azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Use JvmName on kotlin.Metadata parameters to improve public API

Browse Source 
#KT-26359 Fixed
This commit is contained in:
Alexander Udalov
2018-08-30 18:10:00 +02:00
parent 8365836753
commit f63cf9d506
9 changed files with 50 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/kotlinx-metadata/jvm/src/kotlinx/metadata/jvm/KotlinClassHeader.kt
+9 -14
View File
@@ -10,12 +10,7 @@ import org.jetbrains.kotlin.metadata.jvm.deserialization.JvmMetadataVersion
/**
* A mirror to the [Metadata] annotation on a JVM class file, containing the metadata of Kotlin declarations declared in the class file.
* Properties of this class correspond to the properties of [Metadata], but the names are not shortened because there's no restriction
* on the bytecode size here.
*
* Note that [Metadata] is not yet public (see https://youtrack.jetbrains.com/issue/KT-23602). In order to create an instance of
* [KotlinClassHeader] from the [Metadata] annotation instance obtained reflectively, one could use Java code to workaround
* the internal visibility error.
* Properties of this class correspond 1:1 to the properties of [Metadata].
*
* @param kind see [kind]
* @param metadataVersion see [metadataVersion]
@@ -39,7 +34,7 @@ class KotlinClassHeader(
/**
* A kind of the metadata this header encodes.
*
* @see Metadata.k
* @see Metadata.kind
* @see CLASS_KIND
* @see FILE_FACADE_KIND
* @see SYNTHETIC_CLASS_KIND
@@ -51,7 +46,7 @@ class KotlinClassHeader(
/**
* The version of the metadata provided in other properties of this header.
*
* @see Metadata.mv
* @see Metadata.metadataVersion
* @see COMPATIBLE_METADATA_VERSION
*/
val metadataVersion: IntArray = metadataVersion ?: intArrayOf()
@@ -59,7 +54,7 @@ class KotlinClassHeader(
/**
* The version of the bytecode interface (naming conventions, signatures) of the corresponding class file.
*
* @see Metadata.bv
* @see Metadata.bytecodeVersion
* @see COMPATIBLE_BYTECODE_VERSION
*/
val bytecodeVersion: IntArray = bytecodeVersion ?: intArrayOf()
@@ -67,35 +62,35 @@ class KotlinClassHeader(
/**
* The first array of strings used to encode the metadata.
*
* @see Metadata.d1
* @see Metadata.data1
*/
val data1: Array<String> = data1 ?: emptyArray()
/**
* The second array of strings used to encode the metadata.
*
* @see Metadata.d2
* @see Metadata.data2
*/
val data2: Array<String> = data2 ?: emptyArray()
/**
* An extra string field for the metadata.
*
* @see Metadata.xs
* @see Metadata.extraString
*/
val extraString: String = extraString ?: ""
/**
* Fully qualified name of the Kotlin package of the corresponding class, in case [JvmPackageName] was used.
*
* @see Metadata.pn
* @see Metadata.packageName
*/
val packageName: String = packageName ?: ""
/**
* An extra int field for the metadata.
*
* @see Metadata.xi
* @see Metadata.extraInt
*/
val extraInt: Int = extraInt ?: 0
libraries/kotlinx-metadata/jvm/test/kotlinx/metadata/test/MetadataSmokeTest.kt
+1 -2
View File
@@ -15,10 +15,9 @@ import java.net.URLClassLoader
import kotlin.reflect.full.primaryConstructor
class MetadataSmokeTest {
@Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
private fun Class<*>.readMetadata(): KotlinClassHeader {
return getAnnotation(Metadata::class.java).run {
KotlinClassHeader(k, mv, bv, d1, d2, xs, pn, xi)
KotlinClassHeader(kind, metadataVersion, bytecodeVersion, data1, data2, extraString, packageName, extraInt)
}
}
libraries/stdlib/jvm/runtime/kotlin/Metadata.kt
+17 -9
View File
@@ -7,7 +7,7 @@ package kotlin
/**
* This annotation is present on any class file produced by the Kotlin compiler and is read by the compiler and reflection.
* Parameters have very short names on purpose: these names appear in the generated class files, and we'd like to reduce their size.
* Parameters have very short JVM names on purpose: these names appear in all generated class files, and we'd like to reduce their size.
*/
@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.CLASS)
@@ -24,35 +24,42 @@ public annotation class Metadata(
*
* The class file with a kind not listed here is treated as a non-Kotlin file.
*/
val k: Int = 1,
@get:JvmName("k")
val kind: Int = 1,
/**
* The version of the metadata provided in the arguments of this annotation.
*/
val mv: IntArray = [],
@get:JvmName("mv")
val metadataVersion: IntArray = [],
/**
* The version of the bytecode interface (naming conventions, signatures) of the class file annotated with this annotation.
*/
val bv: IntArray = [],
@get:JvmName("bv")
val bytecodeVersion: IntArray = [],
/**
* Metadata in a custom format. The format may be different (or even absent) for different kinds.
*/
val d1: Array<String> = [],
@get:JvmName("d1")
val data1: Array<String> = [],
/**
* An addition to [d1]: array of strings which occur in metadata, written in plain text so that strings already present
* in the constant pool are reused. These strings may be then indexed in the metadata by an integer index in this array.
*/
val d2: Array<String> = [],
@get:JvmName("d2")
val data2: Array<String> = [],
/**
* An extra string. For a multi-file part class, internal name of the facade class.
*/
val xs: String = "",
@get:JvmName("xs")
val extraString: String = "",
/**
* Fully qualified name of the package this class is located in, from Kotlin's point of view, or empty string if this name
* does not differ from the JVM's package FQ name. These names can be different in case the [JvmPackageName] annotation is used.
* Note that this information is also stored in the corresponding module's `.kotlin_module` file.
*/
@SinceKotlin("1.2")
val pn: String = "",
@get:JvmName("pn")
val packageName: String = "",
/**
* An extra int. Bits of this number represent the following flags:
*
@@ -63,5 +70,6 @@ public annotation class Metadata(
* the major.minor version of this metadata ([mv]).
*/
@SinceKotlin("1.1")
val xi: Int = 0
@get:JvmName("xi")
val extraInt: Int = 0
)
libraries/tools/kotlinp/src/org/jetbrains/kotlin/kotlinp/readKotlinClassHeader.kt
+11 -14
View File
@@ -6,10 +6,7 @@
package org.jetbrains.kotlin.kotlinp
import kotlinx.metadata.jvm.KotlinClassHeader
import org.objectweb.asm.AnnotationVisitor
import org.objectweb.asm.ClassReader
import org.objectweb.asm.ClassVisitor
import org.objectweb.asm.Opcodes
import org.objectweb.asm.*
import java.io.File
import java.io.FileInputStream
@@ -17,9 +14,10 @@ internal fun File.readKotlinClassHeader(): KotlinClassHeader? {
var header: KotlinClassHeader? = null
try {
val metadataDesc = Type.getDescriptor(Metadata::class.java)
ClassReader(FileInputStream(this)).accept(object : ClassVisitor(Opcodes.ASM4) {
override fun visitAnnotation(desc: String, visible: Boolean): AnnotationVisitor? =
if (desc == "Lkotlin/Metadata;") readMetadataVisitor { header = it }
if (desc == metadataDesc) readMetadataVisitor { header = it }
else null
}, ClassReader.SKIP_CODE or ClassReader.SKIP_DEBUG or ClassReader.SKIP_FRAMES)
} catch (e: Exception) {
@@ -29,7 +27,6 @@ internal fun File.readKotlinClassHeader(): KotlinClassHeader? {
return header
}
@Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
private fun readMetadataVisitor(output: (KotlinClassHeader) -> Unit): AnnotationVisitor =
object : AnnotationVisitor(Opcodes.ASM4) {
var kind: Int? = null
@@ -43,19 +40,19 @@ private fun readMetadataVisitor(output: (KotlinClassHeader) -> Unit): Annotation
override fun visit(name: String?, value: Any?) {
when (name) {
Metadata::k.name -> kind = value as? Int
Metadata::mv.name -> metadataVersion = value as? IntArray
Metadata::bv.name -> bytecodeVersion = value as? IntArray
Metadata::xs.name -> extraString = value as? String
Metadata::xi.name -> extraInt = value as? Int
Metadata::pn.name -> packageName = value as? String
"k" -> kind = value as? Int
"mv" -> metadataVersion = value as? IntArray
"bv" -> bytecodeVersion = value as? IntArray
"xs" -> extraString = value as? String
"xi" -> extraInt = value as? Int
"pn" -> packageName = value as? String
}
}
override fun visitArray(name: String?): AnnotationVisitor? =
when (name) {
Metadata::d1.name -> stringArrayVisitor { data1 = it }
Metadata::d2.name -> stringArrayVisitor { data2 = it }
"d1" -> stringArrayVisitor { data1 = it }
"d2" -> stringArrayVisitor { data2 = it }
else -> null
}