clear up wxStringBuffer docs a bit

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

diff --git a/include/wx/filefn.h b/include/wx/filefn.h
index 69e95031d429652dc029440dc0786b0b2f6173cf..b977aaf14a5384a874d8efdf6cbab3a98e5743c3 100644 (file)
--- a/include/wx/filefn.h
+++ b/include/wx/filefn.h
@@ -131,6 +131,7 @@ enum wxSeekMode
 // Implemented in filefnwce.cpp
 #if defined( __WXWINCE__)
     typedef __int64 wxFileOffset;
 // Implemented in filefnwce.cpp
 #if defined( __WXWINCE__)
     typedef __int64 wxFileOffset;

+    typedef unsigned __int64 wxFileSize_t;

     #define wxFileOffsetFmtSpec _("I64")
     int wxOpen(const wxChar *filename, int oflag, int WXUNUSED(pmode));
     int wxAccess(const wxChar *name, int WXUNUSED(how));
     #define wxFileOffsetFmtSpec _("I64")
     int wxOpen(const wxChar *filename, int oflag, int WXUNUSED(pmode));
     int wxAccess(const wxChar *name, int WXUNUSED(how));


@@ -173,17 +174,21 @@ enum wxSeekMode
 
     // detect compilers which have support for huge files (currently only
     // Digital Mars doesn't)
 
     // detect compilers which have support for huge files (currently only
     // Digital Mars doesn't)

+    #ifndef __PALMOS__

     #include "wx/msw/private.h"
     #include "wx/msw/private.h"

+    #endif

 
 

-    #undef __HUGEFILES_SUPPORTED
+    #undef wxHAS_HUGE_FILES

     #if defined(__MINGW32__)
     #if defined(__MINGW32__)

-        #define __HUGEFILES_SUPPORTED 1
+        #define wxHAS_HUGE_FILES 1
+    #elif defined(__MWERKS__)
+        #define wxHAS_HUGE_FILES 0

     #elif defined(__DMC__)
     #elif defined(__DMC__)

-        #define __HUGEFILES_SUPPORTED 0
+        #define wxHAS_HUGE_FILES 0

     #elif ((_INTEGRAL_MAX_BITS >= 64) || defined(_LARGE_FILES))
     #elif ((_INTEGRAL_MAX_BITS >= 64) || defined(_LARGE_FILES))

-        #define __HUGEFILES_SUPPORTED 1
+        #define wxHAS_HUGE_FILES 1

     #else
     #else

-        #define __HUGEFILES_SUPPORTED 0
+        #define wxHAS_HUGE_FILES 0

     #endif
 
     // functions
     #endif
 
     // functions


@@ -191,26 +196,34 @@ enum wxSeekMode
         #define   _tell        tell
     #endif
 
         #define   _tell        tell
     #endif
 

-    #if __HUGEFILES_SUPPORTED
+    #if wxHAS_HUGE_FILES

         typedef wxLongLong_t wxFileOffset;
         typedef wxLongLong_t wxFileOffset;

+        typedef unsigned wxLongLong_t wxFileSize_t;

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

-        #define wxFileOffsetFmtSpec _("")
+        typedef unsigned long wxFileSize_t;

     #endif
 
     #define   wxClose      _close
 
     #if defined(__MWERKS__)
         #if __MSL__ >= 0x6000
     #endif
 
     #define   wxClose      _close
 
     #if defined(__MWERKS__)
         #if __MSL__ >= 0x6000

-            #define wxRead        _read(fd, (void *)buf, nCount)
-            #define wxWrite        _write(fd, (void *)buf, nCount)
+            #define wxRead(fd, buf, nCount)  _read(fd, (void *)buf, nCount)
+            #define wxWrite(fd, buf, nCount) _write(fd, (void *)buf, nCount)

         #else
         #else

-            #define wxRead        _read(fd, (const char *)buf, nCount)
-            #define wxWrite        _write(fd, (const char *)buf, nCount)
+            #define wxRead(fd, buf, nCount)\
+                  _read(fd, (const char *)buf, nCount)
+            #define wxWrite(fd, buf, nCount)\
+                  _write(fd, (const char *)buf, nCount)

         #endif
     #else
         #endif
     #else

-        #if defined(__DMC__) || defined(__WATCOMC__)
+        #if defined(__WATCOMC__)
+            inline wxFileSize_t wxRead( int handle, void *buffer, wxFileSize_t len )
+                                { return ::read( handle, buffer, (unsigned int)len ); }
+            inline wxFileSize_t wxWrite( int handle, const void *buffer, wxFileSize_t len )
+                                { return ::write( handle, buffer, (unsigned int)len ); }
+        #elif defined(__DMC__)

             #define wxRead        ::read
             #define wxWrite       ::write
         #else
             #define wxRead        ::read
             #define wxWrite       ::write
         #else


@@ -218,7 +231,7 @@ enum wxSeekMode
             #define wxWrite        _write
         #endif
     #endif
             #define wxWrite        _write
         #endif
     #endif

-    #if __HUGEFILES_SUPPORTED
+    #if wxHAS_HUGE_FILES

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


@@ -241,7 +254,7 @@ enum wxSeekMode
             #define   wxAccess     wxMSLU__waccess
             #define   wxMkDir      wxMSLU__wmkdir
             #define   wxRmDir      wxMSLU__wrmdir
             #define   wxAccess     wxMSLU__waccess
             #define   wxMkDir      wxMSLU__wmkdir
             #define   wxRmDir      wxMSLU__wrmdir

-            #if __HUGEFILES_SUPPORTED
+            #if wxHAS_HUGE_FILES

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


@@ -251,7 +264,7 @@ enum wxSeekMode
             #define   wxAccess     _waccess
             #define   wxMkDir      _wmkdir
             #define   wxRmDir      _wrmdir
             #define   wxAccess     _waccess
             #define   wxMkDir      _wmkdir
             #define   wxRmDir      _wrmdir

-            #if __HUGEFILES_SUPPORTED
+            #if wxHAS_HUGE_FILES

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


@@ -270,7 +283,7 @@ enum wxSeekMode
         #else
             #define   wxRmDir      _rmdir
         #endif
         #else
             #define   wxRmDir      _rmdir
         #endif

-        #if __HUGEFILES_SUPPORTED
+        #if wxHAS_HUGE_FILES

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


@@ -279,7 +292,7 @@ enum wxSeekMode
 
     // 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
 
     // 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 __HUGEFILES_SUPPORTED
+    #if wxHAS_HUGE_FILES

         #if wxUSE_UNICODE && defined(__WATCOMC__)
             #define   wxStructStat struct _wstati64
         #else
         #if wxUSE_UNICODE && defined(__WATCOMC__)
             #define   wxStructStat struct _wstati64
         #else


@@ -294,29 +307,35 @@ enum wxSeekMode
     #endif
 
     // constants (unless already defined by the user code)
     #endif
 
     // constants (unless already defined by the user code)

-    #if !defined(O_RDONLY) && !defined(__BORLANDC__) && !defined(__WATCOMC__)
-        #define   O_RDONLY    _O_RDONLY
-        #define   O_WRONLY    _O_WRONLY
-        #define   O_RDWR      _O_RDWR
-        #define   O_EXCL      _O_EXCL
-        #define   O_CREAT     _O_CREAT
-        #define   O_BINARY    _O_BINARY
-    #endif
+    #if !defined(__BORLANDC__) && !defined(__WATCOMC__) && !defined(__PALMOS__)
+        #ifndef O_RDONLY
+            #define   O_RDONLY    _O_RDONLY
+            #define   O_WRONLY    _O_WRONLY
+            #define   O_RDWR      _O_RDWR
+            #define   O_EXCL      _O_EXCL
+            #define   O_CREAT     _O_CREAT
+            #define   O_BINARY    _O_BINARY
+        #endif

 
 

-    #if !defined(__BORLANDC__) && !defined(__WATCOMC__)
-        #define   S_IFMT      _S_IFMT
-        #define   S_IFDIR     _S_IFDIR
-        #define   S_IFREG     _S_IFREG
-    #endif // O_RDONLY
+        #ifndef S_IFMT
+            #define   S_IFMT      _S_IFMT
+            #define   S_IFDIR     _S_IFDIR
+            #define   S_IFREG     _S_IFREG
+        #endif
+    #endif

 
     // It's a private define, undefine it so nobody gets tempted to use it
 
     // It's a private define, undefine it so nobody gets tempted to use it

-    #undef __HUGEFILES_SUPPORTED
+    #undef wxHAS_HUGE_FILES

 #else // Unix platforms using configure
     typedef off_t wxFileOffset;
     #ifdef _LARGE_FILES
         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
 #else // Unix platforms using configure
     typedef off_t wxFileOffset;
     #ifdef _LARGE_FILES
         #define wxFileOffsetFmtSpec wxLongLongFmtSpec

+        wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
+                                BadFileSizeType );
+        typedef unsigned wxLongLong_t wxFileSize_t;

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

+        typedef unsigned long wxFileSize_t;

     #endif
     // functions
     #define   wxClose      close
     #endif
     // functions
     #define   wxClose      close


@@ -354,9 +373,9 @@ enum wxSeekMode
 // VisualAge C++ V4.0 cannot have any external linkage const decs
 // in headers included by more than one primary source
 //
 // VisualAge C++ V4.0 cannot have any external linkage const decs
 // in headers included by more than one primary source
 //

-extern const wxFileOffset wxInvalidOffset;
+extern const wxFileSize_t wxInvalidOffset;

 #else
 #else

-const wxFileOffset wxInvalidOffset = (wxFileOffset)-1;
+const wxFileSize_t wxInvalidOffset = (wxFileSize_t)-1;

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


@@ -545,6 +564,41 @@ WXDLLIMPEXP_BASE int wxParseCommonDialogsFilter(const wxString& wildCard, wxArra
 // classes
 // ----------------------------------------------------------------------------
 
 // classes
 // ----------------------------------------------------------------------------
 

+#ifdef __UNIX__
+
+// set umask to the given value in ctor and reset it to the old one in dtor
+class WXDLLIMPEXP_BASE wxUmaskChanger
+{
+public:
+    // change the umask to the given one if it is not -1: this allows to write
+    // the same code whether you really want to change umask or not, as is in
+    // wxFileConfig::Flush() for example
+    wxUmaskChanger(int umaskNew)
+    {
+        m_umaskOld = umaskNew == -1 ? -1 : (int)umask((mode_t)umaskNew);
+    }
+
+    ~wxUmaskChanger()
+    {
+        if ( m_umaskOld != -1 )
+            umask((mode_t)m_umaskOld);
+    }
+
+private:
+    int m_umaskOld;
+};
+
+// this macro expands to an "anonymous" wxUmaskChanger object under Unix and
+// nothing elsewhere
+#define wxCHANGE_UMASK(m) wxUmaskChanger wxMAKE_UNIQUE_NAME(umaskChanger_)(m)
+
+#else // !__UNIX__
+
+#define wxCHANGE_UMASK(m)
+
+#endif // __UNIX__/!__UNIX__
+
+

 // Path searching
 class WXDLLIMPEXP_BASE wxPathList : public wxStringList
 {
 // Path searching
 class WXDLLIMPEXP_BASE wxPathList : public wxStringList
 {