Fix the URL generated by Doxygen @sampledir macro.

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

diff --git a/src/common/file.cpp b/src/common/file.cpp
index ae71d0ef12bccbbbb051b3a930c48c0aa4c54512..0364794e8bce07c6cb3e2e81019c21864fde0a76 100644 (file)
--- a/src/common/file.cpp
+++ b/src/common/file.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        file.cpp
+// Name:        src/common/file.cpp

 // Purpose:     wxFile - encapsulates low-level "file descriptor"
 //              wxTempFile
 // Author:      Vadim Zeitlin
 // Purpose:     wxFile - encapsulates low-level "file descriptor"
 //              wxTempFile
 // Author:      Vadim Zeitlin


@@ -14,10 +14,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "file.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -30,28 +26,26 @@
 // standard
 #if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
 
 // standard
 #if defined(__WXMSW__) && !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
 

-#ifndef __SALFORDC__
-    #define   WIN32_LEAN_AND_MEAN
-    #define   NOSERVICE
-    #define   NOIME
-    #define   NOATOM
-    #define   NOGDI
-    #define   NOGDICAPMASKS
-    #define   NOMETAFILE
-    #define   NOMINMAX
-    #define   NOMSG
-    #define   NOOPENFILE
-    #define   NORASTEROPS
-    #define   NOSCROLL
-    #define   NOSOUND
-    #define   NOSYSMETRICS
-    #define   NOTEXTMETRIC
-    #define   NOWH
-    #define   NOCOMM
-    #define   NOKANJI
-    #define   NOCRYPT
-    #define   NOMCX
-#endif
+#define   WIN32_LEAN_AND_MEAN
+#define   NOSERVICE
+#define   NOIME
+#define   NOATOM
+#define   NOGDI
+#define   NOGDICAPMASKS
+#define   NOMETAFILE
+#define   NOMINMAX
+#define   NOMSG
+#define   NOOPENFILE
+#define   NORASTEROPS
+#define   NOSCROLL
+#define   NOSOUND
+#define   NOSYSMETRICS
+#define   NOTEXTMETRIC
+#define   NOWH
+#define   NOCOMM
+#define   NOKANJI
+#define   NOCRYPT
+#define   NOMCX

 
 #elif defined(__WXMSW__) && defined(__WXWINCE__)
     #include  "wx/msw/missing.h"
 
 #elif defined(__WXMSW__) && defined(__WXWINCE__)
     #include  "wx/msw/missing.h"


@@ -92,6 +86,10 @@
 
 #include  <stdio.h>       // SEEK_xxx constants
 
 
 #include  <stdio.h>       // SEEK_xxx constants
 

+#ifndef __WXWINCE__
+    #include <errno.h>
+#endif
+

 // Windows compilers don't have these constants
 #ifndef W_OK
     enum
 // Windows compilers don't have these constants
 #ifndef W_OK
     enum


@@ -103,39 +101,24 @@
     };
 #endif // W_OK
 
     };
 #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
-#if defined(__UNIX__) && !defined(O_BINARY)
-    #define   O_BINARY    (0)
-#endif  //__UNIX__
-
-#ifdef __SALFORDC__
-    #include <unix.h>
-#endif
-
-#ifndef MAX_PATH
-    #define MAX_PATH 512
-#endif
-
-// some broken compilers don't have 3rd argument in open() and creat()
-#ifdef __SALFORDC__
-    #define ACCESS(access)
-    #define stat    _stat
-#else // normal compiler
-    #define ACCESS(access)  , (access)
-#endif // Salford C
-

 // wxWidgets
 #ifndef WX_PRECOMP
     #include  "wx/string.h"
     #include  "wx/intl.h"
     #include  "wx/log.h"
 // wxWidgets
 #ifndef WX_PRECOMP
     #include  "wx/string.h"
     #include  "wx/intl.h"
     #include  "wx/log.h"

+    #include "wx/crt.h"

 #endif // !WX_PRECOMP
 
 #include  "wx/filename.h"
 #include  "wx/file.h"
 #include  "wx/filefn.h"
 
 #endif // !WX_PRECOMP
 
 #include  "wx/filename.h"
 #include  "wx/file.h"
 #include  "wx/filefn.h"
 

+// 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__
+

 #ifdef __WXMSW__
     #include "wx/msw/mslu.h"
 #endif
 #ifdef __WXMSW__
     #include "wx/msw/mslu.h"
 #endif


@@ -144,6 +127,9 @@
     #include "wx/msw/private.h"
 #endif
 
     #include "wx/msw/private.h"
 #endif
 

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

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


@@ -153,12 +139,12 @@
 // static functions
 // ----------------------------------------------------------------------------
 
 // static functions
 // ----------------------------------------------------------------------------
 

-bool wxFile::Exists(const wxChar *name)
+bool wxFile::Exists(const wxString& name)

 {
     return wxFileExists(name);
 }
 
 {
     return wxFileExists(name);
 }
 

-bool wxFile::Access(const wxChar *name, OpenMode mode)
+bool wxFile::Access(const wxString& name, OpenMode mode)

 {
     int how;
 
 {
     int how;
 


@@ -189,43 +175,51 @@ bool wxFile::Access(const wxChar *name, OpenMode mode)
 // ----------------------------------------------------------------------------
 
 // ctors
 // ----------------------------------------------------------------------------
 
 // ctors

-wxFile::wxFile(const wxChar *szFileName, OpenMode mode)
+wxFile::wxFile(const wxString& fileName, OpenMode mode)

 {
     m_fd = fd_invalid;
 {
     m_fd = fd_invalid;

-    m_error = false;
+    m_lasterror = 0;

 
 

-    Open(szFileName, mode);
+    Open(fileName, mode);
+}
+
+bool wxFile::CheckForError(wxFileOffset rc) const
+{
+    if ( rc != -1 )
+        return false;
+
+    const_cast<wxFile *>(this)->m_lasterror =
+#ifndef __WXWINCE__
+                                                errno
+#else
+                                                ::GetLastError()
+#endif
+                                                ;
+
+    return true;

 }
 
 // create the file, fail if it already exists and bOverwrite
 }
 
 // create the file, fail if it already exists and bOverwrite

-bool wxFile::Create(const wxChar *szFileName, bool bOverwrite, int accessMode)
+bool wxFile::Create(const wxString& fileName, 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 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__) && !wxUSE_UNICODE
-    // Dominic Mazzoni [dmazzoni+@cs.cmu.edu] reports that open is still broken on the mac, so we replace
-    // int fd = open( szFileName , O_CREAT | (bOverwrite ? O_TRUNC : O_EXCL), access);
-    int fd = creat( szFileName , accessMode);
-#else
-    int fd = wxOpen( szFileName,
+    int fd = wxOpen( fileName,

                      O_BINARY | O_WRONLY | O_CREAT |
                      O_BINARY | O_WRONLY | O_CREAT |

-                     (bOverwrite ? O_TRUNC : O_EXCL)
-                     ACCESS(accessMode) );
-#endif
-    if ( fd == -1 )
+                     (bOverwrite ? O_TRUNC : O_EXCL),
+                     accessMode );
+    if ( CheckForError(fd) )

     {
     {

-        wxLogSysError(_("can't create file '%s'"), szFileName);
+        wxLogSysError(_("can't create file '%s'"), fileName);

         return false;
     }
         return false;
     }

-    else
-    {
-        Attach(fd);
-        return true;
-    }
+
+    Attach(fd);
+    return true;

 }
 
 // open the file
 }
 
 // open the file

-bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode)
+bool wxFile::Open(const wxString& fileName, OpenMode mode, int accessMode)

 {
     int flags = O_BINARY;
 
 {
     int flags = O_BINARY;
 


@@ -236,7 +230,7 @@ bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode)
             break;
 
         case write_append:
             break;
 
         case write_append:

-            if ( wxFile::Exists(szFileName) )
+            if ( wxFile::Exists(fileName) )

             {
                 flags |= O_WRONLY | O_APPEND;
                 break;
             {
                 flags |= O_WRONLY | O_APPEND;
                 break;


@@ -264,24 +258,23 @@ bool wxFile::Open(const wxChar *szFileName, OpenMode mode, int accessMode)
     accessMode &= wxS_IRUSR | wxS_IWUSR;
 #endif // __WINDOWS__
 
     accessMode &= wxS_IRUSR | wxS_IWUSR;
 #endif // __WINDOWS__
 

-    int fd = wxOpen( szFileName, flags ACCESS(accessMode));
+    int fd = wxOpen( fileName, flags, accessMode);

 
 

-    if ( fd == -1 )
+    if ( CheckForError(fd) )

     {
     {

-        wxLogSysError(_("can't open file '%s'"), szFileName);
+        wxLogSysError(_("can't open file '%s'"), fileName);

         return false;
     }
         return false;
     }

-    else {
-        Attach(fd);
-        return true;
-    }
+
+    Attach(fd);
+    return true;

 }
 
 // close
 bool wxFile::Close()
 {
     if ( IsOpened() ) {
 }
 
 // close
 bool wxFile::Close()
 {
     if ( IsOpened() ) {

-        if (wxClose(m_fd) == -1)
+        if ( CheckForError(wxClose(m_fd)) )

         {
             wxLogSysError(_("can't close file descriptor %d"), m_fd);
             m_fd = fd_invalid;
         {
             wxLogSysError(_("can't close file descriptor %d"), m_fd);
             m_fd = fd_invalid;


@@ -305,7 +298,7 @@ ssize_t wxFile::Read(void *pBuf, size_t nCount)
 
     ssize_t iRc = wxRead(m_fd, pBuf, nCount);
 
 
     ssize_t iRc = wxRead(m_fd, pBuf, nCount);
 

-    if ( iRc == -1 )
+    if ( CheckForError(iRc) )

     {
         wxLogSysError(_("can't read from file descriptor %d"), m_fd);
         return wxInvalidOffset;
     {
         wxLogSysError(_("can't read from file descriptor %d"), m_fd);
         return wxInvalidOffset;


@@ -321,31 +314,45 @@ size_t wxFile::Write(const void *pBuf, size_t nCount)
 
     ssize_t iRc = wxWrite(m_fd, pBuf, nCount);
 
 
     ssize_t iRc = wxWrite(m_fd, pBuf, nCount);
 

-    if ( iRc == -1 )
+    if ( CheckForError(iRc) )

     {
         wxLogSysError(_("can't write to file descriptor %d"), m_fd);
     {
         wxLogSysError(_("can't write to file descriptor %d"), m_fd);

-        m_error = true;

         iRc = 0;
     }
 
     return iRc;
 }
 
         iRc = 0;
     }
 
     return iRc;
 }
 

+bool wxFile::Write(const wxString& s, const wxMBConv& conv)
+{
+  const wxWX2MBbuf buf = s.mb_str(conv);
+  if ( !buf )
+      return false;
+
+#if wxUSE_UNICODE
+  const size_t size = buf.length();
+#else
+  const size_t size = s.length();
+#endif
+
+  return Write(buf, size) == size;
+}
+

 // flush
 bool wxFile::Flush()
 {
 // flush
 bool wxFile::Flush()
 {

-#if defined(__VISUALC__) || defined(HAVE_FSYNC)
+#ifdef HAVE_FSYNC

     // fsync() only works on disk files and returns errors for pipes, don't
     // call it then
     if ( IsOpened() && GetKind() == wxFILE_KIND_DISK )
     {
     // 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 )
+        if ( CheckForError(wxFsync(m_fd)) )

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

-#endif // fsync
+#endif // HAVE_FSYNC

 
     return true;
 }
 
     return true;
 }


@@ -357,15 +364,15 @@ bool wxFile::Flush()
 // seek
 wxFileOffset wxFile::Seek(wxFileOffset ofs, wxSeekMode mode)
 {
 // seek
 wxFileOffset wxFile::Seek(wxFileOffset ofs, wxSeekMode mode)
 {

-    wxASSERT_MSG( IsOpened(), _T("can't seek on closed file") );
+    wxASSERT_MSG( IsOpened(), wxT("can't seek on closed file") );

     wxCHECK_MSG( ofs != wxInvalidOffset || mode != wxFromStart,
                  wxInvalidOffset,
     wxCHECK_MSG( ofs != wxInvalidOffset || mode != wxFromStart,
                  wxInvalidOffset,

-                 _T("invalid absolute file offset") );
+                 wxT("invalid absolute file offset") );

 
     int origin;
     switch ( mode ) {
         default:
 
     int origin;
     switch ( mode ) {
         default:

-            wxFAIL_MSG(_("unknown seek origin"));
+            wxFAIL_MSG(wxT("unknown seek origin"));

 
         case wxFromStart:
             origin = SEEK_SET;
 
         case wxFromStart:
             origin = SEEK_SET;


@@ -381,7 +388,7 @@ wxFileOffset wxFile::Seek(wxFileOffset ofs, wxSeekMode mode)
     }
 
     wxFileOffset iRc = wxSeek(m_fd, ofs, origin);
     }
 
     wxFileOffset iRc = wxSeek(m_fd, ofs, origin);

-    if ( iRc == wxInvalidOffset )
+    if ( CheckForError(iRc) )

     {
         wxLogSysError(_("can't seek on file descriptor %d"), m_fd);
     }
     {
         wxLogSysError(_("can't seek on file descriptor %d"), m_fd);
     }


@@ -395,7 +402,7 @@ wxFileOffset wxFile::Tell() const
     wxASSERT( IsOpened() );
 
     wxFileOffset iRc = wxTell(m_fd);
     wxASSERT( IsOpened() );
 
     wxFileOffset iRc = wxTell(m_fd);

-    if ( iRc == wxInvalidOffset )
+    if ( CheckForError(iRc) )

     {
         wxLogSysError(_("can't get seek position on file descriptor %d"), m_fd);
     }
     {
         wxLogSysError(_("can't get seek position on file descriptor %d"), m_fd);
     }


@@ -408,10 +415,24 @@ wxFileOffset wxFile::Length() const
 {
     wxASSERT( IsOpened() );
 
 {
     wxASSERT( IsOpened() );
 

+    // we use a special method for Linux systems where files in sysfs (i.e.
+    // those under /sys typically) return length of 4096 bytes even when
+    // they're much smaller -- this is a problem as it results in errors later
+    // when we try reading 4KB from them
+#ifdef __LINUX__
+    struct stat st;
+    if ( fstat(m_fd, &st) == 0 )
+    {
+        // returning 0 for the special files indicates to the caller that they
+        // are not seekable
+        return st.st_blocks ? st.st_size : 0;
+    }
+    //else: failed to stat, try the normal method
+#endif // __LINUX__
+

     wxFileOffset iRc = Tell();
     if ( iRc != wxInvalidOffset ) {
     wxFileOffset iRc = Tell();
     if ( iRc != wxInvalidOffset ) {

-        // have to use const_cast :-(
-        wxFileOffset iLen = ((wxFile *)this)->SeekEnd();
+        wxFileOffset iLen = const_cast<wxFile *>(this)->SeekEnd();

         if ( iLen != wxInvalidOffset ) {
             // restore old position
             if ( ((wxFile *)this)->Seek(iRc) == wxInvalidOffset ) {
         if ( iLen != wxInvalidOffset ) {
             // restore old position
             if ( ((wxFile *)this)->Seek(iRc) == wxInvalidOffset ) {


@@ -425,6 +446,7 @@ wxFileOffset wxFile::Length() const
 
     if ( iRc == wxInvalidOffset )
     {
 
     if ( iRc == wxInvalidOffset )
     {

+        // last error was already set by Tell()

         wxLogSysError(_("can't find length of file on file descriptor %d"), m_fd);
     }
 
         wxLogSysError(_("can't find length of file on file descriptor %d"), m_fd);
     }
 


@@ -438,7 +460,7 @@ bool wxFile::Eof() const
 
     wxFileOffset iRc;
 
 
     wxFileOffset iRc;
 

-#if defined(__DOS__) || defined(__UNIX__) || defined(__GNUWIN32__) || defined( __MWERKS__ ) || defined(__SALFORDC__)
+#if defined(__DOS__) || defined(__UNIX__) || defined(__GNUWIN32__) || defined( __MWERKS__ )

     // @@ this doesn't work, of course, on unseekable file descriptors
     wxFileOffset ofsCur = Tell(),
     ofsMax = Length();
     // @@ this doesn't work, of course, on unseekable file descriptors
     wxFileOffset ofsCur = Tell(),
     ofsMax = Length();


@@ -450,14 +472,17 @@ bool wxFile::Eof() const
     iRc = wxEof(m_fd);
 #endif // Windows/Unix
 
     iRc = wxEof(m_fd);
 #endif // Windows/Unix
 

-    if ( iRc == 1)
-        {}
-    else if ( iRc == 0 )
+    if ( iRc == 0 )

         return false;
         return false;

-    else if ( iRc == wxInvalidOffset )
+
+    if ( iRc == wxInvalidOffset )
+    {

         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);

-    else
-        wxFAIL_MSG(_("invalid eof() return value."));
+    }
+    else if ( iRc != 1 )
+    {
+        wxFAIL_MSG(wxT("invalid eof() return value."));
+    }

 
     return true;
 }
 
     return true;
 }


@@ -560,7 +585,9 @@ void wxTempFile::Discard()
 {
     m_file.Close();
     if ( wxRemove(m_strTemp) != 0 )
 {
     m_file.Close();
     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());

+    }

 }
 
 #endif // wxUSE_FILE
 }
 
 #endif // wxUSE_FILE