Inventory GUI update

- new Slot constants
- introduced "internal" philosophy
- renamed InventoryGUIType to InventoryType

src/main/kotlin/net/axay/kspigot/inventory/InventoryGUI.kt

@@ -3,13 +3,9 @@
 package net.axay.kspigot.inventory
 
 import net.axay.kspigot.event.listen
-import net.axay.kspigot.event.register
 import net.axay.kspigot.main.KSpigot
 import org.bukkit.entity.HumanEntity
-import org.bukkit.event.EventHandler
-import org.bukkit.event.Listener
 import org.bukkit.event.inventory.InventoryClickEvent
-import org.bukkit.event.inventory.InventoryInteractEvent
 import org.bukkit.inventory.Inventory
 import org.bukkit.inventory.InventoryView
 
@@ -71,7 +67,7 @@ class InventoryGUIClickEvent(
 
 class InventoryGUIData(
         val plugin: KSpigot,
-        val inventoryGUIType: InventoryGUIType<*>,
+        val inventoryType: InventoryType<*>,
         val title: String?,
         val pages: Map<Int, InventoryGUIPage>
 )
@@ -99,7 +95,7 @@ class InventoryGUIShared(
         inventoryGUIData: InventoryGUIData
 ) : InventoryGUI(inventoryGUIData) {
 
-    override val bukkitInventory by lazy { data.inventoryGUIType.createBukkitInv(null, data.title) }
+    override val bukkitInventory by lazy { data.inventoryType.createBukkitInv(null, data.title) }
 
     override fun isThisInv(inventory: Inventory) = inventory == bukkitInventory
 
@@ -111,7 +107,7 @@ class InventoryGUIShared(
 
         data.pages[page]?.slots?.let { slots ->
 
-            val dimensions = data.inventoryGUIType.dimensions
+            val dimensions = data.inventoryType.dimensions
 
             if (ifOffset()) {
                 dimensions.invSlots.forEach {

src/main/kotlin/net/axay/kspigot/inventory/InventoryGUIBuilder.kt

@@ -6,13 +6,13 @@ import net.axay.kspigot.main.KSpigot
 import org.bukkit.inventory.ItemStack
 
 inline fun <T : ForInventory> KSpigot.inventoryGUI(
-        type: InventoryGUIType<T>,
+        type: InventoryType<T>,
         builder: InventoryGUIBuilder<T>.() -> Unit,
 ) = InventoryGUIBuilder(this, type).apply(builder).build()
 
 class InventoryGUIBuilder<in T : ForInventory>(
         private val kSpigot: KSpigot,
-        val type: InventoryGUIType<in T>
+        val type: InventoryType<in T>
 ) {
 
     var title: String = ""
@@ -31,7 +31,7 @@ class InventoryGUIBuilder<in T : ForInventory>(
 }
 
 class InventoryGUIPageBuilder<in T : ForInventory>(
-        val type: InventoryGUIType<in T>,
+        val type: InventoryType<in T>,
         val page: Int
 ) {
 
@@ -99,7 +99,7 @@ class InventoryGUIPageBuilder<in T : ForInventory>(
         ))
 
     private fun slots(slots: InventorySlotCompound<T>, element: InventoryGUISlot)
-        = slots.withGUIType(type).forEach { curSlot ->
+        = slots.withInvType(type).forEach { curSlot ->
             curSlot.realSlotIn(type.dimensions)?.let { guiSlots[it] = element  }
         }
 

src/main/kotlin/net/axay/kspigot/inventory/InventoryGUIPageChange.kt

@@ -38,7 +38,7 @@ class InventoryGUIPageChanger(private val effect: InventoryGUIPageChangeEffect)
 
             InventoryGUIPageChangeEffect.SLIDE_HORIZONTALLY -> {
 
-                val width = gui.data.inventoryGUIType.dimensions.width
+                val width = gui.data.inventoryType.dimensions.width
 
                 changePageEffect(gui.data.plugin, fromPage, toPage, width) { currentOffset, ifInverted ->
                     if (ifInverted) {
@@ -54,7 +54,7 @@ class InventoryGUIPageChanger(private val effect: InventoryGUIPageChangeEffect)
 
             InventoryGUIPageChangeEffect.SLIDE_VERTICALLY -> {
 
-                val height = gui.data.inventoryGUIType.dimensions.heigth
+                val height = gui.data.inventoryType.dimensions.heigth
 
                 changePageEffect(gui.data.plugin, fromPage, toPage, height) { currentOffset, ifInverted ->
                     if (ifInverted) {
@@ -70,7 +70,7 @@ class InventoryGUIPageChanger(private val effect: InventoryGUIPageChangeEffect)
 
             InventoryGUIPageChangeEffect.SWIPE_HORIZONTALLY -> {
 
-                val width = gui.data.inventoryGUIType.dimensions.width
+                val width = gui.data.inventoryType.dimensions.width
 
                 changePageEffect(gui.data.plugin, fromPage, toPage, width) { currentOffset, ifInverted ->
                     if (ifInverted) {
@@ -84,7 +84,7 @@ class InventoryGUIPageChanger(private val effect: InventoryGUIPageChangeEffect)
 
             InventoryGUIPageChangeEffect.SWIPE_VERTICALLY -> {
 
-                val height = gui.data.inventoryGUIType.dimensions.heigth
+                val height = gui.data.inventoryType.dimensions.heigth
 
                 changePageEffect(gui.data.plugin, fromPage, toPage, height) { currentOffset, ifInverted ->
                     if (ifInverted) {

src/main/kotlin/net/axay/kspigot/inventory/InventoryGUISlots.kt

@@ -2,6 +2,8 @@
 
 package net.axay.kspigot.inventory
 
+import net.axay.kspigot.kotlinextensions.MinMaxPair
+
 // INVENTORY
 
 data class InventoryDimensions(val width: Int, val heigth: Int) {
@@ -69,24 +71,28 @@ data class InventorySlot(val row: Int, val slotInRow: Int) : Comparable<Inventor
 
 }
 
-interface InventorySlotCompound<out T : ForInventory> {
+internal interface InventorySlotCompound<out T : ForInventory> {
-    fun withGUIType(invType: InventoryGUIType<in T>): Collection<InventorySlot>
+    fun withInvType(invType: InventoryType<in T>): Collection<InventorySlot>
 }
 
-open class SingleInventorySlot<out T : ForInventory>(val inventorySlot: InventorySlot)
+open class SingleInventorySlot<out T : ForInventory> internal constructor(
-    : InventorySlotCompound<T> {
+        val inventorySlot: InventorySlot
+) : InventorySlotCompound<T> {
 
     constructor(row: Int, slotInRow: Int) : this(InventorySlot(row, slotInRow))
 
     private val slotAsList = listOf(inventorySlot)
 
-    override fun withGUIType(invType: InventoryGUIType<in T>) = slotAsList
+    override fun withInvType(invType: InventoryType<in T>) = slotAsList
 
 }
 
-enum class InventorySlotRangeType { LINEAR, RECTANGLE }
+internal enum class InventorySlotRangeType {
+    LINEAR,
+    RECTANGLE,
+}
 
-class InventorySlotRange<out T : ForInventory> (
+class InventorySlotRange<out T : ForInventory> internal constructor(
 
         startSlot: SingleInventorySlot<T>,
         endSlot: SingleInventorySlot<T>,
@@ -99,16 +105,12 @@ class InventorySlotRange<out T : ForInventory> (
     override val endInclusive: InventorySlot
 
     init {
-        if (startSlot.inventorySlot <= endSlot.inventorySlot) {
+        val minMaxPair = MinMaxPair(startSlot.inventorySlot, endSlot.inventorySlot)
-            start = startSlot.inventorySlot
+        start = minMaxPair.min
-            endInclusive = endSlot.inventorySlot
+        endInclusive = minMaxPair.max
-        } else {
-            start = endSlot.inventorySlot
-            endInclusive = startSlot.inventorySlot
-        }
     }
 
-    override fun withGUIType(invType: InventoryGUIType<in T>)
+    override fun withInvType(invType: InventoryType<in T>)
         = LinkedHashSet<InventorySlot>().apply {
             when (type) {
 
@@ -145,24 +147,107 @@ class InventorySlotRange<out T : ForInventory> (
 
 }
 
-// SLOT RANGE OPERATOR FUNCTIONS
+/**
-
+ * This range contains all slots having an index between
+ * the indeces of the two given slots.
+ */
 infix fun <T : ForInventory> SingleInventorySlot<T>.linTo(slot: SingleInventorySlot<T>)
         = InventorySlotRange(this, slot, InventorySlotRangeType.LINEAR)
 
+/**
+ * This range contains all slots inside of a thought rectangle
+ * with the two given slots as two opposite corners of the rectangle.
+ */
 infix fun <T : ForInventory> SingleInventorySlot<T>.rectTo(slot: SingleInventorySlot<T>)
         = InventorySlotRange(this, slot, InventorySlotRangeType.RECTANGLE)
 
+class InventoryRowSlots<out T : ForInventory> internal constructor(
+        val row: Int
+) : InventorySlotCompound<T> {
+
+    override fun withInvType(invType: InventoryType<in T>) = HashSet<InventorySlot>().apply {
+        for (slotInRow in 1 .. invType.dimensions.width)
+            this += InventorySlot(row, slotInRow)
+    }
+
+}
+
+class InventoryColumnSlots<out T : ForInventory> internal constructor(
+        val column: Int
+) : InventorySlotCompound<T> {
+
+    override fun withInvType(invType: InventoryType<in T>) = HashSet<InventorySlot>().apply {
+        for (row in 1 .. invType.dimensions.heigth)
+            this += InventorySlot(row, column)
+    }
+
+}
+
+class InventoryBorderSlots<out T : ForInventory> internal constructor(
+        val padding: Int
+) : InventorySlotCompound<T> {
+
+    override fun withInvType(invType: InventoryType<in T>) = HashSet<InventorySlot>().apply {
+
+        val dimensions = invType.dimensions
+
+        for (currentPadding in 0 until padding) {
+            for (slotInRow in 1 + currentPadding .. dimensions.width - currentPadding) {
+                this += InventorySlot(1, slotInRow)
+                this += InventorySlot(dimensions.heigth, slotInRow)
+            }
+            for (row in 2 + currentPadding until dimensions.heigth - currentPadding) {
+                this += InventorySlot(row, 1)
+                this += InventorySlot(row, dimensions.width)
+            }
+        }
+
+    }
+
+}
+
+class InventoryCornerSlots<out T : ForInventory> internal constructor(
+        val ifBottomLeft: Boolean = false,
+        val ifBottomRight: Boolean = false,
+        val ifTopLeft: Boolean = false,
+        val ifTopRight: Boolean = false
+)  : InventorySlotCompound<T> {
+
+    override fun withInvType(invType: InventoryType<in T>) = HashSet<InventorySlot>().apply {
+
+        val dimensions = invType.dimensions
+
+        if (ifBottomLeft) this += InventorySlot(1, 1)
+        if (ifBottomRight) this += InventorySlot(1, dimensions.width)
+        if (ifTopLeft) this += InventorySlot(dimensions.heigth, 1)
+        if (ifTopRight) this += InventorySlot(dimensions.heigth, dimensions.width)
+
+    }
+
+}
+
 // SLOT TYPE SAFETY
 
+// COLUMNS
+
+interface ForColumnOne : ForInventoryWidthThree, ForInventoryWidthFive, ForInventoryWidthNine
+interface ForColumnTwo : ForInventoryWidthThree, ForInventoryWidthFive, ForInventoryWidthNine
+interface ForColumnThree : ForInventoryWidthThree, ForInventoryWidthFive, ForInventoryWidthNine
+interface ForColumnFour : ForInventoryWidthFive, ForInventoryWidthNine
+interface ForColumnFive : ForInventoryWidthFive, ForInventoryWidthNine
+interface ForColumnSix : ForInventoryWidthNine
+interface ForColumnSeven : ForInventoryWidthNine
+interface ForColumnEight : ForInventoryWidthNine
+interface ForColumnNine : ForInventoryWidthNine
+
 // ROWS
+
 interface ForRowOne : ForInventoryOneByNine, ForInventoryTwoByNine, ForInventoryThreeByNine, ForInventoryFourByNine, ForInventoryFiveByNine, ForInventorySixByNine
 interface ForRowTwo : ForInventoryTwoByNine, ForInventoryThreeByNine, ForInventoryFourByNine, ForInventoryFiveByNine, ForInventorySixByNine
 interface ForRowThree : ForInventoryThreeByNine, ForInventoryFourByNine, ForInventoryFiveByNine, ForInventorySixByNine
 interface ForRowFour : ForInventoryFourByNine, ForInventoryFiveByNine, ForInventorySixByNine
 interface ForRowFive : ForInventoryFiveByNine, ForInventorySixByNine
 interface ForRowSix : ForInventorySixByNine
-
 // EDGE CASES:
 // ROW ONE
 interface ForRowOneSlotOneToThree : ForRowOne, ForInventoryOneByFive, ForInventoryThreeByThree
@@ -171,8 +256,13 @@ interface ForRowOneSlotFourToFive : ForRowOne, ForInventoryOneByFive
 interface ForRowTwoSlotOneToThree : ForRowTwo, ForInventoryThreeByThree
 // ROW THREE
 interface ForRowThreeSlotOneToThree : ForRowThree, ForInventoryThreeByThree
+// COMPLETE ROWS (including the edge cases)
+interface ForCompleteRowOne : ForRowOne, ForRowOneSlotOneToThree, ForRowOneSlotFourToFive
+interface ForCompleteRowTwo : ForRowTwo, ForRowTwoSlotOneToThree
+interface ForCompleteRowThree : ForRowThree, ForRowThreeSlotOneToThree
 
 object Slots {
+
     // ROW ONE
     val RowOneSlotOne = SingleInventorySlot<ForRowOneSlotOneToThree>(1, 1)
     val RowOneSlotTwo = SingleInventorySlot<ForRowOneSlotOneToThree>(1, 2)
@@ -233,4 +323,41 @@ object Slots {
     val RowSixSlotSeven = SingleInventorySlot<ForRowSix>(6, 7)
     val RowSixSlotEight = SingleInventorySlot<ForRowSix>(6, 8)
     val RowSixSlotNine = SingleInventorySlot<ForRowSix>(6, 9)
+
+    // ROW
+    val RowOne = InventoryRowSlots<ForCompleteRowOne>(1)
+    val RowTwo = InventoryRowSlots<ForCompleteRowTwo>(2)
+    val RowThree = InventoryRowSlots<ForCompleteRowThree>(3)
+    val RowFour = InventoryRowSlots<ForRowFour>(4)
+    val RowFive = InventoryRowSlots<ForRowFive>(5)
+    val RowSix = InventoryRowSlots<ForRowSix>(6)
+
+    // COLUMN
+    val ColumnOne = InventoryColumnSlots<ForColumnOne>(1)
+    val ColumnTwo = InventoryColumnSlots<ForColumnTwo>(2)
+    val ColumnThree = InventoryColumnSlots<ForColumnThree>(3)
+    val ColumnFour = InventoryColumnSlots<ForColumnFour>(4)
+    val ColumnFive = InventoryColumnSlots<ForColumnFive>(5)
+    val ColumnSix = InventoryColumnSlots<ForColumnSix>(6)
+    val ColumnSeven = InventoryColumnSlots<ForColumnSeven>(7)
+    val ColumnEight = InventoryColumnSlots<ForColumnEight>(8)
+    val ColumnNine = InventoryColumnSlots<ForColumnNine>(9)
+
+    // BORDER
+    val BorderPaddingOne = InventoryBorderSlots<ForEveryInventory>(1)
+    val BorderPaddingTwo = InventoryBorderSlots<ForEveryInventory>(2)
+    val BorderPaddingThree = InventoryBorderSlots<ForEveryInventory>(3)
+    val Border = BorderPaddingOne
+
+    // CORNER
+    val Corners = InventoryCornerSlots<ForEveryInventory>()
+    val CornersLeft = InventoryCornerSlots<ForEveryInventory>(ifBottomLeft = true, ifTopLeft = true)
+    val CornersRight = InventoryCornerSlots<ForEveryInventory>(ifBottomRight = true, ifTopRight = true)
+    val CornersBottom = InventoryCornerSlots<ForEveryInventory>(ifBottomLeft = true, ifBottomRight = true)
+    val CornersTop = InventoryCornerSlots<ForEveryInventory>(ifTopLeft = true, ifTopRight = true)
+    val CornerBottomLeft = InventoryCornerSlots<ForEveryInventory>(ifBottomLeft = true)
+    val CornerBottomRight = InventoryCornerSlots<ForEveryInventory>(ifBottomRight = true)
+    val CornerTopLeft = InventoryCornerSlots<ForEveryInventory>(ifTopLeft = true)
+    val CornerTopRight = InventoryCornerSlots<ForEveryInventory>(ifTopRight = true)
+
 }

src/main/kotlin/net/axay/kspigot/inventory/InventoryType.kt

@@ -7,7 +7,7 @@ import org.bukkit.event.inventory.InventoryType
 import org.bukkit.inventory.Inventory
 import org.bukkit.inventory.InventoryHolder
 
-class InventoryGUIType<T : ForInventory>(
+class InventoryType<T : ForInventory>(
         val dimensions: InventoryDimensions,
         val bukkitType: InventoryType? = null
 ) {
@@ -16,14 +16,14 @@ class InventoryGUIType<T : ForInventory>(
 
     companion object {
 
-        val ONE_BY_NINE = InventoryGUIType<ForInventoryOneByNine>(InventoryDimensions(9, 1))
+        val ONE_BY_NINE = InventoryType<ForInventoryOneByNine>(InventoryDimensions(9, 1))
-        val TWO_BY_NINE = InventoryGUIType<ForInventoryTwoByNine>(InventoryDimensions(9, 2))
+        val TWO_BY_NINE = InventoryType<ForInventoryTwoByNine>(InventoryDimensions(9, 2))
-        val THREE_BY_NINE = InventoryGUIType<ForInventoryThreeByNine>(InventoryDimensions(9, 3))
+        val THREE_BY_NINE = InventoryType<ForInventoryThreeByNine>(InventoryDimensions(9, 3))
-        val FOUR_BY_NINE = InventoryGUIType<ForInventoryFourByNine>(InventoryDimensions(9, 4))
+        val FOUR_BY_NINE = InventoryType<ForInventoryFourByNine>(InventoryDimensions(9, 4))
-        val FIVE_BY_NINE = InventoryGUIType<ForInventoryFiveByNine>(InventoryDimensions(9, 5))
+        val FIVE_BY_NINE = InventoryType<ForInventoryFiveByNine>(InventoryDimensions(9, 5))
-        val SIX_BY_NINE = InventoryGUIType<ForInventorySixByNine>(InventoryDimensions(9, 6))
+        val SIX_BY_NINE = InventoryType<ForInventorySixByNine>(InventoryDimensions(9, 6))
-        val ONE_BY_FIVE = InventoryGUIType<ForInventoryOneByFive>(InventoryDimensions(5, 1), bukkitType = InventoryType.HOPPER)
+        val ONE_BY_FIVE = InventoryType<ForInventoryOneByFive>(InventoryDimensions(5, 1), bukkitType = InventoryType.HOPPER)
-        val THREE_BY_THREE = InventoryGUIType<ForInventoryThreeByThree>(InventoryDimensions(3, 3), bukkitType = InventoryType.DROPPER)
+        val THREE_BY_THREE = InventoryType<ForInventoryThreeByThree>(InventoryDimensions(3, 3), bukkitType = InventoryType.DROPPER)
 
     }
 
@@ -53,4 +53,8 @@ interface ForInventoryOneByFive : ForInventory
 interface ForEveryInventory
     : ForInventoryOneByNine, ForInventoryTwoByNine, ForInventoryThreeByNine,
         ForInventoryFourByNine, ForInventoryFiveByNine, ForInventorySixByNine,
-        ForInventoryThreeByThree, ForInventoryOneByFive
+        ForInventoryThreeByThree, ForInventoryOneByFive
+
+interface ForInventoryWidthThree : ForInventoryThreeByThree
+interface ForInventoryWidthFive : ForInventoryOneByFive
+interface ForInventoryWidthNine : ForInventoryOneByNine, ForInventoryTwoByNine, ForInventoryThreeByNine, ForInventoryFourByNine, ForInventoryFiveByNine, ForInventorySixByNine