std::basic_stringbuf(3) | Library Functions Manual | std::basic_stringbuf(3) |
NAME¶
std::basic_stringbuf -
The actual work of input and output (for std::string).
This class associates either or both of its input and output sequences with a sequence of characters, which can be initialized from, or made available as, a std::basic_string. (Paraphrased from [27.7.1]/1.).
SYNOPSIS¶
Inherits std::basic_streambuf< _CharT, _Traits >.
Public Types¶
typedef __string_type::size_type __size_type
typedef basic_streambuf< char_type, traits_type >
__streambuf_type
typedef basic_string< char_type, _Traits, _Alloc >
__string_type
typedef _Alloc allocator_type
typedef _CharT char_type
typedef traits_type::int_type int_type
typedef traits_type::off_type off_type
typedef traits_type::pos_type pos_type
typedef _Traits traits_type
Public Member Functions¶
basic_stringbuf (const __string_type &__str,
ios_base::openmode __mode=ios_base::in|ios_base::out)
basic_stringbuf (ios_base::openmode
__mode=ios_base::in|ios_base::out)
streamsize in_avail ()
int_type sbumpc ()
int_type sgetc ()
streamsize sgetn (char_type *__s, streamsize __n)
int_type snextc ()
int_type sputbackc (char_type __c)
int_type sputc (char_type __c)
streamsize sputn (const char_type *__s, streamsize
__n)
void stossc ()
void str (const __string_type &__s)
__string_type str () const
int_type sungetc ()
Protected Member Functions¶
void _M_stringbuf_init (ios_base::openmode __mode)
void _M_sync (char_type *__base, __size_type __i, __size_type
__o)
void _M_update_egptr ()
void gbump (int __n)
virtual void imbue (const locale &)
virtual int_type overflow (int_type
__c=traits_type::eof())
virtual int_type pbackfail (int_type
__c=traits_type::eof())
void pbump (int __n)
virtual pos_type seekoff (off_type __off,
ios_base::seekdir __way, ios_base::openmode
__mode=ios_base::in|ios_base::out)
virtual pos_type seekpos (pos_type __sp,
ios_base::openmode __mode=ios_base::in|ios_base::out)
virtual __streambuf_type * setbuf (char_type *__s,
streamsize __n)
void setg (char_type *__gbeg, char_type *__gnext,
char_type *__gend)
void setp (char_type *__pbeg, char_type *__pend)
virtual streamsize showmanyc ()
virtual int sync ()
virtual int_type uflow ()
virtual int_type underflow ()
virtual streamsize xsgetn (char_type *__s,
streamsize __n)
virtual streamsize xsputn (const char_type *__s,
streamsize __n)
Protected Attributes¶
ios_base::openmode _M_mode
__string_type _M_string
Friends¶
template<bool _IsMove, typename _CharT2 >
__gnu_cxx::__enable_if< __is_char< _CharT2 >::__value, _CharT2 *
>::__type __copy_move_a2 (istreambuf_iterator< _CharT2
>, istreambuf_iterator< _CharT2 >, _CharT2 *)
streamsize __copy_streambufs_eof (__streambuf_type *,
__streambuf_type *, bool &)
class basic_ios< char_type, traits_type >
class basic_istream< char_type, traits_type >
class basic_ostream< char_type, traits_type >
template<typename _CharT2 > __gnu_cxx::__enable_if< __is_char<
_CharT2 >::__value, istreambuf_iterator< _CharT2 >
>::__type find (istreambuf_iterator< _CharT2 >,
istreambuf_iterator< _CharT2 >, const _CharT2 &)
template<typename _CharT2 , typename _Traits2 , typename _Alloc >
basic_istream< _CharT2, _Traits2 > & getline
(basic_istream< _CharT2, _Traits2 > &,
basic_string< _CharT2, _Traits2, _Alloc > &, _CharT2)
class istreambuf_iterator< char_type, traits_type >
template<typename _CharT2 , typename _Traits2 , typename _Alloc >
basic_istream< _CharT2, _Traits2 > &
operator>> (basic_istream< _CharT2, _Traits2 >
&, basic_string< _CharT2, _Traits2, _Alloc > &)
template<typename _CharT2 , typename _Traits2 > basic_istream<
_CharT2, _Traits2 > & operator>>
(basic_istream< _CharT2, _Traits2 > &, _CharT2 *)
class ostreambuf_iterator< char_type, traits_type >
locale _M_buf_locale
char_type * _M_in_beg
char_type * _M_in_cur
char_type * _M_in_end
char_type * _M_out_beg
char_type * _M_out_cur
char_type * _M_out_end
locale getloc () const
locale pubimbue (const locale &__loc)
pos_type pubseekoff (off_type __off,
ios_base::seekdir __way, ios_base::openmode
__mode=ios_base::in|ios_base::out)
pos_type pubseekpos (pos_type __sp,
ios_base::openmode __mode=ios_base::in|ios_base::out)
__streambuf_type * pubsetbuf (char_type *__s,
streamsize __n)
int pubsync ()
char_type * eback () const
char_type * egptr () const
char_type * epptr () const
char_type * gptr () const
char_type * pbase () const
char_type * pptr () const
Detailed Description¶
template<typename _CharT, typename _Traits, typename _Alloc> class std::basic_stringbuf< _CharT, _Traits, _Alloc >¶
The actual work of input and output (for std::string).
This class associates either or both of its input and output sequences with a sequence of characters, which can be initialized from, or made available as, a std::basic_string. (Paraphrased from [27.7.1]/1.).
For this class, open modes (of type ios_base::openmode) have in set if the input sequence can be read, and out set if the output sequence can be written.
Definition at line 58 of file sstream.
Member Typedef Documentation¶
template<typename _CharT, typename _Traits, typename _Alloc> typedef basic_streambuf<char_type, traits_type> std::basic_stringbuf< _CharT, _Traits, _Alloc >::__streambuf_type¶
This is a non-standard type.
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 71 of file sstream.
template<typename _CharT, typename _Traits, typename _Alloc> typedef _CharT std::basic_stringbuf< _CharT, _Traits, _Alloc >::char_type These are standard types. They permit a standardized way of referring to names of (or names dependant on) the template parameters, which are specific to the implementation.¶
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 62 of file sstream.
template<typename _CharT, typename _Traits, typename _Alloc> typedef traits_type::int_type std::basic_stringbuf< _CharT, _Traits, _Alloc >::int_type¶
This is a non-standard type.
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 67 of file sstream.
template<typename _CharT, typename _Traits, typename _Alloc> typedef traits_type::off_type std::basic_stringbuf< _CharT, _Traits, _Alloc >::off_type¶
This is a non-standard type.
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 69 of file sstream.
template<typename _CharT, typename _Traits, typename _Alloc> typedef traits_type::pos_type std::basic_stringbuf< _CharT, _Traits, _Alloc >::pos_type¶
This is a non-standard type.
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 68 of file sstream.
template<typename _CharT, typename _Traits, typename _Alloc> typedef _Traits std::basic_stringbuf< _CharT, _Traits, _Alloc >::traits_type¶
This is a non-standard type.
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 63 of file sstream.
Constructor & Destructor Documentation¶
template<typename _CharT, typename _Traits, typename _Alloc> std::basic_stringbuf< _CharT, _Traits, _Alloc >::basic_stringbuf (ios_base::openmode __mode = ios_base::in | ios_base::out) [inline, explicit]¶
Starts with an empty string buffer. Parameters:
The default constructor initializes the parent class using its own default ctor.
Definition at line 92 of file sstream.
template<typename _CharT, typename _Traits, typename _Alloc> std::basic_stringbuf< _CharT, _Traits, _Alloc >::basic_stringbuf (const __string_type & __str, ios_base::openmode __mode = ios_base::in | ios_base::out) [inline, explicit]¶
Starts with an existing string buffer. Parameters:
mode Whether the buffer can read, or write, or both.
This constructor initializes the parent class using its own default ctor.
Definition at line 105 of file sstream.
Member Function Documentation¶
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::eback () const [inline, protected, inherited]¶
Access to the get area. These functions are only available to other protected functions, including derived classes.
- eback() returns the beginning pointer for the input sequence
- gptr() returns the next pointer for the input sequence
- egptr() returns the end pointer for the input sequence
Definition at line 458 of file streambuf.
Referenced by std::basic_filebuf< _CharT, _Traits >::imbue(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow(), std::basic_filebuf< _CharT, _Traits >::pbackfail(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_filebuf< _CharT, _Traits >::seekoff(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos(), std::basic_filebuf< _CharT, _Traits >::underflow(), and std::basic_filebuf< _CharT, _Traits >::xsgetn().
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::egptr () const [inline, protected, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 464 of file streambuf.
Referenced by std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_filebuf< _CharT, _Traits >::seekoff(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos(), std::basic_filebuf< _CharT, _Traits >::showmanyc(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::underflow(), std::basic_filebuf< _CharT, _Traits >::underflow(), and std::basic_filebuf< _CharT, _Traits >::xsgetn().
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::epptr () const [inline, protected, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 511 of file streambuf.
Referenced by std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow(), std::basic_streambuf< _CharT, _Traits >::xsputn(), and std::basic_filebuf< _CharT, _Traits >::xsputn().
template<typename _CharT, typename _Traits> void std::basic_streambuf< _CharT, _Traits >::gbump (int __n) [inline, protected, inherited]¶
Moving the read position. Parameters:
This just advances the read position without returning any data.
Definition at line 474 of file streambuf.
Referenced by std::basic_filebuf< _CharT, _Traits >::pbackfail(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos(), and std::basic_filebuf< _CharT, _Traits >::xsgetn().
template<typename _CharT, typename _Traits> locale std::basic_streambuf< _CharT, _Traits >::getloc () const [inline, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 221 of file streambuf.
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::gptr () const [inline, protected, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 461 of file streambuf.
Referenced by std::basic_filebuf< _CharT, _Traits >::imbue(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow(), std::basic_filebuf< _CharT, _Traits >::pbackfail(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_filebuf< _CharT, _Traits >::seekoff(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos(), std::basic_filebuf< _CharT, _Traits >::showmanyc(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::underflow(), std::basic_filebuf< _CharT, _Traits >::underflow(), and std::basic_filebuf< _CharT, _Traits >::xsgetn().
template<typename _CharT, typename _Traits> virtual void std::basic_streambuf< _CharT, _Traits >::imbue (const locale &) [inline, protected, virtual, inherited]¶
Changes translations. Parameters:
Translations done during I/O which depend on the current locale are changed by this call. The standard adds, Between invocations of this function a class derived from streambuf can safely cache results of calls to locale functions and to members of facets so obtained.
Note:
Reimplemented in std::basic_filebuf< _CharT, _Traits >, std::basic_filebuf< _CharT, encoding_char_traits< _CharT > >, and std::basic_filebuf< char_type, traits_type >.
Definition at line 552 of file streambuf.
template<typename _CharT, typename _Traits> streamsize std::basic_streambuf< _CharT, _Traits >::in_avail () [inline, inherited]¶
Looking ahead into the stream. Returns:
If a read position is available, returns the number of characters available for reading before the buffer must be refilled. Otherwise returns the derived showmanyc().
Definition at line 261 of file streambuf.
template<class _CharT , class _Traits , class _Alloc > basic_stringbuf< _CharT, _Traits, _Alloc >::int_type std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow (int_type = traits_type::eof()) [inline, protected, virtual]¶
Consumes data from the buffer; writes to the controlled sequence. Parameters:
Returns:
Informally, this function is called when the output buffer is full (or does not exist, as buffering need not actually be done). If a buffer exists, it is 'consumed', with 'some effect' on the controlled sequence. (Typically, the buffer is written out to the sequence verbatim.) In either case, the character c is also written out, if c is not eof().
For a formal definition of this function, see a good text such as Langer & Kreft, or [27.5.2.4.5]/3-7.
A functioning output streambuf can be created by overriding only this function (no buffer area will be used).
Note:
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 80 of file sstream.tcc.
References std::basic_stringbuf< _CharT, _Traits, _Alloc >::_M_mode, std::basic_string< _CharT, _Traits, _Alloc >::assign(), std::basic_string< _CharT, _Traits, _Alloc >::capacity(), std::basic_string< _CharT, _Traits, _Alloc >::data(), std::basic_streambuf< _CharT, _Traits >::eback(), std::basic_streambuf< _CharT, _Traits >::epptr(), std::basic_streambuf< _CharT, _Traits >::gptr(), std::max(), std::basic_string< _CharT, _Traits, _Alloc >::max_size(), std::min(), std::ios_base::out, std::basic_streambuf< _CharT, _Traits >::pbase(), std::basic_streambuf< _CharT, _Traits >::pbump(), std::basic_streambuf< _CharT, _Traits >::pptr(), std::basic_string< _CharT, _Traits, _Alloc >::push_back(), std::basic_string< _CharT, _Traits, _Alloc >::reserve(), and std::basic_string< _CharT, _Traits, _Alloc >::swap().
template<class _CharT , class _Traits , class _Alloc > basic_stringbuf< _CharT, _Traits, _Alloc >::int_type std::basic_stringbuf< _CharT, _Traits, _Alloc >::pbackfail (int_type = traits_type::eof()) [inline, protected, virtual]¶
Tries to back up the input sequence. Parameters:
Returns:
Postcondition:
Note:
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 46 of file sstream.tcc.
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::pbase () const [inline, protected, inherited]¶
Access to the put area. These functions are only available to other protected functions, including derived classes.
- pbase() returns the beginning pointer for the output sequence
- pptr() returns the next pointer for the output sequence
- epptr() returns the end pointer for the output sequence
Definition at line 505 of file streambuf.
Referenced by std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow(), std::basic_filebuf< _CharT, _Traits >::overflow(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos(), std::basic_filebuf< _CharT, _Traits >::sync(), and std::basic_filebuf< _CharT, _Traits >::xsputn().
template<typename _CharT, typename _Traits> void std::basic_streambuf< _CharT, _Traits >::pbump (int __n) [inline, protected, inherited]¶
Moving the write position. Parameters:
This just advances the write position without returning any data.
Definition at line 521 of file streambuf.
Referenced by std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow(), std::basic_filebuf< _CharT, _Traits >::overflow(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos(), and std::basic_streambuf< _CharT, _Traits >::xsputn().
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::pptr () const [inline, protected, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 508 of file streambuf.
Referenced by std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow(), std::basic_filebuf< _CharT, _Traits >::overflow(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos(), std::basic_filebuf< _CharT, _Traits >::sync(), std::basic_streambuf< _CharT, _Traits >::xsputn(), and std::basic_filebuf< _CharT, _Traits >::xsputn().
template<typename _CharT, typename _Traits> locale std::basic_streambuf< _CharT, _Traits >::pubimbue (const locale & __loc) [inline, inherited]¶
Entry point for imbue(). Parameters:
Returns:
Calls the derived imbue(loc).
Definition at line 204 of file streambuf.
template<typename _CharT, typename _Traits> pos_type std::basic_streambuf< _CharT, _Traits >::pubseekoff (off_type __off, ios_base::seekdir __way, ios_base::openmode __mode = ios_base::in | ios_base::out) [inline, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 238 of file streambuf.
template<typename _CharT, typename _Traits> pos_type std::basic_streambuf< _CharT, _Traits >::pubseekpos (pos_type __sp, ios_base::openmode __mode = ios_base::in | ios_base::out) [inline, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 243 of file streambuf.
template<typename _CharT, typename _Traits> __streambuf_type* std::basic_streambuf< _CharT, _Traits >::pubsetbuf (char_type * __s, streamsize __n) [inline, inherited]¶
Entry points for derived buffer functions. The public versions of pubfoo dispatch to the protected derived foo member functions, passing the arguments (if any) and returning the result unchanged.
Definition at line 234 of file streambuf.
template<typename _CharT, typename _Traits> int std::basic_streambuf< _CharT, _Traits >::pubsync () [inline, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 248 of file streambuf.
Referenced by std::basic_istream< _CharT, _Traits >::sync().
template<typename _CharT, typename _Traits> int_type std::basic_streambuf< _CharT, _Traits >::sbumpc () [inline, inherited]¶
Getting the next character. Returns:
If the input read position is available, returns that character and increments the read pointer, otherwise calls and returns uflow().
Definition at line 293 of file streambuf.
Referenced by std::basic_istream< _CharT, _Traits >::getline(), std::basic_istream< _CharT, _Traits >::ignore(), and std::istreambuf_iterator< _CharT, _Traits >::operator++().
template<class _CharT , class _Traits , class _Alloc > basic_stringbuf< _CharT, _Traits, _Alloc >::pos_type std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff (off_type, ios_base::seekdir, ios_base::openmode = ios_base::in | ios_base::out) [inline, protected, virtual]¶
Alters the stream positions. Each derived class provides its own appropriate behavior.
Note:
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 149 of file sstream.tcc.
References std::basic_stringbuf< _CharT, _Traits, _Alloc >::_M_mode, std::ios_base::cur, std::basic_streambuf< _CharT, _Traits >::eback(), std::basic_streambuf< _CharT, _Traits >::egptr(), std::ios_base::end, std::basic_streambuf< _CharT, _Traits >::gbump(), std::basic_streambuf< _CharT, _Traits >::gptr(), std::ios_base::in, std::ios_base::out, std::basic_streambuf< _CharT, _Traits >::pbase(), std::basic_streambuf< _CharT, _Traits >::pbump(), and std::basic_streambuf< _CharT, _Traits >::pptr().
template<class _CharT , class _Traits , class _Alloc > basic_stringbuf< _CharT, _Traits, _Alloc >::pos_type std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos (pos_type, ios_base::openmode = ios_base::in | ios_base::out) [inline, protected, virtual]¶
Alters the stream positions. Each derived class provides its own appropriate behavior.
Note:
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 196 of file sstream.tcc.
References std::basic_stringbuf< _CharT, _Traits, _Alloc >::_M_mode, std::basic_streambuf< _CharT, _Traits >::eback(), std::basic_streambuf< _CharT, _Traits >::egptr(), std::basic_streambuf< _CharT, _Traits >::gbump(), std::basic_streambuf< _CharT, _Traits >::gptr(), std::ios_base::in, std::ios_base::out, std::basic_streambuf< _CharT, _Traits >::pbase(), std::basic_streambuf< _CharT, _Traits >::pbump(), and std::basic_streambuf< _CharT, _Traits >::pptr().
template<typename _CharT, typename _Traits, typename _Alloc> virtual __streambuf_type* std::basic_stringbuf< _CharT, _Traits, _Alloc >::setbuf (char_type * __s, streamsize __n) [inline, protected, virtual]¶
Manipulates the buffer. Parameters:
n Size of s.
Returns:
If no buffer has already been created, and both s and n are non-zero, then s is used as a buffer; see http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch25s02.html for more.
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 196 of file sstream.
References std::basic_string< _CharT, _Traits, _Alloc >::clear().
template<typename _CharT, typename _Traits> void std::basic_streambuf< _CharT, _Traits >::setg (char_type * __gbeg, char_type * __gnext, char_type * __gend) [inline, protected, inherited]¶
Setting the three read area pointers. Parameters:
gnext A pointer.
gend A pointer.
Postcondition:
Definition at line 485 of file streambuf.
template<typename _CharT, typename _Traits> void std::basic_streambuf< _CharT, _Traits >::setp (char_type * __pbeg, char_type * __pend) [inline, protected, inherited]¶
Setting the three write area pointers. Parameters:
pend A pointer.
Postcondition:
Definition at line 531 of file streambuf.
template<typename _CharT, typename _Traits> int_type std::basic_streambuf< _CharT, _Traits >::sgetc () [inline, inherited]¶
Getting the next character. Returns:
If the input read position is available, returns that character, otherwise calls and returns underflow(). Does not move the read position after fetching the character.
Definition at line 315 of file streambuf.
Referenced by std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::getline(), std::basic_istream< _CharT, _Traits >::ignore(), and std::basic_istream< _CharT, _Traits >::sentry::sentry().
template<typename _CharT, typename _Traits> streamsize std::basic_streambuf< _CharT, _Traits >::sgetn (char_type * __s, streamsize __n) [inline, inherited]¶
Entry point for xsgetn. Parameters:
n A count.
Returns xsgetn(s,n). The effect is to fill s[0] through s[n-1] with characters from the input sequence, if possible.
Definition at line 334 of file streambuf.
template<typename _CharT, typename _Traits, typename _Alloc> virtual streamsize std::basic_stringbuf< _CharT, _Traits, _Alloc >::showmanyc () [inline, protected, virtual]¶
Investigating the data available. Returns:
If it returns a positive value, then successive calls to underflow() will not return traits::eof() until at least that number of characters have been supplied. If showmanyc() returns -1, then calls to underflow() or uflow() will fail. [27.5.2.4.3]/1
Note:
The standard adds that the intention is not only that the calls [to underflow or uflow] will not return eof() but that they will return 'immediately'.
The standard adds that 'the morphemes of @c showmanyc are
'es-how-many-see', not 'show-manic.
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 164 of file sstream.
template<typename _CharT, typename _Traits> int_type std::basic_streambuf< _CharT, _Traits >::snextc () [inline, inherited]¶
Getting the next character. Returns:
Calls sbumpc(), and if that function returns traits::eof(), so does this function. Otherwise, sgetc().
Definition at line 275 of file streambuf.
Referenced by std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::getline(), std::basic_istream< _CharT, _Traits >::ignore(), and std::basic_istream< _CharT, _Traits >::sentry::sentry().
template<typename _CharT, typename _Traits> int_type std::basic_streambuf< _CharT, _Traits >::sputbackc (char_type __c) [inline, inherited]¶
Pushing characters back into the input stream. Parameters:
Returns:
Similar to sungetc(), but c is pushed onto the stream instead of 'the previous character'. If successful, the next character fetched from the input stream will be c.
Definition at line 348 of file streambuf.
Referenced by std::basic_istream< _CharT, _Traits >::putback().
template<typename _CharT, typename _Traits> int_type std::basic_streambuf< _CharT, _Traits >::sputc (char_type __c) [inline, inherited]¶
Entry point for all single-character output functions. Parameters:
Returns:
One of two public output functions.
If a write position is available for the output sequence (i.e., the buffer is not full), stores c in that position, increments the position, and returns traits::to_int_type(c). If a write position is not available, returns overflow(c).
Definition at line 400 of file streambuf.
Referenced by std::basic_istream< _CharT, _Traits >::get(), and std::ostreambuf_iterator< _CharT, _Traits >::operator=().
template<typename _CharT, typename _Traits> streamsize std::basic_streambuf< _CharT, _Traits >::sputn (const char_type * __s, streamsize __n) [inline, inherited]¶
Entry point for all single-character output functions. Parameters:
n A count.
One of two public output functions.
Returns xsputn(s,n). The effect is to write s[0] through s[n-1] to the output sequence, if possible.
Definition at line 426 of file streambuf.
template<typename _CharT, typename _Traits> void std::basic_streambuf< _CharT, _Traits >::stossc () [inline, inherited]¶
Tosses a character. Advances the read pointer, ignoring the character that would have been read.
See http://gcc.gnu.org/ml/libstdc++/2002-05/msg00168.html
Definition at line 758 of file streambuf.
template<typename _CharT, typename _Traits, typename _Alloc> void std::basic_stringbuf< _CharT, _Traits, _Alloc >::str (const __string_type & __s) [inline]¶
Setting a new buffer. Parameters:
Deallocates any previous stored sequence, then copies s to use as a new one.
Definition at line 144 of file sstream.
References std::basic_string< _CharT, _Traits, _Alloc >::assign(), std::basic_string< _CharT, _Traits, _Alloc >::data(), and std::basic_string< _CharT, _Traits, _Alloc >::size().
template<typename _CharT, typename _Traits, typename _Alloc> __string_type std::basic_stringbuf< _CharT, _Traits, _Alloc >::str () const [inline]¶
Copying out the string buffer. Returns:
If the buffer is only created in input mode, the underlying character sequence is equal to the input sequence; otherwise, it is equal to the output sequence. [27.7.1.2]/1
Definition at line 120 of file sstream.
template<typename _CharT, typename _Traits> int_type std::basic_streambuf< _CharT, _Traits >::sungetc () [inline, inherited]¶
Moving backwards in the input stream. Returns:
If a putback position is available, this function decrements the input pointer and returns that character. Otherwise, calls and returns pbackfail(). The effect is to 'unget' the last character 'gotten'.
Definition at line 373 of file streambuf.
Referenced by std::basic_istream< _CharT, _Traits >::unget().
template<typename _CharT, typename _Traits> virtual int std::basic_streambuf< _CharT, _Traits >::sync (void) [inline, protected, virtual, inherited]¶
Synchronizes the buffer arrays with the controlled sequences. Returns:
Each derived class provides its own appropriate behavior, including the definition of 'failure'.
Note:
Reimplemented in std::basic_filebuf< _CharT, _Traits >, __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >, std::basic_filebuf< _CharT, encoding_char_traits< _CharT > >, and std::basic_filebuf< char_type, traits_type >.
Definition at line 603 of file streambuf.
template<typename _CharT, typename _Traits> virtual int_type std::basic_streambuf< _CharT, _Traits >::uflow () [inline, protected, virtual, inherited]¶
Fetches more data from the controlled sequence. Returns:
Informally, this function does the same thing as underflow(), and in fact is required to call that function. It also returns the new character, like underflow() does. However, this function also moves the read position forward by one.
Reimplemented in __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >.
Definition at line 676 of file streambuf.
template<class _CharT , class _Traits , class _Alloc > basic_stringbuf< _CharT, _Traits, _Alloc >::int_type std::basic_stringbuf< _CharT, _Traits, _Alloc >::underflow () [inline, protected, virtual]¶
Fetches more data from the controlled sequence. Returns:
Informally, this function is called when the input buffer is exhausted (or does not exist, as buffering need not actually be done). If a buffer exists, it is 'refilled'. In either case, the next available character is returned, or traits::eof() to indicate a null pending sequence.
For a formal definition of the pending sequence, see a good text such as Langer & Kreft, or [27.5.2.4.3]/7-14.
A functioning input streambuf can be created by overriding only this function (no buffer area will be used). For an example, see http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch25.html
Note:
Reimplemented from std::basic_streambuf< _CharT, _Traits >.
Definition at line 131 of file sstream.tcc.
References std::basic_stringbuf< _CharT, _Traits, _Alloc >::_M_mode, std::basic_streambuf< _CharT, _Traits >::egptr(), std::basic_streambuf< _CharT, _Traits >::gptr(), and std::ios_base::in.
template<typename _CharT , typename _Traits > streamsize std::basic_streambuf< _CharT, _Traits >::xsgetn (char_type * __s, streamsize __n) [inline, protected, virtual, inherited]¶
Multiple character extraction. Parameters:
n Maximum number of characters to assign.
Returns:
Fills s[0] through s[n-1] with characters from the input sequence, as if by sbumpc(). Stops when either n characters have been copied, or when traits::eof() would be copied.
It is expected that derived classes provide a more efficient implementation by overriding this definition.
Reimplemented in std::basic_filebuf< _CharT, _Traits >, __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >, std::basic_filebuf< _CharT, encoding_char_traits< _CharT > >, and std::basic_filebuf< char_type, traits_type >.
Definition at line 45 of file streambuf.tcc.
References std::min().
template<typename _CharT , typename _Traits > streamsize std::basic_streambuf< _CharT, _Traits >::xsputn (const char_type * __s, streamsize __n) [inline, protected, virtual, inherited]¶
Multiple character insertion. Parameters:
n Maximum number of characters to write.
Returns:
Writes s[0] through s[n-1] to the output sequence, as if by sputc(). Stops when either n characters have been copied, or when sputc() would return traits::eof().
It is expected that derived classes provide a more efficient implementation by overriding this definition.
Reimplemented in std::basic_filebuf< _CharT, _Traits >, __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >, std::basic_filebuf< _CharT, encoding_char_traits< _CharT > >, and std::basic_filebuf< char_type, traits_type >.
Definition at line 79 of file streambuf.tcc.
References std::basic_streambuf< _CharT, _Traits >::epptr(), std::min(), std::basic_streambuf< _CharT, _Traits >::overflow(), std::basic_streambuf< _CharT, _Traits >::pbump(), and std::basic_streambuf< _CharT, _Traits >::pptr().
Member Data Documentation¶
template<typename _CharT, typename _Traits> locale std::basic_streambuf< _CharT, _Traits >::_M_buf_locale [protected, inherited]¶
Current locale setting.
Definition at line 187 of file streambuf.
Referenced by std::basic_filebuf< _CharT, _Traits >::basic_filebuf().
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::_M_in_beg [protected, inherited] This is based on _IO_FILE, just reordered to be more consistent, and is intended to be the most minimal abstraction for an internal buffer.¶
- get == input == read
- put == output == write
Definition at line 179 of file streambuf.
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::_M_in_cur [protected, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 180 of file streambuf.
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::_M_in_end [protected, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 181 of file streambuf.
template<typename _CharT, typename _Traits, typename _Alloc> ios_base::openmode std::basic_stringbuf< _CharT, _Traits, _Alloc >::_M_mode [protected]¶
Place to stash in || out || in | out settings for current stringbuf.
Definition at line 77 of file sstream.
Referenced by std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos(), and std::basic_stringbuf< _CharT, _Traits, _Alloc >::underflow().
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::_M_out_beg [protected, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 182 of file streambuf.
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::_M_out_cur [protected, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 183 of file streambuf.
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::_M_out_end [protected, inherited]¶
Locale access. Returns:
If pubimbue(loc) has been called, then the most recent loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 184 of file streambuf.
Author¶
Generated automatically by Doxygen for libstdc++ from the source code.
19 Jun 2018 | libstdc++ |