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