程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> C語言 >> C++ >> C++入門知識 >> C標准庫<assert.h>實現

C標准庫<assert.h>實現

編輯:C++入門知識

本文地址:http://www.cnblogs.com/archimedes/p/c-library-assert.html,轉載請注明源地址。

1.背景知識

頭文件<assert.h>唯一的目的就是提供assert宏定義,可以在程序中關鍵的地方使用這個宏來進行斷言。如果一處斷言被證明非真,希望程序在標准錯誤流輸出一條適當的提示信息,並使執行異常終止。

可以這樣寫代碼:

#include<assert.h>
...
assert(0 <= i && i < sizeof(a) / sizeof(a[0]));

當然上面的代碼不是實戰中的最好的形式,程序異常終止應該改為某種錯誤的恢復。

宏NDEBUG

可以通過在程序的某些地方定義宏NDEBUG來改變assert的展開方式

如果程序某個包含assert的地方沒有定義NDEBUG,該頭文件就會將宏assert定義為活動形式,它就可以展開為一個表達式,測試斷言並在斷言為假的時候輸出一條錯誤信息,然後程序終止。反之,如果定義了NDEBUG,頭文件就會把這個宏定義為不執行任何操作的靜止形式。

2.<assert.h>的使用

從上面的代碼中可以看到,可以使用一個簡單的謂詞來簡化assert:

if(!ok)
    abort();  //在頭文件<stdlib.h>中聲明

如果覺得斷言沒有存在的必要,就在包含頭文件之前加上下面的代碼:

#define NDEBUG //取消斷言
#include<assert.h>

可以在整個源文件中用不同的方式控制斷言,當斷言在頻繁執行的循環內部發生時,性能可能會急劇下降,或在達到提示性的部分之前,一個更早的斷言可能會終止程序。要打開斷言,可以寫:

#undef NDEBUG
#include<assert.h>

要關閉斷言,可以寫:

#define NDEBUG
#include<assert.h>

注意:即使宏NDEBUG已經被定義了,我們仍然可以安全地定義它,這是一個良性重定義

3.<assert.h>的實現

從上面的分析知該頭文件的大致框架如下:

#undef assert  //消除已定義的
#ifdef NDEBUG
#define assert(expr)  ((void) 0)  //功能失效
#else
#define assert (expr) ...
#endif

一個簡單的編寫宏assert的活動形式的方式如下:

#define assert(expr) if(!(expr)) \
    fprintf(stderr, "Assertion failed: %s, file %s, line %i\n", \
        #expr, __FILE__, __LINE__)

這種方式因為如下幾種原因不能接受:

1、宏不能直接調用庫的任何輸出函數

上面的定義中包含fprintf、stderr等在stdio.h中定義的函數或宏,程序可能沒有包含這個頭文件

2、宏必須能擴展為一個void類型的表達式

3、宏應該可以擴展為有效並且緊湊的代碼

這個版本卻總是調用了一個傳遞了5個參數的函數

修改後的assert宏如下:

#undef assert
#ifdef NDEBUG
    #define assert(expr)  ((void) 0)
#else
    void __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__ 是內置宏,代表該行代碼的所在行號,由於__LINE__沒有擴展成字符串字面量,它變成了一個十進制常量,把它轉換成適當的形式需要一個額外的處理層。向頭文件中添加兩個隱藏的宏__str和__xstr來實現,其中一個宏用它的十進制常量擴展來取代__LINE__,另一個是把十進制常量轉換成一個字符串字面量

宏調用的隱藏庫函數__bad_assertion的實現:

#include<assert.h>
#include<stdio.h>
#include<stdlib.h>
void __bad_assertion(const char *mess) {
        fputs(mess, stderr);
        abort();
 }

函數__bad_assertion使用了兩個其他的庫函數,通過調用<stdio.h>中聲明的函數fputs把字符串寫到標准錯誤流,並使用abort異常終止程序的執行,有關這些相關頭文件以後會詳細剖析。

4.<assert.h>的測試

#include<assert.h>
#include<stdio.h>
#include<stdlib.h>
int main( void )
{
       FILE *fp;
       fp = fopen( "test.txt", "w" );//以可寫的方式打開一個文件,如果不存在就創建一個同名文件
       assert( fp );                           //所以這裡不會出錯
       fclose( fp );
    
       fp = fopen( "noexitfile.txt", "r" );//以只讀的方式打開一個文件,如果不存在就打開文件失敗
       assert( fp );                           //所以這裡出錯
       fclose( fp );                           //程序永遠都執行不到這裡來
       return 0;
}

注意:

1.在函數開始處檢驗傳入參數的合法性如:

int resetBufferSize(int nNewSize)
{
  //功能:改變緩沖區大小,
  //參數:nNewSize 緩沖區新長度
  //返回值:緩沖區當前長度 
  //說明:保持原信息內容不變     nNewSize<=0表示清除緩沖區
  assert(nNewSize >= 0);
  assert(nNewSize <= MAX_BUFFER_SIZE);
  ...
}

2.每個assert只檢驗一個條件,因為同時檢驗多個條件時,如果斷言失敗,無法直觀的判斷是哪個條件失敗,如:

assert(nOffset>=0 && nOffset+nSize<=m_nInfomationSize);//不好

//好
assert(nOffset >= 0);
assert(nOffset+nSize <= m_nInfomationSize);

3.不能使用改變環境的語句,因為assert只在DEBUG個生效,如果這麼做,會使用程序在真正運行時遇到問題,如:

錯誤:

assert(i++ < 100);

這是因為如果出錯,比如在執行之前i=100,那麼這條語句就不會執行,那麼i++這條命令就沒有執行。

正確:

assert(i < 100);
i++;

4.assert和後面的語句應空一行,以形成邏輯和視覺上的一致感。

5.在有的地方,assert不能代替條件過濾。

參考資料

《C標准庫》

 

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved