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