Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 1 | //===--- HTMLDiagnostics.cpp - HTML Diagnostics for Paths ----*- C++ -*-===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file defines the HTMLDiagnostics object. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
| 14 | #include "HTMLDiagnostics.h" |
| 15 | #include "clang/Basic/SourceManager.h" |
Ted Kremenek | 2e93981 | 2008-03-27 07:35:49 +0000 | [diff] [blame] | 16 | #include "clang/Basic/FileManager.h" |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 17 | #include "clang/AST/ASTContext.h" |
| 18 | #include "clang/Analysis/PathDiagnostic.h" |
| 19 | #include "clang/Rewrite/Rewriter.h" |
| 20 | #include "clang/Rewrite/HTMLRewrite.h" |
| 21 | #include "clang/Lex/Lexer.h" |
| 22 | #include "llvm/Support/Compiler.h" |
| 23 | #include "llvm/Support/MemoryBuffer.h" |
| 24 | #include "llvm/Support/Streams.h" |
| 25 | #include "llvm/System/Path.h" |
| 26 | #include <fstream> |
| 27 | #include <sstream> |
| 28 | |
| 29 | using namespace clang; |
| 30 | |
| 31 | //===----------------------------------------------------------------------===// |
| 32 | // Boilerplate. |
| 33 | //===----------------------------------------------------------------------===// |
| 34 | |
| 35 | namespace { |
| 36 | |
| 37 | class VISIBILITY_HIDDEN HTMLDiagnostics : public PathDiagnosticClient { |
| 38 | llvm::sys::Path Directory, FilePrefix; |
| 39 | bool createdDir, noDir; |
| 40 | public: |
| 41 | HTMLDiagnostics(const std::string& prefix); |
| 42 | |
| 43 | virtual ~HTMLDiagnostics() {} |
| 44 | |
| 45 | virtual void HandlePathDiagnostic(const PathDiagnostic& D); |
| 46 | |
Ted Kremenek | 33bd942 | 2008-03-31 23:30:12 +0000 | [diff] [blame] | 47 | void HandlePiece(Rewriter& R, const PathDiagnosticPiece& P, |
| 48 | unsigned num, unsigned max); |
| 49 | |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 50 | void HighlightRange(Rewriter& R, SourceRange Range, unsigned MainFileID); |
| 51 | }; |
| 52 | |
| 53 | } // end anonymous namespace |
| 54 | |
| 55 | HTMLDiagnostics::HTMLDiagnostics(const std::string& prefix) |
| 56 | : Directory(prefix), FilePrefix(prefix), createdDir(false), noDir(false) { |
| 57 | |
| 58 | // All html files begin with "report" |
| 59 | FilePrefix.appendComponent("report"); |
| 60 | } |
| 61 | |
| 62 | PathDiagnosticClient* |
| 63 | clang::CreateHTMLDiagnosticClient(const std::string& prefix) { |
| 64 | |
| 65 | return new HTMLDiagnostics(prefix); |
| 66 | } |
| 67 | |
| 68 | //===----------------------------------------------------------------------===// |
| 69 | // Report processing. |
| 70 | //===----------------------------------------------------------------------===// |
| 71 | |
| 72 | void HTMLDiagnostics::HandlePathDiagnostic(const PathDiagnostic& D) { |
| 73 | |
| 74 | if (D.empty()) |
| 75 | return; |
| 76 | |
| 77 | // Create the HTML directory if it is missing. |
| 78 | |
| 79 | if (!createdDir) { |
| 80 | createdDir = true; |
Ted Kremenek | 344f7e3 | 2008-04-03 17:55:57 +0000 | [diff] [blame] | 81 | std::string ErrorMsg; |
| 82 | Directory.createDirectoryOnDisk(true, &ErrorMsg); |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 83 | |
| 84 | if (!Directory.isDirectory()) { |
| 85 | llvm::cerr << "warning: could not create directory '" |
Ted Kremenek | 344f7e3 | 2008-04-03 17:55:57 +0000 | [diff] [blame] | 86 | << Directory.toString() << "'\n" |
| 87 | << "reason: " << ErrorMsg << '\n'; |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 88 | |
| 89 | noDir = true; |
| 90 | |
| 91 | return; |
| 92 | } |
| 93 | } |
| 94 | |
| 95 | if (noDir) |
| 96 | return; |
| 97 | |
| 98 | // Create a new rewriter to generate HTML. |
| 99 | SourceManager& SMgr = D.begin()->getLocation().getManager(); |
| 100 | Rewriter R(SMgr); |
| 101 | |
| 102 | // Process the path. |
| 103 | |
| 104 | unsigned n = D.size(); |
Ted Kremenek | 33bd942 | 2008-03-31 23:30:12 +0000 | [diff] [blame] | 105 | unsigned max = n; |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 106 | |
| 107 | for (PathDiagnostic::const_reverse_iterator I=D.rbegin(), E=D.rend(); |
| 108 | I!=E; ++I, --n) { |
| 109 | |
Ted Kremenek | 33bd942 | 2008-03-31 23:30:12 +0000 | [diff] [blame] | 110 | HandlePiece(R, *I, n, max); |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | // Add line numbers, header, footer, etc. |
Ted Kremenek | 2e93981 | 2008-03-27 07:35:49 +0000 | [diff] [blame] | 114 | |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 115 | unsigned FileID = R.getSourceMgr().getMainFileID(); |
| 116 | html::EscapeText(R, FileID); |
| 117 | html::AddLineNumbers(R, FileID); |
| 118 | |
Ted Kremenek | b947639 | 2008-04-02 20:44:16 +0000 | [diff] [blame] | 119 | // Get the full directory name of the analyzed file. |
| 120 | |
| 121 | const FileEntry* Entry = SMgr.getFileEntryForID(FileID); |
| 122 | std::string DirName(Entry->getDir()->getName()); |
Ted Kremenek | 2e93981 | 2008-03-27 07:35:49 +0000 | [diff] [blame] | 123 | |
Ted Kremenek | b947639 | 2008-04-02 20:44:16 +0000 | [diff] [blame] | 124 | if (DirName == ".") |
| 125 | DirName = llvm::sys::Path::GetCurrentDirectory().toString(); |
| 126 | |
| 127 | // Add the name of the file as an <h1> tag. |
| 128 | |
Ted Kremenek | 2e93981 | 2008-03-27 07:35:49 +0000 | [diff] [blame] | 129 | { |
| 130 | std::ostringstream os; |
Ted Kremenek | 2e93981 | 2008-03-27 07:35:49 +0000 | [diff] [blame] | 131 | |
Ted Kremenek | b947639 | 2008-04-02 20:44:16 +0000 | [diff] [blame] | 132 | os << "<h1>" << html::EscapeText(DirName) |
| 133 | << "/" << html::EscapeText(Entry->getName()) << "</h1>\n"; |
Ted Kremenek | 2e93981 | 2008-03-27 07:35:49 +0000 | [diff] [blame] | 134 | |
| 135 | R.InsertStrBefore(SourceLocation::getFileLoc(FileID, 0), os.str()); |
Ted Kremenek | 0761540 | 2008-04-02 07:04:46 +0000 | [diff] [blame] | 136 | } |
| 137 | |
Ted Kremenek | b947639 | 2008-04-02 20:44:16 +0000 | [diff] [blame] | 138 | // Embed meta-data tags. |
Ted Kremenek | 0761540 | 2008-04-02 07:04:46 +0000 | [diff] [blame] | 139 | |
| 140 | const std::string& BugDesc = D.getDescription(); |
| 141 | |
| 142 | if (!BugDesc.empty()) { |
| 143 | std::ostringstream os; |
Ted Kremenek | 86b4381 | 2008-04-02 18:03:20 +0000 | [diff] [blame] | 144 | os << "\n<!-- BUGDESC " << BugDesc << " -->\n"; |
Ted Kremenek | 0761540 | 2008-04-02 07:04:46 +0000 | [diff] [blame] | 145 | R.InsertStrBefore(SourceLocation::getFileLoc(FileID, 0), os.str()); |
Ted Kremenek | b947639 | 2008-04-02 20:44:16 +0000 | [diff] [blame] | 146 | } |
| 147 | |
| 148 | { |
| 149 | std::ostringstream os; |
| 150 | os << "\n<!-- BUGFILE " << DirName << "/" << Entry->getName() << " -->\n"; |
| 151 | R.InsertStrBefore(SourceLocation::getFileLoc(FileID, 0), os.str()); |
| 152 | } |
| 153 | |
| 154 | { |
| 155 | std::ostringstream os; |
Ted Kremenek | 344f7e3 | 2008-04-03 17:55:57 +0000 | [diff] [blame] | 156 | os << "\n<!-- BUGLINE " << D.back()->getLocation().getLogicalLineNumber() |
Ted Kremenek | b947639 | 2008-04-02 20:44:16 +0000 | [diff] [blame] | 157 | << " -->\n"; |
| 158 | R.InsertStrBefore(SourceLocation::getFileLoc(FileID, 0), os.str()); |
| 159 | } |
| 160 | |
| 161 | { |
| 162 | std::ostringstream os; |
| 163 | os << "\n<!-- BUGPATHLENGTH " << D.size() << " -->\n"; |
| 164 | R.InsertStrBefore(SourceLocation::getFileLoc(FileID, 0), os.str()); |
| 165 | } |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 166 | |
| 167 | // Add CSS, header, and footer. |
| 168 | |
| 169 | html::AddHeaderFooterInternalBuiltinCSS(R, FileID); |
| 170 | |
| 171 | // Get the rewrite buffer. |
| 172 | const RewriteBuffer *Buf = R.getRewriteBufferFor(FileID); |
| 173 | |
| 174 | if (!Buf) { |
| 175 | llvm::cerr << "warning: no diagnostics generated for main file.\n"; |
| 176 | return; |
| 177 | } |
| 178 | |
| 179 | // Create the stream to write out the HTML. |
| 180 | std::ofstream os; |
| 181 | |
| 182 | { |
| 183 | // Create a path for the target HTML file. |
| 184 | llvm::sys::Path F(FilePrefix); |
| 185 | F.makeUnique(false, NULL); |
| 186 | |
| 187 | // Rename the file with an HTML extension. |
| 188 | llvm::sys::Path H(F); |
| 189 | H.appendSuffix("html"); |
| 190 | F.renamePathOnDisk(H, NULL); |
| 191 | |
| 192 | os.open(H.toString().c_str()); |
| 193 | |
| 194 | if (!os) { |
| 195 | llvm::cerr << "warning: could not create file '" << F.toString() << "'\n"; |
| 196 | return; |
| 197 | } |
| 198 | } |
| 199 | |
| 200 | // Emit the HTML to disk. |
| 201 | |
| 202 | for (RewriteBuffer::iterator I = Buf->begin(), E = Buf->end(); I!=E; ++I) |
| 203 | os << *I; |
| 204 | } |
| 205 | |
| 206 | void HTMLDiagnostics::HandlePiece(Rewriter& R, |
| 207 | const PathDiagnosticPiece& P, |
Ted Kremenek | 33bd942 | 2008-03-31 23:30:12 +0000 | [diff] [blame] | 208 | unsigned num, unsigned max) { |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 209 | |
| 210 | // For now, just draw a box above the line in question, and emit the |
| 211 | // warning. |
| 212 | |
| 213 | FullSourceLoc Pos = P.getLocation(); |
| 214 | |
| 215 | if (!Pos.isValid()) |
| 216 | return; |
| 217 | |
| 218 | SourceManager& SM = R.getSourceMgr(); |
| 219 | FullSourceLoc LPos = Pos.getLogicalLoc(); |
| 220 | unsigned FileID = LPos.getLocation().getFileID(); |
| 221 | |
| 222 | assert (&LPos.getManager() == &SM && "SourceManagers are different!"); |
| 223 | |
| 224 | unsigned MainFileID = SM.getMainFileID(); |
| 225 | |
| 226 | if (FileID != MainFileID) |
| 227 | return; |
| 228 | |
| 229 | // Compute the column number. Rewind from the current position to the start |
| 230 | // of the line. |
| 231 | |
| 232 | unsigned ColNo = LPos.getColumnNumber(); |
| 233 | const char *TokLogicalPtr = LPos.getCharacterData(); |
| 234 | const char *LineStart = TokLogicalPtr-ColNo; |
| 235 | |
Ted Kremenek | 2aa13b5 | 2008-03-31 21:40:14 +0000 | [diff] [blame] | 236 | // Compute the margin offset by counting tabs and non-tabs. |
| 237 | |
| 238 | unsigned PosNo = 0; |
| 239 | |
| 240 | for (const char* c = LineStart; c != TokLogicalPtr; ++c) |
Ted Kremenek | 8fb0016 | 2008-03-31 23:14:05 +0000 | [diff] [blame] | 241 | PosNo += *c == '\t' ? 4 : 1; |
Ted Kremenek | 2aa13b5 | 2008-03-31 21:40:14 +0000 | [diff] [blame] | 242 | |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 243 | // Create the html for the message. |
| 244 | |
| 245 | std::ostringstream os; |
| 246 | |
| 247 | os << "\n<tr><td class=\"num\"></td><td class=\"line\">" |
Ted Kremenek | 33bd942 | 2008-03-31 23:30:12 +0000 | [diff] [blame] | 248 | << "<div id=\""; |
| 249 | |
| 250 | if (num == max) |
| 251 | os << "EndPath"; |
| 252 | else |
| 253 | os << "Path" << num; |
| 254 | |
| 255 | os << "\" class=\"msg\" style=\"margin-left:" |
Ted Kremenek | 2aa13b5 | 2008-03-31 21:40:14 +0000 | [diff] [blame] | 256 | << PosNo << "ex\">"; |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 257 | |
Ted Kremenek | 718ceb1 | 2008-04-02 21:04:20 +0000 | [diff] [blame] | 258 | if (max > 1) |
| 259 | os << "<span class=\"PathIndex\">[" << num << "]</span> "; |
| 260 | |
Ted Kremenek | 053ef59 | 2008-03-27 17:15:29 +0000 | [diff] [blame] | 261 | os << html::EscapeText(P.getString()) << "</div></td></tr>"; |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 262 | |
| 263 | // Insert the new html. |
| 264 | |
| 265 | const llvm::MemoryBuffer *Buf = SM.getBuffer(FileID); |
| 266 | const char* FileStart = Buf->getBufferStart(); |
| 267 | |
| 268 | R.InsertStrBefore(SourceLocation::getFileLoc(FileID, LineStart - FileStart), |
| 269 | os.str()); |
| 270 | |
| 271 | // Now highlight the ranges. |
| 272 | |
| 273 | for (const SourceRange *I = P.ranges_begin(), *E = P.ranges_end(); |
| 274 | I != E; ++I) |
| 275 | HighlightRange(R, *I, MainFileID); |
| 276 | } |
| 277 | |
| 278 | void HTMLDiagnostics::HighlightRange(Rewriter& R, SourceRange Range, |
| 279 | unsigned MainFileID) { |
| 280 | |
| 281 | SourceManager& SourceMgr = R.getSourceMgr(); |
| 282 | |
| 283 | SourceLocation LogicalStart = SourceMgr.getLogicalLoc(Range.getBegin()); |
| 284 | unsigned StartLineNo = SourceMgr.getLineNumber(LogicalStart); |
| 285 | |
| 286 | SourceLocation LogicalEnd = SourceMgr.getLogicalLoc(Range.getEnd()); |
| 287 | unsigned EndLineNo = SourceMgr.getLineNumber(LogicalEnd); |
| 288 | |
| 289 | if (EndLineNo < StartLineNo) |
| 290 | return; |
| 291 | |
| 292 | if (LogicalStart.getFileID() != MainFileID || |
| 293 | LogicalEnd.getFileID() != MainFileID) |
| 294 | return; |
| 295 | |
| 296 | // Compute the column number of the end. |
| 297 | unsigned EndColNo = SourceMgr.getColumnNumber(LogicalEnd); |
| 298 | unsigned OldEndColNo = EndColNo; |
| 299 | |
| 300 | if (EndColNo) { |
| 301 | // Add in the length of the token, so that we cover multi-char tokens. |
| 302 | EndColNo += Lexer::MeasureTokenLength(Range.getEnd(), SourceMgr); |
| 303 | } |
| 304 | |
| 305 | // Highlight the range. Make the span tag the outermost tag for the |
| 306 | // selected range. |
| 307 | |
| 308 | SourceLocation E = |
| 309 | LogicalEnd.getFileLocWithOffset(OldEndColNo > EndColNo |
| 310 | ? -(OldEndColNo - EndColNo) |
| 311 | : EndColNo - OldEndColNo); |
| 312 | |
| 313 | R.InsertCStrBefore(LogicalStart, "<span class=\"mrange\">"); |
| 314 | R.InsertCStrAfter(E, "</span>"); |
Ted Kremenek | dab4ead | 2008-04-08 21:29:14 +0000 | [diff] [blame^] | 315 | |
| 316 | if (EndLineNo == StartLineNo) |
| 317 | return; |
| 318 | |
| 319 | // Add in </span><span> tags for intermediate lines. |
| 320 | |
| 321 | const llvm::MemoryBuffer *Buf = R.getSourceMgr().getBuffer(MainFileID); |
| 322 | |
| 323 | unsigned Pos = SourceMgr.getFullFilePos(LogicalStart); |
| 324 | unsigned EndPos = SourceMgr.getFullFilePos(E); |
| 325 | const char* buf = Buf->getBufferStart(); |
| 326 | |
| 327 | for (; Pos != EndPos; ++Pos) { |
| 328 | |
| 329 | SourceLocation L = SourceLocation::getFileLoc(MainFileID, Pos); |
| 330 | unsigned Col = SourceMgr.getColumnNumber(L); |
| 331 | |
| 332 | if (Col == 1) { |
| 333 | |
| 334 | // Start if a new line. Scan to see if we hit anything that is not |
| 335 | // whitespace or a newline. |
| 336 | |
| 337 | unsigned PosTmp = Pos; |
| 338 | bool NewLine = false; |
| 339 | |
| 340 | for ( ; PosTmp != EndPos ; ++PosTmp) { |
| 341 | switch (buf[PosTmp]) { |
| 342 | case ' ': |
| 343 | case '\t': continue; |
| 344 | case '\n': |
| 345 | NewLine = true; |
| 346 | break; |
| 347 | default: |
| 348 | break; |
| 349 | } |
| 350 | |
| 351 | break; |
| 352 | } |
| 353 | |
| 354 | if (PosTmp == EndPos) |
| 355 | break; |
| 356 | |
| 357 | Pos = PosTmp; |
| 358 | |
| 359 | // Don't highlight a blank line. |
| 360 | if (NewLine) |
| 361 | continue; |
| 362 | |
| 363 | // This line contains text that we should highlight. |
| 364 | // Ignore leading whitespace. |
| 365 | L = SourceLocation::getFileLoc(MainFileID, Pos); |
| 366 | R.InsertCStrAfter(L, "<span class=\"mrange\">"); |
| 367 | } |
| 368 | else if (buf[Pos] == '\n') |
| 369 | R.InsertCStrBefore(L, "</span>"); |
| 370 | } |
Ted Kremenek | 88f5cde | 2008-03-27 06:17:42 +0000 | [diff] [blame] | 371 | } |