| std::basic_fstream< _CharT, _Traits >(3cxx) | std::basic_fstream< _CharT, _Traits >(3cxx) |
NAME¶
std::basic_fstream< _CharT, _Traits > -SYNOPSIS¶
Inherits std::basic_iostream< _CharT, _Traits >.Public Types¶
typedef ctype< _CharT > __ctype_type
typedef num_put< _CharT,
Public Member Functions¶
basic_fstream ()
__istream_type & operator>> (__istream_type &(*__pf)( __istream_type &))
Arithmetic Extractors
__istream_type & operator>> (bool &__n)
Unformatted Input Functions
int_type get ()
operator void * () const
__ostream_type & operator<< (__ostream_type &(*__pf)( __ostream_type &))
Arithmetic Inserters
__ostream_type & operator<< (long __n)
Unformatted Output Functions
__ostream_type & put (char_type __c)
Static Public Member Functions¶
static bool sync_with_stdio (bool __sync=true)
Static Public Attributes¶
static const fmtflags adjustfield
Protected Types¶
enum { _S_local_word_size }
Protected Member Functions¶
void _M_cache_locale (const locale &__loc)
Protected Attributes¶
_Callback_list * _M_callbacks
Detailed Description¶
template<typename _CharT, typename _Traits>class std::basic_fstream< _CharT, _Traits >¶
Controlling input and output for files. This class supports reading from and writing to named files, using the inherited functions from std::basic_iostream. To control the associated sequence, an instance of std::basic_filebuf is used, which this page refers to as sb. Definition at line 761 of file fstream.Member Typedef Documentation¶
template<typename _CharT, typename _Traits> typedef num_put<_CharT, ostreambuf_iterator<_CharT, _Traits> > std::basic_ios< _CharT, _Traits >::__num_put_type [inherited]¶
These are non-standard types. Definition at line 86 of file basic_ios.h.typedef void(* std::ios_base::event_callback)(event, ios_base &, int) [inherited]¶
The type of an event callback function. Parameters:event One of the members of the event
enum.
ios_base Reference to the ios_base
object.
int The integer provided when the callback was registered.
Event callbacks are user defined functions that get called during several
ios_base and basic_ios functions, specifically imbue(),
copyfmt(), and ~ios().
Definition at line 438 of file ios_base.h.
typedef _Ios_Fmtflags std::ios_base::fmtflags [inherited]¶
This is a bitmask type. _Ios_Fmtflags is implementation-defined, but it is valid to perform bitwise operations on these values and expect the Right Thing to happen. Defined objects of type fmtflags are:- •
- boolalpha
- •
- dec
- •
- fixed
- •
- hex
- •
- internal
- •
- left
- •
- oct
- •
- right
- •
- scientific
- •
- showbase
- •
- showpoint
- •
- showpos
- •
- skipws
- •
- unitbuf
- •
- uppercase
- •
- adjustfield
- •
- basefield
- •
- floatfield
typedef _Ios_Iostate std::ios_base::iostate [inherited]¶
This is a bitmask type. _Ios_Iostate is implementation-defined, but it is valid to perform bitwise operations on these values and expect the Right Thing to happen. Defined objects of type iostate are:- •
- badbit
- •
- eofbit
- •
- failbit
- •
- goodbit
typedef _Ios_Openmode std::ios_base::openmode [inherited]¶
This is a bitmask type. _Ios_Openmode is implementation-defined, but it is valid to perform bitwise operations on these values and expect the Right Thing to happen. Defined objects of type openmode are:- •
- app
- •
- ate
- •
- binary
- •
- in
- •
- out
- •
- trunc
typedef _Ios_Seekdir std::ios_base::seekdir [inherited]¶
This is an enumerated type. _Ios_Seekdir is implementation-defined. Defined values of type seekdir are:- •
- beg
- •
- cur, equivalent to SEEK_CUR in the C standard library.
- •
- end, equivalent to SEEK_END in the C standard library.
Member Enumeration Documentation¶
enum std::ios_base::event [inherited]¶
The set of events that may be passed to an event callback. erase_event is used during ~ios() and copyfmt(). imbue_event is used during imbue(). copyfmt_event is used during copyfmt(). Definition at line 421 of file ios_base.h.Constructor & Destructor Documentation¶
template<typename _CharT , typename _Traits > std::basic_fstream< _CharT, _Traits >:: basic_fstream () [inline]¶
Default constructor. Initializes sb using its default constructor, and passes &sb to the base class initializer. Does not open any files (you haven't given it a filename to open). Definition at line 788 of file fstream. References std::basic_ios< _CharT, _Traits >::init().template<typename _CharT , typename _Traits > std::basic_fstream< _CharT, _Traits >:: basic_fstream (const char *__s, ios_base::openmode__mode = ios_base::in | ios_base::out ) [inline], [explicit]¶
Create an input/output file stream. Parameters:s Null terminated string specifying the
filename.
mode Open file in specified mode (see std::ios_base).
Tip: When using std::string to hold the filename, you must use .c_str() before
passing it to this constructor.
Definition at line 801 of file fstream.
References std::basic_ios< _CharT, _Traits >::init(), and
std::basic_fstream< _CharT, _Traits >::open().
template<typename _CharT , typename _Traits > std::basic_fstream< _CharT, _Traits >:: basic_fstream (const std::string &__s, ios_base::openmode__mode = ios_base::in | ios_base::out) [inline], [explicit] ¶
Create an input/output file stream. Parameters:s Null terminated string specifying the
filename.
mode Open file in specified mode (see std::ios_base).
template<typename _CharT , typename _Traits > std::basic_fstream< _CharT, _Traits >::~ basic_fstream () [inline]¶
The destructor does nothing. The file is closed by the filebuf object, not the formatting stream. Definition at line 831 of file fstream.Member Function Documentation¶
const locale& std::ios_base::_M_getloc () const [inline], [inherited]¶
Locale access. Returns:A reference to the current locale.
Like getloc above, but returns a reference instead of generating a copy.
Definition at line 708 of file ios_base.h.
Referenced by std::money_get< _CharT, _InIter >::do_get(),
std::num_get< _CharT, _InIter >::do_get(), std::time_get< _CharT,
_InIter >::do_get_date(), std::time_get< _CharT, _InIter
>::do_get_monthname(), std::time_get< _CharT, _InIter
>::do_get_time(), std::time_get< _CharT, _InIter >::do_get_weekday(),
std::time_get< _CharT, _InIter >::do_get_year(), std::time_put<
_CharT, _OutIter >::do_put(), std::num_put< _CharT, _OutIter
>::do_put(), and std::time_put< _CharT, _OutIter >::put().
template<typename _CharT, typename _Traits> void std::basic_ostream< _CharT, _Traits >::_M_write (const char_type *__s, streamsize__n) [inline], [inherited]¶
Simple insertion. Parameters:c The character to insert.
Returns:
*this
Tries to insert c.
Note:
This function is not overloaded on signed char
and unsigned char.
template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT, _Traits >::bad () const [inline], [inherited]¶
Fast error checking. Returns:True if the badbit is set.
Note that other iostate flags may also be set.
Definition at line 203 of file basic_ios.h.
template<typename _CharT , typename _Traits > void std::basic_ios< _CharT, _Traits >::clear ( iostate__state = goodbit) [inherited]¶
[Re]sets the error state. Parameters:state The new state flag(s) to
set.
See std::ios_base::iostate for the possible bit values. Most users will
not need to pass an argument.
Definition at line 42 of file basic_ios.tcc.
Referenced by std::basic_ios< char, _Traits >::exceptions(),
std::basic_ifstream< _CharT, _Traits >::open(), std::basic_ofstream<
_CharT, _Traits >::open(), std::basic_fstream< _CharT, _Traits
>::open(), std::basic_istream< _CharT, _Traits >::putback(),
std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ios< char,
_Traits >::setstate(), and std::basic_istream< _CharT, _Traits
>::unget().
template<typename _CharT , typename _Traits > void std::basic_fstream< _CharT, _Traits >::close () [inline]¶
Close the file. Calls std::basic_filebuf::close(). If that function fails, failbit is set in the stream's error state. Definition at line 911 of file fstream. References std::basic_filebuf< _CharT, _Traits >::close(), std::ios_base::failbit, and std::basic_ios< _CharT, _Traits >::setstate().template<typename _CharT , typename _Traits > basic_ios< _CharT, _Traits > & std::basic_ios< _CharT, _Traits >::copyfmt (const basic_ios< _CharT, _Traits > &__rhs) [inherited]¶
Copies fields of __rhs into this. Parameters:__rhs The source values for the
copies.
Returns:
Reference to this object.
All fields of __rhs are copied into this object except that rdbuf() and
rdstate() remain unchanged. All values in the pword and iword arrays
are copied. Before copying, each callback is invoked with erase_event. After
copying, each (new) callback is invoked with copyfmt_event. The final step is
to copy exceptions().
Definition at line 64 of file basic_ios.tcc.
References std::basic_ios< _CharT, _Traits >::exceptions(),
std::basic_ios< _CharT, _Traits >::fill(), std::ios_base::flags(),
std::ios_base::getloc(), std::ios_base::precision(), std::basic_ios<
_CharT, _Traits >::tie(), and std::ios_base::width().
template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT, _Traits >::eof () const [inline], [inherited]¶
Fast error checking. Returns:True if the eofbit is set.
Note that other iostate flags may also be set.
Definition at line 182 of file basic_ios.h.
Referenced by std::basic_istream< _CharT, _Traits >::get(),
std::basic_istream< _CharT, _Traits >::getline(), std::basic_istream<
_CharT, _Traits >::ignore(), std::operator>>(),
std::basic_istream< _CharT, _Traits >::peek(), std::basic_istream<
_CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits
>::sentry::sentry(), std::basic_istream< _CharT, _Traits >::unget(),
and std::ws().
template<typename _CharT, typename _Traits> iostate std::basic_ios< _CharT, _Traits >::exceptions () const [inline], [inherited]¶
Throwing exceptions on errors. Returns:The current exceptions mask.
This changes nothing in the stream. See the one-argument version of
exceptions(iostate) for the meaning of the return value.
Definition at line 214 of file basic_ios.h.
Referenced by std::basic_ios< _CharT, _Traits >::copyfmt().
template<typename _CharT, typename _Traits> void std::basic_ios< _CharT, _Traits >::exceptions ( iostate__except) [inline], [inherited]¶
Throwing exceptions on errors. Parameters:except The new exceptions mask.
By default, error flags are set silently. You can set an exceptions mask for
each stream; if a bit in the mask becomes set in the error flags, then an
exception of type std::ios_base::failure is thrown.
If the error flag is already set when the exceptions mask is added, the
exception is immediately thrown. Try running the following under GCC 3.1 or
later:
#include <iostream>
#include <fstream>
#include <exception>
int main()
{
std::set_terminate (__gnu_cxx::__verbose_terminate_handler);
std::ifstream f ('/etc/motd');
std::cerr << 'Setting badbit0;
f.setstate (std::ios_base::badbit);
std::cerr << 'Setting exception mask0;
f.exceptions (std::ios_base::badbit);
}
template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT, _Traits >::fail () const [inline], [inherited]¶
Fast error checking. Returns:True if either the badbit or the failbit is
set.
Checking the badbit in fail() is historical practice. Note that other
iostate flags may also be set.
Definition at line 193 of file basic_ios.h.
Referenced by std::basic_ios< char, _Traits >::operator void *(),
std::basic_ios< char, _Traits >::operator!(), std::basic_istream<
_CharT, _Traits >::seekg(), std::basic_ostream< _CharT, _Traits
>::seekp(), std::basic_istream< _CharT, _Traits >::tellg(),
std::basic_ostream< _CharT, _Traits >::tellp(), and
std::regex_traits< _Ch_type >::value().
template<typename _CharT, typename _Traits> char_type std::basic_ios< _CharT, _Traits >::fill () const [inline], [inherited]¶
Retrieves the empty character. Returns:The current fill character.
It defaults to a space (' ') in the current locale.
Definition at line 362 of file basic_ios.h.
Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(), and
std::basic_ios< char, _Traits >::fill().
template<typename _CharT, typename _Traits> char_type std::basic_ios< _CharT, _Traits >::fill ( char_type__ch) [inline], [inherited]¶
Sets a new empty character. Parameters:ch The new character.
Returns:
The previous fill character.
The fill character is used to fill out space when P+ characters have been
requested (e.g., via setw), Q characters are actually used, and Q<P. It
defaults to a space (' ') in the current locale.
Definition at line 382 of file basic_ios.h.
fmtflags std::ios_base::flags () const [inline], [inherited]¶
Access to format flags. Returns:The format control flags for both input and
output.
fmtflags std::ios_base::flags (fmtflags__fmtfl) [inline], [inherited]¶
Setting new format flags all at once. Parameters:fmtfl The new flags to set.
Returns:
The previous format control flags.
This function overwrites all the format flags with fmtfl.
Definition at line 564 of file ios_base.h.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::flush () [inherited]¶
Synchronizing the stream buffer. Returns:*this
If rdbuf() is a null pointer, changes nothing.
Otherwise, calls rdbuf()->pubsync(), and if that returns -1, sets
badbit.
Definition at line 213 of file ostream.tcc.
References std::ios_base::badbit, std::ios_base::goodbit, std::basic_ios<
_CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits
>::setstate().
Referenced by std::flush().
template<typename _CharT, typename _Traits> streamsize std::basic_istream< _CharT, _Traits >::gcount () const [inline], [inherited]¶
Character counting. Returns:The number of characters extracted by the
previous unformatted input function dispatched for this stream.
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits >::int_type std::basic_istream< _CharT, _Traits >::get (void) [inherited]¶
Simple extraction. Returns:A character, or eof().
Tries to extract a character. If none are available, sets failbit and returns
traits::eof().
Definition at line 238 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, std::basic_ios< _CharT, _Traits >::eof(),
std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit,
std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios<
_CharT, _Traits >::setstate().
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::get (char_type &__c) [inherited]¶
Simple extraction. Parameters:c The character in which to store
data.
Returns:
*this
Tries to extract a character and store it in c. If none are available,
sets failbit and returns traits::eof().
Note:
This function is not overloaded on signed char
and unsigned char.
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::get (char_type *__s, streamsize__n, char_type__delim) [inherited]¶
Simple multiple-character extraction. Parameters:s Pointer to an array.
n Maximum number of characters to store in s.
delim A 'stop' character.
Returns:
*this
Characters are extracted and stored into s until one of the following
happens:
- •
- n-1 characters are stored
- •
- the input sequence reaches EOF
- •
- the next character equals delim, in which case the character is not extracted
This function is not overloaded on signed char
and unsigned char.
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::get (char_type *__s, streamsize__n) [inline], [inherited]¶
Simple multiple-character extraction. Parameters:s Pointer to an array.
n Maximum number of characters to store in s.
Returns:
*this
Returns get(s,n,widen('\n')).
Definition at line 335 of file istream.
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::get ( __streambuf_type &__sb, char_type__delim) [inherited]¶
Extraction into another streambuf. Parameters:sb A streambuf in which to store data.
delim A 'stop' character.
Returns:
*this
Characters are extracted and inserted into sb until one of the following
happens:
- •
- the input sequence reaches EOF
- •
- insertion into the output buffer fails (in this case, the character that would have been inserted is not extracted)
- •
- the next character equals delim (in this case, the character is not extracted)
- •
- an exception occurs (and in this case is caught)
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::get ( __streambuf_type &__sb) [inline], [inherited]¶
Extraction into another streambuf. Parameters:sb A streambuf in which to store
data.
Returns:
*this
Returns get(sb,widen('\n')).
Definition at line 368 of file istream.
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::getline (char_type *__s, streamsize__n, char_type__delim) [inherited]¶
String extraction. Parameters:s A character array in which to store
the data.
n Maximum number of characters to extract.
delim A 'stop' character.
Returns:
*this
Extracts and stores characters into s until one of the following happens.
Note that these criteria are required to be tested in the order listed here,
to allow an input line to exactly fill the s array without setting
failbit.
- 1.
- the input sequence reaches end-of-file, in which case eofbit is set in the stream error state
- 2.
- the next character equals delim, in which case the character is extracted (and therefore counted in gcount()) but not stored
- 3.
- n-1 characters are stored, in which case failbit is set in the stream error state
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::getline (char_type *__s, streamsize__n) [inline], [inherited]¶
String extraction. Parameters:s A character array in which to store
the data.
n Maximum number of characters to extract.
Returns:
*this
Returns getline(s,n,widen('\n')).
Definition at line 408 of file istream.
Referenced by std::basic_istream< char >::getline().
locale std::ios_base::getloc () const [inline], [inherited]¶
Locale access. Returns:A copy of the current locale.
If imbue(loc) has previously been called, then this function returns loc.
Otherwise, it returns a copy of std::locale(), the global C++ locale.
Definition at line 697 of file ios_base.h.
Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(),
std::money_put< _CharT, _OutIter >::do_put(), std::operator>>(),
and std::ws().
template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT, _Traits >::good () const [inline], [inherited]¶
Fast error checking. Returns:True if no error flags are set.
A wrapper around rdstate.
Definition at line 172 of file basic_ios.h.
Referenced by std::basic_ostream< _CharT, _Traits >::sentry::sentry(), and
std::basic_istream< _CharT, _Traits >::sentry::sentry().
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::ignore (void) [inherited]¶
Discarding characters. Parameters:n Number of characters to discard.
delim A 'stop' character.
Returns:
*this
Extracts characters and throws them away until one of the following happens:
- •
- if n != std::numeric_limits<int>::max(), n characters are extracted
- •
- the input sequence reaches end-of-file
- •
- the next character equals delim (in this case, the character is extracted); note that this condition will never occur if delim equals traits::eof().
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::ignore ( streamsize__n) [inherited]¶
Simple extraction. Returns:A character, or eof().
Tries to extract a character. If none are available, sets failbit and returns
traits::eof().
Definition at line 495 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, std::basic_ios< _CharT, _Traits >::eof(),
std::ios_base::eofbit, std::ios_base::goodbit, std::basic_ios< _CharT,
_Traits >::rdbuf(), std::basic_ios< _CharT, _Traits >::setstate(),
std::basic_streambuf< _CharT, _Traits >::sgetc(), and
std::basic_streambuf< _CharT, _Traits >::snextc().
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::ignore ( streamsize__n, int_type__delim) [inherited]¶
Simple extraction. Returns:A character, or eof().
Tries to extract a character. If none are available, sets failbit and returns
traits::eof().
Definition at line 557 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, std::basic_ios< _CharT, _Traits >::eof(),
std::ios_base::eofbit, std::ios_base::goodbit, std::basic_ios< _CharT,
_Traits >::rdbuf(), std::basic_streambuf< _CharT, _Traits
>::sbumpc(), std::basic_ios< _CharT, _Traits >::setstate(),
std::basic_streambuf< _CharT, _Traits >::sgetc(), and
std::basic_streambuf< _CharT, _Traits >::snextc().
template<typename _CharT , typename _Traits > locale std::basic_ios< _CharT, _Traits >::imbue (const locale &__loc) [inherited]¶
Moves to a new locale. Parameters:loc The new locale.
Returns:
The previous locale.
Calls ios_base::imbue(loc), and if a stream buffer is associated with this
stream, calls that buffer's pubimbue(loc).
Additional l10n notes are at
http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html
Reimplemented from std::ios_base.
Definition at line 115 of file basic_ios.tcc.
References std::ios_base::imbue().
Referenced by std::operator<<().
template<typename _CharT, typename _Traits> void std::basic_ios< _CharT, _Traits >::init ( basic_streambuf< _CharT, _Traits > *__sb) [protected], [inherited]¶
All setup is performed here. This is called from the public constructor. It is not virtual and cannot be redefined. Definition at line 127 of file basic_ios.tcc. Referenced by std::basic_fstream< _CharT, _Traits >::basic_fstream(), std::basic_ifstream< _CharT, _Traits >::basic_ifstream(), std::basic_ios< char, _Traits >::basic_ios(), std::basic_istream< char >::basic_istream(), std::basic_istringstream< _CharT, _Traits, _Alloc >::basic_istringstream(), std::basic_ofstream< _CharT, _Traits >::basic_ofstream(), std::basic_ostream< char >::basic_ostream(), std::basic_ostringstream< _CharT, _Traits, _Alloc >::basic_ostringstream(), and std::basic_stringstream< _CharT, _Traits, _Alloc >::basic_stringstream().template<typename _CharT , typename _Traits > bool std::basic_fstream< _CharT, _Traits >::is_open () [inline]¶
Wrapper to test for an open file. Returns:rdbuf()->is_open()
long& std::ios_base::iword (int__ix) [inline], [inherited]¶
Access to integer array. Parameters:__ix Index into the array.
Returns:
A reference to an integer associated with the
index.
The iword function provides access to an array of integers that can be used for
any purpose. The array grows as required to hold the supplied index. All
integers in the array are initialized to 0.
The implementation reserves several indices. You should use xalloc to obtain an
index that is safe to use. Also note that since the array can grow
dynamically, it is not safe to hold onto the reference.
Definition at line 743 of file ios_base.h.
template<typename _CharT, typename _Traits> char std::basic_ios< _CharT, _Traits >::narrow ( char_type__c, char__dfault) const [inline], [inherited]¶
Squeezes characters. Parameters:c The character to narrow.
dfault The character to narrow.
Returns:
The narrowed character.
Maps a character of char_type to a character of char, if possible.
Returns the result of
std::use_facet<ctype<char_type> >(getloc()).narrow(c,dfault)Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html Definition at line 422 of file basic_ios.h.
template<typename _CharT , typename _Traits > void std::basic_fstream< _CharT, _Traits >::open (const char *__s, ios_base::openmode__mode = ios_base::in | ios_base::out) [inline]¶
Opens an external file. Parameters:s The name of the file.
mode The open mode flags.
Calls std::basic_filebuf::open(s,mode). If that function fails, failbit is set
in the stream's error state.
Tip: When using std::string to hold the filename, you must use .c_str() before
passing it to this constructor.
Definition at line 871 of file fstream.
References std::basic_ios< _CharT, _Traits >::clear(),
std::ios_base::failbit, std::basic_filebuf< _CharT, _Traits >::open(),
and std::basic_ios< _CharT, _Traits >::setstate().
Referenced by std::basic_fstream< _CharT, _Traits >::basic_fstream().
template<typename _CharT , typename _Traits > void std::basic_fstream< _CharT, _Traits >::open (const std::string &__s, ios_base::openmode__mode = ios_base::in | ios_base::out) [inline]¶
Opens an external file. Parameters:s The name of the file.
mode The open mode flags.
Calls std::basic_filebuf::open(s,mode). If that function fails, failbit is set
in the stream's error state.
Definition at line 892 of file fstream.
References std::basic_ios< _CharT, _Traits >::clear(),
std::ios_base::failbit, std::basic_filebuf< _CharT, _Traits >::open(),
and std::basic_ios< _CharT, _Traits >::setstate().
template<typename _CharT, typename _Traits> std::basic_ios< _CharT, _Traits >::operator void * () const [inline], [inherited]¶
The quick-and-easy status check. This allows you to write constructs such as if (!a_stream) ... and while (a_stream) ... Definition at line 113 of file basic_ios.h.template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT, _Traits >::operator! () const [inline], [inherited]¶
The quick-and-easy status check. This allows you to write constructs such as if (!a_stream) ... and while (a_stream) ... Definition at line 117 of file basic_ios.h.template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( __ostream_type &(*)(__ostream_type &)__pf) [inline], [inherited]¶
Interface for manipulators. Manipulators such as std::endl and std::hex use these functions in constructs like 'std::cout << std::endl'. For more information, see the iomanip header. Definition at line 110 of file ostream.template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( __ios_type &(*)(__ios_type &)__pf) [inline], [inherited]¶
Interface for manipulators. Manipulators such as std::endl and std::hex use these functions in constructs like 'std::cout << std::endl'. For more information, see the iomanip header. Definition at line 119 of file ostream.template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( ios_base &(*)(ios_base &)__pf) [inline], [inherited]¶
Interface for manipulators. Manipulators such as std::endl and std::hex use these functions in constructs like 'std::cout << std::endl'. For more information, see the iomanip header. Definition at line 129 of file ostream.template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< (long__n) [inline], [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 167 of file ostream.
template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< (unsigned long__n) [inline], [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 171 of file ostream.
template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< (bool__n) [inline], [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 175 of file ostream.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< (short__n) [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 94 of file ostream.tcc.
References std::ios_base::basefield, std::ios_base::flags(), std::ios_base::hex,
and std::ios_base::oct.
template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< (unsigned short__n) [inline], [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 182 of file ostream.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< (int__n) [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 108 of file ostream.tcc.
References std::ios_base::basefield, std::ios_base::flags(), std::ios_base::hex,
and std::ios_base::oct.
template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< (unsigned int__n) [inline], [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 193 of file ostream.
template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< (long long__n) [inline], [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 202 of file ostream.
template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< (unsigned long long__n) [inline], [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 206 of file ostream.
template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< (double__f) [inline], [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 211 of file ostream.
template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< (float__f) [inline], [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 215 of file ostream.
template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< (long double__f) [inline], [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 223 of file ostream.
template<typename _CharT, typename _Traits> __ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< (const void *__p) [inline], [inherited]¶
Basic arithmetic inserters. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to perform numeric formatting.
Definition at line 227 of file ostream.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< ( __streambuf_type *__sb) [inherited]¶
Extracting from another streambuf. Parameters:sb A pointer to a streambuf
This function behaves like one of the basic arithmetic extractors, in that it
also constructs a sentry object and has the same error handling behavior.
If sb is NULL, the stream will set failbit in its error state.
Characters are extracted from sb and inserted into *this until one of the
following occurs:
- •
- the input stream reaches end-of-file,
- •
- insertion into the output sequence fails (in this case, the character that would have been inserted is not extracted), or
- •
- an exception occurs while getting a character from sb, which sets failbit in the error state
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( __istream_type &(*)(__istream_type &)__pf) [inline], [inherited]¶
Interface for manipulators. Manipulators such as std::ws and std::dec use these functions in constructs like std::cin >> std::ws. For more information, see the iomanip header. Definition at line 122 of file istream.template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( __ios_type &(*)(__ios_type &)__pf) [inline], [inherited]¶
Interface for manipulators. Manipulators such as std::ws and std::dec use these functions in constructs like std::cin >> std::ws. For more information, see the iomanip header. Definition at line 126 of file istream.template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( ios_base &(*)(ios_base &)__pf) [inline], [inherited]¶
Interface for manipulators. Manipulators such as std::ws and std::dec use these functions in constructs like std::cin >> std::ws. For more information, see the iomanip header. Definition at line 133 of file istream.template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> (bool &__n) [inline], [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 169 of file istream.
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::operator>> (short &__n) [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 116 of file istream.tcc.
References std::ios_base::badbit, std::ios_base::failbit, std::num_get<
_CharT, _InIter >::get(), std::ios_base::goodbit, and std::basic_ios<
_CharT, _Traits >::setstate().
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> (unsigned short &__n) [inline], [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 176 of file istream.
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::operator>> (int &__n) [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 161 of file istream.tcc.
References std::ios_base::badbit, std::ios_base::failbit, std::num_get<
_CharT, _InIter >::get(), std::ios_base::goodbit, and std::basic_ios<
_CharT, _Traits >::setstate().
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> (unsigned int &__n) [inline], [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 183 of file istream.
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> (long &__n) [inline], [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 187 of file istream.
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> (unsigned long &__n) [inline], [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 191 of file istream.
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> (long long &__n) [inline], [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 196 of file istream.
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> (unsigned long long &__n) [inline], [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 200 of file istream.
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> (float &__f) [inline], [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 205 of file istream.
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> (double &__f) [inline], [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 209 of file istream.
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> (long double &__f) [inline], [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 213 of file istream.
template<typename _CharT, typename _Traits> __istream_type& std::basic_istream< _CharT, _Traits >::operator>> (void *&__p) [inline], [inherited]¶
Basic arithmetic extractors. Parameters:A variable of builtin type.
Returns:
*this if successful
These functions use the stream's current locale (specifically, the
num_get facet) to parse the input data.
Definition at line 217 of file istream.
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::operator>> ( __streambuf_type *__sb) [inherited]¶
Extracting into another streambuf. Parameters:sb A pointer to a streambuf
This function behaves like one of the basic arithmetic extractors, in that it
also constructs a sentry object and has the same error handling behavior.
If sb is NULL, the stream will set failbit in its error state.
Characters are extracted from this stream and inserted into the sb
streambuf until one of the following occurs:
- •
- the input stream reaches end-of-file,
- •
- insertion into the output buffer fails (in this case, the character that would have been inserted is not extracted), or
- •
- an exception occurs (and in this case is caught)
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits >::int_type std::basic_istream< _CharT, _Traits >::peek (void) [inherited]¶
Looking ahead in the stream. Returns:The next character, or eof().
If, after constructing the sentry object, good() is false, returns
traits::eof() . Otherwise reads but does not extract the next input
character.
Definition at line 622 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, std::basic_ios< _CharT, _Traits >::eof(),
std::ios_base::eofbit, std::ios_base::goodbit, std::basic_ios< _CharT,
_Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits
>::setstate().
streamsize std::ios_base::precision () const [inline], [inherited]¶
Flags access. Returns:The precision to generate on certain output
operations.
Be careful if you try to give a definition of precision here; see DR 189.
Definition at line 623 of file ios_base.h.
Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(), and
std::operator<<().
streamsize std::ios_base::precision (streamsize__prec) [inline], [inherited]¶
Changing flags. Parameters:prec The new precision value.
Returns:
The previous value of
precision().
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::put (char_type__c) [inherited]¶
Simple insertion. Parameters:c The character to insert.
Returns:
*this
Tries to insert c.
Note:
This function is not overloaded on signed char
and unsigned char.
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::putback (char_type__c) [inherited]¶
Unextracting a single character. Parameters:c The character to push back into the
input stream.
Returns:
*this
If rdbuf() is not null, calls
rdbuf()->sputbackc(c).
If rdbuf() is null or if sputbackc() fails, sets badbit in the
error state.
Note:
This function first clears eofbit. Since no
characters are extracted, the next call to gcount() will return 0,
as required by DR 60.
void*& std::ios_base::pword (int__ix) [inline], [inherited]¶
Access to void pointer array. Parameters:__ix Index into the array.
Returns:
A reference to a void* associated with the
index.
The pword function provides access to an array of pointers that can be used for
any purpose. The array grows as required to hold the supplied index. All
pointers in the array are initialized to 0.
The implementation reserves several indices. You should use xalloc to obtain an
index that is safe to use. Also note that since the array can grow
dynamically, it is not safe to hold onto the reference.
Definition at line 764 of file ios_base.h.
template<typename _CharT, typename _Traits> basic_streambuf< _CharT, _Traits > * std::basic_ios< _CharT, _Traits >::rdbuf ( basic_streambuf< _CharT, _Traits > *__sb) [inherited]¶
Changing the underlying buffer. Parameters:sb The new stream buffer.
Returns:
The previous stream buffer.
Associates a new buffer with the current stream, and clears the error state.
Due to historical accidents which the LWG refuses to correct, the I/O library
suffers from a design error: this function is hidden in derived classes by
overrides of the zero-argument rdbuf(), which is non-virtual for
hysterical raisins. As a result, you must use explicit qualifications to
access this function via any derived class. For example:
std::fstream foo; // or some other derived type std::streambuf* p = .....; foo.ios::rdbuf(p); // ios == basic_ios<char>
template<typename _CharT , typename _Traits > __filebuf_type* std::basic_fstream< _CharT, _Traits >::rdbuf () const [inline]¶
Accessing the underlying buffer. Returns:The current basic_filebuf buffer.
This hides both signatures of std::basic_ios::rdbuf().
Reimplemented from std::basic_ios< _CharT, _Traits >.
Definition at line 842 of file fstream.
template<typename _CharT, typename _Traits> iostate std::basic_ios< _CharT, _Traits >::rdstate () const [inline], [inherited]¶
Returns the error state of the stream buffer. Returns:A bit pattern (well, isn't everything?)
See std::ios_base::iostate for the possible bit values. Most users will
call one of the interpreting wrappers, e.g., good().
Definition at line 129 of file basic_ios.h.
Referenced by std::basic_ios< char, _Traits >::bad(), std::basic_ios<
char, _Traits >::eof(), std::basic_ios< char, _Traits >::fail(),
std::basic_ios< char, _Traits >::good(), std::basic_istream< _CharT,
_Traits >::putback(), std::basic_istream< _CharT, _Traits >::seekg(),
std::basic_ios< char, _Traits >::setstate(), and std::basic_istream<
_CharT, _Traits >::unget().
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::read (char_type *__s, streamsize__n) [inherited]¶
Extraction without delimiters. Parameters:s A character array.
n Maximum number of characters to store.
Returns:
*this
If the stream state is good(), extracts characters and stores them
into s until one of the following happens:
- •
- n characters are stored
- •
- the input sequence reaches end-of-file, in which case the error state is set to failbit|eofbit.
This function is not overloaded on signed char
and unsigned char.
template<typename _CharT , typename _Traits > streamsize std::basic_istream< _CharT, _Traits >::readsome (char_type *__s, streamsize__n) [inherited]¶
Extraction until the buffer is exhausted, but no more. Parameters:s A character array.
n Maximum number of characters to store.
Returns:
The number of characters extracted.
Extracts characters and stores them into s depending on the number of
characters remaining in the streambuf's buffer,
rdbuf()->in_avail(), called A here:
- •
- if A == -1, sets eofbit and extracts no characters
- •
- if A == 0, extracts no characters
- •
- if A > 0, extracts min(A,n)
void std::ios_base::register_callback (event_callback__fn, int__index) [inherited]¶
Add the callback __fn with parameter __index. Parameters:__fn The function to add.
__index The integer to pass to the function when invoked.
Registers a function as an event callback with an integer parameter to be passed
to the function when invoked. Multiple copies of the function are allowed. If
there are multiple callbacks, they are invoked in the order they were
registered.
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::seekg (pos_type__pos) [inherited]¶
Changing the current read position. Parameters:pos A file position object.
Returns:
*this
If fail() is not true, calls
rdbuf()->pubseekpos(pos). If that function fails, sets
failbit.
Note:
This function first clears eofbit. It does not
count the number of characters extracted, if any, and therefore does not
affect the next call to gcount().
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::seekg (off_type__off, ios_base::seekdir__dir) [inherited]¶
Changing the current read position. Parameters:off A file offset object.
dir The direction in which to seek.
Returns:
*this
If fail() is not true, calls
rdbuf()->pubseekoff(off,dir) . If that function fails, sets
failbit.
Note:
This function first clears eofbit. It does not
count the number of characters extracted, if any, and therefore does not
affect the next call to gcount().
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::seekp (pos_type__pos) [inherited]¶
Changing the current write position. Parameters:pos A file position object.
Returns:
*this
If fail() is not true, calls
rdbuf()->pubseekpos(pos). If that function fails, sets
failbit.
Definition at line 260 of file ostream.tcc.
References std::ios_base::badbit, std::basic_ios< _CharT, _Traits
>::fail(), std::ios_base::failbit, std::ios_base::goodbit,
std::ios_base::out, std::basic_ios< _CharT, _Traits >::rdbuf(), and
std::basic_ios< _CharT, _Traits >::setstate().
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::seekp (off_type__off, ios_base::seekdir__dir) [inherited]¶
Changing the current write position. Parameters:off A file offset object.
dir The direction in which to seek.
Returns:
*this
If fail() is not true, calls
rdbuf()->pubseekoff(off,dir) . If that function fails, sets
failbit.
Definition at line 292 of file ostream.tcc.
References std::ios_base::badbit, std::basic_ios< _CharT, _Traits
>::fail(), std::ios_base::failbit, std::ios_base::goodbit,
std::ios_base::out, std::basic_ios< _CharT, _Traits >::rdbuf(), and
std::basic_ios< _CharT, _Traits >::setstate().
fmtflags std::ios_base::setf (fmtflags__fmtfl) [inline], [inherited]¶
Setting new format flags. Parameters:fmtfl Additional flags to set.
Returns:
The previous format control flags.
This function sets additional flags in format control. Flags that were
previously set remain set.
Definition at line 580 of file ios_base.h.
Referenced by std::dec(), std::fixed(), std::hex(), std::left(), std::oct(),
std::right(), std::scientific(), std::showbase(), std::showpoint(),
std::showpos(), std::skipws(), std::unitbuf(), and std::uppercase().
fmtflags std::ios_base::setf (fmtflags__fmtfl, fmtflags__mask) [inline], [inherited]¶
Setting new format flags. Parameters:fmtfl Additional flags to set.
mask The flags mask for fmtfl.
Returns:
The previous format control flags.
This function clears mask in the format flags, then sets fmtfl
& mask. An example mask is ios_base::adjustfield.
Definition at line 597 of file ios_base.h.
template<typename _CharT, typename _Traits> void std::basic_ios< _CharT, _Traits >::setstate ( iostate__state) [inline], [inherited]¶
Sets additional flags in the error state. Parameters:state The additional state flag(s) to
set.
See std::ios_base::iostate for the possible bit values.
Definition at line 149 of file basic_ios.h.
Referenced by std::basic_ostream< char >::_M_write(),
std::basic_ifstream< _CharT, _Traits >::close(), std::basic_ofstream<
_CharT, _Traits >::close(), std::basic_fstream< _CharT, _Traits
>::close(), std::basic_ostream< _CharT, _Traits >::flush(),
std::basic_istream< _CharT, _Traits >::get(), std::basic_istream<
_CharT, _Traits >::getline(), std::getline(), std::basic_istream<
_CharT, _Traits >::ignore(), std::basic_ifstream< _CharT, _Traits
>::open(), std::basic_ofstream< _CharT, _Traits >::open(),
std::basic_fstream< _CharT, _Traits >::open(), std::basic_ostream<
_CharT, _Traits >::operator<<(), std::operator<<(),
std::basic_istream< _CharT, _Traits >::operator>>(),
std::operator>>(), std::basic_istream< _CharT, _Traits >::peek(),
std::basic_ostream< _CharT, _Traits >::put(), std::basic_istream<
_CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits
>::read(), std::basic_istream< _CharT, _Traits >::readsome(),
std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ostream<
_CharT, _Traits >::seekp(), std::basic_ostream< _CharT, _Traits
>::sentry::sentry(), std::basic_istream< _CharT, _Traits
>::sentry::sentry(), std::basic_istream< _CharT, _Traits >::sync(),
std::basic_istream< _CharT, _Traits >::unget(), and std::ws().
template<typename _CharT , typename _Traits > int std::basic_istream< _CharT, _Traits >::sync (void) [inherited]¶
Synchronizing the stream buffer. Returns:0 on success, -1 on failure
If rdbuf() is a null pointer, returns -1.
Otherwise, calls rdbuf()->pubsync(), and if that returns -1, sets
badbit and returns -1.
Otherwise, returns 0.
Note:
This function does not count the number of
characters extracted, if any, and therefore does not affect the next call to
gcount().
static bool std::ios_base::sync_with_stdio (bool__sync = true) [static], [inherited]¶
Interaction with the standard C I/O objects. Parameters:sync Whether to synchronize or
not.
Returns:
True if the standard streams were previously
synchronized.
The synchronization referred to is only that between the standard C
facilities (e.g., stdout) and the standard C++ objects (e.g., cout).
User-declared streams are unaffected. See
http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch28s02.html
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits >::pos_type std::basic_istream< _CharT, _Traits >::tellg (void) [inherited]¶
Getting the current read position. Returns:A file position object.
If fail() is not false, returns pos_type(-1) to indicate
failure. Otherwise returns
rdbuf()->pubseekoff(0,cur,in).
Note:
This function does not count the number of
characters extracted, if any, and therefore does not affect the next call to
gcount(). At variance with putback, unget and seekg, eofbit is not
cleared first.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits >::pos_type std::basic_ostream< _CharT, _Traits >::tellp () [inherited]¶
Getting the current write position. Returns:A file position object.
If fail() is not false, returns pos_type(-1) to indicate
failure. Otherwise returns
rdbuf()->pubseekoff(0,cur,out).
Definition at line 239 of file ostream.tcc.
References std::ios_base::badbit, std::ios_base::cur, std::basic_ios< _CharT,
_Traits >::fail(), std::ios_base::out, and std::basic_ios< _CharT,
_Traits >::rdbuf().
template<typename _CharT, typename _Traits> basic_ostream<_CharT, _Traits>* std::basic_ios< _CharT, _Traits >::tie () const [inline], [inherited]¶
Fetches the current tied stream. Returns:A pointer to the tied stream, or NULL if the
stream is not tied.
A stream may be tied (or synchronized) to a second output stream. When
this stream performs any I/O, the tied stream is first flushed. For example,
std::cin is tied to std::cout.
Definition at line 287 of file basic_ios.h.
Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(),
std::basic_ostream< _CharT, _Traits >::sentry::sentry(), and
std::basic_istream< _CharT, _Traits >::sentry::sentry().
template<typename _CharT, typename _Traits> basic_ostream<_CharT, _Traits>* std::basic_ios< _CharT, _Traits >::tie ( basic_ostream< _CharT, _Traits > *__tiestr) [inline], [inherited]¶
Ties this stream to an output stream. Parameters:tiestr The output stream.
Returns:
The previously tied output stream, or NULL if
the stream was not tied.
This sets up a new tie; see tie() for more.
Definition at line 299 of file basic_ios.h.
template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::unget (void) [inherited]¶
Unextracting the previous character. Returns:*this
If rdbuf() is not null, calls
rdbuf()->sungetc(c).
If rdbuf() is null or if sungetc() fails, sets badbit in the
error state.
Note:
This function first clears eofbit. Since no
characters are extracted, the next call to gcount() will return 0,
as required by DR 60.
void std::ios_base::unsetf (fmtflags__mask) [inline], [inherited]¶
Clearing format flags. Parameters:mask The flags to unset.
This function clears mask in the format flags.
Definition at line 612 of file ios_base.h.
Referenced by std::noboolalpha(), std::noshowbase(), std::noshowpoint(),
std::noshowpos(), std::noskipws(), std::nounitbuf(), and std::nouppercase().
template<typename _CharT, typename _Traits> char_type std::basic_ios< _CharT, _Traits >::widen (char__c) const [inline], [inherited]¶
Widens characters. Parameters:c The character to widen.
Returns:
The widened character.
Maps a character of char to a character of char_type.
Returns the result of
std::use_facet<ctype<char_type> >(getloc()).widen(c)Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html Definition at line 441 of file basic_ios.h. Referenced by std::endl(), std::basic_ios< char, _Traits >::fill(), std::basic_istream< char >::get(), std::basic_istream< char >::getline(), std::getline(), and std::operator>>().
streamsize std::ios_base::width () const [inline], [inherited]¶
Flags access. Returns:The minimum field width to generate on output
operations.
Minimum field width refers to the number of characters.
Definition at line 646 of file ios_base.h.
Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(),
std::num_put< _CharT, _OutIter >::do_put(), and std::operator>>().
streamsize std::ios_base::width (streamsize__wide) [inline], [inherited]¶
Changing flags. Parameters:wide The new width value.
Returns:
The previous value of width().
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::write (const char_type *__s, streamsize__n) [inherited]¶
Character string insertion. Parameters:s The array to insert.
n Maximum number of characters to insert.
Returns:
*this
Characters are copied from s and inserted into the stream until one of
the following happens:
- •
- n characters are inserted
- •
- inserting into the output sequence fails (in this case, badbit will be set in the stream's error state)
This function is not overloaded on signed char
and unsigned char.
static int std::ios_base::xalloc () throw () [static], [inherited]¶
Access to unique indices. Returns:An integer different from all previous
calls.
This function returns a unique integer every time it is called. It can be used
for any purpose, but is primarily intended to be a unique index for the iword
and pword functions. The expectation is that an application calls xalloc in
order to obtain an index in the iword and pword arrays that can be used
without fear of conflict.
The implementation maintains a static variable that is incremented and returned
on each invocation. xalloc is guaranteed to return an index that is safe to
use in the iword and pword arrays.
Member Data Documentation¶
template<typename _CharT, typename _Traits> streamsize std::basic_istream< _CharT, _Traits >::_M_gcount [protected], [inherited]¶
The number of characters extracted in the previous unformatted function; see gcount(). Definition at line 81 of file istream. Referenced by std::basic_istream< char >::gcount(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::getline(), std::basic_istream< _CharT, _Traits >::ignore(), std::basic_istream< _CharT, _Traits >::peek(), std::basic_istream< _CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits >::read(), std::basic_istream< _CharT, _Traits >::readsome(), std::basic_istream< _CharT, _Traits >::unget(), and std::basic_istream< char >::~basic_istream().const fmtflags std::ios_base::adjustfield [static], [inherited]¶
A mask of left|right|internal. Useful for the 2-arg form of setf. Definition at line 312 of file ios_base.h. Referenced by std::num_put< _CharT, _OutIter >::do_put(), std::internal(), std::left(), and std::right().const openmode std::ios_base::app [static], [inherited]¶
Seek to end before each write. Definition at line 366 of file ios_base.h.const openmode std::ios_base::ate [static], [inherited]¶
Open and seek to end immediately after opening. Definition at line 369 of file ios_base.h. Referenced by std::basic_filebuf< _CharT, _Traits >::open().const iostate std::ios_base::badbit [static], [inherited]¶
Indicates a loss of integrity in an input or output sequence (such as an irrecoverable read error from a file). Definition at line 336 of file ios_base.h. Referenced by std::basic_ostream< char >::_M_write(), std::basic_ios< char, _Traits >::bad(), std::basic_ios< char, _Traits >::fail(), std::basic_ostream< _CharT, _Traits >::flush(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::getline(), std::basic_istream< _CharT, _Traits >::ignore(), std::basic_ostream< _CharT, _Traits >::operator<<(), std::operator<<(), std::basic_istream< _CharT, _Traits >::operator>>(), std::operator>>(), std::basic_istream< _CharT, _Traits >::peek(), std::basic_ostream< _CharT, _Traits >::put(), std::basic_istream< _CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits >::read(), std::basic_istream< _CharT, _Traits >::readsome(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_istream< _CharT, _Traits >::sync(), std::basic_istream< _CharT, _Traits >::tellg(), std::basic_ostream< _CharT, _Traits >::tellp(), std::basic_istream< _CharT, _Traits >::unget(), std::basic_ostream< _CharT, _Traits >::write(), and std::basic_ostream< _CharT, _Traits >::sentry::~sentry().const fmtflags std::ios_base::basefield [static], [inherited]¶
A mask of dec|oct|hex. Useful for the 2-arg form of setf. Definition at line 315 of file ios_base.h. Referenced by std::dec(), std::num_get< _CharT, _InIter >::do_get(), std::hex(), std::oct(), and std::basic_ostream< _CharT, _Traits >::operator<<().const seekdir std::ios_base::beg [static], [inherited]¶
Request a seek relative to the beginning of the stream. Definition at line 398 of file ios_base.h. Referenced by std::basic_filebuf< _CharT, _Traits >::seekpos().const openmode std::ios_base::binary [static], [inherited]¶
Perform input and output in binary mode (as opposed to text mode). This is probably not what you think it is; see http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch27s02.html. Definition at line 374 of file ios_base.h. Referenced by std::basic_filebuf< _CharT, _Traits >::showmanyc().const fmtflags std::ios_base::boolalpha [static], [inherited]¶
Insert/extract bool in alphabetic rather than numeric format. Definition at line 260 of file ios_base.h. Referenced by std::boolalpha(), std::num_get< _CharT, _InIter >::do_get(), std::num_put< _CharT, _OutIter >::do_put(), and std::noboolalpha().const seekdir std::ios_base::cur [static], [inherited]¶
Request a seek relative to the current position within the sequence. Definition at line 401 of file ios_base.h. Referenced by std::basic_filebuf< _CharT, _Traits >::imbue(), std::basic_filebuf< _CharT, _Traits >::overflow(), std::basic_filebuf< _CharT, _Traits >::pbackfail(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_filebuf< _CharT, _Traits >::seekoff(), std::basic_istream< _CharT, _Traits >::tellg(), and std::basic_ostream< _CharT, _Traits >::tellp().const fmtflags std::ios_base::dec [static], [inherited]¶
Converts integer input or generates integer output in decimal base. Definition at line 263 of file ios_base.h. Referenced by std::dec().const seekdir std::ios_base::end [static], [inherited]¶
Request a seek relative to the current end of the sequence. Definition at line 404 of file ios_base.h. Referenced by std::basic_filebuf< _CharT, _Traits >::open(), and std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff().const iostate std::ios_base::eofbit [static], [inherited]¶
Indicates that an input operation reached the end of an input sequence. Definition at line 339 of file ios_base.h. Referenced by std::num_get< _CharT, _InIter >::do_get(), std::time_get< _CharT, _InIter >::do_get_date(), std::time_get< _CharT, _InIter >::do_get_monthname(), std::time_get< _CharT, _InIter >::do_get_time(), std::time_get< _CharT, _InIter >::do_get_weekday(), std::time_get< _CharT, _InIter >::do_get_year(), std::basic_ios< char, _Traits >::eof(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::getline(), std::basic_istream< _CharT, _Traits >::ignore(), std::basic_istream< _CharT, _Traits >::operator>>(), std::operator>>(), std::basic_istream< _CharT, _Traits >::peek(), std::basic_istream< _CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits >::read(), std::basic_istream< _CharT, _Traits >::readsome(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream< _CharT, _Traits >::sentry::sentry(), std::basic_istream< _CharT, _Traits >::unget(), and std::ws().const iostate std::ios_base::failbit [static], [inherited]¶
Indicates that an input operation failed to read the expected characters, or that an output operation failed to generate the desired characters. Definition at line 344 of file ios_base.h. Referenced by std::basic_ifstream< _CharT, _Traits >::close(), std::basic_ofstream< _CharT, _Traits >::close(), std::basic_fstream< _CharT, _Traits >::close(), std::num_get< _CharT, _InIter >::do_get(), std::time_get< _CharT, _InIter >::do_get_monthname(), std::time_get< _CharT, _InIter >::do_get_weekday(), std::time_get< _CharT, _InIter >::do_get_year(), std::basic_ios< char, _Traits >::fail(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::getline(), std::basic_ifstream< _CharT, _Traits >::open(), std::basic_ofstream< _CharT, _Traits >::open(), std::basic_fstream< _CharT, _Traits >::open(), std::basic_ostream< _CharT, _Traits >::operator<<(), std::basic_istream< _CharT, _Traits >::operator>>(), std::operator>>(), std::basic_istream< _CharT, _Traits >::read(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_ostream< _CharT, _Traits >::sentry::sentry(), and std::basic_istream< _CharT, _Traits >::sentry::sentry().const fmtflags std::ios_base::fixed [static], [inherited]¶
Generate floating-point output in fixed-point notation. Definition at line 266 of file ios_base.h. Referenced by std::fixed().const fmtflags std::ios_base::floatfield [static], [inherited]¶
A mask of scientific|fixed. Useful for the 2-arg form of setf. Definition at line 318 of file ios_base.h. Referenced by std::fixed(), and std::scientific().const iostate std::ios_base::goodbit [static], [inherited]¶
Indicates all is well. Definition at line 347 of file ios_base.h. Referenced by std::num_get< _CharT, _InIter >::do_get(), std::time_get< _CharT, _InIter >::do_get_monthname(), std::time_get< _CharT, _InIter >::do_get_weekday(), std::time_get< _CharT, _InIter >::do_get_year(), std::basic_ostream< _CharT, _Traits >::flush(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::getline(), std::basic_istream< _CharT, _Traits >::ignore(), std::basic_ostream< _CharT, _Traits >::operator<<(), std::basic_istream< _CharT, _Traits >::operator>>(), std::operator>>(), std::basic_istream< _CharT, _Traits >::peek(), std::basic_ostream< _CharT, _Traits >::put(), std::basic_istream< _CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits >::read(), std::basic_istream< _CharT, _Traits >::readsome(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_istream< _CharT, _Traits >::sentry::sentry(), std::basic_istream< _CharT, _Traits >::sync(), and std::basic_istream< _CharT, _Traits >::unget().const fmtflags std::ios_base::hex [static], [inherited]¶
Converts integer input or generates integer output in hexadecimal base. Definition at line 269 of file ios_base.h. Referenced by std::num_get< _CharT, _InIter >::do_get(), std::num_put< _CharT, _OutIter >::do_put(), std::hex(), and std::basic_ostream< _CharT, _Traits >::operator<<().const openmode std::ios_base::in [static], [inherited]¶
Open for input. Default for ifstream and fstream. Definition at line 377 of file ios_base.h. Referenced by std::basic_filebuf< char_type, traits_type >::_M_set_buffer(), std::basic_ifstream< _CharT, _Traits >::open(), std::basic_filebuf< _CharT, _Traits >::pbackfail(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::showmanyc(), std::basic_filebuf< _CharT, _Traits >::showmanyc(), std::basic_istream< _CharT, _Traits >::tellg(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::underflow(), std::basic_filebuf< _CharT, _Traits >::underflow(), and std::basic_filebuf< _CharT, _Traits >::xsgetn().const fmtflags std::ios_base::internal [static], [inherited]¶
Adds fill characters at a designated internal point in certain generated output, or identical to right if no such point is designated. Definition at line 274 of file ios_base.h. Referenced by std::internal().const fmtflags std::ios_base::left [static], [inherited]¶
Adds fill characters on the right (final positions) of certain generated output. (I.e., the thing you print is flush left.) Definition at line 278 of file ios_base.h. Referenced by std::num_put< _CharT, _OutIter >::do_put(), and std::left().const fmtflags std::ios_base::oct [static], [inherited]¶
Converts integer input or generates integer output in octal base. Definition at line 281 of file ios_base.h. Referenced by std::oct(), and std::basic_ostream< _CharT, _Traits >::operator<<().const openmode std::ios_base::out [static], [inherited]¶
Open for output. Default for ofstream and fstream. Definition at line 380 of file ios_base.h. Referenced by std::basic_filebuf< char_type, traits_type >::_M_set_buffer(), std::basic_ofstream< _CharT, _Traits >::open(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow(), std::basic_filebuf< _CharT, _Traits >::overflow(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::pbackfail(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos(), std::basic_ostream< _CharT, _Traits >::tellp(), and std::basic_filebuf< _CharT, _Traits >::xsputn().const fmtflags std::ios_base::right [static], [inherited]¶
Adds fill characters on the left (initial positions) of certain generated output. (I.e., the thing you print is flush right.) Definition at line 285 of file ios_base.h. Referenced by std::right().const fmtflags std::ios_base::scientific [static], [inherited]¶
Generates floating-point output in scientific notation. Definition at line 288 of file ios_base.h. Referenced by std::scientific().const fmtflags std::ios_base::showbase [static], [inherited]¶
Generates a prefix indicating the numeric base of generated integer output. Definition at line 292 of file ios_base.h. Referenced by std::noshowbase(), and std::showbase().const fmtflags std::ios_base::showpoint [static], [inherited]¶
Generates a decimal-point character unconditionally in generated floating-point output. Definition at line 296 of file ios_base.h. Referenced by std::noshowpoint(), and std::showpoint().const fmtflags std::ios_base::showpos [static], [inherited]¶
Generates a + sign in non-negative generated numeric output. Definition at line 299 of file ios_base.h. Referenced by std::noshowpos(), and std::showpos().const fmtflags std::ios_base::skipws [static], [inherited]¶
Skips leading white space before certain input operations. Definition at line 302 of file ios_base.h. Referenced by std::noskipws(), std::basic_istream< _CharT, _Traits >::sentry::sentry(), and std::skipws().const openmode std::ios_base::trunc [static], [inherited]¶
Open for input. Default for ofstream. Definition at line 383 of file ios_base.h.const fmtflags std::ios_base::unitbuf [static], [inherited]¶
Flushes output after each output operation. Definition at line 305 of file ios_base.h. Referenced by std::nounitbuf(), std::unitbuf(), and std::basic_ostream< _CharT, _Traits >::sentry::~sentry().const fmtflags std::ios_base::uppercase [static], [inherited]¶
Replaces certain lowercase letters with their uppercase equivalents in generated output. Definition at line 309 of file ios_base.h. Referenced by std::num_put< _CharT, _OutIter >::do_put(), std::nouppercase(), and std::uppercase().Author¶
Generated automatically by Doxygen for libstdc++ from the source code.| Tue Nov 27 2012 | libstdc++ |