C语言编程常见问题解答之编译预处理

    本章集中讨论与预处理程序有关的问题。在编译程序对程序进行通常的编译之前，要先运行预处理程序。可能你以前没有见过这个程序，因为它通常在幕后运行，程序员是看不见它的，然而，这个程序非常有用。
    预处理程序将根据源代码中的预处理指令来修改你的程序。预处理指令(如#define)为预处理程序提供特定的指令，告诉它应该如何修改你的源代码。预处理程序读入所有包含的文件和待编译的源代码，经过处理生成源代码的预处理版本。在该版本中，宏和常量标识符已用相应的代码和值代替。假如源代码中包含条件预处理指令(如#if)，预处理程序将先判定条件，然后相应地修改源代码。
    预处理程序有许多非常有用的功能，例如宏定义，条件编译，在源代码中插入预定义的环境变量，打开或关闭某个编译选项，等等。对专业程序员来说，深入了解预处理程序的各种特征，是创建快速和高效的程序的要害之一。
    在阅读本章时，请记住本章采用的一些技术(以及所提到的一些常见陷阱)，以便更好地利用预处理程序的各种功能。

    5．1  什么是宏(macro)?怎样使用宏?
    宏是一种预处理指令，它提供了一种机制，可以用来替换源代码中的字符串，宏是用“#define"语句定义的，下面是一个宏定义的例子：
    #define VERSION—STAMP "1．02"

    上例中所定义的这种形式的宏通常被称为标识符。在上例中，标识符VERSION_STAMP即代表字符串"1．02"——在编译预处理时，源代码中的每个VERSION_STAMP标识符都将被字符串“1．02”替换掉。
    以下是另一个宏定义的例子：
    #define CUBE(x)((x)，(x)*(x))
    上例中定义了一个名为CUBE的宏，它有一个参数x。CUBE宏有自己的宏体，即((x)*(x)*(x))——在编译预处理时，源代码中的每个CUBE(x)宏都将被((x)*(x)*(x))替换掉。
    使用宏有以下几点好处；
    (1)在输入源代码时，可省去许多键入操作。   
    (2)因为宏只需定义一次，但可以多次使用，所以使用宏能增强程序的易读性和可靠性。
    (3)使用宏不需要额外的开销，因为宏所代表的代码只在宏出现的地方展开，因此不会引起程序中的跳转。
    (4)宏的参数对类型不敏感，因此你不必考虑将何种数据类型传递给宏。
    需要注重的是，在宏名和括起参数的括号之间绝对不能有空格。此外，为了避免在翻译宏时产生歧义，宏体也应该用括号括起来。例如，象下例中这样定义CUBE宏是不正确的：
denne CUBE(x)   x * x * x
  对传递给宏的参数也要小心，例如，一种常见的错误就是将自增变量传递给宏，请看下例：
#include <stdio. h>
#include CUBE(x) (x * x * x)
void main (void);
void main (void)
{
    int x, y;
    x = 5;
    y = CUBE( + +x);
    printfC'y is %d\n" . y);
}

    在上例中，y究竟等于多少呢?实际上，y既不等于125(5的立方)，也不等于336(6* 7*8)，而是等于512。因为变量x被作为参数传递给宏时进行了自增运算，所以上例中的CUBE宏实际上是按以下形式展开的：
    y = ((++x) * (++x) * (++x))；
    这样，每次引用x时，x都要自增，所以你得到的结果与你预期的结果相差很远，在上例中，由于x被引用了3次，而且又使用了自增运算符，因此，在展开宏的代码时，x实际上为8，你将得到8的立方，而不5的立方。
    上述错误是比较常见的，作者曾亲眼见过有多年C语言编程经验的人犯这种错误。因为在程序中检查这种错误是非常费劲的，所以你要给予充分的注重。你最好试一下上面的例子，亲眼看一下那个令人惊奇的结果值(512)。
    宏也可使用一些非凡的运算符，例如字符串化运算符“#”和。连接运算符“##”。“#”运算符能将宏的参数转换为带双引号的字符串，请看下例：
    define DEBUG_VALUE(v)  printf(#v"is equal to %d．\n"，v)
    你可以在程序中用DEBUG_VALUE宏检查变量的值，请看下例:
    int x＝20；
    DEBUG_VALUE(x);
    上述语句将在屏幕上打印"x is equal to 20"。这个例子说明，宏所使用的“#”运算符是一种非常方便的调试工具。
    “##”运算符的作用是将两个独立的字符串连接成一个字符串，详见5．16。

    请参见：
    5．10 使用宏更好，还是使用函数更好?

  5．16 连接运算符“##”有什么作用?
    5．17 怎样建立对类型不敏感的宏?
    5．18 什么是标准预定义宏?
    5．31 怎样取消一个已定义的宏?

    5．2  预处理程序(preprocessor)有什么作用?   
    C语言预处理程序的作用是根据源代码中的预处理指令修改你的源代码。预处理指令是一种命令语句(如#define)，它指示预处理程序如何修改源代码。在对程序进行通常的编译处理之前，编译程序会自动运行预处理程序，对程序进行编译预处理，这部分工作对程序员来说是不可见的。
    预处理程序读入所有包含的文件以及待编译的源代码，然后生成源代码的预处理版本。在预处理版本中，宏和常量标识符已全部被相应的代码和值替换掉了。假如源代码中包含条件预处理指令(如#if)，那么预处理程序将先判定条件，再相应地修改源代码。
    下面的例子中使用了多种预处理指令：
# include <stdio. h>
# define TRUE 1
# define FALSE (!TRUE)
# define GREATER (a, b) ((a) > (b) ? (TRUE) : (FALSE))
# define PIG-LATIN FALSE
void main (void);
void main (void)
{
    int x, y;
# if PIG_LATIN
    printf("Easeplay enternay ethay aluevay orfay xnay:") ;
    scanf("%d", &x) ;
    printf("Easeplay enternay ethay aluevay orfay ynay:");
    scanf("%d", &y);
#else
    printf(" Please enter the value for x: ");
    scanf("%d", &x);
    printf("Please enter the value for y: ");
    scanf("%d", &y);
# endif
    if (GREATER(x, y) = = TRUE)
    {
# if PIG- LATIN
    printf("xnay islay eatergray anthay ynay!\n");
#else
    printf {" x is greater than y! \n" ) ;
# endif
    }
    else
    {
# if PIG_LATIN
    printf ("xnay islay otnay eatergray anthay ynay!\n");
#else
    printf ("x is not greater than y!\n");
# endif
    }
}

   上例通过预处理指令定义了3个标识符常量(即TRUE，FALSE和PIG_LATIN)和一个宏(即GREATER(a，b))，并使用了一组条件编译指令。当预处理程序处理上例中的源代码时，它首先读入stdio.h头文件，并解释其中的预处理指令，然后把所有标识符常量和宏用相应的值和代码替换掉，最后判定PIG_LATIN是否为TRUE，并由此决定是使用拉丁文还是
使用英文。
    假如PIG_LATIN为FALSE，则上例的预处理版本将如下所示 ：
/ * Here is where all the include files
would be expanded. * /
void main (void)
{
    int x, y;
    printf("Please enter the value for X: ");
    scanf("%d", &x);
    printf("Please enter the value for y: ");
    scanf("%d", &y),
    if (((x) > (y) ? (1) : (!1)) == 1)
    {
        printf("x is greater than y!\n");
    }
    else
    {
        printf{"x is not greater than y!\n");
    }
}

    多数编译程序都提供了一个命令行选项，或者有一个独立的预处理程序，可以让你只启动预处理程序并将源代码的预处理版本保存到一个文件中。你可以用这种方法查看源代码的预处理版本，这对调试与宏或其它预处理指令有关的错误是比较有用的。

    请参见：   
    5．3  怎样避免多次包含同一个头文件?
    5．4  可以用#include指令包含类型名不是".h"的文件吗?
    5．12 #include <file>和#include"file"有什么不同?
    5．22 预处理指令#pragma有什么作用?
    5．23 #line有什么作用?

    5．3  怎样避免多次包含同一个头文件? 
    通过#ifndef和#define指令，你可以避免多次包含同一个头文件。在创建一个头文件时，你可以用#define指令为它定义一个唯一的标识符名称。你可以通过#ifndef指令检查这个标识符名称是否已被定义，假如已被定义，则说明该头文件已经被包含了，就不要再次包含该头文件；反之，则定义这个标识符名称，以避免以后再次包含该头文件。下述头文件就使用了这种技术：
# ifndef _FILENAME_H
#define _FILENAME_H

#define VER_NUM " 1. 00. 00"
#define REL_DATE "08/01/94"

#if _WINDOWS_
# define OS_VER     "WINDOWS"
#else
#define OS_VER      "DOS" 
# endif

# endif
 
    当预处理程序处理上述头文件时，它首先检查标识符名称_FILENAME_H是否已被定义——假如没有被定义，预处理程序就对此后的语句进行预处理，直到最后一个#endif语句；反之，预处理程序就不再对此后的语句进行预处理。

    请参见：  
    5．4  可以用#include指令包含类型名不是".h"的文件吗?
    5，12 #include <file>和#include“file”有什么不同?
    5．14 包含文件可以嵌套吗?
    5．15 包含文件最多可以嵌套几层?

    5. 4  可以用#include指令包含类型名不是".h"的文件吗?
    预处理程序将包含用#include指令指定的任意一个文件。例如，假如程序中有下面这样一条语句，那么预处理程序就会包含macros.inc文件。
    #include <macros.inc>

    不过，最好不要用#include指令包含类型名不是".h"的文件，因为这样不轻易区分哪些文件是用于编译预处理的。例如，修改或调试你的程序的人可能不知道查看macros.inc文件中的宏定义，而在类型名为".h"的文件中，他却找不到在macros.inc文件中定义的宏。假如将macros.inc文件改名为macros.h，就可以避免发生这种问题。

    请参见：
    5．3怎样避免多次包含同一个头文件?
    5．12#include<file>和#include“file”有什么不同?
    5，14包含文件可以嵌套吗?
    5．15包含文件最多可以嵌套几层?

    5.5  用#define指令说明常量有什么好处?
    假如用#define指令说明常量，常量只需说明一次，就可多次在程序中使用，而且维护程序时只需修改#define语句，不必一一修改常量的所有实例。例如，假如在程序中要多次使用PI(约3．14159)，就可以象下面这样说明一个常量：   
    #define PI 3.14159
    假如想提高PI的精度，只需修改在#define语句中定义的PI值，就不必在程序中到处修改了。通常，最好将#define语句放在一个头文件中，这样多个模块就可以使用同一个常量了。
    用#define指令说明常量的另一个好处是占用的内存最少，因为以这种方式定义的常量将直接进入源代码，不需要再在内存中分配变量空间。
    但是，这种方法也有缺点，即大多数调试程序无法检查用#define说明的常量。
    用#define指令说明的常量可以用#under指令取消。这意味着，假如原来定义的标识符(如NULL)不符合你的要求，你可以先取消原来的定义，然后重新按自己的要求定义一个标识符，详见5．31。

    请参见：
    5．6用enum要害字说明常量有什么好处?
    5．7与用#define指令说明常量相比，用enum要害字说明常量有什么好处?
    5．31怎样取消一个已定义的宏?

    5．6  用enum要害字说明常量有什么好处?
    用enum要害字说明常量(即说明枚举常量)有三点好处：
    (1)用enum要害字说明的常量由编译程序自动生成，程序员不需要用手工对常量一一赋值。
    (2)用enum要害字说明常量使程序更清楚易读，因为在定义enum常量的同时也定义了一个枚举类型标识符。
    (3)在调试程序时通常可以检查枚举常量，这一点是非常有用的，尤其在不得不手工检查头文件中的常量值时。
    不过，用enum要害字说明常量比用#define指令说明常量要占用更多的内存，因为前者需要分配内存来存储常量。
    以下是一个在检测程序错误时使用的枚举常量的例子：
    enum Error_Code
    {
        OUT_OF_MEMORY，
        INSUFFICIENT_DISK_SPACE，   
        LOGIC_ERROR，   
        FILE_NOT_FOUND   
    }  ；
    与用#define说明常量相比，用enum说明常量还有其它好处，这一点将在5．7中作更具体的介绍。

    请参见：
    5．5 用#define指令说明常量有什么好处?
    5．7 与用#denne指令说明常量相比，用enum要害字说明常量有什么好处?

    5．7  与用#define指令说明常量相比，用enum要害字说明常量有什么好处?
    与用#define指令说明常量(即说明标识符常量)相比，用enum要害字说明常量(即说明枚举常量)有以下几点好处：
    (1) 使程序更轻易维护，因为枚举常量是由编译程序自动生成的，而标识符常量必须由程序员手工赋值。例如，你可以定义一组枚举常量，作为程序中可能发生的错误的错误号，请看下例：
    enum Error_Code   
    {
       OUT_OF_MEMORY，   
       INSUFFICIENT_DISK_SPACE，   
       LOGIC_ERROR，
       FILE+NOT_FOUND
    }  ；  
    在上例中，OUT_OF_MEMORY等枚举常量依次被编译程序自动赋值为0，1，2和3。
    同样，你也可以用#define指令说明类似的一组常量，请看下例：
    #define OUT_OF_MEMORY             0   
    #define INSUFFICIENT_DISK_SPACE    1
    #define LOGIC_ERROR                2
    #define FILE_NOT_FOUND             3
    上述两例的结果是相同的。
    假设你要增加两个新的常量，例如DRIVE_NOT_READY和CORRUPT_FILE。假如常量原来是用enum要害字说明的，你可以在原来的常量中的任意一个位置插入这两个常量，因为编译程序会自动赋给每一个枚举常量一个唯一的值；假如常量原来是用#define指令说明的，你就不得不手工为新的常量赋值。在 上面的例子中，你并不关心常量的实际值，而只关心常量的值是否唯一，因此，用enum要害字说明常量使程序更轻易维护，并且能防止给不同的常量赋予相同的值。
    (2)使程序更易读，这样别人修改你的程序时就比较方便。请看下例：
    void copy_file(char*  source_file_name，  char *  dest_file_name)
    {   
        ......
        Error_Code,err；
        ......
        if(drive_ready()!＝TRUE)
        err＝DRIVE_NOT_READY；
        ......
    }   
    在上例中，从变量err的定义就可以看出；赋予err的值只能是枚举类型Error_Code中的数值。因此，当另一个程序员想修改或增加上例的功能时，他只要检查一下Error_Code的定义，就能知道赋给err的有效值都有哪些。
 注重：将变量定义为枚举类型后，并不能保证赋予该变量的值就是枚举类型中的有效值。
    在上例中，编译程序并不要求赋予err的值只能是Error—Code类型中的有效值，因此，程序员自己必须保证程序能实现这一点。
    相反，假如常量原来是用#define指令说明的，那么上例就可能如下所示：
    void copy_file(char *source *file，char *dest_file)
    { 
        ...... 
        int err；
        ......
        if(drive_ready()!＝TRUE)
            err＝DRIVE_NOT_READY；
        ......
    }
    当另一个程序员想修改或增加上例的功能时，他就无法立即知道变量err的有效值都有哪些，他必须先检查头文件中的#defineDRIVE_NOT_READY语句，并且寄希望于所有相关的常量都在同一个头文件中定义。
    (3)使程序调试起来更方便，因为某些标识符调试程序能打印枚举常量的值。这一点在调试程序时是非常用的，因为假如你的程序在使用枚举常量的一行语句中停住了，你就能马上检查出这个常量的值；反之，绝大多数调试程序无法打印标识符常量的值，因此你不得不在头文件中手工检查该常量的值。

    请参见：
    5．5 用#dehne指令说明常量有什么好处?
    5．6 用enum要害字说明常量有什么好处?

    5．8  如何使部分程序在演示版中失效?
    假如你在为你的程序制作一个演示版，你可以通过预处理指令使你的程序的一部分生效或失效。以下是一个用#if和#endif指令实现上述功能的例子：
    int save_document(char * doc_name)
    {
    #if DEMO_VERSION
        printf("Sorry!  You can't save documents using the DEMO version Of
        ->this program!\n");
        return(0)；
    #endif   
    }
    在编写演示版程序的源代码时，假如插入了#define DEMO_VERSION这行语句，预处理程序就会将上述save_document()函数中符合编译条件的代码包含进来，这样，使用演示版的用户就无法保存他们的文件。更好的方法是，在编译选项中定义DEMO_VERSION，这样就不必修改程序的源代码了。
    上述技巧在许多不同的情况下都很有用。例如，假如你编写的程序可能要在多种操作系统或操作环境下使用，你就可以定义一些象WINDOWS_VER，UNIX_VER和DOS_VER这样的宏，通过它们指示预处理程序如何根据具体条件将相应的代码包含到你的程序中去。

    请参见：
    5．32怎样检查一个符号是否已被定义?

    5．9  什么时候应该用宏代替函数?   
    见5．1-0。

    请参见：
    5．1什么是宏(macro)?怎样使用宏?
    5．1-0使用宏更好，还是使用函数更好?
    5．17怎样建立对类型不敏感的宏?

    5．10  使用宏更好，还是使用函数更好?
    这取决于你的代码是为哪种情况编写的。宏与函数相比有一个明显的优势，即它比函数效率更高(并且更快)，因为宏可以直接在源代码中展开，而调用函数还需要额外的开销。但是，宏一般比较小，无法处理大的、复杂的代码结构，而函数可以。此外，宏需要逐行展开，因此宏每出现一次，宏的代码就要复制一次，这样你的程序就会变大，而使用函数不会使程序变大。
    一般来说，应该用宏去替换小的、可重复的代码段，这样可以使程序运行速度更快；当任务比较复杂，需要多行代码才能实现时，或者要求程序越小越好时，就应该使用函数。

    请参见：
    5．1  什么是宏(macro)?怎样使用宏?
    5．17 怎样建立对类型不敏感的宏?

    5．11 在程序中加入注释的最好方法是什么?
    大部分C编译程序为在程序中加注释提供了以下两种方法：
    (1)分别是用符号“/*”和“*/”标出注释的开始和结束，在符号“/*”和“*/”之间的任何内容都将被编译程序当作注释来处理。这种方法是在程序中加入注释的最好方法。
    例如，你可以在程序中加入下述注释：
    /*
    This portion Of the program contains
    a comment that is several lines long
    and is not included in the compiled
    Version Of the program．
    */
    (2)用符号“// ”标出注释行，从符号“// ”到当前行末尾之间的任何内容都将被编译程序当作注释来处理。当要加入一行独立的注释时，使用符号“//”是最方便的。但是，对于上面的例子，由于一段独立的注释中有4行内容，因此使用符号“//”是不合适的，请看下例：
    // This portion Of the program contains   
    // a  comment  that  is  several  lines  long
    // and is not included in the compiled   
    // Version Ofthe program．
    需要注重的是，用符号"// "加入注释的方法与ANSI标准是不兼容的，许多版本较早的编译程序不支持这种方法。

    请参见：
    5．8 如何使部分程序在演示版中失效?

    5．12  #include <file>和#include“file”有什么不同?
    在C程序中包含文件有以下两种方法：
    (1)用符号“<”和“>”将要包含的文件的文件名括起来。这种方法指示预处理程序到预定义的缺省路径下寻找文件。预定义的缺省路径通常是在INCLUDE环境变量中指定的，请看下例：   
    INCLUDE=C:\COMPILER\INCLUDE；S:\SOURCE\HEADERS；
    对于上述INCLUDE环境变量，假如用#include<file>语句包含文件，编译程序将首先到C:\COMPILER\INCLUDE目录下寻找文件；假如未找到，则到S:\SOURCE\HEADERS
  目录下继续寻找；假如还未找到，则到当前目录下继续寻找。   
    (2)用双引号将要包含的文件的文件名括起来。这种方法指示预处理程序先到当前目录下寻找文件，再到预定义的缺省路径下寻找文件。   
    对于上例中的INCLUDE环境变量，假如用#include“file”语句包含文件，编译程序将首先到当前目录下寻找文件；假如未找到，则到C:\COMPILER\INCLUDE目录下继续寻找；假如还未找到，则到S:\SOURCE\HEADERS目录下继续寻找。
    #include<file>语句一般用来包含标准头文件(例如stdio.h或stdlib.h)，因为这些头文件极少被修改，并且它们总是存放在编译程序的标准包含文件目 录下。#include“file”语句一般用来包含非标准头文件，因为这些头文件一般存放在当前目录下，你可以经常修改它们，并且要求编译程序总是使用这些头文件的最新版本。

    请参见：
    5．3  怎样避免多次包含同一个头文件?
    5. 4  可以用#include指令包含类型名不是“．h”的文件吗?
    5．14 包含文件可以嵌套吗?
    5．15 包含文件最多可以嵌套几层?

    5．13  你能指定在编译时包含哪一个头文件吗?   
    你可以通过#if，#else和#endif这组指令实现这一点。例如，头文件alloc.h和malloc.h的作用和内容基本相同，但前者供BorlandC++编译程序使用，后者供MicrosoftC++编译程序使用。假如你在编写一个既支持BorlandC++又支持MicrosoftC++的程序，你就应该指定在编译时是包含alloc.h头文件还是包含malloc.h头文件，请看下例：
    #ifdef __BORLANDC__
    #include<alloc.h>
    #else
    #include<malloc.h>
    #endif
    当用BorlandC++编译程序处理上例时，编译程序会自动定义__BORLANDC__标识符名称，因此alloc.h头文件将被包含进来；当用microsoftC++编译程序处理上例时，由于编译程序检查到__BORLANDC__标识符名称没有被定义，因此malloc.h头文件将被包含进来。

    请参见：
    5．21怎样判定一个程序是用C编译程序还是用C++编译程序编译的?
    5．32怎样检查一个符号是否已被定义?

    5．14  包含文件可以嵌套吗?
    包含文件可以嵌套，但你应该避免多次包含同一个文件(见5．3)。
    过去，人们认为头文件嵌套是一种不可取的编程方法，因为它增加了MAKE程序中的依靠跟踪函数(dependencytrackingfunction)的工作负担，从而降低了编译速度。现在，通过引入预编译头文件(precompiledheaders，即所有头文件和相关的依靠文件都以一种已被预编译的状态存储起来)这样一种技术，许多流行的编译程序已经解决了上述问题。
    许多程序员都喜欢建立一个自己的头文件，使其包含每个模块所需的每个头文件。这是一个头文件。

    请参见：
    5．3  怎样避免多次包含同一个头文件?
    5．4  可以用#include指令包含类型名不是“．h”的文件吗?
    5．12 #include<file~和#include“file”有什么不同?
    5．15 包含文件最多可以嵌套几层?

    5．15 包含文件最多可以嵌套几层?
    尽治理论上包含文件可以嵌套任意多层，但是，假如嵌套层数太多，编译程序就会用光它的堆栈空间。因此，实际的嵌套层数是有限的，它一般取决于你的硬件设置和编译程序的版本。
    在编写程序时，你应该避免过多的嵌套。一般来说，只有在确实需要时才嵌套包含文件，例如建立一个头文件，使其包含每个模块所需的每个头文件。

    请参见：
    5．3  怎样避免多次包含同一个头文件?
    5．4  可以用#include指令包含类型名不是“．h”的文件吗?
    5．12 #include<file>和#include“file”有什么不同?
    5．14 包含文件可以嵌套吗?

    5．16 连接运算符“##”有什么作用?
    连接运算符“##”可以把两个独立的字符串连接成一个字符串。在C的宏中，经常要用到“##”运算符，请看下例：
    #include<stdio.h>
    #define SORT(X)  sort_function # # X
    void main(vOid)；
    void main(vOid)
    {
        char *array；
        int  elements，element_size；．
        SORT(3) (array，elements，element_size)；
    }
    在上例中，宏SORT利用“##”运算符把字符串sort_function和经参数x传递过来的字符串连接起来，这意味着语句
    SORT(3)(array，elemnts，element_size)；
    将被预处理程序转换为语句
    sort_function3(array，elements，element_size)；
    从宏SORT的用法中你可以看出，假如在运行时才能确定要调用哪个函数，你可以利用“##”运算符动态地构造要调用的函数的名称。

    请参见：
    5．1什么是宏?怎样使用宏?
    5．17怎样建立对类型敏感的宏?