.TH "std::wbuffer_convert< _Codecvt, _Elem, _Tr >" 3cxx "libstdc++" \" -*- nroff -*- .ad l .nh .SH NAME std::wbuffer_convert< _Codecvt, _Elem, _Tr > \- Buffer conversions\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBstd::basic_streambuf< _CharT, _Traits >\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "\fBtypedef\fP _Codecvt::state_type \fBstate_type\fP" .br .in -1c .PP .RI "\fB\fP" .br .in +1c .in +1c .ti -1c .RI "\fBtypedef\fP _CharT \fBchar_type\fP" .br .ti -1c .RI "\fBtypedef\fP _Traits \fBtraits_type\fP" .br .ti -1c .RI "\fBtypedef\fP traits_type::int_type \fBint_type\fP" .br .ti -1c .RI "\fBtypedef\fP traits_type::pos_type \fBpos_type\fP" .br .ti -1c .RI "\fBtypedef\fP traits_type::off_type \fBoff_type\fP" .br .in -1c .in -1c .PP .RI "\fB\fP" .br .in +1c .in +1c .ti -1c .RI "\fBtypedef\fP \fBbasic_streambuf\fP< \fBchar_type\fP, \fBtraits_type\fP > \fB__streambuf_type\fP" .br .RI "This is a non-standard type\&. " .in -1c .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBwbuffer_convert\fP ()" .br .RI "Default constructor\&. " .ti -1c .RI "\fBwbuffer_convert\fP (\fBconst\fP \fBwbuffer_convert\fP &)=\fBdelete\fP" .br .ti -1c .RI "\fBwbuffer_convert\fP (\fBstreambuf\fP *\fB__bytebuf\fP, _Codecvt *\fB__pcvt\fP=new _Codecvt, state_type \fB__state\fP=state_type())" .br .ti -1c .RI "\fBlocale\fP \fBgetloc\fP () \fBconst\fP" .br .RI "Locale access\&. " .ti -1c .RI "\fBstreamsize\fP \fBin_avail\fP ()" .br .RI "Looking ahead into the stream\&. " .ti -1c .RI "\fBwbuffer_convert\fP & \fBoperator=\fP (\fBconst\fP \fBwbuffer_convert\fP &)=\fBdelete\fP" .br .ti -1c .RI "\fBlocale\fP \fBpubimbue\fP (\fBconst\fP \fBlocale\fP &\fB__loc\fP)" .br .RI "Entry point for imbue()\&. " .ti -1c .RI "\fBstreambuf\fP * \fBrdbuf\fP () \fBconst\fP \fBnoexcept\fP" .br .ti -1c .RI "\fBstreambuf\fP * \fBrdbuf\fP (\fBstreambuf\fP *\fB__bytebuf\fP) \fBnoexcept\fP" .br .ti -1c .RI "\fBint_type\fP \fBsbumpc\fP ()" .br .RI "Getting the next character\&. " .ti -1c .RI "\fBint_type\fP \fBsgetc\fP ()" .br .RI "Getting the next character\&. " .ti -1c .RI "\fBstreamsize\fP \fBsgetn\fP (\fBchar_type\fP *\fB__s\fP, \fBstreamsize\fP __n)" .br .RI "Entry point for xsgetn\&. " .ti -1c .RI "\fBint_type\fP \fBsnextc\fP ()" .br .RI "Getting the next character\&. " .ti -1c .RI "\fBint_type\fP \fBsputbackc\fP (\fBchar_type\fP __c)" .br .RI "Pushing characters back into the input stream\&. " .ti -1c .RI "\fBint_type\fP \fBsputc\fP (\fBchar_type\fP __c)" .br .RI "Entry point for all single-character output functions\&. " .ti -1c .RI "\fBstreamsize\fP \fBsputn\fP (\fBconst\fP \fBchar_type\fP *\fB__s\fP, \fBstreamsize\fP __n)" .br .RI "Entry point for all single-character output functions\&. " .ti -1c .RI "state_type \fBstate\fP () \fBconst\fP \fBnoexcept\fP" .br .RI "The conversion state following the last conversion\&. " .ti -1c .RI "\fBint_type\fP \fBsungetc\fP ()" .br .RI "Moving backwards in the input stream\&. " .in -1c .PP .RI "\fB\fP" .br .in +1c .in +1c .ti -1c .RI "\fBbasic_streambuf\fP * \fBpubsetbuf\fP (\fBchar_type\fP *\fB__s\fP, \fBstreamsize\fP __n)" .br .RI "Entry points for derived buffer functions\&. " .ti -1c .RI "\fBpos_type\fP \fBpubseekoff\fP (\fBoff_type\fP \fB__off\fP, \fBios_base::seekdir\fP \fB__way\fP, \fBios_base::openmode\fP \fB__mode\fP=\fBios_base::in\fP|\fBios_base::out\fP)" .br .RI "Alters the stream position\&. " .ti -1c .RI "\fBpos_type\fP \fBpubseekpos\fP (\fBpos_type\fP \fB__sp\fP, \fBios_base::openmode\fP \fB__mode\fP=\fBios_base::in\fP|\fBios_base::out\fP)" .br .RI "Alters the stream position\&. " .ti -1c .RI "int \fBpubsync\fP ()" .br .RI "Calls virtual sync function\&. " .in -1c .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "\fBvoid\fP \fB__safe_gbump\fP (\fBstreamsize\fP __n)" .br .ti -1c .RI "\fBvoid\fP \fB__safe_pbump\fP (\fBstreamsize\fP __n)" .br .ti -1c .RI "\fBvoid\fP \fBgbump\fP (int __n)" .br .RI "Moving the read position\&. " .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBimbue\fP (\fBconst\fP \fBlocale\fP &\fB__loc\fP)" .br .RI "Changes translations\&. " .ti -1c .RI "\fB_Wide_streambuf::int_type\fP \fBoverflow\fP (\fBtypename\fP \fB_Wide_streambuf::int_type\fP \fB__out\fP)" .br .RI "Consumes data from the buffer; writes to the controlled sequence\&. " .ti -1c .RI "\fBvirtual\fP \fBint_type\fP \fBpbackfail\fP (\fBint_type\fP __c=traits_type::eof())" .br .RI "Tries to back up the input sequence\&. " .ti -1c .RI "\fBvoid\fP \fBpbump\fP (int __n)" .br .RI "Moving the write position\&. " .ti -1c .RI "\fBvirtual\fP \fBpos_type\fP \fBseekoff\fP (\fBoff_type\fP, \fBios_base::seekdir\fP, \fBios_base::openmode\fP=\fBios_base::in\fP|\fBios_base::out\fP)" .br .RI "Alters the stream positions\&. " .ti -1c .RI "\fBvirtual\fP \fBpos_type\fP \fBseekpos\fP (\fBpos_type\fP, \fBios_base::openmode\fP=\fBios_base::in\fP|\fBios_base::out\fP)" .br .RI "Alters the stream positions\&. " .ti -1c .RI "\fBvirtual\fP \fBbasic_streambuf\fP< \fBchar_type\fP, _Traits > * \fBsetbuf\fP (\fBchar_type\fP *, \fBstreamsize\fP)" .br .RI "Manipulates the buffer\&. " .ti -1c .RI "\fBvoid\fP \fBsetg\fP (\fBchar_type\fP *\fB__gbeg\fP, \fBchar_type\fP *\fB__gnext\fP, \fBchar_type\fP *\fB__gend\fP)" .br .RI "Setting the three read area pointers\&. " .ti -1c .RI "\fBvoid\fP \fBsetp\fP (\fBchar_type\fP *\fB__pbeg\fP, \fBchar_type\fP *\fB__pend\fP)" .br .RI "Setting the three write area pointers\&. " .ti -1c .RI "\fBvirtual\fP \fBstreamsize\fP \fBshowmanyc\fP ()" .br .RI "Investigating the data available\&. " .ti -1c .RI "\fBvoid\fP \fBswap\fP (\fBbasic_streambuf\fP &\fB__sb\fP)" .br .ti -1c .RI "int \fBsync\fP ()" .br .RI "Synchronizes the buffer arrays with the controlled sequences\&. " .ti -1c .RI "\fBvirtual\fP \fBint_type\fP \fBuflow\fP ()" .br .RI "Fetches more data from the controlled sequence\&. " .ti -1c .RI "\fB_Wide_streambuf::int_type\fP \fBunderflow\fP ()" .br .RI "Fetches more data from the controlled sequence\&. " .ti -1c .RI "\fBvirtual\fP \fBstreamsize\fP \fBxsgetn\fP (\fBchar_type\fP *\fB__s\fP, \fBstreamsize\fP __n)" .br .RI "Multiple character extraction\&. " .ti -1c .RI "\fBvirtual\fP \fBstreamsize\fP \fBxsputn\fP (\fBconst\fP \fBchar_type\fP *\fB__s\fP, \fBstreamsize\fP __n)" .br .RI "Multiple character insertion\&. " .ti -1c .RI "\fBstreamsize\fP \fBxsputn\fP (\fBconst\fP \fBtypename\fP \fB_Wide_streambuf::char_type\fP *\fB__s\fP, \fBstreamsize\fP __n)" .br .in -1c .PP .RI "\fB\fP" .br .in +1c .in +1c .ti -1c .RI "\fBchar_type\fP * \fBeback\fP () \fBconst\fP" .br .RI "Access to the get area\&. " .ti -1c .RI "\fBchar_type\fP * \fBgptr\fP () \fBconst\fP" .br .RI "Access to the get area\&. " .ti -1c .RI "\fBchar_type\fP * \fBegptr\fP () \fBconst\fP" .br .RI "Access to the get area\&. " .in -1c .in -1c .PP .RI "\fB\fP" .br .in +1c .in +1c .ti -1c .RI "\fBchar_type\fP * \fBpbase\fP () \fBconst\fP" .br .RI "Access to the put area\&. " .ti -1c .RI "\fBchar_type\fP * \fBpptr\fP () \fBconst\fP" .br .RI "Access to the put area\&. " .ti -1c .RI "\fBchar_type\fP * \fBepptr\fP () \fBconst\fP" .br .RI "Access to the put area\&. " .in -1c .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "\fBlocale\fP \fB_M_buf_locale\fP" .br .RI "Current locale setting\&. " .ti -1c .RI "\fBchar_type\fP * \fB_M_in_beg\fP" .br .RI "Start of get area\&. " .ti -1c .RI "\fBchar_type\fP * \fB_M_in_cur\fP" .br .RI "Current read area\&. " .ti -1c .RI "\fBchar_type\fP * \fB_M_in_end\fP" .br .RI "End of get area\&. " .ti -1c .RI "\fBchar_type\fP * \fB_M_out_beg\fP" .br .RI "Start of put area\&. " .ti -1c .RI "\fBchar_type\fP * \fB_M_out_cur\fP" .br .RI "Current put area\&. " .ti -1c .RI "\fBchar_type\fP * \fB_M_out_end\fP" .br .RI "End of put area\&. " .in -1c .SH "Detailed Description" .PP .SS "template<\fBtypename\fP _Codecvt, \fBtypename\fP \fB_Elem\fP = wchar_t, \fBtypename\fP \fB_Tr\fP = char_traits<_Elem>> .br class std::wbuffer_convert< _Codecvt, _Elem, _Tr >"Buffer conversions\&. .SH "Member Typedef Documentation" .PP .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBtypedef\fP \fBbasic_streambuf\fP<\fBchar_type\fP, \fBtraits_type\fP> \fBstd::basic_streambuf\fP< _CharT, _Traits >::__streambuf_type\fC [inherited]\fP" .PP This is a non-standard type\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBtypedef\fP _CharT \fBstd::basic_streambuf\fP< _CharT, _Traits >::char_type\fC [inherited]\fP" These are standard types\&. They permit a standardized way of referring to names of (or names dependent on) the template parameters, which are specific to the implementation\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBtypedef\fP traits_type::int_type \fBstd::basic_streambuf\fP< _CharT, _Traits >::int_type\fC [inherited]\fP" These are standard types\&. They permit a standardized way of referring to names of (or names dependent on) the template parameters, which are specific to the implementation\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBtypedef\fP traits_type::off_type \fBstd::basic_streambuf\fP< _CharT, _Traits >::off_type\fC [inherited]\fP" These are standard types\&. They permit a standardized way of referring to names of (or names dependent on) the template parameters, which are specific to the implementation\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBtypedef\fP traits_type::pos_type \fBstd::basic_streambuf\fP< _CharT, _Traits >::pos_type\fC [inherited]\fP" These are standard types\&. They permit a standardized way of referring to names of (or names dependent on) the template parameters, which are specific to the implementation\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBtypedef\fP _Traits \fBstd::basic_streambuf\fP< _CharT, _Traits >::traits_type\fC [inherited]\fP" These are standard types\&. They permit a standardized way of referring to names of (or names dependent on) the template parameters, which are specific to the implementation\&. .SH "Constructor & Destructor Documentation" .PP .SS "template<\fBtypename\fP _Codecvt , \fBtypename\fP \fB_Elem\fP = wchar_t, \fBtypename\fP \fB_Tr\fP = char_traits<_Elem>> \fBstd::wbuffer_convert\fP< _Codecvt, \fB_Elem\fP, \fB_Tr\fP >::wbuffer_convert ()\fC [inline]\fP" .PP Default constructor\&. .SS "template<\fBtypename\fP _Codecvt , \fBtypename\fP \fB_Elem\fP = wchar_t, \fBtypename\fP \fB_Tr\fP = char_traits<_Elem>> \fBstd::wbuffer_convert\fP< _Codecvt, \fB_Elem\fP, \fB_Tr\fP >::wbuffer_convert (\fBstreambuf\fP * __bytebuf, _Codecvt * __pcvt = \fCnew _Codecvt\fP, state_type __state = \fCstate_type()\fP)\fC [inline]\fP, \fC [explicit]\fP" Constructor\&. .PP \fBParameters\fP .RS 4 \fI__bytebuf\fP The underlying byte stream buffer\&. .br \fI__pcvt\fP The facet to use for conversions\&. .br \fI__state\fP Initial conversion state\&. .RE .PP Takes ownership of \fC__pcvt\fP and will delete it in the destructor\&. .PP References \fBstd::basic_streambuf< _CharT, _Traits >::setg()\fP, and \fBstd::basic_streambuf< _CharT, _Traits >::setp()\fP\&. .SH "Member Function Documentation" .PP .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP * \fBstd::basic_streambuf\fP< _CharT, _Traits >::eback () const\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Access to the get area\&. These functions are only available to other protected functions, including derived classes\&. .PP .IP "\(bu" 2 eback() returns the beginning pointer for the input sequence .IP "\(bu" 2 gptr() returns the next pointer for the input sequence .IP "\(bu" 2 egptr() returns the end pointer for the input sequence .PP .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP * \fBstd::basic_streambuf\fP< _CharT, _Traits >::egptr () const\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Access to the get area\&. These functions are only available to other protected functions, including derived classes\&. .PP .IP "\(bu" 2 eback() returns the beginning pointer for the input sequence .IP "\(bu" 2 gptr() returns the next pointer for the input sequence .IP "\(bu" 2 egptr() returns the end pointer for the input sequence .PP .PP Referenced by \fBstd::wbuffer_convert< _Codecvt, _Elem, _Tr >::underflow()\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP * \fBstd::basic_streambuf\fP< _CharT, _Traits >::epptr () const\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Access to the put area\&. These functions are only available to other protected functions, including derived classes\&. .PP .IP "\(bu" 2 pbase() returns the beginning pointer for the output sequence .IP "\(bu" 2 pptr() returns the next pointer for the output sequence .IP "\(bu" 2 epptr() returns the end pointer for the output sequence .PP .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBvoid\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::gbump (int __n)\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Moving the read position\&. .PP \fBParameters\fP .RS 4 \fI__n\fP The delta by which to move\&. .RE .PP This just advances the read position without returning any data\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBlocale\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::getloc () const\fC [inline]\fP, \fC [inherited]\fP" .PP Locale access\&. .PP \fBReturns\fP .RS 4 The current locale in effect\&. .RE .PP If pubimbue(loc) has been called, then the most recent \fCloc\fP is returned\&. Otherwise the global locale in effect at the time of construction is returned\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP * \fBstd::basic_streambuf\fP< _CharT, _Traits >::gptr () const\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Access to the get area\&. These functions are only available to other protected functions, including derived classes\&. .PP .IP "\(bu" 2 eback() returns the beginning pointer for the input sequence .IP "\(bu" 2 gptr() returns the next pointer for the input sequence .IP "\(bu" 2 egptr() returns the end pointer for the input sequence .PP .PP Referenced by \fBstd::wbuffer_convert< _Codecvt, _Elem, _Tr >::underflow()\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBvirtual\fP \fBvoid\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::imbue (\fBconst\fP \fBlocale\fP & __loc)\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Changes translations\&. .PP \fBParameters\fP .RS 4 \fI__loc\fP A new locale\&. .RE .PP Translations done during I/O which depend on the current locale are changed by this call\&. The standard adds, \fIBetween 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\&.\fP .PP \fBNote\fP .RS 4 Base class version does nothing\&. .RE .PP .PP Reimplemented in \fBstd::basic_filebuf< _CharT, _Traits >\fP, \fBstd::basic_filebuf< _CharT, encoding_char_traits< _CharT > >\fP, \fBstd::basic_filebuf< _CharT, std::char_traits< _CharT > >\fP, and \fBstd::basic_filebuf< char_type, traits_type >\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstreamsize\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::in_avail ()\fC [inline]\fP, \fC [inherited]\fP" .PP Looking ahead into the stream\&. .PP \fBReturns\fP .RS 4 The number of characters available\&. .RE .PP If a read position is available, returns the number of characters available for reading before the buffer must be refilled\&. Otherwise returns the derived \fCshowmanyc()\fP\&. .SS "template<\fBtypename\fP _Codecvt , \fBtypename\fP \fB_Elem\fP = wchar_t, \fBtypename\fP \fB_Tr\fP = char_traits<_Elem>> \fB_Wide_streambuf::int_type\fP \fBstd::wbuffer_convert\fP< _Codecvt, \fB_Elem\fP, \fB_Tr\fP >::overflow (\fBtypename\fP \fB_Wide_streambuf::int_type\fP __c)\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP" .PP Consumes data from the buffer; writes to the controlled sequence\&. .PP \fBParameters\fP .RS 4 \fI__c\fP An additional character to consume\&. .RE .PP \fBReturns\fP .RS 4 eof() to indicate failure, something else (usually \fI__c\fP, or not_eof()) .RE .PP 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 \fIconsumed\fP, with \fIsome effect\fP on the controlled sequence\&. (Typically, the buffer is written out to the sequence verbatim\&.) In either case, the character \fIc\fP is also written out, if \fI__c\fP is not \fCeof()\fP\&. .PP For a formal definition of this function, see a good text such as Langer & Kreft, or [27\&.5\&.2\&.4\&.5]/3-7\&. .PP A functioning output streambuf can be created by overriding only this function (no buffer area will be used)\&. .PP \fBNote\fP .RS 4 Base class version does nothing, returns eof()\&. .RE .PP .PP Reimplemented from \fBstd::basic_streambuf< _CharT, _Traits >\fP\&. .PP References \fBstd::basic_streambuf< _CharT, _Traits >::sputc()\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBvirtual\fP \fBint_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::pbackfail (\fBint_type\fP __c = \fCtraits_type::eof()\fP)\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Tries to back up the input sequence\&. .PP \fBParameters\fP .RS 4 \fI__c\fP The character to be inserted back into the sequence\&. .RE .PP \fBReturns\fP .RS 4 eof() on failure, \fIsome other value\fP on success .RE .PP \fBPostcondition\fP .RS 4 The constraints of \fCgptr()\fP, \fCeback()\fP, and \fCpptr()\fP are the same as for \fCunderflow()\fP\&. .RE .PP \fBNote\fP .RS 4 Base class version does nothing, returns eof()\&. .RE .PP .PP Reimplemented in \fBstd::basic_filebuf< _CharT, _Traits >\fP, \fBstd::basic_filebuf< _CharT, encoding_char_traits< _CharT > >\fP, \fBstd::basic_filebuf< _CharT, std::char_traits< _CharT > >\fP, \fBstd::basic_filebuf< char_type, traits_type >\fP, \fB__gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >\fP, and \fBstd::basic_stringbuf< _CharT, _Traits, _Alloc >\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP * \fBstd::basic_streambuf\fP< _CharT, _Traits >::pbase () const\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Access to the put area\&. These functions are only available to other protected functions, including derived classes\&. .PP .IP "\(bu" 2 pbase() returns the beginning pointer for the output sequence .IP "\(bu" 2 pptr() returns the next pointer for the output sequence .IP "\(bu" 2 epptr() returns the end pointer for the output sequence .PP .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBvoid\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::pbump (int __n)\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Moving the write position\&. .PP \fBParameters\fP .RS 4 \fI__n\fP The delta by which to move\&. .RE .PP This just advances the write position without returning any data\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP * \fBstd::basic_streambuf\fP< _CharT, _Traits >::pptr () const\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Access to the put area\&. These functions are only available to other protected functions, including derived classes\&. .PP .IP "\(bu" 2 pbase() returns the beginning pointer for the output sequence .IP "\(bu" 2 pptr() returns the next pointer for the output sequence .IP "\(bu" 2 epptr() returns the end pointer for the output sequence .PP .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBlocale\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::pubimbue (\fBconst\fP \fBlocale\fP & __loc)\fC [inline]\fP, \fC [inherited]\fP" .PP Entry point for imbue()\&. .PP \fBParameters\fP .RS 4 \fI__loc\fP The new locale\&. .RE .PP \fBReturns\fP .RS 4 The previous locale\&. .RE .PP Calls the derived imbue(__loc)\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBpos_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::pubseekoff (\fBoff_type\fP __off, \fBios_base::seekdir\fP __way, \fBios_base::openmode\fP __mode = \fC\fBios_base::in\fP | \fBios_base::out\fP\fP)\fC [inline]\fP, \fC [inherited]\fP" .PP Alters the stream position\&. .PP \fBParameters\fP .RS 4 \fI__off\fP Offset\&. .br \fI__way\fP Value for ios_base::seekdir\&. .br \fI__mode\fP Value for ios_base::openmode\&. .RE .PP Calls virtual seekoff function\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBpos_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::pubseekpos (\fBpos_type\fP __sp, \fBios_base::openmode\fP __mode = \fC\fBios_base::in\fP | \fBios_base::out\fP\fP)\fC [inline]\fP, \fC [inherited]\fP" .PP Alters the stream position\&. .PP \fBParameters\fP .RS 4 \fI__sp\fP Position .br \fI__mode\fP Value for ios_base::openmode\&. .RE .PP Calls virtual seekpos function\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBbasic_streambuf\fP * \fBstd::basic_streambuf\fP< _CharT, _Traits >::pubsetbuf (\fBchar_type\fP * __s, \fBstreamsize\fP __n)\fC [inline]\fP, \fC [inherited]\fP" .PP Entry points for derived buffer functions\&. The public versions of \fCpubfoo\fP dispatch to the protected derived \fCfoo\fP member functions, passing the arguments (if any) and returning the result unchanged\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > int \fBstd::basic_streambuf\fP< _CharT, _Traits >::pubsync ()\fC [inline]\fP, \fC [inherited]\fP" .PP Calls virtual sync function\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBint_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::sbumpc ()\fC [inline]\fP, \fC [inherited]\fP" .PP Getting the next character\&. .PP \fBReturns\fP .RS 4 The next character, or eof\&. .RE .PP If the input read position is available, returns that character and increments the read pointer, otherwise calls and returns \fCuflow()\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBvirtual\fP \fBpos_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::seekoff (\fBoff_type\fP, \fBios_base::seekdir\fP, \fBios_base::openmode\fP = \fC\fBios_base::in\fP | \fBios_base::out\fP\fP)\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Alters the stream positions\&. Each derived class provides its own appropriate behavior\&. .PP \fBNote\fP .RS 4 Base class version does nothing, returns a \fCpos_type\fP that represents an invalid stream position\&. .RE .PP .PP Reimplemented in \fBstd::basic_filebuf< _CharT, _Traits >\fP, \fBstd::basic_filebuf< _CharT, encoding_char_traits< _CharT > >\fP, \fBstd::basic_filebuf< _CharT, std::char_traits< _CharT > >\fP, \fBstd::basic_filebuf< char_type, traits_type >\fP, and \fBstd::basic_stringbuf< _CharT, _Traits, _Alloc >\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBvirtual\fP \fBpos_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::seekpos (\fBpos_type\fP, \fBios_base::openmode\fP = \fC\fBios_base::in\fP | \fBios_base::out\fP\fP)\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Alters the stream positions\&. Each derived class provides its own appropriate behavior\&. .PP \fBNote\fP .RS 4 Base class version does nothing, returns a \fCpos_type\fP that represents an invalid stream position\&. .RE .PP .PP Reimplemented in \fBstd::basic_filebuf< _CharT, _Traits >\fP, \fBstd::basic_filebuf< _CharT, encoding_char_traits< _CharT > >\fP, \fBstd::basic_filebuf< _CharT, std::char_traits< _CharT > >\fP, \fBstd::basic_filebuf< char_type, traits_type >\fP, and \fBstd::basic_stringbuf< _CharT, _Traits, _Alloc >\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBvirtual\fP \fBbasic_streambuf\fP< \fBchar_type\fP, _Traits > * \fBstd::basic_streambuf\fP< _CharT, _Traits >::setbuf (\fBchar_type\fP *, \fBstreamsize\fP)\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Manipulates the buffer\&. Each derived class provides its own appropriate behavior\&. See the next-to-last paragraph of https://gcc.gnu.org/onlinedocs/libstdc++/manual/streambufs.html#io.streambuf.buffering for more on this function\&. .PP \fBNote\fP .RS 4 Base class version does nothing, returns \fCthis\fP\&. .RE .PP .PP Reimplemented in \fBstd::basic_filebuf< _CharT, _Traits >\fP, \fBstd::basic_filebuf< _CharT, encoding_char_traits< _CharT > >\fP, \fBstd::basic_filebuf< _CharT, std::char_traits< _CharT > >\fP, \fBstd::basic_filebuf< char_type, traits_type >\fP, and \fBstd::basic_stringbuf< _CharT, _Traits, _Alloc >\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBvoid\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::setg (\fBchar_type\fP * __gbeg, \fBchar_type\fP * __gnext, \fBchar_type\fP * __gend)\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Setting the three read area pointers\&. .PP \fBParameters\fP .RS 4 \fI__gbeg\fP A pointer\&. .br \fI__gnext\fP A pointer\&. .br \fI__gend\fP A pointer\&. .RE .PP \fBPostcondition\fP .RS 4 \fI__gbeg\fP == \fCeback()\fP, \fI__gnext\fP == \fCgptr()\fP, and \fI__gend\fP == \fCegptr()\fP .RE .PP .PP Referenced by \fBstd::wbuffer_convert< _Codecvt, _Elem, _Tr >::wbuffer_convert()\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBvoid\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::setp (\fBchar_type\fP * __pbeg, \fBchar_type\fP * __pend)\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Setting the three write area pointers\&. .PP \fBParameters\fP .RS 4 \fI__pbeg\fP A pointer\&. .br \fI__pend\fP A pointer\&. .RE .PP \fBPostcondition\fP .RS 4 \fI__pbeg\fP == \fCpbase()\fP, \fI__pbeg\fP == \fCpptr()\fP, and \fI__pend\fP == \fCepptr()\fP .RE .PP .PP Referenced by \fBstd::wbuffer_convert< _Codecvt, _Elem, _Tr >::wbuffer_convert()\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBint_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::sgetc ()\fC [inline]\fP, \fC [inherited]\fP" .PP Getting the next character\&. .PP \fBReturns\fP .RS 4 The next character, or eof\&. .RE .PP If the input read position is available, returns that character, otherwise calls and returns \fCunderflow()\fP\&. Does not move the read position after fetching the character\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstreamsize\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::sgetn (\fBchar_type\fP * __s, \fBstreamsize\fP __n)\fC [inline]\fP, \fC [inherited]\fP" .PP Entry point for xsgetn\&. .PP \fBParameters\fP .RS 4 \fI__s\fP A buffer area\&. .br \fI__n\fP A count\&. .RE .PP Returns xsgetn(__s,__n)\&. The effect is to fill \fI__s\fP[0] through \fI__s\fP[__n-1] with characters from the input sequence, if possible\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBvirtual\fP \fBstreamsize\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::showmanyc ()\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Investigating the data available\&. .PP \fBReturns\fP .RS 4 An estimate of the number of characters available in the input sequence, or -1\&. .RE .PP \fIIf it returns a positive value, then successive calls to \fCunderflow()\fP will not return \fCtraits::eof()\fP until at least that number of characters have been supplied\&. If \fCshowmanyc()\fP returns -1, then calls to \fCunderflow()\fP or \fCuflow()\fP will fail\&.\fP [27\&.5\&.2\&.4\&.3]/1 .PP \fBNote\fP .RS 4 Base class version does nothing, returns zero\&. .PP The standard adds that \fIthe intention is not only that the calls [to underflow or uflow] will not return \fCeof()\fP but that they will return immediately\&.\fP .PP The standard adds that \fIthe morphemes of \fCshowmanyc\fP are \fBes-how-many-see\fP, not \fBshow-manic\fP\&.\fP .RE .PP .PP Reimplemented in \fBstd::basic_filebuf< _CharT, _Traits >\fP, \fBstd::basic_filebuf< _CharT, encoding_char_traits< _CharT > >\fP, \fBstd::basic_filebuf< _CharT, std::char_traits< _CharT > >\fP, \fBstd::basic_filebuf< char_type, traits_type >\fP, and \fBstd::basic_stringbuf< _CharT, _Traits, _Alloc >\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBint_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::snextc ()\fC [inline]\fP, \fC [inherited]\fP" .PP Getting the next character\&. .PP \fBReturns\fP .RS 4 The next character, or eof\&. .RE .PP Calls \fCsbumpc()\fP, and if that function returns \fCtraits::eof()\fP, so does this function\&. Otherwise, \fCsgetc()\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBint_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::sputbackc (\fBchar_type\fP __c)\fC [inline]\fP, \fC [inherited]\fP" .PP Pushing characters back into the input stream\&. .PP \fBParameters\fP .RS 4 \fI__c\fP The character to push back\&. .RE .PP \fBReturns\fP .RS 4 The previous character, if possible\&. .RE .PP Similar to sungetc(), but \fI__c\fP is pushed onto the stream instead of \fIthe previous character\&.\fP If successful, the next character fetched from the input stream will be \fI__c\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBint_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::sputc (\fBchar_type\fP __c)\fC [inline]\fP, \fC [inherited]\fP" .PP Entry point for all single-character output functions\&. .PP \fBParameters\fP .RS 4 \fI__c\fP A character to output\&. .RE .PP \fBReturns\fP .RS 4 \fI__c\fP, if possible\&. .RE .PP One of two public output functions\&. .PP If a write position is available for the output sequence (i\&.e\&., the buffer is not full), stores \fI__c\fP in that position, increments the position, and returns \fCtraits::to_int_type(__c)\fP\&. If a write position is not available, returns \fCoverflow(__c)\fP\&. .PP Referenced by \fBstd::wbuffer_convert< _Codecvt, _Elem, _Tr >::overflow()\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstreamsize\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::sputn (\fBconst\fP \fBchar_type\fP * __s, \fBstreamsize\fP __n)\fC [inline]\fP, \fC [inherited]\fP" .PP Entry point for all single-character output functions\&. .PP \fBParameters\fP .RS 4 \fI__s\fP A buffer read area\&. .br \fI__n\fP A count\&. .RE .PP One of two public output functions\&. .PP Returns xsputn(__s,__n)\&. The effect is to write \fI__s\fP[0] through \fI__s\fP[__n-1] to the output sequence, if possible\&. .SS "template<\fBtypename\fP _Codecvt , \fBtypename\fP \fB_Elem\fP = wchar_t, \fBtypename\fP \fB_Tr\fP = char_traits<_Elem>> state_type \fBstd::wbuffer_convert\fP< _Codecvt, \fB_Elem\fP, \fB_Tr\fP >::state () const\fC [inline]\fP, \fC [noexcept]\fP" .PP The conversion state following the last conversion\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBint_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::sungetc ()\fC [inline]\fP, \fC [inherited]\fP" .PP Moving backwards in the input stream\&. .PP \fBReturns\fP .RS 4 The previous character, if possible\&. .RE .PP 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 \fIunget\fP the last character \fIgotten\fP\&. .SS "template<\fBtypename\fP _Codecvt , \fBtypename\fP \fB_Elem\fP = wchar_t, \fBtypename\fP \fB_Tr\fP = char_traits<_Elem>> int \fBstd::wbuffer_convert\fP< _Codecvt, \fB_Elem\fP, \fB_Tr\fP >::sync ()\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP" .PP Synchronizes the buffer arrays with the controlled sequences\&. .PP \fBReturns\fP .RS 4 -1 on failure\&. .RE .PP Each derived class provides its own appropriate behavior, including the definition of \fIfailure\fP\&. .PP \fBNote\fP .RS 4 Base class version does nothing, returns zero\&. .RE .PP .PP Reimplemented from \fBstd::basic_streambuf< _CharT, _Traits >\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBvirtual\fP \fBint_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::uflow ()\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Fetches more data from the controlled sequence\&. .PP \fBReturns\fP .RS 4 The first character from the \fIpending sequence\fP\&. .RE .PP Informally, this function does the same thing as \fCunderflow()\fP, and in fact is required to call that function\&. It also returns the new character, like \fCunderflow()\fP does\&. However, this function also moves the read position forward by one\&. .PP Reimplemented in \fB__gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >\fP\&. .SS "template<\fBtypename\fP _Codecvt , \fBtypename\fP \fB_Elem\fP = wchar_t, \fBtypename\fP \fB_Tr\fP = char_traits<_Elem>> \fB_Wide_streambuf::int_type\fP \fBstd::wbuffer_convert\fP< _Codecvt, \fB_Elem\fP, \fB_Tr\fP >::underflow ()\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP" .PP Fetches more data from the controlled sequence\&. .PP \fBReturns\fP .RS 4 The first character from the \fIpending sequence\fP\&. .RE .PP 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 \fIrefilled\fP\&. In either case, the next available character is returned, or \fCtraits::eof()\fP to indicate a null pending sequence\&. .PP For a formal definition of the pending sequence, see a good text such as Langer & Kreft, or [27\&.5\&.2\&.4\&.3]/7-14\&. .PP A functioning input streambuf can be created by overriding only this function (no buffer area will be used)\&. For an example, see https://gcc.gnu.org/onlinedocs/libstdc++/manual/streambufs.html .PP \fBNote\fP .RS 4 Base class version does nothing, returns eof()\&. .RE .PP .PP Reimplemented from \fBstd::basic_streambuf< _CharT, _Traits >\fP\&. .PP References \fBstd::basic_streambuf< _CharT, _Traits >::egptr()\fP, and \fBstd::basic_streambuf< _CharT, _Traits >::gptr()\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstreamsize\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::xsgetn (\fBchar_type\fP * __s, \fBstreamsize\fP __n)\fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Multiple character extraction\&. .PP \fBParameters\fP .RS 4 \fI__s\fP A buffer area\&. .br \fI__n\fP Maximum number of characters to assign\&. .RE .PP \fBReturns\fP .RS 4 The number of characters assigned\&. .RE .PP Fills \fI__s\fP[0] through \fI__s\fP[__n-1] with characters from the input sequence, as if by \fCsbumpc()\fP\&. Stops when either \fI__n\fP characters have been copied, or when \fCtraits::eof()\fP would be copied\&. .PP It is expected that derived classes provide a more efficient implementation by overriding this definition\&. .PP Reimplemented in \fBstd::basic_filebuf< _CharT, _Traits >\fP, \fBstd::basic_filebuf< _CharT, encoding_char_traits< _CharT > >\fP, \fBstd::basic_filebuf< _CharT, std::char_traits< _CharT > >\fP, and \fBstd::basic_filebuf< char_type, traits_type >\fP\&. .PP References \fBstd::min()\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstreamsize\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::xsputn (\fBconst\fP \fBchar_type\fP * __s, \fBstreamsize\fP __n)\fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Multiple character insertion\&. .PP \fBParameters\fP .RS 4 \fI__s\fP A buffer area\&. .br \fI__n\fP Maximum number of characters to write\&. .RE .PP \fBReturns\fP .RS 4 The number of characters written\&. .RE .PP Writes \fI__s\fP[0] through \fI__s\fP[__n-1] to the output sequence, as if by \fCsputc()\fP\&. Stops when either \fIn\fP characters have been copied, or when \fCsputc()\fP would return \fCtraits::eof()\fP\&. .PP It is expected that derived classes provide a more efficient implementation by overriding this definition\&. .PP Reimplemented in \fBstd::basic_filebuf< _CharT, _Traits >\fP, \fBstd::basic_filebuf< _CharT, encoding_char_traits< _CharT > >\fP, \fBstd::basic_filebuf< _CharT, std::char_traits< _CharT > >\fP, and \fBstd::basic_filebuf< char_type, traits_type >\fP\&. .PP References \fBstd::min()\fP\&. .SH "Member Data Documentation" .PP .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBlocale\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_buf_locale\fC [protected]\fP, \fC [inherited]\fP" .PP Current locale setting\&. .PP Referenced by \fBstd::basic_filebuf< _CharT, _Traits >::basic_filebuf()\fP\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP* \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_in_beg\fC [protected]\fP, \fC [inherited]\fP" .PP Start of get area\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP* \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_in_cur\fC [protected]\fP, \fC [inherited]\fP" .PP Current read area\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP* \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_in_end\fC [protected]\fP, \fC [inherited]\fP" .PP End of get area\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP* \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_out_beg\fC [protected]\fP, \fC [inherited]\fP" .PP Start of put area\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP* \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_out_cur\fC [protected]\fP, \fC [inherited]\fP" .PP Current put area\&. .SS "template<\fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBchar_type\fP* \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_out_end\fC [protected]\fP, \fC [inherited]\fP" .PP End of put area\&. .SH "Author" .PP Generated automatically by Doxygen for libstdc++ from the source code\&.