src/main/kotlin/platform/mixin/inspection/injector/ModifyVariableArgsOnlyInspection.kt diff

← → edited src/main/kotlin/platform/mixin/inspection/injector/ModifyVariableArgsOnlyInspection.kt

Ignore whitespaces Open in IDE

⁠ llamalad7: Feature/method signature intersection (#2647 )

* Refactor: Rework expected MethodSignatures.

- ParameterGroups are gone, with every signature now effectively containing a required leading group and an optional vararg trailing group. The prior flexibility made working them easy to get wrong, for example in the matching logic which would have been incorrect for leading vararg groups.
- Inject previously contained 2 optional groups (the target's params and the captured locals) but this was in fact incorrect, since the captured params are required if we want to capture any locals, so it is now (better) represented as 2 separate signature options.
- The distinction between `WARN_IF_ABSENT` and `ERROR_IF_ABSENT` is entirely removed. It was effectively unused since it only applied to captured Inject locals, which are varargs and therefore never "absent" (a separate inspection handles unused LocalCapture).
- ModifyArgs is in fact all-or-nothing wrt capturing the target parameters, and this is now reflected.

* Fix: Disallow non-int int-like types in @ModifyConstant.

Not sure why these are there, Mixin doesn't allow them.

* Fix: Disallow `nullValue` in `@ModifyConstant`.

It does not work and cannot ever work.

* stash

* stash

* finish general intersection

* cleanup

* stash

* stash

* fix general intersection

* stash

* fix tests

* return type only suggestions

* prioritise existing return type in modifier suggestions

* restore BeforeConstant's behaviour of ensuring only 1 discriminator is specified, and supporting wildcard matches

* Fix: Support `.class` constants in `@ModifyConstant`.

* Switch `@ModifyConstant` to a general signature type.

* int coercion kinda fixed ish

* fix int coercion properly

* cleanup

* proper int-like logic

* cleanup

* some docs and fixes

* fix return type solving

* Cache walked supertypes and improve handling of Object as a supertype.

* Cleanup

* Cleanup

* Small fixes

* Small fixes

* Fix: Suggest "ci" for coerced callba...

Copy Copy

/*
* Minecraft Development for IntelliJ
*
* https://mcdev.io/
*
* Copyright (C) 2026 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.injector

import com.demonwav.mcdev.platform.mixin.handlers.InjectorAnnotationHandler
import com.demonwav.mcdev.platform.mixin.handlers.MixinAnnotationHandler
import com.demonwav.mcdev.platform.mixin.handlers.injectionPoint.CollectVisitor
import com.demonwav.mcdev.platform.mixin.inspection.MixinInspection
import com.demonwav.mcdev.platform.mixin.inspection.fix.AnnotationAttributeFix
import com.demonwav.mcdev.platform.mixin.util.LocalInfo
import com.demonwav.mcdev.platform.mixin.util.MethodTargetMember
import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Annotations.MODIFY_VARIABLE
import com.demonwav.mcdev.platform.mixin.util.hasAccess
import com.demonwav.mcdev.util.findAnnotation
import com.demonwav.mcdev.util.findModule
import com.intellij.codeInspection.ProblemsHolder
import com.intellij.psi.JavaElementVisitor
import com.intellij.psi.PsiAnnotation
import com.intellij.psi.PsiElementVisitor
import com.intellij.psi.PsiMethod
import org.objectweb.asm.Opcodes
import org.objectweb.asm.Type

class ModifyVariableArgsOnlyInspection : MixinInspection() {
override fun getStaticDescription() =
"Checks that @ModifyVariable has argsOnly if it targets arguments, which improves performance of the mixin"

override fun buildVisitor(holder: ProblemsHolder): PsiElementVisitor {
return object : JavaElementVisitor() {
override fun visitMethod(method: PsiMethod) {
val modifyVariable = method.findAnnotation(MODIFY_VARIABLE) ?: return
val localType = method.parameterList.getParameter(0)?.type ?: return
val problemElement = modifyVariable.nameReferenceElement ?: return

val injector =
MixinAnnotationHandler.forMixinAnnotation(MODIFY_VARIABLE) as? InjectorAnnotationHandler ?: return
val localInfo = LocalInfo.fromAnnotation(localType, modifyVariable)

if (Util.shouldReport(localInfo, injector, modifyVariable)) {
val description = "@ModifyVariable may be argsOnly = true"
holder.registerProblem(
problemElement,
description,
AnnotationAttributeFix(modifyVariable, "argsOnly" to true),
)
}
}
}
}

object Util {
fun shouldReport(
localInfo: LocalInfo,
injector: InjectorAnnotationHandler,
injectorAnnotation: PsiAnnotation,
): Boolean {
if (localInfo.argsOnly) {
return false
}

val localInfo = LocalInfo(
localInfo.type,
argsOnly = true,
localInfo.index,
localInfo.ordinal,
localInfo.names,
)

val module = injectorAnnotation.findModule() ?: return false

for (targetMember in MixinAnnotationHandler.resolveTarget(injectorAnnotation)) {
val (targetClass, targetMethod) = (targetMember as? MethodTargetMember)?.classAndMethod ?: continue
val resolvedInsns = injector.resolveInstructions(injectorAnnotation, targetClass, targetMethod)

if (resolvedInsns.isEmpty()) {
// unresolved injection point, don't report that we can be argsOnly
return false
}

var argumentsSize = Type.getArgumentsAndReturnSizes(targetMethod.desc) shr 2
if (targetMethod.hasAccess(Opcodes.ACC_STATIC)) {
argumentsSize--
}

for (insn in resolvedInsns) {
val matchedLocals = localInfo.matchLocals(
module,
targetClass,
targetMethod,
insn.insn,
CollectVisitor.Mode.RESOLUTION
)
if (matchedLocals.isNullOrEmpty() || matchedLocals.any { it.index >= argumentsSize }) {
return false
}
}
}

return true
}
}
}

/*
* Minecraft Development for IntelliJ
*
* https://mcdev.io/
*
* Copyright (C) 2026 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.injector

import com.demonwav.mcdev.platform.mixin.handlers.InsnInjectorAnnotationHandler
import com.demonwav.mcdev.platform.mixin.handlers.MixinAnnotationHandler
import com.demonwav.mcdev.platform.mixin.handlers.injectionPoint.CollectVisitor
import com.demonwav.mcdev.platform.mixin.inspection.MixinInspection
import com.demonwav.mcdev.platform.mixin.inspection.fix.AnnotationAttributeFix
import com.demonwav.mcdev.platform.mixin.util.LocalInfo
import com.demonwav.mcdev.platform.mixin.util.MethodTargetMember
import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Annotations.MODIFY_VARIABLE
import com.demonwav.mcdev.platform.mixin.util.hasAccess
import com.demonwav.mcdev.util.findAnnotation
import com.demonwav.mcdev.util.findModule
import com.intellij.codeInspection.ProblemsHolder
import com.intellij.psi.JavaElementVisitor
import com.intellij.psi.PsiAnnotation
import com.intellij.psi.PsiElementVisitor
import com.intellij.psi.PsiMethod
import org.objectweb.asm.Opcodes
import org.objectweb.asm.Type

class ModifyVariableArgsOnlyInspection : MixinInspection() {
override fun getStaticDescription() =
"Checks that @ModifyVariable has argsOnly if it targets arguments, which improves performance of the mixin"

override fun buildVisitor(holder: ProblemsHolder): PsiElementVisitor {
return object : JavaElementVisitor() {
override fun visitMethod(method: PsiMethod) {
val modifyVariable = method.findAnnotation(MODIFY_VARIABLE) ?: return
val localType = method.parameterList.getParameter(0)?.type ?: return
val problemElement = modifyVariable.nameReferenceElement ?: return

val injector =
MixinAnnotationHandler.forMixinAnnotation(MODIFY_VARIABLE) as? InsnInjectorAnnotationHandler ?: return
val localInfo = LocalInfo.fromAnnotation(localType, modifyVariable)

if (Util.shouldReport(localInfo, injector, modifyVariable)) {
val description = "@ModifyVariable may be argsOnly = true"
holder.registerProblem(
problemElement,
description,
AnnotationAttributeFix(modifyVariable, "argsOnly" to true),
)
}
}
}
}

object Util {
fun shouldReport(
localInfo: LocalInfo,
injector: InsnInjectorAnnotationHandler,
injectorAnnotation: PsiAnnotation,
): Boolean {
if (localInfo.argsOnly) {
return false
}

val localInfo = LocalInfo(
localInfo.type,
argsOnly = true,
localInfo.index,
localInfo.ordinal,
localInfo.names,
)

val module = injectorAnnotation.findModule() ?: return false

for (targetMember in MixinAnnotationHandler.resolveTarget(injectorAnnotation)) {
val (targetClass, targetMethod) = (targetMember as? MethodTargetMember)?.classAndMethod ?: continue
val resolvedInsns = injector.resolveInstructions(injectorAnnotation, targetClass, targetMethod)

if (resolvedInsns.isEmpty()) {
// unresolved injection point, don't report that we can be argsOnly
return false
}

var argumentsSize = Type.getArgumentsAndReturnSizes(targetMethod.desc) shr 2
if (targetMethod.hasAccess(Opcodes.ACC_STATIC)) {
argumentsSize--
}

for (insn in resolvedInsns) {
val matchedLocals = localInfo.matchLocals(
module,
targetClass,
targetMethod,
insn.insn,
CollectVisitor.Mode.RESOLUTION
)
if (matchedLocals.isNullOrEmpty() || matchedLocals.any { it.index >= argumentsSize }) {
return false
}
}
}

return true
}
}
}

/* * Minecraft Development for IntelliJ * * https://mcdev.io/ * * Copyright (C) 2026 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.injector import com.demonwav.mcdev.platform.mixin.handlers.InjectorAnnotationHandler import com.demonwav.mcdev.platform.mixin.handlers.MixinAnnotationHandler import com.demonwav.mcdev.platform.mixin.handlers.injectionPoint.CollectVisitor import com.demonwav.mcdev.platform.mixin.inspection.MixinInspection import com.demonwav.mcdev.platform.mixin.inspection.fix.AnnotationAttributeFix import com.demonwav.mcdev.platform.mixin.util.LocalInfo import com.demonwav.mcdev.platform.mixin.util.MethodTargetMember import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Annotations.MODIFY_VARIABLE import com.demonwav.mcdev.platform.mixin.util.hasAccess import com.demonwav.mcdev.util.findAnnotation import com.demonwav.mcdev.util.findModule import com.intellij.codeInspection.ProblemsHolder import com.intellij.psi.JavaElementVisitor import com.intellij.psi.PsiAnnotation import com.intellij.psi.PsiElementVisitor import com.intellij.psi.PsiMethod import org.objectweb.asm.Opcodes import org.objectweb.asm.Type class ModifyVariableArgsOnlyInspection : MixinInspection() { override fun getStaticDescription() = "Checks that @ModifyVariable has argsOnly if it targets arguments, which improves performance of the mixin" override fun buildVisitor(holder: ProblemsHolder): PsiElementVisitor { return object : JavaElementVisitor() { override fun visitMethod(method: PsiMethod) { val modifyVariable = method.findAnnotation(MODIFY_VARIABLE) ?: return val localType = method.parameterList.getParameter(0)?.type ?: return val problemElement = modifyVariable.nameReferenceElement ?: return val injector = MixinAnnotationHandler.forMixinAnnotation(MODIFY_VARIABLE) as? InjectorAnnotationHandler ?: return val localInfo = LocalInfo.fromAnnotation(localType, modifyVariable) if (Util.shouldReport(localInfo, injector, modifyVariable)) { val description = "@ModifyVariable may be argsOnly = true" holder.registerProblem( problemElement, description, AnnotationAttributeFix(modifyVariable, "argsOnly" to true), ) } } } } object Util { fun shouldReport( localInfo: LocalInfo, injector: InjectorAnnotationHandler, injectorAnnotation: PsiAnnotation, ): Boolean { if (localInfo.argsOnly) { return false } val localInfo = LocalInfo( localInfo.type, argsOnly = true, localInfo.index, localInfo.ordinal, localInfo.names, ) val module = injectorAnnotation.findModule() ?: return false for (targetMember in MixinAnnotationHandler.resolveTarget(injectorAnnotation)) { val (targetClass, targetMethod) = (targetMember as? MethodTargetMember)?.classAndMethod ?: continue val resolvedInsns = injector.resolveInstructions(injectorAnnotation, targetClass, targetMethod) if (resolvedInsns.isEmpty()) { // unresolved injection point, don't report that we can be argsOnly return false } var argumentsSize = Type.getArgumentsAndReturnSizes(targetMethod.desc) shr 2 if (targetMethod.hasAccess(Opcodes.ACC_STATIC)) { argumentsSize-- } for (insn in resolvedInsns) { val matchedLocals = localInfo.matchLocals( module, targetClass, targetMethod, insn.insn, CollectVisitor.Mode.RESOLUTION ) if (matchedLocals.isNullOrEmpty() || matchedLocals.any { it.index >= argumentsSize }) { return false } } } return true } } } /* * Minecraft Development for IntelliJ * * https://mcdev.io/ * * Copyright (C) 2026 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.injector import com.demonwav.mcdev.platform.mixin.handlers.InsnInjectorAnnotationHandler import com.demonwav.mcdev.platform.mixin.handlers.MixinAnnotationHandler import com.demonwav.mcdev.platform.mixin.handlers.injectionPoint.CollectVisitor import com.demonwav.mcdev.platform.mixin.inspection.MixinInspection import com.demonwav.mcdev.platform.mixin.inspection.fix.AnnotationAttributeFix import com.demonwav.mcdev.platform.mixin.util.LocalInfo import com.demonwav.mcdev.platform.mixin.util.MethodTargetMember import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Annotations.MODIFY_VARIABLE import com.demonwav.mcdev.platform.mixin.util.hasAccess import com.demonwav.mcdev.util.findAnnotation import com.demonwav.mcdev.util.findModule import com.intellij.codeInspection.ProblemsHolder import com.intellij.psi.JavaElementVisitor import com.intellij.psi.PsiAnnotation import com.intellij.psi.PsiElementVisitor import com.intellij.psi.PsiMethod import org.objectweb.asm.Opcodes import org.objectweb.asm.Type class ModifyVariableArgsOnlyInspection : MixinInspection() { override fun getStaticDescription() = "Checks that @ModifyVariable has argsOnly if it targets arguments, which improves performance of the mixin" override fun buildVisitor(holder: ProblemsHolder): PsiElementVisitor { return object : JavaElementVisitor() { override fun visitMethod(method: PsiMethod) { val modifyVariable = method.findAnnotation(MODIFY_VARIABLE) ?: return val localType = method.parameterList.getParameter(0)?.type ?: return val problemElement = modifyVariable.nameReferenceElement ?: return val injector = MixinAnnotationHandler.forMixinAnnotation(MODIFY_VARIABLE) as? InsnInjectorAnnotationHandler ?: return val localInfo = LocalInfo.fromAnnotation(localType, modifyVariable) if (Util.shouldReport(localInfo, injector, modifyVariable)) { val description = "@ModifyVariable may be argsOnly = true" holder.registerProblem( problemElement, description, AnnotationAttributeFix(modifyVariable, "argsOnly" to true), ) } } } } object Util { fun shouldReport( localInfo: LocalInfo, injector: InsnInjectorAnnotationHandler, injectorAnnotation: PsiAnnotation, ): Boolean { if (localInfo.argsOnly) { return false } val localInfo = LocalInfo( localInfo.type, argsOnly = true, localInfo.index, localInfo.ordinal, localInfo.names, ) val module = injectorAnnotation.findModule() ?: return false for (targetMember in MixinAnnotationHandler.resolveTarget(injectorAnnotation)) { val (targetClass, targetMethod) = (targetMember as? MethodTargetMember)?.classAndMethod ?: continue val resolvedInsns = injector.resolveInstructions(injectorAnnotation, targetClass, targetMethod) if (resolvedInsns.isEmpty()) { // unresolved injection point, don't report that we can be argsOnly return false } var argumentsSize = Type.getArgumentsAndReturnSizes(targetMethod.desc) shr 2 if (targetMethod.hasAccess(Opcodes.ACC_STATIC)) { argumentsSize-- } for (insn in resolvedInsns) { val matchedLocals = localInfo.matchLocals( module, targetClass, targetMethod, insn.insn, CollectVisitor.Mode.RESOLUTION ) if (matchedLocals.isNullOrEmpty() || matchedLocals.any { it.index >= argumentsSize }) { return false } } } return true } } }

Add build comment

Mute test

Server communication failure

Run custom build

TODO

Responsibility

Edit tags

Loading...

Are you sure?