为什么这个. c文件#包含它自己？

Question

为什么这个. c文件#包含本身？

• https://github.com/powturbo/TurboPFor-Integer-Compression

简单的

#define USIZE 8
#include "vsimple.c"
#undef USIZE

#define USIZE 16
#include "vsimple.c"
#undef USIZE

#define USIZE 32
#include "vsimple.c"
#undef USIZE

#define USIZE 64
#include "vsimple.c"
#undef USIZE

Answer 1

@chqrlie 100%的公认答案解释了正在发生的事情。这只是一个补充评论。

如果使用C，我们可以定义两个模板函数来提供vsenc8，vsenc16，vsenc32，vsenc64和vsdec8，vsdec16，vsdec32，vsdec64。然而，相比之下，C是一种非常简单的语言，不支持模板。要想拥有同样的能力（在更丑陋的包装中），一个常见的技巧是使用该语言的哑宏功能，让C预处理器为我们做同样的工作。大多数有一定经验的C程序员在职业生涯中会反复遇到并使用这种结构。

理解这个特定示例有点乏味的是，实现文件被非常规地解析了5次，首先有一些预备定义，然后是两个函数的四个变体。第一个过程（在#ifndef USIZE预处理器块内）将定义所需的宏和非变量，并将递归地#使用不同的USIZE值（8，16，32，64）作为模板值，包括本身四次。当递归包含时，相应的#else预处理器块将使用根据过程中使用的USIZE宏常量值生成的两个函数的结果进行解析。

更传统、概念更清晰、易于理解的方法是包含来自不同文件的模板函数，比如vsimple。impl：

#define USIZE 8
/* Generate vsenc8(), vsdec8()... */ 
#include "vsimple.impl"

#undef USIZE
#define USIZE 16
/* Generate vsenc16(), vsdec16()... */ 
#include "vsimple.impl"

#undef USIZE
#define USIZE 32
/* Generate vsenc32(), vsdec32()... */ 
#include "vsimple.impl"

#undef USIZE
#define USIZE 64
/* Generate vsenc64(), vsdec64()... */ 
#include "vsimple.impl"

包含文件vsimple。c和包含的文件vsimple。impl也可以被组织起来，以便更清楚地定义它们的定义和时间。大多数C程序员会识别实现模式，并立即知道发生了什么。

以这种方式递归地、反复地包含它自己，会让人产生一种hocus pocery的感觉，这种感觉会因为一个模糊的C竞争条目而受到欢迎，但对于关键任务的生产代码则不会。

Answer 2

该文件包含自身，因此可以使用相同的源代码为宏USIZE的特定值生成4组不同的函数。

#include指令实际上封装在#ifndef中：

#ifndef USIZE

// common definitions
...
//

#define VSENC vsenc
#define VSDEC vsdec

#define USIZE 8
#include "vsimple.c"
#undef USIZE

#define USIZE 16
#include "vsimple.c"
#undef USIZE

#define USIZE 32
#include "vsimple.c"
#undef USIZE

#define USIZE 64
#include "vsimple.c"
#undef USIZE

#else // defined(USIZE)

// macro expanded size specific functions using token pasting

...

#define uint_t TEMPLATE3(uint, USIZE, _t)

unsigned char *TEMPLATE2(VSENC, USIZE)(uint_t *__restrict in, size_t n, unsigned char *__restrict out) {
   ...
}

unsigned char *TEMPLATE2(VSDEC, USIZE)(unsigned char *__restrict ip, size_t n, uint_t *__restrict op) {
   ...
}

#endif

本模块中定义的功能有

// vsencNN: compress array with n unsigned (NN bits in[n]) values to the buffer out. Return value = end of compressed output buffer out
unsigned char *vsenc8( unsigned char  *__restrict in, size_t n, unsigned char  *__restrict out);
unsigned char *vsenc16(unsigned short *__restrict in, size_t n, unsigned char  *__restrict out);
unsigned char *vsenc32(unsigned       *__restrict in, size_t n, unsigned char  *__restrict out);
unsigned char *vsenc64(uint64_t       *__restrict in, size_t n, unsigned char  *__restrict out);

// vsdecNN: decompress buffer into an array of n unsigned values. Return value = end of compressed input buffer in
unsigned char *vsdec8( unsigned char  *__restrict in, size_t n, unsigned char  *__restrict out);
unsigned char *vsdec16(unsigned char  *__restrict in, size_t n, unsigned short *__restrict out);
unsigned char *vsdec32(unsigned char  *__restrict in, size_t n, unsigned       *__restrict out);
unsigned char *vsdec64(unsigned char  *__restrict in, size_t n, uint64_t       *__restrict out);

它们都是从videe. c中的两个函数定义扩展而来的：

unsigned char *TEMPLATE2(VSENC, USIZE)(uint_t *__restrict in, size_t n, unsigned char *__restrict out) {
   ...
}

unsigned char *TEMPLATE2(VSDEC, USIZE)(unsigned char *__restrict ip, size_t n, uint_t *__restrict op) {
   ...
}

TEMPLATE2和TEMPLATE3宏在conf.h中定义为

#define TEMPLATE2_(_x_, _y_) _x_##_y_
#define TEMPLATE2(_x_, _y_) TEMPLATE2_(_x_,_y_)

#define TEMPLATE3_(_x_,_y_,_z_) _x_##_y_##_z_
#define TEMPLATE3(_x_,_y_,_z_) TEMPLATE3_(_x_, _y_, _z_)

因此，unsigned char*TEMPLATE2（VSENC，USIZE）（uint_t*_\u restrict in，size_t n，unsigned char*_restrictout）被扩展为unsigned char*vsenc8（uint8_t*_restrictin，size_t n，unsigned char*_restrictout）在第一个包含中，vsenc16（uint16_t*_restrictin，在第二个包含中，等等。

预处理源代码的这种用法在单独的文件中更常见：一个用于实例化部分，该部分具有所有公共定义，特别是宏，另一个用于代码和数据模板的单独文件，该文件通过不同的宏定义被包含多次。

一个很好的例子是从QuickJS中的atom和操作码定义生成枚举、字符串和结构数组。