added wxEncodingToCodepage() and implemented it properly (using in32 API instead...

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

diff --git a/include/wx/filename.h b/include/wx/filename.h
index cf6cd1d18e74fb6a43d84019d1a7ae83c1babe05..36680b9fcb6db27bbe0f10d1105fbf105814e5c1 100644 (file)
--- a/include/wx/filename.h
+++ b/include/wx/filename.h
@@ -36,6 +36,7 @@
 
 // ridiculously enough, this will replace DirExists with wxDirExists etc
 #include "wx/filefn.h"
 
 // ridiculously enough, this will replace DirExists with wxDirExists etc
 #include "wx/filefn.h"

+#include "wx/datetime.h"

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -50,6 +51,7 @@ enum wxPathFormat
     wxPATH_UNIX,
     wxPATH_MAC,
     wxPATH_DOS,
     wxPATH_UNIX,
     wxPATH_MAC,
     wxPATH_DOS,

+    wxPATH_VMS,

 
     wxPATH_BEOS = wxPATH_UNIX,
     wxPATH_WIN = wxPATH_DOS,
 
     wxPATH_BEOS = wxPATH_UNIX,
     wxPATH_WIN = wxPATH_DOS,


@@ -94,6 +96,14 @@ public:
                wxPathFormat format = wxPATH_NATIVE)
         { Assign(path, name, format); }
 
                wxPathFormat format = wxPATH_NATIVE)
         { Assign(path, name, format); }
 

+        // from a volume, directory name, file base name and extension
+    wxFileName(const wxString& volume,
+               const wxString& path,
+               const wxString& name,
+               const wxString& ext,
+               wxPathFormat format = wxPATH_NATIVE)
+        { Assign(volume, path, name, ext, format); }
+

         // from a directory name, file base name and extension
     wxFileName(const wxString& path,
                const wxString& name,
         // from a directory name, file base name and extension
     wxFileName(const wxString& path,
                const wxString& name,


@@ -101,31 +111,41 @@ public:
                wxPathFormat format = wxPATH_NATIVE)
         { Assign(path, name, ext, format); }
 
                wxPathFormat format = wxPATH_NATIVE)
         { Assign(path, name, ext, format); }
 

-        // assorted assignment operators
-
-    wxFileName& operator=(const wxFileName& filename)
-        { Assign(filename); return *this; }
-
-    wxFileName& operator=(const wxString& filename)
-        { Assign(filename); return *this; }
-

         // the same for delayed initialization
 
         // the same for delayed initialization
 

-        // VZ: wouldn't it be better to call this Create() for consistency with
-        //     all GUI classes? Personally, I like Set() more than Assign() too
-

     void Assign(const wxFileName& filepath);
     void Assign(const wxFileName& filepath);

+

     void Assign(const wxString& fullpath,
                 wxPathFormat format = wxPATH_NATIVE);
     void Assign(const wxString& fullpath,
                 wxPathFormat format = wxPATH_NATIVE);

+
+    void Assign(const wxString& volume,
+                const wxString& path,
+                const wxString& name,
+                const wxString& ext,
+                wxPathFormat format = wxPATH_NATIVE);
+

     void Assign(const wxString& path,
                 const wxString& name,
                 wxPathFormat format = wxPATH_NATIVE);
     void Assign(const wxString& path,
                 const wxString& name,
                 wxPathFormat format = wxPATH_NATIVE);

+

     void Assign(const wxString& path,
                 const wxString& name,
                 const wxString& ext,
     void Assign(const wxString& path,
                 const wxString& name,
                 const wxString& ext,

-                wxPathFormat format = wxPATH_NATIVE);
-    void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE)
-        { Assign(dir, _T(""), format); }
+                wxPathFormat format = wxPATH_NATIVE)
+    {
+        // empty volume
+        Assign(_T(""), path, name, ext, format);
+    }
+
+    void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE);
+
+        // assorted assignment operators
+
+    wxFileName& operator=(const wxFileName& filename)
+        { Assign(filename); return *this; }
+
+    wxFileName& operator=(const wxString& filename)
+        { Assign(filename); return *this; }

 
         // reset all components to default, uninitialized state
     void Clear();
 
         // reset all components to default, uninitialized state
     void Clear();


@@ -134,7 +154,7 @@ public:
     static wxFileName FileName(const wxString& file);
     static wxFileName DirName(const wxString& dir);
 
     static wxFileName FileName(const wxString& file);
     static wxFileName DirName(const wxString& dir);
 

-    // test for existence
+    // file tests

 
         // is the filename valid at all?
     bool IsOk() const { return !m_dirs.IsEmpty() || !m_name.IsEmpty(); }
 
         // is the filename valid at all?
     bool IsOk() const { return !m_dirs.IsEmpty() || !m_name.IsEmpty(); }


@@ -149,11 +169,36 @@ public:
 
         // VZ: also need: IsDirWritable(), IsFileExecutable() &c (TODO)
 
 
         // VZ: also need: IsDirWritable(), IsFileExecutable() &c (TODO)
 

+    // time functions
+
+        // set the file creation and last access/mod times
+        // (any of the pointers may be NULL)
+    bool SetTimes(const wxDateTime *dtCreate,
+                  const wxDateTime *dtAccess,
+                  const wxDateTime *dtMod);
+
+        // set the access and modification times to the current moment
+    bool Touch();
+
+        // return the last access, last modification and last change times
+        // (any of the pointers may be NULL)
+    bool GetTimes(wxDateTime *dtAccess,
+                  wxDateTime *dtMod,
+                  wxDateTime *dtChange) const;
+
+        // convenience wrapper: get just the last mod time of the file
+    wxDateTime GetModificationTime() const
+    {
+        wxDateTime dtMod;
+        (void)GetTimes(NULL, &dtMod, NULL);
+        return dtMod;
+    }
+

     // various file/dir operations
 
         // retrieve the value of the current working directory
     // various file/dir operations
 
         // retrieve the value of the current working directory

-    void AssignCwd();
-    static wxString GetCwd();
+    void AssignCwd(const wxString& volume = wxEmptyString);
+    static wxString GetCwd(const wxString& volume = wxEmptyString);

 
         // change the current working directory
     bool SetCwd();
 
         // change the current working directory
     bool SetCwd();


@@ -163,8 +208,9 @@ public:
     void AssignHomeDir();
     static wxString GetHomeDir();
 
     void AssignHomeDir();
     static wxString GetHomeDir();
 

-        // get a temp file name starting with thespecified prefix
-    void AssignTempFileName( const wxString &prefix );
+        // get a temp file name starting with the specified prefix
+    void AssignTempFileName(const wxString& prefix);
+    static wxString CreateTempFileName(const wxString& prefix);

 
     // directory creation and removal.
     // if full is TRUE, will try to make each directory in the path.
 
     // directory creation and removal.
     // if full is TRUE, will try to make each directory in the path.


@@ -185,22 +231,46 @@ public:
                    const wxString& cwd = wxEmptyString,
                    wxPathFormat format = wxPATH_NATIVE);
 
                    const wxString& cwd = wxEmptyString,
                    wxPathFormat format = wxPATH_NATIVE);
 

+        // get a path path relative to the given base directory, i.e. opposite
+        // of Normalize
+        //
+        // pass an empty string to get a path relative to the working directory
+        //
+        // returns TRUE if the file name was modified, FALSE if we failed to do
+        // anything with it (happens when the file is on a different volume,
+        // for example)
+    bool MakeRelativeTo(const wxString& pathBase = _T(""),
+                        wxPathFormat format = wxPATH_NATIVE);
+
+

     // Comparison
 
     // Comparison
 

+        // compares with the rules of this platform
+    bool SameAs(const wxFileName &filepath,
+                wxPathFormat format = wxPATH_NATIVE);
+

         // uses the current platform settings
     bool operator==(const wxFileName& filename) { return SameAs(filename); }
     bool operator==(const wxString& filename)
         { return *this == wxFileName(filename); }
 
         // uses the current platform settings
     bool operator==(const wxFileName& filename) { return SameAs(filename); }
     bool operator==(const wxString& filename)
         { return *this == wxFileName(filename); }
 

-        // compares with the rules of this platform
-    bool SameAs(const wxFileName &filepath,
-                wxPathFormat format = wxPATH_NATIVE);
-

     // Tests
     // Tests

+
+        // are the file names of this type cases sensitive?

     static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE );
     static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE );

-    bool IsRelative( wxPathFormat format = wxPATH_NATIVE );
+
+        // is this filename absolute?

     bool IsAbsolute( wxPathFormat format = wxPATH_NATIVE );
 
     bool IsAbsolute( wxPathFormat format = wxPATH_NATIVE );
 

+        // is this filename relative?
+    bool IsRelative( wxPathFormat format = wxPATH_NATIVE )
+        { return !IsAbsolute(format); }
+
+    // Information about path format
+
+    // get the string separating the volume from the path for this format
+    static wxString GetVolumeSeparator(wxPathFormat format = wxPATH_NATIVE);
+

     // get the string of path separators for this format
     static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE);
 
     // get the string of path separators for this format
     static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE);
 


@@ -220,17 +290,21 @@ public:
     // Other accessors
     void SetExt( const wxString &ext )          { m_ext = ext; }
     wxString GetExt() const                     { return m_ext; }
     // Other accessors
     void SetExt( const wxString &ext )          { m_ext = ext; }
     wxString GetExt() const                     { return m_ext; }

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

 
     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; }

-    bool HasName() const                        { return !m_name.IsEmpty(); }
+    bool HasName() const                        { return !m_name.empty(); }
+
+    void SetVolume( const wxString &volume )    { m_volume = volume; }
+    wxString GetVolume() const                  { return m_volume; }
+    bool HasVolume() const                      { return !m_volume.empty(); }

 
     // full name is the file name + extension (but without the path)
     void SetFullName(const wxString& fullname);
     wxString GetFullName() const;
 
 
     // full name is the file name + extension (but without the path)
     void SetFullName(const wxString& fullname);
     wxString GetFullName() const;
 

-    const wxArrayString &GetDirs() const        { return m_dirs; }
+    const wxArrayString& GetDirs() const        { return m_dirs; }

 
     // Construct path only - possibly with the trailing separator
     wxString GetPath( bool add_separator = FALSE,
 
     // Construct path only - possibly with the trailing separator
     wxString GetPath( bool add_separator = FALSE,


@@ -254,8 +328,16 @@ public:
         // get the canonical path format for this platform
     static wxPathFormat GetFormat( wxPathFormat format = wxPATH_NATIVE );
 
         // get the canonical path format for this platform
     static wxPathFormat GetFormat( wxPathFormat format = wxPATH_NATIVE );
 

-        // split a fullpath into path, (base) name and ext (all of the pointers
-        // can be NULL)
+        // split a fullpath into the volume, path, (base) name and extension
+        // (all of the pointers can be NULL)
+    static void SplitPath(const wxString& fullpath,
+                          wxString *volume,
+                          wxString *path,
+                          wxString *name,
+                          wxString *ext,
+                          wxPathFormat format = wxPATH_NATIVE);
+
+        // compatibility version

     static void SplitPath(const wxString& fullpath,
                           wxString *path,
                           wxString *name,
     static void SplitPath(const wxString& fullpath,
                           wxString *path,
                           wxString *name,


@@ -263,6 +345,9 @@ public:
                           wxPathFormat format = wxPATH_NATIVE);
 
 private:
                           wxPathFormat format = wxPATH_NATIVE);
 
 private:

+    // the drive/volume/device specification (always empty for Unix)
+    wxString        m_volume;
+

     // the path components of the file
     wxArrayString   m_dirs;
 
     // the path components of the file
     wxArrayString   m_dirs;