C标准库assert.h实现
1.背景知識(shí)
頭文件<assert.h>唯一的目的就是提供assert宏定義,可以在程序中關(guān)鍵的地方使用這個(gè)宏來進(jìn)行斷言。如果一處斷言被證明非真,希望程序在標(biāo)準(zhǔn)錯(cuò)誤流輸出一條適當(dāng)?shù)奶崾拘畔?#xff0c;并使執(zhí)行異常終止。
可以這樣寫代碼:
#include<assert.h> ... assert(0 <= i && i < sizeof(a) / sizeof(a[0]));當(dāng)然上面的代碼不是實(shí)戰(zhàn)中的最好的形式,程序異常終止應(yīng)該改為某種錯(cuò)誤的恢復(fù)。
宏NDEBUG
可以通過在程序的某些地方定義宏NDEBUG來改變assert的展開方式
如果程序某個(gè)包含assert的地方?jīng)]有定義NDEBUG,該頭文件就會(huì)將宏assert定義為活動(dòng)形式,它就可以展開為一個(gè)表達(dá)式,測(cè)試斷言并在斷言為假的時(shí)候輸出一條錯(cuò)誤信息,然后程序終止。反之,如果定義了NDEBUG,頭文件就會(huì)把這個(gè)宏定義為不執(zhí)行任何操作的靜止形式。
2.<assert.h>的使用
從上面的代碼中可以看到,可以使用一個(gè)簡(jiǎn)單的謂詞來簡(jiǎn)化assert:
if(!ok)abort(); //在頭文件<stdlib.h>中聲明如果覺得斷言沒有存在的必要,就在包含頭文件之前加上下面的代碼:
#define NDEBUG //取消斷言 #include<assert.h>可以在整個(gè)源文件中用不同的方式控制斷言,當(dāng)斷言在頻繁執(zhí)行的循環(huán)內(nèi)部發(fā)生時(shí),性能可能會(huì)急劇下降,或在達(dá)到提示性的部分之前,一個(gè)更早的斷言可能會(huì)終止程序。要打開斷言,可以寫:
#undef NDEBUG #include<assert.h>要關(guān)閉斷言,可以寫:
#define NDEBUG #include<assert.h>注意:即使宏NDEBUG已經(jīng)被定義了,我們?nèi)匀豢梢园踩囟x它,這是一個(gè)良性重定義
3.<assert.h>的實(shí)現(xiàn)
從上面的分析知該頭文件的大致框架如下:
#undef assert //消除已定義的 #ifdef NDEBUG #define assert(expr) ((void) 0) //功能失效 #else #define assert (expr) ... #endif一個(gè)簡(jiǎn)單的編寫宏assert的活動(dòng)形式的方式如下:
#define assert(expr) if(!(expr)) \fprintf(stderr, "Assertion failed: %s, file %s, line %i\n", \#expr, __FILE__, __LINE__)這種方式因?yàn)槿缦聨追N原因不能接受:
1、宏不能直接調(diào)用庫的任何輸出函數(shù)
上面的定義中包含fprintf、stderr等在stdio.h中定義的函數(shù)或宏,程序可能沒有包含這個(gè)頭文件
2、宏必須能擴(kuò)展為一個(gè)void類型的表達(dá)式
3、宏應(yīng)該可以擴(kuò)展為有效并且緊湊的代碼
這個(gè)版本卻總是調(diào)用了一個(gè)傳遞了5個(gè)參數(shù)的函數(shù)
修改后的assert宏如下:
#undef assert #ifdef NDEBUG#define assert(expr) ((void) 0) #elsevoid __bad_assertion (const char *_mess);#define __str(x) # x#define __xstr(x) __str(x)#define assert(expr) ((expr)? (void)0 : \__bad_assertion("Assertion \"" #expr \"\" failed, file " __xstr(__FILE__) \", line " __xstr(__LINE__) "\n")) #endif其中__LINE__ 是內(nèi)置宏,代表該行代碼的所在行號(hào),由于__LINE__沒有擴(kuò)展成字符串字面量,它變成了一個(gè)十進(jìn)制常量,把它轉(zhuǎn)換成適當(dāng)?shù)男问叫枰粋€(gè)額外的處理層。向頭文件中添加兩個(gè)隱藏的宏__str和__xstr來實(shí)現(xiàn),其中一個(gè)宏用它的十進(jìn)制常量擴(kuò)展來取代__LINE__,另一個(gè)是把十進(jìn)制常量轉(zhuǎn)換成一個(gè)字符串字面量
宏調(diào)用的隱藏庫函數(shù)__bad_assertion的實(shí)現(xiàn):
#include<assert.h> #include<stdio.h> #include<stdlib.h> void __bad_assertion(const char *mess) {fputs(mess, stderr);abort();}函數(shù)__bad_assertion使用了兩個(gè)其他的庫函數(shù),通過調(diào)用<stdio.h>中聲明的函數(shù)fputs把字符串寫到標(biāo)準(zhǔn)錯(cuò)誤流,并使用abort異常終止程序的執(zhí)行,有關(guān)這些相關(guān)頭文件以后會(huì)詳細(xì)剖析。
4.<assert.h>的測(cè)試
#include<assert.h> #include<stdio.h> #include<stdlib.h> int main( void ) {FILE *fp;fp = fopen( "test.txt", "w" );//以可寫的方式打開一個(gè)文件,如果不存在就創(chuàng)建一個(gè)同名文件assert( fp ); //所以這里不會(huì)出錯(cuò) fclose( fp );fp = fopen( "noexitfile.txt", "r" );//以只讀的方式打開一個(gè)文件,如果不存在就打開文件失敗assert( fp ); //所以這里出錯(cuò)fclose( fp ); //程序永遠(yuǎn)都執(zhí)行不到這里來return 0; }注意:
1.在函數(shù)開始處檢驗(yàn)傳入?yún)?shù)的合法性如:
int resetBufferSize(int nNewSize) {//功能:改變緩沖區(qū)大小,//參數(shù):nNewSize 緩沖區(qū)新長度//返回值:緩沖區(qū)當(dāng)前長度 //說明:保持原信息內(nèi)容不變 nNewSize<=0表示清除緩沖區(qū)assert(nNewSize >= 0);assert(nNewSize <= MAX_BUFFER_SIZE);... }2.每個(gè)assert只檢驗(yàn)一個(gè)條件,因?yàn)橥瑫r(shí)檢驗(yàn)多個(gè)條件時(shí),如果斷言失敗,無法直觀的判斷是哪個(gè)條件失敗,如:
assert(nOffset>=0 && nOffset+nSize<=m_nInfomationSize);//不好//好 assert(nOffset >= 0); assert(nOffset+nSize <= m_nInfomationSize);3.不能使用改變環(huán)境的語句,因?yàn)閍ssert只在DEBUG個(gè)生效,如果這么做,會(huì)使用程序在真正運(yùn)行時(shí)遇到問題,如:
錯(cuò)誤:
assert(i++ < 100);這是因?yàn)槿绻鲥e(cuò),比如在執(zhí)行之前i=100,那么這條語句就不會(huì)執(zhí)行,那么i++這條命令就沒有執(zhí)行。
正確:
assert(i < 100); i++;4.assert和后面的語句應(yīng)空一行,以形成邏輯和視覺上的一致感。
5.在有的地方,assert不能代替條件過濾。
參考資料
《C標(biāo)準(zhǔn)庫》
本文地址:http://www.cnblogs.com/archimedes/p/c-library-assert.html,轉(zhuǎn)載請(qǐng)注明源地址。
總結(jié)
以上是生活随笔為你收集整理的C标准库assert.h实现的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 编写高效的C程序与C代码优化
- 下一篇: hadoop实战--搭建开发环境及编写H