Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for external property getter #1260

Merged
merged 1 commit into from Jun 10, 2022
Merged

Add support for external property getter #1260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 7 additions & 2 deletions kotlinpoet/src/main/java/com/squareup/kotlinpoet/FunSpec.kt
View file
Open in desktop
Expand Up @@ -55,13 +55,18 @@ public class FunSpec private constructor(
public val delegateConstructorArguments: List<CodeBlock> =
builder.delegateConstructorArguments.toImmutableList()
public val body: CodeBlock = builder.body.build()
private val isExternalGetter = name == GETTER && builder.modifiers.contains(EXTERNAL)
private val isEmptySetter = name == SETTER && parameters.isEmpty()

init {
require(body.isEmpty() || !builder.modifiers.containsAnyOf(ABSTRACT, EXPECT)) {
"abstract or expect function ${builder.name} cannot have code"
}
if (name == SETTER) {
if (name == GETTER) {
require(!isExternalGetter || body.isEmpty()) {
"external getter cannot have code"
}
} else if (name == SETTER) {
require(parameters.size <= 1) {
"$name can have at most one parameter"
}
Expand Down Expand Up @@ -155,7 +160,7 @@ public class FunSpec private constructor(
codeWriter.emitCode("%N", this)
}

if (!isEmptySetter) {
if (!isEmptySetter && !isExternalGetter) {
parameters.emit(codeWriter) { param ->
param.emit(codeWriter, includeType = name != SETTER)
}
Expand Down
38 changes: 38 additions & 0 deletions kotlinpoet/src/test/java/com/squareup/kotlinpoet/PropertySpecTest.kt
View file
Open in desktop
Expand Up @@ -18,6 +18,7 @@ package com.squareup.kotlinpoet
import com.google.common.truth.Truth.assertThat
import com.squareup.kotlinpoet.FunSpec.Companion.GETTER
import com.squareup.kotlinpoet.FunSpec.Companion.SETTER
import com.squareup.kotlinpoet.KModifier.EXTERNAL
import com.squareup.kotlinpoet.KModifier.PRIVATE
import com.squareup.kotlinpoet.ParameterizedTypeName.Companion.parameterizedBy
import java.io.Serializable
Expand Down Expand Up @@ -74,6 +75,43 @@ class PropertySpecTest {
}.hasMessageThat().isEqualTo("parameterless setter cannot have code")
}

@Test fun externalGetterAndSetter() {
val prop = PropertySpec.builder("foo", String::class)
.mutable()
.getter(
FunSpec.getterBuilder()
.addModifiers(EXTERNAL)
.build()
)
.setter(
FunSpec.setterBuilder()
.addModifiers(EXTERNAL)
.build()
)
.build()

assertThat(prop.toString()).isEqualTo(
"""
|var foo: kotlin.String
| external get
| external set
|""".trimMargin()
)
}

@Test fun externalGetterCannotHaveBody() {
assertThrows<IllegalArgumentException> {
PropertySpec.builder("foo", String::class)
.getter(
FunSpec.getterBuilder()
.addModifiers(EXTERNAL)
.addStatement("return %S", "foo")
.build()
)
.build()
}.hasMessageThat().isEqualTo("external getter cannot have code")
}

@Test fun inlineSingleAccessorVal() {
val prop = PropertySpec.builder("foo", String::class)
.getter(
Expand Down