Inheritance diagram for std::basic_ostream< _CharT, _Traits >:

[legend]

Classes

class sentry
Performs setup work for output streams. More...

Public Types

typedef ctype< _CharT > __ctype_type
typedef basic_ios< _CharT,
_Traits > __ios_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 _CharT char_type
enum event { erase_event, imbue_event, copyfmt_event }
typedef void(* event_callback )(event __e, ios_base &__b, int __i)
typedef _Ios_Fmtflags fmtflags
typedef _Traits::int_type int_type
typedef int io_state
typedef _Ios_Iostate iostate
typedef _Traits::off_type off_type
typedef int open_mode
typedef _Ios_Openmode openmode
typedef _Traits::pos_type pos_type
typedef int seek_dir
typedef _Ios_Seekdir seekdir
typedef std::streamoff streamoff
typedef std::streampos streampos
typedef _Traits traits_type

typedef num_get< _CharT,
istreambuf_iterator< _CharT,
_Traits > > __num_get_type

Public Member Functions

basic_ostream (__streambuf_type *__sb)
virtual ~basic_ostream ()
const locale & _M_getloc () const
void _M_setstate (iostate __state)
bool bad () const
void clear (iostate __state=goodbit)
basic_ios & copyfmt (const basic_ios &__rhs)
bool eof () const
iostate exceptions () const
void exceptions (iostate __except)
bool fail () const
char_type fill () const
char_type fill (char_type __ch)
fmtflags flags () const
fmtflags flags (fmtflags __fmtfl)
__ostream_type & flush ()
locale getloc () const
bool good () const
locale imbue (const locale &__loc)
long & iword (int __ix)
char narrow (char_type __c, char __dfault) const
__ostream_type & operator<< (const void *__p)
__ostream_type & operator<< (__streambuf_type *__sb)
streamsize precision () const
streamsize precision (streamsize __prec)
void *& pword (int __ix)
basic_streambuf< _CharT,
_Traits > * rdbuf () const
basic_streambuf< _CharT,
_Traits > * rdbuf (basic_streambuf< _CharT, _Traits > *__sb)
iostate rdstate () const
void register_callback (event_callback __fn, int __index)
__ostream_type & seekp (pos_type)
__ostream_type & seekp (off_type, ios_base::seekdir)
fmtflags setf (fmtflags __fmtfl)
fmtflags setf (fmtflags __fmtfl, fmtflags __mask)
void setstate (iostate __state)
pos_type tellp ()
basic_ostream< _CharT, _Traits > * tie () const
basic_ostream< _CharT, _Traits > * tie (basic_ostream< _CharT, _Traits > *__tiestr)
void unsetf (fmtflags __mask)
char_type widen (char __c) const
streamsize width () const
streamsize width (streamsize __wide)

__ostream_type & operator<< (__ostream_type &(*__pf)(__ostream_type &))
__ostream_type & operator<< (__ios_type &(*__pf)(__ios_type &))
__ostream_type & operator<< (ios_base &(*__pf)(ios_base &))

Inserters

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)

Unformatted Output Functions

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)

operator void * () const
bool operator! () const

Static Public Member Functions

static bool sync_with_stdio (bool __sync=true)
static int xalloc () throw ()

Static Public Attributes

static const fmtflags adjustfield
static const openmode app
static const openmode ate
static const iostate badbit
static const fmtflags basefield
static const seekdir beg
static const openmode binary
static const fmtflags boolalpha
static const seekdir cur
static const fmtflags dec
static const seekdir end
static const iostate eofbit
static const iostate failbit
static const fmtflags fixed
static const fmtflags floatfield
static const iostate goodbit
static const fmtflags hex
static const openmode in
static const fmtflags internal
static const fmtflags left
static const fmtflags oct
static const openmode out
static const fmtflags right
static const fmtflags scientific
static const fmtflags showbase
static const fmtflags showpoint
static const fmtflags showpos
static const fmtflags skipws
static const openmode trunc
static const fmtflags unitbuf
static const fmtflags uppercase

Protected Types

enum { _S_local_word_size }

Protected Member Functions

void _M_cache_locale (const locale &__loc)
void _M_call_callbacks (event __ev) throw ()
void _M_dispose_callbacks (void) throw ()
_Words & _M_grow_words (int __index, bool __iword)
void _M_init () throw ()
template<typename _ValueT > __ostream_type & _M_insert (_ValueT __v)
void init (basic_streambuf< _CharT, _Traits > *__sb)

Protected Attributes

_Callback_list * _M_callbacks
const __ctype_type * _M_ctype
iostate _M_exception
char_type _M_fill
bool _M_fill_init
fmtflags _M_flags
locale _M_ios_locale
_Words _M_local_word [_S_local_word_size]
const __num_get_type * _M_num_get
const __num_put_type * _M_num_put
streamsize _M_precision
basic_streambuf< _CharT,
_Traits > * _M_streambuf
iostate _M_streambuf_state
basic_ostream< _CharT, _Traits > * _M_tie
streamsize _M_width
_Words * _M_word
int _M_word_size
_Words _M_word_zero

Friends

class sentry

Detailed Description

template<typename _CharT, typename _Traits>
class std::basic_ostream< _CharT, _Traits >

Template class basic_ostream.

This is the base class for all output streams. It provides text formatting of all builtin types, and communicates with any class derived from basic_streambuf to do the actual output.

Definition at line 56 of file ostream.

Member Typedef Documentation

template<typename _CharT, typename _Traits>

typedef ctype<_CharT> std::basic_ostream< _CharT, _Traits >::__ctype_type

These are non-standard types.

Reimplemented from std::basic_ios< _CharT, _Traits >.

Definition at line 72 of file ostream.

template<typename _CharT, typename _Traits>

typedef num_get<_CharT, istreambuf_iterator<_CharT, _Traits> > std::basic_ios< _CharT, _Traits >::__num_get_type [inherited]

These are non-standard types.

Reimplemented in std::basic_istream< _CharT, _Traits >, std::basic_istream< char, _Traits >, and std::basic_istream< char >.

Definition at line 88 of file basic_ios.h.

template<typename _CharT, typename _Traits>

typedef num_put<_CharT, ostreambuf_iterator<_CharT, _Traits> > std::basic_ostream< _CharT, _Traits >::__num_put_type

These are non-standard types.

Reimplemented from std::basic_ios< _CharT, _Traits >.

Definition at line 71 of file ostream.

template<typename _CharT, typename _Traits>

typedef _CharT std::basic_ostream< _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 from std::basic_ios< _CharT, _Traits >.

Reimplemented in std::basic_iostream< _CharT, _Traits >, std::basic_iostream< char >, std::basic_fstream< _CharT, _Traits >, std::basic_ofstream< _CharT, _Traits >, std::basic_stringstream< _CharT, _Traits, _Alloc >, and std::basic_ostringstream< _CharT, _Traits, _Alloc >.

Definition at line 60 of file ostream.

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

The type of an event callback function.

Parameters:

__e	One of the members of the event enum.
__b	Reference to the ios_base object.
__i	The integer provided when the callback was registered.

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

Definition at line 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:

boolalpha
dec
fixed
hex
internal
left
oct
right
scientific
showbase
showpoint
showpos
skipws
unitbuf
uppercase
adjustfield
basefield
floatfield

Definition at line 257 of file ios_base.h.

template<typename _CharT, typename _Traits>

typedef _Traits::int_type std::basic_ostream< _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 from std::basic_ios< _CharT, _Traits >.

Reimplemented in std::basic_iostream< _CharT, _Traits >, std::basic_iostream< char >, std::basic_fstream< _CharT, _Traits >, std::basic_ofstream< _CharT, _Traits >, std::basic_stringstream< _CharT, _Traits, _Alloc >, and std::basic_ostringstream< _CharT, _Traits, _Alloc >.

Definition at line 61 of file ostream.

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

This is a bitmask type.

_Ios_Iostate is implementation-defined, but it is valid to perform bitwise operations on these values and expect the Right Thing to happen. Defined objects of type iostate are:

badbit
eofbit
failbit
goodbit

Definition at line 332 of file ios_base.h.

template<typename _CharT, typename _Traits>

typedef _Traits::off_type std::basic_ostream< _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 from std::basic_ios< _CharT, _Traits >.

Reimplemented in std::basic_iostream< _CharT, _Traits >, std::basic_iostream< char >, std::basic_fstream< _CharT, _Traits >, std::basic_ofstream< _CharT, _Traits >, std::basic_stringstream< _CharT, _Traits, _Alloc >, and std::basic_ostringstream< _CharT, _Traits, _Alloc >.

Definition at line 63 of file ostream.

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

This is a bitmask type.

_Ios_Openmode is implementation-defined, but it is valid to perform bitwise operations on these values and expect the Right Thing to happen. Defined objects of type openmode are:

app
ate
binary
in
out
trunc

Definition at line 363 of file ios_base.h.

template<typename _CharT, typename _Traits>

typedef _Traits::pos_type std::basic_ostream< _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 from std::basic_ios< _CharT, _Traits >.

Reimplemented in std::basic_iostream< _CharT, _Traits >, std::basic_iostream< char >, std::basic_fstream< _CharT, _Traits >, std::basic_ofstream< _CharT, _Traits >, std::basic_stringstream< _CharT, _Traits, _Alloc >, and std::basic_ostringstream< _CharT, _Traits, _Alloc >.

Definition at line 62 of file ostream.

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

This is an enumerated type.

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

beg
cur, equivalent to SEEK_CUR in the C standard library.
end, equivalent to SEEK_END in the C standard library.

Definition at line 395 of file ios_base.h.

template<typename _CharT, typename _Traits>

typedef _Traits std::basic_ostream< _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 from std::basic_ios< _CharT, _Traits >.

Reimplemented in std::basic_iostream< _CharT, _Traits >, std::basic_iostream< char >, std::basic_fstream< _CharT, _Traits >, std::basic_ofstream< _CharT, _Traits >, std::basic_stringstream< _CharT, _Traits, _Alloc >, and std::basic_ostringstream< _CharT, _Traits, _Alloc >.

Definition at line 64 of file ostream.

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

Constructor & Destructor Documentation

template<typename _CharT, typename _Traits>

std::basic_ostream< _CharT, _Traits >::basic_ostream ( __streambuf_type * __sb ) [inline, explicit]

Base constructor.

This ctor is almost never called by the user directly, rather from derived classes' initialization lists, which pass a pointer to their own stream buffer.

Definition at line 82 of file ostream.

template<typename _CharT, typename _Traits>

virtual std::basic_ostream< _CharT, _Traits >::~basic_ostream ( ) [inline, virtual]

Base destructor.

This does very little apart from providing a virtual base dtor.

Definition at line 91 of file ostream.

Member Function Documentation

const locale& std::ios_base::_M_getloc ( ) const [inline, inherited]

Locale access.

Returns:: A reference to the current locale.

Like getloc above, but returns a reference instead of generating a copy.

Definition at line 708 of file ios_base.h.

Referenced by std::money_get< _CharT, _InIter >::do_get(), std::num_get< _CharT, _InIter >::do_get(), std::time_get< _CharT, _InIter >::do_get_date(), std::time_get< _CharT, _InIter >::do_get_monthname(), std::time_get< _CharT, _InIter >::do_get_time(), std::time_get< _CharT, _InIter >::do_get_weekday(), std::time_get< _CharT, _InIter >::do_get_year(), std::time_put< _CharT, _OutIter >::do_put(), std::num_put< _CharT, _OutIter >::do_put(), and std::time_put< _CharT, _OutIter >::put().

template<typename _CharT, typename _Traits>

void std::basic_ostream< _CharT, _Traits >::_M_write	(	const char_type *	__s,
		streamsize	__n
	)		`[inline]`

Core write functionality, without sentry.

Parameters:

__s	The array to insert.
__n	Maximum number of characters to insert.

Definition at line 309 of file ostream.

Referenced by std::basic_ostream< _CharT, _Traits >::write().

template<typename _CharT, typename _Traits>

bool std::basic_ios< _CharT, _Traits >::bad ( ) const [inline, inherited]

Fast error checking.

Returns:: True if the badbit is set.

Note that other iostate flags may also be set.

Definition at line 203 of file basic_ios.h.

template<typename _CharT , typename _Traits >

void std::basic_ios< _CharT, _Traits >::clear ( iostate __state = goodbit ) [inherited]

[Re]sets the error state.

Parameters:

__state The new state flag(s) to set.

See std::ios_base::iostate for the possible bit values. Most users will not need to pass an argument.

Definition at line 42 of file basic_ios.tcc.

Referenced by std::basic_ios< char, _Traits >::exceptions(), std::basic_ifstream< _CharT, _Traits >::open(), std::basic_ofstream< _CharT, _Traits >::open(), std::basic_fstream< _CharT, _Traits >::open(), std::basic_istream< _CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ios< char, _Traits >::setstate(), and std::basic_istream< _CharT, _Traits >::unget().

template<typename _CharT , typename _Traits >

basic_ios< _CharT, _Traits > & std::basic_ios< _CharT, _Traits >::copyfmt ( const basic_ios< _CharT, _Traits > & __rhs ) [inherited]

Copies fields of __rhs into this.

Parameters:

__rhs The source values for the copies.

Returns:: Reference to this object.

All fields of __rhs are copied into this object except that rdbuf() and rdstate() remain unchanged. All values in the pword and iword arrays are copied. Before copying, each callback is invoked with erase_event. After copying, each (new) callback is invoked with copyfmt_event. The final step is to copy exceptions().

Definition at line 64 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, inherited]

Fast error checking.

Returns:: True if the eofbit is set.

Note that other iostate flags may also be set.

Definition at line 182 of file basic_ios.h.

Referenced by std::basic_istream< _CharT, _Traits >::get(), 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 >::putback(), std::basic_istream< _CharT, _Traits >::sentry::sentry(), std::basic_istream< _CharT, _Traits >::unget(), and std::ws().

template<typename _CharT, typename _Traits>

iostate std::basic_ios< _CharT, _Traits >::exceptions ( ) const [inline, inherited]

Throwing exceptions on errors.

Returns:: The current exceptions mask.

This changes nothing in the stream. See the one-argument version of exceptions(iostate) for the meaning of the return value.

Definition at line 214 of file basic_ios.h.

Referenced by std::basic_ios< _CharT, _Traits >::copyfmt().

template<typename _CharT, typename _Traits>

void std::basic_ios< _CharT, _Traits >::exceptions ( iostate __except ) [inline, inherited]

Throwing exceptions on errors.

Parameters:

__except The new exceptions mask.

By default, error flags are set silently. You can set an exceptions mask for each stream; if a bit in the mask becomes set in the error flags, then an exception of type std::ios_base::failure is thrown.

If the error flag is already set when the exceptions mask is added, the exception is immediately thrown. Try running the following under GCC 3.1 or later:

  #include <iostream>
  #include <fstream>
  #include <exception>

  int main()
  {
      std::set_terminate (<strong>gnu_cxx::</strong>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.

template<typename _CharT, typename _Traits>

bool std::basic_ios< _CharT, _Traits >::fail ( ) const [inline, inherited]

Fast error checking.

Returns:: True if either the badbit or the failbit is set.

Checking the badbit in fail() is historical practice. Note that other iostate flags may also be set.

Definition at line 193 of file basic_ios.h.

Referenced by std::basic_ios< char, _Traits >::operator void *(), std::basic_ios< char, _Traits >::operator!(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_istream< _CharT, _Traits >::tellg(), std::basic_ostream< _CharT, _Traits >::tellp(), and std::regex_traits< _Ch_type >::value().

template<typename _CharT, typename _Traits>

char_type std::basic_ios< _CharT, _Traits >::fill ( ) const [inline, inherited]

Retrieves the empty character.

Returns:: The current fill character.

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

Definition at line 362 of file basic_ios.h.

Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(), and std::basic_ios< char, _Traits >::fill().

template<typename _CharT, typename _Traits>

char_type std::basic_ios< _CharT, _Traits >::fill ( char_type __ch ) [inline, inherited]

Sets a new empty character.

Parameters:

__ch	The new character.

Returns:: The previous fill character.

The fill character is used to fill out space when P+ characters have been requested (e.g., via setw), Q characters are actually used, and Q<P. It defaults to a space (' ') in the current locale.

Definition at line 382 of file basic_ios.h.

fmtflags std::ios_base::flags ( ) const [inline, inherited]

Access to format flags.

Returns:: The format control flags for both input and output.

Definition at line 553 of file ios_base.h.

Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(), std::num_get< _CharT, _InIter >::do_get(), std::num_put< _CharT, _OutIter >::do_put(), std::basic_ostream< _CharT, _Traits >::operator<<(), std::operator<<(), std::operator>>(), and std::basic_istream< _CharT, _Traits >::sentry::sentry().

fmtflags std::ios_base::flags ( fmtflags __fmtfl ) [inline, inherited]

Setting new format flags all at once.

Parameters:

__fmtfl The new flags to set.

Returns:: The previous format control flags.

This function overwrites all the format flags with __fmtfl.

Definition at line 564 of file ios_base.h.

template<typename _CharT , typename _Traits >

basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::flush ( )

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.

Definition at line 213 of file ostream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits >::setstate().

Referenced by std::flush().

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 697 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, inherited]

Fast error checking.

Returns:: True if no error flags are set.

A wrapper around rdstate.

Definition at line 172 of file basic_ios.h.

Referenced by std::basic_ostream< _CharT, _Traits >::sentry::sentry(), and std::basic_istream< _CharT, _Traits >::sentry::sentry().

template<typename _CharT , typename _Traits >

locale std::basic_ios< _CharT, _Traits >::imbue ( const locale & __loc ) [inherited]

Moves to a new locale.

Parameters:

__loc The new locale.

Returns:: The previous locale.

Calls ios_base::imbue(loc), and if a stream buffer is associated with this stream, calls that buffer's pubimbue(loc).

Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html

Reimplemented from std::ios_base.

Definition at line 115 of file basic_ios.tcc.

References std::ios_base::imbue().

Referenced by std::operator<<().

template<typename _CharT, typename _Traits>

void std::basic_ios< _CharT, _Traits >::init ( basic_streambuf< _CharT, _Traits > * __sb ) [protected, inherited]

All setup is performed here.

This is called from the public constructor. It is not virtual and cannot be redefined.

Definition at line 127 of file basic_ios.tcc.

Referenced by std::basic_fstream< _CharT, _Traits >::basic_fstream(), std::basic_ifstream< _CharT, _Traits >::basic_ifstream(), std::basic_ios< char, _Traits >::basic_ios(), std::basic_istream< char >::basic_istream(), std::basic_istringstream< _CharT, _Traits, _Alloc >::basic_istringstream(), std::basic_ofstream< _CharT, _Traits >::basic_ofstream(), std::basic_ostream< char >::basic_ostream(), std::basic_ostringstream< _CharT, _Traits, _Alloc >::basic_ostringstream(), and std::basic_stringstream< _CharT, _Traits, _Alloc >::basic_stringstream().

long& std::ios_base::iword ( int __ix ) [inline, inherited]

Access to integer array.

Parameters:

__ix	Index into the array.

Returns:: A reference to an integer associated with the index.

The iword function provides access to an array of integers that can be used for any purpose. The array grows as required to hold the supplied index. All integers in the array are initialized to 0.

The implementation reserves several indices. You should use xalloc to obtain an index that is safe to use. Also note that since the array can grow dynamically, it is not safe to hold onto the reference.

Definition at line 743 of file ios_base.h.

template<typename _CharT, typename _Traits>

char std::basic_ios< _CharT, _Traits >::narrow	(	char_type	__c,
		char	__dfault
	)		const `[inline, inherited]`

Squeezes characters.

Parameters:

__c	The character to narrow.
__dfault	The character to narrow.

Returns:: The narrowed character.

Maps a character of char_type to a character of char, if possible.

Returns the result of

    std::use_facet<ctype<char_type> >(getloc()).narrow(c,dfault)

Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html

Definition at line 422 of file basic_ios.h.

template<typename _CharT, typename _Traits>

std::basic_ios< _CharT, _Traits >::operator void * ( ) const [inline, inherited]

The quick-and-easy status check.

This allows you to write constructs such as if (!a_stream) ... and while (a_stream) ...

Definition at line 113 of file basic_ios.h.

template<typename _CharT, typename _Traits>

bool std::basic_ios< _CharT, _Traits >::operator! ( ) const [inline, inherited]

The quick-and-easy status check.

This allows you to write constructs such as if (!a_stream) ... and while (a_stream) ...

Definition at line 117 of file basic_ios.h.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( __ostream_type &(*)(__ostream_type &) __pf ) [inline]

Interface for manipulators.

Manipulators such as std::endl and std::hex use these functions in constructs like "std::cout << std::endl". For more information, see the iomanip header.

Definition at line 106 of file ostream.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( __ios_type &(*)(__ios_type &) __pf ) [inline]

Interface for manipulators.

Manipulators such as std::endl and std::hex use these functions in constructs like "std::cout << std::endl". For more information, see the iomanip header.

Definition at line 115 of file ostream.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( ios_base &(*)(ios_base &) __pf ) [inline]

Interface for manipulators.

Manipulators such as std::endl and std::hex use these functions in constructs like "std::cout << std::endl". For more information, see the iomanip header.

Definition at line 125 of file ostream.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( long __n ) [inline]

Integer arithmetic inserters.

Parameters:

__n	A variable of builtin integral type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 164 of file ostream.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( unsigned long __n ) [inline]

Integer arithmetic inserters.

Parameters:

__n	A variable of builtin integral type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 168 of file ostream.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( bool __n ) [inline]

Integer arithmetic inserters.

Parameters:

__n	A variable of builtin integral type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 172 of file ostream.

template<typename _CharT , typename _Traits >

basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< ( short __n )

Integer arithmetic inserters.

Parameters:

__n	A variable of builtin integral type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 94 of file ostream.tcc.

References std::ios_base::basefield, std::ios_base::flags(), std::ios_base::hex, and std::ios_base::oct.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( unsigned short __n ) [inline]

Integer arithmetic inserters.

Parameters:

__n	A variable of builtin integral type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 179 of file ostream.

template<typename _CharT , typename _Traits >

basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< ( int __n )

Integer arithmetic inserters.

Parameters:

__n	A variable of builtin integral type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 108 of file ostream.tcc.

References std::ios_base::basefield, std::ios_base::flags(), std::ios_base::hex, and std::ios_base::oct.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( unsigned int __n ) [inline]

Integer arithmetic inserters.

Parameters:

__n	A variable of builtin integral type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 190 of file ostream.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( long long __n ) [inline]

Integer arithmetic inserters.

Parameters:

__n	A variable of builtin integral type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 199 of file ostream.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( unsigned long long __n ) [inline]

Integer arithmetic inserters.

Parameters:

__n	A variable of builtin integral type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 203 of file ostream.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( double __f ) [inline]

Floating point arithmetic inserters.

Parameters:

__f	A variable of builtin floating point type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 218 of file ostream.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( float __f ) [inline]

Floating point arithmetic inserters.

Parameters:

__f	A variable of builtin floating point type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 222 of file ostream.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( long double __f ) [inline]

Floating point arithmetic inserters.

Parameters:

__f	A variable of builtin floating point type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 230 of file ostream.

template<typename _CharT, typename _Traits>

__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( const void * __p ) [inline]

Pointer arithmetic inserters.

Parameters:

__p	A variable of pointer type.

Returns:: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting.

Definition at line 243 of file ostream.

template<typename _CharT , typename _Traits >

basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< ( __streambuf_type * __sb )

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.

Definition at line 122 of file ostream.tcc.

References std::ios_base::badbit, std::ios_base::failbit, std::ios_base::goodbit, std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits >::setstate().

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

Flags access.

Returns:: The precision to generate on certain output operations.

Be careful if you try to give a definition of precision here; see DR 189.

Definition at line 623 of file ios_base.h.

Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(), and std::operator<<().

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

Changing flags.

Parameters:

__prec The new precision value.

Returns:: The previous value of precision().

Definition at line 632 of file ios_base.h.

template<typename _CharT , typename _Traits >

basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::put ( char_type __c )

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.

Definition at line 151 of file ostream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits >::setstate().

Referenced by std::endl(), and std::ends().

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

template<typename _CharT, typename _Traits>

basic_streambuf<_CharT, _Traits>* std::basic_ios< _CharT, _Traits >::rdbuf ( ) const [inline, inherited]

Accessing the underlying buffer.

Returns:: The current stream buffer.

This does not change the state of the stream.

Reimplemented in std::basic_fstream< _CharT, _Traits >, std::basic_ofstream< _CharT, _Traits >, std::basic_stringstream< _CharT, _Traits, _Alloc >, std::basic_ifstream< _CharT, _Traits >, std::basic_ostringstream< _CharT, _Traits, _Alloc >, and std::basic_istringstream< _CharT, _Traits, _Alloc >.

Definition at line 313 of file basic_ios.h.

template<typename _CharT, typename _Traits>

basic_streambuf< _CharT, _Traits > * std::basic_ios< _CharT, _Traits >::rdbuf ( basic_streambuf< _CharT, _Traits > * __sb ) [inherited]

Changing the underlying buffer.

Parameters:

__sb	The new stream buffer.

Returns:: The previous stream buffer.

Associates a new buffer with the current stream, and clears the error state.

Due to historical accidents which the LWG refuses to correct, the I/O library suffers from a design error: this function is hidden in derived classes by overrides of the zero-argument rdbuf(), which is non-virtual for hysterical raisins. As a result, you must use explicit qualifications to access this function via any derived class. For example:

  std::fstream     foo;         // or some other derived type
  std::streambuf*  p = .....;

  foo.ios::rdbuf(p);            // ios == basic_ios<char>

Definition at line 54 of file basic_ios.tcc.

template<typename _CharT, typename _Traits>

iostate std::basic_ios< _CharT, _Traits >::rdstate ( ) const [inline, inherited]

Returns the error state of the stream buffer.

Returns:: A bit pattern (well, isn't everything?)

See std::ios_base::iostate for the possible bit values. Most users will call one of the interpreting wrappers, e.g., good().

Definition at line 129 of file basic_ios.h.

Referenced by std::basic_ios< char, _Traits >::bad(), std::basic_ios< char, _Traits >::eof(), std::basic_ios< char, _Traits >::fail(), std::basic_ios< char, _Traits >::good(), std::basic_istream< _CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ios< char, _Traits >::setstate(), and std::basic_istream< _CharT, _Traits >::unget().

void std::ios_base::register_callback	(	event_callback	__fn,
		int	__index
	)		`[inherited]`

Add the callback __fn with parameter __index.

Parameters:

__fn	The function to add.
__index	The integer to pass to the function when invoked.

Registers a function as an event callback with an integer parameter to be passed to the function when invoked. Multiple copies of the function are allowed. If there are multiple callbacks, they are invoked in the order they were registered.

template<typename _CharT , typename _Traits >

basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::seekp ( pos_type __pos )

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.

Definition at line 260 of file ostream.tcc.

References std::ios_base::badbit, std::basic_ios< _CharT, _Traits >::fail(), std::ios_base::failbit, std::ios_base::goodbit, std::ios_base::out, std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits >::setstate().

template<typename _CharT , typename _Traits >

basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::seekp	(	off_type	__off,
		ios_base::seekdir	__dir
	)

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.

Definition at line 292 of file ostream.tcc.

References std::ios_base::badbit, std::basic_ios< _CharT, _Traits >::fail(), std::ios_base::failbit, std::ios_base::goodbit, std::ios_base::out, std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits >::setstate().

fmtflags std::ios_base::setf ( fmtflags __fmtfl ) [inline, inherited]

Setting new format flags.

Parameters:

__fmtfl Additional flags to set.

Returns:: The previous format control flags.

This function sets additional flags in format control. Flags that were previously set remain set.

Definition at line 580 of file ios_base.h.

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

fmtflags std::ios_base::setf	(	fmtflags	__fmtfl,
		fmtflags	__mask
	)		`[inline, inherited]`

Setting new format flags.

Parameters:

__fmtfl	Additional flags to set.
__mask	The flags mask for fmtfl.

Returns:: The previous format control flags.

This function clears mask in the format flags, then sets fmtfl & mask. An example mask is ios_base::adjustfield.

Definition at line 597 of file ios_base.h.

template<typename _CharT, typename _Traits>

void std::basic_ios< _CharT, _Traits >::setstate ( iostate __state ) [inline, inherited]

Sets additional flags in the error state.

Parameters:

__state The additional state flag(s) to set.

See std::ios_base::iostate for the possible bit values.

Definition at line 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.

Parameters:

__sync Whether to synchronize or not.

Returns:: True if the standard streams were previously synchronized.

The synchronization referred to is only that between the standard C facilities (e.g., stdout) and the standard C++ objects (e.g., cout). User-declared streams are unaffected. See http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch28s02.html

template<typename _CharT , typename _Traits >

basic_ostream< _CharT, _Traits >::pos_type std::basic_ostream< _CharT, _Traits >::tellp ( )

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).

Definition at line 239 of file ostream.tcc.

References std::ios_base::badbit, std::ios_base::cur, std::basic_ios< _CharT, _Traits >::fail(), std::ios_base::out, and std::basic_ios< _CharT, _Traits >::rdbuf().

template<typename _CharT, typename _Traits>

basic_ostream<_CharT, _Traits>* std::basic_ios< _CharT, _Traits >::tie ( ) const [inline, inherited]

Fetches the current tied stream.

Returns:: A pointer to the tied stream, or NULL if the stream is not tied.

A stream may be tied (or synchronized) to a second output stream. When this stream performs any I/O, the tied stream is first flushed. For example, std::cin is tied to std::cout.

Definition at line 287 of file basic_ios.h.

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

template<typename _CharT, typename _Traits>

basic_ostream<_CharT, _Traits>* std::basic_ios< _CharT, _Traits >::tie ( basic_ostream< _CharT, _Traits > * __tiestr ) [inline, inherited]

Ties this stream to an output stream.

Parameters:

__tiestr The output stream.

Returns:: The previously tied output stream, or NULL if the stream was not tied.

This sets up a new tie; see tie() for more.

Definition at line 299 of file basic_ios.h.

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

Referenced by std::noboolalpha(), std::noshowbase(), std::noshowpoint(), std::noshowpos(), std::noskipws(), std::nounitbuf(), and std::nouppercase().

template<typename _CharT, typename _Traits>

char_type std::basic_ios< _CharT, _Traits >::widen ( char __c ) const [inline, inherited]

Widens characters.

Parameters:

__c	The character to widen.

Returns:: The widened character.

Maps a character of char to a character of char_type.

Returns the result of

    std::use_facet<ctype<char_type> >(getloc()).widen(c)

Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html

Definition at line 441 of file basic_ios.h.

Referenced by std::endl(), std::basic_ios< char, _Traits >::fill(), std::basic_istream< char >::get(), std::basic_istream< char >::getline(), std::getline(), std::tr2::operator>>(), and std::operator>>().

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

Flags access.

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

Minimum field width refers to the number of characters.

Definition at line 646 of file ios_base.h.

Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(), std::num_put< _CharT, _OutIter >::do_put(), and std::operator>>().

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

Changing flags.

Parameters:

__wide The new width value.

Returns:: The previous value of width().

Definition at line 655 of file ios_base.h.

template<typename _CharT , typename _Traits >

basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::write	(	const char_type *	__s,
		streamsize	__n
	)

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.

Definition at line 185 of file ostream.tcc.

References std::basic_ostream< _CharT, _Traits >::_M_write(), and std::ios_base::badbit.

static 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.

Member Data Documentation

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::num_put< _CharT, _OutIter >::do_put(), std::internal(), std::left(), and std::right().

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

Seek to end before each write.

Definition at line 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.

Referenced by std::basic_filebuf< _CharT, _Traits >::open().

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

Indicates a loss of integrity in an input or output sequence (such as an irrecoverable read error from a file).

Definition at line 336 of file ios_base.h.

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::num_get< _CharT, _InIter >::do_get(), std::hex(), std::oct(), and std::basic_ostream< _CharT, _Traits >::operator<<().

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

Request a seek relative to the beginning of the stream.

Definition at line 398 of file ios_base.h.

Referenced by std::basic_filebuf< _CharT, _Traits >::seekpos().

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

Perform input and output in binary mode (as opposed to text mode). This is probably not what you think it is; see http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch27s02.html.

Definition at line 374 of file ios_base.h.

Referenced by std::basic_filebuf< _CharT, _Traits >::showmanyc().

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

Insert/extract bool in alphabetic rather than numeric format.

Definition at line 260 of file ios_base.h.

Referenced by std::boolalpha(), std::num_get< _CharT, _InIter >::do_get(), std::num_put< _CharT, _OutIter >::do_put(), and std::noboolalpha().

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

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

Definition at line 401 of file ios_base.h.

Referenced by std::basic_filebuf< _CharT, _Traits >::imbue(), std::basic_filebuf< _CharT, _Traits >::overflow(), std::basic_filebuf< _CharT, _Traits >::pbackfail(), 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().