Override GetPixelSize on OS X as the base impl creates a wxScreenDC each time, which...

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

diff --git a/include/wx/filefn.h b/include/wx/filefn.h
index 945aee42a519bd376359f9c0ee223813b4fa38a4..eca68ca64b67b6e60eb72919847e9ea79b5f8320 100644 (file)
--- a/include/wx/filefn.h
+++ b/include/wx/filefn.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        filefn.h
+// Name:        wx/filefn.h

 // Purpose:     File- and directory-related functions
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     File- and directory-related functions
 // Author:      Julian Smart
 // Modified by:


@@ -12,10 +12,6 @@
 #ifndef   _FILEFN_H_
 #define   _FILEFN_H_
 
 #ifndef   _FILEFN_H_
 #define   _FILEFN_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "filefn.h"
-#endif
-

 #include "wx/list.h"
 #include "wx/arrstr.h"
 
 #include "wx/list.h"
 #include "wx/arrstr.h"
 


@@ -159,39 +155,43 @@ enum wxFileKind
     #define   wxRmDir      _wrmdir
     #define   wxStat       _wstat
     #define   wxStructStat struct _stat
     #define   wxRmDir      _wrmdir
     #define   wxStat       _wstat
     #define   wxStructStat struct _stat

-
-// Microsoft compiler loves underscores, feed them to it
-#elif defined( __VISUALC__ ) \
-    || ( defined(__MINGW32__) && !defined(__WINE__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
-    || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
-    || ( defined(__DMC__) && defined(__WXMSW__) ) \
-    || ( defined(__WATCOMC__) && defined(__WXMSW__) )
-
-    // detect compilers which have support for huge files (currently only
-    // Digital Mars doesn't)
-    #ifndef __WXPALMOS__
-    #include "wx/msw/private.h"
-    #endif
+#elif defined(__WXMSW__) && !defined(__WXPALMOS__) && \
+      ( \
+        defined(__VISUALC__) || \
+        (defined(__MINGW32__) && !defined(__WINE__) && \
+                                wxCHECK_W32API_VERSION(0, 5)) || \
+        defined(__MWERKS__) || \
+        defined(__DMC__) || \
+        defined(__WATCOMC__) || \
+        defined(__BORLANDC__) \
+      )

 
     #undef wxHAS_HUGE_FILES
 
     #undef wxHAS_HUGE_FILES

-    #if defined(__MINGW32__)
+
+    // detect compilers which have support for huge files (notice that the
+    // MSVC falls under _INTEGRAL_MAX_BITS >= 64 branch, so we don't have to
+    // test for it explicitly)
+    #if defined(_INTEGRAL_MAX_BITS)
+        #if _INTEGRAL_MAX_BITS >= 64
+            #define wxHAS_HUGE_FILES 1
+        #endif
+    #elif defined(__MINGW32__)

         #define wxHAS_HUGE_FILES 1
         #define wxHAS_HUGE_FILES 1

-    #elif defined(__MWERKS__)
-        #define wxHAS_HUGE_FILES 0
-    #elif defined(__DMC__)
-        #define wxHAS_HUGE_FILES 0
-    #elif ((_INTEGRAL_MAX_BITS >= 64) || defined(_LARGE_FILES))
+    #elif defined(_LARGE_FILES)

         #define wxHAS_HUGE_FILES 1
         #define wxHAS_HUGE_FILES 1

-    #else
-        #define wxHAS_HUGE_FILES 0

     #endif
 
     #endif
 

+    // other Windows compilers (DMC, Watcom, Metrowerks and Borland) don't have
+    // huge file support (or at least not all functions needed for it by wx)
+    // currently
+
+

     // functions
     #if defined(__BORLANDC__) || defined(__WATCOMC__)
         #define   _tell        tell
     #endif
 
     // functions
     #if defined(__BORLANDC__) || defined(__WATCOMC__)
         #define   _tell        tell
     #endif
 

-    #if wxHAS_HUGE_FILES
+    #ifdef wxHAS_HUGE_FILES

         typedef wxLongLong_t wxFileOffset;
         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
     #else
         typedef wxLongLong_t wxFileOffset;
         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
     #else


@@ -215,20 +215,22 @@ enum wxFileKind
             #define wxRead        ::read
             #define wxWrite       ::write
         #else
             #define wxRead        ::read
             #define wxWrite       ::write
         #else

-            #define wxRead        _read
+            #define wxRead         _read

             #define wxWrite        _write
         #endif
     #endif
             #define wxWrite        _write
         #endif
     #endif

-    #if wxHAS_HUGE_FILES
-        #define   wxSeek      _lseeki64
+    #ifdef wxHAS_HUGE_FILES
+        #define   wxSeek       _lseeki64

         #define   wxLseek      _lseeki64
         #define   wxTell       _telli64
         #define   wxLseek      _lseeki64
         #define   wxTell       _telli64

-    #else
-        #define   wxSeek      _lseek
+    #else // !wxHAS_HUGE_FILES
+        #define   wxSeek       _lseek

         #define   wxLseek      _lseek
         #define   wxTell       _tell
         #define   wxLseek      _lseek
         #define   wxTell       _tell

-    #endif
+    #endif // wxHAS_HUGE_FILES/!wxHAS_HUGE_FILES
+

     #define   wxFsync      _commit
     #define   wxFsync      _commit

+

     #if defined(__WATCOMC__)
         #define   wxEof        ::eof
     #else
     #if defined(__WATCOMC__)
         #define   wxEof        ::eof
     #else


@@ -237,12 +239,14 @@ enum wxFileKind
 
     #if wxUSE_UNICODE
         #if wxUSE_UNICODE_MSLU
 
     #if wxUSE_UNICODE
         #if wxUSE_UNICODE_MSLU

+            #include "wx/msw/mslu.h"
+

             #define   wxOpen       wxMSLU__wopen
 
             #define   wxAccess     wxMSLU__waccess
             #define   wxMkDir      wxMSLU__wmkdir
             #define   wxRmDir      wxMSLU__wrmdir
             #define   wxOpen       wxMSLU__wopen
 
             #define   wxAccess     wxMSLU__waccess
             #define   wxMkDir      wxMSLU__wmkdir
             #define   wxRmDir      wxMSLU__wrmdir

-            #if wxHAS_HUGE_FILES
+            #ifdef wxHAS_HUGE_FILES

                 #define   wxStat       wxMSLU__wstati64
             #else
                 #define   wxStat       wxMSLU__wstat
                 #define   wxStat       wxMSLU__wstati64
             #else
                 #define   wxStat       wxMSLU__wstat


@@ -252,7 +256,7 @@ enum wxFileKind
             #define   wxAccess     _waccess
             #define   wxMkDir      _wmkdir
             #define   wxRmDir      _wrmdir
             #define   wxAccess     _waccess
             #define   wxMkDir      _wmkdir
             #define   wxRmDir      _wrmdir

-            #if wxHAS_HUGE_FILES
+            #ifdef wxHAS_HUGE_FILES

                 #define   wxStat       _wstati64
             #else
                 #define   wxStat       _wstat
                 #define   wxStat       _wstati64
             #else
                 #define   wxStat       _wstat


@@ -271,23 +275,24 @@ enum wxFileKind
         #else
             #define   wxRmDir      _rmdir
         #endif
         #else
             #define   wxRmDir      _rmdir
         #endif

-        #if wxHAS_HUGE_FILES
+        #ifdef wxHAS_HUGE_FILES

             #define   wxStat       _stati64
         #else
             #define   wxStat       _stat
         #endif
             #define   wxStat       _stati64
         #else
             #define   wxStat       _stat
         #endif

-    #endif
+    #endif // wxUSE_UNICODE/!wxUSE_UNICODE

 
 

-    // types: notice that Watcom is the only compiler to have a wide char
-    // version of struct stat as well as a wide char stat function variant
-    #if wxHAS_HUGE_FILES
-        #if wxUSE_UNICODE && defined(__WATCOMC__)
+    // Types: Notice that Watcom is the only compiler to have a wide char
+    // version of struct stat as well as a wide char stat function variant.
+    // This was droped since OW 1.4 "for consistency across platforms".
+    #ifdef wxHAS_HUGE_FILES
+        #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)

             #define   wxStructStat struct _wstati64
         #else
             #define   wxStructStat struct _stati64
         #endif
     #else
             #define   wxStructStat struct _wstati64
         #else
             #define   wxStructStat struct _stati64
         #endif
     #else

-        #if wxUSE_UNICODE && defined(__WATCOMC__)
+        #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)

             #define   wxStructStat struct _wstat
         #else
             #define   wxStructStat struct _stat
             #define   wxStructStat struct _wstat
         #else
             #define   wxStructStat struct _stat


@@ -295,7 +300,7 @@ enum wxFileKind
     #endif
 
     // constants (unless already defined by the user code)
     #endif
 
     // constants (unless already defined by the user code)

-    #if !defined(__BORLANDC__) && !defined(__WATCOMC__) && !defined(__WXPALMOS__)
+    #if !defined(__BORLANDC__) && !defined(__WATCOMC__)

         #ifndef O_RDONLY
             #define   O_RDONLY    _O_RDONLY
             #define   O_WRONLY    _O_WRONLY
         #ifndef O_RDONLY
             #define   O_RDONLY    _O_RDONLY
             #define   O_WRONLY    _O_WRONLY


@@ -312,14 +317,31 @@ enum wxFileKind
         #endif
     #endif
 
         #endif
     #endif
 

-    // It's a private define, undefine it so nobody gets tempted to use it
+    #ifdef wxHAS_HUGE_FILES
+        // wxFile is present and supports large files. Currently wxFFile
+        // doesn't have large file support with any Windows compiler (even
+        // Win64 ones).
+        #if wxUSE_FILE
+            #define wxHAS_LARGE_FILES
+        #endif
+    #endif
+
+    // it's a private define, undefine it so that nobody gets tempted to use it

     #undef wxHAS_HUGE_FILES
     #undef wxHAS_HUGE_FILES

-#else // Unix platforms using configure
+#else // Unix or Windows using unknown compiler, assume POSIX supported

     typedef off_t wxFileOffset;
     #ifdef _LARGE_FILES
         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
         wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
                                 BadFileSizeType );
     typedef off_t wxFileOffset;
     #ifdef _LARGE_FILES
         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
         wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
                                 BadFileSizeType );

+        // wxFile is present and supports large files
+        #ifdef wxUSE_FILE
+            #define wxHAS_LARGE_FILES
+        #endif
+        // wxFFile is present and supports large files
+        #if SIZEOF_LONG == 8 || defined HAVE_FSEEKO
+            #define wxHAS_LARGE_FFILES
+        #endif

     #else
         #define wxFileOffsetFmtSpec _T("")
     #endif
     #else
         #define wxFileOffsetFmtSpec _T("")
     #endif


@@ -345,15 +367,31 @@ enum wxFileKind
             typedef unsigned long mode_t;
         #endif
         WXDLLIMPEXP_BASE int wxStat( const wxChar *file_name, wxStructStat *buf );
             typedef unsigned long mode_t;
         #endif
         WXDLLIMPEXP_BASE int wxStat( const wxChar *file_name, wxStructStat *buf );

+        WXDLLIMPEXP_BASE int wxLstat( const wxChar *file_name, wxStructStat *buf );

         WXDLLIMPEXP_BASE int wxAccess( const wxChar *pathname, int mode );
         WXDLLIMPEXP_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode );
     #else
         #define   wxOpen       open
         #define   wxStat       stat
         WXDLLIMPEXP_BASE int wxAccess( const wxChar *pathname, int mode );
         WXDLLIMPEXP_BASE int wxOpen( const wxChar *pathname, int flags, mode_t mode );
     #else
         #define   wxOpen       open
         #define   wxStat       stat

+        #define   wxLstat      lstat

         #define   wxAccess     access
     #endif
         #define   wxAccess     access
     #endif

+
+    #define wxHAS_NATIVE_LSTAT

 #endif // platforms
 
 #endif // platforms
 

+#ifdef O_BINARY
+    #define wxO_BINARY O_BINARY
+#else
+    #define wxO_BINARY 0
+#endif
+
+// if the platform doesn't have symlinks, define wxLstat to be the same as
+// wxStat to avoid #ifdefs in the code using it
+#ifndef wxHAS_NATIVE_LSTAT
+    #define wxLstat wxStat
+#endif
+

 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
 //
 // VisualAge C++ V4.0 cannot have any external linkage const decs
 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
 //
 // VisualAge C++ V4.0 cannot have any external linkage const decs


@@ -439,16 +477,18 @@ WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
 WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
 
 // Rename file
 WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
 
 // Rename file

-WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2);
+WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2, bool overwrite = true);

 
 // Get current working directory.
 
 // Get current working directory.

+#if WXWIN_COMPATIBILITY_2_6

 // If buf is NULL, allocates space using new, else
 // copies into buf.
 // IMPORTANT NOTE getcwd is know not to work under some releases
 // of Win32s 1.3, according to MS release notes!
 // If buf is NULL, allocates space using new, else
 // copies into buf.
 // IMPORTANT NOTE getcwd is know not to work under some releases
 // of Win32s 1.3, according to MS release notes!

-WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000);
+wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* wxGetWorkingDirectory(wxChar *buf = (wxChar *) NULL, int sz = 1000) );

 // new and preferred version of wxGetWorkingDirectory
 // NB: can't have the same name because of overloading ambiguity
 // new and preferred version of wxGetWorkingDirectory
 // NB: can't have the same name because of overloading ambiguity

+#endif // WXWIN_COMPATIBILITY_2_6

 WXDLLIMPEXP_BASE wxString wxGetCwd();
 
 // Set working directory
 WXDLLIMPEXP_BASE wxString wxGetCwd();
 
 // Set working directory


@@ -464,15 +504,19 @@ WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd);
 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(FILE *fp);
 
 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd);
 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(FILE *fp);
 

+#if WXWIN_COMPATIBILITY_2_6

 // compatibility defines, don't use in new code
 // compatibility defines, don't use in new code

-// consider removal droping 2.4 compatibility
-// #if WXWIN_COMPATIBILITY_2_4

 wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) );
 inline bool wxPathExists(const wxChar *pszPathName)
 {
     return wxDirExists(pszPathName);
 }
 wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) );
 inline bool wxPathExists(const wxChar *pszPathName)
 {
     return wxDirExists(pszPathName);
 }

-// #endif //WXWIN_COMPATIBILITY_2_4
+#endif //WXWIN_COMPATIBILITY_2_6
+
+// permissions; these functions work both on files and directories:
+WXDLLIMPEXP_BASE bool wxIsWritable(const wxString &path);
+WXDLLIMPEXP_BASE bool wxIsReadable(const wxString &path);
+WXDLLIMPEXP_BASE bool wxIsExecutable(const wxString &path);

 
 // ----------------------------------------------------------------------------
 // separators in file names
 
 // ----------------------------------------------------------------------------
 // separators in file names


@@ -547,9 +591,13 @@ WXDLLIMPEXP_BASE bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, co
 // On non-Windows platform, probably just return the empty string.
 WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
 
 // On non-Windows platform, probably just return the empty string.
 WXDLLIMPEXP_BASE wxString wxGetOSDirectory();
 

+#if wxUSE_DATETIME
+

 // Get file modification time
 WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename);
 
 // Get file modification time
 WXDLLIMPEXP_BASE time_t wxFileModificationTime(const wxString& filename);
 

+#endif // wxUSE_DATETIME
+

 // Parses the wildCard, returning the number of filters.
 // Returns 0 if none or if there's a problem,
 // The arrays will contain an equal number of items found before the error.
 // Parses the wildCard, returning the number of filters.
 // Returns 0 if none or if there's a problem,
 // The arrays will contain an equal number of items found before the error.


@@ -597,29 +645,32 @@ private:
 
 
 // Path searching
 
 
 // Path searching

-class WXDLLIMPEXP_BASE wxPathList : public wxStringList
+class WXDLLIMPEXP_BASE wxPathList : public wxArrayString

 {
 public:
 {
 public:

-    // avoid GCC warning about virtual functions w/o virtual dtor
-    virtual ~wxPathList() {}
+    wxPathList() {}
+    wxPathList(const wxArrayString &arr)
+        { Add(arr); }

 
     // Adds all paths in environment variable
     void AddEnvList(const wxString& envVariable);
 
 
     // Adds all paths in environment variable
     void AddEnvList(const wxString& envVariable);
 

+    // Adds given path to this list

     void Add(const wxString& path);
     void Add(const wxString& path);

+    void Add(const wxArrayString &paths);
+

     // Find the first full path for which the file exists
     // Find the first full path for which the file exists

-    wxString FindValidPath(const wxString& filename);
+    wxString FindValidPath(const wxString& filename) const;
+

     // Find the first full path for which the file exists; ensure it's an
     // absolute path that gets returned.
     // Find the first full path for which the file exists; ensure it's an
     // absolute path that gets returned.

-    wxString FindAbsoluteValidPath(const wxString& filename);
+    wxString FindAbsoluteValidPath(const wxString& filename) const;
+

     // Given full path and filename, add path to list
     void EnsureFileAccessible(const wxString& path);
     // Given full path and filename, add path to list
     void EnsureFileAccessible(const wxString& path);

-    // Returns true if the path is in the list
-    bool Member(const wxString& path);

 
 

-private:
-    // DECLARE_DYNAMIC_CLASS(wxPathList)
+    // Returns true if the path is in the list
+    wxDEPRECATED( bool Member(const wxString& path) const );

 };
 
 };
 

-#endif
-  // _WX_FILEFN_H_
+#endif // _WX_FILEFN_H_