1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
//===--- SuperSelfCheck.cpp - clang-tidy ----------------------------------===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "SuperSelfCheck.h"
#include "clang/AST/ASTContext.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
using namespace clang::ast_matchers;
namespace clang {
namespace tidy {
namespace objc {
namespace {
/// \brief Matches Objective-C methods in the initializer family.
///
/// Example matches -init and -initWithInt:.
/// (matcher = objcMethodDecl(isInitializer()))
/// \code
/// @interface Foo
/// - (instancetype)init;
/// - (instancetype)initWithInt:(int)i;
/// + (instancetype)init;
/// - (void)bar;
/// @end
/// \endcode
AST_MATCHER(ObjCMethodDecl, isInitializer) {
return Node.getMethodFamily() == OMF_init;
}
/// \brief Matches Objective-C implementations of classes that directly or
/// indirectly have a superclass matching \c InterfaceDecl.
///
/// Note that a class is not considered to be a subclass of itself.
///
/// Example matches implementation declarations for Y and Z.
/// (matcher = objcInterfaceDecl(isSubclassOf(hasName("X"))))
/// \code
/// @interface X
/// @end
/// @interface Y : X
/// @end
/// @implementation Y // directly derived
/// @end
/// @interface Z : Y
/// @end
/// @implementation Z // indirectly derived
/// @end
/// \endcode
AST_MATCHER_P(ObjCImplementationDecl, isSubclassOf,
ast_matchers::internal::Matcher<ObjCInterfaceDecl>,
InterfaceDecl) {
// Check if any of the superclasses of the class match.
for (const ObjCInterfaceDecl *SuperClass =
Node.getClassInterface()->getSuperClass();
SuperClass != nullptr; SuperClass = SuperClass->getSuperClass()) {
if (InterfaceDecl.matches(*SuperClass, Finder, Builder))
return true;
}
// No matches found.
return false;
}
/// \brief Matches Objective-C message expressions where the receiver is the
/// super instance.
///
/// Example matches the invocations of -banana and -orange.
/// (matcher = objcMessageExpr(isMessagingSuperInstance()))
/// \code
/// - (void)banana {
/// [self apple]
/// [super banana];
/// [super orange];
/// }
/// \endcode
AST_MATCHER(ObjCMessageExpr, isMessagingSuperInstance) {
return Node.getReceiverKind() == ObjCMessageExpr::SuperInstance;
}
} // namespace
void SuperSelfCheck::registerMatchers(MatchFinder *Finder) {
// This check should only be applied to Objective-C sources.
if (!getLangOpts().ObjC)
return;
Finder->addMatcher(
objcMessageExpr(
hasSelector("self"), isMessagingSuperInstance(),
hasAncestor(objcMethodDecl(isInitializer(),
hasDeclContext(objcImplementationDecl(
isSubclassOf(hasName("NSObject")))))))
.bind("message"),
this);
}
void SuperSelfCheck::check(const MatchFinder::MatchResult &Result) {
const auto *Message = Result.Nodes.getNodeAs<ObjCMessageExpr>("message");
auto Diag = diag(Message->getExprLoc(), "suspicious invocation of %0 in "
"initializer; did you mean to "
"invoke a superclass initializer?")
<< Message->getMethodDecl();
SourceLocation ReceiverLoc = Message->getReceiverRange().getBegin();
if (ReceiverLoc.isMacroID() || ReceiverLoc.isInvalid())
return;
SourceLocation SelectorLoc = Message->getSelectorStartLoc();
if (SelectorLoc.isMacroID() || SelectorLoc.isInvalid())
return;
Diag << FixItHint::CreateReplacement(Message->getSourceRange(),
StringRef("[super init]"));
}
} // namespace objc
} // namespace tidy
} // namespace clang
|
