C++17:static_assert实现
admin
2024-01-22 00:10:57
0

引言

static_assert是从C++0x开始引入的关键字,static_assert可让编译器在编译时进行断言检查。static_assert的语法格式:

static_assert( constant-expression, string-literal ); // C++11 
static_assert( constant-expression ); // C++17
  • constant-expression
    可转换为布尔值的整型常量表达式。 如果计算出的表达式为零 (false),则显示 string-literal 参数,并且编译失败,并出现错误。 如果表达式不为零 (true),则 static_assert 声明无效。
  • string-literal
    当 constant-expression 参数为零时显示的消息。 该消息是编译器的基本字符集中的一个字符串(不是多字节或宽字符)。C++ 17前需要的constant-expression消息参数,C++17变成可选。意味着C++17以后static_assert声明不再需要第二个参数。

static_assert中文译为静态断言,此名称是相对与assert而言的,assert中文译为断言或动态断言。C++0x之前没有动态断言和静态断言之分,因为C++98仅支持assert这一种断言方式。

static_assert(sizeof(void *) == 4, "64-bit code generation is not supported.");

assert为C++98从C语言继承而来的断言方式,assert的定义即语法格式(Visual Studio 2022):

#ifdef NDEBUG#define assert(expression) ((void)0)#else_ACRTIMP void __cdecl _wassert(_In_z_ wchar_t const* _Message,_In_z_ wchar_t const* _File,_In_   unsigned       _Line);#define assert(expression) (void)(                                                       \(!!(expression)) ||                                                              \(_wassert(_CRT_WIDE(#expression), _CRT_WIDE(__FILE__), (unsigned)(__LINE__)), 0) \)#endif

当未定义 NDEBUG 时,C 运行库的发布版本和调试版本中均启用了 assert 宏。 定义时 NDEBUG ,该宏可用,但不会评估其参数,并且不起作用。 启用后assert 宏会调用 _wassert 用于实现。此定义巧妙的利用C语言的||短路求值特性,只有expression为false,_wassert才会运行并抛出错误结束进程,否则_wassert不会运行,就不会抛出错误。

assert(std::is_same_v);   // Error: assert 不接收二个参数
assert((std::is_same_v)); // OK: 一个参数
std::complex c;
assert(c == std::complex{0, 0}); // Error: assert 不接收二个参数
assert((c == std::complex{0, 0})); // OK: 一个参数

为何引入assert_assert

也许现在的你和我最初的想法一样,认为assert_assert很多余。我们带着这个疑问,看看下面这个案例。

案例:某家公司的一个app需要Microsoft,Google和Phone设备3种联系人读取,在最初1.0版本时,他们仅支持Microsoft和Phone设备两种方式的联系人读取;从2.0开始他们开始支持Google联系人的读取。

  • 1.0版本App
enum ContactType
{MICROSOFT,  // 微软联系人 PHONE,      // 本地手机联系人ALL         // 所有联系人
};// 本地文件名称
static const std::string LOCAL_FILE_NAME = "contact_type.txt";// 读取操作
typedef bool (*readOperator)();  // 读取Microsoft
bool readMicrosoftContact()
{std::cout << "read microsoft contact...";return true;
}// 读取本地phone
bool readPhoneContact()
{std::cout << "read phone contact...";return true;
}// 读取本地phone
bool readAllContact()
{std::cout << "read phone contact...";return true;
}static const std::unordered_map g_readOperators{{ContactType::PHONE, readPhoneContact},{ContactType::MICROSOFT, readMicrosoftContact},{ContactType::ALL, readAllContact}
};int main()
{int contactType = ContactType::ALL;std::ifstream readLocalFile(LOCAL_FILE_NAME);if (readLocalFile.good())   // 文件存在{readLocalFile >> contactType;readLocalFile.close();}else{std::ofstream outputLocalFile(LOCAL_FILE_NAME);std::cout << "please enter contact type: 0 Microsoft,1 Phone, 2 ALL: ";std::cin >> contactType;outputLocalFile << contactType;outputLocalFile.flush();outputLocalFile.close();}auto iter = g_readOperators.find(contactType);if (g_readOperators.end() != iter){iter->second();}return 0;
}

此时用户首次运行可执行程序,输入:1表示读取本地Phone联系人,程序输出

please enter contact type: 1
read phone contact...
  • 2.0版本App
enum ContactType
{MICROSOFT,  // 微软联系人 GOOGLE,     // google联系人PHONE,      // 本地手机联系人ALL         // 所有联系人
};// 本地文件名称
static const std::string LOCAL_FILE_NAME = "contact_type.txt";// 读取操作
typedef bool (*readOperator)();  // 读取Microsoft
bool readMicrosoftContact()
{std::cout << "read microsoft contact...";return true;
}// 读取google
bool readGoogleContact()
{std::cout << "read google contact...";return true;
}// 读取本地phone
bool readPhoneContact()
{std::cout << "read phone contact...";return true;
}// 读取本地phone
bool readAllContact()
{std::cout << "read phone contact...";return true;
}static const std::unordered_map g_readOperators{{ContactType::PHONE, readPhoneContact},{ContactType::MICROSOFT, readMicrosoftContact},{ContactType::GOOGLE, readGoogleContact},{ContactType::ALL, readAllContact}
};int main()
{int contactType = ContactType::ALL;std::ifstream readLocalFile(LOCAL_FILE_NAME);if (readLocalFile.good())   // 文件存在{readLocalFile >> contactType;readLocalFile.close();}else{std::ofstream outputLocalFile(LOCAL_FILE_NAME);std::cout << "please enter contact type: 0 Microsoft,1 GOOGLE, 2 Phone, 3 ALL: ";std::cin >> contactType;outputLocalFile << contactType;outputLocalFile.flush();outputLocalFile.close();}auto iter = g_readOperators.find(contactType);if (g_readOperators.end() != iter){iter->second();}return 0;
}

可执行程序支持了GOOGLE联系人,用户升级可执行程序,然后可执行程序会直接启动不需要用户输入自己的contact类型,但是用户这时候发现,可执行程序展示的联系人非自己的Phone联系人,产生了生成问题。

read google contact...
  • App存在的问题

这个问题在于用户第一次输入1表示PHONE,升级2.0后1不在表示PHONE,而表示GOOGLE了。

关键这种问题有时候是无法感知的,也很难定位。不过幸好有了static_assert。我们可以采用静态断言来解决这类问题。我们在1.0版本添加static_assert如下:

enum ContactType
{MICROSOFT,  // 微软联系人 PHONE,      // 本地手机联系人ALL         // 所有联系人
};static_assert(0 == ContactType::MICROSOFT);
static_assert(1 == ContactType::PHONE);

这样2.0版本修改ContactType枚举,static_assert就会提示编译错误。我们为每个版本增加枚举,添加新的断言而不修改老版本的断言,此种方式可完美的解决枚举定义不一致问题。例如,在枚举中间添加GOOGLE,static_assert(1 == ContactType::PHONE)就会有编译错误提示。

enum ContactType
{MICROSOFT,  // 微软联系人 GOOGLE,     // google联系人PHONE,      // 本地手机联系人ALL         // 所有联系人
};static_assert(0 == ContactType::MICROSOFT);
static_assert(1 == ContactType::PHONE);
static_assert(1 == ContactType::GOOGLE);

如何使用static_assert

static_assert可以应用于命名空间和作用域内(作为块声明),也可应用于类体内(作为成员声明)。

命名空间static_assert

命名空间中的static_assert立刻求值并断言。例如:

static_assert(sizeof(void *) == 4, "64-bit code generation is not supported.");

类中的static_assert

static_assert 声明具有模板类中。编译器将在声明 static_assert 声明时检查该声明,但不计算 constant-expression 参数,直到类模板实例化式才求值并断言。但是对于普通非模板类,编译器会立刻求值并且断言。

#include 
#include template  >
class basic_string 
{static_assert(std::is_trivially_copyable::value, "Template argument CharT must be a POD type in class template basic_string");// ...
};class EmptyClass
{static_assert(2 == sizeof(int), "int must is 2 bytes");
};int main()
{basic_string bs;
}

编译提示错误:

1> main.cpp(21,21): error C2338: static_assert failed: 'EmptyClass* must is 2 bytes'

块中的static_assert

static_assert 声明具有函数模板内。编译器将在声明 static_assert 声明时检查该声明,但不计算 constant-expression 参数,直到函数模板实例化式才求值并断言。但是对于非模板函数,编译器会立刻求值并且断言。

template
inline void doStuff(T val) 
{static_assert(!std::is_volatile::value, "No volatile types plz");//...
}int test(int a)
{static_assert(2 == sizeof(int), "test int must is 2 bytes");return 0;
}int main()
{volatile char sometext[261];doStuff(sometext);
}

编译提示错误:

1> main.cpp(21,21):  error C2338: static_assert failed: 'test int must is 2 bytes'

static_assert实现

利用C++语言的语法规则实现静态断言的方式非常多,这里只介绍两种static_assert实现方式。第一种通过除0编译错误实现静态断言;第二种开源库Boost内置的BOOST_STATIC_ASSERT中断言机制,利用sizeof操作符实现静态断言。

“除0”静态断言

“除0”静态断言,利用“除0"会导致编译器报错这个特性来实现静态断言。

#define assert_static(e)               \do {                                 \enum{assert_static__ = 1 /(e)}; \} while(false)

Boost静态断言

BOOST_STATIC_ASSERT宏利用c++规范,不完整类型即不可实例化的类型,在对其进行sizeof运算时提示编译错误。

templatestruct STATIC_ASSERTION_FAILURE;
template<>struct STATIC_ASSERTION_FAILURE{};
templatestruct static_assert_test{};#defineBOOST_STATIC_ASSERT(B)                                      \typedef static_assert_test> \boost_static_assert_typedef_##__LINE__

总结

本文从static_assert和assert的定义切入,分别详细介绍static_assert引入的原因,如何使用static_assert,最后以static_assert实现作为本文的结束。希望本文的介绍可以加深你对静态断言static_assert的理解。

相关内容

热门资讯

拜年的来历? 拜年的来历?那你是卖。... 那你是卖。 展开 传说远古时代有一种叫“年”的怪物,每逢腊月三十...
工作压力有利于成长的事例 工作压力有利于成长的事例 把李嘉诚的传记,推荐给您,我以前看过一多半,很有感触,希望可以帮助到您
苏武牧羊北海边的北海指的是哪里... 苏武牧羊北海边的北海指的是哪里?贝加尔湖,中国古代称为北海,位于俄罗斯西伯利亚南部简介贝加尔湖是亚欧...
购物狂电影的最后一幕那个弃婴 ... 购物狂电影的最后一幕那个弃婴 是怎么回事?是主角的小时候吧,讲她为什么是购物狂,因为她小时候被抛弃在...
方法决定成败 方法决定成败没错,方法决定成败,态度决定一切,心态决定效率。送你这几句名言,以资鼓励。
霞秋的意思?想表达晚年幸福? 霞秋的意思?想表达晚年幸福?霞秋的意思?想表达晚年幸福?... 霞秋的意思?想表达晚年幸福? 展...
关于“欣赏”的名言和事例 关于“欣赏”的名言和事例19世纪末,美国西部的密苏里有一个坏孩子,他偷偷地向邻居家的窗户扔石头,还把...
自己发的语音总是不敢去听,怎么... 自己发的语音总是不敢去听,怎么让自己勇敢去听呢?怎么说呢,其实你录下来的声音就是别人听到的,只是因为...
格物致知的真正意义是什么? 格物致知的真正意义是什么?提示:可以从文章内容中直接找到答案。? 参考答案:格物致知的真正...
醒悟中心卢卫斌老师谈强迫症的治... 醒悟中心卢卫斌老师谈强迫症的治疗为什么需要禅修练习  强迫症是一种复合型心理障碍,有其独特的障碍模型...
宣化那有好玩的地方 宣化那有好玩的地方有吗? 「莫等闲,白了少年头。空b切」
水深水浅东西涧 云去云来远近山... 水深水浅东西涧 云去云来远近山是什么意思  涧水或东或西时深时浅,山峦亦近云雾盘桓.  作品原文  ...
我的妹妹不可能那么可爱 讲的是... 我的妹妹不可能那么可爱 讲的是什么?就是有一个长的很可爱明明可以很受欢迎【也确实很受欢迎】的妹纸爱好...
童话诗有什么特点 童话诗有什么特点 童话诗(Fairy tale poem),故事诗的一种,现代诗的一种体裁。是以童话...
一块姜在挡车的是什么歌 一块姜在挡车的是什么歌一块姜在挡车的是什么歌感应:泳儿的歌我听的不多,但这首歌尤其的熟悉是一个人生活...
MP3出问题 MP3出问题我选其他歌,它都会跳回去原来那首歌,有时候还更厉害,显示这首歌的文件名字,唱另外一首歌出...
在金庸的设定里,一个武林高手可... 在金庸的设定里,一个武林高手可以打赢100个人已经是极限,但500个武林高手一定打不过1000名普第...
唐诗人张九龄"海上生明月天涯天... 唐诗人张九龄"海上生明月天涯天涯共此时"一诗全文?望月汪渗怀远 唐· 张九龄海上生明月,天涯共此时。...
暗里着迷歌曲深意? 暗里着迷歌曲深意?歌曲《暗里着迷》是刘德华在1993年发行的一首歌,他一直称这一首歌是自己半生中最重...
好听的名字 好听的名字 好听的名字有:圣杰,俊楠,皓轩,雨泽,智宸,明杰,峻熙,泽林,沛荣,嘉浩。1、圣杰:“圣...