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