如何将 printf() 包装到函数或宏中？

Question

这听起来像是一个面试问题，但实际上是一个实际问题。

我正在使用嵌入式平台，并且只有这些功能的等价物：

• printf()
• snprintf()

此外，printf() 实现（和签名）可能会在不久的将来发生变化，因此对其的调用必须驻留在单独的模块中，以便以后轻松迁移。

鉴于此，我可以将日志调用包装在某个函数或宏中吗？目标是我的源代码在一千个地方调用THAT_MACRO("Number of bunnies: %d", numBunnies);，但对上述函数的调用只在一个地方看到。

编译器：arm-gcc -std=c99

编辑：只是提一下，但在 2000 年的最佳实践之后，可能更早，内联函数比宏要好得多，原因有很多。

Answer 1

有两种方法可以做到这一点：

1. 变量宏

   #define my_printf(...) printf(__VA_ARGS__)
   

2. 转发va_args的函数

   #include <stdarg.h>
   #include <stdio.h>
   
   void my_printf(const char *fmt, ...) {
       va_list args;
       va_start(args, fmt);
       vprintf(fmt, args);
       va_end(args);
   }
   

还有vsnprintf、vfprintf 以及stdio 中你能想到的任何东西。

Answer 2

由于您可以使用 C99，我会将其包装在 variadic macro 中：

#define TM_PRINTF(f_, ...) printf((f_), __VA_ARGS__)
#define TM_SNPRINTF(s_, sz_, f_, ...) snprintf((s_), (sz_), (f_), __VA_ARGS__)

因为你没有说你有vprintf 或类似的东西。如果你确实有类似的东西，你可以将它包装在一个函数中，就像 Sergey L 在他的回答中提供的那样。

---

上述 TM_PRINTF 不适用于空的 VA_ARGS 列表。 至少在 GCC 中可以这样写：

#define TM_PRINTF(f_, ...) printf((f_), ##__VA_ARGS__)

如果__VA_ARGS__ 为空，则两个## 符号会删除它们前面多余的逗号。

Answer 3

如果您可以忍受将调用包含在 两个 括号中，您可以这样做：

#define THAT_MACRO(pargs)    printf pargs

然后使用它：

THAT_MACRO(("This is a string: %s\n", "foo"));
           ^
           |
          OMG

这是可行的，因为从预处理器的角度来看，整个参数列表变成一个宏参数，用括号代替。

这比单纯的做要好

#define THAT_MACRO printf

因为它允许你定义它：

#define THAT_MACRO(pargs)  /* nothing */

这会“吃掉”宏参数，它们永远不会成为编译代码的一部分。

更新当然，在 C99 中这种技术已经过时了，只要使用可变参数宏就可以了。

Answer 4

#define TM_PRINTF(f_, ...) printf((f_), ##__VA_ARGS__)

## 令牌将启用 TM_PRINTF("aaa");

Answer 5

#define PRINTF(...) printf(__VA_ARGS__)

这样工作：

它定义参数化宏 PRINTF 以接受（最多）无限参数，然后将其从 PRINTF(...) 预处理到 printf(__VA_ARGS__)。 __VA_ARGS__ 在参数化宏定义中用于表示给定的参数（因为你不能命名无限参数，对吗？）。

Answer 6

图书馆有限？嵌入式系统？需要尽可能多的性能？没问题！

正如this question 的答案所示，您可以使用汇编语言将不接受 VA_LIST 的函数包装成可以接受的函数，以很少的成本实现您自己的 vprintf！

虽然这会起作用，并且几乎可以肯定会产生您想要的性能和抽象，但我还是建议您获得一个功能更丰富的标准库，也许可以通过对uClibc 的部分进行切片。除非您绝对需要每个周期，否则这样的解决方案肯定是比使用汇编更便携且整体更有用的答案。

毕竟，这就是存在此类项目的原因。

Answer 7

这是@ldav1 出色答案的略微修改版本，它在日志之前打印时间：

#define TM_PRINTF(f_, ...)                                                                            \
{                                                                                                 \
    struct tm _tm123_;                                                                            \
    struct timeval _xxtv123_;                                                                     \
    gettimeofday(&_xxtv123_, NULL);                                                               \
    localtime_r(&_xxtv123_.tv_sec, &_tm123_);                                                     \
    printf("%2d:%2d:%2d.%d\t", _tm123_.tm_hour, _tm123_.tm_min, _tm123_.tm_sec, _xxtv123_.tv_usec); \
    printf((f_), ##__VA_ARGS__);                                                                  \
};