Add installation guide

README-chs.md

@@ -101,3 +101,37 @@ fun test(a1: Int, a2: Any): String = runBlocking { test(a1, a2) }
 ## 现在体验
 
 基于编译器 IR 后端的代码生成已经完成, 可启用 IR 后端后添加 Gradle 插件依赖:
+
+1. 第一步: 安装 Gradle 插件.
+
+`build.gradle` 或 `build.gradle.kts`
+```kotlin
+plugins {
+  id("net.mamoe.kotlin-jvm-blocking-bridge") version "0.1.12"
+}
+```
+
+如果 Gradle 无法下载这个插件, 请在 `settings.gradle` 或 `settings.gradle.kts` 中添加 `gradlePluginPortal()`:
+```kotlin
+pluginManagement {
+    repositories {
+        gradlePluginPortal()
+    }
+}
+```
+
+本插件会自动添加如下的依赖:
+```kotlin
+implementation("net.mamoe:kotlin-jvm-blocking-bridge")
+```
+因此只需要安装插件, 而不需要添加依赖即可使用
+
+2. 第二步, 使用 IR 后端.
+
+添加下面内容到 `build.gradle` 或 `build.gradle.kts`
+```kotlin
+```kotlin
+tasks.withType<KotlinCompile> {
+    kotlinOptions.useIR = true
+}
+```

README.md

@@ -104,11 +104,38 @@ TODOs:
 
 ## Try now
 
-You can try it now with Kotlin Compiler IR backend:
+You can try it now with Kotlin Compiler IR backend.
+
+1. First step: Install Gradle plugin.
 
 `build.gradle` or `build.gradle.kts`
 ```kotlin
 plugins {
-  id("net.mamoe.kotlin-jvm-blocking-bridge") version "0.1.3"
+  id("net.mamoe.kotlin-jvm-blocking-bridge") version "0.1.12"
+}
+```
+
+If gradle can't resolve plugin, please add `gradlePluginPortal()` into `settings.gradle` or `settings.gradle.kts`:
+```kotlin
+pluginManagement {
+    repositories {
+        gradlePluginPortal()
+    }
 }
-```
+```
+
+The plugin will automatically install runtime annotation library for you, as:
+```kotlin
+implementation("net.mamoe:kotlin-jvm-blocking-bridge")
+```
+Therefore, you need only to install the plugin.
+
+2. Second step, use IR backend.
+
+Add this into `build.gradle` or `build.gradle.kts`
+```kotlin
+```kotlin
+tasks.withType<KotlinCompile> {
+    kotlinOptions.useIR = true
+}
+```

buildSrc/src/main/kotlin/Versions.kt

@@ -1,5 +1,5 @@
 object Versions {
-    const val project = "0.1.3"
+    const val project = "0.1.12"
 
     const val kotlin = "1.4-M3"
     const val coroutines = "1.3.7"

compiler-plugin/build.gradle.kts

@@ -16,8 +16,10 @@ dependencies {
 
     compileOnly("org.jetbrains.kotlin:kotlin-compiler-embeddable:${Versions.kotlin}")
 
-    kapt("com.google.auto.service:auto-service:1.0-rc6")
-    compileOnly("com.google.auto.service:auto-service-annotations:1.0-rc6")
+    kapt("com.google.auto.service:auto-service:1.0-rc7")
+    compileOnly("com.google.auto.service:auto-service-annotations:1.0-rc7")
+
+    testImplementation(kotlin("reflect"))
 
     testImplementation("org.jetbrains.kotlin:kotlin-compiler-embeddable:${Versions.kotlin}")
     testImplementation("com.github.tschuchortdev:kotlin-compile-testing:1.2.6")

compiler-plugin/src/main/kotlin/net/mamoe/kjbb/JvmBlockingBridgeCommandLineProcessor.kt

@@ -20,18 +20,32 @@ import org.jetbrains.kotlin.compiler.plugin.AbstractCliOption
 import org.jetbrains.kotlin.compiler.plugin.CliOption
 import org.jetbrains.kotlin.compiler.plugin.CommandLineProcessor
 import org.jetbrains.kotlin.config.CompilerConfiguration
+import org.jetbrains.kotlin.config.CompilerConfigurationKey
 
-class JvmBlockingBridgeCommandLineProcessor : CommandLineProcessor {
-    override val pluginId: String = "net.mamoe.kotlin-jvm-blocking-bridge"
+internal val KEY_ENABLED = CompilerConfigurationKey<Boolean>("enabled")
+
+open class JvmBlockingBridgeCommandLineProcessor : CommandLineProcessor {
+    companion object {
+        const val PLUGIN_ID = "net.mamoe.kotlin-jvm-blocking-bridge-gradle"
+    }
+
+    override val pluginId: String = PLUGIN_ID
 
     override val pluginOptions: Collection<CliOption> = listOf(
+        CliOption(
+            optionName = "blocking-bridge",
+            valueDescription = "'true' to enable @JvmBlockingBridge annotation",
+            description = "@JvmBlockingBridge",
+            required = false,
+            allowMultipleOccurrences = false
+        )
     )
 
     override fun processOption(
         option: AbstractCliOption,
         value: String,
         configuration: CompilerConfiguration
     ) {
-
+        configuration.put(KEY_ENABLED, value.toBoolean())
     }
 }

compiler-plugin/src/main/kotlin/net/mamoe/kjbb/JvmBlockingBridgeComponentRegistrar.kt

@@ -9,12 +9,16 @@ import org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar
 import org.jetbrains.kotlin.config.CompilerConfiguration
 
 @Suppress("unused")
-class JvmBlockingBridgeComponentRegistrar : ComponentRegistrar {
+open class JvmBlockingBridgeComponentRegistrar : ComponentRegistrar {
 
     override fun registerProjectComponents(
         project: MockProject,
         configuration: CompilerConfiguration
     ) {
+        if (configuration[KEY_ENABLED] == false) {
+            return
+        }
+
         IrGenerationExtension.registerExtension(project, JvmBlockingBridgeIrGenerationExtension())
         ExpressionCodegenExtension.registerExtension(project, JvmBlockingBridgeCodegenJvmExtension())
     }

compiler-plugin/src/main/kotlin/net/mamoe/kjbb/ir/JvmBlockingBridgeIrGenerationExtension.kt

@@ -23,9 +23,9 @@ class JvmBlockingBridgeIrGenerationExtension : IrGenerationExtension {
 }
 
 internal fun ClassLoweringPass.runOnFileInOrder(irFile: IrFile) {
-    irFile.acceptChildrenVoid(object : IrElementVisitorVoid {
+    irFile.acceptVoid(object : IrElementVisitorVoid {
         override fun visitElement(element: IrElement) {
-            element.acceptVoid(this)
+            element.acceptChildrenVoid(this)
         }
 
         override fun visitClass(declaration: IrClass) {

compiler-plugin/src/main/kotlin/net/mamoe/kjbb/jvm/BridgeCodegen.kt

@@ -2,6 +2,7 @@ package net.mamoe.kjbb.jvm
 
 import org.jetbrains.kotlin.codegen.ImplementationBodyCodegen
 import org.jetbrains.kotlin.descriptors.CallableMemberDescriptor
+import org.jetbrains.kotlin.descriptors.Modality
 import org.jetbrains.kotlin.descriptors.SimpleFunctionDescriptor
 import org.jetbrains.kotlin.descriptors.annotations.Annotations
 import org.jetbrains.kotlin.descriptors.impl.AnonymousFunctionDescriptor
@@ -27,6 +28,8 @@ class BridgeCodegen(
     }
 
     fun SimpleFunctionDescriptor.generateBridge() {
+        val originalFunction = this
+
         println("generating bridge: ${this.valueParameters}, ${this.isSuspend}")
         val desc = AnonymousFunctionDescriptor.create(
             clazz,
@@ -38,11 +41,11 @@ class BridgeCodegen(
             initialize(
                 null,
                 ReceiverParameterDescriptorImpl(clazz, clazz.thisAsReceiverParameter.value, Annotations.EMPTY),
-                typeParameters,
-                valueParameters.map { it.copy(this, it.name, it.index) },
-                returnType,
-                null,
-                visibility
+                originalFunction.typeParameters,
+                originalFunction.valueParameters.map { it.copy(this, it.name, it.index) },
+                originalFunction.returnType,
+                Modality.FINAL,
+                originalFunction.visibility
             )
 
             isSuspend = true

compiler-plugin/src/main/kotlin/net/mamoe/kjbb/jvm/JvmBlockingBridgeCodegenJvmExtension.kt

@@ -8,7 +8,6 @@ import org.jetbrains.kotlin.codegen.extensions.ExpressionCodegenExtension
  */
 open class JvmBlockingBridgeCodegenJvmExtension : ExpressionCodegenExtension {
     override fun generateClassSyntheticParts(codegen: ImplementationBodyCodegen) {
-        return
         BridgeCodegen(codegen).generate()
     }
 

compiler-plugin/src/test/kotlin/TestComponentRegistrar.kt

@@ -0,0 +1,21 @@
+import net.mamoe.kjbb.ir.JvmBlockingBridgeIrGenerationExtension
+import net.mamoe.kjbb.jvm.JvmBlockingBridgeCodegenJvmExtension
+import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension
+import org.jetbrains.kotlin.codegen.extensions.ExpressionCodegenExtension
+import org.jetbrains.kotlin.com.intellij.mock.MockProject
+import org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar
+import org.jetbrains.kotlin.config.CompilerConfiguration
+
+@Suppress("unused")
+open class TestComponentRegistrar : ComponentRegistrar {
+
+    override fun registerProjectComponents(
+        project: MockProject,
+        configuration: CompilerConfiguration
+    ) {
+        IrGenerationExtension.registerExtension(project, JvmBlockingBridgeIrGenerationExtension())
+        ExpressionCodegenExtension.registerExtension(project, JvmBlockingBridgeCodegenJvmExtension())
+    }
+}
+
+

compiler-plugin/src/test/kotlin/TestForClass.kt → compiler-plugin/src/test/kotlin/ir/TestCompilerInIrBackend.kt

@@ -1,6 +1,9 @@
 @file:Suppress("UNCHECKED_CAST", "RemoveRedundantBackticks")
 
+package ir
 
+
+import compile
 import org.intellij.lang.annotations.Language
 import org.junit.jupiter.api.Test
 import kotlin.test.assertEquals
@@ -9,7 +12,7 @@ fun testTestData(
     @Language("kt")
     source: String
 ) {
-    val result = compile(source)
+    val result = compile(source, true)
 
     @Suppress("UNCHECKED_CAST")
     val test = result.classLoader.loadClass("TestData")
@@ -21,7 +24,7 @@ fun testTestData(
 }
 
 @Suppress("RedundantSuspendModifier")
-class TestCompiling {
+class TestCompilerInIrBackend {
 
     @Test
     fun `no param, no extension receiver`() {

compiler-plugin/src/test/kotlin/TestInheritance.kt → compiler-plugin/src/test/kotlin/ir/TestInheritance.kt

@@ -1,16 +1,8 @@
-import org.intellij.lang.annotations.Language
+package ir
+
 import org.junit.jupiter.api.Test
 import kotlin.test.assertFails
 
-private fun test(
-    @Language("kt")
-    source: String
-) {
-    val result = compile(source)
-
-    val testData = result.classLoader.loadClass("TestData")
-}
-
 internal class TestForInterface {
 
     @Test

compiler-plugin/src/test/kotlin/jvm/TestCompilerInJvmBackend.kt

@@ -0,0 +1,18 @@
+package jvm
+
+internal class TestCompilerInJvmBackend {
+
+    //@Test
+    fun `simple function in object`() = testJvmCompile(
+        """
+        object TestData {
+            @JvmBlockingBridge
+            suspend fun test(): String{
+                return "OK"
+            }
+            
+            fun main(): String = this.runFunction("test")
+        }
+    """
+    )
+}

compiler-plugin/src/test/kotlin/jvm/testJvmCompile.kt

@@ -0,0 +1,20 @@
+package jvm
+
+import compile
+import org.intellij.lang.annotations.Language
+import kotlin.test.assertEquals
+
+fun testJvmCompile(
+    @Language("kt")
+    source: String
+) {
+    val result = compile(source, false)
+
+    @Suppress("UNCHECKED_CAST")
+    val test = result.classLoader.loadClass("TestData")
+    assertEquals(
+        "OK",
+        (test.kotlin.objectInstance!!).run {
+            this::class.java.methods.first { it.name == "main" }.invoke(this)
+        } as String)
+}

compiler-plugin/src/test/kotlin/util.kt

@@ -2,7 +2,6 @@
 
 import com.tschuchort.compiletesting.KotlinCompilation
 import com.tschuchort.compiletesting.SourceFile
-import net.mamoe.kjbb.JvmBlockingBridgeComponentRegistrar
 import org.intellij.lang.annotations.Language
 import java.io.File
 import java.lang.reflect.Modifier
@@ -22,7 +21,8 @@ fun <R> Class<*>.runStaticFunction(name: String, vararg args: Any): R {
 
 fun compile(
     @Language("kt")
-    source: String
+    source: String,
+    ir: Boolean
 ): KotlinCompilation.Result {
     val kotlinSource = SourceFile.kotlin(
         "TestData.kt", "import kotlin.test.assertEquals\n$source"
@@ -31,12 +31,12 @@ fun compile(
     return KotlinCompilation().apply {
         sources = listOf(kotlinSource)
 
-        compilerPlugins = listOf(JvmBlockingBridgeComponentRegistrar())
+        compilerPlugins = listOf(TestComponentRegistrar())
         verbose = false
 
         workingDir = File("testCompileOutput").apply { mkdir() }
 
-        useIR = true
+        useIR = ir
 
         inheritClassPath = true
         messageOutputStream = System.out

gradle-plugin/build.gradle.kts

@@ -1,5 +1,3 @@
-import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
-
 plugins {
     kotlin("jvm")
     kotlin("kapt")
@@ -10,14 +8,15 @@ plugins {
     `maven-publish`
     id("com.jfrog.bintray")
 
-    id("com.github.johnrengelman.shadow")
+   // id("com.github.johnrengelman.shadow")
 }
 
 dependencies {
-    implementation(kotlin("stdlib"))
+    compileOnly(kotlin("stdlib"))
     compileOnly(gradleApi())
-    implementation(kotlin("gradle-plugin-api"))
-
+    compileOnly(kotlin("gradle-plugin-api"))
+    compileOnly(kotlin("gradle-plugin"))
+    implementation("io.github.classgraph:classgraph:4.8.47")
     compileOnly("org.jetbrains.kotlin:kotlin-compiler-embeddable:${Versions.kotlin}")
 
     api(project(":kotlin-jvm-blocking-bridge-compiler"))
@@ -45,8 +44,10 @@ gradlePlugin {
     }
 }
 
+/*
 tasks.getByName("shadowJar", ShadowJar::class) {
     archiveClassifier.set("")
 }
 
-tasks.publishPlugins.get().dependsOn(tasks.shadowJar.get())
+tasks.publishPlugins.get().dependsOn(tasks.shadowJar.get())
+*/