take old (wx 2.2? older?) wxGrid compatibility functions inside WXWIN_COMPATIBILITY_2...

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

diff --git a/include/wx/filename.h b/include/wx/filename.h
index cbd601e66328158215de9f913aa8dff9aea6d6cc..347b0ab621e7e4588a4dcb3a4535af39145db186 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,18 +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"
+
+#if wxUSE_FILE
+class WXDLLIMPEXP_FWD_BASE wxFile;
+#endif
+
+#if wxUSE_FFILE
+class WXDLLIMPEXP_FWD_BASE wxFFile;
+#endif

 
 

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

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


@@ -79,6 +81,7 @@ 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
 };


@@ -89,6 +92,13 @@ enum
     wxPATH_MKDIR_FULL    = 0x0001   // create directories recursively
 };
 
     wxPATH_MKDIR_FULL    = 0x0001   // create directories recursively
 };
 

+#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
 // ----------------------------------------------------------------------------


@@ -140,8 +150,16 @@ public:
                 const wxString& path,
                 const wxString& name,
                 const wxString& ext,
                 const wxString& path,
                 const wxString& name,
                 const wxString& ext,

+                bool hasExt,

                 wxPathFormat format = wxPATH_NATIVE);
 
                 wxPathFormat format = wxPATH_NATIVE);
 

+    void Assign(const wxString& volume,
+                const wxString& path,
+                const wxString& name,
+                const wxString& ext,
+                wxPathFormat format = wxPATH_NATIVE)
+        { Assign(volume, path, name, ext, !ext.empty(), format); }
+

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


@@ -149,11 +167,7 @@ public:
     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)
-    {
-        // empty volume
-        Assign(wxEmptyString, path, name, ext, format);
-    }
+                wxPathFormat format = wxPATH_NATIVE);

 
     void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE);
 
 
     void AssignDir(const wxString& dir, wxPathFormat format = wxPATH_NATIVE);
 


@@ -178,9 +192,10 @@ public:
 
         // is the filename valid at all?
     bool IsOk() const
 
         // is the filename valid at all?
     bool IsOk() const

-    { 
+    {

         // we're fine if we have the path or the name or if we're a root dir
         // 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;

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


@@ -191,7 +206,28 @@ public:
     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)
+        // 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


@@ -219,7 +255,7 @@ public:
     }
 #endif // wxUSE_DATETIME
 
     }
 #endif // wxUSE_DATETIME
 

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

     bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;
     bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) ;
     // gets the 'common' type and creator for a certain extension
     bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;
     bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) ;
     // gets the 'common' type and creator for a certain extension


@@ -244,12 +280,32 @@ public:
     void AssignHomeDir();
     static wxString GetHomeDir();
 
     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)
         // 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
+
+#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.
     bool Mkdir( int perm = 0777, int flags = 0);
 
     // directory creation and removal.
     bool Mkdir( int perm = 0777, int flags = 0);


@@ -338,24 +394,31 @@ public:
     // 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);
 

+    // get the string of path terminators, i.e. characters which terminate the
+    // path
+    static wxString GetPathTerminators(wxPathFormat format = wxPATH_NATIVE);
+

     // get the canonical path separator for this format
     // 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);
 
     // Dir accessors
         { return GetPathSeparators(format)[0u]; }
 
     // is the char a path separator for this format?
     static bool IsPathSeparator(wxChar ch, 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 );

     size_t GetDirCount() const { return m_dirs.size(); }
     size_t GetDirCount() const { return m_dirs.size(); }

+    void AppendDir(const wxString& dir);
+    void PrependDir(const wxString& dir);
+    void InsertDir(size_t before, const wxString& dir);
+    void RemoveDir(size_t pos);
+    void RemoveLastDir() { RemoveDir(GetDirCount() - 1); }

 
     // Other accessors
 
     // 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; }


@@ -402,15 +465,52 @@ public:
                           wxString *path,
                           wxString *name,
                           wxString *ext,
                           wxString *path,
                           wxString *name,
                           wxString *ext,

+                          bool *hasExt = NULL,

                           wxPathFormat format = wxPATH_NATIVE);
 
                           wxPathFormat format = wxPATH_NATIVE);
 

-        // compatibility version
+    static void SplitPath(const wxString& fullpath,
+                          wxString *volume,
+                          wxString *path,
+                          wxString *name,
+                          wxString *ext,
+                          wxPathFormat format)
+    {
+        SplitPath(fullpath, volume, path, name, ext, NULL, format);
+    }
+
+        // compatibility version: volume is part of path

     static void SplitPath(const wxString& fullpath,
                           wxString *path,
                           wxString *name,
                           wxString *ext,
                           wxPathFormat format = wxPATH_NATIVE);
 
     static void SplitPath(const wxString& fullpath,
                           wxString *path,
                           wxString *name,
                           wxString *ext,
                           wxPathFormat format = wxPATH_NATIVE);
 

+        // split a path into volume and pure path part
+    static void SplitVolume(const wxString& fullpathWithVolume,
+                            wxString *volume,
+                            wxString *path,
+                            wxPathFormat format = wxPATH_NATIVE);
+
+#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 = wxGetTranslation(_T("Not available")),
+                                  int precision = 1) const;
+    static wxString GetHumanReadableSize(const wxULongLong &sz,
+                                         const wxString &nullsize = wxGetTranslation(_T("Not available")),
+                                         int precision = 1);
+#endif // wxUSE_LONGLONG
+

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


@@ -420,7 +520,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()


@@ -445,6 +545,13 @@ private:
     // 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;
     // 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;

+
+    // when m_ext is empty, it may be because we don't have any extension or
+    // because we have an empty extension
+    //
+    // the difference is important as file with name "foo" and without
+    // extension has full name "foo" while with empty extension it is "foo."
+    bool            m_hasExt;

 };
 
 #endif // _WX_FILENAME_H_
 };
 
 #endif // _WX_FILENAME_H_