clang  9.0.0svn
PlistReporter.cpp
Go to the documentation of this file.
1 //===--- PlistReporter.cpp - ARC Migrate Tool Plist Reporter ----*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "Internals.h"
13 #include "clang/Lex/Lexer.h"
14 using namespace clang;
15 using namespace arcmt;
16 using namespace markup;
17 
19  switch (Level) {
21  llvm_unreachable("ignored");
23  return "note";
26  return "warning";
29  return "error";
30  }
31  llvm_unreachable("Invalid DiagnosticsEngine level!");
32 }
33 
34 void arcmt::writeARCDiagsToPlist(const std::string &outPath,
37  const LangOptions &LangOpts) {
38  DiagnosticIDs DiagIDs;
39 
40  // Build up a set of FIDs that we use by scanning the locations and
41  // ranges of the diagnostics.
42  FIDMap FM;
44 
46  I = diags.begin(), E = diags.end(); I != E; ++I) {
47  const StoredDiagnostic &D = *I;
48 
49  AddFID(FM, Fids, SM, D.getLocation());
50 
52  RI = D.range_begin(), RE = D.range_end(); RI != RE; ++RI) {
53  AddFID(FM, Fids, SM, RI->getBegin());
54  AddFID(FM, Fids, SM, RI->getEnd());
55  }
56  }
57 
58  std::error_code EC;
59  llvm::raw_fd_ostream o(outPath, EC, llvm::sys::fs::F_Text);
60  if (EC) {
61  llvm::errs() << "error: could not create file: " << outPath << '\n';
62  return;
63  }
64 
65  EmitPlistHeader(o);
66 
67  // Write the root object: a <dict> containing...
68  // - "files", an <array> mapping from FIDs to file names
69  // - "diagnostics", an <array> containing the diagnostics
70  o << "<dict>\n"
71  " <key>files</key>\n"
72  " <array>\n";
73 
74  for (FileID FID : Fids)
75  EmitString(o << " ", SM.getFileEntryForID(FID)->getName()) << '\n';
76 
77  o << " </array>\n"
78  " <key>diagnostics</key>\n"
79  " <array>\n";
80 
82  DI = diags.begin(), DE = diags.end(); DI != DE; ++DI) {
83 
84  const StoredDiagnostic &D = *DI;
85 
87  continue;
88 
89  o << " <dict>\n";
90 
91  // Output the diagnostic.
92  o << " <key>description</key>";
93  EmitString(o, D.getMessage()) << '\n';
94  o << " <key>category</key>";
96  DiagIDs.getCategoryNumberForDiag(D.getID()))) << '\n';
97  o << " <key>type</key>";
98  EmitString(o, getLevelName(D.getLevel())) << '\n';
99 
100  // Output the location of the bug.
101  o << " <key>location</key>\n";
102  EmitLocation(o, SM, D.getLocation(), FM, 2);
103 
104  // Output the ranges (if any).
105  if (!D.getRanges().empty()) {
106  o << " <key>ranges</key>\n";
107  o << " <array>\n";
108  for (auto &R : D.getRanges()) {
109  CharSourceRange ExpansionRange = SM.getExpansionRange(R);
110  EmitRange(o, SM, Lexer::getAsCharRange(ExpansionRange, SM, LangOpts),
111  FM, 4);
112  }
113  o << " </array>\n";
114  }
115 
116  // Close up the entry.
117  o << " </dict>\n";
118  }
119 
120  o << " </array>\n";
121 
122  // Finish.
123  o << "</dict>\n</plist>";
124 }
static unsigned getCategoryNumberForDiag(unsigned DiagID)
Return the category number that a specified DiagID belongs to, or 0 if no category.
unsigned getID() const
Definition: Diagnostic.h:1459
void EmitLocation(raw_ostream &o, const SourceManager &SM, SourceLocation L, const FIDMap &FM, unsigned indent)
Definition: PlistSupport.h:107
Defines the clang::FileManager interface and associated types.
range_iterator range_begin() const
Definition: Diagnostic.h:1468
Defines the SourceManager interface.
Represents a diagnostic in a form that can be retained until its corresponding source manager is dest...
Definition: Diagnostic.h:1438
range_iterator range_end() const
Definition: Diagnostic.h:1469
static StringRef getCategoryNameFromID(unsigned CategoryID)
Given a category ID, return the name of the category.
unsigned AddFID(FIDMap &FIDs, SmallVectorImpl< FileID > &V, FileID FID)
Definition: PlistSupport.h:27
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:49
ArrayRef< CharSourceRange > getRanges() const
Definition: Diagnostic.h:1472
StringRef getMessage() const
Definition: Diagnostic.h:1462
static StringRef getLevelName(DiagnosticsEngine::Level Level)
Represents a character-granular source range.
DiagnosticsEngine::Level getLevel() const
Definition: Diagnostic.h:1460
const FileEntry * getFileEntryForID(FileID FID) const
Returns the FileEntry record for the provided FileID.
void writeARCDiagsToPlist(const std::string &outPath, ArrayRef< StoredDiagnostic > diags, SourceManager &SM, const LangOptions &LangOpts)
const SourceManager & SM
Definition: Format.cpp:1498
llvm::DenseMap< FileID, unsigned > FIDMap
Definition: PlistSupport.h:25
StringRef getName() const
Definition: FileManager.h:83
raw_ostream & EmitPlistHeader(raw_ostream &o)
Definition: PlistSupport.h:62
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Dataflow Directional Tag Classes.
const FullSourceLoc & getLocation() const
Definition: Diagnostic.h:1461
Used for handling and querying diagnostic IDs.
void EmitRange(raw_ostream &o, const SourceManager &SM, CharSourceRange R, const FIDMap &FM, unsigned indent)
Definition: PlistSupport.h:123
static CharSourceRange getAsCharRange(SourceRange Range, const SourceManager &SM, const LangOptions &LangOpts)
Given a token range, produce a corresponding CharSourceRange that is not a token range.
Definition: Lexer.h:379
CharSourceRange getExpansionRange(SourceLocation Loc) const
Given a SourceLocation object, return the range of tokens covered by the expansion in the ultimate fi...
raw_ostream & EmitString(raw_ostream &o, StringRef s)
Definition: PlistSupport.h:78
Level
The level of the diagnostic, after it has been through mapping.
Definition: Diagnostic.h:151
std::vector< CharSourceRange >::const_iterator range_iterator
Definition: Diagnostic.h:1466
This class handles loading and caching of source files into memory.