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 #if defined(__GNUG__) && !defined(__APPLE__)
  16     #pragma interface "filefn.h"
  17 #endif
  18
  19 #include "wx/list.h"
  20
  21 #ifndef __WXWINCE__
  22 #include <time.h>
  23 #endif
  24
  25 // ----------------------------------------------------------------------------
  26 // constants
  27 // ----------------------------------------------------------------------------
  28
  29 #ifdef __WXWINCE__
  30     typedef long off_t;
  31 #else
  32
  33 // define off_t
  34 #if !defined(__WXMAC__) || defined(__UNIX__)
  35     #include  <sys/types.h>
  36 #else
  37     typedef long off_t;
  38 #endif
  39
  40 #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) )
  41     typedef _off_t off_t;
  42 #elif defined(__BORLANDC__) && defined(__WIN16__)
  43     typedef long off_t;
  44 #elif defined(__SC__)
  45     typedef long off_t;
  46 #elif defined(__MWERKS__) && !defined(__INTEL__)
  47     typedef long off_t;
  48 #endif
  49
  50 #endif
  51
  52 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
  53 //
  54 // VisualAge C++ V4.0 cannot have any external linkage const decs
  55 // in headers included by more than one primary source
  56 //
  57 extern const off_t wxInvalidOffset;
  58 #else
  59 const off_t wxInvalidOffset = (off_t)-1;
  60 #endif
  61
  62 enum wxSeekMode
  63 {
  64   wxFromStart,
  65   wxFromCurrent,
  66   wxFromEnd
  67 };
  68
  69 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
  70
  71 // ----------------------------------------------------------------------------
  72 // declare our versions of low level file functions: some compilers prepend
  73 // underscores to the usual names, some also have Unicode versions of them
  74 // ----------------------------------------------------------------------------
  75
  76 // Microsoft compiler loves underscores, feed them to it
  77 #if defined( __VISUALC__ ) \
  78     || ( defined(__MINGW32__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
  79     || ( defined(__MWERKS__) && defined(__WXMSW__) )
  80     // functions
  81     #define   wxClose      _close
  82     #define   wxRead       _read
  83     #define   wxWrite      _write
  84     #define   wxLseek      _lseek
  85     #define   wxFsync      _commit
  86     #define   wxEof        _eof
  87
  88     #define   wxTell       _tell
  89
  90     #if wxUSE_UNICODE
  91         #if wxUSE_UNICODE_MSLU
  92             #define   wxOpen       wxMSLU__wopen
  93             #define   wxAccess     wxMSLU__waccess
  94             #define   wxMkDir      wxMSLU__wmkdir
  95             #define   wxRmDir      wxMSLU__wrmdir
  96             #define   wxStat       wxMSLU__wstat
  97         #else
  98             #define   wxOpen       _wopen
  99             #define   wxAccess     _waccess
 100             #define   wxMkDir      _wmkdir
 101             #define   wxRmDir      _wrmdir
 102             #define   wxStat       _wstat
 103         #endif
 104     #else // !wxUSE_UNICODE
 105         #define   wxOpen       _open
 106         #define   wxAccess     _access
 107         #define   wxMkDir      _mkdir
 108         #define   wxRmDir      _rmdir
 109         #define   wxStat       _stat
 110     #endif
 111
 112     // types
 113     #define   wxStructStat struct _stat
 114
 115     // constants (unless already defined by the user code)
 116     #ifndef O_RDONLY
 117         #define   O_RDONLY    _O_RDONLY
 118         #define   O_WRONLY    _O_WRONLY
 119         #define   O_RDWR      _O_RDWR
 120         #define   O_EXCL      _O_EXCL
 121         #define   O_CREAT     _O_CREAT
 122         #define   O_BINARY    _O_BINARY
 123
 124         #define   S_IFMT      _S_IFMT
 125         #define   S_IFDIR     _S_IFDIR
 126         #define   S_IFREG     _S_IFREG
 127     #endif // O_RDONLY
 128 #else
 129     // functions
 130     #define   wxClose      close
 131     #define   wxRead       read
 132     #define   wxWrite      write
 133     #define   wxLseek      lseek
 134     #define   wxFsync      commit
 135     #define   wxEof        eof
 136
 137     #define   wxMkDir      mkdir
 138     #define   wxRmDir      rmdir
 139
 140     #define   wxTell(fd)   lseek(fd, 0, SEEK_CUR)
 141
 142     #define   wxStructStat struct stat
 143
 144 #if wxUSE_UNICODE
 145 #   define wxNEED_WX_UNISTD_H
 146 WXDLLEXPORT int wxStat( const wxChar *file_name, wxStructStat *buf );
 147 WXDLLEXPORT int wxAccess( const wxChar *pathname, int mode );
 148 WXDLLEXPORT int wxOpen( const wxChar *pathname, int flags, mode_t mode );
 149 #else
 150     #define   wxOpen       open
 151     #define   wxStat       stat
 152     #define   wxAccess     access
 153 #endif
 154
 155 #endif  // VC++
 156
 157 // ----------------------------------------------------------------------------
 158 // functions
 159 // ----------------------------------------------------------------------------
 160 WXDLLEXPORT bool wxFileExists(const wxString& filename);
 161
 162 // does the path exist? (may have or not '/' or '\\' at the end)
 163 WXDLLEXPORT bool wxPathExists(const wxChar *pszPathName);
 164
 165 WXDLLEXPORT bool wxIsAbsolutePath(const wxString& filename);
 166
 167 // Get filename
 168 WXDLLEXPORT wxChar* wxFileNameFromPath(wxChar *path);
 169 WXDLLEXPORT wxString wxFileNameFromPath(const wxString& path);
 170
 171 // Get directory
 172 WXDLLEXPORT wxString wxPathOnly(const wxString& path);
 173
 174 // wxString version
 175 WXDLLEXPORT wxString wxRealPath(const wxString& path);
 176
 177 WXDLLEXPORT void wxDos2UnixFilename(wxChar *s);
 178
 179 WXDLLEXPORT void wxUnix2DosFilename(wxChar *s);
 180
 181 // Strip the extension, in situ
 182 WXDLLEXPORT void wxStripExtension(wxChar *buffer);
 183 WXDLLEXPORT void wxStripExtension(wxString& buffer);
 184
 185 // Get a temporary filename
 186 WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
 187 WXDLLEXPORT bool wxGetTempFileName(const wxString& prefix, wxString& buf);
 188
 189 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
 190 WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
 191 WXDLLEXPORT bool wxExpandPath(wxString& dest, const wxChar *path);
 192
 193 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
 194 // and make (if under the home tree) relative to home
 195 // [caller must copy-- volatile]
 196 WXDLLEXPORT wxChar* wxContractPath(const wxString& filename,
 197                                    const wxString& envname = wxEmptyString,
 198                                    const wxString& user = wxEmptyString);
 199
 200 // Destructive removal of /./ and /../ stuff
 201 WXDLLEXPORT wxChar* wxRealPath(wxChar *path);
 202
 203 // Allocate a copy of the full absolute path
 204 WXDLLEXPORT wxChar* wxCopyAbsolutePath(const wxString& path);
 205
 206 // Get first file name matching given wild card.
 207 // Flags are reserved for future use.
 208 #define wxFILE  1
 209 #define wxDIR   2
 210 WXDLLEXPORT wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
 211 WXDLLEXPORT wxString wxFindNextFile();
 212
 213 // Does the pattern contain wildcards?
 214 WXDLLEXPORT bool wxIsWild(const wxString& pattern);
 215
 216 // Does the pattern match the text (usually a filename)?
 217 // If dot_special is TRUE, doesn't match * against . (eliminating
 218 // `hidden' dot files)
 219 WXDLLEXPORT bool wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = TRUE);
 220
 221 // Concatenate two files to form third
 222 WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
 223
 224 // Copy file1 to file2
 225 WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2,
 226                             bool overwrite = TRUE);
 227
 228 // Remove file
 229 WXDLLEXPORT bool wxRemoveFile(const wxString& file);
 230
 231 // Rename file
 232 WXDLLEXPORT bool wxRenameFile(const wxString& file1, const wxString& file2);
 233
 234 // Get current working directory.
 235 // If buf is NULL, allocates space using new, else
 236 // copies into buf.
 237 // IMPORTANT NOTE getcwd is know not to work under some releases
 238 // of Win32s 1.3, according to MS release notes!
 239 WXDLLEXPORT wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
 240 // new and preferred version of wxGetWorkingDirectory
 241 // NB: can't have the same name because of overloading ambiguity
 242 WXDLLEXPORT wxString wxGetCwd();
 243
 244 // Set working directory
 245 WXDLLEXPORT bool wxSetWorkingDirectory(const wxString& d);
 246
 247 // Make directory
 248 WXDLLEXPORT bool wxMkdir(const wxString& dir, int perm = 0777);
 249
 250 // Remove directory. Flags reserved for future use.
 251 WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0);
 252
 253 // compatibility defines, don't use in new code
 254 #define wxDirExists wxPathExists
 255
 256 #if WXWIN_COMPATIBILITY_2
 257     #define FileExists wxFileExists
 258     #define DirExists wxDirExists
 259     #define IsAbsolutePath wxIsAbsolutePath
 260     #define FileNameFromPath wxFileNameFromPath
 261     #define PathOnly wxPathOnly
 262     #define Dos2UnixFilename wxDos2UnixFilename
 263     #define Unix2DosFilename wxUnix2DosFilename
 264 #endif
 265
 266 // ----------------------------------------------------------------------------
 267 // separators in file names
 268 // ----------------------------------------------------------------------------
 269
 270 // between file name and extension
 271 #define wxFILE_SEP_EXT        wxT('.')
 272
 273 // between drive/volume name and the path
 274 #define wxFILE_SEP_DSK        wxT(':')
 275
 276 // between the path components
 277 #define wxFILE_SEP_PATH_DOS   wxT('\\')
 278 #define wxFILE_SEP_PATH_UNIX  wxT('/')
 279 #define wxFILE_SEP_PATH_MAC   wxT(':')
 280 #define wxFILE_SEP_PATH_VMS   wxT('.') // VMS also uses '[' and ']'
 281
 282 // separator in the path list (as in PATH environment variable)
 283 // there is no PATH variable in Classic Mac OS so just use the
 284 // semicolon (it must be different from the file name separator)
 285 // NB: these are strings and not characters on purpose!
 286 #define wxPATH_SEP_DOS        wxT(";")
 287 #define wxPATH_SEP_UNIX       wxT(":")
 288 #define wxPATH_SEP_MAC        wxT(";")
 289
 290 // platform independent versions
 291 #if defined(__UNIX__) && !defined(__CYGWIN__)
 292   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
 293   #define wxPATH_SEP          wxPATH_SEP_UNIX
 294 #elif defined(__MAC__)
 295   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_MAC
 296   #define wxPATH_SEP          wxPATH_SEP_MAC
 297 #elif defined(__CYGWIN__) // Cygwin
 298   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
 299   #define wxPATH_SEP          wxPATH_SEP_UNIX
 300 #else   // Windows and OS/2
 301   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
 302   #define wxPATH_SEP          wxPATH_SEP_DOS
 303 #endif  // Unix/Windows
 304
 305 // this is useful for wxString::IsSameAs(): to compare two file names use
 306 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
 307 #if defined(__UNIX__) && !defined(__DARWIN__)
 308   #define wxARE_FILENAMES_CASE_SENSITIVE  TRUE
 309 #else   // Windows, Mac OS and OS/2
 310   #define wxARE_FILENAMES_CASE_SENSITIVE  FALSE
 311 #endif  // Unix/Windows
 312
 313 // is the char a path separator?
 314 inline bool wxIsPathSeparator(wxChar c)
 315 {
 316     // under DOS/Windows we should understand both Unix and DOS file separators
 317 #if defined(__UNIX__) || defined(__MAC__)
 318     return c == wxFILE_SEP_PATH;
 319 #else
 320     return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
 321 #endif
 322 }
 323
 324 // does the string ends with path separator?
 325 WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName);
 326
 327 // split the full path into path (including drive for DOS), name and extension
 328 // (understands both '/' and '\\')
 329 WXDLLEXPORT void wxSplitPath(const wxChar *pszFileName,
 330                              wxString *pstrPath,
 331                              wxString *pstrName,
 332                              wxString *pstrExt);
 333
 334 // find a file in a list of directories, returns false if not found
 335 WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
 336
 337 // Get the OS directory if appropriate (such as the Windows directory).
 338 // On non-Windows platform, probably just return the empty string.
 339 WXDLLEXPORT wxString wxGetOSDirectory();
 340
 341 // Get file modification time
 342 WXDLLEXPORT time_t wxFileModificationTime(const wxString& filename);
 343
 344 // ----------------------------------------------------------------------------
 345 // classes
 346 // ----------------------------------------------------------------------------
 347
 348 // Path searching
 349 class WXDLLEXPORT wxPathList : public wxStringList
 350 {
 351 public:
 352     // Adds all paths in environment variable
 353     void AddEnvList(const wxString& envVariable);
 354
 355     void Add(const wxString& path);
 356     // Avoid compiler warning
 357     wxNode *Add(const wxChar *s) { return wxStringList::Add(s); }
 358     // Find the first full path for which the file exists
 359     wxString FindValidPath(const wxString& filename);
 360     // Find the first full path for which the file exists; ensure it's an
 361     // absolute path that gets returned.
 362     wxString FindAbsoluteValidPath(const wxString& filename);
 363     // Given full path and filename, add path to list
 364     void EnsureFileAccessible(const wxString& path);
 365     // Returns TRUE if the path is in the list
 366     bool Member(const wxString& path);
 367
 368 private:
 369     DECLARE_DYNAMIC_CLASS(wxPathList)
 370 };
 371
 372 #endif
 373   // _WX_FILEFN_H_