fixed outdated filenames

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

diff --git a/include/wx/filefn.h b/include/wx/filefn.h
index b0565fdbbf944076d8450d50adf8d1a3cecadbd3..b1df9ded523c7ca4b8121617dd2cd97330adf9c1 100644 (file)
--- a/include/wx/filefn.h
+++ b/include/wx/filefn.h
@@ -18,12 +18,14 @@
 
 #include "wx/list.h"
 
 
 #include "wx/list.h"
 

+#include <time.h>
+

 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
 // define off_t
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
 // define off_t

-#ifndef __WXMAC__
+#if !defined(__WXMAC__) || defined(__UNIX__)

     #include  <sys/types.h>
 #else
     typedef long off_t;
     #include  <sys/types.h>
 #else
     typedef long off_t;


@@ -39,7 +41,15 @@
     typedef long off_t;
 #endif
 
     typedef long off_t;
 #endif
 

+#if defined(__VISAGECPP__) && __IBMCPP__ >= 400
+//
+// VisualAge C++ V4.0 cannot have any external linkage const decs
+// in headers included by more than one primary source
+//
+extern const off_t wxInvalidOffset;
+#else

 const off_t wxInvalidOffset = (off_t)-1;
 const off_t wxInvalidOffset = (off_t)-1;

+#endif

 
 enum wxSeekMode
 {
 
 enum wxSeekMode
 {


@@ -50,6 +60,86 @@ enum wxSeekMode
 
 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
 
 
 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
 

+// ----------------------------------------------------------------------------
+// declare our versions of low level file functions: some compilers prepend
+// underscores to the usual names, some also have Unicode versions of them
+// ----------------------------------------------------------------------------
+
+// Microsoft compiler loves underscores, feed them to it
+#if defined( __VISUALC__ ) \
+    || ( defined(__MINGW32__) && wxCHECK_W32API_VERSION( 0, 5 ) ) \
+    || ( defined(__MWERKS__) && defined(__WXMSW__) )
+    // functions
+    #define   wxClose      _close
+    #define   wxRead       _read
+    #define   wxWrite      _write
+    #define   wxLseek      _lseek
+    #define   wxFsync      _commit
+    #define   wxEof        _eof
+
+    #define   wxTell       _tell
+
+    #if wxUSE_UNICODE
+        #if wxUSE_UNICODE_MSLU
+            #define   wxOpen       wxMSLU__wopen
+            #define   wxAccess     wxMSLU__waccess
+            #define   wxMkDir      wxMSLU__wmkdir
+            #define   wxRmDir      wxMSLU__wrmdir
+            #define   wxStat       wxMSLU__wstat
+        #else
+            #define   wxOpen       _wopen
+            #define   wxAccess     _waccess
+            #define   wxMkDir      _wmkdir
+            #define   wxRmDir      _wrmdir
+            #define   wxStat       _wstat
+        #endif
+    #else // !wxUSE_UNICODE
+        #define   wxOpen       _open
+        #define   wxAccess     _access
+        #define   wxMkDir      _mkdir
+        #define   wxRmDir      _rmdir
+        #define   wxStat       _stat
+    #endif
+
+    // types
+    #define   wxStructStat struct _stat
+
+    // constants (unless already defined by the user code)
+    #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
+
+        #define   S_IFMT      _S_IFMT
+        #define   S_IFDIR     _S_IFDIR
+        #define   S_IFREG     _S_IFREG
+    #endif // O_RDONLY
+#else
+    // functions
+    #define   wxOpen       open
+    #define   wxClose      close
+    #define   wxRead       read
+    #define   wxWrite      write
+    #define   wxLseek      lseek
+    #define   wxFsync      commit
+    #define   wxAccess     access
+    #define   wxEof        eof
+
+    #define   wxMkDir      mkdir
+    #define   wxRmDir      rmdir
+
+    #define   wxTell(fd)   lseek(fd, 0, SEEK_CUR)
+
+    #define   wxStat       stat
+
+    // types
+    #define   wxStructStat struct stat
+
+#endif  // VC++
+

 // ----------------------------------------------------------------------------
 // functions
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // functions
 // ----------------------------------------------------------------------------


@@ -83,28 +173,24 @@ WXDLLEXPORT void wxDos2UnixFilename(wxChar *s);
 WXDLLEXPORT void wxUnix2DosFilename(wxChar *s);
 #define Unix2DosFilename wxUnix2DosFilename
 
 WXDLLEXPORT void wxUnix2DosFilename(wxChar *s);
 #define Unix2DosFilename wxUnix2DosFilename
 

-#ifdef __WXMAC__
-  WXDLLEXPORT void wxMacPathToFSSpec( const wxChar *path , FSSpec *spec ) ;
-  WXDLLEXPORT void wxMac2UnixFilename(wxChar *s);
-  WXDLLEXPORT void wxUnix2MacFilename(wxChar *s);
-#endif
-

 // Strip the extension, in situ
 WXDLLEXPORT void wxStripExtension(wxChar *buffer);
 WXDLLEXPORT void wxStripExtension(wxString& buffer);
 
 // Strip the extension, in situ
 WXDLLEXPORT void wxStripExtension(wxChar *buffer);
 WXDLLEXPORT void wxStripExtension(wxString& buffer);
 

-// Get a temporary filename, opening and closing the file.
+// Get a temporary filename

 WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);
 WXDLLEXPORT wxChar* wxGetTempFileName(const wxString& prefix, wxChar *buf = (wxChar *) NULL);

+WXDLLEXPORT bool wxGetTempFileName(const wxString& prefix, wxString& buf);

 
 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
 WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path);
 
 // Expand file name (~/ and ${OPENWINHOME}/ stuff)
 WXDLLEXPORT wxChar* wxExpandPath(wxChar *dest, const wxChar *path);

+WXDLLEXPORT bool wxExpandPath(wxString& dest, const wxChar *path);

 
 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
 // and make (if under the home tree) relative to home
 // [caller must copy-- volatile]
 WXDLLEXPORT wxChar* wxContractPath(const wxString& filename,
 
 // Contract w.r.t environment (</usr/openwin/lib, OPENWHOME> -> ${OPENWINHOME}/lib)
 // and make (if under the home tree) relative to home
 // [caller must copy-- volatile]
 WXDLLEXPORT wxChar* wxContractPath(const wxString& filename,

-                                  const wxString& envname = wxEmptyString,
-                                  const wxString& user = wxEmptyString);
+                                   const wxString& envname = wxEmptyString,
+                                   const wxString& user = wxEmptyString);

 
 // Destructive removal of /./ and /../ stuff
 WXDLLEXPORT wxChar* wxRealPath(wxChar *path);
 
 // Destructive removal of /./ and /../ stuff
 WXDLLEXPORT wxChar* wxRealPath(wxChar *path);


@@ -131,7 +217,8 @@ WXDLLEXPORT bool wxMatchWild(const wxString& pattern,  const wxString& text, boo
 WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
 
 // Copy file1 to file2
 WXDLLEXPORT bool wxConcatFiles(const wxString& file1, const wxString& file2, const wxString& file3);
 
 // Copy file1 to file2

-WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2);
+WXDLLEXPORT bool wxCopyFile(const wxString& file1, const wxString& file2,
+                            bool overwrite = TRUE);

 
 // Remove file
 WXDLLEXPORT bool wxRemoveFile(const wxString& file);
 
 // Remove file
 WXDLLEXPORT bool wxRemoveFile(const wxString& file);


@@ -158,21 +245,40 @@ WXDLLEXPORT bool wxMkdir(const wxString& dir, int perm = 0777);
 // Remove directory. Flags reserved for future use.
 WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0);
 
 // Remove directory. Flags reserved for future use.
 WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0);
 

+// ----------------------------------------------------------------------------

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

-#define wxFILE_SEP_EXT        T('.')
-#define wxFILE_SEP_DSK        T(':')
-#define wxFILE_SEP_PATH_DOS   T('\\')
-#define wxFILE_SEP_PATH_UNIX  T('/')
+// ----------------------------------------------------------------------------
+
+// between file name and extension
+#define wxFILE_SEP_EXT        wxT('.')
+
+// between drive/volume name and the path
+#define wxFILE_SEP_DSK        wxT(':')
+
+// between the path components
+#define wxFILE_SEP_PATH_DOS   wxT('\\')
+#define wxFILE_SEP_PATH_UNIX  wxT('/')
+#define wxFILE_SEP_PATH_MAC   wxT(':')
+#define wxFILE_SEP_PATH_VMS   wxT('.') // VMS also uses '[' and ']'

 
 // separator in the path list (as in PATH environment variable)
 
 // separator in the path list (as in PATH environment variable)

+// there is no PATH variable in Classic Mac OS so just use the
+// semicolon (it must be different from the file name separator)

 // NB: these are strings and not characters on purpose!
 // NB: these are strings and not characters on purpose!

-#define wxPATH_SEP_DOS        T(";")
-#define wxPATH_SEP_UNIX       T(":")
+#define wxPATH_SEP_DOS        wxT(";")
+#define wxPATH_SEP_UNIX       wxT(":")
+#define wxPATH_SEP_MAC        wxT(";")

 
 // platform independent versions
 
 // platform independent versions

-#ifdef  __UNIX__
+#if defined(__UNIX__) && !defined(__CYGWIN__)

   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
   #define wxPATH_SEP          wxPATH_SEP_UNIX
   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_UNIX
   #define wxPATH_SEP          wxPATH_SEP_UNIX

+#elif defined(__MAC__)
+  #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_MAC
+  #define wxPATH_SEP          wxPATH_SEP_MAC
+#elif defined(__CYGWIN__) // Cygwin
+  #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
+  #define wxPATH_SEP          wxPATH_SEP_UNIX

 #else   // Windows and OS/2
   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
   #define wxPATH_SEP          wxPATH_SEP_DOS
 #else   // Windows and OS/2
   #define wxFILE_SEP_PATH     wxFILE_SEP_PATH_DOS
   #define wxPATH_SEP          wxPATH_SEP_DOS


@@ -180,15 +286,22 @@ WXDLLEXPORT bool wxRmdir(const wxString& dir, int flags = 0);
 
 // this is useful for wxString::IsSameAs(): to compare two file names use
 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)
 
 // this is useful for wxString::IsSameAs(): to compare two file names use
 // filename1.IsSameAs(filename2, wxARE_FILENAMES_CASE_SENSITIVE)

-#ifdef  __UNIX__
+#if defined(__UNIX__) && !defined(__DARWIN__)

   #define wxARE_FILENAMES_CASE_SENSITIVE  TRUE
   #define wxARE_FILENAMES_CASE_SENSITIVE  TRUE

-#else   // Windows and OS/2
+#else   // Windows, Mac OS and OS/2

   #define wxARE_FILENAMES_CASE_SENSITIVE  FALSE
 #endif  // Unix/Windows
 
 // is the char a path separator?
 inline bool wxIsPathSeparator(wxChar c)
   #define wxARE_FILENAMES_CASE_SENSITIVE  FALSE
 #endif  // Unix/Windows
 
 // is the char a path separator?
 inline bool wxIsPathSeparator(wxChar c)

-  { return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX; }
+{
+    // under DOS/Windows we should understand both Unix and DOS file separators
+#if defined(__UNIX__) || defined(__MAC__)
+    return c == wxFILE_SEP_PATH;
+#else
+    return c == wxFILE_SEP_PATH_DOS || c == wxFILE_SEP_PATH_UNIX;
+#endif
+}

 
 // does the string ends with path separator?
 WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName);
 
 // does the string ends with path separator?
 WXDLLEXPORT bool wxEndsWithPathSeparator(const wxChar *pszFileName);


@@ -207,6 +320,9 @@ WXDLLEXPORT bool wxFindFileInPath(wxString *pStr, const wxChar *pszPath, const w
 // On non-Windows platform, probably just return the empty string.
 WXDLLEXPORT wxString wxGetOSDirectory();
 
 // On non-Windows platform, probably just return the empty string.
 WXDLLEXPORT wxString wxGetOSDirectory();
 

+// Get file modification time
+WXDLLEXPORT time_t wxFileModificationTime(const wxString& filename);
+

 // ----------------------------------------------------------------------------
 // classes
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // classes
 // ----------------------------------------------------------------------------