C/C++之预处理命令

淩亂°似流年 2022-05-31 09:26 317阅读 0赞

C程序的源代码中可包括各种编译指令，这些指令称为预处理命令。预处理命令属于C语言编译器，而不是C语言的组成部分。C语言预处理程序包括下列命令：\#define，\#error，＃include，\#if，\#else，\#elif，\#endif，\#ifdef，\#ifndef，\#undef，\#line，\#pragma等。总体来说，预处理指令可以分为四大类：

*  宏：\#define、\#undef
 *  文件：\#include
 *  条件编译：\#if，\#else，\#elif，\#endif，\#ifdef，\#ifndef等
 *  其他：\#error,\#line和\#pragma是一些比较特殊的指令，一般很少用到。

预处理指令遵循以下规则：

*  指令都是以\#开始。\#符号不需要在一行的行首，只要她之前有空白字符就行。在\#后是指令名，接着是指令所需要的其他信息。
 *  在指令的符号之间可以插入任意数量的空格或横向制表符。
 *  指令总是第一个换行符处结束，除非明确地指明要继续。
 *  指令可以出现在程序中的任何地方。通常将\#define和\#include指令放在文件的开始，其他指令则放在后面，甚至在函数定义的中间。
 *  注释可以与指令放在同一行。

***以上规则，在C99标准文档的6.10章节可有介绍。***

**0x01 宏指令 \#define**

唯一需要注意的就是该语句*没有分号*。在标识符和串之间可以有任意个空格，串一旦开始，仅由一新行结束。

**0x02 文件指令\#include**

\#include命令的作用是把指定的文件模块内容插入到\#include所在的位置，当程序编译链接时，系统会把所有\#include指定的文件链接生成可执行代码。

（1）如果显式路径名为文件标识符的一部分，则仅在那些子目录中搜索被嵌入文件。否则，如果文件名用**双引号**括起来，则首先检索当前工作目录。如果未发现文件，则在命令行中说明的所有目录中搜索。如果仍未发现文件，则搜索实现时定义的标准目录。如果没有显式路径名且文件名被**尖括号**括起来，则首先在编译命令行中的目录内检索。如果文件没找到，则检索标准目录，不检索当前工作目录。

（2）通过\#define包含进来的文件模块中还可以再包含其他文件，这种用法称为嵌套包含。嵌套的层数与具体C语言系统有关，但是一般可以嵌套8层以上。

（3）\#include 也可以包含.c文件。但是一般不会这么用

下面以Linux下gcc为例：

\#include "headfile.h"

①先搜索当前目录

②然后搜索-I指定的目录

③再搜索gcc的环境变量CPLUS\_INCLUDE\_PATH（C程序使用的是C\_INCLUDE\_PATH）

④最后搜索gcc的内定目录

/usr/include

/usr/local/include

/usr/lib/gcc/x86\_64-redhat-linux/4.1.1/include

\#include <headfile.h>

①先搜索-I指定的目录

②然后搜索gcc的环境变量CPLUS\_INCLUDE\_PATH

③最后搜索gcc的内定目录

/usr/include

/usr/local/include

/usr/lib/gcc/x86\_64-redhat-linux/4.1.1/include

库的搜索路径：

①gcc会去找-L

②再找gcc的环境变量LIBRARY\_PATH

③再找内定目录 /lib、/usr/lib、/usr/local/lib

**0x03 条件编译**

**以下内容源自某技术博客**

**1、\#if, \#elif, \#else, \#endif**

\#if　条件1  
　代码段1  
\#elif 条件2  
 代码段2  
...  
\#elif 条件n  
 代码段n  
\#else  
 代码段 n+1  
\#endif

即可以设置不同的条件，在编译时编译不同的代码，预编译指令中的表达式与C语言本身的表达式基本一至如逻辑运算、算术运算、位运算等均可以在预编译指令中使用。之所以能够实现条件编译是因为预编译指令是在编译之前进行处理的，通过预编译进行宏替换、条件选择代码段，然后生成最后的待编译代码，最后进行编译。

\#if的一般含义是如果\#if 后面的常量表达式为true，则编译它所控制的代码，如条件1成立时就代码段1，条件1不成立再看条件2是否成立，如果条件2成立则编译代码段2，否则再依次类推判断其它条件，如果条件1－N都不成力则会编译最后的代码段n+1。

**2、\#ifdef, \#else, \#endif或\#ifndef, \#else, \#endif**

条件编译的另一种方法是用\#ifdef与\#ifndef命令，它们分别表示"如果有定义"及"如果无定义"。有定义是指在*编译本段代码时是否有某个宏通过 \#define 指令定义的宏*，\#ifndef指令指找不到通过 \#define 定义的某宏，该宏可以是在当前文件此条指令的前面定义的，也可以是在该文件包含的其它文件中。

\#ifdef的一般形式是：

\#ifdef macro\_name  
 代码段1  
\#else  
 代码段2  
\#endif

\#ifndef的一般形式是：

\#ifndef macro\_name  
 代码段2  
\#else  
 代码段1  
\#endif

这两段代码的效果是完全一样的。

**3、通过宏函数defined(macro\_name)**

参数为宏名（无需加"")，如果该macro\_name定义过则返回真，否则返回假，用该函数则可以写比较复杂的条件编译指令，如\#if defined(macro1)||(!defined(macro2) && defined(macro3))...\#else...\#endif

**（1）\#ifdef和\#defined()比较**

首先比较一下这两种方法，第一种方法只能判断一个宏，如果条件比较复杂实现起来比较烦锁，用后者就比较方便。如有两个宏MACRO\_1,MACRO\_2只有两个宏都定义过才会编译代码段A，分别实现如下：

\#ifdef MACRO\_1

\#ifdef MACRO\_2

代码段　A

\#endif

或者

\#if defined(MACRO\_1) && defined(MACRO\_2)

\#endif

同样，要实现更复杂的条件用\#ifdef更麻烦，所以推荐使用后者，因为即使当前代码用的是简单的条件编译，以后在维护、升级时可能会增加，用后者可维护性较强。旧的编译器可能没有实现\#defined()指令，C99已经加为标准。要兼容老的编译器，还需用\#ifdef指令。

2、\#if与 \#ifdef或\#if defined()比较

比如自己写了一个printf函数，想通过一个宏MY\_PRINTF\_EN实现条件编译，用\#if可实现如下

\#define MY\_PRINTF\_EN 1  
\#if MYS\_PRINTF\_EN == 1  
int printf(char\* fmt, char\* args, ...)  
\{

...

\#endif

如果宏MY\_PRINTF\_EN定义为1则编译这段代码，如果宏定义不为1或者没有定义该宏，则不编译这段代码。同样也可以通过\#ifdef或者\#defined()实现，如

\#define MY\_PRINTF\_EN 1  
\#if defined(MY\_PRINTF\_EN)  
int printf(char\* fmt, char\* args, ...)  
\{

...

\#endif

在这种情况下两种方法具有异曲同工之妙，但试想如果你为了节约代码写了两个printf函数，在不同情况下使用不同的printf函数，一个是精简版一个是全功能标准版，如：

\#define MY\_PRINTF\_SIMPLE

\#ifdef MY\_PRINTF\_SIMPLE

void printf(\*str) // 向终端简单地输出一个字符串

...

\#endif

\#ifdef MY\_PRINTF\_STANDARD

int printf(char\* fmt, char\* args, ...)

...

\#endif

同样可以用\#if defined()实现

\#define MY\_PRINTF\_SIMPLE

\#if defined(MY\_PRINTF\_SIMPLE)

void printf(\*str) // 向终端简单地输出一个字符串

...

\#elif defined(MY\_PRINTF\_STANDARD)

int printf(char\* fmt, char\* args, ...)

...

\#endif

两种方法都可以实现，但可见后者更方便。但试想如果你有三个版本，用前者就更麻烦了，但方法相似，用后者就更方便，但仍需三个宏进行控制，你要住三个宏，改进一下就用\#if可以用一个宏直接控制N种情况如：

\#define MY\_PRINTF\_VERSION    1

\#if MY\_PRINTF\_VERSION == 1

void printf(\*str) // 向终端简单地输出一个字符串

...

\#elif MY\_PRINTF\_VERSION == 2

int printf(char\* fmt, char\* args, ...)

...

\#elif MY\_PRINTF\_VERSION == 3

int printf(unsigned char com\_number, char\* str)

...

\#else

默认版本

\#endif

这样，你只需修改一下数字就可以完成版本的选择了

看来好像用\#if 比较好了，试想如下情况：你写了一个配置文件叫做config.h用来配置一些宏，通过这些宏来控制代码，如你在config.h的宏\#define MY\_PRINTF\_EN 1来控制是否需要编译自己的printf函数，而在你的源代码文件printf.c中有如下指令

\#include "config.h"

\#if MY\_PRINTF\_EN == 1

int printf(char\* fmt, char\* args, ...)

...

\#endif

但这样也会有一个问题，就是如果你忘了在config.h中添加宏MY\_PRINTF\_EN，那么自己写的printf函数也不会被编译，有些编译器会给出警告:MY\_PRINTF\_EN未定义。如果你有两个版本的想有一个默认版本，可以在printf.c中这样实现

\#incldue "config.h"

\#if !defined(MY\_PRINTF\_VERSION)

\#define MY\_PRINTF\_VERSION   1

\#endif

\#if MY\_PRINTF\_VERSION == 1

void printf(\*str) // 向终端简单地输出一个字符串

...

\#elif MY\_PRINTF\_VERSION == 2

int printf(char\* fmt, char\* args, ...)

...

\#elif MY\_PRINTF\_VERSION == 3

int printf(unsigned char com\_number, char\* str)

\#endif

这种情况下还得用到\#ifdef或\#if　defined()，你可以不用动主体的任何代码，只需要修改printf.c文件中MY\_RPINTF\_VERSION宏的数字就可以改变了，如果用前面那种方法还得拖动代码，在拖动中就有可能造成错误。

再试想，如果软件升级了，或者有了大的改动，原来有三个版本，现在只剩下两个版本了，如

\#if MY\_PRINTF\_VERSION == 2

int printf(char\* fmt, char\* args, ...)

\{...

\#elif MY\_PRINTF\_VERSION == 3

int printf(unsigned char com\_number, char\* str)

\#endif

因为这些核心代码不想让使用这些代码的人关心，他们只需要修改config.h文件，那就要在printf.c中实现兼容性。如果以前有人在config.h配置宏MY\_PRINTF\_VERSION为1,即有\#define MY\_PRINTF\_VERSION   1，而现在没有1版本了，要想兼容怎么办？那当然可以用更复杂的条件实现如：

\#if MY\_PRINTF\_VERSION == 2 || MY\_PRINTF\_VERSION == 1

int printf(char\* fmt, char\* args, ...)

...

\#elif MY\_PRINTF\_VERSION == 3

int printf(unsigned char com\_number, char\* str)

\#endif

不过还有另外一种方法，即使用\#undef命令

\#if MY\_PRINTF\_VERSION == 1

\#undef MY\_PRINTF\_VERSION

\#define MY\_PRINTF\_VERSION  2

\#endif

\#if MY\_PRINTF\_VERSION == 2

int printf(char\* fmt, char\* args, ...)

...

\#elif MY\_PRINTF\_VERSION == 3

int printf(unsigned char com\_number, char\* str)

\#endif

用\#if还有一个好处，如果你把宏名记错了，把MY\_PRINTF\_EN定义成了MY\_PRINT\_EN，那么你用\#ifdef MY\_PRINTF\_EN或者\#if defined(MY\_PRINTF\_EN)控制的代码就不能被编译，查起来又不好查，用\#if MY\_PRINTF\_EN ==1控制就很好查，因为你把MY\_PRINTF\_EN定义成MY\_PRINT\_EN，则MY\_PRINTF\_EN实际上没有定义，那么编译器会给出警告\#if MY\_PRINTF\_EN　== 1中的MY\_PRINTF\_EN没有定义，但错就比较快。

**0x04 其他**