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