wxUSE_XML

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

diff --git a/include/wx/filename.h b/include/wx/filename.h
index e8a87042b8e95c3f5b588ea7846fdd2f4bab207b..401162c336c112e28a3f73eaed7eed5826f50e9f 100644 (file)
--- a/include/wx/filename.h
+++ b/include/wx/filename.h
@@ -18,6 +18,7 @@
 
 #ifndef WX_PRECOMP
     #include  "wx/string.h"
+    #include  "wx/arrstr.h"
 #endif
 
 /*
@@ -38,7 +39,7 @@
 #include "wx/filefn.h"
 #include "wx/datetime.h"
 
-class WXDLLEXPORT wxFile;
+class WXDLLIMPEXP_BASE wxFile;
 
 // ----------------------------------------------------------------------------
 // constants
@@ -51,13 +52,14 @@ enum wxPathFormat
 {
     wxPATH_NATIVE = 0,      // the path format for the current platform
     wxPATH_UNIX,
+    wxPATH_BEOS = wxPATH_UNIX,
     wxPATH_MAC,
     wxPATH_DOS,
+    wxPATH_WIN = wxPATH_DOS,
+    wxPATH_OS2 = wxPATH_DOS,
     wxPATH_VMS,
 
-    wxPATH_BEOS = wxPATH_UNIX,
-    wxPATH_WIN = wxPATH_DOS,
-    wxPATH_OS2 = wxPATH_DOS
+    wxPATH_MAX // Not a valid value for specifying path format
 };
 
 // the kind of normalization to do with the file name: these values can be
@@ -90,14 +92,14 @@ enum
 // wxFileName: encapsulates a file path
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxFileName
+class WXDLLIMPEXP_BASE wxFileName
 {
 public:
     // constructors and assignment
 
         // the usual stuff
     wxFileName() { Clear(); }
-    wxFileName( const wxFileName &filepath ) { Assign(filepath); }
+    wxFileName(const wxFileName& filepath) { Assign(filepath); }
 
         // from a full filename: if it terminates with a '/', a directory path
         // is contructed (the name will be empty), otherwise a file name and
@@ -149,7 +151,7 @@ public:
                 wxPathFormat format = wxPATH_NATIVE)
     {
         // empty volume
-        Assign(_T(""), path, name, ext, format);
+        Assign(wxEmptyString, path, name, ext, format);
     }
 
     void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE);
@@ -166,13 +168,15 @@ public:
     void Clear();
 
         // static pseudo constructors
-    static wxFileName FileName(const wxString& file);
-    static wxFileName DirName(const wxString& dir);
+    static wxFileName FileName(const wxString& file,
+                               wxPathFormat format = wxPATH_NATIVE);
+    static wxFileName DirName(const wxString& dir,
+                              wxPathFormat format = wxPATH_NATIVE);
 
     // file tests
 
         // is the filename valid at all?
-    bool IsOk() const { return !m_dirs.IsEmpty() || !m_name.IsEmpty(); }
+    bool IsOk() const { return m_dirs.size() != 0 || !m_name.IsEmpty(); }
 
         // does the file with this name exists?
     bool FileExists() const;
@@ -243,7 +247,6 @@ public:
                                        wxFile *fileTemp = NULL);
 
     // directory creation and removal.
-    // if full is TRUE, will try to make each directory in the path.
     bool Mkdir( int perm = 0777, int flags = 0);
     static bool Mkdir( const wxString &dir, int perm = 0777, int flags = 0 );
 
@@ -266,10 +269,10 @@ public:
         //
         // 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
+        // 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(""),
+    bool MakeRelativeTo(const wxString& pathBase = wxEmptyString,
                         wxPathFormat format = wxPATH_NATIVE);
 
         // make the path absolute
@@ -308,6 +311,10 @@ public:
     bool IsRelative(wxPathFormat format = wxPATH_NATIVE) const
         { return !IsAbsolute(format); }
 
+    // Returns the characters that aren't allowed in filenames
+    // on the specified platform.
+    static wxString GetForbiddenChars(wxPathFormat format = wxPATH_NATIVE);
+
     // Information about path format
 
     // get the string separating the volume from the path for this format,
@@ -330,7 +337,7 @@ public:
     void PrependDir( const wxString &dir );
     void InsertDir( int before, const wxString &dir );
     void RemoveDir( int pos );
-    size_t GetDirCount() const { return m_dirs.GetCount(); }
+    size_t GetDirCount() const { return m_dirs.size(); }
 
     // Other accessors
     void SetExt( const wxString &ext )          { m_ext = ext; }
@@ -416,9 +423,9 @@ private:
     // that our path is '/', i.e. the root directory
     //
     // we use m_relative to distinguish between these two cases, it will be
-    // TRUE in the former and FALSE in the latter
+    // true in the former and false in the latter
     //
-    // NB: the path is not absolute just because m_relative is FALSE, it still
+    // NB: the path is not absolute just because m_relative is false, it still
     //     needs the drive (i.e. volume) in some formats (Windows)
     bool            m_relative;
 };