[Serialization] Reorganize module structure

2022-08-22 11:49:45 +03:00
parent 0a8cefc8a5
commit cc00dcc038
150 changed files with 493 additions and 322 deletions
@@ -0,0 +1,21 @@
+description = "Kotlin Serialization Compiler Plugin (Common)"
+
+plugins {
+    kotlin("jvm")
+    id("jps-compatible")
+}
+
+dependencies {
+    compileOnly(project(":compiler:util"))
+    compileOnly(project(":core:compiler.common"))
+    compileOnly(intellijCore())
+}
+
+sourceSets {
+    "main" { projectDefault() }
+    "test" { none() }
+}
+
+runtimeJar()
+sourcesJar()
+javadocJar()
@@ -0,0 +1,14 @@
+/*
+ * Copyright 2010-2022 JetBrains s.r.o. and Kotlin Programming Language contributors.
+ * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
+ */
+
+package org.jetbrains.kotlinx.serialization.compiler.fir
+
+import org.jetbrains.kotlin.GeneratedDeclarationKey
+
+object SerializationPluginKey : GeneratedDeclarationKey() {
+    override fun toString(): String {
+        return "KotlinxSerializationPlugin"
+    }
+}
@@ -0,0 +1,155 @@
+/*
+ * Copyright 2010-2022 JetBrains s.r.o. and Kotlin Programming Language contributors.
+ * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
+ */
+
+package org.jetbrains.kotlinx.serialization.compiler.resolve
+
+import org.jetbrains.kotlin.name.CallableId
+import org.jetbrains.kotlin.name.ClassId
+import org.jetbrains.kotlin.name.FqName
+import org.jetbrains.kotlin.name.Name
+
+object SerializationPackages {
+    val packageFqName = FqName("kotlinx.serialization")
+    val internalPackageFqName = FqName("kotlinx.serialization.internal")
+    val encodingPackageFqName = FqName("kotlinx.serialization.encoding")
+    val descriptorsPackageFqName = FqName("kotlinx.serialization.descriptors")
+    val builtinsPackageFqName = FqName("kotlinx.serialization.builtins")
+
+    val allPublicPackages = listOf(packageFqName, encodingPackageFqName, descriptorsPackageFqName, builtinsPackageFqName)
+}
+
+object SerializationAnnotations {
+    // When changing names for these annotations, please change
+    // org.jetbrains.kotlin.idea.caches.lightClasses.annotations.KOTLINX_SERIALIZABLE_FQ_NAME and
+    // org.jetbrains.kotlin.idea.caches.lightClasses.annotations.KOTLINX_SERIALIZER_FQ_NAME accordingly.
+    // Otherwise, there it might lead to exceptions from light classes when building them for serializer/serializable classes
+    val serializableAnnotationFqName = FqName("kotlinx.serialization.Serializable")
+    val serializerAnnotationFqName = FqName("kotlinx.serialization.Serializer")
+    val serialNameAnnotationFqName = FqName("kotlinx.serialization.SerialName")
+    val requiredAnnotationFqName = FqName("kotlinx.serialization.Required")
+    val serialTransientFqName = FqName("kotlinx.serialization.Transient")
+    // Also implicitly used in kotlin-native.compiler.backend.native/CodeGenerationInfo.kt
+    val serialInfoFqName = FqName("kotlinx.serialization.SerialInfo")
+    val inheritableSerialInfoFqName = FqName("kotlinx.serialization.InheritableSerialInfo")
+    val metaSerializableAnnotationFqName = FqName("kotlinx.serialization.MetaSerializable")
+    val encodeDefaultFqName = FqName("kotlinx.serialization.EncodeDefault")
+
+    val contextualFqName = FqName("kotlinx.serialization.ContextualSerialization") // this one is deprecated
+    val contextualOnFileFqName = FqName("kotlinx.serialization.UseContextualSerialization")
+    val contextualOnPropertyFqName = FqName("kotlinx.serialization.Contextual")
+    val polymorphicFqName = FqName("kotlinx.serialization.Polymorphic")
+    val additionalSerializersFqName = FqName("kotlinx.serialization.UseSerializers")
+}
+
+object SerialEntityNames {
+    const val KSERIALIZER_CLASS = "KSerializer"
+    const val SERIAL_DESC_FIELD = "descriptor"
+    const val SAVE = "serialize"
+    const val LOAD = "deserialize"
+    const val SERIALIZER_CLASS = "\$serializer"
+
+    const val CACHED_DESCRIPTOR_FIELD = "\$cachedDescriptor"
+    const val CACHED_SERIALIZER_PROPERTY = "\$cachedSerializer"
+
+    // classes
+    val KCLASS_NAME_FQ = FqName("kotlin.reflect.KClass")
+    val KSERIALIZER_NAME = Name.identifier(KSERIALIZER_CLASS)
+    val SERIAL_CTOR_MARKER_NAME = Name.identifier("SerializationConstructorMarker")
+    val KSERIALIZER_NAME_FQ = SerializationPackages.packageFqName.child(KSERIALIZER_NAME)
+    val SERIALIZER_CLASS_NAME = Name.identifier(SERIALIZER_CLASS)
+    val IMPL_NAME = Name.identifier("Impl")
+
+    val GENERATED_SERIALIZER_CLASS = Name.identifier("GeneratedSerializer")
+    val GENERATED_SERIALIZER_FQ = SerializationPackages.internalPackageFqName.child(GENERATED_SERIALIZER_CLASS)
+
+    const val ENCODER_CLASS = "Encoder"
+    const val STRUCTURE_ENCODER_CLASS = "CompositeEncoder"
+    const val DECODER_CLASS = "Decoder"
+    const val STRUCTURE_DECODER_CLASS = "CompositeDecoder"
+
+    const val ANNOTATION_MARKER_CLASS = "SerializableWith"
+
+    const val SERIAL_SAVER_CLASS = "SerializationStrategy"
+    const val SERIAL_LOADER_CLASS = "DeserializationStrategy"
+
+    const val SERIAL_DESCRIPTOR_CLASS = "SerialDescriptor"
+    const val SERIAL_DESCRIPTOR_CLASS_IMPL = "PluginGeneratedSerialDescriptor"
+    const val SERIAL_DESCRIPTOR_FOR_ENUM = "EnumDescriptor"
+    const val SERIAL_DESCRIPTOR_FOR_INLINE = "InlineClassDescriptor"
+
+    const val PLUGIN_EXCEPTIONS_FILE = "PluginExceptions"
+    const val ENUMS_FILE = "Enums"
+
+    //exceptions
+    const val SERIAL_EXC = "SerializationException"
+    const val MISSING_FIELD_EXC = "MissingFieldException"
+    const val UNKNOWN_FIELD_EXC = "UnknownFieldException"
+
+    // functions
+    val SERIAL_DESC_FIELD_NAME = Name.identifier(SERIAL_DESC_FIELD)
+    val SAVE_NAME = Name.identifier(SAVE)
+    val LOAD_NAME = Name.identifier(LOAD)
+    val CHILD_SERIALIZERS_GETTER = Name.identifier("childSerializers")
+    val TYPE_PARAMS_SERIALIZERS_GETTER = Name.identifier("typeParametersSerializers")
+    val WRITE_SELF_NAME = Name.identifier("write\$Self")
+    val SERIALIZER_PROVIDER_NAME = Name.identifier("serializer")
+    val SINGLE_MASK_FIELD_MISSING_FUNC_NAME = Name.identifier("throwMissingFieldException")
+    val ARRAY_MASK_FIELD_MISSING_FUNC_NAME = Name.identifier("throwArrayMissingFieldException")
+    val ENUM_SERIALIZER_FACTORY_FUNC_NAME = Name.identifier("createSimpleEnumSerializer")
+    val MARKED_ENUM_SERIALIZER_FACTORY_FUNC_NAME = Name.identifier("createMarkedEnumSerializer")
+    val SINGLE_MASK_FIELD_MISSING_FUNC_FQ = SerializationPackages.internalPackageFqName.child(SINGLE_MASK_FIELD_MISSING_FUNC_NAME)
+    val ARRAY_MASK_FIELD_MISSING_FUNC_FQ = SerializationPackages.internalPackageFqName.child(ARRAY_MASK_FIELD_MISSING_FUNC_NAME)
+    val CACHED_SERIALIZER_PROPERTY_NAME = Name.identifier(CACHED_SERIALIZER_PROPERTY)
+    val CACHED_DESCRIPTOR_FIELD_NAME = Name.identifier(CACHED_DESCRIPTOR_FIELD)
+
+    val ENUM_SERIALIZER_FACTORY_FUNC_FQ = SerializationPackages.internalPackageFqName.child(ENUM_SERIALIZER_FACTORY_FUNC_NAME)
+    val MARKED_ENUM_SERIALIZER_FACTORY_FUNC_FQ = SerializationPackages.internalPackageFqName.child(MARKED_ENUM_SERIALIZER_FACTORY_FUNC_NAME)
+
+    // parameters
+    val dummyParamName = Name.identifier("serializationConstructorMarker")
+    const val typeArgPrefix = "typeSerial"
+
+    val wrapIntoNullableExt = SerializationPackages.builtinsPackageFqName.child(Name.identifier("nullable"))
+    val wrapIntoNullableCallableId = CallableId(SerializationPackages.builtinsPackageFqName, Name.identifier("nullable"))
+}
+
+object SpecialBuiltins {
+    const val referenceArraySerializer = "ReferenceArraySerializer"
+    const val objectSerializer = "ObjectSerializer"
+    const val enumSerializer = "EnumSerializer"
+    const val polymorphicSerializer = "PolymorphicSerializer"
+    const val sealedSerializer = "SealedClassSerializer"
+    const val contextSerializer = "ContextualSerializer"
+    const val nullableSerializer = "NullableSerializer"
+}
+
+object CallingConventions {
+    const val begin = "beginStructure"
+    const val end = "endStructure"
+
+    const val decode = "decode"
+    const val update = "update"
+    const val encode = "encode"
+    const val encodeEnum = "encodeEnum"
+    const val decodeEnum = "decodeEnum"
+    const val encodeInline = "encodeInline"
+    const val decodeInline = "decodeInline"
+    const val decodeElementIndex = "decodeElementIndex"
+    const val decodeSequentially = "decodeSequentially"
+    const val elementPostfix = "Element"
+    const val shouldEncodeDefault = "shouldEncodeElementDefault"
+
+    const val addElement = "addElement"
+    const val addAnnotation = "pushAnnotation"
+    const val addClassAnnotation = "pushClassAnnotation"
+}
+
+object SerializationDependencies {
+    val LAZY_FQ = FqName("kotlin.Lazy")
+    val LAZY_FUNC_FQ = FqName("kotlin.lazy")
+    val LAZY_MODE_FQ = FqName("kotlin.LazyThreadSafetyMode")
+    val FUNCTION0_FQ = FqName("kotlin.Function0")
+    val LAZY_PUBLICATION_MODE_NAME = Name.identifier("PUBLICATION")
+}