include/wx/txtstrm.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        txtstrm.h
   3 // Purpose:     Text stream classes
   4 // Author:      Guilhem Lavaux
   5 // Modified by:
   6 // Created:     28/06/1998
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Guilhem Lavaux
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_TXTSTREAM_H_
  13 #define _WX_TXTSTREAM_H_
  14
  15 #include "wx/stream.h"
  16
  17 #if wxUSE_STREAMS
  18
  19 class WXDLLIMPEXP_BASE wxTextInputStream;
  20 class WXDLLIMPEXP_BASE wxTextOutputStream;
  21
  22 typedef wxTextInputStream& (*__wxTextInputManip)(wxTextInputStream&);
  23 typedef wxTextOutputStream& (*__wxTextOutputManip)(wxTextOutputStream&);
  24
  25 WXDLLIMPEXP_BASE wxTextOutputStream &endl( wxTextOutputStream &stream );
  26
  27
  28 #define wxEOT wxT('\4') // the End-Of-Text control code (used only inside wxTextInputStream)
  29
  30 // If you're scanning through a file using wxTextInputStream, you should check for EOF _before_
  31 // reading the next item (word / number), because otherwise the last item may get lost.
  32 // You should however be prepared to receive an empty item (empty string / zero number) at the
  33 // end of file, especially on Windows systems. This is unavoidable because most (but not all) files end
  34 // with whitespace (i.e. usually a newline).
  35 class WXDLLIMPEXP_BASE wxTextInputStream
  36 {
  37 public:
  38 #if wxUSE_UNICODE
  39     wxTextInputStream(wxInputStream& s, const wxString &sep=wxT(" \t"), wxMBConv& conv = wxConvUTF8 );
  40 #else
  41     wxTextInputStream(wxInputStream& s, const wxString &sep=wxT(" \t") );
  42 #endif
  43     ~wxTextInputStream();
  44
  45     wxUint32 Read32(int base = 10); // base may be between 2 and 36, inclusive, or the special 0 (= C format)
  46     wxUint16 Read16(int base = 10);
  47     wxUint8  Read8(int base = 10);
  48     wxInt32  Read32S(int base = 10);
  49     wxInt16  Read16S(int base = 10);
  50     wxInt8   Read8S(int base = 10);
  51     double   ReadDouble();
  52     wxString ReadString();  // deprecated: use ReadLine or ReadWord instead
  53     wxString ReadLine();
  54     wxString ReadWord();
  55     wxChar   GetChar() { wxChar c = NextChar(); return (wxChar)(c != wxEOT ? c : 0); }
  56
  57     wxString GetStringSeparators() const { return m_separators; }
  58     void SetStringSeparators(const wxString &c) { m_separators = c; }
  59
  60     // Operators
  61     wxTextInputStream& operator>>(wxString& word);
  62     wxTextInputStream& operator>>(char& c);
  63 #if wxUSE_UNICODE && wxWCHAR_T_IS_REAL_TYPE
  64     wxTextInputStream& operator>>(wchar_t& wc);
  65 #endif // wxUSE_UNICODE
  66     wxTextInputStream& operator>>(wxInt16& i);
  67     wxTextInputStream& operator>>(wxInt32& i);
  68     wxTextInputStream& operator>>(wxUint16& i);
  69     wxTextInputStream& operator>>(wxUint32& i);
  70     wxTextInputStream& operator>>(double& i);
  71     wxTextInputStream& operator>>(float& f);
  72
  73     wxTextInputStream& operator>>( __wxTextInputManip func) { return func(*this); }
  74
  75 protected:
  76     wxInputStream &m_input;
  77     wxString m_separators;
  78     char m_lastBytes[10]; // stores the bytes that were read for the last character
  79
  80 #if wxUSE_UNICODE
  81     wxMBConv &m_conv;
  82 #endif
  83
  84     bool   EatEOL(const wxChar &c);
  85     void   UngetLast(); // should be used instead of wxInputStream::Ungetch() because of Unicode issues
  86     // returns EOT (\4) if there is a stream error, or end of file
  87     wxChar NextChar();   // this should be used instead of GetC() because of Unicode issues
  88     wxChar NextNonSeparators();
  89
  90     DECLARE_NO_COPY_CLASS(wxTextInputStream)
  91 };
  92
  93 typedef enum
  94 {
  95   wxEOL_NATIVE,
  96   wxEOL_UNIX,
  97   wxEOL_MAC,
  98   wxEOL_DOS
  99 } wxEOL;
 100
 101 class WXDLLIMPEXP_BASE wxTextOutputStream
 102 {
 103 public:
 104 #if wxUSE_UNICODE
 105     wxTextOutputStream( wxOutputStream& s, wxEOL mode = wxEOL_NATIVE, wxMBConv& conv = wxConvUTF8  );
 106 #else
 107     wxTextOutputStream( wxOutputStream& s, wxEOL mode = wxEOL_NATIVE );
 108 #endif
 109     virtual ~wxTextOutputStream();
 110
 111     void SetMode( wxEOL mode = wxEOL_NATIVE );
 112     wxEOL GetMode() { return m_mode; }
 113
 114     void Write32(wxUint32 i);
 115     void Write16(wxUint16 i);
 116     void Write8(wxUint8 i);
 117     virtual void WriteDouble(double d);
 118     virtual void WriteString(const wxString& string);
 119
 120     wxTextOutputStream& PutChar(wxChar c);
 121
 122     wxTextOutputStream& operator<<(const wxChar *string);
 123     wxTextOutputStream& operator<<(const wxString& string);
 124     wxTextOutputStream& operator<<(char c);
 125 #if wxUSE_UNICODE && wxWCHAR_T_IS_REAL_TYPE
 126     wxTextOutputStream& operator<<(wchar_t wc);
 127 #endif // wxUSE_UNICODE
 128     wxTextOutputStream& operator<<(wxInt16 c);
 129     wxTextOutputStream& operator<<(wxInt32 c);
 130     wxTextOutputStream& operator<<(wxUint16 c);
 131     wxTextOutputStream& operator<<(wxUint32 c);
 132     wxTextOutputStream& operator<<(double f);
 133     wxTextOutputStream& operator<<(float f);
 134
 135     wxTextOutputStream& operator<<( __wxTextOutputManip func) { return func(*this); }
 136
 137 protected:
 138     wxOutputStream &m_output;
 139     wxEOL           m_mode;
 140
 141 #if wxUSE_UNICODE
 142     wxMBConv &m_conv;
 143 #endif
 144
 145     DECLARE_NO_COPY_CLASS(wxTextOutputStream)
 146 };
 147
 148 #endif
 149   // wxUSE_STREAMS
 150
 151 #endif
 152     // _WX_DATSTREAM_H_