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