basic_ofstream Class Template Reference

Inheritance diagram for basic_ofstream:

Inheritance graph
List of all members.

Detailed Description

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

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

Definition at line 530 of file fstream.

Public Types

Public Member Functions

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.

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.

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends


Member Typedef Documentation

typedef _CharT char_type
 

These are standard types. They permit a standardized way of referring to names of (or names dependant on) the template parameters, which are specific to the implementation.

Reimplemented from basic_ostream.

Definition at line 534 of file fstream.

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

The type of an event callback function.

Parameters:
event One of the members of the event enum.
ios_base Reference to the ios_base object.
int The integer provided when the callback was registered.
Event callbacks are user defined functions that get called during several ios_base and basic_ios functions, specifically imbue(), copyfmt(), and ~ios().

Definition at line 435 of file ios_base.h.

typedef _Ios_Fmtflags fmtflags [inherited]
 

This is a bitmask type.

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

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

Definition at line 253 of file ios_base.h.

typedef _Ios_Iostate iostate [inherited]
 

This is a bitmask type.

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

  • badbit
  • eofbit
  • failbit
  • goodbit

Definition at line 328 of file ios_base.h.

typedef _Ios_Openmode openmode [inherited]
 

This is a bitmask type.

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

  • app
  • ate
  • binary
  • in
  • out
  • trunc

Definition at line 359 of file ios_base.h.

typedef _Ios_Seekdir seekdir [inherited]
 

This is an enumerated type.

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

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

Definition at line 392 of file ios_base.h.


Member Enumeration Documentation

enum event [inherited]
 

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

erase_event is used during ~ios() and copyfmt(). imbue_event is used during imbue(). copyfmt_event is used during copyfmt().

Definition at line 418 of file ios_base.h.


Constructor & Destructor Documentation

basic_ofstream  )  [inline]
 

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 556 of file fstream.

References basic_ios::init().

basic_ofstream const char *  __s,
ios_base::openmode  __mode = ios_base::out|ios_base::trunc
[inline, explicit]
 

Create an output file stream.

Parameters:
s Null terminated string specifying the filename.
mode Open file in specified mode (see std::ios_base).
ios_base::out|ios_base::trunc is automatically included in mode.

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

Definition at line 571 of file fstream.

References basic_ios::init(), and basic_ofstream::open().

~basic_ofstream  )  [inline]
 

The destructor does nothing.

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

Definition at line 585 of file fstream.


Member Function Documentation

const locale& _M_getloc  )  const [inline, inherited]
 

Locale access.

Returns:
A reference to the current locale.
Like getloc above, but returns a reference instead of generating a copy.

Definition at line 700 of file ios_base.h.

Referenced by money_get::do_get(), num_get::do_get(), time_get::do_get_date(), time_get::do_get_monthname(), time_get::do_get_time(), time_get::do_get_weekday(), time_get::do_get_year(), time_put::do_put(), num_put::do_put(), and time_put::put().

bool bad  )  const [inline, inherited]
 

Fast error checking.

Returns:
True if the badbit is set.
Note that other iostate flags may also be set.

Definition at line 197 of file basic_ios.h.

References ios_base::badbit.

void clear iostate  __state = goodbit  )  [inherited]
 

[Re]sets the error state.

Parameters:
state The new state flag(s) to set.
See std::ios_base::iostate for the possible bit values. Most users will not need to pass an argument.

Definition at line 44 of file basic_ios.tcc.

References ios_base::badbit, and basic_ios::rdstate().

Referenced by basic_ios::exceptions(), basic_fstream::open(), basic_ofstream::open(), basic_ifstream::open(), basic_ios::rdbuf(), and basic_ios::setstate().

void close  )  [inline]
 

Close the file.

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

Definition at line 643 of file fstream.

References basic_filebuf::close(), ios_base::failbit, and basic_ios::setstate().

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

Copies fields of __rhs into this.

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

Definition at line 66 of file basic_ios.tcc.

References ios_base::_M_callbacks, ios_base::_M_word, ios_base::_M_word_size, basic_ios::exceptions(), basic_ios::fill(), ios_base::flags(), ios_base::getloc(), ios_base::precision(), basic_ios::tie(), and ios_base::width().

bool eof  )  const [inline, inherited]
 

Fast error checking.

Returns:
True if the eofbit is set.
Note that other iostate flags may also be set.

Definition at line 176 of file basic_ios.h.

References ios_base::eofbit.

void exceptions iostate  __except  )  [inline, inherited]
 

Throwing exceptions on errors.

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

If the error 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.

References basic_ios::clear().

iostate exceptions  )  const [inline, inherited]
 

Throwing exceptions on errors.

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

Definition at line 208 of file basic_ios.h.

Referenced by basic_ios::copyfmt().

bool fail  )  const [inline, inherited]
 

Fast error checking.

Returns:
True if either the badbit or the failbit is set.
Checking the badbit in fail() is historical practice. Note that other iostate flags may also be set.

Definition at line 187 of file basic_ios.h.

References ios_base::badbit, and ios_base::failbit.

Referenced by basic_ios::operator void *().

char_type fill char_type  __ch  )  [inline, inherited]
 

Sets a new "empty" character.

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

Definition at line 376 of file basic_ios.h.

References basic_ios::fill().

char_type fill  )  const [inline, inherited]
 

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.

References basic_ios::widen().

Referenced by basic_ios::copyfmt(), basic_ios::fill(), and basic_ostream::operator<<().

fmtflags flags fmtflags  __fmtfl  )  [inline, inherited]
 

Setting new format flags all at once.

Parameters:
fmtfl The new flags to set.
Returns:
The previous format control flags.
This function overwrites all the format flags with fmtfl.

Definition at line 558 of file ios_base.h.

fmtflags flags  )  const [inline, inherited]
 

Access to format flags.

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

Definition at line 548 of file ios_base.h.

Referenced by basic_ios::copyfmt(), num_get::do_get(), num_put::do_put(), and basic_ostream::operator<<().

basic_ostream< _CharT, _Traits > & flush  )  [inherited]
 

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

References ios_base::badbit, ios_base::goodbit, basic_ios::rdbuf(), and basic_ios::setstate().

Referenced by std::flush().

locale getloc  )  const [inline, inherited]
 

Locale access.

Returns:
A copy of the current locale.
If imbue(loc) has previously been called, then this function returns loc. Otherwise, it returns a copy of std::locale(), the global C++ locale.

Definition at line 690 of file ios_base.h.

Referenced by basic_ios::copyfmt(), and money_put::do_put().

bool good  )  const [inline, inherited]
 

Fast error checking.

Returns:
True if no error flags are set.
A wrapper around rdstate.

Definition at line 166 of file basic_ios.h.

References basic_ios::rdstate().

locale imbue const locale __loc  )  [inherited]
 

Moves to a new locale.

Parameters:
loc The new locale.
Returns:
The previous locale.
Calls ios_base::imbue(loc), and if a stream buffer is associated with this stream, calls that buffer's pubimbue(loc).

Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/22_locale/howto.html

Reimplemented from ios_base.

Definition at line 127 of file basic_ios.tcc.

References ios_base::imbue(), and basic_ios::rdbuf().

void init basic_streambuf< _CharT, _Traits > *  __sb  )  [protected, inherited]
 

All setup is performed here.

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

Definition at line 139 of file basic_ios.tcc.

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

Referenced by basic_fstream::basic_fstream(), basic_ifstream::basic_ifstream(), basic_ios::basic_ios(), basic_iostream::basic_iostream(), basic_istream::basic_istream(), basic_istringstream::basic_istringstream(), basic_ofstream::basic_ofstream(), basic_ostream::basic_ostream(), basic_ostringstream::basic_ostringstream(), and basic_stringstream::basic_stringstream().

bool is_open  )  [inline]
 

Wrapper to test for an open file.

Returns:
rdbuf()->is_open()

Definition at line 604 of file fstream.

References basic_filebuf::is_open().

long& iword int  __ix  )  [inline, inherited]
 

Access to integer array.

Parameters:
__ix Index into the array.
Returns:
A reference to an integer associated with the index.
The iword function provides access to an array of integers that can be used for any purpose. The array grows as required to hold the supplied index. All integers in the array are initialized to 0.

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

Definition at line 734 of file ios_base.h.

char narrow char_type  __c,
char  __dfault
const [inherited]
 

Squeezes characters.

Parameters:
c The character to narrow.
dfault The character to narrow.
Returns:
The narrowed character.
Maps a character of char_type to a character of char, if possible.

Returns the result of

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

Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/22_locale/howto.html

Definition at line 116 of file basic_ios.tcc.

void open const char *  __s,
ios_base::openmode  __mode = ios_base::out | ios_base::trunc
[inline]
 

Opens an external file.

Parameters:
s The name of the file.
mode The open mode flags.
Calls std::basic_filebuf::open(s,mode|out|trunc). 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 625 of file fstream.

References basic_ios::clear(), ios_base::failbit, basic_filebuf::open(), and basic_ios::setstate().

Referenced by basic_ofstream::basic_ofstream().

operator void *  )  const [inline, inherited]
 

The quick-and-easy status check.

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

Definition at line 107 of file basic_ios.h.

References basic_ios::fail().

basic_ostream< _CharT, _Traits > & operator<< __streambuf_type __sb  )  [inherited]
 

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

References ios_base::badbit, ios_base::failbit, ios_base::goodbit, and basic_ios::setstate().

basic_ostream< _CharT, _Traits > & operator<< const void *  __p  )  [inherited]
 

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

References ios_base::badbit, ios_base::goodbit, num_put::put(), and basic_ios::setstate().

basic_ostream< _CharT, _Traits > & operator<< long double  __f  )  [inherited]
 

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

References ios_base::badbit, ios_base::goodbit, num_put::put(), and basic_ios::setstate().

__ostream_type& operator<< float  __f  )  [inline, inherited]
 

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

basic_ostream< _CharT, _Traits > & operator<< double  __f  )  [inherited]
 

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

References ios_base::badbit, ios_base::goodbit, num_put::put(), and basic_ios::setstate().

basic_ostream< _CharT, _Traits > & operator<< unsigned long long  __n  )  [inherited]
 

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

References ios_base::badbit, ios_base::goodbit, num_put::put(), and basic_ios::setstate().

basic_ostream< _CharT, _Traits > & operator<< long long  __n  )  [inherited]
 

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

References ios_base::badbit, ios_base::basefield, basic_ios::fill(), ios_base::flags(), ios_base::goodbit, ios_base::hex, ios_base::oct, num_put::put(), and basic_ios::setstate().

__ostream_type& operator<< unsigned int  __n  )  [inline, inherited]
 

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

__ostream_type& operator<< int  __n  )  [inline, inherited]
 

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

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

__ostream_type& operator<< unsigned short  __n  )  [inline, inherited]
 

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

__ostream_type& operator<< short  __n  )  [inline, inherited]
 

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

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

basic_ostream< _CharT, _Traits > & operator<< bool  __n  )  [inherited]
 

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

References ios_base::badbit, ios_base::goodbit, num_put::put(), and basic_ios::setstate().

basic_ostream< _CharT, _Traits > & operator<< unsigned long  __n  )  [inherited]
 

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

References ios_base::badbit, ios_base::goodbit, num_put::put(), and basic_ios::setstate().

basic_ostream< _CharT, _Traits > & operator<< long  __n  )  [inherited]
 

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

References ios_base::badbit, ios_base::basefield, basic_ios::fill(), ios_base::flags(), ios_base::goodbit, ios_base::hex, ios_base::oct, num_put::put(), and basic_ios::setstate().

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

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

streamsize precision streamsize  __prec  )  [inline, inherited]
 

Changing flags.

Parameters:
prec The new precision value.
Returns:
The previous value of precision().

Definition at line 626 of file ios_base.h.

streamsize precision  )  const [inline, inherited]
 

Flags access.

Returns:
The precision to generate on certain output operations.

Definition at line 618 of file ios_base.h.

Referenced by basic_ios::copyfmt().

basic_ostream< _CharT, _Traits > & put char_type  __c  )  [inherited]
 

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

References ios_base::badbit, ios_base::goodbit, basic_ios::rdbuf(), and basic_ios::setstate().

Referenced by std::ends().

void*& pword int  __ix  )  [inline, inherited]
 

Access to void pointer array.

Parameters:
__ix Index into the array.
Returns:
A reference to a void* associated with the index.
The pword function provides access to an array of pointers that can be used for any purpose. The array grows as required to hold the supplied index. All pointers in the array are initialized to 0.

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

Definition at line 755 of file ios_base.h.

basic_streambuf< _CharT, _Traits > * rdbuf basic_streambuf< _CharT, _Traits > *  __sb  )  [inherited]
 

Changing the underlying buffer.

Parameters:
sb The new stream buffer.
Returns:
The previous stream buffer.
Associates a new buffer with the current stream, and clears the error state.

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

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

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

Definition at line 56 of file basic_ios.tcc.

References basic_ios::clear().

__filebuf_type* rdbuf  )  const [inline]
 

Accessing the underlying buffer.

Returns:
The current basic_filebuf buffer.
This hides both signatures of std::basic_ios::rdbuf().

Reimplemented from basic_ios.

Definition at line 596 of file fstream.

iostate rdstate  )  const [inline, inherited]
 

Returns the error state of the stream buffer.

Returns:
A bit pattern (well, isn't everything?)
See std::ios_base::iostate for the possible bit values. Most users will call one of the interpreting wrappers, e.g., good().

Definition at line 123 of file basic_ios.h.

Referenced by basic_ios::clear(), and basic_ios::good().

void register_callback event_callback  __fn,
int  __index
[inherited]
 

Add the callback __fn with parameter __index.

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

basic_ostream< _CharT, _Traits > & seekp off_type  ,
ios_base::seekdir 
[inherited]
 

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

References ios_base::badbit, ios_base::failbit, ios_base::goodbit, ios_base::out, basic_ios::rdbuf(), and basic_ios::setstate().

basic_ostream< _CharT, _Traits > & seekp pos_type   )  [inherited]
 

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

References ios_base::badbit, ios_base::failbit, ios_base::goodbit, ios_base::out, basic_ios::rdbuf(), and basic_ios::setstate().

fmtflags setf fmtflags  __fmtfl,
fmtflags  __mask
[inline, inherited]
 

Setting new format flags.

Parameters:
fmtfl Additional flags to set.
mask The flags mask for fmtfl.
Returns:
The previous format control flags.
This function clears mask in the format flags, then sets fmtfl & mask. An example mask is ios_base::adjustfield.

Definition at line 591 of file ios_base.h.

fmtflags setf fmtflags  __fmtfl  )  [inline, inherited]
 

Setting new format flags.

Parameters:
fmtfl Additional flags to set.
Returns:
The previous format control flags.
This function sets additional flags in format control. Flags that were previously set remain set.

Definition at line 574 of file ios_base.h.

Referenced by std::boolalpha().

void setstate iostate  __state  )  [inline, inherited]
 

Sets additional flags in the error state.

Parameters:
state The additional state flag(s) to set.
See std::ios_base::iostate for the possible bit values.

Definition at line 143 of file basic_ios.h.

References basic_ios::clear().

Referenced by basic_fstream::close(), basic_ofstream::close(), basic_ifstream::close(), basic_ostream::flush(), basic_istream::get(), basic_istream::getline(), basic_istream::ignore(), basic_fstream::open(), basic_ofstream::open(), basic_ifstream::open(), basic_ostream::operator<<(), std::operator>>(), basic_istream::operator>>(), basic_istream::peek(), basic_ostream::put(), basic_istream::putback(), basic_istream::read(), basic_istream::readsome(), basic_istream::seekg(), basic_ostream::seekp(), basic_istream::sync(), and basic_istream::unget().

static bool sync_with_stdio bool  __sync = true  )  [static, inherited]
 

Interaction with the standard C I/O objects.

Parameters:
sync Whether to synchronize or not.
Returns:
True if the standard streams were previously synchronized.
The synchronization referred to is only that between the standard C facilities (e.g., stdout) and the standard C++ objects (e.g., cout). User-declared streams are unaffected. See http://gcc.gnu.org/onlinedocs/libstdc++/27_io/howto.html#8 for more.

basic_ostream< _CharT, _Traits >::pos_type tellp  )  [inherited]
 

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

References ios_base::badbit, ios_base::cur, ios_base::out, and basic_ios::rdbuf().

basic_ostream<_CharT, _Traits>* tie basic_ostream< _CharT, _Traits > *  __tiestr  )  [inline, inherited]
 

Ties this stream to an output stream.

Parameters:
tiestr The output stream.
Returns:
The previously tied output stream, or NULL if the stream was not tied.
This sets up a new tie; see tie() for more.

Definition at line 293 of file basic_ios.h.

basic_ostream<_CharT, _Traits>* tie  )  const [inline, inherited]
 

Fetches the current tied stream.

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

Definition at line 281 of file basic_ios.h.

Referenced by basic_ios::copyfmt().

void unsetf fmtflags  __mask  )  [inline, inherited]
 

Clearing format flags.

Parameters:
mask The flags to unset.
This function clears mask in the format flags.

Definition at line 606 of file ios_base.h.

_CharT widen char  __c  )  const [inherited]
 

Widens characters.

Parameters:
c The character to widen.
Returns:
The widened character.
Maps a character of char to a character of char_type.

Returns the result of

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

Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/22_locale/howto.html

Definition at line 121 of file basic_ios.tcc.

Referenced by basic_ios::fill().

streamsize width streamsize  __wide  )  [inline, inherited]
 

Changing flags.

Parameters:
wide The new width value.
Returns:
The previous value of width().

Definition at line 648 of file ios_base.h.

streamsize width  )  const [inline, inherited]
 

Flags access.

Returns:
The minimum field width to generate on output operations.
"Minimum field width" refers to the number of characters.

Definition at line 640 of file ios_base.h.

Referenced by basic_ios::copyfmt(), and num_put::do_put().

__ostream_type& write const char_type __s,
streamsize  __n
[inherited]
 

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.

static int xalloc  )  throw () [static, inherited]
 

Access to unique indices.

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

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


Member Data Documentation

const fmtflags adjustfield [static, inherited]
 

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

Definition at line 308 of file ios_base.h.

Referenced by std::internal(), std::left(), and std::right().

const openmode app [static, inherited]
 

Seek to end before each write.

Definition at line 362 of file ios_base.h.

const openmode ate [static, inherited]
 

Open and seek to end immediately after opening.

Definition at line 365 of file ios_base.h.

Referenced by basic_filebuf::open().

const iostate badbit [static, inherited]
 

as an irrecoverable read error from a file).

Definition at line 332 of file ios_base.h.

Referenced by basic_ios::bad(), basic_ios::clear(), basic_ios::fail(), basic_ostream::flush(), basic_istream::get(), std::getline(), basic_istream::getline(), basic_istream::ignore(), basic_ios::init(), std::operator<<(), basic_ostream::operator<<(), basic_istream::operator>>(), std::operator>>(), basic_istream::peek(), basic_ostream::put(), basic_istream::putback(), basic_istream::read(), basic_istream::readsome(), basic_istream::seekg(), basic_ostream::seekp(), basic_istream::sync(), basic_istream::tellg(), basic_ostream::tellp(), and basic_istream::unget().

const fmtflags basefield [static, inherited]
 

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

Definition at line 311 of file ios_base.h.

Referenced by std::dec(), std::hex(), std::oct(), and basic_ostream::operator<<().

const seekdir beg [static, inherited]
 

Request a seek relative to the beginning of the stream.

Definition at line 395 of file ios_base.h.

Referenced by basic_filebuf::seekpos().

const openmode binary [static, inherited]
 

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

Definition at line 371 of file ios_base.h.

Referenced by basic_filebuf::showmanyc().

const fmtflags boolalpha [static, inherited]
 

Insert/extract bool in alphabetic rather than numeric format.

Definition at line 256 of file ios_base.h.

Referenced by std::boolalpha(), num_get::do_get(), num_put::do_put(), and std::noboolalpha().

const seekdir cur [static, inherited]
 

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

Definition at line 398 of file ios_base.h.

Referenced by basic_filebuf::imbue(), basic_filebuf::pbackfail(), basic_stringbuf::seekoff(), basic_filebuf::seekoff(), basic_istream::tellg(), and basic_ostream::tellp().

const fmtflags dec [static, inherited]
 

Converts integer input or generates integer output in decimal base.

Definition at line 259 of file ios_base.h.

Referenced by std::dec().

const seekdir end [static, inherited]
 

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

Definition at line 401 of file ios_base.h.

Referenced by basic_filebuf::open(), and basic_stringbuf::seekoff().

const iostate eofbit [static, inherited]
 

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

Definition at line 335 of file ios_base.h.

Referenced by num_get::do_get(), time_get::do_get_date(), time_get::do_get_monthname(), time_get::do_get_time(), time_get::do_get_weekday(), time_get::do_get_year(), basic_ios::eof(), basic_istream::get(), std::getline(), basic_istream::getline(), basic_istream::ignore(), std::operator>>(), basic_istream::peek(), basic_istream::read(), basic_istream::readsome(), and std::ws().

const iostate failbit [static, inherited]
 

desired characters.

Definition at line 340 of file ios_base.h.

Referenced by basic_fstream::close(), basic_ofstream::close(), basic_ifstream::close(), basic_ios::fail(), basic_istream::get(), std::getline(), basic_istream::getline(), basic_fstream::open(), basic_ofstream::open(), basic_ifstream::open(), basic_ostream::operator<<(), basic_istream::operator>>(), std::operator>>(), basic_istream::read(), basic_istream::seekg(), and basic_ostream::seekp().

const fmtflags fixed [static, inherited]
 

Generate floating-point output in fixed-point notation.

Definition at line 262 of file ios_base.h.

Referenced by std::fixed().

const fmtflags floatfield [static, inherited]
 

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

Definition at line 314 of file ios_base.h.

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

const iostate goodbit [static, inherited]
 

Indicates all is well.

Definition at line 343 of file ios_base.h.

Referenced by basic_ostream::flush(), basic_istream::get(), std::getline(), basic_istream::getline(), basic_istream::ignore(), basic_ios::init(), basic_ostream::operator<<(), basic_istream::operator>>(), std::operator>>(), basic_istream::peek(), basic_ostream::put(), basic_istream::putback(), basic_istream::read(), basic_istream::readsome(), basic_istream::seekg(), basic_ostream::seekp(), basic_istream::sync(), and basic_istream::unget().

const fmtflags hex [static, inherited]
 

Converts integer input or generates integer output in hexadecimal base.

Definition at line 265 of file ios_base.h.

Referenced by std::hex(), and basic_ostream::operator<<().

const openmode in [static, inherited]
 

Open for input. Default for ifstream and fstream.

Definition at line 374 of file ios_base.h.

Referenced by basic_filebuf::pbackfail(), basic_istream::seekg(), basic_stringbuf::seekoff(), basic_stringbuf::seekpos(), basic_filebuf::showmanyc(), basic_istream::tellg(), basic_stringbuf::underflow(), and basic_filebuf::underflow().

const fmtflags internal [static, inherited]
 

designated.

Definition at line 270 of file ios_base.h.

Referenced by std::internal().

const fmtflags left [static, inherited]
 

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

Definition at line 274 of file ios_base.h.

Referenced by std::left().

const fmtflags oct [static, inherited]
 

Converts integer input or generates integer output in octal base.

Definition at line 277 of file ios_base.h.

Referenced by std::oct(), and basic_ostream::operator<<().

const openmode out [static, inherited]
 

Open for output. Default for ofstream and fstream.

Definition at line 377 of file ios_base.h.

Referenced by basic_stringbuf::overflow(), basic_filebuf::overflow(), basic_stringbuf::pbackfail(), basic_stringbuf::seekoff(), basic_ostream::seekp(), basic_stringbuf::seekpos(), and basic_ostream::tellp().

const fmtflags right [static, inherited]
 

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

Definition at line 281 of file ios_base.h.

Referenced by std::right().

const fmtflags scientific [static, inherited]
 

Generates floating-point output in scientific notation.

Definition at line 284 of file ios_base.h.

Referenced by std::scientific().

const fmtflags showbase [static, inherited]
 

output.

Definition at line 288 of file ios_base.h.

Referenced by std::noshowbase(), and std::showbase().

const fmtflags showpoint [static, inherited]
 

floating-point output.

Definition at line 292 of file ios_base.h.

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

const fmtflags showpos [static, inherited]
 

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

Definition at line 295 of file ios_base.h.

Referenced by std::noshowpos(), and std::showpos().

const fmtflags skipws [static, inherited]
 

Skips leading white space before certain input operations.

Definition at line 298 of file ios_base.h.

Referenced by std::noskipws(), and std::skipws().

const openmode trunc [static, inherited]
 

Open for input. Default for ofstream.

Definition at line 380 of file ios_base.h.

const fmtflags unitbuf [static, inherited]
 

Flushes output after each output operation.

Definition at line 301 of file ios_base.h.

Referenced by std::nounitbuf(), and std::unitbuf().

const fmtflags uppercase [static, inherited]
 

in generated output.

Definition at line 305 of file ios_base.h.

Referenced by std::nouppercase(), and std::uppercase().


The documentation for this class was generated from the following file:
Generated on Wed Apr 27 18:35:37 2005 for libstdc++ source by  doxygen 1.4.2