include/wx/filename.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/filename.h
   3 // Purpose:     wxFileName - encapsulates a file path
   4 // Author:      Robert Roebling, Vadim Zeitlin
   5 // Modified by:
   6 // Created:     28.12.00
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2000 Robert Roebling
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef   _WX_FILENAME_H_
  13 #define   _WX_FILENAME_H_
  14
  15 /*
  16     TODO:
  17
  18     1. support for drives under Windows
  19     2. more file operations:
  20         a) chmod()
  21         b) [acm]time() - get and set
  22         c) rename()?
  23     3. SameFileAs() function to compare inodes under Unix
  24  */
  25
  26 #include "wx/arrstr.h"
  27 #include "wx/filefn.h"
  28 #include "wx/datetime.h"
  29 #include "wx/intl.h"
  30 #include "wx/longlong.h"
  31 #include "wx/file.h"
  32
  33 #if wxUSE_FILE
  34 class WXDLLIMPEXP_FWD_BASE wxFile;
  35 #endif
  36
  37 #if wxUSE_FFILE
  38 class WXDLLIMPEXP_FWD_BASE wxFFile;
  39 #endif
  40
  41 // this symbol is defined for the platforms where file systems use volumes in
  42 // paths
  43 #if defined(__WXMSW__) || defined(__DOS__) || defined(__OS2__)
  44     #define wxHAS_FILESYSTEM_VOLUMES
  45 #endif
  46
  47 // ----------------------------------------------------------------------------
  48 // constants
  49 // ----------------------------------------------------------------------------
  50
  51 // the various values for the path format: this mainly affects the path
  52 // separator but also whether or not the path has the drive part (as under
  53 // Windows)
  54 enum wxPathFormat
  55 {
  56     wxPATH_NATIVE = 0,      // the path format for the current platform
  57     wxPATH_UNIX,
  58     wxPATH_BEOS = wxPATH_UNIX,
  59     wxPATH_MAC,
  60     wxPATH_DOS,
  61     wxPATH_WIN = wxPATH_DOS,
  62     wxPATH_OS2 = wxPATH_DOS,
  63     wxPATH_VMS,
  64
  65     wxPATH_MAX // Not a valid value for specifying path format
  66 };
  67
  68 // the kind of normalization to do with the file name: these values can be
  69 // or'd together to perform several operations at once
  70 enum wxPathNormalize
  71 {
  72     wxPATH_NORM_ENV_VARS = 0x0001,  // replace env vars with their values
  73     wxPATH_NORM_DOTS     = 0x0002,  // squeeze all .. and .
  74     wxPATH_NORM_TILDE    = 0x0004,  // Unix only: replace ~ and ~user
  75     wxPATH_NORM_CASE     = 0x0008,  // if case insensitive => tolower
  76     wxPATH_NORM_ABSOLUTE = 0x0010,  // make the path absolute
  77     wxPATH_NORM_LONG =     0x0020,  // make the path the long form
  78     wxPATH_NORM_SHORTCUT = 0x0040,  // resolve the shortcut, if it is a shortcut
  79     wxPATH_NORM_ALL      = 0x00ff & ~wxPATH_NORM_CASE
  80 };
  81
  82 // what exactly should GetPath() return?
  83 enum
  84 {
  85     wxPATH_NO_SEPARATOR  = 0x0000,  // for symmetry with wxPATH_GET_SEPARATOR
  86     wxPATH_GET_VOLUME    = 0x0001,  // include the volume if applicable
  87     wxPATH_GET_SEPARATOR = 0x0002   // terminate the path with the separator
  88 };
  89
  90 // Mkdir flags
  91 enum
  92 {
  93     wxPATH_MKDIR_FULL    = 0x0001   // create directories recursively
  94 };
  95
  96 // Rmdir flags
  97 enum
  98 {
  99     wxPATH_RMDIR_FULL       = 0x0001,  // delete with subdirectories if empty
 100     wxPATH_RMDIR_RECURSIVE  = 0x0002   // delete all recursively (dangerous!)
 101 };
 102
 103 #if wxUSE_LONGLONG
 104 // error code of wxFileName::GetSize()
 105 extern WXDLLIMPEXP_DATA_BASE(const wxULongLong) wxInvalidSize;
 106 #endif // wxUSE_LONGLONG
 107
 108
 109
 110 // ----------------------------------------------------------------------------
 111 // wxFileName: encapsulates a file path
 112 // ----------------------------------------------------------------------------
 113
 114 class WXDLLIMPEXP_BASE wxFileName
 115 {
 116 public:
 117     // constructors and assignment
 118
 119         // the usual stuff
 120     wxFileName() { Clear(); }
 121     wxFileName(const wxFileName& filepath) { Assign(filepath); }
 122
 123         // from a full filename: if it terminates with a '/', a directory path
 124         // is contructed (the name will be empty), otherwise a file name and
 125         // extension are extracted from it
 126     wxFileName( const wxString& fullpath, wxPathFormat format = wxPATH_NATIVE )
 127         { Assign( fullpath, format ); }
 128
 129         // from a directory name and a file name
 130     wxFileName(const wxString& path,
 131                const wxString& name,
 132                wxPathFormat format = wxPATH_NATIVE)
 133         { Assign(path, name, format); }
 134
 135         // from a volume, directory name, file base name and extension
 136     wxFileName(const wxString& volume,
 137                const wxString& path,
 138                const wxString& name,
 139                const wxString& ext,
 140                wxPathFormat format = wxPATH_NATIVE)
 141         { Assign(volume, path, name, ext, format); }
 142
 143         // from a directory name, file base name and extension
 144     wxFileName(const wxString& path,
 145                const wxString& name,
 146                const wxString& ext,
 147                wxPathFormat format = wxPATH_NATIVE)
 148         { Assign(path, name, ext, format); }
 149
 150         // the same for delayed initialization
 151
 152     void Assign(const wxFileName& filepath);
 153
 154     void Assign(const wxString& fullpath,
 155                 wxPathFormat format = wxPATH_NATIVE);
 156
 157     void Assign(const wxString& volume,
 158                 const wxString& path,
 159                 const wxString& name,
 160                 const wxString& ext,
 161                 bool hasExt,
 162                 wxPathFormat format = wxPATH_NATIVE);
 163
 164     void Assign(const wxString& volume,
 165                 const wxString& path,
 166                 const wxString& name,
 167                 const wxString& ext,
 168                 wxPathFormat format = wxPATH_NATIVE)
 169         { Assign(volume, path, name, ext, !ext.empty(), format); }
 170
 171     void Assign(const wxString& path,
 172                 const wxString& name,
 173                 wxPathFormat format = wxPATH_NATIVE);
 174
 175     void Assign(const wxString& path,
 176                 const wxString& name,
 177                 const wxString& ext,
 178                 wxPathFormat format = wxPATH_NATIVE);
 179
 180     void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE);
 181
 182         // assorted assignment operators
 183
 184     wxFileName& operator=(const wxFileName& filename)
 185         { if (this != &filename) Assign(filename); return *this; }
 186
 187     wxFileName& operator=(const wxString& filename)
 188         { Assign(filename); return *this; }
 189
 190         // reset all components to default, uninitialized state
 191     void Clear();
 192
 193         // static pseudo constructors
 194     static wxFileName FileName(const wxString& file,
 195                                wxPathFormat format = wxPATH_NATIVE);
 196     static wxFileName DirName(const wxString& dir,
 197                               wxPathFormat format = wxPATH_NATIVE);
 198
 199     // file tests
 200
 201         // is the filename valid at all?
 202     bool IsOk() const
 203     {
 204         // we're fine if we have the path or the name or if we're a root dir
 205         return m_dirs.size() != 0 || !m_name.empty() || !m_relative ||
 206                 !m_ext.empty() || m_hasExt;
 207     }
 208
 209         // does the file with this name exists?
 210     bool FileExists() const;
 211     static bool FileExists( const wxString &file );
 212
 213         // does the directory with this name exists?
 214     bool DirExists() const;
 215     static bool DirExists( const wxString &dir );
 216
 217         // checks on most common flags for files/directories;
 218         // more platform-specific features (like e.g. Unix permissions) are not
 219         // available in wxFileName
 220
 221     bool IsDirWritable() const { return wxIsWritable(GetPath()); }
 222     static bool IsDirWritable(const wxString &path) { return wxDirExists(path) && wxIsWritable(path); }
 223
 224     bool IsDirReadable() const { return wxIsReadable(GetPath()); }
 225     static bool IsDirReadable(const wxString &path) { return wxDirExists(path) && wxIsReadable(path); }
 226
 227     // NOTE: IsDirExecutable() is not present because the meaning of "executable"
 228     //       directory is very platform-dependent and also not so useful
 229
 230     bool IsFileWritable() const { return wxIsWritable(GetFullPath()); }
 231     static bool IsFileWritable(const wxString &path) { return wxFileExists(path) && wxIsWritable(path); }
 232
 233     bool IsFileReadable() const { return wxIsReadable(GetFullPath()); }
 234     static bool IsFileReadable(const wxString &path) { return wxFileExists(path) && wxIsReadable(path); }
 235
 236     bool IsFileExecutable() const { return wxIsExecutable(GetFullPath()); }
 237     static bool IsFileExecutable(const wxString &path) { return wxFileExists(path) && wxIsExecutable(path); }
 238
 239
 240     // time functions
 241 #if wxUSE_DATETIME
 242         // set the file last access/mod and creation times
 243         // (any of the pointers may be NULL)
 244     bool SetTimes(const wxDateTime *dtAccess,
 245                   const wxDateTime *dtMod,
 246                   const wxDateTime *dtCreate) const;
 247
 248         // set the access and modification times to the current moment
 249     bool Touch() const;
 250
 251         // return the last access, last modification and create times
 252         // (any of the pointers may be NULL)
 253     bool GetTimes(wxDateTime *dtAccess,
 254                   wxDateTime *dtMod,
 255                   wxDateTime *dtCreate) const;
 256
 257         // convenience wrapper: get just the last mod time of the file
 258     wxDateTime GetModificationTime() const
 259     {
 260         wxDateTime dtMod;
 261         (void)GetTimes(NULL, &dtMod, NULL);
 262         return dtMod;
 263     }
 264 #endif // wxUSE_DATETIME
 265
 266 #if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON
 267     bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;
 268     bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) const;
 269     // gets the 'common' type and creator for a certain extension
 270     static bool MacFindDefaultTypeAndCreator( const wxString& ext , wxUint32 *type , wxUint32 *creator ) ;
 271     // registers application defined extensions and their default type and creator
 272     static void MacRegisterDefaultTypeAndCreator( const wxString& ext , wxUint32 type , wxUint32 creator ) ;
 273     // looks up the appropriate type and creator from the registration and then sets
 274     bool MacSetDefaultTypeAndCreator() ;
 275 #endif
 276
 277     // various file/dir operations
 278
 279         // retrieve the value of the current working directory
 280     void AssignCwd(const wxString& volume = wxEmptyString);
 281     static wxString GetCwd(const wxString& volume = wxEmptyString);
 282
 283         // change the current working directory
 284     bool SetCwd() const;
 285     static bool SetCwd( const wxString &cwd );
 286
 287         // get the value of user home (Unix only mainly)
 288     void AssignHomeDir();
 289     static wxString GetHomeDir();
 290
 291         // get the system temporary directory
 292     static wxString GetTempDir();
 293
 294 #if wxUSE_FILE || wxUSE_FFILE
 295         // get a temp file name starting with the specified prefix
 296     void AssignTempFileName(const wxString& prefix);
 297     static wxString CreateTempFileName(const wxString& prefix);
 298 #endif // wxUSE_FILE
 299
 300 #if wxUSE_FILE
 301         // get a temp file name starting with the specified prefix and open the
 302         // file passed to us using this name for writing (atomically if
 303         // possible)
 304     void AssignTempFileName(const wxString& prefix, wxFile *fileTemp);
 305     static wxString CreateTempFileName(const wxString& prefix,
 306                                        wxFile *fileTemp);
 307 #endif // wxUSE_FILE
 308
 309 #if wxUSE_FFILE
 310         // get a temp file name starting with the specified prefix and open the
 311         // file passed to us using this name for writing (atomically if
 312         // possible)
 313     void AssignTempFileName(const wxString& prefix, wxFFile *fileTemp);
 314     static wxString CreateTempFileName(const wxString& prefix,
 315                                        wxFFile *fileTemp);
 316 #endif // wxUSE_FFILE
 317
 318     // directory creation and removal.
 319     bool Mkdir(int perm = wxS_DIR_DEFAULT, int flags = 0) const;
 320     static bool Mkdir(const wxString &dir, int perm = wxS_DIR_DEFAULT,
 321                       int flags = 0);
 322
 323     bool Rmdir(int flags = 0) const;
 324     static bool Rmdir(const wxString &dir, int flags = 0);
 325
 326     // operations on the path
 327
 328         // normalize the path: with the default flags value, the path will be
 329         // made absolute, without any ".." and "." and all environment
 330         // variables will be expanded in it
 331         //
 332         // this may be done using another (than current) value of cwd
 333     bool Normalize(int flags = wxPATH_NORM_ALL,
 334                    const wxString& cwd = wxEmptyString,
 335                    wxPathFormat format = wxPATH_NATIVE);
 336
 337         // get a path path relative to the given base directory, i.e. opposite
 338         // of Normalize
 339         //
 340         // pass an empty string to get a path relative to the working directory
 341         //
 342         // returns true if the file name was modified, false if we failed to do
 343         // anything with it (happens when the file is on a different volume,
 344         // for example)
 345     bool MakeRelativeTo(const wxString& pathBase = wxEmptyString,
 346                         wxPathFormat format = wxPATH_NATIVE);
 347
 348         // make the path absolute
 349         //
 350         // this may be done using another (than current) value of cwd
 351     bool MakeAbsolute(const wxString& cwd = wxEmptyString,
 352                       wxPathFormat format = wxPATH_NATIVE)
 353         { return Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE |
 354                            wxPATH_NORM_TILDE, cwd, format); }
 355
 356 #if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE
 357         // if the path is a shortcut, return the target and optionally,
 358         // the arguments
 359     bool GetShortcutTarget(const wxString& shortcutPath,
 360                            wxString& targetFilename,
 361                            wxString* arguments = NULL) const;
 362 #endif
 363
 364 #ifndef __WXWINCE__
 365         // if the path contains the value of the environment variable named envname
 366         // then this function replaces it with the string obtained from
 367         //    wxString::Format(replacementFmtString, value_of_envname_variable)
 368         //
 369         // Example:
 370         //    wxFileName fn("/usr/openwin/lib/someFile");
 371         //    fn.ReplaceEnvVariable("OPENWINHOME");
 372         //         // now fn.GetFullPath() == "$OPENWINHOME/lib/someFile"
 373     bool ReplaceEnvVariable(const wxString& envname,
 374                             const wxString& replacementFmtString = "$%s",
 375                             wxPathFormat format = wxPATH_NATIVE);
 376 #endif
 377
 378         // replaces, if present in the path, the home directory for the given user
 379         // (see wxGetHomeDir) with a tilde
 380     bool ReplaceHomeDir(wxPathFormat format = wxPATH_NATIVE);
 381
 382
 383     // Comparison
 384
 385         // compares with the rules of the given platforms format
 386     bool SameAs(const wxFileName& filepath,
 387                 wxPathFormat format = wxPATH_NATIVE) const;
 388
 389         // compare with another filename object
 390     bool operator==(const wxFileName& filename) const
 391         { return SameAs(filename); }
 392     bool operator!=(const wxFileName& filename) const
 393         { return !SameAs(filename); }
 394
 395         // compare with a filename string interpreted as a native file name
 396     bool operator==(const wxString& filename) const
 397         { return SameAs(wxFileName(filename)); }
 398     bool operator!=(const wxString& filename) const
 399         { return !SameAs(wxFileName(filename)); }
 400
 401         // are the file names of this type cases sensitive?
 402     static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE );
 403
 404         // is this filename absolute?
 405     bool IsAbsolute(wxPathFormat format = wxPATH_NATIVE) const;
 406
 407         // is this filename relative?
 408     bool IsRelative(wxPathFormat format = wxPATH_NATIVE) const
 409         { return !IsAbsolute(format); }
 410
 411     // Returns the characters that aren't allowed in filenames
 412     // on the specified platform.
 413     static wxString GetForbiddenChars(wxPathFormat format = wxPATH_NATIVE);
 414
 415     // Information about path format
 416
 417     // get the string separating the volume from the path for this format,
 418     // return an empty string if this format doesn't support the notion of
 419     // volumes at all
 420     static wxString GetVolumeSeparator(wxPathFormat format = wxPATH_NATIVE);
 421
 422     // get the string of path separators for this format
 423     static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE);
 424
 425     // get the string of path terminators, i.e. characters which terminate the
 426     // path
 427     static wxString GetPathTerminators(wxPathFormat format = wxPATH_NATIVE);
 428
 429     // get the canonical path separator for this format
 430     static wxUniChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE)
 431         { return GetPathSeparators(format)[0u]; }
 432
 433     // is the char a path separator for this format?
 434     static bool IsPathSeparator(wxChar ch, wxPathFormat format = wxPATH_NATIVE);
 435
 436     // is this is a DOS path which beings with a windows unique volume name
 437     // ('\\?\Volume{guid}\')?
 438     static bool IsMSWUniqueVolumeNamePath(const wxString& path,
 439                                           wxPathFormat format = wxPATH_NATIVE);
 440
 441     // Dir accessors
 442     size_t GetDirCount() const { return m_dirs.size(); }
 443     void AppendDir(const wxString& dir);
 444     void PrependDir(const wxString& dir);
 445     void InsertDir(size_t before, const wxString& dir);
 446     void RemoveDir(size_t pos);
 447     void RemoveLastDir() { RemoveDir(GetDirCount() - 1); }
 448
 449     // Other accessors
 450     void SetExt( const wxString &ext )          { m_ext = ext; m_hasExt = !m_ext.empty(); }
 451     void ClearExt()                             { m_ext = wxEmptyString; m_hasExt = false; }
 452     void SetEmptyExt()                          { m_ext = wxT(""); m_hasExt = true; }
 453     wxString GetExt() const                     { return m_ext; }
 454     bool HasExt() const                         { return m_hasExt; }
 455
 456     void SetName( const wxString &name )        { m_name = name; }
 457     wxString GetName() const                    { return m_name; }
 458     bool HasName() const                        { return !m_name.empty(); }
 459
 460     void SetVolume( const wxString &volume )    { m_volume = volume; }
 461     wxString GetVolume() const                  { return m_volume; }
 462     bool HasVolume() const                      { return !m_volume.empty(); }
 463
 464     // full name is the file name + extension (but without the path)
 465     void SetFullName(const wxString& fullname);
 466     wxString GetFullName() const;
 467
 468     const wxArrayString& GetDirs() const        { return m_dirs; }
 469
 470     // flags are combination of wxPATH_GET_XXX flags
 471     wxString GetPath(int flags = wxPATH_GET_VOLUME,
 472                      wxPathFormat format = wxPATH_NATIVE) const;
 473
 474     // Replace current path with this one
 475     void SetPath( const wxString &path, wxPathFormat format = wxPATH_NATIVE );
 476
 477     // Construct full path with name and ext
 478     wxString GetFullPath( wxPathFormat format = wxPATH_NATIVE ) const;
 479
 480     // Return the short form of the path (returns identity on non-Windows platforms)
 481     wxString GetShortPath() const;
 482
 483     // Return the long form of the path (returns identity on non-Windows platforms)
 484     wxString GetLongPath() const;
 485
 486     // Is this a file or directory (not necessarily an existing one)
 487     bool IsDir() const { return m_name.empty() && m_ext.empty(); }
 488
 489     // various helpers
 490
 491         // get the canonical path format for this platform
 492     static wxPathFormat GetFormat( wxPathFormat format = wxPATH_NATIVE );
 493
 494         // split a fullpath into the volume, path, (base) name and extension
 495         // (all of the pointers can be NULL)
 496     static void SplitPath(const wxString& fullpath,
 497                           wxString *volume,
 498                           wxString *path,
 499                           wxString *name,
 500                           wxString *ext,
 501                           bool *hasExt = NULL,
 502                           wxPathFormat format = wxPATH_NATIVE);
 503
 504     static void SplitPath(const wxString& fullpath,
 505                           wxString *volume,
 506                           wxString *path,
 507                           wxString *name,
 508                           wxString *ext,
 509                           wxPathFormat format)
 510     {
 511         SplitPath(fullpath, volume, path, name, ext, NULL, format);
 512     }
 513
 514         // compatibility version: volume is part of path
 515     static void SplitPath(const wxString& fullpath,
 516                           wxString *path,
 517                           wxString *name,
 518                           wxString *ext,
 519                           wxPathFormat format = wxPATH_NATIVE);
 520
 521         // split a path into volume and pure path part
 522     static void SplitVolume(const wxString& fullpathWithVolume,
 523                             wxString *volume,
 524                             wxString *path,
 525                             wxPathFormat format = wxPATH_NATIVE);
 526
 527         // strip the file extension: "foo.bar" => "foo" (but ".baz" => ".baz")
 528     static wxString StripExtension(const wxString& fullpath);
 529
 530 #ifdef wxHAS_FILESYSTEM_VOLUMES
 531         // return the string representing a file system volume, or drive
 532     static wxString GetVolumeString(char drive, int flags = wxPATH_GET_SEPARATOR);
 533 #endif // wxHAS_FILESYSTEM_VOLUMES
 534
 535     // File size
 536
 537 #if wxUSE_LONGLONG
 538         // returns the size of the given filename
 539     wxULongLong GetSize() const;
 540     static wxULongLong GetSize(const wxString &file);
 541
 542         // returns the size in a human readable form
 543     wxString GetHumanReadableSize(const wxString &nullsize = wxGetTranslation(wxT("Not available")),
 544                                   int precision = 1) const;
 545     static wxString GetHumanReadableSize(const wxULongLong &sz,
 546                                          const wxString &nullsize = wxGetTranslation(wxT("Not available")),
 547                                          int precision = 1);
 548 #endif // wxUSE_LONGLONG
 549
 550
 551     // deprecated methods, don't use any more
 552     // --------------------------------------
 553
 554 #ifndef __DIGITALMARS__
 555     wxString GetPath( bool withSep, wxPathFormat format = wxPATH_NATIVE ) const
 556         { return GetPath(withSep ? wxPATH_GET_SEPARATOR : 0, format); }
 557 #endif
 558     wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const
 559         { return GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, format); }
 560
 561 private:
 562     // check whether this dir is valid for Append/Prepend/InsertDir()
 563     static bool IsValidDirComponent(const wxString& dir);
 564
 565     // the drive/volume/device specification (always empty for Unix)
 566     wxString        m_volume;
 567
 568     // the path components of the file
 569     wxArrayString   m_dirs;
 570
 571     // the file name and extension (empty for directories)
 572     wxString        m_name,
 573                     m_ext;
 574
 575     // when m_dirs is empty it may mean either that we have no path at all or
 576     // that our path is '/', i.e. the root directory
 577     //
 578     // we use m_relative to distinguish between these two cases, it will be
 579     // true in the former and false in the latter
 580     //
 581     // NB: the path is not absolute just because m_relative is false, it still
 582     //     needs the drive (i.e. volume) in some formats (Windows)
 583     bool            m_relative;
 584
 585     // when m_ext is empty, it may be because we don't have any extension or
 586     // because we have an empty extension
 587     //
 588     // the difference is important as file with name "foo" and without
 589     // extension has full name "foo" while with empty extension it is "foo."
 590     bool            m_hasExt;
 591 };
 592
 593 #endif // _WX_FILENAME_H_
 594