A better fix for wxHash{Map,Set} with g++ 4.7.

[wxWidgets.git] / include / wx / filename.h

diff --git a/include/wx/filename.h b/include/wx/filename.h
index 131b6fc51e38aa93e4d6146408837135145b9d48..b351bf4d7e7028342cf44bb75b38fa054a3746d2 100644 (file)
--- a/include/wx/filename.h
+++ b/include/wx/filename.h
@@ -12,15 +12,6 @@
 #ifndef   _WX_FILENAME_H_
 #define   _WX_FILENAME_H_
 
 #ifndef   _WX_FILENAME_H_
 #define   _WX_FILENAME_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "filename.h"
-#endif
-
-#ifndef WX_PRECOMP
-    #include  "wx/string.h"
-    #include  "wx/arrstr.h"
-#endif
-

 /*
     TODO:
 
 /*
     TODO:
 


@@ -28,19 +19,29 @@
     2. more file operations:
         a) chmod()
         b) [acm]time() - get and set
     2. more file operations:
         a) chmod()
         b) [acm]time() - get and set

-        c) file size
-        d) file permissions with readable accessors for most common bits
-           such as IsReadable() &c
-        e) rename()?
+        c) rename()?

     3. SameFileAs() function to compare inodes under Unix
  */
 
     3. SameFileAs() function to compare inodes under Unix
  */
 

-// ridiculously enough, this will replace DirExists with wxDirExists etc
+#include "wx/arrstr.h"

 #include "wx/filefn.h"
 #include "wx/datetime.h"
 #include "wx/filefn.h"
 #include "wx/datetime.h"

+#include "wx/intl.h"
+#include "wx/longlong.h"
+#include "wx/file.h"

 
 #if wxUSE_FILE
 
 #if wxUSE_FILE

-class WXDLLIMPEXP_BASE wxFile;
+class WXDLLIMPEXP_FWD_BASE wxFile;
+#endif
+
+#if wxUSE_FFILE
+class WXDLLIMPEXP_FWD_BASE wxFFile;
+#endif
+
+// this symbol is defined for the platforms where file systems use volumes in
+// paths
+#if defined(__WINDOWS__) || defined(__DOS__) || defined(__OS2__)
+    #define wxHAS_FILESYSTEM_VOLUMES

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -64,12 +65,20 @@ enum wxPathFormat
     wxPATH_MAX // Not a valid value for specifying path format
 };
 
     wxPATH_MAX // Not a valid value for specifying path format
 };
 

+// different conventions that may be used with GetHumanReadableSize()
+enum wxSizeConvention
+{
+    wxSIZE_CONV_TRADITIONAL,  // 1024 bytes = 1 KB
+    wxSIZE_CONV_IEC,          // 1024 bytes = 1 KiB
+    wxSIZE_CONV_SI            // 1000 bytes = 1 KB
+};
+

 // the kind of normalization to do with the file name: these values can be
 // or'd together to perform several operations at once
 enum wxPathNormalize
 {
     wxPATH_NORM_ENV_VARS = 0x0001,  // replace env vars with their values
 // the kind of normalization to do with the file name: these values can be
 // or'd together to perform several operations at once
 enum wxPathNormalize
 {
     wxPATH_NORM_ENV_VARS = 0x0001,  // replace env vars with their values

-    wxPATH_NORM_DOTS     = 0x0002,  // squeeze all .. and . and prepend cwd
+    wxPATH_NORM_DOTS     = 0x0002,  // squeeze all .. and .

     wxPATH_NORM_TILDE    = 0x0004,  // Unix only: replace ~ and ~user
     wxPATH_NORM_CASE     = 0x0008,  // if case insensitive => tolower
     wxPATH_NORM_ABSOLUTE = 0x0010,  // make the path absolute
     wxPATH_NORM_TILDE    = 0x0004,  // Unix only: replace ~ and ~user
     wxPATH_NORM_CASE     = 0x0008,  // if case insensitive => tolower
     wxPATH_NORM_ABSOLUTE = 0x0010,  // make the path absolute


@@ -81,16 +90,31 @@ enum wxPathNormalize
 // what exactly should GetPath() return?
 enum
 {
 // what exactly should GetPath() return?
 enum
 {

+    wxPATH_NO_SEPARATOR  = 0x0000,  // for symmetry with wxPATH_GET_SEPARATOR

     wxPATH_GET_VOLUME    = 0x0001,  // include the volume if applicable
     wxPATH_GET_SEPARATOR = 0x0002   // terminate the path with the separator
 };
 
     wxPATH_GET_VOLUME    = 0x0001,  // include the volume if applicable
     wxPATH_GET_SEPARATOR = 0x0002   // terminate the path with the separator
 };
 

-// MkDir flags
+// Mkdir flags

 enum
 {
     wxPATH_MKDIR_FULL    = 0x0001   // create directories recursively
 };
 
 enum
 {
     wxPATH_MKDIR_FULL    = 0x0001   // create directories recursively
 };
 

+// Rmdir flags
+enum
+{
+    wxPATH_RMDIR_FULL       = 0x0001,  // delete with subdirectories if empty
+    wxPATH_RMDIR_RECURSIVE  = 0x0002   // delete all recursively (dangerous!)
+};
+
+#if wxUSE_LONGLONG
+// error code of wxFileName::GetSize()
+extern WXDLLIMPEXP_DATA_BASE(const wxULongLong) wxInvalidSize;
+#endif // wxUSE_LONGLONG
+
+
+

 // ----------------------------------------------------------------------------
 // wxFileName: encapsulates a file path
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxFileName: encapsulates a file path
 // ----------------------------------------------------------------------------


@@ -166,7 +190,7 @@ public:
         // assorted assignment operators
 
     wxFileName& operator=(const wxFileName& filename)
         // assorted assignment operators
 
     wxFileName& operator=(const wxFileName& filename)

-        { Assign(filename); return *this; }
+        { if (this != &filename) Assign(filename); return *this; }

 
     wxFileName& operator=(const wxString& filename)
         { Assign(filename); return *this; }
 
     wxFileName& operator=(const wxString& filename)
         { Assign(filename); return *this; }


@@ -186,19 +210,46 @@ public:
     bool IsOk() const
     {
         // we're fine if we have the path or the name or if we're a root dir
     bool IsOk() const
     {
         // we're fine if we have the path or the name or if we're a root dir

-        return m_dirs.size() != 0 || !m_name.IsEmpty() || !m_relative ||
+        return m_dirs.size() != 0 || !m_name.empty() || !m_relative ||

                 !m_ext.empty() || m_hasExt;
     }
 
                 !m_ext.empty() || m_hasExt;
     }
 

-        // does the file with this name exists?
+        // does the file with this name exist?

     bool FileExists() const;
     static bool FileExists( const wxString &file );
 
     bool FileExists() const;
     static bool FileExists( const wxString &file );
 

-        // does the directory with this name exists?
+        // does the directory with this name exist?

     bool DirExists() const;
     static bool DirExists( const wxString &dir );
 
     bool DirExists() const;
     static bool DirExists( const wxString &dir );
 

-        // VZ: also need: IsDirWritable(), IsFileExecutable() &c (TODO)
+        // does anything at all with this name (i.e. file, directory or some
+        // other file system object such as a device, socket, ...) exist?
+    bool Exists() const { return Exists(GetFullPath()); }
+    static bool Exists(const wxString& path);
+
+
+        // checks on most common flags for files/directories;
+        // more platform-specific features (like e.g. Unix permissions) are not
+        // available in wxFileName
+
+    bool IsDirWritable() const { return wxIsWritable(GetPath()); }
+    static bool IsDirWritable(const wxString &path) { return wxDirExists(path) && wxIsWritable(path); }
+
+    bool IsDirReadable() const { return wxIsReadable(GetPath()); }
+    static bool IsDirReadable(const wxString &path) { return wxDirExists(path) && wxIsReadable(path); }
+
+    // NOTE: IsDirExecutable() is not present because the meaning of "executable"
+    //       directory is very platform-dependent and also not so useful
+
+    bool IsFileWritable() const { return wxIsWritable(GetFullPath()); }
+    static bool IsFileWritable(const wxString &path) { return wxFileExists(path) && wxIsWritable(path); }
+
+    bool IsFileReadable() const { return wxIsReadable(GetFullPath()); }
+    static bool IsFileReadable(const wxString &path) { return wxFileExists(path) && wxIsReadable(path); }
+
+    bool IsFileExecutable() const { return wxIsExecutable(GetFullPath()); }
+    static bool IsFileExecutable(const wxString &path) { return wxFileExists(path) && wxIsExecutable(path); }
+

 
     // time functions
 #if wxUSE_DATETIME
 
     // time functions
 #if wxUSE_DATETIME


@@ -206,10 +257,10 @@ public:
         // (any of the pointers may be NULL)
     bool SetTimes(const wxDateTime *dtAccess,
                   const wxDateTime *dtMod,
         // (any of the pointers may be NULL)
     bool SetTimes(const wxDateTime *dtAccess,
                   const wxDateTime *dtMod,

-                  const wxDateTime *dtCreate);
+                  const wxDateTime *dtCreate) const;

 
         // set the access and modification times to the current moment
 
         // set the access and modification times to the current moment

-    bool Touch();
+    bool Touch() const;

 
         // return the last access, last modification and create times
         // (any of the pointers may be NULL)
 
         // return the last access, last modification and create times
         // (any of the pointers may be NULL)


@@ -226,9 +277,9 @@ public:
     }
 #endif // wxUSE_DATETIME
 
     }
 #endif // wxUSE_DATETIME
 

-#ifdef __WXMAC__
+#if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON

     bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;
     bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;

-    bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) ;
+    bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) const;

     // gets the 'common' type and creator for a certain extension
     static bool MacFindDefaultTypeAndCreator( const wxString& ext , wxUint32 *type , wxUint32 *creator ) ;
     // registers application defined extensions and their default type and creator
     // gets the 'common' type and creator for a certain extension
     static bool MacFindDefaultTypeAndCreator( const wxString& ext , wxUint32 *type , wxUint32 *creator ) ;
     // registers application defined extensions and their default type and creator


@@ -244,28 +295,47 @@ public:
     static wxString GetCwd(const wxString& volume = wxEmptyString);
 
         // change the current working directory
     static wxString GetCwd(const wxString& volume = wxEmptyString);
 
         // change the current working directory

-    bool SetCwd();
+    bool SetCwd() const;

     static bool SetCwd( const wxString &cwd );
 
         // get the value of user home (Unix only mainly)
     void AssignHomeDir();
     static wxString GetHomeDir();
 
     static bool SetCwd( const wxString &cwd );
 
         // get the value of user home (Unix only mainly)
     void AssignHomeDir();
     static wxString GetHomeDir();
 

+        // get the system temporary directory
+    static wxString GetTempDir();
+
+#if wxUSE_FILE || wxUSE_FFILE
+        // get a temp file name starting with the specified prefix
+    void AssignTempFileName(const wxString& prefix);
+    static wxString CreateTempFileName(const wxString& prefix);
+#endif // wxUSE_FILE
+

 #if wxUSE_FILE
         // get a temp file name starting with the specified prefix and open the
         // file passed to us using this name for writing (atomically if
         // possible)
 #if wxUSE_FILE
         // get a temp file name starting with the specified prefix and open the
         // file passed to us using this name for writing (atomically if
         // possible)

-    void AssignTempFileName(const wxString& prefix, wxFile *fileTemp = NULL);
+    void AssignTempFileName(const wxString& prefix, wxFile *fileTemp);

     static wxString CreateTempFileName(const wxString& prefix,
     static wxString CreateTempFileName(const wxString& prefix,

-                                       wxFile *fileTemp = NULL);
+                                       wxFile *fileTemp);

 #endif // wxUSE_FILE
 
 #endif // wxUSE_FILE
 

+#if wxUSE_FFILE
+        // get a temp file name starting with the specified prefix and open the
+        // file passed to us using this name for writing (atomically if
+        // possible)
+    void AssignTempFileName(const wxString& prefix, wxFFile *fileTemp);
+    static wxString CreateTempFileName(const wxString& prefix,
+                                       wxFFile *fileTemp);
+#endif // wxUSE_FFILE
+

     // directory creation and removal.
     // directory creation and removal.

-    bool Mkdir( int perm = 0777, int flags = 0);
-    static bool Mkdir( const wxString &dir, int perm = 0777, int flags = 0 );
+    bool Mkdir(int perm = wxS_DIR_DEFAULT, int flags = 0) const;
+    static bool Mkdir(const wxString &dir, int perm = wxS_DIR_DEFAULT,
+                      int flags = 0);

 
 

-    bool Rmdir();
-    static bool Rmdir( const wxString &dir );
+    bool Rmdir(int flags = 0) const;
+    static bool Rmdir(const wxString &dir, int flags = 0);

 
     // operations on the path
 
 
     // operations on the path
 


@@ -302,9 +372,28 @@ public:
         // the arguments
     bool GetShortcutTarget(const wxString& shortcutPath,
                            wxString& targetFilename,
         // the arguments
     bool GetShortcutTarget(const wxString& shortcutPath,
                            wxString& targetFilename,

-                           wxString* arguments = NULL);
+                           wxString* arguments = NULL) const;
+#endif
+
+#ifndef __WXWINCE__
+        // if the path contains the value of the environment variable named envname
+        // then this function replaces it with the string obtained from
+        //    wxString::Format(replacementFmtString, value_of_envname_variable)
+        //
+        // Example:
+        //    wxFileName fn("/usr/openwin/lib/someFile");
+        //    fn.ReplaceEnvVariable("OPENWINHOME");
+        //         // now fn.GetFullPath() == "$OPENWINHOME/lib/someFile"
+    bool ReplaceEnvVariable(const wxString& envname,
+                            const wxString& replacementFmtString = "$%s",
+                            wxPathFormat format = wxPATH_NATIVE);

 #endif
 
 #endif
 

+        // replaces, if present in the path, the home directory for the given user
+        // (see wxGetHomeDir) with a tilde
+    bool ReplaceHomeDir(wxPathFormat format = wxPATH_NATIVE);
+
+

     // Comparison
 
         // compares with the rules of the given platforms format
     // Comparison
 
         // compares with the rules of the given platforms format


@@ -352,12 +441,17 @@ public:
     static wxString GetPathTerminators(wxPathFormat format = wxPATH_NATIVE);
 
     // get the canonical path separator for this format
     static wxString GetPathTerminators(wxPathFormat format = wxPATH_NATIVE);
 
     // get the canonical path separator for this format

-    static wxChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE)
+    static wxUniChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE)

         { return GetPathSeparators(format)[0u]; }
 
     // is the char a path separator for this format?
     static bool IsPathSeparator(wxChar ch, wxPathFormat format = wxPATH_NATIVE);
 
         { return GetPathSeparators(format)[0u]; }
 
     // is the char a path separator for this format?
     static bool IsPathSeparator(wxChar ch, wxPathFormat format = wxPATH_NATIVE);
 

+    // is this is a DOS path which beings with a windows unique volume name
+    // ('\\?\Volume{guid}\')?
+    static bool IsMSWUniqueVolumeNamePath(const wxString& path,
+                                          wxPathFormat format = wxPATH_NATIVE);
+

     // Dir accessors
     size_t GetDirCount() const { return m_dirs.size(); }
     void AppendDir(const wxString& dir);
     // Dir accessors
     size_t GetDirCount() const { return m_dirs.size(); }
     void AppendDir(const wxString& dir);


@@ -367,9 +461,11 @@ public:
     void RemoveLastDir() { RemoveDir(GetDirCount() - 1); }
 
     // Other accessors
     void RemoveLastDir() { RemoveDir(GetDirCount() - 1); }
 
     // Other accessors

-    void SetExt( const wxString &ext )          { m_ext = ext; }
+    void SetExt( const wxString &ext )          { m_ext = ext; m_hasExt = !m_ext.empty(); }
+    void ClearExt()                             { m_ext = wxEmptyString; m_hasExt = false; }
+    void SetEmptyExt()                          { m_ext = wxT(""); m_hasExt = true; }

     wxString GetExt() const                     { return m_ext; }
     wxString GetExt() const                     { return m_ext; }

-    bool HasExt() const                         { return !m_ext.empty(); }
+    bool HasExt() const                         { return m_hasExt; }

 
     void SetName( const wxString &name )        { m_name = name; }
     wxString GetName() const                    { return m_name; }
 
     void SetName( const wxString &name )        { m_name = name; }
     wxString GetName() const                    { return m_name; }


@@ -424,7 +520,7 @@ public:
                           wxString *path,
                           wxString *name,
                           wxString *ext,
                           wxString *path,
                           wxString *name,
                           wxString *ext,

-                          wxPathFormat format = wxPATH_NATIVE)
+                          wxPathFormat format)

     {
         SplitPath(fullpath, volume, path, name, ext, NULL, format);
     }
     {
         SplitPath(fullpath, volume, path, name, ext, NULL, format);
     }


@@ -442,6 +538,34 @@ public:
                             wxString *path,
                             wxPathFormat format = wxPATH_NATIVE);
 
                             wxString *path,
                             wxPathFormat format = wxPATH_NATIVE);
 

+        // strip the file extension: "foo.bar" => "foo" (but ".baz" => ".baz")
+    static wxString StripExtension(const wxString& fullpath);
+
+#ifdef wxHAS_FILESYSTEM_VOLUMES
+        // return the string representing a file system volume, or drive
+    static wxString GetVolumeString(char drive, int flags = wxPATH_GET_SEPARATOR);
+#endif // wxHAS_FILESYSTEM_VOLUMES
+
+    // File size
+
+#if wxUSE_LONGLONG
+        // returns the size of the given filename
+    wxULongLong GetSize() const;
+    static wxULongLong GetSize(const wxString &file);
+
+        // returns the size in a human readable form
+    wxString
+    GetHumanReadableSize(const wxString& nullsize = _("Not available"),
+                         int precision = 1,
+                         wxSizeConvention conv = wxSIZE_CONV_TRADITIONAL) const;
+    static wxString
+    GetHumanReadableSize(const wxULongLong& sz,
+                         const wxString& nullsize = _("Not available"),
+                         int precision = 1,
+                         wxSizeConvention conv = wxSIZE_CONV_TRADITIONAL);
+#endif // wxUSE_LONGLONG
+
+

     // deprecated methods, don't use any more
     // --------------------------------------
 
     // deprecated methods, don't use any more
     // --------------------------------------
 


@@ -450,7 +574,7 @@ public:
         { return GetPath(withSep ? wxPATH_GET_SEPARATOR : 0, format); }
 #endif
     wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const
         { return GetPath(withSep ? wxPATH_GET_SEPARATOR : 0, format); }
 #endif
     wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const

-        { return GetPath(wxPATH_GET_SEPARATOR, format); }
+        { return GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, format); }

 
 private:
     // check whether this dir is valid for Append/Prepend/InsertDir()
 
 private:
     // check whether this dir is valid for Append/Prepend/InsertDir()