WIP - Enable parameter() DSL to be extended

BenWoodworth · Jan 4, 2024 · fc36aa0 · fc36aa0
1 parent daa3149
commit fc36aa0
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 3 deletions.
diff --git a/api/parameterize.api b/api/parameterize.api
@@ -1,3 +1,6 @@
+public abstract interface annotation class com/benwoodworth/parameterize/ExperimentalParameterizeApi : java/lang/annotation/Annotation {
+}
+
 public final class com/benwoodworth/parameterize/ParameterizeConfiguration {
 	public static final field Companion Lcom/benwoodworth/parameterize/ParameterizeConfiguration$Companion;
 	public final fun getDecorator ()Lkotlin/jvm/functions/Function3;
@@ -94,9 +97,11 @@ public final class com/benwoodworth/parameterize/ParameterizeScope {
 
 public final class com/benwoodworth/parameterize/ParameterizeScope$Parameter {
 	public static final synthetic fun box-impl (Lkotlin/sequences/Sequence;)Lcom/benwoodworth/parameterize/ParameterizeScope$Parameter;
+	public static fun constructor-impl (Lkotlin/sequences/Sequence;)Lkotlin/sequences/Sequence;
 	public fun equals (Ljava/lang/Object;)Z
 	public static fun equals-impl (Lkotlin/sequences/Sequence;Ljava/lang/Object;)Z
 	public static final fun equals-impl0 (Lkotlin/sequences/Sequence;Lkotlin/sequences/Sequence;)Z
+	public final fun getArguments ()Lkotlin/sequences/Sequence;
 	public fun hashCode ()I
 	public static fun hashCode-impl (Lkotlin/sequences/Sequence;)I
 	public fun toString ()Ljava/lang/String;

diff --git a/src/commonMain/kotlin/Annotations.kt b/src/commonMain/kotlin/Annotations.kt
@@ -0,0 +1,7 @@
+package com.benwoodworth.parameterize
+
+@Retention(AnnotationRetention.BINARY)
+@SinceKotlin("1.3")
+@RequiresOptIn
+@MustBeDocumented
+public annotation class ExperimentalParameterizeApi
diff --git a/src/commonMain/kotlin/Parameterize.kt b/src/commonMain/kotlin/Parameterize.kt
@@ -137,6 +137,7 @@ public class ParameterizeScope internal constructor(
      * ```
      */
     public fun <T> parameter(arguments: Sequence<T>): Parameter<T> =
+        @OptIn(ExperimentalParameterizeApi::class)
         Parameter(arguments)
 
     /** @suppress */
@@ -156,10 +157,16 @@ public class ParameterizeScope internal constructor(
     }
 
 
-    /** @suppress */
+    /**
+     * @constructor
+     * **Experimental:** Prefer using the scope-limited [parameter] function instead, if possible.
+     * The constructor will be made `@PublishedApi internal` once context receivers are introduced to the language.
+     *
+     * @suppress
+     */
     @JvmInline
-    public value class Parameter<out T> internal constructor(
-        internal val arguments: Sequence<T>
+    public value class Parameter<out T> @ExperimentalParameterizeApi constructor(
+        public val arguments: Sequence<T>
     )
 
     /** @suppress */