命名空间
变体
操作

static_assert 声明 (自 C++11 起)

来自 cppreference.com
< cpp‎ | language
 
 
C++ 语言
 
 

执行编译时断言检查。

内容

[编辑] 语法

static_assert( bool-constexpr , unevaluated-string ) (1)
static_assert( bool-constexpr ) (2) (自 C++17 起)
static_assert( bool-constexpr , constant-expression ) (3) (自 C++26 起)

声明静态断言。如果断言失败,程序将形成不正确,并且可能会生成诊断错误消息。

1) 具有固定错误消息的静态断言。
2) 没有错误消息的静态断言。
3) 具有用户生成的错误消息的静态断言。
只有当语法 (1) 不匹配时,才能匹配此语法。

[编辑] 解释

bool-constexpr -

一个 上下文转换的常量表达式,类型为 bool。不允许使用内置转换,除了非缩窄 整数转换bool

(直到 C++23)

一个 上下文转换为 bool 的表达式,其中转换是 常量表达式

(自 C++23 起)
unevaluated-string - 一个 未求值的字符串字面量,它将作为错误消息显示
constant-expression - 一个 常量表达式 msg 满足以下所有条件
  • msg.size() 可以隐式转换为 std::size_t
  • msg.data() 可以隐式转换为 const char*

一个 static_assert 声明可以出现在命名空间和块 作用域(作为 块声明)中,以及类体(作为 成员声明)内部。

如果 bool-constexpr 是良构的并且求值为 true,或者是在模板定义的上下文中求值并且模板未实例化,则此声明没有效果。否则会发出编译时错误,并且如果存在用户提供的消息,则会将其包含在诊断消息中。

用户提供的消息的文本如下确定

  • 如果消息与 unevaluated-string 的语法要求匹配,则消息的文本是 unevaluated-string 的文本。
  • 否则,给定以下值
消息的文本由 len代码单元 的序列形成,从 ptr 开始,使用 普通字面量编码。对于 [0len) 中的每个整数 iptr[i] 必须是 整型常量表达式
(自 C++26 起)

[edit] 注释

标准不要求编译器打印 message 的逐字文本,尽管编译器通常会尽可能多地这样做。

由于 message 必须是字符串字面量,因此它不能包含动态信息,甚至不能包含不是字符串字面量本身的 常量表达式。特别是,它不能包含 名称模板类型参数

(直到 C++26)
特性测试宏 Std 特性
__cpp_static_assert 200410L (C++11) static_assert (语法 (1))
201411L (C++17) 单参数 static_assert (语法 (2))
202306L (C++26) 用户生成的错误消息 (语法 (3)

[edit] 关键字

static_assert

[edit] 示例

#include <format>
#include <type_traits>
 
static_assert(03301 == 1729); // since C++17 the message string is optional
 
template<class T>
void swap(T& a, T& b) noexcept
{
    static_assert(std::is_copy_constructible_v<T>,
                  "Swap requires copying");
    static_assert(std::is_nothrow_copy_constructible_v<T> &&
                  std::is_nothrow_copy_assignable_v<T>,
                  "Swap requires nothrow copy/assign");
    auto c = b;
    b = a;
    a = c;
}
 
template<class T>
struct data_structure
{
    static_assert(std::is_default_constructible_v<T>,
                  "Data structure requires default-constructible elements");
};
 
template<class>
constexpr bool dependent_false = false; // workaround before CWG2518/P2593R1
 
template<class T>
struct bad_type
{
    static_assert(dependent_false<T>, "error on instantiation, workaround");
    static_assert(false, "error on instantiation"); // OK because of CWG2518/P2593R1
};
 
struct no_copy
{
    no_copy(const no_copy&) = delete;
    no_copy() = default;
};
 
struct no_default
{
    no_default() = delete;
};
 
#if __cpp_static_assert >= 202306L
// Not real C++ yet (std::format should be constexpr to work):
static_assert(sizeof(int) == 4, std::format("Expected 4, got {}", sizeof(int)));
#endif
 
int main()
{
    int a, b;
    swap(a, b);
 
    no_copy nc_a, nc_b;
    swap(nc_a, nc_b); // 1
 
    [[maybe_unused]] data_structure<int> ds_ok;
    [[maybe_unused]] data_structure<no_default> ds_error; // 2
}

可能的输出

1: error: static assertion failed: Swap requires copying
2: error: static assertion failed: Data structure requires default-constructible elements
3: error: static assertion failed: Expected 4, got 2

[edit] 缺陷报告

以下行为更改缺陷报告被追溯应用于以前发布的 C++ 标准。

DR 应用于 已发布的行为 正确行为
CWG 2039 C++11 只有转换前的表达式需要是常量 转换也必须是
常量表达式中有效的
CWG 2518
(P2593R1)
C++11 未实例化的 static_assert(false, ""); 非法 变为合法

[edit] 参考文献

  • C++23 标准 (ISO/IEC 14882:2024)
  • 9.1 前言 [dcl.pre] (p: 10)
  • C++20 标准 (ISO/IEC 14882:2020)
  • 9.1 前言 [dcl.pre] (p: 6)
  • C++17 标准 (ISO/IEC 14882:2017)
  • 10 声明 [dcl.dcl] (p: 6)
  • C++14 标准 (ISO/IEC 14882:2014)
  • 7 声明 [dcl.dcl] (p: 4)
  • C++11 标准 (ISO/IEC 14882:2011)
  • 7 声明 [dcl.dcl] (p: 4)

[edit] 参见

显示给定的错误消息并使程序非法
(预处理指令)[edit]
如果用户指定的条件不是 true,则中止程序。可以在发布版本中禁用。
(函数宏) [edit]
(C++11)
有条件地 移除 函数重载或模板特化以进行重载解析
(类模板) [edit]
类型特征 (C++11) 定义基于模板的编译时接口以查询类型的属性
C 文档 for 静态断言