1//===- HTMLDiagnostics.cpp - HTML Diagnostics for Paths -------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9//  This file defines the HTMLDiagnostics object.
10//
11//===----------------------------------------------------------------------===//
12
13#include "clang/Analysis/PathDiagnostic.h"
14#include "clang/AST/Decl.h"
15#include "clang/AST/DeclBase.h"
16#include "clang/AST/Stmt.h"
17#include "clang/Basic/FileManager.h"
18#include "clang/Basic/LLVM.h"
19#include "clang/Basic/SourceLocation.h"
20#include "clang/Basic/SourceManager.h"
21#include "clang/Lex/Lexer.h"
22#include "clang/Lex/Preprocessor.h"
23#include "clang/Lex/Token.h"
24#include "clang/Rewrite/Core/HTMLRewrite.h"
25#include "clang/Rewrite/Core/Rewriter.h"
26#include "clang/StaticAnalyzer/Core/AnalyzerOptions.h"
27#include "clang/StaticAnalyzer/Core/IssueHash.h"
28#include "clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h"
29#include "llvm/ADT/ArrayRef.h"
30#include "llvm/ADT/SmallString.h"
31#include "llvm/ADT/StringRef.h"
32#include "llvm/ADT/iterator_range.h"
33#include "llvm/Support/Casting.h"
34#include "llvm/Support/Errc.h"
35#include "llvm/Support/ErrorHandling.h"
36#include "llvm/Support/FileSystem.h"
37#include "llvm/Support/MemoryBuffer.h"
38#include "llvm/Support/Path.h"
39#include "llvm/Support/raw_ostream.h"
40#include <algorithm>
41#include <cassert>
42#include <map>
43#include <memory>
44#include <set>
45#include <sstream>
46#include <string>
47#include <system_error>
48#include <utility>
49#include <vector>
50
51using namespace clang;
52using namespace ento;
53
54//===----------------------------------------------------------------------===//
55// Boilerplate.
56//===----------------------------------------------------------------------===//
57
58namespace {
59
60class HTMLDiagnostics : public PathDiagnosticConsumer {
61  std::string Directory;
62  bool createdDir = false;
63  bool noDir = false;
64  const Preprocessor &PP;
65  AnalyzerOptions &AnalyzerOpts;
66  const bool SupportsCrossFileDiagnostics;
67
68public:
69  HTMLDiagnostics(AnalyzerOptions &AnalyzerOpts,
70                  const std::string& prefix,
71                  const Preprocessor &pp,
72                  bool supportsMultipleFiles)
73      : Directory(prefix), PP(pp), AnalyzerOpts(AnalyzerOpts),
74        SupportsCrossFileDiagnostics(supportsMultipleFiles) {}
75
76  ~HTMLDiagnostics() override { FlushDiagnostics(nullptr); }
77
78  void FlushDiagnosticsImpl(std::vector<const PathDiagnostic *> &Diags,
79                            FilesMade *filesMade) override;
80
81  StringRef getName() const override {
82    return "HTMLDiagnostics";
83  }
84
85  bool supportsCrossFileDiagnostics() const override {
86    return SupportsCrossFileDiagnostics;
87  }
88
89  unsigned ProcessMacroPiece(raw_ostream &os,
90                             const PathDiagnosticMacroPiece& P,
91                             unsigned num);
92
93  void HandlePiece(Rewriter &R, FileID BugFileID, const PathDiagnosticPiece &P,
94                   const std::vector<SourceRange> &PopUpRanges, unsigned num,
95                   unsigned max);
96
97  void HighlightRange(Rewriter& R, FileID BugFileID, SourceRange Range,
98                      const char *HighlightStart = "<span class=\"mrange\">",
99                      const char *HighlightEnd = "</span>");
100
101  void ReportDiag(const PathDiagnostic& D,
102                  FilesMade *filesMade);
103
104  // Generate the full HTML report
105  std::string GenerateHTML(const PathDiagnostic& D, Rewriter &R,
106                           const SourceManager& SMgr, const PathPieces& path,
107                           const char *declName);
108
109  // Add HTML header/footers to file specified by FID
110  void FinalizeHTML(const PathDiagnostic& D, Rewriter &R,
111                    const SourceManager& SMgr, const PathPieces& path,
112                    FileID FID, const FileEntry *Entry, const char *declName);
113
114  // Rewrite the file specified by FID with HTML formatting.
115  void RewriteFile(Rewriter &R, const PathPieces& path, FileID FID);
116
117
118private:
119  /// \return Javascript for displaying shortcuts help;
120  StringRef showHelpJavascript();
121
122  /// \return Javascript for navigating the HTML report using j/k keys.
123  StringRef generateKeyboardNavigationJavascript();
124
125  /// \return JavaScript for an option to only show relevant lines.
126  std::string showRelevantLinesJavascript(
127    const PathDiagnostic &D, const PathPieces &path);
128
129  /// Write executed lines from \p D in JSON format into \p os.
130  void dumpCoverageData(const PathDiagnostic &D,
131                        const PathPieces &path,
132                        llvm::raw_string_ostream &os);
133};
134
135} // namespace
136
137void ento::createHTMLDiagnosticConsumer(
138    AnalyzerOptions &AnalyzerOpts, PathDiagnosticConsumers &C,
139    const std::string &prefix, const Preprocessor &PP,
140    const cross_tu::CrossTranslationUnitContext &) {
141  C.push_back(new HTMLDiagnostics(AnalyzerOpts, prefix, PP, true));
142}
143
144void ento::createHTMLSingleFileDiagnosticConsumer(
145    AnalyzerOptions &AnalyzerOpts, PathDiagnosticConsumers &C,
146    const std::string &prefix, const Preprocessor &PP,
147    const cross_tu::CrossTranslationUnitContext &) {
148  C.push_back(new HTMLDiagnostics(AnalyzerOpts, prefix, PP, false));
149}
150
151//===----------------------------------------------------------------------===//
152// Report processing.
153//===----------------------------------------------------------------------===//
154
155void HTMLDiagnostics::FlushDiagnosticsImpl(
156  std::vector<const PathDiagnostic *> &Diags,
157  FilesMade *filesMade) {
158  for (const auto Diag : Diags)
159    ReportDiag(*Diag, filesMade);
160}
161
162void HTMLDiagnostics::ReportDiag(const PathDiagnostic& D,
163                                 FilesMade *filesMade) {
164  // Create the HTML directory if it is missing.
165  if (!createdDir) {
166    createdDir = true;
167    if (std::error_code ec = llvm::sys::fs::create_directories(Directory)) {
168      llvm::errs() << "warning: could not create directory '"
169                   << Directory << "': " << ec.message() << '\n';
170      noDir = true;
171      return;
172    }
173  }
174
175  if (noDir)
176    return;
177
178  // First flatten out the entire path to make it easier to use.
179  PathPieces path = D.path.flatten(/*ShouldFlattenMacros=*/false);
180
181  // The path as already been prechecked that the path is non-empty.
182  assert(!path.empty());
183  const SourceManager &SMgr = path.front()->getLocation().getManager();
184
185  // Create a new rewriter to generate HTML.
186  Rewriter R(const_cast<SourceManager&>(SMgr), PP.getLangOpts());
187
188  // The file for the first path element is considered the main report file, it
189  // will usually be equivalent to SMgr.getMainFileID(); however, it might be a
190  // header when -analyzer-opt-analyze-headers is used.
191  FileID ReportFile = path.front()->getLocation().asLocation().getExpansionLoc().getFileID();
192
193  // Get the function/method name
194  SmallString<128> declName("unknown");
195  int offsetDecl = 0;
196  if (const Decl *DeclWithIssue = D.getDeclWithIssue()) {
197      if (const auto *ND = dyn_cast<NamedDecl>(DeclWithIssue))
198          declName = ND->getDeclName().getAsString();
199
200      if (const Stmt *Body = DeclWithIssue->getBody()) {
201          // Retrieve the relative position of the declaration which will be used
202          // for the file name
203          FullSourceLoc L(
204              SMgr.getExpansionLoc(path.back()->getLocation().asLocation()),
205              SMgr);
206          FullSourceLoc FunL(SMgr.getExpansionLoc(Body->getBeginLoc()), SMgr);
207          offsetDecl = L.getExpansionLineNumber() - FunL.getExpansionLineNumber();
208      }
209  }
210
211  std::string report = GenerateHTML(D, R, SMgr, path, declName.c_str());
212  if (report.empty()) {
213    llvm::errs() << "warning: no diagnostics generated for main file.\n";
214    return;
215  }
216
217  // Create a path for the target HTML file.
218  int FD;
219  SmallString<128> Model, ResultPath;
220
221  if (!AnalyzerOpts.ShouldWriteStableReportFilename) {
222      llvm::sys::path::append(Model, Directory, "report-%%%%%%.html");
223      if (std::error_code EC =
224          llvm::sys::fs::make_absolute(Model)) {
225          llvm::errs() << "warning: could not make '" << Model
226                       << "' absolute: " << EC.message() << '\n';
227        return;
228      }
229      if (std::error_code EC =
230          llvm::sys::fs::createUniqueFile(Model, FD, ResultPath)) {
231          llvm::errs() << "warning: could not create file in '" << Directory
232                       << "': " << EC.message() << '\n';
233          return;
234      }
235  } else {
236      int i = 1;
237      std::error_code EC;
238      do {
239          // Find a filename which is not already used
240          const FileEntry* Entry = SMgr.getFileEntryForID(ReportFile);
241          std::stringstream filename;
242          Model = "";
243          filename << "report-"
244                   << llvm::sys::path::filename(Entry->getName()).str()
245                   << "-" << declName.c_str()
246                   << "-" << offsetDecl
247                   << "-" << i << ".html";
248          llvm::sys::path::append(Model, Directory,
249                                  filename.str());
250          EC = llvm::sys::fs::openFileForReadWrite(
251              Model, FD, llvm::sys::fs::CD_CreateNew, llvm::sys::fs::OF_None);
252          if (EC && EC != llvm::errc::file_exists) {
253              llvm::errs() << "warning: could not create file '" << Model
254                           << "': " << EC.message() << '\n';
255              return;
256          }
257          i++;
258      } while (EC);
259  }
260
261  llvm::raw_fd_ostream os(FD, true);
262
263  if (filesMade)
264    filesMade->addDiagnostic(D, getName(),
265                             llvm::sys::path::filename(ResultPath));
266
267  // Emit the HTML to disk.
268  os << report;
269}
270
271std::string HTMLDiagnostics::GenerateHTML(const PathDiagnostic& D, Rewriter &R,
272    const SourceManager& SMgr, const PathPieces& path, const char *declName) {
273  // Rewrite source files as HTML for every new file the path crosses
274  std::vector<FileID> FileIDs;
275  for (auto I : path) {
276    FileID FID = I->getLocation().asLocation().getExpansionLoc().getFileID();
277    if (llvm::is_contained(FileIDs, FID))
278      continue;
279
280    FileIDs.push_back(FID);
281    RewriteFile(R, path, FID);
282  }
283
284  if (SupportsCrossFileDiagnostics && FileIDs.size() > 1) {
285    // Prefix file names, anchor tags, and nav cursors to every file
286    for (auto I = FileIDs.begin(), E = FileIDs.end(); I != E; I++) {
287      std::string s;
288      llvm::raw_string_ostream os(s);
289
290      if (I != FileIDs.begin())
291        os << "<hr class=divider>\n";
292
293      os << "<div id=File" << I->getHashValue() << ">\n";
294
295      // Left nav arrow
296      if (I != FileIDs.begin())
297        os << "<div class=FileNav><a href=\"#File" << (I - 1)->getHashValue()
298           << "\">&#x2190;</a></div>";
299
300      os << "<h4 class=FileName>" << SMgr.getFileEntryForID(*I)->getName()
301         << "</h4>\n";
302
303      // Right nav arrow
304      if (I + 1 != E)
305        os << "<div class=FileNav><a href=\"#File" << (I + 1)->getHashValue()
306           << "\">&#x2192;</a></div>";
307
308      os << "</div>\n";
309
310      R.InsertTextBefore(SMgr.getLocForStartOfFile(*I), os.str());
311    }
312
313    // Append files to the main report file in the order they appear in the path
314    for (auto I : llvm::make_range(FileIDs.begin() + 1, FileIDs.end())) {
315      std::string s;
316      llvm::raw_string_ostream os(s);
317
318      const RewriteBuffer *Buf = R.getRewriteBufferFor(I);
319      for (auto BI : *Buf)
320        os << BI;
321
322      R.InsertTextAfter(SMgr.getLocForEndOfFile(FileIDs[0]), os.str());
323    }
324  }
325
326  const RewriteBuffer *Buf = R.getRewriteBufferFor(FileIDs[0]);
327  if (!Buf)
328    return {};
329
330  // Add CSS, header, and footer.
331  FileID FID =
332      path.back()->getLocation().asLocation().getExpansionLoc().getFileID();
333  const FileEntry* Entry = SMgr.getFileEntryForID(FID);
334  FinalizeHTML(D, R, SMgr, path, FileIDs[0], Entry, declName);
335
336  std::string file;
337  llvm::raw_string_ostream os(file);
338  for (auto BI : *Buf)
339    os << BI;
340
341  return os.str();
342}
343
344void HTMLDiagnostics::dumpCoverageData(
345    const PathDiagnostic &D,
346    const PathPieces &path,
347    llvm::raw_string_ostream &os) {
348
349  const FilesToLineNumsMap &ExecutedLines = D.getExecutedLines();
350
351  os << "var relevant_lines = {";
352  for (auto I = ExecutedLines.begin(),
353            E = ExecutedLines.end(); I != E; ++I) {
354    if (I != ExecutedLines.begin())
355      os << ", ";
356
357    os << "\"" << I->first.getHashValue() << "\": {";
358    for (unsigned LineNo : I->second) {
359      if (LineNo != *(I->second.begin()))
360        os << ", ";
361
362      os << "\"" << LineNo << "\": 1";
363    }
364    os << "}";
365  }
366
367  os << "};";
368}
369
370std::string HTMLDiagnostics::showRelevantLinesJavascript(
371      const PathDiagnostic &D, const PathPieces &path) {
372  std::string s;
373  llvm::raw_string_ostream os(s);
374  os << "<script type='text/javascript'>\n";
375  dumpCoverageData(D, path, os);
376  os << R"<<<(
377
378var filterCounterexample = function (hide) {
379  var tables = document.getElementsByClassName("code");
380  for (var t=0; t<tables.length; t++) {
381    var table = tables[t];
382    var file_id = table.getAttribute("data-fileid");
383    var lines_in_fid = relevant_lines[file_id];
384    if (!lines_in_fid) {
385      lines_in_fid = {};
386    }
387    var lines = table.getElementsByClassName("codeline");
388    for (var i=0; i<lines.length; i++) {
389        var el = lines[i];
390        var lineNo = el.getAttribute("data-linenumber");
391        if (!lines_in_fid[lineNo]) {
392          if (hide) {
393            el.setAttribute("hidden", "");
394          } else {
395            el.removeAttribute("hidden");
396          }
397        }
398    }
399  }
400}
401
402window.addEventListener("keydown", function (event) {
403  if (event.defaultPrevented) {
404    return;
405  }
406  if (event.key == "S") {
407    var checked = document.getElementsByName("showCounterexample")[0].checked;
408    filterCounterexample(!checked);
409    document.getElementsByName("showCounterexample")[0].checked = !checked;
410  } else {
411    return;
412  }
413  event.preventDefault();
414}, true);
415
416document.addEventListener("DOMContentLoaded", function() {
417    document.querySelector('input[name="showCounterexample"]').onchange=
418        function (event) {
419      filterCounterexample(this.checked);
420    };
421});
422</script>
423
424<form>
425    <input type="checkbox" name="showCounterexample" id="showCounterexample" />
426    <label for="showCounterexample">
427       Show only relevant lines
428    </label>
429</form>
430)<<<";
431
432  return os.str();
433}
434
435void HTMLDiagnostics::FinalizeHTML(const PathDiagnostic& D, Rewriter &R,
436    const SourceManager& SMgr, const PathPieces& path, FileID FID,
437    const FileEntry *Entry, const char *declName) {
438  // This is a cludge; basically we want to append either the full
439  // working directory if we have no directory information.  This is
440  // a work in progress.
441
442  llvm::SmallString<0> DirName;
443
444  if (llvm::sys::path::is_relative(Entry->getName())) {
445    llvm::sys::fs::current_path(DirName);
446    DirName += '/';
447  }
448
449  int LineNumber = path.back()->getLocation().asLocation().getExpansionLineNumber();
450  int ColumnNumber = path.back()->getLocation().asLocation().getExpansionColumnNumber();
451
452  R.InsertTextBefore(SMgr.getLocForStartOfFile(FID), showHelpJavascript());
453
454  R.InsertTextBefore(SMgr.getLocForStartOfFile(FID),
455                     generateKeyboardNavigationJavascript());
456
457  // Checkbox and javascript for filtering the output to the counterexample.
458  R.InsertTextBefore(SMgr.getLocForStartOfFile(FID),
459                     showRelevantLinesJavascript(D, path));
460
461  // Add the name of the file as an <h1> tag.
462  {
463    std::string s;
464    llvm::raw_string_ostream os(s);
465
466    os << "<!-- REPORTHEADER -->\n"
467       << "<h3>Bug Summary</h3>\n<table class=\"simpletable\">\n"
468          "<tr><td class=\"rowname\">File:</td><td>"
469       << html::EscapeText(DirName)
470       << html::EscapeText(Entry->getName())
471       << "</td></tr>\n<tr><td class=\"rowname\">Warning:</td><td>"
472          "<a href=\"#EndPath\">line "
473       << LineNumber
474       << ", column "
475       << ColumnNumber
476       << "</a><br />"
477       << D.getVerboseDescription() << "</td></tr>\n";
478
479    // The navigation across the extra notes pieces.
480    unsigned NumExtraPieces = 0;
481    for (const auto &Piece : path) {
482      if (const auto *P = dyn_cast<PathDiagnosticNotePiece>(Piece.get())) {
483        int LineNumber =
484            P->getLocation().asLocation().getExpansionLineNumber();
485        int ColumnNumber =
486            P->getLocation().asLocation().getExpansionColumnNumber();
487        os << "<tr><td class=\"rowname\">Note:</td><td>"
488           << "<a href=\"#Note" << NumExtraPieces << "\">line "
489           << LineNumber << ", column " << ColumnNumber << "</a><br />"
490           << P->getString() << "</td></tr>";
491        ++NumExtraPieces;
492      }
493    }
494
495    // Output any other meta data.
496
497    for (PathDiagnostic::meta_iterator I = D.meta_begin(), E = D.meta_end();
498         I != E; ++I) {
499      os << "<tr><td></td><td>" << html::EscapeText(*I) << "</td></tr>\n";
500    }
501
502    os << R"<<<(
503</table>
504<!-- REPORTSUMMARYEXTRA -->
505<h3>Annotated Source Code</h3>
506<p>Press <a href="#" onclick="toggleHelp(); return false;">'?'</a>
507   to see keyboard shortcuts</p>
508<input type="checkbox" class="spoilerhider" id="showinvocation" />
509<label for="showinvocation" >Show analyzer invocation</label>
510<div class="spoiler">clang -cc1 )<<<";
511    os << html::EscapeText(AnalyzerOpts.FullCompilerInvocation);
512    os << R"<<<(
513</div>
514<div id='tooltiphint' hidden="true">
515  <p>Keyboard shortcuts: </p>
516  <ul>
517    <li>Use 'j/k' keys for keyboard navigation</li>
518    <li>Use 'Shift+S' to show/hide relevant lines</li>
519    <li>Use '?' to toggle this window</li>
520  </ul>
521  <a href="#" onclick="toggleHelp(); return false;">Close</a>
522</div>
523)<<<";
524    R.InsertTextBefore(SMgr.getLocForStartOfFile(FID), os.str());
525  }
526
527  // Embed meta-data tags.
528  {
529    std::string s;
530    llvm::raw_string_ostream os(s);
531
532    StringRef BugDesc = D.getVerboseDescription();
533    if (!BugDesc.empty())
534      os << "\n<!-- BUGDESC " << BugDesc << " -->\n";
535
536    StringRef BugType = D.getBugType();
537    if (!BugType.empty())
538      os << "\n<!-- BUGTYPE " << BugType << " -->\n";
539
540    PathDiagnosticLocation UPDLoc = D.getUniqueingLoc();
541    FullSourceLoc L(SMgr.getExpansionLoc(UPDLoc.isValid()
542                                             ? UPDLoc.asLocation()
543                                             : D.getLocation().asLocation()),
544                    SMgr);
545    const Decl *DeclWithIssue = D.getDeclWithIssue();
546
547    StringRef BugCategory = D.getCategory();
548    if (!BugCategory.empty())
549      os << "\n<!-- BUGCATEGORY " << BugCategory << " -->\n";
550
551    os << "\n<!-- BUGFILE " << DirName << Entry->getName() << " -->\n";
552
553    os << "\n<!-- FILENAME " << llvm::sys::path::filename(Entry->getName()) << " -->\n";
554
555    os  << "\n<!-- FUNCTIONNAME " <<  declName << " -->\n";
556
557    os << "\n<!-- ISSUEHASHCONTENTOFLINEINCONTEXT "
558       << GetIssueHash(SMgr, L, D.getCheckerName(), D.getBugType(),
559                       DeclWithIssue, PP.getLangOpts())
560       << " -->\n";
561
562    os << "\n<!-- BUGLINE "
563       << LineNumber
564       << " -->\n";
565
566    os << "\n<!-- BUGCOLUMN "
567      << ColumnNumber
568      << " -->\n";
569
570    os << "\n<!-- BUGPATHLENGTH " << path.size() << " -->\n";
571
572    // Mark the end of the tags.
573    os << "\n<!-- BUGMETAEND -->\n";
574
575    // Insert the text.
576    R.InsertTextBefore(SMgr.getLocForStartOfFile(FID), os.str());
577  }
578
579  html::AddHeaderFooterInternalBuiltinCSS(R, FID, Entry->getName());
580}
581
582StringRef HTMLDiagnostics::showHelpJavascript() {
583  return R"<<<(
584<script type='text/javascript'>
585
586var toggleHelp = function() {
587    var hint = document.querySelector("#tooltiphint");
588    var attributeName = "hidden";
589    if (hint.hasAttribute(attributeName)) {
590      hint.removeAttribute(attributeName);
591    } else {
592      hint.setAttribute("hidden", "true");
593    }
594};
595window.addEventListener("keydown", function (event) {
596  if (event.defaultPrevented) {
597    return;
598  }
599  if (event.key == "?") {
600    toggleHelp();
601  } else {
602    return;
603  }
604  event.preventDefault();
605});
606</script>
607)<<<";
608}
609
610static bool shouldDisplayPopUpRange(const SourceRange &Range) {
611  return !(Range.getBegin().isMacroID() || Range.getEnd().isMacroID());
612}
613
614static void
615HandlePopUpPieceStartTag(Rewriter &R,
616                         const std::vector<SourceRange> &PopUpRanges) {
617  for (const auto &Range : PopUpRanges) {
618    if (!shouldDisplayPopUpRange(Range))
619      continue;
620
621    html::HighlightRange(R, Range.getBegin(), Range.getEnd(), "",
622                         "<table class='variable_popup'><tbody>",
623                         /*IsTokenRange=*/true);
624  }
625}
626
627static void HandlePopUpPieceEndTag(Rewriter &R,
628                                   const PathDiagnosticPopUpPiece &Piece,
629                                   std::vector<SourceRange> &PopUpRanges,
630                                   unsigned int LastReportedPieceIndex,
631                                   unsigned int PopUpPieceIndex) {
632  SmallString<256> Buf;
633  llvm::raw_svector_ostream Out(Buf);
634
635  SourceRange Range(Piece.getLocation().asRange());
636  if (!shouldDisplayPopUpRange(Range))
637    return;
638
639  // Write out the path indices with a right arrow and the message as a row.
640  Out << "<tr><td valign='top'><div class='PathIndex PathIndexPopUp'>"
641      << LastReportedPieceIndex;
642
643  // Also annotate the state transition with extra indices.
644  Out << '.' << PopUpPieceIndex;
645
646  Out << "</div></td><td>" << Piece.getString() << "</td></tr>";
647
648  // If no report made at this range mark the variable and add the end tags.
649  if (std::find(PopUpRanges.begin(), PopUpRanges.end(), Range) ==
650      PopUpRanges.end()) {
651    // Store that we create a report at this range.
652    PopUpRanges.push_back(Range);
653
654    Out << "</tbody></table></span>";
655    html::HighlightRange(R, Range.getBegin(), Range.getEnd(),
656                         "<span class='variable'>", Buf.c_str(),
657                         /*IsTokenRange=*/true);
658  } else {
659    // Otherwise inject just the new row at the end of the range.
660    html::HighlightRange(R, Range.getBegin(), Range.getEnd(), "", Buf.c_str(),
661                         /*IsTokenRange=*/true);
662  }
663}
664
665void HTMLDiagnostics::RewriteFile(Rewriter &R,
666                                  const PathPieces& path, FileID FID) {
667  // Process the path.
668  // Maintain the counts of extra note pieces separately.
669  unsigned TotalPieces = path.size();
670  unsigned TotalNotePieces = std::count_if(
671      path.begin(), path.end(), [](const PathDiagnosticPieceRef &p) {
672        return isa<PathDiagnosticNotePiece>(*p);
673      });
674  unsigned PopUpPieceCount = std::count_if(
675      path.begin(), path.end(), [](const PathDiagnosticPieceRef &p) {
676        return isa<PathDiagnosticPopUpPiece>(*p);
677      });
678
679  unsigned TotalRegularPieces = TotalPieces - TotalNotePieces - PopUpPieceCount;
680  unsigned NumRegularPieces = TotalRegularPieces;
681  unsigned NumNotePieces = TotalNotePieces;
682  // Stores the count of the regular piece indices.
683  std::map<int, int> IndexMap;
684
685  // Stores the different ranges where we have reported something.
686  std::vector<SourceRange> PopUpRanges;
687  for (auto I = path.rbegin(), E = path.rend(); I != E; ++I) {
688    const auto &Piece = *I->get();
689
690    if (isa<PathDiagnosticPopUpPiece>(Piece)) {
691      ++IndexMap[NumRegularPieces];
692    } else if (isa<PathDiagnosticNotePiece>(Piece)) {
693      // This adds diagnostic bubbles, but not navigation.
694      // Navigation through note pieces would be added later,
695      // as a separate pass through the piece list.
696      HandlePiece(R, FID, Piece, PopUpRanges, NumNotePieces, TotalNotePieces);
697      --NumNotePieces;
698    } else {
699      HandlePiece(R, FID, Piece, PopUpRanges, NumRegularPieces,
700                  TotalRegularPieces);
701      --NumRegularPieces;
702    }
703  }
704
705  // Secondary indexing if we are having multiple pop-ups between two notes.
706  // (e.g. [(13) 'a' is 'true'];  [(13.1) 'b' is 'false'];  [(13.2) 'c' is...)
707  NumRegularPieces = TotalRegularPieces;
708  for (auto I = path.rbegin(), E = path.rend(); I != E; ++I) {
709    const auto &Piece = *I->get();
710
711    if (const auto *PopUpP = dyn_cast<PathDiagnosticPopUpPiece>(&Piece)) {
712      int PopUpPieceIndex = IndexMap[NumRegularPieces];
713
714      // Pop-up pieces needs the index of the last reported piece and its count
715      // how many times we report to handle multiple reports on the same range.
716      // This marks the variable, adds the </table> end tag and the message
717      // (list element) as a row. The <table> start tag will be added after the
718      // rows has been written out. Note: It stores every different range.
719      HandlePopUpPieceEndTag(R, *PopUpP, PopUpRanges, NumRegularPieces,
720                             PopUpPieceIndex);
721
722      if (PopUpPieceIndex > 0)
723        --IndexMap[NumRegularPieces];
724
725    } else if (!isa<PathDiagnosticNotePiece>(Piece)) {
726      --NumRegularPieces;
727    }
728  }
729
730  // Add the <table> start tag of pop-up pieces based on the stored ranges.
731  HandlePopUpPieceStartTag(R, PopUpRanges);
732
733  // Add line numbers, header, footer, etc.
734  html::EscapeText(R, FID);
735  html::AddLineNumbers(R, FID);
736
737  // If we have a preprocessor, relex the file and syntax highlight.
738  // We might not have a preprocessor if we come from a deserialized AST file,
739  // for example.
740  html::SyntaxHighlight(R, FID, PP);
741  html::HighlightMacros(R, FID, PP);
742}
743
744void HTMLDiagnostics::HandlePiece(Rewriter &R, FileID BugFileID,
745                                  const PathDiagnosticPiece &P,
746                                  const std::vector<SourceRange> &PopUpRanges,
747                                  unsigned num, unsigned max) {
748  // For now, just draw a box above the line in question, and emit the
749  // warning.
750  FullSourceLoc Pos = P.getLocation().asLocation();
751
752  if (!Pos.isValid())
753    return;
754
755  SourceManager &SM = R.getSourceMgr();
756  assert(&Pos.getManager() == &SM && "SourceManagers are different!");
757  std::pair<FileID, unsigned> LPosInfo = SM.getDecomposedExpansionLoc(Pos);
758
759  if (LPosInfo.first != BugFileID)
760    return;
761
762  const llvm::MemoryBuffer *Buf = SM.getBuffer(LPosInfo.first);
763  const char* FileStart = Buf->getBufferStart();
764
765  // Compute the column number.  Rewind from the current position to the start
766  // of the line.
767  unsigned ColNo = SM.getColumnNumber(LPosInfo.first, LPosInfo.second);
768  const char *TokInstantiationPtr =Pos.getExpansionLoc().getCharacterData();
769  const char *LineStart = TokInstantiationPtr-ColNo;
770
771  // Compute LineEnd.
772  const char *LineEnd = TokInstantiationPtr;
773  const char* FileEnd = Buf->getBufferEnd();
774  while (*LineEnd != '\n' && LineEnd != FileEnd)
775    ++LineEnd;
776
777  // Compute the margin offset by counting tabs and non-tabs.
778  unsigned PosNo = 0;
779  for (const char* c = LineStart; c != TokInstantiationPtr; ++c)
780    PosNo += *c == '\t' ? 8 : 1;
781
782  // Create the html for the message.
783
784  const char *Kind = nullptr;
785  bool IsNote = false;
786  bool SuppressIndex = (max == 1);
787  switch (P.getKind()) {
788  case PathDiagnosticPiece::Event: Kind = "Event"; break;
789  case PathDiagnosticPiece::ControlFlow: Kind = "Control"; break;
790    // Setting Kind to "Control" is intentional.
791  case PathDiagnosticPiece::Macro: Kind = "Control"; break;
792  case PathDiagnosticPiece::Note:
793    Kind = "Note";
794    IsNote = true;
795    SuppressIndex = true;
796    break;
797  case PathDiagnosticPiece::Call:
798  case PathDiagnosticPiece::PopUp:
799    llvm_unreachable("Calls and extra notes should already be handled");
800  }
801
802  std::string sbuf;
803  llvm::raw_string_ostream os(sbuf);
804
805  os << "\n<tr><td class=\"num\"></td><td class=\"line\"><div id=\"";
806
807  if (IsNote)
808    os << "Note" << num;
809  else if (num == max)
810    os << "EndPath";
811  else
812    os << "Path" << num;
813
814  os << "\" class=\"msg";
815  if (Kind)
816    os << " msg" << Kind;
817  os << "\" style=\"margin-left:" << PosNo << "ex";
818
819  // Output a maximum size.
820  if (!isa<PathDiagnosticMacroPiece>(P)) {
821    // Get the string and determining its maximum substring.
822    const auto &Msg = P.getString();
823    unsigned max_token = 0;
824    unsigned cnt = 0;
825    unsigned len = Msg.size();
826
827    for (char C : Msg)
828      switch (C) {
829      default:
830        ++cnt;
831        continue;
832      case ' ':
833      case '\t':
834      case '\n':
835        if (cnt > max_token) max_token = cnt;
836        cnt = 0;
837      }
838
839    if (cnt > max_token)
840      max_token = cnt;
841
842    // Determine the approximate size of the message bubble in em.
843    unsigned em;
844    const unsigned max_line = 120;
845
846    if (max_token >= max_line)
847      em = max_token / 2;
848    else {
849      unsigned characters = max_line;
850      unsigned lines = len / max_line;
851
852      if (lines > 0) {
853        for (; characters > max_token; --characters)
854          if (len / characters > lines) {
855            ++characters;
856            break;
857          }
858      }
859
860      em = characters / 2;
861    }
862
863    if (em < max_line/2)
864      os << "; max-width:" << em << "em";
865  }
866  else
867    os << "; max-width:100em";
868
869  os << "\">";
870
871  if (!SuppressIndex) {
872    os << "<table class=\"msgT\"><tr><td valign=\"top\">";
873    os << "<div class=\"PathIndex";
874    if (Kind) os << " PathIndex" << Kind;
875    os << "\">" << num << "</div>";
876
877    if (num > 1) {
878      os << "</td><td><div class=\"PathNav\"><a href=\"#Path"
879         << (num - 1)
880         << "\" title=\"Previous event ("
881         << (num - 1)
882         << ")\">&#x2190;</a></div>";
883    }
884
885    os << "</td><td>";
886  }
887
888  if (const auto *MP = dyn_cast<PathDiagnosticMacroPiece>(&P)) {
889    os << "Within the expansion of the macro '";
890
891    // Get the name of the macro by relexing it.
892    {
893      FullSourceLoc L = MP->getLocation().asLocation().getExpansionLoc();
894      assert(L.isFileID());
895      StringRef BufferInfo = L.getBufferData();
896      std::pair<FileID, unsigned> LocInfo = L.getDecomposedLoc();
897      const char* MacroName = LocInfo.second + BufferInfo.data();
898      Lexer rawLexer(SM.getLocForStartOfFile(LocInfo.first), PP.getLangOpts(),
899                     BufferInfo.begin(), MacroName, BufferInfo.end());
900
901      Token TheTok;
902      rawLexer.LexFromRawLexer(TheTok);
903      for (unsigned i = 0, n = TheTok.getLength(); i < n; ++i)
904        os << MacroName[i];
905    }
906
907    os << "':\n";
908
909    if (!SuppressIndex) {
910      os << "</td>";
911      if (num < max) {
912        os << "<td><div class=\"PathNav\"><a href=\"#";
913        if (num == max - 1)
914          os << "EndPath";
915        else
916          os << "Path" << (num + 1);
917        os << "\" title=\"Next event ("
918        << (num + 1)
919        << ")\">&#x2192;</a></div></td>";
920      }
921
922      os << "</tr></table>";
923    }
924
925    // Within a macro piece.  Write out each event.
926    ProcessMacroPiece(os, *MP, 0);
927  }
928  else {
929    os << html::EscapeText(P.getString());
930
931    if (!SuppressIndex) {
932      os << "</td>";
933      if (num < max) {
934        os << "<td><div class=\"PathNav\"><a href=\"#";
935        if (num == max - 1)
936          os << "EndPath";
937        else
938          os << "Path" << (num + 1);
939        os << "\" title=\"Next event ("
940           << (num + 1)
941           << ")\">&#x2192;</a></div></td>";
942      }
943
944      os << "</tr></table>";
945    }
946  }
947
948  os << "</div></td></tr>";
949
950  // Insert the new html.
951  unsigned DisplayPos = LineEnd - FileStart;
952  SourceLocation Loc =
953    SM.getLocForStartOfFile(LPosInfo.first).getLocWithOffset(DisplayPos);
954
955  R.InsertTextBefore(Loc, os.str());
956
957  // Now highlight the ranges.
958  ArrayRef<SourceRange> Ranges = P.getRanges();
959  for (const auto &Range : Ranges) {
960    // If we have already highlighted the range as a pop-up there is no work.
961    if (std::find(PopUpRanges.begin(), PopUpRanges.end(), Range) !=
962        PopUpRanges.end())
963      continue;
964
965    HighlightRange(R, LPosInfo.first, Range);
966  }
967}
968
969static void EmitAlphaCounter(raw_ostream &os, unsigned n) {
970  unsigned x = n % ('z' - 'a');
971  n /= 'z' - 'a';
972
973  if (n > 0)
974    EmitAlphaCounter(os, n);
975
976  os << char('a' + x);
977}
978
979unsigned HTMLDiagnostics::ProcessMacroPiece(raw_ostream &os,
980                                            const PathDiagnosticMacroPiece& P,
981                                            unsigned num) {
982  for (const auto &subPiece : P.subPieces) {
983    if (const auto *MP = dyn_cast<PathDiagnosticMacroPiece>(subPiece.get())) {
984      num = ProcessMacroPiece(os, *MP, num);
985      continue;
986    }
987
988    if (const auto *EP = dyn_cast<PathDiagnosticEventPiece>(subPiece.get())) {
989      os << "<div class=\"msg msgEvent\" style=\"width:94%; "
990            "margin-left:5px\">"
991            "<table class=\"msgT\"><tr>"
992            "<td valign=\"top\"><div class=\"PathIndex PathIndexEvent\">";
993      EmitAlphaCounter(os, num++);
994      os << "</div></td><td valign=\"top\">"
995         << html::EscapeText(EP->getString())
996         << "</td></tr></table></div>\n";
997    }
998  }
999
1000  return num;
1001}
1002
1003void HTMLDiagnostics::HighlightRange(Rewriter& R, FileID BugFileID,
1004                                     SourceRange Range,
1005                                     const char *HighlightStart,
1006                                     const char *HighlightEnd) {
1007  SourceManager &SM = R.getSourceMgr();
1008  const LangOptions &LangOpts = R.getLangOpts();
1009
1010  SourceLocation InstantiationStart = SM.getExpansionLoc(Range.getBegin());
1011  unsigned StartLineNo = SM.getExpansionLineNumber(InstantiationStart);
1012
1013  SourceLocation InstantiationEnd = SM.getExpansionLoc(Range.getEnd());
1014  unsigned EndLineNo = SM.getExpansionLineNumber(InstantiationEnd);
1015
1016  if (EndLineNo < StartLineNo)
1017    return;
1018
1019  if (SM.getFileID(InstantiationStart) != BugFileID ||
1020      SM.getFileID(InstantiationEnd) != BugFileID)
1021    return;
1022
1023  // Compute the column number of the end.
1024  unsigned EndColNo = SM.getExpansionColumnNumber(InstantiationEnd);
1025  unsigned OldEndColNo = EndColNo;
1026
1027  if (EndColNo) {
1028    // Add in the length of the token, so that we cover multi-char tokens.
1029    EndColNo += Lexer::MeasureTokenLength(Range.getEnd(), SM, LangOpts)-1;
1030  }
1031
1032  // Highlight the range.  Make the span tag the outermost tag for the
1033  // selected range.
1034
1035  SourceLocation E =
1036    InstantiationEnd.getLocWithOffset(EndColNo - OldEndColNo);
1037
1038  html::HighlightRange(R, InstantiationStart, E, HighlightStart, HighlightEnd);
1039}
1040
1041StringRef HTMLDiagnostics::generateKeyboardNavigationJavascript() {
1042  return R"<<<(
1043<script type='text/javascript'>
1044var digitMatcher = new RegExp("[0-9]+");
1045
1046document.addEventListener("DOMContentLoaded", function() {
1047    document.querySelectorAll(".PathNav > a").forEach(
1048        function(currentValue, currentIndex) {
1049            var hrefValue = currentValue.getAttribute("href");
1050            currentValue.onclick = function() {
1051                scrollTo(document.querySelector(hrefValue));
1052                return false;
1053            };
1054        });
1055});
1056
1057var findNum = function() {
1058    var s = document.querySelector(".selected");
1059    if (!s || s.id == "EndPath") {
1060        return 0;
1061    }
1062    var out = parseInt(digitMatcher.exec(s.id)[0]);
1063    return out;
1064};
1065
1066var scrollTo = function(el) {
1067    document.querySelectorAll(".selected").forEach(function(s) {
1068        s.classList.remove("selected");
1069    });
1070    el.classList.add("selected");
1071    window.scrollBy(0, el.getBoundingClientRect().top -
1072        (window.innerHeight / 2));
1073}
1074
1075var move = function(num, up, numItems) {
1076  if (num == 1 && up || num == numItems - 1 && !up) {
1077    return 0;
1078  } else if (num == 0 && up) {
1079    return numItems - 1;
1080  } else if (num == 0 && !up) {
1081    return 1 % numItems;
1082  }
1083  return up ? num - 1 : num + 1;
1084}
1085
1086var numToId = function(num) {
1087  if (num == 0) {
1088    return document.getElementById("EndPath")
1089  }
1090  return document.getElementById("Path" + num);
1091};
1092
1093var navigateTo = function(up) {
1094  var numItems = document.querySelectorAll(
1095      ".line > .msgEvent, .line > .msgControl").length;
1096  var currentSelected = findNum();
1097  var newSelected = move(currentSelected, up, numItems);
1098  var newEl = numToId(newSelected, numItems);
1099
1100  // Scroll element into center.
1101  scrollTo(newEl);
1102};
1103
1104window.addEventListener("keydown", function (event) {
1105  if (event.defaultPrevented) {
1106    return;
1107  }
1108  if (event.key == "j") {
1109    navigateTo(/*up=*/false);
1110  } else if (event.key == "k") {
1111    navigateTo(/*up=*/true);
1112  } else {
1113    return;
1114  }
1115  event.preventDefault();
1116}, true);
1117</script>
1118  )<<<";
1119}
1120