编写一个带有可变参数并返回值的C宏

Question

我有一个用于在stderr上显示消息的宏，该消息显示当前文件名（来自__FILE__ ）和行号（来自__LINE__ ），但也允许使用自定义消息的可选格式和可变参数列表。 如果指定了自定义消息，则编译器必须做得相当不错，可以警告有关不正确的printf参数的警告。

可以通过以下方式来调用它，并带有此任意错误代码：

LogError(ErrorCode_TypeMismatch);                        // prints "[filename:lineno] Type Mismatch:"
LogError(ErrorCode_TypeMismatch, "type was %d", type);   // prints "[filename:lineno] Type Mismatch: type was 0"

打印的文件名始终是基本名（即，路径已删除）。

另外，它返回传入的错误代码值，以便可以按以下方式使用它：

result = LogError(ErrorCode_TypeMismatch);                     // result will be ErrorCode_TypeMismatch
result = LogError(ErrorCode_InvalidName, "name is %s", name);  // result will be ErrorCode_InvalidName

目前，我有以下解决方案：

#include <stdio.h>
#include <stdarg.h>

// used to make strings from numeric macros
#define XSTRINGY(a) STRINGY(a)
#define STRINGY(a) #a

typedef enum {
    ErrorCode_TypeMismatch,
    ErrorCode_InvalidName,
    // ...
} ErrorCode;

#define LogError(code, ...) Log2(code, __VA_ARGS__)

// a function to simply return the value provided, used below
static inline ErrorCode ReturnErrorCode(ErrorCode code) { return code; }

#define Log2(code, format, ...) \
ReturnErrorCode(code); /* return the code */ \
{ \
    const char * fileName = __FILE__; \
    const char * lineNum = XSTRINGY(__LINE__); \
    const char * shortFileName = strrchr(fileName, '/'); \
    const char * errorString = ErrorCode_ToString(code); /* returns string representation of error code, implementation not shown here */ \
    DoLog("[%s:%s] %s: " format "\n", shortFileName ? shortFileName + 1 : fileName, lineNum, errorString, ##__VA_ARGS__); \
}

void DoLog(const char * format, ...) __attribute__ ((format (printf, 1, 2)));
void DoLog(const char * format, ...)
{
    va_list argp;
    va_start(argp, format);
    vfprintf(stderr, format, argp);
    va_end(argp);
}

这样效果很好，并且符合前面提到的要求。

但是，我想引入一个新的要求-LogError宏可以与return语句一起使用，例如：

return LogError(ErrorCode_TypeMismatch);
// or
return LogError(ErrorCode_TypeMismatch, "The values are %d, %d", value0, value1);

不幸的是，由于Log2宏的写入方式（用于返回传入的值），处理器将执行返回，而格式化文件名/行号并打印出来的其余代码将不会执行。 因此，不会生成任何输出（尽管会返回正确的值）。

我研究了许多有关逗号运算符和GNU语句表达式的想法（出于可移植性的原因，我希望避免使用，尽管##__VA_ARGS__是可以接受的），而我发现了一些与从宏返回值有关的有用资源（“函数“宏），我找不到适合此类可变宏的解决方案。

另外，是否有一种方法可以检测到宏已与return语句一起使用并自动停止构建？ 此宏似乎不会触发编译器发出的无法到达代码的警告，我不确定为什么会这样。

Answer 1

您可以通过不使用Log2宏中的语句（仅使用表达式）来解决此问题。 这意味着您不能声明变量，但是必须将所有表达式DoLog传递给DoLog函数，并且不能使用临时变量。

也许像这样

#define Log2(code, format, ...)                                          \
    (DoLog("[%s:%d] %s: " format "\n",                                   \
         strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__, \
         __LINE__,                                                       \
         ErrorCode_ToString(code),                                       \
         ##__VA_ARGS__                                                   \
     ),                                                                  \
     code /* Will be the result of the expression */                     \
    )

如果在return语句中使用它，例如

return LogError(ErrorCode_TypeMismatch);

宏将扩展为

return (DoLog(...), ErrorCode_TypeMismatch);

它将评估DoLog调用，并感谢逗号表达式返回错误代码。