- add name for custom actions

Author: stslex

app/src/main/kotlin/com/stslex/compiler_app/MainActivity.kt

@@ -61,7 +61,11 @@ class MainActivity : ComponentActivity() {
         findViewById<TextView>(R.id.usernameFieldTextView).text = name
     }
 
-    @DistinctUntilChangeFun(true, action = TestLogger::class)
+    @DistinctUntilChangeFun(
+        name = "set_user_second_name",
+        logging = true,
+        action = TestLogger::class
+    )
     private fun setSecondName(name: String) {
         logger.log(Level.INFO, "setSecondName: $name")
         findViewById<TextView>(R.id.secondNameFieldTextView).text = name

app/src/main/kotlin/com/stslex/compiler_app/TestLogger.kt

@@ -4,7 +4,10 @@ import io.github.stslex.compiler_plugin.utils.Action
 
 class TestLogger : Action {
 
-    override fun invoke(isProcess: Boolean) {
-        println("test logger procession: $isProcess")
+    override fun invoke(
+        name: String,
+        isProcess: Boolean
+    ) {
+        println("test action $name procession: $isProcess")
     }
 }

compiler-plugin/src/main/kotlin/io/github/stslex/compiler_plugin/DistinctChangeCache.kt

@@ -18,22 +18,24 @@ internal class DistinctChangeCache(
     ): R {
         val entry = cache[key]
 
+        // log enter to invoke processing
         if (config.logging) {
-            logger.i("key: $key, config:$config, entry: $entry, args: $args")
+            logger.i("name: ${config.name} key: $key, config:$config, entry: $entry, args: $args")
         }
 
+        config.action(
+            name = config.name,
+            isProcess = entry != null && entry.first == args
+        )
+
         if (entry != null && entry.first == args) {
-            if (config.logging) {
-                logger.i("$key not change")
-            }
-            config.action(isProcess = false)
+            if (config.logging) logger.i("${config.name} with key $key not change")
             return entry.second as R
         }
 
-        config.action(isProcess = true)
-
         val result = body()
         cache[key] = args to result
+
         return result
     }
 }

compiler-plugin/src/main/kotlin/io/github/stslex/compiler_plugin/DistinctUntilChangeFun.kt

@@ -7,12 +7,16 @@ import kotlin.reflect.KClass
 /**
  * @param logging enable logs for Kotlin Compiler Runtime work (useful for debug - don't use in production)
  * @param singletonAllow if enable - generates distinction for function without classes (so it's singleton)
+ * @param name set name for function in compiler logs and put in into action, else take function name
+ * @param action any action to process when function enter - it invokes with state of processing function body info and [name].
+ * @suppress [action] shouldn't have properties in it's constructor
  * */
 @Target(AnnotationTarget.FUNCTION)
 @Retention(AnnotationRetention.BINARY)
 public annotation class DistinctUntilChangeFun(
     val logging: Boolean = LOGGING_DEFAULT,
     val singletonAllow: Boolean = SINGLETON_ALLOW,
+    val name: String = "",
     val action: KClass<out Action> = DefaultAction::class
 ) {
 

compiler-plugin/src/main/kotlin/io/github/stslex/compiler_plugin/model/DistinctChangeConfig.kt

@@ -4,5 +4,6 @@ import io.github.stslex.compiler_plugin.utils.Action
 
 internal data class DistinctChangeConfig(
     val logging: Boolean,
-    val action: Action
+    val action: Action,
+    val name: String
 )

compiler-plugin/src/main/kotlin/io/github/stslex/compiler_plugin/utils/CompilerLogger.kt

@@ -1,11 +1,18 @@
 package io.github.stslex.compiler_plugin.utils
 
-/**Use for any action in runtime plugin*/
+/**
+ * Use for any action in runtime plugin
+ * @suppress shouldn't have properties in it's constructor - cause compiling crush
+ **/
 public fun interface Action {
 
     /**
+     * @param name setted at [io.github.stslex.compiler_plugin.DistinctUntilChangeFun] property name
      * @param isProcess show that function block will process
      **/
-    public operator fun invoke(isProcess: Boolean)
+    public operator fun invoke(
+        name: String,
+        isProcess: Boolean
+    )
 
 }

compiler-plugin/src/main/kotlin/io/github/stslex/compiler_plugin/utils/DefaultAction.kt

@@ -2,5 +2,8 @@ package io.github.stslex.compiler_plugin.utils
 
 internal class DefaultAction : Action {
 
-    override fun invoke(isProcess: Boolean) = Unit
+    override fun invoke(
+        name: String,
+        isProcess: Boolean
+    ) = Unit
 }

compiler-plugin/src/main/kotlin/io/github/stslex/compiler_plugin/utils/ReadQualifierUtil.kt

@@ -7,6 +7,7 @@ import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext
 import org.jetbrains.kotlin.backend.common.lower.DeclarationIrBuilder
 import org.jetbrains.kotlin.ir.builders.irBoolean
 import org.jetbrains.kotlin.ir.builders.irCallConstructor
+import org.jetbrains.kotlin.ir.builders.irString
 import org.jetbrains.kotlin.ir.declarations.IrSimpleFunction
 import org.jetbrains.kotlin.ir.expressions.IrClassReference
 import org.jetbrains.kotlin.ir.expressions.IrConst
@@ -36,7 +37,10 @@ internal fun IrPluginContext.readQualifier(
 
     val irBuilder = createIrBuilder(function)
 
-    val loggingExpr = annotation.getValueArgument(0) ?: irBuilder.irBoolean(LOGGING_DEFAULT)
+    val loggingExpr = annotation.getValueArgument(0)
+        ?: irBuilder.irBoolean(LOGGING_DEFAULT)
+    val actionName = annotation.getValueArgument(2)
+        ?: irBuilder.irString(function.name.identifier)
     val actionInstanceExpr = getQualifierAction(annotation, irBuilder)
 
     val constructorSymbol = referenceClass(DistinctChangeConfig::class.classId)
@@ -53,6 +57,7 @@ internal fun IrPluginContext.readQualifier(
         .apply {
             putValueArgument(0, loggingExpr)
             putValueArgument(1, actionInstanceExpr)
+            putValueArgument(2, actionName)
         }
 }
 
@@ -65,7 +70,7 @@ private fun IrPluginContext.getQualifierAction(
         .findClass(DefaultAction::class.name, DefaultAction::class.fqName)
         ?: error("readQualifier ${DefaultAction::class.java.simpleName} not found")
 
-    val actionReference = annotation.getValueArgument(2) as? IrClassReference
+    val actionReference = annotation.getValueArgument(3) as? IrClassReference
 
     val actionClassSymbol = actionReference?.symbol as? IrClassSymbol ?: defaultActionClass
 

gradle/libs.versions.toml

@@ -14,7 +14,7 @@ activity = "1.10.0"
 constraintLayout = "2.2.0"
 jetbrainsKotlinJvm = "2.0.20"
 
-stslexCompilerPlugin = "0.0.3"
+stslexCompilerPlugin = "0.0.4"
 
 [libraries]
 android-desugarJdkLibs = { module = "com.android.tools:desugar_jdk_libs", version.ref = "androidDesugarJdkLibs" }