コンテンツにスキップ

C言語/nodiscard

リンクを追加
出典: フリー教科書『ウィキブックス（Wikibooks）』

nodiscard属性の概要

[編集]

C23規格では、コードの安全性と品質を向上させるための新たな属性の一つとして、nodiscard属性が導入されました。この属性は、関数の戻り値が呼び出し元で無視されるべきではないことを明示的に示すためのものです。

nodiscard属性が付与された関数の戻り値が使用されない場合、コンパイラは警告を発します。これにより、エラー処理やリソース管理などの重要な戻り値を誤って無視することを防ぎ、より堅牢なコードを作成することが可能になります。

構文と基本的な使用方法

[編集]

nodiscard属性の基本的な構文は次のとおりです： 

[[nodiscard]] 戻り値の型 関数名(パラメータリスト);

この属性は関数の戻り値だけでなく、列挙型や構造体などの型宣言にも適用できます。

以下に、基本的な使用例を示します： 

#include <stdio.h>
#include <stdlib.h>
// 戻り値が無視されるべきではない関数
[[nodiscard]] int* allocate_buffer(size_t size) {
    return malloc(size);
}

int main(void) {
    // 警告が発生する例
    allocate_buffer(100); // コンパイラ警告: 'nodiscard'属性が付いた関数の戻り値が無視されています
    
    // 正しい使用法
    int* buffer = allocate_buffer(100);
    
    // バッファを使用
    if (buffer) {
        buffer[0] = 42;
        printf("値: %d\n", buffer[0]);
        free(buffer);
    }
    
    return 0;
}

この例では、allocate_buffer関数はnodiscard属性が付与されています。この関数の戻り値（メモリポインタ）が無視された場合、メモリリークが発生する可能性があるため、コンパイラは警告を発します。

メッセージ付きnodiscard属性

[編集]

C23では、nodiscard属性にメッセージを追加することができます。これにより、戻り値が無視された場合に表示される警告メッセージをカスタマイズできます。 

#include <stdio.h>
#include <stdbool.h>
[[nodiscard("セキュリティチェックの結果を無視すると脆弱性が発生する可能性があります")]]
bool validate_input(const char* input) {
    // 入力の検証処理
    return input != NULL && input[0] != '\0';
}

[[nodiscard("リソースリークを防ぐため、戻り値をチェックしてください")]]
FILE* safe_file_open(const char* filename, const char* mode) {
    return fopen(filename, mode);
}

int main(void) {
    const char* user_input = "test";
    
    // 警告: セキュリティチェックの結果を無視すると脆弱性が発生する可能性があります
    validate_input(user_input);
    
    // 正しい使用法
    if (validate_input(user_input)) {
        // 入力が有効な場合の処理
        printf("入力は有効です\n");
        
        // 警告: リソースリークを防ぐため、戻り値をチェックしてください
        safe_file_open("test.txt", "r");
        
        // 正しい使用法
        FILE* file = safe_file_open("test.txt", "r");
        if (file) {
            // ファイル操作
            fclose(file);
        }
    }
    
    return 0;
}

この例では、validateinput関数とsafefile_open関数にメッセージ付きのnodiscard属性が付与されています。これにより、戻り値が無視された場合に、より明確で具体的な警告メッセージが表示されます。

型に対するnodiscard属性

[編集]

nodiscard属性は関数だけでなく、型（構造体、列挙型、typedef）にも適用できます。型にnodiscard属性を付与すると、その型を戻り値として返す関数すべてにnodiscardが適用されます。 

// エラーコードを表す列挙型
[[nodiscard]] typedef enum {
    SUCCESS = 0,
    ERROR_FILE_NOT_FOUND,
    ERROR_PERMISSION_DENIED,
    ERROR_OUT_OF_MEMORY
} ErrorCode;

// この関数は暗黙的にnodiscardになる
ErrorCode process_file(const char* filename) {
    // ファイル処理のロジック
    return SUCCESS;
}

int main(void) {
    // 警告が発生する例
    process_file("data.txt"); // 警告: nodiscard型の戻り値が無視されています
    
    // 正しい使用法
    ErrorCode result = process_file("data.txt");
    if (result != SUCCESS) {
        // エラー処理
    }
    
    return 0;
}

実践的な使用例

[編集]

メモリ管理関数

[編集]

メモリ管理関数は、戻り値が無視されるとリソースリークの原因となるため、nodiscard属性の典型的な使用例です。 

[[nodiscard("メモリリークを防ぐため、戻り値を確認してください")]]
void* safe_malloc(size_t size) {
    void* ptr = malloc(size);
    if (!ptr && size > 0) {
        fprintf(stderr, "メモリ割り当てに失敗しました\n");
    }
    return ptr;
}

[[nodiscard("メモリリークを防ぐため、戻り値を確認してください")]]
char* string_duplicate(const char* str) {
    if (!str) return NULL;
    
    size_t len = strlen(str) + 1;
    char* new_str = safe_malloc(len);
    
    if (new_str) {
        memcpy(new_str, str, len);
    }
    
    return new_str;
}

エラー処理関数

[編集]

エラーを返す可能性のある関数は、エラー状態が無視されないようにnodiscard属性を使用するべきです。 

[[nodiscard("エラー状態を無視すると予期しない動作の原因になる可能性があります")]]
int initialize_system(void) {
    // システム初期化のロジック
    int status = perform_initialization();
    if (status != 0) {
        // エラーログ
    }
    return status;
}

スレッド関数

[編集]

マルチスレッドプログラミングでは、スレッド作成や同期プリミティブの操作の結果を確認することが重要です。 

#include <threads.h>
[[nodiscard("スレッド作成の失敗を検出するために戻り値を確認してください")]]
int create_worker_thread(thrd_t* thread, int (*function)(void*), void* arg) {
    return thrd_create(thread, function, arg);
}

コンパイラ対応状況

[編集]

nodiscard属性はC++17ですでに導入されていた機能がC23に採用されたものです。主要なコンパイラの対応状況は次のとおりです：

コンパイラ バージョン サポート状況 注意事項
GCC 10.0以上 完全対応 -std=c2xまたは-std=c23フラグが必要
Clang 10.0以上 完全対応 -std=c2xまたは-std=c23フラグが必要
MSVC 2019以上 完全対応 /std:c23フラグが必要
ICC (Intel) 2021以上 部分対応 メッセージ付き属性は未対応の場合あり

古いコンパイラで同様の機能を実現するには、以下のようなマクロを定義することで代替できます： 

#if defined(__GNUC__) || defined(__clang__)
  #define NODISCARD __attribute__((warn_unused_result))
#elif defined(_MSC_VER) && _MSC_VER >= 1700
  #define NODISCARD _Check_return_
#else
  #define NODISCARD
#endif

C++との互換性

[編集]

nodiscard属性はC++17ですでに導入されていた機能であるため、C/C++の両方で使用されるコードでは高い互換性があります。ただし、C23とC++17/20の間にはいくつかの違いがあります：

機能 C23 C++17 C++20
基本的なnodiscard属性 対応 ← ←
メッセージ付きnodiscard 対応 非対応 対応
型に対するnodiscard 対応 ← ←
クラスメンバ関数への適用 非該当 対応 ←

他の属性との組み合わせ

[編集]

nodiscard属性は他の属性と組み合わせて使用することができます。以下は一般的な組み合わせの例です： 

// エラーコードを返す非推奨関数
[[nodiscard]] [[deprecated("代わりにnew_function()を使用してください")]]
int old_function(void);

// いくつかの引数が使用されない可能性がある関数
[[nodiscard]] int complex_operation(int a, [[maybe_unused]] int debug_level);

ベストプラクティス

[編集]

nodiscard属性を効果的に使用するためのベストプラクティスをいくつか紹介します：

適切な関数への適用

[編集]

すべての関数にnodiscard属性を付与するのではなく、戻り値が重要な意味を持つ特定の種類の関数に対してのみ使用することをお勧めします：

関数の種類 nodiscard推奨 理由
リソース確保関数 ◯ メモリリーク防止
エラーコード返却関数 ◯ エラー状態の把握
状態チェック関数 ◯ 重要な条件の確認
ファクトリ関数 ◯ 生成したオブジェクトの管理
void関数 × 戻り値なし
単純な計算関数 △ 用途による

明確なメッセージの提供

[編集]

nodiscard属性にメッセージを付与する場合は、具体的で明確な情報を提供することが重要です： 

// 良い例
[[nodiscard("ファイルハンドルが未使用の場合、リソースリークが発生します")]]
FILE* open_config_file(void);

// 改善できる例
[[nodiscard("エラー")]] // 具体性に欠ける
int validate_config(void);

型の設計

[編集]

エラーコードや結果オブジェクトを表す型を設計する際は、その型全体にnodiscard属性を適用することを検討してください： 

[[nodiscard]] typedef struct {
    bool success;
    union {
        void* result;
        const char* error_message;
    } data;
} OperationResult;

OperationResult perform_critical_operation(void);

実際のコード例

[編集]

以下に、nodiscard属性を活用した実際のコード例を示します。この例では、ファイル処理ライブラリの一部を実装しています： 

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdbool.h>
// ファイル操作の結果を表す型
[[nodiscard("ファイル操作の結果を確認せずに処理を続行すると、データ損失のリスクがあります")]]
typedef struct {
    bool success;
    union {
        size_t bytes_processed;
        const char* error_message;
    } data;
} FileResult;

// ファイルハンドラ構造体
typedef struct {
    FILE* handle;
    char* filename;
    char* mode;
    bool is_open;
} FileHandler;

// ファイルハンドラを作成
[[nodiscard("未使用のファイルハンドラはリソースリークの原因になります")]]
FileHandler* create_file_handler(const char* filename, const char* mode) {
    if (!filename || !mode) {
        return NULL;
    }
    
    FileHandler* handler = malloc(sizeof(FileHandler));
    if (!handler) {
        return NULL;
    }
    
    handler->filename = strdup(filename);
    handler->mode = strdup(mode);
    handler->handle = NULL;
    handler->is_open = false;
    
    return handler;
}

// ファイルを開く
[[nodiscard("ファイルオープンの失敗を検出するために戻り値を確認してください")]]
FileResult open_file(FileHandler* handler) {
    FileResult result = {0};
    
    if (!handler) {
        result.success = false;
        result.data.error_message = "無効なファイルハンドラです";
        return result;
    }
    
    if (handler->is_open) {
        result.success = false;
        result.data.error_message = "ファイルはすでに開かれています";
        return result;
    }
    
    handler->handle = fopen(handler->filename, handler->mode);
    
    if (!handler->handle) {
        result.success = false;
        result.data.error_message = "ファイルを開けませんでした";
        return result;
    }
    
    handler->is_open = true;
    result.success = true;
    result.data.bytes_processed = 0;
    
    return result;
}

// ファイルからデータを読み込む
[[nodiscard("読み込み操作の結果を確認せずに処理を続行すると、不完全なデータが使用される可能性があります")]]
FileResult read_data(FileHandler* handler, void* buffer, size_t size) {
    FileResult result = {0};
    
    if (!handler || !handler->is_open || !buffer) {
        result.success = false;
        result.data.error_message = "無効なパラメータまたはファイルが開かれていません";
        return result;
    }
    
    size_t read_count = fread(buffer, 1, size, handler->handle);
    
    if (read_count < size && ferror(handler->handle)) {
        result.success = false;
        result.data.error_message = "読み込み中にエラーが発生しました";
        return result;
    }
    
    result.success = true;
    result.data.bytes_processed = read_count;
    
    return result;
}

// ファイルにデータを書き込む
[[nodiscard("書き込み操作の結果を確認せずに処理を続行すると、データ損失の原因になります")]]
FileResult write_data(FileHandler* handler, const void* buffer, size_t size) {
    FileResult result = {0};
    
    if (!handler || !handler->is_open || !buffer) {
        result.success = false;
        result.data.error_message = "無効なパラメータまたはファイルが開かれていません";
        return result;
    }
    
    size_t write_count = fwrite(buffer, 1, size, handler->handle);
    
    if (write_count < size) {
        result.success = false;
        result.data.error_message = "書き込み中にエラーが発生しました";
        return result;
    }
    
    result.success = true;
    result.data.bytes_processed = write_count;
    
    return result;
}

// ファイルを閉じる
void close_file(FileHandler* handler) {
    if (handler && handler->is_open) {
        fclose(handler->handle);
        handler->is_open = false;
        handler->handle = NULL;
    }
}

// ファイルハンドラを解放
void destroy_file_handler(FileHandler* handler) {
    if (handler) {
        if (handler->is_open) {
            close_file(handler);
        }
        
        free(handler->filename);
        free(handler->mode);
        free(handler);
    }
}

// 使用例
int main(void) {
    // ファイルハンドラを作成
    FileHandler* handler = create_file_handler("example.txt", "w+");
    if (!handler) {
        fprintf(stderr, "ファイルハンドラの作成に失敗しました\n");
        return 1;
    }
    
    // ファイルを開く
    FileResult open_result = open_file(handler);
    if (!open_result.success) {
        fprintf(stderr, "ファイルを開けませんでした: %s\n", open_result.data.error_message);
        destroy_file_handler(handler);
        return 1;
    }
    
    // データを書き込む
    const char* message = "nodiscard属性のテスト";
    FileResult write_result = write_data(handler, message, strlen(message));
    if (!write_result.success) {
        fprintf(stderr, "書き込みに失敗しました: %s\n", write_result.data.error_message);
        destroy_file_handler(handler);
        return 1;
    }
    
    printf("正常に%zuバイト書き込みました\n", write_result.data.bytes_processed);
    
    // リソースを解放
    destroy_file_handler(handler);
    
    return 0;
}

この例では、ファイル操作の各段階でnodiscard属性を使用しています。これにより、重要な戻り値を誤って無視することを防ぎ、より堅牢なコードを実現しています。

まとめ

[編集]

nodiscard属性はC23の重要な追加機能の一つであり、戻り値が無視されるべきではない関数や型を明示するために使用されます。この属性を適切に使用することで、以下のような利点があります：

  1. エラー状態やリソースの漏洩を見逃すリスクの軽減
  2. コードの意図の明確化
  3. コード品質の向上
  4. 実行時エラーの早期発見

nodiscard属性は、特にリソース管理、エラー処理、セキュリティ関連の関数において非常に有用です。適切に使用することで、より安全で堅牢なCプログラムを開発することができます。

"https://ja.wikibooks.org/w/index.php?title=C言語/nodiscard&oldid=270967" より作成