Lots of OS/2 Updates mirroring msw updates

[wxWidgets.git] / include / wx / textfile.h

diff --git a/include/wx/textfile.h b/include/wx/textfile.h
index 9999ffdd468438b573f3c344644fa3ce50f765cf..c6e33dcca36d8019f0644b0591d9ddf5e0b66735 100644 (file)
--- a/include/wx/textfile.h
+++ b/include/wx/textfile.h
@@ -4,21 +4,45 @@
 //              (file is fully loaded in memory) and which understands CR/LF
 //              differences between platforms.
 // Author:      Vadim Zeitlin
 //              (file is fully loaded in memory) and which understands CR/LF
 //              differences between platforms.
 // Author:      Vadim Zeitlin

-// Modified by: 
+// Modified by:

 // Created:     03.04.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 
 // Created:     03.04.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 

-#ifndef   _TEXTFILE_H
-#define   _TEXTFILE_H
+#ifndef _WX_TEXTFILE_H
+#define _WX_TEXTFILE_H

 
 #ifdef __GNUG__
 
 #ifdef __GNUG__

-#pragma interface "textfile.h"
+    #pragma interface "textfile.h"

 #endif
 
 #include "wx/defs.h"
 #endif
 
 #include "wx/defs.h"

+
+#if !wxUSE_FILE
+    #undef wxUSE_TEXTFILE
+    #define wxUSE_TEXTFILE 0
+#endif // wxUSE_FILE
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+// NB: this is always defined, even if !wxUSE_TEXTFILE
+
+// the line termination type
+enum wxTextFileType
+{
+    wxTextFileType_None,  // incomplete (the last line of the file only)
+    wxTextFileType_Unix,  // line is terminated with 'LF' = 0xA = 10 = '\n'
+    wxTextFileType_Dos,   //                         'CR' 'LF'
+    wxTextFileType_Mac,   //                         'CR' = 0xD = 13 = '\r'
+    wxTextFileType_Os2    //                         'CR' 'LF'
+};
+
+#if wxUSE_TEXTFILE
+

 #include "wx/string.h"
 #include "wx/file.h"
 #include "wx/dynarray.h"
 #include "wx/string.h"
 #include "wx/file.h"
 #include "wx/dynarray.h"


@@ -26,30 +50,39 @@
 // ----------------------------------------------------------------------------
 // wxTextFile
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxTextFile
 // ----------------------------------------------------------------------------

-class wxTextFile
+
+WX_DEFINE_EXPORTED_ARRAY(wxTextFileType, ArrayFileType);
+
+class WXDLLEXPORT wxTextFile

 {
 public:
 {
 public:

-  // constants
-  enum Type
-  {
-    Type_None,  // incomplete (the last line of the file only)
-    Type_Unix,  // line is terminated with 'CR' = 0xA = 10 = '\n'
-    Type_Dos,   //                         'LF' 'CR'
-    Type_Mac    //                         'LF' = 0xD = 12 = '\r'
-  };
-
-  // default type for current platform (determined at compile time)
-  static const Type typeDefault;
+  // constants and static functions
+    // default type for current platform (determined at compile time)
+  static const wxTextFileType typeDefault;
+
+    // this function returns a string which is identical to "text" passed in
+    // except that the line terminator characters are changed to correspond the
+    // given type. Called with the default argument, the function translates
+    // the string to the native format (Unix for Unix, DOS for Windows, ...).
+  static wxString Translate(const wxString& text,
+                            wxTextFileType type = typeDefault);
+
+    // get the file termination string
+  static const wxChar *GetEOL(wxTextFileType type = typeDefault);

 
   // ctors
     // def ctor, use Open(string)
   wxTextFile() { }
 
   // ctors
     // def ctor, use Open(string)
   wxTextFile() { }

-    // 
+    //

   wxTextFile(const wxString& strFile);
 
   // file operations
     // file exists?
   bool Exists() const;
   wxTextFile(const wxString& strFile);
 
   // file operations
     // file exists?
   bool Exists() const;

+    // create the file if it doesn't already exist
+  bool Create();
+    // same as Create() but with (another) file name
+  bool Create(const wxString& strFile);

     // Open() also loads file in memory on success
   bool Open();
     // same as Open() but with (another) file name
     // Open() also loads file in memory on success
   bool Open();
     // same as Open() but with (another) file name


@@ -57,49 +90,57 @@ public:
     // closes the file and frees memory, losing all changes
   bool Close();
     // is file currently opened?
     // closes the file and frees memory, losing all changes
   bool Close();
     // is file currently opened?

-  bool IsOpened() const { return m_file.IsOpened(); }
+  bool IsOpened() const { return m_isOpened; }

 
   // accessors
     // get the number of lines in the file
 
   // accessors
     // get the number of lines in the file

-  size_t    GetLineCount() const { return m_aLines.Count(); }
+  size_t GetLineCount() const { return m_aLines.Count(); }

     // the returned line may be modified (but don't add CR/LF at the end!)
     // the returned line may be modified (but don't add CR/LF at the end!)

-  wxString& GetLine(uint n)    const { return m_aLines[n]; }
-  wxString& operator[](uint n) const { return m_aLines[n]; }
+  wxString& GetLine(size_t n)    const { return m_aLines[n]; }
+  wxString& operator[](size_t n) const { return m_aLines[n]; }
+
+    // the current line has meaning only when you're using
+    // GetFirstLine()/GetNextLine() functions, it doesn't get updated when
+    // you're using "direct access" i.e. GetLine()
+  size_t GetCurrentLine() const { return m_nCurLine; }
+  void GoToLine(size_t n) { m_nCurLine = n; }
+  bool Eof() const { return (m_aLines.Count() == 0 || m_nCurLine == m_aLines.Count() - 1); }
+
+    // these methods allow more "iterator-like" traversal of the list of
+    // lines, i.e. you may write something like:
+    //  for ( str = GetFirstLine(); !Eof(); str = GetNextLine() ) { ... }
+
+    // NB: const is commented out because not all compilers understand
+    //     'mutable' keyword yet (m_nCurLine should be mutable)
+  wxString& GetFirstLine() /* const */ { return m_aLines[m_nCurLine = 0]; }
+  wxString& GetNextLine()  /* const */ { return m_aLines[++m_nCurLine];   }
+  wxString& GetPrevLine()  /* const */
+    { wxASSERT(m_nCurLine > 0); return m_aLines[--m_nCurLine];   }
+  wxString& GetLastLine() /* const */
+    { return m_aLines[m_nCurLine = m_aLines.Count() - 1]; }
+

     // get the type of the line (see also GetEOL)
     // get the type of the line (see also GetEOL)

-  Type GetLineType(uint n) const { return m_aTypes[n]; }
+  wxTextFileType GetLineType(size_t n) const { return m_aTypes[n]; }

     // guess the type of file (m_file is supposed to be opened)
     // guess the type of file (m_file is supposed to be opened)

-  Type GuessType() const;
+  wxTextFileType GuessType() const;

     // get the name of the file
     // get the name of the file

-  const char *GetName() const { return m_strFile.c_str(); }
+  const wxChar *GetName() const { return m_strFile.c_str(); }

 
   // add/remove lines
     // add a line to the end
 
   // add/remove lines
     // add a line to the end

-  void AddLine(const wxString& str, Type type = typeDefault) 
+  void AddLine(const wxString& str, wxTextFileType type = typeDefault)

     { m_aLines.Add(str); m_aTypes.Add(type); }
     // insert a line before the line number n
     { m_aLines.Add(str); m_aTypes.Add(type); }
     // insert a line before the line number n

-  void InsertLine(const wxString& str, uint n, Type type = typeDefault) 
+  void InsertLine(const wxString& str,
+                  size_t n,
+                  wxTextFileType type = typeDefault)

     { m_aLines.Insert(str, n); m_aTypes.Insert(type, n); }
     // delete one line
     { m_aLines.Insert(str, n); m_aTypes.Insert(type, n); }
     // delete one line

-  void RemoveLine(uint n) { m_aLines.Remove(n); m_aTypes.Remove(n); }
+  void RemoveLine(size_t n) { m_aLines.Remove(n); m_aTypes.Remove(n); }

 
   // change the file on disk (default argument means "don't change type")
   // possibly in another format
 
   // change the file on disk (default argument means "don't change type")
   // possibly in another format

-  bool Write(Type typeNew = Type_None);
-
-  // get the file termination string
-  inline static const char *GetEOL(Type type = typeDefault)
-  {
-    switch ( type ) {
-      case Type_None: return "";
-      case Type_Unix: return "\n";
-      case Type_Dos:  return "\r\n";
-      case Type_Mac:  return "\r";
-
-      default:
-        wxFAIL_MSG("bad file type in wxTextFile::GetEOL.");
-        return NULL;
-    }
-  }
+  bool Write(wxTextFileType typeNew = wxTextFileType_None);

 
   // dtor
   ~wxTextFile();
 
   // dtor
   ~wxTextFile();


@@ -112,12 +153,46 @@ private:
   // read the file in memory (m_file is supposed to be just opened)
   bool Read();
 
   // read the file in memory (m_file is supposed to be just opened)
   bool Read();
 

-  WX_DEFINE_ARRAY(Type, ArrayFileType);
-

   wxFile        m_file;     // current file
   wxFile        m_file;     // current file

+

   ArrayFileType m_aTypes;   // type of each line
   wxArrayString m_aLines;   // lines of file
   ArrayFileType m_aTypes;   // type of each line
   wxArrayString m_aLines;   // lines of file

+
+  size_t        m_nCurLine; // number of current line in the file
+
+  bool          m_isOpened; // was the file successfully opened the last time?
+

   wxString      m_strFile;  // name of the file
 };
 
   wxString      m_strFile;  // name of the file
 };
 

-#endif  //_TEXTFILE_H
+#else // !wxUSE_TEXTFILE
+
+// these static wxTextFile methods are used internally by wxWindows, so should
+// be defined even if we're compiling without wxTextFile at all.
+
+class WXDLLEXPORT wxTextFile
+{
+public:
+    // default type for current platform (determined at compile time)
+    static const wxTextFileType typeDefault;
+
+    // this function returns a string which is identical to "text" passed in
+    // except that the line terminator characters are changed to correspond the
+    // given type. Called with the default argument, the function translates
+    // the string to the native format (Unix for Unix, DOS for Windows, ...).
+    static wxString Translate(const wxString& text,
+                              wxTextFileType type = typeDefault);
+
+    // get the file termination string
+    static const wxChar *GetEOL(wxTextFileType type = typeDefault);
+
+private:
+    // copy ctor/assignment operator not implemented
+    wxTextFile(const wxTextFile&);
+    wxTextFile& operator=(const wxTextFile&);
+};
+
+#endif // wxUSE_TEXTFILE
+
+#endif // _WX_TEXTFILE_H
+