命名空间
变体
操作

std::num_get<CharT,InputIt>::get, std::num_get<CharT,InputIt>::do_get

来自 cppreference.cn
< cpp‎ | locale‎ | num get
 
C++
 
文本处理库
 
本地化库
 
std::num_get
成员函数
num_get::getnum_get::do_get
 
(1)
public:

iter_type get( iter_type in, iter_type end, std::ios_base& str,

               std::ios_base::iostate& err, bool& v ) const;
iter_type get( iter_type in, iter_type end, std::ios_base& str,
               std::ios_base::iostate& err, long& v ) const;
iter_type get( iter_type in, iter_type end, std::ios_base& str,
               std::ios_base::iostate& err, long long& v ) const;
 (C++11 起)
iter_type get( iter_type in, iter_type end, std::ios_base& str,
               std::ios_base::iostate& err, unsigned short& v ) const;
iter_type get( iter_type in, iter_type end, std::ios_base& str,
               std::ios_base::iostate& err, unsigned int& v ) const;
iter_type get( iter_type in, iter_type end, std::ios_base& str,
               std::ios_base::iostate& err, unsigned long& v ) const;
iter_type get( iter_type in, iter_type end, std::ios_base& str,
               std::ios_base::iostate& err, unsigned long long& v ) const;
 (C++11 起)
iter_type get( iter_type in, iter_type end, std::ios_base& str,
               std::ios_base::iostate& err, float& v ) const;
iter_type get( iter_type in, iter_type end, std::ios_base& str,
               std::ios_base::iostate& err, double& v ) const;
iter_type get( iter_type in, iter_type end, std::ios_base& str,
               std::ios_base::iostate& err, long double& v ) const;
iter_type get( iter_type in, iter_type end, std::ios_base& str,
               std::ios_base::iostate& err, void*& v ) const;
(2)
protected:

virtual iter_type do_get( iter_type in, iter_type end, std::ios_base& str,

                          std::ios_base::iostate& err, bool& v ) const;
virtual iter_type do_get( iter_type in, iter_type end, std::ios_base& str,
                          std::ios_base::iostate& err, long& v ) const;
virtual iter_type do_get( iter_type in, iter_type end, std::ios_base& str,
                          std::ios_base::iostate& err, long long& v ) const;
 (C++11 起)
virtual iter_type do_get( iter_type in, iter_type end, std::ios_base& str,
                          std::ios_base::iostate& err, unsigned short& v ) const;
virtual iter_type do_get( iter_type in, iter_type end, std::ios_base& str,
                          std::ios_base::iostate& err, unsigned int& v ) const;
virtual iter_type do_get( iter_type in, iter_type end, std::ios_base& str,
                          std::ios_base::iostate& err, unsigned long& v ) const;
virtual iter_type do_get( iter_type in, iter_type end, std::ios_base& str,

                          std::ios_base::iostate& err,

                          unsigned long long& v ) const;
 (C++11 起)
virtual iter_type do_get( iter_type in, iter_type end, std::ios_base& str,
                          std::ios_base::iostate& err, float& v ) const;
virtual iter_type do_get( iter_type in, iter_type end, std::ios_base& str,
                          std::ios_base::iostate& err, double& v ) const;
virtual iter_type do_get( iter_type in, iter_type end, std::ios_base& str,
                          std::ios_base::iostate& err, long double& v ) const;
virtual iter_type do_get( iter_type in, iter_type end, std::ios_base& str,
                          std::ios_base::iostate& err, void*& v ) const;
1) 公有成员函数，调用最派生类的成员函数 do_get。
2) 从输入迭代器 in 读取字符并生成 v 类型的值，同时考虑来自 str.flags() 的 I/O 流格式化标志、来自 std::use_facet<std::ctype<CharT>>(str.getloc()) 的字符分类规则以及来自 std::use_facet<std::numpunct<CharT>>(str.getloc()) 的数字标点字符。所有格式化输入流运算符（例如 std::cin >> n;）都会调用此函数。

转换分三个阶段进行

目录

[编辑] 阶段 1：转换说明符选择

  • 获取 I/O 格式标志，如同通过以下方式：
fmtflags basefield = (str.flags() & std::ios_base::basefield);
fmtflags boolalpha = (str.flags() & std::ios_base::boolalpha);
  • 如果 v 的类型是整数类型，则选择以下五个选项中第一个适用的：
如果 basefield == oct，将使用转换说明符 %o
如果 basefield == hex，将使用转换说明符 %X
如果 basefield == 0，将使用转换说明符 %i
如果 v 的类型是有符号的，将使用转换说明符 %d
如果 v 的类型是无符号的，将使用转换说明符 %u
  • 对于整数类型，如果需要，向转换规范添加长度修饰符：h 表示 short 和 unsigned short，l 表示 long 和 unsigned long，ll 表示 long long 和 unsigned long long(C++11 起)
  • 如果 v 的类型是 float，将使用转换说明符 %g
  • 如果 v 的类型是 double，将使用转换说明符 %lg
  • 如果 v 的类型是 long double，将使用转换说明符 %Lg
  • 如果 v 的类型是 void*，将使用转换说明符 %p
  • 如果 v 的类型是 bool 且 boolalpha == 0，则按 v 的类型为 long 进行处理，除了在阶段 3 中存储到 v 中的值。
  • 如果 v 的类型是 bool 且 boolalpha != 0，则以下内容替换阶段 2 和 3
    • 从输入迭代器 in 获取的连续字符与从 std::use_facet<std::numpunct<CharT>>(str.getloc()).falsename() 和 std::use_facet<std::numpunct<CharT>>(str.getloc()).truename() 获取的字符序列进行匹配，仅在必要时才进行唯一匹配。输入迭代器 in 仅在需要获取字符时才与 end 进行比较。
    • 如果目标序列被唯一匹配，则 v 被设置为相应的 bool 值。否则，false 存储在 v 中，且 std::ios_base::failbit 被分配给 err。如果在输入结束前（in == end）未能找到唯一匹配，则执行 err |= std::ios_base::eofbit。

[编辑] 阶段 2：字符提取

  • 如果 in == end，阶段 2 立即终止，不再提取任何字符。
  • 从 in 提取下一个字符，如同通过 char_type ct = *in;
    • 如果字符匹配 "0123456789abcdefxABCDEFX+-"(C++11 前)"0123456789abcdefpxABCDEFPX+-"(C++11 起) 中的一个，并被拓宽为语言环境的 char_type，如同通过 std::use_facet<std::ctype<CharT>>(str.getloc()).widen()，则它被转换为相应的 char。
    • 如果字符匹配小数点分隔符（std::use_facet<std::numpunct<CharT>>(str.getloc()).decimal_point())），则将其替换为 '.'。
    • 如果字符匹配千位分隔符（std::use_facet<std::numpunct<CharT>>(str.getloc()).thousands_sep()）并且正在使用千位分隔符（由 std::use_facet<std::numpunct<CharT>>(str.getloc()).grouping().length() != 0 确定），则如果尚未累积小数点 '.'，则记住字符的位置，但字符被忽略。如果小数点已累积，则字符被丢弃，阶段 2 终止。
    • 在任何情况下，都会检查从上一步获得的 char 是否允许在给定阶段 1 中选择的转换说明符的情况下由 std::scanf 解析的输入字段中。如果允许，则将其累积到临时缓冲区中，并重复阶段 2。如果不允许，则阶段 2 终止。

[编辑] 阶段 3：转换和存储

  • 阶段 2 中累积的 char 序列被转换为数值
输入根据 std::scanf 的规则进行解析。
 (C++11 前)
输入被解析，如同通过以下方式：
(C++11 起)
  • 如果转换函数未能转换整个字段，则值 ​0​ 存储在 v 中。
  • 如果 v 的类型是有符号整数类型，并且转换函数产生的值太大或太小而无法容纳，则分别将最大正值或负值存储在 v 中。
  • 如果 v 的类型是无符号整数类型，并且转换函数产生的值不适合，则将最大可表示值存储在 v 中。
  • 在任何情况下，如果转换函数失败，std::ios_base::failbit 将被分配给 err。
  • 否则，转换的数值结果存储在 v 中。
    • 如果 v 的类型是 bool 且 boolalpha 未设置，则如果存储的值为 ​0​，则存储 false；如果存储的值为 1，则存储 true；对于任何其他值，std::ios_base::failbit 被分配给 err，并且存储 true。
  • 此后，检查数字分组。如果阶段 2 中丢弃的任何千位分隔符的位置与 std::use_facet<std::numpunct<CharT>>(str.getloc()).grouping() 提供​​的分组不匹配，则 std::ios_base::failbit 被分配给 err。
  • 如果阶段 2 因测试 in == end 而终止，则执行 err |= std::ios_base::eofbit 以设置 eof 位。

[编辑] 返回值

in

[编辑] 注

在 LWG issue 23 和 LWG issue 696 解决之前，如果发生错误，v 保持不变。

在 LWG issue 221 解决之前，表示十六进制整数的字符串（例如 "0xA0"）会被 do_get(int) 拒绝，即使它们是 strtol 的有效输入，因为阶段 2 会过滤掉字符 'X' 和 'x'。

在 LWG issue 1169 解决之前，将负数字符串转换为无符号整数可能会产生零（因为字符串表示的值小于目标类型可以表示的值）。

在 LWG issue 2381 解决之前，表示带指数的十六进制浮点数（例如 "0x1.23p-10"）的字符串会被 do_get(double) 拒绝，即使它们是 strtod 的有效输入，因为阶段 2 会过滤掉字符 'P' 和 'p'。

表示无穷大或非数字的字符串（例如 "NaN" 和 "inf"）会被 do_get(double) 拒绝，即使它们是 strtod 的有效输入，因为阶段 2 会过滤掉诸如 'N' 或 'i' 等字符。

 (C++11 起)

[编辑] 示例

为用户定义类型实现 operator>>。

运行此代码
#include <iostream>
#include <iterator>
#include <locale>
 
struct base { long x; };
 
template<class CharT, class Traits>
std::basic_istream<CharT, Traits>&
    operator >>(std::basic_istream<CharT, Traits>& is, base& b)
{
    std::ios_base::iostate err = std::ios_base::goodbit;
 
    try // setting err could throw
    {
        typename std::basic_istream<CharT, Traits>::sentry s(is);
 
        if (s) // if stream is ready for input
            std::use_facet<std::num_get<CharT>>(is.getloc()).get(is, {}, is, err, b.x);
    }
    catch (std::ios_base::failure& error)
    {
        // handle the exception
    }
 
    return is;
}
 
int main()
{
    base b;
    std::cin >> b;
}

[编辑] 缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 发布时的行为 正确的行为
LWG 17 C++98 解析文本布尔值的过程是错误的 已更正
LWG 18 C++98 缺少采用 bool& 值的 get 重载 已添加
LWG 23 C++98 溢出输入导致未定义行为 处理溢出
LWG 154 C++98 double 的转换说明符是 %g（与 float 相同） 改为 %lg
LWG 221 C++98 do_get 不解析 'x' 和 'X'，而 strtol 解析它们 使 'x' 和 'X' 被解析
LWG 275 C++98 get 有一个采用 short& 值而不是 float& 的重载 已更正
LWG 358 C++98 小数点后的千位分隔符被忽略 如果遇到，阶段 2 终止
LWG 696 C++98 转换失败时结果不变 设置为零
LWG 1169 C++98 浮点类型之间的溢出处理不一致 已使其保持一致
与 strtof/strtod
LWG 2381 C++11 do_get 不解析 'p' 和 'P'，而 strtod 解析它们 使 'p' 和 'P' 被解析

[编辑] 另请参阅

 提取格式化数据
(std::basic_istream<CharT,Traits> 的公有成员函数) [编辑]
取自 "https://cppreference.cn/mwiki/index.php?title=cpp/locale/num_get/get&oldid=160184"