blob: b047cf478b6c229a559b2fedf1282a5ed6e9c252 [file] [log] [blame]
Manuel Klimek24db0f02013-05-14 09:13:00 +00001//===--- Marshallers.h - Generic matcher function marshallers -*- C++ -*-===//
2//
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
20#ifndef LLVM_CLANG_AST_MATCHERS_DYNAMIC_MARSHALLERS_H
21#define LLVM_CLANG_AST_MATCHERS_DYNAMIC_MARSHALLERS_H
22
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
Peter Collingbourned32e28c2014-01-23 22:48:38 +000035
Manuel Klimek24db0f02013-05-14 09:13:00 +000036/// \brief Helper template class to just from argument type to the right is/get
37/// functions in VariantValue.
38/// Used to verify and extract the matcher arguments below.
39template <class T> struct ArgTypeTraits;
40template <class T> struct ArgTypeTraits<const T &> : public ArgTypeTraits<T> {
41};
42
43template <> struct ArgTypeTraits<std::string> {
44 static bool is(const VariantValue &Value) { return Value.isString(); }
45 static const std::string &get(const VariantValue &Value) {
46 return Value.getString();
47 }
Peter Collingbourned32e28c2014-01-23 22:48:38 +000048 static ArgKind getKind() {
49 return ArgKind(ArgKind::AK_String);
50 }
Manuel Klimek24db0f02013-05-14 09:13:00 +000051};
52
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +000053template <>
54struct ArgTypeTraits<StringRef> : public ArgTypeTraits<std::string> {
55};
56
Manuel Klimek24db0f02013-05-14 09:13:00 +000057template <class T> struct ArgTypeTraits<ast_matchers::internal::Matcher<T> > {
Samuel Benzaquen81ef9292013-06-20 14:28:32 +000058 static bool is(const VariantValue &Value) {
Samuel Benzaquen998cda232013-08-30 15:09:52 +000059 return Value.isMatcher() && Value.getMatcher().hasTypedMatcher<T>();
Samuel Benzaquen81ef9292013-06-20 14:28:32 +000060 }
Manuel Klimek24db0f02013-05-14 09:13:00 +000061 static ast_matchers::internal::Matcher<T> get(const VariantValue &Value) {
Samuel Benzaquen998cda232013-08-30 15:09:52 +000062 return Value.getMatcher().getTypedMatcher<T>();
Manuel Klimek24db0f02013-05-14 09:13:00 +000063 }
Peter Collingbourned32e28c2014-01-23 22:48:38 +000064 static ArgKind getKind() {
65 return ArgKind(ast_type_traits::ASTNodeKind::getFromNodeKind<T>());
66 }
Samuel Benzaquenc31b3522013-06-04 15:46:22 +000067};
Manuel Klimek24db0f02013-05-14 09:13:00 +000068
Samuel Benzaquenc31b3522013-06-04 15:46:22 +000069template <> struct ArgTypeTraits<unsigned> {
70 static bool is(const VariantValue &Value) { return Value.isUnsigned(); }
71 static unsigned get(const VariantValue &Value) {
72 return Value.getUnsigned();
73 }
Peter Collingbourned32e28c2014-01-23 22:48:38 +000074 static ArgKind getKind() {
75 return ArgKind(ArgKind::AK_Unsigned);
76 }
Manuel Klimek24db0f02013-05-14 09:13:00 +000077};
78
Peter Collingbournef43e6942013-11-23 01:34:36 +000079/// \brief Matcher descriptor interface.
Manuel Klimek24db0f02013-05-14 09:13:00 +000080///
Peter Collingbournef43e6942013-11-23 01:34:36 +000081/// Provides a \c create() method that constructs the matcher from the provided
Peter Collingbourned32e28c2014-01-23 22:48:38 +000082/// arguments, and various other methods for type introspection.
Peter Collingbournef43e6942013-11-23 01:34:36 +000083class MatcherDescriptor {
Manuel Klimek24db0f02013-05-14 09:13:00 +000084public:
Peter Collingbournef43e6942013-11-23 01:34:36 +000085 virtual ~MatcherDescriptor() {}
86 virtual VariantMatcher create(const SourceRange &NameRange,
87 ArrayRef<ParserValue> Args,
88 Diagnostics *Error) const = 0;
Peter Collingbourned32e28c2014-01-23 22:48:38 +000089
90 /// Returns whether the matcher is variadic. Variadic matchers can take any
91 /// number of arguments, but they must be of the same type.
92 virtual bool isVariadic() const = 0;
93
94 /// Returns the number of arguments accepted by the matcher if not variadic.
95 virtual unsigned getNumArgs() const = 0;
96
97 /// Given that the matcher is being converted to type \p ThisKind, append the
98 /// set of argument types accepted for argument \p ArgNo to \p ArgKinds.
99 // FIXME: We should provide the ability to constrain the output of this
100 // function based on the types of other matcher arguments.
101 virtual void getArgKinds(ast_type_traits::ASTNodeKind ThisKind, unsigned ArgNo,
102 std::vector<ArgKind> &ArgKinds) const = 0;
103
104 /// Returns whether this matcher is convertible to the given type. If it is
105 /// so convertible, store in *Specificity a value corresponding to the
106 /// "specificity" of the converted matcher to the given context, and in
107 /// *LeastDerivedKind the least derived matcher kind which would result in the
108 /// same matcher overload. Zero specificity indicates that this conversion
109 /// would produce a trivial matcher that will either always or never match.
110 /// Such matchers are excluded from code completion results.
111 virtual bool isConvertibleTo(
Craig Topper210e1ad2014-05-17 18:49:24 +0000112 ast_type_traits::ASTNodeKind Kind, unsigned *Specificity = nullptr,
113 ast_type_traits::ASTNodeKind *LeastDerivedKind = nullptr) const = 0;
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000114
115 /// Returns whether the matcher will, given a matcher of any type T, yield a
116 /// matcher of type T.
117 virtual bool isPolymorphic() const { return false; }
Manuel Klimek24db0f02013-05-14 09:13:00 +0000118};
119
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000120inline bool isRetKindConvertibleTo(
Craig Topper00bbdcf2014-06-28 23:22:23 +0000121 ArrayRef<ast_type_traits::ASTNodeKind> RetKinds,
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000122 ast_type_traits::ASTNodeKind Kind, unsigned *Specificity,
123 ast_type_traits::ASTNodeKind *LeastDerivedKind) {
Samuel Benzaquen646f23b2014-08-12 21:11:37 +0000124 for (const ast_type_traits::ASTNodeKind &NodeKind : RetKinds) {
125 if (ArgKind(NodeKind).isConvertibleTo(Kind, Specificity)) {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000126 if (LeastDerivedKind)
Samuel Benzaquen646f23b2014-08-12 21:11:37 +0000127 *LeastDerivedKind = NodeKind;
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000128 return true;
129 }
130 }
131 return false;
132}
133
Manuel Klimek24db0f02013-05-14 09:13:00 +0000134/// \brief Simple callback implementation. Marshaller and function are provided.
Samuel Benzaquenb5dd69f2013-06-11 18:51:07 +0000135///
136/// This class wraps a function of arbitrary signature and a marshaller
Peter Collingbournef43e6942013-11-23 01:34:36 +0000137/// function into a MatcherDescriptor.
Samuel Benzaquenb5dd69f2013-06-11 18:51:07 +0000138/// The marshaller is in charge of taking the VariantValue arguments, checking
139/// their types, unpacking them and calling the underlying function.
Peter Collingbournef43e6942013-11-23 01:34:36 +0000140class FixedArgCountMatcherDescriptor : public MatcherDescriptor {
Manuel Klimek24db0f02013-05-14 09:13:00 +0000141public:
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000142 typedef VariantMatcher (*MarshallerType)(void (*Func)(),
143 StringRef MatcherName,
144 const SourceRange &NameRange,
145 ArrayRef<ParserValue> Args,
146 Diagnostics *Error);
Samuel Benzaquenb5dd69f2013-06-11 18:51:07 +0000147
Dmitri Gribenkocb63baf2013-05-17 17:50:16 +0000148 /// \param Marshaller Function to unpack the arguments and call \c Func
149 /// \param Func Matcher construct function. This is the function that
150 /// compile-time matcher expressions would use to create the matcher.
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000151 /// \param RetKinds The list of matcher types to which the matcher is
152 /// convertible.
153 /// \param ArgKinds The types of the arguments this matcher takes.
154 FixedArgCountMatcherDescriptor(
155 MarshallerType Marshaller, void (*Func)(), StringRef MatcherName,
Craig Topper00bbdcf2014-06-28 23:22:23 +0000156 ArrayRef<ast_type_traits::ASTNodeKind> RetKinds,
157 ArrayRef<ArgKind> ArgKinds)
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000158 : Marshaller(Marshaller), Func(Func), MatcherName(MatcherName),
159 RetKinds(RetKinds.begin(), RetKinds.end()),
160 ArgKinds(ArgKinds.begin(), ArgKinds.end()) {}
Manuel Klimek24db0f02013-05-14 09:13:00 +0000161
Peter Collingbournef43e6942013-11-23 01:34:36 +0000162 VariantMatcher create(const SourceRange &NameRange,
163 ArrayRef<ParserValue> Args, Diagnostics *Error) const {
Manuel Klimek24db0f02013-05-14 09:13:00 +0000164 return Marshaller(Func, MatcherName, NameRange, Args, Error);
165 }
166
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000167 bool isVariadic() const { return false; }
168 unsigned getNumArgs() const { return ArgKinds.size(); }
169 void getArgKinds(ast_type_traits::ASTNodeKind ThisKind, unsigned ArgNo,
170 std::vector<ArgKind> &Kinds) const {
171 Kinds.push_back(ArgKinds[ArgNo]);
172 }
173 bool isConvertibleTo(ast_type_traits::ASTNodeKind Kind, unsigned *Specificity,
174 ast_type_traits::ASTNodeKind *LeastDerivedKind) const {
175 return isRetKindConvertibleTo(RetKinds, Kind, Specificity,
176 LeastDerivedKind);
177 }
178
Manuel Klimek24db0f02013-05-14 09:13:00 +0000179private:
180 const MarshallerType Marshaller;
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000181 void (* const Func)();
Manuel Klimek24db0f02013-05-14 09:13:00 +0000182 const std::string MatcherName;
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000183 const std::vector<ast_type_traits::ASTNodeKind> RetKinds;
184 const std::vector<ArgKind> ArgKinds;
Manuel Klimek24db0f02013-05-14 09:13:00 +0000185};
186
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +0000187/// \brief Helper methods to extract and merge all possible typed matchers
188/// out of the polymorphic object.
189template <class PolyMatcher>
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000190static void mergePolyMatchers(const PolyMatcher &Poly,
Samuel Benzaquenf34ac3e2013-10-29 14:37:15 +0000191 std::vector<DynTypedMatcher> &Out,
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +0000192 ast_matchers::internal::EmptyTypeList) {}
193
194template <class PolyMatcher, class TypeList>
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000195static void mergePolyMatchers(const PolyMatcher &Poly,
Samuel Benzaquenf34ac3e2013-10-29 14:37:15 +0000196 std::vector<DynTypedMatcher> &Out, TypeList) {
197 Out.push_back(ast_matchers::internal::Matcher<typename TypeList::head>(Poly));
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +0000198 mergePolyMatchers(Poly, Out, typename TypeList::tail());
199}
200
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000201/// \brief Convert the return values of the functions into a VariantMatcher.
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +0000202///
203/// There are 2 cases right now: The return value is a Matcher<T> or is a
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000204/// polymorphic matcher. For the former, we just construct the VariantMatcher.
205/// For the latter, we instantiate all the possible Matcher<T> of the poly
206/// matcher.
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000207static VariantMatcher outvalueToVariantMatcher(const DynTypedMatcher &Matcher) {
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000208 return VariantMatcher::SingleMatcher(Matcher);
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +0000209}
210
211template <typename T>
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000212static VariantMatcher outvalueToVariantMatcher(const T &PolyMatcher,
213 typename T::ReturnTypes * =
214 NULL) {
Samuel Benzaquenf34ac3e2013-10-29 14:37:15 +0000215 std::vector<DynTypedMatcher> Matchers;
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000216 mergePolyMatchers(PolyMatcher, Matchers, typename T::ReturnTypes());
Benjamin Kramer3f755aa2014-03-10 17:55:02 +0000217 VariantMatcher Out = VariantMatcher::PolymorphicMatcher(std::move(Matchers));
Samuel Benzaquen0239b692013-08-13 14:54:51 +0000218 return Out;
Samuel Benzaquenc6f2c9b2013-06-21 15:51:31 +0000219}
220
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000221template <typename T>
222inline void buildReturnTypeVectorFromTypeList(
223 std::vector<ast_type_traits::ASTNodeKind> &RetTypes) {
224 RetTypes.push_back(
225 ast_type_traits::ASTNodeKind::getFromNodeKind<typename T::head>());
226 buildReturnTypeVectorFromTypeList<typename T::tail>(RetTypes);
227}
228
229template <>
230inline void
231buildReturnTypeVectorFromTypeList<ast_matchers::internal::EmptyTypeList>(
232 std::vector<ast_type_traits::ASTNodeKind> &RetTypes) {}
233
234template <typename T>
235struct BuildReturnTypeVector {
236 static void build(std::vector<ast_type_traits::ASTNodeKind> &RetTypes) {
237 buildReturnTypeVectorFromTypeList<typename T::ReturnTypes>(RetTypes);
238 }
239};
240
241template <typename T>
242struct BuildReturnTypeVector<ast_matchers::internal::Matcher<T> > {
243 static void build(std::vector<ast_type_traits::ASTNodeKind> &RetTypes) {
244 RetTypes.push_back(ast_type_traits::ASTNodeKind::getFromNodeKind<T>());
245 }
246};
247
248template <typename T>
249struct BuildReturnTypeVector<ast_matchers::internal::BindableMatcher<T> > {
250 static void build(std::vector<ast_type_traits::ASTNodeKind> &RetTypes) {
251 RetTypes.push_back(ast_type_traits::ASTNodeKind::getFromNodeKind<T>());
252 }
253};
254
255/// \brief Variadic marshaller function.
256template <typename ResultT, typename ArgT,
257 ResultT (*Func)(ArrayRef<const ArgT *>)>
258VariantMatcher
259variadicMatcherDescriptor(StringRef MatcherName, const SourceRange &NameRange,
260 ArrayRef<ParserValue> Args, Diagnostics *Error) {
261 ArgT **InnerArgs = new ArgT *[Args.size()]();
262
263 bool HasError = false;
264 for (size_t i = 0, e = Args.size(); i != e; ++i) {
265 typedef ArgTypeTraits<ArgT> ArgTraits;
266 const ParserValue &Arg = Args[i];
267 const VariantValue &Value = Arg.Value;
268 if (!ArgTraits::is(Value)) {
269 Error->addError(Arg.Range, Error->ET_RegistryWrongArgType)
270 << (i + 1) << ArgTraits::getKind().asString() << Value.getTypeAsString();
271 HasError = true;
272 break;
273 }
274 InnerArgs[i] = new ArgT(ArgTraits::get(Value));
275 }
276
277 VariantMatcher Out;
278 if (!HasError) {
279 Out = outvalueToVariantMatcher(
280 Func(ArrayRef<const ArgT *>(InnerArgs, Args.size())));
281 }
282
283 for (size_t i = 0, e = Args.size(); i != e; ++i) {
284 delete InnerArgs[i];
285 }
286 delete[] InnerArgs;
287 return Out;
288}
289
290/// \brief Matcher descriptor for variadic functions.
291///
292/// This class simply wraps a VariadicFunction with the right signature to export
293/// it as a MatcherDescriptor.
294/// This allows us to have one implementation of the interface for as many free
295/// functions as we want, reducing the number of symbols and size of the
296/// object file.
297class VariadicFuncMatcherDescriptor : public MatcherDescriptor {
298public:
299 typedef VariantMatcher (*RunFunc)(StringRef MatcherName,
300 const SourceRange &NameRange,
301 ArrayRef<ParserValue> Args,
302 Diagnostics *Error);
303
304 template <typename ResultT, typename ArgT,
305 ResultT (*F)(ArrayRef<const ArgT *>)>
306 VariadicFuncMatcherDescriptor(llvm::VariadicFunction<ResultT, ArgT, F> Func,
307 StringRef MatcherName)
308 : Func(&variadicMatcherDescriptor<ResultT, ArgT, F>),
309 MatcherName(MatcherName.str()),
310 ArgsKind(ArgTypeTraits<ArgT>::getKind()) {
311 BuildReturnTypeVector<ResultT>::build(RetKinds);
312 }
313
314 VariantMatcher create(const SourceRange &NameRange,
315 ArrayRef<ParserValue> Args, Diagnostics *Error) const {
316 return Func(MatcherName, NameRange, Args, Error);
317 }
318
319 bool isVariadic() const { return true; }
320 unsigned getNumArgs() const { return 0; }
321 void getArgKinds(ast_type_traits::ASTNodeKind ThisKind, unsigned ArgNo,
322 std::vector<ArgKind> &Kinds) const {
323 Kinds.push_back(ArgsKind);
324 }
325 bool isConvertibleTo(ast_type_traits::ASTNodeKind Kind, unsigned *Specificity,
326 ast_type_traits::ASTNodeKind *LeastDerivedKind) const {
327 return isRetKindConvertibleTo(RetKinds, Kind, Specificity,
328 LeastDerivedKind);
329 }
330
331private:
332 const RunFunc Func;
333 const std::string MatcherName;
334 std::vector<ast_type_traits::ASTNodeKind> RetKinds;
335 const ArgKind ArgsKind;
336};
337
338/// \brief Return CK_Trivial when appropriate for VariadicDynCastAllOfMatchers.
339class DynCastAllOfMatcherDescriptor : public VariadicFuncMatcherDescriptor {
340public:
341 template <typename BaseT, typename DerivedT>
342 DynCastAllOfMatcherDescriptor(
343 ast_matchers::internal::VariadicDynCastAllOfMatcher<BaseT, DerivedT> Func,
344 StringRef MatcherName)
345 : VariadicFuncMatcherDescriptor(Func, MatcherName),
346 DerivedKind(ast_type_traits::ASTNodeKind::getFromNodeKind<DerivedT>()) {
347 }
348
Craig Toppera798a9d2014-03-02 09:32:10 +0000349 bool
350 isConvertibleTo(ast_type_traits::ASTNodeKind Kind, unsigned *Specificity,
351 ast_type_traits::ASTNodeKind *LeastDerivedKind) const override {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000352 // If Kind is not a base of DerivedKind, either DerivedKind is a base of
353 // Kind (in which case the match will always succeed) or Kind and
354 // DerivedKind are unrelated (in which case it will always fail), so set
355 // Specificity to 0.
356 if (VariadicFuncMatcherDescriptor::isConvertibleTo(Kind, Specificity,
357 LeastDerivedKind)) {
358 if (Kind.isSame(DerivedKind) || !Kind.isBaseOf(DerivedKind)) {
359 if (Specificity)
360 *Specificity = 0;
361 }
362 return true;
363 } else {
364 return false;
365 }
366 }
367
368private:
369 const ast_type_traits::ASTNodeKind DerivedKind;
370};
371
372/// \brief Helper macros to check the arguments on all marshaller functions.
373#define CHECK_ARG_COUNT(count) \
374 if (Args.size() != count) { \
375 Error->addError(NameRange, Error->ET_RegistryWrongArgCount) \
376 << count << Args.size(); \
377 return VariantMatcher(); \
378 }
379
380#define CHECK_ARG_TYPE(index, type) \
381 if (!ArgTypeTraits<type>::is(Args[index].Value)) { \
382 Error->addError(Args[index].Range, Error->ET_RegistryWrongArgType) \
383 << (index + 1) << ArgTypeTraits<type>::getKind().asString() \
384 << Args[index].Value.getTypeAsString(); \
385 return VariantMatcher(); \
386 }
387
388
Manuel Klimek24db0f02013-05-14 09:13:00 +0000389/// \brief 0-arg marshaller function.
390template <typename ReturnType>
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000391static VariantMatcher matcherMarshall0(void (*Func)(), StringRef MatcherName,
392 const SourceRange &NameRange,
393 ArrayRef<ParserValue> Args,
394 Diagnostics *Error) {
395 typedef ReturnType (*FuncType)();
Manuel Klimek24db0f02013-05-14 09:13:00 +0000396 CHECK_ARG_COUNT(0);
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000397 return outvalueToVariantMatcher(reinterpret_cast<FuncType>(Func)());
Manuel Klimek24db0f02013-05-14 09:13:00 +0000398}
399
400/// \brief 1-arg marshaller function.
Samuel Benzaquenc31b3522013-06-04 15:46:22 +0000401template <typename ReturnType, typename ArgType1>
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000402static VariantMatcher matcherMarshall1(void (*Func)(), StringRef MatcherName,
403 const SourceRange &NameRange,
404 ArrayRef<ParserValue> Args,
405 Diagnostics *Error) {
406 typedef ReturnType (*FuncType)(ArgType1);
Manuel Klimek24db0f02013-05-14 09:13:00 +0000407 CHECK_ARG_COUNT(1);
408 CHECK_ARG_TYPE(0, ArgType1);
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000409 return outvalueToVariantMatcher(reinterpret_cast<FuncType>(Func)(
410 ArgTypeTraits<ArgType1>::get(Args[0].Value)));
Manuel Klimek24db0f02013-05-14 09:13:00 +0000411}
412
Samuel Benzaquenc31b3522013-06-04 15:46:22 +0000413/// \brief 2-arg marshaller function.
414template <typename ReturnType, typename ArgType1, typename ArgType2>
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000415static VariantMatcher matcherMarshall2(void (*Func)(), StringRef MatcherName,
416 const SourceRange &NameRange,
417 ArrayRef<ParserValue> Args,
418 Diagnostics *Error) {
419 typedef ReturnType (*FuncType)(ArgType1, ArgType2);
Samuel Benzaquenc31b3522013-06-04 15:46:22 +0000420 CHECK_ARG_COUNT(2);
421 CHECK_ARG_TYPE(0, ArgType1);
422 CHECK_ARG_TYPE(1, ArgType2);
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000423 return outvalueToVariantMatcher(reinterpret_cast<FuncType>(Func)(
424 ArgTypeTraits<ArgType1>::get(Args[0].Value),
425 ArgTypeTraits<ArgType2>::get(Args[1].Value)));
Samuel Benzaquenc31b3522013-06-04 15:46:22 +0000426}
427
Manuel Klimek24db0f02013-05-14 09:13:00 +0000428#undef CHECK_ARG_COUNT
429#undef CHECK_ARG_TYPE
430
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000431/// \brief Helper class used to collect all the possible overloads of an
432/// argument adaptative matcher function.
433template <template <typename ToArg, typename FromArg> class ArgumentAdapterT,
434 typename FromTypes, typename ToTypes>
435class AdaptativeOverloadCollector {
436public:
437 AdaptativeOverloadCollector(StringRef Name,
Peter Collingbournef43e6942013-11-23 01:34:36 +0000438 std::vector<MatcherDescriptor *> &Out)
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000439 : Name(Name), Out(Out) {
440 collect(FromTypes());
441 }
442
443private:
444 typedef ast_matchers::internal::ArgumentAdaptingMatcherFunc<
445 ArgumentAdapterT, FromTypes, ToTypes> AdaptativeFunc;
446
447 /// \brief End case for the recursion
448 static void collect(ast_matchers::internal::EmptyTypeList) {}
449
450 /// \brief Recursive case. Get the overload for the head of the list, and
451 /// recurse to the tail.
Peter Collingbournef43e6942013-11-23 01:34:36 +0000452 template <typename FromTypeList>
453 inline void collect(FromTypeList);
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000454
455 const StringRef Name;
Peter Collingbournef43e6942013-11-23 01:34:36 +0000456 std::vector<MatcherDescriptor *> &Out;
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000457};
458
Peter Collingbournef43e6942013-11-23 01:34:36 +0000459/// \brief MatcherDescriptor that wraps multiple "overloads" of the same
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000460/// matcher.
461///
462/// It will try every overload and generate appropriate errors for when none or
463/// more than one overloads match the arguments.
Peter Collingbournef43e6942013-11-23 01:34:36 +0000464class OverloadedMatcherDescriptor : public MatcherDescriptor {
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000465public:
Peter Collingbournef43e6942013-11-23 01:34:36 +0000466 OverloadedMatcherDescriptor(ArrayRef<MatcherDescriptor *> Callbacks)
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000467 : Overloads(Callbacks.begin(), Callbacks.end()) {}
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000468
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000469 virtual ~OverloadedMatcherDescriptor() {}
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000470
Peter Collingbournef43e6942013-11-23 01:34:36 +0000471 virtual VariantMatcher create(const SourceRange &NameRange,
472 ArrayRef<ParserValue> Args,
473 Diagnostics *Error) const {
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000474 std::vector<VariantMatcher> Constructed;
475 Diagnostics::OverloadContext Ctx(Error);
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000476 for (const auto &O : Overloads) {
477 VariantMatcher SubMatcher = O->create(NameRange, Args, Error);
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000478 if (!SubMatcher.isNull()) {
479 Constructed.push_back(SubMatcher);
480 }
481 }
482
483 if (Constructed.empty()) return VariantMatcher(); // No overload matched.
484 // We ignore the errors if any matcher succeeded.
485 Ctx.revertErrors();
486 if (Constructed.size() > 1) {
487 // More than one constructed. It is ambiguous.
488 Error->addError(NameRange, Error->ET_RegistryAmbiguousOverload);
489 return VariantMatcher();
490 }
491 return Constructed[0];
492 }
493
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000494 bool isVariadic() const {
495 bool Overload0Variadic = Overloads[0]->isVariadic();
496#ifndef NDEBUG
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000497 for (const auto &O : Overloads) {
498 assert(Overload0Variadic == O->isVariadic());
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000499 }
500#endif
501 return Overload0Variadic;
502 }
503
504 unsigned getNumArgs() const {
505 unsigned Overload0NumArgs = Overloads[0]->getNumArgs();
506#ifndef NDEBUG
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000507 for (const auto &O : Overloads) {
508 assert(Overload0NumArgs == O->getNumArgs());
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000509 }
510#endif
511 return Overload0NumArgs;
512 }
513
514 void getArgKinds(ast_type_traits::ASTNodeKind ThisKind, unsigned ArgNo,
515 std::vector<ArgKind> &Kinds) const {
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000516 for (const auto &O : Overloads) {
517 if (O->isConvertibleTo(ThisKind))
518 O->getArgKinds(ThisKind, ArgNo, Kinds);
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000519 }
520 }
521
522 bool isConvertibleTo(ast_type_traits::ASTNodeKind Kind, unsigned *Specificity,
523 ast_type_traits::ASTNodeKind *LeastDerivedKind) const {
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000524 for (const auto &O : Overloads) {
525 if (O->isConvertibleTo(Kind, Specificity, LeastDerivedKind))
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000526 return true;
527 }
528 return false;
529 }
530
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000531private:
Ahmed Charlesbfb62322014-03-09 12:24:23 +0000532 std::vector<std::unique_ptr<MatcherDescriptor>> Overloads;
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000533};
534
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000535/// \brief Variadic operator marshaller function.
Peter Collingbournef43e6942013-11-23 01:34:36 +0000536class VariadicOperatorMatcherDescriptor : public MatcherDescriptor {
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000537public:
538 typedef ast_matchers::internal::VariadicOperatorFunction VarFunc;
Peter Collingbournef43e6942013-11-23 01:34:36 +0000539 VariadicOperatorMatcherDescriptor(unsigned MinCount, unsigned MaxCount,
540 VarFunc Func, StringRef MatcherName)
Samuel Benzaquen4d058742013-11-22 14:41:48 +0000541 : MinCount(MinCount), MaxCount(MaxCount), Func(Func),
542 MatcherName(MatcherName) {}
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000543
Peter Collingbournef43e6942013-11-23 01:34:36 +0000544 virtual VariantMatcher create(const SourceRange &NameRange,
545 ArrayRef<ParserValue> Args,
546 Diagnostics *Error) const {
Samuel Benzaquen4d058742013-11-22 14:41:48 +0000547 if (Args.size() < MinCount || MaxCount < Args.size()) {
548 const std::string MaxStr =
549 (MaxCount == UINT_MAX ? "" : Twine(MaxCount)).str();
550 Error->addError(NameRange, Error->ET_RegistryWrongArgCount)
551 << ("(" + Twine(MinCount) + ", " + MaxStr + ")") << Args.size();
552 return VariantMatcher();
553 }
554
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000555 std::vector<VariantMatcher> InnerArgs;
556 for (size_t i = 0, e = Args.size(); i != e; ++i) {
557 const ParserValue &Arg = Args[i];
558 const VariantValue &Value = Arg.Value;
559 if (!Value.isMatcher()) {
560 Error->addError(Arg.Range, Error->ET_RegistryWrongArgType)
561 << (i + 1) << "Matcher<>" << Value.getTypeAsString();
562 return VariantMatcher();
563 }
564 InnerArgs.push_back(Value.getMatcher());
565 }
Benjamin Kramer3f755aa2014-03-10 17:55:02 +0000566 return VariantMatcher::VariadicOperatorMatcher(Func, std::move(InnerArgs));
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000567 }
568
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000569 bool isVariadic() const { return true; }
570 unsigned getNumArgs() const { return 0; }
571 void getArgKinds(ast_type_traits::ASTNodeKind ThisKind, unsigned ArgNo,
572 std::vector<ArgKind> &Kinds) const {
573 Kinds.push_back(ThisKind);
574 }
575 bool isConvertibleTo(ast_type_traits::ASTNodeKind Kind, unsigned *Specificity,
576 ast_type_traits::ASTNodeKind *LeastDerivedKind) const {
577 if (Specificity)
578 *Specificity = 1;
579 if (LeastDerivedKind)
580 *LeastDerivedKind = Kind;
581 return true;
582 }
Craig Topperbbc6d622014-03-02 10:02:43 +0000583 bool isPolymorphic() const override { return true; }
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000584
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000585private:
Samuel Benzaquen4d058742013-11-22 14:41:48 +0000586 const unsigned MinCount;
587 const unsigned MaxCount;
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000588 const VarFunc Func;
589 const StringRef MatcherName;
590};
591
Manuel Klimek24db0f02013-05-14 09:13:00 +0000592/// Helper functions to select the appropriate marshaller functions.
Samuel Benzaquenb5dd69f2013-06-11 18:51:07 +0000593/// They detect the number of arguments, arguments types and return type.
Manuel Klimek24db0f02013-05-14 09:13:00 +0000594
595/// \brief 0-arg overload
596template <typename ReturnType>
Peter Collingbournef43e6942013-11-23 01:34:36 +0000597MatcherDescriptor *makeMatcherAutoMarshall(ReturnType (*Func)(),
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000598 StringRef MatcherName) {
599 std::vector<ast_type_traits::ASTNodeKind> RetTypes;
600 BuildReturnTypeVector<ReturnType>::build(RetTypes);
601 return new FixedArgCountMatcherDescriptor(
602 matcherMarshall0<ReturnType>, reinterpret_cast<void (*)()>(Func),
Craig Topper00bbdcf2014-06-28 23:22:23 +0000603 MatcherName, RetTypes, None);
Manuel Klimek24db0f02013-05-14 09:13:00 +0000604}
605
606/// \brief 1-arg overload
607template <typename ReturnType, typename ArgType1>
Peter Collingbournef43e6942013-11-23 01:34:36 +0000608MatcherDescriptor *makeMatcherAutoMarshall(ReturnType (*Func)(ArgType1),
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000609 StringRef MatcherName) {
610 std::vector<ast_type_traits::ASTNodeKind> RetTypes;
611 BuildReturnTypeVector<ReturnType>::build(RetTypes);
612 ArgKind AK = ArgTypeTraits<ArgType1>::getKind();
Peter Collingbournef43e6942013-11-23 01:34:36 +0000613 return new FixedArgCountMatcherDescriptor(
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000614 matcherMarshall1<ReturnType, ArgType1>,
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000615 reinterpret_cast<void (*)()>(Func), MatcherName, RetTypes, AK);
Manuel Klimek24db0f02013-05-14 09:13:00 +0000616}
617
Samuel Benzaquenc31b3522013-06-04 15:46:22 +0000618/// \brief 2-arg overload
619template <typename ReturnType, typename ArgType1, typename ArgType2>
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000620MatcherDescriptor *makeMatcherAutoMarshall(ReturnType (*Func)(ArgType1, ArgType2),
621 StringRef MatcherName) {
622 std::vector<ast_type_traits::ASTNodeKind> RetTypes;
623 BuildReturnTypeVector<ReturnType>::build(RetTypes);
624 ArgKind AKs[] = { ArgTypeTraits<ArgType1>::getKind(),
625 ArgTypeTraits<ArgType2>::getKind() };
Peter Collingbournef43e6942013-11-23 01:34:36 +0000626 return new FixedArgCountMatcherDescriptor(
Samuel Benzaquen998cda232013-08-30 15:09:52 +0000627 matcherMarshall2<ReturnType, ArgType1, ArgType2>,
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000628 reinterpret_cast<void (*)()>(Func), MatcherName, RetTypes, AKs);
Samuel Benzaquenc31b3522013-06-04 15:46:22 +0000629}
630
Samuel Benzaquen79656e12013-07-15 19:25:06 +0000631/// \brief Variadic overload.
632template <typename ResultT, typename ArgT,
633 ResultT (*Func)(ArrayRef<const ArgT *>)>
Peter Collingbournef43e6942013-11-23 01:34:36 +0000634MatcherDescriptor *
Samuel Benzaquen79656e12013-07-15 19:25:06 +0000635makeMatcherAutoMarshall(llvm::VariadicFunction<ResultT, ArgT, Func> VarFunc,
Manuel Klimek24db0f02013-05-14 09:13:00 +0000636 StringRef MatcherName) {
Peter Collingbourned32e28c2014-01-23 22:48:38 +0000637 return new VariadicFuncMatcherDescriptor(VarFunc, MatcherName);
638}
639
640/// \brief Overload for VariadicDynCastAllOfMatchers.
641///
642/// Not strictly necessary, but DynCastAllOfMatcherDescriptor gives us better
643/// completion results for that type of matcher.
644template <typename BaseT, typename DerivedT>
645MatcherDescriptor *
646makeMatcherAutoMarshall(ast_matchers::internal::VariadicDynCastAllOfMatcher<
647 BaseT, DerivedT> VarFunc,
648 StringRef MatcherName) {
649 return new DynCastAllOfMatcherDescriptor(VarFunc, MatcherName);
Manuel Klimek24db0f02013-05-14 09:13:00 +0000650}
651
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000652/// \brief Argument adaptative overload.
653template <template <typename ToArg, typename FromArg> class ArgumentAdapterT,
654 typename FromTypes, typename ToTypes>
Peter Collingbournef43e6942013-11-23 01:34:36 +0000655MatcherDescriptor *
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000656makeMatcherAutoMarshall(ast_matchers::internal::ArgumentAdaptingMatcherFunc<
657 ArgumentAdapterT, FromTypes, ToTypes>,
658 StringRef MatcherName) {
Peter Collingbournef43e6942013-11-23 01:34:36 +0000659 std::vector<MatcherDescriptor *> Overloads;
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000660 AdaptativeOverloadCollector<ArgumentAdapterT, FromTypes, ToTypes>(MatcherName,
661 Overloads);
Peter Collingbournef43e6942013-11-23 01:34:36 +0000662 return new OverloadedMatcherDescriptor(Overloads);
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000663}
664
665template <template <typename ToArg, typename FromArg> class ArgumentAdapterT,
666 typename FromTypes, typename ToTypes>
667template <typename FromTypeList>
Peter Collingbournef43e6942013-11-23 01:34:36 +0000668inline void AdaptativeOverloadCollector<ArgumentAdapterT, FromTypes,
669 ToTypes>::collect(FromTypeList) {
Samuel Benzaquenbd7d8872013-08-16 16:19:42 +0000670 Out.push_back(makeMatcherAutoMarshall(
671 &AdaptativeFunc::template create<typename FromTypeList::head>, Name));
672 collect(typename FromTypeList::tail());
673}
674
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000675/// \brief Variadic operator overload.
Samuel Benzaquen4d058742013-11-22 14:41:48 +0000676template <unsigned MinCount, unsigned MaxCount>
Peter Collingbournef43e6942013-11-23 01:34:36 +0000677MatcherDescriptor *
Samuel Benzaquen4d058742013-11-22 14:41:48 +0000678makeMatcherAutoMarshall(ast_matchers::internal::VariadicOperatorMatcherFunc<
679 MinCount, MaxCount> Func,
680 StringRef MatcherName) {
Peter Collingbournef43e6942013-11-23 01:34:36 +0000681 return new VariadicOperatorMatcherDescriptor(MinCount, MaxCount, Func.Func,
682 MatcherName);
Samuel Benzaquen4adca622013-08-28 18:42:04 +0000683}
684
Manuel Klimek24db0f02013-05-14 09:13:00 +0000685} // namespace internal
686} // namespace dynamic
687} // namespace ast_matchers
688} // namespace clang
689
690#endif // LLVM_CLANG_AST_MATCHERS_DYNAMIC_MARSHALLERS_H