ziqingluo-90 updated this revision to Diff 441832.
ziqingluo-90 added a comment.
adding a unit test for the ASTMatcher `objcMessageCallee` added in ASTMatcher.h
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D128314/new/
https://reviews.llvm.org/D128314
Files:
clang-tools-extra/clang-tidy/bugprone/InfiniteLoopCheck.cpp
clang-tools-extra/test/clang-tidy/checkers/bugprone/infinite-loop-noreturn.mm
clang/docs/LibASTMatchersReference.html
clang/include/clang/ASTMatchers/ASTMatchers.h
clang/lib/ASTMatchers/Dynamic/Registry.cpp
clang/unittests/ASTMatchers/ASTMatchersNodeTest.cpp
Index: clang/unittests/ASTMatchers/ASTMatchersNodeTest.cpp
===================================================================
--- clang/unittests/ASTMatchers/ASTMatchersNodeTest.cpp
+++ clang/unittests/ASTMatchers/ASTMatchersNodeTest.cpp
@@ -2352,6 +2352,37 @@
argumentCountIs(0))));
}
+TEST(ASTMatchersTestObjC, ObjCMessageCallee) {
+ // Will NOT match function callee:
+ EXPECT_TRUE(notMatchesObjC("void f() {"
+ " f(); "
+ "}",
+ objcMessageExpr(objcMessageCallee(hasName("f")))));
+
+ StringRef Objc1String = "@interface I "
+ " - (void)instanceMethod;"
+ " + (void)classMethod;"
+ " + (void)uncalledMethod;"
+ "@end\n"
+ "int main(void) {\n"
+ " [I classMethod];"
+ " I *i = [[I alloc] init];"
+ " [i instanceMethod];"
+ "}";
+ // Should find the two method declarations through the message expressions:
+ EXPECT_TRUE(
+ matchesObjC(Objc1String, objcMessageExpr(objcMessageCallee(
+ objcMethodDecl(hasName("classMethod"))))));
+ EXPECT_TRUE(matchesObjC(Objc1String,
+ objcMessageExpr(objcMessageCallee(
+ objcMethodDecl(hasName("instanceMethod"))))));
+ // Will NOT match a method declaration through `objcMessageCallee` if there is
+ // no such message expression:
+ EXPECT_FALSE(matchesObjC(Objc1String,
+ objcMessageExpr(objcMessageCallee(
+ objcMethodDecl(hasName("uncalledMethod"))))));
+}
+
TEST(ASTMatchersTestObjC, ObjCStringLiteral) {
StringRef Objc1String = "@interface NSObject "
Index: clang/lib/ASTMatchers/Dynamic/Registry.cpp
===================================================================
--- clang/lib/ASTMatchers/Dynamic/Registry.cpp
+++ clang/lib/ASTMatchers/Dynamic/Registry.cpp
@@ -501,6 +501,7 @@
REGISTER_MATCHER(objcIvarDecl);
REGISTER_MATCHER(objcIvarRefExpr);
REGISTER_MATCHER(objcMessageExpr);
+ REGISTER_MATCHER(objcMessageCallee);
REGISTER_MATCHER(objcMethodDecl);
REGISTER_MATCHER(objcObjectPointerType);
REGISTER_MATCHER(objcPropertyDecl);
Index: clang/include/clang/ASTMatchers/ASTMatchers.h
===================================================================
--- clang/include/clang/ASTMatchers/ASTMatchers.h
+++ clang/include/clang/ASTMatchers/ASTMatchers.h
@@ -3838,6 +3838,25 @@
InnerMatcher.matches(*ExprNode, Finder, Builder));
}
+/// matches if ObjCMessageExpr's callee declaration matches
+///
+/// Given
+/// \code
+/// @interface I: NSObject
+/// +(void)foo;
+/// @end
+/// ...
+/// [I foo]
+/// \endcode
+/// The example above matches \code [I foo] \endcode with
+/// objcMessageExpr(objcMessageCallee(objcMethodDecl(hasName("foo"))))
+AST_MATCHER_P(ObjCMessageExpr, objcMessageCallee,
+ internal::Matcher<ObjCMethodDecl>, InnerMatcher) {
+ const ObjCMethodDecl *msgDecl = Node.getMethodDecl();
+ return (msgDecl != nullptr &&
+ InnerMatcher.matches(*msgDecl, Finder, Builder));
+}
+
/// Matches if the call expression's callee's declaration matches the
/// given matcher.
///
Index: clang/docs/LibASTMatchersReference.html
===================================================================
--- clang/docs/LibASTMatchersReference.html
+++ clang/docs/LibASTMatchersReference.html
@@ -8867,6 +8867,20 @@
</pre></td></tr>
+<tr><td>Matcher<<a href="https://clang.llvm.org/doxygen/classclang_1_1ObjCMessageExpr.html";>ObjCMessageExpr</a>></td><td class="name" onclick="toggle('objcMessageCallee0')"><a name="objcMessageCallee0Anchor">objcMessageCallee</a></td><td>Matcher<<a href="https://clang.llvm.org/doxygen/classclang_1_1ObjCMethodDecl.html";>ObjCMethodDecl</a>> InnerMatcher</td></tr>
+<tr><td colspan="4" class="doc" id="objcMessageCallee0"><pre>matches if ObjCMessageExpr's callee declaration matches
+
+Given
+ @interface I: NSObject
+ +(void)foo;
+ @end
+ ...
+ [I foo]
+The example above matches [I foo] with
+objcMessageExpr(objcMessageCallee(objcMethodDecl(hasName("foo"))))
+</pre></td></tr>
+
+
<tr><td>Matcher<<a href="https://clang.llvm.org/doxygen/classclang_1_1ObjCMethodDecl.html";>ObjCMethodDecl</a>></td><td class="name" onclick="toggle('hasAnyParameter1')"><a name="hasAnyParameter1Anchor">hasAnyParameter</a></td><td>Matcher<<a href="https://clang.llvm.org/doxygen/classclang_1_1ParmVarDecl.html";>ParmVarDecl</a>> InnerMatcher</td></tr>
<tr><td colspan="4" class="doc" id="hasAnyParameter1"><pre>Matches any parameter of a function or an ObjC method declaration or a
block.
Index: clang-tools-extra/test/clang-tidy/checkers/bugprone/infinite-loop-noreturn.mm
===================================================================
--- /dev/null
+++ clang-tools-extra/test/clang-tidy/checkers/bugprone/infinite-loop-noreturn.mm
@@ -0,0 +1,62 @@
+// RUN: %check_clang_tidy %s bugprone-infinite-loop %t -- -- -fblocks -fexceptions
+// RUN: %check_clang_tidy %s bugprone-infinite-loop %t -- -- -fblocks -fobjc-arc -fexceptions
+
+@interface I
++ (void)foo;
++ (void)bar;
++ (void)baz __attribute__((noreturn));
++ (instancetype)alloc;
+- (instancetype)init;
+@end
+
+_Noreturn void term();
+
+void plainCFunction() {
+ int i = 0;
+ int j = 0;
+ int a[10];
+
+ while (i < 10) {
+ // no warning, function term has C noreturn attribute
+ term();
+ }
+ while (i < 10) {
+ // no warning, class method baz has noreturn attribute
+ [I baz];
+ }
+ while (i + j < 10) {
+ // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: this loop is infinite; none of its condition variables (i, j) are updated in the loop body [bugprone-infinite-loop]
+ [I foo];
+ }
+ while (i + j < 10) {
+ [I foo];
+ [I baz]; // no warning, class method baz has noreturn attribute
+ }
+
+ void (^block)() = ^{
+ };
+ void __attribute__((noreturn)) (^block_nr)(void) = ^void __attribute__((noreturn)) (void) { throw "err"; };
+
+ while (i < 10) {
+ // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: this loop is infinite; none of its condition variables (i) are updated in the loop body [bugprone-infinite-loop]
+ block();
+ }
+ while (i < 10) {
+ // no warning, the block has "noreturn" arribute
+ block_nr();
+ }
+}
+
+@implementation I
++ (void)bar {
+}
+
++ (void)foo {
+ static int i = 0;
+
+ while (i < 10) {
+ // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: this loop is infinite; none of its condition variables (i) are updated in the loop body [bugprone-infinite-loop]
+ [I bar];
+ }
+}
+@end
Index: clang-tools-extra/clang-tidy/bugprone/InfiniteLoopCheck.cpp
===================================================================
--- clang-tools-extra/clang-tidy/bugprone/InfiniteLoopCheck.cpp
+++ clang-tools-extra/clang-tidy/bugprone/InfiniteLoopCheck.cpp
@@ -16,15 +16,35 @@
using clang::tidy::utils::hasPtrOrReferenceInFunc;
namespace clang {
+namespace ast_matchers {
+/// matches a Decl if it has a "no return" attribute of any kind
+AST_MATCHER(Decl, declHasNoReturnAttr) {
+ return Node.hasAttr<NoReturnAttr>() || Node.hasAttr<CXX11NoReturnAttr>() ||
+ Node.hasAttr<C11NoReturnAttr>();
+}
+
+/// matches a FunctionType if the type includes the GNU no return attribute
+AST_MATCHER(FunctionType, typeHasNoReturnAttr) {
+ return Node.getNoReturnAttr();
+}
+} // namespace ast_matchers
namespace tidy {
namespace bugprone {
static internal::Matcher<Stmt>
loopEndingStmt(internal::Matcher<Stmt> Internal) {
- // FIXME: Cover noreturn ObjC methods (and blocks?).
+ internal::Matcher<QualType> isNoReturnFunType =
+ ignoringParens(functionType(typeHasNoReturnAttr()));
+ internal::Matcher<Decl> isNoReturnDecl =
+ anyOf(declHasNoReturnAttr(), functionDecl(hasType(isNoReturnFunType)),
+ varDecl(hasType(blockPointerType(pointee(isNoReturnFunType)))));
+
return stmt(anyOf(
mapAnyOf(breakStmt, returnStmt, gotoStmt, cxxThrowExpr).with(Internal),
- callExpr(Internal, callee(functionDecl(isNoReturn())))));
+ callExpr(Internal,
+ callee(mapAnyOf(functionDecl, /* block callee */ varDecl)
+ .with(isNoReturnDecl))),
+ objcMessageExpr(Internal, objcMessageCallee(isNoReturnDecl))));
}
/// Return whether `Var` was changed in `LoopStmt`.
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
