Inheritance diagram for std::basic_streambuf< CharT, Traits >:
Public Types | |
typedef CharT | char_type |
typedef Traits | traits_type |
typedef traits_type::int_type | int_type |
typedef traits_type::pos_type | pos_type |
typedef traits_type::off_type | off_type |
Public Member Functions | |
virtual | ~basic_streambuf () |
Destructor deallocates no buffer space. | |
locale | pubimbue (const locale &__loc) |
Entry point for imbue(). | |
locale | getloc () const |
Locale access. | |
streamsize | in_avail () |
Looking ahead into the stream. | |
int_type | snextc () |
Getting the next character. | |
int_type | sbumpc () |
Getting the next character. | |
int_type | sgetc () |
Getting the next character. | |
streamsize | sgetn (char_type *s, streamsize n) |
Entry point for xsgetn. | |
int_type | sputbackc (char_type c) |
Pushing characters back into the input stream. | |
int_type | sungetc () |
Moving backwards in the input stream. | |
int_type | sputc (char_type c) |
Entry point for all single-character output functions. | |
streamsize | sputn (const char_type *s, streamsize n) |
Entry point for all single-character output functions. | |
streambuf_type * | pubsetbuf (char_type *s, streamsize n) |
Entry points for derived buffer functions. | |
pos_type | pubseekoff (off_type __off, ios_base::seekdir __way, ios_base::openmode __mode=ios_base::in|ios_base::out) |
Entry points for derived buffer functions. | |
pos_type | pubseekpos (pos_type sp, ios_base::openmode __mode=ios_base::in|ios_base::out) |
Entry points for derived buffer functions. | |
int | pubsync () |
Entry points for derived buffer functions. | |
Protected Member Functions | |
basic_streambuf () | |
Base constructor. | |
void | gbump (int n) |
Moving the read position. | |
void | setg (char_type *__gbeg, char_type *__gnext, char_type *__gend) |
Setting the three read area pointers. | |
void | pbump (int n) |
Moving the write position. | |
void | setp (char_type *__pbeg, char_type *__pend) |
Setting the three write area pointers. | |
virtual void | imbue (const locale &) |
Changes translations. | |
virtual basic_streambuf< char_type, Traits > * | setbuf (char_type *, streamsize) |
Maniuplates the buffer. | |
virtual pos_type | seekoff (off_type, ios_base::seekdir, ios_base::openmode=ios_base::in|ios_base::out) |
Alters the stream positions. | |
virtual pos_type | seekpos (pos_type, ios_base::openmode=ios_base::in|ios_base::out) |
Alters the stream positions. | |
virtual int | sync () |
Synchronizes the buffer arrays with the controlled sequences. | |
virtual streamsize | showmanyc () |
Investigating the data available. | |
virtual streamsize | xsgetn (char_type *s, streamsize n) |
Multiple character extraction. | |
virtual int_type | underflow () |
Fetches more data from the controlled sequence. | |
virtual int_type | uflow () |
Fetches more data from the controlled sequence. | |
virtual int_type | pbackfail (int_type=traits_type::eof()) |
Tries to back up the input sequence. | |
virtual streamsize | xsputn (const char_type *s, streamsize n) |
Multiple character insertion. | |
virtual int_type | overflow (int_type=traits_type::eof()) |
Consumes data from the buffer; writes to the controlled sequence. | |
char_type * | eback () const |
Access to the get area. | |
char_type * | gptr () const |
Access to the get area. | |
char_type * | egptr () const |
Access to the get area. | |
char_type * | pbase () const |
Access to the put area. | |
char_type * | pptr () const |
Access to the put area. | |
char_type * | epptr () const |
Access to the put area. |
This is a base class. Derived stream buffers each control a pair of character sequences: one for input, and one for output.
Section [27.5.1] of the standard describes the requirements and behavior of stream buffer classes. That section (three paragraphs) is reproduced here, for simplicity and accuracy.
charT
array object. The array object represents, at any moment, a (sub)sequence of characters from the sequence. Operations performed on a sequence alter the values stored in these pointers, perform reads and writes directly to or from associated sequences, and alter "the stream position" and conversion state as needed to maintain this subsequence relationship. The three pointers are:charT
array, as described above; otherwise, xbeg and xend shall also be null.
Definition at line 125 of file streambuf.
|
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 in __gnu_cxx::stdio_filebuf< CharT, Traits >, std::basic_filebuf< CharT, Traits >, std::basic_stringbuf< CharT, Traits, Alloc >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. |
|
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 in __gnu_cxx::stdio_filebuf< CharT, Traits >, std::basic_filebuf< CharT, Traits >, std::basic_stringbuf< CharT, Traits, Alloc >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. |
|
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 in __gnu_cxx::stdio_filebuf< CharT, Traits >, std::basic_filebuf< CharT, Traits >, std::basic_stringbuf< CharT, Traits, Alloc >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. |
|
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 in __gnu_cxx::stdio_filebuf< CharT, Traits >, std::basic_filebuf< CharT, Traits >, std::basic_stringbuf< CharT, Traits, Alloc >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. |
|
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 in __gnu_cxx::stdio_filebuf< CharT, Traits >, std::basic_filebuf< CharT, Traits >, std::basic_stringbuf< CharT, Traits, Alloc >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. |
|
Destructor deallocates no buffer space.
|
|
Base constructor. Only called from derived constructors, and sets up all the buffer data to zero, including the pointers described in the basic_streambuf class description. Note that, as a result,
|
|
Access to the get area. These functions are only available to other protected functions, including derived classes.
Definition at line 599 of file streambuf. Referenced by std::basic_stringbuf< CharT, Traits, Alloc >::seekpos(). |
|
Access to the get area. These functions are only available to other protected functions, including derived classes.
Definition at line 605 of file streambuf. Referenced by std::basic_streambuf< CharT, enc_char_traits< CharT > >::in_avail(), std::basic_stringbuf< CharT, Traits, Alloc >::seekoff(), and std::basic_stringbuf< CharT, Traits, Alloc >::seekpos(). |
|
Access to the put area. These functions are only available to other protected functions, including derived classes.
Definition at line 654 of file streambuf. Referenced by std::basic_stringbuf< CharT, Traits, Alloc >::seekoff(). |
|
Moving the read position.
|
|
Locale access.
loc is returned. Otherwise the global locale in effect at the time of construction is returned.
Definition at line 395 of file streambuf. Referenced by std::basic_ios< CharT, Traits >::copyfmt(), and std::basic_filebuf< CharT, Traits >::showmanyc(). |
|
Access to the get area. These functions are only available to other protected functions, including derived classes.
Definition at line 602 of file streambuf. Referenced by std::basic_streambuf< CharT, enc_char_traits< CharT > >::in_avail(), std::basic_streambuf< CharT, Traits >::sbumpc(), std::basic_stringbuf< CharT, Traits, Alloc >::seekoff(), and std::basic_stringbuf< CharT, Traits, Alloc >::underflow(). |
|
Changes translations.
Reimplemented in std::basic_filebuf< CharT, Traits >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. Definition at line 697 of file streambuf. Referenced by std::basic_streambuf< CharT, enc_char_traits< CharT > >::pubimbue(). |
|
Looking ahead into the stream.
showmanyc() .
|
|
Consumes data from the buffer; writes to the controlled sequence.
eof() .For a formal definiton 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).
Reimplemented in std::basic_filebuf< CharT, Traits >, std::basic_stringbuf< CharT, Traits, Alloc >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. Definition at line 890 of file streambuf. Referenced by std::basic_streambuf< CharT, Traits >::sputc(), and std::basic_streambuf< CharT, Traits >::xsputn(). |
|
Tries to back up the input sequence.
Reimplemented in std::basic_filebuf< CharT, Traits >, std::basic_stringbuf< CharT, Traits, Alloc >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. Definition at line 847 of file streambuf. Referenced by std::basic_streambuf< CharT, Traits >::sputbackc(), and std::basic_streambuf< CharT, Traits >::sungetc(). |
|
Access to the put area. These functions are only available to other protected functions, including derived classes.
Definition at line 648 of file streambuf. Referenced by std::basic_stringbuf< CharT, Traits, Alloc >::seekpos(). |
|
Moving the write position.
|
|
Access to the put area. These functions are only available to other protected functions, including derived classes.
Definition at line 651 of file streambuf. Referenced by std::basic_stringbuf< CharT, Traits, Alloc >::seekoff(). |
|
Entry point for imbue().
Definition at line 378 of file streambuf. Referenced by std::basic_ios< CharT, Traits >::imbue(). |
|
Entry points for derived buffer functions.
The public versions of |
|
Entry points for derived buffer functions.
The public versions of |
|
Entry points for derived buffer functions.
The public versions of |
|
Entry points for derived buffer functions.
The public versions of |
|
Getting the next character.
uflow() .
Definition at line 49 of file streambuf.tcc. References std::basic_streambuf< CharT, Traits >::gptr(), and std::basic_streambuf< CharT, Traits >::uflow(). Referenced by std::operator>>(). |
|
Alters the stream positions. Each derived class provides its own appropriate behavior.
Reimplemented in std::basic_filebuf< CharT, Traits >, std::basic_stringbuf< CharT, Traits, Alloc >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. Definition at line 723 of file streambuf. Referenced by std::basic_streambuf< CharT, enc_char_traits< CharT > >::pubseekoff(). |
|
Alters the stream positions. Each derived class provides its own appropriate behavior.
Reimplemented in std::basic_filebuf< CharT, Traits >, std::basic_stringbuf< CharT, Traits, Alloc >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. Definition at line 735 of file streambuf. Referenced by std::basic_streambuf< CharT, enc_char_traits< CharT > >::pubseekpos(). |
|
Maniuplates the buffer. Each derived class provides its own appropriate behavior. See the next-to-last paragraph of http://gcc.gnu.org/onlinedocs/libstdc++/27_io/howto.html#2 for more on this function.
Reimplemented in std::basic_filebuf< CharT, Traits >, std::basic_stringbuf< CharT, Traits, Alloc >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. Definition at line 712 of file streambuf. Referenced by std::basic_streambuf< CharT, enc_char_traits< CharT > >::pubsetbuf(). |
|
Setting the three read area pointers.
|
|
Setting the three write area pointers.
|
|
Getting the next character.
underflow() . Does not move the read position after fetching the character.
Definition at line 489 of file streambuf. Referenced by std::basic_streambuf< CharT, enc_char_traits< CharT > >::snextc(). |
|
Entry point for xsgetn.
|
|
Investigating the data available.
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
Reimplemented in std::basic_filebuf< CharT, Traits >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. Definition at line 770 of file streambuf. Referenced by std::basic_streambuf< CharT, enc_char_traits< CharT > >::in_avail(). |
|
Getting the next character.
sbumpc() , and if that function returns traits::eof() , so does this function. Otherwise, sgetc() .
|
|
Pushing characters back into the input stream.
Definition at line 66 of file streambuf.tcc. References std::basic_streambuf< CharT, Traits >::pbackfail(). Referenced by std::operator>>(). |
|
Entry point for all single-character 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 Definition at line 104 of file streambuf.tcc. References std::basic_streambuf< CharT, Traits >::overflow(). Referenced by std::basic_stringbuf< CharT, Traits, Alloc >::overflow(). |
|
Entry point for all single-character output functions.
Returns xsputn(s,n). The effect is to write s[0] through s[n-1] to the output sequence, if possible. |
|
Moving backwards in the input stream.
Definition at line 83 of file streambuf.tcc. References std::basic_streambuf< CharT, Traits >::pbackfail(). |
|
Synchronizes the buffer arrays with the controlled sequences.
Reimplemented in std::basic_filebuf< CharT, Traits >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. Definition at line 748 of file streambuf. Referenced by std::basic_streambuf< CharT, enc_char_traits< CharT > >::pubsync(). |
|
Fetches more data from the controlled sequence.
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 std::basic_filebuf< CharT, Traits >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. Definition at line 821 of file streambuf. Referenced by std::basic_streambuf< CharT, Traits >::sbumpc(), and std::basic_streambuf< CharT, Traits >::xsgetn(). |
|
Fetches more data from the controlled sequence.
traits::eof() to indicate a null pending sequence.For a formal definiton 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++/27_io/howto.html#6
Reimplemented in std::basic_filebuf< CharT, Traits >, std::basic_stringbuf< CharT, Traits, Alloc >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. Definition at line 808 of file streambuf. Referenced by std::basic_streambuf< CharT, enc_char_traits< CharT > >::sgetc(). |
|
Multiple character extraction.
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 >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. Definition at line 121 of file streambuf.tcc. References std::copy(), std::min(), and std::basic_streambuf< CharT, Traits >::uflow(). Referenced by std::basic_streambuf< CharT, enc_char_traits< CharT > >::sgetn(). |
|
Multiple character insertion.
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 >, std::basic_filebuf< char_type, traits_type >, and std::basic_filebuf< CharT, enc_char_traits< CharT > >. Definition at line 160 of file streambuf.tcc. References std::copy(), std::min(), and std::basic_streambuf< CharT, Traits >::overflow(). Referenced by std::basic_streambuf< CharT, enc_char_traits< CharT > >::sputn(). |