1 //===--- Diagnostics.cpp - Helper class for error diagnostics -----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "clang/ASTMatchers/Dynamic/Diagnostics.h"
13 namespace ast_matchers {
16 Diagnostics::ArgStream Diagnostics::pushContextFrame(ContextType Type,
18 ContextStack.push_back(ContextFrame());
19 ContextFrame& data = ContextStack.back();
22 return ArgStream(&data.Args);
25 Diagnostics::Context::Context(ConstructMatcherEnum, Diagnostics *Error,
26 StringRef MatcherName,
27 const SourceRange &MatcherRange)
29 Error->pushContextFrame(CT_MatcherConstruct, MatcherRange) << MatcherName;
32 Diagnostics::Context::Context(MatcherArgEnum, Diagnostics *Error,
33 StringRef MatcherName,
34 const SourceRange &MatcherRange,
37 Error->pushContextFrame(CT_MatcherArg, MatcherRange) << ArgNumber
41 Diagnostics::Context::~Context() { Error->ContextStack.pop_back(); }
43 Diagnostics::OverloadContext::OverloadContext(Diagnostics *Error)
44 : Error(Error), BeginIndex(Error->Errors.size()) {}
46 Diagnostics::OverloadContext::~OverloadContext() {
47 // Merge all errors that happened while in this context.
48 if (BeginIndex < Error->Errors.size()) {
49 Diagnostics::ErrorContent &Dest = Error->Errors[BeginIndex];
50 for (size_t i = BeginIndex + 1, e = Error->Errors.size(); i < e; ++i) {
51 Dest.Messages.push_back(Error->Errors[i].Messages[0]);
53 Error->Errors.resize(BeginIndex + 1);
57 void Diagnostics::OverloadContext::revertErrors() {
59 Error->Errors.resize(BeginIndex);
62 Diagnostics::ArgStream &Diagnostics::ArgStream::operator<<(const Twine &Arg) {
63 Out->push_back(Arg.str());
67 Diagnostics::ArgStream Diagnostics::addError(const SourceRange &Range,
69 Errors.push_back(ErrorContent());
70 ErrorContent &Last = Errors.back();
71 Last.ContextStack = ContextStack;
72 Last.Messages.push_back(ErrorContent::Message());
73 Last.Messages.back().Range = Range;
74 Last.Messages.back().Type = Error;
75 return ArgStream(&Last.Messages.back().Args);
78 StringRef contextTypeToFormatString(Diagnostics::ContextType Type) {
80 case Diagnostics::CT_MatcherConstruct:
81 return "Error building matcher $0.";
82 case Diagnostics::CT_MatcherArg:
83 return "Error parsing argument $0 for matcher $1.";
85 llvm_unreachable("Unknown ContextType value.");
88 StringRef errorTypeToFormatString(Diagnostics::ErrorType Type) {
90 case Diagnostics::ET_RegistryMatcherNotFound:
91 return "Matcher not found: $0";
92 case Diagnostics::ET_RegistryWrongArgCount:
93 return "Incorrect argument count. (Expected = $0) != (Actual = $1)";
94 case Diagnostics::ET_RegistryWrongArgType:
95 return "Incorrect type for arg $0. (Expected = $1) != (Actual = $2)";
96 case Diagnostics::ET_RegistryNotBindable:
97 return "Matcher does not support binding.";
98 case Diagnostics::ET_RegistryAmbiguousOverload:
99 // TODO: Add type info about the overload error.
100 return "Ambiguous matcher overload.";
101 case Diagnostics::ET_RegistryValueNotFound:
102 return "Value not found: $0";
104 case Diagnostics::ET_ParserStringError:
105 return "Error parsing string token: <$0>";
106 case Diagnostics::ET_ParserNoOpenParen:
107 return "Error parsing matcher. Found token <$0> while looking for '('.";
108 case Diagnostics::ET_ParserNoCloseParen:
109 return "Error parsing matcher. Found end-of-code while looking for ')'.";
110 case Diagnostics::ET_ParserNoComma:
111 return "Error parsing matcher. Found token <$0> while looking for ','.";
112 case Diagnostics::ET_ParserNoCode:
113 return "End of code found while looking for token.";
114 case Diagnostics::ET_ParserNotAMatcher:
115 return "Input value is not a matcher expression.";
116 case Diagnostics::ET_ParserInvalidToken:
117 return "Invalid token <$0> found when looking for a value.";
118 case Diagnostics::ET_ParserMalformedBindExpr:
119 return "Malformed bind() expression.";
120 case Diagnostics::ET_ParserTrailingCode:
121 return "Expected end of code.";
122 case Diagnostics::ET_ParserUnsignedError:
123 return "Error parsing unsigned token: <$0>";
124 case Diagnostics::ET_ParserOverloadedType:
125 return "Input value has unresolved overloaded type: $0";
127 case Diagnostics::ET_None:
130 llvm_unreachable("Unknown ErrorType value.");
133 void formatErrorString(StringRef FormatString, ArrayRef<std::string> Args,
134 llvm::raw_ostream &OS) {
135 while (!FormatString.empty()) {
136 std::pair<StringRef, StringRef> Pieces = FormatString.split("$");
137 OS << Pieces.first.str();
138 if (Pieces.second.empty()) break;
140 const char Next = Pieces.second.front();
141 FormatString = Pieces.second.drop_front();
142 if (Next >= '0' && Next <= '9') {
143 const unsigned Index = Next - '0';
144 if (Index < Args.size()) {
147 OS << "<Argument_Not_Provided>";
153 static void maybeAddLineAndColumn(const SourceRange &Range,
154 llvm::raw_ostream &OS) {
155 if (Range.Start.Line > 0 && Range.Start.Column > 0) {
156 OS << Range.Start.Line << ":" << Range.Start.Column << ": ";
160 static void printContextFrameToStream(const Diagnostics::ContextFrame &Frame,
161 llvm::raw_ostream &OS) {
162 maybeAddLineAndColumn(Frame.Range, OS);
163 formatErrorString(contextTypeToFormatString(Frame.Type), Frame.Args, OS);
167 printMessageToStream(const Diagnostics::ErrorContent::Message &Message,
168 const Twine Prefix, llvm::raw_ostream &OS) {
169 maybeAddLineAndColumn(Message.Range, OS);
171 formatErrorString(errorTypeToFormatString(Message.Type), Message.Args, OS);
174 static void printErrorContentToStream(const Diagnostics::ErrorContent &Content,
175 llvm::raw_ostream &OS) {
176 if (Content.Messages.size() == 1) {
177 printMessageToStream(Content.Messages[0], "", OS);
179 for (size_t i = 0, e = Content.Messages.size(); i != e; ++i) {
180 if (i != 0) OS << "\n";
181 printMessageToStream(Content.Messages[i],
182 "Candidate " + Twine(i + 1) + ": ", OS);
187 void Diagnostics::printToStream(llvm::raw_ostream &OS) const {
188 for (size_t i = 0, e = Errors.size(); i != e; ++i) {
189 if (i != 0) OS << "\n";
190 printErrorContentToStream(Errors[i], OS);
194 std::string Diagnostics::toString() const {
196 llvm::raw_string_ostream OS(S);
201 void Diagnostics::printToStreamFull(llvm::raw_ostream &OS) const {
202 for (size_t i = 0, e = Errors.size(); i != e; ++i) {
203 if (i != 0) OS << "\n";
204 const ErrorContent &Error = Errors[i];
205 for (size_t i = 0, e = Error.ContextStack.size(); i != e; ++i) {
206 printContextFrameToStream(Error.ContextStack[i], OS);
209 printErrorContentToStream(Error, OS);
213 std::string Diagnostics::toStringFull() const {
215 llvm::raw_string_ostream OS(S);
216 printToStreamFull(OS);
220 } // namespace dynamic
221 } // namespace ast_matchers