interface/wx/filename.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        filename.h
   3 // Purpose:     interface of wxFileName
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /**
  11     The various values for the path format: this mainly affects the path
  12     separator but also whether or not the path has the drive part
  13     (as under Windows).
  14
  15     See wxFileName for more info.
  16 */
  17 enum wxPathFormat
  18 {
  19     wxPATH_NATIVE = 0,      //!< the path format for the current platform.
  20     wxPATH_UNIX,
  21     wxPATH_BEOS = wxPATH_UNIX,
  22     wxPATH_MAC,
  23     wxPATH_DOS,
  24     wxPATH_WIN = wxPATH_DOS,
  25     wxPATH_OS2 = wxPATH_DOS,
  26     wxPATH_VMS,
  27
  28     wxPATH_MAX   //!< Not a valid value for specifying path format
  29 };
  30
  31 /**
  32     Different conventions for human readable sizes.
  33
  34     @see wxFileName::GetHumanReadableSize().
  35
  36     @since 2.9.1
  37 */
  38 enum wxSizeConvention
  39 {
  40     /// 1024 bytes = 1KB.
  41     wxSIZE_CONV_TRADITIONAL,
  42
  43     /// 1024 bytes = 1KiB.
  44     wxSIZE_CONV_IEC,
  45
  46     /// 1000 bytes = 1KB.
  47     wxSIZE_CONV_SI
  48 };
  49
  50
  51 /**
  52     The kind of normalization to do with the file name: these values can be
  53     or'd together to perform several operations at once.
  54     See wxFileName::Normalize() for more info.
  55 */
  56 enum wxPathNormalize
  57 {
  58     //! Replace environment variables with their values.
  59     //! wxFileName understands both Unix and Windows (but only under Windows) environment
  60     //! variables expansion: i.e. @c "$var", @c "$(var)" and @c "${var}" are always understood
  61     //! and in addition under Windows @c "%var%" is also.
  62     wxPATH_NORM_ENV_VARS = 0x0001,
  63
  64     wxPATH_NORM_DOTS     = 0x0002,  //!< Squeeze all @c ".." and @c ".".
  65     wxPATH_NORM_TILDE    = 0x0004,  //!< Replace @c "~" and @c "~user" (Unix only).
  66     wxPATH_NORM_CASE     = 0x0008,  //!< If the platform is case insensitive, make lowercase the path.
  67     wxPATH_NORM_ABSOLUTE = 0x0010,  //!< Make the path absolute.
  68     wxPATH_NORM_LONG =     0x0020,  //!< Expand the path to the "long" form (Windows only).
  69     wxPATH_NORM_SHORTCUT = 0x0040,  //!< Resolve the shortcut, if it is a shortcut (Windows only).
  70
  71     //! A value indicating all normalization flags except for @c wxPATH_NORM_CASE.
  72     wxPATH_NORM_ALL      = 0x00ff & ~wxPATH_NORM_CASE
  73 };
  74
  75 /**
  76     Flags for wxFileName::Rmdir().
  77  */
  78 enum
  79 {
  80     /// Delete the specified directory and its subdirectories if they are empty.
  81     wxPATH_RMDIR_FULL = 1,
  82
  83     /**
  84       Delete the specified directory and all the files and subdirectories in it
  85       recursively.
  86
  87       This flag is obviously @b dangerous and should be used with care and
  88       after asking the user for confirmation.
  89      */
  90     wxPATH_RMDIR_RECURSIVE = 2
  91 };
  92
  93 /**
  94     The return value of wxFileName::GetSize() in case of error.
  95 */
  96 wxULongLong wxInvalidSize;
  97
  98
  99 /**
 100     @class wxFileName
 101
 102     wxFileName encapsulates a file name.
 103
 104     This class serves two purposes: first, it provides the functions to split the
 105     file names into components and to recombine these components in the full file
 106     name which can then be passed to the OS file functions
 107     (and @ref group_funcmacro_file "wxWidgets functions" wrapping them).
 108     Second, it includes the functions for working with the files itself. Note that
 109     to change the file data you should use wxFile class instead.
 110     wxFileName provides functions for working with the file attributes.
 111
 112     When working with directory names (i.e. without filename and extension)
 113     make sure not to misuse the file name part of this class with the last
 114     directory. Instead initialize the wxFileName instance like this:
 115
 116     @code
 117     wxFileName dirname( "C:\mydir", "" );
 118     MyMethod( dirname.GetPath() );
 119     @endcode
 120
 121     The same can be done using the static method wxFileName::DirName():
 122
 123     @code
 124     wxFileName dirname = wxFileName::DirName( "C:\mydir" );
 125     MyMethod( dirname.GetPath() );
 126     @endcode
 127
 128     Accordingly, methods dealing with directories or directory names like
 129     wxFileName::IsDirReadable() use wxFileName::GetPath() whereas methods dealing
 130     with file names like wxFileName::IsFileReadable() use wxFileName::GetFullPath().
 131
 132     If it is not known whether a string contains a directory name or a complete
 133     file name (such as when interpreting user input) you need to use the static
 134     function wxFileName::DirExists() (or its identical variants wxDir::Exists() and
 135     wxDirExists()) and construct the wxFileName instance accordingly.
 136     This will only work if the directory actually exists, of course:
 137
 138     @code
 139     wxString user_input;
 140     // get input from user
 141
 142     wxFileName fname;
 143     if (wxDirExists(user_input))
 144         fname.AssignDir( user_input );
 145     else
 146         fname.Assign( user_input );
 147     @endcode
 148
 149     Please note that many wxFileName methods accept the path format argument
 150     which is by @c wxPATH_NATIVE by default meaning to use the path format
 151     native for the current platform.
 152     The path format affects the operation of wxFileName functions in several ways:
 153     first and foremost, it defines the path separator character to use, but it
 154     also affects other things such as whether the path has the drive part or not.
 155     See wxPathFormat for more info.
 156
 157
 158     @section filename_format File name format
 159
 160     wxFileName currently supports the file names in the Unix, DOS/Windows,
 161     Mac OS and VMS formats. Although these formats are quite different,
 162     wxFileName tries to treat them all in the same generic way.
 163     It supposes that all file names consist of the following parts: the volume
 164     (also known as drive under Windows or device under VMS), the path which is
 165     a sequence of directory names separated by the path separators and the full
 166     filename itself which, in turn, is composed from the base file name and the
 167     extension. All of the individual components of the file name may be empty
 168     and, for example, the volume name is always empty under Unix, but if they
 169     are all empty simultaneously, the filename object is considered to be in an
 170     invalid state and wxFileName::IsOk() returns false for it.
 171
 172     File names can be case-sensitive or not, the function wxFileName::IsCaseSensitive()
 173     allows to determine this. The rules for determining whether the file name is
 174     absolute or relative also depend on the file name format and the only portable way
 175     to answer this question is to use wxFileName::IsAbsolute() or wxFileName::IsRelative()
 176     method.
 177
 178     Note that on Windows,"X:" refers to the current working directory on drive X.
 179     Therefore, a wxFileName instance constructed from for example "X:dir/file.ext"
 180     treats the portion beyond drive separator as being relative to that directory.
 181     To ensure that the filename is absolute, you may use wxFileName::MakeAbsolute().
 182     There is also an inverse function wxFileName::MakeRelativeTo() which undoes
 183     what wxFileName::Normalize(wxPATH_NORM_DOTS) does.
 184     Other functions returning information about the file format provided by this
 185     class are wxFileName::GetVolumeSeparator(), wxFileName::IsPathSeparator().
 186
 187
 188     @section filename_construction File name construction
 189
 190     You can initialize a wxFileName instance using one of the following functions:
 191
 192     @li wxFileName::wxFileName()
 193     @li wxFileName::Assign()
 194     @li wxFileName::AssignCwd()
 195     @li wxFileName::AssignDir()
 196     @li wxFileName::AssignHomeDir()
 197     @li wxFileName::AssignTempFileName()
 198     @li wxFileName::DirName()
 199     @li wxFileName::FileName()
 200     @li wxFileName::operator=()
 201
 202
 203     @section filename_tests File name tests
 204
 205     Before doing other tests, you should use wxFileName::IsOk() to verify that
 206     the filename is well defined. If it is, FileExists() can be used to test whether
 207     a file with such name exists and wxFileName::DirExists() can be used to test
 208     for directory existence.
 209     File names should be compared using the wxFileName::SameAs() method or
 210     wxFileName::operator==(). For testing basic access modes, you can use:
 211
 212     @li wxFileName::IsDirWritable()
 213     @li wxFileName::IsDirReadable()
 214     @li wxFileName::IsFileWritable()
 215     @li wxFileName::IsFileReadable()
 216     @li wxFileName::IsFileExecutable()
 217
 218
 219     @section filename_components File name components
 220
 221     These functions allow to examine and modify the individual directories
 222     of the path:
 223
 224     @li wxFileName::AppendDir()
 225     @li wxFileName::InsertDir()
 226     @li wxFileName::GetDirCount()
 227     @li wxFileName::PrependDir()
 228     @li wxFileName::RemoveDir()
 229     @li wxFileName::RemoveLastDir()
 230
 231     To change the components of the file name individually you can use the
 232     following functions:
 233
 234     @li wxFileName::GetExt()
 235     @li wxFileName::GetName()
 236     @li wxFileName::GetVolume()
 237     @li wxFileName::HasExt()
 238     @li wxFileName::HasName()
 239     @li wxFileName::HasVolume()
 240     @li wxFileName::SetExt()
 241     @li wxFileName::ClearExt()
 242     @li wxFileName::SetEmptyExt()
 243     @li wxFileName::SetName()
 244     @li wxFileName::SetVolume()
 245
 246     You can initialize a wxFileName instance using one of the following functions:
 247
 248
 249     @section filename_operations File name operations
 250
 251     These methods allow to work with the file creation, access and modification
 252     times. Note that not all filesystems under all platforms implement these times
 253     in the same way. For example, the access time under Windows has a resolution of
 254     one day (so it is really the access date and not time). The access time may be
 255     updated when the file is executed or not depending on the platform.
 256
 257     @li wxFileName::GetModificationTime()
 258     @li wxFileName::GetTimes()
 259     @li wxFileName::SetTimes()
 260     @li wxFileName::Touch()
 261
 262     Other file system operations functions are:
 263
 264     @li wxFileName::Mkdir()
 265     @li wxFileName::Rmdir()
 266
 267
 268     @library{wxbase}
 269     @category{file}
 270 */
 271 class wxFileName
 272 {
 273 public:
 274     /**
 275         Default constructor.
 276     */
 277     wxFileName();
 278
 279     /**
 280         Copy constructor.
 281     */
 282     wxFileName(const wxFileName& filename);
 283
 284     /**
 285         Constructor taking a full filename.
 286
 287         If it terminates with a '/', a directory path is constructed
 288         (the name will be empty), otherwise a file name and extension
 289         are extracted from it.
 290     */
 291     wxFileName(const wxString& fullpath,
 292                wxPathFormat format = wxPATH_NATIVE);
 293
 294     /**
 295         Constructor a directory name and file name.
 296     */
 297     wxFileName(const wxString& path, const wxString& name,
 298                wxPathFormat format = wxPATH_NATIVE);
 299
 300     /**
 301         Constructor from a directory name, base file name and extension.
 302     */
 303     wxFileName(const wxString& path, const wxString& name,
 304                const wxString& ext,
 305                wxPathFormat format = wxPATH_NATIVE);
 306
 307     /**
 308         Constructor from a volume name, a directory name, base file name and extension.
 309     */
 310     wxFileName(const wxString& volume, const wxString& path,
 311                const wxString& name,
 312                const wxString& ext,
 313                wxPathFormat format = wxPATH_NATIVE);
 314
 315     /**
 316         Appends a directory component to the path. This component should contain a
 317         single directory name level, i.e. not contain any path or volume separators nor
 318         should it be empty, otherwise the function does nothing (and generates an
 319         assert failure in debug build).
 320     */
 321     void AppendDir(const wxString& dir);
 322
 323     /**
 324         Creates the file name from another filename object.
 325     */
 326     void Assign(const wxFileName& filepath);
 327
 328     /**
 329         Creates the file name from a full file name with a path.
 330     */
 331     void Assign(const wxString& fullpath,
 332                 wxPathFormat format = wxPATH_NATIVE);
 333
 334     /**
 335         Creates the file name from volume, path, name and extension.
 336     */
 337     void Assign(const wxString& volume, const wxString& path,
 338                 const wxString& name,
 339                 const wxString& ext,
 340                 bool hasExt,
 341                 wxPathFormat format = wxPATH_NATIVE);
 342
 343     /**
 344         Creates the file name from volume, path, name and extension.
 345     */
 346     void Assign(const wxString& volume, const wxString& path,
 347                 const wxString& name,
 348                 const wxString& ext,
 349                 wxPathFormat format = wxPATH_NATIVE);
 350
 351     /**
 352         Creates the file name from file path and file name.
 353     */
 354     void Assign(const wxString& path, const wxString& name,
 355                 wxPathFormat format = wxPATH_NATIVE);
 356
 357     /**
 358         Creates the file name from path, name and extension.
 359     */
 360     void Assign(const wxString& path, const wxString& name,
 361                 const wxString& ext,
 362                 wxPathFormat format = wxPATH_NATIVE);
 363
 364     /**
 365         Makes this object refer to the current working directory on the specified
 366         volume (or current volume if @a volume is empty).
 367
 368         @see GetCwd()
 369     */
 370     void AssignCwd(const wxString& volume = wxEmptyString);
 371
 372     /**
 373         Sets this file name object to the given directory name.
 374         The name and extension will be empty.
 375     */
 376     void AssignDir(const wxString& dir,
 377                    wxPathFormat format = wxPATH_NATIVE);
 378
 379     /**
 380         Sets this file name object to the home directory.
 381     */
 382     void AssignHomeDir();
 383
 384     /**
 385         The function calls CreateTempFileName() to create a temporary file
 386         and sets this object to the name of the file.
 387
 388         If a temporary file couldn't be created, the object is put into
 389         an invalid state (see IsOk()).
 390     */
 391     void AssignTempFileName(const wxString& prefix);
 392
 393     /**
 394         The function calls CreateTempFileName() to create a temporary
 395         file name and open @a fileTemp with it.
 396
 397         If the file couldn't be opened, the object is put into
 398         an invalid state (see IsOk()).
 399     */
 400     void AssignTempFileName(const wxString& prefix, wxFile* fileTemp);
 401
 402     /**
 403         The function calls CreateTempFileName() to create a temporary
 404         file name and open @a fileTemp with it.
 405
 406         If the file couldn't be opened, the object is put into
 407         an invalid state (see IsOk()).
 408     */
 409     void AssignTempFileName(const wxString& prefix, wxFFile* fileTemp);
 410
 411     /**
 412         Reset all components to default, uninitialized state.
 413     */
 414     void Clear();
 415
 416     /**
 417         Removes the extension from the file name resulting in a
 418         file name with no trailing dot.
 419
 420         @see SetExt(), SetEmptyExt()
 421     */
 422     void ClearExt();
 423
 424     //@{
 425     /**
 426         Returns a temporary file name starting with the given @e prefix.
 427         If the @a prefix is an absolute path, the temporary file is created in this
 428         directory, otherwise it is created in the default system directory for the
 429         temporary files or in the current directory.
 430
 431         If the function succeeds, the temporary file is actually created.
 432         If @a fileTemp is not @NULL, this file will be opened using the name of
 433         the temporary file. When possible, this is done in an atomic way ensuring that
 434         no race condition occurs between the temporary file name generation and opening
 435         it which could often lead to security compromise on the multiuser systems.
 436         If @a fileTemp is @NULL, the file is only created, but not opened.
 437         Under Unix, the temporary file will have read and write permissions for the
 438         owner only to minimize the security problems.
 439
 440         @param prefix
 441             Prefix to use for the temporary file name construction
 442         @param fileTemp
 443             The file to open or @NULL to just get the name
 444
 445         @return The full temporary file name or an empty string on error.
 446     */
 447     static wxString CreateTempFileName(const wxString& prefix,
 448                                        wxFile* fileTemp = NULL);
 449     static wxString CreateTempFileName(const wxString& prefix,
 450                                        wxFFile* fileTemp = NULL);
 451     //@}
 452
 453     /**
 454         Returns @true if the directory with this name exists.
 455
 456         Notice that this function tests the directory part of this object,
 457         i.e. the string returned by GetPath(), and not the full path returned
 458         by GetFullPath().
 459
 460         @see FileExists(), Exists()
 461     */
 462     bool DirExists() const;
 463
 464     /**
 465         Returns @true if the directory with name @a dir exists.
 466
 467         @see FileExists(), Exists()
 468     */
 469     static bool DirExists(const wxString& dir);
 470
 471     /**
 472         Returns the object corresponding to the directory with the given name.
 473         The @a dir parameter may have trailing path separator or not.
 474     */
 475     static wxFileName DirName(const wxString& dir,
 476                               wxPathFormat format = wxPATH_NATIVE);
 477
 478     /**
 479         Calls the static overload of this function with the full path of this
 480         object.
 481
 482         @since 2.9.4
 483      */
 484     bool Exists() const;
 485
 486     /**
 487         Returns @true if either a file or a directory or something else with
 488         this name exists in the file system.
 489
 490         This method is equivalent to @code FileExists() || DirExists() @endcode
 491         under most systems but under Unix it also returns true if the file
 492         identifies a special file system object such as a device, a socket or a
 493         FIFO.
 494
 495         @since 2.9.4
 496
 497         @see FileExists(), DirExists()
 498      */
 499     static bool Exists(const wxString& path);
 500
 501     /**
 502         Returns @true if the file with this name exists.
 503
 504         @see DirExists(), Exists()
 505     */
 506     bool FileExists() const;
 507
 508     /**
 509         Returns @true if the file with name @a file exists.
 510
 511         @see DirExists(), Exists()
 512     */
 513     static bool FileExists(const wxString& file);
 514
 515     /**
 516         Returns the file name object corresponding to the given @e file. This
 517         function exists mainly for symmetry with DirName().
 518     */
 519     static wxFileName FileName(const wxString& file,
 520                                wxPathFormat format = wxPATH_NATIVE);
 521
 522     /**
 523         Retrieves the value of the current working directory on the specified volume.
 524         If the volume is empty, the program's current working directory is returned for
 525         the current volume.
 526
 527         @return The string containing the current working directory or an empty
 528                 string on error.
 529
 530         @see AssignCwd()
 531     */
 532     static wxString GetCwd(const wxString& volume = wxEmptyString);
 533
 534     /**
 535         Returns the number of directories in the file name.
 536     */
 537     size_t GetDirCount() const;
 538
 539     /**
 540         Returns the directories in string array form.
 541     */
 542     const wxArrayString& GetDirs() const;
 543
 544     /**
 545         Returns the file name extension.
 546     */
 547     wxString GetExt() const;
 548
 549     /**
 550         Returns the characters that can't be used in filenames and directory names
 551         for the specified format.
 552     */
 553     static wxString GetForbiddenChars(wxPathFormat format = wxPATH_NATIVE);
 554
 555     /**
 556         Returns the canonical path format for this platform.
 557     */
 558     static wxPathFormat GetFormat(wxPathFormat format = wxPATH_NATIVE);
 559
 560     /**
 561         Returns the full name (including extension but excluding directories).
 562     */
 563     wxString GetFullName() const;
 564
 565     /**
 566         Returns the full path with name and extension.
 567     */
 568     wxString GetFullPath(wxPathFormat format = wxPATH_NATIVE) const;
 569
 570     /**
 571         Returns the home directory.
 572     */
 573     static wxString GetHomeDir();
 574
 575     //@{
 576     /**
 577         Returns the representation of the file size in a human-readable form.
 578
 579         In the first version, the size of this file is used. In the second one,
 580         the specified size @a bytes is used.
 581
 582         If the file size could not be retrieved or @a bytes is ::wxInvalidSize
 583         or zero, the @c failmsg string is returned.
 584
 585         Otherwise the returned string is a floating-point number with @c
 586         precision decimal digits followed by the abbreviation of the unit used.
 587         By default the traditional, although incorrect, convention of using SI
 588         units for multiples of 1024 is used, i.e. returned string will use
 589         suffixes of B, KB, MB, GB, TB for bytes, kilobytes, megabytes,
 590         gigabytes and terabytes respectively. With the IEC convention the names
 591         of the units are changed to B, KiB, MiB, GiB and TiB for bytes,
 592         kibibytes, mebibytes, gibibytes and tebibytes. Finally, with SI
 593         convention the same B, KB, MB, GB and TB suffixes are used but in their
 594         correct SI meaning, i.e. as multiples of 1000 and not 1024.
 595
 596         Support for the different size conventions is new in wxWidgets 2.9.1,
 597         in previous versions only the traditional convention was implemented.
 598     */
 599     wxString
 600     GetHumanReadableSize(const wxString& failmsg = _("Not available"),
 601                          int precision = 1,
 602                          wxSizeConvention conv = wxSIZE_CONV_TRADITIONAL) const;
 603
 604     static wxString
 605     GetHumanReadableSize(const wxULongLong& bytes,
 606                          const wxString& nullsize = _("Not available"),
 607                          int precision = 1,
 608                          wxSizeConvention conv = wxSIZE_CONV_TRADITIONAL);
 609     //@}
 610
 611     /**
 612         Return the long form of the path (returns identity on non-Windows platforms).
 613     */
 614     wxString GetLongPath() const;
 615
 616     /**
 617         Returns the last time the file was last modified.
 618     */
 619     wxDateTime GetModificationTime() const;
 620
 621     /**
 622         Returns the name part of the filename (without extension).
 623
 624         @see GetFullName()
 625     */
 626     wxString GetName() const;
 627
 628     /**
 629         Returns the path part of the filename (without the name or extension).
 630
 631         The possible flags values are:
 632
 633         - @b wxPATH_GET_VOLUME:
 634         Return the path with the volume (does nothing for the filename formats
 635         without volumes), otherwise the path without volume part is returned.
 636
 637         - @b wxPATH_GET_SEPARATOR:
 638         Return the path with the trailing separator, if this flag is not given
 639         there will be no separator at the end of the path.
 640
 641         - @b wxPATH_NO_SEPARATOR:
 642         Don't include the trailing separator in the returned string. This is
 643         the default (the value of this flag is 0) and exists only for symmetry
 644         with wxPATH_GET_SEPARATOR.
 645
 646         @note If the path is a toplevel one (e.g. @c "/" on Unix or @c "C:\" on
 647               Windows), then the returned path will contain trailing separator
 648               even with @c wxPATH_NO_SEPARATOR.
 649     */
 650     wxString GetPath(int flags = wxPATH_GET_VOLUME,
 651                      wxPathFormat format = wxPATH_NATIVE) const;
 652
 653     /**
 654         Returns the usually used path separator for this format.
 655         For all formats but @c wxPATH_DOS there is only one path separator anyhow,
 656         but for DOS there are two of them and the native one, i.e. the backslash
 657         is returned by this method.
 658
 659         @see GetPathSeparators()
 660     */
 661     static wxUniChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE);
 662
 663     /**
 664         Returns the string containing all the path separators for this format.
 665         For all formats but @c wxPATH_DOS this string contains only one character
 666         but for DOS and Windows both @c '/' and @c '\' may be used as separators.
 667
 668         @see GetPathSeparator()
 669     */
 670     static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE);
 671
 672     /**
 673         Returns the string of characters which may terminate the path part.
 674         This is the same as GetPathSeparators() except for VMS
 675         path format where ] is used at the end of the path part.
 676     */
 677     static wxString GetPathTerminators(wxPathFormat format = wxPATH_NATIVE);
 678
 679     /**
 680         Returns the path with the trailing separator, useful for appending the name
 681         to the given path.
 682
 683         This is the same as calling
 684         @code
 685         GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, format)
 686         @endcode
 687     */
 688     wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE) const;
 689
 690     /**
 691         Return the short form of the path (returns identity on non-Windows platforms).
 692     */
 693     wxString GetShortPath() const;
 694
 695     /**
 696         Returns the size of the file If the file does not exist or its size could
 697         not be read (because e.g. the file is locked by another process) the returned
 698         value is ::wxInvalidSize.
 699     */
 700     wxULongLong GetSize() const;
 701
 702     /**
 703         Returns the size of the file If the file does not exist or its size could
 704         not be read (because e.g. the file is locked by another process) the returned
 705         value is ::wxInvalidSize.
 706     */
 707     static wxULongLong GetSize(const wxString& filename);
 708
 709     /**
 710         Returns the directory used for temporary files.
 711     */
 712     static wxString GetTempDir();
 713
 714     /**
 715         Returns the last access, last modification and creation times.
 716         The last access time is updated whenever the file is read or written
 717         (or executed in the case of Windows), last modification time is only
 718         changed when the file is written to.
 719         Finally, the creation time is indeed the time when the file was created
 720         under Windows and the inode change time under Unix (as it is impossible to
 721         retrieve the real file creation time there anyhow) which can also be changed
 722         by many operations after the file creation.
 723
 724         If no filename or extension is specified in this instance of wxFileName
 725         (and therefore IsDir() returns @true) then this function will return the
 726         directory times of the path specified by GetPath(), otherwise the file
 727         times of the file specified by GetFullPath().
 728         Any of the pointers may be @NULL if the corresponding time is not needed.
 729
 730         @return @true on success, @false if we failed to retrieve the times.
 731     */
 732     bool GetTimes(wxDateTime* dtAccess, wxDateTime* dtMod,
 733                   wxDateTime* dtCreate) const;
 734
 735     /**
 736         Returns the string containing the volume for this file name, empty if it
 737         doesn't have one or if the file system doesn't support volumes at all
 738         (for example, Unix).
 739     */
 740     wxString GetVolume() const;
 741
 742     /**
 743         Returns the string separating the volume from the path for this format.
 744     */
 745     static wxString GetVolumeSeparator(wxPathFormat format = wxPATH_NATIVE);
 746
 747      /**
 748         This function builds a volume path string, for example "C:\\".
 749
 750         Implemented for the platforms which use drive letters, i.e. DOS, MSW
 751         and OS/2 only.
 752
 753         @since 2.9.0
 754
 755         @param drive
 756             The drive letter, 'A' through 'Z' or 'a' through 'z'.
 757
 758         @param flags
 759             @c wxPATH_NO_SEPARATOR or @c wxPATH_GET_SEPARATOR to omit or include
 760             the trailing path separator, the default is to include it.
 761
 762         @return Volume path string.
 763     */
 764     static wxString GetVolumeString(char drive, int flags = wxPATH_GET_SEPARATOR);
 765
 766     /**
 767         Returns @true if an extension is present.
 768     */
 769     bool HasExt() const;
 770
 771     /**
 772         Returns @true if a name is present.
 773     */
 774     bool HasName() const;
 775
 776     /**
 777         Returns @true if a volume specifier is present.
 778     */
 779     bool HasVolume() const;
 780
 781     /**
 782         Inserts a directory component before the zero-based position in the directory
 783         list. Please see AppendDir() for important notes.
 784     */
 785     void InsertDir(size_t before, const wxString& dir);
 786
 787     /**
 788         Returns @true if this filename is absolute.
 789     */
 790     bool IsAbsolute(wxPathFormat format = wxPATH_NATIVE) const;
 791
 792     /**
 793         Returns @true if the file names of this type are case-sensitive.
 794     */
 795     static bool IsCaseSensitive(wxPathFormat format = wxPATH_NATIVE);
 796
 797     /**
 798         Returns @true if this object represents a directory, @false otherwise
 799         (i.e. if it is a file).
 800
 801         Note that this method doesn't test whether the directory or file really
 802         exists, you should use DirExists() or FileExists() for this.
 803     */
 804     bool IsDir() const;
 805
 806     /**
 807         Returns @true if the directory component of this instance is an existing
 808         directory and this process has read permissions on it. Read permissions
 809         on a directory mean that you can list the directory contents but it
 810         doesn't imply that you have read permissions on the files contained.
 811     */
 812     bool IsDirReadable() const;
 813
 814     /**
 815         Returns @true if the given @e dir is an existing directory and this process
 816         has read permissions on it. Read permissions on a directory mean that you
 817         can list the directory contents but it doesn't imply that you have read
 818         permissions on the files contained.
 819     */
 820     static bool IsDirReadable(const wxString& dir);
 821
 822     /**
 823         Returns @true if the directory component of this instance
 824         is an existing directory and this process has write permissions on it.
 825         Write permissions on a directory mean that you can create new files in the
 826         directory.
 827     */
 828     bool IsDirWritable() const;
 829
 830     /**
 831         Returns @true if the  given @a dir is an existing directory and this
 832         process has write permissions on it.
 833         Write permissions on a directory mean that you can create new files in the
 834         directory.
 835     */
 836     static bool IsDirWritable(const wxString& dir);
 837
 838     /**
 839         Returns @true if a file with this name exists and if this process has execute
 840         permissions on it.
 841     */
 842     bool IsFileExecutable() const;
 843
 844     /**
 845         Returns @true if a file with this name exists and if this process has execute
 846         permissions on it.
 847     */
 848     static bool IsFileExecutable(const wxString& file);
 849
 850     /**
 851         Returns @true if a file with this name exists and if this process has read
 852         permissions on it.
 853     */
 854     bool IsFileReadable() const;
 855
 856     /**
 857         Returns @true if a file with this name exists and if this process has read
 858         permissions on it.
 859     */
 860     static bool IsFileReadable(const wxString& file);
 861
 862     /**
 863         Returns @true if a file with this name exists and if this process has write
 864         permissions on it.
 865     */
 866     bool IsFileWritable() const;
 867
 868     /**
 869         Returns @true if a file with this name exists and if this process has write
 870         permissions on it.
 871     */
 872     static bool IsFileWritable(const wxString& file);
 873
 874     /**
 875         Returns @true if the filename is valid, @false if it is not initialized yet.
 876         The assignment functions and Clear() may reset the object to the uninitialized,
 877         invalid state (the former only do it on failure).
 878     */
 879     bool IsOk() const;
 880
 881     /**
 882         Returns @true if the char is a path separator for this format.
 883     */
 884     static bool IsPathSeparator(wxChar ch,
 885                                 wxPathFormat format = wxPATH_NATIVE);
 886
 887     /**
 888         Returns @true if the volume part of the path is a unique volume name.
 889
 890         This function will always return @false if the path format is not
 891         wxPATH_DOS.
 892
 893         Unique volume names are Windows volume identifiers which remain the same
 894         regardless of where the volume is actually mounted. Example of a path
 895         using a volume name could be
 896         @code
 897             \\?\Volume{8089d7d7-d0ac-11db-9dd0-806d6172696f}\Program Files\setup.exe
 898         @endcode
 899
 900         @since 2.9.1
 901     */
 902     static bool IsMSWUniqueVolumeNamePath(const wxString& path,
 903                                           wxPathFormat format = wxPATH_NATIVE);
 904
 905     /**
 906         Returns @true if this filename is not absolute.
 907     */
 908     bool IsRelative(wxPathFormat format = wxPATH_NATIVE) const;
 909
 910     /**
 911         On Mac OS, gets the common type and creator for the given extension.
 912
 913         @onlyfor{wxosx}
 914     */
 915     static bool MacFindDefaultTypeAndCreator(const wxString& ext,
 916                                             wxUint32* type,
 917                                             wxUint32* creator);
 918
 919     /**
 920         On Mac OS, registers application defined extensions and their default type
 921         and creator.
 922
 923         @onlyfor{wxosx}
 924     */
 925     static void MacRegisterDefaultTypeAndCreator(const wxString& ext,
 926                                                 wxUint32 type,
 927                                                 wxUint32 creator);
 928
 929     /**
 930         On Mac OS, looks up the appropriate type and creator from the registration
 931         and then sets it.
 932
 933         @onlyfor{wxosx}
 934     */
 935     bool MacSetDefaultTypeAndCreator();
 936
 937     /**
 938         Make the file name absolute.
 939         This is a shortcut for
 940         @code
 941         wxFileName::Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE |
 942                               wxPATH_NORM_TILDE, cwd, format)
 943         @endcode
 944
 945         @see MakeRelativeTo(), Normalize(), IsAbsolute()
 946     */
 947     bool MakeAbsolute(const wxString& cwd = wxEmptyString,
 948                       wxPathFormat format = wxPATH_NATIVE);
 949
 950     /**
 951         This function tries to put this file name in a form relative to
 952         @a pathBase.
 953         In other words, it returns the file name which should be used to access
 954         this file if the current directory were pathBase.
 955
 956         @param pathBase
 957             The directory to use as root, current directory is used by default
 958         @param format
 959             The file name format, native by default
 960
 961         @return @true if the file name has been changed, @false if we failed to do
 962                 anything with it (currently this only happens if the file name
 963                 is on a volume different from the volume specified by @a pathBase).
 964
 965         @see Normalize()
 966     */
 967     bool MakeRelativeTo(const wxString& pathBase = wxEmptyString,
 968                         wxPathFormat format = wxPATH_NATIVE);
 969
 970     /**
 971         Creates a directory.
 972
 973         @param perm
 974             The permissions for the newly created directory.
 975             See the ::wxPosixPermissions enumeration for more info.
 976         @param flags
 977             If the flags contain @c wxPATH_MKDIR_FULL flag, try to create each
 978             directory in the path and also don't return an error if the target
 979             directory already exists.
 980
 981         @return Returns @true if the directory was successfully created, @false
 982                 otherwise.
 983     */
 984     bool Mkdir(int perm = wxS_DIR_DEFAULT, int flags = 0) const;
 985
 986     /**
 987         Creates a directory.
 988
 989         @param dir
 990             The directory to create
 991         @param perm
 992             The permissions for the newly created directory.
 993             See the ::wxPosixPermissions enumeration for more info.
 994         @param flags
 995             If the flags contain @c wxPATH_MKDIR_FULL flag, try to create each
 996             directory in the path and also don't return an error if the target
 997             directory already exists.
 998
 999         @return Returns @true if the directory was successfully created, @false
1000                 otherwise.
1001     */
1002     static bool Mkdir(const wxString& dir, int perm = wxS_DIR_DEFAULT,
1003                       int flags = 0);
1004
1005     /**
1006         Normalize the path.
1007
1008         With the default flags value, the path will be made absolute, without
1009         any ".." and "." and all environment variables will be expanded in it.
1010
1011         Notice that in some rare cases normalizing a valid path may result in
1012         an invalid wxFileName object. E.g. normalizing "./" path using
1013         wxPATH_NORM_DOTS but not wxPATH_NORM_ABSOLUTE will result in a
1014         completely empty and thus invalid object. As long as there is a non
1015         empty file name the result of normalization will be valid however.
1016
1017         @param flags
1018             The kind of normalization to do with the file name. It can be
1019             any or-combination of the ::wxPathNormalize enumeration values.
1020         @param cwd
1021             If not empty, this directory will be used instead of current
1022             working directory in normalization (see @c wxPATH_NORM_ABSOLUTE).
1023         @param format
1024             The file name format to use when processing the paths, native by default.
1025
1026         @return @true if normalization was successfully or @false otherwise.
1027     */
1028     bool Normalize(int flags = wxPATH_NORM_ALL,
1029                    const wxString& cwd = wxEmptyString,
1030                    wxPathFormat format = wxPATH_NATIVE);
1031
1032     /**
1033         Prepends a directory to the file path.
1034         Please see AppendDir() for important notes.
1035     */
1036     void PrependDir(const wxString& dir);
1037
1038     /**
1039         Removes the specified directory component from the path.
1040
1041         @see GetDirCount()
1042     */
1043     void RemoveDir(size_t pos);
1044
1045     /**
1046         Removes last directory component from the path.
1047     */
1048     void RemoveLastDir();
1049
1050     /**
1051         If the path contains the value of the environment variable named @a envname
1052         then this function replaces it with the string obtained from
1053         wxString::Format(replacementFmtString, value_of_envname_variable).
1054
1055         This function is useful to make the path shorter or to make it dependent
1056         from a certain environment variable.
1057         Normalize() with @c wxPATH_NORM_ENV_VARS can perform the opposite of this
1058         function (depending on the value of @a replacementFmtString).
1059
1060         The name and extension of this filename are not modified.
1061
1062         Example:
1063         @code
1064             wxFileName fn("/usr/openwin/lib/someFile");
1065             fn.ReplaceEnvVariable("OPENWINHOME");
1066                     // now fn.GetFullPath() == "$OPENWINHOME/lib/someFile"
1067         @endcode
1068
1069         @since 2.9.0
1070
1071         @return @true if the operation was successful (which doesn't mean
1072                 that something was actually replaced, just that ::wxGetEnv
1073                 didn't fail).
1074     */
1075     bool ReplaceEnvVariable(const wxString& envname,
1076                             const wxString& replacementFmtString = "$%s",
1077                             wxPathFormat format = wxPATH_NATIVE);
1078
1079     /**
1080         Replaces, if present in the path, the home directory for the given user
1081         (see ::wxGetHomeDir) with a tilde (~).
1082
1083         Normalize() with @c wxPATH_NORM_TILDE performs the opposite of this
1084         function.
1085
1086         The name and extension of this filename are not modified.
1087
1088         @since 2.9.0
1089
1090         @return @true if the operation was successful (which doesn't mean
1091                 that something was actually replaced, just that ::wxGetHomeDir
1092                 didn't fail).
1093     */
1094     bool ReplaceHomeDir(wxPathFormat format = wxPATH_NATIVE);
1095
1096
1097     /**
1098         Deletes the specified directory from the file system.
1099
1100         @param flags
1101             Can contain one of wxPATH_RMDIR_FULL or wxPATH_RMDIR_RECURSIVE. By
1102             default contains neither so the directory will not be removed
1103             unless it is empty.
1104
1105         @return Returns @true if the directory was successfully deleted, @false
1106                 otherwise.
1107     */
1108     bool Rmdir(int flags = 0) const;
1109
1110     /**
1111         Deletes the specified directory from the file system.
1112
1113         @param dir
1114             The directory to delete
1115         @param flags
1116             Can contain one of wxPATH_RMDIR_FULL or wxPATH_RMDIR_RECURSIVE. By
1117             default contains neither so the directory will not be removed
1118             unless it is empty.
1119
1120         @return Returns @true if the directory was successfully deleted, @false
1121                 otherwise.
1122     */
1123     static bool Rmdir(const wxString& dir, int flags = 0);
1124
1125     /**
1126         Compares the filename using the rules of this platform.
1127     */
1128     bool SameAs(const wxFileName& filepath,
1129                 wxPathFormat format = wxPATH_NATIVE) const;
1130
1131     /**
1132         Changes the current working directory.
1133     */
1134     bool SetCwd() const;
1135
1136     /**
1137         Changes the current working directory.
1138     */
1139     static bool SetCwd(const wxString& cwd);
1140
1141     /**
1142         Sets the extension of the file name to be an empty extension.
1143         This is different from having no extension at all as the file
1144         name will have a trailing dot after a call to this method.
1145
1146         @see SetExt(), ClearExt()
1147     */
1148     void SetEmptyExt();
1149
1150     /**
1151         Sets the extension of the file name.
1152
1153         Setting an empty string as the extension will remove the extension
1154         resulting in a file name without a trailing dot, unlike a call to
1155         SetEmptyExt().
1156
1157         @see SetEmptyExt(), ClearExt()
1158     */
1159     void SetExt(const wxString& ext);
1160
1161     /**
1162         The full name is the file name and extension (but without the path).
1163     */
1164     void SetFullName(const wxString& fullname);
1165
1166     /**
1167         Sets the name part (without extension).
1168
1169         @see SetFullName()
1170     */
1171     void SetName(const wxString& name);
1172
1173     /**
1174         Sets the path.
1175
1176         The @a path argument includes both the path and the volume, if
1177         supported by @a format.
1178
1179         Calling this function doesn't affect the name and extension components,
1180         to change them as well you can use Assign() or just an assignment
1181         operator.
1182
1183         @see GetPath()
1184      */
1185     void SetPath(const wxString& path, wxPathFormat format = wxPATH_NATIVE);
1186
1187     /**
1188         Sets the file creation and last access/modification times (any of the pointers
1189         may be @NULL).
1190     */
1191     bool SetTimes(const wxDateTime* dtAccess,
1192                   const wxDateTime* dtMod,
1193                   const wxDateTime* dtCreate) const;
1194
1195     /**
1196         Sets the volume specifier.
1197     */
1198     void SetVolume(const wxString& volume);
1199
1200     //@{
1201     /**
1202         This function splits a full file name into components: the volume (with the
1203         first version) path (including the volume in the second version), the base name
1204         and the extension.
1205
1206         Any of the output parameters (@e volume, @e path, @a name or @e ext) may
1207         be @NULL if you are not interested in the value of a particular component.
1208         Also, @a fullpath may be empty on entry.
1209         On return, @a path contains the file path (without the trailing separator),
1210         @a name contains the file name and @a ext contains the file extension
1211         without leading dot. All three of them may be empty if the corresponding
1212         component is. The old contents of the strings pointed to by these parameters
1213         will be overwritten in any case (if the pointers are not @NULL).
1214
1215         Note that for a filename "foo." the extension is present, as indicated by the
1216         trailing dot, but empty. If you need to cope with such cases, you should use
1217         @a hasExt instead of relying on testing whether @a ext is empty or not.
1218     */
1219     static void SplitPath(const wxString& fullpath,
1220                           wxString* volume,
1221                           wxString* path,
1222                           wxString* name,
1223                           wxString* ext,
1224                           bool* hasExt = NULL,
1225                           wxPathFormat format = wxPATH_NATIVE);
1226     static void SplitPath(const wxString& fullpath,
1227                           wxString* volume,
1228                           wxString* path,
1229                           wxString* name,
1230                           wxString* ext,
1231                           wxPathFormat format);
1232     static void SplitPath(const wxString& fullpath,
1233                           wxString* path,
1234                           wxString* name,
1235                           wxString* ext,
1236                           wxPathFormat format = wxPATH_NATIVE);
1237     //@}
1238
1239     /**
1240         Splits the given @a fullpath into the volume part (which may be empty) and
1241         the pure path part, not containing any volume.
1242
1243         @see SplitPath()
1244     */
1245     static void SplitVolume(const wxString& fullpath,
1246                             wxString* volume,
1247                             wxString* path,
1248                             wxPathFormat format = wxPATH_NATIVE);
1249
1250
1251     /**
1252         Strip the file extension.
1253
1254         This function does more than just removing everything after the last
1255         period from the string, for example it will return the string ".vimrc"
1256         unchanged because the part after the period is not an extension but the
1257         file name in this case. You can use wxString::BeforeLast() to really
1258         get just the part before the last period (but notice that that function
1259         returns empty string if period is not present at all unlike this
1260         function which returns the @a fullname unchanged in this case).
1261
1262         @param fullname
1263            File path including name and, optionally, extension.
1264
1265         @return
1266             File path without extension
1267
1268         @since 2.9.0
1269     */
1270     static wxString StripExtension(const wxString& fullname);
1271
1272     /**
1273         Sets the access and modification times to the current moment.
1274     */
1275     bool Touch() const;
1276
1277     /**
1278         Returns @true if the filenames are different. The string @e filenames
1279         is interpreted as a path in the native filename format.
1280     */
1281     bool operator!=(const wxFileName& filename) const;
1282
1283     /**
1284         Returns @true if the filenames are different. The string @e filenames
1285         is interpreted as a path in the native filename format.
1286     */
1287     bool operator!=(const wxString& filename) const;
1288
1289     /**
1290         Returns @true if the filenames are equal. The string @e filenames is
1291         interpreted as a path in the native filename format.
1292     */
1293     bool operator==(const wxFileName& filename) const;
1294
1295     /**
1296         Returns @true if the filenames are equal. The string @e filenames is
1297         interpreted as a path in the native filename format.
1298     */
1299     bool operator==(const wxString& filename) const;
1300
1301     /**
1302         Assigns the new value to this filename object.
1303     */
1304     wxFileName& operator=(const wxFileName& filename);
1305
1306     /**
1307         Assigns the new value to this filename object.
1308     */
1309     wxFileName& operator=(const wxString& filename);
1310 };