libcxx/include/streambuf

   1 // -*- C++ -*-
   2 //===----------------------------------------------------------------------===//
   3 //
   4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   5 // See https://llvm.org/LICENSE.txt for license information.
   6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef _LIBCPP_STREAMBUF
  11 #define _LIBCPP_STREAMBUF
  12
  13 /*
  14     streambuf synopsis
  15
  16 namespace std
  17 {
  18
  19 template <class charT, class traits = char_traits<charT> >
  20 class basic_streambuf
  21 {
  22 public:
  23     // types:
  24     typedef charT char_type;
  25     typedef traits traits_type;
  26     typedef typename traits_type::int_type int_type;
  27     typedef typename traits_type::pos_type pos_type;
  28     typedef typename traits_type::off_type off_type;
  29
  30     virtual ~basic_streambuf();
  31
  32     // 27.6.2.2.1 locales:
  33     locale pubimbue(const locale& loc);
  34     locale getloc() const;
  35
  36     // 27.6.2.2.2 buffer and positioning:
  37     basic_streambuf* pubsetbuf(char_type* s, streamsize n);
  38     pos_type pubseekoff(off_type off, ios_base::seekdir way,
  39                         ios_base::openmode which = ios_base::in | ios_base::out);
  40     pos_type pubseekpos(pos_type sp,
  41                         ios_base::openmode which = ios_base::in | ios_base::out);
  42     int pubsync();
  43
  44     // Get and put areas:
  45     // 27.6.2.2.3 Get area:
  46     streamsize in_avail();
  47     int_type snextc();
  48     int_type sbumpc();
  49     int_type sgetc();
  50     streamsize sgetn(char_type* s, streamsize n);
  51
  52     // 27.6.2.2.4 Putback:
  53     int_type sputbackc(char_type c);
  54     int_type sungetc();
  55
  56     // 27.6.2.2.5 Put area:
  57     int_type sputc(char_type c);
  58     streamsize sputn(const char_type* s, streamsize n);
  59
  60 protected:
  61     basic_streambuf();
  62     basic_streambuf(const basic_streambuf& rhs);
  63     basic_streambuf& operator=(const basic_streambuf& rhs);
  64     void swap(basic_streambuf& rhs);
  65
  66     // 27.6.2.3.2 Get area:
  67     char_type* eback() const;
  68     char_type* gptr() const;
  69     char_type* egptr() const;
  70     void gbump(int n);
  71     void setg(char_type* gbeg, char_type* gnext, char_type* gend);
  72
  73     // 27.6.2.3.3 Put area:
  74     char_type* pbase() const;
  75     char_type* pptr() const;
  76     char_type* epptr() const;
  77     void pbump(int n);
  78     void setp(char_type* pbeg, char_type* pend);
  79
  80     // 27.6.2.4 virtual functions:
  81     // 27.6.2.4.1 Locales:
  82     virtual void imbue(const locale& loc);
  83
  84     // 27.6.2.4.2 Buffer management and positioning:
  85     virtual basic_streambuf* setbuf(char_type* s, streamsize n);
  86     virtual pos_type seekoff(off_type off, ios_base::seekdir way,
  87                              ios_base::openmode which = ios_base::in | ios_base::out);
  88     virtual pos_type seekpos(pos_type sp,
  89                              ios_base::openmode which = ios_base::in | ios_base::out);
  90     virtual int sync();
  91
  92     // 27.6.2.4.3 Get area:
  93     virtual streamsize showmanyc();
  94     virtual streamsize xsgetn(char_type* s, streamsize n);
  95     virtual int_type underflow();
  96     virtual int_type uflow();
  97
  98     // 27.6.2.4.4 Putback:
  99     virtual int_type pbackfail(int_type c = traits_type::eof());
 100
 101     // 27.6.2.4.5 Put area:
 102     virtual streamsize xsputn(const char_type* s, streamsize n);
 103     virtual int_type overflow (int_type c = traits_type::eof());
 104 };
 105
 106 }  // std
 107
 108 */
 109
 110 #if __cplusplus < 201103L && defined(_LIBCPP_USE_FROZEN_CXX03_HEADERS)
 111 #  include <__cxx03/streambuf>
 112 #else
 113 #  include <__config>
 114
 115 #  if _LIBCPP_HAS_LOCALIZATION
 116
 117 #    include <__assert>
 118 #    include <__fwd/streambuf.h>
 119 #    include <__locale>
 120 #    include <__type_traits/is_same.h>
 121 #    include <__utility/is_valid_range.h>
 122 #    include <climits>
 123 #    include <ios>
 124 #    include <iosfwd>
 125 #    include <version>
 126
 127 #    if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
 128 #      pragma GCC system_header
 129 #    endif
 130
 131 _LIBCPP_PUSH_MACROS
 132 #    include <__undef_macros>
 133
 134 _LIBCPP_BEGIN_NAMESPACE_STD
 135
 136 template <class _CharT, class _Traits>
 137 class _LIBCPP_TEMPLATE_VIS basic_streambuf {
 138 public:
 139   // types:
 140   typedef _CharT char_type;
 141   typedef _Traits traits_type;
 142   typedef typename traits_type::int_type int_type;
 143   typedef typename traits_type::pos_type pos_type;
 144   typedef typename traits_type::off_type off_type;
 145
 146   static_assert(is_same<_CharT, typename traits_type::char_type>::value,
 147                 "traits_type::char_type must be the same type as CharT");
 148
 149   virtual ~basic_streambuf();
 150
 151   // 27.6.2.2.1 locales:
 152   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 locale pubimbue(const locale& __loc) {
 153     imbue(__loc);
 154     locale __r = __loc_;
 155     __loc_     = __loc;
 156     return __r;
 157   }
 158
 159   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 locale getloc() const { return __loc_; }
 160
 161   // 27.6.2.2.2 buffer and positioning:
 162   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 basic_streambuf* pubsetbuf(char_type* __s, streamsize __n) {
 163     return setbuf(__s, __n);
 164   }
 165
 166   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 pos_type
 167   pubseekoff(off_type __off, ios_base::seekdir __way, ios_base::openmode __which = ios_base::in | ios_base::out) {
 168     return seekoff(__off, __way, __which);
 169   }
 170
 171   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 pos_type
 172   pubseekpos(pos_type __sp, ios_base::openmode __which = ios_base::in | ios_base::out) {
 173     return seekpos(__sp, __which);
 174   }
 175
 176   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 int pubsync() { return sync(); }
 177
 178   // Get and put areas:
 179   // 27.6.2.2.3 Get area:
 180   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 streamsize in_avail() {
 181     if (__ninp_ < __einp_)
 182       return static_cast<streamsize>(__einp_ - __ninp_);
 183     return showmanyc();
 184   }
 185
 186   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 int_type snextc() {
 187     if (sbumpc() == traits_type::eof())
 188       return traits_type::eof();
 189     return sgetc();
 190   }
 191
 192   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 int_type sbumpc() {
 193     if (__ninp_ == __einp_)
 194       return uflow();
 195     return traits_type::to_int_type(*__ninp_++);
 196   }
 197
 198   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 int_type sgetc() {
 199     if (__ninp_ == __einp_)
 200       return underflow();
 201     return traits_type::to_int_type(*__ninp_);
 202   }
 203
 204   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 streamsize sgetn(char_type* __s, streamsize __n) { return xsgetn(__s, __n); }
 205
 206   // 27.6.2.2.4 Putback:
 207   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 int_type sputbackc(char_type __c) {
 208     if (__binp_ == __ninp_ || !traits_type::eq(__c, __ninp_[-1]))
 209       return pbackfail(traits_type::to_int_type(__c));
 210     return traits_type::to_int_type(*--__ninp_);
 211   }
 212
 213   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 int_type sungetc() {
 214     if (__binp_ == __ninp_)
 215       return pbackfail();
 216     return traits_type::to_int_type(*--__ninp_);
 217   }
 218
 219   // 27.6.2.2.5 Put area:
 220   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 int_type sputc(char_type __c) {
 221     if (__nout_ == __eout_)
 222       return overflow(traits_type::to_int_type(__c));
 223     *__nout_++ = __c;
 224     return traits_type::to_int_type(__c);
 225   }
 226
 227   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 streamsize sputn(const char_type* __s, streamsize __n) {
 228     return xsputn(__s, __n);
 229   }
 230
 231 protected:
 232   basic_streambuf();
 233   basic_streambuf(const basic_streambuf& __rhs);
 234   basic_streambuf& operator=(const basic_streambuf& __rhs);
 235   void swap(basic_streambuf& __rhs);
 236
 237   // 27.6.2.3.2 Get area:
 238   _LIBCPP_HIDE_FROM_ABI char_type* eback() const { return __binp_; }
 239   _LIBCPP_HIDE_FROM_ABI char_type* gptr() const { return __ninp_; }
 240   _LIBCPP_HIDE_FROM_ABI char_type* egptr() const { return __einp_; }
 241
 242   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 void gbump(int __n) { __ninp_ += __n; }
 243
 244   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 void setg(char_type* __gbeg, char_type* __gnext, char_type* __gend) {
 245     _LIBCPP_ASSERT_VALID_INPUT_RANGE(std::__is_valid_range(__gbeg, __gnext), "[gbeg, gnext) must be a valid range");
 246     _LIBCPP_ASSERT_VALID_INPUT_RANGE(std::__is_valid_range(__gbeg, __gend), "[gbeg, gend) must be a valid range");
 247     _LIBCPP_ASSERT_VALID_INPUT_RANGE(std::__is_valid_range(__gnext, __gend), "[gnext, gend) must be a valid range");
 248     __binp_ = __gbeg;
 249     __ninp_ = __gnext;
 250     __einp_ = __gend;
 251   }
 252
 253   // 27.6.2.3.3 Put area:
 254   _LIBCPP_HIDE_FROM_ABI char_type* pbase() const { return __bout_; }
 255   _LIBCPP_HIDE_FROM_ABI char_type* pptr() const { return __nout_; }
 256   _LIBCPP_HIDE_FROM_ABI char_type* epptr() const { return __eout_; }
 257
 258   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 void pbump(int __n) { __nout_ += __n; }
 259
 260   _LIBCPP_HIDE_FROM_ABI void __pbump(streamsize __n) { __nout_ += __n; }
 261
 262   inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1 void setp(char_type* __pbeg, char_type* __pend) {
 263     _LIBCPP_ASSERT_VALID_INPUT_RANGE(std::__is_valid_range(__pbeg, __pend), "[pbeg, pend) must be a valid range");
 264     __bout_ = __nout_ = __pbeg;
 265     __eout_           = __pend;
 266   }
 267
 268   // 27.6.2.4 virtual functions:
 269   // 27.6.2.4.1 Locales:
 270   virtual void imbue(const locale& __loc);
 271
 272   // 27.6.2.4.2 Buffer management and positioning:
 273   virtual basic_streambuf* setbuf(char_type* __s, streamsize __n);
 274   virtual pos_type
 275   seekoff(off_type __off, ios_base::seekdir __way, ios_base::openmode __which = ios_base::in | ios_base::out);
 276   virtual pos_type seekpos(pos_type __sp, ios_base::openmode __which = ios_base::in | ios_base::out);
 277   virtual int sync();
 278
 279   // 27.6.2.4.3 Get area:
 280   virtual streamsize showmanyc();
 281   virtual streamsize xsgetn(char_type* __s, streamsize __n);
 282   virtual int_type underflow();
 283   virtual int_type uflow();
 284
 285   // 27.6.2.4.4 Putback:
 286   virtual int_type pbackfail(int_type __c = traits_type::eof());
 287
 288   // 27.6.2.4.5 Put area:
 289   virtual streamsize xsputn(const char_type* __s, streamsize __n);
 290   virtual int_type overflow(int_type __c = traits_type::eof());
 291
 292 private:
 293   locale __loc_;
 294   char_type* __binp_;
 295   char_type* __ninp_;
 296   char_type* __einp_;
 297   char_type* __bout_;
 298   char_type* __nout_;
 299   char_type* __eout_;
 300 };
 301
 302 template <class _CharT, class _Traits>
 303 basic_streambuf<_CharT, _Traits>::~basic_streambuf() {}
 304
 305 template <class _CharT, class _Traits>
 306 basic_streambuf<_CharT, _Traits>::basic_streambuf()
 307     : __binp_(nullptr), __ninp_(nullptr), __einp_(nullptr), __bout_(nullptr), __nout_(nullptr), __eout_(nullptr) {}
 308
 309 template <class _CharT, class _Traits>
 310 basic_streambuf<_CharT, _Traits>::basic_streambuf(const basic_streambuf& __sb)
 311     : __loc_(__sb.__loc_),
 312       __binp_(__sb.__binp_),
 313       __ninp_(__sb.__ninp_),
 314       __einp_(__sb.__einp_),
 315       __bout_(__sb.__bout_),
 316       __nout_(__sb.__nout_),
 317       __eout_(__sb.__eout_) {}
 318
 319 template <class _CharT, class _Traits>
 320 basic_streambuf<_CharT, _Traits>& basic_streambuf<_CharT, _Traits>::operator=(const basic_streambuf& __sb) {
 321   __loc_  = __sb.__loc_;
 322   __binp_ = __sb.__binp_;
 323   __ninp_ = __sb.__ninp_;
 324   __einp_ = __sb.__einp_;
 325   __bout_ = __sb.__bout_;
 326   __nout_ = __sb.__nout_;
 327   __eout_ = __sb.__eout_;
 328   return *this;
 329 }
 330
 331 template <class _CharT, class _Traits>
 332 void basic_streambuf<_CharT, _Traits>::swap(basic_streambuf& __sb) {
 333   std::swap(__loc_, __sb.__loc_);
 334   std::swap(__binp_, __sb.__binp_);
 335   std::swap(__ninp_, __sb.__ninp_);
 336   std::swap(__einp_, __sb.__einp_);
 337   std::swap(__bout_, __sb.__bout_);
 338   std::swap(__nout_, __sb.__nout_);
 339   std::swap(__eout_, __sb.__eout_);
 340 }
 341
 342 template <class _CharT, class _Traits>
 343 void basic_streambuf<_CharT, _Traits>::imbue(const locale&) {}
 344
 345 template <class _CharT, class _Traits>
 346 basic_streambuf<_CharT, _Traits>* basic_streambuf<_CharT, _Traits>::setbuf(char_type*, streamsize) {
 347   return this;
 348 }
 349
 350 template <class _CharT, class _Traits>
 351 typename basic_streambuf<_CharT, _Traits>::pos_type
 352 basic_streambuf<_CharT, _Traits>::seekoff(off_type, ios_base::seekdir, ios_base::openmode) {
 353   return pos_type(off_type(-1));
 354 }
 355
 356 template <class _CharT, class _Traits>
 357 typename basic_streambuf<_CharT, _Traits>::pos_type
 358 basic_streambuf<_CharT, _Traits>::seekpos(pos_type, ios_base::openmode) {
 359   return pos_type(off_type(-1));
 360 }
 361
 362 template <class _CharT, class _Traits>
 363 int basic_streambuf<_CharT, _Traits>::sync() {
 364   return 0;
 365 }
 366
 367 template <class _CharT, class _Traits>
 368 streamsize basic_streambuf<_CharT, _Traits>::showmanyc() {
 369   return 0;
 370 }
 371
 372 template <class _CharT, class _Traits>
 373 streamsize basic_streambuf<_CharT, _Traits>::xsgetn(char_type* __s, streamsize __n) {
 374   const int_type __eof = traits_type::eof();
 375   int_type __c;
 376   streamsize __i = 0;
 377   while (__i < __n) {
 378     if (__ninp_ < __einp_) {
 379       const streamsize __len = std::min(static_cast<streamsize>(INT_MAX), std::min(__einp_ - __ninp_, __n - __i));
 380       traits_type::copy(__s, __ninp_, __len);
 381       __s += __len;
 382       __i += __len;
 383       this->gbump(__len);
 384     } else if ((__c = uflow()) != __eof) {
 385       *__s = traits_type::to_char_type(__c);
 386       ++__s;
 387       ++__i;
 388     } else
 389       break;
 390   }
 391   return __i;
 392 }
 393
 394 template <class _CharT, class _Traits>
 395 typename basic_streambuf<_CharT, _Traits>::int_type basic_streambuf<_CharT, _Traits>::underflow() {
 396   return traits_type::eof();
 397 }
 398
 399 template <class _CharT, class _Traits>
 400 typename basic_streambuf<_CharT, _Traits>::int_type basic_streambuf<_CharT, _Traits>::uflow() {
 401   if (underflow() == traits_type::eof())
 402     return traits_type::eof();
 403   return traits_type::to_int_type(*__ninp_++);
 404 }
 405
 406 template <class _CharT, class _Traits>
 407 typename basic_streambuf<_CharT, _Traits>::int_type basic_streambuf<_CharT, _Traits>::pbackfail(int_type) {
 408   return traits_type::eof();
 409 }
 410
 411 template <class _CharT, class _Traits>
 412 streamsize basic_streambuf<_CharT, _Traits>::xsputn(const char_type* __s, streamsize __n) {
 413   streamsize __i = 0;
 414   int_type __eof = traits_type::eof();
 415   while (__i < __n) {
 416     if (__nout_ >= __eout_) {
 417       if (overflow(traits_type::to_int_type(*__s)) == __eof)
 418         break;
 419       ++__s;
 420       ++__i;
 421     } else {
 422       streamsize __chunk_size = std::min(__eout_ - __nout_, __n - __i);
 423       traits_type::copy(__nout_, __s, __chunk_size);
 424       __nout_ += __chunk_size;
 425       __s += __chunk_size;
 426       __i += __chunk_size;
 427     }
 428   }
 429   return __i;
 430 }
 431
 432 template <class _CharT, class _Traits>
 433 typename basic_streambuf<_CharT, _Traits>::int_type basic_streambuf<_CharT, _Traits>::overflow(int_type) {
 434   return traits_type::eof();
 435 }
 436
 437 extern template class _LIBCPP_EXTERN_TEMPLATE_TYPE_VIS basic_streambuf<char>;
 438
 439 #    if _LIBCPP_HAS_WIDE_CHARACTERS
 440 extern template class _LIBCPP_EXTERN_TEMPLATE_TYPE_VIS basic_streambuf<wchar_t>;
 441 #    endif
 442
 443 _LIBCPP_END_NAMESPACE_STD
 444
 445 _LIBCPP_POP_MACROS
 446
 447 #  endif // _LIBCPP_HAS_LOCALIZATION
 448
 449 #  if !defined(_LIBCPP_REMOVE_TRANSITIVE_INCLUDES) && _LIBCPP_STD_VER <= 20
 450 #    include <cstdint>
 451 #  endif
 452 #endif // __cplusplus < 201103L && defined(_LIBCPP_USE_FROZEN_CXX03_HEADERS)
 453
 454 #endif // _LIBCPP_STREAMBUF