Add inspection for CTOR_HEAD missing unsafe = true

Author: Earthcomputer

src/main/kotlin/platform/mixin/inspection/injector/CtorHeadNoUnsafeInspection.kt

@@ -0,0 +1,84 @@
+/*
+ * 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.injector
+
+import com.demonwav.mcdev.facet.MinecraftFacet
+import com.demonwav.mcdev.platform.fabric.FabricModuleType
+import com.demonwav.mcdev.platform.mixin.inspection.MixinInspection
+import com.demonwav.mcdev.platform.mixin.util.MixinConstants
+import com.demonwav.mcdev.util.constantStringValue
+import com.demonwav.mcdev.util.constantValue
+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 java.awt.FlowLayout
+import javax.swing.JCheckBox
+import javax.swing.JComponent
+import javax.swing.JPanel
+
+class CtorHeadNoUnsafeInspection : MixinInspection() {
+    @JvmField
+    var ignoreForFabric = true
+
+    override fun createOptionsPanel(): JComponent {
+        val panel = JPanel(FlowLayout(FlowLayout.LEFT))
+        val checkbox = JCheckBox("Ignore in Fabric mods", ignoreForFabric)
+        checkbox.addActionListener {
+            ignoreForFabric = checkbox.isSelected
+        }
+        panel.add(checkbox)
+        return panel
+    }
+
+    override fun getStaticDescription() = "Reports when @At(\"CTOR_HEAD\") is missing unsafe"
+
+    override fun buildVisitor(holder: ProblemsHolder): PsiElementVisitor {
+        if (ignoreForFabric) {
+            val isFabric = holder.file.findModule()?.let { MinecraftFacet.getInstance(it) }?.isOfType(FabricModuleType)
+                ?: false
+            if (isFabric) {
+                return PsiElementVisitor.EMPTY_VISITOR
+            }
+        }
+
+        return object : JavaElementVisitor() {
+            override fun visitAnnotation(annotation: PsiAnnotation) {
+                if (!annotation.hasQualifiedName(MixinConstants.Annotations.AT)) {
+                    return
+                }
+                val valueElement = annotation.findDeclaredAttributeValue("value")
+                if (valueElement?.constantStringValue != "CTOR_HEAD") {
+                    return
+                }
+                if (annotation.findDeclaredAttributeValue("unsafe")?.constantValue == true) {
+                    return
+                }
+                holder.registerProblem(
+                    valueElement,
+                    "CTOR_HEAD is missing unsafe = true",
+                    InjectIntoConstructorInspection.AddUnsafeFix(annotation),
+                )
+            }
+        }
+    }
+}

src/main/kotlin/platform/mixin/inspection/injector/InjectIntoConstructorInspection.kt

@@ -131,7 +131,7 @@ class InjectIntoConstructorInspection : MixinInspection() {
 
     override fun getStaticDescription() = "@Inject into Constructor"
 
-    private class AddUnsafeFix(at: PsiAnnotation) : LocalQuickFixOnPsiElement(at) {
+    class AddUnsafeFix(at: PsiAnnotation) : LocalQuickFixOnPsiElement(at) {
         override fun getFamilyName() = "Add unsafe = true"
         override fun getText() = "Add unsafe = true"
 

src/main/resources/META-INF/plugin.xml

@@ -888,6 +888,14 @@
                          level="ERROR"
                          hasStaticDescription="true"
                          implementationClass="com.demonwav.mcdev.platform.mixin.inspection.injector.CancellableBeforeSuperCallInspection"/>
+        <localInspection displayName="CTOR_HEAD is missing unsafe = true"
+                         shortName="CtorHeadNoUnsafe"
+                         groupName="Mixin"
+                         language="JAVA"
+                         enabledByDefault="true"
+                         level="ERROR"
+                         hasStaticDescription="true"
+                         implementationClass="com.demonwav.mcdev.platform.mixin.inspection.injector.CtorHeadNoUnsafeInspection"/>
         <!--endregion-->
 
         <!--region Overwrite Inspections -->