std::num_get

std::num_get< _CharT, _InIter > Class Template Reference

Facet for parsing number strings. More...

#include <locale_facets.h>

Inheritance diagram for std::num_get< _CharT, _InIter >:

std::locale::facet List of all members.

Public Types

typedef _CharT char_type
 Public typedefs.
typedef _InIter iter_type

Public Member Functions

 num_get (size_t __refs=0)
 Constructor performs initialization.
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, bool &__v) const
 Numeric parsing.
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, void *&__v) const
 Numeric parsing.
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, long &__v) const
 Numeric parsing.
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, unsigned short &__v) const
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, unsigned int &__v) const
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, unsigned long &__v) const
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, float &__v) const
 Numeric parsing.
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, double &__v) const
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, long double &__v) const

Static Public Attributes

static locale::id id
 Numpunct facet id.

Protected Member Functions

virtual ~num_get ()
 Destructor.
iter_type _M_extract_float (iter_type, iter_type, ios_base &, ios_base::iostate &, string &__xtrc) const
template<typename _ValueT>
iter_type _M_extract_int (iter_type, iter_type, ios_base &, ios_base::iostate &, _ValueT &__v) const
virtual iter_type do_get (iter_type, iter_type, ios_base &, ios_base::iostate &, bool &) const
 Numeric parsing.
virtual iter_type do_get (iter_type, iter_type, ios_base &, ios_base::iostate &, long &) const
virtual iter_type do_get (iter_type, iter_type, ios_base &, ios_base::iostate &__err, unsigned short &) const
virtual iter_type do_get (iter_type, iter_type, ios_base &, ios_base::iostate &__err, unsigned int &) const
virtual iter_type do_get (iter_type, iter_type, ios_base &, ios_base::iostate &__err, unsigned long &) const
virtual iter_type do_get (iter_type, iter_type, ios_base &, ios_base::iostate &__err, float &) const
virtual iter_type do_get (iter_type, iter_type, ios_base &, ios_base::iostate &__err, double &) const
virtual iter_type do_get (iter_type, iter_type, ios_base &, ios_base::iostate &__err, long double &) const
virtual iter_type do_get (iter_type, iter_type, ios_base &, ios_base::iostate &__err, void *&) const

Detailed Description

template<typename _CharT, typename _InIter>
class std::num_get< _CharT, _InIter >

Facet for parsing number strings.

This facet encapsulates the code to parse and return a number from a string. It is used by the istream numeric extraction operators.

The num_get template uses protected virtual functions to provide the actual results. The public accessors forward the call to the virtual functions. These virtual functions are hooks for developers to implement the behavior they require from the num_get facet.

Definition at line 1927 of file locale_facets.h.

Member Typedef Documentation

template<typename _CharT, typename _InIter>
typedef _CharT std::num_get< _CharT, _InIter >::char_type

Public typedefs.

Definition at line 1933 of file locale_facets.h.

template<typename _CharT, typename _InIter>
typedef _InIter std::num_get< _CharT, _InIter >::iter_type

Definition at line 1934 of file locale_facets.h.

Constructor & Destructor Documentation

template<typename _CharT, typename _InIter>
std::num_get< _CharT, _InIter >::num_get ( size_t  __refs = 0  )  [inline, explicit]

Constructor performs initialization.

This is the constructor provided by the standard.

Parameters:
refs Passed to the base facet class.

Definition at line 1948 of file locale_facets.h.

template<typename _CharT, typename _InIter>
virtual std::num_get< _CharT, _InIter >::~num_get (  )  [inline, protected, virtual]

Destructor.

Definition at line 2117 of file locale_facets.h.

Member Function Documentation

template<typename _CharT, typename _InIter>
_GLIBCXX_BEGIN_LDBL_NAMESPACE _InIter std::num_get< _CharT, _InIter >::_M_extract_float ( iter_type  ,
iter_type  ,
ios_base &  ,
ios_base::iostate &  ,
string &  __xtrc 
) const [protected]

Definition at line 280 of file locale_facets.tcc.

References std::__verify_grouping(), std::ios_base::_M_getloc(), std::__num_base::_S_atoms_in, std::__num_base::_S_iE, std::__num_base::_S_ie, std::__num_base::_S_iminus, std::__num_base::_S_iplus, std::__num_base::_S_izero, std::basic_string< _CharT, _Traits, _Alloc >::clear(), std::ios_base::eofbit, std::ios_base::failbit, std::find(), std::basic_string< _CharT, _Traits, _Alloc >::reserve(), and std::basic_string< _CharT, _Traits, _Alloc >::size().

Referenced by std::num_get< _CharT, _InIter >::do_get().

template<typename _CharT, typename _InIter>
template<typename _ValueT>
_GLIBCXX_BEGIN_LDBL_NAMESPACE _InIter std::num_get< _CharT, _InIter >::_M_extract_int ( iter_type  ,
iter_type  ,
ios_base &  ,
ios_base::iostate &  ,
_ValueT &  __v 
) const [protected]

Definition at line 473 of file locale_facets.tcc.

References std::__verify_grouping(), std::ios_base::_M_getloc(), std::__num_base::_S_iend, std::__num_base::_S_iminus, std::__num_base::_S_iplus, std::__num_base::_S_iX, std::__num_base::_S_ix, std::__num_base::_S_izero, std::ios_base::basefield, std::ios_base::eofbit, std::ios_base::failbit, std::find(), std::ios_base::flags(), std::ios_base::hex, std::max(), std::min(), std::ios_base::oct, std::basic_string< _CharT, _Traits, _Alloc >::reserve(), and std::basic_string< _CharT, _Traits, _Alloc >::size().

Referenced by std::num_get< _CharT, _InIter >::do_get().

template<typename _CharT, typename _InIter>
_InIter std::num_get< _CharT, _InIter >::do_get ( iter_type  ,
iter_type  ,
ios_base &  ,
ios_base::iostate &  __err,
void *&   
) const [protected, virtual]

Definition at line 812 of file locale_facets.tcc.

References std::num_get< _CharT, _InIter >::_M_extract_int(), std::ios_base::basefield, std::ios_base::failbit, std::ios_base::flags(), and std::ios_base::hex.

template<typename _CharT, typename _InIter>
_InIter std::num_get< _CharT, _InIter >::do_get ( iter_type  ,
iter_type  ,
ios_base &  ,
ios_base::iostate &  __err,
long double &   
) const [protected, virtual]

Definition at line 799 of file locale_facets.tcc.

References std::__convert_to_v(), std::num_get< _CharT, _InIter >::_M_extract_float(), std::locale::facet::_S_get_c_locale(), std::basic_string< _CharT, _Traits, _Alloc >::c_str(), and std::basic_string< _CharT, _Traits, _Alloc >::reserve().

template<typename _CharT, typename _InIter>
_InIter std::num_get< _CharT, _InIter >::do_get ( iter_type  ,
iter_type  ,
ios_base &  ,
ios_base::iostate &  __err,
double &   
) const [protected, virtual]

Definition at line 771 of file locale_facets.tcc.

References std::__convert_to_v(), std::num_get< _CharT, _InIter >::_M_extract_float(), std::locale::facet::_S_get_c_locale(), std::basic_string< _CharT, _Traits, _Alloc >::c_str(), and std::basic_string< _CharT, _Traits, _Alloc >::reserve().

template<typename _CharT, typename _InIter>
_InIter std::num_get< _CharT, _InIter >::do_get ( iter_type  ,
iter_type  ,
ios_base &  ,
ios_base::iostate &  __err,
float &   
) const [protected, virtual]

Definition at line 758 of file locale_facets.tcc.

References std::__convert_to_v(), std::num_get< _CharT, _InIter >::_M_extract_float(), std::locale::facet::_S_get_c_locale(), std::basic_string< _CharT, _Traits, _Alloc >::c_str(), and std::basic_string< _CharT, _Traits, _Alloc >::reserve().

template<typename _CharT, typename _InIter>
_InIter std::num_get< _CharT, _InIter >::do_get ( iter_type  ,
iter_type  ,
ios_base &  ,
ios_base::iostate &  __err,
unsigned long &   
) const [protected, virtual]

Definition at line 735 of file locale_facets.tcc.

References std::num_get< _CharT, _InIter >::_M_extract_int().

template<typename _CharT, typename _InIter>
_InIter std::num_get< _CharT, _InIter >::do_get ( iter_type  ,
iter_type  ,
ios_base &  ,
ios_base::iostate &  __err,
unsigned int &   
) const [protected, virtual]

Definition at line 728 of file locale_facets.tcc.

References std::num_get< _CharT, _InIter >::_M_extract_int().

template<typename _CharT, typename _InIter>
_InIter std::num_get< _CharT, _InIter >::do_get ( iter_type  ,
iter_type  ,
ios_base &  ,
ios_base::iostate &  __err,
unsigned short &   
) const [protected, virtual]

Definition at line 721 of file locale_facets.tcc.

References std::num_get< _CharT, _InIter >::_M_extract_int().

template<typename _CharT, typename _InIter>
_InIter std::num_get< _CharT, _InIter >::do_get ( iter_type  ,
iter_type  ,
ios_base &  ,
ios_base::iostate &  ,
long &   
) const [protected, virtual]

Definition at line 714 of file locale_facets.tcc.

References std::num_get< _CharT, _InIter >::_M_extract_int().

template<typename _CharT, typename _InIter>
_InIter std::num_get< _CharT, _InIter >::do_get ( iter_type  ,
iter_type  ,
ios_base &  ,
ios_base::iostate &  ,
bool &   
) const [protected, virtual]

Numeric parsing.

Parses the input stream into the variable v. This function is a hook for derived classes to change the value returned.

See also:
get() for more details.
Parameters:
in Start of input stream.
end End of input stream.
io Source of locale and flags.
err Error flags to set.
v Value to format and insert.
Returns:
Iterator after reading.

Definition at line 649 of file locale_facets.tcc.

References std::num_get< _CharT, _InIter >::_M_extract_int(), std::ios_base::_M_getloc(), std::ios_base::boolalpha, std::ios_base::eofbit, std::ios_base::failbit, and std::ios_base::flags().

Referenced by std::num_get< _CharT, _InIter >::get().

template<typename _CharT, typename _InIter>
iter_type std::num_get< _CharT, _InIter >::get ( iter_type  __in,
iter_type  __end,
ios_base &  __io,
ios_base::iostate &  __err,
void *&  __v 
) const [inline]

Numeric parsing.

Parses the input stream into the pointer variable v. It does so by calling num_get::do_get().

The input characters are parsed like the scanf p specifier.

Digit grouping is intrepreted according to numpunct::grouping() and numpunct::thousands_sep(). If the pattern of digit groups isn't consistent, sets err to ios_base::failbit.

Note that the digit grouping effect for pointers is a bit ambiguous in the standard and shouldn't be relied on. See DR 344.

If parsing the string yields a valid value for v, v is set. Otherwise, sets err to ios_base::failbit and leaves v unaltered. Sets err to ios_base::eofbit if the stream is emptied.

Parameters:
in Start of input stream.
end End of input stream.
io Source of locale and flags.
err Error flags to set.
v Value to format and insert.
Returns:
Iterator after reading.

Definition at line 2111 of file locale_facets.h.

References std::num_get< _CharT, _InIter >::do_get().

template<typename _CharT, typename _InIter>
iter_type std::num_get< _CharT, _InIter >::get ( iter_type  __in,
iter_type  __end,
ios_base &  __io,
ios_base::iostate &  __err,
long double &  __v 
) const [inline]

Definition at line 2079 of file locale_facets.h.

References std::num_get< _CharT, _InIter >::do_get().

template<typename _CharT, typename _InIter>
iter_type std::num_get< _CharT, _InIter >::get ( iter_type  __in,
iter_type  __end,
ios_base &  __io,
ios_base::iostate &  __err,
double &  __v 
) const [inline]

Definition at line 2074 of file locale_facets.h.

References std::num_get< _CharT, _InIter >::do_get().

template<typename _CharT, typename _InIter>
iter_type std::num_get< _CharT, _InIter >::get ( iter_type  __in,
iter_type  __end,
ios_base &  __io,
ios_base::iostate &  __err,
float &  __v 
) const [inline]

Numeric parsing.

Parses the input stream into the integral variable v. It does so by calling num_get::do_get().

The input characters are parsed like the scanf g specifier. The matching type length modifier is also used.

The decimal point character used is numpunct::decimal_point(). Digit grouping is intrepreted according to numpunct::grouping() and numpunct::thousands_sep(). If the pattern of digit groups isn't consistent, sets err to ios_base::failbit.

If parsing the string yields a valid value for v, v is set. Otherwise, sets err to ios_base::failbit and leaves v unaltered. Sets err to ios_base::eofbit if the stream is emptied.

Parameters:
in Start of input stream.
end End of input stream.
io Source of locale and flags.
err Error flags to set.
v Value to format and insert.
Returns:
Iterator after reading.

Definition at line 2069 of file locale_facets.h.

References std::num_get< _CharT, _InIter >::do_get().

template<typename _CharT, typename _InIter>
iter_type std::num_get< _CharT, _InIter >::get ( iter_type  __in,
iter_type  __end,
ios_base &  __io,
ios_base::iostate &  __err,
unsigned long &  __v 
) const [inline]

Definition at line 2025 of file locale_facets.h.

References std::num_get< _CharT, _InIter >::do_get().

template<typename _CharT, typename _InIter>
iter_type std::num_get< _CharT, _InIter >::get ( iter_type  __in,
iter_type  __end,
ios_base &  __io,
ios_base::iostate &  __err,
unsigned int &  __v 
) const [inline]

Definition at line 2020 of file locale_facets.h.

References std::num_get< _CharT, _InIter >::do_get().

template<typename _CharT, typename _InIter>
iter_type std::num_get< _CharT, _InIter >::get ( iter_type  __in,
iter_type  __end,
ios_base &  __io,
ios_base::iostate &  __err,
unsigned short &  __v 
) const [inline]

Definition at line 2015 of file locale_facets.h.

References std::num_get< _CharT, _InIter >::do_get().

template<typename _CharT, typename _InIter>
iter_type std::num_get< _CharT, _InIter >::get ( iter_type  __in,
iter_type  __end,
ios_base &  __io,
ios_base::iostate &  __err,
long &  __v 
) const [inline]

Numeric parsing.

Parses the input stream into the integral variable v. It does so by calling num_get::do_get().

Parsing is affected by the flag settings in io.

The basic parse is affected by the value of io.flags() & ios_base::basefield. If equal to ios_base::oct, parses like the scanf o specifier. Else if equal to ios_base::hex, parses like X specifier. Else if basefield equal to 0, parses like the i specifier. Otherwise, parses like d for signed and u for unsigned types. The matching type length modifier is also used.

Digit grouping is intrepreted according to numpunct::grouping() and numpunct::thousands_sep(). If the pattern of digit groups isn't consistent, sets err to ios_base::failbit.

If parsing the string yields a valid value for v, v is set. Otherwise, sets err to ios_base::failbit and leaves v unaltered. Sets err to ios_base::eofbit if the stream is emptied.

Parameters:
in Start of input stream.
end End of input stream.
io Source of locale and flags.
err Error flags to set.
v Value to format and insert.
Returns:
Iterator after reading.

Definition at line 2010 of file locale_facets.h.

References std::num_get< _CharT, _InIter >::do_get().

template<typename _CharT, typename _InIter>
iter_type std::num_get< _CharT, _InIter >::get ( iter_type  __in,
iter_type  __end,
ios_base &  __io,
ios_base::iostate &  __err,
bool &  __v 
) const [inline]

Numeric parsing.

Parses the input stream into the bool v. It does so by calling num_get::do_get().

If ios_base::boolalpha is set, attempts to read ctype<CharT>::truename() or ctype<CharT>::falsename(). Sets v to true or false if successful. Sets err to ios_base::failbit if reading the string fails. Sets err to ios_base::eofbit if the stream is emptied.

If ios_base::boolalpha is not set, proceeds as with reading a long, except if the value is 1, sets v to true, if the value is 0, sets v to false, and otherwise set err to ios_base::failbit.

Parameters:
in Start of input stream.
end End of input stream.
io Source of locale and flags.
err Error flags to set.
v Value to format and insert.
Returns:
Iterator after reading.

Definition at line 1974 of file locale_facets.h.

References std::num_get< _CharT, _InIter >::do_get().

Referenced by std::basic_istream< _CharT, _Traits >::operator>>().

Member Data Documentation

template<typename _CharT, typename _InIter>
locale::id std::num_get< _CharT, _InIter >::id [static]

Numpunct facet id.

Definition at line 1938 of file locale_facets.h.

The documentation for this class was generated from the following files:
Generated on Tue Feb 2 16:59:00 2010 for GNU C++ STL by  doxygen 1.4.7