# 15.4 錯誤報告 有時候你需要在控制臺或者一個對話框中顯示一條消息以幫助調試或者用來提示那些不能被你的代碼正常處理的行為.wxWidgets提供了很多用于記錄錯誤的函數,這些函數工作方式各不相同,你可以使用它們來進行運行情況的報告和記錄.比如,當你正在分配一個很大的圖片時,可能由于這個圖片太大了,系統無法分配足夠的資源,系統將使用wxLogError函數顯示一個對話框來報告這個錯誤(如下圖所示).又或者說,你想將某個參數的值打印在調試窗口中以便于調試,你可以使用wxLogDebug函數.究竟這些錯誤信息或者調試信息是顯示在終端上,對話框中還是別的什么地方,取決于你所使用的函數,以及當前激活的wxLog目標對象,我們將在稍后的部分描述相關內容.  所有的這種記錄函數都擁有類似于printf或vprintf的語法,也就是:第一個參數是格式化文本參數,后面是不定類型的變量或者一組指向變量的指針,如下所示: ``` wxString name(wxT("Calculation")); int nGoes = 3; wxLogError(wxT("%s does not compute! You have %d more goes."), name.c_str(), nGoes); ``` 下面我們逐個描述一下這些函數: wxLogError函數用來顯示那些必須顯示給用戶的錯誤消息.其默認行為是彈出一個對話框來通知用戶相應的錯誤.那為什么不直接使用 wxMessageBox呢?原因是,首先wxLogError提示的錯誤消息是可以通過創建一個wxLogNull的Log目標來屏蔽讓其不顯示出來的,而且這些消息也是排在系統隊列中,在系統空閑的時候顯示的.因此如果有一系列的錯誤同時出現,它們將顯示在同一個對話框中,而如果使用 wxMessageBox,你的用戶可能不得不不停的點擊OK按鈕. wxLogFatalError和wxLogError類似,不過除了顯示錯誤消息,它還使用標準的系統調用abort,以錯誤碼3結束整個程序的運行.和其它類似的函數不同,這個函數顯示的消息不能通過設置空的打印目標的方法來屏蔽. wxLogWarning也和wxLogError類似,不過顯示的信息將作為警告而不是錯誤. wxLogMessage則用來顯示所有正常的,信息類型的消息,默認也是顯示在對話框中. wxLogVerbose則用來顯示那些冗長的詳細信息.通常情況下,這種信息是不顯示的,但是如果用戶想顯示它以便了解程序運行的更詳細的情況,可以通過使用wxLog::SetVerbose函數改變這種默認的行為. wxLogStatus則用來顯示狀態條消息,如果當前的frame窗口擁有一個狀態條,那么這個消息將顯示在那里. wxLogSysError通常主要被wxWidgets自己使用,它用來報告那些系統錯誤,同時會顯示由errno或者GetLastError(依平臺的不同)指示的錯誤碼和錯誤消息.它的另外一種形式允許你的第一個參數的位置顯式的指示系統錯誤碼. wxLogDebug用來顯式調試信息.這些信息只在調試版本中(定義了__WXDEBUG__宏)才會出現,在正式版本中將被移除.在 windows平臺上,只有當程序在一個調試器中運行或者使用第三方工具比如來自http://www.sysinternals.com的 DebugView工具運行的時候才會顯示出來. wxLogTrace和wxLogDebug的功能幾乎完全一樣,也是只在調試模式才會顯示信息.之所以有這個函數,是為了提供一個和普通的調試模式不同的級別以便區分普通的調試信息和用于跟蹤的調試信息.它的另外一種形式允許你指定一個掩碼,通過wxLog:: AddTraceMask函數設置了掩碼以后,只有掩碼符合的跟蹤消息才會被顯示出來以實現跟蹤消息的過濾.比如在wxWidgets內部使用了 mousecapture掩碼.如果你設置了這個掩碼,在鼠標移動的時候你將看到跟蹤信息. ``` void wxWindowBase::CaptureMouse() { wxLogTrace(wxT("mousecapture"), wxT("CaptureMouse(%p) "), this); ... } void MyApp::OnInit() { // Add mousecapture to the list of trace masks wxLog::AddTraceMask(wxT("mousecapture")); ... } ``` 你可能會疑惑,為什么不直接使用C的標準輸入輸出函數或者C++的流呢?簡短的回答是,它們都是很不錯的機制,但是并不一定適用于wxWidgets.wxLog機制主要有以下三個優點: 首先,wxLog是可移植的.常用的printf語句或者C++的cout流和cerr流在unix系統下工作是沒有問題的,但是在 windows系統中,對于圖形化界面的應用程序,這些函數或流可能不能正常顯示需要的內容.因此,你可以使用wxLogMessage作為printf 的一個簡單的替代品. 你也可以通過下面的方法將所有的log信息轉向標準的cout流: ``` wxLog *logger=new wxLogStream(&cout); wxLog::SetActiveTarget(logger); ``` 另外,將發送往cout的輸出重定向到一個wxTextCtrl控件也是可行的,這需要使用到wxStreamToTextRedirector類. 其次:wxLog更靈活.使用wxLog機制的輸出可以被分情況重定向或者隱藏,比如只顯示錯誤消息和告警消息,忽略所有正常的信息.而如果使用標準的函數或流,這是不可能的或者說是很難作到的. 最后:wxLog機制也是更完善的機制.通常,當有錯誤發生的時候,應該給用戶顯示一些信息.讓我們來舉一個簡單的例子,假如你正在進行寫文件操作,這時候發生了磁盤空間不足的情況,這種錯誤是被wxWidgets內部(wxFile::Write)處理的,因此,調用這個函數只能知道寫動作發生了異常,至于是什么類型的異常則很難得到,如果在這種情況下使用wxLogError函數,正確的錯誤碼和相應的錯誤信息都將顯示給用戶. 現在我們來描述以下wxWidgets的Log機制是怎樣工作的,以便你處理那些默認沒有提供的行為. wxWidgets有一個log目標的概念:它其實就是一個wxLog的派生類.它需要實現wxLog定義的那些虛函數,這些函數將在相應的Log函數被調用的時候使用.任何時候都只有一個log目標是活動的.log目標通常的使用方法就是調用wxLog:: SetActiveTarget來安裝這個目標,安裝以后的目標將在相應的log函數被調用的時候自動使用. 要創建一個自定義的log目標,你只需要創建一個wxLog的派生類,并實現其虛函數DoLogString和(或)DoLog.如果你對wxWidgets默認的增加時間戳和信息類型的格式化方法感到滿意,只是想更改信息的目的地,那么實現DoLogString函數就足夠了,而重載 DoLog函數則使得你可以任意的定制輸出信息的格式,不過同時你也需要自己區分信息的各種類型.你可以參考src/common/log.cpp文件看看wxWidgets是怎么作到這一點的. wxWidgets自己實現了幾個wxLog的派生類,你也可以讀一讀它們的代碼,這對你創建自定義的log目標也是有好處的.這些預定義的log目標包括: wxLogStderr將所有的信息輸出到FILE*作為參數的文件中,如果FILE*為空,則輸出到標準錯誤輸出. wxLogStream和wxLogStderr功能相同,不過它使用標準C++的ostream類和cerr流來代替FILE*和stderr. wxLogGui則是wxWidgets所有wxWidgets程序默認使用的log目標,依平臺的不同它實現了不同的輸出處理. wxLogWindow則提供了一個類似"跟蹤終端"之類的窗口,這個窗口將顯示所有的輸出信息,同時這些信息也將顯示在之前的log目標上.這個跟蹤終端窗口提供了清除信息,關閉窗口以及將所有信息保存到文件中的功能. wxLogNull則被用來臨時阻止某些錯誤信息的輸出,比如你打開不存在的文件的時候將顯示一個錯誤信息,有時候你不希望顯示這個信息,可以在棧上創建一個wxLogNull變量,在這個變量的作用域范圍內,沒有任何錯誤信息將被顯示,而離開了其作用域,則所有的信息又可以正常顯示了. ``` wxFile file; // wxFile.Open()在打開一個不存在的文件時通常會顯示錯誤信息,但是在這里我們不想看到這個信息. { wxLogNull logNo; if ( !file.Open("bar") ) ... process error ourselves ... } // wxLogNull的析構函數被調用,舊的log目標被恢復. wxLogMessage("..."); // 可以被顯示 ``` 有時候你也許希望將信息輸出到多個地方,比如,你可以希望所有的信息在正常顯示的同時被保存在某個文件中,這時候你可以使用wxLogChain和wxLogPassThrough,如下所示: ``` // 這將隱式的設置當前log目標 wxLogChain *logChain = new wxLogChain(new wxLogStderr); // 所有的輸出將被同時顯示在stderr和通常的地方 // 不要直接刪除logChain指針,這會導致當前活動log目標為一個不確定的指針. // 應該使用SetActiveTarget. delete wxLog::SetActiveTarget(new wxLogGui); ``` wxMessageOutput VS wxLog 有時候,使用wxLog不太合適,這主要是因為wxLog對輸出的信息作了過多的處理,并且會等待空閑的時候才會顯示這些信息.而 wxMessageOutput和它的派生類則可以作為你的底層printf的替代品,來在GUI和命令行程序中使用.你可以象使用printf函數那樣使用wxMessageOutput::Printf函數,比如,如果你想把信息打印在標準錯誤輸入: ``` #include "wx/msgout.h" wxMessageOutputStderr err; err.Printf(wxT("Error in app %s.\n"), appName.c_str()); ``` wxMessageOutputDebug將信息顯示在調試器終端或者是標準錯誤輸出中,這主要看程序是以什么方式運行的,和 wxLogDebug不同,wxMessageOutputDebug輸出的信息在正式版本中將不會被移除.GUI應用程序還可以使用 wxMessageOutputMessageBox來即時顯示消息,而不比象wxLog那樣需要搜集(其它Log信息)和等待(系統空閑),同樣的還存在一個wxMessageOutputLog類,它將消息輸出到wxLogMessage. 和wxLog類似,wxMessageOutput也有一個當前的目標,這個目標可以通過wxMessageOutput::Set設置,通過wxMessageOutput::Get獲取.默認的目標是系統初始化的時候由wxWidgets設置的,在命令行程序中使用的是 wxMessageOutputStderr,在GUI程序中使用的是wxMessageOutputMessageBox.wxWidgets內部經常使用這個對象,比如在wxCmdLineParser類中,使用了下面的代碼: ``` wxMessageOutput* msgOut = wxMessageOutput::Get(); if ( msgOut ) { wxString usage = GetUsageString(); msgOut->Printf( wxT("%s%s"), usage.c_str(), errorMsg.c_str() ); } else { wxFAIL_MSG( _T("no wxMessageOutput object?") ); } ```