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