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