C Language
Утверждение

Вступление

Синтаксис

• утверждает (выражение)
• static_assert (выражение, сообщение)
• _Static_assert (выражение, сообщение)

параметры

замечания

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

Предварительное условие и постусловие

Одним из предпосылок для утверждения является предварительное условие и постусловие. Это может быть очень полезно для поддержания инварианта и дизайна по контракту . Например, длина всегда равна нулю или положительна, поэтому эта функция должна возвращать нулевое или положительное значение.

#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;
}

Простое утверждение

Утверждение - это утверждение, используемое для утверждения, что факт должен быть правдой, когда эта строка кода будет достигнута. Утверждения полезны для обеспечения выполнения ожидаемых условий. Когда условие, переданное утверждению, истинно, действия нет. Поведение в ложных условиях зависит от флагов компилятора. Когда утверждения разрешены, ложный ввод вызывает немедленную остановку программы. Когда они отключены, никаких действий не предпринимается. Общепринятой практикой является включение утверждений во внутренние и отладочные сборки и их отключение в сборках релизов, хотя утверждения часто включаются в выпуске. (Оправдывание прекращается или хуже, чем ошибки зависят от программы.) Утверждения должны использоваться только для того, чтобы ловить внутренние ошибки программирования, что обычно означает, что передаются плохие параметры.

#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 , так и выключить. Легкий способ сделать это - определить 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) чтобы указать, что такое условие является ошибочным:

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

    default:
        assert(0);
}

Всякий раз, когда аргумент макроса assert() вычисляет false, макрос будет записывать диагностическую информацию в стандартный поток ошибок, а затем прервать программу. Эта информация включает в себя номер файла и строки оператора assert() и может быть очень полезной при отладке. Зарезервировать можно, NDEBUG макрос NDEBUG .

Другой способ прервать программу при возникновении ошибки являются стандартной библиотеки функций exit , quick_exit или abort . exit и quick_exit принимают аргумент, который можно передать обратно в вашу среду. abort() (и, таким образом, assert ) может быть действительно серьезным завершением вашей программы, и некоторые очистки, которые в противном случае были бы выполнены в конце выполнения, могут не выполняться.

Основным преимуществом assert() является то, что он автоматически печатает отладочную информацию. Вызов abort() имеет то преимущество, что он не может быть отключен как assert, но может не вызывать отображение какой-либо информации отладки. В некоторых ситуациях использование обеих конструкций вместе может быть полезным:

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

Когда assert() включены , вызов assert() будет печатать отладочную информацию и завершать программу. Выполнение никогда не достигает вызова abort() . Когда assert() отключены , вызов assert() ничего не делает и вызывается abort() . Это гарантирует, что программа всегда заканчивается для этого условия ошибки; включение и отключение утверждений влияет только на то, напечатан ли вывод отладки.

Вы никогда не должны оставлять такое assert в производственном коде, потому что отладочная информация не полезна для конечных пользователей, и поскольку abort обычно является слишком строгим завершением, которое блокирует обработчики очистки, которые установлены для exit или quick_exit для запуска.

Сообщения об ошибках подтверждения

Существует трюк, который может отображать сообщение об ошибке вместе с утверждением. Обычно вы пишете такой код

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

Если утверждение не выполнено, сообщение об ошибке будет напоминать

Утверждение не выполнено: p! = NULL, файл main.c, строка 5

Однако вы можете использовать логическое И ( && ), чтобы дать сообщение об ошибке

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" имеет никакого эффекта, за исключением того, что компилятор отобразит полное выражение, которое не удалось.