Scroll to navigation

std::num_get(3) Library Functions Manual std::num_get(3)

NAME

std::num_get -

Facet for parsing number strings.

SYNOPSIS

Inherits std::locale::facet.

Public Member Functions


iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, void *&__v) const
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, bool &__v) const
num_get (size_t __refs=0)

Static Public Attributes


static locale::id id

Protected Member Functions


iter_type _M_extract_float (iter_type, iter_type, ios_base &, ios_base::iostate &, string &) const
template<typename _ValueT > iter_type _M_extract_int (iter_type, iter_type, ios_base &, ios_base::iostate &, _ValueT &) const
template<typename _CharT2 > __gnu_cxx::__enable_if<!__is_char< _CharT2 >::__value, int >::__type _M_find (const _CharT2 *__zero, size_t __len, _CharT2 __c) const
template<typename _CharT2 > __gnu_cxx::__enable_if< __is_char< _CharT2 >::__value, int >::__type _M_find (const _CharT2 *, size_t __len, _CharT2 __c) const
virtual ~num_get ()

Static Protected Member Functions


static __c_locale _S_clone_c_locale (__c_locale &__cloc)
static void _S_create_c_locale (__c_locale &__cloc, const char *__s, __c_locale __old=0)
static void _S_destroy_c_locale (__c_locale &__cloc)
static __c_locale _S_get_c_locale ()
static const char * _S_get_c_name ()

Friends


class locale::_Impl


typedef _CharT char_type
typedef _InIter iter_type
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, long double &__v) const
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, float &__v) const
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, unsigned long long &__v) const
iter_type get (iter_type __in, iter_type __end, ios_base &__io, ios_base::iostate &__err, long long &__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, unsigned int &__v) const
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, long &__v) const
virtual iter_type do_get (iter_type, iter_type, ios_base &, ios_base::iostate &__err, void *&) 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, double &) 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 __beg, iter_type __end, ios_base &__io, ios_base::iostate &__err, unsigned long long &__v) const
virtual iter_type do_get (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate &__err, long long &__v) const
virtual iter_type do_get (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate &__err, unsigned long &__v) const
virtual iter_type do_get (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate &__err, unsigned int &__v) const
virtual iter_type do_get (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate &__err, unsigned short &__v) const
virtual iter_type do_get (iter_type __beg, iter_type __end, ios_base &__io, ios_base::iostate &__err, long &__v) const
virtual iter_type do_get (iter_type, iter_type, ios_base &, ios_base::iostate &, bool &) 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 1908 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 1914 of file locale_facets.h.

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

Public typedefs.

Definition at line 1915 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 1929 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 2098 of file locale_facets.h.

Member Function Documentation

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

Public typedefs.

Definition at line 733 of file locale_facets.tcc.

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

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

Public typedefs.

Definition at line 718 of file locale_facets.tcc.

References std::basic_string< _CharT, _Traits, _Alloc >::c_str(), std::ios_base::eofbit, and std::basic_string< _CharT, _Traits, _Alloc >::reserve().

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

Public typedefs.

Definition at line 686 of file locale_facets.tcc.

References std::basic_string< _CharT, _Traits, _Alloc >::c_str(), std::ios_base::eofbit, and std::basic_string< _CharT, _Traits, _Alloc >::reserve().

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

Public typedefs.

Definition at line 671 of file locale_facets.tcc.

References std::basic_string< _CharT, _Traits, _Alloc >::c_str(), std::ios_base::eofbit, and std::basic_string< _CharT, _Traits, _Alloc >::reserve().

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

Public typedefs.

Definition at line 2192 of file locale_facets.h.

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

Public typedefs.

Definition at line 2187 of file locale_facets.h.

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

Public typedefs.

Definition at line 2181 of file locale_facets.h.

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

Public typedefs.

Definition at line 2176 of file locale_facets.h.

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

Public typedefs.

Definition at line 2171 of file locale_facets.h.

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

Public typedefs.

Definition at line 2166 of file locale_facets.h.

template<typename _CharT , typename _InIter > _InIter std::num_get< _CharT, _InIter >::do_get (iter_type __beg, iter_type __end, ios_base & __io, ios_base::iostate & __err, bool & __v) const [inline, 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 575 of file locale_facets.tcc.

References std::ios_base::_M_getloc(), std::ios_base::boolalpha, std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::flags(), and std::ios_base::goodbit.

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 interpreted 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 2092 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]

Public typedefs.

Definition at line 2060 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]

Public typedefs.

Definition at line 2055 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 interpreted 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 2050 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 long & __v) const [inline]

Public typedefs.

Definition at line 2017 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 long & __v) const [inline]

Public typedefs.

Definition at line 2012 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]

Public typedefs.

Definition at line 2006 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]

Public typedefs.

Definition at line 2001 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]

Public typedefs.

Definition at line 1996 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 interpreted 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 1991 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 1955 of file locale_facets.h.

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

Member Data Documentation

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

Numpunct facet id.

Definition at line 1919 of file locale_facets.h.

Author

Generated automatically by Doxygen for libstdc++ from the source code.

19 Jun 2018 libstdc++