]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/textfile.cpp
fix bug introduced by the last change: we could overwrite the buffer if the file...
[wxWidgets.git] / src / common / textfile.cpp
index 77510ace07e8c07a1cd2cec3f4e80615cbf0fe89..79d837f6319ccc8e87ee574410c795b78c29b8cc 100644 (file)
@@ -6,17 +6,13 @@
 // Created:     03.04.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 "textfile.h"
-#endif
-
 #include  "wx/wxprec.h"
 
 #ifdef    __BORLANDC__
 #if wxUSE_TEXTFILE
 
 #ifndef WX_PRECOMP
-    #include  "wx/string.h"
-    #include  "wx/intl.h"
-    #include  "wx/file.h"
-    #include  "wx/log.h"
+    #include "wx/string.h"
+    #include "wx/intl.h"
+    #include "wx/file.h"
+    #include "wx/log.h"
 #endif
 
 #include "wx/textfile.h"
+#include "wx/filename.h"
+#include "wx/buffer.h"
 
 // ============================================================================
 // wxTextFile class implementation
@@ -61,21 +59,22 @@ bool wxTextFile::OnExists() const
 
 bool wxTextFile::OnOpen(const wxString &strBufferName, wxTextBufferOpenMode OpenMode)
 {
-    wxFile::OpenMode FileOpenMode = wxFile::read;
-    int                             nAssertVal = 0;
+    wxFile::OpenMode FileOpenMode;
+
+    switch ( OpenMode )
+    {
+        default:
+            wxFAIL_MSG( _T("unknown open mode in wxTextFile::Open") );
+            // fall through
 
-    switch (OpenMode)
-  {
         case ReadAccess :
             FileOpenMode = wxFile::read;
             break;
+
         case WriteAccess :
             FileOpenMode = wxFile::write;
             break;
-        default :
-            wxASSERT(nAssertVal); // Should not happen.
-            break;
-  }
+    }
 
     return m_file.Open(strBufferName.c_str(), FileOpenMode);
 }
@@ -87,95 +86,219 @@ bool wxTextFile::OnClose()
 }
 
 
-bool wxTextFile::OnRead(wxMBConv& conv)
+bool wxTextFile::OnRead(const wxMBConv& conv)
 {
-  // file should be opened and we must be in it's beginning
-  wxASSERT( m_file.IsOpened() && m_file.Tell() == 0 );
-
-#if wxUSE_UNICODE
-  char conv_mbBuf[2];
-  wchar_t conv_wcBuf[2];
-  conv_mbBuf[1] = 0;
-#else
-  (void)conv;
-#endif
+    // file should be opened
+    wxASSERT_MSG( m_file.IsOpened(), _T("can't read closed file") );
+
+    // read the entire file in memory: this is not the most efficient thing to
+    // do it but there is no good way to avoid it in Unicode build because if
+    // we read the file block by block we can't convert each block to Unicode
+    // separately (the last multibyte char in the block might be only partially
+    // read and so the conversion would fail) and, as the file contents is kept
+    // in memory by wxTextFile anyhow, it shouldn't be a big problem to read
+    // the file entirely
+    size_t bufSize = 0;
+
+    // number of bytes to (try to) read from disk at once
+    static const size_t BLOCK_SIZE = 4096;
+
+    wxCharBuffer buf;
+
+    // first determine if the file is seekable or not and so whether we can
+    // determine its length in advance
+    wxFileOffset fileLength;
+    {
+        wxLogNull logNull;
+        fileLength = m_file.Length();
+    }
 
-  wxString str;
-  char ch, chLast = '\0';
-  char buf[1024];
-  int n, nRead;
-  do {
-    nRead = m_file.Read(buf, WXSIZEOF(buf));
-    if ( nRead == wxInvalidOffset ) {
-      // read error (error message already given in wxFile::Read)
-      return FALSE;
+    // some non-seekable files under /proc under Linux pretend that they're
+    // seekable but always return 0; others do return an error
+    const bool seekable = fileLength != wxInvalidOffset && fileLength != 0;
+    if ( seekable )
+    {
+        // we know the required length, so set the buffer size in advance
+        bufSize = fileLength;
+        if ( !buf.extend(bufSize) )
+            return false;
+
+        // if the file is seekable, also check that we're at its beginning
+        wxASSERT_MSG( m_file.Tell() == 0, _T("should be at start of file") );
+
+        char *dst = buf.data();
+        for ( size_t nRemaining = bufSize; nRemaining > 0; )
+        {
+            size_t nToRead = BLOCK_SIZE;
+
+            // the file size could have changed, avoid overflowing the buffer
+            // even if it did
+            if ( nToRead > nRemaining )
+                nToRead = nRemaining;
+
+            ssize_t nRead = m_file.Read(dst, nToRead);
+
+            if ( nRead == wxInvalidOffset )
+            {
+                // read error (error message already given in wxFile::Read)
+                return false;
+            }
+
+            if ( nRead == 0 )
+            {
+                // this file can't be empty because we checked for this above
+                // so this must be the end of file
+                break;
+            }
+
+            dst += nRead;
+            nRemaining -= nRead;
+        }
+
+        wxASSERT_MSG( dst - buf.data() == (wxFileOffset)bufSize,
+                      _T("logic error") );
+    }
+    else // file is not seekable
+    {
+        char block[BLOCK_SIZE];
+        for ( ;; )
+        {
+            ssize_t nRead = m_file.Read(block, WXSIZEOF(block));
+
+            if ( nRead == wxInvalidOffset )
+            {
+                // read error (error message already given in wxFile::Read)
+                return false;
+            }
+
+            if ( nRead == 0 )
+            {
+                // if no bytes have been read, presumably this is a
+                // valid-but-empty file
+                if ( bufSize == 0 )
+                    return true;
+
+                // otherwise we've finished reading the file
+                break;
+            }
+
+            // extend the buffer for new data
+            if ( !buf.extend(bufSize + nRead) )
+                return false;
+
+            // and append it to the buffer
+            memcpy(buf.data() + bufSize, block, nRead);
+            bufSize += nRead;
+        }
     }
 
-    for ( n = 0; n < nRead; n++ ) {
-      ch = buf[n];
-      switch ( ch ) {
-        case '\n':
-          // Dos/Unix line termination
-                AddLine(str, chLast == '\r' ? wxTextFileType_Dos
-                                      : wxTextFileType_Unix);
-          str.Empty();
-          chLast = '\n';
-          break;
-
-        case '\r':
-          if ( chLast == '\r' ) {
-            // Mac empty line
-                    AddLine(wxEmptyString, wxTextFileType_Mac);
-          }
-          else
-            chLast = '\r';
-          break;
+    const wxString str(buf, conv, bufSize);
 
-        default:
-          if ( chLast == '\r' ) {
-            // Mac line termination
-                    AddLine(str, wxTextFileType_Mac);
-            chLast = ch;
-#if wxUSE_UNICODE
-            conv_mbBuf[0] = ch;
-            if (conv.MB2WC(conv_wcBuf, conv_mbBuf, 2) == (size_t)-1)
-                conv_wcBuf[0] = ch;
-            str = conv_wcBuf[0];
-#else
-            str = ch;
-#endif
-          }
-          else {
-            // add to the current line
+    // there's no risk of this happening in ANSI build
 #if wxUSE_UNICODE
-            conv_mbBuf[0] = ch;
-            if (conv.MB2WC(conv_wcBuf, conv_mbBuf, 2) == (size_t)-1)
-                conv_wcBuf[0] = ch;
-            str += conv_wcBuf[0];
-#else
-            str += ch;
-#endif
-          }
-      }
+    if ( bufSize > 4 && str.empty() )
+    {
+        wxLogError(_("Failed to convert file \"%s\" to Unicode."), GetName());
+        return false;
+    }
+#endif // wxUSE_UNICODE
+
+    // we don't need this memory any more
+    buf.reset();
+
+
+    // now break the buffer in lines
+
+    // last processed character, we need to know if it was a CR or not
+    wxChar chLast = '\0';
+
+    // the beginning of the current line, changes inside the loop
+    wxString::const_iterator lineStart = str.begin();
+    const wxString::const_iterator end = str.end();
+    for ( wxString::const_iterator p = lineStart; p != end; p++ )
+    {
+        const wxChar ch = *p;
+        switch ( ch )
+        {
+            case '\n':
+                // could be a DOS or Unix EOL
+                if ( chLast == '\r' )
+                {
+                    if ( p - 1 >= lineStart )
+                    {
+                        AddLine(wxString(lineStart, p - 1), wxTextFileType_Dos);
+                    }
+                    else
+                    {
+                        // there were two line endings, so add an empty line:
+                        AddLine(wxEmptyString, wxTextFileType_Dos);
+                    }
+                }
+                else // bare '\n', Unix style
+                {
+                    AddLine(wxString(lineStart, p), wxTextFileType_Unix);
+                }
+
+                lineStart = p + 1;
+                break;
+
+            case '\r':
+                if ( chLast == '\r' )
+                {
+                    // Mac empty line
+                    AddLine(wxEmptyString, wxTextFileType_Mac);
+                    lineStart = p + 1;
+                }
+                //else: we don't know what this is yet -- could be a Mac EOL or
+                //      start of DOS EOL so wait for next char
+                break;
+
+            default:
+                if ( chLast == '\r' )
+                {
+                    // Mac line termination
+                    if ( p - 1 >= lineStart )
+                    {
+                        AddLine(wxString(lineStart, p - 1), wxTextFileType_Mac);
+                    }
+                    else
+                    {
+                        // there were two line endings, so add an empty line:
+                        AddLine(wxEmptyString, wxTextFileType_Mac);
+                    }
+                    lineStart = p;
+                }
+        }
+
+        chLast = ch;
     }
-  } while ( nRead == WXSIZEOF(buf) );
 
-  // anything in the last line?
-  if ( !str.IsEmpty() ) {
-        AddLine(str, wxTextFileType_None);  // no line terminator
-  }
+    // anything in the last line?
+    if ( lineStart != end )
+    {
+        // add unterminated last line
+        AddLine(wxString(lineStart, end), wxTextFileType_None);
+    }
 
-  return TRUE;
+    return true;
 }
 
 
-bool wxTextFile::OnWrite(wxTextFileType typeNew, wxMBConv& conv)
+bool wxTextFile::OnWrite(wxTextFileType typeNew, const wxMBConv& conv)
 {
-    wxTempFile fileTmp(m_strBufferName);
+    wxFileName fn = m_strBufferName;
+
+    // We do NOT want wxPATH_NORM_CASE here, or the case will not
+    // be preserved.
+    if ( !fn.IsAbsolute() )
+        fn.Normalize(wxPATH_NORM_ENV_VARS | wxPATH_NORM_DOTS | wxPATH_NORM_TILDE |
+                     wxPATH_NORM_ABSOLUTE | wxPATH_NORM_LONG);
+
+    wxTempFile fileTmp(fn.GetFullPath());
 
     if ( !fileTmp.IsOpened() ) {
         wxLogError(_("can't write buffer '%s' to disk."), m_strBufferName.c_str());
-        return FALSE;
+        return false;
     }
 
     size_t nCount = GetLineCount();
@@ -191,4 +314,3 @@ bool wxTextFile::OnWrite(wxTextFileType typeNew, wxMBConv& conv)
 }
 
 #endif // wxUSE_TEXTFILE
-