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 _TEXTFILE_H
  15 #define _TEXTFILE_H
  16
  17 #ifdef __GNUG__
  18 #pragma interface "textfile.h"
  19 #endif
  20
  21 #include "wx/defs.h"
  22
  23 #if wxUSE_TEXTFILE && wxUSE_FILE
  24
  25 #include "wx/string.h"
  26 #include "wx/file.h"
  27 #include "wx/dynarray.h"
  28
  29 // ----------------------------------------------------------------------------
  30 // wxTextFile
  31 // ----------------------------------------------------------------------------
  32
  33 // the line termination type
  34 enum wxTextFileType
  35 {
  36     wxTextFileType_None,  // incomplete (the last line of the file only)
  37     wxTextFileType_Unix,  // line is terminated with 'LF' = 0xA = 10 = '\n'
  38     wxTextFileType_Dos,   //                         'CR' 'LF'
  39     wxTextFileType_Mac    //                         'CR' = 0xD = 13 = '\r'
  40 };
  41
  42 WX_DEFINE_ARRAY(wxTextFileType, ArrayFileType);
  43
  44 class WXDLLEXPORT wxTextFile
  45 {
  46 public:
  47   // default type for current platform (determined at compile time)
  48   static const wxTextFileType typeDefault;
  49
  50   // ctors
  51     // def ctor, use Open(string)
  52   wxTextFile() { }
  53     //
  54   wxTextFile(const wxString& strFile);
  55
  56   // file operations
  57     // file exists?
  58   bool Exists() const;
  59     // Open() also loads file in memory on success
  60   bool Open();
  61     // same as Open() but with (another) file name
  62   bool Open(const wxString& strFile);
  63     // closes the file and frees memory, losing all changes
  64   bool Close();
  65     // is file currently opened?
  66   bool IsOpened() const { return m_isOpened; }
  67
  68   // accessors
  69     // get the number of lines in the file
  70   size_t GetLineCount() const { return m_aLines.Count(); }
  71     // the returned line may be modified (but don't add CR/LF at the end!)
  72   wxString& GetLine(size_t n)    const { return m_aLines[n]; }
  73   wxString& operator[](size_t n) const { return m_aLines[n]; }
  74
  75     // the current line has meaning only when you're using
  76     // GetFirstLine()/GetNextLine() functions, it doesn't get updated when
  77     // you're using "direct access" i.e. GetLine()
  78   size_t GetCurrentLine() const { return m_nCurLine; }
  79   void GoToLine(size_t n) { m_nCurLine = n; }
  80   bool Eof() const { return m_nCurLine == m_aLines.Count() - 1; }
  81
  82     // these methods allow more "iterator-like" traversal of the list of
  83     // lines, i.e. you may write something like:
  84     //  for ( str = GetFirstLine(); !Eof(); str = GetNextLine() ) { ... }
  85
  86     // NB: const is commented out because not all compilers understand
  87     //     'mutable' keyword yet (m_nCurLine should be mutable)
  88   wxString& GetFirstLine() /* const */ { return m_aLines[m_nCurLine = 0]; }
  89   wxString& GetNextLine()  /* const */ { return m_aLines[++m_nCurLine];   }
  90   wxString& GetPrevLine()  /* const */
  91     { wxASSERT(m_nCurLine > 0); return m_aLines[--m_nCurLine];   }
  92   wxString& GetLastLine() /* const */
  93     { return m_aLines[m_nCurLine = m_aLines.Count() - 1]; }
  94
  95     // get the type of the line (see also GetEOL)
  96   wxTextFileType GetLineType(size_t n) const { return m_aTypes[n]; }
  97     // guess the type of file (m_file is supposed to be opened)
  98   wxTextFileType GuessType() const;
  99     // get the name of the file
 100   const wxChar *GetName() const { return m_strFile.c_str(); }
 101
 102   // add/remove lines
 103     // add a line to the end
 104   void AddLine(const wxString& str, wxTextFileType type = typeDefault)
 105     { m_aLines.Add(str); m_aTypes.Add(type); }
 106     // insert a line before the line number n
 107   void InsertLine(const wxString& str,
 108                   size_t n,
 109                   wxTextFileType type = typeDefault)
 110     { m_aLines.Insert(str, n); m_aTypes.Insert(type, n); }
 111     // delete one line
 112   void RemoveLine(size_t n) { m_aLines.Remove(n); m_aTypes.Remove(n); }
 113
 114   // change the file on disk (default argument means "don't change type")
 115   // possibly in another format
 116   bool Write(wxTextFileType typeNew = wxTextFileType_None);
 117
 118   // get the file termination string
 119   // Note: implementation moved to textfile to prevent warning due to switch.
 120   static const wxChar *GetEOL(wxTextFileType type = typeDefault);
 121
 122   // dtor
 123   ~wxTextFile();
 124
 125 private:
 126   // copy ctor/assignment operator not implemented
 127   wxTextFile(const wxTextFile&);
 128   wxTextFile& operator=(const wxTextFile&);
 129
 130   // read the file in memory (m_file is supposed to be just opened)
 131   bool Read();
 132
 133   wxFile        m_file;     // current file
 134
 135   ArrayFileType m_aTypes;   // type of each line
 136   wxArrayString m_aLines;   // lines of file
 137
 138   size_t        m_nCurLine; // number of current line in the file
 139
 140   bool          m_isOpened; // was the file successfully opened the last time?
 141
 142   wxString      m_strFile;  // name of the file
 143 };
 144
 145 #endif
 146   // wxUSE_TEXTFILE && wxUSE_FILE
 147
 148 #endif
 149   // _TEXTFILE_H
 150