Как использовать #undef или вообще не использовать

@tiger() · Регистрация: 20.04.2011

Студворк — интернет-сервис помощи студентам

Посоветуйте какую лучше применить концепцию.

Хочу сделать в проекте унифицированные сообщения об ошибках в едином стиле. Чтобы они выглядели так:

C

1 2	ERROR: main.c foo -1 UNKNOWN_ERROR Message: main.c foo 0 OK

И чтобы в коде они выглядели одинаково, примерно так:

C

1 2	if (error) printf("%s %s %s %d %s\n", ERROR_PREFIX, SOURCE_PREFIX, FUNC_PREFIX, error, GetStringOfError(error));

Здесь ERROR_PREFIX и SOURCE_PREFIX можно задать дефайнами в начале каждого исходника, а вот как быть с FUNC_PREFIX? Можно ли его тоже дефайном делать в каждой функции? Например так:

C

int foo(void)
{
#define FUNC_PREFIX foo
 
<...>
<... use FUNC_PREFIX ...>
if (something) return 1;
<... use FUNC_PREFIX ...>
 
#undef FUNC_PREFIX
return 0;
}

Смущает что: если #undef будет стоять всегда в конце, как быть с промежуточными return-ами? Если мы не доходим до строки #undef, а выходим раньше, что станет с FUNC_PREFIX?

Charles Kludge · 10.09.2013, 17:07

А чем assert() не устраивает?

silent_1991 · 11.09.2013, 15:14

tiger(), существует встроенный идентификатор __func__, генерируемый компилятором в теле каждой функции и содержащий строковое имя содержащей его функции.

@Nameless One · 12.09.2013, 06:32

Сообщение от tiger()

Смущает что: если #undef будет стоять всегда в конце, как быть с промежуточными return-ами? Если мы не доходим до строки #undef, а выходим раньше, что станет с FUNC_PREFIX?

Препроцессор работает не в рантайме, а ещё до непосредственной компиляции.

Вручную ничего определять не надо, можно воспользоваться стандартными макросами __FILE__ и __LINE__ (ERROR_PREFIX можно передавать в качестве аргумента) вместе с идентификатором __func__, как предложил silent_1991. Для большего удобства всё это можно обернуть в макрос:

C

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
 
#ifndef NDEBUG
#define CHECK_ERRNO(FMT, ...)                           \
    do {                                                \
        if(errno) {                                     \
            int errsv = errno;                          \
            fprintf(stderr,                             \
                    "Error at %s:%s:%d "                \
                    "(code: %d reason: \"%s\"): "       \
                    FMT "\n", __FILE__,                 \
                    __func__, __LINE__, errno,          \
                    strerror(errno),                    \
                    ##__VA_ARGS__);                     \
            errno = errsv;                              \
       }                                                \
    } while(0)
#else
#define CHECH_ERRNO(FMT, ...) ((void) 0)
#endif /* NDEBUG */
 
void test_fun(const char *filename)
{
    FILE *file = fopen(filename, "r");
    CHECK_ERRNO("Opening \"%s\"...", filename);
    if(file) {
        fclose(file);
    }
}
 
int main(void)
{
    test_fun("/there/is/no/such/file");
    exit(0);
}

Возможный вывод:

Код

~/samples/c $ bin/sample 
Error at /home/nameless/samples/c/main.c:test_fun:28 (code: 2 reason: "No such file or directory"): Opening "/there/is/no/such/file"...

Сообщение от silent_1991

существует встроенный идентификатор __func__, генерируемый компилятором в теле каждой функции и содержащий строковое имя содержащей его функции.

+ GCC определяет __FUNCTION__ для той же самой цели. Вдруг у ТС gcc, не поддерживающий C99?

@tiger() · 16.09.2013, 07:29 **[ТС]**

Сообщение от Nameless One

C

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
 
#ifndef NDEBUG
#define CHECK_ERRNO(FMT, ...)                           \
    do {                                                \
        if(errno) {                                     \
            int errsv = errno;                          \
            fprintf(stderr,                             \
                    "Error at %s:%s:%d "                \
                    "(code: %d reason: \"%s\"): "       \
                    FMT "\n", __FILE__,                 \
                    __func__, __LINE__, errno,          \
                    strerror(errno),                    \
                    ##__VA_ARGS__);                     \
            errno = errsv;                              \
       }                                                \
    } while(0)
#else
#define CHECH_ERRNO(FMT, ...) ((void) 0)
#endif /* NDEBUG */

Во, такой макрос как раз то что надо. Только я не все понял здесь..

Во-первых зачем нужен do {} while (0), если можно просто написать этот кусок кода и он тоже выполнится один раз?
Во-вторых я не понял откуда берутся переменные errno, errsv, чему они равны, здесь нигде не инициализируются.
И еще - зачем в CHECH_ERRNO неопределенное количество аргументов?

@Nameless One · 16.09.2013, 07:41

Сообщение от tiger()

Во-первых зачем нужен do {} while (0)

Это стандартная идиома при написании многострочных макросов. Объяснять, зачем тут do {} while(0), если честно, лень, я это уже делал здесь (читать комментарии). Ну или можешь загуглить «c multiline macro».

Сообщение от tiger()

Во-вторых я не понял откуда берутся переменные errno, errsv, чему они равны, здесь нигде не инициализируются.

Символ errno объявляется в заголовочном файле errno.h. Он содержит код ошибки последней вызванной библиотечной функции (если ошибка была). errsv мы определяем сами.

Сообщение от tiger()

И еще - зачем в CHECH_ERRNO неопределенное количество аргументов?

Там опечатка, должно быть CHECK_ERRNO. Зачем? Чтобы можно было эти аргументы вывести. Вывод производится по аналогии с функцией форматного вывода printf, которая принимает форматную строку и неопределённое число аргументов. Например, строку 19 можно было бы заменить на

C

1	CHECK_ERRNO("Opening \"%s\"...; my mood today is %s", filename, get_mood());

При этом вывелось бы

Код

Error at /home/nameless/samples/c/main.c:test_fun:28 (code: 2 reason: "No such file or directory"): Opening "/there/is/no/such/file"...; my mood today is sad

Это сделано лишь для удобства. Не нравится — можешь так не делать.

@tiger() · 16.09.2013, 08:05 **[ТС]**

Сообщение от Nameless One

Это стандартная идиома при написании многострочных макросов. Объяснять, зачем тут do {} while(0), если честно, лень, я это уже делал здесь (читать комментарии). Ну или можешь загуглить «c multiline macro».

Ага, сам почитаю, спасибо за ссылку

Сообщение от Nameless One

Символ errno объявляется в заголовочном файле errno.h. Он содержит код ошибки последней вызванной библиотечной функции (если ошибка была).

Я не уверен что мой код ошибки будет там находиться. Я отлаживаю такой код ошибки, который почти в каждой функции из моего API определен как локальная переменная int32_t например и возвращается по return. То есть я после таких функций имею переменную result условно говоря, которую проверяю на 0 - все хорошо или не0 - код ошибки.

Вот что у меня получилось

C

#define FILE (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)
 
#ifdef UART_DEBUG
#define OUTPUT_ERROR(FMT, ...)                   \
    do {                                         \
        fprintf("ERROR:   in %s:%s"): FMT,  \
        FILE, __func__, ##__VA_ARGS__);                          \
    } while(0)
#else
#define CHECH_ERRNO(FMT, ...) ((void) 0)
#endif // UART_DEBUG

Еще добавил вначале макрос чтобы путь файла состоял из одного имени файла.

В целом возможно два варианта ошибочных ситуаций: мы знаем что была ошибка и ее код или просто знаем что была ошибка. То есть в тексте после очередной функции API я хочу использовать

C

1	OUTPUT_ERROR("Function API_1 failed\n");

или

C

1	OUTPUT_ERROR("Function API_1 failed with (%d) - %s\n", error_code, GetString(error_code));

Сообщение от Nameless One

Это сделано лишь для удобства. Не нравится — можешь так не делать.

Наоборот нравится, просто хочу разобраться как и что.

@Nameless One · 16.09.2013, 08:14

Сообщение от tiger()

Я не уверен что мой код ошибки будет там находиться. Я отлаживаю такой код ошибки, который почти в каждой функции из моего API определен как локальная переменная int32_t например и возвращается по return. То есть я после таких функций имею переменную result условно говоря, которую проверяю на 0 - все хорошо или не0 - код ошибки.

Это был просто пример. Естественно, твоего кода ошибки там не будет, и тебе нужно изменить errno на свою переменную.

@tiger() · 16.09.2013, 08:52 **[ТС]**

Сообщение от Nameless One

Это был просто пример. Естественно, твоего кода ошибки там не будет, и тебе нужно изменить errno на свою переменную.

Спасибо Nameless One, очень удобный макрос!

Charles Kludge Клюг 7674 / 3189 / 382 Регистрация: 03.05.2011 Сообщений: 8,380
	10.09.2013, 17:07	2
	А чем assert() не устраивает? 0

silent_1991 5055 / 3115 / 271 Регистрация: 11.11.2009 Сообщений: 7,044
	11.09.2013, 15:14	3
	tiger(), существует встроенный идентификатор __func__, генерируемый компилятором в теле каждой функции и содержащий строковое имя содержащей его функции. 1

@Nameless One 5827 / 3478 / 358 Регистрация: 08.02.2010 Сообщений: 7,448
	16.09.2013, 08:14	8
	Сообщение от tiger() Я не уверен что мой код ошибки будет там находиться. Я отлаживаю такой код ошибки, который почти в каждой функции из моего API определен как локальная переменная int32_t например и возвращается по return. То есть я после таких функций имею переменную result условно говоря, которую проверяю на 0 - все хорошо или не0 - код ошибки. Это был просто пример. Естественно, твоего кода ошибки там не будет, и тебе нужно изменить errno на свою переменную. 1

@tiger() 4 / 4 / 1 Регистрация: 20.04.2011 Сообщений: 141
	16.09.2013, 08:52 [ТС]	9
	Сообщение от Nameless One Это был просто пример. Естественно, твоего кода ошибки там не будет, и тебе нужно изменить errno на свою переменную. Спасибо Nameless One, очень удобный макрос! 0