lib/StaticAnalyzer/Core/HTMLDiagnostics.cpp

   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
  29 using namespace clang;
  30 using namespace ento;
  31
  32 //===----------------------------------------------------------------------===//
  33 // Boilerplate.
  34 //===----------------------------------------------------------------------===//
  35
  36 namespace {
  37
  38 class HTMLDiagnostics : public PathDiagnosticConsumer {
  39   llvm::sys::Path Directory, FilePrefix;
  40   bool createdDir, noDir;
  41   const Preprocessor &PP;
  42 public:
  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                                     SmallVectorImpl<std::string> *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                   SmallVectorImpl<std::string> *FilesMade);
  67 };
  68
  69 } // end anonymous namespace
  70
  71 HTMLDiagnostics::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
  79 PathDiagnosticConsumer*
  80 ento::createHTMLDiagnosticConsumer(const std::string& prefix,
  81                                  const Preprocessor &PP) {
  82   return new HTMLDiagnostics(prefix, PP);
  83 }
  84
  85 //===----------------------------------------------------------------------===//
  86 // Report processing.
  87 //===----------------------------------------------------------------------===//
  88
  89 void HTMLDiagnostics::FlushDiagnosticsImpl(
  90   std::vector<const PathDiagnostic *> &Diags,
  91   SmallVectorImpl<std::string> *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
  98 void HTMLDiagnostics::ReportDiag(const PathDiagnostic& D,
  99                                  SmallVectorImpl<std::string> *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(llvm::sys::path::filename(H.str()));
 271
 272   // Emit the HTML to disk.
 273   for (RewriteBuffer::iterator I = Buf->begin(), E = Buf->end(); I!=E; ++I)
 274       os << *I;
 275 }
 276
 277 void HTMLDiagnostics::HandlePiece(Rewriter& R, FileID BugFileID,
 278                                   const PathDiagnosticPiece& P,
 279                                   unsigned num, unsigned max) {
 280
 281   // For now, just draw a box above the line in question, and emit the
 282   // warning.
 283   FullSourceLoc Pos = P.getLocation().asLocation();
 284
 285   if (!Pos.isValid())
 286     return;
 287
 288   SourceManager &SM = R.getSourceMgr();
 289   assert(&Pos.getManager() == &SM && "SourceManagers are different!");
 290   std::pair<FileID, unsigned> LPosInfo = SM.getDecomposedExpansionLoc(Pos);
 291
 292   if (LPosInfo.first != BugFileID)
 293     return;
 294
 295   const llvm::MemoryBuffer *Buf = SM.getBuffer(LPosInfo.first);
 296   const char* FileStart = Buf->getBufferStart();
 297
 298   // Compute the column number.  Rewind from the current position to the start
 299   // of the line.
 300   unsigned ColNo = SM.getColumnNumber(LPosInfo.first, LPosInfo.second);
 301   const char *TokInstantiationPtr =Pos.getExpansionLoc().getCharacterData();
 302   const char *LineStart = TokInstantiationPtr-ColNo;
 303
 304   // Compute LineEnd.
 305   const char *LineEnd = TokInstantiationPtr;
 306   const char* FileEnd = Buf->getBufferEnd();
 307   while (*LineEnd != '\n' && LineEnd != FileEnd)
 308     ++LineEnd;
 309
 310   // Compute the margin offset by counting tabs and non-tabs.
 311   unsigned PosNo = 0;
 312   for (const char* c = LineStart; c != TokInstantiationPtr; ++c)
 313     PosNo += *c == '\t' ? 8 : 1;
 314
 315   // Create the html for the message.
 316
 317   const char *Kind = 0;
 318   switch (P.getKind()) {
 319   case PathDiagnosticPiece::Call:
 320       llvm_unreachable("Calls should already be handled");
 321   case PathDiagnosticPiece::Event:  Kind = "Event"; break;
 322   case PathDiagnosticPiece::ControlFlow: Kind = "Control"; break;
 323     // Setting Kind to "Control" is intentional.
 324   case PathDiagnosticPiece::Macro: Kind = "Control"; break;
 325   }
 326
 327   std::string sbuf;
 328   llvm::raw_string_ostream os(sbuf);
 329
 330   os << "\n<tr><td class=\"num\"></td><td class=\"line\"><div id=\"";
 331
 332   if (num == max)
 333     os << "EndPath";
 334   else
 335     os << "Path" << num;
 336
 337   os << "\" class=\"msg";
 338   if (Kind)
 339     os << " msg" << Kind;
 340   os << "\" style=\"margin-left:" << PosNo << "ex";
 341
 342   // Output a maximum size.
 343   if (!isa<PathDiagnosticMacroPiece>(P)) {
 344     // Get the string and determining its maximum substring.
 345     const std::string& Msg = P.getString();
 346     unsigned max_token = 0;
 347     unsigned cnt = 0;
 348     unsigned len = Msg.size();
 349
 350     for (std::string::const_iterator I=Msg.begin(), E=Msg.end(); I!=E; ++I)
 351       switch (*I) {
 352       default:
 353         ++cnt;
 354         continue;
 355       case ' ':
 356       case '\t':
 357       case '\n':
 358         if (cnt > max_token) max_token = cnt;
 359         cnt = 0;
 360       }
 361
 362     if (cnt > max_token)
 363       max_token = cnt;
 364
 365     // Determine the approximate size of the message bubble in em.
 366     unsigned em;
 367     const unsigned max_line = 120;
 368
 369     if (max_token >= max_line)
 370       em = max_token / 2;
 371     else {
 372       unsigned characters = max_line;
 373       unsigned lines = len / max_line;
 374
 375       if (lines > 0) {
 376         for (; characters > max_token; --characters)
 377           if (len / characters > lines) {
 378             ++characters;
 379             break;
 380           }
 381       }
 382
 383       em = characters / 2;
 384     }
 385
 386     if (em < max_line/2)
 387       os << "; max-width:" << em << "em";
 388   }
 389   else
 390     os << "; max-width:100em";
 391
 392   os << "\">";
 393
 394   if (max > 1) {
 395     os << "<table class=\"msgT\"><tr><td valign=\"top\">";
 396     os << "<div class=\"PathIndex";
 397     if (Kind) os << " PathIndex" << Kind;
 398     os << "\">" << num << "</div>";
 399
 400     if (num > 1) {
 401       os << "</td><td><div class=\"PathNav\"><a href=\"#Path"
 402          << (num - 1)
 403          << "\" title=\"Previous event ("
 404          << (num - 1)
 405          << ")\">&#x2190;</a></div></td>";
 406     }
 407
 408     os << "</td><td>";
 409   }
 410
 411   if (const PathDiagnosticMacroPiece *MP =
 412         dyn_cast<PathDiagnosticMacroPiece>(&P)) {
 413
 414     os << "Within the expansion of the macro '";
 415
 416     // Get the name of the macro by relexing it.
 417     {
 418       FullSourceLoc L = MP->getLocation().asLocation().getExpansionLoc();
 419       assert(L.isFileID());
 420       StringRef BufferInfo = L.getBufferData();
 421       std::pair<FileID, unsigned> LocInfo = L.getDecomposedLoc();
 422       const char* MacroName = LocInfo.second + BufferInfo.data();
 423       Lexer rawLexer(SM.getLocForStartOfFile(LocInfo.first), PP.getLangOpts(),
 424                      BufferInfo.begin(), MacroName, BufferInfo.end());
 425
 426       Token TheTok;
 427       rawLexer.LexFromRawLexer(TheTok);
 428       for (unsigned i = 0, n = TheTok.getLength(); i < n; ++i)
 429         os << MacroName[i];
 430     }
 431
 432     os << "':\n";
 433
 434     if (max > 1) {
 435       os << "</td>";
 436       if (num < max) {
 437         os << "<td><div class=\"PathNav\"><a href=\"#";
 438         if (num == max - 1)
 439           os << "EndPath";
 440         else
 441           os << "Path" << (num + 1);
 442         os << "\" title=\"Next event ("
 443         << (num + 1)
 444         << ")\">&#x2192;</a></div></td>";
 445       }
 446
 447       os << "</tr></table>";
 448     }
 449
 450     // Within a macro piece.  Write out each event.
 451     ProcessMacroPiece(os, *MP, 0);
 452   }
 453   else {
 454     os << html::EscapeText(P.getString());
 455
 456     if (max > 1) {
 457       os << "</td>";
 458       if (num < max) {
 459         os << "<td><div class=\"PathNav\"><a href=\"#";
 460         if (num == max - 1)
 461           os << "EndPath";
 462         else
 463           os << "Path" << (num + 1);
 464         os << "\" title=\"Next event ("
 465            << (num + 1)
 466            << ")\">&#x2192;</a></div></td>";
 467       }
 468
 469       os << "</tr></table>";
 470     }
 471   }
 472
 473   os << "</div></td></tr>";
 474
 475   // Insert the new html.
 476   unsigned DisplayPos = LineEnd - FileStart;
 477   SourceLocation Loc =
 478     SM.getLocForStartOfFile(LPosInfo.first).getLocWithOffset(DisplayPos);
 479
 480   R.InsertTextBefore(Loc, os.str());
 481
 482   // Now highlight the ranges.
 483   for (const SourceRange *I = P.ranges_begin(), *E = P.ranges_end();
 484         I != E; ++I)
 485     HighlightRange(R, LPosInfo.first, *I);
 486
 487 #if 0
 488   // If there is a code insertion hint, insert that code.
 489   // FIXME: This code is disabled because it seems to mangle the HTML
 490   // output. I'm leaving it here because it's generally the right idea,
 491   // but needs some help from someone more familiar with the rewriter.
 492   for (const FixItHint *Hint = P.fixit_begin(), *HintEnd = P.fixit_end();
 493        Hint != HintEnd; ++Hint) {
 494     if (Hint->RemoveRange.isValid()) {
 495       HighlightRange(R, LPosInfo.first, Hint->RemoveRange,
 496                      "<span class=\"CodeRemovalHint\">", "</span>");
 497     }
 498     if (Hint->InsertionLoc.isValid()) {
 499       std::string EscapedCode = html::EscapeText(Hint->CodeToInsert, true);
 500       EscapedCode = "<span class=\"CodeInsertionHint\">" + EscapedCode
 501         + "</span>";
 502       R.InsertTextBefore(Hint->InsertionLoc, EscapedCode);
 503     }
 504   }
 505 #endif
 506 }
 507
 508 static void EmitAlphaCounter(raw_ostream &os, unsigned n) {
 509   unsigned x = n % ('z' - 'a');
 510   n /= 'z' - 'a';
 511
 512   if (n > 0)
 513     EmitAlphaCounter(os, n);
 514
 515   os << char('a' + x);
 516 }
 517
 518 unsigned HTMLDiagnostics::ProcessMacroPiece(raw_ostream &os,
 519                                             const PathDiagnosticMacroPiece& P,
 520                                             unsigned num) {
 521
 522   for (PathPieces::const_iterator I = P.subPieces.begin(), E=P.subPieces.end();
 523         I!=E; ++I) {
 524
 525     if (const PathDiagnosticMacroPiece *MP =
 526           dyn_cast<PathDiagnosticMacroPiece>(*I)) {
 527       num = ProcessMacroPiece(os, *MP, num);
 528       continue;
 529     }
 530
 531     if (PathDiagnosticEventPiece *EP = dyn_cast<PathDiagnosticEventPiece>(*I)) {
 532       os << "<div class=\"msg msgEvent\" style=\"width:94%; "
 533             "margin-left:5px\">"
 534             "<table class=\"msgT\"><tr>"
 535             "<td valign=\"top\"><div class=\"PathIndex PathIndexEvent\">";
 536       EmitAlphaCounter(os, num++);
 537       os << "</div></td><td valign=\"top\">"
 538          << html::EscapeText(EP->getString())
 539          << "</td></tr></table></div>\n";
 540     }
 541   }
 542
 543   return num;
 544 }
 545
 546 void HTMLDiagnostics::HighlightRange(Rewriter& R, FileID BugFileID,
 547                                      SourceRange Range,
 548                                      const char *HighlightStart,
 549                                      const char *HighlightEnd) {
 550   SourceManager &SM = R.getSourceMgr();
 551   const LangOptions &LangOpts = R.getLangOpts();
 552
 553   SourceLocation InstantiationStart = SM.getExpansionLoc(Range.getBegin());
 554   unsigned StartLineNo = SM.getExpansionLineNumber(InstantiationStart);
 555
 556   SourceLocation InstantiationEnd = SM.getExpansionLoc(Range.getEnd());
 557   unsigned EndLineNo = SM.getExpansionLineNumber(InstantiationEnd);
 558
 559   if (EndLineNo < StartLineNo)
 560     return;
 561
 562   if (SM.getFileID(InstantiationStart) != BugFileID ||
 563       SM.getFileID(InstantiationEnd) != BugFileID)
 564     return;
 565
 566   // Compute the column number of the end.
 567   unsigned EndColNo = SM.getExpansionColumnNumber(InstantiationEnd);
 568   unsigned OldEndColNo = EndColNo;
 569
 570   if (EndColNo) {
 571     // Add in the length of the token, so that we cover multi-char tokens.
 572     EndColNo += Lexer::MeasureTokenLength(Range.getEnd(), SM, LangOpts)-1;
 573   }
 574
 575   // Highlight the range.  Make the span tag the outermost tag for the
 576   // selected range.
 577
 578   SourceLocation E =
 579     InstantiationEnd.getLocWithOffset(EndColNo - OldEndColNo);
 580
 581   html::HighlightRange(R, InstantiationStart, E, HighlightStart, HighlightEnd);
 582 }