1 //===--- PlistDiagnostics.cpp - Plist Diagnostics for Paths -----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the PlistDiagnostics object.
12 //===----------------------------------------------------------------------===//
14 #include "clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h"
15 #include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h"
16 #include "clang/Basic/SourceManager.h"
17 #include "clang/Basic/FileManager.h"
18 #include "clang/Lex/Preprocessor.h"
19 #include "llvm/Support/raw_ostream.h"
20 #include "llvm/Support/Casting.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/ADT/SmallVector.h"
23 using namespace clang;
26 typedef llvm::DenseMap<FileID, unsigned> FIDMap;
30 class PlistDiagnostics : public PathDiagnosticConsumer {
31 const std::string OutputFile;
32 const LangOptions &LangOpts;
33 const bool SupportsCrossFileDiagnostics;
35 PlistDiagnostics(const std::string& prefix, const LangOptions &LangOpts,
36 bool supportsMultipleFiles);
38 virtual ~PlistDiagnostics() {}
40 void FlushDiagnosticsImpl(std::vector<const PathDiagnostic *> &Diags,
41 FilesMade *filesMade);
43 virtual StringRef getName() const {
44 return "PlistDiagnostics";
47 PathGenerationScheme getGenerationScheme() const { return Extensive; }
48 bool supportsLogicalOpControlFlow() const { return true; }
49 bool supportsAllBlockEdges() const { return true; }
50 virtual bool useVerboseDescription() const { return false; }
51 virtual bool supportsCrossFileDiagnostics() const {
52 return SupportsCrossFileDiagnostics;
55 } // end anonymous namespace
57 PlistDiagnostics::PlistDiagnostics(const std::string& output,
58 const LangOptions &LO,
59 bool supportsMultipleFiles)
60 : OutputFile(output), LangOpts(LO),
61 SupportsCrossFileDiagnostics(supportsMultipleFiles) {}
63 void ento::createPlistDiagnosticConsumer(PathDiagnosticConsumers &C,
65 const Preprocessor &PP) {
66 C.push_back(new PlistDiagnostics(s, PP.getLangOpts(), false));
69 void ento::createPlistMultiFileDiagnosticConsumer(PathDiagnosticConsumers &C,
71 const Preprocessor &PP) {
72 C.push_back(new PlistDiagnostics(s, PP.getLangOpts(), true));
75 static void AddFID(FIDMap &FIDs, SmallVectorImpl<FileID> &V,
76 const SourceManager* SM, SourceLocation L) {
78 FileID FID = SM->getFileID(SM->getExpansionLoc(L));
79 FIDMap::iterator I = FIDs.find(FID);
80 if (I != FIDs.end()) return;
85 static unsigned GetFID(const FIDMap& FIDs, const SourceManager &SM,
87 FileID FID = SM.getFileID(SM.getExpansionLoc(L));
88 FIDMap::const_iterator I = FIDs.find(FID);
89 assert(I != FIDs.end());
93 static raw_ostream &Indent(raw_ostream &o, const unsigned indent) {
94 for (unsigned i = 0; i < indent; ++i) o << ' ';
98 static void EmitLocation(raw_ostream &o, const SourceManager &SM,
99 const LangOptions &LangOpts,
100 SourceLocation L, const FIDMap &FM,
101 unsigned indent, bool extend = false) {
103 FullSourceLoc Loc(SM.getExpansionLoc(L), const_cast<SourceManager&>(SM));
105 // Add in the length of the token, so that we cover multi-char tokens.
107 extend ? Lexer::MeasureTokenLength(Loc, SM, LangOpts) - 1 : 0;
109 Indent(o, indent) << "<dict>\n";
110 Indent(o, indent) << " <key>line</key><integer>"
111 << Loc.getExpansionLineNumber() << "</integer>\n";
112 Indent(o, indent) << " <key>col</key><integer>"
113 << Loc.getExpansionColumnNumber() + offset << "</integer>\n";
114 Indent(o, indent) << " <key>file</key><integer>"
115 << GetFID(FM, SM, Loc) << "</integer>\n";
116 Indent(o, indent) << "</dict>\n";
119 static void EmitLocation(raw_ostream &o, const SourceManager &SM,
120 const LangOptions &LangOpts,
121 const PathDiagnosticLocation &L, const FIDMap& FM,
122 unsigned indent, bool extend = false) {
123 EmitLocation(o, SM, LangOpts, L.asLocation(), FM, indent, extend);
126 static void EmitRange(raw_ostream &o, const SourceManager &SM,
127 const LangOptions &LangOpts,
128 PathDiagnosticRange R, const FIDMap &FM,
130 Indent(o, indent) << "<array>\n";
131 EmitLocation(o, SM, LangOpts, R.getBegin(), FM, indent+1);
132 EmitLocation(o, SM, LangOpts, R.getEnd(), FM, indent+1, !R.isPoint);
133 Indent(o, indent) << "</array>\n";
136 static raw_ostream &EmitString(raw_ostream &o, StringRef s) {
138 for (StringRef::const_iterator I = s.begin(), E = s.end(); I != E; ++I) {
141 default: o << c; break;
142 case '&': o << "&"; break;
143 case '<': o << "<"; break;
144 case '>': o << ">"; break;
145 case '\'': o << "'"; break;
146 case '\"': o << """; break;
153 static void ReportControlFlow(raw_ostream &o,
154 const PathDiagnosticControlFlowPiece& P,
156 const SourceManager &SM,
157 const LangOptions &LangOpts,
160 Indent(o, indent) << "<dict>\n";
163 Indent(o, indent) << "<key>kind</key><string>control</string>\n";
166 Indent(o, indent) << "<key>edges</key>\n";
168 Indent(o, indent) << "<array>\n";
170 for (PathDiagnosticControlFlowPiece::const_iterator I=P.begin(), E=P.end();
172 Indent(o, indent) << "<dict>\n";
175 // Make the ranges of the start and end point self-consistent with adjacent edges
176 // by forcing to use only the beginning of the range. This simplifies the layout
177 // logic for clients.
178 Indent(o, indent) << "<key>start</key>\n";
179 SourceLocation StartEdge = I->getStart().asRange().getBegin();
180 EmitRange(o, SM, LangOpts, SourceRange(StartEdge, StartEdge), FM, indent+1);
182 Indent(o, indent) << "<key>end</key>\n";
183 SourceLocation EndEdge = I->getEnd().asRange().getBegin();
184 EmitRange(o, SM, LangOpts, SourceRange(EndEdge, EndEdge), FM, indent+1);
187 Indent(o, indent) << "</dict>\n";
190 Indent(o, indent) << "</array>\n";
193 // Output any helper text.
194 const std::string& s = P.getString();
196 Indent(o, indent) << "<key>alternate</key>";
197 EmitString(o, s) << '\n';
201 Indent(o, indent) << "</dict>\n";
204 static void ReportEvent(raw_ostream &o, const PathDiagnosticPiece& P,
206 const SourceManager &SM,
207 const LangOptions &LangOpts,
211 Indent(o, indent) << "<dict>\n";
214 Indent(o, indent) << "<key>kind</key><string>event</string>\n";
216 // Output the location.
217 FullSourceLoc L = P.getLocation().asLocation();
219 Indent(o, indent) << "<key>location</key>\n";
220 EmitLocation(o, SM, LangOpts, L, FM, indent);
222 // Output the ranges (if any).
223 ArrayRef<SourceRange> Ranges = P.getRanges();
225 if (!Ranges.empty()) {
226 Indent(o, indent) << "<key>ranges</key>\n";
227 Indent(o, indent) << "<array>\n";
229 for (ArrayRef<SourceRange>::iterator I = Ranges.begin(), E = Ranges.end();
231 EmitRange(o, SM, LangOpts, *I, FM, indent+1);
234 Indent(o, indent) << "</array>\n";
237 // Output the call depth.
238 Indent(o, indent) << "<key>depth</key>"
239 << "<integer>" << depth << "</integer>\n";
242 assert(!P.getString().empty());
243 Indent(o, indent) << "<key>extended_message</key>\n";
245 EmitString(o, P.getString()) << '\n';
247 // Output the short text.
248 // FIXME: Really use a short string.
249 Indent(o, indent) << "<key>message</key>\n";
250 EmitString(o, P.getString()) << '\n';
254 Indent(o, indent); o << "</dict>\n";
257 static void ReportPiece(raw_ostream &o,
258 const PathDiagnosticPiece &P,
259 const FIDMap& FM, const SourceManager &SM,
260 const LangOptions &LangOpts,
263 bool includeControlFlow);
265 static void ReportCall(raw_ostream &o,
266 const PathDiagnosticCallPiece &P,
267 const FIDMap& FM, const SourceManager &SM,
268 const LangOptions &LangOpts,
272 IntrusiveRefCntPtr<PathDiagnosticEventPiece> callEnter =
273 P.getCallEnterEvent();
276 ReportPiece(o, *callEnter, FM, SM, LangOpts, indent, depth, true);
278 IntrusiveRefCntPtr<PathDiagnosticEventPiece> callEnterWithinCaller =
279 P.getCallEnterWithinCallerEvent();
283 if (callEnterWithinCaller)
284 ReportPiece(o, *callEnterWithinCaller, FM, SM, LangOpts,
285 indent, depth, true);
287 for (PathPieces::const_iterator I = P.path.begin(), E = P.path.end();I!=E;++I)
288 ReportPiece(o, **I, FM, SM, LangOpts, indent, depth, true);
290 IntrusiveRefCntPtr<PathDiagnosticEventPiece> callExit =
291 P.getCallExitEvent();
294 ReportPiece(o, *callExit, FM, SM, LangOpts, indent, depth, true);
297 static void ReportMacro(raw_ostream &o,
298 const PathDiagnosticMacroPiece& P,
299 const FIDMap& FM, const SourceManager &SM,
300 const LangOptions &LangOpts,
304 for (PathPieces::const_iterator I = P.subPieces.begin(), E=P.subPieces.end();
306 ReportPiece(o, **I, FM, SM, LangOpts, indent, depth, false);
310 static void ReportDiag(raw_ostream &o, const PathDiagnosticPiece& P,
311 const FIDMap& FM, const SourceManager &SM,
312 const LangOptions &LangOpts) {
313 ReportPiece(o, P, FM, SM, LangOpts, 4, 0, true);
316 static void ReportPiece(raw_ostream &o,
317 const PathDiagnosticPiece &P,
318 const FIDMap& FM, const SourceManager &SM,
319 const LangOptions &LangOpts,
322 bool includeControlFlow) {
323 switch (P.getKind()) {
324 case PathDiagnosticPiece::ControlFlow:
325 if (includeControlFlow)
326 ReportControlFlow(o, cast<PathDiagnosticControlFlowPiece>(P), FM, SM,
329 case PathDiagnosticPiece::Call:
330 ReportCall(o, cast<PathDiagnosticCallPiece>(P), FM, SM, LangOpts,
333 case PathDiagnosticPiece::Event:
334 ReportEvent(o, cast<PathDiagnosticSpotPiece>(P), FM, SM, LangOpts,
337 case PathDiagnosticPiece::Macro:
338 ReportMacro(o, cast<PathDiagnosticMacroPiece>(P), FM, SM, LangOpts,
344 void PlistDiagnostics::FlushDiagnosticsImpl(
345 std::vector<const PathDiagnostic *> &Diags,
346 FilesMade *filesMade) {
347 // Build up a set of FIDs that we use by scanning the locations and
348 // ranges of the diagnostics.
350 SmallVector<FileID, 10> Fids;
351 const SourceManager* SM = 0;
354 SM = &(*(*Diags.begin())->path.begin())->getLocation().getManager();
357 for (std::vector<const PathDiagnostic*>::iterator DI = Diags.begin(),
358 DE = Diags.end(); DI != DE; ++DI) {
360 const PathDiagnostic *D = *DI;
362 llvm::SmallVector<const PathPieces *, 5> WorkList;
363 WorkList.push_back(&D->path);
365 while (!WorkList.empty()) {
366 const PathPieces &path = *WorkList.back();
369 for (PathPieces::const_iterator I = path.begin(), E = path.end();
371 const PathDiagnosticPiece *piece = I->getPtr();
372 AddFID(FM, Fids, SM, piece->getLocation().asLocation());
373 ArrayRef<SourceRange> Ranges = piece->getRanges();
374 for (ArrayRef<SourceRange>::iterator I = Ranges.begin(),
375 E = Ranges.end(); I != E; ++I) {
376 AddFID(FM, Fids, SM, I->getBegin());
377 AddFID(FM, Fids, SM, I->getEnd());
380 if (const PathDiagnosticCallPiece *call =
381 dyn_cast<PathDiagnosticCallPiece>(piece)) {
382 IntrusiveRefCntPtr<PathDiagnosticEventPiece>
383 callEnterWithin = call->getCallEnterWithinCallerEvent();
385 AddFID(FM, Fids, SM, callEnterWithin->getLocation().asLocation());
387 WorkList.push_back(&call->path);
389 else if (const PathDiagnosticMacroPiece *macro =
390 dyn_cast<PathDiagnosticMacroPiece>(piece)) {
391 WorkList.push_back(¯o->subPieces);
399 llvm::raw_fd_ostream o(OutputFile.c_str(), ErrMsg);
400 if (!ErrMsg.empty()) {
401 llvm::errs() << "warning: could not create file: " << OutputFile << '\n';
405 // Write the plist header.
406 o << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
407 "<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" "
408 "\"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
409 "<plist version=\"1.0\">\n";
411 // Write the root object: a <dict> containing...
412 // - "files", an <array> mapping from FIDs to file names
413 // - "diagnostics", an <array> containing the path diagnostics
415 " <key>files</key>\n"
418 for (SmallVectorImpl<FileID>::iterator I=Fids.begin(), E=Fids.end();
421 EmitString(o, SM->getFileEntryForID(*I)->getName()) << '\n';
425 " <key>diagnostics</key>\n"
428 for (std::vector<const PathDiagnostic*>::iterator DI=Diags.begin(),
429 DE = Diags.end(); DI!=DE; ++DI) {
432 " <key>path</key>\n";
434 const PathDiagnostic *D = *DI;
438 for (PathPieces::const_iterator I = D->path.begin(), E = D->path.end();
440 ReportDiag(o, **I, FM, *SM, LangOpts);
444 // Output the bug type and bug category.
445 o << " <key>description</key>";
446 EmitString(o, D->getDescription()) << '\n';
447 o << " <key>category</key>";
448 EmitString(o, D->getCategory()) << '\n';
449 o << " <key>type</key>";
450 EmitString(o, D->getBugType()) << '\n';
452 // Output information about the semantic context where
453 // the issue occurred.
454 if (const Decl *DeclWithIssue = D->getDeclWithIssue()) {
455 // FIXME: handle blocks, which have no name.
456 if (const NamedDecl *ND = dyn_cast<NamedDecl>(DeclWithIssue)) {
458 switch (ND->getKind()) {
459 case Decl::CXXRecord:
460 declKind = "C++ class";
462 case Decl::CXXMethod:
463 declKind = "C++ method";
465 case Decl::ObjCMethod:
466 declKind = "Objective-C method";
469 declKind = "function";
474 if (!declKind.empty()) {
475 const std::string &declName = ND->getDeclName().getAsString();
476 o << " <key>issue_context_kind</key>";
477 EmitString(o, declKind) << '\n';
478 o << " <key>issue_context</key>";
479 EmitString(o, declName) << '\n';
482 // Output the bug hash for issue unique-ing. Currently, it's just an
483 // offset from the beginning of the function.
484 if (const Stmt *Body = DeclWithIssue->getBody()) {
485 FullSourceLoc Loc(SM->getExpansionLoc(D->getLocation().asLocation()),
487 FullSourceLoc FunLoc(SM->getExpansionLoc(Body->getLocStart()), *SM);
488 o << " <key>issue_hash</key><integer>"
489 << Loc.getExpansionLineNumber() - FunLoc.getExpansionLineNumber()
495 // Output the location of the bug.
496 o << " <key>location</key>\n";
497 EmitLocation(o, *SM, LangOpts, D->getLocation(), FM, 2);
499 // Output the diagnostic to the sub-diagnostic client, if any.
500 if (!filesMade->empty()) {
502 for (FilesMade::iterator I = filesMade->begin(), E = filesMade->end();
504 StringRef newName = I->first;
505 if (newName != lastName) {
506 if (!lastName.empty())
509 o << " <key>" << lastName << "_files</key>\n";
512 o << " <string>" << I->second << "</string>\n";
517 // Close up the entry.
524 o << "</dict>\n</plist>";
527 StringRef Name(getName());
528 filesMade->push_back(std::make_pair(Name, OutputFile));