NoQ created this revision.
NoQ added reviewers: alexfh, gribozavr2, aaron.ballman, stephenkelly,
xazax.hun, vsavchenko.
Herald added subscribers: martong, rnkovacs.
NoQ requested review of this revision.
It additionally covers Objective-C methods and blocks that don't inherit from
`FunctionDecl`.
I'm open to suggestions here. For instance, it might make sense to have three
different matchers instead (`forFunction()`, `forBlock()`, `forObjCMethod()`)
and `anyOf()` them. I don't think it's practical though; most of the time you
want any callable and if you don't you can always narrow it down with
`forCallable(functionDecl())` or something like that. I guess it might make
sense to implement both approaches.
I'm also open to suggestions with respect to the very fact that such matchers
exist in the first place. From existing use cases it looks to me that most of
the time (including my use case) they're used to avoid the problem with
`hasDescendant()` (and similar matchers) digging into nested declarations (eg.,
inspecting the body of a lambda within a function when you only want it to
inspect the function itself). I would be totally satisfied with a better
alternative for `hasDescendant()` instead - that only traverses statements;
that'd probably be faster as well as more precise and concise. @stephenkelly,
IIRC you've voiced some strong opinions on this subject on the mailing list.
Repository:
rC Clang
https://reviews.llvm.org/D102213
Files:
clang/docs/LibASTMatchersReference.html
clang/include/clang/ASTMatchers/ASTMatchers.h
clang/unittests/ASTMatchers/ASTMatchersTraversalTest.cpp
Index: clang/unittests/ASTMatchers/ASTMatchersTraversalTest.cpp
===================================================================
--- clang/unittests/ASTMatchers/ASTMatchersTraversalTest.cpp
+++ clang/unittests/ASTMatchers/ASTMatchersTraversalTest.cpp
@@ -5524,6 +5524,47 @@
EXPECT_TRUE(notMatches(CppString2, returnStmt(forFunction(hasName("F")))));
}
+TEST(StatementMatcher, ForCallable) {
+ StringRef ObjCString1 = "@interface I"
+ "-(void) foo;"
+ "@end"
+ "@implementation I"
+ "-(void) foo {"
+ " void (^block)() = ^{ 0x2b | ~0x2b; };"
+ "}"
+ "@end";
+
+ EXPECT_TRUE(
+ matchesObjC(
+ ObjCString1,
+ binaryOperator(forCallable(blockDecl()))));
+
+ EXPECT_TRUE(
+ notMatchesObjC(
+ ObjCString1,
+ binaryOperator(forCallable(objcMethodDecl()))));
+
+ StringRef ObjCString2 = "@interface I"
+ "-(void) foo;"
+ "@end"
+ "@implementation I"
+ "-(void) foo {"
+ " 0x2b | ~0x2b;"
+ " void (^block)() = ^{};"
+ "}"
+ "@end";
+
+ EXPECT_TRUE(
+ matchesObjC(
+ ObjCString2,
+ binaryOperator(forCallable(objcMethodDecl()))));
+
+ EXPECT_TRUE(
+ notMatchesObjC(
+ ObjCString2,
+ binaryOperator(forCallable(blockDecl()))));
+}
+
TEST(Matcher, ForEachOverriden) {
const auto ForEachOverriddenInClass = [](const char *ClassName) {
return cxxMethodDecl(ofClass(hasName(ClassName)), isVirtual(),
Index: clang/include/clang/ASTMatchers/ASTMatchers.h
===================================================================
--- clang/include/clang/ASTMatchers/ASTMatchers.h
+++ clang/include/clang/ASTMatchers/ASTMatchers.h
@@ -7543,7 +7543,7 @@
});
}
-/// Matches declaration of the function the statement belongs to
+/// Matches declaration of the function the statement belongs to.
///
/// Given:
/// \code
@@ -7559,21 +7559,67 @@
InnerMatcher) {
const auto &Parents = Finder->getASTContext().getParents(Node);
+ llvm::SmallVector<DynTypedNode, 8> Stack(Parents.begin(), Parents.end());
+ while (!Stack.empty()) {
+ const auto &CurNode = Stack.back();
+ Stack.pop_back();
+ if (const auto *FuncDeclNode = CurNode.get<FunctionDecl>()) {
+ if (InnerMatcher.matches(*FuncDeclNode, Finder, Builder)) {
+ return true;
+ }
+ } else if (const auto *LambdaExprNode = CurNode.get<LambdaExpr>()) {
+ if (InnerMatcher.matches(*LambdaExprNode->getCallOperator(), Finder,
+ Builder)) {
+ return true;
+ }
+ } else {
+ for (const auto &Parent : Finder->getASTContext().getParents(CurNode))
+ Stack.push_back(Parent);
+ }
+ }
+ return false;
+}
+
+/// Matches declaration of the function, method, or block
+/// the statement belongs to. Similar to 'forFunction' but additionally covers
+/// Objective-C methods and blocks.
+///
+/// Given:
+/// \code
+/// -(void) foo {
+/// int x = 1;
+/// dispatch_sync(queue, ^{ int y = 2; });
+/// }
+/// \endcode
+/// declStmt(forCallable(objcMethodDecl()))
+/// matches 'int x = 1'
+/// but does not match 'int y = 2'.
+AST_MATCHER_P(Stmt, forCallable, internal::Matcher<Decl>, InnerMatcher) {
+ const auto &Parents = Finder->getASTContext().getParents(Node);
+
llvm::SmallVector<DynTypedNode, 8> Stack(Parents.begin(), Parents.end());
while(!Stack.empty()) {
const auto &CurNode = Stack.back();
Stack.pop_back();
- if(const auto *FuncDeclNode = CurNode.get<FunctionDecl>()) {
- if(InnerMatcher.matches(*FuncDeclNode, Finder, Builder)) {
+ if (const auto *FuncDeclNode = CurNode.get<FunctionDecl>()) {
+ if (InnerMatcher.matches(*FuncDeclNode, Finder, Builder)) {
+ return true;
+ }
+ } else if (const auto *LambdaExprNode = CurNode.get<LambdaExpr>()) {
+ if (InnerMatcher.matches(*LambdaExprNode->getCallOperator(), Finder,
+ Builder)) {
+ return true;
+ }
+ } else if (const auto *ObjCMethodDeclNode = CurNode.get<ObjCMethodDecl>()) {
+ if (InnerMatcher.matches(*ObjCMethodDeclNode, Finder, Builder)) {
return true;
}
- } else if(const auto *LambdaExprNode = CurNode.get<LambdaExpr>()) {
- if(InnerMatcher.matches(*LambdaExprNode->getCallOperator(),
- Finder, Builder)) {
+ } else if (const auto *BlockDeclNode = CurNode.get<BlockDecl>()) {
+ if (InnerMatcher.matches(*BlockDeclNode, Finder, Builder)) {
return true;
}
} else {
- for(const auto &Parent: Finder->getASTContext().getParents(CurNode))
+ for (const auto &Parent : Finder->getASTContext().getParents(CurNode))
Stack.push_back(Parent);
}
}
Index: clang/docs/LibASTMatchersReference.html
===================================================================
--- clang/docs/LibASTMatchersReference.html
+++ clang/docs/LibASTMatchersReference.html
@@ -8814,7 +8814,7 @@
<tr><td>Matcher<<a href="https://clang.llvm.org/doxygen/classclang_1_1Stmt.html";>Stmt</a>></td><td class="name" onclick="toggle('forFunction0')"><a name="forFunction0Anchor">forFunction</a></td><td>Matcher<<a href="https://clang.llvm.org/doxygen/classclang_1_1FunctionDecl.html";>FunctionDecl</a>> InnerMatcher</td></tr>
-<tr><td colspan="4" class="doc" id="forFunction0"><pre>Matches declaration of the function the statement belongs to
+<tr><td colspan="4" class="doc" id="forFunction0"><pre>Matches declaration of the function the statement belongs to.
Given:
F& operator=(const F& o) {
@@ -8827,6 +8827,23 @@
</pre></td></tr>
+<tr><td>Matcher<<a href="https://clang.llvm.org/doxygen/classclang_1_1Stmt.html";>Stmt</a>></td><td class="name" onclick="toggle('forCallable0')"><a name="forCallable0Anchor">forCallable</a></td><td>Matcher<<a href="https://clang.llvm.org/doxygen/classclang_1_1Decl.html";>Decl</a>> InnerMatcher</td></tr>
+<tr><td colspan="4" class="doc" id="forCallable0"><pre>
+Matches declaration of the function, method, or block the statement belongs to.
+Similar to 'forFunction' but additionally covers Objective-C methods and blocks.
+
+Given:
+-(void) foo {
+ int x = 1;
+ dispatch_sync(queue, ^{ int y = 2; });
+}
+
+declStmt(forCallable(objcMethodDecl()))
+ matches 'int x = 1'
+ but does not match 'int y = 2'.
+</pre></td></tr>
+
+
<tr><td>Matcher<<a href="https://clang.llvm.org/doxygen/classclang_1_1Stmt.html";>Stmt</a>></td><td class="name" onclick="toggle('sizeOfExpr0')"><a name="sizeOfExpr0Anchor">sizeOfExpr</a></td><td>Matcher<<a href="https://clang.llvm.org/doxygen/classclang_1_1UnaryExprOrTypeTraitExpr.html";>UnaryExprOrTypeTraitExpr</a>> InnerMatcher</td></tr>
<tr><td colspan="4" class="doc" id="sizeOfExpr0"><pre>Same as unaryExprOrTypeTraitExpr, but only matching
sizeof.
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
