cleanup - added whitespace around operators, some blank lines, fixed comment typos...

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

diff --git a/include/wx/filefn.h b/include/wx/filefn.h
index b977aaf14a5384a874d8efdf6cbab3a98e5743c3..4189de1bf108966cff69854f5d41db45f39b9f10 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


@@ -131,7 +138,6 @@ 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));


@@ -144,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


@@ -174,7 +165,7 @@ 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__
+    #ifndef __WXPALMOS__

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


@@ -198,11 +189,9 @@ enum wxSeekMode
 
     #if wxHAS_HUGE_FILES
         typedef wxLongLong_t wxFileOffset;
 
     #if wxHAS_HUGE_FILES
         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;

-        typedef unsigned long wxFileSize_t;

     #endif
 
     #define   wxClose      _close
     #endif
 
     #define   wxClose      _close


@@ -218,12 +207,7 @@ enum wxSeekMode
                   _write(fd, (const char *)buf, nCount)
         #endif
     #else
                   _write(fd, (const char *)buf, nCount)
         #endif
     #else

-        #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__)
+        #if defined(__DMC__) || defined(__WATCOMC__)

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


@@ -290,16 +274,17 @@ enum wxSeekMode
         #endif
     #endif
 
         #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
+    // 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 wxHAS_HUGE_FILES

-        #if wxUSE_UNICODE && defined(__WATCOMC__)
+        #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


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

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

         #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


@@ -332,10 +317,8 @@ enum wxSeekMode
         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
         wxCOMPILE_TIME_ASSERT( sizeof(off_t) == sizeof(wxLongLong_t),
                                 BadFileSizeType );
         #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


@@ -343,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


@@ -373,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 wxFileSize_t wxInvalidOffset;
+extern const int wxInvalidOffset;

 #else
 #else

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

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


@@ -384,7 +367,7 @@ const wxFileSize_t wxInvalidOffset = (wxFileSize_t)-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);
 


@@ -456,13 +439,15 @@ WXDLLIMPEXP_BASE bool wxRemoveFile(const wxString& file);
 WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2);
 
 // Get current working directory.
 WXDLLIMPEXP_BASE bool wxRenameFile(const wxString& file1, const wxString& file2);
 
 // 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


@@ -474,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