| /* |
| * Copyright 2008-2012 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.openapi.project.Project; |
| import com.intellij.psi.*; |
| import com.intellij.psi.codeStyle.JavaCodeStyleManager; |
| import com.intellij.psi.codeStyle.SuggestedNameInfo; |
| import com.intellij.psi.codeStyle.VariableKind; |
| import com.intellij.psi.util.PsiTreeUtil; |
| import com.intellij.util.IncorrectOperationException; |
| 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.TypeUtils; |
| import com.siyeh.ig.psiutils.VariableAccessUtils; |
| import org.jetbrains.annotations.Nls; |
| import org.jetbrains.annotations.NonNls; |
| import org.jetbrains.annotations.NotNull; |
| import org.jetbrains.annotations.Nullable; |
| |
| import java.util.ArrayList; |
| import java.util.Collections; |
| import java.util.List; |
| |
| public class KeySetIterationMayUseEntrySetInspection extends BaseInspection { |
| |
| @Override |
| @NotNull |
| @Nls |
| public String getDisplayName() { |
| return InspectionGadgetsBundle.message( |
| "key.set.iteration.may.use.entry.set.display.name"); |
| } |
| |
| @Override |
| @NotNull |
| protected String buildErrorString(Object... infos) { |
| return InspectionGadgetsBundle.message( |
| "key.set.iteration.may.use.entry.set.problem.descriptor"); |
| } |
| |
| @Override |
| protected InspectionGadgetsFix buildFix(Object... infos) { |
| return new KeySetIterationMapUseEntrySetFix(); |
| } |
| |
| private static class KeySetIterationMapUseEntrySetFix extends InspectionGadgetsFix { |
| @Override |
| @NotNull |
| public String getFamilyName() { |
| return getName(); |
| } |
| |
| @Override |
| @NotNull |
| public String getName() { |
| return InspectionGadgetsBundle.message("key.set.iteration.may.use.entry.set.quickfix"); |
| } |
| |
| @Override |
| protected void doFix(Project project, ProblemDescriptor descriptor) throws IncorrectOperationException { |
| final PsiElement element = descriptor.getPsiElement(); |
| final PsiElement parent = element.getParent(); |
| if (!(parent instanceof PsiForeachStatement)) { |
| return; |
| } |
| final PsiElement map; |
| if (element instanceof PsiReferenceExpression) { |
| final PsiReferenceExpression referenceExpression = (PsiReferenceExpression)element; |
| final PsiElement target = referenceExpression.resolve(); |
| if (!(target instanceof PsiVariable)) { |
| return; |
| } |
| final PsiVariable variable = (PsiVariable)target; |
| final PsiExpression initializer = variable.getInitializer(); |
| if (!(initializer instanceof PsiMethodCallExpression)) { |
| return; |
| } |
| final PsiMethodCallExpression methodCallExpression = (PsiMethodCallExpression)initializer; |
| final PsiReferenceExpression methodExpression = methodCallExpression.getMethodExpression(); |
| final PsiExpression qualifier = methodExpression.getQualifierExpression(); |
| if (!(qualifier instanceof PsiReferenceExpression)) { |
| return; |
| } |
| final PsiReferenceExpression reference = (PsiReferenceExpression)qualifier; |
| map = reference.resolve(); |
| final String qualifierText = qualifier.getText(); |
| PsiReplacementUtil.replaceExpression(referenceExpression, qualifierText + ".entrySet()"); |
| } |
| else if (element instanceof PsiMethodCallExpression) { |
| final PsiMethodCallExpression methodCallExpression = (PsiMethodCallExpression)element; |
| final PsiReferenceExpression methodExpression = methodCallExpression.getMethodExpression(); |
| final PsiExpression qualifier = methodExpression.getQualifierExpression(); |
| if (!(qualifier instanceof PsiReferenceExpression)) { |
| return; |
| } |
| final PsiReferenceExpression referenceExpression = (PsiReferenceExpression)qualifier; |
| map = referenceExpression.resolve(); |
| final String qualifierText = qualifier.getText(); |
| PsiReplacementUtil.replaceExpression(methodCallExpression, qualifierText + ".entrySet()"); |
| } |
| else { |
| return; |
| } |
| final PsiForeachStatement foreachStatement = (PsiForeachStatement)parent; |
| final PsiExpression iteratedValue = foreachStatement.getIteratedValue(); |
| if (iteratedValue == null) { |
| return; |
| } |
| final PsiType type = iteratedValue.getType(); |
| if (!(type instanceof PsiClassType)) { |
| return; |
| } |
| final PsiClassType classType = (PsiClassType)type; |
| final PsiType[] parameterTypes = classType.getParameters(); |
| PsiType parameterType = parameterTypes.length == 1 ? parameterTypes[0] : null; |
| boolean insertCast = false; |
| if (parameterType == null) { |
| parameterType = TypeUtils.getObjectType(foreachStatement); |
| insertCast = true; |
| } |
| final PsiParameter parameter = foreachStatement.getIterationParameter(); |
| final String variableName = createNewVariableName(foreachStatement, parameterType); |
| if (insertCast) { |
| replaceParameterAccess(parameter, "((Map.Entry)" + variableName + ')', map, foreachStatement); |
| } |
| else { |
| replaceParameterAccess(parameter, variableName, map, foreachStatement); |
| } |
| final PsiElementFactory factory = JavaPsiFacade.getInstance(project).getElementFactory(); |
| final PsiParameter newParameter = factory.createParameter( variableName, parameterType); |
| if (parameter.hasModifierProperty(PsiModifier.FINAL)) { |
| final PsiModifierList modifierList = newParameter.getModifierList(); |
| if (modifierList != null) { |
| modifierList.setModifierProperty(PsiModifier.FINAL, true); |
| } |
| } |
| parameter.replace(newParameter); |
| } |
| |
| private static void replaceParameterAccess(PsiParameter parameter, |
| @NonNls String variableName, |
| PsiElement map, |
| PsiElement context) { |
| final ParameterAccessCollector collector = new ParameterAccessCollector(parameter, map); |
| context.accept(collector); |
| final List<PsiExpression> accesses = collector.getParameterAccesses(); |
| for (PsiExpression access : accesses) { |
| if (access instanceof PsiMethodCallExpression) { |
| PsiReplacementUtil.replaceExpression(access, variableName + ".getValue()"); |
| } |
| else { |
| PsiReplacementUtil.replaceExpression(access, variableName + ".getKey()"); |
| } |
| } |
| } |
| |
| private static String createNewVariableName(@NotNull PsiElement scope, @NotNull PsiType type) { |
| final Project project = scope.getProject(); |
| final JavaCodeStyleManager codeStyleManager = JavaCodeStyleManager.getInstance(project); |
| @NonNls String baseName; |
| final SuggestedNameInfo suggestions = codeStyleManager.suggestVariableName(VariableKind.LOCAL_VARIABLE, null, null, type); |
| final String[] names = suggestions.names; |
| if (names != null && names.length > 0) { |
| baseName = names[0]; |
| } |
| else { |
| baseName = "entry"; |
| } |
| if (baseName == null || baseName.length() == 0) { |
| baseName = "entry"; |
| } |
| return codeStyleManager.suggestUniqueVariableName(baseName, scope, true); |
| } |
| |
| private static class ParameterAccessCollector extends JavaRecursiveElementVisitor { |
| |
| private final PsiParameter parameter; |
| private final PsiElement map; |
| private final String parameterName; |
| |
| private final List<PsiExpression> parameterAccesses = new ArrayList(); |
| |
| public ParameterAccessCollector(PsiParameter parameter, PsiElement map) { |
| this.parameter = parameter; |
| parameterName = parameter.getName(); |
| this.map = map; |
| } |
| |
| @Override |
| public void visitReferenceExpression(PsiReferenceExpression expression) { |
| super.visitReferenceExpression(expression); |
| if (expression.getQualifierExpression() != null) { |
| return; |
| } |
| final String expressionText = expression.getText(); |
| if (!expressionText.equals(parameterName)) { |
| return; |
| } |
| final PsiElement target = expression.resolve(); |
| if (!parameter.equals(target)) { |
| return; |
| } |
| try { |
| if (!collectValueUsage(expression)) { |
| parameterAccesses.add(expression); |
| } |
| } |
| catch (IncorrectOperationException e) { |
| throw new RuntimeException(e); |
| } |
| } |
| |
| private boolean collectValueUsage(PsiReferenceExpression expression) throws IncorrectOperationException { |
| final PsiElement parent = expression.getParent(); |
| if (!(parent instanceof PsiExpressionList)) { |
| return false; |
| } |
| final PsiElement grandParent = parent.getParent(); |
| if (!(grandParent instanceof PsiMethodCallExpression)) { |
| return false; |
| } |
| final PsiMethodCallExpression methodCallExpression = (PsiMethodCallExpression)grandParent; |
| final PsiReferenceExpression methodExpression = methodCallExpression.getMethodExpression(); |
| @NonNls final String methodName = methodExpression.getReferenceName(); |
| if (!"get".equals(methodName)) { |
| return false; |
| } |
| final PsiExpression qualifier = methodExpression.getQualifierExpression(); |
| if (!(qualifier instanceof PsiReferenceExpression)) { |
| return false; |
| } |
| final PsiReferenceExpression referenceExpression = (PsiReferenceExpression)qualifier; |
| final PsiElement target2 = referenceExpression.resolve(); |
| if (!map.equals(target2)) { |
| return false; |
| } |
| final PsiExpression qualifierExpression = referenceExpression.getQualifierExpression(); |
| if (qualifierExpression != null && |
| !(qualifier instanceof PsiThisExpression) || qualifierExpression instanceof PsiSuperExpression) { |
| return false; |
| } |
| parameterAccesses.add(methodCallExpression); |
| return true; |
| } |
| |
| public List<PsiExpression> getParameterAccesses() { |
| Collections.reverse(parameterAccesses); |
| return parameterAccesses; |
| } |
| } |
| } |
| |
| @Override |
| public BaseInspectionVisitor buildVisitor() { |
| return new KeySetIterationMayUseEntrySetVisitor(); |
| } |
| |
| private static class KeySetIterationMayUseEntrySetVisitor |
| extends BaseInspectionVisitor { |
| |
| @Override |
| public void visitForeachStatement(PsiForeachStatement statement) { |
| super.visitForeachStatement(statement); |
| final PsiExpression iteratedValue = statement.getIteratedValue(); |
| if (iteratedValue == null) { |
| return; |
| } |
| final PsiExpression iteratedExpression; |
| if (iteratedValue instanceof PsiReferenceExpression) { |
| final PsiReferenceExpression referenceExpression = (PsiReferenceExpression)iteratedValue; |
| final PsiElement target = referenceExpression.resolve(); |
| if (!(target instanceof PsiLocalVariable)) { |
| return; |
| } |
| final PsiVariable variable = (PsiVariable)target; |
| final PsiMethod containingMethod = PsiTreeUtil.getParentOfType(variable, PsiMethod.class); |
| if (VariableAccessUtils.variableIsAssignedAtPoint(variable, containingMethod, statement)) { |
| return; |
| } |
| iteratedExpression = variable.getInitializer(); |
| } |
| else { |
| iteratedExpression = iteratedValue; |
| } |
| final PsiParameter parameter = statement.getIterationParameter(); |
| if (!isMapKeySetIteration(iteratedExpression, parameter, statement.getBody())) { |
| return; |
| } |
| registerError(iteratedValue); |
| } |
| |
| private static boolean isMapKeySetIteration(PsiExpression iteratedExpression, PsiVariable key, @Nullable PsiElement context) { |
| if (context == null) { |
| return false; |
| } |
| if (!(iteratedExpression instanceof PsiMethodCallExpression)) { |
| return false; |
| } |
| final PsiMethodCallExpression methodCallExpression = (PsiMethodCallExpression)iteratedExpression; |
| final PsiReferenceExpression methodExpression = methodCallExpression.getMethodExpression(); |
| @NonNls final String methodName = methodExpression.getReferenceName(); |
| if (!"keySet".equals(methodName)) { |
| return false; |
| } |
| final PsiExpression expression = methodExpression.getQualifierExpression(); |
| if (!(expression instanceof PsiReferenceExpression)) { |
| return false; |
| } |
| final PsiReferenceExpression referenceExpression = (PsiReferenceExpression)expression; |
| final PsiElement target = referenceExpression.resolve(); |
| if (!(target instanceof PsiVariable)) { |
| return false; |
| } |
| final PsiVariable targetVariable = (PsiVariable)target; |
| final PsiType type = targetVariable.getType(); |
| if (!(type instanceof PsiClassType)) { |
| return false; |
| } |
| final PsiClassType classType = (PsiClassType)type; |
| final PsiClass aClass = classType.resolve(); |
| if (aClass == null) { |
| return false; |
| } |
| final String className = aClass.getQualifiedName(); |
| if (!CommonClassNames.JAVA_UTIL_MAP.equals(className)) { |
| return false; |
| } |
| final GetValueFromMapChecker checker = new GetValueFromMapChecker(targetVariable, key); |
| context.accept(checker); |
| return checker.isGetValueFromMap(); |
| } |
| } |
| |
| private static class GetValueFromMapChecker extends JavaRecursiveElementVisitor { |
| |
| private final PsiVariable key; |
| private final PsiVariable map; |
| private boolean getValueFromMap = false; |
| private boolean tainted = false; |
| |
| GetValueFromMapChecker(@NotNull PsiVariable map, @NotNull PsiVariable key) { |
| this.map = map; |
| this.key = key; |
| } |
| |
| @Override |
| public void visitReferenceExpression(PsiReferenceExpression expression) { |
| if (tainted) { |
| return; |
| } |
| super.visitReferenceExpression(expression); |
| final PsiElement parent = expression.getParent(); |
| if (parent instanceof PsiAssignmentExpression) { |
| final PsiElement target = expression.resolve(); |
| if (key.equals(target) || map.equals(target)) { |
| tainted = true; |
| } |
| } |
| else if (!(parent instanceof PsiReferenceExpression)) { |
| return; |
| } |
| final PsiElement grandParent = parent.getParent(); |
| if (!(grandParent instanceof PsiMethodCallExpression)) { |
| return; |
| } |
| final PsiMethodCallExpression methodCallExpression = (PsiMethodCallExpression)grandParent; |
| final PsiReferenceExpression methodExpression = (PsiReferenceExpression)parent; |
| final PsiElement target = expression.resolve(); |
| if (!map.equals(target)) { |
| return; |
| } |
| final PsiExpression qualifierExpression = expression.getQualifierExpression(); |
| if (qualifierExpression != null && |
| !(qualifierExpression instanceof PsiThisExpression || qualifierExpression instanceof PsiSuperExpression)) { |
| return; |
| } |
| @NonNls final String methodName = methodExpression.getReferenceName(); |
| if (!"get".equals(methodName)) { |
| return; |
| } |
| final PsiExpressionList argumentList = methodCallExpression.getArgumentList(); |
| final PsiExpression[] arguments = argumentList.getExpressions(); |
| if (arguments.length != 1) { |
| return; |
| } |
| final PsiExpression argument = arguments[0]; |
| if (!(argument instanceof PsiReferenceExpression)) { |
| return; |
| } |
| final PsiReferenceExpression referenceExpression = (PsiReferenceExpression)argument; |
| final PsiElement argumentTarget = referenceExpression.resolve(); |
| if (!key.equals(argumentTarget)) { |
| return; |
| } |
| getValueFromMap = true; |
| } |
| |
| public boolean isGetValueFromMap() { |
| return getValueFromMap && !tainted; |
| } |
| } |
| } |
