include/wx/textbuf.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/textbuf.h
   3 // Purpose:     class wxTextBuffer to work with text buffers of _small_ size
   4 //              (buffer is fully loaded in memory) and which understands CR/LF
   5 //              differences between platforms.
   6 // Created:     14.11.01
   7 // Author:      Morten Hanssen, Vadim Zeitlin
   8 // Copyright:   (c) 1998-2001 Morten Hanssen, Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_TEXTBUFFER_H
  13 #define _WX_TEXTBUFFER_H
  14
  15 #include "wx/defs.h"
  16 #include "wx/arrstr.h"
  17
  18 // ----------------------------------------------------------------------------
  19 // constants
  20 // ----------------------------------------------------------------------------
  21
  22 // the line termination type (kept wxTextFileType name for compability)
  23 enum wxTextFileType
  24 {
  25     wxTextFileType_None,  // incomplete (the last line of the file only)
  26     wxTextFileType_Unix,  // line is terminated with 'LF' = 0xA = 10 = '\n'
  27     wxTextFileType_Dos,   //                         'CR' 'LF'
  28     wxTextFileType_Mac,   //                         'CR' = 0xD = 13 = '\r'
  29     wxTextFileType_Os2    //                         'CR' 'LF'
  30 };
  31
  32 #include "wx/string.h"
  33
  34 #if wxUSE_TEXTBUFFER
  35
  36 #include "wx/dynarray.h"
  37
  38 // ----------------------------------------------------------------------------
  39 // wxTextBuffer
  40 // ----------------------------------------------------------------------------
  41
  42 WX_DEFINE_USER_EXPORTED_ARRAY_INT(wxTextFileType,
  43                                   wxArrayLinesType,
  44                                   class WXDLLIMPEXP_BASE);
  45
  46 #endif // wxUSE_TEXTBUFFER
  47
  48 class WXDLLIMPEXP_BASE wxTextBuffer
  49 {
  50 public:
  51     // constants and static functions
  52     // default type for current platform (determined at compile time)
  53     static const wxTextFileType typeDefault;
  54
  55     // this function returns a string which is identical to "text" passed in
  56     // except that the line terminator characters are changed to correspond the
  57     // given type. Called with the default argument, the function translates
  58     // the string to the native format (Unix for Unix, DOS for Windows, ...).
  59     static wxString Translate(const wxString& text,
  60                             wxTextFileType type = typeDefault);
  61
  62     // get the buffer termination string
  63     static const wxChar *GetEOL(wxTextFileType type = typeDefault);
  64
  65     // the static methods of this class are compiled in even when
  66     // !wxUSE_TEXTBUFFER because they are used by the library itself, but the
  67     // rest can be left out
  68 #if wxUSE_TEXTBUFFER
  69
  70     // buffer operations
  71     // -----------------
  72
  73     // buffer exists?
  74     bool Exists() const;
  75
  76     // create the buffer if it doesn't already exist
  77     bool Create();
  78
  79     // same as Create() but with (another) buffer name
  80     bool Create(const wxString& strBufferName);
  81
  82     // Open() also loads buffer in memory on success
  83     bool Open(wxMBConv& conv = wxConvUTF8);
  84
  85     // same as Open() but with (another) buffer name
  86     bool Open(const wxString& strBufferName, wxMBConv& conv = wxConvUTF8);
  87
  88     // closes the buffer and frees memory, losing all changes
  89     bool Close();
  90
  91     // is buffer currently opened?
  92     bool IsOpened() const { return m_isOpened; }
  93
  94     // accessors
  95     // ---------
  96
  97     // get the number of lines in the buffer
  98     size_t GetLineCount() const { return m_aLines.size(); }
  99
 100     // the returned line may be modified (but don't add CR/LF at the end!)
 101     wxString& GetLine(size_t n)    const { return (wxString&)m_aLines[n]; }
 102     wxString& operator[](size_t n) const { return (wxString&)m_aLines[n]; }
 103
 104     // the current line has meaning only when you're using
 105     // GetFirstLine()/GetNextLine() functions, it doesn't get updated when
 106     // you're using "direct access" i.e. GetLine()
 107     size_t GetCurrentLine() const { return m_nCurLine; }
 108     void GoToLine(size_t n) { m_nCurLine = n; }
 109     bool Eof() const { return m_nCurLine == m_aLines.size(); }
 110
 111     // these methods allow more "iterator-like" traversal of the list of
 112     // lines, i.e. you may write something like:
 113     //  for ( str = GetFirstLine(); !Eof(); str = GetNextLine() ) { ... }
 114
 115     // NB: const is commented out because not all compilers understand
 116     //     'mutable' keyword yet (m_nCurLine should be mutable)
 117     wxString& GetFirstLine() /* const */
 118         { return m_aLines.empty() ? ms_eof : m_aLines[m_nCurLine = 0]; }
 119     wxString& GetNextLine()  /* const */
 120         { return ++m_nCurLine == m_aLines.size() ? ms_eof
 121                                                  : m_aLines[m_nCurLine]; }
 122     wxString& GetPrevLine()  /* const */
 123         { wxASSERT(m_nCurLine > 0); return m_aLines[--m_nCurLine]; }
 124     wxString& GetLastLine() /* const */
 125         { m_nCurLine = m_aLines.size() - 1; return m_aLines.Last(); }
 126
 127     // get the type of the line (see also GetEOL)
 128     wxTextFileType GetLineType(size_t n) const { return m_aTypes[n]; }
 129
 130     // guess the type of buffer
 131     wxTextFileType GuessType() const;
 132
 133     // get the name of the buffer
 134     const wxChar *GetName() const { return m_strBufferName.c_str(); }
 135
 136     // add/remove lines
 137     // ----------------
 138
 139     // add a line to the end
 140     void AddLine(const wxString& str, wxTextFileType type = typeDefault)
 141         { m_aLines.push_back(str); m_aTypes.push_back(type); }
 142     // insert a line before the line number n
 143     void InsertLine(const wxString& str,
 144                   size_t n,
 145                   wxTextFileType type = typeDefault)
 146     {
 147         m_aLines.insert(m_aLines.begin() + n, str);
 148         m_aTypes.insert(m_aTypes.begin()+n, type);
 149     }
 150
 151     // delete one line
 152     void RemoveLine(size_t n)
 153     {
 154         m_aLines.erase(m_aLines.begin() + n);
 155         m_aTypes.erase(m_aTypes.begin() + n);
 156     }
 157
 158     // remove all lines
 159     void Clear() { m_aLines.clear(); m_aTypes.clear(); m_nCurLine = 0; }
 160
 161     // change the buffer (default argument means "don't change type")
 162     // possibly in another format
 163     bool Write(wxTextFileType typeNew = wxTextFileType_None,
 164                wxMBConv& conv = wxConvUTF8);
 165
 166     // dtor
 167     virtual ~wxTextBuffer();
 168
 169 protected:
 170     // ctors
 171     // -----
 172
 173     // default ctor, use Open(string)
 174     wxTextBuffer() { m_isOpened = false; }
 175
 176     // ctor from filename
 177     wxTextBuffer(const wxString& strBufferName);
 178
 179     enum wxTextBufferOpenMode { ReadAccess, WriteAccess };
 180
 181     // Must implement these in derived classes.
 182     virtual bool OnExists() const = 0;
 183     virtual bool OnOpen(const wxString &strBufferName,
 184                         wxTextBufferOpenMode openmode) = 0;
 185     virtual bool OnClose() = 0;
 186     virtual bool OnRead(wxMBConv& conv) = 0;
 187     virtual bool OnWrite(wxTextFileType typeNew, wxMBConv& conv) = 0;
 188
 189     static wxString ms_eof;     // dummy string returned at EOF
 190     wxString m_strBufferName;   // name of the buffer
 191
 192 private:
 193     wxArrayLinesType m_aTypes;   // type of each line
 194     wxArrayString    m_aLines;   // lines of file
 195
 196     size_t        m_nCurLine; // number of current line in the buffer
 197
 198     bool          m_isOpened; // was the buffer successfully opened the last time?
 199 #endif // wxUSE_TEXTBUFFER
 200
 201     // copy ctor/assignment operator not implemented
 202     wxTextBuffer(const wxTextBuffer&);
 203     wxTextBuffer& operator=(const wxTextBuffer&);
 204 };
 205
 206 #endif // _WX_TEXTBUFFER_H
 207