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