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