|
| 1 | +/* |
| 2 | + * Minecraft Development for IntelliJ |
| 3 | + * |
| 4 | + * https://mcdev.io/ |
| 5 | + * |
| 6 | + * Copyright (C) 2023 minecraft-dev |
| 7 | + * |
| 8 | + * This program is free software: you can redistribute it and/or modify |
| 9 | + * it under the terms of the GNU Lesser General Public License as published |
| 10 | + * by the Free Software Foundation, version 3.0 only. |
| 11 | + * |
| 12 | + * This program is distributed in the hope that it will be useful, |
| 13 | + * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | + * GNU General Public License for more details. |
| 16 | + * |
| 17 | + * You should have received a copy of the GNU Lesser General Public License |
| 18 | + * along with this program. If not, see <https://www.gnu.org/licenses/>. |
| 19 | + */ |
| 20 | + |
| 21 | +package com.demonwav.mcdev.platform.mixin.inspection.mixinextras |
| 22 | + |
| 23 | +import com.demonwav.mcdev.platform.mixin.handlers.InjectorAnnotationHandler |
| 24 | +import com.demonwav.mcdev.platform.mixin.handlers.MixinAnnotationHandler |
| 25 | +import com.demonwav.mcdev.platform.mixin.handlers.mixinextras.WrapOperationHandler |
| 26 | +import com.demonwav.mcdev.platform.mixin.inspection.MixinInspection |
| 27 | +import com.demonwav.mcdev.platform.mixin.util.MixinConstants |
| 28 | +import com.demonwav.mcdev.util.findContainingMethod |
| 29 | +import com.intellij.codeInspection.LocalQuickFixOnPsiElement |
| 30 | +import com.intellij.codeInspection.ProblemsHolder |
| 31 | +import com.intellij.openapi.project.Project |
| 32 | +import com.intellij.psi.JavaElementVisitor |
| 33 | +import com.intellij.psi.PsiClass |
| 34 | +import com.intellij.psi.PsiClassType |
| 35 | +import com.intellij.psi.PsiElement |
| 36 | +import com.intellij.psi.PsiElementFactory |
| 37 | +import com.intellij.psi.PsiExpressionList |
| 38 | +import com.intellij.psi.PsiFile |
| 39 | +import com.intellij.psi.PsiMethod |
| 40 | +import com.intellij.psi.PsiMethodCallExpression |
| 41 | +import com.intellij.psi.PsiParameter |
| 42 | +import com.intellij.psi.PsiReferenceExpression |
| 43 | +import com.intellij.psi.PsiType |
| 44 | +import com.intellij.psi.PsiTypes |
| 45 | +import com.intellij.psi.search.searches.OverridingMethodsSearch |
| 46 | +import com.intellij.psi.search.searches.ReferencesSearch |
| 47 | +import com.intellij.psi.util.PsiUtil |
| 48 | +import com.intellij.psi.util.parentOfType |
| 49 | +import com.siyeh.ig.psiutils.MethodCallUtils |
| 50 | +import org.jetbrains.plugins.groovy.intentions.style.inference.resolve |
| 51 | + |
| 52 | +class UnnecessaryMutableLocalInspection : MixinInspection() { |
| 53 | + override fun getStaticDescription() = "Unnecessary mutable reference to captured local" |
| 54 | + |
| 55 | + override fun buildVisitor(holder: ProblemsHolder) = object : JavaElementVisitor() { |
| 56 | + override fun visitMethod(method: PsiMethod) { |
| 57 | + val project = method.project |
| 58 | + val hasValidMixinAnnotation = method.annotations.any { ann -> |
| 59 | + ann.qualifiedName?.let { MixinAnnotationHandler.forMixinAnnotation(it, project) } |
| 60 | + // Mutable Local references do have different semantics inside a WrapOperation. |
| 61 | + ?.let { it is InjectorAnnotationHandler && it !is WrapOperationHandler } == true |
| 62 | + } |
| 63 | + if (!hasValidMixinAnnotation) { |
| 64 | + return |
| 65 | + } |
| 66 | + |
| 67 | + // ignore if method has any references |
| 68 | + val hasReferences = ReferencesSearch.search(method) |
| 69 | + .mapNotNull { PsiUtil.skipParenthesizedExprUp(it.element).parent as? PsiMethodCallExpression } |
| 70 | + .any { !MethodCallUtils.hasSuperQualifier(it) } |
| 71 | + if (hasReferences) { |
| 72 | + return |
| 73 | + } |
| 74 | + |
| 75 | + for ((i, param) in method.parameterList.parameters.withIndex()) { |
| 76 | + if (!param.hasAnnotation(MixinConstants.MixinExtras.LOCAL)) { |
| 77 | + continue |
| 78 | + } |
| 79 | + val paramType = param.type.resolve() |
| 80 | + if (paramType?.qualifiedName?.startsWith(MixinConstants.MixinExtras.LOCAL_REF_PACKAGE) != true) { |
| 81 | + continue |
| 82 | + } |
| 83 | + |
| 84 | + checkParameter(holder, method, param, i, paramType) |
| 85 | + } |
| 86 | + } |
| 87 | + } |
| 88 | + |
| 89 | + private fun checkParameter( |
| 90 | + holder: ProblemsHolder, |
| 91 | + originalMethod: PsiMethod, |
| 92 | + originalParam: PsiParameter, |
| 93 | + paramIndex: Int, |
| 94 | + paramType: PsiClass |
| 95 | + ) { |
| 96 | + var hasAnyGets = false |
| 97 | + for (method in OverridingMethodsSearch.search(originalMethod).findAll() + listOf(originalMethod)) { |
| 98 | + val param = method.parameterList.getParameter(paramIndex) ?: return |
| 99 | + val getMethod = paramType.findMethodsByName("get", false).firstOrNull() ?: return |
| 100 | + for (ref in ReferencesSearch.search(param)) { |
| 101 | + if (isDelegationToSuper(ref.element, paramIndex)) { |
| 102 | + continue |
| 103 | + } |
| 104 | + val parent = PsiUtil.skipParenthesizedExprUp(ref.element.parent) as? PsiReferenceExpression ?: return |
| 105 | + if (parent.references.any { it.isReferenceTo(getMethod) }) { |
| 106 | + hasAnyGets = true |
| 107 | + } else { |
| 108 | + return |
| 109 | + } |
| 110 | + } |
| 111 | + } |
| 112 | + if (!hasAnyGets) { |
| 113 | + // Don't annoy them if they've just made the parameter |
| 114 | + return |
| 115 | + } |
| 116 | + holder.registerProblem( |
| 117 | + originalParam.typeElement ?: originalParam, |
| 118 | + "@Local could be captured immutably", |
| 119 | + SwitchToImmutableCaptureFix(originalParam) |
| 120 | + ) |
| 121 | + } |
| 122 | + |
| 123 | + // Ignore super delegations in subclasses. super.foo(myLocalRef) has no effect on whether the local can be converted |
| 124 | + private fun isDelegationToSuper(ref: PsiElement, paramIndex: Int): Boolean { |
| 125 | + val method = ref.findContainingMethod() ?: return false |
| 126 | + val superMethod = method.findSuperMethods().firstOrNull { it.containingClass?.isInterface == false } |
| 127 | + ?: return false |
| 128 | + |
| 129 | + // For some reason ref is sometimes the identifier rather than the reference expression. Get the reference expr |
| 130 | + val actualRef = if (ref is PsiReferenceExpression) { |
| 131 | + ref |
| 132 | + } else { |
| 133 | + PsiUtil.skipParenthesizedExprUp(ref.parent) as? PsiReferenceExpression ?: return false |
| 134 | + } |
| 135 | + val param = PsiUtil.skipParenthesizedExprUp(actualRef) |
| 136 | + val paramList = param.parent as? PsiExpressionList ?: return false |
| 137 | + val methodCall = paramList.parent as? PsiMethodCallExpression ?: return false |
| 138 | + |
| 139 | + // Check that the method call is a super call |
| 140 | + if (!MethodCallUtils.hasSuperQualifier(methodCall)) { |
| 141 | + return false |
| 142 | + } |
| 143 | + |
| 144 | + // Check that our reference is in the correct parameter index |
| 145 | + if (paramList.expressions.getOrNull(paramIndex) != param) { |
| 146 | + return false |
| 147 | + } |
| 148 | + |
| 149 | + // Check that the super call is referencing the correct super method. |
| 150 | + return methodCall.resolveMethod() == superMethod |
| 151 | + } |
| 152 | + |
| 153 | + private class SwitchToImmutableCaptureFix(param: PsiParameter) : LocalQuickFixOnPsiElement(param) { |
| 154 | + override fun getFamilyName() = "Switch to immutable capture" |
| 155 | + override fun getText() = "Switch to immutable capture" |
| 156 | + |
| 157 | + override fun invoke(project: Project, file: PsiFile, startElement: PsiElement, endElement: PsiElement) { |
| 158 | + val param = startElement as? PsiParameter ?: return |
| 159 | + val method = param.parentOfType<PsiMethod>() ?: return |
| 160 | + val paramIndex = method.parameterList.getParameterIndex(param) |
| 161 | + val methods = mutableListOf(method) |
| 162 | + if (file.isPhysical) { |
| 163 | + methods.addAll(OverridingMethodsSearch.search(method)) |
| 164 | + } |
| 165 | + for (impl in methods) { |
| 166 | + fixMethod(impl, paramIndex) |
| 167 | + } |
| 168 | + } |
| 169 | + |
| 170 | + private fun fixMethod(method: PsiMethod, paramIndex: Int) { |
| 171 | + val param = method.parameterList.getParameter(paramIndex) ?: return |
| 172 | + val paramType = param.type as? PsiClassType ?: return |
| 173 | + val innerType = paramType.innerRefType ?: return |
| 174 | + val factory = PsiElementFactory.getInstance(method.project) |
| 175 | + param.typeElement?.replace(factory.createTypeElement(innerType)) |
| 176 | + for (ref in ReferencesSearch.search(param)) { |
| 177 | + val refExpression = PsiUtil.skipParenthesizedExprUp(ref.element.parent) as? PsiReferenceExpression |
| 178 | + ?: continue |
| 179 | + val call = refExpression.parent as? PsiMethodCallExpression ?: continue |
| 180 | + call.replace(ref.element) |
| 181 | + } |
| 182 | + } |
| 183 | + |
| 184 | + private val PsiClassType.innerRefType: PsiType? |
| 185 | + get() = |
| 186 | + when (resolve()?.qualifiedName?.substringAfterLast('.')) { |
| 187 | + "LocalBooleanRef" -> PsiTypes.booleanType() |
| 188 | + "LocalCharRef" -> PsiTypes.charType() |
| 189 | + "LocalDoubleRef" -> PsiTypes.doubleType() |
| 190 | + "LocalFloatRef" -> PsiTypes.floatType() |
| 191 | + "LocalIntRef" -> PsiTypes.intType() |
| 192 | + "LocalLongRef" -> PsiTypes.longType() |
| 193 | + "LocalShortRef" -> PsiTypes.shortType() |
| 194 | + "LocalRef" -> parameters.getOrNull(0) |
| 195 | + else -> null |
| 196 | + } |
| 197 | + } |
| 198 | +} |
0 commit comments