| /* |
| * Copyright 2000-2014 JetBrains s.r.o. |
| * |
| * 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.metrics; |
| |
| import com.intellij.psi.PsiType; |
| import org.jetbrains.annotations.Nls; |
| import org.jetbrains.annotations.NotNull; |
| import org.jetbrains.plugins.groovy.codeInspection.BaseInspectionVisitor; |
| import org.jetbrains.plugins.groovy.codeInspection.utils.ControlFlowUtils; |
| import org.jetbrains.plugins.groovy.lang.psi.api.statements.GrStatement; |
| import org.jetbrains.plugins.groovy.lang.psi.api.statements.blocks.GrCodeBlock; |
| import org.jetbrains.plugins.groovy.lang.psi.api.statements.typedef.members.GrMethod; |
| |
| public class GroovyMultipleReturnPointsPerMethodInspectionBase extends GroovyMethodMetricInspection { |
| @Override |
| @Nls |
| @NotNull |
| public String getGroupDisplayName() { |
| return METHOD_METRICS; |
| } |
| |
| @Override |
| @NotNull |
| public String getDisplayName() { |
| return "Method with multiple return points"; |
| } |
| |
| @Override |
| protected int getDefaultLimit() { |
| return 1; |
| } |
| |
| @Override |
| protected String getConfigurationLabel() { |
| return "Return point limit:"; |
| } |
| |
| @Override |
| @NotNull |
| public String buildErrorString(Object... infos) { |
| final Integer returnPointCount = (Integer) infos[0]; |
| return "<code>#ref</code> has " + returnPointCount + " return points #loc"; |
| |
| } |
| |
| @NotNull |
| @Override |
| public BaseInspectionVisitor buildVisitor() { |
| return new MultipleReturnPointsVisitor(); |
| } |
| |
| private class MultipleReturnPointsVisitor extends BaseInspectionVisitor { |
| |
| @Override |
| public void visitMethod(@NotNull GrMethod method) { |
| // note: no call to super |
| if (method.getNameIdentifier() == null) { |
| return; |
| } |
| final int returnPointCount = calculateReturnPointCount(method); |
| if (returnPointCount <= getLimit()) { |
| return; |
| } |
| registerMethodError(method, Integer.valueOf(returnPointCount)); |
| } |
| |
| private int calculateReturnPointCount(GrMethod method) { |
| final ReturnPointCountVisitor visitor = |
| new ReturnPointCountVisitor(); |
| method.accept(visitor); |
| final int count = visitor.getCount(); |
| if (!mayFallThroughBottom(method)) { |
| return count; |
| } |
| final GrCodeBlock body = method.getBlock(); |
| if (body == null) { |
| return count; |
| } |
| final GrStatement[] statements = body.getStatements(); |
| if (statements.length == 0) { |
| return count + 1; |
| } |
| final GrStatement lastStatement = |
| statements[statements.length - 1]; |
| if (ControlFlowUtils.statementMayCompleteNormally(lastStatement)) { |
| return count + 1; |
| } |
| return count; |
| } |
| |
| private boolean mayFallThroughBottom(GrMethod method) { |
| if (method.isConstructor()) { |
| return true; |
| } |
| final PsiType returnType = method.getReturnType(); |
| return PsiType.VOID.equals(returnType); |
| } |
| } |
| } |