C/C++之预处理命令
C程序的源代碼中可包括各種編譯指令,這些指令稱為預處理命令。預處理命令屬于C語言編譯器,而不是C語言的組成部分。C語言預處理程序包括下列命令:#define,#error,#include,#if,#else,#elif,#endif,#ifdef,#ifndef,#undef,#line,#pragma等。總體來說,預處理指令可以分為四大類:
- 宏:#define、#undef
- 文件:#include
- 條件編譯:#if,#else,#elif,#endif,#ifdef,#ifndef等
- 其他:#error,#line和#pragma是一些比較特殊的指令,一般很少用到。
預處理指令遵循以下規則:
- 指令都是以#開始。#符號不需要在一行的行首,只要她之前有空白字符就行。在#后是指令名,接著是指令所需要的其他信息。
- 在指令的符號之間可以插入任意數量的空格或橫向制表符。
- 指令總是第一個換行符處結束,除非明確地指明要繼續。
- 指令可以出現在程序中的任何地方。通常將#define和#include指令放在文件的開始,其他指令則放在后面,甚至在函數定義的中間。
- 注釋可以與指令放在同一行。
以上規則,在C99標準文檔的6.10章節可有介紹。
0x01 宏指令 #define
唯一需要注意的就是該語句沒有分號。在標識符和串之間可以有任意個空格,串一旦開始,僅由一新行結束。
0x02 文件指令#include
#include命令的作用是把指定的文件模塊內容插入到#include所在的位置,當程序編譯鏈接時,系統會把所有#include指定的文件鏈接生成可執行代碼。
(1)如果顯式路徑名為文件標識符的一部分,則僅在那些子目錄中搜索被嵌入文件。否則,如果文件名用雙引號括起來,則首先檢索當前工作目錄。如果未發現文件,則在命令行中說明的所有目錄中搜索。如果仍未發現文件,則搜索實現時定義的標準目錄。如果沒有顯式路徑名且文件名被尖括號括起來,則首先在編譯命令行中的目錄內檢索。如果文件沒找到,則檢索標準目錄,不檢索當前工作目錄。
(2)通過#define包含進來的文件模塊中還可以再包含其他文件,這種用法稱為嵌套包含。嵌套的層數與具體C語言系統有關,但是一般可以嵌套8層以上。
(3)#include 也可以包含.c文件。但是一般不會這么用
下面以Linux下gcc為例:
#include "headfile.h"
①先搜索當前目錄
②然后搜索-I指定的目錄
③再搜索gcc的環境變量CPLUS_INCLUDE_PATH(C程序使用的是C_INCLUDE_PATH)
④最后搜索gcc的內定目錄
/usr/include
/usr/local/include
/usr/lib/gcc/x86_64-redhat-linux/4.1.1/include
#include <headfile.h>
①先搜索-I指定的目錄
②然后搜索gcc的環境變量CPLUS_INCLUDE_PATH
③最后搜索gcc的內定目錄
/usr/include
/usr/local/include
/usr/lib/gcc/x86_64-redhat-linux/4.1.1/include
庫的搜索路徑:
①gcc會去找-L
②再找gcc的環境變量LIBRARY_PATH
③再找內定目錄 /lib、/usr/lib、/usr/local/lib
0x03 條件編譯
以下內容源自某技術博客
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
#ifndef的一般形式是:
#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中有如下指令
#include "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沒有定義,但錯就比較快。
0x04 其他
?
?
?
?
?
?
?
總結
以上是生活随笔為你收集整理的C/C++之预处理命令的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: C/C++之类的前置声明
- 下一篇: s3c2440移植MQTT