C Language
アサーション

前書き

構文

• アサート（式）
• static_assert（式、メッセージ）
• _Static_assert（式、メッセージ）

パラメーター

備考

#ifdef NDEBUG
#  define assert(condition) ((void) 0)
#else
#  define assert(condition) /* implementation defined */
#endif

前提条件と事後条件

アサーションのユースケースの1つは、前提条件と事後条件です。これは、契約によって 不変および設計を維持するために非常に有用であり得る。例として、長さは常にゼロまたは正であるため、この関数はゼロまたは正の値を返す必要があります。

#include <stdio.h>
/* Uncomment to disable `assert()` */
/* #define NDEBUG */
#include <assert.h>

int length2 (int *a, int count)
{
    int i, result = 0;

    /* Precondition: */
    /* NULL is an invalid vector */
    assert (a != NULL);
    /* Number of dimensions can not be negative.*/ 
    assert (count >= 0);

    /* Calculation */
    for (i = 0; i < count; ++i) 
    {
        result = result + (a[i] * a[i]);
    }

    /* Postcondition: */
    /* Resulting length can not be negative. */
    assert (result >= 0);
    return result;
}

#define COUNT 3

int main (void)
{
    int a[COUNT] = {1, 2, 3};
    int *b = NULL;
    int r;
    r = length2 (a, COUNT);
    printf ("r = %i\n", r);
    r = length2 (b, COUNT);
    printf ("r = %i\n", r);
    return 0;
}

単純アサーション

アサーションは、そのコード行に到達したときにファクトが真でなければならないと主張するために使用されるステートメントです。アサーションは、期待される条件が満たされることを保証するのに役立ちます。アサーションに渡された条件が真の場合、アクションはありません。 false条件の動作は、コンパイラフラグによって異なります。アサーションが有効になっていると、誤った入力が発生するとすぐにプログラムが停止します。それらが無効になっているときは何もしません。アサーションは、リリースではしばしば有効になっていますが、内部ビルドやデバッグビルドでアサーションを有効にし、リリースビルドでアサーションを無効にするのが一般的です。 （終了がエラーよりも良いか悪いかは、プログラムによって異なります。）アサーションは、内部プログラミングエラーを捕捉するためにのみ使用してください。通常、悪いパラメータが渡されます。

#include <stdio.h>
/* Uncomment to disable `assert()` */
/* #define NDEBUG */
#include <assert.h>

int main(void)
{
    int x = -1;
    assert(x >= 0);

    printf("x = %d\n", x);   
    return 0;
}

NDEBUG出力は未定義です：

a.out: main.c:9: main: Assertion `x >= 0' failed.

NDEBUG可能な出力の定義：

x = -1

すべてのアサーションをオンまたはオフにしてコードを簡単にコンパイルできるように、 NDEBUGグローバルに定義することをお勧めします。これを行う簡単な方法は、 NDEBUGをコンパイラのオプションとして定義するか、共有構成ヘッダー（ config.h ）で定義することです。

静的アサーション

#include <assert.h>

enum {N = 5};
_Static_assert(N == 5, "N does not equal 5");
static_assert(N > 10, "N is not greater than 10");  /* compiler error */

#define STATIC_MSG(msg, l) STATIC_MSG2(msg, l)
#define STATIC_MSG2(msg,l) on_line_##l##__##msg
#define STATIC_ASSERT(x, msg) extern char STATIC_MSG(msg, __LINE__) [(x)?1:-1]
 
enum { N = 5 };
STATIC_ASSERT(N == 5, N_must_equal_5);
STATIC_ASSERT(N > 5, N_must_be_greater_than_5); /* compile error */

到達不可能なコードのアサーション

開発中に、特定のコードパスが制御フローの到達を妨げる必要があるときは、 assert(0)を使用assert(0)て、そのような条件が誤っていることを示すことができます。

switch (color) {
    case COLOR_RED:
    case COLOR_GREEN:
    case COLOR_BLUE:
        break;

    default:
        assert(0);
}

assert()マクロの引数がfalseを評価assert()たびに、マクロは診断情報を標準エラーストリームに書き込み、プログラムを中止します。この情報には、 assert()ステートメントのファイルと行番号が含まれており、デバッグに非常に役立ちます。 NDEBUGは、マクロNDEBUG定義することによって無効にすることができます。

エラーが発生したときにプログラムを終了させるもう1つの方法は、標準ライブラリ関数exit 、 quick_exitまたはabortです。 exitとquick_exitはあなたの環境に戻すことができる引数をとります。 abort() （したがってassert ）はプログラムの重大な終了となり、実行終了時に実行されるクリーンアップは実行されません。

assert()の主な利点は、デバッグ情報を自動的に出力することです。 abort()を呼び出すと、 abort()ように無効にすることはできませんが、デバッグ情報が表示されないことがあります。いくつかの状況では、両方のコンストラクトを併用すると効果的です。

if (color == COLOR_RED || color == COLOR_GREEN) {
   ...
} else if (color == COLOR_BLUE) {
   ...
} else {
   assert(0), abort();
}

アサートが有効になると、 assert()コールはデバッグ情報を出力し、プログラムを終了します。実行は決してabort()呼び出しに達しません。アサーションが無効になると、 assert()コールは何もせず、 abort()が呼び出されます。これにより、プログラムは常にこのエラー状態で終了します。アサートの有効化と無効化は、デバッグ出力が出力されるかどうかにかかわらず影響を与えます。

あなたは、このようなままにすることはありませんassertデバッグ情報は、エンドユーザーにとって有益ではないためとするので、生産コード内をabort一般的にインストールされているクリーンアップハンドラ阻害あまりにもひどい終了でexitまたはquick_exit実行することを。

アサートエラーメッセージ

アサーションとともにエラーメッセージを表示できるトリックが存在します。通常、次のようなコードを記述します

void f(void *p)
{
    assert(p != NULL);
    /* more code */
}

アサーションが失敗した場合は、エラーメッセージが似ています

アサーションが失敗しました：p！= NULL、ファイルmain.c、行5

ただし、論理AND（ && ）を使用してエラーメッセージを表示することもできます

void f(void *p)
{
    assert(p != NULL && "function f: p cannot be NULL");
    /* more code */
}

今、アサーションが失敗した場合、エラーメッセージは次のようになります

アサーションが失敗しました：p！= NULL && "関数f：pはNULLにできません"、ファイルmain.c、行5

これがなぜ機能するかについての理由は、文字列リテラルが常に非ゼロ（true）と評価されるためです。ブール式に&& 1を追加しても効果はありません。したがって、 && "error message"追加しても、コンパイラは失敗した式全体を表示します。