GNU C++ STL: std::basic_ios< _CharT, _Traits

template<typename _CharT, typename _Traits>

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

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

Definition at line 78 of file basic_ios.h.

template<typename _CharT, typename _Traits>

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

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

Definition at line 82 of file basic_ios.h.

template<typename _CharT, typename _Traits>

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

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

Definition at line 80 of file basic_ios.h.

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.

Definition at line 65 of file basic_ios.h.

template<typename _CharT, typename _Traits>

typedef _Traits::int_type std::basic_ios< _CharT, _Traits >::int_type

Definition at line 66 of file basic_ios.h.

template<typename _CharT, typename _Traits>

typedef _Traits::off_type std::basic_ios< _CharT, _Traits >::off_type

Definition at line 68 of file basic_ios.h.

template<typename _CharT, typename _Traits>

typedef _Traits::pos_type std::basic_ios< _CharT, _Traits >::pos_type

Definition at line 67 of file basic_ios.h.

template<typename _CharT, typename _Traits>

typedef _Traits std::basic_ios< _CharT, _Traits >::traits_type

Definition at line 69 of file basic_ios.h.

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 basic_ios.h.

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 basic_ios.h.

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 basic_ios.h.

template<typename _CharT, typename _Traits>

void std::basic_ios< _CharT, _Traits >::_M_cache_locale ( const locale & __loc ) [protected]

Definition at line 170 of file basic_ios.tcc.

References std::basic_ios< _CharT, _Traits >::_M_ctype, std::basic_ios< _CharT, _Traits >::_M_num_get, and std::basic_ios< _CharT, _Traits >::_M_num_put.

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

template<typename _CharT, typename _Traits>

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

Definition at line 150 of file basic_ios.h.

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 basic_ios.h.

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

References __N, std::__throw_ios_failure(), std::ios_base::_M_streambuf_state, std::ios_base::badbit, and std::basic_ios< _CharT, _Traits >::rdstate().

Referenced by std::basic_ios< char, _Traits >::exceptions(), std::basic_fstream< _CharT, _Traits >::open(), std::basic_ofstream< _CharT, _Traits >::open(), std::basic_ifstream< _CharT, _Traits >::open(), 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 66 of file basic_ios.tcc.

References std::basic_ios< _CharT, _Traits >::_M_cache_locale(), std::ios_base::_M_call_callbacks(), std::ios_base::_M_callbacks, std::ios_base::_M_dispose_callbacks(), std::ios_base::_M_ios_locale, std::ios_base::_M_local_word, std::ios_base::_M_word, std::ios_base::_M_word_size, std::ios_base::_S_local_word_size, std::ios_base::copyfmt_event, std::ios_base::erase_event, 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 basic_ios.h.

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 badbit\n";
      f.setstate (std::ios_base::badbit);

      std::cerr << "Setting exception mask\n";
      f.exceptions (std::ios_base::badbit);
  }

Definition at line 243 of file basic_ios.h.

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 basic_ios.h.

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 basic_ios.h.

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 basic_ios.h.

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 basic_ios.h.

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

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

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::basic_ios< _CharT, _Traits >::_M_cache_locale(), and 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]

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::basic_ios< _CharT, _Traits >::_M_cache_locale(), std::ios_base::_M_exception, std::basic_ios< _CharT, _Traits >::_M_fill, std::basic_ios< _CharT, _Traits >::_M_fill_init, std::ios_base::_M_init(), std::ios_base::_M_ios_locale, std::basic_ios< _CharT, _Traits >::_M_streambuf, std::ios_base::_M_streambuf_state, std::basic_ios< _CharT, _Traits >::_M_tie, 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_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().

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.

References std::__check_facet(), and std::basic_ios< _CharT, _Traits >::_M_ctype.

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 basic_ios.h.

template<typename _CharT, typename _Traits>

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

Definition at line 111 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 )

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

References std::basic_ios< _CharT, _Traits >::_M_streambuf, and 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 basic_ios.h.

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 basic_ios.h.

Referenced by std::basic_ios< _CharT, _Traits >::clear(), and std::basic_ios< char, _Traits >::good().

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 basic_ios.h.

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 basic_ios.h.

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

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

References std::__check_facet(), and std::basic_ios< _CharT, _Traits >::_M_ctype.

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

template<typename _CharT, typename _Traits>

const __ctype_type* std::basic_ios< _CharT, _Traits >::_M_ctype [protected]

Definition at line 93 of file basic_ios.h.

Referenced by std::basic_ios< _CharT, _Traits >::_M_cache_locale(), std::basic_ios< _CharT, _Traits >::narrow(), std::basic_istream< _CharT, _Traits >::sentry::sentry(), and std::basic_ios< _CharT, _Traits >::widen().

template<typename _CharT, typename _Traits>

char_type std::basic_ios< _CharT, _Traits >::_M_fill [mutable, protected]

Definition at line 88 of file basic_ios.h.

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

template<typename _CharT, typename _Traits>

bool std::basic_ios< _CharT, _Traits >::_M_fill_init [mutable, protected]

Definition at line 89 of file basic_ios.h.

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

template<typename _CharT, typename _Traits>

const __num_get_type* std::basic_ios< _CharT, _Traits >::_M_num_get [protected]

Definition at line 97 of file basic_ios.h.

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

template<typename _CharT, typename _Traits>

const __num_put_type* std::basic_ios< _CharT, _Traits >::_M_num_put [protected]

Definition at line 95 of file basic_ios.h.

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

template<typename _CharT, typename _Traits>

basic_streambuf<_CharT, _Traits>* std::basic_ios< _CharT, _Traits >::_M_streambuf [protected]

Definition at line 90 of file basic_ios.h.

Referenced by std::basic_ios< _CharT, _Traits >::init(), std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios< char, _Traits >::rdbuf().

template<typename _CharT, typename _Traits>

basic_ostream<_CharT, _Traits>* std::basic_ios< _CharT, _Traits >::_M_tie [protected]

Definition at line 87 of file basic_ios.h.

Referenced by std::basic_ios< _CharT, _Traits >::init(), and std::basic_ios< char, _Traits >::tie().

std::basic_ios< _CharT, _Traits > Class Template Reference

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation


Public Types

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.

	operator void * () const
	The quick-and-easy status check.
bool	operator! () const
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)
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

std::basic_ios< _CharT, _Traits > Class Template Reference

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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