blob: c0f5d141be066f88d81e48ad5c9024e2631b1a46 [file] [log] [blame]
//===--- DiagChecker.cpp - Diagnostic Checking Functions ------------------===//
// The LLVM Compiler Infrastructure
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
// Process the input files and check that the diagnostic messages are expected.
#include "clang/Frontend/Utils.h"
#include "clang/Frontend/TextDiagnosticBuffer.h"
#include "clang/Sema/ParseAST.h"
#include "clang/AST/ASTConsumer.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Lex/Preprocessor.h"
#include <cstdio>
using namespace clang;
typedef TextDiagnosticBuffer::DiagList DiagList;
typedef TextDiagnosticBuffer::const_iterator const_diag_iterator;
static void EmitError(Preprocessor &PP, SourceLocation Pos, const char *String){
unsigned ID = PP.getDiagnostics().getCustomDiagID(Diagnostic::Error, String);
PP.Diag(Pos, ID);
// Indicating that a line expects an error or a warning is simple. Put a comment
// on the line that has the diagnostic, use "expected-{error,warning}" to tag
// if it's an expected error or warning, and place the expected text between {{
// and }} markers. The full text doesn't have to be included, only enough to
// ensure that the correct diagnostic was emitted.
// Here's an example:
// int A = B; // expected-error {{use of undeclared identifier 'B'}}
// You can place as many diagnostics on one line as you wish. To make the code
// more readable, you can use slash-newline to separate out the diagnostics.
// The simple syntax above allows each specification to match exactly one error.
// You can use the extended syntax to customize this. The extended syntax is
// "expected-<type> <n> {{diag text}}", where <type> is one of "error",
// "warning" or "note", and <n> is a positive integer. This allows the
// diagnostic to appear as many times as specified. Example:
// void f(); // expected-note 2 {{previous declaration is here}}
/// FindDiagnostics - Go through the comment and see if it indicates expected
/// diagnostics. If so, then put them in a diagnostic list.
static void FindDiagnostics(const char *CommentStart, unsigned CommentLen,
DiagList &ExpectedDiags,
Preprocessor &PP, SourceLocation Pos,
const char *ExpectedStr) {
const char *CommentEnd = CommentStart+CommentLen;
unsigned ExpectedStrLen = strlen(ExpectedStr);
// Find all expected-foo diagnostics in the string and add them to
// ExpectedDiags.
while (CommentStart != CommentEnd) {
CommentStart = std::find(CommentStart, CommentEnd, 'e');
if (unsigned(CommentEnd-CommentStart) < ExpectedStrLen) return;
// If this isn't expected-foo, ignore it.
if (memcmp(CommentStart, ExpectedStr, ExpectedStrLen)) {
CommentStart += ExpectedStrLen;
// Skip whitespace.
while (CommentStart != CommentEnd &&
// Default, if we find the '{' now, is 1 time.
int Times = 1;
int Temp = 0;
// In extended syntax, there could be a digit now.
while (CommentStart != CommentEnd &&
CommentStart[0] >= '0' && CommentStart[0] <= '9') {
Temp *= 10;
Temp += CommentStart[0] - '0';
if (Temp > 0)
Times = Temp;
// Skip whitespace again.
while (CommentStart != CommentEnd &&
// We should have a {{ now.
if (CommentEnd-CommentStart < 2 ||
CommentStart[0] != '{' || CommentStart[1] != '{') {
if (std::find(CommentStart, CommentEnd, '{') != CommentEnd)
EmitError(PP, Pos, "bogus characters before '{{' in expected string");
EmitError(PP, Pos, "cannot find start ('{{') of expected string");
CommentStart += 2;
// Find the }}.
const char *ExpectedEnd = CommentStart;
while (1) {
ExpectedEnd = std::find(ExpectedEnd, CommentEnd, '}');
if (CommentEnd-ExpectedEnd < 2) {
EmitError(PP, Pos, "cannot find end ('}}') of expected string");
if (ExpectedEnd[1] == '}')
++ExpectedEnd; // Skip over singular }'s
std::string Msg(CommentStart, ExpectedEnd);
std::string::size_type FindPos;
while ((FindPos = Msg.find("\\n")) != std::string::npos)
Msg.replace(FindPos, 2, "\n");
// Add is possibly multiple times.
for (int i = 0; i < Times; ++i)
ExpectedDiags.push_back(std::make_pair(Pos, Msg));
CommentStart = ExpectedEnd;
/// FindExpectedDiags - Lex the main source file to find all of the
// expected errors and warnings.
static void FindExpectedDiags(Preprocessor &PP,
DiagList &ExpectedErrors,
DiagList &ExpectedWarnings,
DiagList &ExpectedNotes) {
// Create a raw lexer to pull all the comments out of the main file. We don't
// want to look in #include'd headers for expected-error strings.
FileID FID = PP.getSourceManager().getMainFileID();
// Create a lexer to lex all the tokens of the main file in raw mode.
Lexer RawLex(FID, PP.getSourceManager(), PP.getLangOptions());
// Return comments as tokens, this is how we find expected diagnostics.
Token Tok;
while (Tok.isNot(tok::eof)) {
if (! continue;
std::string Comment = PP.getSpelling(Tok);
if (Comment.empty()) continue;
// Find all expected errors.
FindDiagnostics(&Comment[0], Comment.size(), ExpectedErrors, PP,
Tok.getLocation(), "expected-error");
// Find all expected warnings.
FindDiagnostics(&Comment[0], Comment.size(), ExpectedWarnings, PP,
Tok.getLocation(), "expected-warning");
// Find all expected notes.
FindDiagnostics(&Comment[0], Comment.size(), ExpectedNotes, PP,
Tok.getLocation(), "expected-note");
/// PrintProblem - This takes a diagnostic map of the delta between expected and
/// seen diagnostics. If there's anything in it, then something unexpected
/// happened. Print the map out in a nice format and return "true". If the map
/// is empty and we're not going to print things, then return "false".
static bool PrintProblem(SourceManager &SourceMgr,
const_diag_iterator diag_begin,
const_diag_iterator diag_end,
const char *Msg) {
if (diag_begin == diag_end) return false;
fprintf(stderr, "%s\n", Msg);
for (const_diag_iterator I = diag_begin, E = diag_end; I != E; ++I)
fprintf(stderr, " Line %d: %s\n",
return true;
/// CompareDiagLists - Compare two diagnostic lists and return the difference
/// between them.
static bool CompareDiagLists(SourceManager &SourceMgr,
const_diag_iterator d1_begin,
const_diag_iterator d1_end,
const_diag_iterator d2_begin,
const_diag_iterator d2_end,
const char *MsgLeftOnly,
const char *MsgRightOnly) {
DiagList LeftOnly;
DiagList Left(d1_begin, d1_end);
DiagList Right(d2_begin, d2_end);
for (const_diag_iterator I = Left.begin(), E = Left.end(); I != E; ++I) {
unsigned LineNo1 = SourceMgr.getInstantiationLineNumber(I->first);
const std::string &Diag1 = I->second;
DiagList::iterator II, IE;
for (II = Right.begin(), IE = Right.end(); II != IE; ++II) {
unsigned LineNo2 = SourceMgr.getInstantiationLineNumber(II->first);
if (LineNo1 != LineNo2) continue;
const std::string &Diag2 = II->second;
if (Diag2.find(Diag1) != std::string::npos ||
Diag1.find(Diag2) != std::string::npos) {
if (II == IE) {
// Not found.
} else {
// Found. The same cannot be found twice.
// Now all that's left in Right are those that were not matched.
return PrintProblem(SourceMgr, LeftOnly.begin(), LeftOnly.end(), MsgLeftOnly)
| PrintProblem(SourceMgr, Right.begin(), Right.end(), MsgRightOnly);
/// CheckResults - This compares the expected results to those that
/// were actually reported. It emits any discrepencies. Return "true" if there
/// were problems. Return "false" otherwise.
static bool CheckResults(Preprocessor &PP,
const DiagList &ExpectedErrors,
const DiagList &ExpectedWarnings,
const DiagList &ExpectedNotes) {
const DiagnosticClient *DiagClient = PP.getDiagnostics().getClient();
assert(DiagClient != 0 &&
"DiagChecker requires a valid TextDiagnosticBuffer");
const TextDiagnosticBuffer &Diags =
static_cast<const TextDiagnosticBuffer&>(*DiagClient);
SourceManager &SourceMgr = PP.getSourceManager();
// We want to capture the delta between what was expected and what was
// seen.
// Expected \ Seen - set expected but not seen
// Seen \ Expected - set seen but not expected
bool HadProblem = false;
// See if there are error mismatches.
HadProblem |= CompareDiagLists(SourceMgr,
ExpectedErrors.begin(), ExpectedErrors.end(),
Diags.err_begin(), Diags.err_end(),
"Errors expected but not seen:",
"Errors seen but not expected:");
// See if there are warning mismatches.
HadProblem |= CompareDiagLists(SourceMgr,
Diags.warn_begin(), Diags.warn_end(),
"Warnings expected but not seen:",
"Warnings seen but not expected:");
// See if there are note mismatches.
HadProblem |= CompareDiagLists(SourceMgr,
Diags.note_begin(), Diags.note_end(),
"Notes expected but not seen:",
"Notes seen but not expected:");
return HadProblem;
/// CheckDiagnostics - Gather the expected diagnostics and check them.
bool clang::CheckDiagnostics(Preprocessor &PP) {
// Gather the set of expected diagnostics.
DiagList ExpectedErrors, ExpectedWarnings, ExpectedNotes;
FindExpectedDiags(PP, ExpectedErrors, ExpectedWarnings, ExpectedNotes);
// Check that the expected diagnostics occurred.
return CheckResults(PP, ExpectedErrors, ExpectedWarnings, ExpectedNotes);