blob: f28abb06f90f3be6f20105791b3d6cb6733e986a [file] [log] [blame]
Eugene Zelenko1660a5d2016-01-26 19:01:06 +00001//===--- Marshallers.h - Generic matcher function marshallers ---*- C++ -*-===//
Manuel Klimek24db0f02013-05-14 09:13:00 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9///
10/// \file
11/// \brief Functions templates and classes to wrap matcher construct functions.
12///
13/// A collection of template function and classes that provide a generic
14/// marshalling layer on top of matcher construct functions.
15/// These are used by the registry to export all marshaller constructors with
16/// the same generic interface.
17///
18//===----------------------------------------------------------------------===//
19
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000020#ifndef LLVM_CLANG_LIB_ASTMATCHERS_DYNAMIC_MARSHALLERS_H
21#define LLVM_CLANG_LIB_ASTMATCHERS_DYNAMIC_MARSHALLERS_H
Manuel Klimek24db0f02013-05-14 09:13:00 +000022
Manuel Klimek24db0f02013-05-14 09:13:00 +000023#include "clang/ASTMatchers/ASTMatchers.h"
24#include "clang/ASTMatchers/Dynamic/Diagnostics.h"
25#include "clang/ASTMatchers/Dynamic/VariantValue.h"
26#include "clang/Basic/LLVM.h"
Samuel Benzaquen0239b692013-08-13 14:54:51 +000027#include "llvm/ADT/STLExtras.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000028#include <string>
Manuel Klimek24db0f02013-05-14 09:13:00 +000029
30namespace clang {
31namespace ast_matchers {
32namespace dynamic {
Manuel Klimek24db0f02013-05-14 09:13:00 +000033namespace internal {
34
35/// \brief Helper template class to just from argument type to the right is/get
36/// functions in VariantValue.
37/// Used to verify and extract the matcher arguments below.
38template <class T> struct ArgTypeTraits;
39template <class T> struct ArgTypeTraits<const T &> : public ArgTypeTraits<T> {
40};
41
42template <> struct ArgTypeTraits<std::string> {
43 static bool is(const VariantValue &Value) { return Value.isString(); }
44 static const std::string &get(const VariantValue &Value) {
45 return Value.getString();
46 }
Peter Collingbourned32e28c2014-01-23 22:48:38 +000047 static ArgKind getKind() {
48 return ArgKind(ArgKind::AK_String);
49 }
Manuel Klimek24db0f02013-05-14 09:13:00 +000050};
51
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +000052template <>
53struct ArgTypeTraits<StringRef> : public ArgTypeTraits<std::string> {
54};
55
Manuel Klimek24db0f02013-05-14 09:13:00 +000056template <class T> struct ArgTypeTraits<ast_matchers::internal::Matcher<T> > {
Samuel Benzaquen81ef9292013-06-20 14:28:32 +000057 static bool is(const VariantValue &Value) {
Samuel Benzaquen998cda232013-08-30 15:09:52 +000058 return Value.isMatcher() && Value.getMatcher().hasTypedMatcher<T>();
Samuel Benzaquen81ef9292013-06-20 14:28:32 +000059 }
Manuel Klimek24db0f02013-05-14 09:13:00 +000060 static ast_matchers::internal::Matcher<T> get(const VariantValue &Value) {
Samuel Benzaquen998cda232013-08-30 15:09:52 +000061 return Value.getMatcher().getTypedMatcher<T>();
Manuel Klimek24db0f02013-05-14 09:13:00 +000062 }
Peter Collingbourned32e28c2014-01-23 22:48:38 +000063 static ArgKind getKind() {
64 return ArgKind(ast_type_traits::ASTNodeKind::getFromNodeKind<T>());
65 }
Samuel Benzaquenc31b3522013-06-04 15:46:22 +000066};
Manuel Klimek24db0f02013-05-14 09:13:00 +000067
Samuel Benzaquenc31b3522013-06-04 15:46:22 +000068template <> struct ArgTypeTraits<unsigned> {
69 static bool is(const VariantValue &Value) { return Value.isUnsigned(); }
70 static unsigned get(const VariantValue &Value) {
71 return Value.getUnsigned();
72 }
Peter Collingbourned32e28c2014-01-23 22:48:38 +000073 static ArgKind getKind() {
74 return ArgKind(ArgKind::AK_Unsigned);
75 }
Manuel Klimek24db0f02013-05-14 09:13:00 +000076};
77
Manuel Klimek3fe8a382014-08-25 11:23:50 +000078template <> struct ArgTypeTraits<attr::Kind> {
79private:
80 static attr::Kind getAttrKind(llvm::StringRef AttrKind) {
81 return llvm::StringSwitch<attr::Kind>(AttrKind)
82#define ATTR(X) .Case("attr::" #X, attr:: X)
83#include "clang/Basic/AttrList.inc"
84 .Default(attr::Kind(-1));
85 }
86public:
87 static bool is(const VariantValue &Value) {
88 return Value.isString() &&
89 getAttrKind(Value.getString()) != attr::Kind(-1);
90 }
91 static attr::Kind get(const VariantValue &Value) {
92 return getAttrKind(Value.getString());
93 }
94 static ArgKind getKind() {
95 return ArgKind(ArgKind::AK_String);
96 }
97};
98
Peter Collingbournef43e6942013-11-23 01:34:36 +000099/// \brief Matcher descriptor interface.
Manuel Klimek24db0f02013-05-14 09:13:00 +0000100///
Peter Collingbournef43e6942013-11-23 01:34:36 +0000101/// Provides a \c create() method that constructs the matcher from the provided
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000102/// arguments, and various other methods for type introspection.
Peter Collingbournef43e6942013-11-23 01:34:36 +0000103class MatcherDescriptor {
Manuel Klimek24db0f02013-05-14 09:13:00 +0000104public:
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000105 virtual ~MatcherDescriptor() {}
Craig Toppere335f252015-10-04 04:53:55 +0000106 virtual VariantMatcher create(SourceRange NameRange,
Peter Collingbournef43e6942013-11-23 01:34:36 +0000107 ArrayRef<ParserValue> Args,
108 Diagnostics *Error) const = 0;
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000109
110 /// Returns whether the matcher is variadic. Variadic matchers can take any
111 /// number of arguments, but they must be of the same type.
112 virtual bool isVariadic() const = 0;
113
114 /// Returns the number of arguments accepted by the matcher if not variadic.
115 virtual unsigned getNumArgs() const = 0;
116
117 /// Given that the matcher is being converted to type \p ThisKind, append the
118 /// set of argument types accepted for argument \p ArgNo to \p ArgKinds.
119 // FIXME: We should provide the ability to constrain the output of this
120 // function based on the types of other matcher arguments.
121 virtual void getArgKinds(ast_type_traits::ASTNodeKind ThisKind, unsigned ArgNo,
122 std::vector<ArgKind> &ArgKinds) const = 0;
123
124 /// Returns whether this matcher is convertible to the given type. If it is
125 /// so convertible, store in *Specificity a value corresponding to the
126 /// "specificity" of the converted matcher to the given context, and in
127 /// *LeastDerivedKind the least derived matcher kind which would result in the
128 /// same matcher overload. Zero specificity indicates that this conversion
129 /// would produce a trivial matcher that will either always or never match.
130 /// Such matchers are excluded from code completion results.
131 virtual bool isConvertibleTo(
Craig Topper210e1ad2014-05-17 18:49:24 +0000132 ast_type_traits::ASTNodeKind Kind, unsigned *Specificity = nullptr,
133 ast_type_traits::ASTNodeKind *LeastDerivedKind = nullptr) const = 0;
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000134
135 /// Returns whether the matcher will, given a matcher of any type T, yield a
136 /// matcher of type T.
137 virtual bool isPolymorphic() const { return false; }
Manuel Klimek24db0f02013-05-14 09:13:00 +0000138};
139
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000140inline bool isRetKindConvertibleTo(
Craig Topper00bbdcf2014-06-28 23:22:23 +0000141 ArrayRef<ast_type_traits::ASTNodeKind> RetKinds,
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000142 ast_type_traits::ASTNodeKind Kind, unsigned *Specificity,
143 ast_type_traits::ASTNodeKind *LeastDerivedKind) {
Samuel Benzaquen646f23b2014-08-12 21:11:37 +0000144 for (const ast_type_traits::ASTNodeKind &NodeKind : RetKinds) {
145 if (ArgKind(NodeKind).isConvertibleTo(Kind, Specificity)) {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000146 if (LeastDerivedKind)
Samuel Benzaquen646f23b2014-08-12 21:11:37 +0000147 *LeastDerivedKind = NodeKind;
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000148 return true;
149 }
150 }
151 return false;
152}
153
Manuel Klimek24db0f02013-05-14 09:13:00 +0000154/// \brief Simple callback implementation. Marshaller and function are provided.
Samuel Benzaquenb5dd69f2013-06-11 18:51:07 +0000155///
156/// This class wraps a function of arbitrary signature and a marshaller
Peter Collingbournef43e6942013-11-23 01:34:36 +0000157/// function into a MatcherDescriptor.
Samuel Benzaquenb5dd69f2013-06-11 18:51:07 +0000158/// The marshaller is in charge of taking the VariantValue arguments, checking
159/// their types, unpacking them and calling the underlying function.
Peter Collingbournef43e6942013-11-23 01:34:36 +0000160class FixedArgCountMatcherDescriptor : public MatcherDescriptor {
Manuel Klimek24db0f02013-05-14 09:13:00 +0000161public:
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000162 typedef VariantMatcher (*MarshallerType)(void (*Func)(),
163 StringRef MatcherName,
Craig Toppere335f252015-10-04 04:53:55 +0000164 SourceRange NameRange,
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000165 ArrayRef<ParserValue> Args,
166 Diagnostics *Error);
Samuel Benzaquenb5dd69f2013-06-11 18:51:07 +0000167
Dmitri Gribenkocb63baf2013-05-17 17:50:16 +0000168 /// \param Marshaller Function to unpack the arguments and call \c Func
169 /// \param Func Matcher construct function. This is the function that
170 /// compile-time matcher expressions would use to create the matcher.
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000171 /// \param RetKinds The list of matcher types to which the matcher is
172 /// convertible.
173 /// \param ArgKinds The types of the arguments this matcher takes.
174 FixedArgCountMatcherDescriptor(
175 MarshallerType Marshaller, void (*Func)(), StringRef MatcherName,
Craig Topper00bbdcf2014-06-28 23:22:23 +0000176 ArrayRef<ast_type_traits::ASTNodeKind> RetKinds,
177 ArrayRef<ArgKind> ArgKinds)
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000178 : Marshaller(Marshaller), Func(Func), MatcherName(MatcherName),
179 RetKinds(RetKinds.begin(), RetKinds.end()),
180 ArgKinds(ArgKinds.begin(), ArgKinds.end()) {}
Manuel Klimek24db0f02013-05-14 09:13:00 +0000181
Craig Toppere335f252015-10-04 04:53:55 +0000182 VariantMatcher create(SourceRange NameRange,
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000183 ArrayRef<ParserValue> Args,
184 Diagnostics *Error) const override {
Manuel Klimek24db0f02013-05-14 09:13:00 +0000185 return Marshaller(Func, MatcherName, NameRange, Args, Error);
186 }
187
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000188 bool isVariadic() const override { return false; }
189 unsigned getNumArgs() const override { return ArgKinds.size(); }
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000190 void getArgKinds(ast_type_traits::ASTNodeKind ThisKind, unsigned ArgNo,
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000191 std::vector<ArgKind> &Kinds) const override {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000192 Kinds.push_back(ArgKinds[ArgNo]);
193 }
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000194 bool isConvertibleTo(
195 ast_type_traits::ASTNodeKind Kind, unsigned *Specificity,
196 ast_type_traits::ASTNodeKind *LeastDerivedKind) const override {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000197 return isRetKindConvertibleTo(RetKinds, Kind, Specificity,
198 LeastDerivedKind);
199 }
200
Manuel Klimek24db0f02013-05-14 09:13:00 +0000201private:
202 const MarshallerType Marshaller;
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000203 void (* const Func)();
Manuel Klimek24db0f02013-05-14 09:13:00 +0000204 const std::string MatcherName;
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000205 const std::vector<ast_type_traits::ASTNodeKind> RetKinds;
206 const std::vector<ArgKind> ArgKinds;
Manuel Klimek24db0f02013-05-14 09:13:00 +0000207};
208
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +0000209/// \brief Helper methods to extract and merge all possible typed matchers
210/// out of the polymorphic object.
211template <class PolyMatcher>
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000212static void mergePolyMatchers(const PolyMatcher &Poly,
Samuel Benzaquenf34ac3e2013-10-29 14:37:15 +0000213 std::vector<DynTypedMatcher> &Out,
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +0000214 ast_matchers::internal::EmptyTypeList) {}
215
216template <class PolyMatcher, class TypeList>
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000217static void mergePolyMatchers(const PolyMatcher &Poly,
Samuel Benzaquenf34ac3e2013-10-29 14:37:15 +0000218 std::vector<DynTypedMatcher> &Out, TypeList) {
219 Out.push_back(ast_matchers::internal::Matcher<typename TypeList::head>(Poly));
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +0000220 mergePolyMatchers(Poly, Out, typename TypeList::tail());
221}
222
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000223/// \brief Convert the return values of the functions into a VariantMatcher.
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +0000224///
225/// There are 2 cases right now: The return value is a Matcher<T> or is a
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000226/// polymorphic matcher. For the former, we just construct the VariantMatcher.
227/// For the latter, we instantiate all the possible Matcher<T> of the poly
228/// matcher.
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000229static VariantMatcher outvalueToVariantMatcher(const DynTypedMatcher &Matcher) {
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000230 return VariantMatcher::SingleMatcher(Matcher);
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +0000231}
232
233template <typename T>
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000234static VariantMatcher outvalueToVariantMatcher(const T &PolyMatcher,
235 typename T::ReturnTypes * =
Eugene Zelenko1660a5d2016-01-26 19:01:06 +0000236 nullptr) {
Samuel Benzaquenf34ac3e2013-10-29 14:37:15 +0000237 std::vector<DynTypedMatcher> Matchers;
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000238 mergePolyMatchers(PolyMatcher, Matchers, typename T::ReturnTypes());
Benjamin Kramer3f755aa2014-03-10 17:55:02 +0000239 VariantMatcher Out = VariantMatcher::PolymorphicMatcher(std::move(Matchers));
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000240 return Out;
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +0000241}
242
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000243template <typename T>
244inline void buildReturnTypeVectorFromTypeList(
245 std::vector<ast_type_traits::ASTNodeKind> &RetTypes) {
246 RetTypes.push_back(
247 ast_type_traits::ASTNodeKind::getFromNodeKind<typename T::head>());
248 buildReturnTypeVectorFromTypeList<typename T::tail>(RetTypes);
249}
250
251template <>
252inline void
253buildReturnTypeVectorFromTypeList<ast_matchers::internal::EmptyTypeList>(
254 std::vector<ast_type_traits::ASTNodeKind> &RetTypes) {}
255
256template <typename T>
257struct BuildReturnTypeVector {
258 static void build(std::vector<ast_type_traits::ASTNodeKind> &RetTypes) {
259 buildReturnTypeVectorFromTypeList<typename T::ReturnTypes>(RetTypes);
260 }
261};
262
263template <typename T>
264struct BuildReturnTypeVector<ast_matchers::internal::Matcher<T> > {
265 static void build(std::vector<ast_type_traits::ASTNodeKind> &RetTypes) {
266 RetTypes.push_back(ast_type_traits::ASTNodeKind::getFromNodeKind<T>());
267 }
268};
269
270template <typename T>
271struct BuildReturnTypeVector<ast_matchers::internal::BindableMatcher<T> > {
272 static void build(std::vector<ast_type_traits::ASTNodeKind> &RetTypes) {
273 RetTypes.push_back(ast_type_traits::ASTNodeKind::getFromNodeKind<T>());
274 }
275};
276
277/// \brief Variadic marshaller function.
278template <typename ResultT, typename ArgT,
279 ResultT (*Func)(ArrayRef<const ArgT *>)>
280VariantMatcher
Craig Toppere335f252015-10-04 04:53:55 +0000281variadicMatcherDescriptor(StringRef MatcherName, SourceRange NameRange,
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000282 ArrayRef<ParserValue> Args, Diagnostics *Error) {
283 ArgT **InnerArgs = new ArgT *[Args.size()]();
284
285 bool HasError = false;
286 for (size_t i = 0, e = Args.size(); i != e; ++i) {
287 typedef ArgTypeTraits<ArgT> ArgTraits;
288 const ParserValue &Arg = Args[i];
289 const VariantValue &Value = Arg.Value;
290 if (!ArgTraits::is(Value)) {
291 Error->addError(Arg.Range, Error->ET_RegistryWrongArgType)
292 << (i + 1) << ArgTraits::getKind().asString() << Value.getTypeAsString();
293 HasError = true;
294 break;
295 }
296 InnerArgs[i] = new ArgT(ArgTraits::get(Value));
297 }
298
299 VariantMatcher Out;
300 if (!HasError) {
Craig Topper8c2a2a02014-08-30 16:55:39 +0000301 Out = outvalueToVariantMatcher(Func(llvm::makeArrayRef(InnerArgs,
302 Args.size())));
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000303 }
304
305 for (size_t i = 0, e = Args.size(); i != e; ++i) {
306 delete InnerArgs[i];
307 }
308 delete[] InnerArgs;
309 return Out;
310}
311
312/// \brief Matcher descriptor for variadic functions.
313///
314/// This class simply wraps a VariadicFunction with the right signature to export
315/// it as a MatcherDescriptor.
316/// This allows us to have one implementation of the interface for as many free
317/// functions as we want, reducing the number of symbols and size of the
318/// object file.
319class VariadicFuncMatcherDescriptor : public MatcherDescriptor {
320public:
321 typedef VariantMatcher (*RunFunc)(StringRef MatcherName,
Craig Toppere335f252015-10-04 04:53:55 +0000322 SourceRange NameRange,
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000323 ArrayRef<ParserValue> Args,
324 Diagnostics *Error);
325
326 template <typename ResultT, typename ArgT,
327 ResultT (*F)(ArrayRef<const ArgT *>)>
Samuel Benzaquenc1384c12016-03-25 16:29:30 +0000328 VariadicFuncMatcherDescriptor(
329 ast_matchers::internal::VariadicFunction<ResultT, ArgT, F> Func,
330 StringRef MatcherName)
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000331 : Func(&variadicMatcherDescriptor<ResultT, ArgT, F>),
332 MatcherName(MatcherName.str()),
333 ArgsKind(ArgTypeTraits<ArgT>::getKind()) {
334 BuildReturnTypeVector<ResultT>::build(RetKinds);
335 }
336
Craig Toppere335f252015-10-04 04:53:55 +0000337 VariantMatcher create(SourceRange NameRange,
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000338 ArrayRef<ParserValue> Args,
339 Diagnostics *Error) const override {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000340 return Func(MatcherName, NameRange, Args, Error);
341 }
342
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000343 bool isVariadic() const override { return true; }
344 unsigned getNumArgs() const override { return 0; }
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000345 void getArgKinds(ast_type_traits::ASTNodeKind ThisKind, unsigned ArgNo,
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000346 std::vector<ArgKind> &Kinds) const override {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000347 Kinds.push_back(ArgsKind);
348 }
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000349 bool isConvertibleTo(
350 ast_type_traits::ASTNodeKind Kind, unsigned *Specificity,
351 ast_type_traits::ASTNodeKind *LeastDerivedKind) const override {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000352 return isRetKindConvertibleTo(RetKinds, Kind, Specificity,
353 LeastDerivedKind);
354 }
355
356private:
357 const RunFunc Func;
358 const std::string MatcherName;
359 std::vector<ast_type_traits::ASTNodeKind> RetKinds;
360 const ArgKind ArgsKind;
361};
362
363/// \brief Return CK_Trivial when appropriate for VariadicDynCastAllOfMatchers.
364class DynCastAllOfMatcherDescriptor : public VariadicFuncMatcherDescriptor {
365public:
366 template <typename BaseT, typename DerivedT>
367 DynCastAllOfMatcherDescriptor(
368 ast_matchers::internal::VariadicDynCastAllOfMatcher<BaseT, DerivedT> Func,
369 StringRef MatcherName)
370 : VariadicFuncMatcherDescriptor(Func, MatcherName),
371 DerivedKind(ast_type_traits::ASTNodeKind::getFromNodeKind<DerivedT>()) {
372 }
373
Craig Toppera798a9d2014-03-02 09:32:10 +0000374 bool
375 isConvertibleTo(ast_type_traits::ASTNodeKind Kind, unsigned *Specificity,
376 ast_type_traits::ASTNodeKind *LeastDerivedKind) const override {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000377 // If Kind is not a base of DerivedKind, either DerivedKind is a base of
378 // Kind (in which case the match will always succeed) or Kind and
379 // DerivedKind are unrelated (in which case it will always fail), so set
380 // Specificity to 0.
381 if (VariadicFuncMatcherDescriptor::isConvertibleTo(Kind, Specificity,
382 LeastDerivedKind)) {
383 if (Kind.isSame(DerivedKind) || !Kind.isBaseOf(DerivedKind)) {
384 if (Specificity)
385 *Specificity = 0;
386 }
387 return true;
388 } else {
389 return false;
390 }
391 }
392
393private:
394 const ast_type_traits::ASTNodeKind DerivedKind;
395};
396
397/// \brief Helper macros to check the arguments on all marshaller functions.
398#define CHECK_ARG_COUNT(count) \
399 if (Args.size() != count) { \
400 Error->addError(NameRange, Error->ET_RegistryWrongArgCount) \
401 << count << Args.size(); \
402 return VariantMatcher(); \
403 }
404
405#define CHECK_ARG_TYPE(index, type) \
406 if (!ArgTypeTraits<type>::is(Args[index].Value)) { \
407 Error->addError(Args[index].Range, Error->ET_RegistryWrongArgType) \
408 << (index + 1) << ArgTypeTraits<type>::getKind().asString() \
409 << Args[index].Value.getTypeAsString(); \
410 return VariantMatcher(); \
411 }
412
Manuel Klimek24db0f02013-05-14 09:13:00 +0000413/// \brief 0-arg marshaller function.
414template <typename ReturnType>
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000415static VariantMatcher matcherMarshall0(void (*Func)(), StringRef MatcherName,
Craig Toppere335f252015-10-04 04:53:55 +0000416 SourceRange NameRange,
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000417 ArrayRef<ParserValue> Args,
418 Diagnostics *Error) {
419 typedef ReturnType (*FuncType)();
Manuel Klimek24db0f02013-05-14 09:13:00 +0000420 CHECK_ARG_COUNT(0);
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000421 return outvalueToVariantMatcher(reinterpret_cast<FuncType>(Func)());
Manuel Klimek24db0f02013-05-14 09:13:00 +0000422}
423
424/// \brief 1-arg marshaller function.
Samuel Benzaquenc31b3522013-06-04 15:46:22 +0000425template <typename ReturnType, typename ArgType1>
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000426static VariantMatcher matcherMarshall1(void (*Func)(), StringRef MatcherName,
Craig Toppere335f252015-10-04 04:53:55 +0000427 SourceRange NameRange,
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000428 ArrayRef<ParserValue> Args,
429 Diagnostics *Error) {
430 typedef ReturnType (*FuncType)(ArgType1);
Manuel Klimek24db0f02013-05-14 09:13:00 +0000431 CHECK_ARG_COUNT(1);
432 CHECK_ARG_TYPE(0, ArgType1);
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000433 return outvalueToVariantMatcher(reinterpret_cast<FuncType>(Func)(
434 ArgTypeTraits<ArgType1>::get(Args[0].Value)));
Manuel Klimek24db0f02013-05-14 09:13:00 +0000435}
436
Samuel Benzaquenc31b3522013-06-04 15:46:22 +0000437/// \brief 2-arg marshaller function.
438template <typename ReturnType, typename ArgType1, typename ArgType2>
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000439static VariantMatcher matcherMarshall2(void (*Func)(), StringRef MatcherName,
Craig Toppere335f252015-10-04 04:53:55 +0000440 SourceRange NameRange,
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000441 ArrayRef<ParserValue> Args,
442 Diagnostics *Error) {
443 typedef ReturnType (*FuncType)(ArgType1, ArgType2);
Samuel Benzaquenc31b3522013-06-04 15:46:22 +0000444 CHECK_ARG_COUNT(2);
445 CHECK_ARG_TYPE(0, ArgType1);
446 CHECK_ARG_TYPE(1, ArgType2);
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000447 return outvalueToVariantMatcher(reinterpret_cast<FuncType>(Func)(
448 ArgTypeTraits<ArgType1>::get(Args[0].Value),
449 ArgTypeTraits<ArgType2>::get(Args[1].Value)));
Samuel Benzaquenc31b3522013-06-04 15:46:22 +0000450}
451
Manuel Klimek24db0f02013-05-14 09:13:00 +0000452#undef CHECK_ARG_COUNT
453#undef CHECK_ARG_TYPE
454
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000455/// \brief Helper class used to collect all the possible overloads of an
456/// argument adaptative matcher function.
457template <template <typename ToArg, typename FromArg> class ArgumentAdapterT,
458 typename FromTypes, typename ToTypes>
459class AdaptativeOverloadCollector {
460public:
461 AdaptativeOverloadCollector(StringRef Name,
Peter Collingbournef43e6942013-11-23 01:34:36 +0000462 std::vector<MatcherDescriptor *> &Out)
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000463 : Name(Name), Out(Out) {
464 collect(FromTypes());
465 }
466
467private:
468 typedef ast_matchers::internal::ArgumentAdaptingMatcherFunc<
469 ArgumentAdapterT, FromTypes, ToTypes> AdaptativeFunc;
470
471 /// \brief End case for the recursion
472 static void collect(ast_matchers::internal::EmptyTypeList) {}
473
474 /// \brief Recursive case. Get the overload for the head of the list, and
475 /// recurse to the tail.
Peter Collingbournef43e6942013-11-23 01:34:36 +0000476 template <typename FromTypeList>
477 inline void collect(FromTypeList);
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000478
Craig Topperbf3e3272014-08-30 16:55:52 +0000479 StringRef Name;
Peter Collingbournef43e6942013-11-23 01:34:36 +0000480 std::vector<MatcherDescriptor *> &Out;
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000481};
482
Peter Collingbournef43e6942013-11-23 01:34:36 +0000483/// \brief MatcherDescriptor that wraps multiple "overloads" of the same
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000484/// matcher.
485///
486/// It will try every overload and generate appropriate errors for when none or
487/// more than one overloads match the arguments.
Peter Collingbournef43e6942013-11-23 01:34:36 +0000488class OverloadedMatcherDescriptor : public MatcherDescriptor {
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000489public:
Peter Collingbournef43e6942013-11-23 01:34:36 +0000490 OverloadedMatcherDescriptor(ArrayRef<MatcherDescriptor *> Callbacks)
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000491 : Overloads(Callbacks.begin(), Callbacks.end()) {}
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000492
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000493 ~OverloadedMatcherDescriptor() override {}
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000494
Craig Toppere335f252015-10-04 04:53:55 +0000495 VariantMatcher create(SourceRange NameRange,
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000496 ArrayRef<ParserValue> Args,
497 Diagnostics *Error) const override {
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000498 std::vector<VariantMatcher> Constructed;
499 Diagnostics::OverloadContext Ctx(Error);
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000500 for (const auto &O : Overloads) {
501 VariantMatcher SubMatcher = O->create(NameRange, Args, Error);
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000502 if (!SubMatcher.isNull()) {
503 Constructed.push_back(SubMatcher);
504 }
505 }
506
507 if (Constructed.empty()) return VariantMatcher(); // No overload matched.
508 // We ignore the errors if any matcher succeeded.
509 Ctx.revertErrors();
510 if (Constructed.size() > 1) {
511 // More than one constructed. It is ambiguous.
512 Error->addError(NameRange, Error->ET_RegistryAmbiguousOverload);
513 return VariantMatcher();
514 }
515 return Constructed[0];
516 }
517
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000518 bool isVariadic() const override {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000519 bool Overload0Variadic = Overloads[0]->isVariadic();
520#ifndef NDEBUG
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000521 for (const auto &O : Overloads) {
522 assert(Overload0Variadic == O->isVariadic());
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000523 }
524#endif
525 return Overload0Variadic;
526 }
527
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000528 unsigned getNumArgs() const override {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000529 unsigned Overload0NumArgs = Overloads[0]->getNumArgs();
530#ifndef NDEBUG
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000531 for (const auto &O : Overloads) {
532 assert(Overload0NumArgs == O->getNumArgs());
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000533 }
534#endif
535 return Overload0NumArgs;
536 }
537
538 void getArgKinds(ast_type_traits::ASTNodeKind ThisKind, unsigned ArgNo,
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000539 std::vector<ArgKind> &Kinds) const override {
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000540 for (const auto &O : Overloads) {
541 if (O->isConvertibleTo(ThisKind))
542 O->getArgKinds(ThisKind, ArgNo, Kinds);
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000543 }
544 }
545
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000546 bool isConvertibleTo(
547 ast_type_traits::ASTNodeKind Kind, unsigned *Specificity,
548 ast_type_traits::ASTNodeKind *LeastDerivedKind) const override {
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000549 for (const auto &O : Overloads) {
550 if (O->isConvertibleTo(Kind, Specificity, LeastDerivedKind))
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000551 return true;
552 }
553 return false;
554 }
555
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000556private:
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000557 std::vector<std::unique_ptr<MatcherDescriptor>> Overloads;
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000558};
559
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000560/// \brief Variadic operator marshaller function.
Peter Collingbournef43e6942013-11-23 01:34:36 +0000561class VariadicOperatorMatcherDescriptor : public MatcherDescriptor {
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000562public:
Samuel Benzaquen2c15e8c2014-11-20 15:45:53 +0000563 typedef DynTypedMatcher::VariadicOperator VarOp;
Peter Collingbournef43e6942013-11-23 01:34:36 +0000564 VariadicOperatorMatcherDescriptor(unsigned MinCount, unsigned MaxCount,
Samuel Benzaquen2c15e8c2014-11-20 15:45:53 +0000565 VarOp Op, StringRef MatcherName)
566 : MinCount(MinCount), MaxCount(MaxCount), Op(Op),
Samuel Benzaquen4d058742013-11-22 14:41:48 +0000567 MatcherName(MatcherName) {}
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000568
Craig Toppere335f252015-10-04 04:53:55 +0000569 VariantMatcher create(SourceRange NameRange,
Alexander Kornienko34eb2072015-04-11 02:00:23 +0000570 ArrayRef<ParserValue> Args,
571 Diagnostics *Error) const override {
Samuel Benzaquen4d058742013-11-22 14:41:48 +0000572 if (Args.size() < MinCount || MaxCount < Args.size()) {
573 const std::string MaxStr =
574 (MaxCount == UINT_MAX ? "" : Twine(MaxCount)).str();
575 Error->addError(NameRange, Error->ET_RegistryWrongArgCount)
576 << ("(" + Twine(MinCount) + ", " + MaxStr + ")") << Args.size();
577 return VariantMatcher();
578 }
579
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000580 std::vector<VariantMatcher> InnerArgs;
581 for (size_t i = 0, e = Args.size(); i != e; ++i) {
582 const ParserValue &Arg = Args[i];
583 const VariantValue &Value = Arg.Value;
584 if (!Value.isMatcher()) {
585 Error->addError(Arg.Range, Error->ET_RegistryWrongArgType)
586 << (i + 1) << "Matcher<>" << Value.getTypeAsString();
587 return VariantMatcher();
588 }
589 InnerArgs.push_back(Value.getMatcher());
590 }
Samuel Benzaquen2c15e8c2014-11-20 15:45:53 +0000591 return VariantMatcher::VariadicOperatorMatcher(Op, std::move(InnerArgs));
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000592 }
593
Fariborz Jahanian5afc8692014-10-01 16:56:40 +0000594 bool isVariadic() const override { return true; }
595 unsigned getNumArgs() const override { return 0; }
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000596 void getArgKinds(ast_type_traits::ASTNodeKind ThisKind, unsigned ArgNo,
Fariborz Jahanian5afc8692014-10-01 16:56:40 +0000597 std::vector<ArgKind> &Kinds) const override {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000598 Kinds.push_back(ThisKind);
599 }
600 bool isConvertibleTo(ast_type_traits::ASTNodeKind Kind, unsigned *Specificity,
Fariborz Jahanian5afc8692014-10-01 16:56:40 +0000601 ast_type_traits::ASTNodeKind *LeastDerivedKind) const override {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000602 if (Specificity)
603 *Specificity = 1;
604 if (LeastDerivedKind)
605 *LeastDerivedKind = Kind;
606 return true;
607 }
Craig Topperbbc6d622014-03-02 10:02:43 +0000608 bool isPolymorphic() const override { return true; }
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000609
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000610private:
Samuel Benzaquen4d058742013-11-22 14:41:48 +0000611 const unsigned MinCount;
612 const unsigned MaxCount;
Samuel Benzaquen2c15e8c2014-11-20 15:45:53 +0000613 const VarOp Op;
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000614 const StringRef MatcherName;
615};
616
Manuel Klimek24db0f02013-05-14 09:13:00 +0000617/// Helper functions to select the appropriate marshaller functions.
Samuel Benzaquenb5dd69f2013-06-11 18:51:07 +0000618/// They detect the number of arguments, arguments types and return type.
Manuel Klimek24db0f02013-05-14 09:13:00 +0000619
620/// \brief 0-arg overload
621template <typename ReturnType>
Peter Collingbournef43e6942013-11-23 01:34:36 +0000622MatcherDescriptor *makeMatcherAutoMarshall(ReturnType (*Func)(),
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000623 StringRef MatcherName) {
624 std::vector<ast_type_traits::ASTNodeKind> RetTypes;
625 BuildReturnTypeVector<ReturnType>::build(RetTypes);
626 return new FixedArgCountMatcherDescriptor(
627 matcherMarshall0<ReturnType>, reinterpret_cast<void (*)()>(Func),
Craig Topper00bbdcf2014-06-28 23:22:23 +0000628 MatcherName, RetTypes, None);
Manuel Klimek24db0f02013-05-14 09:13:00 +0000629}
630
631/// \brief 1-arg overload
632template <typename ReturnType, typename ArgType1>
Peter Collingbournef43e6942013-11-23 01:34:36 +0000633MatcherDescriptor *makeMatcherAutoMarshall(ReturnType (*Func)(ArgType1),
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000634 StringRef MatcherName) {
635 std::vector<ast_type_traits::ASTNodeKind> RetTypes;
636 BuildReturnTypeVector<ReturnType>::build(RetTypes);
637 ArgKind AK = ArgTypeTraits<ArgType1>::getKind();
Peter Collingbournef43e6942013-11-23 01:34:36 +0000638 return new FixedArgCountMatcherDescriptor(
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000639 matcherMarshall1<ReturnType, ArgType1>,
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000640 reinterpret_cast<void (*)()>(Func), MatcherName, RetTypes, AK);
Manuel Klimek24db0f02013-05-14 09:13:00 +0000641}
642
Samuel Benzaquenc31b3522013-06-04 15:46:22 +0000643/// \brief 2-arg overload
644template <typename ReturnType, typename ArgType1, typename ArgType2>
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000645MatcherDescriptor *makeMatcherAutoMarshall(ReturnType (*Func)(ArgType1, ArgType2),
646 StringRef MatcherName) {
647 std::vector<ast_type_traits::ASTNodeKind> RetTypes;
648 BuildReturnTypeVector<ReturnType>::build(RetTypes);
649 ArgKind AKs[] = { ArgTypeTraits<ArgType1>::getKind(),
650 ArgTypeTraits<ArgType2>::getKind() };
Peter Collingbournef43e6942013-11-23 01:34:36 +0000651 return new FixedArgCountMatcherDescriptor(
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000652 matcherMarshall2<ReturnType, ArgType1, ArgType2>,
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000653 reinterpret_cast<void (*)()>(Func), MatcherName, RetTypes, AKs);
Samuel Benzaquenc31b3522013-06-04 15:46:22 +0000654}
655
Samuel Benzaquen79656e12013-07-15 19:25:06 +0000656/// \brief Variadic overload.
657template <typename ResultT, typename ArgT,
658 ResultT (*Func)(ArrayRef<const ArgT *>)>
Samuel Benzaquenc1384c12016-03-25 16:29:30 +0000659MatcherDescriptor *makeMatcherAutoMarshall(
660 ast_matchers::internal::VariadicFunction<ResultT, ArgT, Func> VarFunc,
661 StringRef MatcherName) {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000662 return new VariadicFuncMatcherDescriptor(VarFunc, MatcherName);
663}
664
665/// \brief Overload for VariadicDynCastAllOfMatchers.
666///
667/// Not strictly necessary, but DynCastAllOfMatcherDescriptor gives us better
668/// completion results for that type of matcher.
669template <typename BaseT, typename DerivedT>
670MatcherDescriptor *
671makeMatcherAutoMarshall(ast_matchers::internal::VariadicDynCastAllOfMatcher<
672 BaseT, DerivedT> VarFunc,
673 StringRef MatcherName) {
674 return new DynCastAllOfMatcherDescriptor(VarFunc, MatcherName);
Manuel Klimek24db0f02013-05-14 09:13:00 +0000675}
676
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000677/// \brief Argument adaptative overload.
678template <template <typename ToArg, typename FromArg> class ArgumentAdapterT,
679 typename FromTypes, typename ToTypes>
Peter Collingbournef43e6942013-11-23 01:34:36 +0000680MatcherDescriptor *
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000681makeMatcherAutoMarshall(ast_matchers::internal::ArgumentAdaptingMatcherFunc<
682 ArgumentAdapterT, FromTypes, ToTypes>,
683 StringRef MatcherName) {
Peter Collingbournef43e6942013-11-23 01:34:36 +0000684 std::vector<MatcherDescriptor *> Overloads;
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000685 AdaptativeOverloadCollector<ArgumentAdapterT, FromTypes, ToTypes>(MatcherName,
686 Overloads);
Peter Collingbournef43e6942013-11-23 01:34:36 +0000687 return new OverloadedMatcherDescriptor(Overloads);
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000688}
689
690template <template <typename ToArg, typename FromArg> class ArgumentAdapterT,
691 typename FromTypes, typename ToTypes>
692template <typename FromTypeList>
Peter Collingbournef43e6942013-11-23 01:34:36 +0000693inline void AdaptativeOverloadCollector<ArgumentAdapterT, FromTypes,
694 ToTypes>::collect(FromTypeList) {
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000695 Out.push_back(makeMatcherAutoMarshall(
696 &AdaptativeFunc::template create<typename FromTypeList::head>, Name));
697 collect(typename FromTypeList::tail());
698}
699
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000700/// \brief Variadic operator overload.
Samuel Benzaquen4d058742013-11-22 14:41:48 +0000701template <unsigned MinCount, unsigned MaxCount>
Peter Collingbournef43e6942013-11-23 01:34:36 +0000702MatcherDescriptor *
Samuel Benzaquen4d058742013-11-22 14:41:48 +0000703makeMatcherAutoMarshall(ast_matchers::internal::VariadicOperatorMatcherFunc<
704 MinCount, MaxCount> Func,
705 StringRef MatcherName) {
Samuel Benzaquen2c15e8c2014-11-20 15:45:53 +0000706 return new VariadicOperatorMatcherDescriptor(MinCount, MaxCount, Func.Op,
Peter Collingbournef43e6942013-11-23 01:34:36 +0000707 MatcherName);
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000708}
709
Eugene Zelenko1660a5d2016-01-26 19:01:06 +0000710} // namespace internal
711} // namespace dynamic
712} // namespace ast_matchers
713} // namespace clang
Manuel Klimek24db0f02013-05-14 09:13:00 +0000714
Eugene Zelenko1660a5d2016-01-26 19:01:06 +0000715#endif // LLVM_CLANG_AST_MATCHERS_DYNAMIC_MARSHALLERS_H