详解C++17中nodiscard标记符的使用

目录

• 前言
• 弃值表达式
• nodiscard标记符
• 函数非弃值声明
• 类/枚举类/结构 非弃值声明
• 返回类引用与类指针

前言

在C++ 17中引入了一个标记符nodiscard，用于声明一个 “非弃值(no-discard)表达式”。那么在开始之前，我们需要了解一下什么是弃值表达式。

弃值表达式

弃值表达式，就是放弃获取返回值的表达式。首先弃值表达式的返回值是非void类型的。一般，我们使用的弃值表达式，其返回值只是起次要的作用，而其本身的作用占主要。比如++i;就是一个弃值表达式，它的主要作用就是累加，但同时我们也可以选择获取其累加的返回值，只不过这是次要的。

再比如，C标准库的文件写入函数，其声明如下：

int __cdecl fputs(const char * __restrict__ _Str,FILE * __restrict__ _File);

它有一个int类型的返回值，用于获取写入状态，它的主要作用是写入文件，我可以选择不获取状态，也可以选择获取状态：

fputs("Hello World",pFile);
int result = fputs("Hello World",pFile);

nodiscard标记符

那么我如果想向用户建议获取返回值，这时候，我就可以使用nodiscard标记符。它一般用于标记函数的返回值或者某个类。声明语法为：

/* @since C++17 */
[[nodiscard]] return_type function();
/* @since C++20 */
[[nodiscard("message")]] return_type  function();
/* Standard lib defination */
/*
    #if __cplusplus >= 201703L
    # define _GLIBCXX_NODISCARD [[__nodiscard__]]
    #else
    # define _GLIBCXX_NODISCARD
    #endif
*/
_GLIBCXX_NODISCARD return_type  function();

如果一个被nodiscard标记了的表达式，如果我们在使用时弃值了，而且没有使用static_cast<void>将其转化为void时，编译器会抛出warning来提醒用户获取返回值。

函数非弃值声明

[[nodiscard]] int func1(){
    return 1;
}

[[nodiscard("nodiscared function")]] int func2(){
    return 1;
}

int main(){
    func1();                         //warning C++17
    func2();                         //warning c++20
    int a = func1();                 //no warning
    static_cast<void>(func1());      //no warning
}

结果如下：

类/枚举类/结构 非弃值声明

class [[nodiscard]] A{};
enum class [[nodiscard]] B{X,Y};
struct [[nodiscard]] C{};

A createA(){
    return A();
}

B createB(){
    return B::X;
}

C createC(){
    return C();
}

int main(){
    createA();
    createB();
    createC();
}

输出如下：

6.cpp: In function 'int main()':
6.cpp:22:12: warning: ignoring returned value of type 'A', declared with attribute 'nodiscard' [-Wunused-result]
   22 |     createA();
      |     ~~~~~~~^~
6.cpp:10:3: note: in call to 'A createA()', declared here
   10 | A createA(){
      |   ^~~~~~~
6.cpp:6:21: note: 'A' declared here
    6 | class [[nodiscard]] A{};
      |                     ^
6.cpp:23:12: warning: ignoring returned value of type 'B', declared with attribute 'nodiscard' [-Wunused-result]
   23 |     createB();
      |     ~~~~~~~^~
6.cpp:14:3: note: in call to 'B createB()', declared here
   14 | B createB(){
      |   ^~~~~~~
6.cpp:7:26: note: 'B' declared here
    7 | enum class [[nodiscard]] B{X,Y};
      |                          ^
6.cpp:24:12: warning: ignoring returned value of type 'C', declared with attribute 'nodiscard' [-Wunused-result]
   24 |     createC();
      |     ~~~~~~~^~
6.cpp:18:3: note: in call to 'C createC()', declared here
   18 | C createC(){
      |   ^~~~~~~
6.cpp:8:22: note: 'C' declared here
    8 | struct [[nodiscard]] C{};
      |                      ^

返回类引用与类指针

当返回值为引用或者指针的 类/枚举类/结构（函数不行） 时，nodiscard 就无效了：

class [[nodiscard]] A{};

A& createAref(){
    A* a = new A();
    return *a;
}

A* createAptr(){
    A* a = new A();
    return a;
}

int main(){
    createAref(); //no warning
    createAptr(); //no warning
}

到此这篇关于详解C++17中nodiscard标记符的使用的文章就介绍到这了,更多相关C++17 nodiscard标记符内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！