std::basic_istream<; _CharT, _Traits >(std::basic_istream< _CharT, _Traits >(3)
NAME
std::basic_istream< _CharT, _Traits > -
SYNOPSIS
Inherits std::basic_ios< _CharT, _Traits >.
Inherited by std::basic_ifstream< _CharT, _Traits >,
std::basic_iostream< _CharT, _Traits >, and std::basic_istringstream<
_CharT, _Traits, _Alloc >.
Classes
class sentry
Public Types
typedef ctype< _CharT > __ctype_type
typedef basic_ios< _CharT,
_Traits > __ios_type"
typedef basic_istream< _CharT,
_Traits > __istream_type"
typedef num_get< _CharT,
istreambuf_iterator< _CharT,
_Traits > > __num_get_type"
typedef basic_streambuf
< _CharT, _Traits > __streambuf_type"
typedef _CharT char_type
enum event { erase_event, imbue_event, copyfmt_event }
typedef void(* event_callback )(event __e, ios_base &__b, int __i)
typedef _Ios_Fmtflags fmtflags
typedef _Traits::int_type int_type
typedef int io_state
typedef _Ios_Iostate iostate
typedef _Traits::off_type off_type
typedef int open_mode
typedef _Ios_Openmode openmode
typedef _Traits::pos_type pos_type
typedef int seek_dir
typedef _Ios_Seekdir seekdir
typedef std::streamoff streamoff
typedef std::streampos streampos
typedef _Traits traits_type
typedef num_put< _CharT,
ostreambuf_iterator< _CharT,
_Traits > > __num_put_type"
Public Member Functions
basic_istream (__streambuf_type *__sb)
virtual ~basic_istream ()
template<typename _ValueT > basic_istream< _CharT, _Traits > &
_M_extract (_ValueT &__v)
const locale & _M_getloc () const
void _M_setstate (iostate __state)
bool bad () const
void clear (iostate __state=goodbit)
basic_ios & copyfmt (const basic_ios &__rhs)
bool eof () const
iostate exceptions () const
void exceptions (iostate __except)
bool fail () const
char_type fill () const
char_type fill (char_type __ch)
fmtflags flags () const
fmtflags flags (fmtflags __fmtfl)
streamsize gcount () const
template<> basic_istream< char > & getline (char_type *__s, streamsize
__n, char_type __delim)
template<> basic_istream< wchar_t > & getline (char_type *__s,
streamsize __n, char_type __delim)
locale getloc () const
bool good () const
template<> basic_istream< char > & ignore (streamsize __n)
template<> basic_istream< char > & ignore (streamsize __n, int_type
__delim)
template<> basic_istream< wchar_t > & ignore (streamsize __n)
template<> basic_istream< wchar_t > & ignore (streamsize __n, int_type
__delim)
locale imbue (const locale &__loc)
long & iword (int __ix)
char narrow (char_type __c, char __dfault) const
__istream_type & operator>> (void *&__p)
__istream_type & operator>> (__streambuf_type *__sb)
streamsize precision () const
streamsize precision (streamsize __prec)
void *& pword (int __ix)
basic_streambuf< _CharT,
_Traits > * rdbuf () const "
basic_streambuf< _CharT,
_Traits > * rdbuf (basic_streambuf< _CharT, _Traits > *__sb)"
iostate rdstate () const
void register_callback (event_callback __fn, int __index)
fmtflags setf (fmtflags __fmtfl)
fmtflags setf (fmtflags __fmtfl, fmtflags __mask)
void setstate (iostate __state)
basic_ostream< _CharT, _Traits > * tie () const
basic_ostream< _CharT, _Traits > * tie (basic_ostream< _CharT, _Traits
> *__tiestr)
void unsetf (fmtflags __mask)
char_type widen (char __c) const
streamsize width () const
streamsize width (streamsize __wide)
__istream_type & operator>> (__istream_type &(*__pf)(__istream_type
&))
__istream_type & operator>> (__ios_type &(*__pf)(__ios_type &))
__istream_type & operator>> (ios_base &(*__pf)(ios_base &))
Extractors
All the operator>> functions (aka formatted input functions) have some
common behavior. Each starts by constructing a temporary object of type
std::basic_istream::sentry with the second argument (noskipws) set to
false. This has several effects, concluding with the setting of a
status flag; see the sentry documentation for more.
If the sentry status is good, the function tries to extract whatever
data is appropriate for the type of the argument.
If an exception is thrown during extraction, ios_base::badbit will be
turned on in the stream's error state without causing an
ios_base::failure to be thrown. The original exception will then be
rethrown.
__istream_type & operator>> (bool &__n)
__istream_type & operator>> (short &__n)
__istream_type & operator>> (unsigned short &__n)
__istream_type & operator>> (int &__n)
__istream_type & operator>> (unsigned int &__n)
__istream_type & operator>> (long &__n)
__istream_type & operator>> (unsigned long &__n)
__istream_type & operator>> (long long &__n)
__istream_type & operator>> (unsigned long long &__n)
__istream_type & operator>> (float &__f)
__istream_type & operator>> (double &__f)
__istream_type & operator>> (long double &__f)
Unformatted Input Functions
All the unformatted input functions have some common behavior. Each
starts by constructing a temporary object of type
std::basic_istream::sentry with the second argument (noskipws) set to
true. This has several effects, concluding with the setting of a status
flag; see the sentry documentation for more.
If the sentry status is good, the function tries to extract whatever
data is appropriate for the type of the argument.
The number of characters extracted is stored for later retrieval by
gcount().
If an exception is thrown during extraction, ios_base::badbit will be
turned on in the stream's error state without causing an
ios_base::failure to be thrown. The original exception will then be
rethrown.
int_type get ()
__istream_type & get (char_type &__c)
__istream_type & get (char_type *__s, streamsize __n, char_type
__delim)
__istream_type & get (char_type *__s, streamsize __n)
__istream_type & get (__streambuf_type &__sb, char_type __delim)
__istream_type & get (__streambuf_type &__sb)
__istream_type & getline (char_type *__s, streamsize __n, char_type
__delim)
__istream_type & getline (char_type *__s, streamsize __n)
__istream_type & ignore (streamsize __n, int_type __delim)
__istream_type & ignore (streamsize __n)
__istream_type & ignore ()
int_type peek ()
__istream_type & read (char_type *__s, streamsize __n)
streamsize readsome (char_type *__s, streamsize __n)
__istream_type & putback (char_type __c)
__istream_type & unget ()
int sync ()
pos_type tellg ()
__istream_type & seekg (pos_type)
__istream_type & seekg (off_type, ios_base::seekdir)
operator void * () const
bool operator! () const
Static Public Member Functions
static bool sync_with_stdio (bool __sync=true)
static int xalloc () throw ()
Static Public Attributes
static const fmtflags adjustfield
static const openmode app
static const openmode ate
static const iostate badbit
static const fmtflags basefield
static const seekdir beg
static const openmode binary
static const fmtflags boolalpha
static const seekdir cur
static const fmtflags dec
static const seekdir end
static const iostate eofbit
static const iostate failbit
static const fmtflags fixed
static const fmtflags floatfield
static const iostate goodbit
static const fmtflags hex
static const openmode in
static const fmtflags internal
static const fmtflags left
static const fmtflags oct
static const openmode out
static const fmtflags right
static const fmtflags scientific
static const fmtflags showbase
static const fmtflags showpoint
static const fmtflags showpos
static const fmtflags skipws
static const openmode trunc
static const fmtflags unitbuf
static const fmtflags uppercase
Protected Types
enum { _S_local_word_size }
Protected Member Functions
void _M_cache_locale (const locale &__loc)
void _M_call_callbacks (event __ev) throw ()
void _M_dispose_callbacks (void) throw ()
template<typename _ValueT > __istream_type & _M_extract (_ValueT &__v)
_Words & _M_grow_words (int __index, bool __iword)
void _M_init () throw ()
void init (basic_streambuf< _CharT, _Traits > *__sb)
Protected Attributes
_Callback_list * _M_callbacks
const __ctype_type * _M_ctype
iostate _M_exception
char_type _M_fill
bool _M_fill_init
fmtflags _M_flags
streamsize _M_gcount
locale _M_ios_locale
_Words _M_local_word [_S_local_word_size]
const __num_get_type * _M_num_get
const __num_put_type * _M_num_put
streamsize _M_precision
basic_streambuf< _CharT,
_Traits > * _M_streambuf"
iostate _M_streambuf_state
basic_ostream< _CharT, _Traits > * _M_tie
streamsize _M_width
_Words * _M_word
int _M_word_size
_Words _M_word_zero
Friends
class sentry
Detailed Description
template<typename _CharT, typename _Traits = char_traits<_CharT>>class
std::basic_istream< _CharT, _Traits >
Template class basic_istream.
Template Parameters:
_CharT Type of character stream.
_Traits Traits for character type, defaults to char_traits<_CharT>.
This is the base class for all input streams. It provides text
formatting of all builtin types, and communicates with any class
derived from basic_streambuf to do the actual input.
Definition at line 83 of file iosfwd.
Member Typedef Documentation
template<typename _CharT, typename _Traits = char_traits<_CharT>> 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 88 of file basic_ios.h.
typedef void(* std::ios_base::event_callback)(event __e, ios_base &__b, int
__i) [inherited]
The type of an event callback function.
Parameters:
__e One of the members of the event enum.
__b Reference to the ios_base object.
__i 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 436 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
Definition at line 255 of file ios_base.h.
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
Definition at line 330 of file ios_base.h.
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
Definition at line 361 of file ios_base.h.
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.
Definition at line 393 of file ios_base.h.
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 419 of file ios_base.h.
Constructor & Destructor Documentation
template<typename _CharT, typename _Traits = char_traits<_CharT>>
std::basic_istream< _CharT, _Traits >::basic_istream (__streambuf_type
*__sb) [inline], [explicit]
Base constructor. This ctor is almost never called by the user
directly, rather from derived classes' initialization lists, which pass
a pointer to their own stream buffer.
Definition at line 93 of file istream.
template<typename _CharT, typename _Traits = char_traits<_CharT>> virtual
std::basic_istream< _CharT, _Traits >::~basic_istream () [inline],
[virtual]
Base destructor. This does very little apart from providing a virtual
base dtor.
Definition at line 103 of file istream.
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 706 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 = char_traits<_CharT>> 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 205 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 41 of file basic_ios.tcc.
Referenced by std::basic_ios< char, char_traits< char >
>::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, char_traits< char > >::setstate(), and
std::basic_istream< _CharT, _Traits >::unget().
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 63 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(), std::tie(), and std::ios_base::width().
template<typename _CharT, typename _Traits = char_traits<_CharT>> 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 184 of file basic_ios.h.
template<typename _CharT, typename _Traits = char_traits<_CharT>> 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 216 of file basic_ios.h.
Referenced by std::basic_ios< _CharT, _Traits >::copyfmt().
template<typename _CharT, typename _Traits = char_traits<_CharT>> 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);
* }
*
Definition at line 251 of file basic_ios.h.
template<typename _CharT, typename _Traits = char_traits<_CharT>> 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 195 of file basic_ios.h.
Referenced by std::basic_ios< char, char_traits< char > >::operator
void *(), std::basic_ios< char, char_traits< char > >::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_traits<_CharT>> 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 364 of file basic_ios.h.
Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(), and
std::basic_ios< char, char_traits< char > >::fill().
template<typename _CharT, typename _Traits = char_traits<_CharT>> 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 384 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.
Definition at line 551 of file ios_base.h.
Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(),
std::num_get< _CharT, _InIter >::do_get(), std::num_put< _CharT,
_OutIter >::do_put(), std::basic_ostream< _CharT, _Traits
>::operator<<(), std::operator<<(), std::operator>>(), and
std::basic_istream< _CharT, _Traits >::sentry::sentry().
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 562 of file ios_base.h.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
streamsize std::basic_istream< _CharT, _Traits >::gcount () const
[inline]
Character counting.
Returns:
The number of characters extracted by the previous unformatted
input function dispatched for this stream.
Definition at line 269 of file istream.
template<typename _CharT , typename _Traits > basic_istream< _CharT,
_Traits >::int_type std::basic_istream< _CharT, _Traits >::get (void)
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 236 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, 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)
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.
Definition at line 272 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, 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 *__s,
streamsize__n, char_type__delim)
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
If no characters are stored, failbit is set in the stream's error
state.
In any case, a null character is stored into the next location in the
array.
Note:
This function is not overloaded on signed char and unsigned char.
Definition at line 309 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::failbit,
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 = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::get (char_type
*__s, streamsize__n) [inline]
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 354 of file istream.
template<typename _CharT , typename _Traits > basic_istream< _CharT,
_Traits > & std::basic_istream< _CharT, _Traits >::get
(__streambuf_type &__sb, char_type__delim)
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)
If no characters are stored, failbit is set in the stream's error
state.
Definition at line 356 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::failbit,
std::ios_base::goodbit, std::basic_ios< _CharT, _Traits >::rdbuf(),
std::basic_ios< _CharT, _Traits >::setstate(), std::basic_streambuf<
_CharT, _Traits >::sgetc(), std::basic_streambuf< _CharT, _Traits
>::snextc(), and std::basic_streambuf< _CharT, _Traits >::sputc().
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::get
(__streambuf_type &__sb) [inline]
Extraction into another streambuf.
Parameters:
__sb A streambuf in which to store data.
Returns:
*this
Returns get(__sb,widen('\n')).
Definition at line 387 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)
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
If no characters are extracted, failbit is set. (An empty line of input
should therefore not cause failbit to be set.)
In any case, a null character is stored in the next location in the
array.
Definition at line 400 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::failbit,
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().
Referenced by std::basic_istream< char >::getline().
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::getline
(char_type *__s, streamsize__n) [inline]
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 427 of file istream.
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 695 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 = char_traits<_CharT>> 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 174 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
(streamsize__n, int_type__delim)
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().
NB: Provide three overloads, instead of the single function (with
defaults) mandated by the Standard: this leads to a better performing
implementation, while still conforming to the Standard.
Definition at line 555 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, 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 > basic_istream< _CharT,
_Traits > & std::basic_istream< _CharT, _Traits >::ignore
(streamsize__n)
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 493 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, 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 (void)
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 460 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::goodbit,
std::basic_ios< _CharT, _Traits >::rdbuf(), std::basic_streambuf<
_CharT, _Traits >::sbumpc(), and std::basic_ios< _CharT, _Traits
>::setstate().
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
Definition at line 114 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 126 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, char_traits< char > >::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().
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 741 of file ios_base.h.
template<typename _CharT, typename _Traits = char_traits<_CharT>> 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 424 of file basic_ios.h.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
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 115 of file basic_ios.h.
template<typename _CharT, typename _Traits = char_traits<_CharT>> 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 119 of file basic_ios.h.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>>
(__istream_type &(*)(__istream_type &)__pf) [inline]
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 120 of file istream.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>>
(__ios_type &(*)(__ios_type &)__pf) [inline]
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 124 of file istream.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>>
(ios_base &(*)(ios_base &)__pf) [inline]
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 131 of file istream.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> (bool
&__n) [inline]
Integer arithmetic extractors.
Parameters:
__n A variable of builtin integral 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 168 of file istream.
template<typename _CharT , typename _Traits > basic_istream< _CharT,
_Traits > & std::basic_istream< _CharT, _Traits >::operator>> (short
&__n)
Integer arithmetic extractors.
Parameters:
__n A variable of builtin integral 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 114 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 = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>>
(unsigned short &__n) [inline]
Integer arithmetic extractors.
Parameters:
__n A variable of builtin integral 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 175 of file istream.
template<typename _CharT , typename _Traits > basic_istream< _CharT,
_Traits > & std::basic_istream< _CharT, _Traits >::operator>> (int
&__n)
Integer arithmetic extractors.
Parameters:
__n A variable of builtin integral 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 159 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 = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>>
(unsigned int &__n) [inline]
Integer arithmetic extractors.
Parameters:
__n A variable of builtin integral 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 182 of file istream.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> (long
&__n) [inline]
Integer arithmetic extractors.
Parameters:
__n A variable of builtin integral 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 186 of file istream.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>>
(unsigned long &__n) [inline]
Integer arithmetic extractors.
Parameters:
__n A variable of builtin integral 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 190 of file istream.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> (long
long &__n) [inline]
Integer arithmetic extractors.
Parameters:
__n A variable of builtin integral 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 195 of file istream.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>>
(unsigned long long &__n) [inline]
Integer arithmetic extractors.
Parameters:
__n A variable of builtin integral 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 199 of file istream.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>>
(float &__f) [inline]
Floating point arithmetic extractors.
Parameters:
__f A variable of builtin floating point 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 214 of file istream.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>>
(double &__f) [inline]
Floating point arithmetic extractors.
Parameters:
__f A variable of builtin floating point 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 218 of file istream.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> (long
double &__f) [inline]
Floating point arithmetic extractors.
Parameters:
__f A variable of builtin floating point 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 222 of file istream.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> (void
*&__p) [inline]
Basic arithmetic extractors.
Parameters:
__p A variable of pointer 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 235 of file istream.
template<typename _CharT , typename _Traits > basic_istream< _CharT,
_Traits > & std::basic_istream< _CharT, _Traits >::operator>>
(__streambuf_type *__sb)
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)
If the function inserts no characters, failbit is set.
Definition at line 204 of file istream.tcc.
References 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 >::int_type std::basic_istream< _CharT, _Traits >::peek (void)
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 620 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, 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 621 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().
Definition at line 630 of file ios_base.h.
template<typename _CharT , typename _Traits > basic_istream< _CharT,
_Traits > & std::basic_istream< _CharT, _Traits >::putback
(char_type__c)
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.
Definition at line 711 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, std::basic_ios< _CharT, _Traits >::clear(),
std::ios_base::eofbit, std::ios_base::goodbit, std::basic_ios< _CharT,
_Traits >::rdbuf(), std::basic_ios< _CharT, _Traits >::rdstate(),
std::basic_ios< _CharT, _Traits >::setstate(), and
std::basic_streambuf< _CharT, _Traits >::sputbackc().
Referenced by std::operator>>().
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 762 of file ios_base.h.
template<typename _CharT, typename _Traits = char_traits<_CharT>>
basic_streambuf<_CharT, _Traits>* std::basic_ios< _CharT, _Traits
>::rdbuf () const [inline], [inherited]
Accessing the underlying buffer.
Returns:
The current stream buffer.
This does not change the state of the stream.
Definition at line 315 of file basic_ios.h.
Referenced by std::basic_ostream< char >::_M_write(),
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_ostream< _CharT, _Traits >::operator<<(),
std::basic_istream< _CharT, _Traits >::operator>>(),
std::tr2::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(), std::basic_istream< _CharT, _Traits >::tellg(),
std::basic_ostream< _CharT, _Traits >::tellp(), std::basic_istream<
_CharT, _Traits >::unget(), and std::ws().
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>
*
Definition at line 53 of file basic_ios.tcc.
template<typename _CharT, typename _Traits = char_traits<_CharT>> 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 131 of file basic_ios.h.
Referenced by std::basic_ios< char, char_traits< char > >::bad(),
std::basic_ios< char, char_traits< char > >::eof(), std::basic_ios<
char, char_traits< char > >::fail(), std::basic_ios< char, char_traits<
char > >::good(), std::basic_istream< _CharT, _Traits >::putback(),
std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ios< char,
char_traits< char > >::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)
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.
Note:
This function is not overloaded on signed char and unsigned char.
Definition at line 650 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, 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 > streamsize
std::basic_istream< _CharT, _Traits >::readsome (char_type *__s,
streamsize__n)
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)
The goal is to empty the current buffer, and to not request any more
from the external input sequence controlled by the streambuf.
Definition at line 679 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::goodbit,
std::min(), std::basic_ios< _CharT, _Traits >::rdbuf(), and
std::basic_ios< _CharT, _Traits >::setstate().
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)
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().
Definition at line 845 of file istream.tcc.
References std::ios_base::badbit, std::basic_ios< _CharT, _Traits
>::clear(), std::ios_base::eofbit, std::basic_ios< _CharT, _Traits
>::fail(), std::ios_base::failbit, std::ios_base::goodbit,
std::ios_base::in, std::basic_ios< _CharT, _Traits >::rdbuf(),
std::basic_ios< _CharT, _Traits >::rdstate(), and std::basic_ios<
_CharT, _Traits >::setstate().
template<typename _CharT , typename _Traits > basic_istream< _CharT,
_Traits > & std::basic_istream< _CharT, _Traits >::seekg
(off_type__off, ios_base::seekdir__dir)
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().
Definition at line 884 of file istream.tcc.
References std::ios_base::badbit, std::basic_ios< _CharT, _Traits
>::clear(), std::ios_base::eofbit, std::basic_ios< _CharT, _Traits
>::fail(), std::ios_base::failbit, std::ios_base::goodbit,
std::ios_base::in, std::basic_ios< _CharT, _Traits >::rdbuf(),
std::basic_ios< _CharT, _Traits >::rdstate(), 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 578 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 595 of file ios_base.h.
template<typename _CharT, typename _Traits = char_traits<_CharT>> 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 151 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::tr2::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)
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().
Definition at line 781 of file istream.tcc.
References std::ios_base::badbit, std::ios_base::goodbit,
std::basic_streambuf< _CharT, _Traits >::pubsync(), std::basic_ios<
_CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits
>::setstate().
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)
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.
Definition at line 817 of file istream.tcc.
References std::ios_base::badbit, std::ios_base::cur, std::basic_ios<
_CharT, _Traits >::fail(), std::ios_base::in, and std::basic_ios<
_CharT, _Traits >::rdbuf().
template<typename _CharT, typename _Traits = char_traits<_CharT>>
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 289 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 = char_traits<_CharT>>
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 301 of file basic_ios.h.
template<typename _CharT , typename _Traits > basic_istream< _CharT,
_Traits > & std::basic_istream< _CharT, _Traits >::unget (void)
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.
Definition at line 746 of file istream.tcc.
References std::basic_istream< _CharT, _Traits >::_M_gcount,
std::ios_base::badbit, std::basic_ios< _CharT, _Traits >::clear(),
std::ios_base::eofbit, std::ios_base::goodbit, std::basic_ios< _CharT,
_Traits >::rdbuf(), std::basic_ios< _CharT, _Traits >::rdstate(),
std::basic_ios< _CharT, _Traits >::setstate(), and
std::basic_streambuf< _CharT, _Traits >::sungetc().
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 610 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_traits<_CharT>> 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 443 of file basic_ios.h.
Referenced by std::basic_ios< char, char_traits< char > >::fill(),
std::basic_istream< char >::get(), std::basic_istream< char
>::getline(), std::getline(), std::tr2::operator>>(), 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 644 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().
Definition at line 653 of file ios_base.h.
static int std::ios_base::xalloc () [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 = char_traits<_CharT>>
streamsize std::basic_istream< _CharT, _Traits >::_M_gcount [protected]
The number of characters extracted in the previous unformatted
function; see gcount().
Definition at line 82 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 310 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 364 of file ios_base.h.
const openmode std::ios_base::ate [static], [inherited]
Open and seek to end immediately after opening.
Definition at line 367 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 334 of file ios_base.h.
Referenced by std::basic_ostream< char >::_M_write(), std::basic_ios<
char, char_traits< char > >::bad(), std::basic_ios< char, char_traits<
char > >::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 313 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 396 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 372 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 258 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 399 of file ios_base.h.
Referenced by std::basic_filebuf< _CharT, _Traits >::imbue(),
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 261 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 402 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 337 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, char_traits<
char > >::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 342 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, char_traits< char > >::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 264 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 316 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 345 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 267 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 375 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_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 272 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 276 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 279 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 378 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 >::seekoff(),
std::basic_ostream< _CharT, _Traits >::seekp(), 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 283 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 286 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 290 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 294 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 297 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 300 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 381 of file ios_base.h.
const fmtflags std::ios_base::unitbuf [static], [inherited]
Flushes output after each output operation.
Definition at line 303 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 307 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.
libstdc++ Wed Nostd::basic_istream< _CharT, _Traits >(3)
