annotate clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp @ 173:0572611fdcc8 llvm10 llvm12

reorgnization done
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 11:55:54 +0900
parents 1d019706d866
children c4bab56944e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===--- SuperSelfCheck.cpp - clang-tidy ----------------------------------===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // The LLVM Compiler Infrastructure
anatofuz
parents:
diff changeset
4 //
anatofuz
parents:
diff changeset
5 // This file is distributed under the University of Illinois Open Source
anatofuz
parents:
diff changeset
6 // License. See LICENSE.TXT for details.
anatofuz
parents:
diff changeset
7 //
anatofuz
parents:
diff changeset
8 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
9
anatofuz
parents:
diff changeset
10 #include "SuperSelfCheck.h"
anatofuz
parents:
diff changeset
11 #include "clang/AST/ASTContext.h"
anatofuz
parents:
diff changeset
12 #include "clang/ASTMatchers/ASTMatchFinder.h"
anatofuz
parents:
diff changeset
13
anatofuz
parents:
diff changeset
14 using namespace clang::ast_matchers;
anatofuz
parents:
diff changeset
15
anatofuz
parents:
diff changeset
16 namespace clang {
anatofuz
parents:
diff changeset
17 namespace tidy {
anatofuz
parents:
diff changeset
18 namespace objc {
anatofuz
parents:
diff changeset
19
anatofuz
parents:
diff changeset
20 namespace {
anatofuz
parents:
diff changeset
21
anatofuz
parents:
diff changeset
22 /// Matches Objective-C methods in the initializer family.
anatofuz
parents:
diff changeset
23 ///
anatofuz
parents:
diff changeset
24 /// Example matches -init and -initWithInt:.
anatofuz
parents:
diff changeset
25 /// (matcher = objcMethodDecl(isInitializer()))
anatofuz
parents:
diff changeset
26 /// \code
anatofuz
parents:
diff changeset
27 /// @interface Foo
anatofuz
parents:
diff changeset
28 /// - (instancetype)init;
anatofuz
parents:
diff changeset
29 /// - (instancetype)initWithInt:(int)i;
anatofuz
parents:
diff changeset
30 /// + (instancetype)init;
anatofuz
parents:
diff changeset
31 /// - (void)bar;
anatofuz
parents:
diff changeset
32 /// @end
anatofuz
parents:
diff changeset
33 /// \endcode
anatofuz
parents:
diff changeset
34 AST_MATCHER(ObjCMethodDecl, isInitializer) {
anatofuz
parents:
diff changeset
35 return Node.getMethodFamily() == OMF_init;
anatofuz
parents:
diff changeset
36 }
anatofuz
parents:
diff changeset
37
anatofuz
parents:
diff changeset
38 /// Matches Objective-C implementations with interfaces that match
anatofuz
parents:
diff changeset
39 /// \c Base.
anatofuz
parents:
diff changeset
40 ///
anatofuz
parents:
diff changeset
41 /// Example matches implementation declarations for X.
anatofuz
parents:
diff changeset
42 /// (matcher = objcImplementationDecl(hasInterface(hasName("X"))))
anatofuz
parents:
diff changeset
43 /// \code
anatofuz
parents:
diff changeset
44 /// @interface X
anatofuz
parents:
diff changeset
45 /// @end
anatofuz
parents:
diff changeset
46 /// @implementation X
anatofuz
parents:
diff changeset
47 /// @end
anatofuz
parents:
diff changeset
48 /// @interface Y
anatofuz
parents:
diff changeset
49 // @end
anatofuz
parents:
diff changeset
50 /// @implementation Y
anatofuz
parents:
diff changeset
51 /// @end
anatofuz
parents:
diff changeset
52 /// \endcode
anatofuz
parents:
diff changeset
53 AST_MATCHER_P(ObjCImplementationDecl, hasInterface,
anatofuz
parents:
diff changeset
54 ast_matchers::internal::Matcher<ObjCInterfaceDecl>, Base) {
anatofuz
parents:
diff changeset
55 const ObjCInterfaceDecl *InterfaceDecl = Node.getClassInterface();
anatofuz
parents:
diff changeset
56 return Base.matches(*InterfaceDecl, Finder, Builder);
anatofuz
parents:
diff changeset
57 }
anatofuz
parents:
diff changeset
58
anatofuz
parents:
diff changeset
59 /// Matches Objective-C message expressions where the receiver is the
anatofuz
parents:
diff changeset
60 /// super instance.
anatofuz
parents:
diff changeset
61 ///
anatofuz
parents:
diff changeset
62 /// Example matches the invocations of -banana and -orange.
anatofuz
parents:
diff changeset
63 /// (matcher = objcMessageExpr(isMessagingSuperInstance()))
anatofuz
parents:
diff changeset
64 /// \code
anatofuz
parents:
diff changeset
65 /// - (void)banana {
anatofuz
parents:
diff changeset
66 /// [self apple]
anatofuz
parents:
diff changeset
67 /// [super banana];
anatofuz
parents:
diff changeset
68 /// [super orange];
anatofuz
parents:
diff changeset
69 /// }
anatofuz
parents:
diff changeset
70 /// \endcode
anatofuz
parents:
diff changeset
71 AST_MATCHER(ObjCMessageExpr, isMessagingSuperInstance) {
anatofuz
parents:
diff changeset
72 return Node.getReceiverKind() == ObjCMessageExpr::SuperInstance;
anatofuz
parents:
diff changeset
73 }
anatofuz
parents:
diff changeset
74
anatofuz
parents:
diff changeset
75 } // namespace
anatofuz
parents:
diff changeset
76
anatofuz
parents:
diff changeset
77 void SuperSelfCheck::registerMatchers(MatchFinder *Finder) {
anatofuz
parents:
diff changeset
78 Finder->addMatcher(
anatofuz
parents:
diff changeset
79 objcMessageExpr(hasSelector("self"), isMessagingSuperInstance(),
anatofuz
parents:
diff changeset
80 hasAncestor(objcMethodDecl(
anatofuz
parents:
diff changeset
81 isInitializer(),
anatofuz
parents:
diff changeset
82 hasDeclContext(objcImplementationDecl(hasInterface(
anatofuz
parents:
diff changeset
83 isDerivedFrom(hasName("NSObject"))))))))
anatofuz
parents:
diff changeset
84 .bind("message"),
anatofuz
parents:
diff changeset
85 this);
anatofuz
parents:
diff changeset
86 }
anatofuz
parents:
diff changeset
87
anatofuz
parents:
diff changeset
88 void SuperSelfCheck::check(const MatchFinder::MatchResult &Result) {
anatofuz
parents:
diff changeset
89 const auto *Message = Result.Nodes.getNodeAs<ObjCMessageExpr>("message");
anatofuz
parents:
diff changeset
90
anatofuz
parents:
diff changeset
91 auto Diag = diag(Message->getExprLoc(), "suspicious invocation of %0 in "
anatofuz
parents:
diff changeset
92 "initializer; did you mean to "
anatofuz
parents:
diff changeset
93 "invoke a superclass initializer?")
anatofuz
parents:
diff changeset
94 << Message->getMethodDecl();
anatofuz
parents:
diff changeset
95
anatofuz
parents:
diff changeset
96 SourceLocation ReceiverLoc = Message->getReceiverRange().getBegin();
anatofuz
parents:
diff changeset
97 if (ReceiverLoc.isMacroID() || ReceiverLoc.isInvalid())
anatofuz
parents:
diff changeset
98 return;
anatofuz
parents:
diff changeset
99
anatofuz
parents:
diff changeset
100 SourceLocation SelectorLoc = Message->getSelectorStartLoc();
anatofuz
parents:
diff changeset
101 if (SelectorLoc.isMacroID() || SelectorLoc.isInvalid())
anatofuz
parents:
diff changeset
102 return;
anatofuz
parents:
diff changeset
103
anatofuz
parents:
diff changeset
104 Diag << FixItHint::CreateReplacement(Message->getSourceRange(),
anatofuz
parents:
diff changeset
105 StringRef("[super init]"));
anatofuz
parents:
diff changeset
106 }
anatofuz
parents:
diff changeset
107
anatofuz
parents:
diff changeset
108 } // namespace objc
anatofuz
parents:
diff changeset
109 } // namespace tidy
anatofuz
parents:
diff changeset
110 } // namespace clang