106f32e7eSjoerg //===- HTMLDiagnostics.cpp - HTML Diagnostics for Paths -------------------===//
206f32e7eSjoerg //
306f32e7eSjoerg // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
406f32e7eSjoerg // See https://llvm.org/LICENSE.txt for license information.
506f32e7eSjoerg // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
606f32e7eSjoerg //
706f32e7eSjoerg //===----------------------------------------------------------------------===//
806f32e7eSjoerg //
906f32e7eSjoerg // This file defines the HTMLDiagnostics object.
1006f32e7eSjoerg //
1106f32e7eSjoerg //===----------------------------------------------------------------------===//
1206f32e7eSjoerg
1306f32e7eSjoerg #include "clang/AST/Decl.h"
1406f32e7eSjoerg #include "clang/AST/DeclBase.h"
1506f32e7eSjoerg #include "clang/AST/Stmt.h"
16*13fbcb42Sjoerg #include "clang/Analysis/IssueHash.h"
17*13fbcb42Sjoerg #include "clang/Analysis/MacroExpansionContext.h"
18*13fbcb42Sjoerg #include "clang/Analysis/PathDiagnostic.h"
1906f32e7eSjoerg #include "clang/Basic/FileManager.h"
2006f32e7eSjoerg #include "clang/Basic/LLVM.h"
2106f32e7eSjoerg #include "clang/Basic/SourceLocation.h"
2206f32e7eSjoerg #include "clang/Basic/SourceManager.h"
2306f32e7eSjoerg #include "clang/Lex/Lexer.h"
2406f32e7eSjoerg #include "clang/Lex/Preprocessor.h"
2506f32e7eSjoerg #include "clang/Lex/Token.h"
2606f32e7eSjoerg #include "clang/Rewrite/Core/HTMLRewrite.h"
2706f32e7eSjoerg #include "clang/Rewrite/Core/Rewriter.h"
2806f32e7eSjoerg #include "clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h"
2906f32e7eSjoerg #include "llvm/ADT/ArrayRef.h"
3006f32e7eSjoerg #include "llvm/ADT/SmallString.h"
3106f32e7eSjoerg #include "llvm/ADT/StringRef.h"
3206f32e7eSjoerg #include "llvm/ADT/iterator_range.h"
3306f32e7eSjoerg #include "llvm/Support/Casting.h"
3406f32e7eSjoerg #include "llvm/Support/Errc.h"
3506f32e7eSjoerg #include "llvm/Support/ErrorHandling.h"
3606f32e7eSjoerg #include "llvm/Support/FileSystem.h"
3706f32e7eSjoerg #include "llvm/Support/MemoryBuffer.h"
3806f32e7eSjoerg #include "llvm/Support/Path.h"
3906f32e7eSjoerg #include "llvm/Support/raw_ostream.h"
4006f32e7eSjoerg #include <algorithm>
4106f32e7eSjoerg #include <cassert>
4206f32e7eSjoerg #include <map>
4306f32e7eSjoerg #include <memory>
4406f32e7eSjoerg #include <set>
4506f32e7eSjoerg #include <sstream>
4606f32e7eSjoerg #include <string>
4706f32e7eSjoerg #include <system_error>
4806f32e7eSjoerg #include <utility>
4906f32e7eSjoerg #include <vector>
5006f32e7eSjoerg
5106f32e7eSjoerg using namespace clang;
5206f32e7eSjoerg using namespace ento;
5306f32e7eSjoerg
5406f32e7eSjoerg //===----------------------------------------------------------------------===//
5506f32e7eSjoerg // Boilerplate.
5606f32e7eSjoerg //===----------------------------------------------------------------------===//
5706f32e7eSjoerg
5806f32e7eSjoerg namespace {
5906f32e7eSjoerg
6006f32e7eSjoerg class HTMLDiagnostics : public PathDiagnosticConsumer {
61*13fbcb42Sjoerg PathDiagnosticConsumerOptions DiagOpts;
6206f32e7eSjoerg std::string Directory;
6306f32e7eSjoerg bool createdDir = false;
6406f32e7eSjoerg bool noDir = false;
6506f32e7eSjoerg const Preprocessor &PP;
6606f32e7eSjoerg const bool SupportsCrossFileDiagnostics;
6706f32e7eSjoerg
6806f32e7eSjoerg public:
HTMLDiagnostics(PathDiagnosticConsumerOptions DiagOpts,const std::string & OutputDir,const Preprocessor & pp,bool supportsMultipleFiles)69*13fbcb42Sjoerg HTMLDiagnostics(PathDiagnosticConsumerOptions DiagOpts,
70*13fbcb42Sjoerg const std::string &OutputDir, const Preprocessor &pp,
7106f32e7eSjoerg bool supportsMultipleFiles)
72*13fbcb42Sjoerg : DiagOpts(std::move(DiagOpts)), Directory(OutputDir), PP(pp),
7306f32e7eSjoerg SupportsCrossFileDiagnostics(supportsMultipleFiles) {}
7406f32e7eSjoerg
~HTMLDiagnostics()7506f32e7eSjoerg ~HTMLDiagnostics() override { FlushDiagnostics(nullptr); }
7606f32e7eSjoerg
7706f32e7eSjoerg void FlushDiagnosticsImpl(std::vector<const PathDiagnostic *> &Diags,
7806f32e7eSjoerg FilesMade *filesMade) override;
7906f32e7eSjoerg
getName() const8006f32e7eSjoerg StringRef getName() const override {
8106f32e7eSjoerg return "HTMLDiagnostics";
8206f32e7eSjoerg }
8306f32e7eSjoerg
supportsCrossFileDiagnostics() const8406f32e7eSjoerg bool supportsCrossFileDiagnostics() const override {
8506f32e7eSjoerg return SupportsCrossFileDiagnostics;
8606f32e7eSjoerg }
8706f32e7eSjoerg
8806f32e7eSjoerg unsigned ProcessMacroPiece(raw_ostream &os,
8906f32e7eSjoerg const PathDiagnosticMacroPiece& P,
9006f32e7eSjoerg unsigned num);
9106f32e7eSjoerg
9206f32e7eSjoerg void HandlePiece(Rewriter &R, FileID BugFileID, const PathDiagnosticPiece &P,
9306f32e7eSjoerg const std::vector<SourceRange> &PopUpRanges, unsigned num,
9406f32e7eSjoerg unsigned max);
9506f32e7eSjoerg
9606f32e7eSjoerg void HighlightRange(Rewriter& R, FileID BugFileID, SourceRange Range,
9706f32e7eSjoerg const char *HighlightStart = "<span class=\"mrange\">",
9806f32e7eSjoerg const char *HighlightEnd = "</span>");
9906f32e7eSjoerg
10006f32e7eSjoerg void ReportDiag(const PathDiagnostic& D,
10106f32e7eSjoerg FilesMade *filesMade);
10206f32e7eSjoerg
10306f32e7eSjoerg // Generate the full HTML report
10406f32e7eSjoerg std::string GenerateHTML(const PathDiagnostic& D, Rewriter &R,
10506f32e7eSjoerg const SourceManager& SMgr, const PathPieces& path,
10606f32e7eSjoerg const char *declName);
10706f32e7eSjoerg
10806f32e7eSjoerg // Add HTML header/footers to file specified by FID
10906f32e7eSjoerg void FinalizeHTML(const PathDiagnostic& D, Rewriter &R,
11006f32e7eSjoerg const SourceManager& SMgr, const PathPieces& path,
11106f32e7eSjoerg FileID FID, const FileEntry *Entry, const char *declName);
11206f32e7eSjoerg
11306f32e7eSjoerg // Rewrite the file specified by FID with HTML formatting.
11406f32e7eSjoerg void RewriteFile(Rewriter &R, const PathPieces& path, FileID FID);
11506f32e7eSjoerg
11606f32e7eSjoerg
11706f32e7eSjoerg private:
11806f32e7eSjoerg /// \return Javascript for displaying shortcuts help;
11906f32e7eSjoerg StringRef showHelpJavascript();
12006f32e7eSjoerg
12106f32e7eSjoerg /// \return Javascript for navigating the HTML report using j/k keys.
12206f32e7eSjoerg StringRef generateKeyboardNavigationJavascript();
12306f32e7eSjoerg
12406f32e7eSjoerg /// \return JavaScript for an option to only show relevant lines.
12506f32e7eSjoerg std::string showRelevantLinesJavascript(
12606f32e7eSjoerg const PathDiagnostic &D, const PathPieces &path);
12706f32e7eSjoerg
12806f32e7eSjoerg /// Write executed lines from \p D in JSON format into \p os.
12906f32e7eSjoerg void dumpCoverageData(const PathDiagnostic &D,
13006f32e7eSjoerg const PathPieces &path,
13106f32e7eSjoerg llvm::raw_string_ostream &os);
13206f32e7eSjoerg };
13306f32e7eSjoerg
13406f32e7eSjoerg } // namespace
13506f32e7eSjoerg
createHTMLDiagnosticConsumer(PathDiagnosticConsumerOptions DiagOpts,PathDiagnosticConsumers & C,const std::string & OutputDir,const Preprocessor & PP,const cross_tu::CrossTranslationUnitContext & CTU,const MacroExpansionContext & MacroExpansions)13606f32e7eSjoerg void ento::createHTMLDiagnosticConsumer(
137*13fbcb42Sjoerg PathDiagnosticConsumerOptions DiagOpts, PathDiagnosticConsumers &C,
138*13fbcb42Sjoerg const std::string &OutputDir, const Preprocessor &PP,
139*13fbcb42Sjoerg const cross_tu::CrossTranslationUnitContext &CTU,
140*13fbcb42Sjoerg const MacroExpansionContext &MacroExpansions) {
141*13fbcb42Sjoerg
142*13fbcb42Sjoerg // FIXME: HTML is currently our default output type, but if the output
143*13fbcb42Sjoerg // directory isn't specified, it acts like if it was in the minimal text
144*13fbcb42Sjoerg // output mode. This doesn't make much sense, we should have the minimal text
145*13fbcb42Sjoerg // as our default. In the case of backward compatibility concerns, this could
146*13fbcb42Sjoerg // be preserved with -analyzer-config-compatibility-mode=true.
147*13fbcb42Sjoerg createTextMinimalPathDiagnosticConsumer(DiagOpts, C, OutputDir, PP, CTU,
148*13fbcb42Sjoerg MacroExpansions);
149*13fbcb42Sjoerg
150*13fbcb42Sjoerg // TODO: Emit an error here.
151*13fbcb42Sjoerg if (OutputDir.empty())
152*13fbcb42Sjoerg return;
153*13fbcb42Sjoerg
154*13fbcb42Sjoerg C.push_back(new HTMLDiagnostics(std::move(DiagOpts), OutputDir, PP, true));
15506f32e7eSjoerg }
15606f32e7eSjoerg
createHTMLSingleFileDiagnosticConsumer(PathDiagnosticConsumerOptions DiagOpts,PathDiagnosticConsumers & C,const std::string & OutputDir,const Preprocessor & PP,const cross_tu::CrossTranslationUnitContext & CTU,const clang::MacroExpansionContext & MacroExpansions)15706f32e7eSjoerg void ento::createHTMLSingleFileDiagnosticConsumer(
158*13fbcb42Sjoerg PathDiagnosticConsumerOptions DiagOpts, PathDiagnosticConsumers &C,
159*13fbcb42Sjoerg const std::string &OutputDir, const Preprocessor &PP,
160*13fbcb42Sjoerg const cross_tu::CrossTranslationUnitContext &CTU,
161*13fbcb42Sjoerg const clang::MacroExpansionContext &MacroExpansions) {
162*13fbcb42Sjoerg createTextMinimalPathDiagnosticConsumer(DiagOpts, C, OutputDir, PP, CTU,
163*13fbcb42Sjoerg MacroExpansions);
164*13fbcb42Sjoerg
165*13fbcb42Sjoerg // TODO: Emit an error here.
166*13fbcb42Sjoerg if (OutputDir.empty())
167*13fbcb42Sjoerg return;
168*13fbcb42Sjoerg
169*13fbcb42Sjoerg C.push_back(new HTMLDiagnostics(std::move(DiagOpts), OutputDir, PP, false));
170*13fbcb42Sjoerg }
171*13fbcb42Sjoerg
createPlistHTMLDiagnosticConsumer(PathDiagnosticConsumerOptions DiagOpts,PathDiagnosticConsumers & C,const std::string & prefix,const Preprocessor & PP,const cross_tu::CrossTranslationUnitContext & CTU,const MacroExpansionContext & MacroExpansions)172*13fbcb42Sjoerg void ento::createPlistHTMLDiagnosticConsumer(
173*13fbcb42Sjoerg PathDiagnosticConsumerOptions DiagOpts, PathDiagnosticConsumers &C,
17406f32e7eSjoerg const std::string &prefix, const Preprocessor &PP,
175*13fbcb42Sjoerg const cross_tu::CrossTranslationUnitContext &CTU,
176*13fbcb42Sjoerg const MacroExpansionContext &MacroExpansions) {
177*13fbcb42Sjoerg createHTMLDiagnosticConsumer(
178*13fbcb42Sjoerg DiagOpts, C, std::string(llvm::sys::path::parent_path(prefix)), PP, CTU,
179*13fbcb42Sjoerg MacroExpansions);
180*13fbcb42Sjoerg createPlistMultiFileDiagnosticConsumer(DiagOpts, C, prefix, PP, CTU,
181*13fbcb42Sjoerg MacroExpansions);
182*13fbcb42Sjoerg createTextMinimalPathDiagnosticConsumer(std::move(DiagOpts), C, prefix, PP,
183*13fbcb42Sjoerg CTU, MacroExpansions);
184*13fbcb42Sjoerg }
185*13fbcb42Sjoerg
createSarifHTMLDiagnosticConsumer(PathDiagnosticConsumerOptions DiagOpts,PathDiagnosticConsumers & C,const std::string & sarif_file,const Preprocessor & PP,const cross_tu::CrossTranslationUnitContext & CTU,const MacroExpansionContext & MacroExpansions)186*13fbcb42Sjoerg void ento::createSarifHTMLDiagnosticConsumer(
187*13fbcb42Sjoerg PathDiagnosticConsumerOptions DiagOpts, PathDiagnosticConsumers &C,
188*13fbcb42Sjoerg const std::string &sarif_file, const Preprocessor &PP,
189*13fbcb42Sjoerg const cross_tu::CrossTranslationUnitContext &CTU,
190*13fbcb42Sjoerg const MacroExpansionContext &MacroExpansions) {
191*13fbcb42Sjoerg createHTMLDiagnosticConsumer(
192*13fbcb42Sjoerg DiagOpts, C, std::string(llvm::sys::path::parent_path(sarif_file)), PP,
193*13fbcb42Sjoerg CTU, MacroExpansions);
194*13fbcb42Sjoerg createSarifDiagnosticConsumer(DiagOpts, C, sarif_file, PP, CTU,
195*13fbcb42Sjoerg MacroExpansions);
196*13fbcb42Sjoerg createTextMinimalPathDiagnosticConsumer(std::move(DiagOpts), C, sarif_file,
197*13fbcb42Sjoerg PP, CTU, MacroExpansions);
19806f32e7eSjoerg }
19906f32e7eSjoerg
20006f32e7eSjoerg //===----------------------------------------------------------------------===//
20106f32e7eSjoerg // Report processing.
20206f32e7eSjoerg //===----------------------------------------------------------------------===//
20306f32e7eSjoerg
FlushDiagnosticsImpl(std::vector<const PathDiagnostic * > & Diags,FilesMade * filesMade)20406f32e7eSjoerg void HTMLDiagnostics::FlushDiagnosticsImpl(
20506f32e7eSjoerg std::vector<const PathDiagnostic *> &Diags,
20606f32e7eSjoerg FilesMade *filesMade) {
20706f32e7eSjoerg for (const auto Diag : Diags)
20806f32e7eSjoerg ReportDiag(*Diag, filesMade);
20906f32e7eSjoerg }
21006f32e7eSjoerg
ReportDiag(const PathDiagnostic & D,FilesMade * filesMade)21106f32e7eSjoerg void HTMLDiagnostics::ReportDiag(const PathDiagnostic& D,
21206f32e7eSjoerg FilesMade *filesMade) {
21306f32e7eSjoerg // Create the HTML directory if it is missing.
21406f32e7eSjoerg if (!createdDir) {
21506f32e7eSjoerg createdDir = true;
21606f32e7eSjoerg if (std::error_code ec = llvm::sys::fs::create_directories(Directory)) {
21706f32e7eSjoerg llvm::errs() << "warning: could not create directory '"
21806f32e7eSjoerg << Directory << "': " << ec.message() << '\n';
21906f32e7eSjoerg noDir = true;
22006f32e7eSjoerg return;
22106f32e7eSjoerg }
22206f32e7eSjoerg }
22306f32e7eSjoerg
22406f32e7eSjoerg if (noDir)
22506f32e7eSjoerg return;
22606f32e7eSjoerg
22706f32e7eSjoerg // First flatten out the entire path to make it easier to use.
22806f32e7eSjoerg PathPieces path = D.path.flatten(/*ShouldFlattenMacros=*/false);
22906f32e7eSjoerg
23006f32e7eSjoerg // The path as already been prechecked that the path is non-empty.
23106f32e7eSjoerg assert(!path.empty());
23206f32e7eSjoerg const SourceManager &SMgr = path.front()->getLocation().getManager();
23306f32e7eSjoerg
23406f32e7eSjoerg // Create a new rewriter to generate HTML.
23506f32e7eSjoerg Rewriter R(const_cast<SourceManager&>(SMgr), PP.getLangOpts());
23606f32e7eSjoerg
23706f32e7eSjoerg // The file for the first path element is considered the main report file, it
23806f32e7eSjoerg // will usually be equivalent to SMgr.getMainFileID(); however, it might be a
23906f32e7eSjoerg // header when -analyzer-opt-analyze-headers is used.
24006f32e7eSjoerg FileID ReportFile = path.front()->getLocation().asLocation().getExpansionLoc().getFileID();
24106f32e7eSjoerg
24206f32e7eSjoerg // Get the function/method name
24306f32e7eSjoerg SmallString<128> declName("unknown");
24406f32e7eSjoerg int offsetDecl = 0;
24506f32e7eSjoerg if (const Decl *DeclWithIssue = D.getDeclWithIssue()) {
24606f32e7eSjoerg if (const auto *ND = dyn_cast<NamedDecl>(DeclWithIssue))
24706f32e7eSjoerg declName = ND->getDeclName().getAsString();
24806f32e7eSjoerg
24906f32e7eSjoerg if (const Stmt *Body = DeclWithIssue->getBody()) {
25006f32e7eSjoerg // Retrieve the relative position of the declaration which will be used
25106f32e7eSjoerg // for the file name
25206f32e7eSjoerg FullSourceLoc L(
25306f32e7eSjoerg SMgr.getExpansionLoc(path.back()->getLocation().asLocation()),
25406f32e7eSjoerg SMgr);
25506f32e7eSjoerg FullSourceLoc FunL(SMgr.getExpansionLoc(Body->getBeginLoc()), SMgr);
25606f32e7eSjoerg offsetDecl = L.getExpansionLineNumber() - FunL.getExpansionLineNumber();
25706f32e7eSjoerg }
25806f32e7eSjoerg }
25906f32e7eSjoerg
26006f32e7eSjoerg std::string report = GenerateHTML(D, R, SMgr, path, declName.c_str());
26106f32e7eSjoerg if (report.empty()) {
26206f32e7eSjoerg llvm::errs() << "warning: no diagnostics generated for main file.\n";
26306f32e7eSjoerg return;
26406f32e7eSjoerg }
26506f32e7eSjoerg
26606f32e7eSjoerg // Create a path for the target HTML file.
26706f32e7eSjoerg int FD;
26806f32e7eSjoerg SmallString<128> Model, ResultPath;
26906f32e7eSjoerg
270*13fbcb42Sjoerg if (!DiagOpts.ShouldWriteStableReportFilename) {
27106f32e7eSjoerg llvm::sys::path::append(Model, Directory, "report-%%%%%%.html");
27206f32e7eSjoerg if (std::error_code EC =
27306f32e7eSjoerg llvm::sys::fs::make_absolute(Model)) {
27406f32e7eSjoerg llvm::errs() << "warning: could not make '" << Model
27506f32e7eSjoerg << "' absolute: " << EC.message() << '\n';
27606f32e7eSjoerg return;
27706f32e7eSjoerg }
278*13fbcb42Sjoerg if (std::error_code EC = llvm::sys::fs::createUniqueFile(
279*13fbcb42Sjoerg Model, FD, ResultPath, llvm::sys::fs::OF_Text)) {
28006f32e7eSjoerg llvm::errs() << "warning: could not create file in '" << Directory
28106f32e7eSjoerg << "': " << EC.message() << '\n';
28206f32e7eSjoerg return;
28306f32e7eSjoerg }
28406f32e7eSjoerg } else {
28506f32e7eSjoerg int i = 1;
28606f32e7eSjoerg std::error_code EC;
28706f32e7eSjoerg do {
28806f32e7eSjoerg // Find a filename which is not already used
28906f32e7eSjoerg const FileEntry* Entry = SMgr.getFileEntryForID(ReportFile);
29006f32e7eSjoerg std::stringstream filename;
29106f32e7eSjoerg Model = "";
29206f32e7eSjoerg filename << "report-"
29306f32e7eSjoerg << llvm::sys::path::filename(Entry->getName()).str()
29406f32e7eSjoerg << "-" << declName.c_str()
29506f32e7eSjoerg << "-" << offsetDecl
29606f32e7eSjoerg << "-" << i << ".html";
29706f32e7eSjoerg llvm::sys::path::append(Model, Directory,
29806f32e7eSjoerg filename.str());
29906f32e7eSjoerg EC = llvm::sys::fs::openFileForReadWrite(
30006f32e7eSjoerg Model, FD, llvm::sys::fs::CD_CreateNew, llvm::sys::fs::OF_None);
30106f32e7eSjoerg if (EC && EC != llvm::errc::file_exists) {
30206f32e7eSjoerg llvm::errs() << "warning: could not create file '" << Model
30306f32e7eSjoerg << "': " << EC.message() << '\n';
30406f32e7eSjoerg return;
30506f32e7eSjoerg }
30606f32e7eSjoerg i++;
30706f32e7eSjoerg } while (EC);
30806f32e7eSjoerg }
30906f32e7eSjoerg
31006f32e7eSjoerg llvm::raw_fd_ostream os(FD, true);
31106f32e7eSjoerg
31206f32e7eSjoerg if (filesMade)
31306f32e7eSjoerg filesMade->addDiagnostic(D, getName(),
31406f32e7eSjoerg llvm::sys::path::filename(ResultPath));
31506f32e7eSjoerg
31606f32e7eSjoerg // Emit the HTML to disk.
31706f32e7eSjoerg os << report;
31806f32e7eSjoerg }
31906f32e7eSjoerg
GenerateHTML(const PathDiagnostic & D,Rewriter & R,const SourceManager & SMgr,const PathPieces & path,const char * declName)32006f32e7eSjoerg std::string HTMLDiagnostics::GenerateHTML(const PathDiagnostic& D, Rewriter &R,
32106f32e7eSjoerg const SourceManager& SMgr, const PathPieces& path, const char *declName) {
32206f32e7eSjoerg // Rewrite source files as HTML for every new file the path crosses
32306f32e7eSjoerg std::vector<FileID> FileIDs;
32406f32e7eSjoerg for (auto I : path) {
32506f32e7eSjoerg FileID FID = I->getLocation().asLocation().getExpansionLoc().getFileID();
32606f32e7eSjoerg if (llvm::is_contained(FileIDs, FID))
32706f32e7eSjoerg continue;
32806f32e7eSjoerg
32906f32e7eSjoerg FileIDs.push_back(FID);
33006f32e7eSjoerg RewriteFile(R, path, FID);
33106f32e7eSjoerg }
33206f32e7eSjoerg
33306f32e7eSjoerg if (SupportsCrossFileDiagnostics && FileIDs.size() > 1) {
33406f32e7eSjoerg // Prefix file names, anchor tags, and nav cursors to every file
33506f32e7eSjoerg for (auto I = FileIDs.begin(), E = FileIDs.end(); I != E; I++) {
33606f32e7eSjoerg std::string s;
33706f32e7eSjoerg llvm::raw_string_ostream os(s);
33806f32e7eSjoerg
33906f32e7eSjoerg if (I != FileIDs.begin())
34006f32e7eSjoerg os << "<hr class=divider>\n";
34106f32e7eSjoerg
34206f32e7eSjoerg os << "<div id=File" << I->getHashValue() << ">\n";
34306f32e7eSjoerg
34406f32e7eSjoerg // Left nav arrow
34506f32e7eSjoerg if (I != FileIDs.begin())
34606f32e7eSjoerg os << "<div class=FileNav><a href=\"#File" << (I - 1)->getHashValue()
34706f32e7eSjoerg << "\">←</a></div>";
34806f32e7eSjoerg
34906f32e7eSjoerg os << "<h4 class=FileName>" << SMgr.getFileEntryForID(*I)->getName()
35006f32e7eSjoerg << "</h4>\n";
35106f32e7eSjoerg
35206f32e7eSjoerg // Right nav arrow
35306f32e7eSjoerg if (I + 1 != E)
35406f32e7eSjoerg os << "<div class=FileNav><a href=\"#File" << (I + 1)->getHashValue()
35506f32e7eSjoerg << "\">→</a></div>";
35606f32e7eSjoerg
35706f32e7eSjoerg os << "</div>\n";
35806f32e7eSjoerg
35906f32e7eSjoerg R.InsertTextBefore(SMgr.getLocForStartOfFile(*I), os.str());
36006f32e7eSjoerg }
36106f32e7eSjoerg
36206f32e7eSjoerg // Append files to the main report file in the order they appear in the path
36306f32e7eSjoerg for (auto I : llvm::make_range(FileIDs.begin() + 1, FileIDs.end())) {
36406f32e7eSjoerg std::string s;
36506f32e7eSjoerg llvm::raw_string_ostream os(s);
36606f32e7eSjoerg
36706f32e7eSjoerg const RewriteBuffer *Buf = R.getRewriteBufferFor(I);
36806f32e7eSjoerg for (auto BI : *Buf)
36906f32e7eSjoerg os << BI;
37006f32e7eSjoerg
37106f32e7eSjoerg R.InsertTextAfter(SMgr.getLocForEndOfFile(FileIDs[0]), os.str());
37206f32e7eSjoerg }
37306f32e7eSjoerg }
37406f32e7eSjoerg
37506f32e7eSjoerg const RewriteBuffer *Buf = R.getRewriteBufferFor(FileIDs[0]);
37606f32e7eSjoerg if (!Buf)
37706f32e7eSjoerg return {};
37806f32e7eSjoerg
37906f32e7eSjoerg // Add CSS, header, and footer.
38006f32e7eSjoerg FileID FID =
38106f32e7eSjoerg path.back()->getLocation().asLocation().getExpansionLoc().getFileID();
38206f32e7eSjoerg const FileEntry* Entry = SMgr.getFileEntryForID(FID);
38306f32e7eSjoerg FinalizeHTML(D, R, SMgr, path, FileIDs[0], Entry, declName);
38406f32e7eSjoerg
38506f32e7eSjoerg std::string file;
38606f32e7eSjoerg llvm::raw_string_ostream os(file);
38706f32e7eSjoerg for (auto BI : *Buf)
38806f32e7eSjoerg os << BI;
38906f32e7eSjoerg
39006f32e7eSjoerg return os.str();
39106f32e7eSjoerg }
39206f32e7eSjoerg
dumpCoverageData(const PathDiagnostic & D,const PathPieces & path,llvm::raw_string_ostream & os)39306f32e7eSjoerg void HTMLDiagnostics::dumpCoverageData(
39406f32e7eSjoerg const PathDiagnostic &D,
39506f32e7eSjoerg const PathPieces &path,
39606f32e7eSjoerg llvm::raw_string_ostream &os) {
39706f32e7eSjoerg
39806f32e7eSjoerg const FilesToLineNumsMap &ExecutedLines = D.getExecutedLines();
39906f32e7eSjoerg
40006f32e7eSjoerg os << "var relevant_lines = {";
40106f32e7eSjoerg for (auto I = ExecutedLines.begin(),
40206f32e7eSjoerg E = ExecutedLines.end(); I != E; ++I) {
40306f32e7eSjoerg if (I != ExecutedLines.begin())
40406f32e7eSjoerg os << ", ";
40506f32e7eSjoerg
40606f32e7eSjoerg os << "\"" << I->first.getHashValue() << "\": {";
40706f32e7eSjoerg for (unsigned LineNo : I->second) {
40806f32e7eSjoerg if (LineNo != *(I->second.begin()))
40906f32e7eSjoerg os << ", ";
41006f32e7eSjoerg
41106f32e7eSjoerg os << "\"" << LineNo << "\": 1";
41206f32e7eSjoerg }
41306f32e7eSjoerg os << "}";
41406f32e7eSjoerg }
41506f32e7eSjoerg
41606f32e7eSjoerg os << "};";
41706f32e7eSjoerg }
41806f32e7eSjoerg
showRelevantLinesJavascript(const PathDiagnostic & D,const PathPieces & path)41906f32e7eSjoerg std::string HTMLDiagnostics::showRelevantLinesJavascript(
42006f32e7eSjoerg const PathDiagnostic &D, const PathPieces &path) {
42106f32e7eSjoerg std::string s;
42206f32e7eSjoerg llvm::raw_string_ostream os(s);
42306f32e7eSjoerg os << "<script type='text/javascript'>\n";
42406f32e7eSjoerg dumpCoverageData(D, path, os);
42506f32e7eSjoerg os << R"<<<(
42606f32e7eSjoerg
42706f32e7eSjoerg var filterCounterexample = function (hide) {
42806f32e7eSjoerg var tables = document.getElementsByClassName("code");
42906f32e7eSjoerg for (var t=0; t<tables.length; t++) {
43006f32e7eSjoerg var table = tables[t];
43106f32e7eSjoerg var file_id = table.getAttribute("data-fileid");
43206f32e7eSjoerg var lines_in_fid = relevant_lines[file_id];
43306f32e7eSjoerg if (!lines_in_fid) {
43406f32e7eSjoerg lines_in_fid = {};
43506f32e7eSjoerg }
43606f32e7eSjoerg var lines = table.getElementsByClassName("codeline");
43706f32e7eSjoerg for (var i=0; i<lines.length; i++) {
43806f32e7eSjoerg var el = lines[i];
43906f32e7eSjoerg var lineNo = el.getAttribute("data-linenumber");
44006f32e7eSjoerg if (!lines_in_fid[lineNo]) {
44106f32e7eSjoerg if (hide) {
44206f32e7eSjoerg el.setAttribute("hidden", "");
44306f32e7eSjoerg } else {
44406f32e7eSjoerg el.removeAttribute("hidden");
44506f32e7eSjoerg }
44606f32e7eSjoerg }
44706f32e7eSjoerg }
44806f32e7eSjoerg }
44906f32e7eSjoerg }
45006f32e7eSjoerg
45106f32e7eSjoerg window.addEventListener("keydown", function (event) {
45206f32e7eSjoerg if (event.defaultPrevented) {
45306f32e7eSjoerg return;
45406f32e7eSjoerg }
45506f32e7eSjoerg if (event.key == "S") {
45606f32e7eSjoerg var checked = document.getElementsByName("showCounterexample")[0].checked;
45706f32e7eSjoerg filterCounterexample(!checked);
45806f32e7eSjoerg document.getElementsByName("showCounterexample")[0].checked = !checked;
45906f32e7eSjoerg } else {
46006f32e7eSjoerg return;
46106f32e7eSjoerg }
46206f32e7eSjoerg event.preventDefault();
46306f32e7eSjoerg }, true);
46406f32e7eSjoerg
46506f32e7eSjoerg document.addEventListener("DOMContentLoaded", function() {
46606f32e7eSjoerg document.querySelector('input[name="showCounterexample"]').onchange=
46706f32e7eSjoerg function (event) {
46806f32e7eSjoerg filterCounterexample(this.checked);
46906f32e7eSjoerg };
47006f32e7eSjoerg });
47106f32e7eSjoerg </script>
47206f32e7eSjoerg
47306f32e7eSjoerg <form>
47406f32e7eSjoerg <input type="checkbox" name="showCounterexample" id="showCounterexample" />
47506f32e7eSjoerg <label for="showCounterexample">
47606f32e7eSjoerg Show only relevant lines
47706f32e7eSjoerg </label>
47806f32e7eSjoerg </form>
47906f32e7eSjoerg )<<<";
48006f32e7eSjoerg
48106f32e7eSjoerg return os.str();
48206f32e7eSjoerg }
48306f32e7eSjoerg
FinalizeHTML(const PathDiagnostic & D,Rewriter & R,const SourceManager & SMgr,const PathPieces & path,FileID FID,const FileEntry * Entry,const char * declName)48406f32e7eSjoerg void HTMLDiagnostics::FinalizeHTML(const PathDiagnostic& D, Rewriter &R,
48506f32e7eSjoerg const SourceManager& SMgr, const PathPieces& path, FileID FID,
48606f32e7eSjoerg const FileEntry *Entry, const char *declName) {
48706f32e7eSjoerg // This is a cludge; basically we want to append either the full
48806f32e7eSjoerg // working directory if we have no directory information. This is
48906f32e7eSjoerg // a work in progress.
49006f32e7eSjoerg
49106f32e7eSjoerg llvm::SmallString<0> DirName;
49206f32e7eSjoerg
49306f32e7eSjoerg if (llvm::sys::path::is_relative(Entry->getName())) {
49406f32e7eSjoerg llvm::sys::fs::current_path(DirName);
49506f32e7eSjoerg DirName += '/';
49606f32e7eSjoerg }
49706f32e7eSjoerg
49806f32e7eSjoerg int LineNumber = path.back()->getLocation().asLocation().getExpansionLineNumber();
49906f32e7eSjoerg int ColumnNumber = path.back()->getLocation().asLocation().getExpansionColumnNumber();
50006f32e7eSjoerg
50106f32e7eSjoerg R.InsertTextBefore(SMgr.getLocForStartOfFile(FID), showHelpJavascript());
50206f32e7eSjoerg
50306f32e7eSjoerg R.InsertTextBefore(SMgr.getLocForStartOfFile(FID),
50406f32e7eSjoerg generateKeyboardNavigationJavascript());
50506f32e7eSjoerg
50606f32e7eSjoerg // Checkbox and javascript for filtering the output to the counterexample.
50706f32e7eSjoerg R.InsertTextBefore(SMgr.getLocForStartOfFile(FID),
50806f32e7eSjoerg showRelevantLinesJavascript(D, path));
50906f32e7eSjoerg
51006f32e7eSjoerg // Add the name of the file as an <h1> tag.
51106f32e7eSjoerg {
51206f32e7eSjoerg std::string s;
51306f32e7eSjoerg llvm::raw_string_ostream os(s);
51406f32e7eSjoerg
51506f32e7eSjoerg os << "<!-- REPORTHEADER -->\n"
51606f32e7eSjoerg << "<h3>Bug Summary</h3>\n<table class=\"simpletable\">\n"
51706f32e7eSjoerg "<tr><td class=\"rowname\">File:</td><td>"
51806f32e7eSjoerg << html::EscapeText(DirName)
51906f32e7eSjoerg << html::EscapeText(Entry->getName())
52006f32e7eSjoerg << "</td></tr>\n<tr><td class=\"rowname\">Warning:</td><td>"
52106f32e7eSjoerg "<a href=\"#EndPath\">line "
52206f32e7eSjoerg << LineNumber
52306f32e7eSjoerg << ", column "
52406f32e7eSjoerg << ColumnNumber
52506f32e7eSjoerg << "</a><br />"
52606f32e7eSjoerg << D.getVerboseDescription() << "</td></tr>\n";
52706f32e7eSjoerg
52806f32e7eSjoerg // The navigation across the extra notes pieces.
52906f32e7eSjoerg unsigned NumExtraPieces = 0;
53006f32e7eSjoerg for (const auto &Piece : path) {
53106f32e7eSjoerg if (const auto *P = dyn_cast<PathDiagnosticNotePiece>(Piece.get())) {
53206f32e7eSjoerg int LineNumber =
53306f32e7eSjoerg P->getLocation().asLocation().getExpansionLineNumber();
53406f32e7eSjoerg int ColumnNumber =
53506f32e7eSjoerg P->getLocation().asLocation().getExpansionColumnNumber();
53606f32e7eSjoerg os << "<tr><td class=\"rowname\">Note:</td><td>"
53706f32e7eSjoerg << "<a href=\"#Note" << NumExtraPieces << "\">line "
53806f32e7eSjoerg << LineNumber << ", column " << ColumnNumber << "</a><br />"
53906f32e7eSjoerg << P->getString() << "</td></tr>";
54006f32e7eSjoerg ++NumExtraPieces;
54106f32e7eSjoerg }
54206f32e7eSjoerg }
54306f32e7eSjoerg
54406f32e7eSjoerg // Output any other meta data.
54506f32e7eSjoerg
54606f32e7eSjoerg for (PathDiagnostic::meta_iterator I = D.meta_begin(), E = D.meta_end();
54706f32e7eSjoerg I != E; ++I) {
54806f32e7eSjoerg os << "<tr><td></td><td>" << html::EscapeText(*I) << "</td></tr>\n";
54906f32e7eSjoerg }
55006f32e7eSjoerg
55106f32e7eSjoerg os << R"<<<(
55206f32e7eSjoerg </table>
55306f32e7eSjoerg <!-- REPORTSUMMARYEXTRA -->
55406f32e7eSjoerg <h3>Annotated Source Code</h3>
55506f32e7eSjoerg <p>Press <a href="#" onclick="toggleHelp(); return false;">'?'</a>
55606f32e7eSjoerg to see keyboard shortcuts</p>
55706f32e7eSjoerg <input type="checkbox" class="spoilerhider" id="showinvocation" />
55806f32e7eSjoerg <label for="showinvocation" >Show analyzer invocation</label>
55906f32e7eSjoerg <div class="spoiler">clang -cc1 )<<<";
560*13fbcb42Sjoerg os << html::EscapeText(DiagOpts.ToolInvocation);
56106f32e7eSjoerg os << R"<<<(
56206f32e7eSjoerg </div>
56306f32e7eSjoerg <div id='tooltiphint' hidden="true">
56406f32e7eSjoerg <p>Keyboard shortcuts: </p>
56506f32e7eSjoerg <ul>
56606f32e7eSjoerg <li>Use 'j/k' keys for keyboard navigation</li>
56706f32e7eSjoerg <li>Use 'Shift+S' to show/hide relevant lines</li>
56806f32e7eSjoerg <li>Use '?' to toggle this window</li>
56906f32e7eSjoerg </ul>
57006f32e7eSjoerg <a href="#" onclick="toggleHelp(); return false;">Close</a>
57106f32e7eSjoerg </div>
57206f32e7eSjoerg )<<<";
57306f32e7eSjoerg R.InsertTextBefore(SMgr.getLocForStartOfFile(FID), os.str());
57406f32e7eSjoerg }
57506f32e7eSjoerg
57606f32e7eSjoerg // Embed meta-data tags.
57706f32e7eSjoerg {
57806f32e7eSjoerg std::string s;
57906f32e7eSjoerg llvm::raw_string_ostream os(s);
58006f32e7eSjoerg
58106f32e7eSjoerg StringRef BugDesc = D.getVerboseDescription();
58206f32e7eSjoerg if (!BugDesc.empty())
58306f32e7eSjoerg os << "\n<!-- BUGDESC " << BugDesc << " -->\n";
58406f32e7eSjoerg
58506f32e7eSjoerg StringRef BugType = D.getBugType();
58606f32e7eSjoerg if (!BugType.empty())
58706f32e7eSjoerg os << "\n<!-- BUGTYPE " << BugType << " -->\n";
58806f32e7eSjoerg
58906f32e7eSjoerg PathDiagnosticLocation UPDLoc = D.getUniqueingLoc();
59006f32e7eSjoerg FullSourceLoc L(SMgr.getExpansionLoc(UPDLoc.isValid()
59106f32e7eSjoerg ? UPDLoc.asLocation()
59206f32e7eSjoerg : D.getLocation().asLocation()),
59306f32e7eSjoerg SMgr);
59406f32e7eSjoerg const Decl *DeclWithIssue = D.getDeclWithIssue();
59506f32e7eSjoerg
59606f32e7eSjoerg StringRef BugCategory = D.getCategory();
59706f32e7eSjoerg if (!BugCategory.empty())
59806f32e7eSjoerg os << "\n<!-- BUGCATEGORY " << BugCategory << " -->\n";
59906f32e7eSjoerg
60006f32e7eSjoerg os << "\n<!-- BUGFILE " << DirName << Entry->getName() << " -->\n";
60106f32e7eSjoerg
60206f32e7eSjoerg os << "\n<!-- FILENAME " << llvm::sys::path::filename(Entry->getName()) << " -->\n";
60306f32e7eSjoerg
60406f32e7eSjoerg os << "\n<!-- FUNCTIONNAME " << declName << " -->\n";
60506f32e7eSjoerg
60606f32e7eSjoerg os << "\n<!-- ISSUEHASHCONTENTOFLINEINCONTEXT "
607*13fbcb42Sjoerg << getIssueHash(L, D.getCheckerName(), D.getBugType(), DeclWithIssue,
608*13fbcb42Sjoerg PP.getLangOpts())
60906f32e7eSjoerg << " -->\n";
61006f32e7eSjoerg
61106f32e7eSjoerg os << "\n<!-- BUGLINE "
61206f32e7eSjoerg << LineNumber
61306f32e7eSjoerg << " -->\n";
61406f32e7eSjoerg
61506f32e7eSjoerg os << "\n<!-- BUGCOLUMN "
61606f32e7eSjoerg << ColumnNumber
61706f32e7eSjoerg << " -->\n";
61806f32e7eSjoerg
61906f32e7eSjoerg os << "\n<!-- BUGPATHLENGTH " << path.size() << " -->\n";
62006f32e7eSjoerg
62106f32e7eSjoerg // Mark the end of the tags.
62206f32e7eSjoerg os << "\n<!-- BUGMETAEND -->\n";
62306f32e7eSjoerg
62406f32e7eSjoerg // Insert the text.
62506f32e7eSjoerg R.InsertTextBefore(SMgr.getLocForStartOfFile(FID), os.str());
62606f32e7eSjoerg }
62706f32e7eSjoerg
62806f32e7eSjoerg html::AddHeaderFooterInternalBuiltinCSS(R, FID, Entry->getName());
62906f32e7eSjoerg }
63006f32e7eSjoerg
showHelpJavascript()63106f32e7eSjoerg StringRef HTMLDiagnostics::showHelpJavascript() {
63206f32e7eSjoerg return R"<<<(
63306f32e7eSjoerg <script type='text/javascript'>
63406f32e7eSjoerg
63506f32e7eSjoerg var toggleHelp = function() {
63606f32e7eSjoerg var hint = document.querySelector("#tooltiphint");
63706f32e7eSjoerg var attributeName = "hidden";
63806f32e7eSjoerg if (hint.hasAttribute(attributeName)) {
63906f32e7eSjoerg hint.removeAttribute(attributeName);
64006f32e7eSjoerg } else {
64106f32e7eSjoerg hint.setAttribute("hidden", "true");
64206f32e7eSjoerg }
64306f32e7eSjoerg };
64406f32e7eSjoerg window.addEventListener("keydown", function (event) {
64506f32e7eSjoerg if (event.defaultPrevented) {
64606f32e7eSjoerg return;
64706f32e7eSjoerg }
64806f32e7eSjoerg if (event.key == "?") {
64906f32e7eSjoerg toggleHelp();
65006f32e7eSjoerg } else {
65106f32e7eSjoerg return;
65206f32e7eSjoerg }
65306f32e7eSjoerg event.preventDefault();
65406f32e7eSjoerg });
65506f32e7eSjoerg </script>
65606f32e7eSjoerg )<<<";
65706f32e7eSjoerg }
65806f32e7eSjoerg
shouldDisplayPopUpRange(const SourceRange & Range)659*13fbcb42Sjoerg static bool shouldDisplayPopUpRange(const SourceRange &Range) {
660*13fbcb42Sjoerg return !(Range.getBegin().isMacroID() || Range.getEnd().isMacroID());
661*13fbcb42Sjoerg }
662*13fbcb42Sjoerg
66306f32e7eSjoerg static void
HandlePopUpPieceStartTag(Rewriter & R,const std::vector<SourceRange> & PopUpRanges)66406f32e7eSjoerg HandlePopUpPieceStartTag(Rewriter &R,
66506f32e7eSjoerg const std::vector<SourceRange> &PopUpRanges) {
66606f32e7eSjoerg for (const auto &Range : PopUpRanges) {
667*13fbcb42Sjoerg if (!shouldDisplayPopUpRange(Range))
668*13fbcb42Sjoerg continue;
669*13fbcb42Sjoerg
67006f32e7eSjoerg html::HighlightRange(R, Range.getBegin(), Range.getEnd(), "",
67106f32e7eSjoerg "<table class='variable_popup'><tbody>",
67206f32e7eSjoerg /*IsTokenRange=*/true);
67306f32e7eSjoerg }
67406f32e7eSjoerg }
67506f32e7eSjoerg
HandlePopUpPieceEndTag(Rewriter & R,const PathDiagnosticPopUpPiece & Piece,std::vector<SourceRange> & PopUpRanges,unsigned int LastReportedPieceIndex,unsigned int PopUpPieceIndex)67606f32e7eSjoerg static void HandlePopUpPieceEndTag(Rewriter &R,
67706f32e7eSjoerg const PathDiagnosticPopUpPiece &Piece,
67806f32e7eSjoerg std::vector<SourceRange> &PopUpRanges,
67906f32e7eSjoerg unsigned int LastReportedPieceIndex,
68006f32e7eSjoerg unsigned int PopUpPieceIndex) {
68106f32e7eSjoerg SmallString<256> Buf;
68206f32e7eSjoerg llvm::raw_svector_ostream Out(Buf);
68306f32e7eSjoerg
68406f32e7eSjoerg SourceRange Range(Piece.getLocation().asRange());
685*13fbcb42Sjoerg if (!shouldDisplayPopUpRange(Range))
686*13fbcb42Sjoerg return;
68706f32e7eSjoerg
68806f32e7eSjoerg // Write out the path indices with a right arrow and the message as a row.
68906f32e7eSjoerg Out << "<tr><td valign='top'><div class='PathIndex PathIndexPopUp'>"
69006f32e7eSjoerg << LastReportedPieceIndex;
69106f32e7eSjoerg
69206f32e7eSjoerg // Also annotate the state transition with extra indices.
69306f32e7eSjoerg Out << '.' << PopUpPieceIndex;
69406f32e7eSjoerg
69506f32e7eSjoerg Out << "</div></td><td>" << Piece.getString() << "</td></tr>";
69606f32e7eSjoerg
69706f32e7eSjoerg // If no report made at this range mark the variable and add the end tags.
69806f32e7eSjoerg if (std::find(PopUpRanges.begin(), PopUpRanges.end(), Range) ==
69906f32e7eSjoerg PopUpRanges.end()) {
70006f32e7eSjoerg // Store that we create a report at this range.
70106f32e7eSjoerg PopUpRanges.push_back(Range);
70206f32e7eSjoerg
70306f32e7eSjoerg Out << "</tbody></table></span>";
70406f32e7eSjoerg html::HighlightRange(R, Range.getBegin(), Range.getEnd(),
70506f32e7eSjoerg "<span class='variable'>", Buf.c_str(),
70606f32e7eSjoerg /*IsTokenRange=*/true);
70706f32e7eSjoerg } else {
70806f32e7eSjoerg // Otherwise inject just the new row at the end of the range.
70906f32e7eSjoerg html::HighlightRange(R, Range.getBegin(), Range.getEnd(), "", Buf.c_str(),
71006f32e7eSjoerg /*IsTokenRange=*/true);
71106f32e7eSjoerg }
71206f32e7eSjoerg }
71306f32e7eSjoerg
RewriteFile(Rewriter & R,const PathPieces & path,FileID FID)71406f32e7eSjoerg void HTMLDiagnostics::RewriteFile(Rewriter &R,
71506f32e7eSjoerg const PathPieces& path, FileID FID) {
71606f32e7eSjoerg // Process the path.
71706f32e7eSjoerg // Maintain the counts of extra note pieces separately.
71806f32e7eSjoerg unsigned TotalPieces = path.size();
71906f32e7eSjoerg unsigned TotalNotePieces = std::count_if(
72006f32e7eSjoerg path.begin(), path.end(), [](const PathDiagnosticPieceRef &p) {
72106f32e7eSjoerg return isa<PathDiagnosticNotePiece>(*p);
72206f32e7eSjoerg });
72306f32e7eSjoerg unsigned PopUpPieceCount = std::count_if(
72406f32e7eSjoerg path.begin(), path.end(), [](const PathDiagnosticPieceRef &p) {
72506f32e7eSjoerg return isa<PathDiagnosticPopUpPiece>(*p);
72606f32e7eSjoerg });
72706f32e7eSjoerg
72806f32e7eSjoerg unsigned TotalRegularPieces = TotalPieces - TotalNotePieces - PopUpPieceCount;
72906f32e7eSjoerg unsigned NumRegularPieces = TotalRegularPieces;
73006f32e7eSjoerg unsigned NumNotePieces = TotalNotePieces;
73106f32e7eSjoerg // Stores the count of the regular piece indices.
73206f32e7eSjoerg std::map<int, int> IndexMap;
73306f32e7eSjoerg
73406f32e7eSjoerg // Stores the different ranges where we have reported something.
73506f32e7eSjoerg std::vector<SourceRange> PopUpRanges;
73606f32e7eSjoerg for (auto I = path.rbegin(), E = path.rend(); I != E; ++I) {
73706f32e7eSjoerg const auto &Piece = *I->get();
73806f32e7eSjoerg
73906f32e7eSjoerg if (isa<PathDiagnosticPopUpPiece>(Piece)) {
74006f32e7eSjoerg ++IndexMap[NumRegularPieces];
74106f32e7eSjoerg } else if (isa<PathDiagnosticNotePiece>(Piece)) {
74206f32e7eSjoerg // This adds diagnostic bubbles, but not navigation.
74306f32e7eSjoerg // Navigation through note pieces would be added later,
74406f32e7eSjoerg // as a separate pass through the piece list.
74506f32e7eSjoerg HandlePiece(R, FID, Piece, PopUpRanges, NumNotePieces, TotalNotePieces);
74606f32e7eSjoerg --NumNotePieces;
74706f32e7eSjoerg } else {
74806f32e7eSjoerg HandlePiece(R, FID, Piece, PopUpRanges, NumRegularPieces,
74906f32e7eSjoerg TotalRegularPieces);
75006f32e7eSjoerg --NumRegularPieces;
75106f32e7eSjoerg }
75206f32e7eSjoerg }
75306f32e7eSjoerg
75406f32e7eSjoerg // Secondary indexing if we are having multiple pop-ups between two notes.
75506f32e7eSjoerg // (e.g. [(13) 'a' is 'true']; [(13.1) 'b' is 'false']; [(13.2) 'c' is...)
75606f32e7eSjoerg NumRegularPieces = TotalRegularPieces;
75706f32e7eSjoerg for (auto I = path.rbegin(), E = path.rend(); I != E; ++I) {
75806f32e7eSjoerg const auto &Piece = *I->get();
75906f32e7eSjoerg
76006f32e7eSjoerg if (const auto *PopUpP = dyn_cast<PathDiagnosticPopUpPiece>(&Piece)) {
76106f32e7eSjoerg int PopUpPieceIndex = IndexMap[NumRegularPieces];
76206f32e7eSjoerg
76306f32e7eSjoerg // Pop-up pieces needs the index of the last reported piece and its count
76406f32e7eSjoerg // how many times we report to handle multiple reports on the same range.
76506f32e7eSjoerg // This marks the variable, adds the </table> end tag and the message
76606f32e7eSjoerg // (list element) as a row. The <table> start tag will be added after the
76706f32e7eSjoerg // rows has been written out. Note: It stores every different range.
76806f32e7eSjoerg HandlePopUpPieceEndTag(R, *PopUpP, PopUpRanges, NumRegularPieces,
76906f32e7eSjoerg PopUpPieceIndex);
77006f32e7eSjoerg
77106f32e7eSjoerg if (PopUpPieceIndex > 0)
77206f32e7eSjoerg --IndexMap[NumRegularPieces];
77306f32e7eSjoerg
77406f32e7eSjoerg } else if (!isa<PathDiagnosticNotePiece>(Piece)) {
77506f32e7eSjoerg --NumRegularPieces;
77606f32e7eSjoerg }
77706f32e7eSjoerg }
77806f32e7eSjoerg
77906f32e7eSjoerg // Add the <table> start tag of pop-up pieces based on the stored ranges.
78006f32e7eSjoerg HandlePopUpPieceStartTag(R, PopUpRanges);
78106f32e7eSjoerg
78206f32e7eSjoerg // Add line numbers, header, footer, etc.
78306f32e7eSjoerg html::EscapeText(R, FID);
78406f32e7eSjoerg html::AddLineNumbers(R, FID);
78506f32e7eSjoerg
78606f32e7eSjoerg // If we have a preprocessor, relex the file and syntax highlight.
78706f32e7eSjoerg // We might not have a preprocessor if we come from a deserialized AST file,
78806f32e7eSjoerg // for example.
78906f32e7eSjoerg html::SyntaxHighlight(R, FID, PP);
79006f32e7eSjoerg html::HighlightMacros(R, FID, PP);
79106f32e7eSjoerg }
79206f32e7eSjoerg
HandlePiece(Rewriter & R,FileID BugFileID,const PathDiagnosticPiece & P,const std::vector<SourceRange> & PopUpRanges,unsigned num,unsigned max)79306f32e7eSjoerg void HTMLDiagnostics::HandlePiece(Rewriter &R, FileID BugFileID,
79406f32e7eSjoerg const PathDiagnosticPiece &P,
79506f32e7eSjoerg const std::vector<SourceRange> &PopUpRanges,
79606f32e7eSjoerg unsigned num, unsigned max) {
79706f32e7eSjoerg // For now, just draw a box above the line in question, and emit the
79806f32e7eSjoerg // warning.
79906f32e7eSjoerg FullSourceLoc Pos = P.getLocation().asLocation();
80006f32e7eSjoerg
80106f32e7eSjoerg if (!Pos.isValid())
80206f32e7eSjoerg return;
80306f32e7eSjoerg
80406f32e7eSjoerg SourceManager &SM = R.getSourceMgr();
80506f32e7eSjoerg assert(&Pos.getManager() == &SM && "SourceManagers are different!");
80606f32e7eSjoerg std::pair<FileID, unsigned> LPosInfo = SM.getDecomposedExpansionLoc(Pos);
80706f32e7eSjoerg
80806f32e7eSjoerg if (LPosInfo.first != BugFileID)
80906f32e7eSjoerg return;
81006f32e7eSjoerg
811*13fbcb42Sjoerg llvm::MemoryBufferRef Buf = SM.getBufferOrFake(LPosInfo.first);
812*13fbcb42Sjoerg const char *FileStart = Buf.getBufferStart();
81306f32e7eSjoerg
81406f32e7eSjoerg // Compute the column number. Rewind from the current position to the start
81506f32e7eSjoerg // of the line.
81606f32e7eSjoerg unsigned ColNo = SM.getColumnNumber(LPosInfo.first, LPosInfo.second);
81706f32e7eSjoerg const char *TokInstantiationPtr =Pos.getExpansionLoc().getCharacterData();
81806f32e7eSjoerg const char *LineStart = TokInstantiationPtr-ColNo;
81906f32e7eSjoerg
82006f32e7eSjoerg // Compute LineEnd.
82106f32e7eSjoerg const char *LineEnd = TokInstantiationPtr;
822*13fbcb42Sjoerg const char *FileEnd = Buf.getBufferEnd();
82306f32e7eSjoerg while (*LineEnd != '\n' && LineEnd != FileEnd)
82406f32e7eSjoerg ++LineEnd;
82506f32e7eSjoerg
82606f32e7eSjoerg // Compute the margin offset by counting tabs and non-tabs.
82706f32e7eSjoerg unsigned PosNo = 0;
82806f32e7eSjoerg for (const char* c = LineStart; c != TokInstantiationPtr; ++c)
82906f32e7eSjoerg PosNo += *c == '\t' ? 8 : 1;
83006f32e7eSjoerg
83106f32e7eSjoerg // Create the html for the message.
83206f32e7eSjoerg
83306f32e7eSjoerg const char *Kind = nullptr;
83406f32e7eSjoerg bool IsNote = false;
83506f32e7eSjoerg bool SuppressIndex = (max == 1);
83606f32e7eSjoerg switch (P.getKind()) {
83706f32e7eSjoerg case PathDiagnosticPiece::Event: Kind = "Event"; break;
83806f32e7eSjoerg case PathDiagnosticPiece::ControlFlow: Kind = "Control"; break;
83906f32e7eSjoerg // Setting Kind to "Control" is intentional.
84006f32e7eSjoerg case PathDiagnosticPiece::Macro: Kind = "Control"; break;
84106f32e7eSjoerg case PathDiagnosticPiece::Note:
84206f32e7eSjoerg Kind = "Note";
84306f32e7eSjoerg IsNote = true;
84406f32e7eSjoerg SuppressIndex = true;
84506f32e7eSjoerg break;
84606f32e7eSjoerg case PathDiagnosticPiece::Call:
84706f32e7eSjoerg case PathDiagnosticPiece::PopUp:
84806f32e7eSjoerg llvm_unreachable("Calls and extra notes should already be handled");
84906f32e7eSjoerg }
85006f32e7eSjoerg
85106f32e7eSjoerg std::string sbuf;
85206f32e7eSjoerg llvm::raw_string_ostream os(sbuf);
85306f32e7eSjoerg
85406f32e7eSjoerg os << "\n<tr><td class=\"num\"></td><td class=\"line\"><div id=\"";
85506f32e7eSjoerg
85606f32e7eSjoerg if (IsNote)
85706f32e7eSjoerg os << "Note" << num;
85806f32e7eSjoerg else if (num == max)
85906f32e7eSjoerg os << "EndPath";
86006f32e7eSjoerg else
86106f32e7eSjoerg os << "Path" << num;
86206f32e7eSjoerg
86306f32e7eSjoerg os << "\" class=\"msg";
86406f32e7eSjoerg if (Kind)
86506f32e7eSjoerg os << " msg" << Kind;
86606f32e7eSjoerg os << "\" style=\"margin-left:" << PosNo << "ex";
86706f32e7eSjoerg
86806f32e7eSjoerg // Output a maximum size.
86906f32e7eSjoerg if (!isa<PathDiagnosticMacroPiece>(P)) {
87006f32e7eSjoerg // Get the string and determining its maximum substring.
87106f32e7eSjoerg const auto &Msg = P.getString();
87206f32e7eSjoerg unsigned max_token = 0;
87306f32e7eSjoerg unsigned cnt = 0;
87406f32e7eSjoerg unsigned len = Msg.size();
87506f32e7eSjoerg
87606f32e7eSjoerg for (char C : Msg)
87706f32e7eSjoerg switch (C) {
87806f32e7eSjoerg default:
87906f32e7eSjoerg ++cnt;
88006f32e7eSjoerg continue;
88106f32e7eSjoerg case ' ':
88206f32e7eSjoerg case '\t':
88306f32e7eSjoerg case '\n':
88406f32e7eSjoerg if (cnt > max_token) max_token = cnt;
88506f32e7eSjoerg cnt = 0;
88606f32e7eSjoerg }
88706f32e7eSjoerg
88806f32e7eSjoerg if (cnt > max_token)
88906f32e7eSjoerg max_token = cnt;
89006f32e7eSjoerg
89106f32e7eSjoerg // Determine the approximate size of the message bubble in em.
89206f32e7eSjoerg unsigned em;
89306f32e7eSjoerg const unsigned max_line = 120;
89406f32e7eSjoerg
89506f32e7eSjoerg if (max_token >= max_line)
89606f32e7eSjoerg em = max_token / 2;
89706f32e7eSjoerg else {
89806f32e7eSjoerg unsigned characters = max_line;
89906f32e7eSjoerg unsigned lines = len / max_line;
90006f32e7eSjoerg
90106f32e7eSjoerg if (lines > 0) {
90206f32e7eSjoerg for (; characters > max_token; --characters)
90306f32e7eSjoerg if (len / characters > lines) {
90406f32e7eSjoerg ++characters;
90506f32e7eSjoerg break;
90606f32e7eSjoerg }
90706f32e7eSjoerg }
90806f32e7eSjoerg
90906f32e7eSjoerg em = characters / 2;
91006f32e7eSjoerg }
91106f32e7eSjoerg
91206f32e7eSjoerg if (em < max_line/2)
91306f32e7eSjoerg os << "; max-width:" << em << "em";
91406f32e7eSjoerg }
91506f32e7eSjoerg else
91606f32e7eSjoerg os << "; max-width:100em";
91706f32e7eSjoerg
91806f32e7eSjoerg os << "\">";
91906f32e7eSjoerg
92006f32e7eSjoerg if (!SuppressIndex) {
92106f32e7eSjoerg os << "<table class=\"msgT\"><tr><td valign=\"top\">";
92206f32e7eSjoerg os << "<div class=\"PathIndex";
92306f32e7eSjoerg if (Kind) os << " PathIndex" << Kind;
92406f32e7eSjoerg os << "\">" << num << "</div>";
92506f32e7eSjoerg
92606f32e7eSjoerg if (num > 1) {
92706f32e7eSjoerg os << "</td><td><div class=\"PathNav\"><a href=\"#Path"
92806f32e7eSjoerg << (num - 1)
92906f32e7eSjoerg << "\" title=\"Previous event ("
93006f32e7eSjoerg << (num - 1)
931*13fbcb42Sjoerg << ")\">←</a></div>";
93206f32e7eSjoerg }
93306f32e7eSjoerg
93406f32e7eSjoerg os << "</td><td>";
93506f32e7eSjoerg }
93606f32e7eSjoerg
93706f32e7eSjoerg if (const auto *MP = dyn_cast<PathDiagnosticMacroPiece>(&P)) {
93806f32e7eSjoerg os << "Within the expansion of the macro '";
93906f32e7eSjoerg
94006f32e7eSjoerg // Get the name of the macro by relexing it.
94106f32e7eSjoerg {
94206f32e7eSjoerg FullSourceLoc L = MP->getLocation().asLocation().getExpansionLoc();
94306f32e7eSjoerg assert(L.isFileID());
94406f32e7eSjoerg StringRef BufferInfo = L.getBufferData();
94506f32e7eSjoerg std::pair<FileID, unsigned> LocInfo = L.getDecomposedLoc();
94606f32e7eSjoerg const char* MacroName = LocInfo.second + BufferInfo.data();
94706f32e7eSjoerg Lexer rawLexer(SM.getLocForStartOfFile(LocInfo.first), PP.getLangOpts(),
94806f32e7eSjoerg BufferInfo.begin(), MacroName, BufferInfo.end());
94906f32e7eSjoerg
95006f32e7eSjoerg Token TheTok;
95106f32e7eSjoerg rawLexer.LexFromRawLexer(TheTok);
95206f32e7eSjoerg for (unsigned i = 0, n = TheTok.getLength(); i < n; ++i)
95306f32e7eSjoerg os << MacroName[i];
95406f32e7eSjoerg }
95506f32e7eSjoerg
95606f32e7eSjoerg os << "':\n";
95706f32e7eSjoerg
95806f32e7eSjoerg if (!SuppressIndex) {
95906f32e7eSjoerg os << "</td>";
96006f32e7eSjoerg if (num < max) {
96106f32e7eSjoerg os << "<td><div class=\"PathNav\"><a href=\"#";
96206f32e7eSjoerg if (num == max - 1)
96306f32e7eSjoerg os << "EndPath";
96406f32e7eSjoerg else
96506f32e7eSjoerg os << "Path" << (num + 1);
96606f32e7eSjoerg os << "\" title=\"Next event ("
96706f32e7eSjoerg << (num + 1)
96806f32e7eSjoerg << ")\">→</a></div></td>";
96906f32e7eSjoerg }
97006f32e7eSjoerg
97106f32e7eSjoerg os << "</tr></table>";
97206f32e7eSjoerg }
97306f32e7eSjoerg
97406f32e7eSjoerg // Within a macro piece. Write out each event.
97506f32e7eSjoerg ProcessMacroPiece(os, *MP, 0);
97606f32e7eSjoerg }
97706f32e7eSjoerg else {
97806f32e7eSjoerg os << html::EscapeText(P.getString());
97906f32e7eSjoerg
98006f32e7eSjoerg if (!SuppressIndex) {
98106f32e7eSjoerg os << "</td>";
98206f32e7eSjoerg if (num < max) {
98306f32e7eSjoerg os << "<td><div class=\"PathNav\"><a href=\"#";
98406f32e7eSjoerg if (num == max - 1)
98506f32e7eSjoerg os << "EndPath";
98606f32e7eSjoerg else
98706f32e7eSjoerg os << "Path" << (num + 1);
98806f32e7eSjoerg os << "\" title=\"Next event ("
98906f32e7eSjoerg << (num + 1)
99006f32e7eSjoerg << ")\">→</a></div></td>";
99106f32e7eSjoerg }
99206f32e7eSjoerg
99306f32e7eSjoerg os << "</tr></table>";
99406f32e7eSjoerg }
99506f32e7eSjoerg }
99606f32e7eSjoerg
99706f32e7eSjoerg os << "</div></td></tr>";
99806f32e7eSjoerg
99906f32e7eSjoerg // Insert the new html.
100006f32e7eSjoerg unsigned DisplayPos = LineEnd - FileStart;
100106f32e7eSjoerg SourceLocation Loc =
100206f32e7eSjoerg SM.getLocForStartOfFile(LPosInfo.first).getLocWithOffset(DisplayPos);
100306f32e7eSjoerg
100406f32e7eSjoerg R.InsertTextBefore(Loc, os.str());
100506f32e7eSjoerg
100606f32e7eSjoerg // Now highlight the ranges.
100706f32e7eSjoerg ArrayRef<SourceRange> Ranges = P.getRanges();
100806f32e7eSjoerg for (const auto &Range : Ranges) {
100906f32e7eSjoerg // If we have already highlighted the range as a pop-up there is no work.
101006f32e7eSjoerg if (std::find(PopUpRanges.begin(), PopUpRanges.end(), Range) !=
101106f32e7eSjoerg PopUpRanges.end())
101206f32e7eSjoerg continue;
101306f32e7eSjoerg
101406f32e7eSjoerg HighlightRange(R, LPosInfo.first, Range);
101506f32e7eSjoerg }
101606f32e7eSjoerg }
101706f32e7eSjoerg
EmitAlphaCounter(raw_ostream & os,unsigned n)101806f32e7eSjoerg static void EmitAlphaCounter(raw_ostream &os, unsigned n) {
101906f32e7eSjoerg unsigned x = n % ('z' - 'a');
102006f32e7eSjoerg n /= 'z' - 'a';
102106f32e7eSjoerg
102206f32e7eSjoerg if (n > 0)
102306f32e7eSjoerg EmitAlphaCounter(os, n);
102406f32e7eSjoerg
102506f32e7eSjoerg os << char('a' + x);
102606f32e7eSjoerg }
102706f32e7eSjoerg
ProcessMacroPiece(raw_ostream & os,const PathDiagnosticMacroPiece & P,unsigned num)102806f32e7eSjoerg unsigned HTMLDiagnostics::ProcessMacroPiece(raw_ostream &os,
102906f32e7eSjoerg const PathDiagnosticMacroPiece& P,
103006f32e7eSjoerg unsigned num) {
103106f32e7eSjoerg for (const auto &subPiece : P.subPieces) {
103206f32e7eSjoerg if (const auto *MP = dyn_cast<PathDiagnosticMacroPiece>(subPiece.get())) {
103306f32e7eSjoerg num = ProcessMacroPiece(os, *MP, num);
103406f32e7eSjoerg continue;
103506f32e7eSjoerg }
103606f32e7eSjoerg
103706f32e7eSjoerg if (const auto *EP = dyn_cast<PathDiagnosticEventPiece>(subPiece.get())) {
103806f32e7eSjoerg os << "<div class=\"msg msgEvent\" style=\"width:94%; "
103906f32e7eSjoerg "margin-left:5px\">"
104006f32e7eSjoerg "<table class=\"msgT\"><tr>"
104106f32e7eSjoerg "<td valign=\"top\"><div class=\"PathIndex PathIndexEvent\">";
104206f32e7eSjoerg EmitAlphaCounter(os, num++);
104306f32e7eSjoerg os << "</div></td><td valign=\"top\">"
104406f32e7eSjoerg << html::EscapeText(EP->getString())
104506f32e7eSjoerg << "</td></tr></table></div>\n";
104606f32e7eSjoerg }
104706f32e7eSjoerg }
104806f32e7eSjoerg
104906f32e7eSjoerg return num;
105006f32e7eSjoerg }
105106f32e7eSjoerg
HighlightRange(Rewriter & R,FileID BugFileID,SourceRange Range,const char * HighlightStart,const char * HighlightEnd)105206f32e7eSjoerg void HTMLDiagnostics::HighlightRange(Rewriter& R, FileID BugFileID,
105306f32e7eSjoerg SourceRange Range,
105406f32e7eSjoerg const char *HighlightStart,
105506f32e7eSjoerg const char *HighlightEnd) {
105606f32e7eSjoerg SourceManager &SM = R.getSourceMgr();
105706f32e7eSjoerg const LangOptions &LangOpts = R.getLangOpts();
105806f32e7eSjoerg
105906f32e7eSjoerg SourceLocation InstantiationStart = SM.getExpansionLoc(Range.getBegin());
106006f32e7eSjoerg unsigned StartLineNo = SM.getExpansionLineNumber(InstantiationStart);
106106f32e7eSjoerg
106206f32e7eSjoerg SourceLocation InstantiationEnd = SM.getExpansionLoc(Range.getEnd());
106306f32e7eSjoerg unsigned EndLineNo = SM.getExpansionLineNumber(InstantiationEnd);
106406f32e7eSjoerg
106506f32e7eSjoerg if (EndLineNo < StartLineNo)
106606f32e7eSjoerg return;
106706f32e7eSjoerg
106806f32e7eSjoerg if (SM.getFileID(InstantiationStart) != BugFileID ||
106906f32e7eSjoerg SM.getFileID(InstantiationEnd) != BugFileID)
107006f32e7eSjoerg return;
107106f32e7eSjoerg
107206f32e7eSjoerg // Compute the column number of the end.
107306f32e7eSjoerg unsigned EndColNo = SM.getExpansionColumnNumber(InstantiationEnd);
107406f32e7eSjoerg unsigned OldEndColNo = EndColNo;
107506f32e7eSjoerg
107606f32e7eSjoerg if (EndColNo) {
107706f32e7eSjoerg // Add in the length of the token, so that we cover multi-char tokens.
107806f32e7eSjoerg EndColNo += Lexer::MeasureTokenLength(Range.getEnd(), SM, LangOpts)-1;
107906f32e7eSjoerg }
108006f32e7eSjoerg
108106f32e7eSjoerg // Highlight the range. Make the span tag the outermost tag for the
108206f32e7eSjoerg // selected range.
108306f32e7eSjoerg
108406f32e7eSjoerg SourceLocation E =
108506f32e7eSjoerg InstantiationEnd.getLocWithOffset(EndColNo - OldEndColNo);
108606f32e7eSjoerg
108706f32e7eSjoerg html::HighlightRange(R, InstantiationStart, E, HighlightStart, HighlightEnd);
108806f32e7eSjoerg }
108906f32e7eSjoerg
generateKeyboardNavigationJavascript()109006f32e7eSjoerg StringRef HTMLDiagnostics::generateKeyboardNavigationJavascript() {
109106f32e7eSjoerg return R"<<<(
109206f32e7eSjoerg <script type='text/javascript'>
109306f32e7eSjoerg var digitMatcher = new RegExp("[0-9]+");
109406f32e7eSjoerg
1095*13fbcb42Sjoerg var querySelectorAllArray = function(selector) {
1096*13fbcb42Sjoerg return Array.prototype.slice.call(
1097*13fbcb42Sjoerg document.querySelectorAll(selector));
1098*13fbcb42Sjoerg }
1099*13fbcb42Sjoerg
110006f32e7eSjoerg document.addEventListener("DOMContentLoaded", function() {
1101*13fbcb42Sjoerg querySelectorAllArray(".PathNav > a").forEach(
110206f32e7eSjoerg function(currentValue, currentIndex) {
110306f32e7eSjoerg var hrefValue = currentValue.getAttribute("href");
110406f32e7eSjoerg currentValue.onclick = function() {
110506f32e7eSjoerg scrollTo(document.querySelector(hrefValue));
110606f32e7eSjoerg return false;
110706f32e7eSjoerg };
110806f32e7eSjoerg });
110906f32e7eSjoerg });
111006f32e7eSjoerg
111106f32e7eSjoerg var findNum = function() {
111206f32e7eSjoerg var s = document.querySelector(".selected");
111306f32e7eSjoerg if (!s || s.id == "EndPath") {
111406f32e7eSjoerg return 0;
111506f32e7eSjoerg }
111606f32e7eSjoerg var out = parseInt(digitMatcher.exec(s.id)[0]);
111706f32e7eSjoerg return out;
111806f32e7eSjoerg };
111906f32e7eSjoerg
112006f32e7eSjoerg var scrollTo = function(el) {
1121*13fbcb42Sjoerg querySelectorAllArray(".selected").forEach(function(s) {
112206f32e7eSjoerg s.classList.remove("selected");
112306f32e7eSjoerg });
112406f32e7eSjoerg el.classList.add("selected");
112506f32e7eSjoerg window.scrollBy(0, el.getBoundingClientRect().top -
112606f32e7eSjoerg (window.innerHeight / 2));
112706f32e7eSjoerg }
112806f32e7eSjoerg
112906f32e7eSjoerg var move = function(num, up, numItems) {
113006f32e7eSjoerg if (num == 1 && up || num == numItems - 1 && !up) {
113106f32e7eSjoerg return 0;
113206f32e7eSjoerg } else if (num == 0 && up) {
113306f32e7eSjoerg return numItems - 1;
113406f32e7eSjoerg } else if (num == 0 && !up) {
113506f32e7eSjoerg return 1 % numItems;
113606f32e7eSjoerg }
113706f32e7eSjoerg return up ? num - 1 : num + 1;
113806f32e7eSjoerg }
113906f32e7eSjoerg
114006f32e7eSjoerg var numToId = function(num) {
114106f32e7eSjoerg if (num == 0) {
114206f32e7eSjoerg return document.getElementById("EndPath")
114306f32e7eSjoerg }
114406f32e7eSjoerg return document.getElementById("Path" + num);
114506f32e7eSjoerg };
114606f32e7eSjoerg
114706f32e7eSjoerg var navigateTo = function(up) {
114806f32e7eSjoerg var numItems = document.querySelectorAll(
114906f32e7eSjoerg ".line > .msgEvent, .line > .msgControl").length;
115006f32e7eSjoerg var currentSelected = findNum();
115106f32e7eSjoerg var newSelected = move(currentSelected, up, numItems);
115206f32e7eSjoerg var newEl = numToId(newSelected, numItems);
115306f32e7eSjoerg
115406f32e7eSjoerg // Scroll element into center.
115506f32e7eSjoerg scrollTo(newEl);
115606f32e7eSjoerg };
115706f32e7eSjoerg
115806f32e7eSjoerg window.addEventListener("keydown", function (event) {
115906f32e7eSjoerg if (event.defaultPrevented) {
116006f32e7eSjoerg return;
116106f32e7eSjoerg }
116206f32e7eSjoerg if (event.key == "j") {
116306f32e7eSjoerg navigateTo(/*up=*/false);
116406f32e7eSjoerg } else if (event.key == "k") {
116506f32e7eSjoerg navigateTo(/*up=*/true);
116606f32e7eSjoerg } else {
116706f32e7eSjoerg return;
116806f32e7eSjoerg }
116906f32e7eSjoerg event.preventDefault();
117006f32e7eSjoerg }, true);
117106f32e7eSjoerg </script>
117206f32e7eSjoerg )<<<";
117306f32e7eSjoerg }
1174