extend GetAsBitmap with an optional subrect

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

diff --git a/include/wx/filefn.h b/include/wx/filefn.h
index 3915a0176b71629462d29dc8ecd80751317db44e..c0c7e140b973bb0ee9983f9543b4f7c0260d7314 100644 (file)
--- a/include/wx/filefn.h
+++ b/include/wx/filefn.h
@@ -155,39 +155,39 @@ 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
+    #if defined(__VISUALC__)

         #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(__MINGW32__)
+        #define wxHAS_HUGE_FILES 1
+    #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


@@ -211,20 +211,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


@@ -233,12 +235,31 @@ enum wxFileKind
 
     #if wxUSE_UNICODE
         #if wxUSE_UNICODE_MSLU
 
     #if wxUSE_UNICODE
         #if wxUSE_UNICODE_MSLU

+            // implement the missing file functions in Win9x ourselves
+            #if defined( __VISUALC__ ) \
+                || ( defined(__MINGW32__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
+                || ( defined(__MWERKS__) && defined(__WXMSW__) ) \
+                || ( defined(__BORLANDC__) && (__BORLANDC__ > 0x460) ) \
+                || defined(__DMC__)
+                #ifdef __BORLANDC__
+                    // BCC has _stati64() function but struct stati64
+                    #define _stati64 stati64
+                #endif // __BORLANDC__
+
+                WXDLLIMPEXP_BASE int wxMSLU__wopen(const wxChar *name, int flags, int mode);
+                WXDLLIMPEXP_BASE int wxMSLU__waccess(const wxChar *name, int mode);
+                WXDLLIMPEXP_BASE int wxMSLU__wmkdir(const wxChar *name);
+                WXDLLIMPEXP_BASE int wxMSLU__wrmdir(const wxChar *name);
+                WXDLLIMPEXP_BASE int wxMSLU__wstat(const wxChar *name, struct _stat *buffer);
+                WXDLLIMPEXP_BASE int wxMSLU__wstati64(const wxChar *name, struct _stati64 *buffer);
+            #endif // Windows compilers with MSLU support
+

             #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


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


@@ -267,17 +288,17 @@ 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.
     // This was droped since OW 1.4 "for consistency across platforms".
 
     // 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".

-    #if wxHAS_HUGE_FILES
+    #ifdef wxHAS_HUGE_FILES

         #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
             #define   wxStructStat struct _wstati64
         #else
         #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
             #define   wxStructStat struct _wstati64
         #else


@@ -292,7 +313,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


@@ -309,14 +330,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


@@ -342,15 +380,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


@@ -615,7 +669,7 @@ public:
     void AddEnvList(const wxString& envVariable);
 
     // Adds given path to this list
     void AddEnvList(const wxString& envVariable);
 
     // Adds given path to this list

-    void Add(const wxString& path);
+    bool Add(const wxString& path);

     void Add(const wxArrayString &paths);
 
     // Find the first full path for which the file exists
     void Add(const wxArrayString &paths);
 
     // Find the first full path for which the file exists


@@ -626,10 +680,12 @@ public:
     wxString FindAbsoluteValidPath(const wxString& filename) const;
 
     // Given full path and filename, add path to list
     wxString FindAbsoluteValidPath(const wxString& filename) const;
 
     // Given full path and filename, add path to list

-    void EnsureFileAccessible(const wxString& path);
+    bool EnsureFileAccessible(const wxString& path);

 
 

+#if WXWIN_COMPATIBILITY_2_6

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

+#endif

 };
 
 #endif // _WX_FILEFN_H_
 };
 
 #endif // _WX_FILEFN_H_