Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Hocon encoder implementation (#1740)
Use cases: - Generate default config. For now, it is possible only to provide default config files from resources. - Edit config from an app. This feature might be useful for apps having both text config and UI for configuration. Fixes #1609
- Loading branch information
Showing
12 changed files
with
552 additions
and
150 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
140 changes: 140 additions & 0 deletions
140
formats/hocon/src/main/kotlin/kotlinx/serialization/hocon/HoconEncoder.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /* | ||
| * Copyright 2017-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. | ||
| */ | ||
|
|
||
| package kotlinx.serialization.hocon | ||
|
|
||
| import com.typesafe.config.* | ||
| import kotlinx.serialization.* | ||
| import kotlinx.serialization.descriptors.* | ||
| import kotlinx.serialization.encoding.* | ||
| import kotlinx.serialization.internal.* | ||
| import kotlinx.serialization.modules.* | ||
|
|
||
| @ExperimentalSerializationApi | ||
| internal abstract class AbstractHoconEncoder( | ||
| private val hocon: Hocon, | ||
| private val valueConsumer: (ConfigValue) -> Unit, | ||
| ) : NamedValueEncoder() { | ||
|
|
||
| override val serializersModule: SerializersModule | ||
| get() = hocon.serializersModule | ||
|
|
||
| private var writeDiscriminator: Boolean = false | ||
|
|
||
| override fun elementName(descriptor: SerialDescriptor, index: Int): String { | ||
| return descriptor.getConventionElementName(index, hocon.useConfigNamingConvention) | ||
| } | ||
|
|
||
| override fun composeName(parentName: String, childName: String): String = childName | ||
|
|
||
| protected abstract fun encodeTaggedConfigValue(tag: String, value: ConfigValue) | ||
| protected abstract fun getCurrent(): ConfigValue | ||
|
|
||
| override fun encodeTaggedValue(tag: String, value: Any) = encodeTaggedConfigValue(tag, configValueOf(value)) | ||
| override fun encodeTaggedNull(tag: String) = encodeTaggedConfigValue(tag, configValueOf(null)) | ||
| override fun encodeTaggedChar(tag: String, value: Char) = encodeTaggedString(tag, value.toString()) | ||
|
|
||
| override fun encodeTaggedEnum(tag: String, enumDescriptor: SerialDescriptor, ordinal: Int) { | ||
| encodeTaggedString(tag, enumDescriptor.getElementName(ordinal)) | ||
| } | ||
|
|
||
| override fun shouldEncodeElementDefault(descriptor: SerialDescriptor, index: Int): Boolean = hocon.encodeDefaults | ||
|
|
||
| override fun <T> encodeSerializableValue(serializer: SerializationStrategy<T>, value: T) { | ||
| if (serializer !is AbstractPolymorphicSerializer<*> || hocon.useArrayPolymorphism) { | ||
| serializer.serialize(this, value) | ||
| return | ||
| } | ||
|
|
||
| @Suppress("UNCHECKED_CAST") | ||
| val casted = serializer as AbstractPolymorphicSerializer<Any> | ||
| val actualSerializer = casted.findPolymorphicSerializer(this, value as Any) | ||
| writeDiscriminator = true | ||
|
|
||
| actualSerializer.serialize(this, value) | ||
| } | ||
|
|
||
| override fun beginStructure(descriptor: SerialDescriptor): CompositeEncoder { | ||
| val consumer = | ||
| if (currentTagOrNull == null) valueConsumer | ||
| else { value -> encodeTaggedConfigValue(currentTag, value) } | ||
| val kind = descriptor.hoconKind(hocon.useArrayPolymorphism) | ||
|
|
||
| return when { | ||
| kind.listLike -> HoconConfigListEncoder(hocon, consumer) | ||
| kind.objLike -> HoconConfigEncoder(hocon, consumer) | ||
| kind == StructureKind.MAP -> HoconConfigMapEncoder(hocon, consumer) | ||
| else -> this | ||
| }.also { encoder -> | ||
| if (writeDiscriminator) { | ||
| encoder.encodeTaggedString(hocon.classDiscriminator, descriptor.serialName) | ||
| writeDiscriminator = false | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override fun endEncode(descriptor: SerialDescriptor) { | ||
| valueConsumer(getCurrent()) | ||
| } | ||
|
|
||
| private fun configValueOf(value: Any?) = ConfigValueFactory.fromAnyRef(value) | ||
| } | ||
|
|
||
| @ExperimentalSerializationApi | ||
| internal class HoconConfigEncoder(hocon: Hocon, configConsumer: (ConfigValue) -> Unit) : | ||
| AbstractHoconEncoder(hocon, configConsumer) { | ||
|
|
||
| private val configMap = mutableMapOf<String, ConfigValue>() | ||
|
|
||
| override fun encodeTaggedConfigValue(tag: String, value: ConfigValue) { | ||
| configMap[tag] = value | ||
| } | ||
|
|
||
| override fun getCurrent(): ConfigValue = ConfigValueFactory.fromMap(configMap) | ||
| } | ||
|
|
||
| @ExperimentalSerializationApi | ||
| internal class HoconConfigListEncoder(hocon: Hocon, configConsumer: (ConfigValue) -> Unit) : | ||
| AbstractHoconEncoder(hocon, configConsumer) { | ||
|
|
||
| private val values = mutableListOf<ConfigValue>() | ||
|
|
||
| override fun elementName(descriptor: SerialDescriptor, index: Int): String = index.toString() | ||
|
|
||
| override fun encodeTaggedConfigValue(tag: String, value: ConfigValue) { | ||
| values.add(tag.toInt(), value) | ||
| } | ||
|
|
||
| override fun getCurrent(): ConfigValue = ConfigValueFactory.fromIterable(values) | ||
| } | ||
|
|
||
| @ExperimentalSerializationApi | ||
| internal class HoconConfigMapEncoder(hocon: Hocon, configConsumer: (ConfigValue) -> Unit) : | ||
| AbstractHoconEncoder(hocon, configConsumer) { | ||
|
|
||
| private val configMap = mutableMapOf<String, ConfigValue>() | ||
|
|
||
| private lateinit var key: String | ||
| private var isKey: Boolean = true | ||
|
|
||
| override fun encodeTaggedConfigValue(tag: String, value: ConfigValue) { | ||
| if (isKey) { | ||
| key = when (value.valueType()) { | ||
| ConfigValueType.OBJECT, ConfigValueType.LIST -> throw InvalidKeyKindException(value) | ||
| else -> value.unwrappedNullable().toString() | ||
| } | ||
| isKey = false | ||
| } else { | ||
| configMap[key] = value | ||
| isKey = true | ||
| } | ||
| } | ||
|
|
||
| override fun getCurrent(): ConfigValue = ConfigValueFactory.fromMap(configMap) | ||
|
|
||
| // Without cast to `Any?` Kotlin will assume unwrapped value as non-nullable by default | ||
| // and will call `Any.toString()` instead of extension-function `Any?.toString()`. | ||
| // We can't cast value in place using `(value.unwrapped() as Any?).toString()` because of warning "No cast needed". | ||
| private fun ConfigValue.unwrappedNullable(): Any? = unwrapped() | ||
| } |
22 changes: 22 additions & 0 deletions
22
formats/hocon/src/main/kotlin/kotlinx/serialization/hocon/HoconExceptions.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| /* | ||
| * Copyright 2017-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. | ||
| */ | ||
|
|
||
| package kotlinx.serialization.hocon | ||
|
|
||
| import com.typesafe.config.* | ||
| import kotlinx.serialization.* | ||
|
|
||
| internal fun SerializerNotFoundException(type: String?) = SerializationException( | ||
| "Polymorphic serializer was not found for " + | ||
| if (type == null) "missing class discriminator ('null')" else "class discriminator '$type'" | ||
| ) | ||
|
|
||
| internal inline fun <reified T> ConfigValueTypeCastException(valueOrigin: ConfigOrigin) = SerializationException( | ||
| "${valueOrigin.description()} required to be of type ${T::class.simpleName}." | ||
| ) | ||
|
|
||
| internal fun InvalidKeyKindException(value: ConfigValue) = SerializationException( | ||
| "Value of type '${value.valueType()}' can't be used in HOCON as a key in the map. " + | ||
| "It should have either primitive or enum kind." | ||
| ) |
Oops, something went wrong.