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