]> git.buserror.net Git - polintos/scott/priv.git/blob - include/c++/stl/stl/_istreambuf_iterator.h
minor doc updates
[polintos/scott/priv.git] / include / c++ / stl / stl / _istreambuf_iterator.h
1 /*
2  * Copyright (c) 1999
3  * Silicon Graphics Computer Systems, Inc.
4  *
5  * Copyright (c) 1999
6  * Boris Fomitchev
7  *
8  * This material is provided "as is", with absolutely no warranty expressed
9  * or implied. Any use is at your own risk.
10  *
11  * Permission to use or copy this software for any purpose is hereby granted
12  * without fee, provided the above notices are retained on all copies.
13  * Permission to modify the code and to distribute modified code is granted,
14  * provided the above notices are retained, and a notice that the code was
15  * modified is included with the above copyright notice.
16  *
17  */
18 // WARNING: This is an internal header file, included by other C++
19 // standard library headers.  You should not attempt to use this header
20 // file directly.
21
22
23 #ifndef _STLP_INTERNAL_ISTREAMBUF_ITERATOR_H
24 #define _STLP_INTERNAL_ISTREAMBUF_ITERATOR_H
25
26 #ifndef _STLP_INTERNAL_ITERATOR_BASE_H
27 # include <stl/_iterator_base.h>
28 #endif
29
30 #ifndef _STLP_INTERNAL_STREAMBUF
31 # include <stl/_streambuf.h>
32 #endif
33
34 _STLP_BEGIN_NAMESPACE
35
36 // defined in _istream.h
37 template <class _CharT, class _Traits>
38 extern basic_streambuf<_CharT, _Traits>* _STLP_CALL _M_get_istreambuf(basic_istream<_CharT, _Traits>& ) ;
39
40 // We do not read any characters until operator* is called. operator* calls sgetc
41 // unless the iterator is unchanged from the last call in which case a cached value is
42 // used. Calls to operator++ use sbumpc.
43
44 template<class _CharT, class _Traits>
45 class istreambuf_iterator :
46   public iterator<input_iterator_tag, _CharT, typename _Traits::off_type, _CharT*, _CharT&>
47 {
48 public:
49   typedef _CharT                           char_type;
50   typedef _Traits                          traits_type;
51   typedef typename _Traits::int_type       int_type;
52   typedef basic_streambuf<_CharT, _Traits> streambuf_type;
53   typedef basic_istream<_CharT, _Traits>   istream_type;
54
55   typedef input_iterator_tag               iterator_category;
56   typedef _CharT                           value_type;
57   typedef typename _Traits::off_type       difference_type;
58   typedef const _CharT*                    pointer;
59   typedef const _CharT&                    reference;
60
61 public:
62   istreambuf_iterator(streambuf_type* __p = 0) { this->_M_init(__p); }
63   //  istreambuf_iterator(basic_istream<_CharT, _Traits>& __is) { this->_M_init(_M_get_istreambuf(__is)); }
64   inline istreambuf_iterator(basic_istream<_CharT, _Traits>& __is);
65
66   char_type operator*() const { this->_M_getc(); return _M_c; }
67   istreambuf_iterator<_CharT, _Traits>& operator++()
68       {
69         _M_buf->sbumpc();
70         _M_have_c = false;
71         return *this;
72       }
73   istreambuf_iterator<_CharT, _Traits>  operator++(int);
74
75   bool equal(const istreambuf_iterator<_CharT, _Traits>& __i) const {
76     if (this->_M_buf)
77       this->_M_getc();
78     if (__i._M_buf)
79       __i._M_getc();
80     return this->_M_eof == __i._M_eof;
81   }
82
83 private:
84   void _M_init(streambuf_type* __p) {
85     _M_buf = __p;
86     _M_eof = (__p == 0);
87     _M_have_c = false;
88   }
89
90   void _M_getc() const {
91     if (_M_have_c)
92       return;
93     int_type __c = _M_buf->sgetc();
94 # if !defined (_STLP_NEED_MUTABLE) /* && ! defined (__SUNPRO_CC) */
95     _M_c = traits_type::to_char_type(__c);
96     _M_eof = traits_type::eq_int_type(__c, traits_type::eof());
97     _M_have_c = true;
98 # else
99     typedef istreambuf_iterator<_CharT,_Traits> _Self;
100     _Self* __that = __CONST_CAST(_Self*, this);
101     __that->_M_c = __STATIC_CAST(_CharT, traits_type::to_char_type(__c));
102     __that->_M_eof = traits_type::eq_int_type(__c, traits_type::eof());
103     __that->_M_have_c = true;
104 # endif
105   }
106
107 private:
108   streambuf_type* _M_buf;
109   mutable _CharT _M_c;
110   mutable bool _M_eof;
111   mutable bool _M_have_c;
112 };
113
114 template<class _CharT, class _Traits>
115 inline istreambuf_iterator<_CharT, _Traits>::istreambuf_iterator(basic_istream<_CharT, _Traits>& __is)
116 { this->_M_init(_M_get_istreambuf(__is)); }
117
118 template<class _CharT, class _Traits>
119 inline bool _STLP_CALL operator==(const istreambuf_iterator<_CharT, _Traits>& __x,
120                                   const istreambuf_iterator<_CharT, _Traits>& __y) {
121   return __x.equal(__y);
122 }
123
124 #ifdef _STLP_USE_SEPARATE_RELOPS_NAMESPACE
125
126 template<class _CharT, class _Traits>
127 inline bool _STLP_CALL operator!=(const istreambuf_iterator<_CharT, _Traits>& __x,
128                                   const istreambuf_iterator<_CharT, _Traits>& __y) {
129   return !__x.equal(__y);
130 }
131
132 #endif /* _STLP_USE_SEPARATE_RELOPS_NAMESPACE */
133
134 # if defined (_STLP_USE_TEMPLATE_EXPORT)
135 _STLP_EXPORT_TEMPLATE_CLASS istreambuf_iterator<char, char_traits<char> >;
136 #  if defined (INSTANTIATE_WIDE_STREAMS)
137 _STLP_EXPORT_TEMPLATE_CLASS istreambuf_iterator<wchar_t, char_traits<wchar_t> >;
138 #  endif
139 # endif /* _STLP_USE_TEMPLATE_EXPORT */
140
141 # ifdef _STLP_USE_OLD_HP_ITERATOR_QUERIES
142 template <class _CharT, class _Traits>
143 inline input_iterator_tag _STLP_CALL iterator_category(const istreambuf_iterator<_CharT, _Traits>&) { return input_iterator_tag(); }
144 template <class _CharT, class _Traits>
145 inline streamoff* _STLP_CALL
146 distance_type(const istreambuf_iterator<_CharT, _Traits>&) { return (streamoff*)0; }
147 template <class _CharT, class _Traits>
148 inline _CharT* _STLP_CALL value_type(const istreambuf_iterator<_CharT, _Traits>&) { return (_CharT*)0; }
149 # endif
150
151 template <class _CharT, class _Traits>
152 istreambuf_iterator<_CharT, _Traits>
153 istreambuf_iterator<_CharT, _Traits>::operator++(int) {
154   _M_getc(); // __tmp should avoid any future actions under
155   // underlined buffer---during call of operator *()
156   // (due to buffer for *this and __tmp are the same).
157   istreambuf_iterator<_CharT, _Traits> __tmp = *this;
158   _M_buf->sbumpc();
159   _M_have_c = false;
160   return __tmp;
161 }
162
163 _STLP_END_NAMESPACE
164
165 #endif /* _STLP_INTERNAL_ISTREAMBUF_ITERATOR_H */
166
167 // Local Variables:
168 // mode:C++
169 // End:
170