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