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