Merge pull request #90 from DeathsGun/features/79_browsing_improvments

Better mod browsing by making categories multiselectable

Author: DeathsGun

src/main/kotlin/xyz/deathsgun/modmanager/api/gui/list/IListScreen.kt

@@ -24,4 +24,6 @@ interface IListScreen {
 
     fun <E> updateSelectedEntry(widget: Any, entry: E?)
 
+    fun <E> updateMultipleEntries(widget: Any, entries: ArrayList<E>)
+
 }

src/main/kotlin/xyz/deathsgun/modmanager/api/gui/list/ListWidget.kt

@@ -41,7 +41,7 @@ abstract class ListWidget<E : ListWidget.Entry<E>>(
     top: Int,
     var bottom: Int,
     itemHeight: Int,
-    private val parent: IListScreen
+    protected val parent: IListScreen
 ) : AlwaysSelectedEntryListWidget<E>(client, width, height, top, bottom, itemHeight) {
 
     var renderOutline: Boolean = true
@@ -141,7 +141,7 @@ abstract class ListWidget<E : ListWidget.Entry<E>>(
         super.appendNarrations(builder)
     }
 
-    fun isSelectedEntry(entry: Entry<E>): Boolean {
+    open fun isSelectedEntry(entry: Entry<E>): Boolean {
         return selectedId == entry.id
     }
 

src/main/kotlin/xyz/deathsgun/modmanager/api/gui/list/MultiSelectListWidget.kt

@@ -0,0 +1,87 @@
+/*
+ * Copyright 2021 DeathsGun
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package xyz.deathsgun.modmanager.api.gui.list
+
+import kotlinx.serialization.ExperimentalSerializationApi
+import net.minecraft.client.MinecraftClient
+
+/**
+ * Using ModMenu's implementation because the implementation from
+ * Mojang is broken. [com.terraformersmc.modmenu.gui.ModsScreen].
+ * All credits for this code go to the Terraformer's
+ */
+abstract class MultiSelectListWidget<E : MultiSelectListWidget.Entry<E>>(
+    client: MinecraftClient,
+    width: Int,
+    height: Int,
+    top: Int,
+    bottom: Int,
+    itemHeight: Int,
+    parent: IListScreen
+) : ListWidget<E>(client, width, height, top, bottom, itemHeight, parent) {
+
+    private var selectedIds = ArrayList<String>()
+
+    @OptIn(ExperimentalSerializationApi::class)
+    override fun setSelected(entry: E?) {
+        super.setSelected(entry)
+        if (entry == null) {
+            return
+        }
+        if (selectedIds.contains(entry.id)) {
+            selectedIds.removeIf { it == entry.id }
+        } else {
+            selectedIds.add(entry.id)
+        }
+        parent.updateMultipleEntries(
+            this,
+            ArrayList(children().filter { selectedIds.contains(it.id) }.sortedBy { selectedIds.indexOf(it.id) })
+        )
+    }
+
+    fun setSelected(entries: List<E>) {
+        selectedIds.clear()
+        for (entry in entries) {
+            setSelected(entry)
+        }
+    }
+
+    override fun isSelectedEntry(index: Int): Boolean {
+        return selectedIds.contains(getEntry(index).id)
+    }
+
+    override fun addEntry(entry: E): Int {
+        val i = super.addEntry(entry)
+        if (selectedIds.contains(entry.id)) {
+            setSelected(entry)
+        }
+        return i
+    }
+
+    override fun isSelectedEntry(entry: ListWidget.Entry<E>): Boolean {
+        return selectedIds.contains(entry.id)
+    }
+
+    abstract class Entry<E : Entry<E>>(list: MultiSelectListWidget<E>, id: String) :
+        ListWidget.Entry<E>(list, id) {
+        @Suppress("UNCHECKED_CAST")
+        override fun mouseClicked(mouseX: Double, mouseY: Double, button: Int): Boolean {
+            list.setSelected(this as E)
+            return true
+        }
+    }
+}

src/main/kotlin/xyz/deathsgun/modmanager/api/provider/IModProvider.kt

@@ -45,22 +45,24 @@ interface IModProvider : IModUpdateProvider {
     /**
      * Returns a limited number of [Mod]'s from the specified category
      *
-     * @param category the category of all the mods
-     * @param page     the requested from the UI starting at 1
-     * @param limit    to not overfill the ui and for shorter loading times the amount of returned mods needs to limited
+     * @param categories the categories of the mods
+     * @param sorting    the sorting order
+     * @param page       the requested from the UI starting at 1
+     * @param limit      to not overfill the ui and for shorter loading times the amount of returned mods needs to limited
      * @return a list of sorted mods
      */
-    fun getMods(category: Category, sorting: Sorting, page: Int, limit: Int): ModsResult
+    fun getMods(categories: List<Category>, sorting: Sorting, page: Int, limit: Int): ModsResult
 
     /**
      * Returns a limited number of [Mod]'s from a given search.
      *
      * @param query the search string
+     * @param categories the categories in which should be searched
      * @param page  the current requested page starts at 0
      * @param limit the amount of mods to return
      * @return a list of mods matching the search term
      */
-    fun search(query: String, sorting: Sorting, page: Int, limit: Int): ModsResult
+    fun search(query: String, categories: List<Category>, sorting: Sorting, page: Int, limit: Int): ModsResult
 
     /**
      * Returns a more detailed representation of the mod

src/main/kotlin/xyz/deathsgun/modmanager/gui/ModDetailScreen.kt

@@ -185,4 +185,7 @@ class ModDetailScreen(private val previousScreen: Screen, var mod: Mod) : Screen
     override fun <E> updateSelectedEntry(widget: Any, entry: E?) {
     }
 
+    override fun <E> updateMultipleEntries(widget: Any, entries: ArrayList<E>) {
+    }
+
 }

src/main/kotlin/xyz/deathsgun/modmanager/gui/ModUpdateInfoScreen.kt

@@ -142,4 +142,7 @@ class ModUpdateInfoScreen(private val previousScreen: Screen, private val update
     override fun <E> updateSelectedEntry(widget: Any, entry: E?) {
     }
 
+    override fun <E> updateMultipleEntries(widget: Any, entries: ArrayList<E>) {
+    }
+
 }

src/main/kotlin/xyz/deathsgun/modmanager/gui/ModsOverviewScreen.kt

@@ -46,7 +46,7 @@ class ModsOverviewScreen(private val previousScreen: Screen) : Screen(Translatab
 
     private var query: String = ""
     private var selectedMod: ModListEntry? = null
-    private var selectedCategory: CategoryListEntry? = null
+    private var selectedCategories: ArrayList<CategoryListEntry> = ArrayList()
     private var page: Int = 0
     private var limit: Int = 20
     private var scrollPercentage: Double = 0.0
@@ -137,13 +137,13 @@ class ModsOverviewScreen(private val previousScreen: Screen) : Screen(Translatab
                     modList.scrollAmount = scrollPercentage
                 }
             }
-            if (selectedCategory != null) {
-                if (selectedCategory!!.id == "updatable" && ModManager.modManager.update.updates.isEmpty()) {
+            if (selectedCategories.isNotEmpty()) {
+                if (selectedCategories.any { it.category.id == "updatable" } && ModManager.modManager.update.updates.isEmpty()) {
                     categoryList.setSelectedByIndex(0)
                     showModsByCategory()
                     return@launch
                 }
-                categoryList.setSelected(selectedCategory)
+                categoryList.setSelected(selectedCategories)
                 showModsByCategory()
                 modList.scrollAmount = scrollPercentage
                 return@launch
@@ -152,7 +152,7 @@ class ModsOverviewScreen(private val previousScreen: Screen) : Screen(Translatab
                 showModsBySearch()
                 return@launch
             }
-            categoryList.setSelectedByIndex(0)
+            showModsByCategory()
         }
         modList.init()
         categoryList.init()
@@ -178,38 +178,20 @@ class ModsOverviewScreen(private val previousScreen: Screen) : Screen(Translatab
             showModsBySearch()
             return
         }
-        if (selectedCategory == null) {
-            showModsByRelevance()
-            return
-        }
         showModsByCategory()
     }
 
-    private fun showModsByRelevance() {
-        val provider = ModManager.modManager.getSelectedProvider() ?: return
-        when (val result = provider.getMods(Sorting.RELEVANCE, page, limit)) {
-            is ModsResult.Error -> {
-                error = result.text
-            }
-            is ModsResult.Success -> {
-                error = null
-                modList.setMods(result.mods)
-            }
-        }
-    }
-
     private fun showModsByCategory() {
-        selectedCategory ?: return
         query = ""
         val provider = ModManager.modManager.getSelectedProvider() ?: return
-        if (selectedCategory!!.id == "updatable") {
+        if (selectedCategories.any { it.id == "updatable" }) {
             modList.clear()
             ModManager.modManager.update.updates.forEach {
                 modList.add(it.mod)
             }
             return
         }
-        when (val result = provider.getMods(selectedCategory!!.category, sorting, page, limit)) {
+        when (val result = provider.getMods(selectedCategories.map { it.category }, sorting, page, limit)) {
             is ModsResult.Error -> {
                 error = result.text
             }
@@ -232,7 +214,7 @@ class ModsOverviewScreen(private val previousScreen: Screen) : Screen(Translatab
 
     private fun showModsBySearch() {
         val provider = ModManager.modManager.getSelectedProvider() ?: return
-        when (val result = provider.search(this.query, sorting, page, limit)) {
+        when (val result = provider.search(this.query, selectedCategories.map { it.category }, sorting, page, limit)) {
             is ModsResult.Error -> {
                 this.error = result.text
             }
@@ -248,32 +230,44 @@ class ModsOverviewScreen(private val previousScreen: Screen) : Screen(Translatab
     }
 
     override fun <E> updateSelectedEntry(widget: Any, entry: E?) {
-        if (widget is ModListWidget) {
-            if (entry == null) {
-                return
-            }
-            if (selectedMod == entry) {
-                if (selectedCategory?.id == "updatable" && query.isEmpty()) {
-                    val update = ModManager.modManager.update.getUpdateForMod(selectedMod!!.mod) ?: return
-                    client?.setScreen(ModUpdateInfoScreen(this, update))
-                    return
-                }
-                client?.setScreen(ModDetailScreen(this, selectedMod!!.mod))
+        if (widget !is ModListWidget) {
+            return
+        }
+        if (entry == null) {
+            return
+        }
+        if (selectedMod == entry) {
+            if (selectedCategories.any { it.id == "updatable" } && query.isEmpty()) {
+                val update = ModManager.modManager.update.getUpdateForMod(selectedMod!!.mod) ?: return
+                client?.setScreen(ModUpdateInfoScreen(this, update))
                 return
             }
-            selectedMod = entry as ModListEntry
+            client?.setScreen(ModDetailScreen(this, selectedMod!!.mod))
             return
         }
-        if (widget is CategoryListWidget) {
-            if (entry == null) {
-                return
+        selectedMod = entry as ModListEntry
+    }
+
+    override fun <E> updateMultipleEntries(widget: Any, entries: ArrayList<E>) {
+        if (widget !is CategoryListWidget) {
+            return
+        }
+        modList.scrollAmount = 0.0
+        page = 0
+        @Suppress("UNCHECKED_CAST")
+        selectedCategories = entries as ArrayList<CategoryListEntry>
+        query = ""
+        if (selectedCategories.any { it.id == "updatable" } && selectedCategories.size > 1) {
+            val last = selectedCategories.last()
+            if (last.id == "updatable") {
+                selectedCategories.removeIf { it.category.id != "updatable" }
+            } else {
+                selectedCategories.removeIf { it.category.id == "updatable" }
             }
-            modList.scrollAmount = 0.0
-            page = 0
-            selectedCategory = entry as CategoryListEntry
-            query = ""
-            showModsByCategory()
+            categoryList.setSelected(selectedCategories)
+            return
         }
+        showModsByCategory()
     }
 
     override fun tick() {

src/main/kotlin/xyz/deathsgun/modmanager/gui/widget/CategoryListEntry.kt

@@ -21,12 +21,12 @@ import net.minecraft.client.util.math.MatrixStack
 import net.minecraft.text.OrderedText
 import net.minecraft.text.Text
 import net.minecraft.util.Language
-import xyz.deathsgun.modmanager.api.gui.list.ListWidget
+import xyz.deathsgun.modmanager.api.gui.list.MultiSelectListWidget
 import xyz.deathsgun.modmanager.api.mod.Category
 
 
-class CategoryListEntry(list: ListWidget<CategoryListEntry>, val category: Category) :
-    ListWidget.Entry<CategoryListEntry>(list, category.id) {
+class CategoryListEntry(list: MultiSelectListWidget<CategoryListEntry>, val category: Category) :
+    MultiSelectListWidget.Entry<CategoryListEntry>(list, category.id) {
 
     override fun render(
         matrices: MatrixStack?,

src/main/kotlin/xyz/deathsgun/modmanager/gui/widget/CategoryListWidget.kt

@@ -18,7 +18,7 @@ package xyz.deathsgun.modmanager.gui.widget
 
 import net.minecraft.client.MinecraftClient
 import xyz.deathsgun.modmanager.api.gui.list.IListScreen
-import xyz.deathsgun.modmanager.api.gui.list.ListWidget
+import xyz.deathsgun.modmanager.api.gui.list.MultiSelectListWidget
 import xyz.deathsgun.modmanager.api.mod.Category
 
 class CategoryListWidget(
@@ -29,7 +29,7 @@ class CategoryListWidget(
     bottom: Int,
     itemHeight: Int,
     parent: IListScreen
-) : ListWidget<CategoryListEntry>(client, width, height, top, bottom, itemHeight, parent) {
+) : MultiSelectListWidget<CategoryListEntry>(client, width, height, top, bottom, itemHeight, parent) {
 
     override fun init() {