Wrappers for *ToText

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

diff --git a/include/wx/filename.h b/include/wx/filename.h
index 9553b4c0e88854242631db301d6259e8b16fc623..cbd601e66328158215de9f913aa8dff9aea6d6cc 100644 (file)
--- a/include/wx/filename.h
+++ b/include/wx/filename.h
@@ -6,18 +6,19 @@
 // Created:     28.12.00
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 Robert Roebling
 // Created:     28.12.00
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 Robert Roebling

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _WX_FILENAME_H_
 #define   _WX_FILENAME_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _WX_FILENAME_H_
 #define   _WX_FILENAME_H_
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "filename.h"
 #endif
 
 #ifndef WX_PRECOMP
     #include  "wx/string.h"
     #pragma interface "filename.h"
 #endif
 
 #ifndef WX_PRECOMP
     #include  "wx/string.h"

+    #include  "wx/arrstr.h"

 #endif
 
 /*
 #endif
 
 /*


@@ -38,7 +39,7 @@
 #include "wx/filefn.h"
 #include "wx/datetime.h"
 
 #include "wx/filefn.h"
 #include "wx/datetime.h"
 

-class WXDLLEXPORT wxFile;
+class WXDLLIMPEXP_BASE wxFile;

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


@@ -51,13 +52,14 @@ enum wxPathFormat
 {
     wxPATH_NATIVE = 0,      // the path format for the current platform
     wxPATH_UNIX,
 {
     wxPATH_NATIVE = 0,      // the path format for the current platform
     wxPATH_UNIX,

+    wxPATH_BEOS = wxPATH_UNIX,

     wxPATH_MAC,
     wxPATH_DOS,
     wxPATH_MAC,
     wxPATH_DOS,

+    wxPATH_WIN = wxPATH_DOS,
+    wxPATH_OS2 = wxPATH_DOS,

     wxPATH_VMS,
 
     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
 };
 
 // the kind of normalization to do with the file name: these values can be


@@ -70,21 +72,35 @@ enum wxPathNormalize
     wxPATH_NORM_CASE     = 0x0008,  // if case insensitive => tolower
     wxPATH_NORM_ABSOLUTE = 0x0010,  // make the path absolute
     wxPATH_NORM_LONG =     0x0020,  // make the path the long form
     wxPATH_NORM_CASE     = 0x0008,  // if case insensitive => tolower
     wxPATH_NORM_ABSOLUTE = 0x0010,  // make the path absolute
     wxPATH_NORM_LONG =     0x0020,  // make the path the long form

-    wxPATH_NORM_ALL      = 0x003f
+    wxPATH_NORM_SHORTCUT = 0x0040,  // resolve the shortcut, if it is a shortcut
+    wxPATH_NORM_ALL      = 0x00ff & ~wxPATH_NORM_CASE
+};
+
+// what exactly should GetPath() return?
+enum
+{
+    wxPATH_GET_VOLUME    = 0x0001,  // include the volume if applicable
+    wxPATH_GET_SEPARATOR = 0x0002   // terminate the path with the separator
+};
+
+// MkDir flags
+enum
+{
+    wxPATH_MKDIR_FULL    = 0x0001   // create directories recursively

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

-class WXDLLEXPORT wxFileName
+class WXDLLIMPEXP_BASE wxFileName

 {
 public:
     // constructors and assignment
 
         // the usual stuff
 {
 public:
     // constructors and assignment
 
         // the usual stuff

-    wxFileName() { }
-    wxFileName( const wxFileName &filepath ) { Assign(filepath); }
+    wxFileName() { Clear(); }
+    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
 
         // from a full filename: if it terminates with a '/', a directory path
         // is contructed (the name will be empty), otherwise a file name and


@@ -136,7 +152,7 @@ public:
                 wxPathFormat format = wxPATH_NATIVE)
     {
         // empty volume
                 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);
     }
 
     void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE);


@@ -153,26 +169,32 @@ public:
     void Clear();
 
         // static pseudo constructors
     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?
 
     // file tests
 
         // is the filename valid at all?

-    bool IsOk() const { return !m_dirs.IsEmpty() || !m_name.IsEmpty(); }
+    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;
+    }

 
         // does the file with this name exists?
 
         // does the file with this name exists?

-    bool FileExists();
+    bool FileExists() const;

     static bool FileExists( const wxString &file );
 
         // does the directory with this name exists?
     static bool FileExists( const wxString &file );
 
         // does the directory with this name exists?

-    bool DirExists();
+    bool DirExists() const;

     static bool DirExists( const wxString &dir );
 
         // VZ: also need: IsDirWritable(), IsFileExecutable() &c (TODO)
 
     // time functions
     static bool DirExists( const wxString &dir );
 
         // VZ: also need: IsDirWritable(), IsFileExecutable() &c (TODO)
 
     // time functions

-
+#if wxUSE_DATETIME

         // set the file last access/mod and creation times
         // (any of the pointers may be NULL)
     bool SetTimes(const wxDateTime *dtAccess,
         // set the file last access/mod and creation times
         // (any of the pointers may be NULL)
     bool SetTimes(const wxDateTime *dtAccess,


@@ -195,6 +217,7 @@ public:
         (void)GetTimes(NULL, &dtMod, NULL);
         return dtMod;
     }
         (void)GetTimes(NULL, &dtMod, NULL);
         return dtMod;
     }

+#endif // wxUSE_DATETIME

 
 #ifdef __WXMAC__
     bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;
 
 #ifdef __WXMAC__
     bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;


@@ -206,6 +229,7 @@ public:
     // looks up the appropriate type and creator from the registration and then sets
     bool MacSetDefaultTypeAndCreator() ;
 #endif
     // looks up the appropriate type and creator from the registration and then sets
     bool MacSetDefaultTypeAndCreator() ;
 #endif

+

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


@@ -228,9 +252,8 @@ public:
                                        wxFile *fileTemp = NULL);
 
     // directory creation and removal.
                                        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, bool full = FALSE);
-    static bool Mkdir( const wxString &dir, int perm = 0777, bool full = FALSE );
+    bool Mkdir( int perm = 0777, int flags = 0);
+    static bool Mkdir( const wxString &dir, int perm = 0777, int flags = 0 );

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


@@ -251,23 +274,45 @@ public:
         //
         // pass an empty string to get a path relative to the working directory
         //
         //
         // 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)
         // 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);
 
                         wxPathFormat format = wxPATH_NATIVE);
 

+        // make the path absolute
+        //
+        // this may be done using another (than current) value of cwd
+    bool MakeAbsolute(const wxString& cwd = wxEmptyString,
+                      wxPathFormat format = wxPATH_NATIVE)
+        { return Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE |
+                           wxPATH_NORM_TILDE, cwd, format); }
+
+#if defined(__WIN32__) && !defined(__WXWINCE__) && wxUSE_OLE
+        // if the path is a shortcut, return the target and optionally,
+        // the arguments
+    bool GetShortcutTarget(const wxString& shortcutPath,
+                           wxString& targetFilename,
+                           wxString* arguments = NULL);
+#endif

 
     // Comparison
 
 
     // Comparison
 

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

 
 

-        // uses the current platform settings
-    bool operator==(const wxFileName& filename) { return SameAs(filename); }
-    bool operator==(const wxString& filename)
-        { return *this == wxFileName(filename); }
+        // compare with another filename object
+    bool operator==(const wxFileName& filename) const
+        { return SameAs(filename); }
+    bool operator!=(const wxFileName& filename) const
+        { return !SameAs(filename); }
+
+        // compare with a filename string interpreted as a native file name
+    bool operator==(const wxString& filename) const
+        { return SameAs(wxFileName(filename)); }
+    bool operator!=(const wxString& filename) const
+        { return !SameAs(wxFileName(filename)); }

 
         // are the file names of this type cases sensitive?
     static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE );
 
         // are the file names of this type cases sensitive?
     static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE );


@@ -279,6 +324,10 @@ public:
     bool IsRelative(wxPathFormat format = wxPATH_NATIVE) const
         { return !IsAbsolute(format); }
 
     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,
     // Information about path format
 
     // get the string separating the volume from the path for this format,


@@ -296,15 +345,12 @@ public:
     // is the char a path separator for this format?
     static bool IsPathSeparator(wxChar ch, wxPathFormat format = wxPATH_NATIVE);
 
     // is the char a path separator for this format?
     static bool IsPathSeparator(wxChar ch, wxPathFormat format = wxPATH_NATIVE);
 

-    // FIXME: what exactly does this do?
-    bool IsWild( wxPathFormat format = wxPATH_NATIVE );
-

     // Dir accessors
     void AppendDir( const wxString &dir );
     void PrependDir( const wxString &dir );
     void InsertDir( int before, const wxString &dir );
     void RemoveDir( int pos );
     // Dir accessors
     void AppendDir( const wxString &dir );
     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; }
 
     // Other accessors
     void SetExt( const wxString &ext )          { m_ext = ext; }


@@ -325,16 +371,13 @@ public:
 
     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,
-                      wxPathFormat format = wxPATH_NATIVE ) const;
+    // flags are combination of wxPATH_GET_XXX flags
+    wxString GetPath(int flags = wxPATH_GET_VOLUME,
+                     wxPathFormat format = wxPATH_NATIVE) const;
+

     // Replace current path with this one
     void SetPath( const wxString &path, wxPathFormat format = wxPATH_NATIVE );
 
     // Replace current path with this one
     void SetPath( const wxString &path, wxPathFormat format = wxPATH_NATIVE );
 

-    // more readable synonym
-    wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const
-        { return GetPath(TRUE /* add separator */, format); }
-

     // Construct full path with name and ext
     wxString GetFullPath( wxPathFormat format = wxPATH_NATIVE ) const;
 
     // Construct full path with name and ext
     wxString GetFullPath( wxPathFormat format = wxPATH_NATIVE ) const;
 


@@ -344,6 +387,9 @@ public:
     // Return the long form of the path (returns identity on non-Windows platforms)
     wxString GetLongPath() const;
 
     // Return the long form of the path (returns identity on non-Windows platforms)
     wxString GetLongPath() const;
 

+    // Is this a file or directory (not necessarily an existing one)
+    bool IsDir() const { return m_name.empty() && m_ext.empty(); }
+

     // various helpers
 
         // get the canonical path format for this platform
     // various helpers
 
         // get the canonical path format for this platform


@@ -365,7 +411,21 @@ public:
                           wxString *ext,
                           wxPathFormat format = wxPATH_NATIVE);
 
                           wxString *ext,
                           wxPathFormat format = wxPATH_NATIVE);
 

+
+    // deprecated methods, don't use any more
+    // --------------------------------------
+
+#ifndef __DIGITALMARS__
+    wxString GetPath( bool withSep, 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); }
+

 private:
 private:

+    // check whether this dir is valid for Append/Prepend/InsertDir()
+    static bool IsValidDirComponent(const wxString& dir);
+

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


@@ -380,9 +440,9 @@ private:
     // that our path is '/', i.e. the root directory
     //
     // we use m_relative to distinguish between these two cases, it will be
     // 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;
 };
     //     needs the drive (i.e. volume) in some formats (Windows)
     bool            m_relative;
 };