libstdc++
|
Virtual base class for all stream classes.
Most of the member functions called dispatched on stream objects (e.g., std::cout.foo(bar)
;) are consolidated in this class.
typedef ctype<_CharT> std::basic_ios::__ctype_type |
These are non-standard types.
Reimplemented in std::basic_istream, and std::basic_ostream.
Definition at line 84 of file basic_ios.h.
typedef num_get<_CharT, istreambuf_iterator<_CharT, _Traits> > std::basic_ios::__num_get_type |
These are non-standard types.
Reimplemented in std::basic_istream.
Definition at line 88 of file basic_ios.h.
typedef num_put<_CharT, ostreambuf_iterator<_CharT, _Traits> > std::basic_ios::__num_put_type |
These are non-standard types.
Reimplemented in std::basic_ostream.
Definition at line 86 of file basic_ios.h.
typedef _CharT std::basic_ios::char_type |
These are standard types. They permit a standardized way of referring to names of (or names dependant on) the template parameters, which are specific to the implementation.
Reimplemented in std::basic_istream, and std::basic_ostream.
Definition at line 73 of file basic_ios.h.
typedef void(* std::ios_base::event_callback)(event, ios_base &, int) [inherited] |
The type of an event callback function.
event | One of the members of the event enum. |
ios_base | Reference to the ios_base object. |
int | The integer provided when the callback was registered. |
Event callbacks are user defined functions that get called during several ios_base and basic_ios functions, specifically imbue(), copyfmt(), and ~ios().
Definition at line 438 of file ios_base.h.
typedef _Ios_Fmtflags std::ios_base::fmtflags [inherited] |
This is a bitmask type.
_Ios_Fmtflags is
implementation-defined, but it is valid to perform bitwise operations on these values and expect the Right Thing to happen. Defined objects of type fmtflags are:
Definition at line 257 of file ios_base.h.
typedef _Traits::int_type std::basic_ios::int_type |
These are standard types. They permit a standardized way of referring to names of (or names dependant on) the template parameters, which are specific to the implementation.
Reimplemented in std::basic_istream, and std::basic_ostream.
Definition at line 74 of file basic_ios.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:
Definition at line 332 of file ios_base.h.
typedef _Traits::off_type std::basic_ios::off_type |
These are standard types. They permit a standardized way of referring to names of (or names dependant on) the template parameters, which are specific to the implementation.
Reimplemented in std::basic_istream, and std::basic_ostream.
Definition at line 76 of file basic_ios.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:
Definition at line 363 of file ios_base.h.
typedef _Traits::pos_type std::basic_ios::pos_type |
These are standard types. They permit a standardized way of referring to names of (or names dependant on) the template parameters, which are specific to the implementation.
Reimplemented in std::basic_istream, and std::basic_ostream.
Definition at line 75 of file basic_ios.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:
SEEK_CUR
in the C standard library.SEEK_END
in the C standard library. Definition at line 395 of file ios_base.h.
typedef _Traits std::basic_ios::traits_type |
These are standard types. They permit a standardized way of referring to names of (or names dependant on) the template parameters, which are specific to the implementation.
Reimplemented in std::basic_istream, and std::basic_ostream.
Definition at line 77 of file basic_ios.h.
enum std::ios_base::event [inherited] |
The set of events that may be passed to an event callback.
erase_event is used during ~ios() and copyfmt(). imbue_event is used during imbue(). copyfmt_event is used during copyfmt().
Definition at line 421 of file ios_base.h.
std::basic_ios::basic_ios | ( | basic_streambuf< _CharT, _Traits > * | __sb | ) | [inline, explicit] |
Constructor performs initialization.
The parameter is passed by derived streams.
Definition at line 262 of file basic_ios.h.
virtual std::basic_ios::~basic_ios | ( | ) | [inline, virtual] |
Empty.
The destructor does nothing. More specifically, it does not destroy the streambuf held by rdbuf().
Definition at line 274 of file basic_ios.h.
std::basic_ios::basic_ios | ( | ) | [inline, protected] |
Empty.
The default constructor does nothing and is not normally accessible to users.
Definition at line 452 of file basic_ios.h.
const locale& std::ios_base::_M_getloc | ( | ) | const [inline, inherited] |
Locale access.
Like getloc above, but returns a reference instead of generating a copy.
Definition at line 708 of file ios_base.h.
Referenced by std::num_get::do_get(), std::num_put::do_put(), std::money_get::do_get(), std::time_get::do_get_time(), std::time_get::do_get_date(), std::time_get::do_get_weekday(), std::time_get::do_get_monthname(), std::time_get::do_get_year(), std::time_put::put(), and std::time_put::do_put().
bool std::basic_ios::bad | ( | ) | const [inline] |
Fast error checking.
Note that other iostate flags may also be set.
Definition at line 203 of file basic_ios.h.
[Re]sets the error state.
state | The new state flag(s) to set. |
See std::ios_base::iostate for the possible bit values. Most users will not need to pass an argument.
Definition at line 42 of file basic_ios.tcc.
Referenced by std::basic_ios< _CharT, _Traits >::setstate(), and std::basic_ios< _CharT, _Traits >::exceptions().
Copies fields of __rhs into this.
__rhs | The source values for the copies. |
All fields of __rhs are copied into this object except that rdbuf() and rdstate() remain unchanged. All values in the pword and iword arrays are copied. Before copying, each callback is invoked with erase_event. After copying, each (new) callback is invoked with copyfmt_event. The final step is to copy exceptions().
Definition at line 64 of file basic_ios.tcc.
References std::ios_base::flags(), std::ios_base::width(), std::ios_base::precision(), tie(), fill(), std::ios_base::getloc(), and exceptions().
bool std::basic_ios::eof | ( | ) | const [inline] |
Fast error checking.
Note that other iostate flags may also be set.
Definition at line 182 of file basic_ios.h.
iostate std::basic_ios::exceptions | ( | ) | const [inline] |
Throwing exceptions on errors.
This changes nothing in the stream. See the one-argument version of exceptions(iostate) for the meaning of the return value.
Definition at line 214 of file basic_ios.h.
Referenced by copyfmt().
void std::basic_ios::exceptions | ( | iostate | __except | ) | [inline] |
Throwing exceptions on errors.
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 badbit\n"; f.setstate (std::ios_base::badbit); std::cerr << "Setting exception mask\n"; f.exceptions (std::ios_base::badbit); }
Definition at line 249 of file basic_ios.h.
bool std::basic_ios::fail | ( | ) | const [inline] |
Fast error checking.
Checking the badbit in fail() is historical practice. Note that other iostate flags may also be set.
Definition at line 193 of file basic_ios.h.
Referenced by std::basic_ios< _CharT, _Traits >::operator void *(), and std::basic_ios< _CharT, _Traits >::operator!().
char_type std::basic_ios::fill | ( | ) | const [inline] |
Retrieves the empty character.
It defaults to a space (' ') in the current locale.
Definition at line 362 of file basic_ios.h.
Referenced by std::basic_ios< _CharT, _Traits >::fill(), and copyfmt().
Sets a new empty character.
ch | The new character. |
The fill character is used to fill out space when P+ characters have been requested (e.g., via setw), Q characters are actually used, and Q<P. It defaults to a space (' ') in the current locale.
Definition at line 382 of file basic_ios.h.
fmtflags std::ios_base::flags | ( | ) | const [inline, inherited] |
Access to format flags.
Definition at line 553 of file ios_base.h.
Referenced by copyfmt(), std::num_get::do_get(), std::num_put::do_put(), and std::operator<<().
Setting new format flags all at once.
fmtfl | The new flags to set. |
This function overwrites all the format flags with fmtfl.
Definition at line 564 of file ios_base.h.
locale std::ios_base::getloc | ( | ) | const [inline, inherited] |
Locale access.
If imbue(loc)
has previously been called, then this function returns loc
. Otherwise, it returns a copy of std::locale()
, the global C++ locale.
Definition at line 697 of file ios_base.h.
Referenced by copyfmt(), and std::money_put::do_put().
bool std::basic_ios::good | ( | ) | const [inline] |
Fast error checking.
A wrapper around rdstate.
Definition at line 172 of file basic_ios.h.
Moves to a new locale.
loc | The new locale. |
Calls ios_base::imbue(loc)
, and if a stream buffer is associated with this stream, calls that buffer's pubimbue(loc)
.
Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html
Reimplemented from std::ios_base.
Definition at line 115 of file basic_ios.tcc.
void std::basic_ios::init | ( | basic_streambuf< _CharT, _Traits > * | __sb | ) | [protected] |
All setup is performed here.
This is called from the public constructor. It is not virtual and cannot be redefined.
Definition at line 127 of file basic_ios.tcc.
Referenced by std::basic_ios< _CharT, _Traits >::basic_ios().
long& std::ios_base::iword | ( | int | __ix | ) | [inline, inherited] |
Access to integer array.
__ix | Index into the array. |
The iword function provides access to an array of integers that can be used for any purpose. The array grows as required to hold the supplied index. All integers in the array are initialized to 0.
The implementation reserves several indices. You should use xalloc to obtain an index that is safe to use. Also note that since the array can grow dynamically, it is not safe to hold onto the reference.
Definition at line 743 of file ios_base.h.
char std::basic_ios::narrow | ( | char_type | __c, |
char | __dfault | ||
) | const [inline] |
Squeezes characters.
c | The character to narrow. |
dfault | The character to narrow. |
Maps a character of char_type
to a character of char
, if possible.
Returns the result of
Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html
Definition at line 422 of file basic_ios.h.
std::basic_ios::operator void * | ( | ) | const [inline] |
The quick-and-easy status check.
This allows you to write constructs such as if (!a_stream) ...
and while (a_stream) ...
Definition at line 113 of file basic_ios.h.
bool std::basic_ios::operator! | ( | ) | const [inline] |
The quick-and-easy status check.
This allows you to write constructs such as if (!a_stream) ...
and while (a_stream) ...
Definition at line 117 of file basic_ios.h.
streamsize std::ios_base::precision | ( | ) | const [inline, inherited] |
Flags access.
Be careful if you try to give a definition of precision here; see DR 189.
Definition at line 623 of file ios_base.h.
Referenced by copyfmt().
streamsize std::ios_base::precision | ( | streamsize | __prec | ) | [inline, inherited] |
Changing flags.
prec | The new precision value. |
Definition at line 632 of file ios_base.h.
void*& std::ios_base::pword | ( | int | __ix | ) | [inline, inherited] |
Access to void pointer array.
__ix | Index into the array. |
The pword function provides access to an array of pointers that can be used for any purpose. The array grows as required to hold the supplied index. All pointers in the array are initialized to 0.
The implementation reserves several indices. You should use xalloc to obtain an index that is safe to use. Also note that since the array can grow dynamically, it is not safe to hold onto the reference.
Definition at line 764 of file ios_base.h.
basic_streambuf<_CharT, _Traits>* std::basic_ios::rdbuf | ( | ) | const [inline] |
Accessing the underlying buffer.
This does not change the state of the stream.
Definition at line 313 of file basic_ios.h.
basic_streambuf< _CharT, _Traits > * std::basic_ios::rdbuf | ( | basic_streambuf< _CharT, _Traits > * | __sb | ) |
Changing the underlying buffer.
sb | The new 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 54 of file basic_ios.tcc.
iostate std::basic_ios::rdstate | ( | ) | const [inline] |
Returns the error state of the stream buffer.
See std::ios_base::iostate for the possible bit values. Most users will call one of the interpreting wrappers, e.g., good().
Definition at line 129 of file basic_ios.h.
Referenced by std::basic_ios< _CharT, _Traits >::setstate(), std::basic_ios< _CharT, _Traits >::good(), std::basic_ios< _CharT, _Traits >::eof(), std::basic_ios< _CharT, _Traits >::fail(), and std::basic_ios< _CharT, _Traits >::bad().
void std::ios_base::register_callback | ( | event_callback | __fn, |
int | __index | ||
) | [inherited] |
Add the callback __fn with parameter __index.
__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.
Setting new format flags.
fmtfl | Additional flags to set. |
This function sets additional flags in format control. Flags that were previously set remain set.
Definition at line 580 of file ios_base.h.
Setting new format flags.
fmtfl | Additional flags to set. |
mask | The flags mask for fmtfl. |
This function clears mask in the format flags, then sets fmtfl &
mask. An example mask is ios_base::adjustfield
.
Definition at line 597 of file ios_base.h.
void std::basic_ios::setstate | ( | iostate | __state | ) | [inline] |
Sets additional flags in the error state.
state | The additional state flag(s) to set. |
See std::ios_base::iostate for the possible bit values.
Definition at line 149 of file basic_ios.h.
static bool std::ios_base::sync_with_stdio | ( | bool | __sync = true | ) | [static, inherited] |
Interaction with the standard C I/O objects.
sync | Whether to synchronize or not. |
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
basic_ostream<_CharT, _Traits>* std::basic_ios::tie | ( | ) | const [inline] |
Fetches the current tied stream.
A stream may be tied (or synchronized) to a second output stream. When this stream performs any I/O, the tied stream is first flushed. For example, std::cin
is tied to std::cout
.
Definition at line 287 of file basic_ios.h.
Referenced by copyfmt().
basic_ostream<_CharT, _Traits>* std::basic_ios::tie | ( | basic_ostream< _CharT, _Traits > * | __tiestr | ) | [inline] |
Ties this stream to an output stream.
tiestr | The output stream. |
This sets up a new tie; see tie() for more.
Definition at line 299 of file basic_ios.h.
void std::ios_base::unsetf | ( | fmtflags | __mask | ) | [inline, inherited] |
Clearing format flags.
mask | The flags to unset. |
This function clears mask in the format flags.
Definition at line 612 of file ios_base.h.
char_type std::basic_ios::widen | ( | char | __c | ) | const [inline] |
Widens characters.
c | The character to widen. |
Maps a character of char
to a character of char_type
.
Returns the result of
Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html
Definition at line 441 of file basic_ios.h.
Referenced by std::basic_ios< _CharT, _Traits >::fill().
streamsize std::ios_base::width | ( | ) | const [inline, inherited] |
Flags access.
Minimum field width refers to the number of characters.
Definition at line 646 of file ios_base.h.
Referenced by copyfmt(), and std::num_put::do_put().
streamsize std::ios_base::width | ( | streamsize | __wide | ) | [inline, inherited] |
Changing flags.
wide | The new width value. |
Definition at line 655 of file ios_base.h.
static int std::ios_base::xalloc | ( | ) | throw () [static, inherited] |
Access to unique indices.
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.
const fmtflags std::ios_base::adjustfield [static, inherited] |
A mask of left|right|internal. Useful for the 2-arg form of setf
.
Definition at line 312 of file ios_base.h.
Referenced by std::internal(), std::left(), std::right(), and std::num_put::do_put().
const openmode std::ios_base::app [static, inherited] |
Seek to end before each write.
Definition at line 366 of file ios_base.h.
const openmode std::ios_base::ate [static, inherited] |
Open and seek to end immediately after opening.
Definition at line 369 of file ios_base.h.
const iostate std::ios_base::badbit [static, inherited] |
Indicates a loss of integrity in an input or output sequence (such as an irrecoverable read error from a file).
Definition at line 336 of file ios_base.h.
Referenced by std::basic_ios< _CharT, _Traits >::fail(), std::basic_ios< _CharT, _Traits >::bad(), std::basic_istream::operator>>(), std::basic_istream::get(), std::basic_istream::getline(), std::basic_istream::ignore(), std::basic_istream::peek(), std::basic_istream::read(), std::basic_istream::readsome(), std::basic_istream::putback(), std::basic_istream::unget(), std::basic_istream::sync(), std::basic_istream::tellg(), std::basic_istream::seekg(), std::operator>>(), std::basic_ostream< char >::_M_write(), std::basic_ostream::sentry::~sentry(), std::operator<<(), std::basic_ostream::operator<<(), std::basic_ostream::put(), std::basic_ostream::write(), std::basic_ostream::flush(), std::basic_ostream::tellp(), and std::basic_ostream::seekp().
const fmtflags std::ios_base::basefield [static, inherited] |
A mask of dec|oct|hex. Useful for the 2-arg form of setf
.
Definition at line 315 of file ios_base.h.
Referenced by std::dec(), std::hex(), std::oct(), and std::num_get::do_get().
const seekdir std::ios_base::beg [static, inherited] |
Request a seek relative to the beginning of the stream.
Definition at line 398 of file ios_base.h.
const openmode std::ios_base::binary [static, inherited] |
Perform input and output in binary mode (as opposed to text mode). This is probably not what you think it is; see http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch27s02.html.
Definition at line 374 of file ios_base.h.
const fmtflags std::ios_base::boolalpha [static, inherited] |
Insert/extract bool
in alphabetic rather than numeric format.
Definition at line 260 of file ios_base.h.
Referenced by std::boolalpha(), std::noboolalpha(), and std::num_put::do_put().
const seekdir std::ios_base::cur [static, inherited] |
Request a seek relative to the current position within the sequence.
Definition at line 401 of file ios_base.h.
Referenced by std::basic_istream::tellg(), and std::basic_ostream::tellp().
const fmtflags std::ios_base::dec [static, inherited] |
Converts integer input or generates integer output in decimal base.
Definition at line 263 of file ios_base.h.
Referenced by std::dec().
const seekdir std::ios_base::end [static, inherited] |
Request a seek relative to the current end of the sequence.
Definition at line 404 of file ios_base.h.
const iostate std::ios_base::eofbit [static, inherited] |
Indicates that an input operation reached the end of an input sequence.
Definition at line 339 of file ios_base.h.
Referenced by std::basic_ios< _CharT, _Traits >::eof(), std::basic_istream::putback(), std::basic_istream::unget(), std::basic_istream::seekg(), and std::ws().
const iostate std::ios_base::failbit [static, inherited] |
Indicates that an input operation failed to read the expected characters, or that an output operation failed to generate the desired characters.
Definition at line 344 of file ios_base.h.
Referenced by std::basic_ios< _CharT, _Traits >::fail(), std::operator>>(), std::basic_ifstream::open(), std::basic_ifstream::close(), std::basic_ofstream::open(), std::basic_ofstream::close(), std::basic_fstream::open(), std::basic_fstream::close(), std::basic_istream::operator>>(), std::basic_ostream::sentry::sentry(), and std::basic_ostream::operator<<().
const fmtflags std::ios_base::fixed [static, inherited] |
Generate floating-point output in fixed-point notation.
Definition at line 266 of file ios_base.h.
Referenced by std::fixed().
const fmtflags std::ios_base::floatfield [static, inherited] |
A mask of scientific|fixed. Useful for the 2-arg form of setf
.
Definition at line 318 of file ios_base.h.
Referenced by std::fixed(), and std::scientific().
const iostate std::ios_base::goodbit [static, inherited] |
Indicates all is well.
Definition at line 347 of file ios_base.h.
const fmtflags std::ios_base::hex [static, inherited] |
Converts integer input or generates integer output in hexadecimal base.
Definition at line 269 of file ios_base.h.
Referenced by std::hex(), std::num_get::do_get(), std::num_put::do_put(), and std::basic_ostream::operator<<().
const openmode std::ios_base::in [static, inherited] |
Open for input. Default for ifstream
and fstream.
Definition at line 377 of file ios_base.h.
Referenced by std::basic_ifstream::open(), std::basic_istream::tellg(), std::basic_istream::seekg(), and std::basic_stringbuf::showmanyc().
const fmtflags std::ios_base::internal [static, inherited] |
Adds fill characters at a designated internal point in certain generated output, or identical to right
if no such point is designated.
Definition at line 274 of file ios_base.h.
Referenced by std::internal().
const fmtflags std::ios_base::left [static, inherited] |
Adds fill characters on the right (final positions) of certain generated output. (I.e., the thing you print is flush left.)
Definition at line 278 of file ios_base.h.
Referenced by std::left(), and std::num_put::do_put().
const fmtflags std::ios_base::oct [static, inherited] |
Converts integer input or generates integer output in octal base.
Definition at line 281 of file ios_base.h.
Referenced by std::oct(), and std::basic_ostream::operator<<().
const openmode std::ios_base::out [static, inherited] |
Open for output. Default for ofstream
and fstream.
Definition at line 380 of file ios_base.h.
Referenced by std::basic_ofstream::open(), std::basic_ostream::tellp(), and std::basic_ostream::seekp().
const fmtflags std::ios_base::right [static, inherited] |
Adds fill characters on the left (initial positions) of certain generated output. (I.e., the thing you print is flush right.)
Definition at line 285 of file ios_base.h.
Referenced by std::right().
const fmtflags std::ios_base::scientific [static, inherited] |
Generates floating-point output in scientific notation.
Definition at line 288 of file ios_base.h.
Referenced by std::scientific().
const fmtflags std::ios_base::showbase [static, inherited] |
Generates a prefix indicating the numeric base of generated integer output.
Definition at line 292 of file ios_base.h.
Referenced by std::showbase(), and std::noshowbase().
const fmtflags std::ios_base::showpoint [static, inherited] |
Generates a decimal-point character unconditionally in generated floating-point output.
Definition at line 296 of file ios_base.h.
Referenced by std::showpoint(), and std::noshowpoint().
const fmtflags std::ios_base::showpos [static, inherited] |
Generates a + sign in non-negative generated numeric output.
Definition at line 299 of file ios_base.h.
Referenced by std::showpos(), and std::noshowpos().
const fmtflags std::ios_base::skipws [static, inherited] |
Skips leading white space before certain input operations.
Definition at line 302 of file ios_base.h.
Referenced by std::skipws(), and std::noskipws().
const openmode std::ios_base::trunc [static, inherited] |
Open for input. Default for ofstream
.
Definition at line 383 of file ios_base.h.
const fmtflags std::ios_base::unitbuf [static, inherited] |
Flushes output after each output operation.
Definition at line 305 of file ios_base.h.
Referenced by std::unitbuf(), and std::nounitbuf().
const fmtflags std::ios_base::uppercase [static, inherited] |
Replaces certain lowercase letters with their uppercase equivalents in generated output.
Definition at line 309 of file ios_base.h.
Referenced by std::uppercase(), and std::nouppercase().