godot.annotation.processor.ext.ksClassDeclarationExt.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of godot-kotlin-symbol-processor Show documentation
Godot Kotlin symbol processor
There is a newer version: 0.10.0-4.3.0
Show newest version
package godot.annotation.processor.ext

import com.google.devtools.ksp.getAllSuperTypes
import com.google.devtools.ksp.getConstructors
import com.google.devtools.ksp.getDeclaredProperties
import com.google.devtools.ksp.isAbstract
import com.google.devtools.ksp.isPublic
import com.google.devtools.ksp.symbol.KSClassDeclaration
import godot.annotation.RegisterClass
import godot.annotation.RegisterConstructor
import godot.annotation.RegisterProperty
import godot.annotation.RegisterSignal
import godot.annotation.processor.Settings
import godot.entrygenerator.model.ClassAnnotation
import godot.entrygenerator.model.Clazz
import godot.entrygenerator.model.RegisteredClass
import godot.entrygenerator.model.RegisteredFunction
import godot.entrygenerator.model.RegisteredProperty
import godot.entrygenerator.model.RegisteredSignal
import java.io.File

internal fun KSClassDeclaration.mapToClazz(
    settings: Settings,
): Clazz {
    val fqName = requireNotNull(qualifiedName?.asString()) {
        "Qualified name for class declaration of a registered type or it's super types cannot be null! KSClassDeclaration: $this"
    }
    val supertypeDeclarations = getAllSuperTypes()
        .mapNotNull { it.declaration as? KSClassDeclaration } //we're only interested in classes not interfaces
        .map { it.mapToClazz(settings) }
        .toList()
    val mappedAnnotations = annotations
        .mapNotNull { it.mapToAnnotation(this) as? ClassAnnotation }
        .toList()

    val registeredFunctions = getAllFunctions()
        .mapNotNull { it.mapToRegisteredFunction(this, settings) }
        .toList()

    val declaredProperties = getDeclaredProperties()
    val allProperties = getAllProperties()
    val registeredProperties = allProperties
        .filter { property ->
            property.annotations.any { it.fqNameUnsafe == RegisterProperty::class.qualifiedName } ||
                property.findOverridee()?.annotations?.any { it.fqNameUnsafe == RegisterProperty::class.qualifiedName } == true
        }
        .map {
            it.mapToRegisteredProperty(settings)
        }
        .toList()
    val registeredSignals = allProperties
        .filter { property ->
            property.annotations.any { it.fqNameUnsafe == RegisterSignal::class.qualifiedName }
        }
        .map { it.mapToRegisteredSignal(declaredProperties.toList(), settings) }
        .toList()

    val shouldBeRegistered = annotations.any { it.fqNameUnsafe == RegisterClass::class.qualifiedName } ||
        isAbstractAndContainsRegisteredMembers(registeredFunctions, registeredProperties, registeredSignals) ||
        isAbstractAndInheritsGodotBaseClass()

    val absoluteSourcePath = this.containingFile?.filePath?.let { File(it) }
    val relativeSourcePath = absoluteSourcePath?.relativeTo(settings.projectBaseDir)?.invariantSeparatorsPath ?: ""

    return if (shouldBeRegistered) {

        val registeredConstructors = getConstructors()
            .filter { it.isPublic() }
            .filter { constructor ->
                constructor.annotations.any { it.fqNameUnsafe == RegisterConstructor::class.qualifiedName } ||
                    constructor.parameters.isEmpty()
            }
            .map { it.mapToRegisteredConstructor(settings) }
            .toList()

        RegisteredClass(
            registeredName = requireNotNull(provideRegisteredClassName(settings)) {
                "Failed to calculate RegisteredName for a registered class: ${this.qualifiedName?.asString()}. This is a bug. Please report it on Github"
            },
            fqName = fqName,
            relativeSourcePath = relativeSourcePath,
            supertypes = supertypeDeclarations,
            annotations = mappedAnnotations,
            constructors = registeredConstructors,
            functions = registeredFunctions,
            signals = registeredSignals,
            properties = registeredProperties,
            isAbstract = isAbstract(),
            isFqNameRegistrationEnabled = settings.isFqNameRegistrationEnabled,
            classNamePrefix = settings.classPrefix,
            symbolProcessorSource = this
        )
    } else {
        Clazz(
            fqName = fqName,
            relativeSourcePath = relativeSourcePath,
            supertypes = supertypeDeclarations,
            annotations = mappedAnnotations,
            symbolProcessorSource = this
        )
    }
}

internal fun KSClassDeclaration.isAbstractAndContainsRegisteredMembers(
    registeredFunctions: List,
    registeredProperties: List,
    registeredSignals: List
): Boolean {
    return isAbstract() && (registeredFunctions.isNotEmpty() || registeredProperties.isNotEmpty() || registeredSignals.isNotEmpty())
}

// issue: https://github.com/utopia-rise/godot-kotlin-jvm/issues/365
// also register empty abstract classes which inherit from a godot base class as child class registrars will reference the class registrar of this class
internal fun KSClassDeclaration.isAbstractAndInheritsGodotBaseClass(): Boolean {
    return isAbstract()
        && superTypes
        .any { supertype ->
            supertype
                .resolve()
                .declaration
                .annotations
                .any { annotation -> annotation.fqNameUnsafe == "godot.annotation.GodotBaseType" }
        }
}