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