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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*
* Copyright 2003-2013 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.InspectionManager;
import com.intellij.codeInspection.ProblemDescriptor;
import com.intellij.codeInspection.ui.MultipleCheckboxOptionsPanel;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.Condition;
import com.intellij.openapi.util.WriteExternalException;
import com.intellij.psi.*;
import com.intellij.psi.search.searches.ClassInheritorsSearch;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.refactoring.makeStatic.MakeMethodStaticProcessor;
import com.intellij.refactoring.makeStatic.Settings;
import com.intellij.util.Processor;
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.fixes.ChangeModifierFix;
import com.siyeh.ig.psiutils.ClassUtils;
import com.siyeh.ig.psiutils.MethodUtils;
import com.siyeh.ig.psiutils.SerializationUtils;
import org.jdom.Element;
import org.jetbrains.annotations.NotNull;
import javax.swing.*;
import java.util.concurrent.atomic.AtomicInteger;
public class MethodMayBeStaticInspection extends BaseInspection {
private static final String IGNORE_DEFAULT_METHODS_ATTR_NAME = "m_ignoreDefaultMethods";
private static final String ONLY_PRIVATE_OR_FINAL_ATTR_NAME = "m_onlyPrivateOrFinal";
private static final String IGNORE_EMPTY_METHODS_ATTR_NAME = "m_ignoreEmptyMethods";
private static final String REPLACE_QUALIFIER_ATTR_NAME = "m_replaceQualifier";
/**
* @noinspection PublicField
*/
public boolean m_onlyPrivateOrFinal = false;
/**
* @noinspection PublicField
*/
public boolean m_ignoreEmptyMethods = true;
public boolean m_ignoreDefaultMethods = true;
public boolean m_replaceQualifier = true;
@Override
@NotNull
public String getDisplayName() {
return InspectionGadgetsBundle.message("method.may.be.static.display.name");
}
@Override
@NotNull
protected String buildErrorString(Object... infos) {
return InspectionGadgetsBundle.message("method.may.be.static.problem.descriptor");
}
@Override
protected InspectionGadgetsFix buildFix(Object... infos) {
return new InspectionGadgetsFix() {
@Override
public void doFix(Project project, ProblemDescriptor descriptor) {
final PsiMethod element = PsiTreeUtil.getParentOfType(descriptor.getPsiElement(), PsiMethod.class);
new MakeMethodStaticProcessor(element.getProject(), element, new Settings(m_replaceQualifier, null, null)).run();
}
@Override
@NotNull
public String getName() {
return InspectionGadgetsBundle.message("change.modifier.quickfix", PsiModifier.STATIC);
}
@NotNull
@Override
public String getFamilyName() {
return ChangeModifierFix.FAMILY_NAME;
}
};
}
@Override
public JComponent createOptionsPanel() {
final MultipleCheckboxOptionsPanel optionsPanel = new MultipleCheckboxOptionsPanel(this);
optionsPanel.addCheckbox(InspectionGadgetsBundle.message("method.may.be.static.only.option"), ONLY_PRIVATE_OR_FINAL_ATTR_NAME);
optionsPanel.addCheckbox(InspectionGadgetsBundle.message("method.may.be.static.empty.option"), IGNORE_EMPTY_METHODS_ATTR_NAME);
optionsPanel.addCheckbox("Ignore default methods", IGNORE_DEFAULT_METHODS_ATTR_NAME);
optionsPanel.addCheckbox("Replace qualifier by class name", REPLACE_QUALIFIER_ATTR_NAME);
return optionsPanel;
}
@Override
public BaseInspectionVisitor buildVisitor() {
return new MethodCanBeStaticVisitor();
}
@Override
public void writeSettings(@NotNull Element node) throws WriteExternalException {
node.addContent(new Element("option").setAttribute("name", ONLY_PRIVATE_OR_FINAL_ATTR_NAME).setAttribute("value", String.valueOf(m_onlyPrivateOrFinal)));
node.addContent(new Element("option").setAttribute("name", IGNORE_EMPTY_METHODS_ATTR_NAME).setAttribute("value", String.valueOf(
m_ignoreEmptyMethods)));
if (!m_ignoreDefaultMethods) {
node.addContent(new Element("option").setAttribute("name", IGNORE_DEFAULT_METHODS_ATTR_NAME).setAttribute("value", "false"));
}
if (!m_replaceQualifier) {
node.addContent(new Element("option").setAttribute("name", REPLACE_QUALIFIER_ATTR_NAME).setAttribute("value", "false"));
}
}
private class MethodCanBeStaticVisitor extends BaseInspectionVisitor {
@Override
public void visitMethod(@NotNull PsiMethod method) {
super.visitMethod(method);
if (method.hasModifierProperty(PsiModifier.STATIC) ||
method.hasModifierProperty(PsiModifier.ABSTRACT) ||
method.hasModifierProperty(PsiModifier.SYNCHRONIZED) ||
method.hasModifierProperty(PsiModifier.NATIVE)) {
return;
}
if (method.isConstructor() || method.getNameIdentifier() == null) {
return;
}
if (m_ignoreDefaultMethods && method.hasModifierProperty(PsiModifier.DEFAULT)) {
return;
}
if (m_ignoreEmptyMethods && MethodUtils.isEmpty(method)) {
return;
}
final PsiClass containingClass = ClassUtils.getContainingClass(method);
if (containingClass == null) {
return;
}
final Condition<PsiElement>[] addins = InspectionManager.CANT_BE_STATIC_EXTENSION.getExtensions();
for (Condition<PsiElement> addin : addins) {
if (addin.value(method)) {
return;
}
}
final PsiElement scope = containingClass.getScope();
if (!(scope instanceof PsiJavaFile) && !containingClass.hasModifierProperty(PsiModifier.STATIC) && !containingClass.isInterface()) {
return;
}
if (m_onlyPrivateOrFinal && !method.hasModifierProperty(PsiModifier.FINAL) && !method.hasModifierProperty(PsiModifier.PRIVATE)) {
return;
}
if (isExcluded(method) || MethodUtils.hasSuper(method) || MethodUtils.isOverridden(method)) {
return;
}
if (implementsSurprisingInterface(method)) {
return;
}
final MethodReferenceVisitor visitor = new MethodReferenceVisitor(method);
method.accept(visitor);
if (!visitor.areReferencesStaticallyAccessible()) {
return;
}
registerMethodError(method);
}
private boolean implementsSurprisingInterface(final PsiMethod method) {
final PsiClass containingClass = method.getContainingClass();
if (containingClass == null) {
return false;
}
final Query<PsiClass> search = ClassInheritorsSearch.search(containingClass, method.getUseScope(), true, true, false);
final boolean[] result = new boolean[1];
search.forEach(new Processor<PsiClass>() {
AtomicInteger count = new AtomicInteger(0);
@Override
public boolean process(PsiClass subClass) {
if (count.incrementAndGet() > 5) {
result[0] = true;
return false;
}
final PsiReferenceList list = subClass.getImplementsList();
if (list == null) {
return true;
}
final PsiJavaCodeReferenceElement[] referenceElements = list.getReferenceElements();
for (PsiJavaCodeReferenceElement referenceElement : referenceElements) {
final PsiElement target = referenceElement.resolve();
if (!(target instanceof PsiClass)) {
result[0] = true;
return false;
}
final PsiClass aClass = (PsiClass)target;
if (!aClass.isInterface()) {
result[0] = true;
return false;
}
if (aClass.findMethodBySignature(method, true) != null) {
result[0] = true;
return false;
}
}
return true;
}
});
return result[0];
}
private boolean isExcluded(PsiMethod method) {
return SerializationUtils.isWriteObject(method) || SerializationUtils.isReadObject(method) ||
SerializationUtils.isWriteReplace(method) || SerializationUtils.isReadResolve(method);
}
}
}
|
