1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
/*
* Copyright 2017-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package kotlinx.serialization
import kotlinx.serialization.modules.EmptyModule
import kotlinx.serialization.modules.SerialModule
abstract class TaggedEncoder<Tag : Any?> : Encoder, CompositeEncoder {
/**
* Provides a tag object for given serial descriptor and index.
* Tag object allows to associate given user information with particular element of composite serializable entity..
*/
protected abstract fun SerialDescriptor.getTag(index: Int): Tag
override val context: SerialModule
get() = EmptyModule
// ---- API ----
open fun encodeTaggedValue(tag: Tag, value: Any): Unit
= throw SerializationException("Non-serializable ${value::class} is not supported by ${this::class} encoder")
open fun encodeTaggedNotNullMark(tag: Tag) {}
open fun encodeTaggedNull(tag: Tag): Unit = throw SerializationException("null is not supported")
open fun encodeTaggedUnit(tag: Tag) = encodeTaggedValue(tag, Unit)
open fun encodeTaggedInt(tag: Tag, value: Int) = encodeTaggedValue(tag, value)
open fun encodeTaggedByte(tag: Tag, value: Byte) = encodeTaggedValue(tag, value)
open fun encodeTaggedShort(tag: Tag, value: Short) = encodeTaggedValue(tag, value)
open fun encodeTaggedLong(tag: Tag, value: Long) = encodeTaggedValue(tag, value)
open fun encodeTaggedFloat(tag: Tag, value: Float) = encodeTaggedValue(tag, value)
open fun encodeTaggedDouble(tag: Tag, value: Double) = encodeTaggedValue(tag, value)
open fun encodeTaggedBoolean(tag: Tag, value: Boolean) = encodeTaggedValue(tag, value)
open fun encodeTaggedChar(tag: Tag, value: Char) = encodeTaggedValue(tag, value)
open fun encodeTaggedString(tag: Tag, value: String) = encodeTaggedValue(tag, value)
open fun encodeTaggedEnum(
tag: Tag,
enumDescription: SerialDescriptor,
ordinal: Int
) = encodeTaggedValue(tag, ordinal)
// ---- Implementation of low-level API ----
fun encodeElement(desc: SerialDescriptor, index: Int): Boolean {
val tag = desc.getTag(index)
val shouldWriteElement = shouldWriteElement(desc, tag, index)
if (shouldWriteElement) {
pushTag(tag)
}
return shouldWriteElement
}
// For format-specific behaviour, invoked only on
open fun shouldWriteElement(desc: SerialDescriptor, tag: Tag, index: Int) = true
final override fun encodeNotNullMark() = encodeTaggedNotNullMark(currentTag)
final override fun encodeNull() = encodeTaggedNull(popTag())
final override fun encodeUnit() = encodeTaggedUnit(popTag())
final override fun encodeBoolean(value: Boolean) = encodeTaggedBoolean(popTag(), value)
final override fun encodeByte(value: Byte) = encodeTaggedByte(popTag(), value)
final override fun encodeShort(value: Short) = encodeTaggedShort(popTag(), value)
final override fun encodeInt(value: Int) = encodeTaggedInt(popTag(), value)
final override fun encodeLong(value: Long) = encodeTaggedLong(popTag(), value)
final override fun encodeFloat(value: Float) = encodeTaggedFloat(popTag(), value)
final override fun encodeDouble(value: Double) = encodeTaggedDouble(popTag(), value)
final override fun encodeChar(value: Char) = encodeTaggedChar(popTag(), value)
final override fun encodeString(value: String) = encodeTaggedString(popTag(), value)
final override fun encodeEnum(
enumDescriptor: SerialDescriptor,
index: Int
) = encodeTaggedEnum(popTag(), enumDescriptor, index)
override fun beginStructure(descriptor: SerialDescriptor, vararg typeSerializers: KSerializer<*>): CompositeEncoder {
return this
}
final override fun endStructure(descriptor: SerialDescriptor) {
if (tagStack.isNotEmpty()) popTag(); endEncode(descriptor)
}
/**
* Format-specific replacement for [endStructure], because latter is overridden to manipulate tag stack.
*/
open fun endEncode(desc: SerialDescriptor) {}
final override fun encodeNonSerializableElement(descriptor: SerialDescriptor, index: Int, value: Any) = encodeTaggedValue(descriptor.getTag(index), value)
final override fun encodeUnitElement(descriptor: SerialDescriptor, index: Int) = encodeTaggedUnit(descriptor.getTag(index))
final override fun encodeBooleanElement(descriptor: SerialDescriptor, index: Int, value: Boolean) = encodeTaggedBoolean(descriptor.getTag(index), value)
final override fun encodeByteElement(descriptor: SerialDescriptor, index: Int, value: Byte) = encodeTaggedByte(descriptor.getTag(index), value)
final override fun encodeShortElement(descriptor: SerialDescriptor, index: Int, value: Short) = encodeTaggedShort(descriptor.getTag(index), value)
final override fun encodeIntElement(descriptor: SerialDescriptor, index: Int, value: Int) = encodeTaggedInt(descriptor.getTag(index), value)
final override fun encodeLongElement(descriptor: SerialDescriptor, index: Int, value: Long) = encodeTaggedLong(descriptor.getTag(index), value)
final override fun encodeFloatElement(descriptor: SerialDescriptor, index: Int, value: Float) = encodeTaggedFloat(descriptor.getTag(index), value)
final override fun encodeDoubleElement(descriptor: SerialDescriptor, index: Int, value: Double) = encodeTaggedDouble(descriptor.getTag(index), value)
final override fun encodeCharElement(descriptor: SerialDescriptor, index: Int, value: Char) = encodeTaggedChar(descriptor.getTag(index), value)
final override fun encodeStringElement(descriptor: SerialDescriptor, index: Int, value: String) = encodeTaggedString(descriptor.getTag(index), value)
final override fun <T : Any?> encodeSerializableElement(desc: SerialDescriptor, index: Int, serializer: SerializationStrategy<T>, value: T) {
if (encodeElement(desc, index))
encodeSerializableValue(serializer, value)
}
final override fun <T : Any> encodeNullableSerializableElement(desc: SerialDescriptor, index: Int, serializer: SerializationStrategy<T>, value: T?) {
if (encodeElement(desc, index))
encodeNullableSerializableValue(serializer, value)
}
private val tagStack = arrayListOf<Tag>()
protected val currentTag: Tag
get() = tagStack.last()
protected val currentTagOrNull
get() = tagStack.lastOrNull()
protected fun pushTag(name: Tag) {
tagStack.add(name)
}
protected fun popTag() =
if (tagStack.isNotEmpty())
tagStack.removeAt(tagStack.lastIndex)
else
throw SerializationException("No tag in stack for requested element")
}
abstract class NamedValueEncoder(val rootName: String = "") : TaggedEncoder<String>() {
final override fun SerialDescriptor.getTag(index: Int): String = nested(elementName(this, index))
protected fun nested(nestedName: String) = composeName(currentTagOrNull ?: rootName, nestedName)
open fun elementName(desc: SerialDescriptor, index: Int) = desc.getElementName(index)
open fun composeName(parentName: String, childName: String) = if (parentName.isEmpty()) childName else "$parentName.$childName"
}
abstract class TaggedDecoder<Tag : Any?> : Decoder, CompositeDecoder {
override val context: SerialModule
get() = EmptyModule
override val updateMode: UpdateMode = UpdateMode.UPDATE
protected abstract fun SerialDescriptor.getTag(index: Int): Tag
// ---- API ----
open fun decodeTaggedValue(tag: Tag): Any
= throw SerializationException("${this::class} can't retrieve untyped values")
open fun decodeTaggedNotNullMark(tag: Tag): Boolean = true
open fun decodeTaggedNull(tag: Tag): Nothing? = null
open fun decodeTaggedUnit(tag: Tag): Unit = decodeTaggedValue(tag) as Unit
open fun decodeTaggedBoolean(tag: Tag): Boolean = decodeTaggedValue(tag) as Boolean
open fun decodeTaggedByte(tag: Tag): Byte = decodeTaggedValue(tag) as Byte
open fun decodeTaggedShort(tag: Tag): Short = decodeTaggedValue(tag) as Short
open fun decodeTaggedInt(tag: Tag): Int = decodeTaggedValue(tag) as Int
open fun decodeTaggedLong(tag: Tag): Long = decodeTaggedValue(tag) as Long
open fun decodeTaggedFloat(tag: Tag): Float = decodeTaggedValue(tag) as Float
open fun decodeTaggedDouble(tag: Tag): Double = decodeTaggedValue(tag) as Double
open fun decodeTaggedChar(tag: Tag): Char = decodeTaggedValue(tag) as Char
open fun decodeTaggedString(tag: Tag): String = decodeTaggedValue(tag) as String
open fun decodeTaggedEnum(tag: Tag, enumDescription: SerialDescriptor): Int = decodeTaggedValue(tag) as Int
// ---- Implementation of low-level API ----
final override fun decodeNotNullMark(): Boolean = decodeTaggedNotNullMark(currentTag)
final override fun decodeNull(): Nothing? = null
final override fun decodeUnit() = decodeTaggedUnit(popTag())
final override fun decodeBoolean(): Boolean = decodeTaggedBoolean(popTag())
final override fun decodeByte(): Byte = decodeTaggedByte(popTag())
final override fun decodeShort(): Short = decodeTaggedShort(popTag())
final override fun decodeInt(): Int = decodeTaggedInt(popTag())
final override fun decodeLong(): Long = decodeTaggedLong(popTag())
final override fun decodeFloat(): Float = decodeTaggedFloat(popTag())
final override fun decodeDouble(): Double = decodeTaggedDouble(popTag())
final override fun decodeChar(): Char = decodeTaggedChar(popTag())
final override fun decodeString(): String = decodeTaggedString(popTag())
final override fun decodeEnum(enumDescriptor: SerialDescriptor): Int = decodeTaggedEnum(popTag(), enumDescriptor)
override fun beginStructure(desc: SerialDescriptor, vararg typeParams: KSerializer<*>): CompositeDecoder {
return this
}
final override fun decodeUnitElement(desc: SerialDescriptor, index: Int) = decodeTaggedUnit(desc.getTag(index))
final override fun decodeBooleanElement(descriptor: SerialDescriptor, index: Int): Boolean = decodeTaggedBoolean(descriptor.getTag(index))
final override fun decodeByteElement(descriptor: SerialDescriptor, index: Int): Byte = decodeTaggedByte(descriptor.getTag(index))
final override fun decodeShortElement(descriptor: SerialDescriptor, index: Int): Short = decodeTaggedShort(descriptor.getTag(index))
final override fun decodeIntElement(desc: SerialDescriptor, index: Int): Int = decodeTaggedInt(desc.getTag(index))
final override fun decodeLongElement(descriptor: SerialDescriptor, index: Int): Long = decodeTaggedLong(descriptor.getTag(index))
final override fun decodeFloatElement(descriptor: SerialDescriptor, index: Int): Float = decodeTaggedFloat(descriptor.getTag(index))
final override fun decodeDoubleElement(desc: SerialDescriptor, index: Int): Double = decodeTaggedDouble(desc.getTag(index))
final override fun decodeCharElement(descriptor: SerialDescriptor, index: Int): Char = decodeTaggedChar(descriptor.getTag(index))
final override fun decodeStringElement(descriptor: SerialDescriptor, index: Int): String = decodeTaggedString(descriptor.getTag(index))
final override fun <T : Any?> decodeSerializableElement(desc: SerialDescriptor, index: Int, deserializer: DeserializationStrategy<T>): T =
tagBlock(desc.getTag(index)) { decodeSerializableValue(deserializer) }
final override fun <T : Any> decodeNullableSerializableElement(desc: SerialDescriptor, index: Int, deserializer: DeserializationStrategy<T?>): T? =
tagBlock(desc.getTag(index)) { decodeNullableSerializableValue(deserializer) }
override fun <T> updateSerializableElement(desc: SerialDescriptor, index: Int, deserializer: DeserializationStrategy<T>, old: T): T =
tagBlock(desc.getTag(index)) { updateSerializableValue(deserializer, old) }
override fun <T : Any> updateNullableSerializableElement(desc: SerialDescriptor, index: Int, deserializer: DeserializationStrategy<T?>, old: T?): T? =
tagBlock(desc.getTag(index)) { updateNullableSerializableValue(deserializer, old) }
private fun <E> tagBlock(tag: Tag, block: () -> E): E {
pushTag(tag)
val r = block()
if (!flag) {
popTag()
}
flag = false
return r
}
private val tagStack = arrayListOf<Tag>()
protected val currentTag: Tag
get() = tagStack.last()
protected val currentTagOrNull
get() = tagStack.lastOrNull()
protected fun pushTag(name: Tag) {
tagStack.add(name)
}
protected fun copyTagsTo(other: TaggedDecoder<Tag>) {
other.tagStack.addAll(tagStack)
}
private var flag = false
protected fun popTag(): Tag {
val r = tagStack.removeAt(tagStack.lastIndex)
flag = true
return r
}
}
abstract class NamedValueDecoder(val rootName: String = "") : TaggedDecoder<String>() {
final override fun SerialDescriptor.getTag(index: Int): String = nested(elementName(this, index))
protected fun nested(nestedName: String) = composeName(currentTagOrNull ?: rootName, nestedName)
open fun elementName(desc: SerialDescriptor, index: Int) = desc.getElementName(index)
open fun composeName(parentName: String, childName: String) = if (parentName.isEmpty()) childName else "$parentName.$childName"
}
|
