include/wx/textfile.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        textfile.h
   3 // Purpose:     class wxTextFile to work with text files of _small_ size
   4 //              (file is fully loaded in memory) and which understands CR/LF
   5 //              differences between platforms.
   6 // Author:      Vadim Zeitlin
   7 // Modified by:
   8 // Created:     03.04.98
   9 // RCS-ID:      $Id$
  10 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
  11 // Licence:     wxWindows license
  12 ///////////////////////////////////////////////////////////////////////////////
  13
  14 #ifndef _WX_TEXTFILE_H
  15 #define _WX_TEXTFILE_H
  16
  17 #ifdef __GNUG__
  18     #pragma interface "textfile.h"
  19 #endif
  20
  21 #include "wx/defs.h"
  22
  23 #if !wxUSE_FILE
  24     #undef wxUSE_TEXTFILE
  25     #define wxUSE_TEXTFILE 0
  26 #endif // wxUSE_FILE
  27
  28 #if wxUSE_TEXTFILE
  29
  30 #include "wx/string.h"
  31 #include "wx/file.h"
  32 #include "wx/dynarray.h"
  33
  34 // ----------------------------------------------------------------------------
  35 // wxTextFile
  36 // ----------------------------------------------------------------------------
  37
  38 // the line termination type
  39 enum wxTextFileType
  40 {
  41     wxTextFileType_None,  // incomplete (the last line of the file only)
  42     wxTextFileType_Unix,  // line is terminated with 'LF' = 0xA = 10 = '\n'
  43     wxTextFileType_Dos,   //                         'CR' 'LF'
  44     wxTextFileType_Mac,   //                         'CR' = 0xD = 13 = '\r'
  45     wxTextFileType_Os2    //                         'CR' 'LF'
  46 };
  47
  48 WX_DEFINE_EXPORTED_ARRAY(wxTextFileType, ArrayFileType);
  49
  50 class WXDLLEXPORT wxTextFile
  51 {
  52 public:
  53   // constants and static functions
  54     // default type for current platform (determined at compile time)
  55   static const wxTextFileType typeDefault;
  56
  57     // this function returns a string which is identical to "text" passed in
  58     // except that the line terminator characters are changed to correspond the
  59     // given type. Called with the default argument, the function translates
  60     // the string to the native format (Unix for Unix, DOS for Windows, ...).
  61   static wxString Translate(const wxString& text,
  62                             wxTextFileType type = typeDefault);
  63
  64     // get the file termination string
  65   static const wxChar *GetEOL(wxTextFileType type = typeDefault);
  66
  67   // ctors
  68     // def ctor, use Open(string)
  69   wxTextFile() { }
  70     //
  71   wxTextFile(const wxString& strFile);
  72
  73   // file operations
  74     // file exists?
  75   bool Exists() const;
  76     // create the file if it doesn't already exist
  77   bool Create();
  78     // same as Create() but with (another) file name
  79   bool Create(const wxString& strFile);
  80     // Open() also loads file in memory on success
  81   bool Open();
  82     // same as Open() but with (another) file name
  83   bool Open(const wxString& strFile);
  84     // closes the file and frees memory, losing all changes
  85   bool Close();
  86     // is file currently opened?
  87   bool IsOpened() const { return m_isOpened; }
  88
  89   // accessors
  90     // get the number of lines in the file
  91   size_t GetLineCount() const { return m_aLines.Count(); }
  92     // the returned line may be modified (but don't add CR/LF at the end!)
  93   wxString& GetLine(size_t n)    const { return m_aLines[n]; }
  94   wxString& operator[](size_t n) const { return m_aLines[n]; }
  95
  96     // the current line has meaning only when you're using
  97     // GetFirstLine()/GetNextLine() functions, it doesn't get updated when
  98     // you're using "direct access" i.e. GetLine()
  99   size_t GetCurrentLine() const { return m_nCurLine; }
 100   void GoToLine(size_t n) { m_nCurLine = n; }
 101   bool Eof() const { return (m_aLines.Count() == 0 || m_nCurLine == m_aLines.Count() - 1); }
 102
 103     // these methods allow more "iterator-like" traversal of the list of
 104     // lines, i.e. you may write something like:
 105     //  for ( str = GetFirstLine(); !Eof(); str = GetNextLine() ) { ... }
 106
 107     // NB: const is commented out because not all compilers understand
 108     //     'mutable' keyword yet (m_nCurLine should be mutable)
 109   wxString& GetFirstLine() /* const */ { return m_aLines[m_nCurLine = 0]; }
 110   wxString& GetNextLine()  /* const */ { return m_aLines[++m_nCurLine];   }
 111   wxString& GetPrevLine()  /* const */
 112     { wxASSERT(m_nCurLine > 0); return m_aLines[--m_nCurLine];   }
 113   wxString& GetLastLine() /* const */
 114     { return m_aLines[m_nCurLine = m_aLines.Count() - 1]; }
 115
 116     // get the type of the line (see also GetEOL)
 117   wxTextFileType GetLineType(size_t n) const { return m_aTypes[n]; }
 118     // guess the type of file (m_file is supposed to be opened)
 119   wxTextFileType GuessType() const;
 120     // get the name of the file
 121   const wxChar *GetName() const { return m_strFile.c_str(); }
 122
 123   // add/remove lines
 124     // add a line to the end
 125   void AddLine(const wxString& str, wxTextFileType type = typeDefault)
 126     { m_aLines.Add(str); m_aTypes.Add(type); }
 127     // insert a line before the line number n
 128   void InsertLine(const wxString& str,
 129                   size_t n,
 130                   wxTextFileType type = typeDefault)
 131     { m_aLines.Insert(str, n); m_aTypes.Insert(type, n); }
 132     // delete one line
 133   void RemoveLine(size_t n) { m_aLines.Remove(n); m_aTypes.Remove(n); }
 134
 135   // change the file on disk (default argument means "don't change type")
 136   // possibly in another format
 137   bool Write(wxTextFileType typeNew = wxTextFileType_None);
 138
 139   // dtor
 140   ~wxTextFile();
 141
 142 private:
 143   // copy ctor/assignment operator not implemented
 144   wxTextFile(const wxTextFile&);
 145   wxTextFile& operator=(const wxTextFile&);
 146
 147   // read the file in memory (m_file is supposed to be just opened)
 148   bool Read();
 149
 150   wxFile        m_file;     // current file
 151
 152   ArrayFileType m_aTypes;   // type of each line
 153   wxArrayString m_aLines;   // lines of file
 154
 155   size_t        m_nCurLine; // number of current line in the file
 156
 157   bool          m_isOpened; // was the file successfully opened the last time?
 158
 159   wxString      m_strFile;  // name of the file
 160 };
 161
 162 #else // !wxUSE_TEXTFILE
 163
 164 // these static wxTextFile methods are used internally by wxWindows, so should
 165 // be defined even if we're compiling without wxTextFile at all.
 166
 167 class WXDLLEXPORT wxTextFile
 168 {
 169 public:
 170     // default type for current platform (determined at compile time)
 171     static const wxTextFileType typeDefault;
 172
 173     // this function returns a string which is identical to "text" passed in
 174     // except that the line terminator characters are changed to correspond the
 175     // given type. Called with the default argument, the function translates
 176     // the string to the native format (Unix for Unix, DOS for Windows, ...).
 177     static wxString Translate(const wxString& text,
 178                               wxTextFileType type = typeDefault);
 179
 180     // get the file termination string
 181     static const wxChar *GetEOL(wxTextFileType type = typeDefault);
 182
 183 private:
 184     // copy ctor/assignment operator not implemented
 185     wxTextFile(const wxTextFile&);
 186     wxTextFile& operator=(const wxTextFile&);
 187 };
 188
 189 #endif // wxUSE_TEXTFILE
 190
 191 #endif // _WX_TEXTFILE_H
 192