blob: 2f492048abfc97ce961ec2428d8a7215f119e164 (
plain)
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
|
/*
* Copyright 2007-2008 Dave Griffith
*
* 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 org.jetbrains.plugins.groovy.codeInspection.control;
import com.intellij.codeInspection.ProblemDescriptor;
import com.intellij.openapi.project.Project;
import com.intellij.psi.PsiElement;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.util.IncorrectOperationException;
import org.jetbrains.annotations.Nls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.plugins.groovy.codeInspection.BaseInspection;
import org.jetbrains.plugins.groovy.codeInspection.BaseInspectionVisitor;
import org.jetbrains.plugins.groovy.codeInspection.GroovyFix;
import org.jetbrains.plugins.groovy.codeInspection.utils.ControlFlowUtils;
import org.jetbrains.plugins.groovy.lang.psi.api.statements.blocks.GrOpenBlock;
import org.jetbrains.plugins.groovy.lang.psi.api.statements.branch.GrReturnStatement;
import org.jetbrains.plugins.groovy.lang.psi.api.statements.expressions.GrExpression;
import org.jetbrains.plugins.groovy.lang.psi.api.statements.typedef.members.GrMethod;
public class GroovyUnnecessaryReturnInspection extends BaseInspection {
@Override
@Nls
@NotNull
public String getGroupDisplayName() {
return CONTROL_FLOW;
}
@Override
@Nls
@NotNull
public String getDisplayName() {
return "Unnecessary 'return' statement";
}
@Override
@Nullable
protected String buildErrorString(Object... args) {
return "#ref is unnecessary as the last statement in a method with no return value #loc";
}
@Override
public boolean isEnabledByDefault() {
return true;
}
@NotNull
@Override
public BaseInspectionVisitor buildVisitor() {
return new Visitor();
}
@Override
@Nullable
protected GroovyFix buildFix(@NotNull PsiElement location) {
return new UnnecessaryReturnFix();
}
private static class UnnecessaryReturnFix extends GroovyFix {
@Override
@NotNull
public String getName() {
return "Remove unnecessary return";
}
@Override
public void doFix(Project project, ProblemDescriptor descriptor) throws IncorrectOperationException {
final PsiElement returnKeywordElement = descriptor.getPsiElement();
final GrReturnStatement returnStatement = (GrReturnStatement) returnKeywordElement.getParent();
assert returnStatement != null;
returnStatement.removeStatement();
}
}
private static class Visitor extends BaseInspectionVisitor {
@Override
public void visitReturnStatement(GrReturnStatement returnStatement) {
super.visitReturnStatement(returnStatement);
final GrExpression returnValue = returnStatement.getReturnValue();
if (returnValue != null) return;
final GrMethod method = PsiTreeUtil.getParentOfType(returnStatement, GrMethod.class);
if (method == null) return;
final GrOpenBlock body = method.getBlock();
if (body == null) return;
if (ControlFlowUtils.openBlockCompletesWithStatement(body, returnStatement)) {
registerStatementError(returnStatement);
}
}
}
}
|
