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 /*
  16     TODO:
  17
  18     1. support for drives under Windows
  19     2. more file operations:
  20         a) chmod()
  21         b) [acm]time() - get and set
  22         c) rename()?
  23     3. SameFileAs() function to compare inodes under Unix
  24  */
  25
  26 #include "wx/arrstr.h"
  27 #include "wx/filefn.h"
  28 #include "wx/datetime.h"
  29 #include "wx/intl.h"
  30 #include "wx/longlong.h"
  31 #include "wx/file.h"
  32
  33 #if wxUSE_FILE
  34 class WXDLLIMPEXP_FWD_BASE wxFile;
  35 #endif
  36
  37 #if wxUSE_FFILE
  38 class WXDLLIMPEXP_FWD_BASE wxFFile;
  39 #endif
  40
  41 // this symbol is defined for the platforms where file systems use volumes in
  42 // paths
  43 #if defined(__WINDOWS__) || defined(__DOS__) || defined(__OS2__)
  44     #define wxHAS_FILESYSTEM_VOLUMES
  45 #endif
  46
  47 // ----------------------------------------------------------------------------
  48 // constants
  49 // ----------------------------------------------------------------------------
  50
  51 // the various values for the path format: this mainly affects the path
  52 // separator but also whether or not the path has the drive part (as under
  53 // Windows)
  54 enum wxPathFormat
  55 {
  56     wxPATH_NATIVE = 0,      // the path format for the current platform
  57     wxPATH_UNIX,
  58     wxPATH_BEOS = wxPATH_UNIX,
  59     wxPATH_MAC,
  60     wxPATH_DOS,
  61     wxPATH_WIN = wxPATH_DOS,
  62     wxPATH_OS2 = wxPATH_DOS,
  63     wxPATH_VMS,
  64
  65     wxPATH_MAX // Not a valid value for specifying path format
  66 };
  67
  68 // different conventions that may be used with GetHumanReadableSize()
  69 enum wxSizeConvention
  70 {
  71     wxSIZE_CONV_TRADITIONAL,  // 1024 bytes = 1 KB
  72     wxSIZE_CONV_IEC,          // 1024 bytes = 1 KiB
  73     wxSIZE_CONV_SI            // 1000 bytes = 1 KB
  74 };
  75
  76 // the kind of normalization to do with the file name: these values can be
  77 // or'd together to perform several operations at once
  78 enum wxPathNormalize
  79 {
  80     wxPATH_NORM_ENV_VARS = 0x0001,  // replace env vars with their values
  81     wxPATH_NORM_DOTS     = 0x0002,  // squeeze all .. and .
  82     wxPATH_NORM_TILDE    = 0x0004,  // Unix only: replace ~ and ~user
  83     wxPATH_NORM_CASE     = 0x0008,  // if case insensitive => tolower
  84     wxPATH_NORM_ABSOLUTE = 0x0010,  // make the path absolute
  85     wxPATH_NORM_LONG =     0x0020,  // make the path the long form
  86     wxPATH_NORM_SHORTCUT = 0x0040,  // resolve the shortcut, if it is a shortcut
  87     wxPATH_NORM_ALL      = 0x00ff & ~wxPATH_NORM_CASE
  88 };
  89
  90 // what exactly should GetPath() return?
  91 enum
  92 {
  93     wxPATH_NO_SEPARATOR  = 0x0000,  // for symmetry with wxPATH_GET_SEPARATOR
  94     wxPATH_GET_VOLUME    = 0x0001,  // include the volume if applicable
  95     wxPATH_GET_SEPARATOR = 0x0002   // terminate the path with the separator
  96 };
  97
  98 // Mkdir flags
  99 enum
 100 {
 101     wxPATH_MKDIR_FULL    = 0x0001   // create directories recursively
 102 };
 103
 104 // Rmdir flags
 105 enum
 106 {
 107     wxPATH_RMDIR_FULL       = 0x0001,  // delete with subdirectories if empty
 108     wxPATH_RMDIR_RECURSIVE  = 0x0002   // delete all recursively (dangerous!)
 109 };
 110
 111 #if wxUSE_LONGLONG
 112 // error code of wxFileName::GetSize()
 113 extern WXDLLIMPEXP_DATA_BASE(const wxULongLong) wxInvalidSize;
 114 #endif // wxUSE_LONGLONG
 115
 116
 117
 118 // ----------------------------------------------------------------------------
 119 // wxFileName: encapsulates a file path
 120 // ----------------------------------------------------------------------------
 121
 122 class WXDLLIMPEXP_BASE wxFileName
 123 {
 124 public:
 125     // constructors and assignment
 126
 127         // the usual stuff
 128     wxFileName() { Clear(); }
 129     wxFileName(const wxFileName& filepath) { Assign(filepath); }
 130
 131         // from a full filename: if it terminates with a '/', a directory path
 132         // is contructed (the name will be empty), otherwise a file name and
 133         // extension are extracted from it
 134     wxFileName( const wxString& fullpath, wxPathFormat format = wxPATH_NATIVE )
 135         { Assign( fullpath, format ); }
 136
 137         // from a directory name and a file name
 138     wxFileName(const wxString& path,
 139                const wxString& name,
 140                wxPathFormat format = wxPATH_NATIVE)
 141         { Assign(path, name, format); }
 142
 143         // from a volume, directory name, file base name and extension
 144     wxFileName(const wxString& volume,
 145                const wxString& path,
 146                const wxString& name,
 147                const wxString& ext,
 148                wxPathFormat format = wxPATH_NATIVE)
 149         { Assign(volume, path, name, ext, format); }
 150
 151         // from a directory name, file base name and extension
 152     wxFileName(const wxString& path,
 153                const wxString& name,
 154                const wxString& ext,
 155                wxPathFormat format = wxPATH_NATIVE)
 156         { Assign(path, name, ext, format); }
 157
 158         // the same for delayed initialization
 159
 160     void Assign(const wxFileName& filepath);
 161
 162     void Assign(const wxString& fullpath,
 163                 wxPathFormat format = wxPATH_NATIVE);
 164
 165     void Assign(const wxString& volume,
 166                 const wxString& path,
 167                 const wxString& name,
 168                 const wxString& ext,
 169                 bool hasExt,
 170                 wxPathFormat format = wxPATH_NATIVE);
 171
 172     void Assign(const wxString& volume,
 173                 const wxString& path,
 174                 const wxString& name,
 175                 const wxString& ext,
 176                 wxPathFormat format = wxPATH_NATIVE)
 177         { Assign(volume, path, name, ext, !ext.empty(), format); }
 178
 179     void Assign(const wxString& path,
 180                 const wxString& name,
 181                 wxPathFormat format = wxPATH_NATIVE);
 182
 183     void Assign(const wxString& path,
 184                 const wxString& name,
 185                 const wxString& ext,
 186                 wxPathFormat format = wxPATH_NATIVE);
 187
 188     void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE);
 189
 190         // assorted assignment operators
 191
 192     wxFileName& operator=(const wxFileName& filename)
 193         { if (this != &filename) Assign(filename); return *this; }
 194
 195     wxFileName& operator=(const wxString& filename)
 196         { Assign(filename); return *this; }
 197
 198         // reset all components to default, uninitialized state
 199     void Clear();
 200
 201         // static pseudo constructors
 202     static wxFileName FileName(const wxString& file,
 203                                wxPathFormat format = wxPATH_NATIVE);
 204     static wxFileName DirName(const wxString& dir,
 205                               wxPathFormat format = wxPATH_NATIVE);
 206
 207     // file tests
 208
 209         // is the filename valid at all?
 210     bool IsOk() const
 211     {
 212         // we're fine if we have the path or the name or if we're a root dir
 213         return m_dirs.size() != 0 || !m_name.empty() || !m_relative ||
 214                 !m_ext.empty() || m_hasExt;
 215     }
 216
 217         // does the file with this name exist?
 218     bool FileExists() const;
 219     static bool FileExists( const wxString &file );
 220
 221         // does the directory with this name exist?
 222     bool DirExists() const;
 223     static bool DirExists( const wxString &dir );
 224
 225         // does anything at all with this name (i.e. file, directory or some
 226         // other file system object such as a device, socket, ...) exist?
 227     bool Exists() const { return Exists(GetFullPath()); }
 228     static bool Exists(const wxString& path);
 229
 230
 231         // checks on most common flags for files/directories;
 232         // more platform-specific features (like e.g. Unix permissions) are not
 233         // available in wxFileName
 234
 235     bool IsDirWritable() const { return wxIsWritable(GetPath()); }
 236     static bool IsDirWritable(const wxString &path) { return wxDirExists(path) && wxIsWritable(path); }
 237
 238     bool IsDirReadable() const { return wxIsReadable(GetPath()); }
 239     static bool IsDirReadable(const wxString &path) { return wxDirExists(path) && wxIsReadable(path); }
 240
 241     // NOTE: IsDirExecutable() is not present because the meaning of "executable"
 242     //       directory is very platform-dependent and also not so useful
 243
 244     bool IsFileWritable() const { return wxIsWritable(GetFullPath()); }
 245     static bool IsFileWritable(const wxString &path) { return wxFileExists(path) && wxIsWritable(path); }
 246
 247     bool IsFileReadable() const { return wxIsReadable(GetFullPath()); }
 248     static bool IsFileReadable(const wxString &path) { return wxFileExists(path) && wxIsReadable(path); }
 249
 250     bool IsFileExecutable() const { return wxIsExecutable(GetFullPath()); }
 251     static bool IsFileExecutable(const wxString &path) { return wxFileExists(path) && wxIsExecutable(path); }
 252
 253
 254     // time functions
 255 #if wxUSE_DATETIME
 256         // set the file last access/mod and creation times
 257         // (any of the pointers may be NULL)
 258     bool SetTimes(const wxDateTime *dtAccess,
 259                   const wxDateTime *dtMod,
 260                   const wxDateTime *dtCreate) const;
 261
 262         // set the access and modification times to the current moment
 263     bool Touch() const;
 264
 265         // return the last access, last modification and create times
 266         // (any of the pointers may be NULL)
 267     bool GetTimes(wxDateTime *dtAccess,
 268                   wxDateTime *dtMod,
 269                   wxDateTime *dtCreate) const;
 270
 271         // convenience wrapper: get just the last mod time of the file
 272     wxDateTime GetModificationTime() const
 273     {
 274         wxDateTime dtMod;
 275         (void)GetTimes(NULL, &dtMod, NULL);
 276         return dtMod;
 277     }
 278 #endif // wxUSE_DATETIME
 279
 280 #if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON
 281     bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;
 282     bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) const;
 283     // gets the 'common' type and creator for a certain extension
 284     static bool MacFindDefaultTypeAndCreator( const wxString& ext , wxUint32 *type , wxUint32 *creator ) ;
 285     // registers application defined extensions and their default type and creator
 286     static void MacRegisterDefaultTypeAndCreator( const wxString& ext , wxUint32 type , wxUint32 creator ) ;
 287     // looks up the appropriate type and creator from the registration and then sets
 288     bool MacSetDefaultTypeAndCreator() ;
 289 #endif
 290
 291     // various file/dir operations
 292
 293         // retrieve the value of the current working directory
 294     void AssignCwd(const wxString& volume = wxEmptyString);
 295     static wxString GetCwd(const wxString& volume = wxEmptyString);
 296
 297         // change the current working directory
 298     bool SetCwd() const;
 299     static bool SetCwd( const wxString &cwd );
 300
 301         // get the value of user home (Unix only mainly)
 302     void AssignHomeDir();
 303     static wxString GetHomeDir();
 304
 305         // get the system temporary directory
 306     static wxString GetTempDir();
 307
 308 #if wxUSE_FILE || wxUSE_FFILE
 309         // get a temp file name starting with the specified prefix
 310     void AssignTempFileName(const wxString& prefix);
 311     static wxString CreateTempFileName(const wxString& prefix);
 312 #endif // wxUSE_FILE
 313
 314 #if wxUSE_FILE
 315         // get a temp file name starting with the specified prefix and open the
 316         // file passed to us using this name for writing (atomically if
 317         // possible)
 318     void AssignTempFileName(const wxString& prefix, wxFile *fileTemp);
 319     static wxString CreateTempFileName(const wxString& prefix,
 320                                        wxFile *fileTemp);
 321 #endif // wxUSE_FILE
 322
 323 #if wxUSE_FFILE
 324         // get a temp file name starting with the specified prefix and open the
 325         // file passed to us using this name for writing (atomically if
 326         // possible)
 327     void AssignTempFileName(const wxString& prefix, wxFFile *fileTemp);
 328     static wxString CreateTempFileName(const wxString& prefix,
 329                                        wxFFile *fileTemp);
 330 #endif // wxUSE_FFILE
 331
 332     // directory creation and removal.
 333     bool Mkdir(int perm = wxS_DIR_DEFAULT, int flags = 0) const;
 334     static bool Mkdir(const wxString &dir, int perm = wxS_DIR_DEFAULT,
 335                       int flags = 0);
 336
 337     bool Rmdir(int flags = 0) const;
 338     static bool Rmdir(const wxString &dir, int flags = 0);
 339
 340     // operations on the path
 341
 342         // normalize the path: with the default flags value, the path will be
 343         // made absolute, without any ".." and "." and all environment
 344         // variables will be expanded in it
 345         //
 346         // this may be done using another (than current) value of cwd
 347     bool Normalize(int flags = wxPATH_NORM_ALL,
 348                    const wxString& cwd = wxEmptyString,
 349                    wxPathFormat format = wxPATH_NATIVE);
 350
 351         // get a path path relative to the given base directory, i.e. opposite
 352         // of Normalize
 353         //
 354         // pass an empty string to get a path relative to the working directory
 355         //
 356         // returns true if the file name was modified, false if we failed to do
 357         // anything with it (happens when the file is on a different volume,
 358         // for example)
 359     bool MakeRelativeTo(const wxString& pathBase = wxEmptyString,
 360                         wxPathFormat format = wxPATH_NATIVE);
 361
 362         // make the path absolute
 363         //
 364         // this may be done using another (than current) value of cwd
 365     bool MakeAbsolute(const wxString& cwd = wxEmptyString,
 366                       wxPathFormat format = wxPATH_NATIVE)
 367         { return Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE |
 368                            wxPATH_NORM_TILDE, cwd, format); }
 369
 370 #if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE
 371         // if the path is a shortcut, return the target and optionally,
 372         // the arguments
 373     bool GetShortcutTarget(const wxString& shortcutPath,
 374                            wxString& targetFilename,
 375                            wxString* arguments = NULL) const;
 376 #endif
 377
 378 #ifndef __WXWINCE__
 379         // if the path contains the value of the environment variable named envname
 380         // then this function replaces it with the string obtained from
 381         //    wxString::Format(replacementFmtString, value_of_envname_variable)
 382         //
 383         // Example:
 384         //    wxFileName fn("/usr/openwin/lib/someFile");
 385         //    fn.ReplaceEnvVariable("OPENWINHOME");
 386         //         // now fn.GetFullPath() == "$OPENWINHOME/lib/someFile"
 387     bool ReplaceEnvVariable(const wxString& envname,
 388                             const wxString& replacementFmtString = "$%s",
 389                             wxPathFormat format = wxPATH_NATIVE);
 390 #endif
 391
 392         // replaces, if present in the path, the home directory for the given user
 393         // (see wxGetHomeDir) with a tilde
 394     bool ReplaceHomeDir(wxPathFormat format = wxPATH_NATIVE);
 395
 396
 397     // Comparison
 398
 399         // compares with the rules of the given platforms format
 400     bool SameAs(const wxFileName& filepath,
 401                 wxPathFormat format = wxPATH_NATIVE) const;
 402
 403         // compare with another filename object
 404     bool operator==(const wxFileName& filename) const
 405         { return SameAs(filename); }
 406     bool operator!=(const wxFileName& filename) const
 407         { return !SameAs(filename); }
 408
 409         // compare with a filename string interpreted as a native file name
 410     bool operator==(const wxString& filename) const
 411         { return SameAs(wxFileName(filename)); }
 412     bool operator!=(const wxString& filename) const
 413         { return !SameAs(wxFileName(filename)); }
 414
 415         // are the file names of this type cases sensitive?
 416     static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE );
 417
 418         // is this filename absolute?
 419     bool IsAbsolute(wxPathFormat format = wxPATH_NATIVE) const;
 420
 421         // is this filename relative?
 422     bool IsRelative(wxPathFormat format = wxPATH_NATIVE) const
 423         { return !IsAbsolute(format); }
 424
 425     // Returns the characters that aren't allowed in filenames
 426     // on the specified platform.
 427     static wxString GetForbiddenChars(wxPathFormat format = wxPATH_NATIVE);
 428
 429     // Information about path format
 430
 431     // get the string separating the volume from the path for this format,
 432     // return an empty string if this format doesn't support the notion of
 433     // volumes at all
 434     static wxString GetVolumeSeparator(wxPathFormat format = wxPATH_NATIVE);
 435
 436     // get the string of path separators for this format
 437     static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE);
 438
 439     // get the string of path terminators, i.e. characters which terminate the
 440     // path
 441     static wxString GetPathTerminators(wxPathFormat format = wxPATH_NATIVE);
 442
 443     // get the canonical path separator for this format
 444     static wxUniChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE)
 445         { return GetPathSeparators(format)[0u]; }
 446
 447     // is the char a path separator for this format?
 448     static bool IsPathSeparator(wxChar ch, wxPathFormat format = wxPATH_NATIVE);
 449
 450     // is this is a DOS path which beings with a windows unique volume name
 451     // ('\\?\Volume{guid}\')?
 452     static bool IsMSWUniqueVolumeNamePath(const wxString& path,
 453                                           wxPathFormat format = wxPATH_NATIVE);
 454
 455     // Dir accessors
 456     size_t GetDirCount() const { return m_dirs.size(); }
 457     void AppendDir(const wxString& dir);
 458     void PrependDir(const wxString& dir);
 459     void InsertDir(size_t before, const wxString& dir);
 460     void RemoveDir(size_t pos);
 461     void RemoveLastDir() { RemoveDir(GetDirCount() - 1); }
 462
 463     // Other accessors
 464     void SetExt( const wxString &ext )          { m_ext = ext; m_hasExt = !m_ext.empty(); }
 465     void ClearExt()                             { m_ext = wxEmptyString; m_hasExt = false; }
 466     void SetEmptyExt()                          { m_ext = wxT(""); m_hasExt = true; }
 467     wxString GetExt() const                     { return m_ext; }
 468     bool HasExt() const                         { return m_hasExt; }
 469
 470     void SetName( const wxString &name )        { m_name = name; }
 471     wxString GetName() const                    { return m_name; }
 472     bool HasName() const                        { return !m_name.empty(); }
 473
 474     void SetVolume( const wxString &volume )    { m_volume = volume; }
 475     wxString GetVolume() const                  { return m_volume; }
 476     bool HasVolume() const                      { return !m_volume.empty(); }
 477
 478     // full name is the file name + extension (but without the path)
 479     void SetFullName(const wxString& fullname);
 480     wxString GetFullName() const;
 481
 482     const wxArrayString& GetDirs() const        { return m_dirs; }
 483
 484     // flags are combination of wxPATH_GET_XXX flags
 485     wxString GetPath(int flags = wxPATH_GET_VOLUME,
 486                      wxPathFormat format = wxPATH_NATIVE) const;
 487
 488     // Replace current path with this one
 489     void SetPath( const wxString &path, wxPathFormat format = wxPATH_NATIVE );
 490
 491     // Construct full path with name and ext
 492     wxString GetFullPath( wxPathFormat format = wxPATH_NATIVE ) const;
 493
 494     // Return the short form of the path (returns identity on non-Windows platforms)
 495     wxString GetShortPath() const;
 496
 497     // Return the long form of the path (returns identity on non-Windows platforms)
 498     wxString GetLongPath() const;
 499
 500     // Is this a file or directory (not necessarily an existing one)
 501     bool IsDir() const { return m_name.empty() && m_ext.empty(); }
 502
 503     // various helpers
 504
 505         // get the canonical path format for this platform
 506     static wxPathFormat GetFormat( wxPathFormat format = wxPATH_NATIVE );
 507
 508         // split a fullpath into the volume, path, (base) name and extension
 509         // (all of the pointers can be NULL)
 510     static void SplitPath(const wxString& fullpath,
 511                           wxString *volume,
 512                           wxString *path,
 513                           wxString *name,
 514                           wxString *ext,
 515                           bool *hasExt = NULL,
 516                           wxPathFormat format = wxPATH_NATIVE);
 517
 518     static void SplitPath(const wxString& fullpath,
 519                           wxString *volume,
 520                           wxString *path,
 521                           wxString *name,
 522                           wxString *ext,
 523                           wxPathFormat format)
 524     {
 525         SplitPath(fullpath, volume, path, name, ext, NULL, format);
 526     }
 527
 528         // compatibility version: volume is part of path
 529     static void SplitPath(const wxString& fullpath,
 530                           wxString *path,
 531                           wxString *name,
 532                           wxString *ext,
 533                           wxPathFormat format = wxPATH_NATIVE);
 534
 535         // split a path into volume and pure path part
 536     static void SplitVolume(const wxString& fullpathWithVolume,
 537                             wxString *volume,
 538                             wxString *path,
 539                             wxPathFormat format = wxPATH_NATIVE);
 540
 541         // strip the file extension: "foo.bar" => "foo" (but ".baz" => ".baz")
 542     static wxString StripExtension(const wxString& fullpath);
 543
 544 #ifdef wxHAS_FILESYSTEM_VOLUMES
 545         // return the string representing a file system volume, or drive
 546     static wxString GetVolumeString(char drive, int flags = wxPATH_GET_SEPARATOR);
 547 #endif // wxHAS_FILESYSTEM_VOLUMES
 548
 549     // File size
 550
 551 #if wxUSE_LONGLONG
 552         // returns the size of the given filename
 553     wxULongLong GetSize() const;
 554     static wxULongLong GetSize(const wxString &file);
 555
 556         // returns the size in a human readable form
 557     wxString
 558     GetHumanReadableSize(const wxString& nullsize = _("Not available"),
 559                          int precision = 1,
 560                          wxSizeConvention conv = wxSIZE_CONV_TRADITIONAL) const;
 561     static wxString
 562     GetHumanReadableSize(const wxULongLong& sz,
 563                          const wxString& nullsize = _("Not available"),
 564                          int precision = 1,
 565                          wxSizeConvention conv = wxSIZE_CONV_TRADITIONAL);
 566 #endif // wxUSE_LONGLONG
 567
 568
 569     // deprecated methods, don't use any more
 570     // --------------------------------------
 571
 572 #ifndef __DIGITALMARS__
 573     wxString GetPath( bool withSep, wxPathFormat format = wxPATH_NATIVE ) const
 574         { return GetPath(withSep ? wxPATH_GET_SEPARATOR : 0, format); }
 575 #endif
 576     wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const
 577         { return GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, format); }
 578
 579 private:
 580     // check whether this dir is valid for Append/Prepend/InsertDir()
 581     static bool IsValidDirComponent(const wxString& dir);
 582
 583     // the drive/volume/device specification (always empty for Unix)
 584     wxString        m_volume;
 585
 586     // the path components of the file
 587     wxArrayString   m_dirs;
 588
 589     // the file name and extension (empty for directories)
 590     wxString        m_name,
 591                     m_ext;
 592
 593     // when m_dirs is empty it may mean either that we have no path at all or
 594     // that our path is '/', i.e. the root directory
 595     //
 596     // we use m_relative to distinguish between these two cases, it will be
 597     // true in the former and false in the latter
 598     //
 599     // NB: the path is not absolute just because m_relative is false, it still
 600     //     needs the drive (i.e. volume) in some formats (Windows)
 601     bool            m_relative;
 602
 603     // when m_ext is empty, it may be because we don't have any extension or
 604     // because we have an empty extension
 605     //
 606     // the difference is important as file with name "foo" and without
 607     // extension has full name "foo" while with empty extension it is "foo."
 608     bool            m_hasExt;
 609 };
 610
 611 #endif // _WX_FILENAME_H_
 612