clang  9.0.0svn
LogDiagnosticPrinter.cpp
Go to the documentation of this file.
1 //===--- LogDiagnosticPrinter.cpp - Log Diagnostic Printer ----------------===//
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 
14 #include "llvm/ADT/SmallString.h"
15 #include "llvm/Support/ErrorHandling.h"
16 #include "llvm/Support/raw_ostream.h"
17 using namespace clang;
18 using namespace markup;
19 
21  raw_ostream &os, DiagnosticOptions *diags,
22  std::unique_ptr<raw_ostream> StreamOwner)
23  : OS(os), StreamOwner(std::move(StreamOwner)), LangOpts(nullptr),
24  DiagOpts(diags) {}
25 
27  switch (Level) {
28  case DiagnosticsEngine::Ignored: return "ignored";
29  case DiagnosticsEngine::Remark: return "remark";
30  case DiagnosticsEngine::Note: return "note";
31  case DiagnosticsEngine::Warning: return "warning";
32  case DiagnosticsEngine::Error: return "error";
33  case DiagnosticsEngine::Fatal: return "fatal error";
34  }
35  llvm_unreachable("Invalid DiagnosticsEngine level!");
36 }
37 
38 void
39 LogDiagnosticPrinter::EmitDiagEntry(llvm::raw_ostream &OS,
40  const LogDiagnosticPrinter::DiagEntry &DE) {
41  OS << " <dict>\n";
42  OS << " <key>level</key>\n"
43  << " ";
44  EmitString(OS, getLevelName(DE.DiagnosticLevel)) << '\n';
45  if (!DE.Filename.empty()) {
46  OS << " <key>filename</key>\n"
47  << " ";
48  EmitString(OS, DE.Filename) << '\n';
49  }
50  if (DE.Line != 0) {
51  OS << " <key>line</key>\n"
52  << " ";
53  EmitInteger(OS, DE.Line) << '\n';
54  }
55  if (DE.Column != 0) {
56  OS << " <key>column</key>\n"
57  << " ";
58  EmitInteger(OS, DE.Column) << '\n';
59  }
60  if (!DE.Message.empty()) {
61  OS << " <key>message</key>\n"
62  << " ";
63  EmitString(OS, DE.Message) << '\n';
64  }
65  OS << " <key>ID</key>\n"
66  << " ";
67  EmitInteger(OS, DE.DiagnosticID) << '\n';
68  if (!DE.WarningOption.empty()) {
69  OS << " <key>WarningOption</key>\n"
70  << " ";
71  EmitString(OS, DE.WarningOption) << '\n';
72  }
73  OS << " </dict>\n";
74 }
75 
77  // We emit all the diagnostics in EndSourceFile. However, we don't emit any
78  // entry if no diagnostics were present.
79  //
80  // Note that DiagnosticConsumer has no "end-of-compilation" callback, so we
81  // will miss any diagnostics which are emitted after and outside the
82  // translation unit processing.
83  if (Entries.empty())
84  return;
85 
86  // Write to a temporary string to ensure atomic write of diagnostic object.
87  SmallString<512> Msg;
88  llvm::raw_svector_ostream OS(Msg);
89 
90  OS << "<dict>\n";
91  if (!MainFilename.empty()) {
92  OS << " <key>main-file</key>\n"
93  << " ";
94  EmitString(OS, MainFilename) << '\n';
95  }
96  if (!DwarfDebugFlags.empty()) {
97  OS << " <key>dwarf-debug-flags</key>\n"
98  << " ";
99  EmitString(OS, DwarfDebugFlags) << '\n';
100  }
101  OS << " <key>diagnostics</key>\n";
102  OS << " <array>\n";
103  for (auto &DE : Entries)
104  EmitDiagEntry(OS, DE);
105  OS << " </array>\n";
106  OS << "</dict>\n";
107 
108  this->OS << OS.str();
109 }
110 
112  const Diagnostic &Info) {
113  // Default implementation (Warnings/errors count).
115 
116  // Initialize the main file name, if we haven't already fetched it.
117  if (MainFilename.empty() && Info.hasSourceManager()) {
118  const SourceManager &SM = Info.getSourceManager();
119  FileID FID = SM.getMainFileID();
120  if (FID.isValid()) {
121  const FileEntry *FE = SM.getFileEntryForID(FID);
122  if (FE && FE->isValid())
123  MainFilename = FE->getName();
124  }
125  }
126 
127  // Create the diag entry.
128  DiagEntry DE;
129  DE.DiagnosticID = Info.getID();
130  DE.DiagnosticLevel = Level;
131 
132  DE.WarningOption = DiagnosticIDs::getWarningOptionForDiag(DE.DiagnosticID);
133 
134  // Format the message.
135  SmallString<100> MessageStr;
136  Info.FormatDiagnostic(MessageStr);
137  DE.Message = MessageStr.str();
138 
139  // Set the location information.
140  DE.Filename = "";
141  DE.Line = DE.Column = 0;
142  if (Info.getLocation().isValid() && Info.hasSourceManager()) {
143  const SourceManager &SM = Info.getSourceManager();
144  PresumedLoc PLoc = SM.getPresumedLoc(Info.getLocation());
145 
146  if (PLoc.isInvalid()) {
147  // At least print the file name if available:
148  FileID FID = SM.getFileID(Info.getLocation());
149  if (FID.isValid()) {
150  const FileEntry *FE = SM.getFileEntryForID(FID);
151  if (FE && FE->isValid())
152  DE.Filename = FE->getName();
153  }
154  } else {
155  DE.Filename = PLoc.getFilename();
156  DE.Line = PLoc.getLine();
157  DE.Column = PLoc.getColumn();
158  }
159  }
160 
161  // Record the diagnostic entry.
162  Entries.push_back(DE);
163 }
164 
Defines the clang::FileManager interface and associated types.
Defines the SourceManager interface.
void EndSourceFile() override
Callback to inform the diagnostic client that processing of a source file has ended.
raw_ostream & EmitInteger(raw_ostream &o, int64_t value)
Definition: PlistSupport.h:71
bool hasSourceManager() const
Definition: Diagnostic.h:1327
unsigned getID() const
Definition: Diagnostic.h:1325
Definition: Format.h:2071
const SourceLocation & getLocation() const
Definition: Diagnostic.h:1326
bool isValid() const
bool isInvalid() const
Return true if this object is invalid or uninitialized.
const FileEntry * getFileEntryForID(FileID FID) const
Returns the FileEntry record for the provided FileID.
unsigned getLine() const
Return the presumed line number of this location.
void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, const Diagnostic &Info) override
Handle this diagnostic, reporting it to the user or capturing it to a log as needed.
static StringRef getWarningOptionForDiag(unsigned DiagID)
Return the lowest-level warning option that enables the specified diagnostic.
Represents an unpacked "presumed" location which can be presented to the user.
const SourceManager & SM
Definition: Format.cpp:1489
const char * getFilename() const
Return the presumed filename of this location.
unsigned getColumn() const
Return the presumed column number of this location.
StringRef getName() const
Definition: FileManager.h:84
Options for controlling the compiler diagnostics engine.
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:59
static StringRef getLevelName(DiagnosticsEngine::Level Level)
virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, const Diagnostic &Info)
Handle this diagnostic, reporting it to the user or capturing it to a log as needed.
Definition: Diagnostic.cpp:532
SourceManager & getSourceManager() const
Definition: Diagnostic.h:1328
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
bool isValid() const
Definition: FileManager.h:86
Dataflow Directional Tag Classes.
bool isValid() const
Return true if this is a valid SourceLocation object.
LogDiagnosticPrinter(raw_ostream &OS, DiagnosticOptions *Diags, std::unique_ptr< raw_ostream > StreamOwner)
FileID getMainFileID() const
Returns the FileID of the main source file.
PresumedLoc getPresumedLoc(SourceLocation Loc, bool UseLineDirectives=true) const
Returns the "presumed" location of a SourceLocation specifies.
FileID getFileID(SourceLocation SpellingLoc) const
Return the FileID for a SourceLocation.
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
A little helper class (which is basically a smart pointer that forwards info from DiagnosticsEngine) ...
Definition: Diagnostic.h:1315
void FormatDiagnostic(SmallVectorImpl< char > &OutStr) const
Format this diagnostic into a string, substituting the formal arguments into the %0 slots...
Definition: Diagnostic.cpp:763
This class handles loading and caching of source files into memory.