src/main/kotlin/platform/mixin/folding/MixinTargetDescriptorFoldingBuilder.kt diff

← → edited src/main/kotlin/platform/mixin/folding/MixinTargetDescriptorFoldingBuilder.kt

Ignore whitespaces Open in IDE

⁠ llamalad7: Feature/mixin quantifiers (#2643 )

* Refactor: Split MemberInfo and MemberReference.

Mixin MemberInfo strings are only tangentially related to concrete MemberReferences. We also introduce a MemberMatcher superinterface for resolving things.

* Refactor: Parse MemberInfos properly and represent Quantifiers.

* Fix: Handle all cases properly in AmbiguousReferenceInspection.

Really nothing is "ambiguous" (except perhaps to the reader), it's just that Mixin's default behaviour of matching the first method in a given class is unexpected, but I'll leave the terminology for now. Adding any explicit quantifier suppresses this inspection, including `{1}` if that's really what's desired.

Additionally, adding a wildcard is almost never the correct fix. Choosing one of the available descriptors is what should be offered instead, but I'll leave that too for now.

* New: Handle maximum values in quantifiers.

* Fix: Fix incorrect filter stats emptiness check.

Causes targets not to show as unresolved when they should.

* New: Handle minimum values in quantifiers.

* Fix: Account for individual Mixin `method` strings contributing multiple methods.

* Fix: Don't report injector signature issues in methods where we find no targets.

* Move insn resolution failure message to field in failure class, and add message for min quantifier not satisfied

---------

Co-authored-by: joe <[email protected]>

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.folding

import com.demonwav.mcdev.platform.mixin.MixinModuleType
import com.demonwav.mcdev.platform.mixin.reference.target.TargetReference
import com.demonwav.mcdev.platform.mixin.util.MixinConstants
import com.intellij.lang.ASTNode
import com.intellij.lang.folding.CustomFoldingBuilder
import com.intellij.lang.folding.FoldingDescriptor
import com.intellij.navigation.NavigationItem
import com.intellij.openapi.editor.Document
import com.intellij.openapi.util.TextRange
import com.intellij.psi.JavaRecursiveElementWalkingVisitor
import com.intellij.psi.PsiAnnotation
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiJavaFile
import com.intellij.psi.PsiMethod
import com.intellij.psi.PsiSubstitutor
import com.intellij.psi.PsiVariable
import com.intellij.psi.util.PsiFormatUtil
import com.intellij.psi.util.PsiFormatUtilBase.SHOW_CONTAINING_CLASS
import com.intellij.psi.util.PsiFormatUtilBase.SHOW_NAME
import com.intellij.psi.util.PsiFormatUtilBase.SHOW_PARAMETERS
import com.intellij.psi.util.PsiFormatUtilBase.SHOW_TYPE

class MixinTargetDescriptorFoldingBuilder : CustomFoldingBuilder() {

override fun isDumbAware(): Boolean = false

override fun isRegionCollapsedByDefault(node: ASTNode): Boolean =
MixinFoldingSettings.instance.state.foldTargetDescriptors

override fun getLanguagePlaceholderText(node: ASTNode, range: TextRange): String? {
val element = node.psi
return TargetReference.resolveTarget(element)?.let { formatElement(it) }
}

private fun formatElement(element: PsiElement): String? {
return when (element) {
is PsiMethod -> {
val options = SHOW_NAME or SHOW_PARAMETERS or SHOW_CONTAINING_CLASS
PsiFormatUtil.formatMethod(element, PsiSubstitutor.EMPTY, options, SHOW_TYPE)
}
is PsiVariable -> {
val options = SHOW_NAME or SHOW_CONTAINING_CLASS
PsiFormatUtil.formatVariable(element, options, PsiSubstitutor.EMPTY)
}
is NavigationItem -> element.presentation?.presentableText
else -> null
}
}

override fun buildLanguageFoldRegions(
descriptors: MutableList<FoldingDescriptor>,
root: PsiElement,
document: Document,
quick: Boolean,
) {
if (root !is PsiJavaFile || !MixinModuleType.isInModule(root)) {
return
}

root.accept(Visitor(descriptors))
}

private class Visitor(private val descriptors: MutableList<FoldingDescriptor>) :
JavaRecursiveElementWalkingVisitor() {

val settings = MixinFoldingSettings.instance.state

override fun visitAnnotation(annotation: PsiAnnotation) {
super.visitAnnotation(annotation)

if (!settings.foldTargetDescriptors) {
return
}

val qualifiedName = annotation.qualifiedName ?: return
if (qualifiedName != MixinConstants.Annotations.AT) {
return
}

val target = annotation.findDeclaredAttributeValue("target") ?: return
descriptors.add(FoldingDescriptor(target, target.textRange))
}
}
}

/*
* 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.folding

import com.demonwav.mcdev.platform.mixin.MixinModuleType
import com.demonwav.mcdev.platform.mixin.reference.target.TargetReference
import com.demonwav.mcdev.platform.mixin.util.MixinConstants
import com.intellij.lang.ASTNode
import com.intellij.lang.folding.CustomFoldingBuilder
import com.intellij.lang.folding.FoldingDescriptor
import com.intellij.navigation.NavigationItem
import com.intellij.openapi.editor.Document
import com.intellij.openapi.util.TextRange
import com.intellij.psi.JavaRecursiveElementWalkingVisitor
import com.intellij.psi.PsiAnnotation
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiJavaFile
import com.intellij.psi.PsiMethod
import com.intellij.psi.PsiSubstitutor
import com.intellij.psi.PsiVariable
import com.intellij.psi.util.PsiFormatUtil
import com.intellij.psi.util.PsiFormatUtilBase.SHOW_CONTAINING_CLASS
import com.intellij.psi.util.PsiFormatUtilBase.SHOW_NAME
import com.intellij.psi.util.PsiFormatUtilBase.SHOW_PARAMETERS
import com.intellij.psi.util.PsiFormatUtilBase.SHOW_TYPE

class MixinTargetDescriptorFoldingBuilder : CustomFoldingBuilder() {

override fun isDumbAware(): Boolean = false

override fun isRegionCollapsedByDefault(node: ASTNode): Boolean =
MixinFoldingSettings.instance.state.foldTargetDescriptors

override fun getLanguagePlaceholderText(node: ASTNode, range: TextRange): String? {
val element = node.psi
return TargetReference.resolveTargets(element).singleOrNull()?.let { formatElement(it) }
}

private fun formatElement(element: PsiElement): String? {
return when (element) {
is PsiMethod -> {
val options = SHOW_NAME or SHOW_PARAMETERS or SHOW_CONTAINING_CLASS
PsiFormatUtil.formatMethod(element, PsiSubstitutor.EMPTY, options, SHOW_TYPE)
}
is PsiVariable -> {
val options = SHOW_NAME or SHOW_CONTAINING_CLASS
PsiFormatUtil.formatVariable(element, options, PsiSubstitutor.EMPTY)
}
is NavigationItem -> element.presentation?.presentableText
else -> null
}
}

override fun buildLanguageFoldRegions(
descriptors: MutableList<FoldingDescriptor>,
root: PsiElement,
document: Document,
quick: Boolean,
) {
if (root !is PsiJavaFile || !MixinModuleType.isInModule(root)) {
return
}

root.accept(Visitor(descriptors))
}

private class Visitor(private val descriptors: MutableList<FoldingDescriptor>) :
JavaRecursiveElementWalkingVisitor() {

val settings = MixinFoldingSettings.instance.state

override fun visitAnnotation(annotation: PsiAnnotation) {
super.visitAnnotation(annotation)

if (!settings.foldTargetDescriptors) {
return
}

val qualifiedName = annotation.qualifiedName ?: return
if (qualifiedName != MixinConstants.Annotations.AT) {
return
}

val target = annotation.findDeclaredAttributeValue("target") ?: return
descriptors.add(FoldingDescriptor(target, target.textRange))
}
}
}

/* * 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.folding import com.demonwav.mcdev.platform.mixin.MixinModuleType import com.demonwav.mcdev.platform.mixin.reference.target.TargetReference import com.demonwav.mcdev.platform.mixin.util.MixinConstants import com.intellij.lang.ASTNode import com.intellij.lang.folding.CustomFoldingBuilder import com.intellij.lang.folding.FoldingDescriptor import com.intellij.navigation.NavigationItem import com.intellij.openapi.editor.Document import com.intellij.openapi.util.TextRange import com.intellij.psi.JavaRecursiveElementWalkingVisitor import com.intellij.psi.PsiAnnotation import com.intellij.psi.PsiElement import com.intellij.psi.PsiJavaFile import com.intellij.psi.PsiMethod import com.intellij.psi.PsiSubstitutor import com.intellij.psi.PsiVariable import com.intellij.psi.util.PsiFormatUtil import com.intellij.psi.util.PsiFormatUtilBase.SHOW_CONTAINING_CLASS import com.intellij.psi.util.PsiFormatUtilBase.SHOW_NAME import com.intellij.psi.util.PsiFormatUtilBase.SHOW_PARAMETERS import com.intellij.psi.util.PsiFormatUtilBase.SHOW_TYPE class MixinTargetDescriptorFoldingBuilder : CustomFoldingBuilder() { override fun isDumbAware(): Boolean = false override fun isRegionCollapsedByDefault(node: ASTNode): Boolean = MixinFoldingSettings.instance.state.foldTargetDescriptors override fun getLanguagePlaceholderText(node: ASTNode, range: TextRange): String? { val element = node.psi return TargetReference.resolveTarget(element)?.let { formatElement(it) } } private fun formatElement(element: PsiElement): String? { return when (element) { is PsiMethod -> { val options = SHOW_NAME or SHOW_PARAMETERS or SHOW_CONTAINING_CLASS PsiFormatUtil.formatMethod(element, PsiSubstitutor.EMPTY, options, SHOW_TYPE) } is PsiVariable -> { val options = SHOW_NAME or SHOW_CONTAINING_CLASS PsiFormatUtil.formatVariable(element, options, PsiSubstitutor.EMPTY) } is NavigationItem -> element.presentation?.presentableText else -> null } } override fun buildLanguageFoldRegions( descriptors: MutableList<FoldingDescriptor>, root: PsiElement, document: Document, quick: Boolean, ) { if (root !is PsiJavaFile || !MixinModuleType.isInModule(root)) { return } root.accept(Visitor(descriptors)) } private class Visitor(private val descriptors: MutableList<FoldingDescriptor>) : JavaRecursiveElementWalkingVisitor() { val settings = MixinFoldingSettings.instance.state override fun visitAnnotation(annotation: PsiAnnotation) { super.visitAnnotation(annotation) if (!settings.foldTargetDescriptors) { return } val qualifiedName = annotation.qualifiedName ?: return if (qualifiedName != MixinConstants.Annotations.AT) { return } val target = annotation.findDeclaredAttributeValue("target") ?: return descriptors.add(FoldingDescriptor(target, target.textRange)) } } } /* * 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.folding import com.demonwav.mcdev.platform.mixin.MixinModuleType import com.demonwav.mcdev.platform.mixin.reference.target.TargetReference import com.demonwav.mcdev.platform.mixin.util.MixinConstants import com.intellij.lang.ASTNode import com.intellij.lang.folding.CustomFoldingBuilder import com.intellij.lang.folding.FoldingDescriptor import com.intellij.navigation.NavigationItem import com.intellij.openapi.editor.Document import com.intellij.openapi.util.TextRange import com.intellij.psi.JavaRecursiveElementWalkingVisitor import com.intellij.psi.PsiAnnotation import com.intellij.psi.PsiElement import com.intellij.psi.PsiJavaFile import com.intellij.psi.PsiMethod import com.intellij.psi.PsiSubstitutor import com.intellij.psi.PsiVariable import com.intellij.psi.util.PsiFormatUtil import com.intellij.psi.util.PsiFormatUtilBase.SHOW_CONTAINING_CLASS import com.intellij.psi.util.PsiFormatUtilBase.SHOW_NAME import com.intellij.psi.util.PsiFormatUtilBase.SHOW_PARAMETERS import com.intellij.psi.util.PsiFormatUtilBase.SHOW_TYPE class MixinTargetDescriptorFoldingBuilder : CustomFoldingBuilder() { override fun isDumbAware(): Boolean = false override fun isRegionCollapsedByDefault(node: ASTNode): Boolean = MixinFoldingSettings.instance.state.foldTargetDescriptors override fun getLanguagePlaceholderText(node: ASTNode, range: TextRange): String? { val element = node.psi return TargetReference.resolveTargets(element).singleOrNull()?.let { formatElement(it) } } private fun formatElement(element: PsiElement): String? { return when (element) { is PsiMethod -> { val options = SHOW_NAME or SHOW_PARAMETERS or SHOW_CONTAINING_CLASS PsiFormatUtil.formatMethod(element, PsiSubstitutor.EMPTY, options, SHOW_TYPE) } is PsiVariable -> { val options = SHOW_NAME or SHOW_CONTAINING_CLASS PsiFormatUtil.formatVariable(element, options, PsiSubstitutor.EMPTY) } is NavigationItem -> element.presentation?.presentableText else -> null } } override fun buildLanguageFoldRegions( descriptors: MutableList<FoldingDescriptor>, root: PsiElement, document: Document, quick: Boolean, ) { if (root !is PsiJavaFile || !MixinModuleType.isInModule(root)) { return } root.accept(Visitor(descriptors)) } private class Visitor(private val descriptors: MutableList<FoldingDescriptor>) : JavaRecursiveElementWalkingVisitor() { val settings = MixinFoldingSettings.instance.state override fun visitAnnotation(annotation: PsiAnnotation) { super.visitAnnotation(annotation) if (!settings.foldTargetDescriptors) { return } val qualifiedName = annotation.qualifiedName ?: return if (qualifiedName != MixinConstants.Annotations.AT) { return } val target = annotation.findDeclaredAttributeValue("target") ?: return descriptors.add(FoldingDescriptor(target, target.textRange)) } } }

Add build comment

Mute test

Server communication failure

Run custom build

TODO

Responsibility

Edit tags

Loading...

Are you sure?