HTMLDiagnostics.cpp revision c4bac8e376b98d633bb00ee5f510d5e58449753c
1//===--- HTMLDiagnostics.cpp - HTML Diagnostics for Paths ----*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file defines the HTMLDiagnostics object. 11// 12//===----------------------------------------------------------------------===// 13 14#include "clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h" 15#include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h" 16#include "clang/AST/ASTContext.h" 17#include "clang/AST/Decl.h" 18#include "clang/Basic/SourceManager.h" 19#include "clang/Basic/FileManager.h" 20#include "clang/Rewrite/Rewriter.h" 21#include "clang/Rewrite/HTMLRewrite.h" 22#include "clang/Lex/Lexer.h" 23#include "clang/Lex/Preprocessor.h" 24#include "llvm/Support/FileSystem.h" 25#include "llvm/Support/MemoryBuffer.h" 26#include "llvm/Support/raw_ostream.h" 27#include "llvm/Support/Path.h" 28 29using namespace clang; 30using namespace ento; 31 32//===----------------------------------------------------------------------===// 33// Boilerplate. 34//===----------------------------------------------------------------------===// 35 36namespace { 37 38class HTMLDiagnostics : public PathDiagnosticConsumer { 39 llvm::sys::Path Directory, FilePrefix; 40 bool createdDir, noDir; 41 const Preprocessor &PP; 42public: 43 HTMLDiagnostics(const std::string& prefix, const Preprocessor &pp); 44 45 virtual ~HTMLDiagnostics() { FlushDiagnostics(NULL); } 46 47 virtual void FlushDiagnosticsImpl(std::vector<const PathDiagnostic *> &Diags, 48 FilesMade *filesMade); 49 50 virtual StringRef getName() const { 51 return "HTMLDiagnostics"; 52 } 53 54 unsigned ProcessMacroPiece(raw_ostream &os, 55 const PathDiagnosticMacroPiece& P, 56 unsigned num); 57 58 void HandlePiece(Rewriter& R, FileID BugFileID, 59 const PathDiagnosticPiece& P, unsigned num, unsigned max); 60 61 void HighlightRange(Rewriter& R, FileID BugFileID, SourceRange Range, 62 const char *HighlightStart = "<span class=\"mrange\">", 63 const char *HighlightEnd = "</span>"); 64 65 void ReportDiag(const PathDiagnostic& D, 66 FilesMade *filesMade); 67}; 68 69} // end anonymous namespace 70 71HTMLDiagnostics::HTMLDiagnostics(const std::string& prefix, 72 const Preprocessor &pp) 73 : Directory(prefix), FilePrefix(prefix), createdDir(false), noDir(false), 74 PP(pp) { 75 // All html files begin with "report" 76 FilePrefix.appendComponent("report"); 77} 78 79void ento::createHTMLDiagnosticConsumer(PathDiagnosticConsumers &C, 80 const std::string& prefix, 81 const Preprocessor &PP) { 82 C.push_back(new HTMLDiagnostics(prefix, PP)); 83} 84 85//===----------------------------------------------------------------------===// 86// Report processing. 87//===----------------------------------------------------------------------===// 88 89void HTMLDiagnostics::FlushDiagnosticsImpl( 90 std::vector<const PathDiagnostic *> &Diags, 91 FilesMade *filesMade) { 92 for (std::vector<const PathDiagnostic *>::iterator it = Diags.begin(), 93 et = Diags.end(); it != et; ++it) { 94 ReportDiag(**it, filesMade); 95 } 96} 97 98void HTMLDiagnostics::ReportDiag(const PathDiagnostic& D, 99 FilesMade *filesMade) { 100 101 // Create the HTML directory if it is missing. 102 if (!createdDir) { 103 createdDir = true; 104 std::string ErrorMsg; 105 Directory.createDirectoryOnDisk(true, &ErrorMsg); 106 107 bool IsDirectory; 108 if (llvm::sys::fs::is_directory(Directory.str(), IsDirectory) || 109 !IsDirectory) { 110 llvm::errs() << "warning: could not create directory '" 111 << Directory.str() << "'\n" 112 << "reason: " << ErrorMsg << '\n'; 113 114 noDir = true; 115 116 return; 117 } 118 } 119 120 if (noDir) 121 return; 122 123 // First flatten out the entire path to make it easier to use. 124 PathPieces path = D.path.flatten(/*ShouldFlattenMacros=*/false); 125 126 // The path as already been prechecked that all parts of the path are 127 // from the same file and that it is non-empty. 128 const SourceManager &SMgr = (*path.begin())->getLocation().getManager(); 129 assert(!path.empty()); 130 FileID FID = 131 (*path.begin())->getLocation().asLocation().getExpansionLoc().getFileID(); 132 assert(!FID.isInvalid()); 133 134 // Create a new rewriter to generate HTML. 135 Rewriter R(const_cast<SourceManager&>(SMgr), PP.getLangOpts()); 136 137 // Process the path. 138 unsigned n = path.size(); 139 unsigned max = n; 140 141 for (PathPieces::const_reverse_iterator I = path.rbegin(), 142 E = path.rend(); 143 I != E; ++I, --n) 144 HandlePiece(R, FID, **I, n, max); 145 146 // Add line numbers, header, footer, etc. 147 148 // unsigned FID = R.getSourceMgr().getMainFileID(); 149 html::EscapeText(R, FID); 150 html::AddLineNumbers(R, FID); 151 152 // If we have a preprocessor, relex the file and syntax highlight. 153 // We might not have a preprocessor if we come from a deserialized AST file, 154 // for example. 155 156 html::SyntaxHighlight(R, FID, PP); 157 html::HighlightMacros(R, FID, PP); 158 159 // Get the full directory name of the analyzed file. 160 161 const FileEntry* Entry = SMgr.getFileEntryForID(FID); 162 163 // This is a cludge; basically we want to append either the full 164 // working directory if we have no directory information. This is 165 // a work in progress. 166 167 std::string DirName = ""; 168 169 if (llvm::sys::path::is_relative(Entry->getName())) { 170 llvm::sys::Path P = llvm::sys::Path::GetCurrentDirectory(); 171 DirName = P.str() + "/"; 172 } 173 174 // Add the name of the file as an <h1> tag. 175 176 { 177 std::string s; 178 llvm::raw_string_ostream os(s); 179 180 os << "<!-- REPORTHEADER -->\n" 181 << "<h3>Bug Summary</h3>\n<table class=\"simpletable\">\n" 182 "<tr><td class=\"rowname\">File:</td><td>" 183 << html::EscapeText(DirName) 184 << html::EscapeText(Entry->getName()) 185 << "</td></tr>\n<tr><td class=\"rowname\">Location:</td><td>" 186 "<a href=\"#EndPath\">line " 187 << (*path.rbegin())->getLocation().asLocation().getExpansionLineNumber() 188 << ", column " 189 << (*path.rbegin())->getLocation().asLocation().getExpansionColumnNumber() 190 << "</a></td></tr>\n" 191 "<tr><td class=\"rowname\">Description:</td><td>" 192 << D.getDescription() << "</td></tr>\n"; 193 194 // Output any other meta data. 195 196 for (PathDiagnostic::meta_iterator I=D.meta_begin(), E=D.meta_end(); 197 I!=E; ++I) { 198 os << "<tr><td></td><td>" << html::EscapeText(*I) << "</td></tr>\n"; 199 } 200 201 os << "</table>\n<!-- REPORTSUMMARYEXTRA -->\n" 202 "<h3>Annotated Source Code</h3>\n"; 203 204 R.InsertTextBefore(SMgr.getLocForStartOfFile(FID), os.str()); 205 } 206 207 // Embed meta-data tags. 208 { 209 std::string s; 210 llvm::raw_string_ostream os(s); 211 212 const std::string& BugDesc = D.getDescription(); 213 if (!BugDesc.empty()) 214 os << "\n<!-- BUGDESC " << BugDesc << " -->\n"; 215 216 const std::string& BugType = D.getBugType(); 217 if (!BugType.empty()) 218 os << "\n<!-- BUGTYPE " << BugType << " -->\n"; 219 220 const std::string& BugCategory = D.getCategory(); 221 if (!BugCategory.empty()) 222 os << "\n<!-- BUGCATEGORY " << BugCategory << " -->\n"; 223 224 os << "\n<!-- BUGFILE " << DirName << Entry->getName() << " -->\n"; 225 226 os << "\n<!-- BUGLINE " 227 << path.back()->getLocation().asLocation().getExpansionLineNumber() 228 << " -->\n"; 229 230 os << "\n<!-- BUGPATHLENGTH " << path.size() << " -->\n"; 231 232 // Mark the end of the tags. 233 os << "\n<!-- BUGMETAEND -->\n"; 234 235 // Insert the text. 236 R.InsertTextBefore(SMgr.getLocForStartOfFile(FID), os.str()); 237 } 238 239 // Add CSS, header, and footer. 240 241 html::AddHeaderFooterInternalBuiltinCSS(R, FID, Entry->getName()); 242 243 // Get the rewrite buffer. 244 const RewriteBuffer *Buf = R.getRewriteBufferFor(FID); 245 246 if (!Buf) { 247 llvm::errs() << "warning: no diagnostics generated for main file.\n"; 248 return; 249 } 250 251 // Create a path for the target HTML file. 252 llvm::sys::Path F(FilePrefix); 253 F.makeUnique(false, NULL); 254 255 // Rename the file with an HTML extension. 256 llvm::sys::Path H(F); 257 H.appendSuffix("html"); 258 F.renamePathOnDisk(H, NULL); 259 260 std::string ErrorMsg; 261 llvm::raw_fd_ostream os(H.c_str(), ErrorMsg); 262 263 if (!ErrorMsg.empty()) { 264 llvm::errs() << "warning: could not create file '" << F.str() 265 << "'\n"; 266 return; 267 } 268 269 if (filesMade) { 270 filesMade->push_back(std::make_pair(StringRef(getName()), 271 llvm::sys::path::filename(H.str()))); 272 } 273 274 // Emit the HTML to disk. 275 for (RewriteBuffer::iterator I = Buf->begin(), E = Buf->end(); I!=E; ++I) 276 os << *I; 277} 278 279void HTMLDiagnostics::HandlePiece(Rewriter& R, FileID BugFileID, 280 const PathDiagnosticPiece& P, 281 unsigned num, unsigned max) { 282 283 // For now, just draw a box above the line in question, and emit the 284 // warning. 285 FullSourceLoc Pos = P.getLocation().asLocation(); 286 287 if (!Pos.isValid()) 288 return; 289 290 SourceManager &SM = R.getSourceMgr(); 291 assert(&Pos.getManager() == &SM && "SourceManagers are different!"); 292 std::pair<FileID, unsigned> LPosInfo = SM.getDecomposedExpansionLoc(Pos); 293 294 if (LPosInfo.first != BugFileID) 295 return; 296 297 const llvm::MemoryBuffer *Buf = SM.getBuffer(LPosInfo.first); 298 const char* FileStart = Buf->getBufferStart(); 299 300 // Compute the column number. Rewind from the current position to the start 301 // of the line. 302 unsigned ColNo = SM.getColumnNumber(LPosInfo.first, LPosInfo.second); 303 const char *TokInstantiationPtr =Pos.getExpansionLoc().getCharacterData(); 304 const char *LineStart = TokInstantiationPtr-ColNo; 305 306 // Compute LineEnd. 307 const char *LineEnd = TokInstantiationPtr; 308 const char* FileEnd = Buf->getBufferEnd(); 309 while (*LineEnd != '\n' && LineEnd != FileEnd) 310 ++LineEnd; 311 312 // Compute the margin offset by counting tabs and non-tabs. 313 unsigned PosNo = 0; 314 for (const char* c = LineStart; c != TokInstantiationPtr; ++c) 315 PosNo += *c == '\t' ? 8 : 1; 316 317 // Create the html for the message. 318 319 const char *Kind = 0; 320 switch (P.getKind()) { 321 case PathDiagnosticPiece::Call: 322 llvm_unreachable("Calls should already be handled"); 323 case PathDiagnosticPiece::Event: Kind = "Event"; break; 324 case PathDiagnosticPiece::ControlFlow: Kind = "Control"; break; 325 // Setting Kind to "Control" is intentional. 326 case PathDiagnosticPiece::Macro: Kind = "Control"; break; 327 } 328 329 std::string sbuf; 330 llvm::raw_string_ostream os(sbuf); 331 332 os << "\n<tr><td class=\"num\"></td><td class=\"line\"><div id=\""; 333 334 if (num == max) 335 os << "EndPath"; 336 else 337 os << "Path" << num; 338 339 os << "\" class=\"msg"; 340 if (Kind) 341 os << " msg" << Kind; 342 os << "\" style=\"margin-left:" << PosNo << "ex"; 343 344 // Output a maximum size. 345 if (!isa<PathDiagnosticMacroPiece>(P)) { 346 // Get the string and determining its maximum substring. 347 const std::string& Msg = P.getString(); 348 unsigned max_token = 0; 349 unsigned cnt = 0; 350 unsigned len = Msg.size(); 351 352 for (std::string::const_iterator I=Msg.begin(), E=Msg.end(); I!=E; ++I) 353 switch (*I) { 354 default: 355 ++cnt; 356 continue; 357 case ' ': 358 case '\t': 359 case '\n': 360 if (cnt > max_token) max_token = cnt; 361 cnt = 0; 362 } 363 364 if (cnt > max_token) 365 max_token = cnt; 366 367 // Determine the approximate size of the message bubble in em. 368 unsigned em; 369 const unsigned max_line = 120; 370 371 if (max_token >= max_line) 372 em = max_token / 2; 373 else { 374 unsigned characters = max_line; 375 unsigned lines = len / max_line; 376 377 if (lines > 0) { 378 for (; characters > max_token; --characters) 379 if (len / characters > lines) { 380 ++characters; 381 break; 382 } 383 } 384 385 em = characters / 2; 386 } 387 388 if (em < max_line/2) 389 os << "; max-width:" << em << "em"; 390 } 391 else 392 os << "; max-width:100em"; 393 394 os << "\">"; 395 396 if (max > 1) { 397 os << "<table class=\"msgT\"><tr><td valign=\"top\">"; 398 os << "<div class=\"PathIndex"; 399 if (Kind) os << " PathIndex" << Kind; 400 os << "\">" << num << "</div>"; 401 402 if (num > 1) { 403 os << "</td><td><div class=\"PathNav\"><a href=\"#Path" 404 << (num - 1) 405 << "\" title=\"Previous event (" 406 << (num - 1) 407 << ")\">←</a></div></td>"; 408 } 409 410 os << "</td><td>"; 411 } 412 413 if (const PathDiagnosticMacroPiece *MP = 414 dyn_cast<PathDiagnosticMacroPiece>(&P)) { 415 416 os << "Within the expansion of the macro '"; 417 418 // Get the name of the macro by relexing it. 419 { 420 FullSourceLoc L = MP->getLocation().asLocation().getExpansionLoc(); 421 assert(L.isFileID()); 422 StringRef BufferInfo = L.getBufferData(); 423 std::pair<FileID, unsigned> LocInfo = L.getDecomposedLoc(); 424 const char* MacroName = LocInfo.second + BufferInfo.data(); 425 Lexer rawLexer(SM.getLocForStartOfFile(LocInfo.first), PP.getLangOpts(), 426 BufferInfo.begin(), MacroName, BufferInfo.end()); 427 428 Token TheTok; 429 rawLexer.LexFromRawLexer(TheTok); 430 for (unsigned i = 0, n = TheTok.getLength(); i < n; ++i) 431 os << MacroName[i]; 432 } 433 434 os << "':\n"; 435 436 if (max > 1) { 437 os << "</td>"; 438 if (num < max) { 439 os << "<td><div class=\"PathNav\"><a href=\"#"; 440 if (num == max - 1) 441 os << "EndPath"; 442 else 443 os << "Path" << (num + 1); 444 os << "\" title=\"Next event (" 445 << (num + 1) 446 << ")\">→</a></div></td>"; 447 } 448 449 os << "</tr></table>"; 450 } 451 452 // Within a macro piece. Write out each event. 453 ProcessMacroPiece(os, *MP, 0); 454 } 455 else { 456 os << html::EscapeText(P.getString()); 457 458 if (max > 1) { 459 os << "</td>"; 460 if (num < max) { 461 os << "<td><div class=\"PathNav\"><a href=\"#"; 462 if (num == max - 1) 463 os << "EndPath"; 464 else 465 os << "Path" << (num + 1); 466 os << "\" title=\"Next event (" 467 << (num + 1) 468 << ")\">→</a></div></td>"; 469 } 470 471 os << "</tr></table>"; 472 } 473 } 474 475 os << "</div></td></tr>"; 476 477 // Insert the new html. 478 unsigned DisplayPos = LineEnd - FileStart; 479 SourceLocation Loc = 480 SM.getLocForStartOfFile(LPosInfo.first).getLocWithOffset(DisplayPos); 481 482 R.InsertTextBefore(Loc, os.str()); 483 484 // Now highlight the ranges. 485 for (const SourceRange *I = P.ranges_begin(), *E = P.ranges_end(); 486 I != E; ++I) 487 HighlightRange(R, LPosInfo.first, *I); 488 489#if 0 490 // If there is a code insertion hint, insert that code. 491 // FIXME: This code is disabled because it seems to mangle the HTML 492 // output. I'm leaving it here because it's generally the right idea, 493 // but needs some help from someone more familiar with the rewriter. 494 for (const FixItHint *Hint = P.fixit_begin(), *HintEnd = P.fixit_end(); 495 Hint != HintEnd; ++Hint) { 496 if (Hint->RemoveRange.isValid()) { 497 HighlightRange(R, LPosInfo.first, Hint->RemoveRange, 498 "<span class=\"CodeRemovalHint\">", "</span>"); 499 } 500 if (Hint->InsertionLoc.isValid()) { 501 std::string EscapedCode = html::EscapeText(Hint->CodeToInsert, true); 502 EscapedCode = "<span class=\"CodeInsertionHint\">" + EscapedCode 503 + "</span>"; 504 R.InsertTextBefore(Hint->InsertionLoc, EscapedCode); 505 } 506 } 507#endif 508} 509 510static void EmitAlphaCounter(raw_ostream &os, unsigned n) { 511 unsigned x = n % ('z' - 'a'); 512 n /= 'z' - 'a'; 513 514 if (n > 0) 515 EmitAlphaCounter(os, n); 516 517 os << char('a' + x); 518} 519 520unsigned HTMLDiagnostics::ProcessMacroPiece(raw_ostream &os, 521 const PathDiagnosticMacroPiece& P, 522 unsigned num) { 523 524 for (PathPieces::const_iterator I = P.subPieces.begin(), E=P.subPieces.end(); 525 I!=E; ++I) { 526 527 if (const PathDiagnosticMacroPiece *MP = 528 dyn_cast<PathDiagnosticMacroPiece>(*I)) { 529 num = ProcessMacroPiece(os, *MP, num); 530 continue; 531 } 532 533 if (PathDiagnosticEventPiece *EP = dyn_cast<PathDiagnosticEventPiece>(*I)) { 534 os << "<div class=\"msg msgEvent\" style=\"width:94%; " 535 "margin-left:5px\">" 536 "<table class=\"msgT\"><tr>" 537 "<td valign=\"top\"><div class=\"PathIndex PathIndexEvent\">"; 538 EmitAlphaCounter(os, num++); 539 os << "</div></td><td valign=\"top\">" 540 << html::EscapeText(EP->getString()) 541 << "</td></tr></table></div>\n"; 542 } 543 } 544 545 return num; 546} 547 548void HTMLDiagnostics::HighlightRange(Rewriter& R, FileID BugFileID, 549 SourceRange Range, 550 const char *HighlightStart, 551 const char *HighlightEnd) { 552 SourceManager &SM = R.getSourceMgr(); 553 const LangOptions &LangOpts = R.getLangOpts(); 554 555 SourceLocation InstantiationStart = SM.getExpansionLoc(Range.getBegin()); 556 unsigned StartLineNo = SM.getExpansionLineNumber(InstantiationStart); 557 558 SourceLocation InstantiationEnd = SM.getExpansionLoc(Range.getEnd()); 559 unsigned EndLineNo = SM.getExpansionLineNumber(InstantiationEnd); 560 561 if (EndLineNo < StartLineNo) 562 return; 563 564 if (SM.getFileID(InstantiationStart) != BugFileID || 565 SM.getFileID(InstantiationEnd) != BugFileID) 566 return; 567 568 // Compute the column number of the end. 569 unsigned EndColNo = SM.getExpansionColumnNumber(InstantiationEnd); 570 unsigned OldEndColNo = EndColNo; 571 572 if (EndColNo) { 573 // Add in the length of the token, so that we cover multi-char tokens. 574 EndColNo += Lexer::MeasureTokenLength(Range.getEnd(), SM, LangOpts)-1; 575 } 576 577 // Highlight the range. Make the span tag the outermost tag for the 578 // selected range. 579 580 SourceLocation E = 581 InstantiationEnd.getLocWithOffset(EndColNo - OldEndColNo); 582 583 html::HighlightRange(R, InstantiationStart, E, HighlightStart, HighlightEnd); 584} 585