/
PropertySpec.kt
351 lines (309 loc) · 12.4 KB
/
PropertySpec.kt
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
/*
* Copyright (C) 2015 Square, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.squareup.kotlinpoet
import com.squareup.kotlinpoet.FunSpec.Companion.GETTER
import com.squareup.kotlinpoet.FunSpec.Companion.SETTER
import com.squareup.kotlinpoet.KModifier.Target.PROPERTY
import java.lang.reflect.Type
import java.util.EnumSet
import javax.lang.model.element.Element
import kotlin.reflect.KClass
/** A generated property declaration. */
@OptIn(ExperimentalKotlinPoetApi::class)
public class PropertySpec private constructor(
builder: Builder,
private val tagMap: TagMap = builder.buildTagMap(),
private val delegateOriginatingElementsHolder: OriginatingElementsHolder = builder.buildOriginatingElements()
) : Taggable by tagMap, OriginatingElementsHolder by delegateOriginatingElementsHolder {
public val mutable: Boolean = builder.mutable
public val name: String = builder.name
public val type: TypeName = builder.type
public val kdoc: CodeBlock = builder.kdoc.build()
public val annotations: List<AnnotationSpec> = builder.annotations.toImmutableList()
public val modifiers: Set<KModifier> = builder.modifiers.toImmutableSet()
public val typeVariables: List<TypeVariableName> = builder.typeVariables.toImmutableList()
public val initializer: CodeBlock? = builder.initializer
public val delegated: Boolean = builder.delegated
public val getter: FunSpec? = builder.getter
public val setter: FunSpec? = builder.setter
public val receiverType: TypeName? = builder.receiverType
@ExperimentalKotlinPoetApi
public val contextReceiverTypes: List<TypeName> = builder.contextReceiverTypes.toImmutableList()
init {
require(
typeVariables.none { it.isReified } ||
(getter != null || setter != null) &&
(getter == null || KModifier.INLINE in getter.modifiers) &&
(setter == null || KModifier.INLINE in setter.modifiers)
) {
"only type parameters of properties with inline getters and/or setters can be reified!"
}
require(mutable || setter == null) {
"only a mutable property can have a setter"
}
if (contextReceiverTypes.isNotEmpty()) {
requireNotNull(getter) { "properties with context receivers require a $GETTER" }
if (mutable) {
requireNotNull(setter) { "mutable properties with context receivers require a $SETTER" }
}
}
}
internal fun emit(
codeWriter: CodeWriter,
implicitModifiers: Set<KModifier>,
withInitializer: Boolean = true,
emitKdoc: Boolean = true,
inline: Boolean = false,
inlineAnnotations: Boolean = inline
) {
val isInlineProperty = getter?.modifiers?.contains(KModifier.INLINE) ?: false &&
(!mutable || setter?.modifiers?.contains(KModifier.INLINE) ?: false)
val propertyModifiers = if (isInlineProperty) modifiers + KModifier.INLINE else modifiers
if (emitKdoc) {
codeWriter.emitKdoc(kdoc.ensureEndsWithNewLine())
}
codeWriter.emitContextReceivers(contextReceiverTypes, suffix = "\n")
codeWriter.emitAnnotations(annotations, inlineAnnotations)
codeWriter.emitModifiers(propertyModifiers, implicitModifiers)
codeWriter.emitCode(if (mutable) "var·" else "val·")
if (typeVariables.isNotEmpty()) {
codeWriter.emitTypeVariables(typeVariables)
codeWriter.emit(" ")
}
if (receiverType != null) {
if (receiverType is LambdaTypeName) {
codeWriter.emitCode("(%T).", receiverType)
} else {
codeWriter.emitCode("%T.", receiverType)
}
}
codeWriter.emitCode("%N: %T", this, type)
if (withInitializer && initializer != null) {
if (delegated) {
codeWriter.emit(" by ")
} else {
codeWriter.emitCode(" = ")
}
val initializerFormat = if (initializer.hasStatements()) "%L" else "«%L»"
codeWriter.emitCode(
codeBlock = CodeBlock.of(initializerFormat, initializer),
isConstantContext = KModifier.CONST in modifiers
)
}
codeWriter.emitWhereBlock(typeVariables)
if (!inline) codeWriter.emit("\n")
val implicitAccessorModifiers = EnumSet.noneOf(KModifier::class.java)
for (modifier in implicitModifiers) {
// Omit visibility modifiers, accessor visibility will default to the property's visibility.
if (modifier !in VISIBILITY_MODIFIERS) {
implicitAccessorModifiers.add(modifier)
}
}
if (isInlineProperty) {
implicitAccessorModifiers.add(KModifier.INLINE)
}
if (getter != null) {
codeWriter.emitCode("⇥")
getter.emit(codeWriter, null, implicitAccessorModifiers, false)
codeWriter.emitCode("⇤")
}
if (setter != null) {
codeWriter.emitCode("⇥")
setter.emit(codeWriter, null, implicitAccessorModifiers, false)
codeWriter.emitCode("⇤")
}
}
internal fun fromPrimaryConstructorParameter(parameter: ParameterSpec): PropertySpec {
val builder = toBuilder()
.addAnnotations(parameter.annotations)
builder.isPrimaryConstructorParameter = true
builder.modifiers += parameter.modifiers
if (builder.kdoc.isEmpty()) {
builder.addKdoc(parameter.kdoc)
}
return builder.build()
}
override fun equals(other: Any?): Boolean {
if (this === other) return true
if (other == null) return false
if (javaClass != other.javaClass) return false
return toString() == other.toString()
}
override fun hashCode(): Int = toString().hashCode()
override fun toString(): String = buildCodeString { emit(this, emptySet()) }
@JvmOverloads
public fun toBuilder(name: String = this.name, type: TypeName = this.type): Builder {
val builder = Builder(name, type)
builder.mutable = mutable
builder.kdoc.add(kdoc)
builder.annotations += annotations
builder.modifiers += modifiers
builder.typeVariables += typeVariables
builder.initializer = initializer
builder.delegated = delegated
builder.setter = setter
builder.getter = getter
builder.receiverType = receiverType
builder.tags += tagMap.tags
builder.originatingElements += originatingElements
return builder
}
public class Builder internal constructor(
internal val name: String,
internal val type: TypeName
) : Taggable.Builder<Builder>,
OriginatingElementsHolder.Builder<Builder> {
internal var isPrimaryConstructorParameter = false
internal var mutable = false
internal val kdoc = CodeBlock.builder()
internal var initializer: CodeBlock? = null
internal var delegated = false
internal var getter: FunSpec? = null
internal var setter: FunSpec? = null
internal var receiverType: TypeName? = null
internal val contextReceiverTypes: MutableList<TypeName> = mutableListOf()
public val annotations: MutableList<AnnotationSpec> = mutableListOf()
public val modifiers: MutableList<KModifier> = mutableListOf()
public val typeVariables: MutableList<TypeVariableName> = mutableListOf()
override val tags: MutableMap<KClass<*>, Any> = mutableMapOf()
override val originatingElements: MutableList<Element> = mutableListOf()
/** True to create a `var` instead of a `val`. */
public fun mutable(mutable: Boolean = true): Builder = apply {
this.mutable = mutable
}
public fun addKdoc(format: String, vararg args: Any): Builder = apply {
kdoc.add(format, *args)
}
public fun addKdoc(block: CodeBlock): Builder = apply {
kdoc.add(block)
}
public fun addAnnotations(annotationSpecs: Iterable<AnnotationSpec>): Builder = apply {
annotations += annotationSpecs
}
public fun addAnnotation(annotationSpec: AnnotationSpec): Builder = apply {
annotations += annotationSpec
}
public fun addAnnotation(annotation: ClassName): Builder = apply {
annotations += AnnotationSpec.builder(annotation).build()
}
@DelicateKotlinPoetApi(
message = "Java reflection APIs don't give complete information on Kotlin types. Consider " +
"using the kotlinpoet-metadata APIs instead."
)
public fun addAnnotation(annotation: Class<*>): Builder =
addAnnotation(annotation.asClassName())
public fun addAnnotation(annotation: KClass<*>): Builder =
addAnnotation(annotation.asClassName())
public fun addModifiers(vararg modifiers: KModifier): Builder = apply {
this.modifiers += modifiers
}
public fun addModifiers(modifiers: Iterable<KModifier>): Builder = apply {
this.modifiers += modifiers
}
public fun addTypeVariables(typeVariables: Iterable<TypeVariableName>): Builder = apply {
this.typeVariables += typeVariables
}
public fun addTypeVariable(typeVariable: TypeVariableName): Builder = apply {
typeVariables += typeVariable
}
public fun initializer(format: String, vararg args: Any?): Builder =
initializer(CodeBlock.of(format, *args))
public fun initializer(codeBlock: CodeBlock?): Builder = apply {
this.initializer = codeBlock
this.delegated = false
}
public fun delegate(format: String, vararg args: Any?): Builder =
delegate(CodeBlock.of(format, *args))
public fun delegate(codeBlock: CodeBlock): Builder = apply {
this.initializer = codeBlock
this.delegated = true
}
public fun getter(getter: FunSpec?): Builder = apply {
require(getter == null || getter.name == GETTER) { "${getter!!.name} is not a getter" }
this.getter = getter
}
public fun setter(setter: FunSpec?): Builder = apply {
require(setter == null || setter.name == SETTER) { "${setter!!.name} is not a setter" }
this.setter = setter
}
public fun receiver(receiverType: TypeName?): Builder = apply {
this.receiverType = receiverType
}
@DelicateKotlinPoetApi(
message = "Java reflection APIs don't give complete information on Kotlin types. Consider " +
"using the kotlinpoet-metadata APIs instead."
)
public fun receiver(receiverType: Type): Builder = receiver(receiverType.asTypeName())
public fun receiver(receiverType: KClass<*>): Builder = receiver(receiverType.asTypeName())
@ExperimentalKotlinPoetApi
public fun contextReceivers(receiverTypes: Iterable<TypeName>): Builder = apply {
contextReceiverTypes += receiverTypes
}
@ExperimentalKotlinPoetApi
public fun contextReceivers(vararg receiverType: TypeName): Builder =
contextReceivers(receiverType.toList())
public fun build(): PropertySpec {
if (KModifier.INLINE in modifiers) {
throw IllegalArgumentException(
"KotlinPoet doesn't allow setting the inline modifier on " +
"properties. You should mark either the getter, the setter, or both inline."
)
}
for (it in modifiers) {
if (!isPrimaryConstructorParameter) it.checkTarget(PROPERTY)
}
return PropertySpec(this)
}
}
public companion object {
@JvmStatic public fun builder(
name: String,
type: TypeName,
vararg modifiers: KModifier
): Builder {
return Builder(name, type).addModifiers(*modifiers)
}
@JvmStatic public fun builder(name: String, type: Type, vararg modifiers: KModifier): Builder =
builder(name, type.asTypeName(), *modifiers)
@JvmStatic public fun builder(
name: String,
type: KClass<*>,
vararg modifiers: KModifier
): Builder = builder(name, type.asTypeName(), *modifiers)
@JvmStatic public fun builder(
name: String,
type: TypeName,
modifiers: Iterable<KModifier>
): Builder {
return Builder(name, type).addModifiers(modifiers)
}
@DelicateKotlinPoetApi(
message = "Java reflection APIs don't give complete information on Kotlin types. Consider " +
"using the kotlinpoet-metadata APIs instead."
)
@JvmStatic
public fun builder(
name: String,
type: Type,
modifiers: Iterable<KModifier>
): Builder = builder(name, type.asTypeName(), modifiers)
@JvmStatic public fun builder(
name: String,
type: KClass<*>,
modifiers: Iterable<KModifier>
): Builder = builder(name, type.asTypeName(), modifiers)
}
}