clang 10.0.0git

Diagnostics.cpp
Go to the documentation of this file.
1 //===--- Diagnostics.cpp - Helper class for error diagnostics -----*- 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 "clang/ASTMatchers/Dynamic/Diagnostics.h"
10
11 namespace clang {
12 namespace ast_matchers {
13 namespace dynamic {
14 Diagnostics::ArgStream Diagnostics::pushContextFrame(ContextType Type,
15 SourceRange Range) {
16 ContextStack.emplace_back();
17 ContextFrame& data = ContextStack.back();
18 data.Type = Type;
19 data.Range = Range;
20 return ArgStream(&data.Args);
21 }
22
23 Diagnostics::Context::Context(ConstructMatcherEnum, Diagnostics *Error,
24 StringRef MatcherName,
25 SourceRange MatcherRange)
26 : Error(Error) {
27 Error->pushContextFrame(CT_MatcherConstruct, MatcherRange) << MatcherName;
28 }
29
30 Diagnostics::Context::Context(MatcherArgEnum, Diagnostics *Error,
31 StringRef MatcherName,
32 SourceRange MatcherRange,
33 unsigned ArgNumber)
34 : Error(Error) {
35 Error->pushContextFrame(CT_MatcherArg, MatcherRange) << ArgNumber
36 << MatcherName;
37 }
38
39 Diagnostics::Context::~Context() { Error->ContextStack.pop_back(); }
40
41 Diagnostics::OverloadContext::OverloadContext(Diagnostics *Error)
42 : Error(Error), BeginIndex(Error->Errors.size()) {}
43
44 Diagnostics::OverloadContext::~OverloadContext() {
45 // Merge all errors that happened while in this context.
46 if (BeginIndex < Error->Errors.size()) {
47 Diagnostics::ErrorContent &Dest = Error->Errors[BeginIndex];
48 for (size_t i = BeginIndex + 1, e = Error->Errors.size(); i < e; ++i) {
49 Dest.Messages.push_back(Error->Errors[i].Messages[0]);
50 }
51 Error->Errors.resize(BeginIndex + 1);
52 }
53 }
54
55 void Diagnostics::OverloadContext::revertErrors() {
56 // Revert the errors.
57 Error->Errors.resize(BeginIndex);
58 }
59
60 Diagnostics::ArgStream &Diagnostics::ArgStream::operator<<(const Twine &Arg) {
61 Out->push_back(Arg.str());
62 return *this;
63 }
64
65 Diagnostics::ArgStream Diagnostics::addError(SourceRange Range,
66 ErrorType Error) {
67 Errors.emplace_back();
68 ErrorContent &Last = Errors.back();
69 Last.ContextStack = ContextStack;
70 Last.Messages.emplace_back();
71 Last.Messages.back().Range = Range;
72 Last.Messages.back().Type = Error;
73 return ArgStream(&Last.Messages.back().Args);
74 }
75
76 static StringRef contextTypeToFormatString(Diagnostics::ContextType Type) {
77 switch (Type) {
78 case Diagnostics::CT_MatcherConstruct:
79 return "Error building matcher $0.";
80 case Diagnostics::CT_MatcherArg:
81 return "Error parsing argument $0 for matcher $1.";
82 }
83 llvm_unreachable("Unknown ContextType value.");
84 }
85
86 static StringRef errorTypeToFormatString(Diagnostics::ErrorType Type) {
87 switch (Type) {
88 case Diagnostics::ET_RegistryMatcherNotFound:
89 return "Matcher not found: $0";
90 case Diagnostics::ET_RegistryWrongArgCount:
91 return "Incorrect argument count. (Expected = $0) != (Actual = $1)";
92 case Diagnostics::ET_RegistryWrongArgType:
93 return "Incorrect type for arg $0. (Expected = $1) != (Actual = $2)";
94 case Diagnostics::ET_RegistryNotBindable:
95 return "Matcher does not support binding.";
96 case Diagnostics::ET_RegistryAmbiguousOverload:
97 // TODO: Add type info about the overload error.
98 return "Ambiguous matcher overload.";
99 case Diagnostics::ET_RegistryValueNotFound:
100 return "Value not found: $0";
101
102 case Diagnostics::ET_ParserStringError:
103 return "Error parsing string token: <$0>";
104 case Diagnostics::ET_ParserNoOpenParen:
105 return "Error parsing matcher. Found token <$0> while looking for '('.";
106 case Diagnostics::ET_ParserNoCloseParen:
107 return "Error parsing matcher. Found end-of-code while looking for ')'.";
108 case Diagnostics::ET_ParserNoComma:
109 return "Error parsing matcher. Found token <$0> while looking for ','.";
110 case Diagnostics::ET_ParserNoCode:
111 return "End of code found while looking for token.";
112 case Diagnostics::ET_ParserNotAMatcher:
113 return "Input value is not a matcher expression.";
114 case Diagnostics::ET_ParserInvalidToken:
115 return "Invalid token <$0> found when looking for a value.";
116 case Diagnostics::ET_ParserMalformedBindExpr:
117 return "Malformed bind() expression.";
118 case Diagnostics::ET_ParserTrailingCode:
119 return "Expected end of code.";
120 case Diagnostics::ET_ParserNumberError:
121 return "Error parsing numeric literal: <$0>";
122 case Diagnostics::ET_ParserOverloadedType:
123 return "Input value has unresolved overloaded type: $0";
124
125 case Diagnostics::ET_None:
126 return "<N/A>";
127 }
128 llvm_unreachable("Unknown ErrorType value.");
129 }
130
131 static void formatErrorString(StringRef FormatString,
132 ArrayRef<std::string> Args,
133 llvm::raw_ostream &OS) {
134 while (!FormatString.empty()) {
135 std::pair<StringRef, StringRef> Pieces = FormatString.split("$");
136 OS << Pieces.first.str();
137 if (Pieces.second.empty()) break;
138
139 const char Next = Pieces.second.front();
140 FormatString = Pieces.second.drop_front();
141 if (Next >= '0' && Next <= '9') {
142 const unsigned Index = Next - '0';
143 if (Index < Args.size()) {
144 OS << Args[Index];
145 } else {
146 OS << "<Argument_Not_Provided>";
147 }
148 }
149 }
150 }
151
152 static void maybeAddLineAndColumn(SourceRange Range,
153 llvm::raw_ostream &OS) {
154 if (Range.Start.Line > 0 && Range.Start.Column > 0) {
155 OS << Range.Start.Line << ":" << Range.Start.Column << ": ";
156 }
157 }
158
159 static void printContextFrameToStream(const Diagnostics::ContextFrame &Frame,
160 llvm::raw_ostream &OS) {
161 maybeAddLineAndColumn(Frame.Range, OS);
162 formatErrorString(contextTypeToFormatString(Frame.Type), Frame.Args, OS);
163 }
164
165 static void
166 printMessageToStream(const Diagnostics::ErrorContent::Message &Message,
167 const Twine Prefix, llvm::raw_ostream &OS) {
168 maybeAddLineAndColumn(Message.Range, OS);
169 OS << Prefix;
170 formatErrorString(errorTypeToFormatString(Message.Type), Message.Args, OS);
171 }
172
173 static void printErrorContentToStream(const Diagnostics::ErrorContent &Content,
174 llvm::raw_ostream &OS) {
175 if (Content.Messages.size() == 1) {
176 printMessageToStream(Content.Messages[0], "", OS);
177 } else {
178 for (size_t i = 0, e = Content.Messages.size(); i != e; ++i) {
179 if (i != 0) OS << "\n";
180 printMessageToStream(Content.Messages[i],
181 "Candidate " + Twine(i + 1) + ": ", OS);
182 }
183 }
184 }
185
186 void Diagnostics::printToStream(llvm::raw_ostream &OS) const {
187 for (size_t i = 0, e = Errors.size(); i != e; ++i) {
188 if (i != 0) OS << "\n";
189 printErrorContentToStream(Errors[i], OS);
190 }
191 }
192
193 std::string Diagnostics::toString() const {
194 std::string S;
195 llvm::raw_string_ostream OS(S);
196 printToStream(OS);
197 return OS.str();
198 }
199
200 void Diagnostics::printToStreamFull(llvm::raw_ostream &OS) const {
201 for (size_t i = 0, e = Errors.size(); i != e; ++i) {
202 if (i != 0) OS << "\n";
203 const ErrorContent &Error = Errors[i];
204 for (size_t i = 0, e = Error.ContextStack.size(); i != e; ++i) {
205 printContextFrameToStream(Error.ContextStack[i], OS);
206 OS << "\n";
207 }
208 printErrorContentToStream(Error, OS);
209 }
210 }
211
212 std::string Diagnostics::toStringFull() const {
213 std::string S;
214 llvm::raw_string_ostream OS(S);
215 printToStreamFull(OS);
216 return OS.str();
217 }
218
219 } // namespace dynamic
220 } // namespace ast_matchers
221 } // namespace clang
clang::ast_matchers::dynamic::Diagnostics::Context::~Context
~Context()
Definition: Diagnostics.cpp:39
clang::ast_matchers::dynamic::printErrorContentToStream
static void printErrorContentToStream(const Diagnostics::ErrorContent &Content, llvm::raw_ostream &OS)
Definition: Diagnostics.cpp:173
clang::ast_matchers::dynamic::Diagnostics::ET_RegistryWrongArgCount
Definition: Diagnostics.h:63
clang::ast_matchers::dynamic::Diagnostics::ArgStream
Helper stream class.
Definition: Diagnostics.h:83
clang::ast_matchers::dynamic::SourceLocation::Line
unsigned Line
Definition: Diagnostics.h:32
clang::ast_matchers::dynamic::Diagnostics::ET_ParserNumberError
Definition: Diagnostics.h:78
clang::ast_matchers::dynamic::Diagnostics::ET_ParserNoCloseParen
Definition: Diagnostics.h:71
clang::ast_matchers::dynamic::Diagnostics::ET_ParserMalformedBindExpr
Definition: Diagnostics.h:76
clang::ast_matchers::dynamic::maybeAddLineAndColumn
static void maybeAddLineAndColumn(SourceRange Range, llvm::raw_ostream &OS)
Definition: Diagnostics.cpp:152
clang::ast_matchers::dynamic::contextTypeToFormatString
static StringRef contextTypeToFormatString(Diagnostics::ContextType Type)
Definition: Diagnostics.cpp:76
clang::ast_matchers::dynamic::Diagnostics::ContextFrame::Args
std::vector< std::string > Args
Definition: Diagnostics.h:145
clang::ast_matchers::dynamic::Diagnostics::Context::MatcherArgEnum
MatcherArgEnum
About to recurse into parsing one argument for a matcher.
Definition: Diagnostics.h:108
clang::ast_matchers::dynamic::Diagnostics::Context::Context
Context(ConstructMatcherEnum, Diagnostics *Error, StringRef MatcherName, SourceRange MatcherRange)
Definition: Diagnostics.cpp:23
clang::ast_matchers::dynamic::Diagnostics::ContextFrame::Type
ContextType Type
Definition: Diagnostics.h:143
clang::ast_matchers::dynamic::Diagnostics::ContextType
ContextType
Parser context types.
Definition: Diagnostics.h:53
clang::ast_matchers::dynamic::Diagnostics::ET_RegistryMatcherNotFound
Definition: Diagnostics.h:62
clang::ast_matchers::dynamic::Diagnostics::ET_RegistryAmbiguousOverload
Definition: Diagnostics.h:66
clang::ast_matchers::dynamic::Diagnostics::Context::ConstructMatcherEnum
ConstructMatcherEnum
About to call the constructor for a matcher.
Definition: Diagnostics.h:104
clang::ast_matchers::dynamic::Diagnostics::ErrorContent::Messages
std::vector< Message > Messages
Definition: Diagnostics.h:156
clang::ast_matchers::dynamic::Diagnostics::OverloadContext::OverloadContext
OverloadContext(Diagnostics *Error)
Definition: Diagnostics.cpp:41
clang::ast_matchers::dynamic::Diagnostics::ET_RegistryNotBindable
Definition: Diagnostics.h:65
clang::ast_matchers::dynamic::Diagnostics::OverloadContext::revertErrors
void revertErrors()
Revert all errors that happened within this context.
Definition: Diagnostics.cpp:55
clang::ast_matchers::dynamic::Diagnostics::ErrorContent::Message
Definition: Diagnostics.h:151
clang::ast_matchers::dynamic::SourceRange::Start
SourceLocation Start
Definition: Diagnostics.h:37
clang::ast_matchers::dynamic::Diagnostics::ET_ParserOverloadedType
Definition: Diagnostics.h:79
llvm::ArrayRef< std::string >
clang::ast_matchers::dynamic::Diagnostics::ET_RegistryValueNotFound
Definition: Diagnostics.h:67
clang::ast_matchers::dynamic::Diagnostics::printToStream
void printToStream(llvm::raw_ostream &OS) const
Returns a simple string representation of each error.
Definition: Diagnostics.cpp:186
clang::ast_matchers::dynamic::Diagnostics::OverloadContext::~OverloadContext
~OverloadContext()
Definition: Diagnostics.cpp:44
clang::ast_matchers::dynamic::SourceLocation::Column
unsigned Column
Definition: Diagnostics.h:33
clang::ast_matchers::dynamic::Diagnostics::printToStreamFull
void printToStreamFull(llvm::raw_ostream &OS) const
Returns the full string representation of each error.
Definition: Diagnostics.cpp:200
Diagnostics.h
Diagnostics class to manage error messages.
clang::ast_matchers::dynamic::Diagnostics::ET_RegistryWrongArgType
Definition: Diagnostics.h:64
clang::ComparisonCategoryType::Last
clang::ast_matchers::dynamic::Diagnostics::ET_ParserNoComma
Definition: Diagnostics.h:72
clang::ast_matchers::dynamic::Diagnostics
Helper class to manage error messages.
Definition: Diagnostics.h:50
clang::ast_matchers::dynamic::printContextFrameToStream
static void printContextFrameToStream(const Diagnostics::ContextFrame &Frame, llvm::raw_ostream &OS)
Definition: Diagnostics.cpp:159
clang::ast_matchers::dynamic::Diagnostics::ET_ParserTrailingCode
Definition: Diagnostics.h:77
clang::ast_matchers::dynamic::Diagnostics::addError
ArgStream addError(SourceRange Range, ErrorType Error)
Add an error to the diagnostics.
Definition: Diagnostics.cpp:65
clang::ast_matchers::dynamic::Diagnostics::ET_None
Definition: Diagnostics.h:60
clang::ast_matchers::dynamic::SourceRange
Definition: Diagnostics.h:36
clang::ast_matchers::dynamic::formatErrorString
static void formatErrorString(StringRef FormatString, ArrayRef< std::string > Args, llvm::raw_ostream &OS)
Definition: Diagnostics.cpp:131
clang::ast_matchers::dynamic::Diagnostics::toStringFull
std::string toStringFull() const
Definition: Diagnostics.cpp:212
clang::ast_matchers::dynamic::Diagnostics::ET_ParserInvalidToken
Definition: Diagnostics.h:75
clang::ast_matchers::dynamic::Diagnostics::ErrorContent::Message::Type
ErrorType Type
Definition: Diagnostics.h:153
clang::ast_matchers::dynamic::Diagnostics::CT_MatcherConstruct
Definition: Diagnostics.h:55
clang
Dataflow Directional Tag Classes.
Definition: CFGReachabilityAnalysis.h:21
ast_matchers
clang::ast_matchers::dynamic::Diagnostics::ErrorType
ErrorType
All errors from the system.
Definition: Diagnostics.h:59
clang::ast_matchers::dynamic::Diagnostics::ArgStream::operator<<
ArgStream & operator<<(const T &Arg)
Definition: Diagnostics.h:86
clang::ast_matchers::dynamic::Diagnostics::ErrorContent::ContextStack
std::vector< ContextFrame > ContextStack
Definition: Diagnostics.h:150
clang::ast_matchers::dynamic::Diagnostics::CT_MatcherArg
Definition: Diagnostics.h:54
clang::ast_matchers::dynamic::Diagnostics::ErrorContent::Message::Range
SourceRange Range
Definition: Diagnostics.h:152
clang::ast_matchers::dynamic::Diagnostics::ET_ParserNoOpenParen
Definition: Diagnostics.h:70
clang::ast_matchers::dynamic::Diagnostics::ErrorContent
Information stored for each error found.
Definition: Diagnostics.h:149
clang::ast_matchers::dynamic::Diagnostics::ErrorContent::Message::Args
std::vector< std::string > Args
Definition: Diagnostics.h:154
clang::ast_matchers::dynamic::Diagnostics::toString
std::string toString() const
Definition: Diagnostics.cpp:193
clang::ast_matchers::dynamic::Diagnostics::ET_ParserNoCode
Definition: Diagnostics.h:73
clang::ast_matchers::dynamic::Diagnostics::ET_ParserStringError
Definition: Diagnostics.h:69
clang::ast_matchers::dynamic::printMessageToStream
static void printMessageToStream(const Diagnostics::ErrorContent::Message &Message, const Twine Prefix, llvm::raw_ostream &OS)
Definition: Diagnostics.cpp:166
clang::ast_matchers::dynamic::Diagnostics::ContextFrame::Range
SourceRange Range
Definition: Diagnostics.h:144
clang::ast_matchers::dynamic::errorTypeToFormatString
static StringRef errorTypeToFormatString(Diagnostics::ErrorType Type)
Definition: Diagnostics.cpp:86
clang::ast_matchers::dynamic::Diagnostics::ET_ParserNotAMatcher
Definition: Diagnostics.h:74
clang::ast_matchers::dynamic::Diagnostics::ContextFrame
Information stored for one frame of the context.
Definition: Diagnostics.h:142