條件編譯#ifdef的妙用詳解
#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就是判斷語句,不是預編譯指令
常見的預處理指令如下:
- #空指令,無任何效果
- #include包含一個源代碼文件
- #define定義宏
- #undef取消已定義的宏
- #if如果給定條件為真,則編譯下面代碼
- #ifdef如果宏已經定義,則編譯下面代碼
- #ifndef如果宏沒有定義,則編譯下面代碼
- #elif如果前面的#if給定條件不為真,當前條件為真,則編譯下面代碼
- #endif結束一個#if……#else條件編譯塊
- #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沒有定義,但錯就比較快。
請看下面一個例子:
- {
- printf("%s\n",HELLO);
- return 1;
- }
如果你覺得這個打印會是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文件中。
條件編譯#ifdef的妙用詳解