Minor corrections to make dist after reports

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

diff --git a/include/wx/filename.h b/include/wx/filename.h
index 1d4f7f66d2fa6e3b53d697ea75f9bbc8d4b0d524..93b12c510733f9e528d2e8ff9bcc396384291044 100644 (file)
--- a/include/wx/filename.h
+++ b/include/wx/filename.h
@@ -19,19 +19,22 @@
     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
  */
 
 #include "wx/arrstr.h"
 #include "wx/filefn.h"
 #include "wx/datetime.h"
     3. SameFileAs() function to compare inodes under Unix
  */
 
 #include "wx/arrstr.h"
 #include "wx/filefn.h"
 #include "wx/datetime.h"

+#include "wx/intl.h"
+#include "wx/longlong.h"

 
 #if wxUSE_FILE
 
 #if wxUSE_FILE

-class WXDLLIMPEXP_BASE wxFile;
+class WXDLLIMPEXP_FWD_BASE wxFile;
+#endif
+
+#if wxUSE_FFILE
+class WXDLLIMPEXP_FWD_BASE wxFFile;

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -82,6 +85,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
 // ----------------------------------------------------------------------------


@@ -189,7 +199,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


@@ -217,7 +248,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


@@ -242,15 +273,33 @@ 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)
 #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,
     static wxString CreateTempFileName(const wxString& prefix,

-                                       wxFile *fileTemp = NULL);
+                                       wxFile *fileTemp);

 #endif // wxUSE_FILE
 
 #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 );
     // directory creation and removal.
     bool Mkdir( int perm = 0777, int flags = 0);
     static bool Mkdir( const wxString &dir, int perm = 0777, int flags = 0 );


@@ -343,7 +392,7 @@ public:
     static wxString GetPathTerminators(wxPathFormat format = wxPATH_NATIVE);
 
     // get the canonical path separator for this format
     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?
         { return GetPathSeparators(format)[0u]; }
 
     // is the char a path separator for this format?


@@ -435,6 +484,22 @@ public:
                             wxString *path,
                             wxPathFormat format = wxPATH_NATIVE);
 
                             wxString *path,
                             wxPathFormat format = wxPATH_NATIVE);
 

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