Keep wxPalmOS buildable after changes in wxConvAuto.

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

diff --git a/include/wx/filefn.h b/include/wx/filefn.h
index 69e95031d429652dc029440dc0786b0b2f6173cf..3351115ba7014cb151b9d6fb31be7aeeeb70c2e6 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"
 


@@ -49,6 +45,9 @@
 // __OS2__ and __UNIX__ are defined.
     #include <process.h>
     #include "wx/os2/private.h"
 // __OS2__ and __UNIX__ are defined.
     #include <process.h>
     #include "wx/os2/private.h"

+    #ifdef __WATCOMC__
+        #include <direct.h>
+    #endif

     #include <io.h>
     #ifdef __EMX__
         #include <unistd.h>
     #include <io.h>
     #ifdef __EMX__
         #include <unistd.h>


@@ -59,7 +58,7 @@
 #endif
 
 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
 #endif
 
 #if defined(__WINDOWS__) && !defined(__WXMICROWIN__)

-#if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__SALFORDC__) && !defined(__WXWINCE__)
+#if !defined( __GNUWIN32__ ) && !defined( __MWERKS__ ) && !defined(__SALFORDC__) && !defined(__WXWINCE__) && !defined(__CYGWIN__)

     #include <direct.h>
     #include <dos.h>
     #include <io.h>
     #include <direct.h>
     #include <dos.h>
     #include <io.h>


@@ -122,6 +121,14 @@ enum wxSeekMode
   wxFromEnd
 };
 
   wxFromEnd
 };
 

+enum wxFileKind
+{
+  wxFILE_KIND_UNKNOWN,
+  wxFILE_KIND_DISK,     // a file supporting seeking to arbitrary offsets
+  wxFILE_KIND_TERMINAL, // a tty
+  wxFILE_KIND_PIPE      // a pipe
+};
+

 // ----------------------------------------------------------------------------
 // declare our versions of low level file functions: some compilers prepend
 // underscores to the usual names, some also have Unicode versions of them
 // ----------------------------------------------------------------------------
 // declare our versions of low level file functions: some compilers prepend
 // underscores to the usual names, some also have Unicode versions of them


@@ -143,25 +150,10 @@ enum wxSeekMode
     #define wxLSeek wxSeek
     wxFileOffset wxTell(int fd);
 
     #define wxLSeek wxSeek
     wxFileOffset wxTell(int fd);
 

-    #if wxUSE_UNICODE
-        #if wxUSE_UNICODE_MSLU
-            #define   wxMkDir      wxMSLU__wmkdir
-            #define   wxRmDir      wxMSLU__wrmdir
-            #define   wxStat       wxMSLU__wstat
-        #else
-            #define   wxMkDir      _wmkdir
-            #define   wxRmDir      _wrmdir
-            #define   wxStat       _wstat
-        #endif
-    #else // !wxUSE_UNICODE
-        #define   wxMkDir      _mkdir
-        #ifdef __WATCOMC__
-            #define   wxRmDir      rmdir
-        #else
-            #define   wxRmDir      _rmdir
-        #endif
-        #define   wxStat       _stat
-    #endif
+    // always Unicode under WinCE
+    #define   wxMkDir      _wmkdir
+    #define   wxRmDir      _wrmdir
+    #define   wxStat       _wstat

     #define   wxStructStat struct _stat
 
 // Microsoft compiler loves underscores, feed them to it
     #define   wxStructStat struct _stat
 
 // Microsoft compiler loves underscores, feed them to it


@@ -173,17 +165,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 __WXPALMOS__

     #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,23 +187,24 @@ enum wxSeekMode
         #define   _tell        tell
     #endif
 
         #define   _tell        tell
     #endif
 

-    #if __HUGEFILES_SUPPORTED
+    #if wxHAS_HUGE_FILES

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

-        #define wxFileOffsetFmtSpec _("")

     #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
         #if defined(__DMC__) || defined(__WATCOMC__)
         #endif
     #else
         #if defined(__DMC__) || defined(__WATCOMC__)


@@ -218,7 +215,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 +238,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 +248,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,23 +267,24 @@ 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
         #endif
     #endif
 
             #define   wxStat       _stati64
         #else
             #define   wxStat       _stat
         #endif
     #endif
 

-    // 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 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".
+    #if 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


@@ -294,27 +292,31 @@ 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(__WXPALMOS__)
+        #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 );

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


@@ -324,7 +326,7 @@ enum wxSeekMode
     #define   wxWrite      ::write
     #define   wxLseek      lseek
     #define   wxSeek       lseek
     #define   wxWrite      ::write
     #define   wxLseek      lseek
     #define   wxSeek       lseek

-    #define   wxFsync      commit
+    #define   wxFsync      fsync

     #define   wxEof        eof
 
     #define   wxMkDir      mkdir
     #define   wxEof        eof
 
     #define   wxMkDir      mkdir


@@ -354,9 +356,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 int wxInvalidOffset;

 #else
 #else

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

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


@@ -365,7 +367,7 @@ const wxFileOffset wxInvalidOffset = (wxFileOffset)-1;
 WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
 
 // does the path exist? (may have or not '/' or '\\' at the end)
 WXDLLIMPEXP_BASE bool wxFileExists(const wxString& filename);
 
 // does the path exist? (may have or not '/' or '\\' at the end)

-WXDLLIMPEXP_BASE bool wxPathExists(const wxChar *pszPathName);
+WXDLLIMPEXP_BASE bool wxDirExists(const wxChar *pszPathName);

 
 WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
 
 
 WXDLLIMPEXP_BASE bool wxIsAbsolutePath(const wxString& filename);
 


@@ -434,16 +436,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


@@ -455,8 +459,18 @@ WXDLLIMPEXP_BASE bool wxMkdir(const wxString& dir, int perm = 0777);
 // Remove directory. Flags reserved for future use.
 WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
 
 // Remove directory. Flags reserved for future use.
 WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
 

+// Return the type of an open file
+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

-#define wxDirExists wxPathExists
+wxDEPRECATED( inline bool wxPathExists(const wxChar *pszPathName) );
+inline bool wxPathExists(const wxChar *pszPathName)
+{
+    return wxDirExists(pszPathName);
+}
+#endif //WXWIN_COMPATIBILITY_2_6

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


@@ -545,6 +559,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
 {