azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[FIR] Change API for generating nested classes from plugins

Browse Source 
`FirDeclarationGenerationExtension.generateClassLikeDeclaration` was split
  into two functions: one for generating top level classes, and one for
  nested classes. Such change reduces verbosity and error-proness of
  this extension and also allows to smoothly run plugins on local classes

^KT-55248 Fixed
This commit is contained in:
Dmitriy Novozhilov
2022-12-21 10:29:54 +02:00
committed by Space Team
parent faa96ec7c0
commit 6783621eb0
31 changed files with 458 additions and 162 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/kotlinx-serialization/kotlinx-serialization.k2/src/org/jetbrains/kotlinx/serialization/compiler/fir/FirBuildersUtils.kt
+1 -1
View File
@@ -30,7 +30,7 @@ import org.jetbrains.kotlin.types.Variance
@OptIn(SymbolInternals::class)
fun FirDeclarationGenerationExtension.buildPrimaryConstructor(owner: FirClassSymbol<*>, isInner: Boolean, key: GeneratedDeclarationKey, status: FirDeclarationStatus): FirConstructor {
val classId = owner.classId
val lookupTag = ConeClassLikeLookupTagImpl(classId)
val lookupTag = owner.toLookupTag()
return buildPrimaryConstructor {
moduleData = session.moduleData
origin = key.origin
plugins/kotlinx-serialization/kotlinx-serialization.k2/src/org/jetbrains/kotlinx/serialization/compiler/fir/SerializationFirResolveExtension.kt
+23 -30
View File
@@ -11,16 +11,16 @@ import org.jetbrains.kotlin.descriptors.Modality
import org.jetbrains.kotlin.descriptors.Visibilities
import org.jetbrains.kotlin.fir.FirSession
import org.jetbrains.kotlin.fir.analysis.checkers.getContainingDeclarationSymbol
import org.jetbrains.kotlin.fir.containingClassForLocalAttr
import org.jetbrains.kotlin.fir.copy
import org.jetbrains.kotlin.fir.declarations.FirDeclarationOrigin
import org.jetbrains.kotlin.fir.declarations.FirRegularClass
import org.jetbrains.kotlin.fir.declarations.builder.*
import org.jetbrains.kotlin.fir.declarations.impl.FirResolvedDeclarationStatusImpl
import org.jetbrains.kotlin.fir.declarations.origin
import org.jetbrains.kotlin.fir.declarations.utils.isCompanion
import org.jetbrains.kotlin.fir.extensions.FirDeclarationGenerationExtension
import org.jetbrains.kotlin.fir.extensions.FirDeclarationPredicateRegistrar
import org.jetbrains.kotlin.fir.extensions.MemberGenerationContext
import org.jetbrains.kotlin.fir.extensions.predicateBasedProvider
import org.jetbrains.kotlin.fir.declarations.utils.isLocal
import org.jetbrains.kotlin.fir.extensions.*
import org.jetbrains.kotlin.fir.moduleData
import org.jetbrains.kotlin.fir.resolve.*
import org.jetbrains.kotlin.fir.resolve.providers.symbolProvider
@@ -68,19 +68,16 @@ class SerializationFirResolveExtension(session: FirSession) : FirDeclarationGene
return result
}
override fun generateClassLikeDeclaration(classId: ClassId): FirClassLikeSymbol<*>? {
return when (classId.shortClassName) {
SpecialNames.DEFAULT_NAME_FOR_COMPANION_OBJECT -> {
generateCompanionDeclaration(classId)
}
SerialEntityNames.SERIALIZER_CLASS_NAME -> {
addSerializerImplClass(classId)
}
else -> error("Can't generate class ${classId.asSingleFqName()}")
override fun generateNestedClassLikeDeclaration(owner: FirClassSymbol<*>, name: Name): FirClassLikeSymbol<*>? {
if (owner !is FirRegularClassSymbol) return null
if (!session.predicateBasedProvider.matches(FirSerializationPredicates.annotatedWithSerializableOrMeta, owner)) return null
return when (name) {
SpecialNames.DEFAULT_NAME_FOR_COMPANION_OBJECT -> generateCompanionDeclaration(owner)
SerialEntityNames.SERIALIZER_CLASS_NAME -> generateSerializerImplClass(owner)
else -> error("Can't generate class ${owner.classId.createNestedClassId(name).asSingleFqName()}")
}
}
override fun getCallableNamesForClass(classSymbol: FirClassSymbol<*>): Set<Name> {
val classId = classSymbol.classId
val result = mutableSetOf<Name>()
@@ -285,15 +282,7 @@ class SerializationFirResolveExtension(session: FirSession) : FirDeclarationGene
return listOf(defaultObjectConstructor.symbol)
}
private fun getClassWithAnnotatedWithSerializableOrMeta(classId: ClassId?): FirRegularClassSymbol? {
if (classId == null) return null
return (session.symbolProvider.getClassLikeSymbolByClassId(classId) as? FirRegularClassSymbol)?.takeIf {
session.predicateBasedProvider.matches(FirSerializationPredicates.annotatedWithSerializableOrMeta, it)
}
}
fun addSerializerImplClass(classId: ClassId): FirClassLikeSymbol<*>? {
val owner = getClassWithAnnotatedWithSerializableOrMeta(classId.outerClassId) ?: return null
private fun generateSerializerImplClass(owner: FirRegularClassSymbol): FirClassLikeSymbol<*> {
val hasTypeParams = owner.typeParameterSymbols.isNotEmpty()
val serializerKind = if (hasTypeParams) ClassKind.CLASS else ClassKind.OBJECT
val serializerFirClass = buildRegularClass {
@@ -302,7 +291,7 @@ class SerializationFirResolveExtension(session: FirSession) : FirDeclarationGene
classKind = serializerKind
scopeProvider = session.kotlinScopeProvider
name = SerialEntityNames.SERIALIZER_CLASS_NAME
symbol = FirRegularClassSymbol(classId)
symbol = FirRegularClassSymbol(owner.classId.createNestedClassId(name))
status = FirResolvedDeclarationStatusImpl(
Visibilities.Public,
Modality.FINAL,
@@ -325,13 +314,11 @@ class SerializationFirResolveExtension(session: FirSession) : FirDeclarationGene
)
), isNullable = false
).toFirResolvedTypeRef()
}
}.also { it.initLocalAttributeIfNeeded(owner) }
return serializerFirClass.symbol
}
fun generateCompanionDeclaration(classId: ClassId): FirClassLikeSymbol<*>? {
if (classId.shortClassName != SpecialNames.DEFAULT_NAME_FOR_COMPANION_OBJECT) return null
val owner = getClassWithAnnotatedWithSerializableOrMeta(classId.outerClassId) ?: return null
private fun generateCompanionDeclaration(owner: FirRegularClassSymbol): FirRegularClassSymbol? {
if (owner.companionObjectSymbol != null) return null
val regularClass = buildRegularClass {
moduleData = session.moduleData
@@ -346,16 +333,22 @@ class SerializationFirResolveExtension(session: FirSession) : FirDeclarationGene
isCompanion = true
}
name = SpecialNames.DEFAULT_NAME_FOR_COMPANION_OBJECT
symbol = FirRegularClassSymbol(classId)
symbol = FirRegularClassSymbol(owner.classId.createNestedClassId(name))
superTypeRefs += session.builtinTypes.anyType
if (with(session) { owner.companionNeedsSerializerFactory }) {
val serializerFactoryClassId = ClassId(SerializationPackages.internalPackageFqName, SERIALIZER_FACTORY_INTERFACE_NAME)
superTypeRefs += serializerFactoryClassId.constructClassLikeType(emptyArray(), false).toFirResolvedTypeRef()
}
}
}.also { it.initLocalAttributeIfNeeded(owner) }
return regularClass.symbol
}
private fun FirRegularClass.initLocalAttributeIfNeeded(owner: FirRegularClassSymbol) {
if (owner.isLocal) {
this.containingClassForLocalAttr = owner.toLookupTag()
}
}
override fun FirDeclarationPredicateRegistrar.registerPredicates() {
register(FirSerializationPredicates.annotatedWithSerializableOrMeta, FirSerializationPredicates.hasMetaAnnotation)
}
plugins/kotlinx-serialization/testData/firMembers/serializerInLocalClass.fir.txt
Vendored
+50
View File
@@ -0,0 +1,50 @@
FILE: serializerInLocalClass.kt
public final fun local(): R|kotlin/String| {
@R|kotlinx/serialization/Serializable|() local final data class Carrier : R|kotlin/Any| {
public constructor(i: R|kotlin/Int|): R|Carrier| {
super<R|kotlin/Any|>()
}
public final val i: R|kotlin/Int| = R|<local>/i|
public get(): R|kotlin/Int|
public final operator fun component1(): R|kotlin/Int|
public final fun copy(i: R|kotlin/Int| = this@R|/Carrier|.R|<local>/i|): R|Carrier|
public final companion object Companion : R|kotlin/Any| {
public final fun serializer(): R|kotlinx/serialization/KSerializer<Carrier>|
private constructor(): R|Carrier.Companion|
}
public final object $serializer : R|kotlinx/serialization/internal/GeneratedSerializer<Carrier>| {
public final fun serialize(encoder: R|kotlinx/serialization/encoding/Encoder|, value: R|Carrier|): R|kotlin/Unit|
public final fun deserialize(decoder: R|kotlinx/serialization/encoding/Decoder|): R|Carrier|
public final val descriptor: R|kotlinx/serialization/descriptors/SerialDescriptor|
public get(): R|kotlinx/serialization/descriptors/SerialDescriptor|
public final fun childSerializers(): R|kotlin/Array<kotlinx/serialization/KSerializer<*>>|
private constructor(): R|Carrier.$serializer|
}
}
^local Q|Carrier|.R|/Carrier.Companion.serializer|().R|SubstitutionOverride<kotlinx/serialization/KSerializer.descriptor: R|kotlinx/serialization/descriptors/SerialDescriptor|>|.R|kotlin/Any.toString|()
}
public final fun box(): R|kotlin/String| {
lval expected: R|kotlin/String| = String(local.Carrier(i: kotlin.Int))
lval actual: R|kotlin/String| = R|/local|()
when () {
!=(R|<local>/expected|, R|<local>/actual|) -> {
^box <strcat>(String(Fail: ), R|<local>/actual|)
}
}
^box String(OK)
}
plugins/kotlinx-serialization/testData/firMembers/serializerInLocalClass.kt
Vendored
+20
View File
@@ -0,0 +1,20 @@
// TARGET_BACKEND: JVM_IR
// WITH_STDLIB
import kotlinx.serialization.*
fun local(): String {
@Serializable
data class Carrier(val i: Int)
return Carrier.serializer().descriptor.toString()
}
fun box(): String {
val expected = "local.Carrier(i: kotlin.Int)"
val actual = local()
if (expected != actual) {
return "Fail: $actual"
}
return "OK"
}
plugins/kotlinx-serialization/tests-gen/org/jetbrains/kotlinx/serialization/runners/SerializationFirBlackBoxTestGenerated.java
Generated
+6
View File
@@ -265,6 +265,12 @@ public class SerializationFirBlackBoxTestGenerated extends AbstractSerialization
runTest("plugins/kotlinx-serialization/testData/firMembers/serializableWithCompanion.kt");
}
@Test
@TestMetadata("serializerInLocalClass.kt")
public void testSerializerInLocalClass() throws Exception {
runTest("plugins/kotlinx-serialization/testData/firMembers/serializerInLocalClass.kt");
}
@Test
@TestMetadata("serializerViaCompanion.kt")
public void testSerializerViaCompanion() throws Exception {
plugins/kotlinx-serialization/tests-gen/org/jetbrains/kotlinx/serialization/runners/SerializationFirDiagnosticTestGenerated.java
Generated
+6
View File
@@ -240,6 +240,12 @@ public class SerializationFirDiagnosticTestGenerated extends AbstractSerializati
runTest("plugins/kotlinx-serialization/testData/firMembers/serializableWithCompanion.kt");
}
@Test
@TestMetadata("serializerInLocalClass.kt")
public void testSerializerInLocalClass() throws Exception {
runTest("plugins/kotlinx-serialization/testData/firMembers/serializerInLocalClass.kt");
}
@Test
@TestMetadata("serializerViaCompanion.kt")
public void testSerializerViaCompanion() throws Exception {