feat: remove unnecessary @Guidsl annotations for cleaner DSL usage

twisti-dev · twisti-dev · commit 8fae80a73d7b · 2025-06-14T16:31:28.000+02:00
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/dsl/markers.kt b/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/dsl/markers.kt
@@ -10,8 +10,4 @@ annotation class GuiDsl
 
 @Target(AnnotationTarget.CLASS, AnnotationTarget.TYPE)
 @DslMarker
-annotation class GuiItemDsl
-
-@Target(AnnotationTarget.CLASS, AnnotationTarget.TYPE)
-@DslMarker
-annotation class GuiClickDsl
+annotation class GuiItemDsl
diff --git a/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/gui/NamedGui.kt b/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/gui/NamedGui.kt
@@ -9,7 +9,7 @@ interface NamedGui : Gui {
     val title: Component
 
     fun title(title: Component)
-    fun title(builder: (@GuiDsl SurfComponentBuilder).() -> Unit)
+    fun title(builder: SurfComponentBuilder.() -> Unit)
 
     override fun clone(): NamedGui
 }
diff --git a/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/gui/handlers/ClickHandlers.kt b/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/gui/handlers/ClickHandlers.kt
@@ -1,17 +1,14 @@
 package dev.slne.surf.surfapi.bukkit.api.inventory.gui.handlers
 
-import dev.slne.surf.surfapi.bukkit.api.inventory.dsl.GuiDsl
 import dev.slne.surf.surfapi.core.api.util.InternalSurfApi
 import org.bukkit.entity.Player
 import org.bukkit.event.inventory.InventoryClickEvent
 
 typealias ClickHandlerDsl = ClickHandlerScope.() -> Unit
 
-@GuiDsl
 interface ClickHandler : GuiHandler<InventoryClickEvent>
 
 @JvmInline
-@GuiDsl
 value class ClickHandlerScope @InternalSurfApi constructor(val event: InventoryClickEvent) {
     val player
         get() = event.whoClicked as? Player ?: error("Click event is not triggered by a player")
diff --git a/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/gui/handlers/CloseHandlers.kt b/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/gui/handlers/CloseHandlers.kt
@@ -1,17 +1,16 @@
 package dev.slne.surf.surfapi.bukkit.api.inventory.gui.handlers
 
-import dev.slne.surf.surfapi.bukkit.api.inventory.dsl.GuiDsl
 import dev.slne.surf.surfapi.core.api.util.InternalSurfApi
+import org.bukkit.entity.Player
 import org.bukkit.event.inventory.InventoryCloseEvent
 
 typealias CloseHandlerDsl = CloseHandlerScope.() -> Unit
 
-@GuiDsl
 interface CloseHandler: GuiHandler<InventoryCloseEvent>
 
 @JvmInline
-@GuiDsl
 value class CloseHandlerScope @InternalSurfApi constructor(val event: InventoryCloseEvent) {
-
+    val player
+        get() = event.player as? Player ?: error("Close event is not triggered by a player")
 }
 
diff --git a/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/gui/handlers/DragHandlers.kt b/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/gui/handlers/DragHandlers.kt
@@ -1,16 +1,13 @@
 package dev.slne.surf.surfapi.bukkit.api.inventory.gui.handlers
 
-import dev.slne.surf.surfapi.bukkit.api.inventory.dsl.GuiDsl
 import dev.slne.surf.surfapi.core.api.util.InternalSurfApi
 import org.bukkit.entity.Player
 import org.bukkit.event.inventory.InventoryDragEvent
 
 typealias DragHandlerDsl = DragHandlerScope.() -> Unit
 
-@GuiDsl
 interface DragHandler : GuiHandler<InventoryDragEvent>
 
-@GuiDsl
 @JvmInline
 value class DragHandlerScope @InternalSurfApi constructor(val event: InventoryDragEvent) {
     val player
diff --git a/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/gui/handlers/GuiHandler.kt b/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/gui/handlers/GuiHandler.kt
@@ -1,10 +1,8 @@
 package dev.slne.surf.surfapi.bukkit.api.inventory.gui.handlers
 
-import dev.slne.surf.surfapi.bukkit.api.inventory.dsl.GuiDsl
 import org.bukkit.event.Event
 import org.jetbrains.annotations.ApiStatus.OverrideOnly
 
-@GuiDsl
 interface GuiHandler<E : Event> {
     @OverrideOnly
     fun handle(event: E)
diff --git a/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/item/GuiItem.kt b/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/item/GuiItem.kt
@@ -17,10 +17,10 @@ interface GuiItem : Cloneable {
     var visible: Boolean
 
     fun item(itemStack: ItemStack)
-    fun item(type: ItemType, block: (@GuiItemDsl ItemStack).() -> Unit = {})
+    fun item(type: ItemType, block: ItemStack.() -> Unit = {})
 
-    fun onClick(handler: @GuiItemDsl ClickHandler)
-    fun onClick(handler: @GuiItemDsl ClickHandlerDsl)
+    fun onClick(handler: ClickHandler)
+    fun onClick(handler: ClickHandlerDsl)
 
     public override fun clone(): GuiItem = super.clone() as GuiItem
 
diff --git a/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/item/UpdatableGuiItem.kt b/surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/inventory/item/UpdatableGuiItem.kt
@@ -9,7 +9,7 @@ import java.util.function.BooleanSupplier
 @GuiItemDsl
 interface UpdatableGuiItem : GuiItem {
 
-    fun onUpdate(update: @GuiItemDsl BooleanSupplier)
+    fun onUpdate(update: BooleanSupplier)
 
     override fun clone(): UpdatableGuiItem = super.clone() as UpdatableGuiItem
 
diff --git a/surf-api-bukkit/surf-api-bukkit-server/src/main/kotlin/dev/slne/surf/surfapi/bukkit/server/impl/inventory/gui/AbstractNamedGui.kt b/surf-api-bukkit/surf-api-bukkit-server/src/main/kotlin/dev/slne/surf/surfapi/bukkit/server/impl/inventory/gui/AbstractNamedGui.kt
@@ -1,6 +1,5 @@
 package dev.slne.surf.surfapi.bukkit.server.impl.inventory.gui
 
-import dev.slne.surf.surfapi.bukkit.api.inventory.dsl.GuiDsl
 import dev.slne.surf.surfapi.bukkit.api.inventory.gui.NamedGui
 import dev.slne.surf.surfapi.core.api.messages.builder.SurfComponentBuilder
 import net.kyori.adventure.text.Component
@@ -20,6 +19,6 @@ abstract class AbstractNamedGui(title: Component, parent: AbstractGui? = null) :
         this.title = title
     }
 
-    override fun title(builder: @GuiDsl SurfComponentBuilder.() -> Unit) =
+    override fun title(builder: SurfComponentBuilder.() -> Unit) =
         title(SurfComponentBuilder(builder))
 }
diff --git a/surf-api-bukkit/surf-api-bukkit-server/src/main/kotlin/dev/slne/surf/surfapi/bukkit/server/impl/inventory/item/GuiItemImpl.kt b/surf-api-bukkit/surf-api-bukkit-server/src/main/kotlin/dev/slne/surf/surfapi/bukkit/server/impl/inventory/item/GuiItemImpl.kt
@@ -2,7 +2,6 @@ package dev.slne.surf.surfapi.bukkit.server.impl.inventory.item
 
 import com.jeff_media.morepersistentdatatypes.DataType
 import dev.slne.surf.surfapi.bukkit.api.builder.meta
-import dev.slne.surf.surfapi.bukkit.api.inventory.dsl.GuiItemDsl
 import dev.slne.surf.surfapi.bukkit.api.inventory.gui.handlers.ClickHandler
 import dev.slne.surf.surfapi.bukkit.api.inventory.gui.handlers.ClickHandlerDsl
 import dev.slne.surf.surfapi.bukkit.api.inventory.item.GuiItem
@@ -32,11 +31,11 @@ open class GuiItemImpl(
     var action: ClickHandler? = null
         private set
 
-    override fun onClick(handler: @GuiItemDsl ClickHandler) {
+    override fun onClick(handler: ClickHandler) {
         action = handler
     }
 
-    override fun onClick(handler: @GuiItemDsl ClickHandlerDsl) {
+    override fun onClick(handler: ClickHandlerDsl) {
         onClick(ClickHandlerScopeImpl(handler))
     }
 
@@ -46,7 +45,7 @@ open class GuiItemImpl(
 
     override fun item(
         type: ItemType,
-        block: @GuiItemDsl ItemStack.() -> Unit,
+        block: ItemStack.() -> Unit,
     ) {
         item(type.createItemStack().apply { block() })
     }
diff --git a/surf-api-bukkit/surf-api-bukkit-server/src/main/kotlin/dev/slne/surf/surfapi/bukkit/server/impl/inventory/item/UpdatableGuiItemImpl.kt b/surf-api-bukkit/surf-api-bukkit-server/src/main/kotlin/dev/slne/surf/surfapi/bukkit/server/impl/inventory/item/UpdatableGuiItemImpl.kt
@@ -1,6 +1,5 @@
 package dev.slne.surf.surfapi.bukkit.server.impl.inventory.item
 
-import dev.slne.surf.surfapi.bukkit.api.inventory.dsl.GuiItemDsl
 import dev.slne.surf.surfapi.bukkit.api.inventory.item.UpdatableGuiItem
 import org.bukkit.NamespacedKey
 import java.util.*
@@ -12,7 +11,7 @@ class UpdatableGuiItemImpl(
 ) : GuiItemImpl(key, uuid), UpdatableGuiItem {
     private var update: BooleanSupplier? = null
 
-    override fun onUpdate(update: @GuiItemDsl BooleanSupplier) {
+    override fun onUpdate(update: BooleanSupplier) {
         this.update = update
     }
 

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ interface NamedGui : Gui {`
`9`	`9`	`val title: Component`
`10`	`10`
`11`	`11`	`fun title(title: Component)`
`12`		`- fun title(builder: (@GuiDsl SurfComponentBuilder).() -> Unit)`
	`12`	`+ fun title(builder: SurfComponentBuilder.() -> Unit)`
`13`	`13`
`14`	`14`	`override fun clone(): NamedGui`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`package dev.slne.surf.surfapi.bukkit.server.impl.inventory.gui`
`2`	`2`
`3`		`-import dev.slne.surf.surfapi.bukkit.api.inventory.dsl.GuiDsl`
`4`	`3`	`import dev.slne.surf.surfapi.bukkit.api.inventory.gui.NamedGui`
`5`	`4`	`import dev.slne.surf.surfapi.core.api.messages.builder.SurfComponentBuilder`
`6`	`5`	`import net.kyori.adventure.text.Component`
`@@ -20,6 +19,6 @@ abstract class AbstractNamedGui(title: Component, parent: AbstractGui? = null) :`
`20`	`19`	`this.title = title`
`21`	`20`	`}`
`22`	`21`
`23`		`- override fun title(builder: @GuiDsl SurfComponentBuilder.() -> Unit) =`
	`22`	`+ override fun title(builder: SurfComponentBuilder.() -> Unit) =`
`24`	`23`	`title(SurfComponentBuilder(builder))`
`25`	`24`	`}`