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