wxMenu::callback stuff taken inside WXWIN_COMPATIBILITY_2 (everybody should

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

diff --git a/include/wx/textfile.h b/include/wx/textfile.h
index 1747218f2715caf5970d132bf93093ef84e50ac4..6c617bb62498b6ae2c3ef4c047dc1fdbf589acba 100644 (file)
--- a/include/wx/textfile.h
+++ b/include/wx/textfile.h
@@ -4,21 +4,29 @@
 //              (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
+
+#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"


@@ -33,21 +41,33 @@ 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_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);
+WX_DEFINE_EXPORTED_ARRAY(wxTextFileType, ArrayFileType);

 
 

-class wxTextFile
+class WXDLLEXPORT wxTextFile

 {
 public:
 {
 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() { }

-    // 
+    //

   wxTextFile(const wxString& strFile);
 
   // file operations
   wxTextFile(const wxString& strFile);
 
   // file operations


@@ -60,7 +80,7 @@ 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


@@ -80,7 +100,7 @@ public:
     // lines, i.e. you may write something like:
     //  for ( str = GetFirstLine(); !Eof(); str = GetNextLine() ) { ... }
 
     // lines, i.e. you may write something like:
     //  for ( str = GetFirstLine(); !Eof(); str = GetNextLine() ) { ... }
 

-    // @@@ const is commented out because not all compilers understand
+    // 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];   }
     //     '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];   }


@@ -94,16 +114,16 @@ public:
     // guess the type of file (m_file is supposed to be opened)
   wxTextFileType GuessType() const;
     // get the name of the file
     // guess the type of file (m_file is supposed to be opened)
   wxTextFileType GuessType() const;
     // 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, wxTextFileType 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
   void InsertLine(const wxString& str,
                   size_t n,
     { m_aLines.Add(str); m_aTypes.Add(type); }
     // insert a line before the line number n
   void InsertLine(const wxString& str,
                   size_t n,

-                  wxTextFileType type = typeDefault) 
+                  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); }
     { 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); }


@@ -112,10 +132,6 @@ public:
   // possibly in another format
   bool Write(wxTextFileType typeNew = wxTextFileType_None);
 
   // 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 char *GetEOL(wxTextFileType type = typeDefault);
-

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


@@ -134,7 +150,39 @@ private:
 
   size_t        m_nCurLine; // number of current line in the 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
+