Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 1 | //===--- PlistDiagnostics.cpp - Plist 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 PlistDiagnostics object. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
Daniel Dunbar | 9b414d3 | 2010-06-15 17:48:49 +0000 | [diff] [blame] | 14 | #include "clang/Checker/PathDiagnosticClients.h" |
Ted Kremenek | 6b67630 | 2010-01-25 17:10:22 +0000 | [diff] [blame] | 15 | #include "clang/Checker/BugReporter/PathDiagnostic.h" |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 16 | #include "clang/Basic/SourceManager.h" |
| 17 | #include "clang/Basic/FileManager.h" |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 18 | #include "clang/Lex/Preprocessor.h" |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 19 | #include "llvm/Support/raw_ostream.h" |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 20 | #include "llvm/Support/Casting.h" |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 21 | #include "llvm/ADT/DenseMap.h" |
| 22 | #include "llvm/ADT/SmallVector.h" |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 23 | using namespace clang; |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 24 | using llvm::cast; |
Chris Lattner | 2b2453a | 2009-01-17 06:22:33 +0000 | [diff] [blame] | 25 | |
| 26 | typedef llvm::DenseMap<FileID, unsigned> FIDMap; |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 27 | |
Ted Kremenek | 4fc82c8 | 2008-11-03 23:18:07 +0000 | [diff] [blame] | 28 | namespace clang { |
| 29 | class Preprocessor; |
Ted Kremenek | 4fc82c8 | 2008-11-03 23:18:07 +0000 | [diff] [blame] | 30 | } |
| 31 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 32 | namespace { |
Ted Kremenek | f722770 | 2009-12-03 19:35:02 +0000 | [diff] [blame] | 33 | struct CompareDiagnostics { |
| 34 | // Compare if 'X' is "<" than 'Y'. |
| 35 | bool operator()(const PathDiagnostic *X, const PathDiagnostic *Y) const { |
| 36 | // First compare by location |
| 37 | const FullSourceLoc &XLoc = X->getLocation().asLocation(); |
| 38 | const FullSourceLoc &YLoc = Y->getLocation().asLocation(); |
| 39 | if (XLoc < YLoc) |
| 40 | return true; |
| 41 | if (XLoc != YLoc) |
| 42 | return false; |
| 43 | |
| 44 | // Next, compare by bug type. |
| 45 | llvm::StringRef XBugType = X->getBugType(); |
| 46 | llvm::StringRef YBugType = Y->getBugType(); |
| 47 | if (XBugType < YBugType) |
| 48 | return true; |
| 49 | if (XBugType != YBugType) |
| 50 | return false; |
| 51 | |
| 52 | // Next, compare by bug description. |
| 53 | llvm::StringRef XDesc = X->getDescription(); |
| 54 | llvm::StringRef YDesc = Y->getDescription(); |
| 55 | if (XDesc < YDesc) |
| 56 | return true; |
| 57 | if (XDesc != YDesc) |
| 58 | return false; |
| 59 | |
| 60 | // FIXME: Further refine by comparing PathDiagnosticPieces? |
| 61 | return false; |
| 62 | } |
| 63 | }; |
| 64 | } |
| 65 | |
| 66 | namespace { |
Benjamin Kramer | bd21828 | 2009-11-28 10:07:24 +0000 | [diff] [blame] | 67 | class PlistDiagnostics : public PathDiagnosticClient { |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 68 | std::vector<const PathDiagnostic*> BatchedDiags; |
| 69 | const std::string OutputFile; |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 70 | const LangOptions &LangOpts; |
Ted Kremenek | b697a4e | 2009-11-05 02:09:23 +0000 | [diff] [blame] | 71 | llvm::OwningPtr<PathDiagnosticClient> SubPD; |
Ted Kremenek | 179ce89 | 2009-11-13 03:14:14 +0000 | [diff] [blame] | 72 | bool flushed; |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 73 | public: |
Ted Kremenek | f755606 | 2009-07-27 22:13:39 +0000 | [diff] [blame] | 74 | PlistDiagnostics(const std::string& prefix, const LangOptions &LangOpts, |
Ted Kremenek | b697a4e | 2009-11-05 02:09:23 +0000 | [diff] [blame] | 75 | PathDiagnosticClient *subPD); |
| 76 | |
| 77 | ~PlistDiagnostics() { FlushDiagnostics(NULL); } |
| 78 | |
| 79 | void FlushDiagnostics(llvm::SmallVectorImpl<std::string> *FilesMade); |
| 80 | |
Ted Kremenek | babdd7b | 2009-03-27 05:06:10 +0000 | [diff] [blame] | 81 | void HandlePathDiagnostic(const PathDiagnostic* D); |
Ted Kremenek | b697a4e | 2009-11-05 02:09:23 +0000 | [diff] [blame] | 82 | |
| 83 | virtual llvm::StringRef getName() const { |
| 84 | return "PlistDiagnostics"; |
| 85 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 86 | |
Ted Kremenek | f755606 | 2009-07-27 22:13:39 +0000 | [diff] [blame] | 87 | PathGenerationScheme getGenerationScheme() const; |
Ted Kremenek | babdd7b | 2009-03-27 05:06:10 +0000 | [diff] [blame] | 88 | bool supportsLogicalOpControlFlow() const { return true; } |
Ted Kremenek | 7dc8664 | 2009-03-31 20:22:36 +0000 | [diff] [blame] | 89 | bool supportsAllBlockEdges() const { return true; } |
Ted Kremenek | d49967f | 2009-04-29 21:58:13 +0000 | [diff] [blame] | 90 | virtual bool useVerboseDescription() const { return false; } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 91 | }; |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 92 | } // end anonymous namespace |
| 93 | |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 94 | PlistDiagnostics::PlistDiagnostics(const std::string& output, |
Ted Kremenek | f755606 | 2009-07-27 22:13:39 +0000 | [diff] [blame] | 95 | const LangOptions &LO, |
Ted Kremenek | b697a4e | 2009-11-05 02:09:23 +0000 | [diff] [blame] | 96 | PathDiagnosticClient *subPD) |
Ted Kremenek | 179ce89 | 2009-11-13 03:14:14 +0000 | [diff] [blame] | 97 | : OutputFile(output), LangOpts(LO), SubPD(subPD), flushed(false) {} |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 98 | |
Ted Kremenek | 4fc82c8 | 2008-11-03 23:18:07 +0000 | [diff] [blame] | 99 | PathDiagnosticClient* |
Daniel Dunbar | efceabd | 2009-11-05 02:41:58 +0000 | [diff] [blame] | 100 | clang::CreatePlistDiagnosticClient(const std::string& s, const Preprocessor &PP, |
Ted Kremenek | b697a4e | 2009-11-05 02:09:23 +0000 | [diff] [blame] | 101 | PathDiagnosticClient *subPD) { |
Daniel Dunbar | efceabd | 2009-11-05 02:41:58 +0000 | [diff] [blame] | 102 | return new PlistDiagnostics(s, PP.getLangOptions(), subPD); |
Ted Kremenek | f755606 | 2009-07-27 22:13:39 +0000 | [diff] [blame] | 103 | } |
| 104 | |
| 105 | PathDiagnosticClient::PathGenerationScheme |
| 106 | PlistDiagnostics::getGenerationScheme() const { |
Ted Kremenek | b697a4e | 2009-11-05 02:09:23 +0000 | [diff] [blame] | 107 | if (const PathDiagnosticClient *PD = SubPD.get()) |
Ted Kremenek | f755606 | 2009-07-27 22:13:39 +0000 | [diff] [blame] | 108 | return PD->getGenerationScheme(); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 109 | |
Ted Kremenek | f755606 | 2009-07-27 22:13:39 +0000 | [diff] [blame] | 110 | return Extensive; |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 111 | } |
| 112 | |
Chris Lattner | a11d617 | 2009-01-19 07:46:45 +0000 | [diff] [blame] | 113 | static void AddFID(FIDMap &FIDs, llvm::SmallVectorImpl<FileID> &V, |
Ted Kremenek | 5fb5dfb | 2009-04-01 06:13:56 +0000 | [diff] [blame] | 114 | const SourceManager* SM, SourceLocation L) { |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 115 | |
Ted Kremenek | c472d79 | 2009-01-23 20:06:20 +0000 | [diff] [blame] | 116 | FileID FID = SM->getFileID(SM->getInstantiationLoc(L)); |
Chris Lattner | 2b2453a | 2009-01-17 06:22:33 +0000 | [diff] [blame] | 117 | FIDMap::iterator I = FIDs.find(FID); |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 118 | if (I != FIDs.end()) return; |
Chris Lattner | 2b2453a | 2009-01-17 06:22:33 +0000 | [diff] [blame] | 119 | FIDs[FID] = V.size(); |
| 120 | V.push_back(FID); |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 121 | } |
| 122 | |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 123 | static unsigned GetFID(const FIDMap& FIDs, const SourceManager &SM, |
Ted Kremenek | 5fb5dfb | 2009-04-01 06:13:56 +0000 | [diff] [blame] | 124 | SourceLocation L) { |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 125 | FileID FID = SM.getFileID(SM.getInstantiationLoc(L)); |
Chris Lattner | 2b2453a | 2009-01-17 06:22:33 +0000 | [diff] [blame] | 126 | FIDMap::const_iterator I = FIDs.find(FID); |
| 127 | assert(I != FIDs.end()); |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 128 | return I->second; |
| 129 | } |
| 130 | |
| 131 | static llvm::raw_ostream& Indent(llvm::raw_ostream& o, const unsigned indent) { |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 132 | for (unsigned i = 0; i < indent; ++i) o << ' '; |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 133 | return o; |
| 134 | } |
| 135 | |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 136 | static void EmitLocation(llvm::raw_ostream& o, const SourceManager &SM, |
| 137 | const LangOptions &LangOpts, |
| 138 | SourceLocation L, const FIDMap &FM, |
| 139 | unsigned indent, bool extend = false) { |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 140 | |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 141 | FullSourceLoc Loc(SM.getInstantiationLoc(L), const_cast<SourceManager&>(SM)); |
Ted Kremenek | f076339 | 2009-04-05 02:08:28 +0000 | [diff] [blame] | 142 | |
| 143 | // Add in the length of the token, so that we cover multi-char tokens. |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 144 | unsigned offset = |
| 145 | extend ? Lexer::MeasureTokenLength(Loc, SM, LangOpts) - 1 : 0; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 146 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 147 | Indent(o, indent) << "<dict>\n"; |
| 148 | Indent(o, indent) << " <key>line</key><integer>" |
Ted Kremenek | f076339 | 2009-04-05 02:08:28 +0000 | [diff] [blame] | 149 | << Loc.getInstantiationLineNumber() << "</integer>\n"; |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 150 | Indent(o, indent) << " <key>col</key><integer>" |
Ted Kremenek | f076339 | 2009-04-05 02:08:28 +0000 | [diff] [blame] | 151 | << Loc.getInstantiationColumnNumber() + offset << "</integer>\n"; |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 152 | Indent(o, indent) << " <key>file</key><integer>" |
Ted Kremenek | f076339 | 2009-04-05 02:08:28 +0000 | [diff] [blame] | 153 | << GetFID(FM, SM, Loc) << "</integer>\n"; |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 154 | Indent(o, indent) << "</dict>\n"; |
| 155 | } |
| 156 | |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 157 | static void EmitLocation(llvm::raw_ostream& o, const SourceManager &SM, |
| 158 | const LangOptions &LangOpts, |
Ted Kremenek | 5fb5dfb | 2009-04-01 06:13:56 +0000 | [diff] [blame] | 159 | const PathDiagnosticLocation &L, const FIDMap& FM, |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 160 | unsigned indent, bool extend = false) { |
| 161 | EmitLocation(o, SM, LangOpts, L.asLocation(), FM, indent, extend); |
Ted Kremenek | 5fb5dfb | 2009-04-01 06:13:56 +0000 | [diff] [blame] | 162 | } |
| 163 | |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 164 | static void EmitRange(llvm::raw_ostream& o, const SourceManager &SM, |
| 165 | const LangOptions &LangOpts, |
Ted Kremenek | 4c5fcd9 | 2009-04-22 22:26:10 +0000 | [diff] [blame] | 166 | PathDiagnosticRange R, const FIDMap &FM, |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 167 | unsigned indent) { |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 168 | Indent(o, indent) << "<array>\n"; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 169 | EmitLocation(o, SM, LangOpts, R.getBegin(), FM, indent+1); |
Ted Kremenek | 4c5fcd9 | 2009-04-22 22:26:10 +0000 | [diff] [blame] | 170 | EmitLocation(o, SM, LangOpts, R.getEnd(), FM, indent+1, !R.isPoint); |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 171 | Indent(o, indent) << "</array>\n"; |
| 172 | } |
| 173 | |
Ted Kremenek | b0b6f72 | 2009-03-28 06:40:54 +0000 | [diff] [blame] | 174 | static llvm::raw_ostream& EmitString(llvm::raw_ostream& o, |
| 175 | const std::string& s) { |
| 176 | o << "<string>"; |
| 177 | for (std::string::const_iterator I=s.begin(), E=s.end(); I!=E; ++I) { |
| 178 | char c = *I; |
| 179 | switch (c) { |
Mike Stump | b716633 | 2010-01-20 02:03:14 +0000 | [diff] [blame] | 180 | default: o << c; break; |
| 181 | case '&': o << "&"; break; |
| 182 | case '<': o << "<"; break; |
| 183 | case '>': o << ">"; break; |
| 184 | case '\'': o << "'"; break; |
| 185 | case '\"': o << """; break; |
Ted Kremenek | b0b6f72 | 2009-03-28 06:40:54 +0000 | [diff] [blame] | 186 | } |
| 187 | } |
| 188 | o << "</string>"; |
| 189 | return o; |
| 190 | } |
| 191 | |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 192 | static void ReportControlFlow(llvm::raw_ostream& o, |
| 193 | const PathDiagnosticControlFlowPiece& P, |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 194 | const FIDMap& FM, |
| 195 | const SourceManager &SM, |
| 196 | const LangOptions &LangOpts, |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 197 | unsigned indent) { |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 198 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 199 | Indent(o, indent) << "<dict>\n"; |
| 200 | ++indent; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 201 | |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 202 | Indent(o, indent) << "<key>kind</key><string>control</string>\n"; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 203 | |
Ted Kremenek | f48fbc6 | 2009-03-27 15:53:20 +0000 | [diff] [blame] | 204 | // Emit edges. |
| 205 | Indent(o, indent) << "<key>edges</key>\n"; |
| 206 | ++indent; |
| 207 | Indent(o, indent) << "<array>\n"; |
| 208 | ++indent; |
| 209 | for (PathDiagnosticControlFlowPiece::const_iterator I=P.begin(), E=P.end(); |
| 210 | I!=E; ++I) { |
| 211 | Indent(o, indent) << "<dict>\n"; |
| 212 | ++indent; |
| 213 | Indent(o, indent) << "<key>start</key>\n"; |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 214 | EmitRange(o, SM, LangOpts, I->getStart().asRange(), FM, indent+1); |
Ted Kremenek | f48fbc6 | 2009-03-27 15:53:20 +0000 | [diff] [blame] | 215 | Indent(o, indent) << "<key>end</key>\n"; |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 216 | EmitRange(o, SM, LangOpts, I->getEnd().asRange(), FM, indent+1); |
Ted Kremenek | f48fbc6 | 2009-03-27 15:53:20 +0000 | [diff] [blame] | 217 | --indent; |
| 218 | Indent(o, indent) << "</dict>\n"; |
| 219 | } |
| 220 | --indent; |
| 221 | Indent(o, indent) << "</array>\n"; |
| 222 | --indent; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 223 | |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 224 | // Output any helper text. |
| 225 | const std::string& s = P.getString(); |
| 226 | if (!s.empty()) { |
Ted Kremenek | b0b6f72 | 2009-03-28 06:40:54 +0000 | [diff] [blame] | 227 | Indent(o, indent) << "<key>alternate</key>"; |
| 228 | EmitString(o, s) << '\n'; |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 229 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 230 | |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 231 | --indent; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 232 | Indent(o, indent) << "</dict>\n"; |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 233 | } |
| 234 | |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 235 | static void ReportEvent(llvm::raw_ostream& o, const PathDiagnosticPiece& P, |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 236 | const FIDMap& FM, |
| 237 | const SourceManager &SM, |
| 238 | const LangOptions &LangOpts, |
Ted Kremenek | 5fb5dfb | 2009-04-01 06:13:56 +0000 | [diff] [blame] | 239 | unsigned indent) { |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 240 | |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 241 | Indent(o, indent) << "<dict>\n"; |
| 242 | ++indent; |
| 243 | |
| 244 | Indent(o, indent) << "<key>kind</key><string>event</string>\n"; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 245 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 246 | // Output the location. |
Ted Kremenek | 5fb5dfb | 2009-04-01 06:13:56 +0000 | [diff] [blame] | 247 | FullSourceLoc L = P.getLocation().asLocation(); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 248 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 249 | Indent(o, indent) << "<key>location</key>\n"; |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 250 | EmitLocation(o, SM, LangOpts, L, FM, indent); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 251 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 252 | // Output the ranges (if any). |
| 253 | PathDiagnosticPiece::range_iterator RI = P.ranges_begin(), |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 254 | RE = P.ranges_end(); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 255 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 256 | if (RI != RE) { |
| 257 | Indent(o, indent) << "<key>ranges</key>\n"; |
| 258 | Indent(o, indent) << "<array>\n"; |
Ted Kremenek | d671c5a | 2009-02-02 21:45:32 +0000 | [diff] [blame] | 259 | ++indent; |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 260 | for (; RI != RE; ++RI) |
| 261 | EmitRange(o, SM, LangOpts, *RI, FM, indent+1); |
Ted Kremenek | d671c5a | 2009-02-02 21:45:32 +0000 | [diff] [blame] | 262 | --indent; |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 263 | Indent(o, indent) << "</array>\n"; |
| 264 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 265 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 266 | // Output the text. |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 267 | assert(!P.getString().empty()); |
Ted Kremenek | 61dc71a | 2009-03-19 00:42:56 +0000 | [diff] [blame] | 268 | Indent(o, indent) << "<key>extended_message</key>\n"; |
Ted Kremenek | b0b6f72 | 2009-03-28 06:40:54 +0000 | [diff] [blame] | 269 | Indent(o, indent); |
| 270 | EmitString(o, P.getString()) << '\n'; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 271 | |
Ted Kremenek | 61dc71a | 2009-03-19 00:42:56 +0000 | [diff] [blame] | 272 | // Output the short text. |
| 273 | // FIXME: Really use a short string. |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 274 | Indent(o, indent) << "<key>message</key>\n"; |
Ted Kremenek | b0b6f72 | 2009-03-28 06:40:54 +0000 | [diff] [blame] | 275 | EmitString(o, P.getString()) << '\n'; |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 276 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 277 | // Finish up. |
| 278 | --indent; |
| 279 | Indent(o, indent); o << "</dict>\n"; |
| 280 | } |
| 281 | |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 282 | static void ReportMacro(llvm::raw_ostream& o, |
| 283 | const PathDiagnosticMacroPiece& P, |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 284 | const FIDMap& FM, const SourceManager &SM, |
| 285 | const LangOptions &LangOpts, |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 286 | unsigned indent) { |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 287 | |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 288 | for (PathDiagnosticMacroPiece::const_iterator I=P.begin(), E=P.end(); |
| 289 | I!=E; ++I) { |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 290 | |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 291 | switch ((*I)->getKind()) { |
Mike Stump | b716633 | 2010-01-20 02:03:14 +0000 | [diff] [blame] | 292 | default: |
| 293 | break; |
| 294 | case PathDiagnosticPiece::Event: |
| 295 | ReportEvent(o, cast<PathDiagnosticEventPiece>(**I), FM, SM, LangOpts, |
| 296 | indent); |
| 297 | break; |
| 298 | case PathDiagnosticPiece::Macro: |
| 299 | ReportMacro(o, cast<PathDiagnosticMacroPiece>(**I), FM, SM, LangOpts, |
| 300 | indent); |
| 301 | break; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 302 | } |
| 303 | } |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 304 | } |
| 305 | |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 306 | static void ReportDiag(llvm::raw_ostream& o, const PathDiagnosticPiece& P, |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 307 | const FIDMap& FM, const SourceManager &SM, |
| 308 | const LangOptions &LangOpts) { |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 309 | |
| 310 | unsigned indent = 4; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 311 | |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 312 | switch (P.getKind()) { |
Mike Stump | b716633 | 2010-01-20 02:03:14 +0000 | [diff] [blame] | 313 | case PathDiagnosticPiece::ControlFlow: |
| 314 | ReportControlFlow(o, cast<PathDiagnosticControlFlowPiece>(P), FM, SM, |
| 315 | LangOpts, indent); |
| 316 | break; |
| 317 | case PathDiagnosticPiece::Event: |
| 318 | ReportEvent(o, cast<PathDiagnosticEventPiece>(P), FM, SM, LangOpts, |
| 319 | indent); |
| 320 | break; |
| 321 | case PathDiagnosticPiece::Macro: |
| 322 | ReportMacro(o, cast<PathDiagnosticMacroPiece>(P), FM, SM, LangOpts, |
| 323 | indent); |
| 324 | break; |
Ted Kremenek | 082cb8d | 2009-03-12 18:41:53 +0000 | [diff] [blame] | 325 | } |
| 326 | } |
| 327 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 328 | void PlistDiagnostics::HandlePathDiagnostic(const PathDiagnostic* D) { |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 329 | if (!D) |
| 330 | return; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 331 | |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 332 | if (D->empty()) { |
| 333 | delete D; |
| 334 | return; |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 335 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 336 | |
Ted Kremenek | 96a6926 | 2009-04-02 05:13:24 +0000 | [diff] [blame] | 337 | // We need to flatten the locations (convert Stmt* to locations) because |
| 338 | // the referenced statements may be freed by the time the diagnostics |
| 339 | // are emitted. |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 340 | const_cast<PathDiagnostic*>(D)->flattenLocations(); |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 341 | BatchedDiags.push_back(D); |
| 342 | } |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 343 | |
Ted Kremenek | b697a4e | 2009-11-05 02:09:23 +0000 | [diff] [blame] | 344 | void PlistDiagnostics::FlushDiagnostics(llvm::SmallVectorImpl<std::string> |
| 345 | *FilesMade) { |
Ted Kremenek | 179ce89 | 2009-11-13 03:14:14 +0000 | [diff] [blame] | 346 | |
| 347 | if (flushed) |
| 348 | return; |
| 349 | |
| 350 | flushed = true; |
Ted Kremenek | f722770 | 2009-12-03 19:35:02 +0000 | [diff] [blame] | 351 | |
| 352 | // Sort the diagnostics so that they are always emitted in a deterministic |
| 353 | // order. |
| 354 | if (!BatchedDiags.empty()) |
| 355 | std::sort(BatchedDiags.begin(), BatchedDiags.end(), CompareDiagnostics()); |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 356 | |
| 357 | // Build up a set of FIDs that we use by scanning the locations and |
| 358 | // ranges of the diagnostics. |
| 359 | FIDMap FM; |
Chris Lattner | 2b2453a | 2009-01-17 06:22:33 +0000 | [diff] [blame] | 360 | llvm::SmallVector<FileID, 10> Fids; |
Ted Kremenek | 5fb5dfb | 2009-04-01 06:13:56 +0000 | [diff] [blame] | 361 | const SourceManager* SM = 0; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 362 | |
| 363 | if (!BatchedDiags.empty()) |
Ted Kremenek | c472d79 | 2009-01-23 20:06:20 +0000 | [diff] [blame] | 364 | SM = &(*BatchedDiags.begin())->begin()->getLocation().getManager(); |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 365 | |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 366 | for (std::vector<const PathDiagnostic*>::iterator DI = BatchedDiags.begin(), |
| 367 | DE = BatchedDiags.end(); DI != DE; ++DI) { |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 368 | |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 369 | const PathDiagnostic *D = *DI; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 370 | |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 371 | for (PathDiagnostic::const_iterator I=D->begin(), E=D->end(); I!=E; ++I) { |
Ted Kremenek | 5fb5dfb | 2009-04-01 06:13:56 +0000 | [diff] [blame] | 372 | AddFID(FM, Fids, SM, I->getLocation().asLocation()); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 373 | |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 374 | for (PathDiagnosticPiece::range_iterator RI=I->ranges_begin(), |
| 375 | RE=I->ranges_end(); RI!=RE; ++RI) { |
| 376 | AddFID(FM, Fids, SM, RI->getBegin()); |
| 377 | AddFID(FM, Fids, SM, RI->getEnd()); |
| 378 | } |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 379 | } |
| 380 | } |
| 381 | |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 382 | // Open the file. |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 383 | std::string ErrMsg; |
Dan Gohman | b044c47 | 2009-08-25 15:36:09 +0000 | [diff] [blame] | 384 | llvm::raw_fd_ostream o(OutputFile.c_str(), ErrMsg); |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 385 | if (!ErrMsg.empty()) { |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 386 | llvm::errs() << "warning: could not creat file: " << OutputFile << '\n'; |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 387 | return; |
| 388 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 389 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 390 | // Write the plist header. |
| 391 | o << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 392 | "<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" " |
Daniel Dunbar | 3c41544 | 2009-07-29 01:10:25 +0000 | [diff] [blame] | 393 | "\"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n" |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 394 | "<plist version=\"1.0\">\n"; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 395 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 396 | // Write the root object: a <dict> containing... |
| 397 | // - "files", an <array> mapping from FIDs to file names |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 398 | // - "diagnostics", an <array> containing the path diagnostics |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 399 | o << "<dict>\n" |
| 400 | " <key>files</key>\n" |
| 401 | " <array>\n"; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 402 | |
Chris Lattner | 2b2453a | 2009-01-17 06:22:33 +0000 | [diff] [blame] | 403 | for (llvm::SmallVectorImpl<FileID>::iterator I=Fids.begin(), E=Fids.end(); |
Ted Kremenek | b0b6f72 | 2009-03-28 06:40:54 +0000 | [diff] [blame] | 404 | I!=E; ++I) { |
| 405 | o << " "; |
| 406 | EmitString(o, SM->getFileEntryForID(*I)->getName()) << '\n'; |
| 407 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 408 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 409 | o << " </array>\n" |
| 410 | " <key>diagnostics</key>\n" |
| 411 | " <array>\n"; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 412 | |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 413 | for (std::vector<const PathDiagnostic*>::iterator DI=BatchedDiags.begin(), |
| 414 | DE = BatchedDiags.end(); DI!=DE; ++DI) { |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 415 | |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 416 | o << " <dict>\n" |
| 417 | " <key>path</key>\n"; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 418 | |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 419 | const PathDiagnostic *D = *DI; |
| 420 | // Create an owning smart pointer for 'D' just so that we auto-free it |
| 421 | // when we exit this method. |
| 422 | llvm::OwningPtr<PathDiagnostic> OwnedD(const_cast<PathDiagnostic*>(D)); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 423 | |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 424 | o << " <array>\n"; |
Ted Kremenek | f755606 | 2009-07-27 22:13:39 +0000 | [diff] [blame] | 425 | |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 426 | for (PathDiagnostic::const_iterator I=D->begin(), E=D->end(); I != E; ++I) |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 427 | ReportDiag(o, *I, FM, *SM, LangOpts); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 428 | |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 429 | o << " </array>\n"; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 430 | |
| 431 | // Output the bug type and bug category. |
Ted Kremenek | b0b6f72 | 2009-03-28 06:40:54 +0000 | [diff] [blame] | 432 | o << " <key>description</key>"; |
| 433 | EmitString(o, D->getDescription()) << '\n'; |
| 434 | o << " <key>category</key>"; |
| 435 | EmitString(o, D->getCategory()) << '\n'; |
| 436 | o << " <key>type</key>"; |
| 437 | EmitString(o, D->getBugType()) << '\n'; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 438 | |
Ted Kremenek | ca1bada | 2009-03-27 15:31:11 +0000 | [diff] [blame] | 439 | // Output the location of the bug. |
| 440 | o << " <key>location</key>\n"; |
Chris Lattner | 2c78b87 | 2009-04-14 23:22:57 +0000 | [diff] [blame] | 441 | EmitLocation(o, *SM, LangOpts, D->getLocation(), FM, 2); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 442 | |
Ted Kremenek | f755606 | 2009-07-27 22:13:39 +0000 | [diff] [blame] | 443 | // Output the diagnostic to the sub-diagnostic client, if any. |
Ted Kremenek | b697a4e | 2009-11-05 02:09:23 +0000 | [diff] [blame] | 444 | if (SubPD) { |
| 445 | SubPD->HandlePathDiagnostic(OwnedD.take()); |
| 446 | llvm::SmallVector<std::string, 1> SubFilesMade; |
| 447 | SubPD->FlushDiagnostics(SubFilesMade); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 448 | |
Ted Kremenek | b697a4e | 2009-11-05 02:09:23 +0000 | [diff] [blame] | 449 | if (!SubFilesMade.empty()) { |
| 450 | o << " <key>" << SubPD->getName() << "_files</key>\n"; |
Ted Kremenek | f755606 | 2009-07-27 22:13:39 +0000 | [diff] [blame] | 451 | o << " <array>\n"; |
Ted Kremenek | b697a4e | 2009-11-05 02:09:23 +0000 | [diff] [blame] | 452 | for (size_t i = 0, n = SubFilesMade.size(); i < n ; ++i) |
| 453 | o << " <string>" << SubFilesMade[i] << "</string>\n"; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 454 | o << " </array>\n"; |
Ted Kremenek | f755606 | 2009-07-27 22:13:39 +0000 | [diff] [blame] | 455 | } |
| 456 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 457 | |
Ted Kremenek | b0b6f72 | 2009-03-28 06:40:54 +0000 | [diff] [blame] | 458 | // Close up the entry. |
Ted Kremenek | ca1bada | 2009-03-27 15:31:11 +0000 | [diff] [blame] | 459 | o << " </dict>\n"; |
Ted Kremenek | ddf32da | 2009-01-21 00:42:24 +0000 | [diff] [blame] | 460 | } |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 461 | |
| 462 | o << " </array>\n"; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 463 | |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 464 | // Finish. |
Ted Kremenek | 4fc82c8 | 2008-11-03 23:18:07 +0000 | [diff] [blame] | 465 | o << "</dict>\n</plist>"; |
Ted Kremenek | b697a4e | 2009-11-05 02:09:23 +0000 | [diff] [blame] | 466 | |
| 467 | if (FilesMade) |
| 468 | FilesMade->push_back(OutputFile); |
Ted Kremenek | cca5e1e | 2009-11-13 03:02:57 +0000 | [diff] [blame] | 469 | |
| 470 | BatchedDiags.clear(); |
Ted Kremenek | 5d86625 | 2008-11-03 22:33:57 +0000 | [diff] [blame] | 471 | } |