Trying to hide evidence of my negative programming skills...

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

diff --git a/include/wx/textfile.h b/include/wx/textfile.h
index a7b213d177fc22bdbc83641c549f0bd3cd879b05..ec93546696cc1a0b877c18839a8343b39763a9b5 100644 (file)
--- a/include/wx/textfile.h
+++ b/include/wx/textfile.h
@@ -11,42 +11,60 @@
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 
 // 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_TEXTFILE && wxUSE_FILE
-
-#include "wx/string.h"
-#include "wx/file.h"
-#include "wx/dynarray.h"
-

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-// wxTextFile
+// 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'
 // 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_Mac,   //                         'CR' = 0xD = 13 = '\r'
+    wxTextFileType_Os2    //                         'CR' 'LF'

 };
 
 };
 

-WX_DEFINE_ARRAY(wxTextFileType, ArrayFileType);
+#if wxUSE_TEXTFILE
+
+#include "wx/string.h"
+#include "wx/file.h"
+#include "wx/dynarray.h"
+
+// ----------------------------------------------------------------------------
+// wxTextFile
+// ----------------------------------------------------------------------------
+
+WX_DEFINE_EXPORTED_ARRAY(wxTextFileType, ArrayFileType);

 
 class WXDLLEXPORT wxTextFile
 {
 public:
 
 class WXDLLEXPORT wxTextFile
 {
 public:

-  // default type for current platform (determined at compile time)
+  // constants and static functions
+    // default type for current platform (determined at compile time)

   static const wxTextFileType typeDefault;
 
   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() { }


@@ -56,6 +74,10 @@ public:
   // file operations
     // file exists?
   bool Exists() const;
   // 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


@@ -77,7 +99,7 @@ public:
     // you're using "direct access" i.e. GetLine()
   size_t GetCurrentLine() const { return m_nCurLine; }
   void GoToLine(size_t n) { m_nCurLine = n; }
     // 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_nCurLine == m_aLines.Count() - 1; }
+  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:
 
     // these methods allow more "iterator-like" traversal of the list of
     // lines, i.e. you may write something like:


@@ -109,16 +131,12 @@ public:
                   wxTextFileType type = typeDefault)
     { m_aLines.Insert(str, n); m_aTypes.Insert(type, n); }
     // delete one line
                   wxTextFileType type = typeDefault)
     { m_aLines.Insert(str, n); m_aTypes.Insert(type, n); }
     // delete one line

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

 
   // change the file on disk (default argument means "don't change type")
   // possibly in another format
   bool Write(wxTextFileType typeNew = wxTextFileType_None);
 
 
   // change the file on disk (default argument means "don't change type")
   // possibly in another format
   bool Write(wxTextFileType typeNew = wxTextFileType_None);
 

-  // get the file termination string
-  // Note: implementation moved to textfile to prevent warning due to switch.
-  static const wxChar *GetEOL(wxTextFileType type = typeDefault);
-

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


@@ -142,9 +160,40 @@ private:
   wxString      m_strFile;  // name of the file
 };
 
   wxString      m_strFile;  // name of the file
 };
 

-#endif
-  // wxUSE_TEXTFILE && wxUSE_FILE
+#else // !wxUSE_TEXTFILE

 
 

-#endif
-  // _TEXTFILE_H
+// 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&);
+
+    // suppress the gcc warning: 'class defines only private constructors and
+    // has no friends'
+#ifdef __GNUG__
+    friend class wxTextFileDummyFriend;
+#endif // gcc
+};
+
+#endif // wxUSE_TEXTFILE
+
+#endif // _WX_TEXTFILE_H