src/common/textfile.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        textfile.cpp
   3 // Purpose:     implementation of wxTextFile class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     03.04.98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // headers
  14 // ============================================================================
  15
  16 #ifdef __GNUG__
  17     #pragma implementation "textfile.h"
  18 #endif
  19
  20 #include  "wx/wxprec.h"
  21
  22 #ifdef    __BORLANDC__
  23     #pragma hdrstop
  24 #endif  //__BORLANDC__
  25
  26 #if !wxUSE_FILE
  27     #undef wxUSE_TEXTFILE
  28     #define wxUSE_TEXTFILE 0
  29 #endif // wxUSE_FILE
  30
  31 #ifndef WX_PRECOMP
  32     #include  "wx/string.h"
  33     #include  "wx/intl.h"
  34     #include  "wx/file.h"
  35     #include  "wx/log.h"
  36 #endif
  37
  38 #include  "wx/textfile.h"
  39
  40 // ============================================================================
  41 // wxTextFile class implementation
  42 // ============================================================================
  43
  44 // ----------------------------------------------------------------------------
  45 // static methods (always compiled in)
  46 // ----------------------------------------------------------------------------
  47
  48 // default type is the native one
  49 const wxTextFileType wxTextFile::typeDefault =
  50 #if   defined(__WINDOWS__)
  51   wxTextFileType_Dos;
  52 #elif defined(__UNIX__)
  53   wxTextFileType_Unix;
  54 #elif defined(__WXMAC__)
  55   wxTextFileType_Mac;
  56 #elif defined(__WXPM__)
  57   wxTextFileType_Os2;
  58 #else
  59   wxTextFileType_None;
  60   #error  "wxTextFile: unsupported platform."
  61 #endif
  62
  63 const wxChar *wxTextFile::GetEOL(wxTextFileType type)
  64 {
  65     switch ( type ) {
  66       default:
  67         wxFAIL_MSG(wxT("bad file type in wxTextFile::GetEOL."));
  68         // fall through nevertheless - we must return something...
  69
  70       case wxTextFileType_None: return wxT("");
  71       case wxTextFileType_Unix: return wxT("\n");
  72       case wxTextFileType_Dos:  return wxT("\r\n");
  73       case wxTextFileType_Mac:  return wxT("\r");
  74     }
  75 }
  76
  77
  78 wxString wxTextFile::Translate(const wxString& text, wxTextFileType type)
  79 {
  80     // don't do anything if there is nothing to do
  81     if ( type == wxTextFileType_None )
  82         return text;
  83
  84     wxString eol = GetEOL(type), result;
  85
  86     // optimization: we know that the length of the new string will be about
  87     // the same as the length of the old one, so prealloc memory to aviod
  88     // unnecessary relocations
  89     result.Alloc(text.Len());
  90
  91     wxChar chLast = 0;
  92     for ( const wxChar *pc = text.c_str(); *pc; pc++ )
  93     {
  94         wxChar ch = *pc;
  95         switch ( ch ) {
  96             case '\n':
  97                 // Dos/Unix line termination
  98                 result += eol;
  99                 chLast = '\n';
 100                 break;
 101
 102             case '\r':
 103                 if ( chLast == '\r' ) {
 104                     // Mac empty line
 105                     result += eol;
 106                 }
 107                 else
 108                     chLast = '\r';
 109                 break;
 110
 111             default:
 112                 if ( chLast == '\r' ) {
 113                     // Mac line termination
 114                     result += eol;
 115                     chLast = ch;
 116                 }
 117                 else {
 118                     // add to the current line
 119                     result += ch;
 120                 }
 121         }
 122     }
 123
 124     return result;
 125 }
 126
 127 #if wxUSE_TEXTFILE
 128
 129 // ----------------------------------------------------------------------------
 130 // ctors & dtor
 131 // ----------------------------------------------------------------------------
 132
 133 wxTextFile::wxTextFile(const wxString& strFile) : m_strFile(strFile)
 134 {
 135   m_nCurLine = 0;
 136   m_isOpened = FALSE;
 137 }
 138
 139 wxTextFile::~wxTextFile()
 140 {
 141   // m_file dtor called automatically
 142 }
 143
 144 // ----------------------------------------------------------------------------
 145 // file operations
 146 // ----------------------------------------------------------------------------
 147
 148 bool wxTextFile::Exists() const
 149 {
 150     return wxFile::Exists(m_strFile);
 151 }
 152
 153 bool wxTextFile::Open(const wxString& strFile)
 154 {
 155   m_strFile = strFile;
 156
 157   return Open();
 158 }
 159
 160 bool wxTextFile::Open()
 161 {
 162   // file name must be either given in ctor or in Open(const wxString&)
 163   wxASSERT( !m_strFile.IsEmpty() );
 164
 165   // open file in read-only mode
 166   if ( !m_file.Open(m_strFile) )
 167     return FALSE;
 168
 169   // read file into memory
 170   m_isOpened = Read();
 171
 172   m_file.Close();
 173
 174   return m_isOpened;
 175 }
 176
 177 // analyse some lines of the file trying to guess it's type.
 178 // if it fails, it assumes the native type for our platform.
 179 wxTextFileType wxTextFile::GuessType() const
 180 {
 181   // file should be opened and we must be in it's beginning
 182   wxASSERT( m_file.IsOpened() && m_file.Tell() == 0 );
 183
 184   // scan the file lines
 185   size_t nUnix = 0,     // number of '\n's alone
 186        nDos  = 0,     // number of '\r\n'
 187        nMac  = 0;     // number of '\r's
 188
 189   // we take MAX_LINES_SCAN in the beginning, middle and the end of file
 190   #define MAX_LINES_SCAN    (10)
 191   size_t nCount = m_aLines.Count() / 3,
 192        nScan =  nCount > 3*MAX_LINES_SCAN ? MAX_LINES_SCAN : nCount / 3;
 193
 194   #define   AnalyseLine(n)              \
 195     switch ( m_aTypes[n] ) {            \
 196       case wxTextFileType_Unix: nUnix++; break;   \
 197       case wxTextFileType_Dos:  nDos++;  break;   \
 198       case wxTextFileType_Mac:  nMac++;  break;   \
 199       default: wxFAIL_MSG(_("unknown line terminator")); \
 200     }
 201
 202   size_t n;
 203   for ( n = 0; n < nScan; n++ )     // the beginning
 204     AnalyseLine(n);
 205   for ( n = (nCount - nScan)/2; n < (nCount + nScan)/2; n++ )
 206     AnalyseLine(n);
 207   for ( n = nCount - nScan; n < nCount; n++ )
 208     AnalyseLine(n);
 209
 210   #undef   AnalyseLine
 211
 212   // interpret the results (FIXME far from being even 50% fool proof)
 213   if ( nDos + nUnix + nMac == 0 ) {
 214     // no newlines at all
 215     wxLogWarning(_("'%s' is probably a binary file."), m_strFile.c_str());
 216   }
 217   else {
 218     #define   GREATER_OF(t1, t2) n##t1 == n##t2 ? typeDefault               \
 219                                                 : n##t1 > n##t2             \
 220                                                     ? wxTextFileType_##t1   \
 221                                                     : wxTextFileType_##t2
 222
 223     // Watcom C++ doesn't seem to be able to handle the macro
 224 #if !defined(__WATCOMC__)
 225     if ( nDos > nUnix )
 226       return GREATER_OF(Dos, Mac);
 227     else if ( nDos < nUnix )
 228       return GREATER_OF(Unix, Mac);
 229     else {
 230       // nDos == nUnix
 231       return nMac > nDos ? wxTextFileType_Mac : typeDefault;
 232     }
 233 #endif // __WATCOMC__
 234
 235     #undef    GREATER_OF
 236   }
 237
 238   return typeDefault;
 239 }
 240
 241 bool wxTextFile::Read()
 242 {
 243   // file should be opened and we must be in it's beginning
 244   wxASSERT( m_file.IsOpened() && m_file.Tell() == 0 );
 245
 246   wxString str;
 247   char ch, chLast = '\0';
 248   char buf[1024];
 249   int n, nRead;
 250   while ( !m_file.Eof() ) {
 251     nRead = m_file.Read(buf, WXSIZEOF(buf));
 252     if ( nRead == wxInvalidOffset ) {
 253       // read error (error message already given in wxFile::Read)
 254       return FALSE;
 255     }
 256
 257     for ( n = 0; n < nRead; n++ ) {
 258       ch = buf[n];
 259       switch ( ch ) {
 260         case '\n':
 261           // Dos/Unix line termination
 262           m_aLines.Add(str);
 263           m_aTypes.Add(chLast == '\r' ? wxTextFileType_Dos
 264                                       : wxTextFileType_Unix);
 265           str.Empty();
 266           chLast = '\n';
 267           break;
 268
 269         case '\r':
 270           if ( chLast == '\r' ) {
 271             // Mac empty line
 272             m_aLines.Add("");
 273             m_aTypes.Add(wxTextFileType_Mac);
 274           }
 275           else
 276             chLast = '\r';
 277           break;
 278
 279         default:
 280           if ( chLast == '\r' ) {
 281             // Mac line termination
 282             m_aLines.Add(str);
 283             m_aTypes.Add(wxTextFileType_Mac);
 284             chLast = ch;
 285             str = ch;
 286           }
 287           else {
 288             // add to the current line
 289             str += ch;
 290           }
 291       }
 292     }
 293   }
 294
 295   // anything in the last line?
 296   if ( !str.IsEmpty() ) {
 297     m_aTypes.Add(wxTextFileType_None);  // no line terminator
 298     m_aLines.Add(str);
 299   }
 300
 301   return TRUE;
 302 }
 303
 304 bool wxTextFile::Close()
 305 {
 306     m_aTypes.Clear();
 307     m_aLines.Clear();
 308     m_nCurLine = 0;
 309     m_isOpened = FALSE;
 310
 311     return TRUE;
 312 }
 313
 314 bool wxTextFile::Write(wxTextFileType typeNew)
 315 {
 316   wxTempFile fileTmp(m_strFile);
 317
 318   if ( !fileTmp.IsOpened() ) {
 319     wxLogError(_("can't write file '%s' to disk."), m_strFile.c_str());
 320     return FALSE;
 321   }
 322
 323   size_t nCount = m_aLines.Count();
 324   for ( size_t n = 0; n < nCount; n++ ) {
 325     fileTmp.Write(m_aLines[n] +
 326                   GetEOL(typeNew == wxTextFileType_None ? m_aTypes[n]
 327                                                         : typeNew));
 328   }
 329
 330   // replace the old file with this one
 331   return fileTmp.Commit();
 332 }
 333
 334 #endif // wxUSE_TEXTFILE
 335