c - 编写一个接受可变参数并返回一个值的 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 函数，而不是使用临时变量。

也许是这样的

#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 LogError(ErrorCode_TypeMismatch);

宏将展开为

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

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