]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/file.cpp
Minor source cleaning.
[wxWidgets.git] / src / common / file.cpp
index 99582fae2898945e44b4d102457493ca7999221f..b44087c38b4725a910b5013b6a36c6783a882cd8 100644 (file)
@@ -7,17 +7,13 @@
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
-    #pragma implementation "file.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
@@ -28,8 +24,7 @@
 #if wxUSE_FILE
 
 // standard
-#if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXWINE__) && !defined(__WXMICROWIN__)
-  #include  <io.h>
+#if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
 
 #ifndef __SALFORDC__
     #define   WIN32_LEAN_AND_MEAN
     #define   NOMCX
 #endif
 
+#elif defined(__WXMSW__) && defined(__WXWINCE__)
+    #include  "wx/msw/missing.h"
+#elif (defined(__OS2__))
+    #include <io.h>
 #elif (defined(__UNIX__) || defined(__GNUWIN32__))
     #include  <unistd.h>
+    #include  <time.h>
+    #include  <sys/stat.h>
     #ifdef __GNUWIN32__
-        #include <windows.h>
+        #include "wx/msw/wrapwin.h"
     #endif
 #elif defined(__DOS__)
     #if defined(__WATCOMC__)
     #else
         #error  "Please specify the header with file functions declarations."
     #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>
 #endif
     char* mktemp( char * path ) { return path ;}
     #include <stat.h>
-    #define   W_OK        2
-    #define   R_OK        4
-    #include  <unistd.h>
+    #include <unistd.h>
 #else
     #error  "Please specify the header with file functions declarations."
 #endif  //Win/UNIX
 
 #include  <stdio.h>       // SEEK_xxx constants
-#include  <fcntl.h>       // O_RDONLY &c
-
-#ifndef __MWERKS__
-    #include  <sys/types.h>   // needed for stat
-    #include  <sys/stat.h>    // stat
-#elif ( defined(__MWERKS__) && defined(__WXMSW__) )
-    #include  <sys/types.h>   // needed for stat
-    #include  <sys/stat.h>    // stat
-#endif
 
-#if defined(__BORLANDC__) || defined(_MSC_VER)
-    #define   W_OK        2
-    #define   R_OK        4
-#endif
+// Windows compilers don't have these constants
+#ifndef W_OK
+    enum
+    {
+        F_OK = 0,   // test for existence
+        X_OK = 1,   //          execute permission
+        W_OK = 2,   //          write
+        R_OK = 4    //          read
+    };
+#endif // W_OK
 
 // 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
     #define ACCESS(access)  , (access)
 #endif // Salford C
 
-// wxWindows
+// wxWidgets
 #ifndef WX_PRECOMP
     #include  "wx/string.h"
     #include  "wx/intl.h"
 
 #include  "wx/filename.h"
 #include  "wx/file.h"
+#include  "wx/filefn.h"
 
 #ifdef __WXMSW__
     #include "wx/msw/mslu.h"
 #endif
 
+#ifdef __WXWINCE__
+    #include "wx/msw/private.h"
+#endif
+
+
 // ============================================================================
 // implementation of wxFile
 // ============================================================================
 // ----------------------------------------------------------------------------
 // static functions
 // ----------------------------------------------------------------------------
+
 bool wxFile::Exists(const wxChar *name)
 {
-    wxStructStat st;
-    return !wxAccess(name, 0) &&
-           !wxStat(name, &st) &&
-           (st.st_mode & S_IFREG);
+    return wxFileExists(name);
 }
 
 bool wxFile::Access(const wxChar *name, OpenMode mode)
 {
-    int how = 0;
+    int how;
+
+    switch ( mode )
+    {
+        default:
+            wxFAIL_MSG(wxT("bad wxFile::Access mode parameter."));
+            // fall through
 
-    switch ( mode ) {
         case read:
             how = R_OK;
             break;
@@ -171,11 +172,12 @@ bool wxFile::Access(const wxChar *name, OpenMode mode)
             how = W_OK;
             break;
 
-        default:
-            wxFAIL_MSG(wxT("bad wxFile::Access mode parameter."));
+        case read_write:
+            how = R_OK | W_OK;
+            break;
     }
 
-    return wxAccess( name, how) == 0;
+    return wxAccess(name, how) == 0;
 }
 
 // ----------------------------------------------------------------------------
@@ -186,7 +188,7 @@ bool wxFile::Access(const wxChar *name, OpenMode mode)
 wxFile::wxFile(const wxChar *szFileName, OpenMode mode)
 {
     m_fd = fd_invalid;
-    m_error = FALSE;
+    m_error = false;
 
     Open(szFileName, mode);
 }
@@ -196,9 +198,9 @@ 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
-#if defined(__WXMAC__) && !defined(__UNIX__)
+#if defined(__WXMAC__) && !defined(__UNIX__) && !wxUSE_UNICODE
     // Dominic Mazzoni [dmazzoni+@cs.cmu.edu] reports that open is still broken on the mac, so we replace
-    // int fd = open(wxUnix2MacFilename( szFileName ), O_CREAT | (bOverwrite ? O_TRUNC : O_EXCL), access);
+    // int fd = open( szFileName , O_CREAT | (bOverwrite ? O_TRUNC : O_EXCL), access);
     int fd = creat( szFileName , accessMode);
 #else
     int fd = wxOpen( szFileName,
@@ -209,13 +211,11 @@ bool wxFile::Create(const wxChar *szFileName, bool bOverwrite, int accessMode)
     if ( fd == -1 )
     {
         wxLogSysError(_("can't create file '%s'"), szFileName);
-        return FALSE;
-    }
-    else
-    {
-        Attach(fd);
-        return TRUE;
+        return false;
     }
+
+    Attach(fd);
+    return true;
 }
 
 // open the file
@@ -251,32 +251,40 @@ bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode)
             break;
     }
 
+#ifdef __WINDOWS__
+    // only read/write bits for "all" are supported by this function under
+    // Windows, and VC++ 8 returns EINVAL if any other bits are used in
+    // accessMode, so clear them as they have at best no effect anyhow
+    accessMode &= wxS_IRUSR | wxS_IWUSR;
+#endif // __WINDOWS__
+
     int fd = wxOpen( szFileName, flags ACCESS(accessMode));
+
     if ( fd == -1 )
     {
         wxLogSysError(_("can't open file '%s'"), szFileName);
-        return FALSE;
-    }
-    else {
-        Attach(fd);
-        return TRUE;
+        return false;
     }
+
+    Attach(fd);
+    return true;
 }
 
 // close
 bool wxFile::Close()
 {
     if ( IsOpened() ) {
-        if ( close(m_fd) == -1 ) {
+        if (wxClose(m_fd) == -1)
+        {
             wxLogSysError(_("can't close file descriptor %d"), m_fd);
             m_fd = fd_invalid;
-            return FALSE;
+            return false;
         }
         else
             m_fd = fd_invalid;
     }
 
-    return TRUE;
+    return true;
 }
 
 // ----------------------------------------------------------------------------
@@ -284,21 +292,19 @@ bool wxFile::Close()
 // ----------------------------------------------------------------------------
 
 // read
-off_t wxFile::Read(void *pBuf, off_t nCount)
+ssize_t wxFile::Read(void *pBuf, size_t nCount)
 {
     wxCHECK( (pBuf != NULL) && IsOpened(), 0 );
 
-#ifdef __MWERKS__
-    int iRc = ::read(m_fd, (char*) pBuf, nCount);
-#else
-    int iRc = ::read(m_fd, pBuf, nCount);
-#endif
-    if ( iRc == -1 ) {
+    ssize_t iRc = wxRead(m_fd, pBuf, nCount);
+
+    if ( iRc == -1 )
+    {
         wxLogSysError(_("can't read from file descriptor %d"), m_fd);
         return wxInvalidOffset;
     }
-    else
-        return (size_t)iRc;
+
+    return iRc;
 }
 
 // write
@@ -306,40 +312,35 @@ size_t wxFile::Write(const void *pBuf, size_t nCount)
 {
     wxCHECK( (pBuf != NULL) && IsOpened(), 0 );
 
-#ifdef __MWERKS__
-#if __MSL__ >= 0x6000
-    int iRc = ::write(m_fd, (void*) pBuf, nCount);
-#else
-    int iRc = ::write(m_fd, (const char*) pBuf, nCount);
-#endif
-#else
-    int iRc = ::write(m_fd, pBuf, nCount);
-#endif
-    if ( iRc == -1 ) {
+    ssize_t iRc = wxWrite(m_fd, pBuf, nCount);
+
+    if ( iRc == -1 )
+    {
         wxLogSysError(_("can't write to file descriptor %d"), m_fd);
-        m_error = TRUE;
-        return 0;
+        m_error = true;
+        iRc = 0;
     }
-    else
-        return iRc;
+
+    return iRc;
 }
 
 // flush
 bool wxFile::Flush()
 {
-    if ( IsOpened() ) {
-#if defined(__VISUALC__) || wxHAVE_FSYNC
+#if defined(__VISUALC__) || defined(HAVE_FSYNC)
+    // fsync() only works on disk files and returns errors for pipes, don't
+    // call it then
+    if ( IsOpened() && GetKind() == wxFILE_KIND_DISK )
+    {
         if ( wxFsync(m_fd) == -1 )
         {
             wxLogSysError(_("can't flush file descriptor %d"), m_fd);
-            return FALSE;
+            return false;
         }
-#else // no fsync
-        // just do nothing
-#endif // fsync
     }
+#endif // fsync
 
-    return TRUE;
+    return true;
 }
 
 // ----------------------------------------------------------------------------
@@ -347,9 +348,12 @@ bool wxFile::Flush()
 // ----------------------------------------------------------------------------
 
 // seek
-off_t wxFile::Seek(off_t ofs, wxSeekMode mode)
+wxFileOffset wxFile::Seek(wxFileOffset ofs, wxSeekMode mode)
 {
-    wxASSERT( IsOpened() );
+    wxASSERT_MSG( IsOpened(), _T("can't seek on closed file") );
+    wxCHECK_MSG( ofs != wxInvalidOffset || mode != wxFromStart,
+                 wxInvalidOffset,
+                 _T("invalid absolute file offset") );
 
     int origin;
     switch ( mode ) {
@@ -369,59 +373,55 @@ off_t wxFile::Seek(off_t ofs, wxSeekMode mode)
             break;
     }
 
-    int iRc = lseek(m_fd, ofs, origin);
-    if ( iRc == -1 ) {
+    wxFileOffset iRc = wxSeek(m_fd, ofs, origin);
+    if ( iRc == wxInvalidOffset )
+    {
         wxLogSysError(_("can't seek on file descriptor %d"), m_fd);
-        return wxInvalidOffset;
     }
-    else
-        return (off_t)iRc;
+
+    return iRc;
 }
 
-// get current off_t
-off_t wxFile::Tell() const
+// get current file offset
+wxFileOffset wxFile::Tell() const
 {
     wxASSERT( IsOpened() );
 
-    int iRc = wxTell(m_fd);
-    if ( iRc == -1 ) {
+    wxFileOffset iRc = wxTell(m_fd);
+    if ( iRc == wxInvalidOffset )
+    {
         wxLogSysError(_("can't get seek position on file descriptor %d"), m_fd);
-        return wxInvalidOffset;
     }
-    else
-        return (off_t)iRc;
+
+    return iRc;
 }
 
 // get current file length
-off_t wxFile::Length() const
+wxFileOffset wxFile::Length() const
 {
     wxASSERT( IsOpened() );
 
-#ifdef __VISUALC__
-    int iRc = _filelength(m_fd);
-#else // !VC++
-    int iRc = wxTell(m_fd);
-    if ( iRc != -1 ) {
-        // @ have to use const_cast :-(
-        int iLen = ((wxFile *)this)->SeekEnd();
-        if ( iLen != -1 ) {
+    wxFileOffset iRc = Tell();
+    if ( iRc != wxInvalidOffset ) {
+        // have to use const_cast :-(
+        wxFileOffset iLen = ((wxFile *)this)->SeekEnd();
+        if ( iLen != wxInvalidOffset ) {
             // restore old position
-            if ( ((wxFile *)this)->Seek(iRc) == -1 ) {
+            if ( ((wxFile *)this)->Seek(iRc) == wxInvalidOffset ) {
                 // error
-                iLen = -1;
+                iLen = wxInvalidOffset;
             }
         }
 
         iRc = iLen;
     }
-#endif  // VC++
 
-    if ( iRc == -1 ) {
+    if ( iRc == wxInvalidOffset )
+    {
         wxLogSysError(_("can't find length of file on file descriptor %d"), m_fd);
-        return wxInvalidOffset;
     }
-    else
-        return (off_t)iRc;
+
+    return iRc;
 }
 
 // is end of file reached?
@@ -429,36 +429,30 @@ bool wxFile::Eof() const
 {
     wxASSERT( IsOpened() );
 
-    int iRc;
+    wxFileOffset iRc;
 
 #if defined(__DOS__) || defined(__UNIX__) || defined(__GNUWIN32__) || defined( __MWERKS__ ) || defined(__SALFORDC__)
     // @@ this doesn't work, of course, on unseekable file descriptors
-    off_t ofsCur = Tell(),
+    wxFileOffset ofsCur = Tell(),
     ofsMax = Length();
     if ( ofsCur == wxInvalidOffset || ofsMax == wxInvalidOffset )
-        iRc = -1;
+        iRc = wxInvalidOffset;
     else
         iRc = ofsCur == ofsMax;
 #else  // Windows and "native" compiler
-    iRc = eof(m_fd);
+    iRc = wxEof(m_fd);
 #endif // Windows/Unix
 
-    switch ( iRc ) {
-        case 1:
-            break;
-
-        case 0:
-            return FALSE;
-
-        case -1:
-            wxLogSysError(_("can't determine if the end of file is reached on descriptor %d"), m_fd);
-                break;
-
-        default:
-            wxFAIL_MSG(_("invalid eof() return value."));
-    }
+    if ( iRc == 1)
+        {}
+    else if ( iRc == 0 )
+        return false;
+    else if ( iRc == wxInvalidOffset )
+        wxLogSysError(_("can't determine if the end of file is reached on descriptor %d"), m_fd);
+    else
+        wxFAIL_MSG(_("invalid eof() return value."));
 
-    return TRUE;
+    return true;
 }
 
 // ============================================================================
@@ -496,7 +490,7 @@ bool wxTempFile::Open(const wxString& strName)
     if ( m_strTemp.empty() )
     {
         // CreateTempFileName() failed
-        return FALSE;
+        return false;
     }
 
 #ifdef __UNIX__
@@ -504,7 +498,7 @@ bool wxTempFile::Open(const wxString& strName)
     mode_t mode;
 
     wxStructStat st;
-    if ( stat(m_strName.fn_str(), &st) == 0 )
+    if ( stat( (const char*) m_strName.fn_str(), &st) == 0 )
     {
         mode = st.st_mode;
     }
@@ -517,13 +511,15 @@ bool wxTempFile::Open(const wxString& strName)
         umask(mask);
     }
 
-    if ( chmod(m_strTemp.mb_str(), mode) == -1 )
+    if ( chmod( (const char*) m_strTemp.fn_str(), mode) == -1 )
     {
+#ifndef __OS2__
         wxLogSysError(_("Failed to set temporary file permissions"));
+#endif
     }
 #endif // Unix
 
-    return TRUE;
+    return true;
 }
 
 // ----------------------------------------------------------------------------
@@ -542,15 +538,15 @@ bool wxTempFile::Commit()
 
     if ( wxFile::Exists(m_strName) && wxRemove(m_strName) != 0 ) {
         wxLogSysError(_("can't remove file '%s'"), m_strName.c_str());
-        return FALSE;
+        return false;
     }
 
-    if ( wxRename(m_strTemp, m_strName) != 0 ) {
+    if ( !wxRenameFile(m_strTemp, m_strName)  ) {
         wxLogSysError(_("can't commit changes to file '%s'"), m_strName.c_str());
-        return FALSE;
+        return false;
     }
 
-    return TRUE;
+    return true;
 }
 
 void wxTempFile::Discard()