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

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