命名空间
变体
操作

断言

来自 cppreference.com
< cpp‎ | error
定义在头文件 <cassert>
禁用的断言
(1)
#define assert(condition) ((void)0)
(直到 C++26)
#define assert(...)       ((void)0)
(自 C++26 起)
启用的断言
(2)
#define assert(condition) /* unspecified */
(直到 C++26)
#define assert(...)       /* unspecified */
(自 C++26 起)

assert 的定义依赖于另一个宏,NDEBUG,该宏没有由标准库定义。

1) 如果在源代码中包含 <cassert><assert.h> 的位置,NDEBUG 被定义为宏名称,则断言被禁用:assert 不执行任何操作。
2) 否则,断言被启用。

assert 检查其参数(必须是标量类型)是否与零比较相等。如果相等,assert 会在标准错误输出上输出实现特定的诊断信息并调用 std::abort。诊断信息需要包含 condition 的文本,以及 预定义变量 __func__ 的值,(自 C++11 起)以及 预定义宏 __FILE____LINE__ 的值。

(直到 C++26)

assert 将诊断测试放入程序中,并展开为类型为 void 的表达式。__VA_ARGS__ 被评估,并 隐式转换为 bool

  • 如果评估结果为 true,则没有其他影响。
  • 否则,断言宏的表达式会在标准错误流上创建以实现定义的格式的诊断信息,并调用 std::abort()。诊断信息包含 #__VA_ARGS__ 以及关于源文件名、源行号和封闭函数名称的信息(例如,由 std::source_location::current() 提供)。
(自 C++26 起)


表达式 assert(E) 保证是一个 常量子表达式,如果:

  • NDEBUGassert 最后定义或重新定义的位置被定义,或者
  • E隐式转换为 bool,是一个常量子表达式,其计算结果为 true
(自 C++17 起)

内容

[编辑] 参数

condition - 标量类型的表达式

[编辑] 返回值

(无)

[编辑] 注意事项

因为 assert 是一个 类函数宏,所以参数中的任何逗号(未被括号保护)都被解释为宏参数分隔符。这种逗号通常出现在模板参数列表和列表初始化中。

assert(std::is_same_v<int, int>);        // error: assert does not take two arguments
assert((std::is_same_v<int, int>));      // OK: one argument
static_assert(std::is_same_v<int, int>); // OK: not a macro
 
std::complex<double> c;
assert(c == std::complex<double>{0, 0});   // error
assert((c == std::complex<double>{0, 0})); // OK
(直到 C++26)

没有标准化的接口来添加额外的消息到 assert 错误。一个可移植的方式是使用 逗号运算符(如果它没有被 重载),或者使用 && 和字符串字面量。

assert(("There are five lights", 2 + 2 == 5));
assert(2 + 2 == 5 && "There are five lights");

Microsoft CRT 中的 assert 实现不符合 C++11 及其后续版本,因为其底层函数 (_wassert) 既不接受 __func__ 也不接受等效的替换。

尽管 C23/C++26 中 assert 的更改并非正式的缺陷报告,但 C 委员会 建议 实现将更改移植到旧模式中。

[编辑] 示例

#include <iostream>
// uncomment to disable assert()
// #define NDEBUG
#include <cassert>
 
// Use (void) to silence unused warnings.
#define assertm(exp, msg) assert(((void)msg, exp))
 
int main()
{
    assert(2 + 2 == 4);
    std::cout << "Checkpoint #1\n";
 
    assert((void("void helps to avoid 'unused value' warning"), 2 * 2 == 4));
    std::cout << "Checkpoint #2\n";
 
    assert((010 + 010 == 16) && "Yet another way to add an assert message");
    std::cout << "Checkpoint #3\n";
 
    assertm((2 + 2) % 3 == 1, "Success");
    std::cout << "Checkpoint #4\n";
 
    assertm(2 + 2 == 5, "Failed"); // assertion fails
    std::cout << "Execution continues past the last assert\n"; // No output
}

可能的输出

Checkpoint #1
Checkpoint #2
Checkpoint #3
Checkpoint #4
main.cpp:23: int main(): Assertion `((void)"Failed", 2 + 2 == 5)' failed.
Aborted

[编辑] 另请参见

static_assert 声明 (C++11) 执行编译时断言检查[编辑]
导致程序异常终止(不进行清理)
(函数) [编辑]
C 文档 for assert