src/main/kotlin/platform/forge/inspections/sideonly/NestedClassSideOnlyInspection.kt diff

← → edited src/main/kotlin/platform/forge/inspections/sideonly/NestedClassSideOnlyInspection.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.forge.inspections.sideonly

import com.intellij.psi.PsiAnnotation
import com.intellij.psi.PsiClass
import com.siyeh.ig.BaseInspection
import com.siyeh.ig.BaseInspectionVisitor
import com.siyeh.ig.InspectionGadgetsFix
import org.jetbrains.annotations.Nls

class NestedClassSideOnlyInspection : BaseInspection() {

@Nls
override fun getDisplayName() = "Invalid usage of @SideOnly in nested class declaration"

override fun buildErrorString(vararg infos: Any) =
"A nested class cannot declare a side that is different from the parent class." +
"\nEither remove the nested class's @SideOnly annotation, or change it to match it's parent's side."

override fun getStaticDescription(): String {
return "Classes which are annotated with @SideOnly cannot contain any nested classes which are " +
"annotated with a different @SideOnly annotation. Since a class that is annotated with @SideOnly " +
"brings everything with it, @SideOnly annotated nested classes are usually useless."
}

override fun buildFix(vararg infos: Any): InspectionGadgetsFix? {
val annotation = infos[0] as PsiAnnotation

return if (annotation.isWritable) {
RemoveAnnotationInspectionGadgetsFix(
annotation.qualifiedName ?: return null,
"Remove @SideOnly annotation from nested class"
)
} else {
null
}
}

override fun buildVisitor(): BaseInspectionVisitor {
return object : BaseInspectionVisitor() {
override fun visitClass(aClass: PsiClass) {
if (aClass.parent == null) {
return
}

aClass.nameIdentifier ?: return

if (!SideOnlyUtil.beginningCheck(aClass)) {
return
}

// The class lists are ordered from lowest to highest in the hierarchy - that is the first element in the list
// is the most nested class, and the last element in the list is the top level class
//
// In this case, the higher-level classes take precedence, so if a class is annotated as @SideOnly.CLIENT and a nested class is
// annotated as @SideOnly.SERVER, the nested class is the class that is in error, not the top level class
var currentSide = Side.NONE
for ((classAnnotation, classSide) in SideOnlyUtil.checkClassHierarchy(aClass)) {
if (currentSide === Side.NONE) {
// If currentSide is NONE, then a class hasn't declared yet what it is
if (classSide !== Side.NONE && classSide !== Side.INVALID) {
currentSide = classSide
} else {
// We are only worried about this class
return
}
} else if (classAnnotation != null && classSide !== Side.NONE && classSide !== Side.INVALID) {
if (classSide !== currentSide) {
registerClassError(aClass, aClass.getAnnotation(classAnnotation.annotationName))
} else {
return
}
}
}
}
}
}
}

/*
* 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.forge.inspections.sideonly

import com.intellij.psi.PsiAnnotation
import com.intellij.psi.PsiClass
import com.siyeh.ig.BaseInspection
import com.siyeh.ig.BaseInspectionVisitor
import com.siyeh.ig.InspectionGadgetsFix
import org.jetbrains.annotations.Nls

class NestedClassSideOnlyInspection : BaseInspection() {

@Nls
override fun getDisplayName() = "Invalid usage of @SideOnly in nested class declaration"

override fun buildErrorString(vararg infos: Any) =
"A nested class cannot declare a side that is different from the parent class." +
"\nEither remove the nested class's @SideOnly annotation, or change it to match it's parent's side."

override fun getStaticDescription(): String {
return "Classes which are annotated with @SideOnly cannot contain any nested classes which are " +
"annotated with a different @SideOnly annotation. Since a class that is annotated with @SideOnly " +
"brings everything with it, @SideOnly annotated nested classes are usually useless."
}

override fun buildFix(vararg infos: Any): InspectionGadgetsFix? {
val annotation = infos[0] as PsiAnnotation

return if (annotation.isWritable) {
RemoveAnnotationInspectionGadgetsFix(
annotation.qualifiedName ?: return null,
"Remove @SideOnly annotation from nested class"
)
} else {
null
}
}

override fun buildVisitor(): BaseInspectionVisitor {
return object : BaseInspectionVisitor() {
override fun visitClass(aClass: PsiClass) {
if (aClass.parent == null) {
return
}

aClass.nameIdentifier ?: return

if (!SideOnlyUtil.beginningCheck(aClass)) {
return
}

// The class lists are ordered from lowest to highest in the hierarchy - that is the first element in the list
// is the most nested class, and the last element in the list is the top level class
//
// In this case, the higher-level classes take precedence, so if a class is annotated as @SideOnly.CLIENT and a nested class is
// annotated as @SideOnly.SERVER, the nested class is the class that is in error, not the top level class
var currentSide = Side.NONE
for ((classAnnotation, classSide) in SideOnlyUtil.checkClassHierarchy(aClass)) {
if (currentSide === Side.NONE) {
// If currentSide is NONE, then a class hasn't declared yet what it is
if (classSide !== Side.NONE && classSide !== Side.INVALID) {
currentSide = classSide
} else {
// We are only worried about this class
return
}
} else if (classAnnotation != null && classSide !== Side.NONE && classSide !== Side.INVALID) {
if (classSide !== currentSide) {
registerClassError(aClass, aClass.getAnnotation(classAnnotation.annotationName))
} else {
return
}
}
}
}
}
}
}

/* * 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.forge.inspections.sideonly import com.intellij.psi.PsiAnnotation import com.intellij.psi.PsiClass import com.siyeh.ig.BaseInspection import com.siyeh.ig.BaseInspectionVisitor import com.siyeh.ig.InspectionGadgetsFix import org.jetbrains.annotations.Nls class NestedClassSideOnlyInspection : BaseInspection() { @Nls override fun getDisplayName() = "Invalid usage of @SideOnly in nested class declaration" override fun buildErrorString(vararg infos: Any) = "A nested class cannot declare a side that is different from the parent class." + "\nEither remove the nested class's @SideOnly annotation, or change it to match it's parent's side." override fun getStaticDescription(): String { return "Classes which are annotated with @SideOnly cannot contain any nested classes which are " + "annotated with a different @SideOnly annotation. Since a class that is annotated with @SideOnly " + "brings everything with it, @SideOnly annotated nested classes are usually useless." } override fun buildFix(vararg infos: Any): InspectionGadgetsFix? { val annotation = infos[0] as PsiAnnotation return if (annotation.isWritable) { RemoveAnnotationInspectionGadgetsFix( annotation.qualifiedName ?: return null, "Remove @SideOnly annotation from nested class" ) } else { null } } override fun buildVisitor(): BaseInspectionVisitor { return object : BaseInspectionVisitor() { override fun visitClass(aClass: PsiClass) { if (aClass.parent == null) { return } aClass.nameIdentifier ?: return if (!SideOnlyUtil.beginningCheck(aClass)) { return } // The class lists are ordered from lowest to highest in the hierarchy - that is the first element in the list // is the most nested class, and the last element in the list is the top level class // // In this case, the higher-level classes take precedence, so if a class is annotated as @SideOnly.CLIENT and a nested class is // annotated as @SideOnly.SERVER, the nested class is the class that is in error, not the top level class var currentSide = Side.NONE for ((classAnnotation, classSide) in SideOnlyUtil.checkClassHierarchy(aClass)) { if (currentSide === Side.NONE) { // If currentSide is NONE, then a class hasn't declared yet what it is if (classSide !== Side.NONE && classSide !== Side.INVALID) { currentSide = classSide } else { // We are only worried about this class return } } else if (classAnnotation != null && classSide !== Side.NONE && classSide !== Side.INVALID) { if (classSide !== currentSide) { registerClassError(aClass, aClass.getAnnotation(classAnnotation.annotationName)) } else { return } } } } } } } /* * 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.forge.inspections.sideonly import com.intellij.psi.PsiAnnotation import com.intellij.psi.PsiClass import com.siyeh.ig.BaseInspection import com.siyeh.ig.BaseInspectionVisitor import com.siyeh.ig.InspectionGadgetsFix import org.jetbrains.annotations.Nls class NestedClassSideOnlyInspection : BaseInspection() { @Nls override fun getDisplayName() = "Invalid usage of @SideOnly in nested class declaration" override fun buildErrorString(vararg infos: Any) = "A nested class cannot declare a side that is different from the parent class." + "\nEither remove the nested class's @SideOnly annotation, or change it to match it's parent's side." override fun getStaticDescription(): String { return "Classes which are annotated with @SideOnly cannot contain any nested classes which are " + "annotated with a different @SideOnly annotation. Since a class that is annotated with @SideOnly " + "brings everything with it, @SideOnly annotated nested classes are usually useless." } override fun buildFix(vararg infos: Any): InspectionGadgetsFix? { val annotation = infos[0] as PsiAnnotation return if (annotation.isWritable) { RemoveAnnotationInspectionGadgetsFix( annotation.qualifiedName ?: return null, "Remove @SideOnly annotation from nested class" ) } else { null } } override fun buildVisitor(): BaseInspectionVisitor { return object : BaseInspectionVisitor() { override fun visitClass(aClass: PsiClass) { if (aClass.parent == null) { return } aClass.nameIdentifier ?: return if (!SideOnlyUtil.beginningCheck(aClass)) { return } // The class lists are ordered from lowest to highest in the hierarchy - that is the first element in the list // is the most nested class, and the last element in the list is the top level class // // In this case, the higher-level classes take precedence, so if a class is annotated as @SideOnly.CLIENT and a nested class is // annotated as @SideOnly.SERVER, the nested class is the class that is in error, not the top level class var currentSide = Side.NONE for ((classAnnotation, classSide) in SideOnlyUtil.checkClassHierarchy(aClass)) { if (currentSide === Side.NONE) { // If currentSide is NONE, then a class hasn't declared yet what it is if (classSide !== Side.NONE && classSide !== Side.INVALID) { currentSide = classSide } else { // We are only worried about this class return } } else if (classAnnotation != null && classSide !== Side.NONE && classSide !== Side.INVALID) { if (classSide !== currentSide) { registerClassError(aClass, aClass.getAnnotation(classAnnotation.annotationName)) } else { return } } } } } } }

Add build comment

Mute test

Server communication failure

Run Custom Build

TODO

Responsibility

Edit tags

Loading...

Are you sure?