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 1
#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經常用來定義常量, 此時的宏名稱一般為大寫的字符串. 這樣利於修改這些常量.
e.g.
#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與(之間可以有空格.
e.g.
#define mul(x,y) ((x)*(y))
注意, 函數宏之後的參數要用括號括起來, 看看這個例子:
e.g.
#define mul(x,y) x*y
"mul(1, 2+2);" 將被擴展為: 1*2 + 2
同樣, 整個標記串也應該用括號引用起來:
e.g.
#define mul(x,y) (x)*(y)
sizeof mul(1,2.0) 將被擴展為 sizeof 1 * 2.0
調用函數宏時候, 傳遞給它的參數可以是函數的返回值, 也可以是任何有意義的語句:
e.g.
mul (f(a,b), g(c,d));
e.g.
#define (stmt) stmt
( a=1; b=2;) 相當於在代碼中加入 a=1; b=2 .
( a=1, b=2;) 就有問題了: 預處理器會提示出錯: 函數宏的參數個數不匹配. 預處理器把","視為參數間的分隔符.
((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__只能用於函數宏中參數中包含有"..."的情況.
e.g.
#ifdef DEBUG
#define my_printf(...) fprintf(stderr, __VA_ARGS__)
#else
#define my_printf(...) printf(__VA_ARGS__)
#endif
tokens中的__VA_ARGS__被替換為函數宏定義中的'"..."可變參數列表.
注意在使用#define時候的一些常見錯誤:
#define MAX = 100
#define MAX 100;
=, ; 的使用要值得注意. 再就是調用函數宏是要注意, 不要多給出";".
注意: 函數宏對參數類型是不敏感的, 你不必考慮將何種數據類型傳遞給宏. 那麼, 如何構建對參數類型敏感的宏呢? 參考本章的第九部分, 關於"##"的介紹.
關於定義宏的另外一些問題
(1) 宏可以被多次定義, 前提是這些定義必須是相同的. 這裏的"相同"要求先後定義中空白符出現的位置相同, 但具體的空白符類型或數量可不同, 比如原先的空格可替換為多個其他類型的空白符: 可為tab, 註釋...
e.g.
#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中, 可在命令行中指定對象宏的定義:
e.g.
$ 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之後該宏無效. 並且字符串中的宏不會被識別
e.g.
#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) 宏的替換可以是遞歸的, 所以可以嵌套定義宏.
e.g.
# 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
語句...
...
#else
語句...
#endif
#if和#else分別相當於C語句中的if, else. 它們根據常量表達式的值來判別是否執行後面的語句. #elif相當於C中的else-if. 使用這些條件編譯命令可以方便地實現對源代碼內容的控制.
else之後不帶常量表達式, 但若包含了常量表達式, gcc只是給出警告信息.
使用它們可以提升代碼的可移植性---針對不同的平台使用執行不同的語句. 也經常用於大段代碼註釋.
e.g.
#if 0
{
一大段代碼;
}
#endif
常量表達式可以是包含宏, 算術運算, 邏輯運算等等的合法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
它們經常用於避免頭文件的重複引用:
#ifndef __FILE_H__
#define __FILE_H__
#include "file.h"
#endif
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
#include 預處理標記
前面兩種形式大家都很熟悉, "#include 預處理標記"中, 預處理標記會被預處理器進行替換, 替換的結果必須符合前兩種形式中的某一種.
實際上, 真正被添加的頭文件並不一定就是#include中所指定的文件. #include"headfile"包含的頭文件當然是同一個文件, 但#include 包包含的"系統頭文件"可能是另外的文件. 但這不值得被注意. 感興趣的話可以查看宏擴展後到底引入了哪些系統頭文件.
關於#include "headfile"和#include 的區別以及如何在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所指定的頭文件.
可參考cpp手冊進一步瞭解#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__.
e.g.
printf("line: %d, file: %s", __LINE__, __FILE__);
#line 100 "haha"
printf("line: %d, file: %s", __LINE__, __FILE__);
printf("line: %d, file: %s", __LINE__, __FILE__);
顯示:
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語句最後列出的文件)的時間戳. 如果指定文件比當前文件新, 則給出警告信息.
e.g.
在demo.c中給出這樣一句:
#pragma GCC dependency "temp-file"
然後在demo.c所在的目錄新建一個更新的文件: $ touch temp-file, 編譯: $ gcc demo.c 會給出這樣的警告信息: warning: current file is older than temp-file
如果當前文件比指定的文件新, 則不給出任何警告信息.
還可以在在#pragma中給添加自定義的警告信息.
e.g.
#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), 則編譯時顯示警告信息. 它一般用於在調用你不想使用的函數時候給出出錯信息.
e.g.
#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:
e.g.
#define PRAGMA_DEP #pragma GCC dependency "temp-file"
由於預處理之進行一次宏擴展, 採用上面的方法會在編譯時引發錯誤, 要將#pragma語句定義成一個宏擴展, 應該使用下面的_Pragma語句:
#define PRAGMA_DEP _Pragma("GCC dependency "temp-file"")
注意, ()中包含的""引用之前引該加上轉義字符.
9, #, ##
#和##用於對字符串的預處理操作, 所以他們也經常用於printf, puts之類的字符串顯示函數中.
#用於在宏擴展之後將tokens轉換為以tokens為內容的字符串常量.
e.g.
#define TEST(a,b) printf( #a "<" #b "=%d", (a)<(b));
注意: #只針對緊隨其後的token有效!
##用於將它前後的兩個token組合在一起轉換成以這兩個token為內容的字符串常量. 注意##前後必須要有token.
e.g.
#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
e.g.
#warning "some warning"
注意, #error和#warning後的token要用""引用起來!
(在gcc中, 如果給出了warning, 編譯繼續進行, 但若給出了error, 則編譯停止. 若在命令行中指定了 -Werror, 即使只有警告信息, 也不編譯.
