libstdc++-v3/include/std/sstream

   1 // String based streams -*- C++ -*-
   2
   3 // Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
   4 // 2006, 2008 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
  18 // along with this library; see the file COPYING.  If not, write to
  19 // the Free Software Foundation, 51 Franklin Street, Fifth Floor,
  20 // Boston, MA 02110-1301, 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 /** @file sstream
  32  *  This is a Standard C++ Library header.
  33  */
  34
  35 //
  36 // ISO C++ 14882: 27.7  String-based streams
  37 //
  38
  39 #ifndef _GLIBCXX_SSTREAM
  40 #define _GLIBCXX_SSTREAM 1
  41
  42 #pragma GCC system_header
  43
  44 #include <istream>
  45 #include <ostream>
  46
  47 _GLIBCXX_BEGIN_NAMESPACE(std)
  48
  49   // [27.7.1] template class basic_stringbuf
  50   /**
  51    *  @brief  The actual work of input and output (for std::string).
  52    *
  53    *  This class associates either or both of its input and output sequences
  54    *  with a sequence of characters, which can be initialized from, or made
  55    *  available as, a @c std::basic_string.  (Paraphrased from [27.7.1]/1.)
  56    *
  57    *  For this class, open modes (of type @c ios_base::openmode) have
  58    *  @c in set if the input sequence can be read, and @c out set if the
  59    *  output sequence can be written.
  60   */
  61   template<typename _CharT, typename _Traits, typename _Alloc>
  62     class basic_stringbuf : public basic_streambuf<_CharT, _Traits>
  63     {
  64     public:
  65       // Types:
  66       typedef _CharT                                    char_type;
  67       typedef _Traits                                   traits_type;
  68       // _GLIBCXX_RESOLVE_LIB_DEFECTS
  69       // 251. basic_stringbuf missing allocator_type
  70       typedef _Alloc                                    allocator_type;
  71       typedef typename traits_type::int_type            int_type;
  72       typedef typename traits_type::pos_type            pos_type;
  73       typedef typename traits_type::off_type            off_type;
  74
  75       typedef basic_streambuf<char_type, traits_type>   __streambuf_type;
  76       typedef basic_string<char_type, _Traits, _Alloc>  __string_type;
  77       typedef typename __string_type::size_type         __size_type;
  78
  79     protected:
  80       /// Place to stash in || out || in | out settings for current stringbuf.
  81       ios_base::openmode        _M_mode;
  82
  83       // Data Members:
  84       __string_type             _M_string;
  85
  86     public:
  87       // Constructors:
  88       /**
  89        *  @brief  Starts with an empty string buffer.
  90        *  @param  mode  Whether the buffer can read, or write, or both.
  91        *
  92        *  The default constructor initializes the parent class using its
  93        *  own default ctor.
  94       */
  95       explicit
  96       basic_stringbuf(ios_base::openmode __mode = ios_base::in | ios_base::out)
  97       : __streambuf_type(), _M_mode(__mode), _M_string()
  98       { }
  99
 100       /**
 101        *  @brief  Starts with an existing string buffer.
 102        *  @param  str  A string to copy as a starting buffer.
 103        *  @param  mode  Whether the buffer can read, or write, or both.
 104        *
 105        *  This constructor initializes the parent class using its
 106        *  own default ctor.
 107       */
 108       explicit
 109       basic_stringbuf(const __string_type& __str,
 110                       ios_base::openmode __mode = ios_base::in | ios_base::out)
 111       : __streambuf_type(), _M_mode(), _M_string(__str.data(), __str.size())
 112       { _M_stringbuf_init(__mode); }
 113
 114       // Get and set:
 115       /**
 116        *  @brief  Copying out the string buffer.
 117        *  @return  A copy of one of the underlying sequences.
 118        *
 119        *  "If the buffer is only created in input mode, the underlying
 120        *  character sequence is equal to the input sequence; otherwise, it
 121        *  is equal to the output sequence." [27.7.1.2]/1
 122       */
 123       __string_type
 124       str() const
 125       {
 126         __string_type __ret;
 127         if (this->pptr())
 128           {
 129             // The current egptr() may not be the actual string end.
 130             if (this->pptr() > this->egptr())
 131               __ret = __string_type(this->pbase(), this->pptr());
 132             else
 133               __ret = __string_type(this->pbase(), this->egptr());
 134           }
 135         else
 136           __ret = _M_string;
 137         return __ret;
 138       }
 139
 140       /**
 141        *  @brief  Setting a new buffer.
 142        *  @param  s  The string to use as a new sequence.
 143        *
 144        *  Deallocates any previous stored sequence, then copies @a s to
 145        *  use as a new one.
 146       */
 147       void
 148       str(const __string_type& __s)
 149       {
 150         // Cannot use _M_string = __s, since v3 strings are COW.
 151         _M_string.assign(__s.data(), __s.size());
 152         _M_stringbuf_init(_M_mode);
 153       }
 154
 155     protected:
 156       // Common initialization code goes here.
 157       void
 158       _M_stringbuf_init(ios_base::openmode __mode)
 159       {
 160         _M_mode = __mode;
 161         __size_type __len = 0;
 162         if (_M_mode & (ios_base::ate | ios_base::app))
 163           __len = _M_string.size();
 164         _M_sync(const_cast<char_type*>(_M_string.data()), 0, __len);
 165       }
 166
 167       virtual streamsize
 168       showmanyc()
 169       {
 170         streamsize __ret = -1;
 171         if (_M_mode & ios_base::in)
 172           {
 173             _M_update_egptr();
 174             __ret = this->egptr() - this->gptr();
 175           }
 176         return __ret;
 177       }
 178
 179       virtual int_type
 180       underflow();
 181
 182       virtual int_type
 183       pbackfail(int_type __c = traits_type::eof());
 184
 185       virtual int_type
 186       overflow(int_type __c = traits_type::eof());
 187
 188       /**
 189        *  @brief  Manipulates the buffer.
 190        *  @param  s  Pointer to a buffer area.
 191        *  @param  n  Size of @a s.
 192        *  @return  @c this
 193        *
 194        *  If no buffer has already been created, and both @a s and @a n are
 195        *  non-zero, then @c s is used as a buffer; see
 196        *  http://gcc.gnu.org/onlinedocs/libstdc++/27_io/howto.html#2
 197        *  for more.
 198       */
 199       virtual __streambuf_type*
 200       setbuf(char_type* __s, streamsize __n)
 201       {
 202         if (__s && __n >= 0)
 203           {
 204             // This is implementation-defined behavior, and assumes
 205             // that an external char_type array of length __n exists
 206             // and has been pre-allocated. If this is not the case,
 207             // things will quickly blow up.
 208
 209             // Step 1: Destroy the current internal array.
 210             _M_string.clear();
 211
 212             // Step 2: Use the external array.
 213             _M_sync(__s, __n, 0);
 214           }
 215         return this;
 216       }
 217
 218       virtual pos_type
 219       seekoff(off_type __off, ios_base::seekdir __way,
 220               ios_base::openmode __mode = ios_base::in | ios_base::out);
 221
 222       virtual pos_type
 223       seekpos(pos_type __sp,
 224               ios_base::openmode __mode = ios_base::in | ios_base::out);
 225
 226       // Internal function for correctly updating the internal buffer
 227       // for a particular _M_string, due to initialization or re-sizing
 228       // of an existing _M_string.
 229       void
 230       _M_sync(char_type* __base, __size_type __i, __size_type __o);
 231
 232       // Internal function for correctly updating egptr() to the actual
 233       // string end.
 234       void
 235       _M_update_egptr()
 236       {
 237         const bool __testin = _M_mode & ios_base::in;
 238         if (this->pptr() && this->pptr() > this->egptr())
 239           {
 240             if (__testin)
 241               this->setg(this->eback(), this->gptr(), this->pptr());
 242             else
 243               this->setg(this->pptr(), this->pptr(), this->pptr());
 244           }
 245       }
 246     };
 247
 248
 249   // [27.7.2] Template class basic_istringstream
 250   /**
 251    *  @brief  Controlling input for std::string.
 252    *
 253    *  This class supports reading from objects of type std::basic_string,
 254    *  using the inherited functions from std::basic_istream.  To control
 255    *  the associated sequence, an instance of std::basic_stringbuf is used,
 256    *  which this page refers to as @c sb.
 257   */
 258   template<typename _CharT, typename _Traits, typename _Alloc>
 259     class basic_istringstream : public basic_istream<_CharT, _Traits>
 260     {
 261     public:
 262       // Types:
 263       typedef _CharT                                    char_type;
 264       typedef _Traits                                   traits_type;
 265       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 266       // 251. basic_stringbuf missing allocator_type
 267       typedef _Alloc                                    allocator_type;
 268       typedef typename traits_type::int_type            int_type;
 269       typedef typename traits_type::pos_type            pos_type;
 270       typedef typename traits_type::off_type            off_type;
 271
 272       // Non-standard types:
 273       typedef basic_string<_CharT, _Traits, _Alloc>     __string_type;
 274       typedef basic_stringbuf<_CharT, _Traits, _Alloc>  __stringbuf_type;
 275       typedef basic_istream<char_type, traits_type>     __istream_type;
 276
 277     private:
 278       __stringbuf_type  _M_stringbuf;
 279
 280     public:
 281       // Constructors:
 282       /**
 283        *  @brief  Default constructor starts with an empty string buffer.
 284        *  @param  mode  Whether the buffer can read, or write, or both.
 285        *
 286        *  @c ios_base::in is automatically included in @a mode.
 287        *
 288        *  Initializes @c sb using @c mode|in, and passes @c &sb to the base
 289        *  class initializer.  Does not allocate any buffer.
 290        *
 291        *  That's a lie.  We initialize the base class with NULL, because the
 292        *  string class does its own memory management.
 293       */
 294       explicit
 295       basic_istringstream(ios_base::openmode __mode = ios_base::in)
 296       : __istream_type(), _M_stringbuf(__mode | ios_base::in)
 297       { this->init(&_M_stringbuf); }
 298
 299       /**
 300        *  @brief  Starts with an existing string buffer.
 301        *  @param  str  A string to copy as a starting buffer.
 302        *  @param  mode  Whether the buffer can read, or write, or both.
 303        *
 304        *  @c ios_base::in is automatically included in @a mode.
 305        *
 306        *  Initializes @c sb using @a str and @c mode|in, and passes @c &sb
 307        *  to the base class initializer.
 308        *
 309        *  That's a lie.  We initialize the base class with NULL, because the
 310        *  string class does its own memory management.
 311       */
 312       explicit
 313       basic_istringstream(const __string_type& __str,
 314                           ios_base::openmode __mode = ios_base::in)
 315       : __istream_type(), _M_stringbuf(__str, __mode | ios_base::in)
 316       { this->init(&_M_stringbuf); }
 317
 318       /**
 319        *  @brief  The destructor does nothing.
 320        *
 321        *  The buffer is deallocated by the stringbuf object, not the
 322        *  formatting stream.
 323       */
 324       ~basic_istringstream()
 325       { }
 326
 327       // Members:
 328       /**
 329        *  @brief  Accessing the underlying buffer.
 330        *  @return  The current basic_stringbuf buffer.
 331        *
 332        *  This hides both signatures of std::basic_ios::rdbuf().
 333       */
 334       __stringbuf_type*
 335       rdbuf() const
 336       { return const_cast<__stringbuf_type*>(&_M_stringbuf); }
 337
 338       /**
 339        *  @brief  Copying out the string buffer.
 340        *  @return  @c rdbuf()->str()
 341       */
 342       __string_type
 343       str() const
 344       { return _M_stringbuf.str(); }
 345
 346       /**
 347        *  @brief  Setting a new buffer.
 348        *  @param  s  The string to use as a new sequence.
 349        *
 350        *  Calls @c rdbuf()->str(s).
 351       */
 352       void
 353       str(const __string_type& __s)
 354       { _M_stringbuf.str(__s); }
 355     };
 356
 357
 358   // [27.7.3] Template class basic_ostringstream
 359   /**
 360    *  @brief  Controlling output for std::string.
 361    *
 362    *  This class supports writing to objects of type std::basic_string,
 363    *  using the inherited functions from std::basic_ostream.  To control
 364    *  the associated sequence, an instance of std::basic_stringbuf is used,
 365    *  which this page refers to as @c sb.
 366   */
 367   template <typename _CharT, typename _Traits, typename _Alloc>
 368     class basic_ostringstream : public basic_ostream<_CharT, _Traits>
 369     {
 370     public:
 371       // Types:
 372       typedef _CharT                                    char_type;
 373       typedef _Traits                                   traits_type;
 374       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 375       // 251. basic_stringbuf missing allocator_type
 376       typedef _Alloc                                    allocator_type;
 377       typedef typename traits_type::int_type            int_type;
 378       typedef typename traits_type::pos_type            pos_type;
 379       typedef typename traits_type::off_type            off_type;
 380
 381       // Non-standard types:
 382       typedef basic_string<_CharT, _Traits, _Alloc>     __string_type;
 383       typedef basic_stringbuf<_CharT, _Traits, _Alloc>  __stringbuf_type;
 384       typedef basic_ostream<char_type, traits_type>     __ostream_type;
 385
 386     private:
 387       __stringbuf_type  _M_stringbuf;
 388
 389     public:
 390       // Constructors/destructor:
 391       /**
 392        *  @brief  Default constructor starts with an empty string buffer.
 393        *  @param  mode  Whether the buffer can read, or write, or both.
 394        *
 395        *  @c ios_base::out is automatically included in @a mode.
 396        *
 397        *  Initializes @c sb using @c mode|out, and passes @c &sb to the base
 398        *  class initializer.  Does not allocate any buffer.
 399        *
 400        *  That's a lie.  We initialize the base class with NULL, because the
 401        *  string class does its own memory management.
 402       */
 403       explicit
 404       basic_ostringstream(ios_base::openmode __mode = ios_base::out)
 405       : __ostream_type(), _M_stringbuf(__mode | ios_base::out)
 406       { this->init(&_M_stringbuf); }
 407
 408       /**
 409        *  @brief  Starts with an existing string buffer.
 410        *  @param  str  A string to copy as a starting buffer.
 411        *  @param  mode  Whether the buffer can read, or write, or both.
 412        *
 413        *  @c ios_base::out is automatically included in @a mode.
 414        *
 415        *  Initializes @c sb using @a str and @c mode|out, and passes @c &sb
 416        *  to the base class initializer.
 417        *
 418        *  That's a lie.  We initialize the base class with NULL, because the
 419        *  string class does its own memory management.
 420       */
 421       explicit
 422       basic_ostringstream(const __string_type& __str,
 423                           ios_base::openmode __mode = ios_base::out)
 424       : __ostream_type(), _M_stringbuf(__str, __mode | ios_base::out)
 425       { this->init(&_M_stringbuf); }
 426
 427       /**
 428        *  @brief  The destructor does nothing.
 429        *
 430        *  The buffer is deallocated by the stringbuf object, not the
 431        *  formatting stream.
 432       */
 433       ~basic_ostringstream()
 434       { }
 435
 436       // Members:
 437       /**
 438        *  @brief  Accessing the underlying buffer.
 439        *  @return  The current basic_stringbuf buffer.
 440        *
 441        *  This hides both signatures of std::basic_ios::rdbuf().
 442       */
 443       __stringbuf_type*
 444       rdbuf() const
 445       { return const_cast<__stringbuf_type*>(&_M_stringbuf); }
 446
 447       /**
 448        *  @brief  Copying out the string buffer.
 449        *  @return  @c rdbuf()->str()
 450       */
 451       __string_type
 452       str() const
 453       { return _M_stringbuf.str(); }
 454
 455       /**
 456        *  @brief  Setting a new buffer.
 457        *  @param  s  The string to use as a new sequence.
 458        *
 459        *  Calls @c rdbuf()->str(s).
 460       */
 461       void
 462       str(const __string_type& __s)
 463       { _M_stringbuf.str(__s); }
 464     };
 465
 466
 467   // [27.7.4] Template class basic_stringstream
 468   /**
 469    *  @brief  Controlling input and output for std::string.
 470    *
 471    *  This class supports reading from and writing to objects of type
 472    *  std::basic_string, using the inherited functions from
 473    *  std::basic_iostream.  To control the associated sequence, an instance
 474    *  of std::basic_stringbuf is used, which this page refers to as @c sb.
 475   */
 476   template <typename _CharT, typename _Traits, typename _Alloc>
 477     class basic_stringstream : public basic_iostream<_CharT, _Traits>
 478     {
 479     public:
 480       // Types:
 481       typedef _CharT                                    char_type;
 482       typedef _Traits                                   traits_type;
 483       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 484       // 251. basic_stringbuf missing allocator_type
 485       typedef _Alloc                                    allocator_type;
 486       typedef typename traits_type::int_type            int_type;
 487       typedef typename traits_type::pos_type            pos_type;
 488       typedef typename traits_type::off_type            off_type;
 489
 490       // Non-standard Types:
 491       typedef basic_string<_CharT, _Traits, _Alloc>     __string_type;
 492       typedef basic_stringbuf<_CharT, _Traits, _Alloc>  __stringbuf_type;
 493       typedef basic_iostream<char_type, traits_type>    __iostream_type;
 494
 495     private:
 496       __stringbuf_type  _M_stringbuf;
 497
 498     public:
 499       // Constructors/destructors
 500       /**
 501        *  @brief  Default constructor starts with an empty string buffer.
 502        *  @param  mode  Whether the buffer can read, or write, or both.
 503        *
 504        *  Initializes @c sb using @c mode, and passes @c &sb to the base
 505        *  class initializer.  Does not allocate any buffer.
 506        *
 507        *  That's a lie.  We initialize the base class with NULL, because the
 508        *  string class does its own memory management.
 509       */
 510       explicit
 511       basic_stringstream(ios_base::openmode __m = ios_base::out | ios_base::in)
 512       : __iostream_type(), _M_stringbuf(__m)
 513       { this->init(&_M_stringbuf); }
 514
 515       /**
 516        *  @brief  Starts with an existing string buffer.
 517        *  @param  str  A string to copy as a starting buffer.
 518        *  @param  mode  Whether the buffer can read, or write, or both.
 519        *
 520        *  Initializes @c sb using @a str and @c mode, and passes @c &sb
 521        *  to the base class initializer.
 522        *
 523        *  That's a lie.  We initialize the base class with NULL, because the
 524        *  string class does its own memory management.
 525       */
 526       explicit
 527       basic_stringstream(const __string_type& __str,
 528                          ios_base::openmode __m = ios_base::out | ios_base::in)
 529       : __iostream_type(), _M_stringbuf(__str, __m)
 530       { this->init(&_M_stringbuf); }
 531
 532       /**
 533        *  @brief  The destructor does nothing.
 534        *
 535        *  The buffer is deallocated by the stringbuf object, not the
 536        *  formatting stream.
 537       */
 538       ~basic_stringstream()
 539       { }
 540
 541       // Members:
 542       /**
 543        *  @brief  Accessing the underlying buffer.
 544        *  @return  The current basic_stringbuf buffer.
 545        *
 546        *  This hides both signatures of std::basic_ios::rdbuf().
 547       */
 548       __stringbuf_type*
 549       rdbuf() const
 550       { return const_cast<__stringbuf_type*>(&_M_stringbuf); }
 551
 552       /**
 553        *  @brief  Copying out the string buffer.
 554        *  @return  @c rdbuf()->str()
 555       */
 556       __string_type
 557       str() const
 558       { return _M_stringbuf.str(); }
 559
 560       /**
 561        *  @brief  Setting a new buffer.
 562        *  @param  s  The string to use as a new sequence.
 563        *
 564        *  Calls @c rdbuf()->str(s).
 565       */
 566       void
 567       str(const __string_type& __s)
 568       { _M_stringbuf.str(__s); }
 569     };
 570
 571 _GLIBCXX_END_NAMESPACE
 572
 573 #ifndef _GLIBCXX_EXPORT_TEMPLATE
 574 # include <bits/sstream.tcc>
 575 #endif
 576
 577 #endif /* _GLIBCXX_SSTREAM */