| /* |
| * Copyright 2000-2013 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 com.siyeh.ipp.modifiers; |
| |
| import com.intellij.codeInsight.intention.LowPriorityAction; |
| import com.intellij.openapi.application.AccessToken; |
| import com.intellij.openapi.application.WriteAction; |
| import com.intellij.openapi.util.io.FileUtil; |
| import com.intellij.psi.*; |
| import com.intellij.psi.impl.source.resolve.JavaResolveUtil; |
| import com.intellij.psi.search.searches.OverridingMethodsSearch; |
| import com.intellij.psi.search.searches.ReferencesSearch; |
| import com.intellij.psi.search.searches.SuperMethodsSearch; |
| import com.intellij.psi.util.MethodSignatureBackedByPsiMethod; |
| import com.intellij.psi.util.PsiTreeUtil; |
| import com.intellij.refactoring.RefactoringBundle; |
| import com.intellij.refactoring.ui.ConflictsDialog; |
| import com.intellij.refactoring.util.CommonRefactoringUtil; |
| import com.intellij.refactoring.util.RefactoringUIUtil; |
| import com.intellij.util.IncorrectOperationException; |
| import com.intellij.util.Processor; |
| import com.intellij.util.Query; |
| import com.intellij.util.containers.MultiMap; |
| import com.siyeh.IntentionPowerPackBundle; |
| import com.siyeh.ipp.base.Intention; |
| import com.siyeh.ipp.base.PsiElementPredicate; |
| import org.intellij.lang.annotations.MagicConstant; |
| import org.jetbrains.annotations.NotNull; |
| |
| /** |
| * @author Bas Leijdekkers |
| */ |
| abstract class ModifierIntention extends Intention implements LowPriorityAction { |
| |
| @NotNull |
| @Override |
| protected final PsiElementPredicate getElementPredicate() { |
| return new ModifierPredicate(getModifier()); |
| } |
| |
| @Override |
| protected final void processIntention(@NotNull PsiElement element) throws IncorrectOperationException { |
| final PsiMember member = (PsiMember)element.getParent(); |
| final PsiModifierList modifierList = member.getModifierList(); |
| if (modifierList == null) { |
| return; |
| } |
| final MultiMap<PsiElement, String> conflicts = checkForConflicts(member); |
| final boolean conflictsDialogOK; |
| if (conflicts.isEmpty()) { |
| conflictsDialogOK = true; |
| } else { |
| final ConflictsDialog conflictsDialog = new ConflictsDialog(member.getProject(), conflicts, new Runnable() { |
| @Override |
| public void run() { |
| final AccessToken token = WriteAction.start(); |
| try { |
| modifierList.setModifierProperty(getModifier(), true); |
| } |
| finally { |
| token.finish(); |
| } |
| } |
| }); |
| conflictsDialog.show(); |
| conflictsDialogOK = conflictsDialog.isOK(); |
| } |
| if (conflictsDialogOK) { |
| modifierList.setModifierProperty(getModifier(), true); |
| } |
| } |
| |
| private MultiMap<PsiElement, String> checkForConflicts(@NotNull final PsiMember member) { |
| if (member instanceof PsiClass && getModifier().equals(PsiModifier.PUBLIC)) { |
| final PsiClass aClass = (PsiClass)member; |
| final PsiElement parent = aClass.getParent(); |
| if (!(parent instanceof PsiJavaFile)) { |
| return MultiMap.emptyInstance(); |
| } |
| final PsiJavaFile javaFile = (PsiJavaFile)parent; |
| final String name = FileUtil.getNameWithoutExtension(javaFile.getName()); |
| final String className = aClass.getName(); |
| if (name.equals(className)) { |
| return MultiMap.emptyInstance(); |
| } |
| final MultiMap<PsiElement, String> conflicts = new MultiMap(); |
| conflicts.putValue(aClass, IntentionPowerPackBundle.message( |
| "0.is.declared.in.1.but.when.public.should.be.declared.in.a.file.named.2", |
| RefactoringUIUtil.getDescription(aClass, false), |
| RefactoringUIUtil.getDescription(javaFile, false), |
| CommonRefactoringUtil.htmlEmphasize(className + ".java"))); |
| return conflicts; |
| } |
| final PsiModifierList modifierList = member.getModifierList(); |
| if (modifierList == null || modifierList.hasModifierProperty(PsiModifier.PRIVATE)) { |
| return MultiMap.emptyInstance(); |
| } |
| final MultiMap<PsiElement, String> conflicts = new MultiMap(); |
| if (member instanceof PsiMethod) { |
| final PsiMethod method = (PsiMethod)member; |
| SuperMethodsSearch.search(method, method.getContainingClass(), true, false).forEach( |
| new Processor<MethodSignatureBackedByPsiMethod>() { |
| @Override |
| public boolean process(MethodSignatureBackedByPsiMethod methodSignature) { |
| final PsiMethod superMethod = methodSignature.getMethod(); |
| if (!hasCompatibleVisibility(superMethod, true)) { |
| conflicts.putValue(superMethod, IntentionPowerPackBundle.message( |
| "0.will.have.incompatible.access.privileges.with.super.1", |
| RefactoringUIUtil.getDescription(method, false), |
| RefactoringUIUtil.getDescription(superMethod, true))); |
| } |
| return true; |
| } |
| }); |
| OverridingMethodsSearch.search(method).forEach(new Processor<PsiMethod>() { |
| @Override |
| public boolean process(PsiMethod overridingMethod) { |
| if (!isVisibleFromOverridingMethod(method, overridingMethod)) { |
| conflicts.putValue(overridingMethod, IntentionPowerPackBundle.message( |
| "0.will.no.longer.be.visible.from.overriding.1", |
| RefactoringUIUtil.getDescription(method, false), |
| RefactoringUIUtil.getDescription(overridingMethod, true))); |
| } |
| else if (!hasCompatibleVisibility(overridingMethod, false)) { |
| conflicts.putValue(overridingMethod, IntentionPowerPackBundle.message( |
| "0.will.have.incompatible.access.privileges.with.overriding.1", |
| RefactoringUIUtil.getDescription(method, false), |
| RefactoringUIUtil.getDescription(overridingMethod, true))); |
| } |
| return false; |
| } |
| }); |
| } |
| final PsiModifierList modifierListCopy = (PsiModifierList)modifierList.copy(); |
| modifierListCopy.setModifierProperty(getModifier(), true); |
| final Query<PsiReference> search = ReferencesSearch.search(member, member.getResolveScope()); |
| search.forEach(new Processor<PsiReference>() { |
| |
| @Override |
| public boolean process(PsiReference reference) { |
| final PsiElement element = reference.getElement(); |
| if (JavaResolveUtil.isAccessible(member, member.getContainingClass(), modifierListCopy, element, null, null)) { |
| return true; |
| } |
| final PsiElement context = PsiTreeUtil.getParentOfType(element, PsiMethod.class, PsiField.class, PsiClass.class, PsiFile.class); |
| if (context == null) { |
| return true; |
| } |
| conflicts.putValue(element, RefactoringBundle.message("0.with.1.visibility.is.not.accessible.from.2", |
| RefactoringUIUtil.getDescription(member, false), |
| PsiBundle.visibilityPresentation(getModifier()), |
| RefactoringUIUtil.getDescription(context, true))); |
| return true; |
| } |
| }); |
| return conflicts; |
| } |
| |
| private boolean hasCompatibleVisibility(PsiMethod method, boolean isSuper) { |
| if (getModifier().equals(PsiModifier.PRIVATE)) { |
| return false; |
| } |
| else if (getModifier().equals(PsiModifier.PACKAGE_LOCAL)) { |
| if (isSuper) { |
| return !(method.hasModifierProperty(PsiModifier.PUBLIC) || method.hasModifierProperty(PsiModifier.PROTECTED)); |
| } |
| return true; |
| } |
| else if (getModifier().equals(PsiModifier.PROTECTED)) { |
| if (isSuper) { |
| return !method.hasModifierProperty(PsiModifier.PUBLIC); |
| } |
| else { |
| return method.hasModifierProperty(PsiModifier.PROTECTED) || method.hasModifierProperty(PsiModifier.PUBLIC); |
| } |
| } |
| else if (getModifier().equals(PsiModifier.PUBLIC)) { |
| if (!isSuper) { |
| return method.hasModifierProperty(PsiModifier.PUBLIC); |
| } |
| return true; |
| } |
| throw new AssertionError(); |
| } |
| |
| private boolean isVisibleFromOverridingMethod(PsiMethod method, PsiMethod overridingMethod) { |
| final PsiModifierList modifierListCopy = (PsiModifierList)method.getModifierList().copy(); |
| modifierListCopy.setModifierProperty(getModifier(), true); |
| return JavaResolveUtil.isAccessible(method, method.getContainingClass(), modifierListCopy, overridingMethod, null, null); |
| } |
| |
| @VisibilityConstant |
| protected abstract String getModifier(); |
| |
| @MagicConstant(stringValues = {PsiModifier.PUBLIC, PsiModifier.PROTECTED, PsiModifier.PRIVATE, PsiModifier.PACKAGE_LOCAL}) |
| @interface VisibilityConstant {} |
| } |
