Item / Gui / Window DSL

- Added DSL-style builders for reactive items / guis / windows to invui-kotlin
- Guis now use properties for background, frozen, ignoreObscuredInventorySlots
- Fixed page change / scroll / tab change handlers not called when updated through property

Author: NichtStudioCode

invui-kotlin/src/main/kotlin/xyz/xenondevs/invui/PropertyWrappers.kt

@@ -3,37 +3,20 @@ package xyz.xenondevs.invui
 import xyz.xenondevs.commons.provider.MutableProvider
 import xyz.xenondevs.commons.provider.Provider
 import xyz.xenondevs.invui.state.MutableProperty
-import xyz.xenondevs.invui.state.Property
 import java.util.function.Consumer
 
-internal class PropertyAdapter<T : Any>(private val provider: Provider<T>) : Property<T> {
-    
-    override fun get(): T {
-        return provider.get()
-    }
-    
-    override fun <O : Any> observeWeak(owner: O, observer: Consumer<in O>) {
-        provider.observeWeak(owner, observer::accept)
-    }
-    
-    override fun <O : Any> unobserveWeak(owner: O, observer: Consumer<in O>) {
-        provider.unobserveWeak(owner, observer::accept)
-    }
-    
-    override fun unobserveWeak(owner: Any) {
-        provider.unobserveWeak(owner)
-    }
-    
-}
-
-internal class MutablePropertyAdapter<T : Any>(private val provider: MutableProvider<T>) : MutableProperty<T> {
+internal class PropertyAdapter<T>(private val provider: Provider<T>) : MutableProperty<T> {
 
     override fun get(): T {
         return provider.get()
     }
 
     override fun set(value: T) {
-        provider.set(value)
+        if (provider is MutableProvider<T>) {
+            provider.set(value)
+        } else {
+            throw UnsupportedOperationException("This property is backed by a non-mutable provider and cannot be written to.")
+        }
     }
 
     override fun <O : Any> observeWeak(owner: O, observer: Consumer<in O>) {

invui-kotlin/src/main/kotlin/xyz/xenondevs/invui/dsl/AnvilWindowDsl.kt

@@ -0,0 +1,49 @@
+@file:OptIn(ExperimentalReactiveApi::class)
+
+package xyz.xenondevs.invui.dsl
+
+import org.bukkit.entity.Player
+import xyz.xenondevs.invui.ExperimentalReactiveApi
+import xyz.xenondevs.invui.gui.Gui
+import xyz.xenondevs.invui.window.AnvilWindow
+import xyz.xenondevs.invui.window.addRenameHandler
+import xyz.xenondevs.invui.window.setResultAlwaysValid
+import xyz.xenondevs.invui.window.setTextFieldAlwaysEnabled
+
+@ExperimentalDslApi
+fun anvilWindow(viewer: Player, anvilWindow: AnvilWindowDsl.() -> Unit): AnvilWindow =
+    AnvilWindowDslImpl(viewer).apply(anvilWindow).build()
+
+@ExperimentalDslApi
+sealed interface AnvilWindowDsl : SplitWindowDsl {
+    
+    val upperGui: GuiDslProperty
+    val text: MutableProviderDslProperty<String>
+    val textFieldAlwaysEnabled: ProviderDslProperty<Boolean>
+    val resultAlwaysValid: ProviderDslProperty<Boolean>
+    
+}
+
+@ExperimentalDslApi
+internal class AnvilWindowDslImpl(
+    viewer: Player
+) : AbstractSplitWindowDsl<AnvilWindow, AnvilWindow.Builder>(viewer), AnvilWindowDsl {
+    
+    override val upperGui = GuiDslProperty(3, 1)
+    override val text = MutableProviderDslProperty("")
+    override val textFieldAlwaysEnabled = ProviderDslProperty(true)
+    override val resultAlwaysValid = ProviderDslProperty(false)
+    
+    override fun createBuilder() = AnvilWindow.builder()
+    
+    override fun applyToBuilder(builder: AnvilWindow.Builder) {
+        super.applyToBuilder(builder)
+        builder.apply { 
+            setUpperGui(upperGui.value)
+            addRenameHandler(text.value)
+            setTextFieldAlwaysEnabled(textFieldAlwaysEnabled.value)
+            setResultAlwaysValid(resultAlwaysValid.value)
+        }
+    }
+    
+}

invui-kotlin/src/main/kotlin/xyz/xenondevs/invui/dsl/BrewingWindowDsl.kt

@@ -0,0 +1,50 @@
+@file:OptIn(ExperimentalReactiveApi::class)
+
+package xyz.xenondevs.invui.dsl
+
+import org.bukkit.entity.Player
+import xyz.xenondevs.invui.ExperimentalReactiveApi
+import xyz.xenondevs.invui.window.BrewingWindow
+import xyz.xenondevs.invui.window.setBrewProgress
+import xyz.xenondevs.invui.window.setFuelProgress
+
+@ExperimentalDslApi
+fun brewingWindow(viewer: Player, brewingWindow: BrewingWindowDsl.() -> Unit): BrewingWindow =
+    BrewingWindowDslImpl(viewer).apply(brewingWindow).build()
+
+@ExperimentalDslApi
+sealed interface BrewingWindowDsl : SplitWindowDsl {
+    
+    val inputGui: GuiDslProperty
+    val fuelGui: GuiDslProperty
+    val resultGui: GuiDslProperty
+    val brewProgress: ProviderDslProperty<Double>
+    val fuelProgress: ProviderDslProperty<Double>
+    
+}
+
+@ExperimentalDslApi
+internal class BrewingWindowDslImpl(
+    viewer: Player
+) : AbstractSplitWindowDsl<BrewingWindow, BrewingWindow.Builder>(viewer), BrewingWindowDsl {
+    
+    override val inputGui = GuiDslProperty(1, 1)
+    override val fuelGui = GuiDslProperty(1, 1)
+    override val resultGui = GuiDslProperty(3, 1)
+    override val brewProgress = ProviderDslProperty(0.0)
+    override val fuelProgress = ProviderDslProperty(0.0)
+    
+    override fun createBuilder() = BrewingWindow.builder()
+    
+    override fun applyToBuilder(builder: BrewingWindow.Builder) {
+        super.applyToBuilder(builder)
+        builder.apply { 
+            setInputGui(inputGui.value)
+            setFuelGui(fuelGui.value)
+            setResultGui(resultGui.value)
+            setBrewProgress(brewProgress.value)
+            setFuelProgress(fuelProgress.value)
+        }
+    }
+    
+}

invui-kotlin/src/main/kotlin/xyz/xenondevs/invui/dsl/CartographyWindow.kt

@@ -0,0 +1,49 @@
+@file:OptIn(ExperimentalReactiveApi::class)
+
+package xyz.xenondevs.invui.dsl
+
+import org.bukkit.entity.Player
+import xyz.xenondevs.invui.ExperimentalReactiveApi
+import xyz.xenondevs.invui.window.CartographyWindow
+import xyz.xenondevs.invui.window.setIcons
+import xyz.xenondevs.invui.window.setView
+
+// TODO: map image
+
+@ExperimentalDslApi
+fun cartographyWindow(viewer: Player, cartographyWindow: CartographyWindowDsl.() -> Unit): CartographyWindow =
+    CartographyWindowDslImpl(viewer).apply(cartographyWindow).build()
+
+@ExperimentalDslApi
+sealed interface CartographyWindowDsl : SplitWindowDsl {
+    
+    val inputGui: GuiDslProperty
+    val resultGui: GuiDslProperty
+    val icons: ProviderDslProperty<Set<CartographyWindow.MapIcon>>
+    val view: ProviderDslProperty<CartographyWindow.View>
+    
+}
+
+@ExperimentalDslApi
+internal class CartographyWindowDslImpl(
+    viewer: Player
+) : AbstractSplitWindowDsl<CartographyWindow, CartographyWindow.Builder>(viewer), CartographyWindowDsl {
+    
+    override val inputGui = GuiDslProperty(1, 2)
+    override val resultGui = GuiDslProperty(1, 1)
+    override val icons = ProviderDslProperty(emptySet<CartographyWindow.MapIcon>())
+    override val view = ProviderDslProperty(CartographyWindow.View.NORMAL)
+    
+    override fun createBuilder() = CartographyWindow.builder()
+    
+    override fun applyToBuilder(builder: CartographyWindow.Builder) {
+        super.applyToBuilder(builder)
+        builder.apply { 
+            setInputGui(inputGui.value)
+            setResultGui(resultGui.value)
+            setIcons(icons.value)
+            setView(view.value)
+        }
+    }
+    
+}

invui-kotlin/src/main/kotlin/xyz/xenondevs/invui/dsl/CrafterWindowDsl.kt

@@ -0,0 +1,45 @@
+@file:OptIn(ExperimentalReactiveApi::class)
+
+package xyz.xenondevs.invui.dsl
+
+import org.bukkit.entity.Player
+import xyz.xenondevs.commons.provider.MutableProvider
+import xyz.xenondevs.commons.provider.mutableProvider
+import xyz.xenondevs.invui.ExperimentalReactiveApi
+import xyz.xenondevs.invui.window.CrafterWindow
+import xyz.xenondevs.invui.window.setSlots
+
+@ExperimentalDslApi
+fun crafterWindow(viewer: Player, crafterWindow: CrafterWindowDsl.() -> Unit): CrafterWindow =
+    CrafterWindowDslImpl(viewer).apply(crafterWindow).build()
+
+@ExperimentalDslApi
+sealed interface CrafterWindowDsl : SplitWindowDsl {
+    
+    val craftingGui: GuiDslProperty
+    val resultGui: GuiDslProperty
+    val slots: MutableProvider2dArrayDslProperty<Boolean>
+    
+}
+
+@ExperimentalDslApi
+internal class CrafterWindowDslImpl(
+    viewer: Player
+) : AbstractSplitWindowDsl<CrafterWindow, CrafterWindow.Builder>(viewer), CrafterWindowDsl {
+    
+    override val craftingGui = GuiDslProperty(3, 3)
+    override val resultGui = GuiDslProperty(1, 1)
+    override val slots = MutableProvider2dArrayDslProperty(3, 3, false)
+    
+    override fun createBuilder() = CrafterWindow.builder()
+    
+    override fun applyToBuilder(builder: CrafterWindow.Builder) {
+        super.applyToBuilder(builder)
+        builder.apply {
+            setCraftingGui(craftingGui.value)
+            setResultGui(resultGui.value)
+            setSlots(slots.value)
+        }
+    }
+    
+}

invui-kotlin/src/main/kotlin/xyz/xenondevs/invui/dsl/CraftingWindowDsl.kt

@@ -0,0 +1,48 @@
+@file:OptIn(ExperimentalReactiveApi::class)
+
+package xyz.xenondevs.invui.dsl
+
+import net.kyori.adventure.key.Key
+import org.bukkit.entity.Player
+import xyz.xenondevs.invui.ExperimentalReactiveApi
+import xyz.xenondevs.invui.window.CraftingWindow
+
+@ExperimentalDslApi
+fun craftingWindow(viewer: Player, craftingWindow: CraftingWindowDsl.() -> Unit): CraftingWindow =
+    CraftingWindowDslImpl(viewer).apply(craftingWindow).build()
+
+@ExperimentalDslApi
+sealed interface CraftingWindowDsl : SplitWindowDsl {
+    
+    val craftingGui: GuiDslProperty
+    val resultGui: GuiDslProperty
+    
+    fun onRecipeClick(handler: (recipeKey: Key) -> Unit)
+    
+}
+
+@ExperimentalDslApi
+internal class CraftingWindowDslImpl(
+    viewer: Player
+) : AbstractSplitWindowDsl<CraftingWindow, CraftingWindow.Builder>(viewer), CraftingWindowDsl {
+    
+    override val craftingGui = GuiDslProperty(3, 3)
+    override val resultGui = GuiDslProperty(1, 1)
+    private val recipeClickHandlers = mutableListOf<(Key) -> Unit>()
+    
+    override fun onRecipeClick(handler: (Key) -> Unit) {
+        recipeClickHandlers += handler
+    }
+    
+    override fun createBuilder() = CraftingWindow.builder()
+    
+    override fun applyToBuilder(builder: CraftingWindow.Builder) {
+        super.applyToBuilder(builder)
+        builder.apply {
+            setCraftingGui(craftingGui.value)
+            setResultGui(resultGui.value)
+            recipeClickHandlers.forEach { addRecipeClickHandler(it) }
+        }
+    }
+    
+}