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 // ----------------------------------------------------------------------------
  42 // constants
  43 // ----------------------------------------------------------------------------
  44
  45 // the various values for the path format: this mainly affects the path
  46 // separator but also whether or not the path has the drive part (as under
  47 // Windows)
  48 enum wxPathFormat
  49 {
  50     wxPATH_NATIVE = 0,      // the path format for the current platform
  51     wxPATH_UNIX,
  52     wxPATH_MAC,
  53     wxPATH_DOS,
  54     wxPATH_VMS,
  55
  56     wxPATH_BEOS = wxPATH_UNIX,
  57     wxPATH_WIN = wxPATH_DOS,
  58     wxPATH_OS2 = wxPATH_DOS
  59 };
  60
  61 // the kind of normalization to do with the file name: these values can be
  62 // or'd together to perform several operations at once
  63 enum wxPathNormalize
  64 {
  65     wxPATH_NORM_ENV_VARS = 0x0001,  // replace env vars with their values
  66     wxPATH_NORM_DOTS     = 0x0002,  // squeeze all .. and . and prepend cwd
  67     wxPATH_NORM_TILDE    = 0x0004,  // Unix only: replace ~ and ~user
  68     wxPATH_NORM_CASE     = 0x0008,  // if case insensitive => tolower
  69     wxPATH_NORM_ABSOLUTE = 0x0010,  // make the path absolute
  70     wxPATH_NORM_LONG =     0x0020,  // make the path the long form
  71     wxPATH_NORM_ALL      = 0x003f
  72 };
  73
  74 // ----------------------------------------------------------------------------
  75 // wxFileName: encapsulates a file path
  76 // ----------------------------------------------------------------------------
  77
  78 class WXDLLEXPORT wxFileName
  79 {
  80 public:
  81     // constructors and assignment
  82
  83         // the usual stuff
  84     wxFileName() { }
  85     wxFileName( const wxFileName &filepath ) { Assign(filepath); }
  86
  87         // from a full filename: if it terminates with a '/', a directory path
  88         // is contructed (the name will be empty), otherwise a file name and
  89         // extension are extracted from it
  90     wxFileName( const wxString& fullpath, wxPathFormat format = wxPATH_NATIVE )
  91         { Assign( fullpath, format ); }
  92
  93         // from a directory name and a file name
  94     wxFileName(const wxString& path,
  95                const wxString& name,
  96                wxPathFormat format = wxPATH_NATIVE)
  97         { Assign(path, name, format); }
  98
  99         // from a volume, directory name, file base name and extension
 100     wxFileName(const wxString& volume,
 101                const wxString& path,
 102                const wxString& name,
 103                const wxString& ext,
 104                wxPathFormat format = wxPATH_NATIVE)
 105         { Assign(volume, path, name, ext, format); }
 106
 107         // from a directory name, file base name and extension
 108     wxFileName(const wxString& path,
 109                const wxString& name,
 110                const wxString& ext,
 111                wxPathFormat format = wxPATH_NATIVE)
 112         { Assign(path, name, ext, format); }
 113
 114         // the same for delayed initialization
 115
 116     void Assign(const wxFileName& filepath);
 117
 118     void Assign(const wxString& fullpath,
 119                 wxPathFormat format = wxPATH_NATIVE);
 120
 121     void Assign(const wxString& volume,
 122                 const wxString& path,
 123                 const wxString& name,
 124                 const wxString& ext,
 125                 wxPathFormat format = wxPATH_NATIVE);
 126
 127     void Assign(const wxString& path,
 128                 const wxString& name,
 129                 wxPathFormat format = wxPATH_NATIVE);
 130
 131     void Assign(const wxString& path,
 132                 const wxString& name,
 133                 const wxString& ext,
 134                 wxPathFormat format = wxPATH_NATIVE)
 135     {
 136         // empty volume
 137         Assign(_T(""), path, name, ext, format);
 138     }
 139
 140     void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE);
 141
 142         // assorted assignment operators
 143
 144     wxFileName& operator=(const wxFileName& filename)
 145         { Assign(filename); return *this; }
 146
 147     wxFileName& operator=(const wxString& filename)
 148         { Assign(filename); return *this; }
 149
 150         // reset all components to default, uninitialized state
 151     void Clear();
 152
 153         // static pseudo constructors
 154     static wxFileName FileName(const wxString& file);
 155     static wxFileName DirName(const wxString& dir);
 156
 157     // file tests
 158
 159         // is the filename valid at all?
 160     bool IsOk() const { return !m_dirs.IsEmpty() || !m_name.IsEmpty(); }
 161
 162         // does the file with this name exists?
 163     bool FileExists();
 164     static bool FileExists( const wxString &file );
 165
 166         // does the directory with this name exists?
 167     bool DirExists();
 168     static bool DirExists( const wxString &dir );
 169
 170         // VZ: also need: IsDirWritable(), IsFileExecutable() &c (TODO)
 171
 172     // time functions
 173
 174         // set the file creation and last access/mod times
 175         // (any of the pointers may be NULL)
 176     bool SetTimes(const wxDateTime *dtCreate,
 177                   const wxDateTime *dtAccess,
 178                   const wxDateTime *dtMod);
 179
 180         // set the access and modification times to the current moment
 181     bool Touch();
 182
 183         // return the last access, last modification and last change times
 184         // (any of the pointers may be NULL)
 185     bool GetTimes(wxDateTime *dtAccess,
 186                   wxDateTime *dtMod,
 187                   wxDateTime *dtChange) const;
 188
 189         // convenience wrapper: get just the last mod time of the file
 190     wxDateTime GetModificationTime() const
 191     {
 192         wxDateTime dtMod;
 193         (void)GetTimes(NULL, &dtMod, NULL);
 194         return dtMod;
 195     }
 196
 197     // various file/dir operations
 198
 199         // retrieve the value of the current working directory
 200     void AssignCwd(const wxString& volume = wxEmptyString);
 201     static wxString GetCwd(const wxString& volume = wxEmptyString);
 202
 203         // change the current working directory
 204     bool SetCwd();
 205     static bool SetCwd( const wxString &cwd );
 206
 207         // get the value of user home (Unix only mainly)
 208     void AssignHomeDir();
 209     static wxString GetHomeDir();
 210
 211         // get a temp file name starting with the specified prefix
 212     void AssignTempFileName(const wxString& prefix);
 213     static wxString CreateTempFileName(const wxString& prefix);
 214
 215     // directory creation and removal.
 216     // if full is TRUE, will try to make each directory in the path.
 217     bool Mkdir( int perm = 0777, bool full = FALSE);
 218     static bool Mkdir( const wxString &dir, int perm = 0777, bool full = FALSE );
 219
 220     bool Rmdir();
 221     static bool Rmdir( const wxString &dir );
 222
 223     // operations on the path
 224
 225         // normalize the path: with the default flags value, the path will be
 226         // made absolute, without any ".." and "." and all environment
 227         // variables will be expanded in it
 228         //
 229         // this may be done using another (than current) value of cwd
 230     bool Normalize(wxPathNormalize flags = wxPATH_NORM_ALL,
 231                    const wxString& cwd = wxEmptyString,
 232                    wxPathFormat format = wxPATH_NATIVE);
 233
 234         // get a path path relative to the given base directory, i.e. opposite
 235         // of Normalize
 236         //
 237         // pass an empty string to get a path relative to the working directory
 238         //
 239         // returns TRUE if the file name was modified, FALSE if we failed to do
 240         // anything with it (happens when the file is on a different volume,
 241         // for example)
 242     bool MakeRelativeTo(const wxString& pathBase = _T(""),
 243                         wxPathFormat format = wxPATH_NATIVE);
 244
 245
 246     // Comparison
 247
 248         // compares with the rules of this platform
 249     bool SameAs(const wxFileName &filepath,
 250                 wxPathFormat format = wxPATH_NATIVE);
 251
 252         // uses the current platform settings
 253     bool operator==(const wxFileName& filename) { return SameAs(filename); }
 254     bool operator==(const wxString& filename)
 255         { return *this == wxFileName(filename); }
 256
 257     // Tests
 258
 259         // are the file names of this type cases sensitive?
 260     static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE );
 261
 262         // is this filename absolute?
 263     bool IsAbsolute() const
 264         { return !m_relative; }
 265
 266         // is this filename relative?
 267     bool IsRelative() const
 268         { return m_relative; }
 269
 270     // Information about path format
 271
 272     // get the string separating the volume from the path for this format
 273     static wxString GetVolumeSeparator(wxPathFormat format = wxPATH_NATIVE);
 274
 275     // get the string of path separators for this format
 276     static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE);
 277
 278     // is the char a path separator for this format?
 279     static bool IsPathSeparator(wxChar ch, wxPathFormat format = wxPATH_NATIVE);
 280
 281     // FIXME: what exactly does this do?
 282     bool IsWild( wxPathFormat format = wxPATH_NATIVE );
 283
 284     // Dir accessors
 285     void AppendDir( const wxString &dir );
 286     void PrependDir( const wxString &dir );
 287     void InsertDir( int before, const wxString &dir );
 288     void RemoveDir( int pos );
 289     size_t GetDirCount() const { return m_dirs.GetCount(); }
 290
 291     // Other accessors
 292     void SetExt( const wxString &ext )          { m_ext = ext; }
 293     wxString GetExt() const                     { return m_ext; }
 294     bool HasExt() const                         { return !m_ext.empty(); }
 295
 296     void SetName( const wxString &name )        { m_name = name; }
 297     wxString GetName() const                    { return m_name; }
 298     bool HasName() const                        { return !m_name.empty(); }
 299
 300     void SetVolume( const wxString &volume )    { m_volume = volume; }
 301     wxString GetVolume() const                  { return m_volume; }
 302     bool HasVolume() const                      { return !m_volume.empty(); }
 303
 304     // full name is the file name + extension (but without the path)
 305     void SetFullName(const wxString& fullname);
 306     wxString GetFullName() const;
 307
 308     const wxArrayString& GetDirs() const        { return m_dirs; }
 309
 310     // Construct path only - possibly with the trailing separator
 311     wxString GetPath( bool add_separator = FALSE,
 312                       wxPathFormat format = wxPATH_NATIVE ) const;
 313
 314     // more readable synonym
 315     wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const
 316         { return GetPath(TRUE /* add separator */, format); }
 317
 318     // Construct full path with name and ext
 319     wxString GetFullPath( wxPathFormat format = wxPATH_NATIVE ) const;
 320
 321     // Return the short form of the path (returns identity on non-Windows platforms)
 322     wxString GetShortPath() const;
 323
 324     // Return the long form of the path (returns identity on non-Windows platforms)
 325     wxString GetLongPath() const;
 326
 327     // various helpers
 328
 329         // get the canonical path format for this platform
 330     static wxPathFormat GetFormat( wxPathFormat format = wxPATH_NATIVE );
 331
 332         // split a fullpath into the volume, path, (base) name and extension
 333         // (all of the pointers can be NULL)
 334     static void SplitPath(const wxString& fullpath,
 335                           wxString *volume,
 336                           wxString *path,
 337                           wxString *name,
 338                           wxString *ext,
 339                           wxPathFormat format = wxPATH_NATIVE);
 340
 341         // compatibility version
 342     static void SplitPath(const wxString& fullpath,
 343                           wxString *path,
 344                           wxString *name,
 345                           wxString *ext,
 346                           wxPathFormat format = wxPATH_NATIVE);
 347
 348 private:
 349     // the drive/volume/device specification (always empty for Unix)
 350     wxString        m_volume;
 351
 352     // the path components of the file
 353     wxArrayString   m_dirs;
 354
 355     // the file name and extension (empty for directories)
 356     wxString        m_name,
 357                     m_ext;
 358
 359     // is the path relative
 360     bool            m_relative;
 361 };
 362
 363 #endif // _WX_FILENAME_H_
 364