Added chapter on collection and container classes to contents

[wxWidgets.git] / src / common / file.cpp

diff --git a/src/common/file.cpp b/src/common/file.cpp
index b29367e38965c68eee77de20a3a4f7f70217ada9..cd4f7c7a010f1fe7179a10798e6051373447f9e1 100644 (file)
--- a/src/common/file.cpp
+++ b/src/common/file.cpp
@@ -20,14 +20,15 @@
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"

-#include "wx/defs.h"

 
 #ifdef __BORLANDC__
 
 #ifdef __BORLANDC__

-    #pragma hdrstop
+  #pragma hdrstop

 #endif
 
 #endif
 

+#if wxUSE_FILE
+

 // standard
 // standard

-#if   defined(__WXMSW__) && !defined(__GNUWIN32__)
+#if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXWINE__)

   #include  <io.h>
 
 #ifndef __SALFORDC__
   #include  <io.h>
 
 #ifndef __SALFORDC__


@@ -59,6 +60,10 @@
     #ifdef __GNUWIN32__
         #include <windows.h>
     #endif
     #ifdef __GNUWIN32__
         #include <windows.h>
     #endif

+#elif (defined(__WXPM__))
+    #include <io.h>
+    #define   W_OK        2
+    #define   R_OK        4

 #elif (defined(__WXSTUBS__))
     // Have to ifdef this for different environments
     #include <io.h>
 #elif (defined(__WXSTUBS__))
     // Have to ifdef this for different environments
     #include <io.h>


@@ -81,43 +86,14 @@
     #include  <sys/stat.h>    // stat
 #endif
 
     #include  <sys/stat.h>    // stat
 #endif
 

-// Microsoft compiler loves underscores, feed them to it
-#ifdef  __VISUALC__
-    // functions
-    #define   open        _open
-    #define   close       _close
-    #define   read        _read
-    #define   write       _write
-    #define   lseek       _lseek
-    #define   fsync       _commit
-    #define   access      _access
-    #define   eof         _eof
-
-    // types
-    #define   stat        _stat
-
-    // constants
-
-    #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_IFDIR     _S_IFDIR
-    #define   S_IFREG     _S_IFREG
-#else
-    #define   tell(fd)    lseek(fd, 0, SEEK_CUR)
-#endif  // VC++
-

 #if defined(__BORLANDC__) || defined(_MSC_VER)
     #define   W_OK        2
     #define   R_OK        4
 #endif
 
 #if defined(__BORLANDC__) || defined(_MSC_VER)
     #define   W_OK        2
     #define   R_OK        4
 #endif
 

-// there is no distinction between text and binary files under Unix
-#ifdef    __UNIX__
+// there is no distinction between text and binary files under Unix, so define
+// O_BINARY as 0 if the system headers don't do it already
+#if defined(__UNIX__) && !defined(O_BINARY)

     #define   O_BINARY    (0)
 #endif  //__UNIX__
 
     #define   O_BINARY    (0)
 #endif  //__UNIX__
 


@@ -125,22 +101,10 @@
     #include <unix.h>
 #endif
 
     #include <unix.h>
 #endif
 

-// wxWindows
-#include  <wx/string.h>
-#include  <wx/intl.h>
-#include  <wx/file.h>
-#include  <wx/log.h>
-

 #ifndef MAX_PATH
     #define MAX_PATH 512
 #endif
 
 #ifndef MAX_PATH
     #define MAX_PATH 512
 #endif
 

-#ifdef __WXMAC__
-    char gwxMacFileName[ MAX_PATH ] ;
-    char gwxMacFileName2[ MAX_PATH ] ;
-    char gwxMacFileName3[ MAX_PATH ] ;
-#endif
-

 // some broken compilers don't have 3rd argument in open() and creat()
 #ifdef __SALFORDC__
     #define ACCESS(access)
 // some broken compilers don't have 3rd argument in open() and creat()
 #ifdef __SALFORDC__
     #define ACCESS(access)


@@ -149,6 +113,12 @@
     #define ACCESS(access)  , (access)
 #endif // Salford C
 
     #define ACCESS(access)  , (access)
 #endif // Salford C
 

+// wxWindows
+#include  "wx/string.h"
+#include  "wx/intl.h"
+#include  "wx/file.h"
+#include  "wx/log.h"
+

 // ============================================================================
 // implementation of wxFile
 // ============================================================================
 // ============================================================================
 // implementation of wxFile
 // ============================================================================


@@ -158,18 +128,26 @@
 // ----------------------------------------------------------------------------
 bool wxFile::Exists(const wxChar *name)
 {
 // ----------------------------------------------------------------------------
 bool wxFile::Exists(const wxChar *name)
 {

-    struct stat st;
+    wxStructStat st;

 #if wxUSE_UNICODE && wxMBFILES
 #if wxUSE_UNICODE && wxMBFILES

-    wxCharBuffer fname = wxConv_file.cWC2MB(name);
+    wxCharBuffer fname = wxConvFile.cWC2MB(name);

 
 

-    return !access(fname, 0) &&
-           !stat(MBSTRINGCAST fname, &st) &&
+#ifdef __WXMAC__
+  return !access(wxUnix2MacFilename( name ) , 0) && !stat(wxUnix2MacFilename( name ), &st) && (st.st_mode & S_IFREG);
+#else
+    return !wxAccess(fname, 0) &&
+           !wxStat(wxMBSTRINGCAST fname, &st) &&

            (st.st_mode & S_IFREG);
            (st.st_mode & S_IFREG);

+#endif

 #else
 #else

-    return !access(name, 0) &&
-           !stat((wxChar*) name, &st) &&
+#ifdef __WXMAC__
+  return !access(wxUnix2MacFilename( name ) , 0) && !stat(wxUnix2MacFilename( name ), &st) && (st.st_mode & S_IFREG);
+#else
+    return !wxAccess(name, 0) &&
+           !wxStat(name, &st) &&

            (st.st_mode & S_IFREG);
 #endif
            (st.st_mode & S_IFREG);
 #endif

+#endif

 }
 
 bool wxFile::Access(const wxChar *name, OpenMode mode)
 }
 
 bool wxFile::Access(const wxChar *name, OpenMode mode)


@@ -186,10 +164,10 @@ bool wxFile::Access(const wxChar *name, OpenMode mode)
             break;
 
         default:
             break;
 
         default:

-            wxFAIL_MSG(_T("bad wxFile::Access mode parameter."));
+            wxFAIL_MSG(wxT("bad wxFile::Access mode parameter."));

     }
 
     }
 

-    return access(wxFNCONV(name), how) == 0;
+    return wxAccess(wxFNCONV(name), how) == 0;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -205,21 +183,19 @@ wxFile::wxFile(const wxChar *szFileName, OpenMode mode)
     Open(szFileName, mode);
 }
 
     Open(szFileName, mode);
 }
 

-// dtor
-wxFile::~wxFile()
-{
-    Close();
-}
-

 // create the file, fail if it already exists and bOverwrite
 bool wxFile::Create(const wxChar *szFileName, bool bOverwrite, int accessMode)
 {
     // if bOverwrite we create a new file or truncate the existing one,
     // otherwise we only create the new file and fail if it already exists
 // create the file, fail if it already exists and bOverwrite
 bool wxFile::Create(const wxChar *szFileName, bool bOverwrite, int accessMode)
 {
     // if bOverwrite we create a new file or truncate the existing one,
     // otherwise we only create the new file and fail if it already exists

-    int fd = open(wxFNCONV(szFileName),
-                  O_WRONLY | O_CREAT | (bOverwrite ? O_TRUNC : O_EXCL)
-                  ACCESS(accessMode));
-
+#ifdef __WXMAC__
+    int fd = open(wxUnix2MacFilename( szFileName ), O_CREAT | (bOverwrite ? O_TRUNC : O_EXCL), access);
+#else
+    int fd = wxOpen(wxFNCONV(szFileName),
+                    O_BINARY | O_WRONLY | O_CREAT |
+                    (bOverwrite ? O_TRUNC : O_EXCL)
+                    ACCESS(accessMode));
+#endif

     if ( fd == -1 ) {
         wxLogSysError(_("can't create file '%s'"), szFileName);
         return FALSE;
     if ( fd == -1 ) {
         wxLogSysError(_("can't create file '%s'"), szFileName);
         return FALSE;


@@ -240,21 +216,29 @@ bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode)
             flags |= O_RDONLY;
             break;
 
             flags |= O_RDONLY;
             break;
 

+        case write_append:
+            if ( wxFile::Exists(szFileName) )
+            {
+                flags |= O_WRONLY | O_APPEND;
+                break;
+            }
+            //else: fall through as write_append is the same as write if the
+            //      file doesn't exist
+

         case write:
             flags |= O_WRONLY | O_CREAT | O_TRUNC;
             break;
 
         case write:
             flags |= O_WRONLY | O_CREAT | O_TRUNC;
             break;
 

-        case write_append:
-            flags |= O_WRONLY | O_APPEND;
-            break;
-

         case read_write:
             flags |= O_RDWR;
             break;
     }
 
         case read_write:
             flags |= O_RDWR;
             break;
     }
 

-    int fd = open(wxFNCONV(szFileName), flags ACCESS(accessMode));
-
+#ifdef __WXMAC__
+    int fd = open(wxUnix2MacFilename( szFileName ), flags, access);
+#else
+    int fd = wxOpen(wxFNCONV(szFileName), flags ACCESS(accessMode));
+#endif

     if ( fd == -1 ) {
         wxLogSysError(_("can't open file '%s'"), szFileName);
         return FALSE;
     if ( fd == -1 ) {
         wxLogSysError(_("can't open file '%s'"), szFileName);
         return FALSE;


@@ -327,7 +311,7 @@ bool wxFile::Flush()
 {
     if ( IsOpened() ) {
 #if defined(__VISUALC__) || wxHAVE_FSYNC
 {
     if ( IsOpened() ) {
 #if defined(__VISUALC__) || wxHAVE_FSYNC

-        if ( fsync(m_fd) == -1 )
+        if ( wxFsync(m_fd) == -1 )

         {
             wxLogSysError(_("can't flush file descriptor %d"), m_fd);
             return FALSE;
         {
             wxLogSysError(_("can't flush file descriptor %d"), m_fd);
             return FALSE;


@@ -349,25 +333,25 @@ off_t wxFile::Seek(off_t ofs, wxSeekMode mode)
 {
     wxASSERT( IsOpened() );
 
 {
     wxASSERT( IsOpened() );
 

-    int flag = -1;
+    int origin;

     switch ( mode ) {
     switch ( mode ) {

+        default:
+            wxFAIL_MSG(_("unknown seek origin"));
+

         case wxFromStart:
         case wxFromStart:

-            flag = SEEK_SET;
+            origin = SEEK_SET;

             break;
 
         case wxFromCurrent:
             break;
 
         case wxFromCurrent:

-            flag = SEEK_CUR;
+            origin = SEEK_CUR;

             break;
 
         case wxFromEnd:
             break;
 
         case wxFromEnd:

-            flag = SEEK_END;
+            origin = SEEK_END;

             break;
             break;

-
-        default:
-            wxFAIL_MSG(_("unknown seek origin"));

     }
 
     }
 

-    int iRc = lseek(m_fd, ofs, flag);
+    int iRc = lseek(m_fd, ofs, origin);

     if ( iRc == -1 ) {
         wxLogSysError(_("can't seek on file descriptor %d"), m_fd);
         return wxInvalidOffset;
     if ( iRc == -1 ) {
         wxLogSysError(_("can't seek on file descriptor %d"), m_fd);
         return wxInvalidOffset;


@@ -381,7 +365,7 @@ off_t wxFile::Tell() const
 {
     wxASSERT( IsOpened() );
 
 {
     wxASSERT( IsOpened() );
 

-    int iRc = tell(m_fd);
+    int iRc = wxTell(m_fd);

     if ( iRc == -1 ) {
         wxLogSysError(_("can't get seek position on file descriptor %d"), m_fd);
         return wxInvalidOffset;
     if ( iRc == -1 ) {
         wxLogSysError(_("can't get seek position on file descriptor %d"), m_fd);
         return wxInvalidOffset;


@@ -398,7 +382,7 @@ off_t wxFile::Length() const
 #ifdef __VISUALC__
     int iRc = _filelength(m_fd);
 #else // !VC++
 #ifdef __VISUALC__
     int iRc = _filelength(m_fd);
 #else // !VC++

-    int iRc = tell(m_fd);
+    int iRc = wxTell(m_fd);

     if ( iRc != -1 ) {
         // @ have to use const_cast :-(
         int iLen = ((wxFile *)this)->SeekEnd();
     if ( iRc != -1 ) {
         // @ have to use const_cast :-(
         int iLen = ((wxFile *)this)->SeekEnd();


@@ -449,8 +433,7 @@ bool wxFile::Eof() const
             return FALSE;
 
         case -1:
             return FALSE;
 
         case -1:

-            wxLogSysError(_("can't determine if the end of file is reached on \
-                descriptor %d"), m_fd);
+            wxLogSysError(_("can't determine if the end of file is reached on descriptor %d"), m_fd);

                 break;
 
         default:
                 break;
 
         default:


@@ -481,31 +464,39 @@ bool wxTempFile::Open(const wxString& strName)
     // different partitions for example). Unfortunately, the only standard
     // (POSIX) temp file creation function tmpnam() can't do it.
 #if defined(__UNIX__) || defined(__WXSTUBS__)|| defined( __WXMAC__ )
     // different partitions for example). Unfortunately, the only standard
     // (POSIX) temp file creation function tmpnam() can't do it.
 #if defined(__UNIX__) || defined(__WXSTUBS__)|| defined( __WXMAC__ )

-    static const wxChar *szMktempSuffix = _T("XXXXXX");
+    static const wxChar *szMktempSuffix = wxT("XXXXXX");

     m_strTemp << strName << szMktempSuffix;
     m_strTemp << strName << szMktempSuffix;

-    mktemp(MBSTRINGCAST m_strTemp.mb_str()); // will do because length doesn't change
+    // can use the cast because length doesn't change
+    mktemp(wxMBSTRINGCAST m_strTemp.mb_str());
+#elif  defined(__WXPM__)
+    // for now just create a file
+    // future enhancements can be to set some extended attributes for file systems
+    // OS/2 supports that have them (HPFS, FAT32) and security (HPFS386)
+    static const wxChar *szMktempSuffix = wxT("XXX");
+    m_strTemp << strName << szMktempSuffix;
+    ::DosCreateDir(m_strTemp.GetWriteBuf(MAX_PATH), NULL);

 #else // Windows
     wxString strPath;
     wxSplitPath(strName, &strPath, NULL, NULL);
     if ( strPath.IsEmpty() )
 #else // Windows
     wxString strPath;
     wxSplitPath(strName, &strPath, NULL, NULL);
     if ( strPath.IsEmpty() )

-        strPath = _T('.');  // GetTempFileName will fail if we give it empty string
+        strPath = wxT('.');  // GetTempFileName will fail if we give it empty string

 #ifdef __WIN32__
 #ifdef __WIN32__

-    if ( !GetTempFileName(strPath, _T("wx_"),0, m_strTemp.GetWriteBuf(MAX_PATH)) )
+    if ( !GetTempFileName(strPath, wxT("wx_"),0, m_strTemp.GetWriteBuf(MAX_PATH)) )

 #else
         // Not sure why MSVC++ 1.5 header defines first param as BYTE - bug?
 #else
         // Not sure why MSVC++ 1.5 header defines first param as BYTE - bug?

-        if ( !GetTempFileName((BYTE) (const wxChar*) strPath, _T("wx_"),0, m_strTemp.GetWriteBuf(MAX_PATH)) )
+        if ( !GetTempFileName((BYTE) (DWORD)(const wxChar*) strPath, wxT("wx_"),0, m_strTemp.GetWriteBuf(MAX_PATH)) )

 #endif
 #endif

-            wxLogLastError(_T("GetTempFileName"));
+            wxLogLastError(wxT("GetTempFileName"));

     m_strTemp.UngetWriteBuf();
 #endif  // Windows/Unix
 
     int access = wxS_DEFAULT;
 #ifdef __UNIX__
     // create the file with the same mode as the original one under Unix
     m_strTemp.UngetWriteBuf();
 #endif  // Windows/Unix
 
     int access = wxS_DEFAULT;
 #ifdef __UNIX__
     // create the file with the same mode as the original one under Unix

-    mode_t umaskOld;
+    mode_t umaskOld = 0; // just to suppress compiler warning

     bool changedUmask;
 
     bool changedUmask;
 

-    struct stat st;
+    wxStructStat st;

     if ( stat(strName.fn_str(), &st) == 0 )
     {
         // this assumes that only lower bits of st_mode contain the access
     if ( stat(strName.fn_str(), &st) == 0 )
     {
         // this assumes that only lower bits of st_mode contain the access


@@ -554,15 +545,27 @@ bool wxTempFile::Commit()
 {
     m_file.Close();
 
 {
     m_file.Close();
 

-    if ( wxFile::Exists(m_strName) && remove(m_strName.fn_str()) != 0 ) {
+#ifndef __WXMAC__
+    if ( wxFile::Exists(m_strName) && wxRemove(m_strName) != 0 ) {

         wxLogSysError(_("can't remove file '%s'"), m_strName.c_str());
         return FALSE;
     }
 
         wxLogSysError(_("can't remove file '%s'"), m_strName.c_str());
         return FALSE;
     }
 

-    if ( rename(m_strTemp.fn_str(), m_strName.fn_str()) != 0 ) {
+    if ( wxRename(m_strTemp, m_strName) != 0 ) {

         wxLogSysError(_("can't commit changes to file '%s'"), m_strName.c_str());
         return FALSE;
     }
         wxLogSysError(_("can't commit changes to file '%s'"), m_strName.c_str());
         return FALSE;
     }

+#else
+  if ( wxFile::Exists(m_strName) && remove(wxUnix2MacFilename( m_strName )) != 0 ) {
+    wxLogSysError(_("can't remove file '%s'"), m_strName.c_str());
+    return FALSE;
+  }
+
+  if ( rename(wxUnix2MacFilename( m_strTemp ), wxUnix2MacFilename( m_strName )) != 0 ) {
+    wxLogSysError(_("can't commit changes to file '%s'"), m_strName.c_str());
+    return FALSE;
+  }
+#endif

 
     return TRUE;
 }
 
     return TRUE;
 }


@@ -570,6 +573,14 @@ bool wxTempFile::Commit()
 void wxTempFile::Discard()
 {
     m_file.Close();
 void wxTempFile::Discard()
 {
     m_file.Close();

-    if ( remove(m_strTemp.fn_str()) != 0 )
+#ifndef __WXMAC__
+    if ( wxRemove(m_strTemp) != 0 )

         wxLogSysError(_("can't remove temporary file '%s'"), m_strTemp.c_str());
         wxLogSysError(_("can't remove temporary file '%s'"), m_strTemp.c_str());

+#else
+    if ( remove( wxUnix2MacFilename(m_strTemp.fn_str())) != 0 )
+        wxLogSysError(_("can't remove temporary file '%s'"), m_strTemp.c_str());
+#endif

 }
 }

+
+#endif
+