include/wx/filefn.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "filefn.h"
  17 #endif
  18
  19 #include "wx/list.h"
  20 #include "wx/arrstr.h"
  21
  22 #ifdef __WXWINCE__
  23     #include "wx/msw/wince/time.h"
  24     #include "wx/msw/private.h"
  25 #else
  26     #include <time.h>
  27 #endif
  28
  29 #ifdef __WXWINCE__
  30 // Nothing
  31 #elif !defined(__MWERKS__)
  32     #include <sys/types.h>
  33     #include <sys/stat.h>
  34 #else
  35     #ifdef __MACH__
  36         #include <sys/types.h>
  37         #include <utime.h>
  38         #include <sys/stat.h>
  39         #include <unistd.h>
  40     #else
  41         #include <stat.h>
  42         #include <unistd.h>
  43         #include <unix.h>
  44     #endif
  45 #endif
  46
  47 #ifdef __OS2__
  48 // need to check for __OS2__ first since currently both
  49 // __OS2__ and __UNIX__ are defined.
  50     #include <process.h>
  51     #include "wx/os2/private.h"
  52     #include <io.h>
  53     #ifdef __EMX__
  54         #include <unistd.h>
  55     #endif
  56 #elif defined(__UNIX__)
  57     #include <unistd.h>
  58     #include <dirent.h>
  59 #endif
  60
  61 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
  62 #if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__SALFORDC__) && !defined(__WXWINCE__)
  63     #include <direct.h>
  64     #include <dos.h>
  65     #include <io.h>
  66 #endif // __WINDOWS__
  67 #endif // native Win compiler
  68
  69 #if defined(__DOS__)
  70     #ifdef __WATCOMC__
  71         #include <direct.h>
  72         #include <dos.h>
  73         #include <io.h>
  74     #endif
  75     #ifdef __DJGPP__
  76         #include <io.h>
  77         #include <unistd.h>
  78     #endif
  79 #endif
  80
  81 #ifdef __BORLANDC__ // Please someone tell me which version of Borland needs
  82                     // this (3.1 I believe) and how to test for it.
  83                     // If this works for Borland 4.0 as well, then no worries.
  84     #include <dir.h>
  85 #endif
  86
  87 #ifdef __SALFORDC__
  88     #include <dir.h>
  89     #include <unix.h>
  90 #endif
  91
  92 #ifndef __WXWINCE__
  93     #include  <fcntl.h>       // O_RDONLY &c
  94 #endif
  95 // ----------------------------------------------------------------------------
  96 // constants
  97 // ----------------------------------------------------------------------------
  98
  99 #ifdef __WXWINCE__
 100     typedef long off_t;
 101 #else
 102     // define off_t
 103     #if !defined(__WXMAC__) || defined(__UNIX__) || defined(__MACH__)
 104         #include  <sys/types.h>
 105     #else
 106         typedef long off_t;
 107     #endif
 108 #endif
 109
 110 #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined( __INTEL__) )
 111     typedef _off_t off_t;
 112 #elif defined(__SYMANTEC__)
 113     typedef long off_t;
 114 #elif defined(__MWERKS__) && !defined(__INTEL__) && !defined(__MACH__)
 115     typedef long off_t;
 116 #endif
 117
 118 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
 119 //
 120 // VisualAge C++ V4.0 cannot have any external linkage const decs
 121 // in headers included by more than one primary source
 122 //
 123 extern const off_t wxInvalidOffset;
 124 #else
 125 const off_t wxInvalidOffset = (off_t)-1;
 126 #endif
 127
 128 enum wxSeekMode
 129 {
 130   wxFromStart,
 131   wxFromCurrent,
 132   wxFromEnd
 133 };
 134
 135 // ----------------------------------------------------------------------------
 136 // declare our versions of low level file functions: some compilers prepend
 137 // underscores to the usual names, some also have Unicode versions of them
 138 // ----------------------------------------------------------------------------
 139
 140 // Wrappers around Win32 api functions like CreateFile, ReadFile and such
 141 // Implemented in filefnwce.cpp
 142 #if defined( __WINCE__)
 143     typedef __int64 wxFileOffset;
 144     #define wxFileOffsetFmtSpec _("I64")
 145     int wxOpen(const wxChar *filename, int oflag, int WXUNUSED(pmode));
 146     int wxAccess(const wxChar *name, int WXUNUSED(how));
 147     int wxClose(int fd);
 148     int wxFsync(int WXUNUSED(fd));
 149     int wxRead(int fd, void *buf, unsigned int count);
 150     int wxWrite(int fd, const void *buf, unsigned int count);
 151     int wxEof(int fd);
 152     wxFileOffset wxSeek(int fd, wxFileOffset offset, int origin);
 153     #define wxLSeek wxSeek
 154     wxFileOffset wxTell(int fd);
 155
 156     #if wxUSE_UNICODE
 157         #if wxUSE_UNICODE_MSLU
 158             #define   wxMkDir      wxMSLU__wmkdir
 159             #define   wxRmDir      wxMSLU__wrmdir
 160             #define   wxStat       wxMSLU__wstat
 161         #else
 162             #define   wxMkDir      _wmkdir
 163             #define   wxRmDir      _wrmdir
 164             #define   wxStat       _wstat
 165         #endif
 166     #else // !wxUSE_UNICODE
 167         #define   wxMkDir      _mkdir
 168         #ifdef __WATCOMC__
 169             #define   wxRmDir      rmdir
 170         #else
 171             #define   wxRmDir      _rmdir
 172         #endif
 173         #define   wxStat       _stat
 174     #endif
 175     #define   wxStructStat struct _stat
 176
 177 // Microsoft compiler loves underscores, feed them to it
 178 #elif defined( __VISUALC__ ) \
 179     || ( defined(__MINGW32__) && !defined(__WINE__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
 180     || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
 181     || ( defined(__DMC__) && defined(__WXMSW__) ) \
 182     || ( defined(__WATCOMC__) && defined(__WXMSW__) )
 183
 184     // Not all of the Win32 compilers do have huge file support, for example
 185     // the Digitalmars compiler does not have huge file size support
 186     #include "wx/msw/private.h"
 187
 188     #undef __HUGEFILES_SUPPORTED
 189     #if _INTEGRAL_MAX_BITS >= 64 && !defined(__DMC__)
 190         #define __HUGEFILES_SUPPORTED 1
 191     #else
 192         #define __HUGEFILES_SUPPORTED 0
 193     #endif
 194
 195     // functions
 196     #if defined(__BORLANDC__) || defined(__WATCOMC__)
 197         #define   _tell        tell
 198     #endif
 199
 200     #if __HUGEFILES_SUPPORTED
 201         typedef wxLongLong_t wxFileOffset;
 202         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
 203     #else
 204         typedef off_t wxFileOffset;
 205         #define wxFileOffsetFmtSpec _("")
 206     #endif
 207
 208     #define   wxClose      _close
 209
 210     #if defined(__MWERKS__)
 211         #if __MSL__ >= 0x6000
 212             #define wxRead        _read(fd, (void *)buf, nCount)
 213             #define wxWrite        _write(fd, (void *)buf, nCount)
 214         #else
 215             #define wxRead        _read(fd, (const char *)buf, nCount)
 216             #define wxWrite        _write(fd, (const char *)buf, nCount)
 217         #endif
 218     #else
 219         #ifdef __DMC__
 220             #define wxRead        ::read
 221             #define wxWrite       ::write
 222         #else
 223             #define wxRead        _read
 224             #define wxWrite        _write
 225         #endif
 226     #endif
 227     #if __HUGEFILES_SUPPORTED
 228         #define   wxSeek      _lseeki64
 229         #define   wxLseek      _lseeki64
 230         #define   wxTell       _telli64
 231     #else
 232         #define   wxSeek      _lseek
 233         #define   wxLseek      _lseek
 234         #define   wxTell       _tell
 235     #endif
 236     #define   wxFsync      _commit
 237     #define   wxEof        _eof
 238
 239     #if wxUSE_UNICODE
 240         #if wxUSE_UNICODE_MSLU
 241             #define   wxOpen       wxMSLU__wopen
 242
 243             #define   wxAccess     wxMSLU__waccess
 244             #define   wxMkDir      wxMSLU__wmkdir
 245             #define   wxRmDir      wxMSLU__wrmdir
 246             #if __HUGEFILES_SUPPORTED
 247                 #define   wxStat       wxMSLU__wstati64
 248             #else
 249                 #define   wxStat       wxMSLU__wstat
 250             #endif
 251         #else
 252             #define   wxOpen       _wopen
 253             #define   wxAccess     _waccess
 254             #define   wxMkDir      _wmkdir
 255             #define   wxRmDir      _wrmdir
 256             #if __HUGEFILES_SUPPORTED
 257                 #define   wxStat       _wstati64
 258             #else
 259                 #define   wxStat       _wstat
 260             #endif
 261         #endif
 262     #else // !wxUSE_UNICODE
 263         #ifdef __BORLANDC__
 264             #define   wxOpen       open
 265         #else
 266             #define   wxOpen       _open
 267         #endif
 268         #define   wxAccess     _access
 269         #define   wxMkDir      _mkdir
 270         #ifdef __WATCOMC__
 271             #define   wxRmDir      rmdir
 272         #else
 273             #define   wxRmDir      _rmdir
 274         #endif
 275         #if __HUGEFILES_SUPPORTED
 276             #define   wxStat       _stati64
 277         #else
 278             #define   wxStat       _stat
 279         #endif
 280     #endif
 281
 282     // types: notice that Watcom is the only compiler to have a wide char
 283     // version of struct stat as well as a wide char stat function variant
 284     #if __HUGEFILES_SUPPORTED
 285         #if wxUSE_UNICODE && defined(__WATCOMC__)
 286             #define   wxStructStat struct _wstati64
 287         #else
 288             #define   wxStructStat struct _stati64
 289         #endif
 290     #else
 291         #if wxUSE_UNICODE && defined(__WATCOMC__)
 292             #define   wxStructStat struct _wstat
 293         #else
 294             #define   wxStructStat struct _stat
 295         #endif
 296     #endif
 297
 298     // constants (unless already defined by the user code)
 299     #if !defined(O_RDONLY) && !defined(__BORLANDC__) && !defined(__WATCOMC__)
 300         #define   O_RDONLY    _O_RDONLY
 301         #define   O_WRONLY    _O_WRONLY
 302         #define   O_RDWR      _O_RDWR
 303         #define   O_EXCL      _O_EXCL
 304         #define   O_CREAT     _O_CREAT
 305         #define   O_BINARY    _O_BINARY
 306     #endif
 307
 308     #if !defined(__BORLANDC__) && !defined(__WATCOMC__)
 309         #define   S_IFMT      _S_IFMT
 310         #define   S_IFDIR     _S_IFDIR
 311         #define   S_IFREG     _S_IFREG
 312     #endif // O_RDONLY
 313
 314     // It's a private define, undefine it so nobody gets tempted to use it
 315     #undef __HUGEFILES_SUPPORTED
 316 #else
 317     typedef off_t wxFileOffset;
 318     #ifdef _LARGE_FILES
 319         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
 320     #else
 321         #define wxFileOffsetFmtSpec _T("")
 322     #endif
 323     // functions
 324     #define   wxClose      close
 325     #define   wxRead       ::read
 326     #define   wxWrite      ::write
 327     #define   wxLseek      lseek
 328     #define   wxSeek       lseek
 329     #define   wxFsync      commit
 330     #define   wxEof        eof
 331
 332     #define   wxMkDir      mkdir
 333     #define   wxRmDir      rmdir
 334
 335     #define   wxTell(fd)   lseek(fd, 0, SEEK_CUR)
 336
 337     #define   wxStructStat struct stat
 338
 339     #if wxUSE_UNICODE
 340         #define wxNEED_WX_UNISTD_H
 341         #if defined(__DMC__)
 342             typedef unsigned long mode_t;
 343         #endif
 344         WXDLLIMPEXP_BASE int wxStat( const wxChar *file_name, wxStructStat *buf );
 345         WXDLLIMPEXP_BASE int wxAccess( const wxChar *pathname, int mode );
 346         WXDLLIMPEXP_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode );
 347     #else
 348         #define   wxOpen       open
 349         #define   wxStat       stat
 350         #define   wxAccess     access
 351     #endif
 352
 353 #endif  // VC++
 354
 355 // ----------------------------------------------------------------------------
 356 // functions
 357 // ----------------------------------------------------------------------------
 358 WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
 359
 360 // does the path exist? (may have or not '/' or '\\' at the end)
 361 WXDLLIMPEXP_BASE bool wxPathExists(const wxChar *pszPathName);
 362
 363 WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
 364
 365 // Get filename
 366 WXDLLIMPEXP_BASE wxChar* wxFileNameFromPath(wxChar *path);
 367 WXDLLIMPEXP_BASE wxString wxFileNameFromPath(const wxString& path);
 368
 369 // Get directory
 370 WXDLLIMPEXP_BASE wxString wxPathOnly(const wxString& path);
 371
 372 // wxString version
 373 WXDLLIMPEXP_BASE wxString wxRealPath(const wxString& path);
 374
 375 WXDLLIMPEXP_BASE void wxDos2UnixFilename(wxChar *s);
 376
 377 WXDLLIMPEXP_BASE void wxUnix2DosFilename(wxChar *s);
 378
 379 // Strip the extension, in situ
 380 WXDLLIMPEXP_BASE void wxStripExtension(wxChar *buffer);
 381 WXDLLIMPEXP_BASE void wxStripExtension(wxString& buffer);
 382
 383 // Get a temporary filename
 384 WXDLLIMPEXP_BASE wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
 385 WXDLLIMPEXP_BASE bool wxGetTempFileName(const wxString& prefix, wxString& buf);
 386
 387 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
 388 WXDLLIMPEXP_BASE wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
 389 WXDLLIMPEXP_BASE bool wxExpandPath(wxString& dest, const wxChar *path);
 390
 391 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
 392 // and make (if under the home tree) relative to home
 393 // [caller must copy-- volatile]
 394 WXDLLIMPEXP_BASE wxChar* wxContractPath(const wxString& filename,
 395                                    const wxString& envname = wxEmptyString,
 396                                    const wxString& user = wxEmptyString);
 397
 398 // Destructive removal of /./ and /../ stuff
 399 WXDLLIMPEXP_BASE wxChar* wxRealPath(wxChar *path);
 400
 401 // Allocate a copy of the full absolute path
 402 WXDLLIMPEXP_BASE wxChar* wxCopyAbsolutePath(const wxString& path);
 403
 404 // Get first file name matching given wild card.
 405 // Flags are reserved for future use.
 406 #define wxFILE  1
 407 #define wxDIR   2
 408 WXDLLIMPEXP_BASE wxString wxFindFirstFile(const wxChar *spec, int flags = wxFILE);
 409 WXDLLIMPEXP_BASE wxString wxFindNextFile();
 410
 411 // Does the pattern contain wildcards?
 412 WXDLLIMPEXP_BASE bool wxIsWild(const wxString& pattern);
 413
 414 // Does the pattern match the text (usually a filename)?
 415 // If dot_special is true, doesn't match * against . (eliminating
 416 // `hidden' dot files)
 417 WXDLLIMPEXP_BASE bool wxMatchWild(const wxString& pattern,  const wxString& text, bool dot_special = true);
 418
 419 // Concatenate two files to form third
 420 WXDLLIMPEXP_BASE bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
 421
 422 // Copy file1 to file2
 423 WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
 424                                  bool overwrite = true);
 425
 426 // Remove file
 427 WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
 428
 429 // Rename file
 430 WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2);
 431
 432 // Get current working directory.
 433 // If buf is NULL, allocates space using new, else
 434 // copies into buf.
 435 // IMPORTANT NOTE getcwd is know not to work under some releases
 436 // of Win32s 1.3, according to MS release notes!
 437 WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
 438 // new and preferred version of wxGetWorkingDirectory
 439 // NB: can't have the same name because of overloading ambiguity
 440 WXDLLIMPEXP_BASE wxString wxGetCwd();
 441
 442 // Set working directory
 443 WXDLLIMPEXP_BASE bool wxSetWorkingDirectory(const wxString& d);
 444
 445 // Make directory
 446 WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777);
 447
 448 // Remove directory. Flags reserved for future use.
 449 WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
 450
 451 // compatibility defines, don't use in new code
 452 #define wxDirExists wxPathExists
 453
 454 // ----------------------------------------------------------------------------
 455 // separators in file names
 456 // ----------------------------------------------------------------------------
 457
 458 // between file name and extension
 459 #define wxFILE_SEP_EXT        wxT('.')
 460
 461 // between drive/volume name and the path
 462 #define wxFILE_SEP_DSK        wxT(':')
 463
 464 // between the path components
 465 #define wxFILE_SEP_PATH_DOS   wxT('\\')
 466 #define wxFILE_SEP_PATH_UNIX  wxT('/')
 467 #define wxFILE_SEP_PATH_MAC   wxT(':')
 468 #define wxFILE_SEP_PATH_VMS   wxT('.') // VMS also uses '[' and ']'
 469
 470 // separator in the path list (as in PATH environment variable)
 471 // there is no PATH variable in Classic Mac OS so just use the
 472 // semicolon (it must be different from the file name separator)
 473 // NB: these are strings and not characters on purpose!
 474 #define wxPATH_SEP_DOS        wxT(";")
 475 #define wxPATH_SEP_UNIX       wxT(":")
 476 #define wxPATH_SEP_MAC        wxT(";")
 477
 478 // platform independent versions
 479 #if defined(__UNIX__) && !defined(__OS2__)
 480   // CYGWIN also uses UNIX settings
 481   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
 482   #define wxPATH_SEP          wxPATH_SEP_UNIX
 483 #elif defined(__MAC__)
 484   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_MAC
 485   #define wxPATH_SEP          wxPATH_SEP_MAC
 486 #else   // Windows and OS/2
 487   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
 488   #define wxPATH_SEP          wxPATH_SEP_DOS
 489 #endif  // Unix/Windows
 490
 491 // this is useful for wxString::IsSameAs(): to compare two file names use
 492 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
 493 #if defined(__UNIX__) && !defined(__DARWIN__) && !defined(__OS2__)
 494   #define wxARE_FILENAMES_CASE_SENSITIVE  true
 495 #else   // Windows, Mac OS and OS/2
 496   #define wxARE_FILENAMES_CASE_SENSITIVE  false
 497 #endif  // Unix/Windows
 498
 499 // is the char a path separator?
 500 inline bool wxIsPathSeparator(wxChar c)
 501 {
 502     // under DOS/Windows we should understand both Unix and DOS file separators
 503 #if ( defined(__UNIX__) && !defined(__OS2__) )|| defined(__MAC__)
 504     return c == wxFILE_SEP_PATH;
 505 #else
 506     return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
 507 #endif
 508 }
 509
 510 // does the string ends with path separator?
 511 WXDLLIMPEXP_BASE bool wxEndsWithPathSeparator(const wxChar *pszFileName);
 512
 513 // split the full path into path (including drive for DOS), name and extension
 514 // (understands both '/' and '\\')
 515 WXDLLIMPEXP_BASE void wxSplitPath(const wxChar *pszFileName,
 516                              wxString *pstrPath,
 517                              wxString *pstrName,
 518                              wxString *pstrExt);
 519
 520 // find a file in a list of directories, returns false if not found
 521 WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const wxChar *pszFile);
 522
 523 // Get the OS directory if appropriate (such as the Windows directory).
 524 // On non-Windows platform, probably just return the empty string.
 525 WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
 526
 527 // Get file modification time
 528 WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename);
 529
 530 // Parses the wildCard, returning the number of filters.
 531 // Returns 0 if none or if there's a problem,
 532 // The arrays will contain an equal number of items found before the error.
 533 // wildCard is in the form:
 534 // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
 535 WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters);
 536
 537 // ----------------------------------------------------------------------------
 538 // classes
 539 // ----------------------------------------------------------------------------
 540
 541 // Path searching
 542 class WXDLLIMPEXP_BASE wxPathList : public wxStringList
 543 {
 544 public:
 545     // avoid GCC warning about virtual functions w/o virtual dtor
 546     virtual ~wxPathList() {}
 547
 548     // Adds all paths in environment variable
 549     void AddEnvList(const wxString& envVariable);
 550
 551     void Add(const wxString& path);
 552     // Find the first full path for which the file exists
 553     wxString FindValidPath(const wxString& filename);
 554     // Find the first full path for which the file exists; ensure it's an
 555     // absolute path that gets returned.
 556     wxString FindAbsoluteValidPath(const wxString& filename);
 557     // Given full path and filename, add path to list
 558     void EnsureFileAccessible(const wxString& path);
 559     // Returns true if the path is in the list
 560     bool Member(const wxString& path);
 561
 562 private:
 563     // DECLARE_DYNAMIC_CLASS(wxPathList)
 564 };
 565
 566 #endif
 567   // _WX_FILEFN_H_