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