typedef CharT char_type

typedef Traits traits_type

typedef traits_type::int_type int_type

typedef traits_type::pos_type pos_type

typedef traits_type::off_type off_type

typedef basic_filebuf< char_type, traits_type > __filebuf_type

typedef basic_ios< char_type, traits_type > __ios_type

typedef basic_iostream< char_type, traits_type > __iostream_type

typedef basic_istream< CharT, Traits > __istream_type

typedef basic_ostream< CharT, Traits > __ostream_type

typedef basic_streambuf< CharT, Traits > streambuf_type

typedef basic_streambuf< CharT, Traits > streambuf_type

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

typedef ctype< CharT > ctype_type

typedef ctype< CharT > ctype_type

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

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 num_put< CharT, ostreambuf_iterator< CharT, Traits > > num_put_type

basic_fstream ()

Default constructor. basic_fstream (const char *s, ios_base::openmode __mode=ios_base::in|ios_base::out)

Create an input/output file stream. ~basic_fstream ()

The destructor does nothing. __filebuf_type * rdbuf () const

Accessing the underlying buffer. bool is_open ()

Wrapper to test for an open file. void open (const char *s, ios_base::openmode __mode=ios_base::in|ios_base::out)

Opens an external file. void close ()

Close the file. streamsize gcount () const

Character counting. 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_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 (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. __ostream_type & flush ()

Synchronizing the stream buffer. pos_type tellp ()

Getting the current write position. __ostream_type & seekp (pos_type)

Changing the current write position. __ostream_type & seekp (off_type, ios_base::seekdir)

Changing the current write position.

__istream_type & operator>> (__istream_type &(*__pf)(__istream_type &))

Interface for manipulators. __istream_type & operator>> (__ios_type &(*__pf)(__ios_type &))

Interface for manipulators. __istream_type & operator>> (ios_base &(*__pf)(ios_base &))

Interface for manipulators.

Arithmetic Extractors

All the operator>> functions (aka formatted input functions) have some common behavior. Each starts by constructing a temporary object of type std::basic_istream::sentry with the second argument (noskipws) set to false. 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 extract whatever data is appropriate for the type of the argument.

If an exception is thrown during extraction, 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.

__istream_type & operator>> (bool &n)

Basic arithmetic extractors. __istream_type & operator>> (short &n)

Basic arithmetic extractors. __istream_type & operator>> (unsigned short &n)

Basic arithmetic extractors. __istream_type & operator>> (int &n)

Basic arithmetic extractors. __istream_type & operator>> (unsigned int &n)

Basic arithmetic extractors. __istream_type & operator>> (long &n)

Basic arithmetic extractors. __istream_type & operator>> (unsigned long &n)

Basic arithmetic extractors. __istream_type & operator>> (float &__f)

Basic arithmetic extractors. __istream_type & operator>> (double &__f)

Basic arithmetic extractors. __istream_type & operator>> (long double &__f)

Basic arithmetic extractors. __istream_type & operator>> (void *&__p)

Basic arithmetic extractors. __istream_type & operator>> (streambuf_type *sb)

Extracting into another streambuf.

Unformatted Input Functions

All the unformatted input functions have some common behavior. Each starts by constructing a temporary object of type std::basic_istream::sentry with the second argument (noskipws) set to true. 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 extract whatever data is appropriate for the type of the argument.

The number of characters extracted is stored for later retrieval by gcount().

If an exception is thrown during extraction, 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.

int_type get ()

Simple extraction. __istream_type & get (char_type &c)

Simple extraction. __istream_type & get (char_type *s, streamsize n, char_type __delim)

Simple multiple-character extraction. __istream_type & get (char_type *s, streamsize n)

Simple multiple-character extraction. __istream_type & get (streambuf_type &sb, char_type __delim)

Extraction into another streambuf. __istream_type & get (streambuf_type &sb)

Extraction into another streambuf. __istream_type & getline (char_type *s, streamsize n, char_type __delim)

String extraction. __istream_type & getline (char_type *s, streamsize n)

String extraction. __istream_type & ignore (streamsize n=1, int_type __delim=traits_type::eof())

Discarding characters. int_type peek ()

Looking ahead in the stream. __istream_type & read (char_type *s, streamsize n)

Extraction without delimiters. streamsize readsome (char_type *s, streamsize n)

Extraction until the buffer is exhausted, but no more. __istream_type & putback (char_type c)

Unextracting a single character. __istream_type & unget ()

Unextracting the previous character. int sync ()

Synchronizing the stream buffer. pos_type tellg ()

Getting the current read position. __istream_type & seekg (pos_type)

Changing the current read position. __istream_type & seekg (off_type, ios_base::seekdir)

Changing the current read position.

operator void * () const

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

The quick-and-easy status check.

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

Interface for manipulators. __ostream_type & operator<< (__ios_type &(*__pf)(__ios_type &))

Interface for manipulators. __ostream_type & operator<< (ios_base &(*__pf)(ios_base &))

Interface for manipulators.

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

Basic arithmetic inserters. __ostream_type & operator<< (unsigned long n)

Basic arithmetic inserters. __ostream_type & operator<< (bool n)

Basic arithmetic inserters. __ostream_type & operator<< (short n)

Basic arithmetic inserters. __ostream_type & operator<< (unsigned short n)

Basic arithmetic inserters. __ostream_type & operator<< (int n)

Basic arithmetic inserters. __ostream_type & operator<< (unsigned int n)

Basic arithmetic inserters. __ostream_type & operator<< (double __f)

Basic arithmetic inserters. __ostream_type & operator<< (float __f)

Basic arithmetic inserters. __ostream_type & operator<< (long double __f)

Basic arithmetic inserters. __ostream_type & operator<< (const void *__p)

Basic arithmetic inserters. __ostream_type & operator<< (streambuf_type *sb)

Extracting from another streambuf.

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)

Simple insertion. void M_write (const char_type *s, streamsize n)

Simple insertion. __ostream_type & write (const char_type *s, streamsize n)

Character string insertion.

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

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

streamsize M_gcount

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 const int S_local_word_size

__filebuf_type M_filebuf

class sentry

class sentry

Controlling intput and output for files.

This class supports reading from and writing to named files, using the inherited functions from std::basic_iostream. To control the associated sequence, an instance of std::basic_filebuf is used, which this page refers to as sb.

Definition at line 725 of file fstream.

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_iostream< CharT, Traits >.

Definition at line 729 of file fstream.

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.

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.

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_iostream< CharT, Traits >.

Definition at line 731 of file fstream.

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.

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_iostream< CharT, Traits >.

Definition at line 733 of file fstream.

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.

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_iostream< CharT, Traits >.

Definition at line 732 of file fstream.

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.

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_iostream< CharT, Traits >.

Definition at line 730 of file fstream.

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.

Default constructor.

Initializes sb using its default constructor, and passes &sb to the base class initializer. Does not open any files (you haven't given it a filename to open).

Definition at line 757 of file fstream.

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

Create an input/output file stream.

Parameters: s Null terminated string specifying the filename.

mode Open file in specified mode (see std::ios_base).

Tip: When using std::string to hold the filename, you must use .c_str() before passing it to this constructor.

Definition at line 770 of file fstream.

References std::basic_ios< CharT, Traits >::init(), and std::basic_fstream< CharT, Traits >::open().

The destructor does nothing.

The file is closed by the filebuf object, not the formatting stream.

Definition at line 784 of file fstream.

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.

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

Close the file.

Calls std::basic_filebuf::close(). If that function fails, failbit is set in the stream's error state.

Definition at line 831 of file fstream.

References std::ios_base::failbit.

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

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.

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

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

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

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.

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::basic_ostream< CharT, Traits >::operator<<(), and std::operator>>().

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.

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

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

Character counting.

Returns: The number of characters extracted by the previous unformatted input function dispatched for this stream.

Definition at line 241 of file istream.

Extraction into another streambuf.

Parameters: sb A streambuf in which to store data.

Returns: *this

Returns get(sb,widen('

Definition at line 358 of file istream.

Extraction into another streambuf.

Parameters: sb A streambuf in which to store data.

delim A 'stop' character.

Returns: *this

Characters are extracted and inserted into sb until one of the following happens:

•

the input sequence reaches EOF

•

insertion into the output buffer fails (in this case, the character that would have been inserted is not extracted)

•

the next character equals delim (in this case, the character is not extracted)

•

an exception occurs (and in this case is caught)

If no characters are stored, failbit is set in the stream's error state.

Definition at line 542 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, std::basic_ios< CharT, Traits >::rdbuf(), and std::basic_ios< CharT, Traits >::setstate().

Simple multiple-character extraction.

Parameters: s Pointer to an array.

n Maximum number of characters to store in s.

Returns: *this

Returns get(s,n,widen('

Definition at line 325 of file istream.

Simple multiple-character extraction.

Parameters: s Pointer to an array.

n Maximum number of characters to store in s.

delim A 'stop' character.

Returns: *this

Characters are extracted and stored into s until one of the following happens:

•

n-1 characters are stored

•

the input sequence reaches EOF

•

the next character equals delim, in which case the character is not extracted

If no characters are stored, failbit is set in the stream's error state.

In any case, a null character is stored into the next location in the array.

Note: This function is not overloaded on signed char and unsigned char.

Definition at line 503 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, std::basic_ios< CharT, Traits >::rdbuf(), and std::basic_ios< CharT, Traits >::setstate().

Simple extraction.

Parameters: c The character in which to store data.

Returns: *this

Tries to extract a character and store it in c. If none are available, sets failbit and returns traits::eof().

Note: This function is not overloaded on signed char and unsigned char.

Definition at line 471 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, std::basic_ios< CharT, Traits >::rdbuf(), and std::basic_ios< CharT, Traits >::setstate().

Simple extraction.

Returns: A character, or eof().

Tries to extract a character. If none are available, sets failbit and returns traits::eof().

Definition at line 440 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, std::basic_ios< CharT, Traits >::rdbuf(), and std::basic_ios< CharT, Traits >::setstate().

Referenced by std::basic_istream< char >::get().

String extraction.

Parameters: s A character array in which to store the data.

n Maximum number of characters to extract.

Returns: *this

Returns getline(s,n,widen('

Definition at line 398 of file istream.

String extraction.

Parameters: s A character array in which to store the data.

n Maximum number of characters to extract.

delim A 'stop' character.

Returns: *this

Extracts and stores characters into s until one of the following happens. Note that these criteria are required to be tested in the order listed here, to allow an input line to exactly fill the s array without setting failbit.

1.

the input sequence reaches end-of-file, in which case eofbit is set in the stream error state

2.

the next character equals delim, in which case the character is extracted (and therefore counted in gcount()) but not stored

3.

n-1 characters are stored, in which case failbit is set in the stream error state

If no characters are extracted, failbit is set. (An empty line of input should therefore not cause failbit to be set.)

In any case, a null character is stored in the next location in the array.

Definition at line 581 of file istream.tcc.

References std::ios_base::badbit, std::copy(), std::ios_base::eofbit, std::ios_base::failbit, std::find(), std::ios_base::goodbit, std::min(), std::basic_ios< CharT, Traits >::rdbuf(), and std::basic_ios< CharT, Traits >::setstate().

Referenced by std::basic_istream< char >::getline().

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

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

Discarding characters.

Parameters: n Number of characters to discard.

delim A 'stop' character.

Returns: *this

Extracts characters and throws them away until one of the following happens:

•

if n != std::numeric_limits<int>::max(), n characters are extracted

•

the input sequence reaches end-of-file

•

the next character equals delim (in this case, the character is extracted); note that this condition will never occur if delim equals traits::eof().

Definition at line 647 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::goodbit, std::basic_ios< CharT, Traits >::rdbuf(), and std::basic_ios< CharT, Traits >::setstate().

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

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

Wrapper to test for an open file.

Returns: rdbuf()->is_open()

Definition at line 803 of file fstream.

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.

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.

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 286 of file ostream.

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.

Opens an external file.

Parameters: s The name of the file.

mode The open mode flags.

Calls std::basic_filebuf::open(s,mode). If that function fails, failbit is set in the stream's error state.

Tip: When using std::string to hold the filename, you must use .c_str() before passing it to this constructor.

Definition at line 817 of file fstream.

References std::ios_base::failbit.

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

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.

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

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 306 of file ostream.tcc.

References std::ios_base::badbit, std::ios_base::failbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic inserters.

Parameters: A variable of builtin 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 283 of file ostream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic inserters.

Parameters: A variable of builtin 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 260 of file ostream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic inserters.

Parameters: A variable of builtin 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.

Basic arithmetic inserters.

Parameters: A variable of builtin 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 237 of file ostream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic inserters.

Parameters: A variable of builtin 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.

Basic arithmetic inserters.

Parameters: A variable of builtin 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 192 of file ostream.

Basic arithmetic inserters.

Parameters: A variable of builtin 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 188 of file ostream.

Basic arithmetic inserters.

Parameters: A variable of builtin 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 177 of file ostream.

Basic arithmetic inserters.

Parameters: A variable of builtin 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 97 of file ostream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic inserters.

Parameters: A variable of builtin 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 154 of file ostream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic inserters.

Parameters: A variable of builtin 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 120 of file ostream.tcc.

References std::ios_base::badbit, std::ios_base::basefield, std::basic_ios< CharT, Traits >::fill(), std::ios_base::flags(), std::ios_base::goodbit, std::ios_base::hex, std::ios_base::oct, and std::basic_ios< CharT, Traits >::setstate().

Interface for manipulators.

Manuipulators 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 85 of file ostream.tcc.

Interface for manipulators.

Manuipulators 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 73 of file ostream.tcc.

Interface for manipulators.

Manuipulators 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 62 of file ostream.tcc.

Extracting into 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 this stream and inserted into the sb streambuf until one of the following occurs:

•

the input stream reaches end-of-file,

•

insertion into the output buffer fails (in this case, the character that would have been inserted is not extracted), or

•

an exception occurs (and in this case is caught)

If the function inserts no characters, failbit is set.

Definition at line 416 of file istream.tcc.

References std::ios_base::failbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic extractors.

Parameters: A variable of builtin type.

Returns: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

Definition at line 394 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic extractors.

Parameters: A variable of builtin type.

Returns: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

Definition at line 372 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic extractors.

Parameters: A variable of builtin type.

Returns: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

Definition at line 350 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic extractors.

Parameters: A variable of builtin type.

Returns: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

Definition at line 328 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic extractors.

Parameters: A variable of builtin type.

Returns: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

Definition at line 260 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic extractors.

Parameters: A variable of builtin type.

Returns: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

Definition at line 238 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic extractors.

Parameters: A variable of builtin type.

Returns: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

Definition at line 216 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic extractors.

Parameters: A variable of builtin type.

Returns: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

Definition at line 185 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::failbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic extractors.

Parameters: A variable of builtin type.

Returns: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

Definition at line 163 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic extractors.

Parameters: A variable of builtin type.

Returns: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

Definition at line 132 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::failbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Basic arithmetic extractors.

Parameters: A variable of builtin type.

Returns: *this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

Definition at line 110 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::goodbit, and std::basic_ios< CharT, Traits >::setstate().

Interface for manipulators.

Manuipulators such as std::ws and std::dec use these functions in constructs like 'std::cin >> std::ws'. For more information, see the iomanip header.

Definition at line 101 of file istream.tcc.

Interface for manipulators.

Manuipulators such as std::ws and std::dec use these functions in constructs like 'std::cin >> std::ws'. For more information, see the iomanip header.

Definition at line 92 of file istream.tcc.

Interface for manipulators.

Manuipulators such as std::ws and std::dec use these functions in constructs like 'std::cin >> std::ws'. For more information, see the iomanip header.

Definition at line 86 of file istream.tcc.

Looking ahead in the stream.

Returns: The next character, or eof().

If, after constructing the sentry object, good() is false, returns traits::eof(). Otherwise reads but does not extract the next input character.

Definition at line 683 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::goodbit, std::basic_ios< CharT, Traits >::rdbuf(), and std::basic_ios< CharT, Traits >::setstate().

Changing flags.

Parameters: prec The new precision value.

Returns: The previous value of precision().

Definition at line 628 of file ios_base.h.

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

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

Unextracting a single character.

Parameters: c The character to push back into the input stream.

Returns: *this

If rdbuf() is not null, calls rdbuf()->sputbackc(c).

If rdbuf() is null or if sputbackc() fails, sets badbit in the error state.

Note: Since no characters are extracted, the next call to gcount() will return 0, as required by DR 60.

Definition at line 759 of file istream.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::operator>>().

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.

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

Accessing the underlying buffer.

Returns: The current basic_filebuf buffer.

This hides both signatures of std::basic_ios::rdbuf().

Reimplemented from std::basic_ios< CharT, Traits >.

Definition at line 795 of file fstream.

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

Extraction without delimiters.

Parameters: s A character array.

n Maximum number of characters to store.

Returns: *this

If the stream state is good(), extracts characters and stores them into s until one of the following happens:

•

n characters are stored

•

the input sequence reaches end-of-file, in which case the error state is set to failbit|eofbit.

Note: This function is not overloaded on signed char and unsigned char.

Definition at line 708 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, std::basic_ios< CharT, Traits >::rdbuf(), and std::basic_ios< CharT, Traits >::setstate().

Extraction until the buffer is exhausted, but no more.

Parameters: s A character array.

n Maximum number of characters to store.

Returns: The number of characters extracted.

Extracts characters and stores them into s depending on the number of characters remaining in the streambuf's buffer, rdbuf()->in_avail(), called A here:

•

if A == -1, sets eofbit and extracts no characters

•

if A == 0, extracts no characters

•

if A > 0, extracts min(A,n)

The goal is to empty the current buffer, and to not request any more from the external input sequence controlled by the streambuf.

Definition at line 732 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::goodbit, std::min(), std::basic_ios< CharT, Traits >::rdbuf(), and std::basic_ios< CharT, Traits >::setstate().

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.

Changing the current read 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.

Note: This function does not count the number of characters extracted, if any, and therefore does not affect the next call to gcount().

Definition at line 892 of file istream.tcc.

References std::ios_base::failbit, std::ios_base::goodbit, and std::ios_base::in.

Changing the current read position.

Parameters: pos A file position object.

Returns: *this

If fail() is not true, calls rdbuf()->pubseekpos(pos). If that function fails, sets failbit.

Note: This function does not count the number of characters extracted, if any, and therefore does not affect the next call to gcount().

Definition at line 864 of file istream.tcc.

References std::ios_base::failbit, std::ios_base::goodbit, and std::ios_base::in.

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 446 of file ostream.tcc.

References std::ios_base::failbit, std::ios_base::goodbit, and std::ios_base::out.

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 419 of file ostream.tcc.

References std::ios_base::failbit, std::ios_base::goodbit, and std::ios_base::out.

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.

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

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.

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

Synchronizing the stream buffer.

Returns: 0 on success, -1 on failure

If rdbuf() is a null pointer, returns -1.

Otherwise, calls rdbuf()->pubsync(), and if that returns -1, sets badbit and returns -1.

Otherwise, returns 0.

Note: This function does not count the number of characters extracted, if any, and therefore does not affect the next call to gcount().

Definition at line 815 of file istream.tcc.

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

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.

Getting the current read position.

Returns: A file position object.

If fail() is not false, returns pos_type(-1) to indicate failure. Otherwise returns rdbuf()->pubseekoff(0,cur,in).

Note: This function does not count the number of characters extracted, if any, and therefore does not affect the next call to gcount().

Definition at line 846 of file istream.tcc.

References std::ios_base::badbit, std::ios_base::cur, and std::ios_base::in.

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 403 of file ostream.tcc.

References std::ios_base::badbit, std::ios_base::cur, and std::ios_base::out.

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.

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

Unextracting the previous character.

Returns: *this

If rdbuf() is not null, calls rdbuf()->sungetc(c).

If rdbuf() is null or if sungetc() fails, sets badbit in the error state.

Note: Since no characters are extracted, the next call to gcount() will return 0, as required by DR 60.

Definition at line 787 of file istream.tcc.

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

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

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

Changing flags.

Parameters: wide The new width value.

Returns: The previous value of width().

Definition at line 650 of file ios_base.h.

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

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 359 of file ostream.tcc.

References std::ios_base::badbit.

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.

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

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

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

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

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

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

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

Definition at line 371 of file ios_base.h.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Definition at line 281 of file ios_base.h.

Referenced by std::right().

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

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

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

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

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

Open for input. Default for ofstream.

Definition at line 380 of file ios_base.h.

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

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