Fix getJvmName for @JvmRecord data class properties #2813
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
|
Collaborator
There was a problem hiding this comment. Can we add a test where one of the properties of the data class is also a data class / jvm record? Also, missing copyright header :) |
This file contains hidden or 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,64 @@ | ||
| // TEST PROCESSOR: JvmNameRecordProcessor | ||
| // EXPECTED: | ||
| // Aliased.z: z | ||
| // Couple.first: first | ||
| // Couple.second: second | ||
| // GenericRecord.g: g | ||
| // GenericRecord.h: h | ||
| // LibRecord.w: w | ||
| // NamedRecord.id: id | ||
| // NamedRecord.name: name | ||
| // Single.x: x | ||
| // WithBody.a: a | ||
| // WithBody.computed: computed | ||
| // WithBody.mutable: mutable, mutable | ||
| // WithJvmName.n: customName | ||
| // END | ||
| // JVM_TARGET: 17 | ||
| // MODULE: lib | ||
| // FILE: LibRecord.kt | ||
| @JvmRecord | ||
| data class LibRecord(val w: Int) | ||
| // MODULE: main(lib) | ||
| // FILE: records.kt | ||
| interface Named { | ||
| val name: String | ||
| } | ||
|
|
||
| interface Generic<A> { | ||
| val g: A | ||
| } | ||
|
|
||
| @JvmRecord | ||
| data class Single(val x: Int) | ||
|
|
||
| @JvmRecord | ||
| data class Couple(val first: Int, val second: String) | ||
|
|
||
| // @JvmRecord classes cannot extend other classes (they extend java.lang.Record), | ||
| // so implementing interfaces is the only supertype case. | ||
| @JvmRecord | ||
| data class NamedRecord(override val name: String, val id: Int) : Named | ||
|
|
||
| @JvmRecord | ||
| data class GenericRecord<A, B>(override val g: A, val h: B) : Generic<A> | ||
|
|
||
| // @JvmRecord constructor properties must be vals; mutable properties are only | ||
| // possible in the class body and without a backing field. | ||
| @JvmRecord | ||
| data class WithBody(val a: Int) { | ||
| val computed: Int | ||
| get() = a * 2 | ||
| var mutable: Int | ||
| get() = a | ||
| set(value) {} | ||
| } | ||
|
|
||
| // An explicit @JvmName takes precedence over the record accessor naming. | ||
| @JvmRecord | ||
| data class WithJvmName(@get:JvmName("customName") val n: Int) | ||
| // FILE: aliased.kt | ||
| import kotlin.jvm.JvmRecord as JR | ||
|
Collaborator
There was a problem hiding this comment. In addition to this, can we also create a test where we use a type alias for the annotation? |
||
|
|
||
| @JR | ||
| data class Aliased(val z: Int) | ||
|
Collaborator
There was a problem hiding this comment. Missing copyright header :) |
This file contains hidden or 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,36 @@ | ||
| package com.google.devtools.ksp.processor | ||
|
|
||
| import com.google.devtools.ksp.KspExperimental | ||
| import com.google.devtools.ksp.getClassDeclarationByName | ||
| import com.google.devtools.ksp.processing.Resolver | ||
| import com.google.devtools.ksp.symbol.KSAnnotated | ||
| import com.google.devtools.ksp.symbol.KSClassDeclaration | ||
|
|
||
| class JvmNameRecordProcessor : AbstractTestProcessor() { | ||
| val results = mutableListOf<String>() | ||
| override fun toResult(): List<String> { | ||
| return results | ||
|
jaschdoc marked this conversation as resolved.
|
||
| } | ||
|
|
||
| @OptIn(KspExperimental::class) | ||
| override fun process(resolver: Resolver): List<KSAnnotated> { | ||
| // getSymbolsWithAnnotation only returns symbols in the current compilation, | ||
| // so the record class from the library module is looked up explicitly. | ||
| val sourceRecords = resolver.getSymbolsWithAnnotation("kotlin.jvm.JvmRecord") | ||
| .filterIsInstance<KSClassDeclaration>() | ||
| val libRecords = listOfNotNull(resolver.getClassDeclarationByName("LibRecord")) | ||
| (sourceRecords + libRecords) | ||
| .flatMap { cls -> | ||
| cls.getAllProperties().map { property -> | ||
| val accessorNames = listOfNotNull( | ||
| property.getter?.let { resolver.getJvmName(it) }, | ||
| property.setter?.let { resolver.getJvmName(it) }, | ||
|
Collaborator
There was a problem hiding this comment. I think we should also get the jvm name of the setter parameter. |
||
| ) | ||
| "${cls.simpleName.asString()}.${property.simpleName.asString()}: ${accessorNames.joinToString()}" | ||
| } | ||
| } | ||
| .sorted() | ||
| .let { results.addAll(it) } | ||
| return emptyList() | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please revert this :)