| /* |
| * 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.GrClosableBlock; |
| 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 GroovyReturnFromClosureCanBeImplicitInspection extends BaseInspection { |
| |
| @Override |
| @Nls |
| @NotNull |
| public String getGroupDisplayName() { |
| return CONTROL_FLOW; |
| } |
| |
| @Override |
| @Nls |
| @NotNull |
| public String getDisplayName() { |
| return "'return' statement can be implicit"; |
| } |
| |
| @Override |
| @Nullable |
| protected String buildErrorString(Object... args) { |
| return "#ref statement at end of a closure can be made implicit #loc"; |
| |
| } |
| |
| @NotNull |
| @Override |
| public BaseInspectionVisitor buildVisitor() { |
| return new Visitor(); |
| } |
| |
| @Override |
| @Nullable |
| protected GroovyFix buildFix(@NotNull PsiElement location) { |
| return new MakeReturnImplicitFix(); |
| } |
| |
| private static class MakeReturnImplicitFix extends GroovyFix { |
| @Override |
| @NotNull |
| public String getName() { |
| return "Make return implicit"; |
| } |
| |
| @Override |
| public void doFix(Project project, ProblemDescriptor descriptor) throws IncorrectOperationException { |
| |
| final PsiElement returnKeywordElement = descriptor.getPsiElement(); |
| final GrReturnStatement returnStatement = (GrReturnStatement) returnKeywordElement.getParent(); |
| if (returnStatement == null) return; |
| if (returnStatement.getReturnValue() == null) return; |
| replaceStatement(returnStatement, returnStatement.getReturnValue().getText()); |
| } |
| } |
| |
| 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 GrClosableBlock closure = |
| PsiTreeUtil.getParentOfType(returnStatement, GrClosableBlock.class); |
| if (closure == null) { |
| return; |
| } |
| final GrMethod containingMethod = |
| PsiTreeUtil.getParentOfType(returnStatement, GrMethod.class); |
| if (containingMethod != null && PsiTreeUtil.isAncestor(closure, containingMethod, true)) { |
| return; |
| } |
| if (!ControlFlowUtils.closureCompletesWithStatement(closure, returnStatement)) { |
| return; |
| } |
| registerStatementError(returnStatement); |
| } |
| } |
| } |