include/wx/filefn.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/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 #include "wx/list.h"
  16 #include "wx/arrstr.h"
  17
  18 #ifdef __WXWINCE__
  19     #include "wx/msw/wince/time.h"
  20     #include "wx/msw/private.h"
  21 #else
  22     #include <time.h>
  23 #endif
  24
  25 #ifdef __WXWINCE__
  26 // Nothing
  27 #elif !defined(__MWERKS__)
  28     #include <sys/types.h>
  29     #include <sys/stat.h>
  30 #else
  31     #ifdef __MACH__
  32         #include <sys/types.h>
  33         #include <utime.h>
  34         #include <sys/stat.h>
  35         #include <unistd.h>
  36     #else
  37         #include <stat.h>
  38         #include <unistd.h>
  39         #include <unix.h>
  40     #endif
  41 #endif
  42
  43 #ifdef __OS2__
  44 // need to check for __OS2__ first since currently both
  45 // __OS2__ and __UNIX__ are defined.
  46     #include <process.h>
  47     #include "wx/os2/private.h"
  48     #ifdef __WATCOMC__
  49         #include <direct.h>
  50     #endif
  51     #include <io.h>
  52     #ifdef __EMX__
  53         #include <unistd.h>
  54     #endif
  55 #elif defined(__UNIX__)
  56     #include <unistd.h>
  57     #include <dirent.h>
  58 #endif
  59
  60 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
  61 #if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__SALFORDC__) && !defined(__WXWINCE__) && !defined(__CYGWIN__)
  62     #include <direct.h>
  63     #include <dos.h>
  64     #include <io.h>
  65 #endif // __WINDOWS__
  66 #endif // native Win compiler
  67
  68 #if defined(__DOS__)
  69     #ifdef __WATCOMC__
  70         #include <direct.h>
  71         #include <dos.h>
  72         #include <io.h>
  73     #endif
  74     #ifdef __DJGPP__
  75         #include <io.h>
  76         #include <unistd.h>
  77     #endif
  78 #endif
  79
  80 #ifdef __BORLANDC__ // Please someone tell me which version of Borland needs
  81                     // this (3.1 I believe) and how to test for it.
  82                     // If this works for Borland 4.0 as well, then no worries.
  83     #include <dir.h>
  84 #endif
  85
  86 #ifdef __SALFORDC__
  87     #include <dir.h>
  88     #include <unix.h>
  89 #endif
  90
  91 #ifndef __WXWINCE__
  92     #include  <fcntl.h>       // O_RDONLY &c
  93 #endif
  94 // ----------------------------------------------------------------------------
  95 // constants
  96 // ----------------------------------------------------------------------------
  97
  98 #ifdef __WXWINCE__
  99     typedef long off_t;
 100 #else
 101     // define off_t
 102     #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__)
 103         #include  <sys/types.h>
 104     #else
 105         typedef long off_t;
 106     #endif
 107 #endif
 108
 109 #if (defined(__VISUALC__) && !defined(__WXWINCE__)) || ( defined(__MWERKS__) && defined( __INTEL__) )
 110     typedef _off_t off_t;
 111 #elif defined(__SYMANTEC__)
 112     typedef long off_t;
 113 #elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
 114     typedef long off_t;
 115 #endif
 116
 117 enum wxSeekMode
 118 {
 119   wxFromStart,
 120   wxFromCurrent,
 121   wxFromEnd
 122 };
 123
 124 enum wxFileKind
 125 {
 126   wxFILE_KIND_UNKNOWN,
 127   wxFILE_KIND_DISK,     // a file supporting seeking to arbitrary offsets
 128   wxFILE_KIND_TERMINAL, // a tty
 129   wxFILE_KIND_PIPE      // a pipe
 130 };
 131
 132 // ----------------------------------------------------------------------------
 133 // declare our versions of low level file functions: some compilers prepend
 134 // underscores to the usual names, some also have Unicode versions of them
 135 // ----------------------------------------------------------------------------
 136
 137 // Wrappers around Win32 api functions like CreateFile, ReadFile and such
 138 // Implemented in filefnwce.cpp
 139 #if defined( __WXWINCE__)
 140     typedef __int64 wxFileOffset;
 141     #define wxFileOffsetFmtSpec _("I64")
 142     int wxOpen(const wxChar *filename, int oflag, int WXUNUSED(pmode));
 143     int wxAccess(const wxChar *name, int WXUNUSED(how));
 144     int wxClose(int fd);
 145     int wxFsync(int WXUNUSED(fd));
 146     int wxRead(int fd, void *buf, unsigned int count);
 147     int wxWrite(int fd, const void *buf, unsigned int count);
 148     int wxEof(int fd);
 149     wxFileOffset wxSeek(int fd, wxFileOffset offset, int origin);
 150     #define wxLSeek wxSeek
 151     wxFileOffset wxTell(int fd);
 152
 153     // always Unicode under WinCE
 154     #define   wxMkDir      _wmkdir
 155     #define   wxRmDir      _wrmdir
 156     #define   wxStat       _wstat
 157     #define   wxStructStat struct _stat
 158 #elif defined(__WXMSW__) && !defined(__WXPALMOS__) && \
 159       ( \
 160         defined(__VISUALC__) || \
 161         (defined(__MINGW32__) && !defined(__WINE__) && \
 162                                 wxCHECK_W32API_VERSION(0, 5)) || \
 163         defined(__MWERKS__) || \
 164         defined(__DMC__) || \
 165         defined(__WATCOMC__) || \
 166         defined(__BORLANDC__) \
 167       )
 168
 169     #undef wxHAS_HUGE_FILES
 170
 171     // detect compilers which have support for huge files (notice that the
 172     // first case covers MSVC, so we don't have to test for it explicitly)
 173     #if ((_INTEGRAL_MAX_BITS >= 64) || defined(_LARGE_FILES))
 174         #define wxHAS_HUGE_FILES 1
 175     #elif defined(__MINGW32__)
 176         #define wxHAS_HUGE_FILES 1
 177     #else
 178         // DMC, Watcom, Metrowerks and Borland don't have huge file support (or
 179         // at least not all functions needed for it by wx) currently
 180         #define wxHAS_HUGE_FILES 0
 181     #endif
 182
 183     // functions
 184     #if defined(__BORLANDC__) || defined(__WATCOMC__)
 185         #define   _tell        tell
 186     #endif
 187
 188     #if wxHAS_HUGE_FILES
 189         typedef wxLongLong_t wxFileOffset;
 190         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
 191     #else
 192         typedef off_t wxFileOffset;
 193     #endif
 194
 195     #define   wxClose      _close
 196
 197     #if defined(__MWERKS__)
 198         #if __MSL__ >= 0x6000
 199             #define wxRead(fd, buf, nCount)  _read(fd, (void *)buf, nCount)
 200             #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
 201         #else
 202             #define wxRead(fd, buf, nCount)\
 203                   _read(fd, (const char *)buf, nCount)
 204             #define wxWrite(fd, buf, nCount)\
 205                   _write(fd, (const char *)buf, nCount)
 206         #endif
 207     #else
 208         #if defined(__DMC__) || defined(__WATCOMC__)
 209             #define wxRead        ::read
 210             #define wxWrite       ::write
 211         #else
 212             #define wxRead         _read
 213             #define wxWrite        _write
 214         #endif
 215     #endif
 216     #if wxHAS_HUGE_FILES
 217         #define   wxSeek       _lseeki64
 218         #define   wxLseek      _lseeki64
 219         #define   wxTell       _telli64
 220     #else // !wxHAS_HUGE_FILES
 221         #define   wxSeek       _lseek
 222         #define   wxLseek      _lseek
 223         #define   wxTell       _tell
 224     #endif // wxHAS_HUGE_FILES/!wxHAS_HUGE_FILES
 225
 226     #define   wxFsync      _commit
 227
 228     #if defined(__WATCOMC__)
 229         #define   wxEof        ::eof
 230     #else
 231         #define   wxEof        _eof
 232     #endif
 233
 234     #if wxUSE_UNICODE
 235         #if wxUSE_UNICODE_MSLU
 236             #define   wxOpen       wxMSLU__wopen
 237
 238             #define   wxAccess     wxMSLU__waccess
 239             #define   wxMkDir      wxMSLU__wmkdir
 240             #define   wxRmDir      wxMSLU__wrmdir
 241             #if wxHAS_HUGE_FILES
 242                 #define   wxStat       wxMSLU__wstati64
 243             #else
 244                 #define   wxStat       wxMSLU__wstat
 245             #endif
 246         #else
 247             #define   wxOpen       _wopen
 248             #define   wxAccess     _waccess
 249             #define   wxMkDir      _wmkdir
 250             #define   wxRmDir      _wrmdir
 251             #if wxHAS_HUGE_FILES
 252                 #define   wxStat       _wstati64
 253             #else
 254                 #define   wxStat       _wstat
 255             #endif
 256         #endif
 257     #else // !wxUSE_UNICODE
 258         #ifdef __BORLANDC__
 259             #define   wxOpen       open
 260         #else
 261             #define   wxOpen       _open
 262         #endif
 263         #define   wxAccess     _access
 264         #define   wxMkDir      _mkdir
 265         #ifdef __WATCOMC__
 266             #define   wxRmDir      rmdir
 267         #else
 268             #define   wxRmDir      _rmdir
 269         #endif
 270         #if wxHAS_HUGE_FILES
 271             #define   wxStat       _stati64
 272         #else
 273             #define   wxStat       _stat
 274         #endif
 275     #endif // wxUSE_UNICODE/!wxUSE_UNICODE
 276
 277     // Types: Notice that Watcom is the only compiler to have a wide char
 278     // version of struct stat as well as a wide char stat function variant.
 279     // This was droped since OW 1.4 "for consistency across platforms".
 280     #if wxHAS_HUGE_FILES
 281         #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
 282             #define   wxStructStat struct _wstati64
 283         #else
 284             #define   wxStructStat struct _stati64
 285         #endif
 286     #else
 287         #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
 288             #define   wxStructStat struct _wstat
 289         #else
 290             #define   wxStructStat struct _stat
 291         #endif
 292     #endif
 293
 294     // constants (unless already defined by the user code)
 295     #if !defined(__BORLANDC__) && !defined(__WATCOMC__)
 296         #ifndef O_RDONLY
 297             #define   O_RDONLY    _O_RDONLY
 298             #define   O_WRONLY    _O_WRONLY
 299             #define   O_RDWR      _O_RDWR
 300             #define   O_EXCL      _O_EXCL
 301             #define   O_CREAT     _O_CREAT
 302             #define   O_BINARY    _O_BINARY
 303         #endif
 304
 305         #ifndef S_IFMT
 306             #define   S_IFMT      _S_IFMT
 307             #define   S_IFDIR     _S_IFDIR
 308             #define   S_IFREG     _S_IFREG
 309         #endif
 310     #endif
 311
 312     #if wxHAS_HUGE_FILES
 313         // wxFile is present and supports large files. Currently wxFFile
 314         // doesn't have large file support with any Windows compiler (even
 315         // Win64 ones).
 316         #if wxUSE_FILE
 317             #define WXFILE_LARGEFILE 1
 318         #endif
 319     #endif
 320
 321     // it's a private define, undefine it so that nobody gets tempted to use it
 322     #undef wxHAS_HUGE_FILES
 323 #else // Unix or Windows using unknown compiler, assume POSIX supported
 324     typedef off_t wxFileOffset;
 325     #ifdef _LARGE_FILES
 326         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
 327         wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
 328                                 BadFileSizeType );
 329         // wxFile is present and supports large files
 330         #ifdef wxUSE_FILE
 331             #define WXFILE_LARGEFILE
 332         #endif
 333         // wxFFile is present and supports large files
 334         #if SIZEOF_LONG == 8 || defined HAVE_FSEEKO
 335             #define WXFFILE_LARGEFILE
 336         #endif
 337     #else
 338         #define wxFileOffsetFmtSpec _T("")
 339     #endif
 340     // functions
 341     #define   wxClose      close
 342     #define   wxRead       ::read
 343     #define   wxWrite      ::write
 344     #define   wxLseek      lseek
 345     #define   wxSeek       lseek
 346     #define   wxFsync      fsync
 347     #define   wxEof        eof
 348
 349     #define   wxMkDir      mkdir
 350     #define   wxRmDir      rmdir
 351
 352     #define   wxTell(fd)   lseek(fd, 0, SEEK_CUR)
 353
 354     #define   wxStructStat struct stat
 355
 356     #if wxUSE_UNICODE
 357         #define wxNEED_WX_UNISTD_H
 358         #if defined(__DMC__)
 359             typedef unsigned long mode_t;
 360         #endif
 361         WXDLLIMPEXP_BASE int wxStat( const wxChar *file_name, wxStructStat *buf );
 362         WXDLLIMPEXP_BASE int wxLstat( const wxChar *file_name, wxStructStat *buf );
 363         WXDLLIMPEXP_BASE int wxAccess( const wxChar *pathname, int mode );
 364         WXDLLIMPEXP_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode );
 365     #else
 366         #define   wxOpen       open
 367         #define   wxStat       stat
 368         #define   wxLstat      lstat
 369         #define   wxAccess     access
 370     #endif
 371
 372     #define wxHAS_NATIVE_LSTAT
 373 #endif // platforms
 374
 375 #ifdef O_BINARY
 376     #define wxO_BINARY O_BINARY
 377 #else
 378     #define wxO_BINARY 0
 379 #endif
 380
 381 // if the platform doesn't have symlinks, define wxLstat to be the same as
 382 // wxStat to avoid #ifdefs in the code using it
 383 #ifndef wxHAS_NATIVE_LSTAT
 384     #define wxLstat wxStat
 385 #endif
 386
 387 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
 388 //
 389 // VisualAge C++ V4.0 cannot have any external linkage const decs
 390 // in headers included by more than one primary source
 391 //
 392 extern const int wxInvalidOffset;
 393 #else
 394 const int wxInvalidOffset = -1;
 395 #endif
 396
 397 // ----------------------------------------------------------------------------
 398 // functions
 399 // ----------------------------------------------------------------------------
 400 WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
 401
 402 // does the path exist? (may have or not '/' or '\\' at the end)
 403 WXDLLIMPEXP_BASE bool wxDirExists(const wxChar *pszPathName);
 404
 405 WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
 406
 407 // Get filename
 408 WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
 409 WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);
 410
 411 // Get directory
 412 WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);
 413
 414 // wxString version
 415 WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path);
 416
 417 WXDLLIMPEXP_BASE void wxDos2UnixFilename(wxChar *s);
 418
 419 WXDLLIMPEXP_BASE void wxUnix2DosFilename(wxChar *s);
 420
 421 // Strip the extension, in situ
 422 WXDLLIMPEXP_BASE void wxStripExtension(wxChar *buffer);
 423 WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer);
 424
 425 // Get a temporary filename
 426 WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
 427 WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf);
 428
 429 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
 430 WXDLLIMPEXP_BASE wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
 431 WXDLLIMPEXP_BASE bool wxExpandPath(wxString& dest, const wxChar *path);
 432
 433 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
 434 // and make (if under the home tree) relative to home
 435 // [caller must copy-- volatile]
 436 WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
 437                                    const wxString& envname = wxEmptyString,
 438                                    const wxString& user = wxEmptyString);
 439
 440 // Destructive removal of /./ and /../ stuff
 441 WXDLLIMPEXP_BASE wxChar* wxRealPath(wxChar *path);
 442
 443 // Allocate a copy of the full absolute path
 444 WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path);
 445
 446 // Get first file name matching given wild card.
 447 // Flags are reserved for future use.
 448 #define wxFILE  1
 449 #define wxDIR   2
 450 WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
 451 WXDLLIMPEXP_BASE wxString wxFindNextFile();
 452
 453 // Does the pattern contain wildcards?
 454 WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);
 455
 456 // Does the pattern match the text (usually a filename)?
 457 // If dot_special is true, doesn't match * against . (eliminating
 458 // `hidden' dot files)
 459 WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = true);
 460
 461 // Concatenate two files to form third
 462 WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
 463
 464 // Copy file1 to file2
 465 WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
 466                                  bool overwrite = true);
 467
 468 // Remove file
 469 WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
 470
 471 // Rename file
 472 WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2, bool overwrite = true);
 473
 474 // Get current working directory.
 475 #if WXWIN_COMPATIBILITY_2_6
 476 // If buf is NULL, allocates space using new, else
 477 // copies into buf.
 478 // IMPORTANT NOTE getcwd is know not to work under some releases
 479 // of Win32s 1.3, according to MS release notes!
 480 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000) );
 481 // new and preferred version of wxGetWorkingDirectory
 482 // NB: can't have the same name because of overloading ambiguity
 483 #endif // WXWIN_COMPATIBILITY_2_6
 484 WXDLLIMPEXP_BASE wxString wxGetCwd();
 485
 486 // Set working directory
 487 WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);
 488
 489 // Make directory
 490 WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777);
 491
 492 // Remove directory. Flags reserved for future use.
 493 WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
 494
 495 // Return the type of an open file
 496 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd);
 497 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(FILE *fp);
 498
 499 #if WXWIN_COMPATIBILITY_2_6
 500 // compatibility defines, don't use in new code
 501 wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) );
 502 inline bool wxPathExists(const wxChar *pszPathName)
 503 {
 504     return wxDirExists(pszPathName);
 505 }
 506 #endif //WXWIN_COMPATIBILITY_2_6
 507
 508 // permissions; these functions work both on files and directories:
 509 WXDLLIMPEXP_BASE bool wxIsWritable(const wxString &path);
 510 WXDLLIMPEXP_BASE bool wxIsReadable(const wxString &path);
 511 WXDLLIMPEXP_BASE bool wxIsExecutable(const wxString &path);
 512
 513 // ----------------------------------------------------------------------------
 514 // separators in file names
 515 // ----------------------------------------------------------------------------
 516
 517 // between file name and extension
 518 #define wxFILE_SEP_EXT        wxT('.')
 519
 520 // between drive/volume name and the path
 521 #define wxFILE_SEP_DSK        wxT(':')
 522
 523 // between the path components
 524 #define wxFILE_SEP_PATH_DOS   wxT('\\')
 525 #define wxFILE_SEP_PATH_UNIX  wxT('/')
 526 #define wxFILE_SEP_PATH_MAC   wxT(':')
 527 #define wxFILE_SEP_PATH_VMS   wxT('.') // VMS also uses '[' and ']'
 528
 529 // separator in the path list (as in PATH environment variable)
 530 // there is no PATH variable in Classic Mac OS so just use the
 531 // semicolon (it must be different from the file name separator)
 532 // NB: these are strings and not characters on purpose!
 533 #define wxPATH_SEP_DOS        wxT(";")
 534 #define wxPATH_SEP_UNIX       wxT(":")
 535 #define wxPATH_SEP_MAC        wxT(";")
 536
 537 // platform independent versions
 538 #if defined(__UNIX__) && !defined(__OS2__)
 539   // CYGWIN also uses UNIX settings
 540   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
 541   #define wxPATH_SEP          wxPATH_SEP_UNIX
 542 #elif defined(__MAC__)
 543   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_MAC
 544   #define wxPATH_SEP          wxPATH_SEP_MAC
 545 #else   // Windows and OS/2
 546   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
 547   #define wxPATH_SEP          wxPATH_SEP_DOS
 548 #endif  // Unix/Windows
 549
 550 // this is useful for wxString::IsSameAs(): to compare two file names use
 551 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
 552 #if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
 553   #define wxARE_FILENAMES_CASE_SENSITIVE  true
 554 #else   // Windows, Mac OS and OS/2
 555   #define wxARE_FILENAMES_CASE_SENSITIVE  false
 556 #endif  // Unix/Windows
 557
 558 // is the char a path separator?
 559 inline bool wxIsPathSeparator(wxChar c)
 560 {
 561     // under DOS/Windows we should understand both Unix and DOS file separators
 562 #if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
 563     return c == wxFILE_SEP_PATH;
 564 #else
 565     return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
 566 #endif
 567 }
 568
 569 // does the string ends with path separator?
 570 WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxChar *pszFileName);
 571
 572 // split the full path into path (including drive for DOS), name and extension
 573 // (understands both '/' and '\\')
 574 WXDLLIMPEXP_BASE void wxSplitPath(const wxChar *pszFileName,
 575                              wxString *pstrPath,
 576                              wxString *pstrName,
 577                              wxString *pstrExt);
 578
 579 // find a file in a list of directories, returns false if not found
 580 WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
 581
 582 // Get the OS directory if appropriate (such as the Windows directory).
 583 // On non-Windows platform, probably just return the empty string.
 584 WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
 585
 586 #if wxUSE_DATETIME
 587
 588 // Get file modification time
 589 WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename);
 590
 591 #endif // wxUSE_DATETIME
 592
 593 // Parses the wildCard, returning the number of filters.
 594 // Returns 0 if none or if there's a problem,
 595 // The arrays will contain an equal number of items found before the error.
 596 // wildCard is in the form:
 597 // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
 598 WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters);
 599
 600 // ----------------------------------------------------------------------------
 601 // classes
 602 // ----------------------------------------------------------------------------
 603
 604 #ifdef __UNIX__
 605
 606 // set umask to the given value in ctor and reset it to the old one in dtor
 607 class WXDLLIMPEXP_BASE wxUmaskChanger
 608 {
 609 public:
 610     // change the umask to the given one if it is not -1: this allows to write
 611     // the same code whether you really want to change umask or not, as is in
 612     // wxFileConfig::Flush() for example
 613     wxUmaskChanger(int umaskNew)
 614     {
 615         m_umaskOld = umaskNew == -1 ? -1 : (int)umask((mode_t)umaskNew);
 616     }
 617
 618     ~wxUmaskChanger()
 619     {
 620         if ( m_umaskOld != -1 )
 621             umask((mode_t)m_umaskOld);
 622     }
 623
 624 private:
 625     int m_umaskOld;
 626 };
 627
 628 // this macro expands to an "anonymous" wxUmaskChanger object under Unix and
 629 // nothing elsewhere
 630 #define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
 631
 632 #else // !__UNIX__
 633
 634 #define wxCHANGE_UMASK(m)
 635
 636 #endif // __UNIX__/!__UNIX__
 637
 638
 639 // Path searching
 640 class WXDLLIMPEXP_BASE wxPathList : public wxArrayString
 641 {
 642 public:
 643     wxPathList() {}
 644     wxPathList(const wxArrayString &arr)
 645         { Add(arr); }
 646
 647     // Adds all paths in environment variable
 648     void AddEnvList(const wxString& envVariable);
 649
 650     // Adds given path to this list
 651     void Add(const wxString& path);
 652     void Add(const wxArrayString &paths);
 653
 654     // Find the first full path for which the file exists
 655     wxString FindValidPath(const wxString& filename) const;
 656
 657     // Find the first full path for which the file exists; ensure it's an
 658     // absolute path that gets returned.
 659     wxString FindAbsoluteValidPath(const wxString& filename) const;
 660
 661     // Given full path and filename, add path to list
 662     void EnsureFileAccessible(const wxString& path);
 663
 664     // Returns true if the path is in the list
 665     wxDEPRECATED( bool Member(const wxString& path) const );
 666 };
 667
 668 #endif // _WX_FILEFN_H_