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