在将一個C源程式轉換為可執行程式的過程中, 編譯預處理是最初的步驟. 這一步驟是由預處理器(preprocessor)來完成的. 在源流程式被編譯器處理之前, 預處理器首先對源程式中的"宏(macro)"進行處理.
C初學者可能對預處理器沒什麼概念, 這是情有可原的: 一般的C編譯器都将預處理, 彙編, 編譯, 連接配接過程內建到一起了. 編譯預處理往往在背景運作. 在有的C編譯器中, 這些過程統統由一個單獨的程式來完成, 編譯的不同階段實作這些不同的功能. 可以指定相應的指令選項來執行這些功能. 有的C編譯器使用分别的程式來完成這些步驟. 可單獨調用這些程式來完成. 在gcc中, 進行編譯預處理的程式被稱為CPP, 它的可執行檔案名為cpp.
編譯預處理指令的文法與C語言的文法是完全獨立的. 比如: 你可以将一個宏擴充為與C文法格格不入的内容, 但該内容與後面的語句結合在一個若能生成合法的C語句, 也是可以正确編譯的.
(一) 預處理指令簡介
預處理指令由#(hash字元)開頭, 它獨占一行, #之前隻能是空白符. 以#開頭的語句就是預處理指令, 不以#開頭的語句為C中的代碼行. 常用的預處理指令如下:
#define 定義一個預處理宏
#undef 取消宏的定義
#include 包含檔案指令
#include_next 與#include相似, 但它有着特殊的用途
#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配合使用, 判斷某個宏是否被定義
#line 标志該語句所在的行号
# 将宏參數替代為以參數值為内容的字元竄常量
## 将兩個相鄰的标記(token)連接配接為一個單獨的标記
#pragma 說明編譯器資訊
#warning 顯示編譯警告資訊
#error 顯示編譯錯誤資訊
(二) 預處理的文法
預處理并不分析整個源代碼檔案, 它隻是将源代碼分割成一些标記(token), 識别語句中哪些是C語句, 哪些是預處理語句. 預處理器能夠識别C标記, 檔案名, 空白符, 檔案結尾标志.
預處理語句格式: #command name(...) token(s)
1, command預處理指令的名稱, 它之前以#開頭, #之後緊随預處理指令, 标準C允許#兩邊可以有空白符, 但比較老的編譯器可能不允許這樣. 若某行中隻包含#(以及空白符), 那麼在标準C中該行被了解為空白. 整個預處理語句之後隻能有空白符或者注釋, 不能有其它内容.
2, name代表宏名稱, 它可帶參數. 參數可以是可變參數清單(C99).
3, 語句中可以利用"\"來換行.
e.g.
# define ONE 1 /* ONE == 1 */
等價于: #define ONE １
#define err(flag, msg) if(flag) \
printf(msg)
等價于: #define err(flag, msg) if(flag) printf(msg)
(三) 預處理指令詳述
1, #define
#define指令定義一個宏:
#define MACRO_NAME(args) tokens(opt)
之後出現的MACRO_NAME将被替代為所定義的标記(tokens). 宏可帶參數, 而後面的标記也是可選的.
對象宏
不帶參數的宏被稱為"對象宏(objectlike macro)"
#define經常用來定義常量, 此時的宏名稱一般為大寫的字元串. 這樣利于修改這些常量.
#define MAX 100
int a[MAX];
#ifndef __FILE_H__
#define __FILE_H__
#include "file.h"
#endif
#define __FILE_H__ 中的宏就不帶任何參數, 也不擴充為任何标記. 這經常用于包含頭檔案.
要調用該宏, 隻需在代碼中指定宏名稱, 該宏将被替代為它被定義的内容.
函數宏
帶參數的宏也被稱為"函數宏". 利用宏可以提高代碼的運作效率: 子程式的調用需要壓棧出棧, 這一過程如果過于頻繁會耗費掉大量的CPU運算資源. 是以一些代碼量小但運作頻繁的代碼如果采用帶參數宏來實作會提高代碼的運作效率.
函數宏的參數是固定的情況
函數宏的定義采用這樣的方式: #define name( args ) tokens
其中的args和tokens都是可選的. 它和對象宏定義上的差別在于宏名稱之後不帶括号.
注意, name之後的左括号(必須緊跟name, 之間不能有空格, 否則這就定義了一個對象宏, 它将被替換為 以(開始的字元串. 但在調用函數宏時, name與(之間可以有空格.
#define mul(x,y) ((x)*(y))
注意, 函數宏之後的參數要用括号括起來, 看看這個例子:
#define mul(x,y) x*y
"mul(1, 2+2);" 将被擴充為: 1*2 + 2
同樣, 整個标記串也應該用括号引用起來:
#define mul(x,y) (x)*(y)
sizeof mul(1,2.0) 将被擴充為 sizeof 1 * 2.0
調用函數宏時候, 傳遞給它的參數可以是函數的傳回值, 也可以是任何有意義的語句:
mul (f(a,b), g(c,d));
#define insert(stmt) stmt
insert ( a=1; b=2;) 相當于在代碼中加入 a=1; b=2 .
insert ( a=1, b=2;) 就有問題了: 預處理器會提示出錯: 函數宏的參數個數不比對. 預處理器把","視為參數間的分隔符.
insert ((a=1, b=2;)) 可解決上述問題.
在定義和調用函數宏時候, 要注意一些問題:
1, 我們經常用{}來引用函數宏被定義的内容, 這就要注意調用這個函數宏時的";"問題.
example_3.7:
#define swap(x,y) { unsigned long _temp=x; x=y; y=_tmp}
如果這樣調用它: "swap(1,2);" 将被擴充為: { unsigned long _temp=1; 1=2; 2=_tmp};
明顯後面的;是多餘的, 我們應該這樣調用: swap(1,2)
雖然這樣的調用是正确的, 但它和C文法相悖, 可采用下面的方法來處理被{}括起來的内容:
#define swap(x,y) \
do { unsigned long _temp=x; x=y; y=_tmp} while (0)
swap(1,2); 将被替換為:
do { unsigned long _temp=1; 1=2; 2=_tmp} while (0);
在Linux核心源代碼中對這種do-while(0)語句有這廣泛的應用.
2, 有的函數宏是無法用do-while(0)來實作的, 是以在調用時不能帶上";", 最好在調用後添加注釋說明.
eg_3.8:
#define incr(v, low, high) \
for ((v) = (low),; (v) <= (high); (v)++)
隻能以這樣的形式被調用: incr(a, 1, 10) /* increase a form 1 to 10 */
函數宏中的參數包括可變參數清單的情況
C99标準中新增了可變參數清單的内容. 不光是函數, 函數宏中也可以使用可變參數清單.
#define name(args, ...) tokens
#define name(...) tokens
"..."代表可變參數清單, 如果它不是僅有的參數, 那麼它隻能出現在參數清單的最後. 調用這樣的函數宏時, 傳遞給它的參數個數要不少于參數清單中參數的個數(多餘的參數被丢棄).
通過__VA_ARGS__來替換函數宏中的可變參數清單. 注意__VA_ARGS__隻能用于函數宏中參數中包含有"..."的情況.
#ifdef DEBUG
#define my_printf(...) fprintf(stderr, __VA_ARGS__)
#else
#define my_printf(...) printf(__VA_ARGS__)
tokens中的__VA_ARGS__被替換為函數宏定義中的"..."可變參數清單.
注意在使用#define時候的一些常見錯誤:
#define MAX = 100
#define MAX 100;
=, ; 的使用要值得注意. 再就是調用函數宏是要注意, 不要多給出";".
注意: 函數宏對參數類型是不敏感的, 你不必考慮将何種資料類型傳遞給宏. 那麼, 如何建構對參數類型敏感的宏呢? 參考本章的第九部分, 關于"##"的介紹.
關于定義宏的另外一些問題
(1) 宏可以被多次定義, 前提是這些定義必須是相同的. 這裡的"相同"要求先後定義中空白符出現的位置相同, 但具體的空白符類型或數量可不同, 比如原先的空格可替換為多個其他類型的空白符: 可為tab, 注釋...
#define NULL 0
#define NULL /* null pointer */ 0
上面的重定義是相同的, 但下面的重定義不同:
#define fun(x) x+1
#define fun(x) x + 1 或: #define fun(y) y+1
如果多次定義時, 再次定義的宏内容是不同的, gcc會給出"NAME redefined"警告資訊.
應該避免重新定義函數宏, 不管是在預處理指令中還是C語句中, 最好對某個對象隻有單一的定義. 在gcc中, 若宏出現了重定義, gcc會給出警告.
(2) 在gcc中, 可在指令行中指定對象宏的定義:
$ gcc -Wall -DMAX=100 -o tmp tmp.c
相當于在tmp.c中添加" #define MAX 100".
那麼, 如果原先tmp.c中含有MAX宏的定義, 那麼再在gcc調用指令中使用-DMAX, 會出現什麼情況呢?
---若-DMAX=1, 則正确編譯.
---若-DMAX的值被指定為不為1的值, 那麼gcc會給出MAX宏被重定義的警告, MAX的值仍為1.
注意: 若在調用gcc的指令行中不顯示地給出對象宏的值, 那麼gcc賦予該宏預設值(1), 如: -DVAL == -DVAL=1
(3) #define所定義的宏的作用域
宏在定義之後才生效, 若宏定義被#undef取消, 則#undef之後該宏無效. 并且字元串中的宏不會被識别
#define ONE 1
sum = ONE + TWO /* sum = 1 + TWO */
#define TWO 2
sum = ONE + TWO /* sum = 1 + 2 */
#undef ONE
sum = ONE + TWO /* sum = ONE + 2 */
char c[] = "TWO" /* c[] = "TWO", NOT "2"! */
(4) 宏的替換可以是遞歸的, 是以可以嵌套定義宏.
# define ONE NUMBER_1
# define NUMBER_1 1
int a = ONE /* a = 1 */
2, #undef
#undef用來取消宏定義, 它與#define對立:
#undef name
如夠被取消的宏實際上沒有被#define所定義, 針對它的#undef并不會産生錯誤.
當一個宏定義被取消後, 可以再度定義它.
3, #if, #elif, #else, #endif
#if, #elif, #else, #endif用于條件編譯:
#if 常量表達式1
語句...
#elif 常量表達式2
#elif 常量表達式3
...
語句...
#if和#else分别相當于C語句中的if, else. 它們根據常量表達式的值來判别是否執行後面的語句. #elif相當于C中的else-if. 使用這些條件編譯指令可以友善地實作對源代碼内容的控制.
else之後不帶常量表達式, 但若包含了常量表達式, gcc隻是給出警告資訊.
使用它們可以提升代碼的可移植性---針對不同的平台使用執行不同的語句. 也經常用于大段代碼注釋.
#if 0
{
一大段代碼;
}
常量表達式可以是包含宏, 算術運算, 邏輯運算等等的合法C常量表達式, 如果常量表達式為一個未定義的宏, 那麼它的值被視為0.
#if MACRO_NON_DEFINED == #if 0
在判斷某個宏是否被定義時, 應當避免使用#if, 因為該宏的值可能就是被定義為0. 而應當使用下面介紹的#ifdef或#ifndef.
注意: #if, #elif, #else之後的宏隻能是對象宏. 如果name為名的宏未定義, 或者該宏是函數宏. 那麼在gcc中使用"-Wundef"選項會顯示宏未定義的警告資訊.
4, #ifdef, #ifndef, defined.
#ifdef, #ifndef, defined用來測試某個宏是否被定義
#ifdef name 或 #ifndef name
它們經常用于避免頭檔案的重複引用:
defined(name): 若宏被定義,則傳回1, 否則傳回0.
它與#if, #elif, #else結合使用來判斷宏是否被定義, 乍一看好像它顯得多餘, 因為已經有了#ifdef和#ifndef. defined用于在一條判斷語句中聲明多個判别條件:
#if defined(VAX) && defined(UNIX) && !defined(DEBUG)
和#if, #elif, #else不同, #indef, #ifndef, defined測試的宏可以是對象宏, 也可以是函數宏. 在gcc中使用"-Wundef"選項不會顯示宏未定義的警告資訊.
5, #include , #include_next
#include用于檔案包含. 在#include 指令所在的行不能含有除注釋和空白符之外的其他任何内容.
#include "headfile"
#include <headfile>
#include 預處理标記
前面兩種形式大家都很熟悉, "#include 預處理标記"中, 預處理标記會被預處理器進行替換, 替換的結果必須符合前兩種形式中的某一種.
實際上, 真正被添加的頭檔案并不一定就是#include中所指定的檔案. #include"headfile"包含的頭檔案當然是同一個檔案, 但#include <headfile>包包含的"系統頭檔案"可能是另外的檔案. 但這不值得被注意. 感興趣的話可以檢視宏擴充後到底引入了哪些系統頭檔案.
關于#include "headfile"和#include <headfile>的差別以及如何在gcc中包含頭檔案的詳細資訊, 參考本blog的GCC筆記.
相對于#include, 我們對#include_next不太熟悉. #include_next僅用于特殊的場合. 它被用于頭檔案中(#include既可用于頭檔案中, 又可用于.c檔案中)來包含其他的頭檔案. 而且包含頭檔案的路徑比較特殊: 從目前頭檔案所在目錄之後的目錄來搜尋頭檔案.
比如: 頭檔案的搜尋路徑一次為A,B,C,D,E. #include_next所在的目前頭檔案位于B目錄, 那麼#include_next使得預處理器從C,D,E目錄來搜尋#include_next所指定的頭檔案.
6, 預定義宏
标準C中定義了一些對象宏, 這些宏的名稱以"__"開頭和結尾, 并且都是大寫字元. 這些預定義宏可以被#undef, 也可以被重定義.
下面列出一些标準C中常見的預定義對象宏(其中也包含gcc自己定義的一些預定義宏:
__LINE__ 目前語句所在的行号, 以10進制整數标注.
__FILE__ 目前源檔案的檔案名, 以字元串常量标注.
__DATE__ 程式被編譯的日期, 以"Mmm dd yyyy"格式的字元串标注.
__TIME__ 程式被編譯的時間, 以"hh:mm:ss"格式的字元串标注, 該時間由asctime傳回.
__STDC__ 如果目前編譯器符合ISO标準, 那麼該宏的值為1
__STDC_VERSION__ 如果目前編譯器符合C89, 那麼它被定義為199409L, 如果符合C99, 那麼被定義為199901L.
我用gcc, 如果不指定-std=c99, 其他情況都給出__STDC_VERSION__未定義的錯誤資訊, 咋回事呢?
__STDC_HOSTED__ 如果目前系統是"本地系統(hosted)", 那麼它被定義為1. 本地系統表示目前系統擁有完整的标準C庫.
gcc定義的預定義宏:
__OPTMIZE__ 如果編譯過程中使用了優化, 那麼該宏被定義為1.
__OPTMIZE_SIZE__ 同上, 但僅在優化是針對代碼大小而非速度時才被定義為1.
__VERSION__ 顯示所用gcc的版本号.
可參考"GCC the complete reference".
要想看到gcc所定義的所有預定義宏, 可以運作: $ cpp -dM /dev/null
7, #line
#line用來修改__LINE__和__FILE__.
printf("line: %d, file: %s\n", __LINE__, __FILE__);
#line 100 "haha"
顯示:
line: 34, file: 1.c
line: 100, file: haha
line: 101, file: haha
8, #pragma, _Pragma
#pragma用編譯器用來添加新的預處理功能或者顯示一些編譯資訊. #pragma的格式是各編譯器特定的, gcc的如下:
#pragma GCC name token(s)
#pragma之後有兩個部分: GCC和特定的pragma name. 下面分别介紹gcc中常用的.
(1) #pragma GCC dependency
dependency測試目前檔案(既該語句所在的程式代碼)與指定檔案(既#pragma語句最後列出的檔案)的時間戳. 如果指定檔案比目前檔案新, 則給出警告資訊.
在demo.c中給出這樣一句:
#pragma GCC dependency "temp-file"
然後在demo.c所在的目錄建立一個更新的檔案: $ touch temp-file, 編譯: $ gcc demo.c 會給出這樣的警告資訊: warning: current file is older than temp-file
如果目前檔案比指定的檔案新, 則不給出任何警告資訊.
還可以在在#pragma中給添加自定義的警告資訊.
#pragma GCC dependency "temp-file" "demo.c needs to be updated!"
1.c:27:38: warning: extra tokens at end of #pragma directive
1.c:27:38: warning: current file is older than temp-file
注意: 後面新增的警告資訊要用""引用起來, 否則gcc将給出警告資訊.
(2) #pragma GCC poison token(s)
若源代碼中出現了#pragma中給出的token(s), 則編譯時顯示警告資訊. 它一般用于在調用你不想使用的函數時候給出出錯資訊.
#pragma GCC poison scanf
scanf("%d", &a);
warning: extra tokens at end of #pragma directive
error: attempt to use poisoned "scanf"
注意, 如果調用了poison中給出的标記, 那麼編譯器會給出的是出錯資訊. 關于第一條警告, 我還不知道怎麼避免, 用""将token(s)引用起來也不行.
(3) #pragma GCC system_header
從#pragma GCC system_header直到檔案結束之間的代碼會被編譯器視為系統頭檔案之中的代碼. 系統頭檔案中的代碼往往不能完全遵循C标準, 是以頭檔案之中的警告資訊往往不顯示. (除非用 #warning顯式指明).
(這條#pragma語句還沒發現用什麼大的用處
)
由于#pragma不能用于宏擴充, 是以gcc還提供了_Pragma:
#define PRAGMA_DEP #pragma GCC dependency "temp-file"
由于預處理之進行一次宏擴充, 采用上面的方法會在編譯時引發錯誤, 要将#pragma語句定義成一個宏擴充, 應該使用下面的_Pragma語句:
#define PRAGMA_DEP _Pragma("GCC dependency \"temp-file\"")
注意, ()中包含的""引用之前引該加上\轉義字元.
9, #, ##
#和##用于對字元串的預處理操作, 是以他們也經常用于printf, puts之類的字元串顯示函數中.
#用于在宏擴充之後将tokens轉換為以tokens為内容的字元串常量.
#define TEST(a,b) printf( #a "<" #b "=%d\n", (a)<(b));
注意: #隻針對緊随其後的token有效!
##用于将它前後的兩個token組合在一起轉換成以這兩個token為内容的字元串常量. 注意##前後必須要有token.
#define TYPE(type, n) type n
之後調用:
TYPE(int, a) = 1;
TYPE(long, b) = 1999;
将被替換為:
int a = 1;
long b = 1999;
(10) #warning, #error
#warning, #error分别用于在編譯時顯示警告和錯誤資訊, 格式如下:
#warning tokens
#error tokens
#warning "some warning"
注意, #error和#warning後的token要用""引用起來!
(在gcc中, 如果給出了warning, 編譯繼續進行, 但若給出了error, 則編譯停止. 若在指令行中指定了 -Werror, 即使隻有警告資訊, 也不編譯.
![mybatis_入門程式Mybatis入門[圖]](data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=)