条件编译指令(符号),C语言条件编译指令完全攻略

 在 C 语言中,条件编译指令可以实现源代码的部分编译功能,可以根据表达式的值或者某个特定的宏来确定编译条件,以决定编译哪些代码,不编译哪些。

使用“#ifndef/#define/#endif”防止头文件被重复引用

在 C 语言中,一个文件中可以包含多个头文件,而头文件之间又是可以相互引用的,这将引起一个文件中可能间接多次包含某个头文件,从而导致了某些头文件被重复引用多次。

例如,有 3 个文件 a.h、b.h 和 c.h,其中 b 文件中包含了 a.h,而 c 文件中又分别包含了 a.h 和 b.h 两个文件。于是问题出来了,由于嵌套包含文件的原因,头文件 a.h 被两次包含在源文件 c 中。在这里,如果头文件中没有防止多次编译的语句,有可能会引起如下两种后果:
  • 某些头文件重复引用只是增加了编译器编译的工作量,导致编译效率降低,不会引起太大的问题。但是,这里还需要说明的是,对比较大的工程而言,编译效率低下也将是一件非常痛苦的事情。
  • 某些头文件重复引用,有可能会引起意想不到的严重错误。比如,在头文件中定义了全局变量(虽然这种方式不被推荐,但有时候确实需要这么做),将会导致全局变量被重复定义。

在 C 语言中,避免同一个头文件被多次包含、重复引用,最常用也是最简单的方法就是利用“#ifndef/#define/#endif”结构产生预处理块来防止头文件被重复引用。如下面的示例代码所示:
#ifndef __HEADERNAME_H__
#define __HEADERNAME_H__
/*声明、定义语句*/
#endif
在上面的预处理块中,当第一次引用(include)头文件时,由于“__HEADERNAME_H__”还没有被宏定义(define)过,即满足“#ifndef__HEADERNAME_H__”,从而执行“#define__HEADERNAME_H__”以及其他内容。

如果因为编码者的不小心或者嵌套包含等原因造成了这个头文件被多次引用(include),那么“#ifndef__HEADERNAME_H__”判断条件将在第二次引用(include)头文件时得不到满足,因此不执行后面的内容,直接跳到“#endif”。

通过“#ifndef/#define/#endif”结构产生预处理块,虽然能够避免同一个头文件被多次包含和重复引用,但也存在一个致命的缺点,那就是一旦一不小心在不同头文件中定义了相同的宏名,问题就比较麻烦了。比如,可能会导致明明看到存在头文件,而编译器却硬说找不到声明等问题。为了避免这种情况,保证宏名的唯一性,建议按照 Google 公司的建议,头文件基于其所在项目源代码树的全路径进行命名。命名格式为:

<PROJECT>_<PATH>_<FILE>_H_

其中,PROJECT 表示项目名称,PATH 表示头文件相对路径,FILE 表示文件名,再以“_H_”作为后缀。比如,在项目 CashRegister 中,现在该项目所在目录下的一个名为 xml 的子文件夹下的一个 parser 头文件,则宏定义如下:
#ifndef CASHREGISTER_XML_PARSER_H_
#define CASHREGISTER_XML_PARSER_H_
/*声明、定义语句*/
#endif
当然,基于命名习惯原因,也可以这样来写:
#ifndef _CASHREGISTER_XML_PARSER_H_
#define _CASHREGISTER_XML_PARSER_H_
/*声明、定义语句*/
#endif
这里需要注意的是,由于编译器在每次编译时都需要打开头文件才能判定是否有重复定义,因此在编译大型项目时,“#ifndef”会使编译时间相对较长。

除此之外,你还可以使用“#pragma once”方式来防止头文件被重复引用,该方式一般由编译器提供,可以保证同一个文件不会被包含多次。但这里需要特别说明的是,该方式受编译器的限制,有些编译器并不支持该指令,因此在兼容性方面表现得不是很好。这里建议为了代码的兼容性,宁肯降低一些编译性能,还是使用“#ifndef/#define/#endif”结构。

使用条件编译指令实现源代码的部分编译

前面已经说过,条件编译指令可以使编译器按不同的条件编译不同的程序部分,因而产生不同的目标代码文件。这对于程序的移植和调试是很有用的,尤其是针对于跨平台程序移植的时候。在 C 语言中,主要有如下条件编译指令。

1、#if指令

该指令检测表达式值是否为真。如果表达式的值为真,则编译后面的代码直到出现 #else、#elif 或 #endif 为止,否则不编译。

2、#endif指令

该指令用于终止 #if 指令。

3、#else指令

该指令用于 #if 指令之后,当前面的 #if 指令的条件不为真时,就编译 #else 后面的代码。

4、#elif指令

该指令综合了 #else 和 #if 指令的作用。下面的示例代码演示了 #if、#else、#elif 与 #endif 的组合使用情况。
#if OS==1
    printf("V1.0");
#elif OS==2
    printf("V2.0");
#else
    printf("未知");
#endif

5、#ifdef 和 #ifndef 指令

相对于 #if 指令(检测表达式的值是否为真),#ifdef 和 #ifndef 指令用于检测指令关键字后面的宏名称是否已经定义。其中,#ifdef 指令表示如果宏已经被定义,那么它的检测结果为真,否则返回假;而 #ifndef 指令的含义正好与 #ifdef 指令相反,它表示如果宏未被定义,那么它的检测结果为真,否则为假。

在一般情况下,条件编译指令组合主要有如下几种形式。
1) 第一种形式如下:

#ifdef 宏名称
    /*程序段1*/
#else
    /*程序段2*/
#endif

它表示如果宏名称已经定义,则对程序段 1 进行编译;否则对程序段 2 进行编译。如果没有程序段 2,则可以省略“#else”,如下所示:

#ifdef 宏名称
    /*程序段1*/
#endif


2) 第二种形式如下:

#ifndef 宏名称
    /*程序段1*/
#else
    /*程序段2*/
#endif

#ifndef 指令的含义正好与 #ifdef 指令相反,因此它表示如果宏名称未被定义,则对程序段 1 进行编译,否则对程序段 2 进行编译。

3) 第三种形式如下:

#if 表达式
    /*程序段1*/
#else
    /*程序段2*/
#endif

它表示如果表达式的值为真(非 0),则对程序段 1 进行编译,否则对程序段 2 进行编译。如果有多个(两个以上)条件,则可以用 #elif 指令,如下所示:

#if 表达式
    /*程序段1*/
#elif 表达式
    /*程序段2*/
#elif 表达式
    /*程序段3*/
#else
    /*程序段4*/
#endif

妙用“defined”

在 C 语言中,除了“#ifdef”和“#ifndef”指令之外,还可以使用 defined 判断标识符是否定义过。实际上,“#if defined”等价于“#ifdef”,而“#if!defined”等价于“#ifndef”。例如,下面的示例代码就演示了如何使用 defined 来避免重复包含头文件引起的重复定义问题:
#if !defined(_CASHREGISTER_XML_PARSER_H_)
#define _CASHREGISTER_XML_PARSER_H_
/*声明、定义语句*/
#endif
它实际上等价于下面的代码:
#ifndef _CASHREGISTER_XML_PARSER_H_
#define _CASHREGISTER_XML_PARSER_H_
/*声明、定义语句*/
#endif
当然,从上面的示例来看,或许看不出来使用 defined 有任何的优势。但是,在处理双重和多重判断时,defined 的优势就显现出来了,如下面的代码所示:
#ifndef _CASHREGISTER_XML_PARSER_H_
#ifndef _CASHREGISTER_XML_TRANSFORM_H_
#ifndef _CASHREGISTER_XML_DECODE_H_
/************/
#endif
#endif
#endif
从上面的代码中可以看出,使用“#ifdef”和“#ifndef”指令一次只能同时检测一个宏是否定义。如果需要检测多个宏,则需将“#ifdef”和“#ifndef”指令重复复制多次,这样看起来很不友好。但是,如果这里使用 defined,那就简单多了,如下面的代码所示:
#if !defined(_CASHREGISTER_XML_PARSER_H_)&&!defined(_CASHREGISTER_XML_TRANSFORM_H_)&&!defined(_CASHREGISTER_XML_DECODE_H_)
/************/
#endif
其实,defined 的使用是非常普及的,在一些常见的 C 语言标准库中也随处可见,例如:
#if (!defined __STRICT_ANSI__ && !defined _ISOC99_SOURCE && \
     !defined _POSIX_SOURCE && !defined _POSIX_C_SOURCE && \
     !defined _XOPEN_SOURCE && !defined _BSD_SOURCE && \
     !defined _SVID_SOURCE)
# define _BSD_SOURCE    1
# define _SVID_SOURCE    1
#endif
因此,这里建议使用 defined。因为即使当前代码使用的是简单的条件编译,以后在维护或升级时也可能会增加,这样也可以提高程序的可维护性。