src/main/kotlin/platform/mixin/inspection/mixinextras/WrongOperationParametersInspection.kt diff

← → edited src/main/kotlin/platform/mixin/inspection/mixinextras/WrongOperationParametersInspection.kt

Ignore whitespaces Open in IDE

⁠ llamalad7: New: Support `WrongOperationParametersInspection` in `@WrapMethod`s. (#2303 )

Copy Copy

/*
* Minecraft Development for IntelliJ
*
* https://mcdev.io/
*
* Copyright (C) 2024 minecraft-dev
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, version 3.0 only.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

package com.demonwav.mcdev.platform.mixin.inspection.mixinextras

import com.demonwav.mcdev.platform.mixin.inspection.MixinInspection
import com.demonwav.mcdev.platform.mixin.util.MixinConstants
import com.demonwav.mcdev.platform.mixin.util.isAssignable
import com.demonwav.mcdev.util.McdevDfaUtil
import com.intellij.codeInsight.intention.FileModifier.SafeFieldForPreview
import com.intellij.codeInspection.LocalQuickFixOnPsiElement
import com.intellij.codeInspection.ProblemsHolder
import com.intellij.openapi.project.Project
import com.intellij.psi.JavaElementVisitor
import com.intellij.psi.JavaPsiFacade
import com.intellij.psi.PsiCallExpression
import com.intellij.psi.PsiClass
import com.intellij.psi.PsiClassType
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiExpressionList
import com.intellij.psi.PsiField
import com.intellij.psi.PsiFile
import com.intellij.psi.PsiMethod
import com.intellij.psi.PsiMethodCallExpression
import com.intellij.psi.util.PsiTreeUtil

class WrongOperationParametersInspection : MixinInspection() {
override fun getStaticDescription() = "Operation.call called with the wrong parameter types"

override fun buildVisitor(holder: ProblemsHolder) = object : JavaElementVisitor() {
override fun visitMethodCallExpression(expression: PsiMethodCallExpression) {
if (expression.methodExpression.referenceName != "call") {
return
}
if (expression.resolveMethod()?.containingClass?.qualifiedName != MixinConstants.MixinExtras.OPERATION) {
return
}

val containingMethod = PsiTreeUtil.getParentOfType(
expression,
PsiMethod::class.java,
true,
PsiClass::class.java,
PsiField::class.java
) ?: return

if (!containingMethod.hasAnnotation(MixinConstants.MixinExtras.WRAP_OPERATION)) {
return
}

val (operationIndex, operationParam) = containingMethod.parameterList.parameters.asSequence()
.withIndex()
.firstOrNull { (_, param) ->
(param.type as? PsiClassType)?.resolve()?.qualifiedName == MixinConstants.MixinExtras.OPERATION
} ?: return
val (expectedParamTypes, paramNames) = containingMethod.parameterList.parameters.asSequence()
.take(operationIndex)
.map { (it.type to it.name) }
.unzip()

val qualifier = expression.methodExpression.qualifierExpression ?: return
if (!McdevDfaUtil.isSometimesEqualToParameter(qualifier, operationParam)) {
return
}

if (expression.argumentList.expressionCount == expectedParamTypes.size) {
val allValid = expression.argumentList.expressions.zip(expectedParamTypes).all { (expr, expectedType) ->
val exprType = McdevDfaUtil.getDataflowType(expr) ?: return@all true
isAssignable(expectedType, exprType, false)
}
if (allValid) {
return
}
}

holder.registerProblem(
expression.argumentList,
"Operation.call called with the wrong parameter types",
ReplaceWithMethodParametersFix(expression.argumentList, paramNames)
)
}
}

private class ReplaceWithMethodParametersFix(
element: PsiExpressionList,
@SafeFieldForPreview private val parameterNames: List<String>
) : LocalQuickFixOnPsiElement(element) {
override fun getFamilyName() = "Replace with method parameters"
override fun getText() = "Replace with method parameters"

override fun invoke(project: Project, file: PsiFile, startElement: PsiElement, endElement: PsiElement) {
val argumentList = startElement as? PsiExpressionList ?: return
val elementFactory = JavaPsiFacade.getElementFactory(project)
val newArgumentList = (
elementFactory.createExpressionFromText(
"foo(${parameterNames.joinToString(", ")})",
argumentList
) as PsiCallExpression
).argumentList!!
argumentList.replace(newArgumentList)
}
}
}

/*
* Minecraft Development for IntelliJ
*
* https://mcdev.io/
*
* Copyright (C) 2024 minecraft-dev
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, version 3.0 only.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

package com.demonwav.mcdev.platform.mixin.inspection.mixinextras

import com.demonwav.mcdev.platform.mixin.inspection.MixinInspection
import com.demonwav.mcdev.platform.mixin.util.MixinConstants
import com.demonwav.mcdev.platform.mixin.util.isAssignable
import com.demonwav.mcdev.util.McdevDfaUtil
import com.intellij.codeInsight.intention.FileModifier.SafeFieldForPreview
import com.intellij.codeInspection.LocalQuickFixOnPsiElement
import com.intellij.codeInspection.ProblemsHolder
import com.intellij.openapi.project.Project
import com.intellij.psi.JavaElementVisitor
import com.intellij.psi.JavaPsiFacade
import com.intellij.psi.PsiCallExpression
import com.intellij.psi.PsiClass
import com.intellij.psi.PsiClassType
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiExpressionList
import com.intellij.psi.PsiField
import com.intellij.psi.PsiFile
import com.intellij.psi.PsiMethod
import com.intellij.psi.PsiMethodCallExpression
import com.intellij.psi.util.PsiTreeUtil

class WrongOperationParametersInspection : MixinInspection() {
override fun getStaticDescription() = "Operation.call called with the wrong parameter types"

override fun buildVisitor(holder: ProblemsHolder) = object : JavaElementVisitor() {
override fun visitMethodCallExpression(expression: PsiMethodCallExpression) {
if (expression.methodExpression.referenceName != "call") {
return
}
if (expression.resolveMethod()?.containingClass?.qualifiedName != MixinConstants.MixinExtras.OPERATION) {
return
}

val containingMethod = PsiTreeUtil.getParentOfType(
expression,
PsiMethod::class.java,
true,
PsiClass::class.java,
PsiField::class.java
) ?: return

if (!containingMethod.hasAnnotation(MixinConstants.MixinExtras.WRAP_OPERATION) &&
!containingMethod.hasAnnotation(MixinConstants.MixinExtras.WRAP_METHOD)
) {
return
}

val (operationIndex, operationParam) = containingMethod.parameterList.parameters.asSequence()
.withIndex()
.firstOrNull { (_, param) ->
(param.type as? PsiClassType)?.resolve()?.qualifiedName == MixinConstants.MixinExtras.OPERATION
} ?: return
val (expectedParamTypes, paramNames) = containingMethod.parameterList.parameters.asSequence()
.take(operationIndex)
.map { (it.type to it.name) }
.unzip()

val qualifier = expression.methodExpression.qualifierExpression ?: return
if (!McdevDfaUtil.isSometimesEqualToParameter(qualifier, operationParam)) {
return
}

if (expression.argumentList.expressionCount == expectedParamTypes.size) {
val allValid = expression.argumentList.expressions.zip(expectedParamTypes).all { (expr, expectedType) ->
val exprType = McdevDfaUtil.getDataflowType(expr) ?: return@all true
isAssignable(expectedType, exprType, false)
}
if (allValid) {
return
}
}

holder.registerProblem(
expression.argumentList,
"Operation.call called with the wrong parameter types",
ReplaceWithMethodParametersFix(expression.argumentList, paramNames)
)
}
}

private class ReplaceWithMethodParametersFix(
element: PsiExpressionList,
@SafeFieldForPreview private val parameterNames: List<String>
) : LocalQuickFixOnPsiElement(element) {
override fun getFamilyName() = "Replace with method parameters"
override fun getText() = "Replace with method parameters"

override fun invoke(project: Project, file: PsiFile, startElement: PsiElement, endElement: PsiElement) {
val argumentList = startElement as? PsiExpressionList ?: return
val elementFactory = JavaPsiFacade.getElementFactory(project)
val newArgumentList = (
elementFactory.createExpressionFromText(
"foo(${parameterNames.joinToString(", ")})",
argumentList
) as PsiCallExpression
).argumentList!!
argumentList.replace(newArgumentList)
}
}
}

/* * Minecraft Development for IntelliJ * * https://mcdev.io/ * * Copyright (C) 2024 minecraft-dev * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published * by the Free Software Foundation, version 3.0 only. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>. */ package com.demonwav.mcdev.platform.mixin.inspection.mixinextras import com.demonwav.mcdev.platform.mixin.inspection.MixinInspection import com.demonwav.mcdev.platform.mixin.util.MixinConstants import com.demonwav.mcdev.platform.mixin.util.isAssignable import com.demonwav.mcdev.util.McdevDfaUtil import com.intellij.codeInsight.intention.FileModifier.SafeFieldForPreview import com.intellij.codeInspection.LocalQuickFixOnPsiElement import com.intellij.codeInspection.ProblemsHolder import com.intellij.openapi.project.Project import com.intellij.psi.JavaElementVisitor import com.intellij.psi.JavaPsiFacade import com.intellij.psi.PsiCallExpression import com.intellij.psi.PsiClass import com.intellij.psi.PsiClassType import com.intellij.psi.PsiElement import com.intellij.psi.PsiExpressionList import com.intellij.psi.PsiField import com.intellij.psi.PsiFile import com.intellij.psi.PsiMethod import com.intellij.psi.PsiMethodCallExpression import com.intellij.psi.util.PsiTreeUtil class WrongOperationParametersInspection : MixinInspection() { override fun getStaticDescription() = "Operation.call called with the wrong parameter types" override fun buildVisitor(holder: ProblemsHolder) = object : JavaElementVisitor() { override fun visitMethodCallExpression(expression: PsiMethodCallExpression) { if (expression.methodExpression.referenceName != "call") { return } if (expression.resolveMethod()?.containingClass?.qualifiedName != MixinConstants.MixinExtras.OPERATION) { return } val containingMethod = PsiTreeUtil.getParentOfType( expression, PsiMethod::class.java, true, PsiClass::class.java, PsiField::class.java ) ?: return if (!containingMethod.hasAnnotation(MixinConstants.MixinExtras.WRAP_OPERATION)) { return } val (operationIndex, operationParam) = containingMethod.parameterList.parameters.asSequence() .withIndex() .firstOrNull { (_, param) -> (param.type as? PsiClassType)?.resolve()?.qualifiedName == MixinConstants.MixinExtras.OPERATION } ?: return val (expectedParamTypes, paramNames) = containingMethod.parameterList.parameters.asSequence() .take(operationIndex) .map { (it.type to it.name) } .unzip() val qualifier = expression.methodExpression.qualifierExpression ?: return if (!McdevDfaUtil.isSometimesEqualToParameter(qualifier, operationParam)) { return } if (expression.argumentList.expressionCount == expectedParamTypes.size) { val allValid = expression.argumentList.expressions.zip(expectedParamTypes).all { (expr, expectedType) -> val exprType = McdevDfaUtil.getDataflowType(expr) ?: return@all true isAssignable(expectedType, exprType, false) } if (allValid) { return } } holder.registerProblem( expression.argumentList, "Operation.call called with the wrong parameter types", ReplaceWithMethodParametersFix(expression.argumentList, paramNames) ) } } private class ReplaceWithMethodParametersFix( element: PsiExpressionList, @SafeFieldForPreview private val parameterNames: List<String> ) : LocalQuickFixOnPsiElement(element) { override fun getFamilyName() = "Replace with method parameters" override fun getText() = "Replace with method parameters" override fun invoke(project: Project, file: PsiFile, startElement: PsiElement, endElement: PsiElement) { val argumentList = startElement as? PsiExpressionList ?: return val elementFactory = JavaPsiFacade.getElementFactory(project) val newArgumentList = ( elementFactory.createExpressionFromText( "foo(${parameterNames.joinToString(", ")})", argumentList ) as PsiCallExpression ).argumentList!! argumentList.replace(newArgumentList) } } } /* * Minecraft Development for IntelliJ * * https://mcdev.io/ * * Copyright (C) 2024 minecraft-dev * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published * by the Free Software Foundation, version 3.0 only. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>. */ package com.demonwav.mcdev.platform.mixin.inspection.mixinextras import com.demonwav.mcdev.platform.mixin.inspection.MixinInspection import com.demonwav.mcdev.platform.mixin.util.MixinConstants import com.demonwav.mcdev.platform.mixin.util.isAssignable import com.demonwav.mcdev.util.McdevDfaUtil import com.intellij.codeInsight.intention.FileModifier.SafeFieldForPreview import com.intellij.codeInspection.LocalQuickFixOnPsiElement import com.intellij.codeInspection.ProblemsHolder import com.intellij.openapi.project.Project import com.intellij.psi.JavaElementVisitor import com.intellij.psi.JavaPsiFacade import com.intellij.psi.PsiCallExpression import com.intellij.psi.PsiClass import com.intellij.psi.PsiClassType import com.intellij.psi.PsiElement import com.intellij.psi.PsiExpressionList import com.intellij.psi.PsiField import com.intellij.psi.PsiFile import com.intellij.psi.PsiMethod import com.intellij.psi.PsiMethodCallExpression import com.intellij.psi.util.PsiTreeUtil class WrongOperationParametersInspection : MixinInspection() { override fun getStaticDescription() = "Operation.call called with the wrong parameter types" override fun buildVisitor(holder: ProblemsHolder) = object : JavaElementVisitor() { override fun visitMethodCallExpression(expression: PsiMethodCallExpression) { if (expression.methodExpression.referenceName != "call") { return } if (expression.resolveMethod()?.containingClass?.qualifiedName != MixinConstants.MixinExtras.OPERATION) { return } val containingMethod = PsiTreeUtil.getParentOfType( expression, PsiMethod::class.java, true, PsiClass::class.java, PsiField::class.java ) ?: return if (!containingMethod.hasAnnotation(MixinConstants.MixinExtras.WRAP_OPERATION) && !containingMethod.hasAnnotation(MixinConstants.MixinExtras.WRAP_METHOD) ) { return } val (operationIndex, operationParam) = containingMethod.parameterList.parameters.asSequence() .withIndex() .firstOrNull { (_, param) -> (param.type as? PsiClassType)?.resolve()?.qualifiedName == MixinConstants.MixinExtras.OPERATION } ?: return val (expectedParamTypes, paramNames) = containingMethod.parameterList.parameters.asSequence() .take(operationIndex) .map { (it.type to it.name) } .unzip() val qualifier = expression.methodExpression.qualifierExpression ?: return if (!McdevDfaUtil.isSometimesEqualToParameter(qualifier, operationParam)) { return } if (expression.argumentList.expressionCount == expectedParamTypes.size) { val allValid = expression.argumentList.expressions.zip(expectedParamTypes).all { (expr, expectedType) -> val exprType = McdevDfaUtil.getDataflowType(expr) ?: return@all true isAssignable(expectedType, exprType, false) } if (allValid) { return } } holder.registerProblem( expression.argumentList, "Operation.call called with the wrong parameter types", ReplaceWithMethodParametersFix(expression.argumentList, paramNames) ) } } private class ReplaceWithMethodParametersFix( element: PsiExpressionList, @SafeFieldForPreview private val parameterNames: List<String> ) : LocalQuickFixOnPsiElement(element) { override fun getFamilyName() = "Replace with method parameters" override fun getText() = "Replace with method parameters" override fun invoke(project: Project, file: PsiFile, startElement: PsiElement, endElement: PsiElement) { val argumentList = startElement as? PsiExpressionList ?: return val elementFactory = JavaPsiFacade.getElementFactory(project) val newArgumentList = ( elementFactory.createExpressionFromText( "foo(${parameterNames.joinToString(", ")})", argumentList ) as PsiCallExpression ).argumentList!! argumentList.replace(newArgumentList) } } }

Add build comment

Mute test

Server communication failure

Run Custom Build

TODO

Responsibility

Edit tags

Loading...

Are you sure?