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
 172     #if defined(__VISUALC__)
 173         #define wxHAS_HUGE_FILES 1
 174     #elif defined(__MINGW32__)
 175         #define wxHAS_HUGE_FILES 1
 176     #elif defined(_LARGE_FILES)
 177         #define wxHAS_HUGE_FILES 1
 178     #endif
 179
 180     // other Windows compilers (DMC, Watcom, Metrowerks and Borland) don't have
 181     // huge file support (or at least not all functions needed for it by wx)
 182     // currently
 183
 184
 185     // functions
 186     #if defined(__BORLANDC__) || defined(__WATCOMC__)
 187         #define   _tell        tell
 188     #endif
 189
 190     #ifdef wxHAS_HUGE_FILES
 191         typedef wxLongLong_t wxFileOffset;
 192         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
 193     #else
 194         typedef off_t wxFileOffset;
 195     #endif
 196
 197     #define   wxClose      _close
 198
 199     #if defined(__MWERKS__)
 200         #if __MSL__ >= 0x6000
 201             #define wxRead(fd, buf, nCount)  _read(fd, (void *)buf, nCount)
 202             #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
 203         #else
 204             #define wxRead(fd, buf, nCount)\
 205                   _read(fd, (const char *)buf, nCount)
 206             #define wxWrite(fd, buf, nCount)\
 207                   _write(fd, (const char *)buf, nCount)
 208         #endif
 209     #else
 210         #if defined(__DMC__) || defined(__WATCOMC__)
 211             #define wxRead        ::read
 212             #define wxWrite       ::write
 213         #else
 214             #define wxRead         _read
 215             #define wxWrite        _write
 216         #endif
 217     #endif
 218     #ifdef wxHAS_HUGE_FILES
 219         #define   wxSeek       _lseeki64
 220         #define   wxLseek      _lseeki64
 221         #define   wxTell       _telli64
 222     #else // !wxHAS_HUGE_FILES
 223         #define   wxSeek       _lseek
 224         #define   wxLseek      _lseek
 225         #define   wxTell       _tell
 226     #endif // wxHAS_HUGE_FILES/!wxHAS_HUGE_FILES
 227
 228     #define   wxFsync      _commit
 229
 230     #if defined(__WATCOMC__)
 231         #define   wxEof        ::eof
 232     #else
 233         #define   wxEof        _eof
 234     #endif
 235
 236     #if wxUSE_UNICODE
 237         #if wxUSE_UNICODE_MSLU
 238             // implement the missing file functions in Win9x ourselves
 239             #if defined( __VISUALC__ ) \
 240                 || ( defined(__MINGW32__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
 241                 || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
 242                 || ( defined(__BORLANDC__) && (__BORLANDC__ > 0x460) ) \
 243                 || defined(__DMC__)
 244                 #ifdef __BORLANDC__
 245                     // BCC has _stati64() function but struct stati64
 246                     #define _stati64 stati64
 247                 #endif // __BORLANDC__
 248
 249                 WXDLLIMPEXP_BASE int wxMSLU__wopen(const wxChar *name, int flags, int mode);
 250                 WXDLLIMPEXP_BASE int wxMSLU__waccess(const wxChar *name, int mode);
 251                 WXDLLIMPEXP_BASE int wxMSLU__wmkdir(const wxChar *name);
 252                 WXDLLIMPEXP_BASE int wxMSLU__wrmdir(const wxChar *name);
 253                 WXDLLIMPEXP_BASE int wxMSLU__wstat(const wxChar *name, struct _stat *buffer);
 254                 WXDLLIMPEXP_BASE int wxMSLU__wstati64(const wxChar *name, struct _stati64 *buffer);
 255             #endif // Windows compilers with MSLU support
 256
 257             #define   wxOpen       wxMSLU__wopen
 258
 259             #define   wxAccess     wxMSLU__waccess
 260             #define   wxMkDir      wxMSLU__wmkdir
 261             #define   wxRmDir      wxMSLU__wrmdir
 262             #ifdef wxHAS_HUGE_FILES
 263                 #define   wxStat       wxMSLU__wstati64
 264             #else
 265                 #define   wxStat       wxMSLU__wstat
 266             #endif
 267         #else
 268             #define   wxOpen       _wopen
 269             #define   wxAccess     _waccess
 270             #define   wxMkDir      _wmkdir
 271             #define   wxRmDir      _wrmdir
 272             #ifdef wxHAS_HUGE_FILES
 273                 #define   wxStat       _wstati64
 274             #else
 275                 #define   wxStat       _wstat
 276             #endif
 277         #endif
 278     #else // !wxUSE_UNICODE
 279         #ifdef __BORLANDC__
 280             #define   wxOpen       open
 281         #else
 282             #define   wxOpen       _open
 283         #endif
 284         #define   wxAccess     _access
 285         #define   wxMkDir      _mkdir
 286         #ifdef __WATCOMC__
 287             #define   wxRmDir      rmdir
 288         #else
 289             #define   wxRmDir      _rmdir
 290         #endif
 291         #ifdef wxHAS_HUGE_FILES
 292             #define   wxStat       _stati64
 293         #else
 294             #define   wxStat       _stat
 295         #endif
 296     #endif // wxUSE_UNICODE/!wxUSE_UNICODE
 297
 298     // Types: Notice that Watcom is the only compiler to have a wide char
 299     // version of struct stat as well as a wide char stat function variant.
 300     // This was droped since OW 1.4 "for consistency across platforms".
 301     #ifdef wxHAS_HUGE_FILES
 302         #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
 303             #define   wxStructStat struct _wstati64
 304         #else
 305             #define   wxStructStat struct _stati64
 306         #endif
 307     #else
 308         #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
 309             #define   wxStructStat struct _wstat
 310         #else
 311             #define   wxStructStat struct _stat
 312         #endif
 313     #endif
 314
 315     // constants (unless already defined by the user code)
 316     #if !defined(__BORLANDC__) && !defined(__WATCOMC__)
 317         #ifndef O_RDONLY
 318             #define   O_RDONLY    _O_RDONLY
 319             #define   O_WRONLY    _O_WRONLY
 320             #define   O_RDWR      _O_RDWR
 321             #define   O_EXCL      _O_EXCL
 322             #define   O_CREAT     _O_CREAT
 323             #define   O_BINARY    _O_BINARY
 324         #endif
 325
 326         #ifndef S_IFMT
 327             #define   S_IFMT      _S_IFMT
 328             #define   S_IFDIR     _S_IFDIR
 329             #define   S_IFREG     _S_IFREG
 330         #endif
 331     #endif
 332
 333     #ifdef wxHAS_HUGE_FILES
 334         // wxFile is present and supports large files. Currently wxFFile
 335         // doesn't have large file support with any Windows compiler (even
 336         // Win64 ones).
 337         #if wxUSE_FILE
 338             #define wxHAS_LARGE_FILES
 339         #endif
 340     #endif
 341
 342     // it's a private define, undefine it so that nobody gets tempted to use it
 343     #undef wxHAS_HUGE_FILES
 344 #else // Unix or Windows using unknown compiler, assume POSIX supported
 345     typedef off_t wxFileOffset;
 346     #ifdef _LARGE_FILES
 347         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
 348         wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
 349                                 BadFileSizeType );
 350         // wxFile is present and supports large files
 351         #ifdef wxUSE_FILE
 352             #define wxHAS_LARGE_FILES
 353         #endif
 354         // wxFFile is present and supports large files
 355         #if SIZEOF_LONG == 8 || defined HAVE_FSEEKO
 356             #define wxHAS_LARGE_FFILES
 357         #endif
 358     #else
 359         #define wxFileOffsetFmtSpec _T("")
 360     #endif
 361     // functions
 362     #define   wxClose      close
 363     #define   wxRead       ::read
 364     #define   wxWrite      ::write
 365     #define   wxLseek      lseek
 366     #define   wxSeek       lseek
 367     #define   wxFsync      fsync
 368     #define   wxEof        eof
 369
 370     #define   wxMkDir      mkdir
 371     #define   wxRmDir      rmdir
 372
 373     #define   wxTell(fd)   lseek(fd, 0, SEEK_CUR)
 374
 375     #define   wxStructStat struct stat
 376
 377     #if wxUSE_UNICODE
 378         #define wxNEED_WX_UNISTD_H
 379         #if defined(__DMC__)
 380             typedef unsigned long mode_t;
 381         #endif
 382         WXDLLIMPEXP_BASE int wxStat( const wxChar *file_name, wxStructStat *buf );
 383         WXDLLIMPEXP_BASE int wxLstat( const wxChar *file_name, wxStructStat *buf );
 384         WXDLLIMPEXP_BASE int wxAccess( const wxChar *pathname, int mode );
 385         WXDLLIMPEXP_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode );
 386     #else
 387         #define   wxOpen       open
 388         #define   wxStat       stat
 389         #define   wxLstat      lstat
 390         #define   wxAccess     access
 391     #endif
 392
 393     #define wxHAS_NATIVE_LSTAT
 394 #endif // platforms
 395
 396 #ifdef O_BINARY
 397     #define wxO_BINARY O_BINARY
 398 #else
 399     #define wxO_BINARY 0
 400 #endif
 401
 402 // if the platform doesn't have symlinks, define wxLstat to be the same as
 403 // wxStat to avoid #ifdefs in the code using it
 404 #ifndef wxHAS_NATIVE_LSTAT
 405     #define wxLstat wxStat
 406 #endif
 407
 408 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
 409 //
 410 // VisualAge C++ V4.0 cannot have any external linkage const decs
 411 // in headers included by more than one primary source
 412 //
 413 extern const int wxInvalidOffset;
 414 #else
 415 const int wxInvalidOffset = -1;
 416 #endif
 417
 418 // ----------------------------------------------------------------------------
 419 // functions
 420 // ----------------------------------------------------------------------------
 421 WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
 422
 423 // does the path exist? (may have or not '/' or '\\' at the end)
 424 WXDLLIMPEXP_BASE bool wxDirExists(const wxChar *pszPathName);
 425
 426 WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
 427
 428 // Get filename
 429 WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
 430 WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);
 431
 432 // Get directory
 433 WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);
 434
 435 // wxString version
 436 WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path);
 437
 438 WXDLLIMPEXP_BASE void wxDos2UnixFilename(wxChar *s);
 439
 440 WXDLLIMPEXP_BASE void wxUnix2DosFilename(wxChar *s);
 441
 442 // Strip the extension, in situ
 443 WXDLLIMPEXP_BASE void wxStripExtension(wxChar *buffer);
 444 WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer);
 445
 446 // Get a temporary filename
 447 WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
 448 WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf);
 449
 450 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
 451 WXDLLIMPEXP_BASE wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
 452 WXDLLIMPEXP_BASE bool wxExpandPath(wxString& dest, const wxChar *path);
 453
 454 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
 455 // and make (if under the home tree) relative to home
 456 // [caller must copy-- volatile]
 457 WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
 458                                    const wxString& envname = wxEmptyString,
 459                                    const wxString& user = wxEmptyString);
 460
 461 // Destructive removal of /./ and /../ stuff
 462 WXDLLIMPEXP_BASE wxChar* wxRealPath(wxChar *path);
 463
 464 // Allocate a copy of the full absolute path
 465 WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path);
 466
 467 // Get first file name matching given wild card.
 468 // Flags are reserved for future use.
 469 #define wxFILE  1
 470 #define wxDIR   2
 471 WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
 472 WXDLLIMPEXP_BASE wxString wxFindNextFile();
 473
 474 // Does the pattern contain wildcards?
 475 WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);
 476
 477 // Does the pattern match the text (usually a filename)?
 478 // If dot_special is true, doesn't match * against . (eliminating
 479 // `hidden' dot files)
 480 WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = true);
 481
 482 // Concatenate two files to form third
 483 WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
 484
 485 // Copy file1 to file2
 486 WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
 487                                  bool overwrite = true);
 488
 489 // Remove file
 490 WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
 491
 492 // Rename file
 493 WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2, bool overwrite = true);
 494
 495 // Get current working directory.
 496 #if WXWIN_COMPATIBILITY_2_6
 497 // If buf is NULL, allocates space using new, else
 498 // copies into buf.
 499 // IMPORTANT NOTE getcwd is know not to work under some releases
 500 // of Win32s 1.3, according to MS release notes!
 501 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000) );
 502 // new and preferred version of wxGetWorkingDirectory
 503 // NB: can't have the same name because of overloading ambiguity
 504 #endif // WXWIN_COMPATIBILITY_2_6
 505 WXDLLIMPEXP_BASE wxString wxGetCwd();
 506
 507 // Set working directory
 508 WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);
 509
 510 // Make directory
 511 WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777);
 512
 513 // Remove directory. Flags reserved for future use.
 514 WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
 515
 516 // Return the type of an open file
 517 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd);
 518 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(FILE *fp);
 519
 520 #if WXWIN_COMPATIBILITY_2_6
 521 // compatibility defines, don't use in new code
 522 wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) );
 523 inline bool wxPathExists(const wxChar *pszPathName)
 524 {
 525     return wxDirExists(pszPathName);
 526 }
 527 #endif //WXWIN_COMPATIBILITY_2_6
 528
 529 // permissions; these functions work both on files and directories:
 530 WXDLLIMPEXP_BASE bool wxIsWritable(const wxString &path);
 531 WXDLLIMPEXP_BASE bool wxIsReadable(const wxString &path);
 532 WXDLLIMPEXP_BASE bool wxIsExecutable(const wxString &path);
 533
 534 // ----------------------------------------------------------------------------
 535 // separators in file names
 536 // ----------------------------------------------------------------------------
 537
 538 // between file name and extension
 539 #define wxFILE_SEP_EXT        wxT('.')
 540
 541 // between drive/volume name and the path
 542 #define wxFILE_SEP_DSK        wxT(':')
 543
 544 // between the path components
 545 #define wxFILE_SEP_PATH_DOS   wxT('\\')
 546 #define wxFILE_SEP_PATH_UNIX  wxT('/')
 547 #define wxFILE_SEP_PATH_MAC   wxT(':')
 548 #define wxFILE_SEP_PATH_VMS   wxT('.') // VMS also uses '[' and ']'
 549
 550 // separator in the path list (as in PATH environment variable)
 551 // there is no PATH variable in Classic Mac OS so just use the
 552 // semicolon (it must be different from the file name separator)
 553 // NB: these are strings and not characters on purpose!
 554 #define wxPATH_SEP_DOS        wxT(";")
 555 #define wxPATH_SEP_UNIX       wxT(":")
 556 #define wxPATH_SEP_MAC        wxT(";")
 557
 558 // platform independent versions
 559 #if defined(__UNIX__) && !defined(__OS2__)
 560   // CYGWIN also uses UNIX settings
 561   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
 562   #define wxPATH_SEP          wxPATH_SEP_UNIX
 563 #elif defined(__MAC__)
 564   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_MAC
 565   #define wxPATH_SEP          wxPATH_SEP_MAC
 566 #else   // Windows and OS/2
 567   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
 568   #define wxPATH_SEP          wxPATH_SEP_DOS
 569 #endif  // Unix/Windows
 570
 571 // this is useful for wxString::IsSameAs(): to compare two file names use
 572 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
 573 #if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
 574   #define wxARE_FILENAMES_CASE_SENSITIVE  true
 575 #else   // Windows, Mac OS and OS/2
 576   #define wxARE_FILENAMES_CASE_SENSITIVE  false
 577 #endif  // Unix/Windows
 578
 579 // is the char a path separator?
 580 inline bool wxIsPathSeparator(wxChar c)
 581 {
 582     // under DOS/Windows we should understand both Unix and DOS file separators
 583 #if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
 584     return c == wxFILE_SEP_PATH;
 585 #else
 586     return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
 587 #endif
 588 }
 589
 590 // does the string ends with path separator?
 591 WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxChar *pszFileName);
 592
 593 // split the full path into path (including drive for DOS), name and extension
 594 // (understands both '/' and '\\')
 595 WXDLLIMPEXP_BASE void wxSplitPath(const wxChar *pszFileName,
 596                              wxString *pstrPath,
 597                              wxString *pstrName,
 598                              wxString *pstrExt);
 599
 600 // find a file in a list of directories, returns false if not found
 601 WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
 602
 603 // Get the OS directory if appropriate (such as the Windows directory).
 604 // On non-Windows platform, probably just return the empty string.
 605 WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
 606
 607 #if wxUSE_DATETIME
 608
 609 // Get file modification time
 610 WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename);
 611
 612 #endif // wxUSE_DATETIME
 613
 614 // Parses the wildCard, returning the number of filters.
 615 // Returns 0 if none or if there's a problem,
 616 // The arrays will contain an equal number of items found before the error.
 617 // wildCard is in the form:
 618 // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
 619 WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters);
 620
 621 // ----------------------------------------------------------------------------
 622 // classes
 623 // ----------------------------------------------------------------------------
 624
 625 #ifdef __UNIX__
 626
 627 // set umask to the given value in ctor and reset it to the old one in dtor
 628 class WXDLLIMPEXP_BASE wxUmaskChanger
 629 {
 630 public:
 631     // change the umask to the given one if it is not -1: this allows to write
 632     // the same code whether you really want to change umask or not, as is in
 633     // wxFileConfig::Flush() for example
 634     wxUmaskChanger(int umaskNew)
 635     {
 636         m_umaskOld = umaskNew == -1 ? -1 : (int)umask((mode_t)umaskNew);
 637     }
 638
 639     ~wxUmaskChanger()
 640     {
 641         if ( m_umaskOld != -1 )
 642             umask((mode_t)m_umaskOld);
 643     }
 644
 645 private:
 646     int m_umaskOld;
 647 };
 648
 649 // this macro expands to an "anonymous" wxUmaskChanger object under Unix and
 650 // nothing elsewhere
 651 #define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
 652
 653 #else // !__UNIX__
 654
 655 #define wxCHANGE_UMASK(m)
 656
 657 #endif // __UNIX__/!__UNIX__
 658
 659
 660 // Path searching
 661 class WXDLLIMPEXP_BASE wxPathList : public wxArrayString
 662 {
 663 public:
 664     wxPathList() {}
 665     wxPathList(const wxArrayString &arr)
 666         { Add(arr); }
 667
 668     // Adds all paths in environment variable
 669     void AddEnvList(const wxString& envVariable);
 670
 671     // Adds given path to this list
 672     bool Add(const wxString& path);
 673     void Add(const wxArrayString &paths);
 674
 675     // Find the first full path for which the file exists
 676     wxString FindValidPath(const wxString& filename) const;
 677
 678     // Find the first full path for which the file exists; ensure it's an
 679     // absolute path that gets returned.
 680     wxString FindAbsoluteValidPath(const wxString& filename) const;
 681
 682     // Given full path and filename, add path to list
 683     bool EnsureFileAccessible(const wxString& path);
 684
 685 #if WXWIN_COMPATIBILITY_2_6
 686     // Returns true if the path is in the list
 687     wxDEPRECATED( bool Member(const wxString& path) const );
 688 #endif
 689 };
 690
 691 #endif // _WX_FILEFN_H_