libstdc++
std::basic_fstream< _CharT, _Traits > Class Template Reference
Inheritance diagram for std::basic_fstream< _CharT, _Traits >:
[legend]

Public Types

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

Public Member Functions

 basic_fstream ()
 
 basic_fstream (const char *__s, ios_base::openmode __mode=ios_base::in|ios_base::out)
 
 basic_fstream (const std::string &__s, ios_base::openmode __mode=ios_base::in|ios_base::out)
 
 basic_fstream (const basic_fstream &)=delete
 
 basic_fstream (basic_fstream &&__rhs)
 
 ~basic_fstream ()
 
template<typename _ValueT >
basic_istream< _CharT, _Traits > & _M_extract (_ValueT &__v)
 
const locale_M_getloc () const
 
template<typename _ValueT >
basic_ostream< _CharT, _Traits > & _M_insert (_ValueT __v)
 
void _M_setstate (iostate __state)
 
bool bad () const
 
void clear (iostate __state=goodbit)
 
void close ()
 
basic_ioscopyfmt (const basic_ios &__rhs)
 
bool eof () const
 
iostate exceptions () const
 
void exceptions (iostate __except)
 
bool fail () const
 
char_type fill () const
 
char_type fill (char_type __ch)
 
fmtflags flags () const
 
fmtflags flags (fmtflags __fmtfl)
 
__ostream_typeflush ()
 
streamsize gcount () const
 
template<>
basic_istream< char > & getline (char_type *__s, streamsize __n, char_type __delim)
 
template<>
basic_istream< wchar_t > & getline (char_type *__s, streamsize __n, char_type __delim)
 
locale getloc () const
 
bool good () const
 
template<>
basic_istream< char > & ignore (streamsize __n)
 
template<>
basic_istream< char > & ignore (streamsize __n, int_type __delim)
 
template<>
basic_istream< wchar_t > & ignore (streamsize __n)
 
template<>
basic_istream< wchar_t > & ignore (streamsize __n, int_type __delim)
 
locale imbue (const locale &__loc)
 
bool is_open ()
 
bool is_open () const
 
long & iword (int __ix)
 
char narrow (char_type __c, char __dfault) const
 
void open (const char *__s, ios_base::openmode __mode=ios_base::in|ios_base::out)
 
void open (const std::string &__s, ios_base::openmode __mode=ios_base::in|ios_base::out)
 
__ostream_typeoperator<< (const void *__p)
 
__ostream_typeoperator<< (__streambuf_type *__sb)
 
basic_fstreamoperator= (const basic_fstream &)=delete
 
basic_fstreamoperator= (basic_fstream &&__rhs)
 
__istream_typeoperator>> (void *&__p)
 
__istream_typeoperator>> (__streambuf_type *__sb)
 
streamsize precision () const
 
streamsize precision (streamsize __prec)
 
void *& pword (int __ix)
 
basic_streambuf< _CharT, _Traits > * rdbuf (basic_streambuf< _CharT, _Traits > *__sb)
 
__filebuf_typerdbuf () const
 
iostate rdstate () const
 
void register_callback (event_callback __fn, int __index)
 
__ostream_typeseekp (pos_type)
 
__ostream_typeseekp (off_type, ios_base::seekdir)
 
fmtflags setf (fmtflags __fmtfl)
 
fmtflags setf (fmtflags __fmtfl, fmtflags __mask)
 
void setstate (iostate __state)
 
void swap (basic_fstream &__rhs)
 
pos_type tellp ()
 
basic_ostream< _CharT, _Traits > * tie () const
 
basic_ostream< _CharT, _Traits > * tie (basic_ostream< _CharT, _Traits > *__tiestr)
 
void unsetf (fmtflags __mask)
 
char_type widen (char __c) const
 
streamsize width () const
 
streamsize width (streamsize __wide)
 
__istream_typeoperator>> (__istream_type &(*__pf)(__istream_type &))
 
__istream_typeoperator>> (__ios_type &(*__pf)(__ios_type &))
 
__istream_typeoperator>> (ios_base &(*__pf)(ios_base &))
 
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) and the original exception will be rethrown if badbit is set in the exceptions mask.

__istream_typeoperator>> (bool &__n)
 
__istream_typeoperator>> (short &__n)
 
__istream_typeoperator>> (unsigned short &__n)
 
__istream_typeoperator>> (int &__n)
 
__istream_typeoperator>> (unsigned int &__n)
 
__istream_typeoperator>> (long &__n)
 
__istream_typeoperator>> (unsigned long &__n)
 
__istream_typeoperator>> (long long &__n)
 
__istream_typeoperator>> (unsigned long long &__n)
 
__istream_typeoperator>> (float &__f)
 
__istream_typeoperator>> (double &__f)
 
__istream_typeoperator>> (long double &__f)
 
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) and the original exception will be rethrown if badbit is set in the exceptions mask.

int_type get ()
 
__istream_typeget (char_type &__c)
 
__istream_typeget (char_type *__s, streamsize __n, char_type __delim)
 
__istream_typeget (char_type *__s, streamsize __n)
 
__istream_typeget (__streambuf_type &__sb, char_type __delim)
 
__istream_typeget (__streambuf_type &__sb)
 
__istream_typegetline (char_type *__s, streamsize __n, char_type __delim)
 
__istream_typegetline (char_type *__s, streamsize __n)
 
__istream_typeignore (streamsize __n, int_type __delim)
 
__istream_typeignore (streamsize __n)
 
__istream_typeignore ()
 
int_type peek ()
 
__istream_typeread (char_type *__s, streamsize __n)
 
streamsize readsome (char_type *__s, streamsize __n)
 
__istream_typeputback (char_type __c)
 
__istream_typeunget ()
 
int sync ()
 
pos_type tellg ()
 
__istream_typeseekg (pos_type)
 
__istream_typeseekg (off_type, ios_base::seekdir)
 
 operator bool () const
 
bool operator! () const
 
__ostream_typeoperator<< (__ostream_type &(*__pf)(__ostream_type &))
 
__ostream_typeoperator<< (__ios_type &(*__pf)(__ios_type &))
 
__ostream_typeoperator<< (ios_base &(*__pf)(ios_base &))
 
Inserters

All the operator<< functions (aka formatted output functions) have some common behavior. Each starts by constructing a temporary object of type std::basic_ostream::sentry. This can have several effects, concluding with the setting of a status flag; see the sentry documentation for more.

If the sentry status is good, the function tries to generate whatever data is appropriate for the type of the argument.

If an exception is thrown during insertion, ios_base::badbit will be turned on in the stream's error state without causing an ios_base::failure to be thrown. The original exception will then be rethrown.

__ostream_typeoperator<< (long __n)
 
__ostream_typeoperator<< (unsigned long __n)
 
__ostream_typeoperator<< (bool __n)
 
__ostream_typeoperator<< (short __n)
 
__ostream_typeoperator<< (unsigned short __n)
 
__ostream_typeoperator<< (int __n)
 
__ostream_typeoperator<< (unsigned int __n)
 
__ostream_typeoperator<< (long long __n)
 
__ostream_typeoperator<< (unsigned long long __n)
 
__ostream_typeoperator<< (double __f)
 
__ostream_typeoperator<< (float __f)
 
__ostream_typeoperator<< (long double __f)
 
Unformatted Output Functions

All the unformatted output functions have some common behavior. Each starts by constructing a temporary object of type std::basic_ostream::sentry. This has several effects, concluding with the setting of a status flag; see the sentry documentation for more.

If the sentry status is good, the function tries to generate whatever data is appropriate for the type of the argument.

If an exception is thrown during insertion, ios_base::badbit will be turned on in the stream's error state. If badbit is on in the stream's exceptions mask, the exception will be rethrown without completing its actions.

__ostream_typeput (char_type __c)
 
void _M_write (const char_type *__s, streamsize __n)
 
__ostream_typewrite (const char_type *__s, streamsize __n)
 

Static Public Member Functions

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

Static Public Attributes

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

Protected Types

enum  { _S_local_word_size }
 

Protected Member Functions

void _M_cache_locale (const locale &__loc)
 
void _M_call_callbacks (event __ev) throw ()
 
void _M_dispose_callbacks (void) throw ()
 
template<typename _ValueT >
__istream_type_M_extract (_ValueT &__v)
 
_Words & _M_grow_words (int __index, bool __iword)
 
void _M_init () throw ()
 
template<typename _ValueT >
__ostream_type_M_insert (_ValueT __v)
 
void _M_move (ios_base &) noexcept
 
void _M_swap (ios_base &__rhs) noexcept
 
void init (basic_streambuf< _CharT, _Traits > *__sb)
 
void move (basic_ios &__rhs)
 
void move (basic_ios &&__rhs)
 
void set_rdbuf (basic_streambuf< _CharT, _Traits > *__sb)
 
void swap (basic_ostream &__rhs)
 
void swap (basic_ios &__rhs) noexcept
 
void swap (basic_istream &__rhs)
 
void swap (basic_iostream &__rhs)
 

Protected Attributes

_Callback_list * _M_callbacks
 
const __ctype_type_M_ctype
 
iostate _M_exception
 
char_type _M_fill
 
bool _M_fill_init
 
fmtflags _M_flags
 
streamsize _M_gcount
 
locale _M_ios_locale
 
_Words _M_local_word [_S_local_word_size]
 
const __num_get_type_M_num_get
 
const __num_put_type_M_num_put
 
streamsize _M_precision
 
basic_streambuf< _CharT, _Traits > * _M_streambuf
 
iostate _M_streambuf_state
 
basic_ostream< _CharT, _Traits > * _M_tie
 
streamsize _M_width
 
_Words * _M_word
 
int _M_word_size
 
_Words _M_word_zero
 

Detailed Description

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

Controlling input and output for files.

Template Parameters
_CharTType of character stream.
_TraitsTraits for character type, defaults to char_traits<_CharT>.

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

Member Typedef Documentation

◆ __num_put_type

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

These are non-standard types.

Definition at line 89 of file basic_ios.h.

◆ event_callback

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

The type of an event callback function.

Parameters
__eOne of the members of the event enum.
__bReference to the ios_base object.
__iThe 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 506 of file ios_base.h.

◆ fmtflags

typedef _Ios_Fmtflags std::ios_base::fmtflags
inherited

This is a bitmask type.

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

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

Definition at line 323 of file ios_base.h.

◆ iostate

typedef _Ios_Iostate std::ios_base::iostate
inherited

This is a bitmask type.

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

  • badbit
  • eofbit
  • failbit
  • goodbit

Definition at line 398 of file ios_base.h.

◆ openmode

typedef _Ios_Openmode std::ios_base::openmode
inherited

This is a bitmask type.

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

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

Definition at line 429 of file ios_base.h.

◆ seekdir

typedef _Ios_Seekdir std::ios_base::seekdir
inherited

This is an enumerated type.

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

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

Definition at line 461 of file ios_base.h.

Member Enumeration Documentation

◆ event

enum std::ios_base::event
inherited

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

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

Definition at line 489 of file ios_base.h.

Constructor & Destructor Documentation

◆ basic_fstream() [1/3]

template<typename _CharT , typename _Traits >
std::basic_fstream< _CharT, _Traits >::basic_fstream ( )
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 1043 of file fstream.

◆ basic_fstream() [2/3]

template<typename _CharT , typename _Traits >
std::basic_fstream< _CharT, _Traits >::basic_fstream ( const char *  __s,
ios_base::openmode  __mode = ios_base::in | ios_base::out 
)
inlineexplicit

Create an input/output file stream.

Parameters
__sNull terminated string specifying the filename.
__modeOpen file in specified mode (see std::ios_base).

Definition at line 1053 of file fstream.

◆ basic_fstream() [3/3]

template<typename _CharT , typename _Traits >
std::basic_fstream< _CharT, _Traits >::basic_fstream ( const std::string __s,
ios_base::openmode  __mode = ios_base::in | ios_base::out 
)
inlineexplicit

Create an input/output file stream.

Parameters
__sNull terminated string specifying the filename.
__modeOpen file in specified mode (see std::ios_base).

Definition at line 1083 of file fstream.

◆ ~basic_fstream()

template<typename _CharT , typename _Traits >
std::basic_fstream< _CharT, _Traits >::~basic_fstream ( )
inline

The destructor does nothing.

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

Definition at line 1118 of file fstream.

Member Function Documentation

◆ _M_getloc()

◆ _M_write()

template<typename _CharT, typename _Traits>
void std::basic_ostream< _CharT, _Traits >::_M_write ( const char_type *  __s,
streamsize  __n 
)
inlineinherited

Core write functionality, without sentry.

Parameters
__sThe array to insert.
__nMaximum number of characters to insert.

Definition at line 317 of file ostream.

◆ bad()

template<typename _CharT, typename _Traits>
bool std::basic_ios< _CharT, _Traits >::bad ( ) const
inlineinherited

Fast error checking.

Returns
True if the badbit is set.

Note that other iostate flags may also be set.

Definition at line 211 of file basic_ios.h.

◆ clear()

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

[Re]sets the error state.

Parameters
__stateThe 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 41 of file basic_ios.tcc.

Referenced by std::basic_ios< char, _Traits >::exceptions(), std::__detail::operator>>(), std::basic_istream< char >::putback(), std::basic_istream< char >::seekg(), std::basic_ios< char, _Traits >::setstate(), and std::basic_istream< char >::unget().

◆ close()

template<typename _CharT , typename _Traits >
void std::basic_fstream< _CharT, _Traits >::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 1253 of file fstream.

◆ copyfmt()

template<typename _CharT , typename _Traits >
basic_ios< _CharT, _Traits > & std::basic_ios< _CharT, _Traits >::copyfmt ( const basic_ios< _CharT, _Traits > &  __rhs)
inherited

Copies fields of __rhs into this.

Parameters
__rhsThe 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 63 of file basic_ios.tcc.

◆ eof()

template<typename _CharT, typename _Traits>
bool std::basic_ios< _CharT, _Traits >::eof ( ) const
inlineinherited

Fast error checking.

Returns
True if the eofbit is set.

Note that other iostate flags may also be set.

Definition at line 190 of file basic_ios.h.

◆ exceptions() [1/2]

template<typename _CharT, typename _Traits>
iostate std::basic_ios< _CharT, _Traits >::exceptions ( ) const
inlineinherited

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 222 of file basic_ios.h.

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

◆ exceptions() [2/2]

template<typename _CharT, typename _Traits>
void std::basic_ios< _CharT, _Traits >::exceptions ( iostate  __except)
inlineinherited

Throwing exceptions on errors.

Parameters
__exceptThe new exceptions mask.

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

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

#include <iostream>
#include <fstream>
#include <exception>
int main()
{
std::set_terminate (__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 257 of file basic_ios.h.

◆ fail()

template<typename _CharT, typename _Traits>
bool std::basic_ios< _CharT, _Traits >::fail ( ) const
inlineinherited

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 201 of file basic_ios.h.

Referenced by std::basic_ios< char, _Traits >::operator bool(), std::basic_ios< char, _Traits >::operator!(), and std::regex_traits< _CharType >::value().

◆ fill() [1/2]

template<typename _CharT, typename _Traits>
char_type std::basic_ios< _CharT, _Traits >::fill ( ) const
inlineinherited

Retrieves the empty character.

Returns
The current fill character.

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

Definition at line 370 of file basic_ios.h.

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

◆ fill() [2/2]

template<typename _CharT, typename _Traits>
char_type std::basic_ios< _CharT, _Traits >::fill ( char_type  __ch)
inlineinherited

Sets a new empty character.

Parameters
__chThe 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 390 of file basic_ios.h.

◆ flags() [1/2]

fmtflags std::ios_base::flags ( ) const
inlineinherited

◆ flags() [2/2]

fmtflags std::ios_base::flags ( fmtflags  __fmtfl)
inlineinherited

Setting new format flags all at once.

Parameters
__fmtflThe new flags to set.
Returns
The previous format control flags.

This function overwrites all the format flags with __fmtfl.

Definition at line 637 of file ios_base.h.

◆ flush()

template<typename _CharT , typename _Traits >
basic_ostream< _CharT, _Traits > & std::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 211 of file ostream.tcc.

◆ gcount()

template<typename _CharT, typename _Traits>
streamsize std::basic_istream< _CharT, _Traits >::gcount ( ) const
inlineinherited

Character counting.

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

Definition at line 269 of file istream.

◆ get() [1/6]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits >::int_type std::basic_istream< _CharT, _Traits >::get ( void  )
inherited

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 244 of file istream.tcc.

◆ get() [2/6]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::get ( char_type &  __c)
inherited

Simple extraction.

Parameters
__cThe 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 280 of file istream.tcc.

◆ get() [3/6]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::get ( char_type *  __s,
streamsize  __n,
char_type  __delim 
)
inherited

Simple multiple-character extraction.

Parameters
__sPointer to an array.
__nMaximum number of characters to store in __s.
__delimA "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 317 of file istream.tcc.

◆ get() [4/6]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::get ( char_type *  __s,
streamsize  __n 
)
inlineinherited

Simple multiple-character extraction.

Parameters
__sPointer to an array.
__nMaximum number of characters to store in s.
Returns
*this

Returns get(__s,__n,widen('\n')).

Definition at line 354 of file istream.

◆ get() [5/6]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::get ( __streambuf_type __sb,
char_type  __delim 
)
inherited

Extraction into another streambuf.

Parameters
__sbA streambuf in which to store data.
__delimA "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 364 of file istream.tcc.

◆ get() [6/6]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::get ( __streambuf_type __sb)
inlineinherited

Extraction into another streambuf.

Parameters
__sbA streambuf in which to store data.
Returns
*this

Returns get(__sb,widen('\n')).

Definition at line 387 of file istream.

◆ getline() [1/3]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::getline ( char_type *  __s,
streamsize  __n,
char_type  __delim 
)
inherited

String extraction.

Parameters
__sA character array in which to store the data.
__nMaximum number of characters to extract.
__delimA "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 408 of file istream.tcc.

◆ getline() [2/3]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::getline ( char_type *  __s,
streamsize  __n 
)
inlineinherited

String extraction.

Parameters
__sA character array in which to store the data.
__nMaximum number of characters to extract.
Returns
*this

Returns getline(__s,__n,widen('\n')).

Definition at line 427 of file istream.

◆ getline() [3/3]

template<>
basic_istream< char > & std::basic_istream< char >::getline ( char_type *  __s,
streamsize  __n,
char_type  __delim 
)
inherited

Explicit specialization declarations, defined in src/istream.cc.

◆ getloc()

locale std::ios_base::getloc ( ) const
inlineinherited

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

Referenced by std::basic_ios< char, _Traits >::copyfmt(), std::money_put< _CharT, _OutIter >::do_put(), and std::ws().

◆ good()

template<typename _CharT, typename _Traits>
bool std::basic_ios< _CharT, _Traits >::good ( ) const
inlineinherited

Fast error checking.

Returns
True if no error flags are set.

A wrapper around rdstate.

Definition at line 180 of file basic_ios.h.

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

◆ ignore() [1/3]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::ignore ( streamsize  __n,
int_type  __delim 
)
inherited

Discarding characters.

Parameters
__nNumber of characters to discard.
__delimA "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().

NB: Provide three overloads, instead of the single function (with defaults) mandated by the Standard: this leads to a better performing implementation, while still conforming to the Standard.

Definition at line 563 of file istream.tcc.

◆ ignore() [2/3]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::ignore ( streamsize  __n)
inherited

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 501 of file istream.tcc.

◆ ignore() [3/3]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::ignore ( void  )
inherited

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 468 of file istream.tcc.

◆ imbue()

template<typename _CharT , typename _Traits >
locale std::basic_ios< _CharT, _Traits >::imbue ( const locale __loc)
inherited

Moves to a new locale.

Parameters
__locThe new locale.
Returns
The previous locale.

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

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

Definition at line 114 of file basic_ios.tcc.

◆ init()

template<typename _CharT, typename _Traits>
void std::basic_ios< _CharT, _Traits >::init ( basic_streambuf< _CharT, _Traits > *  __sb)
protectedinherited

All setup is performed here.

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

Definition at line 126 of file basic_ios.tcc.

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

◆ is_open()

template<typename _CharT , typename _Traits >
bool std::basic_fstream< _CharT, _Traits >::is_open ( )
inline

Wrapper to test for an open file.

Returns
rdbuf()->is_open()

Definition at line 1159 of file fstream.

◆ iword()

long& std::ios_base::iword ( int  __ix)
inlineinherited

Access to integer array.

Parameters
__ixIndex 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 816 of file ios_base.h.

◆ narrow()

template<typename _CharT, typename _Traits>
char std::basic_ios< _CharT, _Traits >::narrow ( char_type  __c,
char  __dfault 
) const
inlineinherited

Squeezes characters.

Parameters
__cThe character to narrow.
__dfaultThe character to narrow.
Returns
The narrowed character.

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

Returns the result of

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

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

Definition at line 430 of file basic_ios.h.

◆ open() [1/2]

template<typename _CharT , typename _Traits >
void std::basic_fstream< _CharT, _Traits >::open ( const char *  __s,
ios_base::openmode  __mode = ios_base::in | ios_base::out 
)
inline

Opens an external file.

Parameters
__sThe name of the file.
__modeThe open mode flags.

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

Definition at line 1177 of file fstream.

◆ open() [2/2]

template<typename _CharT , typename _Traits >
void std::basic_fstream< _CharT, _Traits >::open ( const std::string __s,
ios_base::openmode  __mode = ios_base::in | ios_base::out 
)
inline

Opens an external file.

Parameters
__sThe name of the file.
__modeThe open mode flags.

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

Definition at line 1218 of file fstream.

◆ operator bool()

template<typename _CharT, typename _Traits>
std::basic_ios< _CharT, _Traits >::operator bool ( ) const
inlineexplicitinherited

The quick-and-easy status check.

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

Definition at line 117 of file basic_ios.h.

◆ operator!()

template<typename _CharT, typename _Traits>
bool std::basic_ios< _CharT, _Traits >::operator! ( ) const
inlineinherited

The quick-and-easy status check.

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

Definition at line 125 of file basic_ios.h.

◆ operator<<() [1/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( __ostream_type &(*)(__ostream_type &)  __pf)
inlineinherited

Interface for manipulators.

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

Definition at line 108 of file ostream.

◆ operator<<() [2/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( __ios_type &(*)(__ios_type &)  __pf)
inlineinherited

Interface for manipulators.

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

Definition at line 117 of file ostream.

◆ operator<<() [3/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( ios_base &(*)(ios_base &)  __pf)
inlineinherited

Interface for manipulators.

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

Definition at line 127 of file ostream.

◆ operator<<() [4/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( long  __n)
inlineinherited

Integer arithmetic inserters.

Parameters
__nA variable of builtin integral type.
Returns
*this if successful

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

Definition at line 166 of file ostream.

◆ operator<<() [5/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( unsigned long  __n)
inlineinherited

Integer arithmetic inserters.

Parameters
__nA variable of builtin integral type.
Returns
*this if successful

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

Definition at line 170 of file ostream.

◆ operator<<() [6/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( bool  __n)
inlineinherited

Integer arithmetic inserters.

Parameters
__nA variable of builtin integral type.
Returns
*this if successful

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

Definition at line 174 of file ostream.

◆ operator<<() [7/17]

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

Integer arithmetic inserters.

Parameters
__nA variable of builtin integral type.
Returns
*this if successful

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

Definition at line 92 of file ostream.tcc.

◆ operator<<() [8/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( unsigned short  __n)
inlineinherited

Integer arithmetic inserters.

Parameters
__nA variable of builtin integral type.
Returns
*this if successful

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

Definition at line 181 of file ostream.

◆ operator<<() [9/17]

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

Integer arithmetic inserters.

Parameters
__nA variable of builtin integral type.
Returns
*this if successful

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

Definition at line 106 of file ostream.tcc.

◆ operator<<() [10/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( unsigned int  __n)
inlineinherited

Integer arithmetic inserters.

Parameters
__nA variable of builtin integral type.
Returns
*this if successful

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

Definition at line 192 of file ostream.

◆ operator<<() [11/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( long long  __n)
inlineinherited

Integer arithmetic inserters.

Parameters
__nA variable of builtin integral type.
Returns
*this if successful

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

Definition at line 201 of file ostream.

◆ operator<<() [12/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( unsigned long long  __n)
inlineinherited

Integer arithmetic inserters.

Parameters
__nA variable of builtin integral type.
Returns
*this if successful

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

Definition at line 205 of file ostream.

◆ operator<<() [13/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( double  __f)
inlineinherited

Floating point arithmetic inserters.

Parameters
__fA variable of builtin floating point type.
Returns
*this if successful

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

Definition at line 220 of file ostream.

◆ operator<<() [14/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( float  __f)
inlineinherited

Floating point arithmetic inserters.

Parameters
__fA variable of builtin floating point type.
Returns
*this if successful

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

Definition at line 224 of file ostream.

◆ operator<<() [15/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( long double  __f)
inlineinherited

Floating point arithmetic inserters.

Parameters
__fA variable of builtin floating point type.
Returns
*this if successful

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

Definition at line 232 of file ostream.

◆ operator<<() [16/17]

template<typename _CharT, typename _Traits>
__ostream_type& std::basic_ostream< _CharT, _Traits >::operator<< ( const void *  __p)
inlineinherited

Pointer arithmetic inserters.

Parameters
__pA variable of pointer type.
Returns
*this if successful

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

Definition at line 245 of file ostream.

◆ operator<<() [17/17]

template<typename _CharT , typename _Traits >
basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< ( __streambuf_type __sb)
inherited

Extracting from another streambuf.

Parameters
__sbA 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 120 of file ostream.tcc.

◆ operator>>() [1/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( __istream_type &(*)(__istream_type &)  __pf)
inlineinherited

Interface for manipulators.

Manipulators 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 120 of file istream.

◆ operator>>() [2/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( __ios_type &(*)(__ios_type &)  __pf)
inlineinherited

Interface for manipulators.

Manipulators 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 124 of file istream.

◆ operator>>() [3/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( ios_base &(*)(ios_base &)  __pf)
inlineinherited

Interface for manipulators.

Manipulators 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 131 of file istream.

◆ operator>>() [4/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( bool &  __n)
inlineinherited

Integer arithmetic extractors.

Parameters
__nA variable of builtin integral 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 168 of file istream.

◆ operator>>() [5/17]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::operator>> ( short &  __n)
inherited

Integer arithmetic extractors.

Parameters
__nA variable of builtin integral 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 122 of file istream.tcc.

◆ operator>>() [6/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( unsigned short &  __n)
inlineinherited

Integer arithmetic extractors.

Parameters
__nA variable of builtin integral 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 175 of file istream.

◆ operator>>() [7/17]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::operator>> ( int &  __n)
inherited

Integer arithmetic extractors.

Parameters
__nA variable of builtin integral 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 167 of file istream.tcc.

◆ operator>>() [8/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( unsigned int &  __n)
inlineinherited

Integer arithmetic extractors.

Parameters
__nA variable of builtin integral 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 182 of file istream.

◆ operator>>() [9/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( long &  __n)
inlineinherited

Integer arithmetic extractors.

Parameters
__nA variable of builtin integral 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 186 of file istream.

◆ operator>>() [10/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( unsigned long &  __n)
inlineinherited

Integer arithmetic extractors.

Parameters
__nA variable of builtin integral 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 190 of file istream.

◆ operator>>() [11/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( long long &  __n)
inlineinherited

Integer arithmetic extractors.

Parameters
__nA variable of builtin integral 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 195 of file istream.

◆ operator>>() [12/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( unsigned long long &  __n)
inlineinherited

Integer arithmetic extractors.

Parameters
__nA variable of builtin integral 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 199 of file istream.

◆ operator>>() [13/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( float &  __f)
inlineinherited

Floating point arithmetic extractors.

Parameters
__fA variable of builtin floating point 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 214 of file istream.

◆ operator>>() [14/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( double &  __f)
inlineinherited

Floating point arithmetic extractors.

Parameters
__fA variable of builtin floating point 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 218 of file istream.

◆ operator>>() [15/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( long double &  __f)
inlineinherited

Floating point arithmetic extractors.

Parameters
__fA variable of builtin floating point 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 222 of file istream.

◆ operator>>() [16/17]

template<typename _CharT, typename _Traits>
__istream_type& std::basic_istream< _CharT, _Traits >::operator>> ( void *&  __p)
inlineinherited

Basic arithmetic extractors.

Parameters
__pA variable of pointer 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 235 of file istream.

◆ operator>>() [17/17]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::operator>> ( __streambuf_type __sb)
inherited

Extracting into another streambuf.

Parameters
__sbA 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 212 of file istream.tcc.

◆ peek()

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits >::int_type std::basic_istream< _CharT, _Traits >::peek ( void  )
inherited

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 628 of file istream.tcc.

◆ precision() [1/2]

streamsize std::ios_base::precision ( ) const
inlineinherited

Flags access.

Returns
The precision to generate on certain output operations.

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

Definition at line 696 of file ios_base.h.

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

◆ precision() [2/2]

streamsize std::ios_base::precision ( streamsize  __prec)
inlineinherited

Changing flags.

Parameters
__precThe new precision value.
Returns
The previous value of precision().

Definition at line 705 of file ios_base.h.

◆ put()

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

Simple insertion.

Parameters
__cThe character to insert.
Returns
*this

Tries to insert __c.

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

Definition at line 149 of file ostream.tcc.

◆ putback()

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::putback ( char_type  __c)
inherited

Unextracting a single character.

Parameters
__cThe 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
This function first clears eofbit. Since no characters are extracted, the next call to gcount() will return 0, as required by DR 60.

Definition at line 719 of file istream.tcc.

◆ pword()

void*& std::ios_base::pword ( int  __ix)
inlineinherited

Access to void pointer array.

Parameters
__ixIndex 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 837 of file ios_base.h.

◆ rdbuf() [1/2]

template<typename _CharT, typename _Traits>
basic_streambuf< _CharT, _Traits > * std::basic_ios< _CharT, _Traits >::rdbuf ( basic_streambuf< _CharT, _Traits > *  __sb)
inherited

Changing the underlying buffer.

Parameters
__sbThe 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 53 of file basic_ios.tcc.

◆ rdbuf() [2/2]

template<typename _CharT , typename _Traits >
__filebuf_type* std::basic_fstream< _CharT, _Traits >::rdbuf ( ) const
inline

Accessing the underlying buffer.

Returns
The current basic_filebuf buffer.

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

Definition at line 1151 of file fstream.

◆ rdstate()

template<typename _CharT, typename _Traits>
iostate std::basic_ios< _CharT, _Traits >::rdstate ( ) const
inlineinherited

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 137 of file basic_ios.h.

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

◆ read()

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::read ( char_type *  __s,
streamsize  __n 
)
inherited

Extraction without delimiters.

Parameters
__sA character array.
__nMaximum 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 658 of file istream.tcc.

◆ readsome()

template<typename _CharT , typename _Traits >
streamsize std::basic_istream< _CharT, _Traits >::readsome ( char_type *  __s,
streamsize  __n 
)
inherited

Extraction until the buffer is exhausted, but no more.

Parameters
__sA character array.
__nMaximum 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 687 of file istream.tcc.

◆ register_callback()

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

Add the callback __fn with parameter __index.

Parameters
__fnThe function to add.
__indexThe 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.

◆ seekg() [1/2]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::seekg ( pos_type  __pos)
inherited

Changing the current read position.

Parameters
__posA file position object.
Returns
*this

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

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

Definition at line 853 of file istream.tcc.

◆ seekg() [2/2]

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::seekg ( off_type  __off,
ios_base::seekdir  __dir 
)
inherited

Changing the current read position.

Parameters
__offA file offset object.
__dirThe 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 first clears eofbit. It 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.

◆ seekp() [1/2]

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

Changing the current write position.

Parameters
__posA file position object.
Returns
*this

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

Definition at line 258 of file ostream.tcc.

◆ seekp() [2/2]

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

Changing the current write position.

Parameters
__offA file offset object.
__dirThe 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 290 of file ostream.tcc.

◆ setf() [1/2]

fmtflags std::ios_base::setf ( fmtflags  __fmtfl)
inlineinherited

Setting new format flags.

Parameters
__fmtflAdditional 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 653 of file ios_base.h.

Referenced by std::__detail::operator>>().

◆ setf() [2/2]

fmtflags std::ios_base::setf ( fmtflags  __fmtfl,
fmtflags  __mask 
)
inlineinherited

Setting new format flags.

Parameters
__fmtflAdditional flags to set.
__maskThe 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 670 of file ios_base.h.

◆ setstate()

template<typename _CharT, typename _Traits>
void std::basic_ios< _CharT, _Traits >::setstate ( iostate  __state)
inlineinherited

Sets additional flags in the error state.

Parameters
__stateThe additional state flag(s) to set.

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

Definition at line 157 of file basic_ios.h.

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

◆ sync()

template<typename _CharT , typename _Traits >
int std::basic_istream< _CharT, _Traits >::sync ( void  )
inherited

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 789 of file istream.tcc.

◆ sync_with_stdio()

static bool std::ios_base::sync_with_stdio ( bool  __sync = true)
staticinherited

Interaction with the standard C I/O objects.

Parameters
__syncWhether 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 https://gcc.gnu.org/onlinedocs/libstdc++/manual/fstreams.html#std.io.filestreams.binary

◆ tellg()

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits >::pos_type std::basic_istream< _CharT, _Traits >::tellg ( void  )
inherited

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(). At variance with putback, unget and seekg, eofbit is not cleared first.

Definition at line 825 of file istream.tcc.

◆ tellp()

template<typename _CharT , typename _Traits >
basic_ostream< _CharT, _Traits >::pos_type std::basic_ostream< _CharT, _Traits >::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 237 of file ostream.tcc.

◆ tie() [1/2]

template<typename _CharT, typename _Traits>
basic_ostream<_CharT, _Traits>* std::basic_ios< _CharT, _Traits >::tie ( ) const
inlineinherited

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 295 of file basic_ios.h.

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

◆ tie() [2/2]

template<typename _CharT, typename _Traits>
basic_ostream<_CharT, _Traits>* std::basic_ios< _CharT, _Traits >::tie ( basic_ostream< _CharT, _Traits > *  __tiestr)
inlineinherited

Ties this stream to an output stream.

Parameters
__tiestrThe 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 307 of file basic_ios.h.

◆ unget()

template<typename _CharT , typename _Traits >
basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::unget ( void  )
inherited

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
This function first clears eofbit. Since no characters are extracted, the next call to gcount() will return 0, as required by DR 60.

Definition at line 754 of file istream.tcc.

Referenced by std::__detail::operator>>().

◆ unsetf()

void std::ios_base::unsetf ( fmtflags  __mask)
inlineinherited

Clearing format flags.

Parameters
__maskThe flags to unset.

This function clears __mask in the format flags.

Definition at line 685 of file ios_base.h.

◆ widen()

template<typename _CharT, typename _Traits>
char_type std::basic_ios< _CharT, _Traits >::widen ( char  __c) const
inlineinherited

Widens characters.

Parameters
__cThe character to widen.
Returns
The widened character.

Maps a character of char to a character of char_type.

Returns the result of

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

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

Definition at line 449 of file basic_ios.h.

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

◆ width() [1/2]

streamsize std::ios_base::width ( ) const
inlineinherited

Flags access.

Returns
The minimum field width to generate on output operations.

Minimum field width refers to the number of characters.

Definition at line 719 of file ios_base.h.

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

◆ width() [2/2]

streamsize std::ios_base::width ( streamsize  __wide)
inlineinherited

Changing flags.

Parameters
__wideThe new width value.
Returns
The previous value of width().

Definition at line 728 of file ios_base.h.

◆ write()

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

Character string insertion.

Parameters
__sThe array to insert.
__nMaximum 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 183 of file ostream.tcc.

◆ xalloc()

static int std::ios_base::xalloc ( )
throw (
)
staticinherited

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

◆ _M_gcount

template<typename _CharT, typename _Traits>
streamsize std::basic_istream< _CharT, _Traits >::_M_gcount
protectedinherited

◆ adjustfield

const fmtflags std::ios_base::adjustfield
staticinherited

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

Definition at line 378 of file ios_base.h.

Referenced by std::num_put< _CharT, _OutIter >::do_put(), std::internal(), std::left(), and std::right().

◆ app

const openmode std::ios_base::app
staticinherited

Seek to end before each write.

Definition at line 432 of file ios_base.h.

◆ ate

const openmode std::ios_base::ate
staticinherited

Open and seek to end immediately after opening.

Definition at line 435 of file ios_base.h.

◆ badbit

const iostate std::ios_base::badbit
staticinherited

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

Definition at line 402 of file ios_base.h.

Referenced by std::basic_ios< char, _Traits >::bad(), std::basic_ios< char, _Traits >::fail(), and std::operator<<().

◆ basefield

const fmtflags std::ios_base::basefield
staticinherited

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

Definition at line 381 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::oct(), and std::basic_ostream< char >::operator<<().

◆ beg

const seekdir std::ios_base::beg
staticinherited

Request a seek relative to the beginning of the stream.

Definition at line 464 of file ios_base.h.

◆ binary

const openmode std::ios_base::binary
staticinherited

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

Definition at line 440 of file ios_base.h.

◆ boolalpha

const fmtflags std::ios_base::boolalpha
staticinherited

Insert/extract bool in alphabetic rather than numeric format.

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

◆ cur

const seekdir std::ios_base::cur
staticinherited

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

Definition at line 467 of file ios_base.h.

Referenced by std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff().

◆ dec

const fmtflags std::ios_base::dec
staticinherited

Converts integer input or generates integer output in decimal base.

Definition at line 329 of file ios_base.h.

Referenced by std::dec().

◆ end

const seekdir std::ios_base::end
staticinherited

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

Definition at line 470 of file ios_base.h.

Referenced by std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff().

◆ eofbit

◆ failbit

const iostate std::ios_base::failbit
staticinherited

◆ fixed

const fmtflags std::ios_base::fixed
staticinherited

Generate floating-point output in fixed-point notation.

Definition at line 332 of file ios_base.h.

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

◆ floatfield

const fmtflags std::ios_base::floatfield
staticinherited

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

Definition at line 384 of file ios_base.h.

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

◆ goodbit

◆ hex

const fmtflags std::ios_base::hex
staticinherited

Converts integer input or generates integer output in hexadecimal base.

Definition at line 335 of file ios_base.h.

Referenced by std::num_get< _CharT, _InIter >::do_get(), std::num_put< _CharT, _OutIter >::do_put(), std::hex(), and std::basic_ostream< char >::operator<<().

◆ in

const openmode std::ios_base::in
staticinherited

◆ internal

const fmtflags std::ios_base::internal
staticinherited

Adds fill characters at a designated internal point in certain generated output, or identical to right if no such point is designated.

Definition at line 340 of file ios_base.h.

Referenced by std::internal().

◆ left

const fmtflags std::ios_base::left
staticinherited

Adds fill characters on the right (final positions) of certain generated output. (I.e., the thing you print is flush left.)

Definition at line 344 of file ios_base.h.

Referenced by std::num_put< _CharT, _OutIter >::do_put(), and std::left().

◆ oct

const fmtflags std::ios_base::oct
staticinherited

Converts integer input or generates integer output in octal base.

Definition at line 347 of file ios_base.h.

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

◆ out

const openmode std::ios_base::out
staticinherited

Open for output. Default for ofstream and fstream.

Definition at line 446 of file ios_base.h.

Referenced by std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), and std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos().

◆ right

const fmtflags std::ios_base::right
staticinherited

Adds fill characters on the left (initial positions) of certain generated output. (I.e., the thing you print is flush right.)

Definition at line 351 of file ios_base.h.

Referenced by std::right().

◆ scientific

const fmtflags std::ios_base::scientific
staticinherited

Generates floating-point output in scientific notation.

Definition at line 354 of file ios_base.h.

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

◆ showbase

const fmtflags std::ios_base::showbase
staticinherited

Generates a prefix indicating the numeric base of generated integer output.

Definition at line 358 of file ios_base.h.

Referenced by std::num_put< _CharT, _OutIter >::do_put(), std::noshowbase(), and std::showbase().

◆ showpoint

const fmtflags std::ios_base::showpoint
staticinherited

Generates a decimal-point character unconditionally in generated floating-point output.

Definition at line 362 of file ios_base.h.

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

◆ showpos

const fmtflags std::ios_base::showpos
staticinherited

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

Definition at line 365 of file ios_base.h.

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

◆ skipws

const fmtflags std::ios_base::skipws
staticinherited

Skips leading white space before certain input operations.

Definition at line 368 of file ios_base.h.

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

◆ trunc

const openmode std::ios_base::trunc
staticinherited

Truncate an existing stream when opening. Default for ofstream.

Definition at line 449 of file ios_base.h.

◆ unitbuf

const fmtflags std::ios_base::unitbuf
staticinherited

Flushes output after each output operation.

Definition at line 371 of file ios_base.h.

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

◆ uppercase

const fmtflags std::ios_base::uppercase
staticinherited

Replaces certain lowercase letters with their uppercase equivalents in generated output.

Definition at line 375 of file ios_base.h.

Referenced by std::num_put< _CharT, _OutIter >::do_put(), std::nouppercase(), and std::uppercase().


The documentation for this class was generated from the following file: