]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/filefn.h
Use wxRound instead of wxCoordRound
[wxWidgets.git] / include / wx / filefn.h
index a42adcc9c6b5eef1c0917c86698896b2eef18c1e..116d3ebb06787500cb91390011943ce8ed293729 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        filefn.h
+// Name:        wx/filefn.h
 // Purpose:     File- and directory-related functions
 // Author:      Julian Smart
 // Modified by:
 #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"
 
@@ -49,6 +45,9 @@
 // __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>
@@ -59,7 +58,7 @@
 #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>
@@ -148,55 +147,67 @@ enum wxFileKind
     int wxWrite(int fd, const void *buf, unsigned int count);
     int wxEof(int fd);
     wxFileOffset wxSeek(int fd, wxFileOffset offset, int origin);
-    inline HANDLE wxGetOSFHandle(int fd) { return (HANDLE)fd; }
     #define wxLSeek wxSeek
     wxFileOffset wxTell(int fd);
-    
+
     // 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
-#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
-    #if defined(__MINGW32__)
+
+    // detect compilers which have support for huge files
+    #if defined(__VISUALC__)
         #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
-    #else
-        #define wxHAS_HUGE_FILES 0
     #endif
 
-    // functions
-    #if defined(__BORLANDC__) || defined(__WATCOMC__)
-        #define   _tell        tell
-    #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
 
-    #if wxHAS_HUGE_FILES
+    #ifdef wxHAS_HUGE_FILES
         typedef wxLongLong_t wxFileOffset;
         #define wxFileOffsetFmtSpec wxLongLongFmtSpec
     #else
         typedef off_t wxFileOffset;
     #endif
 
-    #define   wxClose      _close
+
+    // functions
+
+    // MSVC and compatible compilers prepend underscores to the POSIX function
+    // names, other compilers don't and even if their later versions usually do
+    // define the versions with underscores for MSVC compatibility, it's better
+    // to avoid using them as they're not present in earlier versions and
+    // always using the native functions spelling is easier than testing for
+    // the versions
+    #if defined(__BORLANDC__) || defined(__DMC__) || defined(__WATCOMC__)
+        #define wxPOSIX_IDENT(func)    ::func
+    #else // by default assume MSVC-compatible names
+        #define wxPOSIX_IDENT(func)    _ ## func
+        #define wxHAS_UNDERSCORES_IN_POSIX_IDENTS
+    #endif
+
+
+    // first functions not working with strings, i.e. without ANSI/Unicode
+    // complications
+    #define   wxClose      wxPOSIX_IDENT(close)
 
     #if defined(__MWERKS__)
         #if __MSL__ >= 0x6000
@@ -208,84 +219,111 @@ enum wxFileKind
             #define wxWrite(fd, buf, nCount)\
                   _write(fd, (const char *)buf, nCount)
         #endif
-    #else
-        #if defined(__DMC__) || defined(__WATCOMC__)
-            #define wxRead        ::read
-            #define wxWrite       ::write
-        #else
-            #define wxRead        _read
-            #define wxWrite        _write
-        #endif
-    #endif
-    #if wxHAS_HUGE_FILES
-        #define   wxSeek      _lseeki64
-        #define   wxLseek      _lseeki64
-        #define   wxTell       _telli64
-    #else
-        #define   wxSeek      _lseek
-        #define   wxLseek      _lseek
-        #define   wxTell       _tell
+    #else // __MWERKS__
+        #define wxRead         wxPOSIX_IDENT(read)
+        #define wxWrite        wxPOSIX_IDENT(write)
     #endif
-    #define   wxFsync      _commit
-    #if defined(__WATCOMC__)
-        #define   wxEof        ::eof
-    #else
-        #define   wxEof        _eof
+
+    #ifdef wxHAS_HUGE_FILES
+        #define   wxSeek       wxPOSIX_IDENT(lseeki64)
+        #define   wxLseek      wxPOSIX_IDENT(lseeki64)
+        #define   wxTell       wxPOSIX_IDENT(telli64)
+    #else // !wxHAS_HUGE_FILES
+        #define   wxSeek       wxPOSIX_IDENT(lseek)
+        #define   wxLseek      wxPOSIX_IDENT(lseek)
+        #define   wxTell       wxPOSIX_IDENT(tell)
+    #endif // wxHAS_HUGE_FILES/!wxHAS_HUGE_FILES
+
+    #ifndef __WATCOMC__
+        // NB: this one is not POSIX and always has the underscore
+        #define   wxFsync      _commit
+
+        #define HAVE_FSYNC
     #endif
 
+    #define   wxEof        wxPOSIX_IDENT(eof)
+
+    // then the functions taking strings
     #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__)
+
+                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 wxPOSIX_IDENT(stat) *buffer);
+                WXDLLIMPEXP_BASE int
+                wxMSLU__wstati64(const wxChar *name,
+                                 struct wxPOSIX_IDENT(stati64) *buffer);
+            #endif // Windows compilers with MSLU support
+
             #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
             #endif
-        #else
-            #define   wxOpen       _wopen
-            #define   wxAccess     _waccess
-            #define   wxMkDir      _wmkdir
-            #define   wxRmDir      _wrmdir
-            #if wxHAS_HUGE_FILES
-                #define   wxStat       _wstati64
+        #else // !wxUSE_UNICODE_MSLU
+            #ifdef __BORLANDC__
+                #define   wxOpen       _wopen
+                #define   wxAccess     _waccess
+                #define   wxMkDir      _mkdir
+                #define   wxRmDir      _rmdir
+                #ifdef wxHAS_HUGE_FILES
+                    #define   wxStat       _wstati64
+                #else
+                    #define   wxStat       _wstat
+                #endif
             #else
-                #define   wxStat       _wstat
+                #define   wxOpen       _wopen
+                #define   wxAccess     _waccess
+                #define   wxMkDir      _wmkdir
+                #define   wxRmDir      _wrmdir
+                #ifdef wxHAS_HUGE_FILES
+                    #define   wxStat       _wstati64
+                #else
+                    #define   wxStat       _wstat
+                #endif
             #endif
-        #endif
+        #endif // wxUSE_UNICODE_MSLU/!wxUSE_UNICODE_MSLU
     #else // !wxUSE_UNICODE
-        #ifdef __BORLANDC__
-            #define   wxOpen       open
-        #else
-            #define   wxOpen       _open
-        #endif
-        #define   wxAccess     _access
-        #define   wxMkDir      _mkdir
-        #ifdef __WATCOMC__
-            #define   wxRmDir      rmdir
-        #else
-            #define   wxRmDir      _rmdir
-        #endif
-        #if wxHAS_HUGE_FILES
-            #define   wxStat       _stati64
+        #define   wxOpen       wxPOSIX_IDENT(open)
+        #define   wxAccess     wxPOSIX_IDENT(access)
+        #define   wxMkDir      wxPOSIX_IDENT(mkdir)
+        #define   wxRmDir      wxPOSIX_IDENT(rmdir)
+        #ifdef wxHAS_HUGE_FILES
+            #define   wxStat       wxPOSIX_IDENT(stati64)
         #else
-            #define   wxStat       _stat
+            #define   wxStat       wxPOSIX_IDENT(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
-        #if wxUSE_UNICODE && defined(__WATCOMC__)
+        #if wxUSE_UNICODE && wxONLY_WATCOM_EARLIER_THAN(1,4)
             #define   wxStructStat struct _wstat
         #else
             #define   wxStructStat struct _stat
@@ -293,7 +331,7 @@ enum wxFileKind
     #endif
 
     // constants (unless already defined by the user code)
-    #if !defined(__BORLANDC__) && !defined(__WATCOMC__) && !defined(__WXPALMOS__)
+    #ifdef wxHAS_UNDERSCORES_IN_POSIX_IDENTS
         #ifndef O_RDONLY
             #define   O_RDONLY    _O_RDONLY
             #define   O_WRONLY    _O_WRONLY
@@ -308,16 +346,33 @@ enum wxFileKind
             #define   S_IFDIR     _S_IFDIR
             #define   S_IFREG     _S_IFREG
         #endif
+    #endif // wxHAS_UNDERSCORES_IN_POSIX_IDENTS
+
+    #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 nobody gets tempted to use it
+    // it's a private define, undefine it so that nobody gets tempted to use it
     #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 );
+        // 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
@@ -327,7 +382,7 @@ enum wxFileKind
     #define   wxWrite      ::write
     #define   wxLseek      lseek
     #define   wxSeek       lseek
-    #define   wxFsync      commit
+    #define   wxFsync      fsync
     #define   wxEof        eof
 
     #define   wxMkDir      mkdir
@@ -343,24 +398,29 @@ enum wxFileKind
             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
+        #define   wxLstat      lstat
         #define   wxAccess     access
     #endif
+
+    #define wxHAS_NATIVE_LSTAT
 #endif // platforms
 
-#if defined __WXMSW__ && !defined __WXWINCE__
-    // get the HANDLE associated with a file descriptor
-#   ifdef __CYGWIN__
-#       include "wx/msw/private.h" // for HANDLE
-#       include <io.h> // for get_osfhandle()
-        inline HANDLE wxGetOSFHandle(int fd) { return (HANDLE) get_osfhandle(fd); }
-#   else
-        inline HANDLE wxGetOSFHandle(int fd) { return (HANDLE) _get_osfhandle(fd); }
-#   endif
+#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
@@ -379,7 +439,7 @@ const int wxInvalidOffset = -1;
 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);
 
@@ -448,16 +508,18 @@ WXDLLIMPEXP_BASE bool wxCopyFile(const wxString& file1, const wxString& file2,
 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.
+#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!
-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
+#endif // WXWIN_COMPATIBILITY_2_6
 WXDLLIMPEXP_BASE wxString wxGetCwd();
 
 // Set working directory
@@ -471,10 +533,21 @@ WXDLLIMPEXP_BASE bool wxRmdir(const wxString& dir, int flags = 0);
 
 // Return the type of an open file
 WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(int fd);
-inline wxFileKind wxGetFileKind (FILE *fp) { return wxGetFileKind(fileno(fp)); }
+WXDLLIMPEXP_BASE wxFileKind wxGetFileKind(FILE *fp);
 
+#if WXWIN_COMPATIBILITY_2_6
 // 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
+
+// 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
@@ -549,9 +622,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();
 
+#if wxUSE_DATETIME
+
 // 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.
@@ -599,29 +676,34 @@ private:
 
 
 // Path searching
-class WXDLLIMPEXP_BASE wxPathList : public wxStringList
+class WXDLLIMPEXP_BASE wxPathList : public wxArrayString
 {
 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);
 
-    void Add(const wxString& path);
+    // Adds given path to this list
+    bool Add(const wxString& path);
+    void Add(const wxArrayString &paths);
+
     // 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.
-    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);
-    // Returns true if the path is in the list
-    bool Member(const wxString& path);
+    bool EnsureFileAccessible(const wxString& path);
 
-private:
-    // DECLARE_DYNAMIC_CLASS(wxPathList)
+#if WXWIN_COMPATIBILITY_2_6
+    // 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_