libstdc++-v3/include/bits/streambuf_iterator.h

   1 // Streambuf iterators
   2
   3 // Copyright (C) 1997-2001 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 2, or (at your option)
   9 // any later version.
  10
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License along
  17 // with this library; see the file COPYING.  If not, write to the Free
  18 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19 // USA.
  20
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 // XXX Should specialize copy, find algorithms for streambuf iterators.
  31
  32 #ifndef _CPP_BITS_STREAMBUF_ITERATOR_H
  33 #define _CPP_BITS_STREAMBUF_ITERATOR_H 1
  34
  35 #pragma GCC system_header
  36
  37 namespace std
  38 {
  39   template<typename _CharT, typename _Traits>
  40     class ostreambuf_iterator
  41     : public iterator<output_iterator_tag, void, void, void, void>
  42     {
  43     public:
  44       // Types:
  45       typedef _CharT                           char_type;
  46       typedef _Traits                          traits_type;
  47       typedef basic_streambuf<_CharT, _Traits> streambuf_type;
  48       typedef basic_ostream<_CharT, _Traits>   ostream_type;
  49
  50     private:
  51       streambuf_type*   _M_sbuf;
  52       bool              _M_failed;
  53
  54     public:
  55       inline
  56       ostreambuf_iterator(ostream_type& __s) throw ()
  57       : _M_sbuf(__s.rdbuf()), _M_failed(!_M_sbuf) { }
  58
  59       ostreambuf_iterator(streambuf_type* __s) throw ()
  60       : _M_sbuf(__s), _M_failed(!_M_sbuf) { }
  61
  62       ostreambuf_iterator&
  63       operator=(_CharT __c);
  64
  65       ostreambuf_iterator&
  66       operator*() throw()
  67       { return *this; }
  68
  69       ostreambuf_iterator&
  70       operator++(int) throw()
  71       { return *this; }
  72
  73       ostreambuf_iterator&
  74       operator++() throw()
  75       { return *this; }
  76
  77       bool
  78       failed() const throw()
  79       { return _M_failed; }
  80     };
  81
  82   template<typename _CharT, typename _Traits>
  83     inline ostreambuf_iterator<_CharT, _Traits>&
  84     ostreambuf_iterator<_CharT, _Traits>::operator=(_CharT __c)
  85     {
  86       if (!_M_failed &&
  87           _Traits::eq_int_type(_M_sbuf->sputc(__c),_Traits::eof()))
  88       _M_failed = true;
  89       return *this;
  90     }
  91
  92
  93   // 24.5.3 Template class istreambuf_iterator
  94   template<typename _CharT, typename _Traits>
  95     class istreambuf_iterator
  96     : public iterator<input_iterator_tag, _CharT, typename _Traits::off_type,
  97                       _CharT*, _CharT&>
  98     {
  99     public:
 100       // Types:
 101       typedef _CharT                                    char_type;
 102       typedef _Traits                                   traits_type;
 103       typedef typename _Traits::int_type                int_type;
 104       typedef basic_streambuf<_CharT, _Traits>          streambuf_type;
 105       typedef basic_istream<_CharT, _Traits>            istream_type;
 106
 107     private:
 108       // 24.5.3 istreambuf_iterator
 109       // p 1
 110       // If the end of stream is reached (streambuf_type::sgetc()
 111       // returns traits_type::eof()), the iterator becomes equal to
 112       // the "end of stream" iterator value.
 113       // NB: This implementation assumes the "end of stream" value
 114       // is EOF, or -1.
 115       streambuf_type*           _M_sbuf;
 116       int_type                  _M_c;
 117
 118     public:
 119       istreambuf_iterator() throw()
 120       : _M_sbuf(NULL), _M_c(-2) { }
 121
 122       istreambuf_iterator(istream_type& __s) throw()
 123       : _M_sbuf(__s.rdbuf()), _M_c(-2) { }
 124
 125       istreambuf_iterator(streambuf_type* __s) throw()
 126       : _M_sbuf(__s), _M_c(-2) { }
 127
 128       // NB: This should really have an int_type return
 129       // value, so "end of stream" postion can be checked without
 130       // hacking.
 131       char_type
 132       operator*() const
 133       {
 134         // The result of operator*() on an end of stream is undefined.
 135         char_type __ret;
 136         if (_M_sbuf && _M_c != static_cast<int_type>(-2))
 137           __ret = _M_c;
 138         else if (_M_sbuf)
 139           __ret = traits_type::to_char_type(_M_sbuf->sgetc());
 140         else
 141           __ret = static_cast<char_type>(traits_type::eof());
 142         return __ret;
 143       }
 144
 145       istreambuf_iterator&
 146       operator++()
 147       {
 148         if (_M_sbuf)
 149           _M_sbuf->sbumpc();
 150         _M_c = -2;
 151         return *this;
 152       }
 153
 154       istreambuf_iterator
 155       operator++(int)
 156       {
 157         istreambuf_iterator __old = *this;
 158         if (_M_sbuf)
 159           __old._M_c = _M_sbuf->sbumpc();
 160         _M_c = -2;
 161         return __old;
 162       }
 163
 164       bool
 165       equal(const istreambuf_iterator& __b)
 166       {
 167         int_type __eof = traits_type::eof();
 168         bool __thiseof = !_M_sbuf || _M_sbuf->sgetc() == __eof;
 169         bool __beof = !__b._M_sbuf
 170                       || __b._M_sbuf->sgetc() == __eof;
 171         return (__thiseof && __beof || (!__thiseof && !__beof));
 172       }
 173
 174 #ifdef _GLIBCPP_RESOLVE_LIB_DEFECTS
 175       // 110 istreambuf_iterator::equal not const
 176       // NB: there is also number 111 (NAD, Future) pending on this function.
 177       bool
 178       equal(const istreambuf_iterator& __b) const
 179       {
 180         int_type __eof = traits_type::eof();
 181         bool __thiseof = !_M_sbuf || _M_sbuf->sgetc() == __eof;
 182         bool __beof = !__b._M_sbuf
 183                       || __b._M_sbuf->sgetc() == __eof;
 184         return (__thiseof && __beof || (!__thiseof && !__beof));
 185       }
 186 #endif
 187     };
 188
 189   template<typename _CharT, typename _Traits>
 190     inline bool
 191     operator==(const istreambuf_iterator<_CharT, _Traits>& __a,
 192                const istreambuf_iterator<_CharT, _Traits>& __b)
 193     { return __a.equal(__b); }
 194
 195   template<typename _CharT, typename _Traits>
 196     inline bool
 197     operator!=(const istreambuf_iterator<_CharT, _Traits>& __a,
 198                const istreambuf_iterator<_CharT, _Traits>& __b)
 199     { return !__a.equal(__b); }
 200 } // namespace std
 201 #endif