add an assert indicating that old code overriding OnExecute() must be updated with 2.9

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

diff --git a/include/wx/filename.h b/include/wx/filename.h
index 5154ed057e2ee248d852f9be1bd36944fdb05921..023366e020ea3a5201a371ad8abd1adf097bd492 100644 (file)
--- a/include/wx/filename.h
+++ b/include/wx/filename.h
@@ -19,9 +19,7 @@
     2. more file operations:
         a) chmod()
         b) [acm]time() - get and set
-        c) file permissions with readable accessors for most common bits
-           such as IsReadable() &c
-        d) rename()?
+        c) rename()?
     3. SameFileAs() function to compare inodes under Unix
  */
 
@@ -29,9 +27,14 @@
 #include "wx/filefn.h"
 #include "wx/datetime.h"
 #include "wx/intl.h"
+#include "wx/longlong.h"
 
 #if wxUSE_FILE
-class WXDLLIMPEXP_BASE wxFile;
+class WXDLLIMPEXP_FWD_BASE wxFile;
+#endif
+
+#if wxUSE_FFILE
+class WXDLLIMPEXP_FWD_BASE wxFFile;
 #endif
 
 // ----------------------------------------------------------------------------
@@ -82,8 +85,11 @@ enum
     wxPATH_MKDIR_FULL    = 0x0001   // create directories recursively
 };
 
+#if wxUSE_LONGLONG
 // error code of wxFileName::GetSize()
-extern wxULongLong wxInvalidSize;
+extern WXDLLIMPEXP_DATA_BASE(const wxULongLong) wxInvalidSize;
+#endif // wxUSE_LONGLONG
+
 
 
 // ----------------------------------------------------------------------------
@@ -193,7 +199,28 @@ public:
     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
@@ -246,15 +273,33 @@ public:
     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)
-    void AssignTempFileName(const wxString& prefix, wxFile *fileTemp = NULL);
+    void AssignTempFileName(const wxString& prefix, wxFile *fileTemp);
     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);
     static bool Mkdir( const wxString &dir, int perm = 0777, int flags = 0 );
@@ -347,7 +392,7 @@ public:
     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?
@@ -441,6 +486,7 @@ public:
 
     // Filesize
 
+#if wxUSE_LONGLONG
         // returns the size of the given filename
     wxULongLong GetSize() const;
     static wxULongLong GetSize(const wxString &file);
@@ -451,6 +497,7 @@ public:
     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