AST Matcher Reference
This document shows all currently implemented matchers. The matchers are grouped by category and node type they match. You can click on matcher names to show the matcher's source documentation.
There are three different basic categories of matchers:
- Node Matchers: Matchers that match a specific type of AST node.
- Narrowing Matchers: Matchers that match attributes on AST nodes.
- Traversal Matchers: Matchers that allow traversal between AST nodes.
Within each category the matchers are ordered by node type they match on. Note that if a matcher can match multiple node types, it will appear multiple times. This means that by searching for Matcher<Stmt> you can find all matchers that can be used to match on Stmt nodes.
The exception to that rule are matchers that can match on any node. Those are marked with a * and are listed in the beginning of each category.
Note that the categorization of matchers is a great help when you combine them into matcher expressions. You will usually want to form matcher expressions that read like english sentences by alternating between node matchers and narrowing or traversal matchers, like this:
recordDecl(hasDescendant(
ifStmt(hasTrueExpression(
expr(hasDescendant(
ifStmt()))))))
Node Matchers
Node matchers are at the core of matcher expressions - they specify the type of node that is expected. Every match expression starts with a node matcher, which can then be further refined with a narrowing or traversal matcher. All traversal matchers take node matchers as their arguments.
For convenience, all node matchers take an arbitrary number of arguments and implicitly act as allOf matchers.
Node matchers are the only matchers that support the bind("id") call to bind the matched node to the given string, to be later retrieved from the match callback.
It is important to remember that the arguments to node matchers are predicates on the same node, just with additional information about the type. This is often useful to make matcher expression more readable by inlining bind calls into redundant node matchers inside another node matcher:
// This binds the CXXRecordDecl to "id", as the decl() matcher will stay on
// the same node.
recordDecl(decl().bind("id"), hasName("::MyClass"))
| Return type | Name | Parameters | |
|---|---|---|---|
| Matcher<CXXCtorInitializer> | cxxCtorInitializer | Matcher<CXXCtorInitializer>... | |
Matches constructor initializers.
Examples matches i(42).
class C {
C() : i(42) {}
int i;
};
| |||
| Matcher<Decl> | accessSpecDecl | Matcher<AccessSpecDecl>... | |
Matches C++ access specifier declarations.
Given
class C {
public:
int a;
};
accessSpecDecl()
matches 'public:'
| |||
| Matcher<Decl> | blockDecl | Matcher<BlockDecl>... | |
Matches block declarations.
Example matches the declaration of the nameless block printing an input
integer.
myFunc(^(int p) {
printf("%d", p);
})
| |||
| Matcher<Decl> | classTemplateDecl | Matcher<ClassTemplateDecl>... | |
Matches C++ class template declarations.
Example matches Z
template<class T> class Z {};
| |||
| Matcher<Decl> | classTemplatePartialSpecializationDecl | Matcher<ClassTemplatePartialSpecializationDecl>... | |
Matches C++ class template partial specializations.
Given
template<class T1, class T2, int I>
class A {};
template<class T, int I>
class A<T, T*, I> {};
template<>
class A<int, int, 1> {};
classTemplatePartialSpecializationDecl()
matches the specialization A<T,T*,I> but not A<int,int,1>
| |||
| Matcher<Decl> | classTemplateSpecializationDecl | Matcher<ClassTemplateSpecializationDecl>... | |
Matches C++ class template specializations.
Given
template<typename T> class A {};
template<> class A<double> {};
A<int> a;
classTemplateSpecializationDecl()
matches the specializations A<int> and A<double>
| |||
| Matcher<Decl> | cxxConstructorDecl | Matcher<CXXConstructorDecl>... | |
Matches C++ constructor declarations.
Example matches Foo::Foo() and Foo::Foo(int)
class Foo {
public:
Foo();
Foo(int);
int DoSomething();
};
| |||
| Matcher<Decl> | cxxConversionDecl | Matcher<CXXConversionDecl>... | |
Matches conversion operator declarations.
Example matches the operator.
class X { operator int() const; };
| |||
| Matcher<Decl> | cxxDeductionGuideDecl | Matcher<CXXDeductionGuideDecl>... | |
Matches user-defined and implicitly generated deduction guide.
Example matches the deduction guide.
template<typename T>
class X { X(int) };
X(int) -> X<int>;
| |||
| Matcher<Decl> | cxxDestructorDecl | Matcher<CXXDestructorDecl>... | |
Matches explicit C++ destructor declarations.
Example matches Foo::~Foo()
class Foo {
public:
virtual ~Foo();
};
| |||
| Matcher<Decl> | cxxMethodDecl | Matcher<CXXMethodDecl>... | |
Matches method declarations.
Example matches y
class X { void y(); };
| |||
| Matcher<Decl> | cxxRecordDecl | Matcher<CXXRecordDecl>... | |
Matches C++ class declarations.
Example matches X, Z
class X;
template<class T> class Z {};
| |||
| Matcher<Decl> | decl | Matcher<Decl>... | |
Matches declarations.
Examples matches X, C, and the friend declaration inside C;
void X();
class C {
friend X;
};
| |||
| Matcher<Decl> | declaratorDecl | Matcher<DeclaratorDecl>... | |
Matches declarator declarations (field, variable, function
and non-type template parameter declarations).
Given
class X { int y; };
declaratorDecl()
matches int y.
| |||
| Matcher<Decl> | enumConstantDecl | Matcher<EnumConstantDecl>... | |
Matches enum constants.
Example matches A, B, C
enum X {
A, B, C
};
| |||
| Matcher<Decl> | enumDecl | Matcher<EnumDecl>... | |
Matches enum declarations.
Example matches X
enum X {
A, B, C
};
| |||
| Matcher<Decl> | fieldDecl | Matcher<FieldDecl>... | |
Matches field declarations.
Given
class X { int m; };
fieldDecl()
matches 'm'.
| |||
| Matcher<Decl> | friendDecl | Matcher<FriendDecl>... | |
Matches friend declarations.
Given
class X { friend void foo(); };
friendDecl()
matches 'friend void foo()'.
| |||
| Matcher<Decl> | functionDecl | Matcher<FunctionDecl>... | |
Matches function declarations. Example matches f void f(); | |||
| Matcher<Decl> | functionTemplateDecl | Matcher<FunctionTemplateDecl>... | |
Matches C++ function template declarations.
Example matches f
template<class T> void f(T t) {}
| |||
| Matcher<Decl> | indirectFieldDecl | Matcher<IndirectFieldDecl>... | |
Matches indirect field declarations.
Given
struct X { struct { int a; }; };
indirectFieldDecl()
matches 'a'.
| |||
| Matcher<Decl> | labelDecl | Matcher<LabelDecl>... | |
Matches a declaration of label. Given goto FOO; FOO: bar(); labelDecl() matches 'FOO:' | |||
| Matcher<Decl> | linkageSpecDecl | Matcher<LinkageSpecDecl>... | |
Matches a declaration of a linkage specification.
Given
extern "C" {}
linkageSpecDecl()
matches "extern "C" {}"
| |||
| Matcher<Decl> | namedDecl | Matcher<NamedDecl>... | |
Matches a declaration of anything that could have a name.
Example matches X, S, the anonymous union type, i, and U;
typedef int X;
struct S {
union {
int i;
} U;
};
| |||
| Matcher<Decl> | namespaceAliasDecl | Matcher<NamespaceAliasDecl>... | |
Matches a declaration of a namespace alias.
Given
namespace test {}
namespace alias = ::test;
namespaceAliasDecl()
matches "namespace alias" but not "namespace test"
| |||
| Matcher<Decl> | namespaceDecl | Matcher<NamespaceDecl>... | |
Matches a declaration of a namespace.
Given
namespace {}
namespace test {}
namespaceDecl()
matches "namespace {}" and "namespace test {}"
| |||
| Matcher<Decl> | nonTypeTemplateParmDecl | Matcher<NonTypeTemplateParmDecl>... | |
Matches non-type template parameter declarations.
Given
template <typename T, int N> struct C {};
nonTypeTemplateParmDecl()
matches 'N', but not 'T'.
| |||
| Matcher<Decl> | objcCategoryDecl | Matcher<ObjCCategoryDecl>... | |
Matches Objective-C category declarations. Example matches Foo (Additions) @interface Foo (Additions) @end | |||
| Matcher<Decl> | objcCategoryImplDecl | Matcher<ObjCCategoryImplDecl>... | |
Matches Objective-C category definitions. Example matches Foo (Additions) @implementation Foo (Additions) @end | |||
| Matcher<Decl> | objcImplementationDecl | Matcher<ObjCImplementationDecl>... | |
Matches Objective-C implementation declarations. Example matches Foo @implementation Foo @end | |||
| Matcher<Decl> | objcInterfaceDecl | Matcher<ObjCInterfaceDecl>... | |
Matches Objective-C interface declarations. Example matches Foo @interface Foo @end | |||
| Matcher<Decl> | objcIvarDecl | Matcher<ObjCIvarDecl>... | |
Matches Objective-C instance variable declarations.
Example matches _enabled
@implementation Foo {
BOOL _enabled;
}
@end
| |||
| Matcher<Decl> | objcMethodDecl | Matcher<ObjCMethodDecl>... | |
Matches Objective-C method declarations.
Example matches both declaration and definition of -[Foo method]
@interface Foo
- (void)method;
@end
@implementation Foo
- (void)method {}
@end
| |||
| Matcher<Decl> | objcPropertyDecl | Matcher<ObjCPropertyDecl>... | |
Matches Objective-C property declarations. Example matches enabled @interface Foo @property BOOL enabled; @end | |||
| Matcher<Decl> | objcProtocolDecl | Matcher<ObjCProtocolDecl>... | |
Matches Objective-C protocol declarations. Example matches FooDelegate @protocol FooDelegate @end | |||
| Matcher<Decl> | parmVarDecl | Matcher<ParmVarDecl>... | |
Matches parameter variable declarations. Given void f(int x); parmVarDecl() matches int x. | |||
| Matcher<Decl> | recordDecl | Matcher<RecordDecl>... | |
Matches class, struct, and union declarations.
Example matches X, Z, U, and S
class X;
template<class T> class Z {};
struct S {};
union U {};
| |||
| Matcher<Decl> | staticAssertDecl | Matcher<StaticAssertDecl>... | |
Matches a C++ static_assert declaration.
Example:
staticAssertExpr()
matches
static_assert(sizeof(S) == sizeof(int))
in
struct S {
int x;
};
static_assert(sizeof(S) == sizeof(int));
| |||
| Matcher<Decl> | tagDecl | Matcher<TagDecl>... | |
Matches tag declarations.
Example matches X, Z, U, S, E
class X;
template<class T> class Z {};
struct S {};
union U {};
enum E {
A, B, C
};
| |||
| Matcher<Decl> | templateTypeParmDecl | Matcher<TemplateTypeParmDecl>... | |
Matches template type parameter declarations.
Given
template <typename T, int N> struct C {};
templateTypeParmDecl()
matches 'T', but not 'N'.
| |||
| Matcher<Decl> | translationUnitDecl | Matcher<TranslationUnitDecl>... | |
Matches the top declaration context.
Given
int X;
namespace NS {
int Y;
} // namespace NS
decl(hasDeclContext(translationUnitDecl()))
matches "int X", but not "int Y".
| |||
| Matcher<Decl> | typeAliasDecl | Matcher<TypeAliasDecl>... | |
Matches type alias declarations. Given typedef int X; using Y = int; typeAliasDecl() matches "using Y = int", but not "typedef int X" | |||
| Matcher<Decl> | typeAliasTemplateDecl | Matcher<TypeAliasTemplateDecl>... | |
Matches type alias template declarations. typeAliasTemplateDecl() matches template <typename T> using Y = X<T>; | |||
| Matcher<Decl> | typedefDecl | Matcher<TypedefDecl>... | |
Matches typedef declarations. Given typedef int X; using Y = int; typedefDecl() matches "typedef int X", but not "using Y = int" | |||
| Matcher<Decl> | typedefNameDecl | Matcher<TypedefNameDecl>... | |
Matches typedef name declarations. Given typedef int X; using Y = int; typedefNameDecl() matches "typedef int X" and "using Y = int" | |||
| Matcher<Decl> | unresolvedUsingTypenameDecl | Matcher<UnresolvedUsingTypenameDecl>... | |
Matches unresolved using value declarations that involve the
typename.
Given
template <typename T>
struct Base { typedef T Foo; };
template<typename T>
struct S : private Base<T> {
using typename Base<T>::Foo;
};
unresolvedUsingTypenameDecl()
matches using Base<T>::Foo | |||
| Matcher<Decl> | unresolvedUsingValueDecl | Matcher<UnresolvedUsingValueDecl>... | |
Matches unresolved using value declarations.
Given
template<typename X>
class C : private X {
using X::x;
};
unresolvedUsingValueDecl()
matches using X::x | |||
| Matcher<Decl> | usingDecl | Matcher<UsingDecl>... | |
Matches using declarations.
Given
namespace X { int x; }
using X::x;
usingDecl()
matches using X::x | |||
| Matcher<Decl> | usingDirectiveDecl | Matcher<UsingDirectiveDecl>... | |
Matches using namespace declarations.
Given
namespace X { int x; }
using namespace X;
usingDirectiveDecl()
matches using namespace X | |||
| Matcher<Decl> | valueDecl | Matcher<ValueDecl>... | |
Matches any value declaration.
Example matches A, B, C and F
enum X { A, B, C };
void F();
| |||
| Matcher<Decl> | varDecl | Matcher<VarDecl>... | |
Matches variable declarations. Note: this does not match declarations of member variables, which are "field" declarations in Clang parlance. Example matches a int a; | |||
| Matcher<NestedNameSpecifierLoc> | nestedNameSpecifierLoc | Matcher<NestedNameSpecifierLoc>... | |
Same as nestedNameSpecifier but matches NestedNameSpecifierLoc. | |||
| Matcher<NestedNameSpecifier> | nestedNameSpecifier | Matcher<NestedNameSpecifier>... | |
Matches nested name specifiers.
Given
namespace ns {
struct A { static void f(); };
void A::f() {}
void g() { A::f(); }
}
ns::A a;
nestedNameSpecifier()
matches "ns::" and both "A::"
| |||
| Matcher<OMPClause> | ompDefaultClause | Matcher<OMPDefaultClause>... | |
Matches OpenMP ``default`` clause. Given #pragma omp parallel default(none) #pragma omp parallel default(shared) #pragma omp parallel default(firstprivate) #pragma omp parallel ``ompDefaultClause()`` matches ``default(none)``, ``default(shared)``, and ``default(firstprivate)``. | |||
| Matcher<QualType> | qualType | Matcher<QualType>... | |
Matches QualTypes in the clang AST. | |||
| Matcher<Stmt> | addrLabelExpr | Matcher<AddrLabelExpr>... | |
Matches address of label statements (GNU extension). Given FOO: bar(); void *ptr = &&FOO; goto *bar; addrLabelExpr() matches '&&FOO' | |||
| Matcher<Stmt> | arraySubscriptExpr | Matcher<ArraySubscriptExpr>... | |
Matches array subscript expressions. Given int i = a[1]; arraySubscriptExpr() matches "a[1]" | |||
| Matcher<Stmt> | asmStmt | Matcher<AsmStmt>... | |
Matches asm statements.
int i = 100;
__asm("mov al, 2");
asmStmt()
matches '__asm("mov al, 2")'
| |||
| Matcher<Stmt> | atomicExpr | Matcher<AtomicExpr>... | |
Matches atomic builtins.
Example matches __atomic_load_n(ptr, 1)
void foo() { int *ptr; __atomic_load_n(ptr, 1); }
| |||
| Matcher<Stmt> | autoreleasePoolStmt | Matcher<ObjCAutoreleasePoolStmt>... | |
Matches an Objective-C autorelease pool statement.
Given
@autoreleasepool {
int x = 0;
}
autoreleasePoolStmt(stmt()) matches the declaration of "x"
inside the autorelease pool.
| |||
| Matcher<Stmt> | binaryConditionalOperator | Matcher<BinaryConditionalOperator>... | |
Matches binary conditional operator expressions (GNU extension). Example matches a ?: b (a ?: b) + 42; | |||
| Matcher<Stmt> | binaryOperator | Matcher<BinaryOperator>... | |
Matches binary operator expressions. Example matches a || b !(a || b) | |||
| Matcher<Stmt> | blockExpr | Matcher<BlockExpr>... | |
Matches a reference to a block.
Example: matches "^{}":
void f() { ^{}(); }
| |||
| Matcher<Stmt> | breakStmt | Matcher<BreakStmt>... | |
Matches break statements.
Given
while (true) { break; }
breakStmt()
matches 'break'
| |||
| Matcher<Stmt> | cStyleCastExpr | Matcher<CStyleCastExpr>... | |
Matches a C-style cast expression. Example: Matches (int) 2.2f in int i = (int) 2.2f; | |||
| Matcher<Stmt> | callExpr | Matcher<CallExpr>... | |
Matches call expressions. Example matches x.y() and y() X x; x.y(); y(); | |||
| Matcher<Stmt> | caseStmt | Matcher<CaseStmt>... | |
Matches case statements inside switch statements.
Given
switch(a) { case 42: break; default: break; }
caseStmt()
matches 'case 42:'.
| |||
| Matcher<Stmt> | castExpr | Matcher<CastExpr>... | |
Matches any cast nodes of Clang's AST. Example: castExpr() matches each of the following: (int) 3; const_cast<Expr *>(SubExpr); char c = 0; but does not match int i = (0); int k = 0; | |||
| Matcher<Stmt> | characterLiteral | Matcher<CharacterLiteral>... | |
Matches character literals (also matches wchar_t). Not matching Hex-encoded chars (e.g. 0x1234, which is a IntegerLiteral), though. Example matches 'a', L'a' char ch = 'a'; wchar_t chw = L'a'; | |||
| Matcher<Stmt> | chooseExpr | Matcher<ChooseExpr>... | |
Matches GNU __builtin_choose_expr. | |||
| Matcher<Stmt> | compoundLiteralExpr | Matcher<CompoundLiteralExpr>... | |
Matches compound (i.e. non-scalar) literals
Example match: {1}, (1, 2)
int array[4] = {1};
vector int myvec = (vector int)(1, 2);
| |||
| Matcher<Stmt> | compoundStmt | Matcher<CompoundStmt>... | |
Matches compound statements.
Example matches '{}' and '{{}}' in 'for (;;) {{}}'
for (;;) {{}}
| |||
| Matcher<Stmt> | conditionalOperator | Matcher<ConditionalOperator>... | |
Matches conditional operator expressions. Example matches a ? b : c (a ? b : c) + 42 | |||
| Matcher<Stmt> | constantExpr | Matcher<ConstantExpr>... | |
Matches a constant expression wrapper.
Example matches the constant in the case statement:
(matcher = constantExpr())
switch (a) {
case 37: break;
}
| |||
| Matcher<Stmt> | continueStmt | Matcher<ContinueStmt>... | |
Matches continue statements.
Given
while (true) { continue; }
continueStmt()
matches 'continue'
| |||
| Matcher<Stmt> | cudaKernelCallExpr | Matcher<CUDAKernelCallExpr>... | |
Matches CUDA kernel call expression. Example matches, kernel<<<i,j>>>(); | |||
| Matcher<Stmt> | cxxBindTemporaryExpr | Matcher<CXXBindTemporaryExpr>... | |
Matches nodes where temporaries are created.
Example matches FunctionTakesString(GetStringByValue())
(matcher = cxxBindTemporaryExpr())
FunctionTakesString(GetStringByValue());
FunctionTakesStringByPointer(GetStringPointer());
| |||
| Matcher<Stmt> | cxxBoolLiteral | Matcher<CXXBoolLiteralExpr>... | |
Matches bool literals. Example matches true true | |||
| Matcher<Stmt> | cxxCatchStmt | Matcher<CXXCatchStmt>... | |
Matches catch statements.
try {} catch(int i) {}
cxxCatchStmt()
matches 'catch(int i)'
| |||
| Matcher<Stmt> | cxxConstCastExpr | Matcher<CXXConstCastExpr>... | |
Matches a const_cast expression. Example: Matches const_cast<int*>(&r) in int n = 42; const int &r(n); int* p = const_cast<int*>(&r); | |||
| Matcher<Stmt> | cxxConstructExpr | Matcher<CXXConstructExpr>... | |
Matches constructor call expressions (including implicit ones).
Example matches string(ptr, n) and ptr within arguments of f
(matcher = cxxConstructExpr())
void f(const string &a, const string &b);
char *ptr;
int n;
f(string(ptr, n), ptr);
| |||
| Matcher<Stmt> | cxxDefaultArgExpr | Matcher<CXXDefaultArgExpr>... | |
Matches the value of a default argument at the call site.
Example matches the CXXDefaultArgExpr placeholder inserted for the
default value of the second parameter in the call expression f(42)
(matcher = cxxDefaultArgExpr())
void f(int x, int y = 0);
f(42);
| |||
| Matcher<Stmt> | cxxDeleteExpr | Matcher<CXXDeleteExpr>... | |
Matches delete expressions. Given delete X; cxxDeleteExpr() matches 'delete X'. | |||
| Matcher<Stmt> | cxxDependentScopeMemberExpr | Matcher<CXXDependentScopeMemberExpr>... | |
Matches member expressions where the actual member referenced could not be
resolved because the base expression or the member name was dependent.
Given
template <class T> void f() { T t; t.g(); }
cxxDependentScopeMemberExpr()
matches t.g
| |||
| Matcher<Stmt> | cxxDynamicCastExpr | Matcher<CXXDynamicCastExpr>... | |
Matches a dynamic_cast expression.
Example:
cxxDynamicCastExpr()
matches
dynamic_cast<D*>(&b);
in
struct B { virtual ~B() {} }; struct D : B {};
B b;
D* p = dynamic_cast<D*>(&b);
| |||
| Matcher<Stmt> | cxxForRangeStmt | Matcher<CXXForRangeStmt>... | |
Matches range-based for statements.
cxxForRangeStmt() matches 'for (auto a : i)'
int i[] = {1, 2, 3}; for (auto a : i);
for(int j = 0; j < 5; ++j);
| |||
| Matcher<Stmt> | cxxFunctionalCastExpr | Matcher<CXXFunctionalCastExpr>... | |
Matches functional cast expressions Example: Matches Foo(bar); Foo f = bar; Foo g = (Foo) bar; Foo h = Foo(bar); | |||
| Matcher<Stmt> | cxxMemberCallExpr | Matcher<CXXMemberCallExpr>... | |
Matches member call expressions. Example matches x.y() X x; x.y(); | |||
| Matcher<Stmt> | cxxNewExpr | Matcher<CXXNewExpr>... | |
Matches new expressions. Given new X; cxxNewExpr() matches 'new X'. | |||
| Matcher<Stmt> | cxxNoexceptExpr | Matcher<CXXNoexceptExpr>... | |
Matches noexcept expressions. Given bool a() noexcept; bool b() noexcept(true); bool c() noexcept(false); bool d() noexcept(noexcept(a())); bool e = noexcept(b()) || noexcept(c()); cxxNoexceptExpr() matches `noexcept(a())`, `noexcept(b())` and `noexcept(c())`. doesn't match the noexcept specifier in the declarations a, b, c or d. | |||
| Matcher<Stmt> | cxxNullPtrLiteralExpr | Matcher<CXXNullPtrLiteralExpr>... | |
Matches nullptr literal. | |||
| Matcher<Stmt> | cxxOperatorCallExpr | Matcher<CXXOperatorCallExpr>... | |
Matches overloaded operator calls.
Note that if an operator isn't overloaded, it won't match. Instead, use
binaryOperator matcher.
Currently it does not match operators such as new delete.
FIXME: figure out why these do not match?
Example matches both operator<<((o << b), c) and operator<<(o, b)
(matcher = cxxOperatorCallExpr())
ostream &operator<< (ostream &out, int i) { };
ostream &o; int b = 1, c = 1;
o << b << c;
| |||
| Matcher<Stmt> | cxxReinterpretCastExpr | Matcher<CXXReinterpretCastExpr>... | |
Matches a reinterpret_cast expression. Either the source expression or the destination type can be matched using has(), but hasDestinationType() is more specific and can be more readable. Example matches reinterpret_cast<char*>(&p) in void* p = reinterpret_cast<char*>(&p); | |||
| Matcher<Stmt> | cxxStaticCastExpr | Matcher<CXXStaticCastExpr>... | |
Matches a C++ static_cast expression. See also: hasDestinationType See also: reinterpretCast Example: cxxStaticCastExpr() matches static_cast<long>(8) in long eight(static_cast<long>(8)); | |||
| Matcher<Stmt> | cxxStdInitializerListExpr | Matcher<CXXStdInitializerListExpr>... | |
Matches C++ initializer list expressions.
Given
std::vector<int> a({ 1, 2, 3 });
std::vector<int> b = { 4, 5 };
int c[] = { 6, 7 };
std::pair<int, int> d = { 8, 9 };
cxxStdInitializerListExpr()
matches "{ 1, 2, 3 }" and "{ 4, 5 }"
| |||
| Matcher<Stmt> | cxxTemporaryObjectExpr | Matcher<CXXTemporaryObjectExpr>... | |
Matches functional cast expressions having N != 1 arguments Example: Matches Foo(bar, bar) Foo h = Foo(bar, bar); | |||
| Matcher<Stmt> | cxxThisExpr | Matcher<CXXThisExpr>... | |
Matches implicit and explicit this expressions.
Example matches the implicit this expression in "return i".
(matcher = cxxThisExpr())
struct foo {
int i;
int f() { return i; }
};
| |||
| Matcher<Stmt> | cxxThrowExpr | Matcher<CXXThrowExpr>... | |
Matches throw expressions.
try { throw 5; } catch(int i) {}
cxxThrowExpr()
matches 'throw 5'
| |||
| Matcher<Stmt> | cxxTryStmt | Matcher<CXXTryStmt>... | |
Matches try statements.
try {} catch(int i) {}
cxxTryStmt()
matches 'try {}'
| |||
| Matcher<Stmt> | cxxUnresolvedConstructExpr | Matcher<CXXUnresolvedConstructExpr>... | |
Matches unresolved constructor call expressions.
Example matches T(t) in return statement of f
(matcher = cxxUnresolvedConstructExpr())
template <typename T>
void f(const T& t) { return T(t); }
| |||
| Matcher<Stmt> | declRefExpr | Matcher<DeclRefExpr>... | |
Matches expressions that refer to declarations.
Example matches x in if (x)
bool x;
if (x) {}
| |||
| Matcher<Stmt> | declStmt | Matcher<DeclStmt>... | |
Matches declaration statements. Given int a; declStmt() matches 'int a'. | |||
| Matcher<Stmt> | defaultStmt | Matcher<DefaultStmt>... | |
Matches default statements inside switch statements.
Given
switch(a) { case 42: break; default: break; }
defaultStmt()
matches 'default:'.
| |||
| Matcher<Stmt> | designatedInitExpr | Matcher<DesignatedInitExpr>... | |
Matches C99 designated initializer expressions [C99 6.7.8].
Example: Matches { [2].y = 1.0, [0].x = 1.0 }
point ptarray[10] = { [2].y = 1.0, [0].x = 1.0 };
| |||
| Matcher<Stmt> | doStmt | Matcher<DoStmt>... | |
Matches do statements.
Given
do {} while (true);
doStmt()
matches 'do {} while(true)'
| |||
| Matcher<Stmt> | explicitCastExpr | Matcher<ExplicitCastExpr>... | |
Matches explicit cast expressions. Matches any cast expression written in user code, whether it be a C-style cast, a functional-style cast, or a keyword cast. Does not match implicit conversions. Note: the name "explicitCast" is chosen to match Clang's terminology, as Clang uses the term "cast" to apply to implicit conversions as well as to actual cast expressions. See also: hasDestinationType. Example: matches all five of the casts in int((int)(reinterpret_cast<int>(static_cast<int>(const_cast<int>(42))))) but does not match the implicit conversion in long ell = 42; | |||
| Matcher<Stmt> | expr | Matcher<Expr>... | |
Matches expressions.
Example matches x()
void f() { x(); }
| |||
| Matcher<Stmt> | exprWithCleanups | Matcher<ExprWithCleanups>... | |
Matches expressions that introduce cleanups to be run at the end of the sub-expression's evaluation. Example matches std::string() const std::string str = std::string(); | |||
| Matcher<Stmt> | fixedPointLiteral | Matcher<FixedPointLiteral>... | |
Matches fixed point literals | |||
| Matcher<Stmt> | floatLiteral | Matcher<FloatingLiteral>... | |
Matches float literals of all sizes / encodings, e.g. 1.0, 1.0f, 1.0L and 1e10. Does not match implicit conversions such as float a = 10; | |||
| Matcher<Stmt> | forStmt | Matcher<ForStmt>... | |
Matches for statements.
Example matches 'for (;;) {}'
for (;;) {}
int i[] = {1, 2, 3}; for (auto a : i);
| |||
| Matcher<Stmt> | gnuNullExpr | Matcher<GNUNullExpr>... | |
Matches GNU __null expression. | |||
| Matcher<Stmt> | gotoStmt | Matcher<GotoStmt>... | |
Matches goto statements. Given goto FOO; FOO: bar(); gotoStmt() matches 'goto FOO' | |||
| Matcher<Stmt> | ifStmt | Matcher<IfStmt>... | |
Matches if statements.
Example matches 'if (x) {}'
if (x) {}
| |||
| Matcher<Stmt> | imaginaryLiteral | Matcher<ImaginaryLiteral>... | |
Matches imaginary literals, which are based on integer and floating point literals e.g.: 1i, 1.0i | |||
| Matcher<Stmt> | implicitCastExpr | Matcher<ImplicitCastExpr>... | |
Matches the implicit cast nodes of Clang's AST. This matches many different places, including function call return value eliding, as well as any type conversions. | |||
| Matcher<Stmt> | implicitValueInitExpr | Matcher<ImplicitValueInitExpr>... | |
Matches implicit initializers of init list expressions.
Given
point ptarray[10] = { [2].y = 1.0, [2].x = 2.0, [0].x = 1.0 };
implicitValueInitExpr()
matches "[0].y" (implicitly)
| |||
| Matcher<Stmt> | initListExpr | Matcher<InitListExpr>... | |
Matches init list expressions.
Given
int a[] = { 1, 2 };
struct B { int x, y; };
B b = { 5, 6 };
initListExpr()
matches "{ 1, 2 }" and "{ 5, 6 }"
| |||
| Matcher<Stmt> | integerLiteral | Matcher<IntegerLiteral>... | |
Matches integer literals of all sizes / encodings, e.g. 1, 1L, 0x1 and 1U. Does not match character-encoded integers such as L'a'. | |||
| Matcher<Stmt> | labelStmt | Matcher<LabelStmt>... | |
Matches label statements. Given goto FOO; FOO: bar(); labelStmt() matches 'FOO:' | |||
| Matcher<Stmt> | lambdaExpr | Matcher<LambdaExpr>... | |
Matches lambda expressions.
Example matches [&](){return 5;}
[&](){return 5;}
| |||
| Matcher<Stmt> | materializeTemporaryExpr | Matcher<MaterializeTemporaryExpr>... | |
Matches nodes where temporaries are materialized.
Example: Given
struct T {void func();};
T f();
void g(T);
materializeTemporaryExpr() matches 'f()' in these statements
T u(f());
g(f());
f().func();
but does not match
f();
| |||
| Matcher<Stmt> | memberExpr | Matcher<MemberExpr>... | |
Matches member expressions.
Given
class Y {
void x() { this->x(); x(); Y y; y.x(); a; this->b; Y::b; }
int a; static int b;
};
memberExpr()
matches this->x, x, y.x, a, this->b
| |||
| Matcher<Stmt> | nullStmt | Matcher<NullStmt>... | |
Matches null statements. foo();; nullStmt() matches the second ';' | |||
| Matcher<Stmt> | objcCatchStmt | Matcher<ObjCAtCatchStmt>... | |
Matches Objective-C @catch statements.
Example matches @catch
@try {}
@catch (...) {}
| |||
| Matcher<Stmt> | objcFinallyStmt | Matcher<ObjCAtFinallyStmt>... | |
Matches Objective-C @finally statements.
Example matches @finally
@try {}
@finally {}
| |||
| Matcher<Stmt> | objcIvarRefExpr | Matcher<ObjCIvarRefExpr>... | |
Matches a reference to an ObjCIvar.
Example: matches "a" in "init" method:
@implementation A {
NSString *a;
}
- (void) init {
a = @"hello";
}
| |||
| Matcher<Stmt> | objcMessageExpr | Matcher<ObjCMessageExpr>... | |
Matches ObjectiveC Message invocation expressions. The innermost message send invokes the "alloc" class method on the NSString class, while the outermost message send invokes the "initWithString" instance method on the object returned from NSString's "alloc". This matcher should match both message sends. [[NSString alloc] initWithString:@"Hello"] | |||
| Matcher<Stmt> | objcThrowStmt | Matcher<ObjCAtThrowStmt>... | |
Matches Objective-C statements. Example matches @throw obj; | |||
| Matcher<Stmt> | objcTryStmt | Matcher<ObjCAtTryStmt>... | |
Matches Objective-C @try statements.
Example matches @try
@try {}
@catch (...) {}
| |||
| Matcher<Stmt> | ompExecutableDirective | Matcher<OMPExecutableDirective>... | |
Matches any ``#pragma omp`` executable directive. Given #pragma omp parallel #pragma omp parallel default(none) #pragma omp taskyield ``ompExecutableDirective()`` matches ``omp parallel``, ``omp parallel default(none)`` and ``omp taskyield``. | |||
| Matcher<Stmt> | opaqueValueExpr | Matcher<OpaqueValueExpr>... | |
Matches opaque value expressions. They are used as helpers to reference another expressions and can be met in BinaryConditionalOperators, for example. Example matches 'a' (a ?: c) + 42; | |||
| Matcher<Stmt> | parenExpr | Matcher<ParenExpr>... | |
Matches parentheses used in expressions.
Example matches (foo() + 1)
int foo() { return 1; }
int a = (foo() + 1);
| |||
| Matcher<Stmt> | parenListExpr | Matcher<ParenListExpr>... | |
Matches paren list expressions.
ParenListExprs don't have a predefined type and are used for late parsing.
In the final AST, they can be met in template declarations.
Given
template<typename T> class X {
void f() {
X x(*this);
int a = 0, b = 1; int i = (a, b);
}
};
parenListExpr() matches "*this" but NOT matches (a, b) because (a, b)
has a predefined type and is a ParenExpr, not a ParenListExpr.
| |||
| Matcher<Stmt> | predefinedExpr | Matcher<PredefinedExpr>... | |
Matches predefined identifier expressions [C99 6.4.2.2].
Example: Matches __func__
printf("%s", __func__);
| |||
| Matcher<Stmt> | returnStmt | Matcher<ReturnStmt>... | |
Matches return statements. Given return 1; returnStmt() matches 'return 1' | |||
| Matcher<Stmt> | stmt | Matcher<Stmt>... | |
Matches statements.
Given
{ ++a; }
stmt()
matches both the compound statement '{ ++a; }' and '++a'.
| |||
| Matcher<Stmt> | stmtExpr | Matcher<StmtExpr>... | |
Matches statement expression (GNU extension).
Example match: ({ int X = 4; X; })
int C = ({ int X = 4; X; });
| |||
| Matcher<Stmt> | stringLiteral | Matcher<StringLiteral>... | |
Matches string literals (also matches wide string literals). Example matches "abcd", L"abcd" char *s = "abcd"; wchar_t *ws = L"abcd"; | |||
| Matcher<Stmt> | substNonTypeTemplateParmExpr | Matcher<SubstNonTypeTemplateParmExpr>... | |
Matches substitutions of non-type template parameters.
Given
template <int N>
struct A { static const int n = N; };
struct B : public A<42> {};
substNonTypeTemplateParmExpr()
matches "N" in the right-hand side of "static const int n = N;"
| |||
| Matcher<Stmt> | switchCase | Matcher<SwitchCase>... | |
Matches case and default statements inside switch statements.
Given
switch(a) { case 42: break; default: break; }
switchCase()
matches 'case 42:' and 'default:'.
| |||
| Matcher<Stmt> | switchStmt | Matcher<SwitchStmt>... | |
Matches switch statements.
Given
switch(a) { case 42: break; default: break; }
switchStmt()
matches 'switch(a)'.
| |||
| Matcher<Stmt> | unaryExprOrTypeTraitExpr | Matcher<UnaryExprOrTypeTraitExpr>... | |
Matches sizeof (C99), alignof (C++11) and vec_step (OpenCL) Given Foo x = bar; int y = sizeof(x) + alignof(x); unaryExprOrTypeTraitExpr() matches sizeof(x) and alignof(x) | |||
| Matcher<Stmt> | unaryOperator | Matcher<UnaryOperator>... | |
Matches unary operator expressions. Example matches !a !a || b | |||
| Matcher<Stmt> | unresolvedLookupExpr | Matcher<UnresolvedLookupExpr>... | |
Matches reference to a name that can be looked up during parsing
but could not be resolved to a specific declaration.
Given
template<typename T>
T foo() { T a; return a; }
template<typename T>
void bar() {
foo<T>();
}
unresolvedLookupExpr()
matches foo<T>() | |||
| Matcher<Stmt> | unresolvedMemberExpr | Matcher<UnresolvedMemberExpr>... | |
Matches unresolved member expressions.
Given
struct X {
template <class T> void f();
void g();
};
template <class T> void h() { X x; x.f<T>(); x.g(); }
unresolvedMemberExpr()
matches x.f<T>
| |||
| Matcher<Stmt> | userDefinedLiteral | Matcher<UserDefinedLiteral>... | |
Matches user defined literal operator call. Example match: "foo"_suffix | |||
| Matcher<Stmt> | whileStmt | Matcher<WhileStmt>... | |
Matches while statements.
Given
while (true) {}
whileStmt()
matches 'while (true) {}'.
| |||
| Matcher<TemplateArgument> | templateArgument | Matcher<TemplateArgument>... | |
Matches template arguments.
Given
template <typename T> struct C {};
C<int> c;
templateArgument()
matches 'int' in C<int>.
| |||
| Matcher<TemplateName> | templateName | Matcher<TemplateName>... | |
Matches template name.
Given
template <typename T> class X { };
X<int> xi;
templateName()
matches 'X' in X<int>.
| |||
| Matcher<TypeLoc> | typeLoc | Matcher<TypeLoc>... | |
Matches TypeLocs in the clang AST. | |||
| Matcher<Type> | arrayType | Matcher<ArrayType>... | |
Matches all kinds of arrays.
Given
int a[] = { 2, 3 };
int b[4];
void f() { int c[a[0]]; }
arrayType()
matches "int a[]", "int b[4]" and "int c[a[0]]";
| |||
| Matcher<Type> | atomicType | Matcher<AtomicType>... | |
Matches atomic types. Given _Atomic(int) i; atomicType() matches "_Atomic(int) i" | |||
| Matcher<Type> | autoType | Matcher<AutoType>... | |
Matches types nodes representing C++11 auto types.
Given:
auto n = 4;
int v[] = { 2, 3 }
for (auto i : v) { }
autoType()
matches "auto n" and "auto i"
| |||
| Matcher<Type> | blockPointerType | Matcher<BlockPointerType>... | |
Matches block pointer types, i.e. types syntactically represented as "void (^)(int)". The pointee is always required to be a FunctionType. | |||
| Matcher<Type> | builtinType | Matcher<BuiltinType>... | |
Matches builtin Types.
Given
struct A {};
A a;
int b;
float c;
bool d;
builtinType()
matches "int b", "float c" and "bool d"
| |||
| Matcher<Type> | complexType | Matcher<ComplexType>... | |
Matches C99 complex types. Given _Complex float f; complexType() matches "_Complex float f" | |||
| Matcher<Type> | constantArrayType | Matcher<ConstantArrayType>... | |
Matches C arrays with a specified constant size.
Given
void() {
int a[2];
int b[] = { 2, 3 };
int c[b[0]];
}
constantArrayType()
matches "int a[2]"
| |||
| Matcher<Type> | decayedType | Matcher<DecayedType>... | |
Matches decayed type
Example matches i[] in declaration of f.
(matcher = valueDecl(hasType(decayedType(hasDecayedType(pointerType())))))
Example matches i[1].
(matcher = expr(hasType(decayedType(hasDecayedType(pointerType())))))
void f(int i[]) {
i[1] = 0;
}
| |||
| Matcher<Type> | decltypeType | Matcher<DecltypeType>... | |
Matches types nodes representing C++11 decltype(<expr>) types. Given: short i = 1; int j = 42; decltype(i + j) result = i + j; decltypeType() matches "decltype(i + j)" | |||
| Matcher<Type> | deducedTemplateSpecializationType | Matcher<DeducedTemplateSpecializationType>... | |
Matches C++17 deduced template specialization types, e.g. deduced class
template types.
Given
template <typename T>
class C { public: C(T); };
C c(123);
deducedTemplateSpecializationType() matches the type in the declaration
of the variable c.
| |||
| Matcher<Type> | dependentSizedArrayType | Matcher<DependentSizedArrayType>... | |
Matches C++ arrays whose size is a value-dependent expression.
Given
template<typename T, int Size>
class array {
T data[Size];
};
dependentSizedArrayType
matches "T data[Size]"
| |||
| Matcher<Type> | elaboratedType | Matcher<ElaboratedType>... | |
Matches types specified with an elaborated type keyword or with a
qualified name.
Given
namespace N {
namespace M {
class D {};
}
}
class C {};
class C c;
N::M::D d;
elaboratedType() matches the type of the variable declarations of both
c and d.
| |||
| Matcher<Type> | enumType | Matcher<EnumType>... | |
Matches enum types.
Given
enum C { Green };
enum class S { Red };
C c;
S s;
enumType() matches the type of the variable declarations of both c and
s.
| |||
| Matcher<Type> | functionProtoType | Matcher<FunctionProtoType>... | |
Matches FunctionProtoType nodes. Given int (*f)(int); void g(); functionProtoType() matches "int (*f)(int)" and the type of "g" in C++ mode. In C mode, "g" is not matched because it does not contain a prototype. | |||
| Matcher<Type> | functionType | Matcher<FunctionType>... | |
Matches FunctionType nodes. Given int (*f)(int); void g(); functionType() matches "int (*f)(int)" and the type of "g". | |||
| Matcher<Type> | incompleteArrayType | Matcher<IncompleteArrayType>... | |
Matches C arrays with unspecified size.
Given
int a[] = { 2, 3 };
int b[42];
void f(int c[]) { int d[a[0]]; };
incompleteArrayType()
matches "int a[]" and "int c[]"
| |||
| Matcher<Type> | injectedClassNameType | Matcher<InjectedClassNameType>... | |
Matches injected class name types.
Example matches S s, but not S<T> s.
(matcher = parmVarDecl(hasType(injectedClassNameType())))
template <typename T> struct S {
void f(S s);
void g(S<T> s);
};
| |||
| Matcher<Type> | lValueReferenceType | Matcher<LValueReferenceType>... | |
Matches lvalue reference types. Given: int *a; int &b = *a; int &&c = 1; auto &d = b; auto &&e = c; auto &&f = 2; int g = 5; lValueReferenceType() matches the types of b, d, and e. e is matched since the type is deduced as int& by reference collapsing rules. | |||
| Matcher<Type> | memberPointerType | Matcher<MemberPointerType>... | |
Matches member pointer types.
Given
struct A { int i; }
A::* ptr = A::i;
memberPointerType()
matches "A::* ptr"
| |||
| Matcher<Type> | objcObjectPointerType | Matcher<ObjCObjectPointerType>... | |
Matches an Objective-C object pointer type, which is different from a pointer type, despite being syntactically similar. Given int *a; @interface Foo @end Foo *f; pointerType() matches "Foo *f", but does not match "int *a". | |||
| Matcher<Type> | parenType | Matcher<ParenType>... | |
Matches ParenType nodes. Given int (*ptr_to_array)[4]; int *array_of_ptrs[4]; varDecl(hasType(pointsTo(parenType()))) matches ptr_to_array but not array_of_ptrs. | |||
| Matcher<Type> | pointerType | Matcher<PointerType>... | |
Matches pointer types, but does not match Objective-C object pointer types. Given int *a; int &b = *a; int c = 5; @interface Foo @end Foo *f; pointerType() matches "int *a", but does not match "Foo *f". | |||
| Matcher<Type> | rValueReferenceType | Matcher<RValueReferenceType>... | |
Matches rvalue reference types. Given: int *a; int &b = *a; int &&c = 1; auto &d = b; auto &&e = c; auto &&f = 2; int g = 5; rValueReferenceType() matches the types of c and f. e is not matched as it is deduced to int& by reference collapsing rules. | |||
| Matcher<Type> | recordType | Matcher<RecordType>... | |
Matches record types (e.g. structs, classes).
Given
class C {};
struct S {};
C c;
S s;
recordType() matches the type of the variable declarations of both c
and s.
| |||
| Matcher<Type> | referenceType | Matcher<ReferenceType>... | |
Matches both lvalue and rvalue reference types. Given int *a; int &b = *a; int &&c = 1; auto &d = b; auto &&e = c; auto &&f = 2; int g = 5; referenceType() matches the types of b, c, d, e, and f. | |||
| Matcher<Type> | substTemplateTypeParmType | Matcher<SubstTemplateTypeParmType>... | |
Matches types that represent the result of substituting a type for a
template type parameter.
Given
template <typename T>
void F(T t) {
int i = 1 + t;
}
substTemplateTypeParmType() matches the type of 't' but not '1'
| |||
| Matcher<Type> | tagType | Matcher<TagType>... | |
Matches tag types (record and enum types).
Given
enum E {};
class C {};
E e;
C c;
tagType() matches the type of the variable declarations of both e
and c.
| |||
| Matcher<Type> | templateSpecializationType | Matcher<TemplateSpecializationType>... | |
Matches template specialization types.
Given
template <typename T>
class C { };
template class C<int>; // A
C<char> var; // B
templateSpecializationType() matches the type of the explicit
instantiation in A and the type of the variable declaration in B.
| |||
| Matcher<Type> | templateTypeParmType | Matcher<TemplateTypeParmType>... | |
Matches template type parameter types.
Example matches T, but not int.
(matcher = templateTypeParmType())
template <typename T> void f(int i);
| |||
| Matcher<Type> | type | Matcher<Type>... | |
Matches Types in the clang AST. | |||
| Matcher<Type> | typedefType | Matcher<TypedefType>... | |
Matches typedef types. Given typedef int X; typedefType() matches "typedef int X" | |||
| Matcher<Type> | unaryTransformType | Matcher<UnaryTransformType>... | |
Matches types nodes representing unary type transformations. Given: typedef __underlying_type(T) type; unaryTransformType() matches "__underlying_type(T)" | |||
| Matcher<Type> | variableArrayType | Matcher<VariableArrayType>... | |
Matches C arrays with a specified size that is not an
integer-constant-expression.
Given
void f() {
int a[] = { 2, 3 }
int b[42];
int c[a[0]];
}
variableArrayType()
matches "int c[a[0]]"
| |||
Narrowing Matchers
Narrowing matchers match certain attributes on the current node, thus narrowing down the set of nodes of the current type to match on.
There are special logical narrowing matchers (allOf, anyOf, anything and unless) which allow users to create more powerful match expressions.
| Return type | Name | Parameters | |
|---|---|---|---|
| Matcher<*> | allOf | Matcher<*>, ..., Matcher<*> | |
Matches if all given matchers match. Usable as: Any Matcher | |||
| Matcher<*> | anyOf | Matcher<*>, ..., Matcher<*> | |
Matches if any of the given matchers matches. Usable as: Any Matcher | |||
| Matcher<*> | anything | ||
Matches any node. Useful when another matcher requires a child matcher, but there's no additional constraint. This will often be used with an explicit conversion to an internal::Matcher<> type such as TypeMatcher. Example: DeclarationMatcher(anything()) matches all declarations, e.g., "int* p" and "void f()" in int* p; void f(); Usable as: Any Matcher | |||
| Matcher<*> | unless | Matcher<*> | |
Matches if the provided matcher does not match.
Example matches Y (matcher = cxxRecordDecl(unless(hasName("X"))))
class X {};
class Y {};
Usable as: Any Matcher
| |||
| Matcher<BinaryOperator> | hasAnyOperatorName | StringRef, ..., StringRef | |
Matches operator expressions (binary or unary) that have any of the
specified names.
hasAnyOperatorName("+", "-")
Is equivalent to
anyOf(hasOperatorName("+"), hasOperatorName("-"))
| |||
| Matcher<BinaryOperator> | hasOperatorName | std::string Name | |
Matches the operator Name of operator expressions (binary or
unary).
Example matches a || b (matcher = binaryOperator(hasOperatorName("||")))
!(a || b)
| |||
| Matcher<BinaryOperator> | isAssignmentOperator | ||
Matches all kinds of assignment operators.
Example 1: matches a += b (matcher = binaryOperator(isAssignmentOperator()))
if (a == b)
a += b;
Example 2: matches s1 = s2
(matcher = cxxOperatorCallExpr(isAssignmentOperator()))
struct S { S& operator=(const S&); };
void x() { S s1, s2; s1 = s2; }
| |||
| Matcher<BinaryOperator> | isComparisonOperator | ||
Matches comparison operators.
Example 1: matches a == b (matcher = binaryOperator(isComparisonOperator()))
if (a == b)
a += b;
Example 2: matches s1 < s2
(matcher = cxxOperatorCallExpr(isComparisonOperator()))
struct S { bool operator<(const S& other); };
void x(S s1, S s2) { bool b1 = s1 < s2; }
| |||
| Matcher<CXXBaseSpecifier> | isPrivate | ||
Matches private C++ declarations and C++ base specifers that specify private
inheritance.
Examples:
class C {
public: int a;
protected: int b;
private: int c; // fieldDecl(isPrivate()) matches 'c'
};
struct Base {};
struct Derived1 : private Base {}; // matches 'Base'
class Derived2 : Base {}; // matches 'Base'
| |||
| Matcher<CXXBaseSpecifier> | isProtected | ||
Matches protected C++ declarations and C++ base specifers that specify
protected inheritance.
Examples:
class C {
public: int a;
protected: int b; // fieldDecl(isProtected()) matches 'b'
private: int c;
};
class Base {};
class Derived : protected Base {}; // matches 'Base'
| |||
| Matcher<CXXBaseSpecifier> | isPublic | ||
Matches public C++ declarations and C++ base specifers that specify public
inheritance.
Examples:
class C {
public: int a; // fieldDecl(isPublic()) matches 'a'
protected: int b;
private: int c;
};
class Base {};
class Derived1 : public Base {}; // matches 'Base'
struct Derived2 : Base {}; // matches 'Base'
| |||
| Matcher<CXXBaseSpecifier> | isVirtual | ||
Matches declarations of virtual methods and C++ base specifers that specify
virtual inheritance.
Example:
class A {
public:
virtual void x(); // matches x
};
Example:
class Base {};
class DirectlyDerived : virtual Base {}; // matches Base
class IndirectlyDerived : DirectlyDerived, Base {}; // matches Base
Usable as: Matcher<CXXMethodDecl>, Matcher<CXXBaseSpecifier>
| |||
| Matcher<CXXBoolLiteralExpr> | equals | bool Value | |
| Matcher<CXXBoolLiteralExpr> | equals | const ValueT Value | |
Matches literals that are equal to the given value of type ValueT.
Given
f('false, 3.14, 42);
characterLiteral(equals(0))
matches 'cxxBoolLiteral(equals(false)) and cxxBoolLiteral(equals(0))
match false
floatLiteral(equals(3.14)) and floatLiteral(equals(314e-2))
match 3.14
integerLiteral(equals(42))
matches 42
Note that you cannot directly match a negative numeric literal because the
minus sign is not part of the literal: It is a unary operator whose operand
is the positive numeric literal. Instead, you must use a unaryOperator()
matcher to match the minus sign:
unaryOperator(hasOperatorName("-"),
hasUnaryOperand(integerLiteral(equals(13))))
Usable as: Matcher<CharacterLiteral>, Matcher<CXXBoolLiteralExpr>,
Matcher<FloatingLiteral>, Matcher<IntegerLiteral>
| |||
| Matcher<CXXBoolLiteralExpr> | equals | double Value | |
| Matcher<CXXBoolLiteralExpr> | equals | unsigned Value | |
| Matcher<CXXCatchStmt> | isCatchAll | ||
Matches a C++ catch statement that has a catch-all handler.
Given
try {
// ...
} catch (int) {
// ...
} catch (...) {
// ...
}
cxxCatchStmt(isCatchAll()) matches catch(...) but not catch(int).
| |||
| Matcher<CXXConstructExpr> | argumentCountIs | unsigned N | |
Checks that a call expression or a constructor call expression has a specific number of arguments (including absent default arguments). Example matches f(0, 0) (matcher = callExpr(argumentCountIs(2))) void f(int x, int y); f(0, 0); | |||
| Matcher<CXXConstructExpr> | isListInitialization | ||
Matches a constructor call expression which uses list initialization. | |||
| Matcher<CXXConstructExpr> | requiresZeroInitialization | ||
Matches a constructor call expression which requires
zero initialization.
Given
void foo() {
struct point { double x; double y; };
point pt[2] = { { 1.0, 2.0 } };
}
initListExpr(has(cxxConstructExpr(requiresZeroInitialization()))
will match the implicit array filler for pt[1].
| |||
| Matcher<CXXConstructorDecl> | isCopyConstructor | ||
Matches constructor declarations that are copy constructors.
Given
struct S {
S(); // #1
S(const S &); // #2
S(S &&); // #3
};
cxxConstructorDecl(isCopyConstructor()) will match #2, but not #1 or #3.
| |||
| Matcher<CXXConstructorDecl> | isDefaultConstructor | ||
Matches constructor declarations that are default constructors.
Given
struct S {
S(); // #1
S(const S &); // #2
S(S &&); // #3
};
cxxConstructorDecl(isDefaultConstructor()) will match #1, but not #2 or #3.
| |||
| Matcher<CXXConstructorDecl> | isDelegatingConstructor | ||
Matches constructors that delegate to another constructor.
Given
struct S {
S(); // #1
S(int) {} // #2
S(S &&) : S() {} // #3
};
S::S() : S(0) {} // #4
cxxConstructorDecl(isDelegatingConstructor()) will match #3 and #4, but not
#1 or #2.
| |||
| Matcher<CXXConstructorDecl> | isExplicit | ||
Matches constructor, conversion function, and deduction guide declarations
that have an explicit specifier if this explicit specifier is resolved to
true.
Given
template<bool b>
struct S {
S(int); // #1
explicit S(double); // #2
operator int(); // #3
explicit operator bool(); // #4
explicit(false) S(bool) // # 7
explicit(true) S(char) // # 8
explicit(b) S(S) // # 9
};
S(int) -> S<true> // #5
explicit S(double) -> S<false> // #6
cxxConstructorDecl(isExplicit()) will match #2 and #8, but not #1, #7 or #9.
cxxConversionDecl(isExplicit()) will match #4, but not #3.
cxxDeductionGuideDecl(isExplicit()) will match #6, but not #5.
| |||
| Matcher<CXXConstructorDecl> | isMoveConstructor | ||
Matches constructor declarations that are move constructors.
Given
struct S {
S(); // #1
S(const S &); // #2
S(S &&); // #3
};
cxxConstructorDecl(isMoveConstructor()) will match #3, but not #1 or #2.
| |||
| Matcher<CXXConversionDecl> | isExplicit | ||
Matches constructor, conversion function, and deduction guide declarations
that have an explicit specifier if this explicit specifier is resolved to
true.
Given
template<bool b>
struct S {
S(int); // #1
explicit S(double); // #2
operator int(); // #3
explicit operator bool(); // #4
explicit(false) S(bool) // # 7
explicit(true) S(char) // # 8
explicit(b) S(S) // # 9
};
S(int) -> S<true> // #5
explicit S(double) -> S<false> // #6
cxxConstructorDecl(isExplicit()) will match #2 and #8, but not #1, #7 or #9.
cxxConversionDecl(isExplicit()) will match #4, but not #3.
cxxDeductionGuideDecl(isExplicit()) will match #6, but not #5.
| |||
| Matcher<CXXCtorInitializer> | isBaseInitializer | ||
Matches a constructor initializer if it is initializing a base, as
opposed to a member.
Given
struct B {};
struct D : B {
int I;
D(int i) : I(i) {}
};
struct E : B {
E() : B() {}
};
cxxConstructorDecl(hasAnyConstructorInitializer(isBaseInitializer()))
will match E(), but not match D(int).
| |||
| Matcher<CXXCtorInitializer> | isMemberInitializer | ||
Matches a constructor initializer if it is initializing a member, as
opposed to a base.
Given
struct B {};
struct D : B {
int I;
D(int i) : I(i) {}
};
struct E : B {
E() : B() {}
};
cxxConstructorDecl(hasAnyConstructorInitializer(isMemberInitializer()))
will match D(int), but not match E().
| |||
| Matcher<CXXCtorInitializer> | isWritten | ||
Matches a constructor initializer if it is explicitly written in
code (as opposed to implicitly added by the compiler).
Given
struct Foo {
Foo() { }
Foo(int) : foo_("A") { }
string foo_;
};
cxxConstructorDecl(hasAnyConstructorInitializer(isWritten()))
will match Foo(int), but not Foo()
| |||
| Matcher<CXXDeductionGuideDecl> | isExplicit | ||
Matches constructor, conversion function, and deduction guide declarations
that have an explicit specifier if this explicit specifier is resolved to
true.
Given
template<bool b>
struct S {
S(int); // #1
explicit S(double); // #2
operator int(); // #3
explicit operator bool(); // #4
explicit(false) S(bool) // # 7
explicit(true) S(char) // # 8
explicit(b) S(S) // # 9
};
S(int) -> S<true> // #5
explicit S(double) -> S<false> // #6
cxxConstructorDecl(isExplicit()) will match #2 and #8, but not #1, #7 or #9.
cxxConversionDecl(isExplicit()) will match #4, but not #3.
cxxDeductionGuideDecl(isExplicit()) will match #6, but not #5.
| |||
| Matcher<CXXDependentScopeMemberExpr> | isArrow | ||
Matches member expressions that are called with '->' as opposed
to '.'.
Member calls on the implicit this pointer match as called with '->'.
Given
class Y {
void x() { this->x(); x(); Y y; y.x(); a; this->b; Y::b; }
template <class T> void f() { this->f<T>(); f<T>(); }
int a;
static int b;
};
template <class T>
class Z {
void x() { this->m; }
};
memberExpr(isArrow())
matches this->x, x, y.x, a, this->b
cxxDependentScopeMemberExpr(isArrow())
matches this->m
unresolvedMemberExpr(isArrow())
matches this->f<T>, f<T>
| |||
| Matcher<CXXMethodDecl> | isConst | ||
Matches if the given method declaration is const.
Given
struct A {
void foo() const;
void bar();
};
cxxMethodDecl(isConst()) matches A::foo() but not A::bar()
| |||
| Matcher<CXXMethodDecl> | isCopyAssignmentOperator | ||
Matches if the given method declaration declares a copy assignment
operator.
Given
struct A {
A &operator=(const A &);
A &operator=(A &&);
};
cxxMethodDecl(isCopyAssignmentOperator()) matches the first method but not
the second one.
| |||
| Matcher<CXXMethodDecl> | isFinal | ||
Matches if the given method or class declaration is final.
Given:
class A final {};
struct B {
virtual void f();
};
struct C : B {
void f() final;
};
matches A and C::f, but not B, C, or B::f
| |||
| Matcher<CXXMethodDecl> | isMoveAssignmentOperator | ||
Matches if the given method declaration declares a move assignment
operator.
Given
struct A {
A &operator=(const A &);
A &operator=(A &&);
};
cxxMethodDecl(isMoveAssignmentOperator()) matches the second method but not
the first one.
| |||
| Matcher<CXXMethodDecl> | isOverride | ||
Matches if the given method declaration overrides another method.
Given
class A {
public:
virtual void x();
};
class B : public A {
public:
virtual void x();
};
matches B::x
| |||
| Matcher<CXXMethodDecl> | isPure | ||
Matches if the given method declaration is pure.
Given
class A {
public:
virtual void x() = 0;
};
matches A::x
| |||
| Matcher<CXXMethodDecl> | isUserProvided | ||
Matches method declarations that are user-provided.
Given
struct S {
S(); // #1
S(const S &) = default; // #2
S(S &&) = delete; // #3
};
cxxConstructorDecl(isUserProvided()) will match #1, but not #2 or #3.
| |||
| Matcher<CXXMethodDecl> | isVirtual | ||
Matches declarations of virtual methods and C++ base specifers that specify
virtual inheritance.
Example:
class A {
public:
virtual void x(); // matches x
};
Example:
class Base {};
class DirectlyDerived : virtual Base {}; // matches Base
class IndirectlyDerived : DirectlyDerived, Base {}; // matches Base
Usable as: Matcher<CXXMethodDecl>, Matcher<CXXBaseSpecifier>
| |||
| Matcher<CXXMethodDecl> | isVirtualAsWritten | ||
Matches if the given method declaration has an explicit "virtual".
Given
class A {
public:
virtual void x();
};
class B : public A {
public:
void x();
};
matches A::x but not B::x
| |||
| Matcher<CXXNewExpr> | isArray | ||
Matches array new expressions. Given: MyClass *p1 = new MyClass[10]; cxxNewExpr(isArray()) matches the expression 'new MyClass[10]'. | |||
| Matcher<CXXOperatorCallExpr> | hasAnyOverloadedOperatorName | StringRef, ..., StringRef | |
Matches overloaded operator names.
Matches overloaded operator names specified in strings without the
"operator" prefix: e.g. "<<".
hasAnyOverloadesOperatorName("+", "-")
Is equivalent to
anyOf(hasOverloadedOperatorName("+"), hasOverloadedOperatorName("-"))
| |||
| Matcher<CXXOperatorCallExpr> | hasOverloadedOperatorName | StringRef Name | |
Matches overloaded operator names.
Matches overloaded operator names specified in strings without the
"operator" prefix: e.g. "<<".
Given:
class A { int operator*(); };
const A &operator<<(const A &a, const A &b);
A a;
a << a; // <-- This matches
cxxOperatorCallExpr(hasOverloadedOperatorName("<<"))) matches the
specified line and
cxxRecordDecl(hasMethod(hasOverloadedOperatorName("*")))
matches the declaration of A.
Usable as: Matcher<CXXOperatorCallExpr>, Matcher<FunctionDecl>
| |||
| Matcher<CXXOperatorCallExpr> | isAssignmentOperator | ||
Matches all kinds of assignment operators.
Example 1: matches a += b (matcher = binaryOperator(isAssignmentOperator()))
if (a == b)
a += b;
Example 2: matches s1 = s2
(matcher = cxxOperatorCallExpr(isAssignmentOperator()))
struct S { S& operator=(const S&); };
void x() { S s1, s2; s1 = s2; }
| |||
| Matcher<CXXOperatorCallExpr> | isComparisonOperator | ||
Matches comparison operators.
Example 1: matches a == b (matcher = binaryOperator(isComparisonOperator()))
if (a == b)
a += b;
Example 2: matches s1 < s2
(matcher = cxxOperatorCallExpr(isComparisonOperator()))
struct S { bool operator<(const S& other); };
void x(S s1, S s2) { bool b1 = s1 < s2; }
| |||
| Matcher<CXXRecordDecl> | hasDefinition | ||
Matches a class declaration that is defined.
Example matches x (matcher = cxxRecordDecl(hasDefinition()))
class x {};
class y;
| |||
| Matcher<CXXRecordDecl> | isDerivedFrom | std::string BaseName | |
Overloaded method as shortcut for isDerivedFrom(hasName(...)). | |||
| Matcher<CXXRecordDecl> | isDirectlyDerivedFrom | std::string BaseName | |
Overloaded method as shortcut for isDirectlyDerivedFrom(hasName(...)). | |||
| Matcher<CXXRecordDecl> | isExplicitTemplateSpecialization | ||
Matches explicit template specializations of function, class, or
static member variable template instantiations.
Given
template<typename T> void A(T t) { }
template<> void A(int N) { }
functionDecl(isExplicitTemplateSpecialization())
matches the specialization A<int>().
Usable as: Matcher<FunctionDecl>, Matcher<VarDecl>, Matcher<CXXRecordDecl>
| |||
| Matcher<CXXRecordDecl> | isFinal | ||
Matches if the given method or class declaration is final.
Given:
class A final {};
struct B {
virtual void f();
};
struct C : B {
void f() final;
};
matches A and C::f, but not B, C, or B::f
| |||
| Matcher<CXXRecordDecl> | isLambda | ||
Matches the generated class of lambda expressions.
Given:
auto x = []{};
cxxRecordDecl(isLambda()) matches the implicit class declaration of
decltype(x)
| |||
| Matcher<CXXRecordDecl> | isSameOrDerivedFrom | std::string BaseName | |
Overloaded method as shortcut for isSameOrDerivedFrom(hasName(...)). | |||
| Matcher<CXXRecordDecl> | isTemplateInstantiation | ||
Matches template instantiations of function, class, or static
member variable template instantiations.
Given
template <typename T> class X {}; class A {}; X<A> x;
or
template <typename T> class X {}; class A {}; template class X<A>;
or
template <typename T> class X {}; class A {}; extern template class X<A>;
cxxRecordDecl(hasName("::X"), isTemplateInstantiation())
matches the template instantiation of X<A>.
But given
template <typename T> class X {}; class A {};
template <> class X<A> {}; X<A> x;
cxxRecordDecl(hasName("::X"), isTemplateInstantiation())
does not match, as X<A> is an explicit template specialization.
Usable as: Matcher<FunctionDecl>, Matcher<VarDecl>, Matcher<CXXRecordDecl>
| |||
| Matcher<CallExpr> | argumentCountIs | unsigned N | |
Checks that a call expression or a constructor call expression has a specific number of arguments (including absent default arguments). Example matches f(0, 0) (matcher = callExpr(argumentCountIs(2))) void f(int x, int y); f(0, 0); | |||
| Matcher<CallExpr> | usesADL | ||
Matches call expressions which were resolved using ADL.
Example matches y(x) but not y(42) or NS::y(x).
namespace NS {
struct X {};
void y(X);
}
void y(...);
void test() {
NS::X x;
y(x); // Matches
NS::y(x); // Doesn't match
y(42); // Doesn't match
using NS::y;
y(x); // Found by both unqualified lookup and ADL, doesn't match
}
| |||
| Matcher<CastExpr> | hasCastKind | CastKind Kind | |
Matches casts that has a given cast kind.
Example: matches the implicit cast around 0
(matcher = castExpr(hasCastKind(CK_NullToPointer)))
int *p = 0;
If the matcher is use from clang-query, CastKind parameter
should be passed as a quoted string. e.g., hasCastKind("CK_NullToPointer").
| |||
| Matcher<CharacterLiteral> | equals | bool Value | |
| Matcher<CharacterLiteral> | equals | const ValueT Value | |
Matches literals that are equal to the given value of type ValueT.
Given
f('false, 3.14, 42);
characterLiteral(equals(0))
matches 'cxxBoolLiteral(equals(false)) and cxxBoolLiteral(equals(0))
match false
floatLiteral(equals(3.14)) and floatLiteral(equals(314e-2))
match 3.14
integerLiteral(equals(42))
matches 42
Note that you cannot directly match a negative numeric literal because the
minus sign is not part of the literal: It is a unary operator whose operand
is the positive numeric literal. Instead, you must use a unaryOperator()
matcher to match the minus sign:
unaryOperator(hasOperatorName("-"),
hasUnaryOperand(integerLiteral(equals(13))))
Usable as: Matcher<CharacterLiteral>, Matcher<CXXBoolLiteralExpr>,
Matcher<FloatingLiteral>, Matcher<IntegerLiteral>
| |||
| Matcher<CharacterLiteral> | equals | double Value | |
| Matcher<CharacterLiteral> | equals | unsigned Value | |
| Matcher<ClassTemplateSpecializationDecl> | templateArgumentCountIs | unsigned N | |
Matches if the number of template arguments equals N.
Given
template<typename T> struct C {};
C<int> c;
classTemplateSpecializationDecl(templateArgumentCountIs(1))
matches C<int>.
| |||
| Matcher<CompoundStmt> | statementCountIs | unsigned N | |
Checks that a compound statement contains a specific number of
child statements.
Example: Given
{ for (;;) {} }
compoundStmt(statementCountIs(0)))
matches '{}'
but does not match the outer compound statement.
| |||
| Matcher<ConstantArrayType> | hasSize | unsigned N | |
Matches nodes that have the specified size. Given int a[42]; int b[2 * 21]; int c[41], d[43]; char *s = "abcd"; wchar_t *ws = L"abcd"; char *w = "a"; constantArrayType(hasSize(42)) matches "int a[42]" and "int b[2 * 21]" stringLiteral(hasSize(4)) matches "abcd", L"abcd" | |||
| Matcher<DeclStmt> | declCountIs | unsigned N | |
Matches declaration statements that contain a specific number of declarations. Example: Given int a, b; int c; int d = 2, e; declCountIs(2) matches 'int a, b;' and 'int d = 2, e;', but not 'int c;'. | |||
| Matcher<Decl> | equalsBoundNode | std::string ID | |
Matches if a node equals a previously bound node.
Matches a node if it equals the node previously bound to ID.
Given
class X { int a; int b; };
cxxRecordDecl(
has(fieldDecl(hasName("a"), hasType(type().bind("t")))),
has(fieldDecl(hasName("b"), hasType(type(equalsBoundNode("t"))))))
matches the class X, as a and b have the same type.
Note that when multiple matches are involved via forEach* matchers,
equalsBoundNodes acts as a filter.
For example:
compoundStmt(
forEachDescendant(varDecl().bind("d")),
forEachDescendant(declRefExpr(to(decl(equalsBoundNode("d"))))))
will trigger a match for each combination of variable declaration
and reference to that variable declaration within a compound statement.
| |||
| Matcher<Decl> | equalsNode | const Decl* Other | |
Matches if a node equals another node. Decl has pointer identity in the AST. | |||
| Matcher<Decl> | hasAttr | attr::Kind AttrKind | |
Matches declaration that has a given attribute.
Given
__attribute__((device)) void f() { ... }
decl(hasAttr(clang::attr::CUDADevice)) matches the function declaration of
f. If the matcher is used from clang-query, attr::Kind parameter should be
passed as a quoted string. e.g., hasAttr("attr::CUDADevice").
| |||
| Matcher<Decl> | isExpansionInFileMatching | StringRef RegExp, Regex::RegexFlags Flags = NoFlags | |
Matches AST nodes that were expanded within files whose name is
partially matching a given regex.
Example matches Y but not X
(matcher = cxxRecordDecl(isExpansionInFileMatching("AST.*"))
#include "ASTMatcher.h"
class X {};
ASTMatcher.h:
class Y {};
Usable as: Matcher<Decl>, Matcher<Stmt>, Matcher<TypeLoc>
If the matcher is used in clang-query, RegexFlags parameter
should be passed as a quoted string. e.g: "NoFlags".
Flags can be combined with '|' example "IgnoreCase | BasicRegex"
| |||
| Matcher<Decl> | isExpansionInMainFile | ||
Matches AST nodes that were expanded within the main-file.
Example matches X but not Y
(matcher = cxxRecordDecl(isExpansionInMainFile())
#include <Y.h>
class X {};
Y.h:
class Y {};
Usable as: Matcher<Decl>, Matcher<Stmt>, Matcher<TypeLoc>
| |||
| Matcher<Decl> | isExpansionInSystemHeader | ||
Matches AST nodes that were expanded within system-header-files.
Example matches Y but not X
(matcher = cxxRecordDecl(isExpansionInSystemHeader())
#include <SystemHeader.h>
class X {};
SystemHeader.h:
class Y {};
Usable as: Matcher<Decl>, Matcher<Stmt>, Matcher<TypeLoc>
| |||
| Matcher<Decl> | isImplicit | ||
Matches a declaration that has been implicitly added by the compiler (eg. implicit default/copy constructors). | |||
| Matcher<Decl> | isInStdNamespace | ||
Matches declarations in the namespace `std`, but not in nested namespaces.
Given
class vector {};
namespace foo {
class vector {};
namespace std {
class vector {};
}
}
namespace std {
inline namespace __1 {
class vector {}; // #1
namespace experimental {
class vector {};
}
}
}
cxxRecordDecl(hasName("vector"), isInStdNamespace()) will match only #1.
| |||
| Matcher<Decl> | isInstantiated | ||
Matches declarations that are template instantiations or are inside
template instantiations.
Given
template<typename T> void A(T t) { T i; }
A(0);
A(0U);
functionDecl(isInstantiated())
matches 'A(int) {...};' and 'A(unsigned) {...}'.
| |||
| Matcher<Decl> | isPrivate | ||
Matches private C++ declarations and C++ base specifers that specify private
inheritance.
Examples:
class C {
public: int a;
protected: int b;
private: int c; // fieldDecl(isPrivate()) matches 'c'
};
struct Base {};
struct Derived1 : private Base {}; // matches 'Base'
class Derived2 : Base {}; // matches 'Base'
| |||
| Matcher<Decl> | isProtected | ||
Matches protected C++ declarations and C++ base specifers that specify
protected inheritance.
Examples:
class C {
public: int a;
protected: int b; // fieldDecl(isProtected()) matches 'b'
private: int c;
};
class Base {};
class Derived : protected Base {}; // matches 'Base'
| |||
| Matcher<Decl> | isPublic | ||
Matches public C++ declarations and C++ base specifers that specify public
inheritance.
Examples:
class C {
public: int a; // fieldDecl(isPublic()) matches 'a'
protected: int b;
private: int c;
};
class Base {};
class Derived1 : public Base {}; // matches 'Base'
struct Derived2 : Base {}; // matches 'Base'
| |||
| Matcher<DesignatedInitExpr> | designatorCountIs | unsigned N | |
Matches designated initializer expressions that contain
a specific number of designators.
Example: Given
point ptarray[10] = { [2].y = 1.0, [0].x = 1.0 };
point ptarray2[10] = { [2].y = 1.0, [2].x = 0.0, [0].x = 1.0 };
designatorCountIs(2)
matches '{ [2].y = 1.0, [0].x = 1.0 }',
but not '{ [2].y = 1.0, [2].x = 0.0, [0].x = 1.0 }'.
| |||
| Matcher<EnumDecl> | isScoped | ||
Matches C++11 scoped enum declaration.
Example matches Y (matcher = enumDecl(isScoped()))
enum X {};
enum class Y {};
| |||
| Matcher<Expr> | isInstantiationDependent | ||
Matches expressions that are instantiation-dependent even if it is
neither type- nor value-dependent.
In the following example, the expression sizeof(sizeof(T() + T()))
is instantiation-dependent (since it involves a template parameter T),
but is neither type- nor value-dependent, since the type of the inner
sizeof is known (std::size_t) and therefore the size of the outer
sizeof is known.
template<typename T>
void f(T x, T y) { sizeof(sizeof(T() + T()); }
expr(isInstantiationDependent()) matches sizeof(sizeof(T() + T())
| |||
| Matcher<Expr> | isTypeDependent | ||
Matches expressions that are type-dependent because the template type
is not yet instantiated.
For example, the expressions "x" and "x + y" are type-dependent in
the following code, but "y" is not type-dependent:
template<typename T>
void add(T x, int y) {
x + y;
}
expr(isTypeDependent()) matches x + y
| |||
| Matcher<Expr> | isValueDependent | ||
Matches expression that are value-dependent because they contain a
non-type template parameter.
For example, the array bound of "Chars" in the following example is
value-dependent.
template<int Size> int f() { return Size; }
expr(isValueDependent()) matches return Size
| |||
| Matcher<Expr> | nullPointerConstant | ||
Matches expressions that resolve to a null pointer constant, such as GNU's __null, C++11's nullptr, or C's NULL macro. Given: void *v1 = NULL; void *v2 = nullptr; void *v3 = __null; // GNU extension char *cp = (char *)0; int *ip = 0; int i = 0; expr(nullPointerConstant()) matches the initializer for v1, v2, v3, cp, and ip. Does not match the initializer for i. | |||
| Matcher<FieldDecl> | hasBitWidth | unsigned Width | |
Matches non-static data members that are bit-fields of the specified
bit width.
Given
class C {
int a : 2;
int b : 4;
int c : 2;
};
fieldDecl(hasBitWidth(2))
matches 'int a;' and 'int c;' but not 'int b;'.
| |||
| Matcher<FieldDecl> | isBitField | ||
Matches non-static data members that are bit-fields.
Given
class C {
int a : 2;
int b;
};
fieldDecl(isBitField())
matches 'int a;' but not 'int b;'.
| |||
| Matcher<FloatingLiteral> | equals | const ValueT Value | |
Matches literals that are equal to the given value of type ValueT.
Given
f('false, 3.14, 42);
characterLiteral(equals(0))
matches 'cxxBoolLiteral(equals(false)) and cxxBoolLiteral(equals(0))
match false
floatLiteral(equals(3.14)) and floatLiteral(equals(314e-2))
match 3.14
integerLiteral(equals(42))
matches 42
Note that you cannot directly match a negative numeric literal because the
minus sign is not part of the literal: It is a unary operator whose operand
is the positive numeric literal. Instead, you must use a unaryOperator()
matcher to match the minus sign:
unaryOperator(hasOperatorName("-"),
hasUnaryOperand(integerLiteral(equals(13))))
Usable as: Matcher<CharacterLiteral>, Matcher<CXXBoolLiteralExpr>,
Matcher<FloatingLiteral>, Matcher<IntegerLiteral>
| |||
| Matcher<FloatingLiteral> | equals | double Value | |
| Matcher<FunctionDecl> | hasAnyOverloadedOperatorName | StringRef, ..., StringRef | |
Matches overloaded operator names.
Matches overloaded operator names specified in strings without the
"operator" prefix: e.g. "<<".
hasAnyOverloadesOperatorName("+", "-")
Is equivalent to
anyOf(hasOverloadedOperatorName("+"), hasOverloadedOperatorName("-"))
| |||
| Matcher<FunctionDecl> | hasDynamicExceptionSpec | ||
Matches functions that have a dynamic exception specification. Given: void f(); void g() noexcept; void h() noexcept(true); void i() noexcept(false); void j() throw(); void k() throw(int); void l() throw(...); functionDecl(hasDynamicExceptionSpec()) and functionProtoType(hasDynamicExceptionSpec()) match the declarations of j, k, and l, but not f, g, h, or i. | |||
| Matcher<FunctionDecl> | hasOverloadedOperatorName | StringRef Name | |
Matches overloaded operator names.
Matches overloaded operator names specified in strings without the
"operator" prefix: e.g. "<<".
Given:
class A { int operator*(); };
const A &operator<<(const A &a, const A &b);
A a;
a << a; // <-- This matches
cxxOperatorCallExpr(hasOverloadedOperatorName("<<"))) matches the
specified line and
cxxRecordDecl(hasMethod(hasOverloadedOperatorName("*")))
matches the declaration of A.
Usable as: Matcher<CXXOperatorCallExpr>, Matcher<FunctionDecl>
| |||
| Matcher<FunctionDecl> | hasTrailingReturn | ||
Matches a function declared with a trailing return type.
Example matches Y (matcher = functionDecl(hasTrailingReturn()))
int X() {}
auto Y() -> int {}
| |||
| Matcher<FunctionDecl> | isConstexpr | ||
Matches constexpr variable and function declarations,
and if constexpr.
Given:
constexpr int foo = 42;
constexpr int bar();
void baz() { if constexpr(1 > 0) {} }
varDecl(isConstexpr())
matches the declaration of foo.
functionDecl(isConstexpr())
matches the declaration of bar.
ifStmt(isConstexpr())
matches the if statement in baz.
| |||
| Matcher<FunctionDecl> | isDefaulted | ||
Matches defaulted function declarations.
Given:
class A { ~A(); };
class B { ~B() = default; };
functionDecl(isDefaulted())
matches the declaration of ~B, but not ~A.
| |||
| Matcher<FunctionDecl> | isDefinition | ||
Matches if a declaration has a body attached.
Example matches A, va, fa
class A {};
class B; // Doesn't match, as it has no body.
int va;
extern int vb; // Doesn't match, as it doesn't define the variable.
void fa() {}
void fb(); // Doesn't match, as it has no body.
@interface X
- (void)ma; // Doesn't match, interface is declaration.
@end
@implementation X
- (void)ma {}
@end
Usable as: Matcher<TagDecl>, Matcher<VarDecl>, Matcher<FunctionDecl>,
Matcher<ObjCMethodDecl>
| |||
| Matcher<FunctionDecl> | isDeleted | ||
Matches deleted function declarations. Given: void Func(); void DeletedFunc() = delete; functionDecl(isDeleted()) matches the declaration of DeletedFunc, but not Func. | |||
| Matcher<FunctionDecl> | isExplicitTemplateSpecialization | ||
Matches explicit template specializations of function, class, or
static member variable template instantiations.
Given
template<typename T> void A(T t) { }
template<> void A(int N) { }
functionDecl(isExplicitTemplateSpecialization())
matches the specialization A<int>().
Usable as: Matcher<FunctionDecl>, Matcher<VarDecl>, Matcher<CXXRecordDecl>
| |||
| Matcher<FunctionDecl> | isExternC | ||
Matches extern "C" function or variable declarations.
Given:
extern "C" void f() {}
extern "C" { void g() {} }
void h() {}
extern "C" int x = 1;
extern "C" int y = 2;
int z = 3;
functionDecl(isExternC())
matches the declaration of f and g, but not the declaration of h.
varDecl(isExternC())
matches the declaration of x and y, but not the declaration of z.
| |||
| Matcher<FunctionDecl> | isInline | ||
Matches function and namespace declarations that are marked with
the inline keyword.
Given
inline void f();
void g();
namespace n {
inline namespace m {}
}
functionDecl(isInline()) will match ::f().
namespaceDecl(isInline()) will match n::m.
| |||
| Matcher<FunctionDecl> | isMain | ||
Determines whether the function is "main", which is the entry point into an executable program. | |||
| Matcher<FunctionDecl> | isNoReturn | ||
Matches FunctionDecls that have a noreturn attribute.
Given
void nope();
[[noreturn]] void a();
__attribute__((noreturn)) void b();
struct c { [[noreturn]] c(); };
functionDecl(isNoReturn())
matches all of those except
void nope();
| |||
| Matcher<FunctionDecl> | isNoThrow | ||
Matches functions that have a non-throwing exception specification. Given: void f(); void g() noexcept; void h() throw(); void i() throw(int); void j() noexcept(false); functionDecl(isNoThrow()) and functionProtoType(isNoThrow()) match the declarations of g, and h, but not f, i or j. | |||
| Matcher<FunctionDecl> | isStaticStorageClass | ||
Matches variable/function declarations that have "static" storage
class specifier ("static" keyword) written in the source.
Given:
static void f() {}
static int i = 0;
extern int j;
int k;
functionDecl(isStaticStorageClass())
matches the function declaration f.
varDecl(isStaticStorageClass())
matches the variable declaration i.
| |||
| Matcher<FunctionDecl> | isTemplateInstantiation | ||
Matches template instantiations of function, class, or static
member variable template instantiations.
Given
template <typename T> class X {}; class A {}; X<A> x;
or
template <typename T> class X {}; class A {}; template class X<A>;
or
template <typename T> class X {}; class A {}; extern template class X<A>;
cxxRecordDecl(hasName("::X"), isTemplateInstantiation())
matches the template instantiation of X<A>.
But given
template <typename T> class X {}; class A {};
template <> class X<A> {}; X<A> x;
cxxRecordDecl(hasName("::X"), isTemplateInstantiation())
does not match, as X<A> is an explicit template specialization.
Usable as: Matcher<FunctionDecl>, Matcher<VarDecl>, Matcher<CXXRecordDecl>
| |||
| Matcher<FunctionDecl> | isVariadic | ||
Matches if a function declaration is variadic. Example matches f, but not g or h. The function i will not match, even when compiled in C mode. void f(...); void g(int); template <typename... Ts> void h(Ts...); void i(); | |||
| Matcher<FunctionDecl> | parameterCountIs | unsigned N | |
Matches FunctionDecls and FunctionProtoTypes that have a
specific parameter count.
Given
void f(int i) {}
void g(int i, int j) {}
void h(int i, int j);
void j(int i);
void k(int x, int y, int z, ...);
functionDecl(parameterCountIs(2))
matches g and h
functionProtoType(parameterCountIs(2))
matches g and h
functionProtoType(parameterCountIs(3))
matches k
| |||
| Matcher<FunctionProtoType> | hasDynamicExceptionSpec | ||
Matches functions that have a dynamic exception specification. Given: void f(); void g() noexcept; void h() noexcept(true); void i() noexcept(false); void j() throw(); void k() throw(int); void l() throw(...); functionDecl(hasDynamicExceptionSpec()) and functionProtoType(hasDynamicExceptionSpec()) match the declarations of j, k, and l, but not f, g, h, or i. | |||
| Matcher<FunctionProtoType> | isNoThrow | ||
Matches functions that have a non-throwing exception specification. Given: void f(); void g() noexcept; void h() throw(); void i() throw(int); void j() noexcept(false); functionDecl(isNoThrow()) and functionProtoType(isNoThrow()) match the declarations of g, and h, but not f, i or j. | |||
| Matcher<FunctionProtoType> | parameterCountIs | unsigned N | |
Matches FunctionDecls and FunctionProtoTypes that have a
specific parameter count.
Given
void f(int i) {}
void g(int i, int j) {}
void h(int i, int j);
void j(int i);
void k(int x, int y, int z, ...);
functionDecl(parameterCountIs(2))
matches g and h
functionProtoType(parameterCountIs(2))
matches g and h
functionProtoType(parameterCountIs(3))
matches k
| |||
| Matcher<IfStmt> | isConstexpr | ||
Matches constexpr variable and function declarations,
and if constexpr.
Given:
constexpr int foo = 42;
constexpr int bar();
void baz() { if constexpr(1 > 0) {} }
varDecl(isConstexpr())
matches the declaration of foo.
functionDecl(isConstexpr())
matches the declaration of bar.
ifStmt(isConstexpr())
matches the if statement in baz.
| |||
| Matcher<IntegerLiteral> | equals | bool Value | |
| Matcher<IntegerLiteral> | equals | const ValueT Value | |
Matches literals that are equal to the given value of type ValueT.
Given
f('false, 3.14, 42);
characterLiteral(equals(0))
matches 'cxxBoolLiteral(equals(false)) and cxxBoolLiteral(equals(0))
match false
floatLiteral(equals(3.14)) and floatLiteral(equals(314e-2))
match 3.14
integerLiteral(equals(42))
matches 42
Note that you cannot directly match a negative numeric literal because the
minus sign is not part of the literal: It is a unary operator whose operand
is the positive numeric literal. Instead, you must use a unaryOperator()
matcher to match the minus sign:
unaryOperator(hasOperatorName("-"),
hasUnaryOperand(integerLiteral(equals(13))))
Usable as: Matcher<CharacterLiteral>, Matcher<CXXBoolLiteralExpr>,
Matcher<FloatingLiteral>, Matcher<IntegerLiteral>
| |||
| Matcher<IntegerLiteral> | equals | double Value | |
| Matcher<IntegerLiteral> | equals | unsigned Value | |
| Matcher<MemberExpr> | isArrow | ||
Matches member expressions that are called with '->' as opposed
to '.'.
Member calls on the implicit this pointer match as called with '->'.
Given
class Y {
void x() { this->x(); x(); Y y; y.x(); a; this->b; Y::b; }
template <class T> void f() { this->f<T>(); f<T>(); }
int a;
static int b;
};
template <class T>
class Z {
void x() { this->m; }
};
memberExpr(isArrow())
matches this->x, x, y.x, a, this->b
cxxDependentScopeMemberExpr(isArrow())
matches this->m
unresolvedMemberExpr(isArrow())
matches this->f<T>, f<T>
| |||
| Matcher<NamedDecl> | hasAnyName | StringRef, ..., StringRef | |
Matches NamedDecl nodes that have any of the specified names.
This matcher is only provided as a performance optimization of hasName.
hasAnyName(a, b, c)
is equivalent to, but faster than
anyOf(hasName(a), hasName(b), hasName(c))
| |||
| Matcher<NamedDecl> | hasExternalFormalLinkage | ||
Matches a declaration that has external formal linkage.
Example matches only z (matcher = varDecl(hasExternalFormalLinkage()))
void f() {
int x;
static int y;
}
int z;
Example matches f() because it has external formal linkage despite being
unique to the translation unit as though it has internal likage
(matcher = functionDecl(hasExternalFormalLinkage()))
namespace {
void f() {}
}
| |||
| Matcher<NamedDecl> | hasName | StringRef Name | |
Matches NamedDecl nodes that have the specified name.
Supports specifying enclosing namespaces or classes by prefixing the name
with '<enclosing>::'.
Does not match typedefs of an underlying type with the given name.
Example matches X (Name == "X")
class X;
Example matches X (Name is one of "::a::b::X", "a::b::X", "b::X", "X")
namespace a { namespace b { class X; } }
| |||
| Matcher<NamedDecl> | matchesName | StringRef RegExp, Regex::RegexFlags Flags = NoFlags | |
Matches NamedDecl nodes whose fully qualified names contain
a substring matched by the given RegExp.
Supports specifying enclosing namespaces or classes by
prefixing the name with '<enclosing>::'. Does not match typedefs
of an underlying type with the given name.
Example matches X (regexp == "::X")
class X;
Example matches X (regexp is one of "::X", "^foo::.*X", among others)
namespace foo { namespace bar { class X; } }
If the matcher is used in clang-query, RegexFlags parameter
should be passed as a quoted string. e.g: "NoFlags".
Flags can be combined with '|' example "IgnoreCase | BasicRegex"
| |||
| Matcher<NamespaceDecl> | isAnonymous | ||
Matches anonymous namespace declarations.
Given
namespace n {
namespace {} // #1
}
namespaceDecl(isAnonymous()) will match #1 but not ::n.
| |||
| Matcher<NamespaceDecl> | isInline | ||
Matches function and namespace declarations that are marked with
the inline keyword.
Given
inline void f();
void g();
namespace n {
inline namespace m {}
}
functionDecl(isInline()) will match ::f().
namespaceDecl(isInline()) will match n::m.
| |||
| Matcher<OMPDefaultClause> | isNoneKind | ||
Matches if the OpenMP ``default`` clause has ``none`` kind specified. Given #pragma omp parallel #pragma omp parallel default(none) #pragma omp parallel default(shared) #pragma omp parallel default(firstprivate) ``ompDefaultClause(isNoneKind())`` matches only ``default(none)``. | |||
| Matcher<OMPDefaultClause> | isSharedKind | ||
Matches if the OpenMP ``default`` clause has ``shared`` kind specified. Given #pragma omp parallel #pragma omp parallel default(none) #pragma omp parallel default(shared) #pragma omp parallel default(firstprivate) ``ompDefaultClause(isSharedKind())`` matches only ``default(shared)``. | |||
| Matcher<OMPDefaultClause> | isSharedKind | ||
Matches if the OpenMP ``default`` clause has ``firstprivate`` kind specified. Given #pragma omp parallel #pragma omp parallel default(none) #pragma omp parallel default(shared) #pragma omp parallel default(firstprivate) ``ompDefaultClause(isFirstPrivateKind())`` matches only ``default(firstprivate)``. | |||
| Matcher<OMPExecutableDirective> | isAllowedToContainClauseKind | OpenMPClauseKind CKind | |
Matches if the OpenMP directive is allowed to contain the specified OpenMP
clause kind.
Given
#pragma omp parallel
#pragma omp parallel for
#pragma omp for
`ompExecutableDirective(isAllowedToContainClause(OMPC_default))`` matches
``omp parallel`` and ``omp parallel for``.
If the matcher is use from clang-query, ``OpenMPClauseKind`` parameter
should be passed as a quoted string. e.g.,
``isAllowedToContainClauseKind("OMPC_default").``
| |||
| Matcher<OMPExecutableDirective> | isStandaloneDirective | ||
Matches standalone OpenMP directives,
i.e., directives that can't have a structured block.
Given
#pragma omp parallel
{}
#pragma omp taskyield
``ompExecutableDirective(isStandaloneDirective()))`` matches
``omp taskyield``.
| |||
| Matcher<ObjCInterfaceDecl> | isDerivedFrom | std::string BaseName | |
Overloaded method as shortcut for isDerivedFrom(hasName(...)). | |||
| Matcher<ObjCInterfaceDecl> | isDirectlyDerivedFrom | std::string BaseName | |
Overloaded method as shortcut for isDirectlyDerivedFrom(hasName(...)). | |||
| Matcher<ObjCInterfaceDecl> | isSameOrDerivedFrom | std::string BaseName | |
Overloaded method as shortcut for isSameOrDerivedFrom(hasName(...)). | |||
| Matcher<ObjCMessageExpr> | argumentCountIs | unsigned N | |
Checks that a call expression or a constructor call expression has a specific number of arguments (including absent default arguments). Example matches f(0, 0) (matcher = callExpr(argumentCountIs(2))) void f(int x, int y); f(0, 0); | |||
| Matcher<ObjCMessageExpr> | |||