.TH "__gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >" 3cxx "Thu Aug 2 2012" "libstdc++" \" -*- nroff -*- .ad l .nh .SH NAME __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits > \- .SH SYNOPSIS .br .PP .PP Inherits \fBstd::basic_streambuf< _CharT, _Traits >\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "typedef _CharT \fBchar_type\fP" .br .ti -1c .RI "typedef traits_type::int_type \fBint_type\fP" .br .ti -1c .RI "typedef traits_type::off_type \fBoff_type\fP" .br .ti -1c .RI "typedef traits_type::pos_type \fBpos_type\fP" .br .ti -1c .RI "typedef _Traits \fBtraits_type\fP" .br .in -1c .PP .RI "\fB\fP" .br .in +1c .in +1c .ti -1c .RI "typedef \fBbasic_streambuf\fP .br < \fBchar_type\fP, \fBtraits_type\fP > \fB__streambuf_type\fP" .br .in -1c .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "std::__c_file *const \fBfile\fP ()" .br .ti -1c .RI "streamsize \fBin_avail\fP ()" .br .ti -1c .RI "\fBint_type\fP \fBsbumpc\fP ()" .br .ti -1c .RI "\fBint_type\fP \fBsgetc\fP ()" .br .ti -1c .RI "streamsize \fBsgetn\fP (\fBchar_type\fP *__s, streamsize __n)" .br .ti -1c .RI "\fBint_type\fP \fBsnextc\fP ()" .br .ti -1c .RI "\fBint_type\fP \fBsputbackc\fP (\fBchar_type\fP __c)" .br .ti -1c .RI "\fBint_type\fP \fBsputc\fP (\fBchar_type\fP __c)" .br .ti -1c .RI "streamsize \fBsputn\fP (const \fBchar_type\fP *__s, streamsize __n)" .br .ti -1c .RI "\fBstdio_sync_filebuf\fP (std::__c_file *__f)" .br .ti -1c .RI "void \fBstossc\fP ()" .br .ti -1c .RI "\fBint_type\fP \fBsungetc\fP ()" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "void \fBgbump\fP (int __n)" .br .ti -1c .RI "virtual void \fBimbue\fP (const locale &)" .br .ti -1c .RI "virtual \fBint_type\fP \fBoverflow\fP (\fBint_type\fP __c=traits_type::eof())" .br .ti -1c .RI "virtual \fBint_type\fP \fBpbackfail\fP (\fBint_type\fP __c=traits_type::eof())" .br .ti -1c .RI "void \fBpbump\fP (int __n)" .br .ti -1c .RI "virtual \fBstd::streampos\fP \fBseekoff\fP (\fBstd::streamoff\fP __off, \fBstd::ios_base::seekdir\fP __dir, \fBstd::ios_base::openmode\fP=\fBstd::ios_base::in\fP|\fBstd::ios_base::out\fP)" .br .ti -1c .RI "virtual \fBpos_type\fP \fBseekoff\fP (\fBoff_type\fP, ios_base::seekdir, ios_base::openmode=ios_base::in|ios_base::out)" .br .ti -1c .RI "virtual \fBstd::streampos\fP \fBseekpos\fP (\fBstd::streampos\fP __pos, \fBstd::ios_base::openmode\fP __mode=\fBstd::ios_base::in\fP|\fBstd::ios_base::out\fP)" .br .ti -1c .RI "virtual \fBpos_type\fP \fBseekpos\fP (\fBpos_type\fP, ios_base::openmode=ios_base::in|ios_base::out)" .br .ti -1c .RI "virtual \fBbasic_streambuf\fP .br < \fBchar_type\fP, _Traits > * \fBsetbuf\fP (\fBchar_type\fP *, streamsize)" .br .ti -1c .RI "void \fBsetg\fP (\fBchar_type\fP *__gbeg, \fBchar_type\fP *__gnext, \fBchar_type\fP *__gend)" .br .ti -1c .RI "void \fBsetp\fP (\fBchar_type\fP *__pbeg, \fBchar_type\fP *__pend)" .br .ti -1c .RI "virtual streamsize \fBshowmanyc\fP ()" .br .ti -1c .RI "virtual int \fBsync\fP ()" .br .ti -1c .RI "\fBint_type\fP \fBsyncgetc\fP ()" .br .ti -1c .RI "template<> \fBstdio_sync_filebuf\fP< char > .br ::\fBint_type\fP \fBsyncgetc\fP ()" .br .ti -1c .RI "template<> \fBstdio_sync_filebuf\fP< wchar_t > .br ::\fBint_type\fP \fBsyncgetc\fP ()" .br .ti -1c .RI "\fBint_type\fP \fBsyncputc\fP (\fBint_type\fP __c)" .br .ti -1c .RI "template<> \fBstdio_sync_filebuf\fP< char > .br ::\fBint_type\fP \fBsyncputc\fP (\fBint_type\fP __c)" .br .ti -1c .RI "template<> \fBstdio_sync_filebuf\fP< wchar_t > .br ::\fBint_type\fP \fBsyncputc\fP (\fBint_type\fP __c)" .br .ti -1c .RI "\fBint_type\fP \fBsyncungetc\fP (\fBint_type\fP __c)" .br .ti -1c .RI "template<> \fBstdio_sync_filebuf\fP< char > .br ::\fBint_type\fP \fBsyncungetc\fP (\fBint_type\fP __c)" .br .ti -1c .RI "template<> \fBstdio_sync_filebuf\fP< wchar_t > .br ::\fBint_type\fP \fBsyncungetc\fP (\fBint_type\fP __c)" .br .ti -1c .RI "virtual \fBint_type\fP \fBuflow\fP ()" .br .ti -1c .RI "virtual \fBint_type\fP \fBunderflow\fP ()" .br .ti -1c .RI "virtual \fBstd::streamsize\fP \fBxsgetn\fP (\fBchar_type\fP *__s, \fBstd::streamsize\fP __n)" .br .ti -1c .RI "template<> \fBstd::streamsize\fP \fBxsgetn\fP (char *__s, \fBstd::streamsize\fP __n)" .br .ti -1c .RI "template<> \fBstd::streamsize\fP \fBxsgetn\fP (wchar_t *__s, \fBstd::streamsize\fP __n)" .br .ti -1c .RI "virtual \fBstd::streamsize\fP \fBxsputn\fP (const \fBchar_type\fP *__s, \fBstd::streamsize\fP __n)" .br .ti -1c .RI "template<> \fBstd::streamsize\fP \fBxsputn\fP (const char *__s, \fBstd::streamsize\fP __n)" .br .ti -1c .RI "template<> \fBstd::streamsize\fP \fBxsputn\fP (const wchar_t *__s, \fBstd::streamsize\fP __n)" .br .in -1c .PP .RI "\fB\fP" .br .in +1c .in +1c .ti -1c .RI "\fBchar_type\fP * \fBeback\fP () const " .br .ti -1c .RI "\fBchar_type\fP * \fBgptr\fP () const " .br .ti -1c .RI "\fBchar_type\fP * \fBegptr\fP () const " .br .in -1c .in -1c .PP .RI "\fB\fP" .br .in +1c .in +1c .ti -1c .RI "\fBchar_type\fP * \fBpbase\fP () const " .br .ti -1c .RI "\fBchar_type\fP * \fBpptr\fP () const " .br .ti -1c .RI "\fBchar_type\fP * \fBepptr\fP () const " .br .in -1c .in -1c .in +1c .ti -1c .RI "locale \fBpubimbue\fP (const locale &__loc)" .br .ti -1c .RI "locale \fBgetloc\fP () const " .br .ti -1c .RI "\fB__streambuf_type\fP * \fBpubsetbuf\fP (\fBchar_type\fP *__s, streamsize __n)" .br .ti -1c .RI "\fBpos_type\fP \fBpubseekoff\fP (\fBoff_type\fP __off, ios_base::seekdir __way, ios_base::openmode __mode=ios_base::in|ios_base::out)" .br .ti -1c .RI "\fBpos_type\fP \fBpubseekpos\fP (\fBpos_type\fP __sp, ios_base::openmode __mode=ios_base::in|ios_base::out)" .br .ti -1c .RI "int \fBpubsync\fP ()" .br .ti -1c .RI "\fBchar_type\fP * \fB_M_in_beg\fP" .br .ti -1c .RI "\fBchar_type\fP * \fB_M_in_cur\fP" .br .ti -1c .RI "\fBchar_type\fP * \fB_M_in_end\fP" .br .ti -1c .RI "\fBchar_type\fP * \fB_M_out_beg\fP" .br .ti -1c .RI "\fBchar_type\fP * \fB_M_out_cur\fP" .br .ti -1c .RI "\fBchar_type\fP * \fB_M_out_end\fP" .br .ti -1c .RI "locale \fB_M_buf_locale\fP" .br .in -1c .SH "Detailed Description" .PP .SS "template>class __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >" class \fBstdio_sync_filebuf\fP\&. .PP Definition at line 47 of file stdio_sync_filebuf\&.h\&. .SH "Member Typedef Documentation" .PP .SS "template typedef \fBbasic_streambuf\fP<\fBchar_type\fP, \fBtraits_type\fP> \fBstd::basic_streambuf\fP< _CharT, _Traits >::\fB__streambuf_type\fP\fC [inherited]\fP" .PP This is a non-standard type\&. .PP Definition at line 132 of file streambuf\&. .SH "Member Function Documentation" .PP .SS "template \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 \fBeback()\fP returns the beginning pointer for the input sequence .IP "\(bu" 2 \fBgptr()\fP returns the next pointer for the input sequence .IP "\(bu" 2 \fBegptr()\fP returns the end pointer for the input sequence .PP .PP Definition at line 458 of file streambuf\&. .SS "template \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 \fBeback()\fP returns the beginning pointer for the input sequence .IP "\(bu" 2 \fBgptr()\fP returns the next pointer for the input sequence .IP "\(bu" 2 \fBegptr()\fP returns the end pointer for the input sequence .PP .PP Definition at line 464 of file streambuf\&. .SS "template \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 \fBpbase()\fP returns the beginning pointer for the output sequence .IP "\(bu" 2 \fBpptr()\fP returns the next pointer for the output sequence .IP "\(bu" 2 \fBepptr()\fP returns the end pointer for the output sequence .PP .PP Definition at line 511 of file streambuf\&. .SS "template> std::__c_file* const \fB__gnu_cxx::stdio_sync_filebuf\fP< _CharT, _Traits >::file ()\fC [inline]\fP" \fBReturns:\fP .RS 4 The underlying FILE*\&. .RE .PP This function can be used to access the underlying 'C' file pointer\&. Note that there is no way for the library to track what you do with the file, so be careful\&. .PP Definition at line 79 of file stdio_sync_filebuf\&.h\&. .SS "template void \fBstd::basic_streambuf\fP< _CharT, _Traits >::gbump (int__n)\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Moving the read position\&. \fBParameters:\fP .RS 4 \fIn\fP The delta by which to move\&. .RE .PP This just advances the read position without returning any data\&. .PP Definition at line 474 of file streambuf\&. .SS "template locale \fBstd::basic_streambuf\fP< _CharT, _Traits >::getloc () const\fC [inline]\fP, \fC [inherited]\fP" .PP Locale access\&. \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\&. .PP Definition at line 221 of file streambuf\&. .SS "template \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 \fBeback()\fP returns the beginning pointer for the input sequence .IP "\(bu" 2 \fBgptr()\fP returns the next pointer for the input sequence .IP "\(bu" 2 \fBegptr()\fP returns the end pointer for the input sequence .PP .PP Definition at line 461 of file streambuf\&. .SS "template virtual void \fBstd::basic_streambuf\fP< _CharT, _Traits >::imbue (const \fBlocale\fP &)\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Changes translations\&. \fBParameters:\fP .RS 4 \fIloc\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, "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\&." .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, and \fBstd::basic_filebuf< char_type, traits_type >\fP\&. .PP Definition at line 552 of file streambuf\&. .SS "template streamsize \fBstd::basic_streambuf\fP< _CharT, _Traits >::in_avail ()\fC [inline]\fP, \fC [inherited]\fP" .PP Looking ahead into the stream\&. \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 \fC\fBshowmanyc()\fP\fP\&. .PP Definition at line 261 of file streambuf\&. .SS "template> virtual \fBint_type\fP \fB__gnu_cxx::stdio_sync_filebuf\fP< _CharT, _Traits >::overflow (\fBint_type\fP = \fCtraits_type::eof()\fP)\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP" .PP Consumes data from the buffer; writes to the controlled sequence\&. \fBParameters:\fP .RS 4 \fIc\fP An additional character to consume\&. .RE .PP \fBReturns:\fP .RS 4 eof() to indicate failure, something else (usually \fIc\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 'consumed', with 'some effect' 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 \fIc\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 Definition at line 132 of file stdio_sync_filebuf\&.h\&. .SS "template> virtual \fBint_type\fP \fB__gnu_cxx::stdio_sync_filebuf\fP< _CharT, _Traits >::pbackfail (\fBint_type\fP = \fCtraits_type::eof()\fP)\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP" .PP Tries to back up the input sequence\&. \fBParameters:\fP .RS 4 \fIc\fP The character to be inserted back into the sequence\&. .RE .PP \fBReturns:\fP .RS 4 eof() on failure, 'some other value' on success .RE .PP \fBPostcondition:\fP .RS 4 The constraints of \fC\fBgptr()\fP\fP, \fC\fBeback()\fP\fP, and \fC\fBpptr()\fP\fP are the same as for \fC\fBunderflow()\fP\fP\&. .RE .PP \fBNote:\fP .RS 4 Base class version does nothing, returns eof()\&. .RE .PP .PP Reimplemented from \fBstd::basic_streambuf< _CharT, _Traits >\fP\&. .PP Definition at line 107 of file stdio_sync_filebuf\&.h\&. .SS "template \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 \fBpbase()\fP returns the beginning pointer for the output sequence .IP "\(bu" 2 \fBpptr()\fP returns the next pointer for the output sequence .IP "\(bu" 2 \fBepptr()\fP returns the end pointer for the output sequence .PP .PP Definition at line 505 of file streambuf\&. .SS "template void \fBstd::basic_streambuf\fP< _CharT, _Traits >::pbump (int__n)\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Moving the write position\&. \fBParameters:\fP .RS 4 \fIn\fP The delta by which to move\&. .RE .PP This just advances the write position without returning any data\&. .PP Definition at line 521 of file streambuf\&. .SS "template \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 \fBpbase()\fP returns the beginning pointer for the output sequence .IP "\(bu" 2 \fBpptr()\fP returns the next pointer for the output sequence .IP "\(bu" 2 \fBepptr()\fP returns the end pointer for the output sequence .PP .PP Definition at line 508 of file streambuf\&. .SS "template locale \fBstd::basic_streambuf\fP< _CharT, _Traits >::pubimbue (const \fBlocale\fP &__loc)\fC [inline]\fP, \fC [inherited]\fP" .PP Entry point for \fBimbue()\fP\&. \fBParameters:\fP .RS 4 \fIloc\fP The new locale\&. .RE .PP \fBReturns:\fP .RS 4 The previous locale\&. .RE .PP Calls the derived imbue(loc)\&. .PP Definition at line 204 of file streambuf\&. .SS "template \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 Entry point for \fBimbue()\fP\&. \fBParameters:\fP .RS 4 \fIloc\fP The new locale\&. .RE .PP \fBReturns:\fP .RS 4 The previous locale\&. .RE .PP Calls the derived imbue(loc)\&. .PP Definition at line 238 of file streambuf\&. .SS "template \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 Entry point for \fBimbue()\fP\&. \fBParameters:\fP .RS 4 \fIloc\fP The new locale\&. .RE .PP \fBReturns:\fP .RS 4 The previous locale\&. .RE .PP Calls the derived imbue(loc)\&. .PP Definition at line 243 of file streambuf\&. .SS "template \fB__streambuf_type\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\&. .PP Definition at line 234 of file streambuf\&. .SS "template int \fBstd::basic_streambuf\fP< _CharT, _Traits >::pubsync ()\fC [inline]\fP, \fC [inherited]\fP" .PP Entry point for \fBimbue()\fP\&. \fBParameters:\fP .RS 4 \fIloc\fP The new locale\&. .RE .PP \fBReturns:\fP .RS 4 The previous locale\&. .RE .PP Calls the derived imbue(loc)\&. .PP Definition at line 248 of file streambuf\&. .PP Referenced by std::basic_istream< _CharT, _Traits >::sync()\&. .SS "template \fBint_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::sbumpc ()\fC [inline]\fP, \fC [inherited]\fP" .PP Getting the next character\&. \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 \fC\fBuflow()\fP\fP\&. .PP Definition at line 293 of file streambuf\&. .PP Referenced by std::basic_istream< _CharT, _Traits >::getline(), std::basic_istream< _CharT, _Traits >::ignore(), and std::istreambuf_iterator< _CharT, _Traits >::operator++()\&. .SS "template virtual \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< char_type, traits_type >\fP, and \fBstd::basic_stringbuf< _CharT, _Traits, _Alloc >\fP\&. .PP Definition at line 578 of file streambuf\&. .SS "template virtual \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< char_type, traits_type >\fP, and \fBstd::basic_stringbuf< _CharT, _Traits, _Alloc >\fP\&. .PP Definition at line 590 of file streambuf\&. .SS "template virtual \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 http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch25s02.html 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< char_type, traits_type >\fP, and \fBstd::basic_stringbuf< _CharT, _Traits, _Alloc >\fP\&. .PP Definition at line 567 of file streambuf\&. .SS "template void \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\&. \fBParameters:\fP .RS 4 \fIgbeg\fP A pointer\&. .br \fIgnext\fP A pointer\&. .br \fIgend\fP A pointer\&. .RE .PP \fBPostcondition:\fP .RS 4 \fIgbeg\fP == \fC\fBeback()\fP\fP, \fIgnext\fP == \fC\fBgptr()\fP\fP, and \fIgend\fP == \fC\fBegptr()\fP\fP .RE .PP .PP Definition at line 485 of file streambuf\&. .SS "template void \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\&. \fBParameters:\fP .RS 4 \fIpbeg\fP A pointer\&. .br \fIpend\fP A pointer\&. .RE .PP \fBPostcondition:\fP .RS 4 \fIpbeg\fP == \fC\fBpbase()\fP\fP, \fIpbeg\fP == \fC\fBpptr()\fP\fP, and \fIpend\fP == \fC\fBepptr()\fP\fP .RE .PP .PP Definition at line 531 of file streambuf\&. .SS "template \fBint_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::sgetc ()\fC [inline]\fP, \fC [inherited]\fP" .PP Getting the next character\&. \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 \fC\fBunderflow()\fP\fP\&. Does not move the read position after fetching the character\&. .PP Definition at line 315 of file streambuf\&. .PP 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()\&. .SS "template streamsize \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\&. \fBParameters:\fP .RS 4 \fIs\fP A buffer area\&. .br \fIn\fP A count\&. .RE .PP Returns xsgetn(s,n)\&. The effect is to fill \fIs\fP[0] through \fIs\fP[n-1] with characters from the input sequence, if possible\&. .PP Definition at line 334 of file streambuf\&. .SS "template virtual streamsize \fBstd::basic_streambuf\fP< _CharT, _Traits >::showmanyc ()\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP, \fC [inherited]\fP" .PP Investigating the data available\&. \fBReturns:\fP .RS 4 An estimate of the number of characters available in the input sequence, or -1\&. .RE .PP "If it returns a positive value, then successive calls to \fC\fBunderflow()\fP\fP will not return \fCtraits::eof()\fP until at least that number of characters have been supplied\&. If \fC\fBshowmanyc()\fP\fP returns -1, then calls to \fC\fBunderflow()\fP\fP or \fC\fBuflow()\fP\fP will fail\&." [27\&.5\&.2\&.4\&.3]/1 .PP \fBNote:\fP .RS 4 Base class version does nothing, returns zero\&. .PP The standard adds that "the intention is not only that the calls [to underflow or uflow] will not return \fCeof()\fP but that they will return 'immediately'\&. .PP The standard adds that 'the morphemes of @c showmanyc are 'es-how-many-see', not 'show-manic"\&. .RE .PP .PP Reimplemented in \fBstd::basic_filebuf< _CharT, _Traits >\fP, \fBstd::basic_filebuf< _CharT, encoding_char_traits< _CharT > >\fP, \fBstd::basic_filebuf< char_type, traits_type >\fP, and \fBstd::basic_stringbuf< _CharT, _Traits, _Alloc >\fP\&. .PP Definition at line 625 of file streambuf\&. .SS "template \fBint_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::snextc ()\fC [inline]\fP, \fC [inherited]\fP" .PP Getting the next character\&. \fBReturns:\fP .RS 4 The next character, or eof\&. .RE .PP Calls \fC\fBsbumpc()\fP\fP, and if that function returns \fCtraits::eof()\fP, so does this function\&. Otherwise, \fC\fBsgetc()\fP\fP\&. .PP Definition at line 275 of file streambuf\&. .PP 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()\&. .SS "template \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\&. \fBParameters:\fP .RS 4 \fIc\fP The character to push back\&. .RE .PP \fBReturns:\fP .RS 4 The previous character, if possible\&. .RE .PP Similar to \fBsungetc()\fP, but \fIc\fP is pushed onto the stream instead of 'the previous character'\&. If successful, the next character fetched from the input stream will be \fIc\fP\&. .PP Definition at line 348 of file streambuf\&. .PP Referenced by std::basic_istream< _CharT, _Traits >::putback()\&. .SS "template \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\&. \fBParameters:\fP .RS 4 \fIc\fP A character to output\&. .RE .PP \fBReturns:\fP .RS 4 \fIc\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 \fIc\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 Definition at line 400 of file streambuf\&. .PP Referenced by std::basic_istream< _CharT, _Traits >::get(), and std::ostreambuf_iterator< _CharT, _Traits >::operator=()\&. .SS "template streamsize \fBstd::basic_streambuf\fP< _CharT, _Traits >::sputn (const \fBchar_type\fP *__s, \fBstreamsize\fP__n)\fC [inline]\fP, \fC [inherited]\fP" .PP Entry point for all single-character output functions\&. \fBParameters:\fP .RS 4 \fIs\fP A buffer read area\&. .br \fIn\fP A count\&. .RE .PP One of two public output functions\&. .PP Returns xsputn(s,n)\&. The effect is to write \fIs\fP[0] through \fIs\fP[n-1] to the output sequence, if possible\&. .PP Definition at line 426 of file streambuf\&. .SS "template void \fBstd::basic_streambuf\fP< _CharT, _Traits >::stossc ()\fC [inline]\fP, \fC [inherited]\fP" .PP Tosses a character\&. Advances the read pointer, ignoring the character that would have been read\&. .PP See http://gcc.gnu.org/ml/libstdc++/2002-05/msg00168.html .PP Definition at line 758 of file streambuf\&. .SS "template \fBint_type\fP \fBstd::basic_streambuf\fP< _CharT, _Traits >::sungetc ()\fC [inline]\fP, \fC [inherited]\fP" .PP Moving backwards in the input stream\&. \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 \fBpbackfail()\fP\&. The effect is to 'unget' the last character 'gotten'\&. .PP Definition at line 373 of file streambuf\&. .PP Referenced by std::basic_istream< _CharT, _Traits >::unget()\&. .SS "template> virtual int \fB__gnu_cxx::stdio_sync_filebuf\fP< _CharT, _Traits >::sync (void)\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP" .PP Synchronizes the buffer arrays with the controlled sequences\&. \fBReturns:\fP .RS 4 -1 on failure\&. .RE .PP Each derived class provides its own appropriate behavior, including the definition of 'failure'\&. .PP \fBNote:\fP .RS 4 Base class version does nothing, returns zero\&. .RE .PP .PP Reimplemented from \fBstd::basic_streambuf< _CharT, _Traits >\fP\&. .PP Definition at line 151 of file stdio_sync_filebuf\&.h\&. .SS "template> virtual \fBint_type\fP \fB__gnu_cxx::stdio_sync_filebuf\fP< _CharT, _Traits >::uflow ()\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP" .PP Fetches more data from the controlled sequence\&. \fBReturns:\fP .RS 4 The first character from the \fIpending sequence\fP\&. .RE .PP Informally, this function does the same thing as \fC\fBunderflow()\fP\fP, and in fact is required to call that function\&. It also returns the new character, like \fC\fBunderflow()\fP\fP does\&. However, this function also moves the read position forward by one\&. .PP Reimplemented from \fBstd::basic_streambuf< _CharT, _Traits >\fP\&. .PP Definition at line 99 of file stdio_sync_filebuf\&.h\&. .SS "template> virtual \fBint_type\fP \fB__gnu_cxx::stdio_sync_filebuf\fP< _CharT, _Traits >::underflow ()\fC [inline]\fP, \fC [protected]\fP, \fC [virtual]\fP" .PP Fetches more data from the controlled sequence\&. \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 'refilled'\&. 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 http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch25.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 Definition at line 92 of file stdio_sync_filebuf\&.h\&. .SS "template> virtual \fBstd::streamsize\fP \fB__gnu_cxx::stdio_sync_filebuf\fP< _CharT, _Traits >::xsgetn (\fBchar_type\fP *__s, \fBstd::streamsize\fP__n)\fC [protected]\fP, \fC [virtual]\fP" .PP Multiple character extraction\&. \fBParameters:\fP .RS 4 \fIs\fP A buffer area\&. .br \fIn\fP Maximum number of characters to assign\&. .RE .PP \fBReturns:\fP .RS 4 The number of characters assigned\&. .RE .PP Fills \fIs\fP[0] through \fIs\fP[n-1] with characters from the input sequence, as if by \fC\fBsbumpc()\fP\fP\&. Stops when either \fIn\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 from \fBstd::basic_streambuf< _CharT, _Traits >\fP\&. .SS "template> virtual \fBstd::streamsize\fP \fB__gnu_cxx::stdio_sync_filebuf\fP< _CharT, _Traits >::xsputn (const \fBchar_type\fP *__s, \fBstd::streamsize\fP__n)\fC [protected]\fP, \fC [virtual]\fP" .PP Multiple character insertion\&. \fBParameters:\fP .RS 4 \fIs\fP A buffer area\&. .br \fIn\fP Maximum number of characters to write\&. .RE .PP \fBReturns:\fP .RS 4 The number of characters written\&. .RE .PP Writes \fIs\fP[0] through \fIs\fP[n-1] to the output sequence, as if by \fC\fBsputc()\fP\fP\&. Stops when either \fIn\fP characters have been copied, or when \fC\fBsputc()\fP\fP would return \fCtraits::eof()\fP\&. .PP It is expected that derived classes provide a more efficient implementation by overriding this definition\&. .PP Reimplemented from \fBstd::basic_streambuf< _CharT, _Traits >\fP\&. .SH "Member Data Documentation" .PP .SS "template locale \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_buf_locale\fC [protected]\fP, \fC [inherited]\fP" .PP Current locale setting\&. .PP Definition at line 187 of file streambuf\&. .PP Referenced by std::basic_filebuf< _CharT, _Traits >::basic_filebuf()\&. .SS "template \fBchar_type\fP* \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_in_beg\fC [protected]\fP, \fC [inherited]\fP" 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\&. .IP "\(bu" 2 get == input == read .IP "\(bu" 2 put == output == write .PP .PP Definition at line 179 of file streambuf\&. .SS "template \fBchar_type\fP* \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_in_cur\fC [protected]\fP, \fC [inherited]\fP" .PP Entry point for \fBimbue()\fP\&. \fBParameters:\fP .RS 4 \fIloc\fP The new locale\&. .RE .PP \fBReturns:\fP .RS 4 The previous locale\&. .RE .PP Calls the derived imbue(loc)\&. .PP Definition at line 180 of file streambuf\&. .SS "template \fBchar_type\fP* \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_in_end\fC [protected]\fP, \fC [inherited]\fP" .PP Entry point for \fBimbue()\fP\&. \fBParameters:\fP .RS 4 \fIloc\fP The new locale\&. .RE .PP \fBReturns:\fP .RS 4 The previous locale\&. .RE .PP Calls the derived imbue(loc)\&. .PP Definition at line 181 of file streambuf\&. .SS "template \fBchar_type\fP* \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_out_beg\fC [protected]\fP, \fC [inherited]\fP" .PP Entry point for \fBimbue()\fP\&. \fBParameters:\fP .RS 4 \fIloc\fP The new locale\&. .RE .PP \fBReturns:\fP .RS 4 The previous locale\&. .RE .PP Calls the derived imbue(loc)\&. .PP Definition at line 182 of file streambuf\&. .SS "template \fBchar_type\fP* \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_out_cur\fC [protected]\fP, \fC [inherited]\fP" .PP Entry point for \fBimbue()\fP\&. \fBParameters:\fP .RS 4 \fIloc\fP The new locale\&. .RE .PP \fBReturns:\fP .RS 4 The previous locale\&. .RE .PP Calls the derived imbue(loc)\&. .PP Definition at line 183 of file streambuf\&. .SS "template \fBchar_type\fP* \fBstd::basic_streambuf\fP< _CharT, _Traits >::_M_out_end\fC [protected]\fP, \fC [inherited]\fP" .PP Entry point for \fBimbue()\fP\&. \fBParameters:\fP .RS 4 \fIloc\fP The new locale\&. .RE .PP \fBReturns:\fP .RS 4 The previous locale\&. .RE .PP Calls the derived imbue(loc)\&. .PP Definition at line 184 of file streambuf\&. .SH "Author" .PP Generated automatically by Doxygen for libstdc++ from the source code\&.