Skip to content

Commit

Permalink
Escape soft and modifier keywords
Browse files Browse the repository at this point in the history
  • Loading branch information
@Egorand
Egorand committed Oct 8, 2020
1 parent 1327e1f commit 564dd59
Show file tree
Hide file tree
Showing 9 changed files with 111 additions and 61 deletions.
40 changes: 20 additions & 20 deletions ...rc/test/kotlin/com/squareup/kotlinpoet/metadata/specs/test/KotlinPoetMetadataSpecsTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -290,10 +290,10 @@ class KotlinPoetMetadataSpecsTest : MultiClassInspectorTest() {
public inline fun hasDefault(param1: kotlin.String = throw NotImplementedError("Stub!")): kotlin.Unit {
}
public inline fun inline(crossinline param1: () -> kotlin.String): kotlin.Unit {
public inline fun `inline`(crossinline param1: () -> kotlin.String): kotlin.Unit {
}
public inline fun noinline(noinline param1: () -> kotlin.String): kotlin.String {
public inline fun `noinline`(noinline param1: () -> kotlin.String): kotlin.String {
throw NotImplementedError("Stub!")
}
}
Expand Down Expand Up @@ -382,7 +382,7 @@ class KotlinPoetMetadataSpecsTest : MultiClassInspectorTest() {
assertThat(typeSpec.trimmedToString()).isEqualTo(
"""
public class FunctionsReferencingTypeParameters<T> {
public fun test(param: T): kotlin.Unit {
public fun test(`param`: T): kotlin.Unit {
}
}
""".trimIndent()
Expand Down Expand Up @@ -830,19 +830,19 @@ class KotlinPoetMetadataSpecsTest : MultiClassInspectorTest() {
assertThat(typeSpec.trimmedToString()).isEqualTo(
"""
public class GenericClass<T> {
public fun <T> functionAlsoWithT(param: T): kotlin.Unit {
public fun <T> functionAlsoWithT(`param`: T): kotlin.Unit {
}
public fun <R> functionWithADifferentType(param: R): kotlin.Unit {
public fun <R> functionWithADifferentType(`param`: R): kotlin.Unit {
}
public fun functionWithT(param: T): kotlin.Unit {
public fun functionWithT(`param`: T): kotlin.Unit {
}
/**
* Note: Since this is a synthetic function, some JVM information (annotations, modifiers) may be missing.
*/
public inline fun <reified T> reified(param: T): kotlin.Unit {
public inline fun <reified T> `reified`(`param`: T): kotlin.Unit {
}
}
""".trimIndent()
Expand Down Expand Up @@ -900,7 +900,7 @@ class KotlinPoetMetadataSpecsTest : MultiClassInspectorTest() {
"""
public class AnnotationHolders @com.squareup.kotlinpoet.metadata.specs.test.KotlinPoetMetadataSpecsTest.ConstructorAnnotation constructor() {
@field:com.squareup.kotlinpoet.metadata.specs.test.KotlinPoetMetadataSpecsTest.FieldAnnotation
public var field: kotlin.String? = null
public var `field`: kotlin.String? = null
@get:com.squareup.kotlinpoet.metadata.specs.test.KotlinPoetMetadataSpecsTest.GetterAnnotation
public var getter: kotlin.String? = null
Expand Down Expand Up @@ -972,7 +972,7 @@ class KotlinPoetMetadataSpecsTest : MultiClassInspectorTest() {
assertThat(typeSpec.trimmedToString()).isEqualTo(
"""
public class Constants(
public val param: kotlin.String = throw NotImplementedError("Stub!")
public val `param`: kotlin.String = throw NotImplementedError("Stub!")
) {
public val binaryProp: kotlin.Int = throw NotImplementedError("Stub!")
Expand Down Expand Up @@ -1065,7 +1065,7 @@ class KotlinPoetMetadataSpecsTest : MultiClassInspectorTest() {
assertThat(typeSpec.trimmedToString()).isEqualTo(
"""
public class Constants(
public val param: kotlin.String = throw NotImplementedError("Stub!")
public val `param`: kotlin.String = throw NotImplementedError("Stub!")
) {
public val binaryProp: kotlin.Int = throw NotImplementedError("Stub!")
Expand Down Expand Up @@ -1278,7 +1278,7 @@ class KotlinPoetMetadataSpecsTest : MultiClassInspectorTest() {
"""
public class JvmNameData(
@get:kotlin.jvm.JvmName(name = "jvmParam")
public val param: kotlin.String
public val `param`: kotlin.String
) {
@get:kotlin.jvm.JvmName(name = "jvmPropertyGet")
public val propertyGet: kotlin.String? = null
Expand Down Expand Up @@ -1325,7 +1325,7 @@ class KotlinPoetMetadataSpecsTest : MultiClassInspectorTest() {
"""
public class JvmNameData(
@get:kotlin.jvm.JvmName(name = "jvmParam")
public val param: kotlin.String
public val `param`: kotlin.String
) {
@get:kotlin.jvm.JvmName(name = "jvmPropertyGet")
public val propertyGet: kotlin.String? = null
Expand Down Expand Up @@ -1524,13 +1524,13 @@ class KotlinPoetMetadataSpecsTest : MultiClassInspectorTest() {
"""
public class Synthetics(
@get:kotlin.jvm.JvmSynthetic
public val param: kotlin.String
public val `param`: kotlin.String
) {
@field:kotlin.jvm.JvmSynthetic
public val fieldProperty: kotlin.String? = null
@field:kotlin.jvm.JvmSynthetic
public val property: kotlin.String? = null
public val `property`: kotlin.String? = null
@get:kotlin.jvm.JvmSynthetic
public val propertyGet: kotlin.String? = null
Expand Down Expand Up @@ -1589,13 +1589,13 @@ class KotlinPoetMetadataSpecsTest : MultiClassInspectorTest() {
"""
public class Synthetics(
@get:kotlin.jvm.JvmSynthetic
public val param: kotlin.String
public val `param`: kotlin.String
) {
@field:kotlin.jvm.JvmSynthetic
public val fieldProperty: kotlin.String? = null
@field:kotlin.jvm.JvmSynthetic
public val property: kotlin.String? = null
public val `property`: kotlin.String? = null
@get:kotlin.jvm.JvmSynthetic
public val propertyGet: kotlin.String? = null
Expand Down Expand Up @@ -1737,8 +1737,8 @@ class KotlinPoetMetadataSpecsTest : MultiClassInspectorTest() {
assertThat(typeSpec.trimmedToString()).isEqualTo(
"""
@kotlin.SinceKotlin(version = "1.3")
@kotlin.annotation.Retention(value = kotlin.annotation.AnnotationRetention.RUNTIME)
@kotlin.annotation.Target(allowedTargets = [kotlin.annotation.AnnotationTarget.CLASS])
@kotlin.`annotation`.Retention(value = kotlin.`annotation`.AnnotationRetention.RUNTIME)
@kotlin.`annotation`.Target(allowedTargets = [kotlin.`annotation`.AnnotationTarget.CLASS])
public annotation class Metadata(
@get:kotlin.jvm.JvmName(name = "k")
public val kind: kotlin.Int = throw NotImplementedError("Stub!"),
Expand Down Expand Up @@ -1772,8 +1772,8 @@ class KotlinPoetMetadataSpecsTest : MultiClassInspectorTest() {
//language=kotlin
assertThat(typeSpec.trimmedToString()).isEqualTo(
"""
@kotlin.annotation.Retention(value = kotlin.annotation.AnnotationRetention.RUNTIME)
@kotlin.annotation.Target(allowedTargets = [kotlin.annotation.AnnotationTarget.CLASS])
@kotlin.`annotation`.Retention(value = kotlin.`annotation`.AnnotationRetention.RUNTIME)
@kotlin.`annotation`.Target(allowedTargets = [kotlin.`annotation`.AnnotationTarget.CLASS])
public annotation class Metadata(
@get:kotlin.jvm.JvmName(name = "k")
public val kind: kotlin.Int = throw NotImplementedError("Stub!"),
Expand Down
95 changes: 73 additions & 22 deletions kotlinpoet/src/main/java/com/squareup/kotlinpoet/Util.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,36 +165,87 @@ private val IDENTIFIER_REGEX =

internal val String.isIdentifier get() = IDENTIFIER_REGEX.matches(this)

// https://github.com/JetBrains/kotlin/search?q=KeywordStringsGenerated.java
// https://kotlinlang.org/docs/reference/keyword-reference.html
private val KEYWORDS = setOf(
"package",
// Hard keywords
"as",
"typealias",
"break",
"class",
"this",
"super",
"val",
"var",
"fun",
"for",
"null",
"true",
"continue",
"do",
"else",
"false",
"is",
"for",
"fun",
"if",
"in",
"throw",
"return",
"break",
"continue",
"interface",
"is",
"null",
"object",
"if",
"package",
"return",
"super",
"this",
"throw",
"true",
"try",
"else",
"while",
"do",
"typealias",
"typeof",
"val",
"var",
"when",
"interface",
"typeof"
"while",

// Soft keywords
"by",
"catch",
"constructor",
"delegate",
"dynamic",
"field",
"file",
"finally",
"get",
"import",
"init",
"param",
"property",
"receiver",
"set",
"setparam",
"where",

// Modifier keywords
"actual",
"abstract",
"annotation",
"companion",
"const",
"crossinline",
"data",
"enum",
"expect",
"external",
"final",
"infix",
"inline",
"inner",
"internal",
"lateinit",
"noinline",
"open",
"operator",
"out",
"override",
"private",
"protected",
"public",
"reified",
"sealed",
"suspend",
"tailrec",
"vararg",
)

private const val ALLOWED_CHARACTER = '$'
Expand Down
6 changes: 3 additions & 3 deletions kotlinpoet/src/test/java/com/squareup/kotlinpoet/AnnotationSpecTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -570,18 +570,18 @@ class AnnotationSpecTest {
@Parcelize
@TypeParceler<ExternalClass, ExternalClassParceler>
public class MyClass(
public val external: ExternalClass
public val `external`: ExternalClass
)
@Parcelize
public class MyClass(
@TypeParceler<ExternalClass, ExternalClassParceler>
public val external: ExternalClass
public val `external`: ExternalClass
)
@Parcelize
public class MyClass(
public val external: @WriteWith<ExternalClassParceler> ExternalClass
public val `external`: @WriteWith<ExternalClassParceler> ExternalClass
)
""".trimIndent()
Expand Down
6 changes: 3 additions & 3 deletions kotlinpoet/src/test/java/com/squareup/kotlinpoet/CrossplatformTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,13 @@ class CrossplatformTest {
|) {
| public val value: V
|
| public fun get(): V
| public fun `get`(): V
|
| public fun set(value: V): Unit
| public fun `set`(value: V): Unit
|
| public fun getAndSet(value: V): V
|
| public fun compareAndSet(expect: V, update: V): Boolean
| public fun compareAndSet(`expect`: V, update: V): Boolean
|}
|
|public actual typealias AtomicRef<V> = AtomicReference<V>
Expand Down
8 changes: 4 additions & 4 deletions kotlinpoet/src/test/java/com/squareup/kotlinpoet/FileSpecTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@ class FileSpecTest {
"""
|package com.squareup.tacos
|
|import java.lang.System.`out`
|import java.lang.System.gc
|import java.lang.System.nanoTime
|import java.lang.System.out
|import java.lang.Thread
|import java.lang.Thread.State.BLOCKED
|import java.lang.Thread.State.valueOf
Expand Down Expand Up @@ -140,8 +140,8 @@ class FileSpecTest {
"""
|package com.squareup.tacos
|
|import com.squareup.tacos.internal.INGREDIENTS
|import com.squareup.tacos.internal.wrap
|import com.squareup.tacos.`internal`.INGREDIENTS
|import com.squareup.tacos.`internal`.wrap
|import kotlin.collections.List
|
|public fun prepareTacos(): List<Taco> = wrap(INGREDIENTS)
Expand Down Expand Up @@ -1002,7 +1002,7 @@ class FileSpecTest {
.build()
assertThat(spec.toString()).isEqualTo(
"""
|package com.squareup.taco.enchilada.quesadillas.tamales.burritos.`super`.burritos.trying.to.get.a.really.large.packagename
|package com.squareup.taco.enchilada.quesadillas.tamales.burritos.`super`.burritos.trying.to.`get`.a.really.large.packagename
|
|import kotlin.Unit
|
Expand Down
2 changes: 1 addition & 1 deletion kotlinpoet/src/test/java/com/squareup/kotlinpoet/KotlinPoetTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -714,7 +714,7 @@ class KotlinPoetTest {
|import kotlin.String
|
|public open class A {
| protected open external infix operator fun get(v: String): String
| protected open external infix operator fun `get`(v: String): String
|
| internal final tailrec inline fun loop(): String = "a"
|}
Expand Down
4 changes: 2 additions & 2 deletions kotlinpoet/src/test/java/com/squareup/kotlinpoet/MemberNameTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -406,9 +406,9 @@ class MemberNameTest {
|package com.example
|
|import com.squareup.tacos.Taco
|import com.squareup.tacos.`internal`.iterator
|import com.squareup.tacos.`internal`.minusAssign
|import com.squareup.tacos.ingredient.Meat
|import com.squareup.tacos.internal.iterator
|import com.squareup.tacos.internal.minusAssign
|import kotlin.Unit
|
|public fun makeTacoHealthy(taco: Taco): Unit {
Expand Down
4 changes: 2 additions & 2 deletions kotlinpoet/src/test/java/com/squareup/kotlinpoet/PropertySpecTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ class PropertySpecTest {
.build()
assertThat(prop.toString()).isEqualTo(
"""
|private val <T, R : kotlin.Any> java.util.function.Function<T, R>.property: kotlin.String where T : java.io.Serializable, T : kotlin.Cloneable
|private val <T, R : kotlin.Any> java.util.function.Function<T, R>.`property`: kotlin.String where T : java.io.Serializable, T : kotlin.Cloneable
| get() = ""
|""".trimMargin()
)
Expand Down Expand Up @@ -394,7 +394,7 @@ class PropertySpecTest {
.build()
assertThat(property.toString()).isEqualTo(
"""
|val property: com.example.SomeTypeAlias = { arg: kotlin.Any ->
|val `property`: com.example.SomeTypeAlias = { arg: kotlin.Any ->
| println("arg=${'$'}arg")
|}
|
Expand Down
7 changes: 3 additions & 4 deletions kotlinpoet/src/test/java/com/squareup/kotlinpoet/TypeSpecTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ class TypeSpecTest {
"""
|package com.squareup.tacos
|
|import javax.annotation.FreeRange
|import javax.`annotation`.FreeRange
|import kotlin.String
|
|public class EthicalTaco {
Expand Down Expand Up @@ -1058,7 +1058,6 @@ class TypeSpecTest {
)
}

@Ignore("Broken, see https://github.com/square/kotlinpoet/issues/991")
@Test fun enumWithConstructorsAndKeywords() {
val primaryConstructor = FunSpec.constructorBuilder()
.addParameter("value", Int::class)
Expand Down Expand Up @@ -2343,7 +2342,7 @@ class TypeSpecTest {
.addAnnotation(ClassName("javax.annotation", "Nullable"))
.build()
assertThat(parameter.toString())
.isEqualTo("@javax.annotation.Nullable final taco: com.squareup.tacos.Taco")
.isEqualTo("@javax.`annotation`.Nullable final taco: com.squareup.tacos.Taco")
}

@Test fun classToString() {
Expand Down Expand Up @@ -3003,7 +3002,7 @@ class TypeSpecTest {

@Test fun nameFromProperty() {
val property = PropertySpec.builder("property", String::class).build()
assertThat(CodeBlock.of("%N", property).toString()).isEqualTo("property")
assertThat(CodeBlock.of("%N", property).toString()).isEqualTo("`property`")
}

@Test fun nameFromParameter() {
Expand Down

0 comments on commit 564dd59

Please sign in to comment.