__gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >(3cxx) | __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >(3cxx) |
NAME¶
__gnu_cxx::stdio_sync_filebuf< _CharT, _Traits > -SYNOPSIS¶
Inherits std::basic_streambuf< _CharT, _Traits >.Public Types¶
typedef _CharT char_type
typedef basic_streambuf
Public Member Functions¶
stdio_sync_filebuf (std::__c_file *__f)
Protected Member Functions¶
void __safe_gbump (streamsize __n)
char_type * eback () const
char_type * pbase () const
locale pubimbue (const locale &__loc)
Detailed Description¶
template<typename _CharT, typename _Traits = std::char_traits<_CharT>>class __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >¶
Provides a layer of compatibility for C. This GNU extension provides extensions for working with standard C FILE*'s. It must be instantiated by the user with the type of character used in the file stream, e.g., stdio_filebuf<char>. Definition at line 57 of file stdio_sync_filebuf.h.Member Typedef Documentation¶
template<typename _CharT, typename _Traits> typedef basic_streambuf< char_type, traits_type> std::basic_streambuf< _CharT, _Traits >:: __streambuf_type [inherited]¶
This is a non-standard type. Definition at line 135 of file streambuf.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
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::egptr () 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
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::epptr () 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
template<typename _CharT , typename _Traits = std::char_traits<_CharT>> std::__c_file* const __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >::file () [inline]¶
Returns:The underlying FILE*.
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.
Definition at line 89 of file stdio_sync_filebuf.h.
template<typename _CharT, typename _Traits> void std::basic_streambuf< _CharT, _Traits >::gbump (int__n) [inline], [protected], [inherited]¶
Moving the read position. Parameters:__n The delta by which to move.
This just advances the read position without returning any data.
Definition at line 496 of file streambuf.
Referenced by std::basic_streambuf< char_type, traits_type >::sbumpc(),
std::basic_streambuf< char_type, traits_type >::sputbackc(),
std::basic_streambuf< char_type, traits_type >::sungetc(), and
std::basic_streambuf< char_type, traits_type >::uflow().
template<typename _CharT, typename _Traits> locale std::basic_streambuf< _CharT, _Traits >::getloc () const [inline], [inherited]¶
Locale access. Returns:The current locale in effect.
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 224 of file streambuf.
Referenced by std::basic_streambuf< char_type, traits_type >::pubimbue().
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::gptr () 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
template<typename _CharT, typename _Traits> virtual void std::basic_streambuf< _CharT, _Traits >::imbue (const locale &__loc) [inline], [protected], [virtual], [inherited]¶
Changes translations. Parameters:__loc A new locale.
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:
Base class version does nothing.
template<typename _CharT, typename _Traits> streamsize std::basic_streambuf< _CharT, _Traits >::in_avail () [inline], [inherited]¶
Looking ahead into the stream. Returns:The number of characters available.
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 282 of file streambuf.
template<typename _CharT , typename _Traits = std::char_traits<_CharT>> virtual int_type __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >::overflow ( int_type__c = traits_type::eof()) [inline], [protected], [virtual]¶
Consumes data from the buffer; writes to the controlled sequence. Parameters:__c An additional character to
consume.
Returns:
eof() to indicate failure, something else
(usually __c, or not_eof())
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:
Base class version does nothing, returns
eof().
template<typename _CharT , typename _Traits = std::char_traits<_CharT>> virtual int_type __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >::pbackfail ( int_type__c = traits_type::eof()) [inline], [protected], [virtual]¶
Tries to back up the input sequence. Parameters:__c The character to be inserted back
into the sequence.
Returns:
eof() on failure, some other value on
success
Postcondition:
The constraints of gptr(),
eback() , and pptr() are the same as for
underflow() .
Note:
Base class version does nothing, returns
eof().
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
template<typename _CharT, typename _Traits> void std::basic_streambuf< _CharT, _Traits >::pbump (int__n) [inline], [protected], [inherited]¶
Moving the write position. Parameters:__n The delta by which to move.
This just advances the write position without returning any data.
Definition at line 543 of file streambuf.
Referenced by std::basic_streambuf< char_type, traits_type >::sputc().
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::pptr () 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
template<typename _CharT, typename _Traits> locale std::basic_streambuf< _CharT, _Traits >::pubimbue (const locale &__loc) [inline], [inherited]¶
Entry point for imbue(). Parameters:__loc The new locale.
Returns:
The previous locale.
Calls the derived imbue(__loc).
Definition at line 207 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]¶
Alters the stream position. Parameters:__off Offset.
__way Value for ios_base::seekdir.
__mode Value for ios_base::openmode.
Calls virtual seekoff function.
Definition at line 249 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]¶
Alters the stream position. Parameters:__sp Position
__mode Value for ios_base::openmode.
Calls virtual seekpos function.
Definition at line 261 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 237 of file streambuf.template<typename _CharT, typename _Traits> int std::basic_streambuf< _CharT, _Traits >::pubsync () [inline], [inherited]¶
Calls virtual sync function. Definition at line 269 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:The next character, or eof.
If the input read position is available, returns that character and increments
the read pointer, otherwise calls and returns uflow().
Definition at line 314 of file streambuf.
Referenced by std::basic_istream< _CharT, _Traits >::getline(),
std::basic_istream< _CharT, _Traits >::ignore(),
std::istreambuf_iterator< _CharT, _Traits >::operator++(), and
std::basic_streambuf< char_type, traits_type >::snextc().
template<typename _CharT, typename _Traits> virtual pos_type std::basic_streambuf< _CharT, _Traits >::seekoff ( off_type, ios_base::seekdir, ios_base::openmode = ios_base::in | ios_base::out) [inline], [protected] , [virtual], [inherited]¶
Alters the stream positions. Each derived class provides its own appropriate behavior. Note:Base class version does nothing, returns a
pos_type that represents an invalid stream position.
template<typename _CharT, typename _Traits> virtual pos_type std::basic_streambuf< _CharT, _Traits >::seekpos ( pos_type, ios_base::openmode = ios_base::in | ios_base::out ) [inline], [protected], [virtual], [inherited]¶
Alters the stream positions. Each derived class provides its own appropriate behavior. Note:Base class version does nothing, returns a
pos_type that represents an invalid stream position.
template<typename _CharT, typename _Traits> virtual basic_streambuf< char_type,_Traits>* std::basic_streambuf< _CharT, _Traits >::setbuf ( char_type *, streamsize) [inline], [protected], [virtual], [inherited]¶
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. Note:Base class version does nothing, returns
this.
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:__gbeg A pointer.
__gnext A pointer.
__gend A pointer.
Postcondition:
__gbeg == eback(),
__gnext == gptr(), and __gend ==
egptr()
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:__pbeg A pointer.
__pend A pointer.
Postcondition:
__pbeg == pbase(),
__pbeg == pptr(), and __pend ==
epptr()
template<typename _CharT, typename _Traits> int_type std::basic_streambuf< _CharT, _Traits >::sgetc () [inline], [inherited]¶
Getting the next character. Returns:The next character, or eof.
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 336 of file streambuf.
Referenced by std::basic_istream< _CharT, _Traits >::get(),
std::basic_istream< _CharT, _Traits >::getline(), std::basic_istream<
_CharT, _Traits >::ignore(), std::basic_istream< _CharT, _Traits
>::sentry::sentry(), and std::basic_streambuf< char_type, traits_type
>::snextc().
template<typename _CharT, typename _Traits> streamsize std::basic_streambuf< _CharT, _Traits >::sgetn ( char_type *__s, streamsize__n) [inline], [inherited]¶
Entry point for xsgetn. Parameters:__s A buffer area.
__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 355 of file streambuf.
template<typename _CharT, typename _Traits> virtual streamsize std::basic_streambuf< _CharT, _Traits >::showmanyc () [inline], [protected], [virtual], [inherited]¶
Investigating the data available. Returns:An estimate of the number of characters
available in the input sequence, or -1.
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:
Base class version does nothing, returns zero.
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 showmanyc are
es-how-many-see , not show-manic.
template<typename _CharT, typename _Traits> int_type std::basic_streambuf< _CharT, _Traits >::snextc () [inline], [inherited]¶
Getting the next character. Returns:The next character, or eof.
Calls sbumpc(), and if that function returns traits::eof(), so
does this function. Otherwise, sgetc().
Definition at line 296 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:__c The character to push back.
Returns:
The previous character, if possible.
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 370 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:__c A character to output.
Returns:
__c, if possible.
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 422 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:__s A buffer read area.
__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 448 of file streambuf.
template<typename _CharT, typename _Traits> int_type std::basic_streambuf< _CharT, _Traits >::sungetc () [inline], [inherited]¶
Moving backwards in the input stream. Returns:The previous character, if possible.
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 395 of file streambuf.
Referenced by std::basic_istream< _CharT, _Traits >::unget().
template<typename _CharT , typename _Traits = std::char_traits<_CharT>> virtual int __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >::sync (void) [inline], [protected], [virtual]¶
Synchronizes the buffer arrays with the controlled sequences. Returns:-1 on failure.
Each derived class provides its own appropriate behavior, including the
definition of failure.
Note:
Base class version does nothing, returns
zero.
template<typename _CharT , typename _Traits = std::char_traits<_CharT>> virtual int_type __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >::uflow () [inline], [protected], [virtual]¶
Fetches more data from the controlled sequence. Returns:The first character from the pending
sequence.
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 from std::basic_streambuf< _CharT, _Traits >.
Definition at line 109 of file stdio_sync_filebuf.h.
template<typename _CharT , typename _Traits = std::char_traits<_CharT>> virtual int_type __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >::underflow () [inline], [protected], [virtual]¶
Fetches more data from the controlled sequence. Returns:The first character from the pending
sequence.
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:
Base class version does nothing, returns
eof().
template<typename _CharT , typename _Traits > streamsize basic_streambuf< _CharT, _Traits >::xsgetn (char_type *__s, streamsize__n) [protected], [virtual], [inherited]¶
Multiple character extraction. Parameters:__s A buffer area.
__n Maximum number of characters to assign.
Returns:
The number of characters assigned.
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 >,
std::basic_filebuf< _CharT, encoding_char_traits< _CharT >
>, and std::basic_filebuf< char_type, traits_type >.
Definition at line 47 of file streambuf.tcc.
References std::min().
Referenced by std::basic_streambuf< char_type, traits_type >::sgetn().
template<typename _CharT , typename _Traits > streamsize basic_streambuf< _CharT, _Traits >::xsputn (const char_type *__s, streamsize__n) [protected], [virtual], [inherited]¶
Multiple character insertion. Parameters:__s A buffer area.
__n Maximum number of characters to write.
Returns:
The number of characters written.
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 >,
std::basic_filebuf< _CharT, encoding_char_traits< _CharT >
>, and std::basic_filebuf< char_type, traits_type >.
Definition at line 81 of file streambuf.tcc.
References std::min().
Referenced by std::basic_streambuf< char_type, traits_type >::sputn().
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 190 of file streambuf. Referenced by std::basic_filebuf< _CharT, _Traits >::basic_filebuf(), std::basic_streambuf< char_type, traits_type >::getloc(), and std::basic_streambuf< char_type, traits_type >::pubimbue().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
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::_M_in_cur [protected], [inherited]¶
Entry point for imbue(). Parameters:__loc The new locale.
Returns:
The previous locale.
Calls the derived imbue(__loc).
Definition at line 183 of file streambuf.
Referenced by std::basic_streambuf< char_type, traits_type >::gbump(),
std::basic_streambuf< char_type, traits_type >::gptr(), and
std::basic_streambuf< char_type, traits_type >::setg().
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::_M_in_end [protected], [inherited]¶
Entry point for imbue(). Parameters:__loc The new locale.
Returns:
The previous locale.
Calls the derived imbue(__loc).
Definition at line 184 of file streambuf.
Referenced by std::basic_streambuf< char_type, traits_type >::egptr(), and
std::basic_streambuf< char_type, traits_type >::setg().
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::_M_out_beg [protected], [inherited]¶
Entry point for imbue(). Parameters:__loc The new locale.
Returns:
The previous locale.
Calls the derived imbue(__loc).
Definition at line 185 of file streambuf.
Referenced by std::basic_streambuf< char_type, traits_type >::pbase(), and
std::basic_streambuf< char_type, traits_type >::setp().
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::_M_out_cur [protected], [inherited]¶
Entry point for imbue(). Parameters:__loc The new locale.
Returns:
The previous locale.
Calls the derived imbue(__loc).
Definition at line 186 of file streambuf.
Referenced by std::basic_streambuf< char_type, traits_type >::pbump(),
std::basic_streambuf< char_type, traits_type >::pptr(), and
std::basic_streambuf< char_type, traits_type >::setp().
template<typename _CharT, typename _Traits> char_type* std::basic_streambuf< _CharT, _Traits >::_M_out_end [protected], [inherited]¶
Entry point for imbue(). Parameters:__loc The new locale.
Returns:
The previous locale.
Calls the derived imbue(__loc).
Definition at line 187 of file streambuf.
Referenced by std::basic_streambuf< char_type, traits_type >::epptr(), and
std::basic_streambuf< char_type, traits_type >::setp().
Author¶
Generated automatically by Doxygen for libstdc++ from the source code.Sun Jan 6 2013 | libstdc++ |