Redesigning the ComposableName API

Author: jisungbin

compiler/src/main/kotlin/land/sungbin/composeinvestigator/compiler/names.kt

@@ -29,15 +29,16 @@ public object ComposeNames {
   public val currentComposer: FqName = ANDROIDX_COMPOSE_RUNTIME_FQN.child(identifier("currentComposer"))
 
   public val state: FqName = ANDROIDX_COMPOSE_RUNTIME_FQN.child(identifier("State"))
-  public val stateObject: FqName = ANDROIDX_COMPOSE_RUNTIME_FQN.child(identifier("snapshots.StateObject"))
+  public val stateObject: FqName = ANDROIDX_COMPOSE_RUNTIME_FQN.child(identifier("snapshots")).child(identifier("StateObject"))
 }
 
 public object InvestigatorNames {
   public val composableScope: FqName = COMPOSE_INVESTIGATOR_RUNTIME_FQN.child(identifier("ComposableScope"))
   public val noInvestigation: FqName = COMPOSE_INVESTIGATOR_RUNTIME_FQN.child(identifier("NoInvestigation"))
 
   public val composeInvestigator: FqName = COMPOSE_INVESTIGATOR_RUNTIME_FQN.child(identifier("ComposeInvestigator"))
-  public val composeInvestigatorCurrentComposablenName: FqName = composeInvestigator.child(identifier("currentComposableName"))
+  public val composeInvestigatorSetComposableName: FqName = composeInvestigator.child(identifier("setComposableName"))
+  public val composeInvestigatorGetComposableName: FqName = composeInvestigator.child(identifier("getComposableName"))
   public val composeInvestigatorRegisterStateObject: FqName = composeInvestigator.child(identifier("registerStateObject"))
   public val composeInvestigatorComputeInvalidationReason: FqName = composeInvestigator.child(identifier("computeInvalidationReason"))
   public val composeInvestigatorLogger: FqName = composeInvestigator.child(identifier("Companion")).child(identifier("Logger"))
@@ -49,7 +50,6 @@ public object InvestigatorNames {
   public val invalidationResult: FqName = COMPOSE_INVESTIGATOR_RUNTIME_FQN.child(identifier("InvalidationResult"))
   public val invalidationResultSkipped: FqName = invalidationResult.child(identifier("Skipped"))
 
-  public val composableName: FqName = COMPOSE_INVESTIGATOR_RUNTIME_FQN.child(identifier("ComposableName"))
   public val composableInformation: FqName = COMPOSE_INVESTIGATOR_RUNTIME_FQN.child(identifier("ComposableInformation"))
   public val valueArgument: FqName = COMPOSE_INVESTIGATOR_RUNTIME_FQN.child(identifier("ValueArgument"))
 

runtime/src/commonMain/kotlin/land/sungbin/composeinvestigator/runtime/ComposeInvestigator.kt

@@ -4,33 +4,14 @@ package land.sungbin.composeinvestigator.runtime
 
 import androidx.annotation.VisibleForTesting
 import androidx.compose.runtime.Immutable
+import androidx.compose.runtime.NoLiveLiterals
 import androidx.compose.runtime.Stable
 import androidx.compose.runtime.snapshots.StateObject
 
 /** Returns the [ComposeInvestigator] assigned to the current file. */
 public val currentComposeInvestigator: ComposeInvestigator
   @[Stable JvmSynthetic] get() = intrinsicImplementedError()
 
-/**
- * Returns the name of the current Composable.
- * See [ComposeInvestigator.currentComposableName].
- *
- * You can get [name] directly from the property delegation.
- * See [ComposableName.getValue].
- */
-@MustBeDocumented
-@Target() // We use an annotation class to prevent LiveLiteral transform from the Compose compiler.
-@Retention(AnnotationRetention.SOURCE)
-public annotation class ComposableName(public val name: String)
-
-/**
- * `val name: String by ComposableName("MyComposable") // result: "MyComposable"`
- *
- * @see ComposableName
- */
-@Suppress("unused")
-@Stable public operator fun ComposableName.getValue(thisRef: Any?, property: Any?): String = name
-
 /**
  * Classes that hold data from ComposeInvestigator.
  *
@@ -51,39 +32,22 @@ public annotation class ComposableName(public val name: String)
 @Immutable public class ComposeInvestigator @ComposeInvestigatorCompilerApi public constructor() {
   private val stateObjectMap: MutableMap<StateObject, String> = mutableMapOf()
   private val argumentMap: MutableMap<Int, List<ValueArgument>> = mutableMapOf()
+  private val nameMap: MutableMap<Int, String> = mutableMapOf()
 
-  /**
-   * Returns the name of the current Composable, or you can define your own Composable name to use
-   * for ComposeInvestigator.
-   *
-   * ```
-   * @Composable fun MyComposable() {
-   *   val table = currentComposableInvalidationTracer
-   *
-   *   val originalName = table.currentComposableName.name
-   *   assertEquals(originalName, "MyComposable") // Ok
-   *
-   *   table.currentComposableName = ComposableName("AwesomeComposable")
-   *   val newName = table.currentComposableName.name
-   *   assertEquals(newName, "AwesomeComposable") // Ok
-   * }
-   * ```
-   *
-   * This is used as the value of [name][ComposableInformation.simpleName] in [ComposableInformation].
-   *
-   * If you call this getter from a Composable configured as an anonymous function, it will always
-   * be named 'anonymous.' Therefore, in this case, we recommend you specify your Composable name.
-   */
-  public var currentComposableName: ComposableName
-    @[Stable ComposableScope JvmSynthetic] get() {
-      intrinsicImplementedError()
-    }
-    @[ComposableScope JvmSynthetic] set(@Suppress("unused") name) {
-      intrinsicImplementedError()
-    }
+  @NoLiveLiterals @ComposableScope
+  @Stable public fun setComposableName(name: String, compoundKey: Int = intrinsicImplementedError()) {
+    nameMap[compoundKey] = name
+  }
+
+  @NoLiveLiterals @ComposableScope
+  @Stable public fun getComposableName(
+    compoundKey: Int = intrinsicImplementedError(),
+    default: String = intrinsicImplementedError(),
+  ): String = nameMap[compoundKey] ?: default
 
   @VisibleForTesting public fun reset() {
     argumentMap.clear()
+    nameMap.clear()
   }
 
   /**
@@ -105,10 +69,10 @@ public annotation class ComposableName(public val name: String)
     return stateObjectMap[value]
   }
 
-  /** @suppress ComposeInvestigator compiler-only API */
-  @ComposeInvestigatorCompilerApi
   // FIXME Storing the StateObject itself can potentially create a memory leak.
   //  Consider storing immutable primitives like hashCode instead of the object.
+  /** @suppress ComposeInvestigator compiler-only API */
+  @ComposeInvestigatorCompilerApi
   public fun <T : Any> registerStateObject(value: T, name: String): T {
     if (value !is StateObject) return value
     return value.apply { stateObjectMap[this] = name }