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