src/main/kotlin/platform/mixin/handlers/mixinextras/WrapOperationHandler.kt diff

← → edited src/main/kotlin/platform/mixin/handlers/mixinextras/WrapOperationHandler.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) 2025 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.handlers.mixinextras

import com.demonwav.mcdev.platform.mixin.inspection.injector.MethodSignature
import com.demonwav.mcdev.platform.mixin.inspection.injector.ParameterGroup
import com.demonwav.mcdev.platform.mixin.util.mixinExtrasOperationType
import com.demonwav.mcdev.platform.mixin.util.toPsiType
import com.demonwav.mcdev.util.Parameter
import com.intellij.psi.JavaPsiFacade
import com.intellij.psi.PsiAnnotation
import com.intellij.psi.PsiType
import com.llamalad7.mixinextras.expression.impl.point.ExpressionContext
import com.llamalad7.mixinextras.expression.impl.utils.ExpressionASMUtils
import com.llamalad7.mixinextras.expression.impl.utils.ExpressionDecorations
import org.objectweb.asm.Type
import org.objectweb.asm.tree.ClassNode
import org.objectweb.asm.tree.MethodNode

class WrapOperationHandler : MixinExtrasInjectorAnnotationHandler() {
override val supportedInstructionTypes = listOf(
InstructionType.METHOD_CALL, InstructionType.FIELD_GET, InstructionType.FIELD_SET, InstructionType.INSTANCEOF,
InstructionType.INSTANTIATION, InstructionType.SIMPLE_OPERATION
)

override val allowedInsnDescription = "wrap operation targets (see docs)"

override fun getAtKey(annotation: PsiAnnotation): String {
return if (annotation.hasAttribute("constant")) "constant" else "at"
}

override fun expectedMethodSignature(
annotation: PsiAnnotation,
targetClass: ClassNode,
targetMethod: MethodNode,
target: TargetInsn
): Pair<ParameterGroup, PsiType>? {
val params = getParameterTypes(target, targetClass, annotation) ?: return null
val returnType = getReturnType(target, annotation) ?: return null
val operationType = mixinExtrasOperationType(annotation, returnType) ?: return null
return ParameterGroup(
params + Parameter("original", operationType)
) to returnType
}

override fun intLikeTypePositions(target: TargetInsn) = buildList {
if (
target.getDecoration<Type>(ExpressionDecorations.SIMPLE_OPERATION_RETURN_TYPE)
== ExpressionASMUtils.INTLIKE_TYPE
) {
add(MethodSignature.TypePosition.Return)
}
target.getDecoration<Array<Type>>(ExpressionDecorations.SIMPLE_OPERATION_ARGS)?.forEachIndexed { i, it ->
if (it == ExpressionASMUtils.INTLIKE_TYPE) {
add(MethodSignature.TypePosition.Param(i))
}
}
}

private fun getParameterTypes(
target: TargetInsn,
targetClass: ClassNode,
annotation: PsiAnnotation
): List<Parameter>? {
getPsiParameters(target.insn, targetClass, annotation)?.let { return it }
val args = target.getDecoration<Array<Type>>(ExpressionDecorations.SIMPLE_OPERATION_ARGS) ?: return null
return args.toList().toParameters(
annotation,
target.getDecoration(ExpressionDecorations.SIMPLE_OPERATION_PARAM_NAMES)
)
}

private fun getReturnType(
target: TargetInsn,
annotation: PsiAnnotation
): PsiType? {
getPsiReturnType(target.insn, annotation)?.let { return it }
val type = target.getDecoration<Type>(ExpressionDecorations.SIMPLE_OPERATION_RETURN_TYPE) ?: return null
return type.toPsiType(JavaPsiFacade.getElementFactory(annotation.project))
}

override val mixinExtrasExpressionContextType = ExpressionContext.Type.WRAP_OPERATION
}

/*
* 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.handlers.mixinextras

import com.demonwav.mcdev.platform.mixin.inspection.injector.MethodSignature
import com.demonwav.mcdev.platform.mixin.inspection.injector.OperationWrapperSignatures
import com.demonwav.mcdev.platform.mixin.inspection.injector.SuggestedSignature
import com.demonwav.mcdev.platform.mixin.inspection.injector.collectSignatures
import com.demonwav.mcdev.platform.mixin.util.ClassAndMethodNode
import com.demonwav.mcdev.platform.mixin.util.toPsiType
import com.demonwav.mcdev.util.Parameter
import com.demonwav.mcdev.util.buildSequencedSet
import com.intellij.psi.JavaPsiFacade
import com.intellij.psi.PsiAnnotation
import com.intellij.psi.PsiType
import com.llamalad7.mixinextras.expression.impl.point.ExpressionContext
import com.llamalad7.mixinextras.expression.impl.utils.ExpressionASMUtils
import com.llamalad7.mixinextras.expression.impl.utils.ExpressionDecorations
import org.objectweb.asm.Type
import org.objectweb.asm.tree.ClassNode
import org.objectweb.asm.tree.MethodNode

class WrapOperationHandler : MixinExtrasInjectorAnnotationHandler() {
override val supportedInstructionTypes = listOf(
InstructionType.METHOD_CALL, InstructionType.FIELD_GET, InstructionType.FIELD_SET, InstructionType.INSTANCEOF,
InstructionType.INSTANTIATION, InstructionType.SIMPLE_OPERATION
)

override val allowedInsnDescription = "wrap operation targets (see docs)"

override fun getAtKey(annotation: PsiAnnotation): String {
return if (annotation.hasAttribute("constant")) "constant" else "at"
}

override fun expectedMethodSignatureImpl(
annotation: PsiAnnotation,
targetClass: ClassNode,
targetMethod: MethodNode,
target: TargetInsn
): OperationWrapperSignatures? {
val params = getParameterTypes(target, targetClass, annotation) ?: return null
val returnType = getReturnType(target, annotation) ?: return null
return OperationWrapperSignatures.create(
annotation,
params,
returnType,
intLikeTypePositions(target),
trailingParams = collectTargetMethodParameters(annotation.project, targetClass, targetMethod),
)
}

override fun suggestedMethodSignature(
annotation: PsiAnnotation,
targets: List<ClassAndMethodNode>
): SuggestedSignature? {
return SuggestedSignature.operationWrapper(
annotation,
expectedMethodSignatures(annotation, targets).collectSignatures<OperationWrapperSignatures>() ?: return null
)
}

private fun intLikeTypePositions(target: TargetInsn) = buildSequencedSet {
target.getDecoration<Array<Type>>(ExpressionDecorations.SIMPLE_OPERATION_ARGS)?.forEachIndexed { i, it ->
if (it == ExpressionASMUtils.INTLIKE_TYPE) {
add(MethodSignature.TypePosition.Param(i))
}
}
if (
target.getDecoration<Type>(ExpressionDecorations.SIMPLE_OPERATION_RETURN_TYPE)
== ExpressionASMUtils.INTLIKE_TYPE
) {
add(MethodSignature.TypePosition.Return)
}
}

private fun getParameterTypes(
target: TargetInsn,
targetClass: ClassNode,
annotation: PsiAnnotation
): List<Parameter>? {
getPsiParameters(target.insn, targetClass, annotation)?.let { return it }
val args = target.getDecoration<Array<Type>>(ExpressionDecorations.SIMPLE_OPERATION_ARGS) ?: return null
return args.toList().toParameters(
annotation,
target.getDecoration(ExpressionDecorations.SIMPLE_OPERATION_PARAM_NAMES)
)
}

private fun getReturnType(
target: TargetInsn,
annotation: PsiAnnotation
): PsiType? {
getPsiReturnType(target.insn, annotation)?.let { return it }
val type = target.getDecoration<Type>(ExpressionDecorations.SIMPLE_OPERATION_RETURN_TYPE) ?: return null
return type.toPsiType(JavaPsiFacade.getElementFactory(annotation.project))
}

override val mixinExtrasExpressionContextType = ExpressionContext.Type.WRAP_OPERATION
}

/* * Minecraft Development for IntelliJ * * https://mcdev.io/ * * Copyright (C) 2025 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.handlers.mixinextras import com.demonwav.mcdev.platform.mixin.inspection.injector.MethodSignature import com.demonwav.mcdev.platform.mixin.inspection.injector.ParameterGroup import com.demonwav.mcdev.platform.mixin.util.mixinExtrasOperationType import com.demonwav.mcdev.platform.mixin.util.toPsiType import com.demonwav.mcdev.util.Parameter import com.intellij.psi.JavaPsiFacade import com.intellij.psi.PsiAnnotation import com.intellij.psi.PsiType import com.llamalad7.mixinextras.expression.impl.point.ExpressionContext import com.llamalad7.mixinextras.expression.impl.utils.ExpressionASMUtils import com.llamalad7.mixinextras.expression.impl.utils.ExpressionDecorations import org.objectweb.asm.Type import org.objectweb.asm.tree.ClassNode import org.objectweb.asm.tree.MethodNode class WrapOperationHandler : MixinExtrasInjectorAnnotationHandler() { override val supportedInstructionTypes = listOf( InstructionType.METHOD_CALL, InstructionType.FIELD_GET, InstructionType.FIELD_SET, InstructionType.INSTANCEOF, InstructionType.INSTANTIATION, InstructionType.SIMPLE_OPERATION ) override val allowedInsnDescription = "wrap operation targets (see docs)" override fun getAtKey(annotation: PsiAnnotation): String { return if (annotation.hasAttribute("constant")) "constant" else "at" } override fun expectedMethodSignature( annotation: PsiAnnotation, targetClass: ClassNode, targetMethod: MethodNode, target: TargetInsn ): Pair<ParameterGroup, PsiType>? { val params = getParameterTypes(target, targetClass, annotation) ?: return null val returnType = getReturnType(target, annotation) ?: return null val operationType = mixinExtrasOperationType(annotation, returnType) ?: return null return ParameterGroup( params + Parameter("original", operationType) ) to returnType } override fun intLikeTypePositions(target: TargetInsn) = buildList { if ( target.getDecoration<Type>(ExpressionDecorations.SIMPLE_OPERATION_RETURN_TYPE) == ExpressionASMUtils.INTLIKE_TYPE ) { add(MethodSignature.TypePosition.Return) } target.getDecoration<Array<Type>>(ExpressionDecorations.SIMPLE_OPERATION_ARGS)?.forEachIndexed { i, it -> if (it == ExpressionASMUtils.INTLIKE_TYPE) { add(MethodSignature.TypePosition.Param(i)) } } } private fun getParameterTypes( target: TargetInsn, targetClass: ClassNode, annotation: PsiAnnotation ): List<Parameter>? { getPsiParameters(target.insn, targetClass, annotation)?.let { return it } val args = target.getDecoration<Array<Type>>(ExpressionDecorations.SIMPLE_OPERATION_ARGS) ?: return null return args.toList().toParameters( annotation, target.getDecoration(ExpressionDecorations.SIMPLE_OPERATION_PARAM_NAMES) ) } private fun getReturnType( target: TargetInsn, annotation: PsiAnnotation ): PsiType? { getPsiReturnType(target.insn, annotation)?.let { return it } val type = target.getDecoration<Type>(ExpressionDecorations.SIMPLE_OPERATION_RETURN_TYPE) ?: return null return type.toPsiType(JavaPsiFacade.getElementFactory(annotation.project)) } override val mixinExtrasExpressionContextType = ExpressionContext.Type.WRAP_OPERATION } /* * 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.handlers.mixinextras import com.demonwav.mcdev.platform.mixin.inspection.injector.MethodSignature import com.demonwav.mcdev.platform.mixin.inspection.injector.OperationWrapperSignatures import com.demonwav.mcdev.platform.mixin.inspection.injector.SuggestedSignature import com.demonwav.mcdev.platform.mixin.inspection.injector.collectSignatures import com.demonwav.mcdev.platform.mixin.util.ClassAndMethodNode import com.demonwav.mcdev.platform.mixin.util.toPsiType import com.demonwav.mcdev.util.Parameter import com.demonwav.mcdev.util.buildSequencedSet import com.intellij.psi.JavaPsiFacade import com.intellij.psi.PsiAnnotation import com.intellij.psi.PsiType import com.llamalad7.mixinextras.expression.impl.point.ExpressionContext import com.llamalad7.mixinextras.expression.impl.utils.ExpressionASMUtils import com.llamalad7.mixinextras.expression.impl.utils.ExpressionDecorations import org.objectweb.asm.Type import org.objectweb.asm.tree.ClassNode import org.objectweb.asm.tree.MethodNode class WrapOperationHandler : MixinExtrasInjectorAnnotationHandler() { override val supportedInstructionTypes = listOf( InstructionType.METHOD_CALL, InstructionType.FIELD_GET, InstructionType.FIELD_SET, InstructionType.INSTANCEOF, InstructionType.INSTANTIATION, InstructionType.SIMPLE_OPERATION ) override val allowedInsnDescription = "wrap operation targets (see docs)" override fun getAtKey(annotation: PsiAnnotation): String { return if (annotation.hasAttribute("constant")) "constant" else "at" } override fun expectedMethodSignatureImpl( annotation: PsiAnnotation, targetClass: ClassNode, targetMethod: MethodNode, target: TargetInsn ): OperationWrapperSignatures? { val params = getParameterTypes(target, targetClass, annotation) ?: return null val returnType = getReturnType(target, annotation) ?: return null return OperationWrapperSignatures.create( annotation, params, returnType, intLikeTypePositions(target), trailingParams = collectTargetMethodParameters(annotation.project, targetClass, targetMethod), ) } override fun suggestedMethodSignature( annotation: PsiAnnotation, targets: List<ClassAndMethodNode> ): SuggestedSignature? { return SuggestedSignature.operationWrapper( annotation, expectedMethodSignatures(annotation, targets).collectSignatures<OperationWrapperSignatures>() ?: return null ) } private fun intLikeTypePositions(target: TargetInsn) = buildSequencedSet { target.getDecoration<Array<Type>>(ExpressionDecorations.SIMPLE_OPERATION_ARGS)?.forEachIndexed { i, it -> if (it == ExpressionASMUtils.INTLIKE_TYPE) { add(MethodSignature.TypePosition.Param(i)) } } if ( target.getDecoration<Type>(ExpressionDecorations.SIMPLE_OPERATION_RETURN_TYPE) == ExpressionASMUtils.INTLIKE_TYPE ) { add(MethodSignature.TypePosition.Return) } } private fun getParameterTypes( target: TargetInsn, targetClass: ClassNode, annotation: PsiAnnotation ): List<Parameter>? { getPsiParameters(target.insn, targetClass, annotation)?.let { return it } val args = target.getDecoration<Array<Type>>(ExpressionDecorations.SIMPLE_OPERATION_ARGS) ?: return null return args.toList().toParameters( annotation, target.getDecoration(ExpressionDecorations.SIMPLE_OPERATION_PARAM_NAMES) ) } private fun getReturnType( target: TargetInsn, annotation: PsiAnnotation ): PsiType? { getPsiReturnType(target.insn, annotation)?.let { return it } val type = target.getDecoration<Type>(ExpressionDecorations.SIMPLE_OPERATION_RETURN_TYPE) ?: return null return type.toPsiType(JavaPsiFacade.getElementFactory(annotation.project)) } override val mixinExtrasExpressionContextType = ExpressionContext.Type.WRAP_OPERATION }

Add build comment

Mute test

Server communication failure

Run custom build

TODO

Responsibility

Edit tags

Loading...

Are you sure?