イケてるDSLで設定できるようにする

back-in-time.library/src/commonMain/kotlin/com/github/kitakkun/backintime/annotations/Capture.kt

@@ -1,5 +1,8 @@
 package com.github.kitakkun.backintime.annotations
 
+@Target(AnnotationTarget.CLASS)
+annotation class ValueContainer
+
 @Target(AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION)
 annotation class Capture
 

gradle-plugin/build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     kotlin("jvm")
     kotlin("kapt")
+    kotlin("plugin.serialization")
     `java-gradle-plugin`
     `maven-publish`
 }
@@ -21,6 +22,7 @@ dependencies {
 
     compileOnly("com.google.auto.service:auto-service:1.1.1")
     kapt("com.google.auto.service:auto-service:1.1.1")
+    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.2")
 }
 
 publishing {

gradle-plugin/src/main/kotlin/com/github/kitakkun/backintime/BackInTimePlugin.kt

@@ -1,14 +1,18 @@
 package com.github.kitakkun.backintime
 
+import com.github.kitakkun.backintime.extension.BackInTimeExtension
 import com.github.kitakkun.backintime.plugin.BackInTimeCompilerOptionKey
 import com.github.kitakkun.backintime.plugin.BackInTimePluginConsts
 import com.google.auto.service.AutoService
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
 import org.gradle.api.Project
 import org.gradle.api.provider.Provider
 import org.jetbrains.kotlin.gradle.plugin.KotlinCompilation
 import org.jetbrains.kotlin.gradle.plugin.KotlinCompilerPluginSupportPlugin
 import org.jetbrains.kotlin.gradle.plugin.SubpluginArtifact
 import org.jetbrains.kotlin.gradle.plugin.SubpluginOption
+import java.util.Base64
 
 @Suppress("unused")
 @AutoService(KotlinCompilerPluginSupportPlugin::class)
@@ -29,13 +33,14 @@ class BackInTimePlugin : KotlinCompilerPluginSupportPlugin {
         return kotlinCompilation.target.project.provider {
             listOf(
                 SubpluginOption(key = BackInTimeCompilerOptionKey.ENABLED, value = extension.enabled.toString()),
-            ) + extension.capturedCalls.map {
-                SubpluginOption(key = BackInTimeCompilerOptionKey.CAPTURED_CALLS, value = it)
-            } + extension.valueGetters.map {
-                SubpluginOption(key = BackInTimeCompilerOptionKey.VALUE_GETTERS, value = it)
-            } + extension.valueSetters.map {
-                SubpluginOption(key = BackInTimeCompilerOptionKey.VALUE_SETTERS, value = it)
-            }
+            ).plus(
+                extension.valueContainers
+                    .map { Json.encodeToString(it) }
+                    .map { Base64.getEncoder().encodeToString(it.toByteArray(Charsets.UTF_8)) }
+                    .map {
+                        SubpluginOption(key = BackInTimeCompilerOptionKey.VALUE_CONTAINER, value = it)
+                    }
+            )
         }
     }
 

gradle-plugin/src/main/kotlin/com/github/kitakkun/backintime/extension/BackInTimeExtension.kt

@@ -0,0 +1,15 @@
+package com.github.kitakkun.backintime.extension
+
+import com.github.kitakkun.backintime.plugin.extension.ValueContainerConfig
+import kotlinx.serialization.Serializable
+
+@Serializable
+open class BackInTimeExtension(
+    var enabled: Boolean = true,
+    val valueContainers: MutableList<ValueContainerConfig> = mutableListOf(),
+) {
+    fun valueContainers(configuration: ValueContainersScope.() -> Unit) {
+        val scope = ValueContainersScope().apply(configuration)
+        valueContainers.addAll(scope.containers)
+    }
+}

gradle-plugin/src/main/kotlin/com/github/kitakkun/backintime/extension/ValueContainersScope.kt

@@ -0,0 +1,35 @@
+package com.github.kitakkun.backintime.extension
+
+import com.github.kitakkun.backintime.plugin.extension.ValueContainerConfig
+
+class ValueContainersScope {
+    var containers: MutableList<ValueContainerConfig> = mutableListOf()
+        private set
+
+    fun container(configuration: ValueContainerConfig.() -> Unit) {
+        val config = ValueContainerConfig().apply(configuration)
+        this.containers.add(config)
+    }
+
+    fun androidValueContainers() {
+        container {
+            className = "androidx.lifecycle.MutableLiveData"
+            captures = listOf("postValue", "setValue")
+            getter = "getValue"
+            setter = "postValue"
+        }
+        container {
+            className = "androidx.compose.runtime.MutableState"
+            captures = listOf("<set-value>")
+            getter = "<get-value>"
+            setter = "<set-value>"
+        }
+        container {
+            className = "kotlinx.coroutines.flow.MutableStateFlow"
+            captures = listOf("<set-value>", "update", "updateAndGet", "getAndUpdate", "emit", "tryEmit")
+            getter = "<get-value>"
+            setter = "<set-value>"
+        }
+    }
+}
+

kotlin-plugin/build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     kotlin("jvm")
     kotlin("kapt")
+    kotlin("plugin.serialization")
     `maven-publish`
 }
 
@@ -18,6 +19,7 @@ dependencies {
     kapt("com.google.auto.service:auto-service:1.1.1")
 
     testImplementation(kotlin("test"))
+    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.2")
 }
 
 publishing {

kotlin-plugin/src/main/kotlin/com/github/kitakkun/backintime/compiler/BackInTimeAnnotations.kt

@@ -9,6 +9,7 @@ object BackInTimeAnnotations {
     val debuggableStateHolderAnnotationClassId = ClassId.topLevel(debuggableStateHolderAnnotationFqName)
     val debuggableStateHolderManipulatorAnnotationClassId = ClassId.topLevel(debuggableStateHolderManipulatorFqName)
 
+    val valueContainerAnnotationFqName = FqName("com.github.kitakkun.backintime.annotations.ValueContainer")
     val captureAnnotationFqName = FqName("com.github.kitakkun.backintime.annotations.Capture")
     val getterAnnotationFqName = FqName("com.github.kitakkun.backintime.annotations.Getter")
     val setterAnnotationFqName = FqName("com.github.kitakkun.backintime.annotations.Setter")

kotlin-plugin/src/main/kotlin/com/github/kitakkun/backintime/compiler/BackInTimeCommandLineProcessor.kt

@@ -2,12 +2,15 @@ package com.github.kitakkun.backintime.compiler
 
 import com.github.kitakkun.backintime.plugin.BackInTimeCompilerOptionKey
 import com.github.kitakkun.backintime.plugin.BackInTimePluginConsts
+import com.github.kitakkun.backintime.plugin.extension.ValueContainerConfig
 import com.google.auto.service.AutoService
+import kotlinx.serialization.json.Json
 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.compiler.plugin.ExperimentalCompilerApi
 import org.jetbrains.kotlin.config.CompilerConfiguration
+import java.util.Base64
 
 @Suppress("UNUSED")
 @OptIn(ExperimentalCompilerApi::class)
@@ -22,33 +25,22 @@ class BackInTimeCommandLineProcessor : CommandLineProcessor {
             required = false,
         ),
         CliOption(
-            optionName = BackInTimeCompilerOptionKey.CAPTURED_CALLS,
-            valueDescription = "className1:functionName1,className2:functionName2,...(ex: androidx.lifecycle.MutableLiveData:<set-value>, androidx.compose.runtime.MutableState:<set-value>)",
-            description = "Functions to be captured.",
-            allowMultipleOccurrences = true,
-            required = false,
-        ),
-        CliOption(
-            optionName = BackInTimeCompilerOptionKey.VALUE_GETTERS,
-            valueDescription = "className1:functionName1,className2:functionName2,...(ex: androidx.lifecycle.MutableLiveData:<get-value>, androidx.compose.runtime.MutableState:<get-value>)",
-            description = "Value getters to be used.",
-            allowMultipleOccurrences = true,
-            required = false,
-        ),
-        CliOption(
-            optionName = BackInTimeCompilerOptionKey.VALUE_SETTERS,
-            valueDescription = "className1:functionName1,className2:functionName2,...(ex: androidx.lifecycle.MutableLiveData:<set-value>, androidx.compose.runtime.MutableState:<set-value>)",
-            description = "Value setters to be used.",
+            optionName = BackInTimeCompilerOptionKey.VALUE_CONTAINER,
+            valueDescription = "configurable via container dsl",
+            description = "predefined debuggable value-container class",
             allowMultipleOccurrences = true,
             required = false,
         )
     )
 
     override fun processOption(option: AbstractCliOption, value: String, configuration: CompilerConfiguration) = when (option.optionName) {
         BackInTimeCompilerOptionKey.ENABLED -> configuration.put(BackInTimeCompilerConfigurationKey.ENABLED, value.toBoolean())
-        BackInTimeCompilerOptionKey.CAPTURED_CALLS -> configuration.appendList(BackInTimeCompilerConfigurationKey.CAPTURED_CALLS, value)
-        BackInTimeCompilerOptionKey.VALUE_GETTERS -> configuration.appendList(BackInTimeCompilerConfigurationKey.VALUE_GETTERS, value)
-        BackInTimeCompilerOptionKey.VALUE_SETTERS -> configuration.appendList(BackInTimeCompilerConfigurationKey.VALUE_SETTERS, value)
+        BackInTimeCompilerOptionKey.VALUE_CONTAINER -> {
+            val decodedValue = String(Base64.getDecoder().decode(value), Charsets.UTF_8)
+            val config = Json.decodeFromString<ValueContainerConfig>(decodedValue)
+            configuration.appendList(BackInTimeCompilerConfigurationKey.VALUE_CONTAINER, config)
+        }
+
         else -> error("Unexpected config option ${option.optionName}")
     }
 }

kotlin-plugin/src/main/kotlin/com/github/kitakkun/backintime/compiler/BackInTimeCompilerConfiguration.kt

@@ -1,10 +1,8 @@
 package com.github.kitakkun.backintime.compiler
 
-import org.jetbrains.kotlin.name.CallableId
+import com.github.kitakkun.backintime.compiler.backend.ValueContainerClassInfo
 
 data class BackInTimeCompilerConfiguration(
     val enabled: Boolean,
-    val capturedCallableIds: Set<CallableId>,
-    val valueGetterCallableIds: Set<CallableId>,
-    val valueSetterCallableIds: Set<CallableId>,
+    val valueContainers: List<ValueContainerClassInfo>,
 )

kotlin-plugin/src/main/kotlin/com/github/kitakkun/backintime/compiler/BackInTimeCompilerConfigurationKey.kt

@@ -1,11 +1,10 @@
 package com.github.kitakkun.backintime.compiler
 
 import com.github.kitakkun.backintime.plugin.BackInTimeCompilerOptionKey
+import com.github.kitakkun.backintime.plugin.extension.ValueContainerConfig
 import org.jetbrains.kotlin.config.CompilerConfigurationKey
 
 object BackInTimeCompilerConfigurationKey {
     val ENABLED = CompilerConfigurationKey.create<Boolean>(BackInTimeCompilerOptionKey.ENABLED)
-    val CAPTURED_CALLS = CompilerConfigurationKey.create<List<String>>(BackInTimeCompilerOptionKey.CAPTURED_CALLS)
-    val VALUE_GETTERS = CompilerConfigurationKey.create<List<String>>(BackInTimeCompilerOptionKey.VALUE_GETTERS)
-    val VALUE_SETTERS = CompilerConfigurationKey.create<List<String>>(BackInTimeCompilerOptionKey.VALUE_SETTERS)
+    val VALUE_CONTAINER = CompilerConfigurationKey.create<List<ValueContainerConfig>>(BackInTimeCompilerOptionKey.VALUE_CONTAINER)
 }

kotlin-plugin/src/main/kotlin/com/github/kitakkun/backintime/compiler/BackInTimeCompilerConfigurationProcessor.kt

@@ -1,5 +1,6 @@
 package com.github.kitakkun.backintime.compiler
 
+import com.github.kitakkun.backintime.compiler.backend.ValueContainerClassInfo
 import org.jetbrains.kotlin.config.CompilerConfiguration
 import org.jetbrains.kotlin.name.CallableId
 import org.jetbrains.kotlin.name.ClassId
@@ -8,17 +9,16 @@ import org.jetbrains.kotlin.name.Name
 class BackInTimeCompilerConfigurationProcessor {
     fun process(configuration: CompilerConfiguration) = BackInTimeCompilerConfiguration(
         enabled = configuration[BackInTimeCompilerConfigurationKey.ENABLED] ?: false,
-        capturedCallableIds = configuration[BackInTimeCompilerConfigurationKey.CAPTURED_CALLS].orEmpty().map {
-            val (className, functionName) = it.replace(".", "/").split(":")
-            CallableId(ClassId.fromString(className), Name.guessByFirstCharacter(functionName))
-        }.toSet(),
-        valueGetterCallableIds = configuration[BackInTimeCompilerConfigurationKey.VALUE_GETTERS].orEmpty().map {
-            val (className, functionName) = it.replace(".", "/").split(":")
-            CallableId(ClassId.fromString(className), Name.guessByFirstCharacter(functionName))
-        }.toSet(),
-        valueSetterCallableIds = configuration[BackInTimeCompilerConfigurationKey.VALUE_SETTERS].orEmpty().map {
-            val (className, functionName) = it.replace(".", "/").split(":")
-            CallableId(ClassId.fromString(className), Name.guessByFirstCharacter(functionName))
-        }.toSet(),
+        valueContainers = configuration[BackInTimeCompilerConfigurationKey.VALUE_CONTAINER].orEmpty()
+            .map { config ->
+                val classId = ClassId.fromString(config.className.replace(".", "/"))
+
+                ValueContainerClassInfo(
+                    classId = classId,
+                    capturedCallableIds = config.captures.map { CallableId(classId, Name.guessByFirstCharacter(it)) },
+                    valueGetter = CallableId(classId, Name.guessByFirstCharacter(config.getter)),
+                    valueSetter = CallableId(classId, Name.guessByFirstCharacter(config.setter)),
+                )
+            },
     )
 }

kotlin-plugin/src/main/kotlin/com/github/kitakkun/backintime/compiler/backend/BackInTimePluginContext.kt

@@ -18,7 +18,7 @@ class BackInTimePluginContext(
     moduleFragment: IrModuleFragment,
 ) : IrPluginContext by baseContext {
     val pluginContext: IrPluginContext = baseContext
-    val valueContainerClassInfoList: List<ValueContainerClassInfo> = UserDefinedValueContainerAnalyzer.analyzeAdditionalValueContainerClassInfo(config, moduleFragment)
+    val valueContainerClassInfoList: List<ValueContainerClassInfo> = config.valueContainers + UserDefinedValueContainerAnalyzer.analyzeAdditionalValueContainerClassInfo(moduleFragment)
 
     // BackInTimeService
     val backInTimeServiceClassSymbol = referenceClass(BackInTimeConsts.backInTimeDebugServiceClassId)!!