条件编译#ifdef的妙用详解

2018/07/02 23:34
阅读数 42
c语言中条件编译相关的预编译指令,包括   #define、#undef、#ifdef、#ifndef、#if、#elif、#else、#endif、defined。
#define            定义一个预处理宏
#undef            取消宏的定义

#if                   编译预处理中的条件命令,相当于C语法中的if语句
#ifdef              判断某个宏是否被定义,若已定义,执行随后的语句
#ifndef            与#ifdef相反,判断某个宏是否未被定义
#elif                若#if, #ifdef, #ifndef或前面的#elif条件不满足,则执行#elif之后的语句,相当于C语法中的else-if
#else              与#if, #ifdef, #ifndef对应, 若这些条件不满足,则执行#else之后的语句,相当于C语法中的else
#endif             #if, #ifdef, #ifndef这些条件命令的结束标志.
defined          与#if, #elif配合使用,判断某个宏是否被定义
以#开头的都是预编译指令,就是在正式编译之前,编译器做一些预处理的工作

#if 条件语句
程序段1 //如果条件语句成立,那么就编译程序段1
#endif
程序段2//如果条件不语句成立,那么就编译程序段2

#ifndef x//先测试x是否被宏定义过
#define 程序段1 //如果x没有被宏定义过,那么就编译程序段1
#endif
程序段2 //如果x已经定义过了则编译程序段2的语句,“忽视”程序段1。

#ifdef x //先测试x是否被宏定义过
程序段1 //如果x被宏定义过,那么就编译程序段1
#endif
程序段2 //如果x没有被定义过则编译程序段2的语句,“忽视”程序段1。

if就是判断语句,不是预编译指令

常见的预处理指令如下:

  1. #空指令,无任何效果
  2. #include包含一个源代码文件
  3. #define定义宏
  4. #undef取消已定义的宏
  5. #if如果给定条件为真,则编译下面代码
  6. #ifdef如果宏已经定义,则编译下面代码
  7. #ifndef如果宏没有定义,则编译下面代码
  8. #elif如果前面的#if给定条件不为真,当前条件为真,则编译下面代码
  9. #endif结束一个#if……#else条件编译块
  10. #error停止编译并显示错误信息
(一)条件编译方法

 条件编译是通过预编译指令来实现的,主要方法有:

 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 #ifdef的一般形式是: #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 #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中有如下指令

 #i nclude "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没有定义,但错就比较快。

   请看下面一个例子:

  1.  
    #include<stdio.h>
  2.  
    #define BB
  3.  
    #ifdef AA
  4.  
    #define HELLO "hello world"
  5.  
    #elif BB
  6.  
    #define HELLO "hello CC"
  7.  
    #endifint main()
  8.  
    {
  9.  
    printf("%s\n",HELLO);
  10.  
    return 1;
  11.  
    }

 

        如果你觉得这个打印会是hello CC.那你就和我犯了一样的错误了。如果你用gcc -E hello.c -o hello.i 编译,(这条是预编译命令,下面会讲到。)会出现:error: #if with no expression的错误。原因是BB虽然定义了,但是定义的是空值,放在#elif后面就不行。因为#elif不仅仅是检查后面的宏有没有定义,还会检查其值。但是#ifdef就只是检查后面的宏是否定义,而不管其值为多少。读者可以把#define
        BB改成#define AA试一下,结果就会打印hello world了。
        读者如果有兴趣,也可以把#define BB改成#define BB   0  试一试,这时用gcc -E hello.c -o hello.i预编译可以编译通过,但是编译过程就不行了,因为#elif   0为假,HELLO没有定义。
这几个宏是为了进行条件编译。一般情况下,源程序中所有的行都参加编译。但是有时希望对其中一部分内容只在满足一定条件才进行编译,也就是对一部 分内容指定编译的条件,这就是“条件编译”。有时,希望当满足某条件时对一组语句进行编译,而当条件不满足时则编译另一组语句。
    条件编译命令最常见的形式为: 
    #ifdef 标识符 
    程序段1 
    #else 
    程序段2 
    #endif 
     
    它的作用是:当标识符已经被定义过(一般是用#define命令定义),则对程序段1进行编译,否则编译程序段2。 
    其中#else部分也可以没有,即: 
    #ifdef 
    程序段1 
    #denif 
     
    这里的“程序段”可以是语句组,也可以是命令行。这种条件编译可以提高C源程序的通用性。如果一个C源程序在不同计算机系统上运行,而不同的计算机又有一定的差异。例如,我们有一个数据类型,在Windows平台中,应该使用long类型表示,而在其他平台应该使用float表示,这样往往需要对源程序作必要的修改,这就降低了程序的通用性。可以用以下的条件编译:
    #ifdef WINDOWS 
    #define MYTYPE long 
    #else 
    #define MYTYPE float 
    #endif 
     
    如果在Windows上编译程序,则可以在程序的开始加上 
    #define WINDOWS 
     
    这样则编译下面的命令行: 
    #define MYTYPE long 
     
    如果在这组条件编译命令之前曾出现以下命令行: 
    #define WINDOWS 0 
     
    则预编译后程序中的MYTYPE都用float代替。这样,源程序可以不必作任何修改就可以用于不同类型的计算机系统。当然以上介绍的只是一种简单的情况,可以根据此思路设计出其它的条件编译。
    例如,在调试程序时,常常希望输出一些所需的信息,而在调试完成后不再输出这些信息。可以在源程序中插入以下的条件编译段: 
    #ifdef DEBUG 
    print ("device_open(%p)\n", file); 
    #endif 
     
    如果在它的前面有以下命令行: 
    #define DEBUG 
     
    则在程序运行时输出file指针的值,以便调试分析。调试完成后只需将这个define命令行删除即可。有人可能觉得不用条件编译也可达此目的,即在调试时加一批printf语句,调试后一一将printf语句删除去。的确,这是可以的。但是,当调试时加的printf语句比较多时,修改的工作量是很大的。用条件编译,则不必一一删改printf语句,只需删除前面的一条“#define DEBUG”命令即可,这时所有的用DEBUG作标识符的条件编译段都使其中的printf语句不起作用,即起统一控制的作用,如同一个“开关”一样。
    有时也采用下面的形式: 
    #ifndef 标识符 
    程序段1 
    #else 
    程序段2 
    #endif 
     
    只是第一行与第一种形式不同:将“ifdef”改为“ifndef”。它的作用是:若标识符未被定义则编译程序段1,否则编译程序段2。这种形式与第一种形式的作用相反。
    以上两种形式用法差不多,根据需要任选一种,视方便而定。 
    还有一种形式,就是#if后面的是一个表达式,而不是一个简单的标识符: 
    #if 表达式 
    程序段1 
    #else 
    程序段2 
    #endif 
     
    它的作用是:当指定的表达式值为真(非零)时就编译程序段1,否则编译程序段2。可以事先给定一定条件,使程序在不同的条件下执行不同的功能。 
    例如:输入一行字母字符,根据需要设置条件编译,使之能将字母全改为大写输出,或全改为小写字母输出。 
    #define LETTER 1 
    main() 
    { 
    char str[20]="C Language",c; 
    int i="0"; 
    while((c=str[i])!='\0'){ 
    i++; 
    #if LETTER 
    if(c>='a'&&c<='z') c="c-32"; 
    #else 
    if(c>='A'&&c<='Z') c="c"+32; 
    #endif 
    printf("%c",c); 
    } 
    } 
     
    运行结果为:C LANGUAGE 
    现在先定义LETTER为1,这样在预处理条件编译命令时,由于LETTER为真(非零),则对第一个if语句进行编译,运行时使小写字母变大写。如果将程序第一行改为:
    #define LETTER 0 
     
    则在预处理时,对第二个if语句进行编译处理,使大写字母变成小写字母(大写字母与相应的小写字母的ASCII代码差32)。此时运行情况为: 
    c language 
    有人会问:不用条件编译命令而直接用if语句也能达到要求,用条件编译命令有什么好处呢?的确,此问题完全可以不用条件编译处理,但那样做目标程序长(因为所有语句都编译),而采用条件编译,可以减少被编译的语句,从而减少目标的长度。当条件编译段比较多时,目标程序长度可以大大减少。


浅谈#ifdef在软件开发中的妙用

  笔者从事UNIX环境下某应用软件的开发与维护工作,用户分布于全国各地,各用户需要的基本功能都是一样的,但在某些功能上要随着需求变化,不断加以升级,要想实现全国各地用户的升级工作是很困难的,而我们则只是利用E-mail发送补丁程序给用户,这些补丁程序都是在一套软件的基础上不断地修改与扩充而编写的,并由不同的标志文件转入到不同的模块,虽然程序体积在不断扩大,但丝毫不影响老用户的功能,这主要是得益于C程序的#ifdef/#else/#endif的作用。


  我们主要使用以下几种方法,假设我们已在程序首部定义#ifdef DEBUG与#ifdef TEST:

  1.利用#ifdef/#endif将某程序功能模块包括进去,以向某用户提供该功能。

  在程序首部定义#ifdef HNLD:

  #ifdef HNLD

  include"n166_hn.c"

  #endif

  如果不许向别的用户提供该功能,则在编译之前将首部的HNLD加一下划线即可。

  2.在每一个子程序前加上标记,以便追踪程序的运行。

  #ifdef DEBUG

  printf(" Now is in hunan !");

  #endif

  3.避开硬件的限制。有时一些具体应用环境的硬件不一样,但限于条件,本地缺乏这种设备,于是绕过硬件,直接写出预期结果。具体做法是:

  #ifndef TEST

  i=dial();

  //程序调试运行时绕过此语句

  #else

  i=0;

  #endif

  调试通过后,再屏蔽TEST的定义并重新编译,即可发给用户使用了。

# ifdef  #ifndef 等用法(转)

  头件的中的#ifndef,这是一个很关键的东西。比如你有两个C文件,这两个C文件都include了同一个头文件。而编译时,这两个C文件要一同编译成一个可运行文件,于是问题来了,大量的声明冲突。

还是把头文件的内容都放在#ifndef和#endif中吧。不管你的头文件会不会被多个文件引用,你都要加上这个。一般格式是这样的:

#ifndef <标识> 
#define <标识>

...... 
......

#endif

<标识>在理论上来说可以是自由命名的,但每个头文件的这个“标识”都应该是唯一的。标识的命名规则一般是头文件名全大写,前后加下划线,并把文件名中的“.”也变成下划线,如:stdio.h

#ifndef _STDIO_H_ 
#define _STDIO_H_

......

#endif

2.在#ifndef中定义变量出现的问题(一般不定义在#ifndef中)。

#ifndef AAA
#define AAA
...
int i;
...
#endif
里面有一个变量定义
在vc中链接时就出现了i重复定义的错误,而在c中成功编译。

结论:

(1).当你第一个使用这个头的.cpp文件生成.obj的时候,int i 在里面定义了当另外一个使用这个的.cpp再次[单独]生成.obj的时候,int i 又被定义然后两个obj被另外一个.cpp也include 这个头的,连接在一起,就会出现重复定义.

(2).把源程序文件扩展名改成.c后,VC按照C语言的语法对源程序进行编译,而不是C++。在C语言中,若是遇到多个int i,则自动认为其中一个是定义,其他的是声明。

(3).C语言和C++语言连接结果不同,可能(猜测)是在进行编译的时候,C++语言将全局
变量默认为强符号,所以连接出错。C语言则依照是否初始化进行强弱的判断的。(参考)

解决方法:

(1).把源程序文件扩展名改成.c。

(2).推荐解决方案:
.h中只声明 extern int i;在.cpp中定义

<x.h>
#ifndef __X_H__
#define __X_H__
extern int i;
#endif //__X_H__
<x.c>
int i;

注意问题:

(1).变量一般不要定义在.h文件中。

展开阅读全文
打赏
0
0 收藏
分享
加载中
更多评论
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部