libstdc++
|
Classes | |
class | failure |
Public Types | |
enum | event { erase_event, imbue_event, copyfmt_event } |
typedef void(* | event_callback) (event __e, ios_base &__b, int __i) |
typedef _Ios_Fmtflags | fmtflags |
typedef int | io_state |
typedef _Ios_Iostate | iostate |
typedef int | open_mode |
typedef _Ios_Openmode | openmode |
typedef int | seek_dir |
typedef _Ios_Seekdir | seekdir |
typedef std::streamoff | streamoff |
typedef std::streampos | streampos |
Public Member Functions | |
ios_base (const ios_base &)=delete | |
virtual | ~ios_base () |
const locale & | _M_getloc () const |
fmtflags | flags () const |
fmtflags | flags (fmtflags __fmtfl) |
locale | getloc () const |
locale | imbue (const locale &__loc) throw () |
long & | iword (int __ix) |
ios_base & | operator= (const ios_base &)=delete |
streamsize | precision () const |
streamsize | precision (streamsize __prec) |
void *& | pword (int __ix) |
void | register_callback (event_callback __fn, int __index) |
fmtflags | setf (fmtflags __fmtfl) |
fmtflags | setf (fmtflags __fmtfl, fmtflags __mask) |
void | unsetf (fmtflags __mask) |
streamsize | width () const |
streamsize | width (streamsize __wide) |
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_call_callbacks (event __ev) throw () |
void | _M_dispose_callbacks (void) throw () |
_Words & | _M_grow_words (int __index, bool __iword) |
void | _M_init () throw () |
void | _M_move (ios_base &) noexcept |
void | _M_swap (ios_base &__rhs) noexcept |
Protected Attributes | |
_Callback_list * | _M_callbacks |
iostate | _M_exception |
fmtflags | _M_flags |
locale | _M_ios_locale |
_Words | _M_local_word [_S_local_word_size] |
streamsize | _M_precision |
iostate | _M_streambuf_state |
streamsize | _M_width |
_Words * | _M_word |
int | _M_word_size |
_Words | _M_word_zero |
The base of the I/O class hierarchy.
This class defines everything that can be defined about I/O that does not depend on the type of characters being input or output. Most people will only see ios_base
when they need to specify the full name of the various I/O flags (e.g., the openmodes).
Definition at line 222 of file ios_base.h.
The type of an event callback function.
__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 498 of file ios_base.h.
typedef _Ios_Fmtflags std::ios_base::fmtflags |
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 317 of file ios_base.h.
typedef _Ios_Iostate std::ios_base::iostate |
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 392 of file ios_base.h.
typedef _Ios_Openmode std::ios_base::openmode |
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 423 of file ios_base.h.
typedef _Ios_Seekdir std::ios_base::seekdir |
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 455 of file ios_base.h.
enum std::ios_base::event |
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 481 of file ios_base.h.
|
virtual |
Invokes each callback with erase_event. Destroys local storage.
Note that the ios_base object for the standard streams never gets destroyed. As a result, any callbacks registered with the standard streams will not get invoked with erase_event (unless copyfmt is used).
|
inline |
Locale access.
Like getloc above, but returns a reference instead of generating a copy.
Definition at line 768 of file ios_base.h.
|
inline |
Access to format flags.
Definition at line 613 of file ios_base.h.
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 624 of file ios_base.h.
|
inline |
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 757 of file ios_base.h.
Setting a new locale.
__loc | The new locale. |
Sets the new locale for this stream, and then invokes each callback with imbue_event.
|
inline |
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 803 of file ios_base.h.
|
inline |
Flags access.
Be careful if you try to give a definition of precision here; see DR 189.
Definition at line 683 of file ios_base.h.
|
inline |
Changing flags.
__prec | The new precision value. |
Definition at line 692 of file ios_base.h.
|
inline |
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 824 of file ios_base.h.
void std::ios_base::register_callback | ( | event_callback | __fn, |
int | __index | ||
) |
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 640 of file ios_base.h.
Referenced by std::boolalpha(), std::dec(), std::fixed(), std::hex(), std::hexfloat(), std::left(), std::oct(), std::right(), std::scientific(), std::showbase(), std::showpoint(), std::showpos(), std::skipws(), std::unitbuf(), and std::uppercase().
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 657 of file ios_base.h.
|
static |
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 https://gcc.gnu.org/onlinedocs/libstdc++/manual/fstreams.html#std.io.filestreams.binary
|
inline |
Clearing format flags.
__mask | The flags to unset. |
This function clears __mask in the format flags.
Definition at line 672 of file ios_base.h.
Referenced by std::defaultfloat(), std::noboolalpha(), std::noshowbase(), std::noshowpoint(), std::noshowpos(), std::noskipws(), std::nounitbuf(), and std::nouppercase().
|
inline |
Flags access.
Minimum field width refers to the number of characters.
Definition at line 706 of file ios_base.h.
|
inline |
Changing flags.
__wide | The new width value. |
Definition at line 715 of file ios_base.h.
|
static |
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.
|
static |
A mask of left|right|internal. Useful for the 2-arg form of setf
.
Definition at line 372 of file ios_base.h.
Referenced by std::internal(), std::left(), and std::right().
|
static |
Seek to end before each write.
Definition at line 426 of file ios_base.h.
|
static |
Open and seek to end immediately after opening.
Definition at line 429 of file ios_base.h.
|
static |
Indicates a loss of integrity in an input or output sequence (such as an irrecoverable read error from a file).
Definition at line 396 of file ios_base.h.
Referenced by std::basic_ios< _CharT, _Traits >::bad(), and std::basic_ios< _CharT, _Traits >::fail().
|
static |
A mask of dec|oct|hex. Useful for the 2-arg form of setf
.
Definition at line 375 of file ios_base.h.
Referenced by std::dec(), std::hex(), and std::oct().
|
static |
Request a seek relative to the beginning of the stream.
Definition at line 458 of file ios_base.h.
|
static |
Perform input and output in binary mode (as opposed to text mode). This is probably not what you think it is; see https://gcc.gnu.org/onlinedocs/libstdc++/manual/fstreams.html#std.io.filestreams.binary.
Definition at line 434 of file ios_base.h.
|
static |
Insert/extract bool
in alphabetic rather than numeric format.
Definition at line 320 of file ios_base.h.
Referenced by std::boolalpha(), and std::noboolalpha().
|
static |
Request a seek relative to the current position within the sequence.
Definition at line 461 of file ios_base.h.
|
static |
Converts integer input or generates integer output in decimal base.
Definition at line 323 of file ios_base.h.
Referenced by std::dec().
|
static |
Request a seek relative to the current end of the sequence.
Definition at line 464 of file ios_base.h.
|
static |
Indicates that an input operation reached the end of an input sequence.
Definition at line 399 of file ios_base.h.
Referenced by std::basic_ios< _CharT, _Traits >::eof().
|
static |
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 404 of file ios_base.h.
Referenced by std::basic_ios< _CharT, _Traits >::fail().
|
static |
Generate floating-point output in fixed-point notation.
Definition at line 326 of file ios_base.h.
Referenced by std::fixed(), and std::hexfloat().
|
static |
A mask of scientific|fixed. Useful for the 2-arg form of setf
.
Definition at line 378 of file ios_base.h.
Referenced by std::defaultfloat(), std::fixed(), std::hexfloat(), and std::scientific().
|
static |
Indicates all is well.
Definition at line 407 of file ios_base.h.
|
static |
Converts integer input or generates integer output in hexadecimal base.
Definition at line 329 of file ios_base.h.
Referenced by std::hex().
|
static |
Open for input. Default for ifstream
and fstream.
Definition at line 437 of file ios_base.h.
|
static |
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 334 of file ios_base.h.
Referenced by std::internal().
|
static |
Adds fill characters on the right (final positions) of certain generated output. (I.e., the thing you print is flush left.)
Definition at line 338 of file ios_base.h.
Referenced by std::left().
|
static |
Converts integer input or generates integer output in octal base.
Definition at line 341 of file ios_base.h.
Referenced by std::oct().
|
static |
Open for output. Default for ofstream
and fstream.
Definition at line 440 of file ios_base.h.
|
static |
Adds fill characters on the left (initial positions) of certain generated output. (I.e., the thing you print is flush right.)
Definition at line 345 of file ios_base.h.
Referenced by std::right().
|
static |
Generates floating-point output in scientific notation.
Definition at line 348 of file ios_base.h.
Referenced by std::hexfloat(), and std::scientific().
|
static |
Generates a prefix indicating the numeric base of generated integer output.
Definition at line 352 of file ios_base.h.
Referenced by std::noshowbase(), and std::showbase().
|
static |
Generates a decimal-point character unconditionally in generated floating-point output.
Definition at line 356 of file ios_base.h.
Referenced by std::noshowpoint(), and std::showpoint().
|
static |
Generates a + sign in non-negative generated numeric output.
Definition at line 359 of file ios_base.h.
Referenced by std::noshowpos(), and std::showpos().
|
static |
Skips leading white space before certain input operations.
Definition at line 362 of file ios_base.h.
Referenced by std::noskipws(), and std::skipws().
|
static |
Open for input. Default for ofstream
.
Definition at line 443 of file ios_base.h.
|
static |
Flushes output after each output operation.
Definition at line 365 of file ios_base.h.
Referenced by std::nounitbuf(), and std::unitbuf().
|
static |
Replaces certain lowercase letters with their uppercase equivalents in generated output.
Definition at line 369 of file ios_base.h.
Referenced by std::nouppercase(), and std::uppercase().