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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/*
* Copyright 2003-2011 Dave Griffith, Bas Leijdekkers
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.siyeh.ig.performance;
import com.intellij.codeInspection.ProblemDescriptor;
import com.intellij.codeInspection.ui.MultipleCheckboxOptionsPanel;
import com.intellij.openapi.project.Project;
import com.intellij.psi.*;
import com.intellij.psi.search.searches.OverridingMethodsSearch;
import com.intellij.psi.util.PropertyUtil;
import com.intellij.util.IncorrectOperationException;
import com.intellij.util.Query;
import com.siyeh.InspectionGadgetsBundle;
import com.siyeh.ig.BaseInspection;
import com.siyeh.ig.BaseInspectionVisitor;
import com.siyeh.ig.InspectionGadgetsFix;
import com.siyeh.ig.PsiReplacementUtil;
import com.siyeh.ig.psiutils.ClassUtils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.swing.*;
public class CallToSimpleGetterInClassInspection extends BaseInspection {
@SuppressWarnings("UnusedDeclaration")
public boolean ignoreGetterCallsOnOtherObjects = false;
@SuppressWarnings("UnusedDeclaration")
public boolean onlyReportPrivateGetter = false;
@Override
@NotNull
public String getID() {
return "CallToSimpleGetterFromWithinClass";
}
@Override
@NotNull
public String getDisplayName() {
return InspectionGadgetsBundle.message("call.to.simple.getter.in.class.display.name");
}
@Override
@NotNull
public String buildErrorString(Object... infos) {
return InspectionGadgetsBundle.message("call.to.simple.getter.in.class.problem.descriptor");
}
@Override
@Nullable
public JComponent createOptionsPanel() {
final MultipleCheckboxOptionsPanel optionsPanel = new MultipleCheckboxOptionsPanel(this);
optionsPanel.addCheckbox(InspectionGadgetsBundle.message("call.to.simple.getter.in.class.ignore.option"),
"ignoreGetterCallsOnOtherObjects");
optionsPanel.addCheckbox(InspectionGadgetsBundle.message("call.to.private.simple.getter.in.class.option"),
"onlyReportPrivateGetter");
return optionsPanel;
}
@Override
public InspectionGadgetsFix buildFix(Object... infos) {
return new InlineCallFix();
}
private static class InlineCallFix extends InspectionGadgetsFix {
@NotNull
@Override
public String getFamilyName() {
return getName();
}
@Override
@NotNull
public String getName() {
return InspectionGadgetsBundle.message("call.to.simple.getter.in.class.inline.quickfix");
}
@Override
public void doFix(Project project, ProblemDescriptor descriptor) throws IncorrectOperationException {
final PsiElement methodIdentifier = descriptor.getPsiElement();
final PsiReferenceExpression methodExpression = (PsiReferenceExpression)methodIdentifier.getParent();
if (methodExpression == null) {
return;
}
final PsiMethodCallExpression call = (PsiMethodCallExpression)methodExpression.getParent();
if (call == null) {
return;
}
final PsiMethod method = call.resolveMethod();
if (method == null) {
return;
}
final PsiCodeBlock body = method.getBody();
if (body == null) {
return;
}
final PsiStatement[] statements = body.getStatements();
final PsiReturnStatement returnStatement = (PsiReturnStatement)statements[0];
final PsiExpression returnValue = returnStatement.getReturnValue();
if (!(returnValue instanceof PsiReferenceExpression)) {
return;
}
final PsiReferenceExpression referenceExpression = (PsiReferenceExpression)returnValue;
final PsiField field = (PsiField)referenceExpression.resolve();
if (field == null) {
return;
}
final String fieldName = field.getName();
if (fieldName == null) {
return;
}
final PsiExpression qualifier = methodExpression.getQualifierExpression();
if (qualifier == null) {
final JavaPsiFacade facade = JavaPsiFacade.getInstance(call.getProject());
final PsiResolveHelper resolveHelper = facade.getResolveHelper();
final PsiVariable variable = resolveHelper.resolveReferencedVariable(fieldName, call);
if (variable == null) {
return;
}
if (variable.equals(field)) {
PsiReplacementUtil.replaceExpression(call, fieldName);
}
else {
PsiReplacementUtil.replaceExpression(call, "this." + fieldName);
}
}
else {
PsiReplacementUtil.replaceExpression(call, qualifier.getText() + '.' + fieldName);
}
}
}
@Override
public BaseInspectionVisitor buildVisitor() {
return new CallToSimpleGetterInClassVisitor();
}
private class CallToSimpleGetterInClassVisitor extends BaseInspectionVisitor {
@Override
public void visitMethodCallExpression(@NotNull PsiMethodCallExpression call) {
super.visitMethodCallExpression(call);
final PsiClass containingClass = ClassUtils.getContainingClass(call);
if (containingClass == null) {
return;
}
final PsiMethod method = call.resolveMethod();
if (method == null) {
return;
}
if (!containingClass.equals(method.getContainingClass())) {
return;
}
final PsiReferenceExpression methodExpression = call.getMethodExpression();
final PsiExpression qualifier = methodExpression.getQualifierExpression();
if (qualifier != null && !(qualifier instanceof PsiThisExpression)) {
if (ignoreGetterCallsOnOtherObjects) {
return;
}
final PsiType type = qualifier.getType();
if (!(type instanceof PsiClassType)) {
return;
}
final PsiClassType classType = (PsiClassType)type;
final PsiClass qualifierClass = classType.resolve();
if (!containingClass.equals(qualifierClass)) {
return;
}
}
if (!PropertyUtil.isSimpleGetter(method)) {
return;
}
if (onlyReportPrivateGetter && !method.hasModifierProperty(PsiModifier.PRIVATE)) {
return;
}
final Query<PsiMethod> query = OverridingMethodsSearch.search(method, true);
final PsiMethod overridingMethod = query.findFirst();
if (overridingMethod != null) {
return;
}
registerMethodCallError(call);
}
}
}
|
