Kotlin DSL

framework/build.gradle

@@ -10,6 +10,10 @@ dependencies {
     compileOnlyApi libs.spigot.api
 }
 
+dependencies {
+    runtimeOnly(project(':framework:bukkit')) { because('Backward compatibility') }
+}
+
 javadoc {
     exclude 'me/matsubara/**'
     exclude 'me/saiintbrisson/minecraft/utils/**'

framework/src/main/java/me/saiintbrisson/minecraft/AbstractVirtualView.java

@@ -50,6 +50,11 @@ public final ViewItem slot(int row, int column, Object item) {
 		throw new UnsupportedOperationException("not available");
 	}
 
+	@Override
+	public void with(@NotNull ViewItem item) {
+		throw new UnsupportedOperationException("not available");
+	}
+
 	@Override
 	public final void update() {
 		throw new UnsupportedOperationException("not available");

framework/src/main/java/me/saiintbrisson/minecraft/ViewItem.java

@@ -39,11 +39,7 @@ public ViewItem() {
 		this(-1);
 	}
 
-	/**
-	 * @deprecated Use {@link VirtualView#slot(int)} instead.
-	 */
-	@Deprecated
-	public ViewItem(final int slot) {
+	ViewItem(final int slot) {
 		this.slot = slot;
 	}
 

framework/src/main/java/me/saiintbrisson/minecraft/VirtualView.java

@@ -78,6 +78,8 @@ public interface VirtualView {
 	@NotNull
 	ViewItem slot(int row, int column, Object item);
 
+	void with(@NotNull ViewItem item);
+
 	void update();
 
 	void open(@NotNull final Object viewer, @NotNull final Map<String, Object> data);

kotlin-dsl/build.gradle.kts

@@ -0,0 +1,15 @@
+plugins {
+    kotlin("jvm") version "1.6.21"
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation(project(":framework"))
+}
+
+kotlin {
+    explicitApi()
+}

kotlin-dsl/src/main/kotlin/me/saiintbrisson/minecraft/annotations.kt

@@ -0,0 +1,13 @@
+package me.saiintbrisson.minecraft
+
+@DslMarker
+@Target(AnnotationTarget.FUNCTION)
+public annotation class ViewDsl
+
+@DslMarker
+@Target(AnnotationTarget.FUNCTION)
+public annotation class ContextDsl
+
+@DslMarker
+@Target(AnnotationTarget.FUNCTION)
+public annotation class SlotDsl

kotlin-dsl/src/main/kotlin/me/saiintbrisson/minecraft/builders.kt

@@ -0,0 +1,53 @@
+@file:Suppress("FunctionName")
+
+package me.saiintbrisson.minecraft
+
+public class ViewBuilder {
+
+    public var cancelOnClick: Boolean = false
+    public var cancelOnPickup: Boolean = false
+    public var cancelOnDrop: Boolean = false
+    public var cancelOnDrag: Boolean = false
+    public var cancelOnClone: Boolean = false
+    public var cancelOnMoveIn: Boolean = false
+    public var cancelOnMoveOut: Boolean = false
+    public var cancelOnShiftClick: Boolean = false
+    public var clearCursorOnClose: Boolean = false
+    public var closeOnOutsideClick: Boolean = false
+
+    internal var open: (OpenViewContext.() -> Unit)? = null
+    internal var render: ContextBlock? = null
+    internal var update: ContextBlock? = null
+    internal var click: SlotContextBlock? = null
+    internal var close: (CloseViewContext.() -> Unit)? = null
+    internal var hotbarInteract: HotbarInteractBlock? = null
+    internal var itemHold: SlotContextBlock? = null
+    internal var itemRelease: ItemReleaseBlock? = null
+    internal var moveOut: SlotMoveContextBlock? = null
+    internal var moveIn: SlotMoveContextBlock? = null
+
+    @PublishedApi
+    internal var slots: MutableList<ViewSlotBuilder> = mutableListOf()
+
+}
+
+public class ViewSlotBuilder(@PublishedApi internal val slot: Int) {
+
+    internal var render: SlotContextBlock? = null
+    internal var update: SlotContextBlock? = null
+    internal var click: SlotContextBlock? = null
+
+    public fun toItem(): ViewItem {
+        return ViewItem(slot).apply {
+            setHandler(click) { clickHandler = it }
+            setHandler(render) { renderHandler = it }
+            setHandler(update) { updateHandler = it }
+        }
+    }
+
+    private fun ViewItem.setHandler(
+        currentHandler: SlotContextBlock?,
+        assign: ViewItem.(ViewItemHandler) -> Unit
+    ) = currentHandler?.let { it -> assign(it) }
+
+}

kotlin-dsl/src/main/kotlin/me/saiintbrisson/minecraft/extensions.kt

@@ -0,0 +1,94 @@
+@file:Suppress("FunctionName")
+
+package me.saiintbrisson.minecraft
+
+internal typealias ContextBlock = ViewContext.() -> Unit
+internal typealias SlotContextBlock = ViewSlotContext.() -> Unit
+internal typealias SlotMoveContextBlock = ViewSlotMoveContext.() -> Unit
+internal typealias ItemReleaseBlock = ViewSlotContext.(to: ViewSlotContext) -> Unit
+internal typealias HotbarInteractBlock = ViewSlotContext.(hotbarButton: Int) -> Unit
+
+@ViewDsl
+public inline fun View(
+    rows: Int = 0,
+    title: String? = null,
+    content: ViewBuilder.() -> Unit
+): VirtualView {
+    val view = View(rows, title)
+    val builder = ViewBuilder().apply(content)
+    builder.slots.forEach { view.with(it.toItem()) }
+    return view
+}
+
+@SlotDsl
+public inline fun ViewBuilder.slot(
+    slot: Int,
+    block: ViewSlotBuilder.() -> Unit
+) {
+    slots.add(ViewSlotBuilder(slot).apply(block))
+}
+
+@ViewDsl
+public fun ViewBuilder.onOpen(block: OpenViewContext.() -> Unit) {
+    open = block
+}
+
+@ViewDsl
+public fun ViewBuilder.onClose(block: CloseViewContext.() -> Unit) {
+    close = block
+}
+
+@ViewDsl
+public fun ViewBuilder.onRender(block: ContextBlock) {
+    render = block
+}
+
+@ViewDsl
+public fun ViewBuilder.onUpdate(block: ContextBlock) {
+    update = block
+}
+
+@ViewDsl
+public fun ViewBuilder.onClick(block: SlotContextBlock) {
+    click = block
+}
+
+@ViewDsl
+public fun ViewBuilder.onHotbarInteract(block: HotbarInteractBlock) {
+    hotbarInteract = block
+}
+
+@ViewDsl
+public fun ViewBuilder.onItemHold(block: SlotContextBlock) {
+    itemHold = block
+}
+
+@ViewDsl
+public fun ViewBuilder.onItemRelease(block: ItemReleaseBlock) {
+    itemRelease = block
+}
+
+@ViewDsl
+public fun ViewBuilder.onMoveIn(block: SlotMoveContextBlock) {
+    moveIn = block
+}
+
+@ViewDsl
+public fun ViewBuilder.onMoveOut(block: SlotMoveContextBlock) {
+    moveOut = block
+}
+
+@ContextDsl
+public fun ViewSlotBuilder.onRender(block: SlotContextBlock) {
+    render = block
+}
+
+@ContextDsl
+public fun ViewSlotBuilder.onUpdate(block: SlotContextBlock) {
+    update = block
+}
+
+@ContextDsl
+public fun ViewSlotBuilder.onClick(block: SlotContextBlock) {
+    click = block
+}

settings.gradle

@@ -1,3 +1,3 @@
 rootProject.name = 'inventory-framework'
 enableFeaturePreview('VERSION_CATALOGS')
-include 'framework', 'framework:bukkit', 'framework:compat', 'plugin', 'examples', 'bom'
+include 'framework', 'framework:bukkit', 'framework:compat', 'plugin', 'examples', 'bom', 'kotlin-dsl'