1. Diagnostic需要提供哪些數據
出錯處理和錯誤提示,是編譯器開發過程中重要而繁瑣的部分。
診斷信息的格式因編譯器和IDE而不同。
SALVIA將采用Visual Studio的格式,即 文件 + 行列 + 類別(等級) + 編號 + 出錯信息。例如:
d:\programming\salvia\sasl\test\cgllvm_test\function_test_basic.cpp(16): error C2061: syntax error : identifier 'te'
因此在出錯分析的時候,也需要提供如上的一些信息。
2. 診斷信息Diagnostic Item
在以上信息中,文件名和行列號可以在詞法分析的時候獲得,我們將它作為屬性附加在Token中。
類別和編號,對于同一個編譯器而言是相對固定的,盡管我們可以用ID來表示,但是它并不直觀,編譯器檢查也較少。與參數匹配時,也比較容易出錯。
SASL中的診斷信息將每個錯誤都使用一個類型來表達:
class diagnostic_item
{
};
class unrecognized_identifier: public diagnostic_item
{
public:
unrecognized_identifier& token( token_t tok );
private:
static int level;
static int id;
static std::string description_template;
private:
std::string ident;
size_t row, col;
// Other properties
};
這樣的好處在于可以用Combinator的風格來撰寫錯誤信息。例如這樣:
diagnostic_chat.report<unrecognized_identifier>().token( err_tok );
并且由于編譯器的保證也比較不容易寫錯。
但是這種寫法也有一個很關鍵的問題,需要為每個錯誤都定義一個類,工作量很大。SASL對這一問題的處理,自然是傳統的大殺器:運用腳本進行生成。
Clang使用了它內置的代碼生成工具td來完成生成的工作。
3. 診斷信息管理器Diagnostic Chat
Chat是診斷信息的管理工具。它主要要完成以下需求:添加和清理診斷信息,以及在診斷信息的添加清理時提供回調操作。
后者是很有用的,尤其是在調試編譯器的時候。你得分清楚究竟是真正的程序錯誤呢,還是編譯器出了錯。
Diagnostic Chat的原型如下:
class diagnostic_chat
{
public:
template <typename T> T& report();
void add_report_diagnostic_handler( DiagnosticHandlerT handler );
};
同時,我們也將Treat Warning As Error,Error Count,Disable Warning,Stop compiling when error occurs等狀態和功能所需要的支持添加到Chat中。
所以,Chat除了提供管理之外,也要具有相應的診斷信息的統計功能。
4. 過濾器Diagnostic Filter
Filter主要配合IDE使用,從Chat中取出符合條件的診斷信息。Error Count和Disable Warnings等功能也可以通過它來完成。
5. Formatter
Formatter用于將DiagnosticItems中的信息轉換成人可讀的字符串。目前SASL只打算支持Visual Studio的格式,但是相信支持GCC的格式以更好的和Eclipse等第三方IDE集成并不困難。
在C#里面,我們可以用“We need ‘{0}’ not ‘{1}’.”這樣的方式來分離description template并延期的產生格式化的字符串。但是在C++中,這種做法并不容易。C的sprintf很難具有延期、漸增的綁定模板的特定,對自定義類型的字符串化的支持也不足,類型安全也比較差;而stream的話,也會面臨著將好端端的格式化字符串割裂的問題。SASL使用了boost.format,從一定程度上搞定了這兩個問題,從而像C#一樣,使用格式化字符串的功能。