Public Types
- typedef ctype< _CharT > __ctype_type
- typedef ctype< _CharT > __ctype_type
-
typedef basic_ios< _CharT,
_Traits > __ios_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 num_put< _CharT,
ostreambuf_iterator< _CharT,
_Traits > > __num_put_type -
typedef basic_ostream< _CharT,
_Traits > __ostream_type -
typedef basic_streambuf
< _CharT, _Traits > __streambuf_type -
typedef basic_streambuf
< _CharT, _Traits > __streambuf_type - typedef _CharT char_type
- typedef _Traits::int_type int_type
- typedef _Traits::off_type off_type
- typedef _Traits::pos_type pos_type
- typedef _Traits traits_type
Public Member Functions
- basic_iostream (basic_streambuf< _CharT, _Traits > *__sb)
- virtual ~basic_iostream ()
- __ostream_type & flush ()
- streamsize gcount () const
- __ostream_type & seekp (pos_type)
- __ostream_type & seekp (off_type, ios_base::seekdir)
- pos_type tellp ()
- __istream_type & operator>> (__istream_type &(*__pf)(__istream_type &))
- __istream_type & operator>> (__ios_type &(*__pf)(__ios_type &))
- __istream_type & operator>> (ios_base &(*__pf)(ios_base &))
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)
- __istream_type & operator>> (void *&__p)
- __istream_type & operator>> (__streambuf_type *__sb)
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 ()
- __istream_type & ignore (streamsize __n)
- __istream_type & ignore (streamsize __n, int_type __delim)
- 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)
- __ostream_type & operator<< (__ostream_type &(*__pf)(__ostream_type &))
- __ostream_type & operator<< (__ios_type &(*__pf)(__ios_type &))
- __ostream_type & operator<< (ios_base &(*__pf)(ios_base &))
All the operator<< functions (aka formatted output functions) have some common behavior. Each starts by constructing a temporary object of type std::basic_ostream::sentry. This can have 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 generate whatever data is appropriate for the type of the argument.
If an exception is thrown during insertion, 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.
- __ostream_type & operator<< (long __n)
- __ostream_type & operator<< (unsigned long __n)
- __ostream_type & operator<< (bool __n)
- __ostream_type & operator<< (short __n)
- __ostream_type & operator<< (unsigned short __n)
- __ostream_type & operator<< (int __n)
- __ostream_type & operator<< (unsigned int __n)
- __ostream_type & operator<< (long long __n)
- __ostream_type & operator<< (unsigned long long __n)
- __ostream_type & operator<< (double __f)
- __ostream_type & operator<< (float __f)
- __ostream_type & operator<< (long double __f)
- __ostream_type & operator<< (const void *__p)
- __ostream_type & operator<< (__streambuf_type *__sb)
All the unformatted output functions have some common behavior. Each starts by constructing a temporary object of type std::basic_ostream::sentry. 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 generate whatever data is appropriate for the type of the argument.
If an exception is thrown during insertion, ios_base::badbit will be turned on in the stream's error state. If badbit is on in the stream's exceptions mask, the exception will be rethrown without completing its actions.
- __ostream_type & put (char_type __c)
- void _M_write (const char_type *__s, streamsize __n)
- __ostream_type & write (const char_type *__s, streamsize __n)
Protected Member Functions
- __istream_type & _M_extract (_ValueT &__v)
- __ostream_type & _M_insert (_ValueT __v)
Protected Attributes
Friends
Detailed Description
Merging istream and ostream capabilities.
This class multiply inherits from the input and output stream classes simply to provide a single interface.
Constructor & Destructor Documentation
| std::basic_iostream::basic_iostream | ( | basic_streambuf< _CharT, _Traits > * | __sb | ) | [inline, explicit] |
| virtual std::basic_iostream::~basic_iostream | ( | ) | [inline, virtual] |
Member Function Documentation
| void std::basic_ostream::_M_write | ( | const char_type * | __s, |
| streamsize | __n | ||
| ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::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.
| streamsize std::basic_istream::gcount | ( | ) | const [inline, inherited] |
| int_type std::basic_istream::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().
| __istream_type& std::basic_istream::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.
| __istream_type& std::basic_istream::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-1characters 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.
| __istream_type& std::basic_istream::get | ( | char_type * | __s, |
| streamsize | __n | ||
| ) | [inline, inherited] |
| __istream_type& std::basic_istream::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)
If no characters are stored, failbit is set in the stream's error state.
| __istream_type& std::basic_istream::get | ( | __streambuf_type & | __sb | ) | [inline, inherited] |
| __istream_type& std::basic_istream::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.
- the input sequence reaches end-of-file, in which case eofbit is set in the stream error state
- the next character equals
delim, in which case the character is extracted (and therefore counted ingcount()) but not stored n-1characters 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.
| __istream_type& std::basic_istream::getline | ( | char_type * | __s, |
| streamsize | __n | ||
| ) | [inline, inherited] |
| __istream_type& std::basic_istream::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().
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.
| __istream_type& std::basic_istream::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().
| __istream_type& std::basic_istream::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().
| __ostream_type& std::basic_ostream::operator<< | ( | __ostream_type &(*)(__ostream_type &) | __pf | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | __ios_type &(*)(__ios_type &) | __pf | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | ios_base &(*)(ios_base &) | __pf | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | long | __n | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | unsigned long | __n | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | bool | __n | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | short | __n | ) | [inherited] |
Basic arithmetic inserters.
- Parameters:
-
A variable of builtin type.
- Returns:
*thisif successful
These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.
| __ostream_type& std::basic_ostream::operator<< | ( | unsigned short | __n | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | int | __n | ) | [inherited] |
Basic arithmetic inserters.
- Parameters:
-
A variable of builtin type.
- Returns:
*thisif successful
These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.
| __ostream_type& std::basic_ostream::operator<< | ( | unsigned int | __n | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | long long | __n | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | unsigned long long | __n | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | double | __f | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | float | __f | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | long double | __f | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::operator<< | ( | const void * | __p | ) | [inline, inherited] |
| __ostream_type& std::basic_ostream::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
If the function inserts no characters, failbit is set.
| __istream_type& std::basic_istream::operator>> | ( | __istream_type &(*)(__istream_type &) | __pf | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | __ios_type &(*)(__ios_type &) | __pf | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | ios_base &(*)(ios_base &) | __pf | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | bool & | __n | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | short & | __n | ) | [inherited] |
Basic arithmetic extractors.
- Parameters:
-
A variable of builtin type.
- Returns:
*thisif successful
These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.
| __istream_type& std::basic_istream::operator>> | ( | unsigned short & | __n | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | int & | __n | ) | [inherited] |
Basic arithmetic extractors.
- Parameters:
-
A variable of builtin type.
- Returns:
*thisif successful
These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.
| __istream_type& std::basic_istream::operator>> | ( | unsigned int & | __n | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | long & | __n | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | unsigned long & | __n | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | long long & | __n | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | unsigned long long & | __n | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | float & | __f | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | double & | __f | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | long double & | __f | ) | [inline, inherited] |
| __istream_type& std::basic_istream::operator>> | ( | void *& | __p | ) | [inline, inherited] |
| __istream_type& std::basic_istream::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)
If the function inserts no characters, failbit is set.
| int_type std::basic_istream::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.
| __ostream_type& std::basic_ostream::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.
| __istream_type& std::basic_istream::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.
| __istream_type& std::basic_istream::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.
- Note:
- This function is not overloaded on signed char and unsigned char.
| streamsize std::basic_istream::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, extractsmin(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.
| __istream_type& std::basic_istream::seekg | ( | pos_type | ) | [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().
| __istream_type& std::basic_istream::seekg | ( | off_type | , |
| ios_base::seekdir | |||
| ) | [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().
| __ostream_type& std::basic_ostream::seekp | ( | pos_type | ) | [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.
| __ostream_type& std::basic_ostream::seekp | ( | off_type | , |
| ios_base::seekdir | |||
| ) | [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.
| int std::basic_istream::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().
| pos_type std::basic_istream::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.
| pos_type std::basic_ostream::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).
| __istream_type& std::basic_istream::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.
| __ostream_type& std::basic_ostream::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)
- Note:
- This function is not overloaded on signed char and unsigned char.
Member Data Documentation
streamsize std::basic_istream::_M_gcount [protected, inherited] |
The documentation for this class was generated from the following file:
