include/wx/filefn.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        filefn.h
   3 // Purpose:     File- and directory-related functions
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     29/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Julian Smart
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef   _FILEFN_H_
  13 #define   _FILEFN_H_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "filefn.h"
  17 #endif
  18
  19 #include "wx/list.h"
  20
  21 #include <time.h>
  22
  23 // ----------------------------------------------------------------------------
  24 // constants
  25 // ----------------------------------------------------------------------------
  26
  27 // define off_t
  28 #ifndef __WXMAC__
  29     #include  <sys/types.h>
  30 #else
  31     typedef long off_t;
  32 #endif
  33
  34 #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) )
  35     typedef _off_t off_t;
  36 #elif defined(__BORLANDC__) && defined(__WIN16__)
  37     typedef long off_t;
  38 #elif defined(__SC__)
  39     typedef long off_t;
  40 #elif defined(__MWERKS__) && !defined(__INTEL__)
  41     typedef long off_t;
  42 #endif
  43
  44 const off_t wxInvalidOffset = (off_t)-1;
  45
  46 enum wxSeekMode
  47 {
  48   wxFromStart,
  49   wxFromCurrent,
  50   wxFromEnd
  51 };
  52
  53 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
  54
  55 // ----------------------------------------------------------------------------
  56 // functions
  57 // ----------------------------------------------------------------------------
  58 WXDLLEXPORT bool wxFileExists(const wxString& filename);
  59 #define FileExists wxFileExists
  60
  61 // does the path exist? (may have or not '/' or '\\' at the end)
  62 WXDLLEXPORT bool wxPathExists(const wxChar *pszPathName);
  63
  64 #define wxDirExists wxPathExists
  65 #define DirExists wxDirExists
  66
  67 WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename);
  68 #define IsAbsolutePath wxIsAbsolutePath
  69
  70 // Get filename
  71 WXDLLEXPORT wxChar* wxFileNameFromPath(wxChar *path);
  72 WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path);
  73 #define FileNameFromPath wxFileNameFromPath
  74
  75 // Get directory
  76 WXDLLEXPORT wxString wxPathOnly(const wxString& path);
  77 #define PathOnly wxPathOnly
  78
  79 // wxString version
  80 WXDLLEXPORT wxString wxRealPath(const wxString& path);
  81
  82 WXDLLEXPORT void wxDos2UnixFilename(wxChar *s);
  83 #define Dos2UnixFilename wxDos2UnixFilename
  84
  85 WXDLLEXPORT void wxUnix2DosFilename(wxChar *s);
  86 #define Unix2DosFilename wxUnix2DosFilename
  87
  88 #ifdef __WXMAC__
  89   WXDLLEXPORT wxString wxMacFSSpec2MacFilename( const FSSpec *spec ) ;
  90   WXDLLEXPORT wxString wxMacFSSpec2UnixFilename( const FSSpec *spec ) ;
  91   WXDLLEXPORT void wxUnixFilename2FSSpec( const char *path , FSSpec *spec ) ;
  92   WXDLLEXPORT void wxMacFilename2FSSpec( const char *path , FSSpec *spec ) ;
  93   WXDLLEXPORT wxString wxMac2UnixFilename( const char *s) ;
  94   WXDLLEXPORT wxString wxUnix2MacFilename( const char *s);
  95 #endif
  96
  97 // Strip the extension, in situ
  98 WXDLLEXPORT void wxStripExtension(wxChar *buffer);
  99 WXDLLEXPORT void wxStripExtension(wxString& buffer);
 100
 101 // Get a temporary filename, opening and closing the file.
 102 WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
 103 WXDLLEXPORT bool wxGetTempFileName(const wxString& prefix, wxString& buf);
 104
 105 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
 106 WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
 107 WXDLLEXPORT bool wxExpandPath(wxString& dest, const wxChar *path);
 108
 109 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
 110 // and make (if under the home tree) relative to home
 111 // [caller must copy-- volatile]
 112 WXDLLEXPORT wxChar* wxContractPath(const wxString& filename,
 113                                    const wxString& envname = wxEmptyString,
 114                                    const wxString& user = wxEmptyString);
 115
 116 // Destructive removal of /./ and /../ stuff
 117 WXDLLEXPORT wxChar* wxRealPath(wxChar *path);
 118
 119 // Allocate a copy of the full absolute path
 120 WXDLLEXPORT wxChar* wxCopyAbsolutePath(const wxString& path);
 121
 122 // Get first file name matching given wild card.
 123 // Flags are reserved for future use.
 124 #define wxFILE  1
 125 #define wxDIR   2
 126 WXDLLEXPORT wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
 127 WXDLLEXPORT wxString wxFindNextFile();
 128
 129 // Does the pattern contain wildcards?
 130 WXDLLEXPORT bool wxIsWild(const wxString& pattern);
 131
 132 // Does the pattern match the text (usually a filename)?
 133 // If dot_special is TRUE, doesn't match * against . (eliminating
 134 // `hidden' dot files)
 135 WXDLLEXPORT bool wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = TRUE);
 136
 137 // Concatenate two files to form third
 138 WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
 139
 140 // Copy file1 to file2
 141 WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2);
 142
 143 // Remove file
 144 WXDLLEXPORT bool wxRemoveFile(const wxString& file);
 145
 146 // Rename file
 147 WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2);
 148
 149 // Get current working directory.
 150 // If buf is NULL, allocates space using new, else
 151 // copies into buf.
 152 // IMPORTANT NOTE getcwd is know not to work under some releases
 153 // of Win32s 1.3, according to MS release notes!
 154 WXDLLEXPORT wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
 155 // new and preferred version of wxGetWorkingDirectory
 156 // NB: can't have the same name because of overloading ambiguity
 157 WXDLLEXPORT wxString wxGetCwd();
 158
 159 // Set working directory
 160 WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d);
 161
 162 // Make directory
 163 WXDLLEXPORT bool wxMkdir(const wxString& dir, int perm = 0777);
 164
 165 // Remove directory. Flags reserved for future use.
 166 WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0);
 167
 168 // separators in file names
 169 #define wxFILE_SEP_EXT        wxT('.')
 170 #define wxFILE_SEP_DSK        wxT(':')
 171 #define wxFILE_SEP_PATH_DOS   wxT('\\')
 172 #define wxFILE_SEP_PATH_UNIX  wxT('/')
 173
 174 // separator in the path list (as in PATH environment variable)
 175 // NB: these are strings and not characters on purpose!
 176 #define wxPATH_SEP_DOS        wxT(";")
 177 #define wxPATH_SEP_UNIX       wxT(":")
 178
 179 // platform independent versions
 180 #ifdef  __UNIX__
 181   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
 182   #define wxPATH_SEP          wxPATH_SEP_UNIX
 183 #else   // Windows and OS/2
 184   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
 185   #define wxPATH_SEP          wxPATH_SEP_DOS
 186 #endif  // Unix/Windows
 187
 188 // this is useful for wxString::IsSameAs(): to compare two file names use
 189 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
 190 #ifdef  __UNIX__
 191   #define wxARE_FILENAMES_CASE_SENSITIVE  TRUE
 192 #else   // Windows and OS/2
 193   #define wxARE_FILENAMES_CASE_SENSITIVE  FALSE
 194 #endif  // Unix/Windows
 195
 196 // is the char a path separator?
 197 inline bool wxIsPathSeparator(wxChar c)
 198   { return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX; }
 199
 200 // does the string ends with path separator?
 201 WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName);
 202
 203 // split the full path into path (including drive for DOS), name and extension
 204 // (understands both '/' and '\\')
 205 WXDLLEXPORT void wxSplitPath(const wxChar *pszFileName,
 206                              wxString *pstrPath,
 207                              wxString *pstrName,
 208                              wxString *pstrExt);
 209
 210 // find a file in a list of directories, returns false if not found
 211 WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
 212
 213 // Get the OS directory if appropriate (such as the Windows directory).
 214 // On non-Windows platform, probably just return the empty string.
 215 WXDLLEXPORT wxString wxGetOSDirectory();
 216
 217 // Get file modification time
 218 WXDLLEXPORT time_t wxFileModificationTime(const wxString& filename);
 219
 220 // ----------------------------------------------------------------------------
 221 // classes
 222 // ----------------------------------------------------------------------------
 223
 224 // Path searching
 225 class WXDLLEXPORT wxPathList : public wxStringList
 226 {
 227 public:
 228     // Adds all paths in environment variable
 229     void AddEnvList(const wxString& envVariable);
 230
 231     void Add(const wxString& path);
 232     // Avoid compiler warning
 233     wxNode *Add(const wxChar *s) { return wxStringList::Add(s); }
 234     // Find the first full path for which the file exists
 235     wxString FindValidPath(const wxString& filename);
 236     // Find the first full path for which the file exists; ensure it's an
 237     // absolute path that gets returned.
 238     wxString FindAbsoluteValidPath(const wxString& filename);
 239     // Given full path and filename, add path to list
 240     void EnsureFileAccessible(const wxString& path);
 241     // Returns TRUE if the path is in the list
 242     bool Member(const wxString& path);
 243
 244 private:
 245     DECLARE_DYNAMIC_CLASS(wxPathList)
 246 };
 247
 248 #endif
 249   // _WX_FILEFN_H_