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