src/main/kotlin/platform/mixin/inspection/MixinCancellableInspection.kt diff

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

Ignore whitespaces Open in IDE

⁠ joe: 2025

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

import com.demonwav.mcdev.platform.mixin.inspection.injector.CancellableBeforeSuperCallInspection
import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Annotations.INJECT
import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Classes.CALLBACK_INFO
import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Classes.CALLBACK_INFO_RETURNABLE
import com.demonwav.mcdev.util.fullQualifiedName
import com.intellij.codeInspection.LocalQuickFix
import com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement
import com.intellij.codeInspection.ProblemHighlightType
import com.intellij.codeInspection.ProblemsHolder
import com.intellij.openapi.editor.Editor
import com.intellij.openapi.project.Project
import com.intellij.psi.JavaElementVisitor
import com.intellij.psi.PsiAnnotation
import com.intellij.psi.PsiClassType
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiElementFactory
import com.intellij.psi.PsiElementVisitor
import com.intellij.psi.PsiExpressionList
import com.intellij.psi.PsiFile
import com.intellij.psi.PsiLiteral
import com.intellij.psi.PsiMethod
import com.intellij.psi.PsiReferenceExpression
import com.intellij.psi.search.searches.ReferencesSearch
import com.intellij.psi.util.PsiUtil

class MixinCancellableInspection : MixinInspection() {

override fun getStaticDescription(): String =
"Reports missing or unused cancellable @Inject usages"

override fun buildVisitor(holder: ProblemsHolder): PsiElementVisitor = Visitor(holder)

private class Visitor(private val holder: ProblemsHolder) : JavaElementVisitor() {
override fun visitMethod(method: PsiMethod) {
val injectAnnotation = method.getAnnotation(INJECT) ?: return

val cancellableAttribute = injectAnnotation.findAttributeValue("cancellable") as? PsiLiteral ?: return
val isCancellable = cancellableAttribute.value == true

val ciParam = method.parameterList.parameters.firstOrNull {
val className = (it.type as? PsiClassType)?.fullQualifiedName ?: return@firstOrNull false
className == CALLBACK_INFO || className == CALLBACK_INFO_RETURNABLE
} ?: return

val ciType = (ciParam.type as? PsiClassType)?.resolve() ?: return
val searchingFor = ciType.findMethodsByName("setReturnValue", false).firstOrNull()
?: ciType.findMethodsByName("cancel", false).firstOrNull()
?: return

var mayUseCancel = false
var definitelyUsesCancel = false
for (ref in ReferencesSearch.search(ciParam)) {
val parent = PsiUtil.skipParenthesizedExprUp(ref.element.parent)
if (parent is PsiExpressionList) {
// method argument, we can't tell whether it uses cancel
mayUseCancel = true
}
val methodCall = parent as? PsiReferenceExpression ?: continue
if (methodCall.references.any { it.isReferenceTo(searchingFor) }) {
definitelyUsesCancel = true
break
}
}

if (definitelyUsesCancel && !isCancellable) {
val fixes = mutableListOf<LocalQuickFix>()
if (!CancellableBeforeSuperCallInspection.doesInjectBeforeSuperConstructorCall(injectAnnotation)) {
fixes += MakeInjectCancellableFix(injectAnnotation)
}

holder.registerProblem(
method.nameIdentifier ?: method,
"@Inject must be marked as cancellable in order to be cancelled",
ProblemHighlightType.GENERIC_ERROR_OR_WARNING,
*fixes.toTypedArray(),
)
} else if (!definitelyUsesCancel && !mayUseCancel && isCancellable) {
holder.registerProblem(
cancellableAttribute.parent,
"@Inject is cancellable but is never cancelled",
ProblemHighlightType.GENERIC_ERROR_OR_WARNING,
RemoveInjectCancellableFix(injectAnnotation),
)
}
}
}

private class MakeInjectCancellableFix(element: PsiAnnotation) :
LocalQuickFixAndIntentionActionOnPsiElement(element) {

override fun getFamilyName(): String = "Mark as cancellable"

override fun getText(): String = familyName

override fun invoke(
project: Project,
file: PsiFile,
editor: Editor?,
startElement: PsiElement,
endElement: PsiElement,
) {
val annotation = startElement as PsiAnnotation
val value = PsiElementFactory.getInstance(project).createExpressionFromText("true", annotation)
annotation.setDeclaredAttributeValue("cancellable", value)
}
}

class RemoveInjectCancellableFix(element: PsiAnnotation) :
LocalQuickFixAndIntentionActionOnPsiElement(element) {

override fun getFamilyName(): String = "Remove cancellable attribute"

override fun getText(): String = familyName

override fun invoke(
project: Project,
file: PsiFile,
editor: Editor?,
startElement: PsiElement,
endElement: PsiElement,
) {
val annotation = startElement as PsiAnnotation
annotation.setDeclaredAttributeValue("cancellable", null)
}
}
}

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

import com.demonwav.mcdev.platform.mixin.inspection.injector.CancellableBeforeSuperCallInspection
import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Annotations.INJECT
import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Classes.CALLBACK_INFO
import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Classes.CALLBACK_INFO_RETURNABLE
import com.demonwav.mcdev.util.fullQualifiedName
import com.intellij.codeInspection.LocalQuickFix
import com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement
import com.intellij.codeInspection.ProblemHighlightType
import com.intellij.codeInspection.ProblemsHolder
import com.intellij.openapi.editor.Editor
import com.intellij.openapi.project.Project
import com.intellij.psi.JavaElementVisitor
import com.intellij.psi.PsiAnnotation
import com.intellij.psi.PsiClassType
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiElementFactory
import com.intellij.psi.PsiElementVisitor
import com.intellij.psi.PsiExpressionList
import com.intellij.psi.PsiFile
import com.intellij.psi.PsiLiteral
import com.intellij.psi.PsiMethod
import com.intellij.psi.PsiReferenceExpression
import com.intellij.psi.search.searches.ReferencesSearch
import com.intellij.psi.util.PsiUtil

class MixinCancellableInspection : MixinInspection() {

override fun getStaticDescription(): String =
"Reports missing or unused cancellable @Inject usages"

override fun buildVisitor(holder: ProblemsHolder): PsiElementVisitor = Visitor(holder)

private class Visitor(private val holder: ProblemsHolder) : JavaElementVisitor() {
override fun visitMethod(method: PsiMethod) {
val injectAnnotation = method.getAnnotation(INJECT) ?: return

val cancellableAttribute = injectAnnotation.findAttributeValue("cancellable") as? PsiLiteral ?: return
val isCancellable = cancellableAttribute.value == true

val ciParam = method.parameterList.parameters.firstOrNull {
val className = (it.type as? PsiClassType)?.fullQualifiedName ?: return@firstOrNull false
className == CALLBACK_INFO || className == CALLBACK_INFO_RETURNABLE
} ?: return

val ciType = (ciParam.type as? PsiClassType)?.resolve() ?: return
val searchingFor = ciType.findMethodsByName("setReturnValue", false).firstOrNull()
?: ciType.findMethodsByName("cancel", false).firstOrNull()
?: return

var mayUseCancel = false
var definitelyUsesCancel = false
for (ref in ReferencesSearch.search(ciParam)) {
val parent = PsiUtil.skipParenthesizedExprUp(ref.element.parent)
if (parent is PsiExpressionList) {
// method argument, we can't tell whether it uses cancel
mayUseCancel = true
}
val methodCall = parent as? PsiReferenceExpression ?: continue
if (methodCall.references.any { it.isReferenceTo(searchingFor) }) {
definitelyUsesCancel = true
break
}
}

if (definitelyUsesCancel && !isCancellable) {
val fixes = mutableListOf<LocalQuickFix>()
if (!CancellableBeforeSuperCallInspection.doesInjectBeforeSuperConstructorCall(injectAnnotation)) {
fixes += MakeInjectCancellableFix(injectAnnotation)
}

holder.registerProblem(
method.nameIdentifier ?: method,
"@Inject must be marked as cancellable in order to be cancelled",
ProblemHighlightType.GENERIC_ERROR_OR_WARNING,
*fixes.toTypedArray(),
)
} else if (!definitelyUsesCancel && !mayUseCancel && isCancellable) {
holder.registerProblem(
cancellableAttribute.parent,
"@Inject is cancellable but is never cancelled",
ProblemHighlightType.GENERIC_ERROR_OR_WARNING,
RemoveInjectCancellableFix(injectAnnotation),
)
}
}
}

private class MakeInjectCancellableFix(element: PsiAnnotation) :
LocalQuickFixAndIntentionActionOnPsiElement(element) {

override fun getFamilyName(): String = "Mark as cancellable"

override fun getText(): String = familyName

override fun invoke(
project: Project,
file: PsiFile,
editor: Editor?,
startElement: PsiElement,
endElement: PsiElement,
) {
val annotation = startElement as PsiAnnotation
val value = PsiElementFactory.getInstance(project).createExpressionFromText("true", annotation)
annotation.setDeclaredAttributeValue("cancellable", value)
}
}

class RemoveInjectCancellableFix(element: PsiAnnotation) :
LocalQuickFixAndIntentionActionOnPsiElement(element) {

override fun getFamilyName(): String = "Remove cancellable attribute"

override fun getText(): String = familyName

override fun invoke(
project: Project,
file: PsiFile,
editor: Editor?,
startElement: PsiElement,
endElement: PsiElement,
) {
val annotation = startElement as PsiAnnotation
annotation.setDeclaredAttributeValue("cancellable", null)
}
}
}

/* * 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 import com.demonwav.mcdev.platform.mixin.inspection.injector.CancellableBeforeSuperCallInspection import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Annotations.INJECT import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Classes.CALLBACK_INFO import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Classes.CALLBACK_INFO_RETURNABLE import com.demonwav.mcdev.util.fullQualifiedName import com.intellij.codeInspection.LocalQuickFix import com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement import com.intellij.codeInspection.ProblemHighlightType import com.intellij.codeInspection.ProblemsHolder import com.intellij.openapi.editor.Editor import com.intellij.openapi.project.Project import com.intellij.psi.JavaElementVisitor import com.intellij.psi.PsiAnnotation import com.intellij.psi.PsiClassType import com.intellij.psi.PsiElement import com.intellij.psi.PsiElementFactory import com.intellij.psi.PsiElementVisitor import com.intellij.psi.PsiExpressionList import com.intellij.psi.PsiFile import com.intellij.psi.PsiLiteral import com.intellij.psi.PsiMethod import com.intellij.psi.PsiReferenceExpression import com.intellij.psi.search.searches.ReferencesSearch import com.intellij.psi.util.PsiUtil class MixinCancellableInspection : MixinInspection() { override fun getStaticDescription(): String = "Reports missing or unused cancellable @Inject usages" override fun buildVisitor(holder: ProblemsHolder): PsiElementVisitor = Visitor(holder) private class Visitor(private val holder: ProblemsHolder) : JavaElementVisitor() { override fun visitMethod(method: PsiMethod) { val injectAnnotation = method.getAnnotation(INJECT) ?: return val cancellableAttribute = injectAnnotation.findAttributeValue("cancellable") as? PsiLiteral ?: return val isCancellable = cancellableAttribute.value == true val ciParam = method.parameterList.parameters.firstOrNull { val className = (it.type as? PsiClassType)?.fullQualifiedName ?: return@firstOrNull false className == CALLBACK_INFO || className == CALLBACK_INFO_RETURNABLE } ?: return val ciType = (ciParam.type as? PsiClassType)?.resolve() ?: return val searchingFor = ciType.findMethodsByName("setReturnValue", false).firstOrNull() ?: ciType.findMethodsByName("cancel", false).firstOrNull() ?: return var mayUseCancel = false var definitelyUsesCancel = false for (ref in ReferencesSearch.search(ciParam)) { val parent = PsiUtil.skipParenthesizedExprUp(ref.element.parent) if (parent is PsiExpressionList) { // method argument, we can't tell whether it uses cancel mayUseCancel = true } val methodCall = parent as? PsiReferenceExpression ?: continue if (methodCall.references.any { it.isReferenceTo(searchingFor) }) { definitelyUsesCancel = true break } } if (definitelyUsesCancel && !isCancellable) { val fixes = mutableListOf<LocalQuickFix>() if (!CancellableBeforeSuperCallInspection.doesInjectBeforeSuperConstructorCall(injectAnnotation)) { fixes += MakeInjectCancellableFix(injectAnnotation) } holder.registerProblem( method.nameIdentifier ?: method, "@Inject must be marked as cancellable in order to be cancelled", ProblemHighlightType.GENERIC_ERROR_OR_WARNING, *fixes.toTypedArray(), ) } else if (!definitelyUsesCancel && !mayUseCancel && isCancellable) { holder.registerProblem( cancellableAttribute.parent, "@Inject is cancellable but is never cancelled", ProblemHighlightType.GENERIC_ERROR_OR_WARNING, RemoveInjectCancellableFix(injectAnnotation), ) } } } private class MakeInjectCancellableFix(element: PsiAnnotation) : LocalQuickFixAndIntentionActionOnPsiElement(element) { override fun getFamilyName(): String = "Mark as cancellable" override fun getText(): String = familyName override fun invoke( project: Project, file: PsiFile, editor: Editor?, startElement: PsiElement, endElement: PsiElement, ) { val annotation = startElement as PsiAnnotation val value = PsiElementFactory.getInstance(project).createExpressionFromText("true", annotation) annotation.setDeclaredAttributeValue("cancellable", value) } } class RemoveInjectCancellableFix(element: PsiAnnotation) : LocalQuickFixAndIntentionActionOnPsiElement(element) { override fun getFamilyName(): String = "Remove cancellable attribute" override fun getText(): String = familyName override fun invoke( project: Project, file: PsiFile, editor: Editor?, startElement: PsiElement, endElement: PsiElement, ) { val annotation = startElement as PsiAnnotation annotation.setDeclaredAttributeValue("cancellable", null) } } } /* * 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.inspection import com.demonwav.mcdev.platform.mixin.inspection.injector.CancellableBeforeSuperCallInspection import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Annotations.INJECT import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Classes.CALLBACK_INFO import com.demonwav.mcdev.platform.mixin.util.MixinConstants.Classes.CALLBACK_INFO_RETURNABLE import com.demonwav.mcdev.util.fullQualifiedName import com.intellij.codeInspection.LocalQuickFix import com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement import com.intellij.codeInspection.ProblemHighlightType import com.intellij.codeInspection.ProblemsHolder import com.intellij.openapi.editor.Editor import com.intellij.openapi.project.Project import com.intellij.psi.JavaElementVisitor import com.intellij.psi.PsiAnnotation import com.intellij.psi.PsiClassType import com.intellij.psi.PsiElement import com.intellij.psi.PsiElementFactory import com.intellij.psi.PsiElementVisitor import com.intellij.psi.PsiExpressionList import com.intellij.psi.PsiFile import com.intellij.psi.PsiLiteral import com.intellij.psi.PsiMethod import com.intellij.psi.PsiReferenceExpression import com.intellij.psi.search.searches.ReferencesSearch import com.intellij.psi.util.PsiUtil class MixinCancellableInspection : MixinInspection() { override fun getStaticDescription(): String = "Reports missing or unused cancellable @Inject usages" override fun buildVisitor(holder: ProblemsHolder): PsiElementVisitor = Visitor(holder) private class Visitor(private val holder: ProblemsHolder) : JavaElementVisitor() { override fun visitMethod(method: PsiMethod) { val injectAnnotation = method.getAnnotation(INJECT) ?: return val cancellableAttribute = injectAnnotation.findAttributeValue("cancellable") as? PsiLiteral ?: return val isCancellable = cancellableAttribute.value == true val ciParam = method.parameterList.parameters.firstOrNull { val className = (it.type as? PsiClassType)?.fullQualifiedName ?: return@firstOrNull false className == CALLBACK_INFO || className == CALLBACK_INFO_RETURNABLE } ?: return val ciType = (ciParam.type as? PsiClassType)?.resolve() ?: return val searchingFor = ciType.findMethodsByName("setReturnValue", false).firstOrNull() ?: ciType.findMethodsByName("cancel", false).firstOrNull() ?: return var mayUseCancel = false var definitelyUsesCancel = false for (ref in ReferencesSearch.search(ciParam)) { val parent = PsiUtil.skipParenthesizedExprUp(ref.element.parent) if (parent is PsiExpressionList) { // method argument, we can't tell whether it uses cancel mayUseCancel = true } val methodCall = parent as? PsiReferenceExpression ?: continue if (methodCall.references.any { it.isReferenceTo(searchingFor) }) { definitelyUsesCancel = true break } } if (definitelyUsesCancel && !isCancellable) { val fixes = mutableListOf<LocalQuickFix>() if (!CancellableBeforeSuperCallInspection.doesInjectBeforeSuperConstructorCall(injectAnnotation)) { fixes += MakeInjectCancellableFix(injectAnnotation) } holder.registerProblem( method.nameIdentifier ?: method, "@Inject must be marked as cancellable in order to be cancelled", ProblemHighlightType.GENERIC_ERROR_OR_WARNING, *fixes.toTypedArray(), ) } else if (!definitelyUsesCancel && !mayUseCancel && isCancellable) { holder.registerProblem( cancellableAttribute.parent, "@Inject is cancellable but is never cancelled", ProblemHighlightType.GENERIC_ERROR_OR_WARNING, RemoveInjectCancellableFix(injectAnnotation), ) } } } private class MakeInjectCancellableFix(element: PsiAnnotation) : LocalQuickFixAndIntentionActionOnPsiElement(element) { override fun getFamilyName(): String = "Mark as cancellable" override fun getText(): String = familyName override fun invoke( project: Project, file: PsiFile, editor: Editor?, startElement: PsiElement, endElement: PsiElement, ) { val annotation = startElement as PsiAnnotation val value = PsiElementFactory.getInstance(project).createExpressionFromText("true", annotation) annotation.setDeclaredAttributeValue("cancellable", value) } } class RemoveInjectCancellableFix(element: PsiAnnotation) : LocalQuickFixAndIntentionActionOnPsiElement(element) { override fun getFamilyName(): String = "Remove cancellable attribute" override fun getText(): String = familyName override fun invoke( project: Project, file: PsiFile, editor: Editor?, startElement: PsiElement, endElement: PsiElement, ) { val annotation = startElement as PsiAnnotation annotation.setDeclaredAttributeValue("cancellable", null) } } }

Add build comment

Mute test

Server communication failure

Run Custom Build

TODO

Responsibility

Edit tags

Loading...

Are you sure?