SafeInt 类

扩展整数基元，有助于防止整数溢出，并便于比较不同类型的整数。

语法

template<typename T, typename E = _SAFEINT_DEFAULT_ERROR_POLICY>
class SafeInt;

参数

T
SafeInt 替换的整数或布尔参数的类型。

E
定义错误处理策略的枚举数据类型。

U
辅助操作数的整数或布尔参数的类型。

rhs
[输入] 输入参数，表示多个独立函数中的运算符的右侧值。

i
[输入] 输入参数，表示多个独立函数中的运算符的右侧值。

bits
[输入] 输入参数，表示多个独立函数中的运算符的右侧值。

成员

公共构造函数

赋值运算符

强制转换运算符

比较运算符

算术运算符

逻辑运算符

注解

SafeInt 类可防止数学运算中出现整数溢出。 例如，假设将两个 8 位整数相加：一个值为 200，另一个值为 100。 正确的数学运算是 200 + 100 = 300。 不过，由于存在 8 位整数限制，因此高位会丢失，并且编译器返回 44 (300 - 2⁸) 作为结果。 任何依赖此数学等式的运算都会生成意外行为。

SafeInt 类检查是否发生算术溢出，或代码是否尝试除以零。 在这两种情况下，此类都会调用错误处理程序，以警告程序存在潜在问题。

此类还便于比较两个不同类型的整数，只要它们是 SafeInt 对象。 通常情况下，在执行比较时，必须先将数字转换为相同类型。 将一种类型的数字强制转换为另一种类型通常需要进行检查，以确保没有数据丢失。

本主题中的“运算符”表列出了 SafeInt 类支持的数学运算符和比较运算符。 大多数数学运算符返回类型为 T 的 SafeInt 对象。

SafeInt 和整型类型之间的比较运算可以在任意一个方向上执行。 例如，SafeInt<int>(x) < y 和 y> SafeInt<int>(x) 都是有效的，返回的结果也相同。

许多二元运算符不支持使用两种不同的 SafeInt 类型。 其中一个例子就是 & 运算符。 SafeInt<T, E> & int 受支持，但 SafeInt<T, E> & SafeInt<U, E> 不支持。 在后一个示例中，编译器不知道返回什么类型的参数。 此问题的一个解决方案是，将第二个参数强制转换回基类型。 通过使用相同参数，可以借助 SafeInt<T, E> & (U)SafeInt<U, E> 完成此操作。

对于移位运算符，如果移位位数超出模板类型的现有位数，便会抛出 ASSERT 异常。 这在发布模式下不会产生任何影响。 对于移位运算符，可以混用两种类型的 SafeInt 参数，因为返回类型与原始类型相同。 运算符右侧的数字仅指明要移位的位数。

如果使用 SafeInt 对象执行逻辑比较，这严格来说是算术比较。 以下面这些表达式为例：

• SafeInt<uint>((uint)~0) > -1

• ((uint)~0) > -1

第一个语句解析为 true，第二个语句则解析为 false。 0 的按位求反结果为 0xFFFFFFFF。 在第二个语句中，默认比较运算符将 0xFFFFFFFF 与 0xFFFFFFFF 进行比较，并认为它们相等。 SafeInt 类的比较运算符了解到，第二个参数为负数，而第一个参数则无符号。 因此，尽管位表示形式完全相同，但 SafeInt 逻辑运算符了解到无符号整数大于 -1。

结合使用 SafeInt 类和 ?: 三元运算符时要谨慎。 以下面的代码行为例。

Int x = flag ? SafeInt<unsigned int>(y) : -1;

编译器将它转换为：

Int x = flag ? SafeInt<unsigned int>(y) : SafeInt<unsigned int>(-1);

如果 flag 为 false，编译器会抛出异常，而不是将值 -1 赋给 x。 因此，为了避免此行为，请使用如下正确的代码行。

Int x = flag ? (int) SafeInt<unsigned int>(y) : -1;

T 和 U 可以分配有布尔类型、字符类型或整数类型。 整数类型可以有符号，也可以无符号，且大小介于 8 位和 64 位之间。

E 是 SafeInt 使用的错误处理机制。 SafeInt 库随附了两个错误处理机制。 默认策略是 SafeIntErrorPolicy_SafeIntException，它在出错时抛出 SafeIntException 类异常。 另一个策略是 SafeIntErrorPolicy_InvalidParameter，它在出错时停止程序运行。

自定义错误策略的方法有两种。 第一种方法是，在创建 SafeInt 时设置参数 E。 如果只想更改一个 SafeInt 的错误处理策略，请使用这种方法。 另一种方法是，在添加 SafeInt 库前，将 _SAFEINT_DEFAULT_ERROR_POLICY 定义为自定义错误处理类。 若要对代码中 SafeInt 类的所有实例更改默认错误处理策略，请使用这种方法。

继承层次结构

SafeInt

要求

标头： SafeInt.hpp

示例

#include "SafeInt.hpp" // set path to your clone of the SafeInt GitHub repo (https://github.com/dcleblanc/SafeInt)

int main()
{
    int divisor = 3;
    int dividend = 6;
    int result;

    bool success = SafeDivide(dividend, divisor, result); // result = 2
    success = SafeDivide(dividend, 0, result); // expect fail. result isn't modified.
}

命名空间： 无

SafeInt::SafeInt

构造 SafeInt 对象。

SafeInt() throw

SafeInt (const T& i) throw ()

SafeInt (bool b) throw ()

template <typename U>
SafeInt (const SafeInt <U, E>& u)

I template <typename U>
SafeInt (const U& i)

参数

i
[输入] 新 SafeInt 对象的值。 这必须是 T 或 U 类型的参数，具体视构造函数而定。

b
[输入] 新 SafeInt 对象的布尔值。

u
[输入] U 类型的 SafeInt。新 SafeInt 对象的值与 u 相同，但类型为 T。

U SafeInt 中存储的数据的类型。 这可以是布尔类型、字符类型或整数类型。 如果是整数类型，它可以有符号，也可以无符号，且介于 8 位和 64 位之间。

备注

构造函数的输入参数 i 或 u 必须是布尔类型、字符类型或整数类型。 如果它是另一种类型的参数，SafeInt 类便会调用 static_assert，以指明输入参数无效。

使用模板类型 U 的构造函数自动将输入参数转换为 T 指定的类型。 SafeInt 类转换数据，而不会有任何数据丢失。 如果无法在不丢失数据的情况下将数据转换为 T 类型，它会向错误处理程序 E 报告。

如果是通过布尔参数创建 SafeInt，需要立即初始化值。 无法使用代码 SafeInt<bool> sb; 来构造 SafeInt。 这会生成编译错误。