Open Arguments functions - #123

Kord-Extensions · May 22, 2024 · 5e3424c · 5e3424c
1 parent fca5007
commit 5e3424c
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 28 deletions.
diff --git a/...in/com/kotlindiscord/kord/extensions/modules/annotations/converters/ConverterProcessor.kt b/...in/com/kotlindiscord/kord/extensions/modules/annotations/converters/ConverterProcessor.kt
@@ -154,24 +154,26 @@ public class ConverterProcessor(
 			val outputText = buildString {
 				append(
 					"""
-                    @file:OptIn(
-                        KordPreview::class,
-                        ConverterToDefaulting::class,
-                        ConverterToMulti::class,
-                        ConverterToOptional::class
-                    )
-
-                    package ${classDeclaration.packageName.asString()}
-
-                    // Original converter class, for safety
-                    import ${classDeclaration.qualifiedName!!.asString()}
-
-                    // Imports that all converters need
-                    import com.kotlindiscord.kord.extensions.InvalidArgumentException
-                    import com.kotlindiscord.kord.extensions.commands.Arguments
-                    import com.kotlindiscord.kord.extensions.commands.converters.*
-                    import com.kotlindiscord.kord.extensions.commands.converters.builders.*
-                    import dev.kord.common.annotation.KordPreview
+						@file:OptIn(
+							KordPreview::class,
+							ConverterToDefaulting::class,
+							ConverterToMulti::class,
+							ConverterToOptional::class,
+							UnexpectedFunctionBehaviour::class,
+						)
+
+						package ${classDeclaration.packageName.asString()}
+
+						// Original converter class, for safety
+						import ${classDeclaration.qualifiedName!!.asString()}
+
+						// Imports that all converters need
+						import com.kotlindiscord.kord.extensions.InvalidArgumentException
+						import com.kotlindiscord.kord.extensions.annotations.UnexpectedFunctionBehaviour
+						import com.kotlindiscord.kord.extensions.commands.Arguments
+						import com.kotlindiscord.kord.extensions.commands.converters.*
+						import com.kotlindiscord.kord.extensions.commands.converters.builders.*
+						import dev.kord.common.annotation.KordPreview
                     """.trimIndent()
 				)
 

diff --git a/...nsions/annotations/UnexpectedBehaviour.kt → ...nnotations/UnexpectedFunctionBehaviour.kt b/...nsions/annotations/UnexpectedBehaviour.kt → ...nnotations/UnexpectedFunctionBehaviour.kt
@@ -8,9 +8,9 @@ package com.kotlindiscord.kord.extensions.annotations
 
 /** Marks a function that may result in unexpected behaviour, and ask the developer to check the docs. **/
 @RequiresOptIn(
-	message = "Calling this function may result in unexpected behaviour. Please ensure you read its documentation " +
-		"comment before continuing.",
+	message = "Calling or overriding this function may result in unexpected behaviour. Please ensure you read its " +
+		"documentation comment before continuing.",
 	level = RequiresOptIn.Level.WARNING
 )
 @Target(AnnotationTarget.FUNCTION)
-public annotation class UnexpectedBehaviour
+public annotation class UnexpectedFunctionBehaviour
diff --git a/kord-extensions/src/main/kotlin/com/kotlindiscord/kord/extensions/commands/Arguments.kt b/kord-extensions/src/main/kotlin/com/kotlindiscord/kord/extensions/commands/Arguments.kt
@@ -6,6 +6,7 @@
 
 package com.kotlindiscord.kord.extensions.commands
 
+import com.kotlindiscord.kord.extensions.annotations.UnexpectedFunctionBehaviour
 import com.kotlindiscord.kord.extensions.commands.converters.*
 
 /**
@@ -42,6 +43,7 @@ public open class Arguments {
 	 *
 	 * @return Argument converter to use as a delegate.
 	 */
+	@UnexpectedFunctionBehaviour
 	public fun <R : Any> arg(
 		displayName: String,
 		description: String,
@@ -63,6 +65,7 @@ public open class Arguments {
 	 *
 	 * @return Argument converter to use as a delegate.
 	 */
+	@UnexpectedFunctionBehaviour
 	public fun <R : Any> arg(
 		displayName: String,
 		description: String,
@@ -84,6 +87,7 @@ public open class Arguments {
 	 *
 	 * @return Argument converter to use as a delegate.
 	 */
+	@UnexpectedFunctionBehaviour
 	public fun <R : Any> arg(
 		displayName: String,
 		description: String,
@@ -105,6 +109,7 @@ public open class Arguments {
 	 *
 	 * @return Argument converter to use as a delegate.
 	 */
+	@UnexpectedFunctionBehaviour
 	public fun <R : Any> arg(
 		displayName: String,
 		description: String,
@@ -126,6 +131,7 @@ public open class Arguments {
 	 *
 	 * @return Argument converter to use as a delegate.
 	 */
+	@UnexpectedFunctionBehaviour
 	public fun <R : Any> arg(
 		displayName: String,
 		description: String,
@@ -147,6 +153,7 @@ public open class Arguments {
 	 *
 	 * @return Argument converter to use as a delegate.
 	 */
+	@UnexpectedFunctionBehaviour
 	public fun <R : Any> arg(
 		displayName: String,
 		description: String,
@@ -168,6 +175,7 @@ public open class Arguments {
 	 *
 	 * @return Argument converter to use as a delegate.
 	 */
+	@UnexpectedFunctionBehaviour
 	public fun <R : Any> arg(
 		displayName: String,
 		description: String,

diff --git a/...ns/src/main/kotlin/com/kotlindiscord/kord/extensions/types/EphemeralInteractionContext.kt b/...ns/src/main/kotlin/com/kotlindiscord/kord/extensions/types/EphemeralInteractionContext.kt
@@ -7,7 +7,7 @@
 package com.kotlindiscord.kord.extensions.types
 
 import com.kotlindiscord.kord.extensions.annotations.AlwaysPublicResponse
-import com.kotlindiscord.kord.extensions.annotations.UnexpectedBehaviour
+import com.kotlindiscord.kord.extensions.annotations.UnexpectedFunctionBehaviour
 import com.kotlindiscord.kord.extensions.pagination.EphemeralResponsePaginator
 import com.kotlindiscord.kord.extensions.pagination.PublicFollowUpPaginator
 import com.kotlindiscord.kord.extensions.pagination.builders.PaginatorBuilder
@@ -38,7 +38,7 @@ public interface EphemeralInteractionContext : InteractionContext<
 		builder: suspend FollowupMessageCreateBuilder.() -> Unit,
 	): EphemeralFollowupMessage = interactionResponse.createEphemeralFollowup { builder() }
 
-	@UnexpectedBehaviour
+	@UnexpectedFunctionBehaviour
 	public override suspend fun respondOpposite(
 		builder: suspend FollowupMessageCreateBuilder.() -> Unit,
 	): PublicFollowupMessage = interactionResponse.createPublicFollowup { builder() }

diff --git a/...-extensions/src/main/kotlin/com/kotlindiscord/kord/extensions/types/InteractionContext.kt b/...-extensions/src/main/kotlin/com/kotlindiscord/kord/extensions/types/InteractionContext.kt
@@ -9,7 +9,7 @@
 package com.kotlindiscord.kord.extensions.types
 
 import com.kotlindiscord.kord.extensions.annotations.AlwaysPublicResponse
-import com.kotlindiscord.kord.extensions.annotations.UnexpectedBehaviour
+import com.kotlindiscord.kord.extensions.annotations.UnexpectedFunctionBehaviour
 import com.kotlindiscord.kord.extensions.pagination.BaseButtonPaginator
 import com.kotlindiscord.kord.extensions.pagination.builders.PaginatorBuilder
 import dev.kord.core.behavior.interaction.response.InteractionResponseBehavior
@@ -79,7 +79,7 @@ public interface InteractionContext<
 	 * While Discord's API allows you to do this, it will rarely do what you'd expect.
 	 * Only use this if you're sure it'll do what you want, and test thoroughly.
 	 */
-	@UnexpectedBehaviour
+	@UnexpectedFunctionBehaviour
 	public suspend fun respondOpposite(
 		builder: suspend FollowupMessageCreateBuilder.() -> Unit,
 	): OppositeFollowupType

diff --git a/...sions/src/main/kotlin/com/kotlindiscord/kord/extensions/types/PublicInteractionContext.kt b/...sions/src/main/kotlin/com/kotlindiscord/kord/extensions/types/PublicInteractionContext.kt
@@ -7,7 +7,7 @@
 package com.kotlindiscord.kord.extensions.types
 
 import com.kotlindiscord.kord.extensions.annotations.AlwaysPublicResponse
-import com.kotlindiscord.kord.extensions.annotations.UnexpectedBehaviour
+import com.kotlindiscord.kord.extensions.annotations.UnexpectedFunctionBehaviour
 import com.kotlindiscord.kord.extensions.pagination.PublicFollowUpPaginator
 import com.kotlindiscord.kord.extensions.pagination.PublicResponsePaginator
 import com.kotlindiscord.kord.extensions.pagination.builders.PaginatorBuilder
@@ -37,7 +37,7 @@ public interface PublicInteractionContext : InteractionContext<
 		builder: suspend FollowupMessageCreateBuilder.() -> Unit,
 	): PublicFollowupMessage = interactionResponse.createPublicFollowup { builder() }
 
-	@UnexpectedBehaviour
+	@UnexpectedFunctionBehaviour
 	public override suspend fun respondOpposite(
 		builder: suspend FollowupMessageCreateBuilder.() -> Unit,
 	): EphemeralFollowupMessage = interactionResponse.createEphemeralFollowup { builder() }

diff --git a/...main/kotlin/com/kotlindiscord/kord/extensions/modules/unsafe/converters/UnionConverter.kt b/...main/kotlin/com/kotlindiscord/kord/extensions/modules/unsafe/converters/UnionConverter.kt
@@ -5,13 +5,15 @@
  */
 
 @file:OptIn(
-	ConverterToOptional::class
+	ConverterToOptional::class,
+	UnexpectedFunctionBehaviour::class
 )
 @file:Suppress("StringLiteralDuplication")
 
 package com.kotlindiscord.kord.extensions.modules.unsafe.converters
 
 import com.kotlindiscord.kord.extensions.DiscordRelayedException
+import com.kotlindiscord.kord.extensions.annotations.UnexpectedFunctionBehaviour
 import com.kotlindiscord.kord.extensions.commands.Argument
 import com.kotlindiscord.kord.extensions.commands.Arguments
 import com.kotlindiscord.kord.extensions.commands.CommandContext