clang 19.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
10
11namespace clang {
12namespace ast_matchers {
13namespace dynamic {
14Diagnostics::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
24 StringRef MatcherName,
25 SourceRange MatcherRange)
26 : Error(Error) {
27 Error->pushContextFrame(CT_MatcherConstruct, MatcherRange) << MatcherName;
28}
29
31 StringRef MatcherName,
32 SourceRange MatcherRange,
33 unsigned ArgNumber)
34 : Error(Error) {
35 Error->pushContextFrame(CT_MatcherArg, MatcherRange) << ArgNumber
36 << MatcherName;
37}
38
39Diagnostics::Context::~Context() { Error->ContextStack.pop_back(); }
40
42 : Error(Error), BeginIndex(Error->Errors.size()) {}
43
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
56 // Revert the errors.
57 Error->Errors.resize(BeginIndex);
58}
59
61 Out->push_back(Arg.str());
62 return *this;
63}
64
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
77 switch (Type) {
79 return "Error building matcher $0.";
81 return "Error parsing argument $0 for matcher $1.";
82 }
83 llvm_unreachable("Unknown ContextType value.");
84}
85
87 switch (Type) {
89 return "Matcher not found: $0";
91 return "Incorrect argument count. (Expected = $0) != (Actual = $1)";
93 return "Incorrect type for arg $0. (Expected = $1) != (Actual = $2)";
95 return "Matcher does not support binding.";
97 // TODO: Add type info about the overload error.
98 return "Ambiguous matcher overload.";
100 return "Value not found: $0";
102 return "Unknown value '$1' for arg $0; did you mean '$2'";
104 return "Matcher not a node matcher: $0";
106 return "Matcher does not support with call.";
107
109 return "Error parsing string token: <$0>";
111 return "Error parsing matcher. Found token <$0> while looking for '('.";
113 return "Error parsing matcher. Found end-of-code while looking for ')'.";
115 return "Error parsing matcher. Found token <$0> while looking for ','.";
117 return "End of code found while looking for token.";
119 return "Input value is not a matcher expression.";
121 return "Invalid token <$0> found when looking for a value.";
123 return "Malformed bind() expression.";
125 return "Expected end of code.";
127 return "Error parsing numeric literal: <$0>";
129 return "Input value has unresolved overloaded type: $0";
131 return "Period not followed by valid chained call.";
133 return "Failed to build matcher: $0.";
134
136 return "<N/A>";
137 }
138 llvm_unreachable("Unknown ErrorType value.");
139}
140
141static void formatErrorString(StringRef FormatString,
143 llvm::raw_ostream &OS) {
144 while (!FormatString.empty()) {
145 std::pair<StringRef, StringRef> Pieces = FormatString.split("$");
146 OS << Pieces.first.str();
147 if (Pieces.second.empty()) break;
148
149 const char Next = Pieces.second.front();
150 FormatString = Pieces.second.drop_front();
151 if (Next >= '0' && Next <= '9') {
152 const unsigned Index = Next - '0';
153 if (Index < Args.size()) {
154 OS << Args[Index];
155 } else {
156 OS << "<Argument_Not_Provided>";
157 }
158 }
159 }
160}
161
163 llvm::raw_ostream &OS) {
164 if (Range.Start.Line > 0 && Range.Start.Column > 0) {
165 OS << Range.Start.Line << ":" << Range.Start.Column << ": ";
166 }
167}
168
170 llvm::raw_ostream &OS) {
171 maybeAddLineAndColumn(Frame.Range, OS);
173}
174
175static void
177 const Twine Prefix, llvm::raw_ostream &OS) {
178 maybeAddLineAndColumn(Message.Range, OS);
179 OS << Prefix;
180 formatErrorString(errorTypeToFormatString(Message.Type), Message.Args, OS);
181}
182
184 llvm::raw_ostream &OS) {
185 if (Content.Messages.size() == 1) {
186 printMessageToStream(Content.Messages[0], "", OS);
187 } else {
188 for (size_t i = 0, e = Content.Messages.size(); i != e; ++i) {
189 if (i != 0) OS << "\n";
191 "Candidate " + Twine(i + 1) + ": ", OS);
192 }
193 }
194}
195
196void Diagnostics::printToStream(llvm::raw_ostream &OS) const {
197 for (size_t i = 0, e = Errors.size(); i != e; ++i) {
198 if (i != 0) OS << "\n";
199 printErrorContentToStream(Errors[i], OS);
200 }
201}
202
203std::string Diagnostics::toString() const {
204 std::string S;
205 llvm::raw_string_ostream OS(S);
206 printToStream(OS);
207 return S;
208}
209
210void Diagnostics::printToStreamFull(llvm::raw_ostream &OS) const {
211 for (size_t i = 0, e = Errors.size(); i != e; ++i) {
212 if (i != 0) OS << "\n";
213 const ErrorContent &Error = Errors[i];
214 for (size_t i = 0, e = Error.ContextStack.size(); i != e; ++i) {
215 printContextFrameToStream(Error.ContextStack[i], OS);
216 OS << "\n";
217 }
218 printErrorContentToStream(Error, OS);
219 }
220}
221
222std::string Diagnostics::toStringFull() const {
223 std::string S;
224 llvm::raw_string_ostream OS(S);
226 return S;
227}
228
229} // namespace dynamic
230} // namespace ast_matchers
231} // namespace clang
MatchType Type
Diagnostics class to manage error messages.
SourceRange Range
Definition: SemaObjC.cpp:754
enum clang::format::@1262::AnnotatingParser::Context::@343 ContextType
The base class of the type hierarchy.
Definition: Type.h:1813
Helper class to manage error messages.
Definition: Diagnostics.h:50
void printToStream(llvm::raw_ostream &OS) const
Returns a simple string representation of each error.
ArgStream addError(SourceRange Range, ErrorType Error)
Add an error to the diagnostics.
Definition: Diagnostics.cpp:65
ErrorType
All errors from the system.
Definition: Diagnostics.h:59
void printToStreamFull(llvm::raw_ostream &OS) const
Returns the full string representation of each error.
static void maybeAddLineAndColumn(SourceRange Range, llvm::raw_ostream &OS)
static StringRef errorTypeToFormatString(Diagnostics::ErrorType Type)
Definition: Diagnostics.cpp:86
static StringRef contextTypeToFormatString(Diagnostics::ContextType Type)
Definition: Diagnostics.cpp:76
static void formatErrorString(StringRef FormatString, ArrayRef< std::string > Args, llvm::raw_ostream &OS)
static void printContextFrameToStream(const Diagnostics::ContextFrame &Frame, llvm::raw_ostream &OS)
static void printMessageToStream(const Diagnostics::ErrorContent::Message &Message, const Twine Prefix, llvm::raw_ostream &OS)
static void printErrorContentToStream(const Diagnostics::ErrorContent &Content, llvm::raw_ostream &OS)
The JSON file list parser is used to communicate input to InstallAPI.
Information stored for one frame of the context.
Definition: Diagnostics.h:147
MatcherArgEnum
About to recurse into parsing one argument for a matcher.
Definition: Diagnostics.h:113
Context(ConstructMatcherEnum, Diagnostics *Error, StringRef MatcherName, SourceRange MatcherRange)
Definition: Diagnostics.cpp:23
ConstructMatcherEnum
About to call the constructor for a matcher.
Definition: Diagnostics.h:109
Information stored for each error found.
Definition: Diagnostics.h:154
void revertErrors()
Revert all errors that happened within this context.
Definition: Diagnostics.cpp:55