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