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