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 #ifndef __WXPALMOS5__
  19 #ifdef __WXWINCE__
  20     #include "wx/msw/wince/time.h"
  21     #include "wx/msw/private.h"
  22 #else
  23     #include <time.h>
  24 #endif
  25
  26 #ifdef __WXWINCE__
  27 // Nothing
  28 #elif !defined(__MWERKS__)
  29     #include <sys/types.h>
  30     #include <sys/stat.h>
  31 #else
  32     #ifdef __MACH__
  33         #include <sys/types.h>
  34         #include <utime.h>
  35         #include <sys/stat.h>
  36         #include <unistd.h>
  37     #else
  38         #include <stat.h>
  39         #include <unistd.h>
  40         #include <unix.h>
  41     #endif
  42 #endif
  43 #endif // !__WXPALMOS5__
  44
  45 #ifdef __OS2__
  46 // need to check for __OS2__ first since currently both
  47 // __OS2__ and __UNIX__ are defined.
  48     #include <process.h>
  49     #include "wx/os2/private.h"
  50     #ifdef __WATCOMC__
  51         #include <direct.h>
  52     #endif
  53     #include <io.h>
  54     #ifdef __EMX__
  55         #include <unistd.h>
  56     #endif
  57 #elif defined(__UNIX__)
  58     #include <unistd.h>
  59     #include <dirent.h>
  60 #endif
  61
  62 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
  63 #if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__WXWINCE__) && !defined(__CYGWIN__)
  64     #include <direct.h>
  65     #include <dos.h>
  66     #include <io.h>
  67 #endif // __WINDOWS__
  68 #endif // native Win compiler
  69
  70 #if defined(__DOS__)
  71     #ifdef __WATCOMC__
  72         #include <direct.h>
  73         #include <dos.h>
  74         #include <io.h>
  75     #endif
  76     #ifdef __DJGPP__
  77         #include <io.h>
  78         #include <unistd.h>
  79     #endif
  80 #endif
  81
  82 #ifdef __BORLANDC__ // Please someone tell me which version of Borland needs
  83                     // this (3.1 I believe) and how to test for it.
  84                     // If this works for Borland 4.0 as well, then no worries.
  85     #include <dir.h>
  86 #endif
  87
  88 #ifndef __WXPALMOS5__
  89 #ifndef __WXWINCE__
  90     #include  <fcntl.h>       // O_RDONLY &c
  91 #endif
  92 #endif // !__WXPALMOS5__
  93 // ----------------------------------------------------------------------------
  94 // constants
  95 // ----------------------------------------------------------------------------
  96
  97 #if defined(__VISUALC__) || defined(__DIGITALMARS__)
  98     typedef int mode_t;
  99 #endif
 100
 101 #ifdef __WXWINCE__
 102     typedef long off_t;
 103 #else
 104     // define off_t
 105     #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__)
 106         #include  <sys/types.h>
 107     #else
 108         typedef long off_t;
 109     #endif
 110 #endif
 111
 112 #if (defined(__VISUALC__) && !defined(__WXWINCE__)) || ( defined(__MWERKS__) && defined( __INTEL__) )
 113     typedef _off_t off_t;
 114 #elif defined(__SYMANTEC__)
 115     typedef long off_t;
 116 #elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
 117     typedef long off_t;
 118 #elif defined(__WXPALMOS5__)
 119     typedef long off_t;
 120 #endif
 121
 122 enum wxSeekMode
 123 {
 124   wxFromStart,
 125   wxFromCurrent,
 126   wxFromEnd
 127 };
 128
 129 enum wxFileKind
 130 {
 131   wxFILE_KIND_UNKNOWN,
 132   wxFILE_KIND_DISK,     // a file supporting seeking to arbitrary offsets
 133   wxFILE_KIND_TERMINAL, // a tty
 134   wxFILE_KIND_PIPE      // a pipe
 135 };
 136
 137 // we redefine these constants here because S_IREAD &c are _not_ standard
 138 // however, we do assume that the values correspond to the Unix umask bits
 139 enum wxPosixPermissions
 140 {
 141     // standard Posix names for these permission flags:
 142     wxS_IRUSR = 00400,
 143     wxS_IWUSR = 00200,
 144     wxS_IXUSR = 00100,
 145
 146     wxS_IRGRP = 00040,
 147     wxS_IWGRP = 00020,
 148     wxS_IXGRP = 00010,
 149
 150     wxS_IROTH = 00004,
 151     wxS_IWOTH = 00002,
 152     wxS_IXOTH = 00001,
 153
 154     // longer but more readable synonyms for the constants above:
 155     wxPOSIX_USER_READ = wxS_IRUSR,
 156     wxPOSIX_USER_WRITE = wxS_IWUSR,
 157     wxPOSIX_USER_EXECUTE = wxS_IXUSR,
 158
 159     wxPOSIX_GROUP_READ = wxS_IRGRP,
 160     wxPOSIX_GROUP_WRITE = wxS_IWGRP,
 161     wxPOSIX_GROUP_EXECUTE = wxS_IXGRP,
 162
 163     wxPOSIX_OTHERS_READ = wxS_IROTH,
 164     wxPOSIX_OTHERS_WRITE = wxS_IWOTH,
 165     wxPOSIX_OTHERS_EXECUTE = wxS_IXOTH,
 166
 167     // default mode for the new files: allow reading/writing them to everybody but
 168     // the effective file mode will be set after anding this value with umask and
 169     // so won't include wxS_IW{GRP,OTH} for the default 022 umask value
 170     wxS_DEFAULT = (wxPOSIX_USER_READ | wxPOSIX_USER_WRITE | \
 171                    wxPOSIX_GROUP_READ | wxPOSIX_GROUP_WRITE | \
 172                    wxPOSIX_OTHERS_READ | wxPOSIX_OTHERS_WRITE),
 173
 174     // default mode for the new directories (see wxFileName::Mkdir): allow
 175     // reading/writing/executing them to everybody, but just like wxS_DEFAULT
 176     // the effective directory mode will be set after anding this value with umask
 177     wxS_DIR_DEFAULT = (wxPOSIX_USER_READ | wxPOSIX_USER_WRITE | wxPOSIX_USER_EXECUTE | \
 178                        wxPOSIX_GROUP_READ | wxPOSIX_GROUP_WRITE | wxPOSIX_GROUP_EXECUTE | \
 179                        wxPOSIX_OTHERS_READ | wxPOSIX_OTHERS_WRITE | wxPOSIX_OTHERS_EXECUTE)
 180 };
 181
 182 // ----------------------------------------------------------------------------
 183 // declare our versions of low level file functions: some compilers prepend
 184 // underscores to the usual names, some also have Unicode versions of them
 185 // ----------------------------------------------------------------------------
 186
 187 // Wrappers around Win32 api functions like CreateFile, ReadFile and such
 188 // Implemented in filefnwce.cpp
 189 #if defined( __WXWINCE__)
 190     typedef __int64 wxFileOffset;
 191     #define wxFileOffsetFmtSpec wxT("I64")
 192     WXDLLIMPEXP_BASE int wxCRT_Open(const wxChar *filename, int oflag, int WXUNUSED(pmode));
 193     WXDLLIMPEXP_BASE int wxCRT_Access(const wxChar *name, int WXUNUSED(how));
 194     WXDLLIMPEXP_BASE int wxClose(int fd);
 195     WXDLLIMPEXP_BASE int wxFsync(int WXUNUSED(fd));
 196     WXDLLIMPEXP_BASE int wxRead(int fd, void *buf, unsigned int count);
 197     WXDLLIMPEXP_BASE int wxWrite(int fd, const void *buf, unsigned int count);
 198     WXDLLIMPEXP_BASE int wxEof(int fd);
 199     WXDLLIMPEXP_BASE wxFileOffset wxSeek(int fd, wxFileOffset offset, int origin);
 200     #define wxLSeek wxSeek
 201     WXDLLIMPEXP_BASE wxFileOffset wxTell(int fd);
 202
 203     // always Unicode under WinCE
 204     #define   wxCRT_MkDir      _wmkdir
 205     #define   wxCRT_RmDir      _wrmdir
 206     #define   wxCRT_Stat       _wstat
 207     #define   wxStructStat struct _stat
 208 #elif (defined(__WXMSW__) || defined(__OS2__)) && !defined(__WXPALMOS__) && \
 209       ( \
 210         defined(__VISUALC__) || \
 211         defined(__MINGW64__) || \
 212         (defined(__MINGW32__) && !defined(__WINE__) && \
 213                                 wxCHECK_W32API_VERSION(0, 5)) || \
 214         defined(__MWERKS__) || \
 215         defined(__DMC__) || \
 216         defined(__WATCOMC__) || \
 217         defined(__BORLANDC__) \
 218       )
 219
 220     // temporary defines just used immediately below
 221     #undef wxHAS_HUGE_FILES
 222     #undef wxHAS_HUGE_STDIO_FILES
 223
 224     // detect compilers which have support for huge files
 225     #if defined(__VISUALC__)
 226         #define wxHAS_HUGE_FILES 1
 227     #elif defined(__MINGW32__) || defined(__MINGW64__)
 228         #define wxHAS_HUGE_FILES 1
 229     #elif defined(_LARGE_FILES)
 230         #define wxHAS_HUGE_FILES 1
 231     #endif
 232
 233     // detect compilers which have support for huge stdio files
 234     #if wxCHECK_VISUALC_VERSION(8)
 235         #define wxHAS_HUGE_STDIO_FILES
 236         #define wxFseek _fseeki64
 237         #define wxFtell _ftelli64
 238     #elif wxCHECK_MINGW32_VERSION(3, 5) // mingw-runtime version (not gcc)
 239         #define wxHAS_HUGE_STDIO_FILES
 240         #define wxFseek fseeko64
 241         #define wxFtell ftello64
 242     #endif
 243
 244     // other Windows compilers (DMC, Watcom, Metrowerks and Borland) don't have
 245     // huge file support (or at least not all functions needed for it by wx)
 246     // currently
 247
 248     // types
 249
 250     #ifdef wxHAS_HUGE_FILES
 251         typedef wxLongLong_t wxFileOffset;
 252         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
 253     #else
 254         typedef off_t wxFileOffset;
 255     #endif
 256
 257     // at least Borland 5.5 doesn't like "struct ::stat" so don't use the scope
 258     // resolution operator present in wxPOSIX_IDENT for it
 259     #ifdef __BORLANDC__
 260         #define wxPOSIX_STRUCT(s)    struct s
 261     #else
 262         #define wxPOSIX_STRUCT(s)    struct wxPOSIX_IDENT(s)
 263     #endif
 264
 265     // Notice that Watcom is the only compiler to have a wide char
 266     // version of struct stat as well as a wide char stat function variant.
 267     // This was dropped since OW 1.4 "for consistency across platforms".
 268     //
 269     // Borland is also special in that it uses _stat with Unicode functions
 270     // (for MSVC compatibility?) but stat with ANSI ones
 271     #ifdef __BORLANDC__
 272         #if wxHAS_HUGE_FILES
 273             #define wxStructStat struct stati64
 274         #else
 275             #if wxUSE_UNICODE
 276                 #define wxStructStat struct _stat
 277             #else
 278                 #define wxStructStat struct stat
 279             #endif
 280         #endif
 281     #else // !__BORLANDC__
 282         #ifdef wxHAS_HUGE_FILES
 283             #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
 284                 #define wxStructStat struct _wstati64
 285             #else
 286                 #define wxStructStat struct _stati64
 287             #endif
 288         #else
 289             #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
 290                 #define wxStructStat struct _wstat
 291             #else
 292                 #define wxStructStat struct _stat
 293             #endif
 294         #endif
 295     #endif // __BORLANDC__/!__BORLANDC__
 296
 297
 298     // functions
 299
 300     // MSVC and compatible compilers prepend underscores to the POSIX function
 301     // names, other compilers don't and even if their later versions usually do
 302     // define the versions with underscores for MSVC compatibility, it's better
 303     // to avoid using them as they're not present in earlier versions and
 304     // always using the native functions spelling is easier than testing for
 305     // the versions
 306     #if defined(__BORLANDC__) || defined(__DMC__) || defined(__WATCOMC__) || defined(__MINGW64__)
 307         #define wxPOSIX_IDENT(func)    ::func
 308     #else // by default assume MSVC-compatible names
 309         #define wxPOSIX_IDENT(func)    _ ## func
 310         #define wxHAS_UNDERSCORES_IN_POSIX_IDENTS
 311     #endif
 312
 313     // first functions not working with strings, i.e. without ANSI/Unicode
 314     // complications
 315     #define   wxClose      wxPOSIX_IDENT(close)
 316
 317     #if defined(__MWERKS__)
 318         #if __MSL__ >= 0x6000
 319             #define wxRead(fd, buf, nCount)  _read(fd, (void *)buf, nCount)
 320             #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)
 321         #else
 322             #define wxRead(fd, buf, nCount)\
 323                   _read(fd, (const char *)buf, nCount)
 324             #define wxWrite(fd, buf, nCount)\
 325                   _write(fd, (const char *)buf, nCount)
 326         #endif
 327     #else // __MWERKS__
 328         #define wxRead         wxPOSIX_IDENT(read)
 329         #define wxWrite        wxPOSIX_IDENT(write)
 330     #endif
 331
 332     #ifdef wxHAS_HUGE_FILES
 333         #ifndef __MINGW64__
 334             #define   wxSeek       wxPOSIX_IDENT(lseeki64)
 335             #define   wxLseek      wxPOSIX_IDENT(lseeki64)
 336             #define   wxTell       wxPOSIX_IDENT(telli64)
 337         #else
 338             // unfortunately, mingw-W64 is somewhat inconsistent...
 339             #define   wxSeek       _lseeki64
 340             #define   wxLseek      _lseeki64
 341             #define   wxTell       _telli64
 342         #endif
 343     #else // !wxHAS_HUGE_FILES
 344         #define   wxSeek       wxPOSIX_IDENT(lseek)
 345         #define   wxLseek      wxPOSIX_IDENT(lseek)
 346         #define   wxTell       wxPOSIX_IDENT(tell)
 347     #endif // wxHAS_HUGE_FILES/!wxHAS_HUGE_FILES
 348
 349     #ifndef __WATCOMC__
 350          #if !defined(__BORLANDC__) || (__BORLANDC__ > 0x540)
 351              // NB: this one is not POSIX and always has the underscore
 352              #define   wxFsync      _commit
 353
 354              // could be already defined by configure (Cygwin)
 355              #ifndef HAVE_FSYNC
 356                  #define HAVE_FSYNC
 357              #endif
 358         #endif // BORLANDC
 359     #endif
 360
 361     #define   wxEof        wxPOSIX_IDENT(eof)
 362
 363     // then the functions taking strings
 364
 365     // first the ANSI versions
 366     #define   wxCRT_OpenA       wxPOSIX_IDENT(open)
 367     #define   wxCRT_AccessA     wxPOSIX_IDENT(access)
 368     #define   wxCRT_MkDirA      wxPOSIX_IDENT(mkdir)
 369     #define   wxCRT_RmDirA      wxPOSIX_IDENT(rmdir)
 370     #ifdef wxHAS_HUGE_FILES
 371         // MinGW-64 provides underscore-less versions of all file functions
 372         // except for this one.
 373         #ifdef __MINGW64__
 374             #define   wxCRT_StatA       _stati64
 375         #else
 376             #define   wxCRT_StatA       wxPOSIX_IDENT(stati64)
 377         #endif
 378     #else
 379         // Unfortunately Watcom is not consistent
 380         #if defined(__OS2__) && defined(__WATCOMC__)
 381             #define   wxCRT_StatA       _stat
 382         #else
 383             #define   wxCRT_StatA       wxPOSIX_IDENT(stat)
 384         #endif
 385     #endif
 386
 387     // then wide char ones
 388     #if wxUSE_UNICODE
 389         // special workaround for buggy wopen() in bcc 5.5
 390         #if defined(__BORLANDC__) && \
 391             (__BORLANDC__ >= 0x550 && __BORLANDC__ <= 0x551)
 392                 WXDLLIMPEXP_BASE int wxCRT_OpenW(const wxChar *pathname,
 393                                                  int flags, mode_t mode);
 394         #else
 395             #define wxCRT_OpenW       _wopen
 396         #endif
 397
 398         #define   wxCRT_AccessW     _waccess
 399         #define   wxCRT_MkDirW      _wmkdir
 400         #define   wxCRT_RmDirW      _wrmdir
 401         #ifdef wxHAS_HUGE_FILES
 402             #define   wxCRT_StatW       _wstati64
 403         #else
 404             #define   wxCRT_StatW       _wstat
 405         #endif
 406     #endif // wxUSE_UNICODE
 407
 408
 409     // finally the default char-type versions
 410     #if wxUSE_UNICODE
 411         #if wxUSE_UNICODE_MSLU || defined(__WX_STRICT_ANSI_GCC__)
 412             // implement the missing file functions in Win9x ourselves
 413             WXDLLIMPEXP_BASE int wxMSLU__wopen(const wxChar *name,
 414                                                int flags, int mode);
 415             WXDLLIMPEXP_BASE int wxMSLU__waccess(const wxChar *name,
 416                                                  int mode);
 417             WXDLLIMPEXP_BASE int wxMSLU__wmkdir(const wxChar *name);
 418             WXDLLIMPEXP_BASE int wxMSLU__wrmdir(const wxChar *name);
 419
 420             WXDLLIMPEXP_BASE int
 421             wxMSLU__wstat(const wxChar *name, wxStructStat *buffer);
 422
 423             #define   wxCRT_Open       wxMSLU__wopen
 424
 425             #define   wxCRT_Access     wxMSLU__waccess
 426             #define   wxCRT_MkDir      wxMSLU__wmkdir
 427             #define   wxCRT_RmDir      wxMSLU__wrmdir
 428             #define   wxCRT_Stat       wxMSLU__wstat
 429         #else // !wxUSE_UNICODE_MSLU
 430             #define wxCRT_Open      wxCRT_OpenW
 431             #define wxCRT_Access    wxCRT_AccessW
 432             #define wxCRT_MkDir     wxCRT_MkDirW
 433             #define wxCRT_RmDir     wxCRT_RmDirW
 434             #define wxCRT_Stat      wxCRT_StatW
 435         #endif // wxUSE_UNICODE_MSLU/!wxUSE_UNICODE_MSLU
 436     #else // !wxUSE_UNICODE
 437         #define wxCRT_Open      wxCRT_OpenA
 438         #define wxCRT_Access    wxCRT_AccessA
 439         #define wxCRT_MkDir     wxCRT_MkDirA
 440         #define wxCRT_RmDir     wxCRT_RmDirA
 441         #define wxCRT_Stat      wxCRT_StatA
 442     #endif // wxUSE_UNICODE/!wxUSE_UNICODE
 443
 444
 445     // constants (unless already defined by the user code)
 446     #ifdef wxHAS_UNDERSCORES_IN_POSIX_IDENTS
 447         #ifndef O_RDONLY
 448             #define   O_RDONLY    _O_RDONLY
 449             #define   O_WRONLY    _O_WRONLY
 450             #define   O_RDWR      _O_RDWR
 451             #define   O_EXCL      _O_EXCL
 452             #define   O_CREAT     _O_CREAT
 453             #define   O_BINARY    _O_BINARY
 454         #endif
 455
 456         #ifndef S_IFMT
 457             #define   S_IFMT      _S_IFMT
 458             #define   S_IFDIR     _S_IFDIR
 459             #define   S_IFREG     _S_IFREG
 460         #endif
 461     #endif // wxHAS_UNDERSCORES_IN_POSIX_IDENTS
 462
 463     #ifdef wxHAS_HUGE_FILES
 464         // wxFile is present and supports large files.
 465         #if wxUSE_FILE
 466             #define wxHAS_LARGE_FILES
 467         #endif
 468         // wxFFile is present and supports large files
 469         #if wxUSE_FFILE && defined wxHAS_HUGE_STDIO_FILES
 470             #define wxHAS_LARGE_FFILES
 471         #endif
 472     #endif
 473
 474     // private defines, undefine so that nobody gets tempted to use
 475     #undef wxHAS_HUGE_FILES
 476     #undef wxHAS_HUGE_STDIO_FILES
 477 #elif defined (__WXPALMOS__)
 478     typedef off_t wxFileOffset;
 479 #ifdef _LARGE_FILES
 480     #define wxFileOffsetFmtSpec wxLongLongFmtSpec
 481     wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t), BadFileSizeType );
 482     // wxFile is present and supports large files
 483     #ifdef wxUSE_FILE
 484         #define wxHAS_LARGE_FILES
 485     #endif
 486     // wxFFile is present and supports large files
 487     #if SIZEOF_LONG == 8 || defined HAVE_FSEEKO
 488         #define wxHAS_LARGE_FFILES
 489     #endif
 490 #else
 491     #define wxFileOffsetFmtSpec wxT("")
 492 #endif
 493     #define   wxClose      close
 494     #define   wxRead       ::read
 495     #define   wxWrite      ::write
 496     #define   wxLseek      lseek
 497     #define   wxSeek       lseek
 498     #define   wxFsync      fsync
 499     #define   wxEof        eof
 500
 501     #define   wxCRT_MkDir      mkdir
 502     #define   wxCRT_RmDir      rmdir
 503
 504     #define   wxTell(fd)   lseek(fd, 0, SEEK_CUR)
 505
 506     #define   wxStructStat struct stat
 507
 508     #define   wxCRT_Open       open
 509     #define   wxCRT_Stat       svfs_stat
 510     #define   wxCRT_Lstat      lstat
 511     #define   wxCRT_Access     access
 512
 513     #define wxHAS_NATIVE_LSTAT
 514 #else // Unix or Windows using unknown compiler, assume POSIX supported
 515     typedef off_t wxFileOffset;
 516     #ifdef HAVE_LARGEFILE_SUPPORT
 517         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
 518         wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
 519                                 BadFileSizeType );
 520         // wxFile is present and supports large files
 521         #if wxUSE_FILE
 522             #define wxHAS_LARGE_FILES
 523         #endif
 524         // wxFFile is present and supports large files
 525         #if wxUSE_FFILE && (SIZEOF_LONG == 8 || defined HAVE_FSEEKO)
 526             #define wxHAS_LARGE_FFILES
 527         #endif
 528         #ifdef HAVE_FSEEKO
 529             #define wxFseek fseeko
 530             #define wxFtell ftello
 531         #endif
 532     #else
 533         #define wxFileOffsetFmtSpec wxT("")
 534     #endif
 535     // functions
 536     #define   wxClose      close
 537     #define   wxRead       ::read
 538     #define   wxWrite      ::write
 539     #define   wxLseek      lseek
 540     #define   wxSeek       lseek
 541     #define   wxFsync      fsync
 542     #define   wxEof        eof
 543
 544     #define   wxCRT_MkDir      mkdir
 545     #define   wxCRT_RmDir      rmdir
 546
 547     #define   wxTell(fd)   lseek(fd, 0, SEEK_CUR)
 548
 549     #define   wxStructStat struct stat
 550
 551     #define   wxCRT_Open       open
 552     #define   wxCRT_Stat       stat
 553     #define   wxCRT_Lstat      lstat
 554     #define   wxCRT_Access     access
 555
 556     #define wxHAS_NATIVE_LSTAT
 557 #endif // platforms
 558
 559 // if the platform doesn't have symlinks, define wxCRT_Lstat to be the same as
 560 // wxCRT_Stat to avoid #ifdefs in the code using it
 561 #ifndef wxHAS_NATIVE_LSTAT
 562     #define wxCRT_Lstat wxCRT_Stat
 563 #endif
 564
 565 // define wxFseek/wxFtell to large file versions if available (done above) or
 566 // to fseek/ftell if not, to save ifdefs in using code
 567 #ifndef wxFseek
 568     #define wxFseek fseek
 569 #endif
 570 #ifndef wxFtell
 571     #define wxFtell ftell
 572 #endif
 573
 574 inline int wxAccess(const wxString& path, mode_t mode)
 575     { return wxCRT_Access(path.fn_str(), mode); }
 576 inline int wxOpen(const wxString& path, int flags, mode_t mode)
 577     { return wxCRT_Open(path.fn_str(), flags, mode); }
 578
 579 // FIXME-CE: provide our own implementations of the missing CRT functions
 580 #ifndef __WXWINCE__
 581 inline int wxStat(const wxString& path, wxStructStat *buf)
 582     { return wxCRT_Stat(path.fn_str(), buf); }
 583 inline int wxLstat(const wxString& path, wxStructStat *buf)
 584     { return wxCRT_Lstat(path.fn_str(), buf); }
 585 inline int wxRmDir(const wxString& path)
 586     { return wxCRT_RmDir(path.fn_str()); }
 587 #if (defined(__WINDOWS__) && !defined(__CYGWIN__)) \
 588         || (defined(__OS2__) && defined(__WATCOMC__))
 589 inline int wxMkDir(const wxString& path, mode_t WXUNUSED(mode) = 0)
 590     { return wxCRT_MkDir(path.fn_str()); }
 591 #else
 592 inline int wxMkDir(const wxString& path, mode_t mode)
 593     { return wxCRT_MkDir(path.fn_str(), mode); }
 594 #endif
 595 #endif // !__WXWINCE__
 596
 597 #ifdef O_BINARY
 598     #define wxO_BINARY O_BINARY
 599 #else
 600     #define wxO_BINARY 0
 601 #endif
 602
 603 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
 604 //
 605 // VisualAge C++ V4.0 cannot have any external linkage const decs
 606 // in headers included by more than one primary source
 607 //
 608 extern const int wxInvalidOffset;
 609 #else
 610 const int wxInvalidOffset = -1;
 611 #endif
 612
 613 // ----------------------------------------------------------------------------
 614 // functions
 615 // ----------------------------------------------------------------------------
 616 WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
 617
 618 // does the path exist? (may have or not '/' or '\\' at the end)
 619 WXDLLIMPEXP_BASE bool wxDirExists(const wxString& pathName);
 620
 621 WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
 622
 623 // Get filename
 624 WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
 625 WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);
 626
 627 // Get directory
 628 WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);
 629
 630 // all deprecated functions below are deprecated in favour of wxFileName's methods
 631 #if WXWIN_COMPATIBILITY_2_8
 632
 633 wxDEPRECATED( WXDLLIMPEXP_BASE void wxDos2UnixFilename(char *s) );
 634 wxDEPRECATED( WXDLLIMPEXP_BASE void wxDos2UnixFilename(wchar_t *s) );
 635
 636 wxDEPRECATED_BUT_USED_INTERNALLY(
 637     WXDLLIMPEXP_BASE void wxUnix2DosFilename(char *s) );
 638 wxDEPRECATED_BUT_USED_INTERNALLY(
 639     WXDLLIMPEXP_BASE void wxUnix2DosFilename(wchar_t *s) );
 640
 641 // Strip the extension, in situ
 642 // Deprecated in favour of wxFileName::StripExtension() but notice that their
 643 // behaviour is slightly different, see the manual
 644 wxDEPRECATED( WXDLLIMPEXP_BASE void wxStripExtension(char *buffer) );
 645 wxDEPRECATED( WXDLLIMPEXP_BASE void wxStripExtension(wchar_t *buffer) );
 646 wxDEPRECATED( WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer) );
 647
 648 // Get a temporary filename
 649 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = NULL) );
 650 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf) );
 651
 652 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
 653 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE char* wxExpandPath(char *dest, const wxString& path) );
 654 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wchar_t* wxExpandPath(wchar_t *dest, const wxString& path) );
 655     // DEPRECATED: use wxFileName::Normalize(wxPATH_NORM_ENV_VARS)
 656
 657 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
 658 // and make (if under the home tree) relative to home
 659 // [caller must copy-- volatile]
 660 wxDEPRECATED(
 661 WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
 662                                    const wxString& envname = wxEmptyString,
 663                                    const wxString& user = wxEmptyString) );
 664     // DEPRECATED: use wxFileName::ReplaceEnvVariable and wxFileName::ReplaceHomeDir
 665
 666 // Destructive removal of /./ and /../ stuff
 667 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE char* wxRealPath(char *path) );
 668 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wchar_t* wxRealPath(wchar_t *path) );
 669 wxDEPRECATED_BUT_USED_INTERNALLY( WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path) );
 670     // DEPRECATED: use wxFileName::Normalize instead
 671
 672 // Allocate a copy of the full absolute path
 673 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path) );
 674     // DEPRECATED: use wxFileName::MakeAbsolute instead
 675 #endif
 676
 677 // Get first file name matching given wild card.
 678 // Flags are reserved for future use.
 679 #define wxFILE  1
 680 #define wxDIR   2
 681 WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxString& spec, int flags = wxFILE);
 682 WXDLLIMPEXP_BASE wxString wxFindNextFile();
 683
 684 // Does the pattern contain wildcards?
 685 WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);
 686
 687 // Does the pattern match the text (usually a filename)?
 688 // If dot_special is true, doesn't match * against . (eliminating
 689 // `hidden' dot files)
 690 WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = true);
 691
 692 // Concatenate two files to form third
 693 WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
 694
 695 // Copy file1 to file2
 696 WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
 697                                  bool overwrite = true);
 698
 699 // Remove file
 700 WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
 701
 702 // Rename file
 703 WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2, bool overwrite = true);
 704
 705 // Get current working directory.
 706 #if WXWIN_COMPATIBILITY_2_6
 707 // If buf is NULL, allocates space using new, else
 708 // copies into buf.
 709 // IMPORTANT NOTE getcwd is know not to work under some releases
 710 // of Win32s 1.3, according to MS release notes!
 711 wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = NULL, int sz = 1000) );
 712 // new and preferred version of wxGetWorkingDirectory
 713 // NB: can't have the same name because of overloading ambiguity
 714 #endif // WXWIN_COMPATIBILITY_2_6
 715 WXDLLIMPEXP_BASE wxString wxGetCwd();
 716
 717 // Set working directory
 718 WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);
 719
 720 // Make directory
 721 WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = wxS_DIR_DEFAULT);
 722
 723 // Remove directory. Flags reserved for future use.
 724 WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
 725
 726 // Return the type of an open file
 727 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd);
 728 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(FILE *fp);
 729
 730 #if WXWIN_COMPATIBILITY_2_6
 731 // compatibility defines, don't use in new code
 732 wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) );
 733 inline bool wxPathExists(const wxChar *pszPathName)
 734 {
 735     return wxDirExists(pszPathName);
 736 }
 737 #endif //WXWIN_COMPATIBILITY_2_6
 738
 739 // permissions; these functions work both on files and directories:
 740 WXDLLIMPEXP_BASE bool wxIsWritable(const wxString &path);
 741 WXDLLIMPEXP_BASE bool wxIsReadable(const wxString &path);
 742 WXDLLIMPEXP_BASE bool wxIsExecutable(const wxString &path);
 743
 744 // ----------------------------------------------------------------------------
 745 // separators in file names
 746 // ----------------------------------------------------------------------------
 747
 748 // between file name and extension
 749 #define wxFILE_SEP_EXT        wxT('.')
 750
 751 // between drive/volume name and the path
 752 #define wxFILE_SEP_DSK        wxT(':')
 753
 754 // between the path components
 755 #define wxFILE_SEP_PATH_DOS   wxT('\\')
 756 #define wxFILE_SEP_PATH_UNIX  wxT('/')
 757 #define wxFILE_SEP_PATH_MAC   wxT(':')
 758 #define wxFILE_SEP_PATH_VMS   wxT('.') // VMS also uses '[' and ']'
 759
 760 // separator in the path list (as in PATH environment variable)
 761 // there is no PATH variable in Classic Mac OS so just use the
 762 // semicolon (it must be different from the file name separator)
 763 // NB: these are strings and not characters on purpose!
 764 #define wxPATH_SEP_DOS        wxT(";")
 765 #define wxPATH_SEP_UNIX       wxT(":")
 766 #define wxPATH_SEP_MAC        wxT(";")
 767
 768 // platform independent versions
 769 #if defined(__UNIX__) && !defined(__OS2__)
 770   // CYGWIN also uses UNIX settings
 771   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
 772   #define wxPATH_SEP          wxPATH_SEP_UNIX
 773 #elif defined(__WXPALMOS__)
 774   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
 775   #define wxPATH_SEP          wxPATH_SEP_UNIX
 776 #elif defined(__MAC__)
 777   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_MAC
 778   #define wxPATH_SEP          wxPATH_SEP_MAC
 779 #else   // Windows and OS/2
 780   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
 781   #define wxPATH_SEP          wxPATH_SEP_DOS
 782 #endif  // Unix/Windows
 783
 784 // this is useful for wxString::IsSameAs(): to compare two file names use
 785 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
 786 #if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
 787   #define wxARE_FILENAMES_CASE_SENSITIVE  true
 788 #else   // Windows, Mac OS and OS/2
 789   #define wxARE_FILENAMES_CASE_SENSITIVE  false
 790 #endif  // Unix/Windows
 791
 792 // is the char a path separator?
 793 inline bool wxIsPathSeparator(wxChar c)
 794 {
 795     // under DOS/Windows we should understand both Unix and DOS file separators
 796 #if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
 797     return c == wxFILE_SEP_PATH;
 798 #else
 799     return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
 800 #endif
 801 }
 802
 803 // does the string ends with path separator?
 804 WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxString& filename);
 805
 806 #if WXWIN_COMPATIBILITY_2_8
 807 // split the full path into path (including drive for DOS), name and extension
 808 // (understands both '/' and '\\')
 809 // Deprecated in favour of wxFileName::SplitPath
 810 wxDEPRECATED( WXDLLIMPEXP_BASE void wxSplitPath(const wxString& fileName,
 811                                                 wxString *pstrPath,
 812                                                 wxString *pstrName,
 813                                                 wxString *pstrExt) );
 814 #endif
 815
 816 // find a file in a list of directories, returns false if not found
 817 WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxString& szPath, const wxString& szFile);
 818
 819 // Get the OS directory if appropriate (such as the Windows directory).
 820 // On non-Windows platform, probably just return the empty string.
 821 WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
 822
 823 #if wxUSE_DATETIME
 824
 825 // Get file modification time
 826 WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename);
 827
 828 #endif // wxUSE_DATETIME
 829
 830 // Parses the wildCard, returning the number of filters.
 831 // Returns 0 if none or if there's a problem,
 832 // The arrays will contain an equal number of items found before the error.
 833 // wildCard is in the form:
 834 // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
 835 WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters);
 836
 837 // ----------------------------------------------------------------------------
 838 // classes
 839 // ----------------------------------------------------------------------------
 840
 841 #ifdef __UNIX__
 842
 843 // set umask to the given value in ctor and reset it to the old one in dtor
 844 class WXDLLIMPEXP_BASE wxUmaskChanger
 845 {
 846 public:
 847     // change the umask to the given one if it is not -1: this allows to write
 848     // the same code whether you really want to change umask or not, as is in
 849     // wxFileConfig::Flush() for example
 850     wxUmaskChanger(int umaskNew)
 851     {
 852         m_umaskOld = umaskNew == -1 ? -1 : (int)umask((mode_t)umaskNew);
 853     }
 854
 855     ~wxUmaskChanger()
 856     {
 857         if ( m_umaskOld != -1 )
 858             umask((mode_t)m_umaskOld);
 859     }
 860
 861 private:
 862     int m_umaskOld;
 863 };
 864
 865 // this macro expands to an "anonymous" wxUmaskChanger object under Unix and
 866 // nothing elsewhere
 867 #define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
 868
 869 #else // !__UNIX__
 870
 871 #define wxCHANGE_UMASK(m)
 872
 873 #endif // __UNIX__/!__UNIX__
 874
 875
 876 // Path searching
 877 class WXDLLIMPEXP_BASE wxPathList : public wxArrayString
 878 {
 879 public:
 880     wxPathList() {}
 881     wxPathList(const wxArrayString &arr)
 882         { Add(arr); }
 883
 884     // Adds all paths in environment variable
 885     void AddEnvList(const wxString& envVariable);
 886
 887     // Adds given path to this list
 888     bool Add(const wxString& path);
 889     void Add(const wxArrayString &paths);
 890
 891     // Find the first full path for which the file exists
 892     wxString FindValidPath(const wxString& filename) const;
 893
 894     // Find the first full path for which the file exists; ensure it's an
 895     // absolute path that gets returned.
 896     wxString FindAbsoluteValidPath(const wxString& filename) const;
 897
 898     // Given full path and filename, add path to list
 899     bool EnsureFileAccessible(const wxString& path);
 900
 901 #if WXWIN_COMPATIBILITY_2_6
 902     // Returns true if the path is in the list
 903     wxDEPRECATED( bool Member(const wxString& path) const );
 904 #endif
 905 };
 906
 907 #endif // _WX_FILEFN_H_