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