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