From a6d65428ea403d69ce1d4ccc018abd39c406bce1 Mon Sep 17 00:00:00 2001
From: AJ <aj@alt>
Date: Sun, 14 Apr 2024 15:47:05 -0700
Subject: [PATCH] Remove Invocation -> OptionInvocation

---
 clikt/api/clikt.api                              | 16 ++++++++--------
 .../github/ajalt/clikt/internal/Finalization.kt  | 16 ++++++++--------
 .../ajalt/clikt/parameters/groups/ChoiceGroup.kt |  4 ++--
 .../parameters/groups/CoOccurringOptionGroup.kt  |  4 ++--
 .../parameters/groups/MutuallyExclusiveOption.kt |  4 ++--
 .../clikt/parameters/groups/ParameterGroup.kt    |  6 +++---
 .../ajalt/clikt/parameters/options/Option.kt     | 10 +++++-----
 .../clikt/parameters/options/OptionWithValues.kt | 10 +++++-----
 .../com/github/ajalt/clikt/parsers/Invocation.kt |  4 ++--
 .../ajalt/clikt/parsers/ParserInternals.kt       |  4 ++--
 10 files changed, 39 insertions(+), 39 deletions(-)

diff --git a/clikt/api/clikt.api b/clikt/api/clikt.api
index ed24bae0..8b51218c 100644
--- a/clikt/api/clikt.api
+++ b/clikt/api/clikt.api
@@ -1353,12 +1353,17 @@ public final class com/github/ajalt/clikt/parsers/FlatInvocations : kotlin/seque
 	public fun iterator ()Ljava/util/Iterator;
 }
 
-public final class com/github/ajalt/clikt/parsers/Invocation {
+public final class com/github/ajalt/clikt/parsers/InvocationKt {
+	public static final fun flatten (Lcom/github/ajalt/clikt/parsers/CommandInvocation;Z)Lcom/github/ajalt/clikt/parsers/FlatInvocations;
+	public static synthetic fun flatten$default (Lcom/github/ajalt/clikt/parsers/CommandInvocation;ZILjava/lang/Object;)Lcom/github/ajalt/clikt/parsers/FlatInvocations;
+}
+
+public final class com/github/ajalt/clikt/parsers/OptionInvocation {
 	public fun <init> (Ljava/lang/String;Ljava/util/List;)V
 	public final fun component1 ()Ljava/lang/String;
 	public final fun component2 ()Ljava/util/List;
-	public final fun copy (Ljava/lang/String;Ljava/util/List;)Lcom/github/ajalt/clikt/parsers/Invocation;
-	public static synthetic fun copy$default (Lcom/github/ajalt/clikt/parsers/Invocation;Ljava/lang/String;Ljava/util/List;ILjava/lang/Object;)Lcom/github/ajalt/clikt/parsers/Invocation;
+	public final fun copy (Ljava/lang/String;Ljava/util/List;)Lcom/github/ajalt/clikt/parsers/OptionInvocation;
+	public static synthetic fun copy$default (Lcom/github/ajalt/clikt/parsers/OptionInvocation;Ljava/lang/String;Ljava/util/List;ILjava/lang/Object;)Lcom/github/ajalt/clikt/parsers/OptionInvocation;
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getName ()Ljava/lang/String;
 	public final fun getValues ()Ljava/util/List;
@@ -1366,11 +1371,6 @@ public final class com/github/ajalt/clikt/parsers/Invocation {
 	public fun toString ()Ljava/lang/String;
 }
 
-public final class com/github/ajalt/clikt/parsers/InvocationKt {
-	public static final fun flatten (Lcom/github/ajalt/clikt/parsers/CommandInvocation;Z)Lcom/github/ajalt/clikt/parsers/FlatInvocations;
-	public static synthetic fun flatten$default (Lcom/github/ajalt/clikt/parsers/CommandInvocation;ZILjava/lang/Object;)Lcom/github/ajalt/clikt/parsers/FlatInvocations;
-}
-
 public final class com/github/ajalt/clikt/sources/ChainedValueSource : com/github/ajalt/clikt/sources/ValueSource {
 	public fun <init> (Ljava/util/List;)V
 	public final fun getSources ()Ljava/util/List;
diff --git a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/internal/Finalization.kt b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/internal/Finalization.kt
index 53f50da4..490f6d3c 100644
--- a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/internal/Finalization.kt
+++ b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/internal/Finalization.kt
@@ -8,12 +8,12 @@ import com.github.ajalt.clikt.parameters.groups.ParameterGroup
 import com.github.ajalt.clikt.parameters.internal.LateinitException
 import com.github.ajalt.clikt.parameters.options.Option
 import com.github.ajalt.clikt.parsers.ArgumentInvocation
-import com.github.ajalt.clikt.parsers.Invocation
+import com.github.ajalt.clikt.parsers.OptionInvocation
 
 internal fun finalizeOptions(
     context: Context,
     options: List<Option>,
-    invocationsByOption: Map<Option, List<Invocation>>,
+    invocationsByOption: Map<Option, List<OptionInvocation>>,
 ) {
     iterateFinalization(
         context, getAllOptions(invocationsByOption, options).map { Opt(it.key, it.value) }
@@ -21,9 +21,9 @@ internal fun finalizeOptions(
 }
 
 private sealed class Param
-private data class Opt(val option: Option, val invs: List<Invocation>) : Param()
+private data class Opt(val option: Option, val invs: List<OptionInvocation>) : Param()
 private data class Arg(val argument: Argument, val invs: List<String>) : Param()
-private data class Group(val group: ParameterGroup, val invs: Map<Option, List<Invocation>>) :
+private data class Group(val group: ParameterGroup, val invs: Map<Option, List<OptionInvocation>>) :
     Param()
 
 internal fun finalizeParameters(
@@ -31,13 +31,13 @@ internal fun finalizeParameters(
     options: List<Option>,
     groups: List<ParameterGroup>,
     arguments: List<Argument>,
-    optionInvocations: Map<Option, List<Invocation>>,
+    optionInvocations: Map<Option, List<OptionInvocation>>,
     argumentInvocations: List<ArgumentInvocation>,
 ): List<UsageError> {
     // Add uninvoked params last so that e.g. we can skip prompting if there's an error in an
     // invoked option
 
-    val allGroups = buildMap<ParameterGroup?, Map<Option, List<Invocation>>> {
+    val allGroups = buildMap<ParameterGroup?, Map<Option, List<OptionInvocation>>> {
         optionInvocations.entries
             .groupBy({ it.key.group }, { it.key to it.value })
             .mapValuesTo(this) { it.value.toMap() }
@@ -65,9 +65,9 @@ internal fun finalizeParameters(
 }
 
 private fun getAllOptions(
-    invocations: Map<Option, List<Invocation>>,
+    invocations: Map<Option, List<OptionInvocation>>,
     options: List<Option>,
-): Map<Option, List<Invocation>> {
+): Map<Option, List<OptionInvocation>> {
     return buildMap {
         putAll(invocations)
         for (opt in options) {
diff --git a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/ChoiceGroup.kt b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/ChoiceGroup.kt
index db9db784..41ef5eb6 100644
--- a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/ChoiceGroup.kt
+++ b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/ChoiceGroup.kt
@@ -10,7 +10,7 @@ import com.github.ajalt.clikt.parameters.options.OptionDelegate
 import com.github.ajalt.clikt.parameters.options.RawOption
 import com.github.ajalt.clikt.parameters.options.switch
 import com.github.ajalt.clikt.parameters.types.choice
-import com.github.ajalt.clikt.parsers.Invocation
+import com.github.ajalt.clikt.parsers.OptionInvocation
 import kotlin.properties.ReadOnlyProperty
 import kotlin.reflect.KProperty
 
@@ -50,7 +50,7 @@ class ChoiceGroup<GroupT : OptionGroup, OutT> internal constructor(
 
     override fun finalize(
         context: Context,
-        invocationsByOption: Map<Option, List<Invocation>>,
+        invocationsByOption: Map<Option, List<OptionInvocation>>,
     ) {
         val key = option.value
         if (key == null) {
diff --git a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/CoOccurringOptionGroup.kt b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/CoOccurringOptionGroup.kt
index c9eb5294..de22b6a0 100644
--- a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/CoOccurringOptionGroup.kt
+++ b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/CoOccurringOptionGroup.kt
@@ -7,7 +7,7 @@ import com.github.ajalt.clikt.parameters.internal.NullableLateinit
 import com.github.ajalt.clikt.parameters.options.Option
 import com.github.ajalt.clikt.parameters.options.hasEnvvarOrSourcedValue
 import com.github.ajalt.clikt.parameters.options.required
-import com.github.ajalt.clikt.parsers.Invocation
+import com.github.ajalt.clikt.parsers.OptionInvocation
 import kotlin.properties.ReadOnlyProperty
 import kotlin.reflect.KProperty
 
@@ -47,7 +47,7 @@ class CoOccurringOptionGroup<GroupT : OptionGroup, OutT> internal constructor(
 
     override fun getValue(thisRef: BaseCliktCommand<*>, property: KProperty<*>): OutT = value
 
-    override fun finalize(context: Context, invocationsByOption: Map<Option, List<Invocation>>) {
+    override fun finalize(context: Context, invocationsByOption: Map<Option, List<OptionInvocation>>) {
         occurred = invocationsByOption.isNotEmpty() || group.options.any {
             it.hasEnvvarOrSourcedValue(context, invocationsByOption[it] ?: emptyList())
         }
diff --git a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/MutuallyExclusiveOption.kt b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/MutuallyExclusiveOption.kt
index e2f400b7..205e2378 100644
--- a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/MutuallyExclusiveOption.kt
+++ b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/MutuallyExclusiveOption.kt
@@ -4,7 +4,7 @@ import com.github.ajalt.clikt.core.*
 import com.github.ajalt.clikt.internal.finalizeOptions
 import com.github.ajalt.clikt.parameters.internal.NullableLateinit
 import com.github.ajalt.clikt.parameters.options.*
-import com.github.ajalt.clikt.parsers.Invocation
+import com.github.ajalt.clikt.parsers.OptionInvocation
 import kotlin.properties.ReadOnlyProperty
 import kotlin.reflect.KProperty
 
@@ -44,7 +44,7 @@ class MutuallyExclusiveOptions<OptT : Any, OutT> internal constructor(
 
     override fun finalize(
         context: Context,
-        invocationsByOption: Map<Option, List<Invocation>>,
+        invocationsByOption: Map<Option, List<OptionInvocation>>,
     ) {
         finalizeOptions(context, options, invocationsByOption)
         val values = options.filter {
diff --git a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/ParameterGroup.kt b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/ParameterGroup.kt
index 465fd157..b2f931a5 100644
--- a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/ParameterGroup.kt
+++ b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/groups/ParameterGroup.kt
@@ -7,7 +7,7 @@ import com.github.ajalt.clikt.core.ParameterHolder
 import com.github.ajalt.clikt.internal.finalizeOptions
 import com.github.ajalt.clikt.output.HelpFormatter
 import com.github.ajalt.clikt.parameters.options.Option
-import com.github.ajalt.clikt.parsers.Invocation
+import com.github.ajalt.clikt.parsers.OptionInvocation
 import kotlin.properties.PropertyDelegateProvider
 import kotlin.properties.ReadOnlyProperty
 import kotlin.reflect.KProperty
@@ -38,7 +38,7 @@ interface ParameterGroup {
      * @param context The context for this parse
      * @param invocationsByOption The invocations of options in this group.
      */
-    fun finalize(context: Context, invocationsByOption: Map<Option, List<Invocation>>)
+    fun finalize(context: Context, invocationsByOption: Map<Option, List<OptionInvocation>>)
 
     /**
      * Called after all of a command's parameters have been [finalize]d to perform validation of the final values.
@@ -90,7 +90,7 @@ open class OptionGroup(
         options += option
     }
 
-    override fun finalize(context: Context, invocationsByOption: Map<Option, List<Invocation>>) {
+    override fun finalize(context: Context, invocationsByOption: Map<Option, List<OptionInvocation>>) {
         finalizeOptions(context, options, invocationsByOption)
     }
 
diff --git a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/options/Option.kt b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/options/Option.kt
index ed95529b..82061702 100644
--- a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/options/Option.kt
+++ b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/options/Option.kt
@@ -6,7 +6,7 @@ import com.github.ajalt.clikt.core.GroupableOption
 import com.github.ajalt.clikt.core.ParameterHolder
 import com.github.ajalt.clikt.core.StaticallyGroupedOption
 import com.github.ajalt.clikt.output.HelpFormatter
-import com.github.ajalt.clikt.parsers.Invocation
+import com.github.ajalt.clikt.parsers.OptionInvocation
 import com.github.ajalt.clikt.sources.ValueSource
 import kotlin.properties.PropertyDelegateProvider
 import kotlin.properties.ReadOnlyProperty
@@ -80,7 +80,7 @@ interface Option {
      * @param context The context for this parse
      * @param invocations A possibly empty list of invocations of this option.
      */
-    fun finalize(context: Context, invocations: List<Invocation>)
+    fun finalize(context: Context, invocations: List<OptionInvocation>)
 
     /**
      * Called after all of a command's parameters have been [finalize]d to perform validation of the final value.
@@ -141,14 +141,14 @@ internal fun splitOptionPrefix(name: String): Pair<String, String> =
 internal fun Option.longestName(): String? = names.maxByOrNull { it.length }
 
 internal sealed class FinalValue {
-    data class Parsed(val values: List<Invocation>) : FinalValue()
+    data class Parsed(val values: List<OptionInvocation>) : FinalValue()
     data class Sourced(val values: List<ValueSource.Invocation>) : FinalValue()
     data class Envvar(val key: String, val value: String) : FinalValue()
 }
 
 internal fun Option.getFinalValue(
     context: Context,
-    invocations: List<Invocation>,
+    invocations: List<OptionInvocation>,
     envvar: String?,
 ): FinalValue {
     return when {
@@ -170,7 +170,7 @@ internal fun Option.getFinalValue(
 // final value again to check for values from other sources.
 internal fun Option.hasEnvvarOrSourcedValue(
     context: Context,
-    invocations: List<Invocation>,
+    invocations: List<OptionInvocation>,
 ): Boolean {
     val envvar = (this as? OptionWithValues<*, *, *>)?.envvar
     val final = this.getFinalValue(context, invocations, envvar)
diff --git a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/options/OptionWithValues.kt b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/options/OptionWithValues.kt
index 368fcba6..b9daee1f 100644
--- a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/options/OptionWithValues.kt
+++ b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/options/OptionWithValues.kt
@@ -12,7 +12,7 @@ import com.github.ajalt.clikt.parameters.transform.HelpTransformContext
 import com.github.ajalt.clikt.parameters.transform.TransformContext
 import com.github.ajalt.clikt.parameters.transform.message
 import com.github.ajalt.clikt.parameters.types.int
-import com.github.ajalt.clikt.parsers.Invocation
+import com.github.ajalt.clikt.parsers.OptionInvocation
 import com.github.ajalt.clikt.sources.ValueSource
 import com.github.ajalt.mordant.terminal.Terminal
 import kotlin.jvm.JvmMultifileClass
@@ -191,7 +191,7 @@ private class OptionWithValuesImpl<AllT, EachT, ValueT>(
         return helpGetter?.invoke(HelpTransformContext(context)) ?: ""
     }
 
-    override fun finalize(context: Context, invocations: List<Invocation>) {
+    override fun finalize(context: Context, invocations: List<OptionInvocation>) {
         val invs = when (val v = getFinalValue(context, invocations, envvar)) {
             is FinalValue.Parsed -> {
                 when (valueSplit) {
@@ -208,13 +208,13 @@ private class OptionWithValuesImpl<AllT, EachT, ValueT>(
             }
 
             is FinalValue.Sourced -> {
-                v.values.map { Invocation("", it.values) }
+                v.values.map { OptionInvocation("", it.values) }
             }
 
             is FinalValue.Envvar -> {
                 when (valueSplit) {
-                    null -> listOf(Invocation(v.key, listOf(v.value)))
-                    else -> listOf(Invocation(v.key, v.value.split(valueSplit)))
+                    null -> listOf(OptionInvocation(v.key, listOf(v.value)))
+                    else -> listOf(OptionInvocation(v.key, v.value.split(valueSplit)))
                 }
             }
         }
diff --git a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parsers/Invocation.kt b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parsers/Invocation.kt
index e562aec2..b55aabcd 100644
--- a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parsers/Invocation.kt
+++ b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parsers/Invocation.kt
@@ -9,7 +9,7 @@ import com.github.ajalt.clikt.parameters.options.Option
 /**
  * The output of parsing a single option and its values.
  */
-data class Invocation(
+data class OptionInvocation(
     /**
      * The name that was used to invoke the option. May be empty if the value was not retrieved
      * from the command line (e.g. values from environment variables).
@@ -42,7 +42,7 @@ class ArgumentInvocation(
  */
 class CommandInvocation<T : BaseCliktCommand<T>>(
     val command: T,
-    val optionInvocations: Map<Option, List<Invocation>>,
+    val optionInvocations: Map<Option, List<OptionInvocation>>,
     val argumentInvocations: List<ArgumentInvocation>,
     /**
      * The subcommands of this command that were invoked.
diff --git a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parsers/ParserInternals.kt b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parsers/ParserInternals.kt
index cb687df7..241a7515 100644
--- a/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parsers/ParserInternals.kt
+++ b/clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parsers/ParserInternals.kt
@@ -360,7 +360,7 @@ private data class CommandParseResult<T : BaseCliktCommand<T>>(
     val i: Int,
     val errors: List<CliktError>,
     val expandedArgv: List<String>,
-    val optInvocations: Map<Option, List<Invocation>>,
+    val optInvocations: Map<Option, List<OptionInvocation>>,
     val argInvocations: List<ArgumentInvocation>,
 ) {
     fun toInvocation(subcommands: List<CommandInvocation<T>>) = CommandInvocation(
@@ -373,7 +373,7 @@ private data class CommandParseResult<T : BaseCliktCommand<T>>(
 }
 
 private data class OptInvocation(val opt: Option, val name: String, val values: List<String>) {
-    val inv get() = Invocation(name, values)
+    val inv get() = OptionInvocation(name, values)
 }
 
 private data class OptParseResult(