num_get Class Template Reference

Facet for parsing number strings. More...

Inheritance diagram for num_get:

Inheritance graph

List of all members.

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Friends


Detailed Description

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

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

typedef _CharT char_type

Public typedefs.

Definition at line 1933 of file locale_facets.h.

typedef _InIter iter_type

Public typedefs.

Definition at line 1934 of file locale_facets.h.


Constructor & Destructor Documentation

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.

virtual ~num_get (  )  [inline, protected, virtual]

Destructor.

Definition at line 2117 of file locale_facets.h.


Member Function Documentation

_InIter do_get ( iter_type  __beg,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
void *&  __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 812 of file locale_facets.tcc.

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

_InIter do_get ( iter_type  __beg,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
long double &  __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 799 of file locale_facets.tcc.

References basic_string::c_str(), and basic_string::reserve().

_InIter do_get ( iter_type  __beg,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
double &  __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 771 of file locale_facets.tcc.

References basic_string::c_str(), and basic_string::reserve().

_InIter do_get ( iter_type  __beg,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
float &  __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 758 of file locale_facets.tcc.

References basic_string::c_str(), and basic_string::reserve().

_InIter do_get ( iter_type  __beg,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
unsigned long long &  __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 750 of file locale_facets.tcc.

_InIter do_get ( iter_type  __beg,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
long long &  __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 743 of file locale_facets.tcc.

_InIter do_get ( iter_type  __beg,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
unsigned long &  __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 735 of file locale_facets.tcc.

_InIter do_get ( iter_type  __beg,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
unsigned int &  __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 728 of file locale_facets.tcc.

_InIter do_get ( iter_type  __beg,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
unsigned short &  __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 721 of file locale_facets.tcc.

_InIter do_get ( iter_type  __beg,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
long &  __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 714 of file locale_facets.tcc.

_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 649 of file locale_facets.tcc.

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

Referenced by num_get::get().

iter_type 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 num_get::do_get().

iter_type get ( iter_type  __in,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
long double &  __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 2079 of file locale_facets.h.

References num_get::do_get().

iter_type get ( iter_type  __in,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
double &  __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 2074 of file locale_facets.h.

References num_get::do_get().

iter_type 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 num_get::do_get().

iter_type get ( iter_type  __in,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
unsigned long 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 2036 of file locale_facets.h.

References num_get::do_get().

iter_type get ( iter_type  __in,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
long 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 2031 of file locale_facets.h.

References num_get::do_get().

iter_type get ( iter_type  __in,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
unsigned 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 2025 of file locale_facets.h.

References num_get::do_get().

iter_type get ( iter_type  __in,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
unsigned int &  __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 2020 of file locale_facets.h.

References num_get::do_get().

iter_type get ( iter_type  __in,
iter_type  __end,
ios_base __io,
ios_base::iostate __err,
unsigned short &  __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 2015 of file locale_facets.h.

References num_get::do_get().

iter_type 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 num_get::do_get().

iter_type 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 num_get::do_get().

Referenced by basic_istream::operator>>().


Member Data Documentation

locale::id id [inline, 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 Dec 2 03:59:53 2008 for libstdc++ by  doxygen 1.5.7.1