man std::basic_ios (Fonctions bibliothèques) - Virtual base class for all stream classes.

NAME

std::basic_ios - Virtual base class for all stream classes.

SYNOPSIS



#include <ios>

Inherits std::ios_base.

Inherited by std::basic_istream< CharT, Traits > [virtual], and std::basic_ostream< CharT, Traits > [virtual].

Public Types

typedef IosFmtflags fmtflags

This is a bitmask type. typedef IosIostate iostate

This is a bitmask type. typedef IosOpenmode openmode

This is a bitmask type. typedef IosSeekdir seekdir

This is an enumerated type. typedef void(* event_callback )(event, ios_base &, int)

The type of an event callback function. enum event

The set of events that may be passed to an event callback.



typedef CharT char_type

typedef Traits::int_type int_type

typedef Traits::pos_type pos_type

typedef Traits::off_type off_type

typedef Traits traits_type



typedef ctype< CharT > ctype_type

typedef num_put< CharT, ostreambuf_iterator< CharT, Traits > > num_put_type

typedef num_get< CharT, istreambuf_iterator< CharT, Traits > > num_get_type

Public Member Functions

iostate rdstate () const

Returns the error state of the stream buffer. void clear (iostate state=goodbit)

[Re]sets the error state. void setstate (iostate state)

Sets additional flags in the error state. void M_setstate (iostate state)

bool good () const

Fast error checking. bool eof () const

Fast error checking. bool fail () const

Fast error checking. bool bad () const

Fast error checking. iostate exceptions () const

Throwing exceptions on errors. void exceptions (iostate __except)

Throwing exceptions on errors. basic_ios (basic_streambuf< CharT, Traits > *sb)

Constructor performs initialization. virtual ~basic_ios ()

Empty. basic_ostream< CharT, Traits > * tie () const

Fetches the current tied stream. basic_ostream< CharT, Traits > * tie (basic_ostream< CharT, Traits > *__tiestr)

Ties this stream to an output stream. basic_streambuf< CharT, Traits > * rdbuf () const

Accessing the underlying buffer. basic_streambuf< CharT, Traits > * rdbuf (basic_streambuf< CharT, Traits > *sb)

Changing the underlying buffer. basic_ios & copyfmt (const basic_ios &__rhs)

Copies fields of __rhs into this. char_type fill () const

Retreives the 'empty' character. char_type fill (char_type ch)

Sets a new 'empty' character. locale imbue (const locale &__loc)

Moves to a new locale. char narrow (char_type c, char __dfault) const

Squeezes characters. char_type widen (char c) const

Widens characters. void register_callback (event_callback __fn, int index)

Add the callback __fn with parameter index. fmtflags flags () const

Access to format flags. fmtflags flags (fmtflags __fmtfl)

Setting new format flags all at once. fmtflags setf (fmtflags __fmtfl)

Setting new format flags. fmtflags setf (fmtflags __fmtfl, fmtflags __mask)

Setting new format flags. void unsetf (fmtflags __mask)

Clearing format flags. streamsize precision () const

Flags access. streamsize precision (streamsize __prec)

Changing flags. streamsize width () const

Flags access. streamsize width (streamsize __wide)

Changing flags. locale getloc () const

Locale access. const locale & M_getloc () const

Locale access. long & iword (int __ix)

Access to integer array. void *& pword (int __ix)

Access to void pointer array.



operator void * () const

The quick-and-easy status check. bool operator! () const

The quick-and-easy status check.

Static Public Member Functions

static bool sync_with_stdio (bool sync=true)

Interaction with the standard C I/O objects. static int xalloc () throw ()

Access to unique indices.

Static Public Attributes

static const fmtflags boolalpha

Insert/extract bool in alphabetic rather than numeric format. static const fmtflags dec

Converts integer input or generates integer output in decimal base. static const fmtflags fixed

Generate floating-point output in fixed-point notation. static const fmtflags hex

Converts integer input or generates integer output in hexadecimal base. static const fmtflags internal

designated. static const fmtflags left

generated output. (I.e., the thing you print is flush left.) static const fmtflags oct

Converts integer input or generates integer output in octal base. static const fmtflags right

generated output. (I.e., the thing you print is flush right.) static const fmtflags scientific

Generates floating-point output in scientific notation. static const fmtflags showbase

output. static const fmtflags showpoint

floating-point output. static const fmtflags showpos

Generates a + sign in non-negative generated numeric output. static const fmtflags skipws

Skips leading white space before certain input operations. static const fmtflags unitbuf

Flushes output after each output operation. static const fmtflags uppercase

in generated output. static const fmtflags adjustfield

A mask of left|right|internal. Useful for the 2-arg form of setf. static const fmtflags basefield

A mask of dec|oct|hex. Useful for the 2-arg form of setf. static const fmtflags floatfield

A mask of scientific|fixed. Useful for the 2-arg form of setf. static const iostate badbit

as an irrecoverable read error from a file). static const iostate eofbit

Indicates that an input operation reached the end of an input sequence. static const iostate failbit

desired characters. static const iostate goodbit

Indicates all is well. static const openmode app

Seek to end before each write. static const openmode ate

Open and seek to end immediately after opening. static const openmode binary

http://gcc.gnu.org/onlinedocs/libstdc++/27_io/howto.html#7 for more. static const openmode in

Open for input. Default for ifstream and fstream. static const openmode out

Open for output. Default for ofstream and fstream. static const openmode trunc

Open for input. Default for ofstream. static const seekdir beg

Request a seek relative to the beginning of the stream. static const seekdir cur

Request a seek relative to the current position within the sequence. static const seekdir end

Request a seek relative to the current end of the sequence.

Protected Member Functions

basic_ios ()

Empty. void init (basic_streambuf< CharT, Traits > *sb)

All setup is performed here. void M_cache_locale (const locale &__loc)

void M_call_callbacks (event __ev) throw ()

void M_dispose_callbacks (void)

Words & M_grow_words (int index, bool __iword)

void M_init ()

Protected Attributes

basic_ostream< CharT, Traits > * M_tie

char_type M_fill

bool M_fill_init

basic_streambuf< CharT, Traits > * M_streambuf

const ctype_type * M_ctype

const num_put_type * M_num_put

const num_get_type * M_num_get

Callback_list * M_callbacks

Words M_word_zero

Words M_local_word [S_local_word_size]

int M_word_size

Words * M_word

locale M_ios_locale



streamsize M_precision

streamsize M_width

fmtflags M_flags

iostate M_exception

iostate M_streambuf_state

Static Protected Attributes

static const int S_local_word_size

Detailed Description

template<typename CharT, typename Traits> class std::basic_ios< CharT, Traits >

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.

Definition at line 56 of file ios.

Member Typedef Documentation

template<typename CharT, typename Traits> typedef CharT std::basic_ios< CharT, Traits >::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::strstream, std::basic_ifstream< CharT, Traits >, std::basic_ofstream< CharT, Traits >, std::basic_fstream< CharT, Traits >, std::basic_istream< CharT, Traits >, std::basic_iostream< CharT, Traits >, std::basic_ostream< CharT, Traits >, std::basic_istringstream< CharT, Traits, Alloc >, std::basic_ostringstream< CharT, Traits, Alloc >, std::basic_stringstream< CharT, Traits, Alloc >, std::basic_istream< char, Traits >, std::basic_istream< char >, std::basic_iostream< char >, std::basic_ostream< char, Traits >, and std::basic_ostream< char >.

Definition at line 65 of file ios.

typedef void(* std::ios_base::event_callback)(event, ios_base &, int) [inherited]

The type of an event callback function.

Parameters: event One of the members of the event enum.

ios_base Reference to the ios_base object.

int The integer provided when the callback was registered.

Event callbacks are user defined functions that get called during several ios_base and basic_ios functions, specifically imbue(), copyfmt(), and ~ios().

Definition at line 437 of file ios_base.h.

typedef IosFmtflags std::ios_base::fmtflags [inherited]

This is a bitmask type.

'IosFmtflags' 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 253 of file ios_base.h.

template<typename CharT, typename Traits> typedef Traits::int_type std::basic_ios< CharT, Traits >::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::strstream, std::basic_ifstream< CharT, Traits >, std::basic_ofstream< CharT, Traits >, std::basic_fstream< CharT, Traits >, std::basic_istream< CharT, Traits >, std::basic_iostream< CharT, Traits >, std::basic_ostream< CharT, Traits >, std::basic_istringstream< CharT, Traits, Alloc >, std::basic_ostringstream< CharT, Traits, Alloc >, std::basic_stringstream< CharT, Traits, Alloc >, std::basic_istream< char, Traits >, std::basic_istream< char >, std::basic_iostream< char >, std::basic_ostream< char, Traits >, and std::basic_ostream< char >.

Definition at line 66 of file ios.

typedef IosIostate std::ios_base::iostate [inherited]

This is a bitmask type.

'IosIostate' 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 328 of file ios_base.h.

template<typename CharT, typename Traits> typedef Traits::off_type std::basic_ios< CharT, Traits >::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::strstream, std::basic_ifstream< CharT, Traits >, std::basic_ofstream< CharT, Traits >, std::basic_fstream< CharT, Traits >, std::basic_istream< CharT, Traits >, std::basic_iostream< CharT, Traits >, std::basic_ostream< CharT, Traits >, std::basic_istringstream< CharT, Traits, Alloc >, std::basic_ostringstream< CharT, Traits, Alloc >, std::basic_stringstream< CharT, Traits, Alloc >, std::basic_istream< char, Traits >, std::basic_istream< char >, std::basic_iostream< char >, std::basic_ostream< char, Traits >, and std::basic_ostream< char >.

Definition at line 68 of file ios.

typedef IosOpenmode std::ios_base::openmode [inherited]

This is a bitmask type.

'IosOpenmode' 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 359 of file ios_base.h.

template<typename CharT, typename Traits> typedef Traits::pos_type std::basic_ios< CharT, Traits >::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::strstream, std::basic_ifstream< CharT, Traits >, std::basic_ofstream< CharT, Traits >, std::basic_fstream< CharT, Traits >, std::basic_istream< CharT, Traits >, std::basic_iostream< CharT, Traits >, std::basic_ostream< CharT, Traits >, std::basic_istringstream< CharT, Traits, Alloc >, std::basic_ostringstream< CharT, Traits, Alloc >, std::basic_stringstream< CharT, Traits, Alloc >, std::basic_istream< char, Traits >, std::basic_istream< char >, std::basic_iostream< char >, std::basic_ostream< char, Traits >, and std::basic_ostream< char >.

Definition at line 67 of file ios.

typedef IosSeekdir std::ios_base::seekdir [inherited]

This is an enumerated type.

'IosSeekdir' is implementation-defined. Defined values of type seekdir are:

•
beg
•
cur, equivalent to SEEKCUR in the C standard library.
•
end, equivalent to SEEKEND in the C standard library.

Definition at line 392 of file ios_base.h.

template<typename CharT, typename Traits> typedef Traits std::basic_ios< CharT, Traits >::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_ifstream< CharT, Traits >, std::basic_ofstream< CharT, Traits >, std::basic_fstream< CharT, Traits >, std::basic_istream< CharT, Traits >, std::basic_iostream< CharT, Traits >, std::basic_ostream< CharT, Traits >, std::basic_istringstream< CharT, Traits, Alloc >, std::basic_ostringstream< CharT, Traits, Alloc >, std::basic_stringstream< CharT, Traits, Alloc >, std::basic_istream< char, Traits >, std::basic_istream< char >, std::basic_iostream< char >, std::basic_ostream< char, Traits >, and std::basic_ostream< char >.

Definition at line 69 of file ios.

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 420 of file ios_base.h.

Constructor & Destructor Documentation

template<typename CharT, typename Traits> std::basic_ios< CharT, Traits >::basic_ios (basic_streambuf< CharT, Traits > * sb) [inline, explicit]

Constructor performs initialization.

The parameter is passed by derived streams.

Definition at line 256 of file ios.

template<typename CharT, typename Traits> virtual std::basic_ios< CharT, Traits >::~basic_ios () [inline, virtual]

Empty.

The destructor does nothing. More specifically, it does not destroy the streambuf held by rdbuf().

Definition at line 268 of file ios.

template<typename CharT, typename Traits> std::basic_ios< CharT, Traits >::basic_ios () [inline, protected]

Empty.

The default constructor does nothing and is not normally accessible to users.

Definition at line 444 of file ios.

Member Function Documentation

template<typename CharT, typename Traits> bool std::basic_ios< CharT, Traits >::bad () const [inline]

Fast error checking.

Returns: True if the badbit is set.

Note that other iostate flags may also be set.

Definition at line 197 of file ios.

template<typename CharT, typename Traits> void std::basic_ios< CharT, Traits >::clear (iostate state = goodbit)

[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 39 of file basic_ios.tcc.

References std::__throw_ios_failure(), std::ios_base::badbit, and std::basic_ios< CharT, Traits >::rdstate().

Referenced by std::basic_ios< char, Traits >::exceptions(), std::basic_ios< CharT, Traits >::rdbuf(), and std::basic_ios< char, Traits >::setstate().

template<typename CharT, typename Traits> basic_ios< CharT, Traits > & std::basic_ios< CharT, Traits >::copyfmt (const basic_ios< CharT, Traits > & __rhs)

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 61 of file basic_ios.tcc.

References std::basic_ios< CharT, Traits >::exceptions(), std::basic_ios< CharT, Traits >::fill(), std::ios_base::flags(), std::ios_base::getloc(), std::ios_base::precision(), std::basic_ios< CharT, Traits >::tie(), and std::ios_base::width().

template<typename CharT, typename Traits> bool std::basic_ios< CharT, Traits >::eof () const [inline]

Fast error checking.

Returns: True if the eofbit is set.

Note that other iostate flags may also be set.

Definition at line 176 of file ios.

template<typename CharT, typename Traits> void std::basic_ios< CharT, Traits >::exceptions (iostate __except) [inline]

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 flage 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 badbitn'; f.setstate (std::ios_base::badbit);

std::cerr << 'Setting exception maskn'; f.exceptions (std::ios_base::badbit); }

Definition at line 243 of file ios.

template<typename CharT, typename Traits> iostate std::basic_ios< CharT, Traits >::exceptions () const [inline]

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 208 of file ios.

Referenced by std::basic_ios< CharT, Traits >::copyfmt().

template<typename CharT, typename Traits> bool std::basic_ios< CharT, Traits >::fail () const [inline]

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 187 of file ios.

Referenced by std::basic_ios< char, Traits >::operator void *(), and std::basic_ios< char, Traits >::operator!().

template<typename CharT, typename Traits> char_type std::basic_ios< CharT, Traits >::fill (char_type ch) [inline]

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 376 of file ios.

template<typename CharT, typename Traits> char_type std::basic_ios< CharT, Traits >::fill () const [inline]

Retreives the 'empty' character.

Returns: The current fill character.

It defaults to a space (' ') in the current locale.

Definition at line 356 of file ios.

Referenced by std::basic_ios< CharT, Traits >::copyfmt(), std::basic_ios< char, Traits >::fill(), std::basic_ostream< CharT, Traits >::operator<<(), and std::operator>>().

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 560 of file ios_base.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 550 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::money_get< CharT, InIter >::M_extract(), std::num_get< CharT, InIter >::M_extract_int(), std::num_put< CharT, OutIter >::M_group_int(), std::money_put< CharT, OutIter >::M_insert(), std::num_put< CharT, OutIter >::M_insert_float(), std::num_put< CharT, OutIter >::M_insert_int(), std::basic_ostream< CharT, Traits >::operator<<(), std::basic_ostream< char >::operator<<(), std::num_base::S_format_float(), std::__pad< CharT, Traits >::S_pad(), and std::basic_istream< CharT, Traits >::sentry::sentry().

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 692 of file ios_base.h.

Referenced by std::basic_ios< CharT, Traits >::copyfmt(), std::money_put< CharT, OutIter >::do_put(), std::operator>>(), and std::ws().

template<typename CharT, typename Traits> bool std::basic_ios< CharT, Traits >::good () const [inline]

Fast error checking.

Returns: True if no error flags are set.

A wrapper around rdstate.

Definition at line 166 of file ios.

Referenced by std::basic_ostream< CharT, Traits >::sentry::sentry(), and std::basic_istream< CharT, Traits >::sentry::sentry().

template<typename CharT, typename Traits> locale std::basic_ios< CharT, Traits >::imbue (const locale & __loc)

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++/22_locale/howto.html

Reimplemented from std::ios_base.

Definition at line 127 of file basic_ios.tcc.

References std::ios_base::imbue().

template<typename CharT, typename Traits> void std::basic_ios< CharT, Traits >::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 139 of file basic_ios.tcc.

References std::ios_base::badbit, and std::ios_base::goodbit.

Referenced by std::basic_fstream< CharT, Traits >::basic_fstream(), std::basic_ifstream< CharT, Traits >::basic_ifstream(), std::basic_ios< char, Traits >::basic_ios(), std::basic_iostream< char >::basic_iostream(), std::basic_istream< char >::basic_istream(), std::basic_ofstream< CharT, Traits >::basic_ofstream(), and std::basic_ostream< char >::basic_ostream().

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 736 of file ios_base.h.

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 702 of file ios_base.h.

template<typename CharT, typename Traits> char std::basic_ios< CharT, Traits >::narrow (char_type c, char __dfault) const

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++/22_locale/howto.html

Definition at line 116 of file basic_ios.tcc.

template<typename CharT, typename Traits> std::basic_ios< CharT, Traits >::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 107 of file ios.

template<typename CharT, typename Traits> bool std::basic_ios< CharT, Traits >::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 111 of file ios.

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 628 of file ios_base.h.

streamsize std::ios_base::precision () const [inline, inherited]

Flags access.

Returns: The precision to generate on certain output operations.

Definition at line 620 of file ios_base.h.

Referenced by std::basic_ios< CharT, Traits >::copyfmt(), std::num_put< CharT, OutIter >::M_insert_float(), and 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 757 of file ios_base.h.

template<typename CharT, typename Traits> basic_streambuf< CharT, Traits > * std::basic_ios< CharT, Traits >::rdbuf (basic_streambuf< CharT, Traits > * sb)

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 51 of file basic_ios.tcc.

References std::basic_ios< CharT, Traits >::clear().

template<typename CharT, typename Traits> basic_streambuf<CharT, Traits>* std::basic_ios< CharT, Traits >::rdbuf () const [inline]

Accessing the underlying buffer.

Returns: The current stream buffer.

This does not change the state of the stream.

Reimplemented in std::istrstream, std::ostrstream, std::strstream, std::basic_ifstream< CharT, Traits >, std::basic_ofstream< CharT, Traits >, std::basic_fstream< CharT, Traits >, std::basic_istringstream< CharT, Traits, Alloc >, std::basic_ostringstream< CharT, Traits, Alloc >, and std::basic_stringstream< CharT, Traits, Alloc >.

Definition at line 307 of file ios.

Referenced by std::basic_ostream< CharT, Traits >::flush(), std::basic_istream< CharT, Traits >::get(), std::getline(), std::basic_istream< CharT, Traits >::getline(), std::basic_istream< CharT, Traits >::ignore(), std::basic_ostream< char >::M_write(), 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 >::sentry::sentry(), std::basic_istream< CharT, Traits >::sync(), std::basic_istream< CharT, Traits >::unget(), and std::ws().

template<typename CharT, typename Traits> iostate std::basic_ios< CharT, Traits >::rdstate () const [inline]

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 123 of file ios.

Referenced by std::basic_ios< CharT, Traits >::clear(), and std::basic_ios< char, Traits >::good().

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.

Definition at line 148 of file ios.cc.

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 593 of file ios_base.h.

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 576 of file ios_base.h.

Referenced by std::boolalpha(), std::dec(), std::fixed(), std::hex(), std::internal(), std::left(), std::oct(), std::operator>>(), std::right(), std::scientific(), std::showbase(), std::showpoint(), std::showpos(), std::skipws(), std::unitbuf(), and std::uppercase().

template<typename CharT, typename Traits> void std::basic_ios< CharT, Traits >::setstate (iostate state) [inline]

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 143 of file ios.

Referenced by std::basic_ostream< CharT, Traits >::flush(), std::basic_istream< CharT, Traits >::get(), std::getline(), std::basic_istream< CharT, Traits >::getline(), std::basic_istream< CharT, Traits >::ignore(), std::basic_ostream< char >::M_write(), 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_ostream< CharT, Traits >::sentry::sentry(), std::basic_istream< CharT, Traits >::sync(), std::basic_istream< CharT, Traits >::unget(), and std::ws().

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++/27_io/howto.html#8 for more.

Definition at line 148 of file ios_init.cc.

References __gnu_internal::buf_cerr, __gnu_internal::buf_cerr_sync, __gnu_internal::buf_cin, __gnu_internal::buf_cin_sync, __gnu_internal::buf_cout, __gnu_internal::buf_cout_sync, std::cerr, std::cin, std::clog, std::cout, std::ios_base::in, and std::ios_base::out.

template<typename CharT, typename Traits> basic_ostream<CharT, Traits>* std::basic_ios< CharT, Traits >::tie (basic_ostream< CharT, Traits > * __tiestr) [inline]

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 293 of file ios.

template<typename CharT, typename Traits> basic_ostream<CharT, Traits>* std::basic_ios< CharT, Traits >::tie () const [inline]

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 281 of file ios.

Referenced by std::basic_ios< CharT, Traits >::copyfmt(), std::basic_ostream< CharT, Traits >::sentry::sentry(), and std::basic_istream< CharT, Traits >::sentry::sentry().

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 608 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> CharT std::basic_ios< CharT, Traits >::widen (char c) const

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++/22_locale/howto.html

Definition at line 121 of file basic_ios.tcc.

Referenced by std::endl(), std::basic_ios< char, Traits >::fill(), std::getline(), 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 650 of file ios_base.h.

streamsize std::ios_base::width () const [inline, inherited]

Flags access.

Returns: The minimum field width to generate on output operations.

Definition at line 642 of file ios_base.h.

Referenced by std::basic_ios< CharT, Traits >::copyfmt(), std::num_put< CharT, OutIter >::do_put(), std::money_put< CharT, OutIter >::M_insert(), std::num_put< CharT, OutIter >::M_insert_float(), std::num_put< CharT, OutIter >::M_insert_int(), and std::operator>>().

int std::ios_base::xalloc () throw () [static, inherited]

Access to unique indices.

Returns: An integer different from all previous calls.

This function returns a unique integer every time it is called. It can be used for any purpose, but is primarily intended to be a unique index for the iword and pword functions. The expectation is that an application calls xalloc in order to obtain an index in the iword and pword arrays that can be used without fear of conflict.

The implementation maintains a static variable that is incremented and returned on each invocation. xalloc is guaranteed to return an index that is safe to use in the iword and pword arrays.

Definition at line 139 of file ios.cc.

Member Data Documentation

const ios_base::fmtflags std::ios_base::adjustfield [static, inherited]

A mask of left|right|internal. Useful for the 2-arg form of setf.

Definition at line 308 of file ios_base.h.

Referenced by std::internal(), std::left(), std::money_put< CharT, OutIter >::M_insert(), std::right(), and std::__pad< CharT, Traits >::S_pad().

const ios_base::openmode std::ios_base::app [static, inherited]

Seek to end before each write.

Definition at line 362 of file ios_base.h.

Referenced by std::basic_stringbuf< CharT, Traits, Alloc >::M_stringbuf_init().

const ios_base::openmode std::ios_base::ate [static, inherited]

Open and seek to end immediately after opening.

Definition at line 365 of file ios_base.h.

Referenced by std::basic_stringbuf< CharT, Traits, Alloc >::M_stringbuf_init(), and std::basic_filebuf< CharT, Traits >::open().

const ios_base::iostate std::ios_base::badbit [static, inherited]

as an irrecoverable read error from a file).

Definition at line 332 of file ios_base.h.

Referenced by std::basic_ios< char, Traits >::bad(), std::basic_ios< CharT, Traits >::clear(), std::basic_ios< char, Traits >::fail(), std::basic_ostream< CharT, Traits >::flush(), std::basic_istream< CharT, Traits >::get(), std::getline(), std::basic_istream< CharT, Traits >::getline(), std::basic_istream< CharT, Traits >::ignore(), std::basic_ios< CharT, Traits >::init(), std::ios_base::M_grow_words(), std::basic_ostream< char >::M_write(), 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 >::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 ios_base::fmtflags std::ios_base::basefield [static, inherited]

A mask of dec|oct|hex. Useful for the 2-arg form of setf.

Definition at line 311 of file ios_base.h.

Referenced by std::dec(), std::num_get< CharT, InIter >::do_get(), std::num_put< CharT, OutIter >::do_put(), std::hex(), std::int_to_char(), std::num_get< CharT, InIter >::M_extract_int(), std::num_put< CharT, OutIter >::M_group_int(), std::oct(), std::basic_ostream< CharT, Traits >::operator<<(), and std::basic_ostream< char >::operator<<().

const ios_base::seekdir std::ios_base::beg [static, inherited]

Request a seek relative to the beginning of the stream.

Definition at line 395 of file ios_base.h.

Referenced by std::strstreambuf::seekoff(), __gnu_cxx::stdio_sync_filebuf< CharT, Traits >::seekoff(), std::strstreambuf::seekpos(), __gnu_cxx::stdio_sync_filebuf< CharT, Traits >::seekpos(), and std::basic_filebuf< CharT, Traits >::seekpos().

const ios_base::openmode std::ios_base::binary [static, inherited]

http://gcc.gnu.org/onlinedocs/libstdc++/27_io/howto.html#7 for more.

Definition at line 371 of file ios_base.h.

const ios_base::fmtflags std::ios_base::boolalpha [static, inherited]

Insert/extract bool in alphabetic rather than numeric format.

Definition at line 256 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 ios_base::seekdir std::ios_base::cur [static, inherited]

Request a seek relative to the current position within the sequence.

Definition at line 398 of file ios_base.h.

Referenced by std::basic_filebuf< CharT, Traits >::imbue(), std::basic_filebuf< CharT, Traits >::pbackfail(), std::strstreambuf::seekoff(), __gnu_cxx::stdio_sync_filebuf< CharT, Traits >::seekoff(), 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 ios_base::fmtflags std::ios_base::dec [static, inherited]

Converts integer input or generates integer output in decimal base.

Definition at line 259 of file ios_base.h.

Referenced by std::dec(), and std::ios_base::M_init().

const ios_base::seekdir std::ios_base::end [static, inherited]

Request a seek relative to the current end of the sequence.

Definition at line 401 of file ios_base.h.

Referenced by std::basic_filebuf< CharT, Traits >::open(), std::strstreambuf::seekoff(), and std::basic_stringbuf< CharT, Traits, Alloc >::seekoff().

const ios_base::iostate std::ios_base::eofbit [static, inherited]

Indicates that an input operation reached the end of an input sequence.

Definition at line 335 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::basic_ios< char, Traits >::eof(), std::basic_istream< CharT, Traits >::get(), std::getline(), std::basic_istream< CharT, Traits >::getline(), std::basic_istream< CharT, Traits >::ignore(), std::operator>>(), std::basic_istream< CharT, Traits >::peek(), std::basic_istream< CharT, Traits >::read(), std::basic_istream< CharT, Traits >::readsome(), std::basic_istream< CharT, Traits >::sentry::sentry(), and std::ws().

const ios_base::iostate std::ios_base::failbit [static, inherited]

desired characters.

Definition at line 340 of file ios_base.h.

Referenced by std::basic_fstream< CharT, Traits >::close(), std::basic_ofstream< CharT, Traits >::close(), std::basic_ifstream< 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::basic_ios< char, Traits >::fail(), std::basic_istream< CharT, Traits >::get(), std::getline(), std::basic_istream< CharT, Traits >::getline(), std::num_get< CharT, InIter >::M_extract_float(), std::num_get< CharT, InIter >::M_extract_int(), std::time_get< CharT, InIter >::M_extract_via_format(), std::basic_fstream< CharT, Traits >::open(), std::basic_ofstream< CharT, Traits >::open(), std::basic_ifstream< 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(), and std::basic_ostream< CharT, Traits >::sentry::sentry().

const ios_base::fmtflags std::ios_base::fixed [static, inherited]

Generate floating-point output in fixed-point notation.

Definition at line 262 of file ios_base.h.

Referenced by std::fixed(), std::num_put< CharT, OutIter >::M_insert_float(), and std::num_base::S_format_float().

const ios_base::fmtflags std::ios_base::floatfield [static, inherited]

A mask of scientific|fixed. Useful for the 2-arg form of setf.

Definition at line 314 of file ios_base.h.

Referenced by std::fixed(), std::num_base::S_format_float(), and std::scientific().

const ios_base::iostate std::ios_base::goodbit [static, inherited]

Indicates all is well.

Definition at line 343 of file ios_base.h.

Referenced by std::basic_ostream< CharT, Traits >::flush(), std::basic_istream< CharT, Traits >::get(), std::getline(), std::basic_istream< CharT, Traits >::getline(), std::basic_istream< CharT, Traits >::ignore(), std::basic_ios< CharT, Traits >::init(), 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 ios_base::fmtflags std::ios_base::hex [static, inherited]

Converts integer input or generates integer output in hexadecimal base.

Definition at line 265 of file ios_base.h.

Referenced by std::num_get< CharT, InIter >::do_get(), std::num_put< CharT, OutIter >::do_put(), std::hex(), std::int_to_char(), std::num_get< CharT, InIter >::M_extract_int(), std::num_put< CharT, OutIter >::M_group_int(), std::basic_ostream< CharT, Traits >::operator<<(), and std::basic_ostream< char >::operator<<().

const ios_base::openmode std::ios_base::in [static, inherited]

Open for input. Default for ifstream and fstream.

Definition at line 374 of file ios_base.h.

Referenced by std::basic_filebuf< CharT, enc_char_traits< CharT > >::M_set_buffer(), std::basic_stringbuf< CharT, Traits, Alloc >::M_sync(), std::basic_stringbuf< CharT, Traits, Alloc >::M_update_egptr(), std::basic_ifstream< CharT, Traits >::open(), std::basic_filebuf< CharT, Traits >::pbackfail(), std::basic_istream< CharT, Traits >::seekg(), std::strstreambuf::seekoff(), std::basic_stringbuf< CharT, Traits, Alloc >::seekoff(), std::basic_stringbuf< CharT, Traits, Alloc >::seekpos(), std::basic_filebuf< CharT, Traits >::showmanyc(), std::ios_base::sync_with_stdio(), std::basic_istream< CharT, Traits >::tellg(), std::basic_stringbuf< CharT, Traits, Alloc >::underflow(), and std::basic_filebuf< CharT, Traits >::underflow().

const ios_base::fmtflags std::ios_base::internal [static, inherited]

designated.

Definition at line 270 of file ios_base.h.

Referenced by std::num_put< CharT, OutIter >::do_put(), std::internal(), std::money_put< CharT, OutIter >::M_insert(), and std::__pad< CharT, Traits >::S_pad().

const ios_base::fmtflags std::ios_base::left [static, inherited]

generated output. (I.e., the thing you print is flush left.)

Definition at line 274 of file ios_base.h.

Referenced by std::left(), and std::__pad< CharT, Traits >::S_pad().

const ios_base::fmtflags std::ios_base::oct [static, inherited]

Converts integer input or generates integer output in octal base.

Definition at line 277 of file ios_base.h.

Referenced by std::int_to_char(), std::num_get< CharT, InIter >::M_extract_int(), std::num_put< CharT, OutIter >::M_group_int(), std::oct(), std::basic_ostream< CharT, Traits >::operator<<(), and std::basic_ostream< char >::operator<<().

const ios_base::openmode std::ios_base::out [static, inherited]

Open for output. Default for ofstream and fstream.

Definition at line 377 of file ios_base.h.

Referenced by std::basic_filebuf< CharT, enc_char_traits< CharT > >::M_set_buffer(), std::basic_stringbuf< CharT, Traits, Alloc >::M_sync(), std::basic_ofstream< CharT, Traits >::open(), std::basic_stringbuf< CharT, Traits, Alloc >::overflow(), std::basic_filebuf< CharT, Traits >::overflow(), std::strstreambuf::seekoff(), std::basic_stringbuf< CharT, Traits, Alloc >::seekoff(), std::basic_ostream< CharT, Traits >::seekp(), std::basic_stringbuf< CharT, Traits, Alloc >::seekpos(), std::ios_base::sync_with_stdio(), std::basic_ostream< CharT, Traits >::tellp(), and std::basic_filebuf< CharT, Traits >::xsputn().

const ios_base::fmtflags std::ios_base::right [static, inherited]

generated output. (I.e., the thing you print is flush right.)

Definition at line 281 of file ios_base.h.

Referenced by std::right().

const ios_base::fmtflags std::ios_base::scientific [static, inherited]

Generates floating-point output in scientific notation.

Definition at line 284 of file ios_base.h.

Referenced by std::num_base::S_format_float(), and std::scientific().

const ios_base::fmtflags std::ios_base::showbase [static, inherited]

output.

Definition at line 288 of file ios_base.h.

Referenced by std::num_put< CharT, OutIter >::do_put(), std::int_to_char(), std::money_get< CharT, InIter >::M_extract(), std::num_put< CharT, OutIter >::M_group_int(), std::money_put< CharT, OutIter >::M_insert(), std::noshowbase(), and std::showbase().

const ios_base::fmtflags std::ios_base::showpoint [static, inherited]

floating-point output.

Definition at line 292 of file ios_base.h.

Referenced by std::noshowpoint(), std::num_base::S_format_float(), and std::showpoint().

const ios_base::fmtflags std::ios_base::showpos [static, inherited]

Generates a + sign in non-negative generated numeric output.

Definition at line 295 of file ios_base.h.

Referenced by std::int_to_char(), std::noshowpos(), std::num_base::S_format_float(), and std::showpos().

const ios_base::fmtflags std::ios_base::skipws [static, inherited]

Skips leading white space before certain input operations.

Definition at line 298 of file ios_base.h.

Referenced by std::ios_base::M_init(), std::noskipws(), std::basic_istream< CharT, Traits >::sentry::sentry(), and std::skipws().

const ios_base::openmode std::ios_base::trunc [static, inherited]

Open for input. Default for ofstream.

Definition at line 380 of file ios_base.h.

const ios_base::fmtflags std::ios_base::unitbuf [static, inherited]

Flushes output after each output operation.

Definition at line 301 of file ios_base.h.

Referenced by std::ios_base::Init::Init(), std::nounitbuf(), std::unitbuf(), and std::basic_ostream< CharT, Traits >::sentry::~sentry().

const ios_base::fmtflags std::ios_base::uppercase [static, inherited]

in generated output.

Definition at line 305 of file ios_base.h.

Referenced by std::num_put< CharT, OutIter >::do_put(), std::int_to_char(), std::nouppercase(), std::num_base::S_format_float(), and std::uppercase().

Author

Generated automatically by Doxygen for libstdc++-v3 Source from the source code.