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