C++17 nodiscard标記符

文章目錄

• 前言
• 棄值表達式
• nodiscard标記符
• • 函數非棄值聲明
  • 類/枚舉類/結構 非棄值聲明
  • 傳回類引用與類指針

前言

在C++ 17中引入了一個标記符

nodiscard

，用于聲明一個 “非棄值(no-discard)表達式”。那麼在開始之前，我們需要了解一下什麼是棄值表達式。

棄值表達式

棄值表達式，就是放棄擷取傳回值的表達式。首先棄值表達式的傳回值是非void類型的。一般，我們使用的棄值表達式，其傳回值隻是起次要的作用，而其本身的作用占主要。比如

++i;

就是一個棄值表達式，它的主要作用就是累加，但同時我們也可以選擇擷取其累加的傳回值，隻不過這是次要的。

再比如，C标準庫的檔案寫入函數，其聲明如下：

它有一個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
}