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