Add "Goto Script" tab to the "Find Action" window

waleedyaseen · waleedyaseen · commit b6c340fde292 · 2024-08-30T01:41:17.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@
 - Support for varclan and varclansetting.
 - Trigger support for shiftop and onclick variants.
 - Support for "midi" type.
+- Add "Goto Script" tab to the "Find Action" window. 
 
 ### Changed
 
diff --git a/src/main/kotlin/io/runescript/plugin/ide/icons/RsIconProvider.kt b/src/main/kotlin/io/runescript/plugin/ide/icons/RsIconProvider.kt
@@ -0,0 +1,22 @@
+package io.runescript.plugin.ide.icons
+
+import com.intellij.ide.FileIconProvider
+import com.intellij.ide.IconProvider
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.psi.PsiElement
+import io.runescript.plugin.ide.RsIcons
+import io.runescript.plugin.ide.neptune.isNeptuneBuildFile
+import io.runescript.plugin.lang.psi.RsScript
+import io.runescript.plugin.lang.psi.mixin.getIconForTriggerName
+import io.runescript.plugin.lang.psi.triggerName
+import javax.swing.Icon
+
+class RsIconProvider : IconProvider() {
+    override fun getIcon(element: PsiElement, flags: Int): Icon? {
+        if (element is RsScript) {
+            return getIconForTriggerName(element.triggerName)
+        }
+        return null
+    }
+}
diff --git a/src/main/kotlin/io/runescript/plugin/ide/searchEverywhere/RsChooseByNameContributor.kt b/src/main/kotlin/io/runescript/plugin/ide/searchEverywhere/RsChooseByNameContributor.kt
@@ -1,21 +1,18 @@
-package io.runescript.plugin.ide
+package io.runescript.plugin.ide.searchEverywhere
 
 import com.intellij.navigation.ChooseByNameContributorEx
-import com.intellij.navigation.GotoClassContributor
 import com.intellij.navigation.NavigationItem
 import com.intellij.psi.search.GlobalSearchScope
 import com.intellij.psi.stubs.StubIndex
 import com.intellij.util.Processor
 import com.intellij.util.indexing.FindSymbolParameters
 import com.intellij.util.indexing.IdFilter
-import io.runescript.plugin.lang.RuneScript
 import io.runescript.plugin.lang.psi.RsScript
-import io.runescript.plugin.lang.psi.qualifiedName
 import io.runescript.plugin.lang.stubs.index.RsClientScriptIndex
 import io.runescript.plugin.lang.stubs.index.RsCommandScriptIndex
 import io.runescript.plugin.lang.stubs.index.RsProcScriptIndex
 
-class RsGotoClassContributor : ChooseByNameContributorEx, GotoClassContributor {
+class RsChooseByNameContributor : ChooseByNameContributorEx {
 
     private val keys = arrayOf(
         RsProcScriptIndex.KEY,
@@ -53,24 +50,4 @@ class RsGotoClassContributor : ChooseByNameContributorEx, GotoClassContributor {
             }
         }
     }
-
-    override fun getQualifiedName(item: NavigationItem): String? {
-        return (item as? RsScript)?.qualifiedName
-    }
-
-    override fun getQualifiedNameSeparator(): String {
-        return "|"
-    }
-
-    // These are only effective if we override the IdeLanguageCustomization
-
-    override fun getElementKind(): String {
-        return RsBundle.message("go.to.script.kind.text")
-    }
-
-    override fun getElementKindsPluralized(): List<String> {
-        return listOf(RsBundle.message("go.to.script.kind.text.pluralized"))
-    }
-
-    override fun getElementLanguage() = RuneScript
 }
diff --git a/src/main/kotlin/io/runescript/plugin/ide/searchEverywhere/RsGotoScriptModel.kt b/src/main/kotlin/io/runescript/plugin/ide/searchEverywhere/RsGotoScriptModel.kt
@@ -0,0 +1,60 @@
+package io.runescript.plugin.ide.searchEverywhere
+
+import com.intellij.ide.IdeBundle
+import com.intellij.ide.util.gotoByName.FilteringGotoByModel
+import com.intellij.navigation.ChooseByNameContributor
+import com.intellij.navigation.NavigationItem
+import com.intellij.openapi.project.Project
+import com.intellij.ui.IdeUICustomization
+import io.runescript.plugin.lang.psi.RsScript
+import io.runescript.plugin.lang.psi.qualifiedName
+
+class RsGotoScriptModel(project: Project) :
+    FilteringGotoByModel<RsTriggerRef>(project, emptyArray()) {
+
+    private val contributor = RsChooseByNameContributor()
+    private val separators = emptyArray<String>()
+
+    override fun getPromptText(): String {
+        return "Enter script name"
+    }
+
+    override fun getNotInMessage(): String {
+        return IdeUICustomization.getInstance().projectMessage("label.no.matches.found.in.project")
+    }
+
+    override fun getNotFoundMessage(): String {
+        return IdeBundle.message("label.no.matches.found");
+    }
+
+    override fun getCheckBoxName(): String? {
+        return null
+    }
+
+    override fun loadInitialCheckBoxState(): Boolean {
+        return false
+    }
+
+    override fun saveInitialCheckBoxState(state: Boolean) {
+    }
+
+    override fun getSeparators(): Array<String> {
+        return separators
+    }
+
+    override fun getFullName(item: Any): String? {
+        return (item as? RsScript)?.qualifiedName
+    }
+
+    override fun willOpenEditor(): Boolean {
+        return true
+    }
+
+    override fun filterValueFor(item: NavigationItem): RsTriggerRef? {
+        return RsTriggerRef.forNavigationItem(item)
+    }
+
+    override fun getContributorList(): MutableList<ChooseByNameContributor> {
+        return mutableListOf(contributor)
+    }
+}
diff --git a/src/main/kotlin/io/runescript/plugin/ide/searchEverywhere/RsGotoScriptSymbolConfiguration.kt b/src/main/kotlin/io/runescript/plugin/ide/searchEverywhere/RsGotoScriptSymbolConfiguration.kt
@@ -0,0 +1,19 @@
+package io.runescript.plugin.ide.searchEverywhere
+
+import com.intellij.ide.util.gotoByName.ChooseByNameFilterConfiguration
+import com.intellij.openapi.components.*
+import com.intellij.openapi.project.Project
+
+@Service(Service.Level.PROJECT)
+@State(name = "GotoScriptSymbolConfiguration", storages = [Storage(StoragePathMacros.WORKSPACE_FILE)])
+class RsGotoScriptSymbolConfiguration : ChooseByNameFilterConfiguration<RsTriggerRef>() {
+
+    companion object {
+        @JvmStatic
+        fun getInstance(project: Project): RsGotoScriptSymbolConfiguration = project.service()
+    }
+
+    override fun nameForElement(type: RsTriggerRef): String {
+        return type.displayName
+    }
+}
diff --git a/src/main/kotlin/io/runescript/plugin/ide/searchEverywhere/RsSearchEverywhereContributor.kt b/src/main/kotlin/io/runescript/plugin/ide/searchEverywhere/RsSearchEverywhereContributor.kt
@@ -0,0 +1,73 @@
+package io.runescript.plugin.ide.searchEverywhere
+
+import com.intellij.ide.actions.searcheverywhere.*
+import com.intellij.ide.actions.searcheverywhere.footer.createPsiExtendedInfo
+import com.intellij.ide.util.gotoByName.FilteringGotoByModel
+import com.intellij.openapi.actionSystem.AnAction
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.actionSystem.CommonDataKeys
+import com.intellij.openapi.project.Project
+
+class RsSearchEverywhereContributor(event: AnActionEvent) : AbstractGotoSEContributor(event),
+    SearchFieldActionsContributor {
+
+    private val filter = createTriggerFilter(event.getRequiredData(CommonDataKeys.PROJECT))
+
+    override fun getGroupName(): String {
+        return "Scripts"
+    }
+
+    override fun getFullGroupName(): String {
+        return "Scripts"
+    }
+
+    override fun getSortWeight(): Int {
+        return 400
+    }
+
+    override fun createModel(project: Project): FilteringGotoByModel<RsTriggerRef> {
+        val model = RsGotoScriptModel(project)
+        model.setFilterItems(filter.selectedElements)
+        return model
+    }
+
+    override fun getActions(onChanged: Runnable): List<AnAction> {
+        return doGetActions(filter, RsTriggerFilterCollector(), onChanged)
+    }
+
+    override fun isEmptyPatternSupported(): Boolean {
+        return true
+    }
+
+    @Suppress("OVERRIDE_DEPRECATION")
+    override fun getElementPriority(element: Any, searchPattern: String): Int {
+        return super.getElementPriority(element, searchPattern) + 5
+    }
+
+    override fun createExtendedInfo(): ExtendedInfo {
+        return createPsiExtendedInfo()
+    }
+
+    class Factory : SearchEverywhereContributorFactory<Any> {
+        override fun createContributor(initEvent: AnActionEvent): SearchEverywhereContributor<Any> {
+            return PSIPresentationBgRendererWrapper.wrapIfNecessary(RsSearchEverywhereContributor(initEvent))
+        }
+
+        override fun isAvailable(project: Project): Boolean {
+            return true
+        }
+    }
+
+    companion object {
+        fun createTriggerFilter(project: Project): PersistentSearchEverywhereContributorFilter<RsTriggerRef> {
+            val items = RsTriggerRef.forAllTriggers()
+            val persistentConfig = RsGotoScriptSymbolConfiguration.getInstance(project)
+            return PersistentSearchEverywhereContributorFilter(
+                items,
+                persistentConfig,
+                RsTriggerRef::displayName,
+                RsTriggerRef::icon
+            )
+        }
+    }
+}
diff --git a/src/main/kotlin/io/runescript/plugin/ide/searchEverywhere/RsTriggerFilterCollector.java b/src/main/kotlin/io/runescript/plugin/ide/searchEverywhere/RsTriggerFilterCollector.java
@@ -0,0 +1,10 @@
+package io.runescript.plugin.ide.searchEverywhere;
+
+import com.intellij.ide.actions.searcheverywhere.SearchEverywhereFiltersStatisticsCollector;
+
+public class RsTriggerFilterCollector extends SearchEverywhereFiltersStatisticsCollector.BaseFilterStatisticsCollector<RsTriggerRef> {
+
+    @Override
+    public void elementMarkChanged(RsTriggerRef element, boolean isMarked) {
+    }
+}
diff --git a/src/main/kotlin/io/runescript/plugin/ide/searchEverywhere/RsTriggerRef.kt b/src/main/kotlin/io/runescript/plugin/ide/searchEverywhere/RsTriggerRef.kt
@@ -0,0 +1,51 @@
+package io.runescript.plugin.ide.searchEverywhere
+
+import com.intellij.navigation.NavigationItem
+import com.intellij.openapi.util.text.StringUtil
+import io.runescript.plugin.ide.RsIcons
+import io.runescript.plugin.lang.psi.RsScript
+import io.runescript.plugin.lang.psi.triggerName
+import io.runescript.plugin.lang.psi.type.trigger.RsTriggerType
+import javax.swing.Icon
+
+data class RsTriggerRef(val displayName: String, val icon: Icon?) {
+
+    companion object {
+        @JvmStatic
+        fun forTrigger(trigger: RsTriggerType): RsTriggerRef = RsTriggerRef(
+            trigger.literal,
+            when (trigger) {
+                RsTriggerType.PROC -> RsIcons.GutterProc
+                RsTriggerType.CLIENTSCRIPT -> RsIcons.GutterClientScript
+                RsTriggerType.COMMAND -> RsIcons.GutterCommand
+                else -> RsIcons.GutterOther
+            }
+        )
+
+        @JvmStatic
+        fun forNavigationItem(item: NavigationItem): RsTriggerRef? {
+            val trigger = RsTriggerType.lookup((item as RsScript).triggerName) ?: return null
+            return forTrigger(trigger)
+        }
+
+        @JvmStatic
+        fun forAllTriggers(): List<RsTriggerRef> {
+            return RsTriggerType.values()
+                .sortedWith { a, b -> StringUtil.naturalCompare(a.literal, b.literal) }
+                .map { forTrigger(it) }
+        }
+    }
+
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as RsTriggerRef
+
+        return displayName == other.displayName
+    }
+
+    override fun hashCode(): Int {
+        return displayName.hashCode()
+    }
+}
diff --git a/src/main/kotlin/io/runescript/plugin/lang/psi/mixin/RsScriptMixin.kt b/src/main/kotlin/io/runescript/plugin/lang/psi/mixin/RsScriptMixin.kt
@@ -21,6 +21,7 @@ import io.runescript.plugin.ide.codeInsight.controlFlow.RsControlFlowBuilder
 import io.runescript.plugin.ide.highlight.RsSyntaxHighlighterColors
 import io.runescript.plugin.lang.psi.*
 import io.runescript.plugin.lang.stubs.RsScriptStub
+import javax.swing.Icon
 
 abstract class RsScriptMixin : StubBasedPsiElementBase<RsScriptStub>, RsScript {
 
@@ -36,7 +37,12 @@ abstract class RsScriptMixin : StubBasedPsiElementBase<RsScriptStub>, RsScript {
             CachedValueProvider.Result(controlFlow, this)
         }
 
-    override fun processDeclarations(processor: PsiScopeProcessor, state: ResolveState, lastParent: PsiElement?, place: PsiElement): Boolean {
+    override fun processDeclarations(
+        processor: PsiScopeProcessor,
+        state: ResolveState,
+        lastParent: PsiElement?,
+        place: PsiElement
+    ): Boolean {
         parameterList?.let {
             if (!it.processDeclarations(processor, state, lastParent, place)) {
                 return false
@@ -46,12 +52,7 @@ abstract class RsScriptMixin : StubBasedPsiElementBase<RsScriptStub>, RsScript {
     }
 
     override fun getPresentation(): ItemPresentation? {
-        val icon = when (triggerName) {
-            "proc" -> RsIcons.GutterProc
-            "clientscript" -> RsIcons.GutterClientScript
-            "command" -> RsIcons.GutterCommand
-            else -> RsIcons.GutterOther
-        }
+        val icon = getIconForTriggerName(triggerName)
         return PresentationData(qualifiedName, containingFile.name, icon, RsSyntaxHighlighterColors.SCRIPT_DECLARATION)
     }
 
@@ -75,4 +76,13 @@ abstract class RsScriptMixin : StubBasedPsiElementBase<RsScriptStub>, RsScript {
     override fun getTextOffset(): Int {
         return scriptNameExpression.startOffset
     }
+}
+
+fun getIconForTriggerName(triggerName: String): Icon {
+    return when (triggerName) {
+        "proc" -> RsIcons.GutterProc
+        "clientscript" -> RsIcons.GutterClientScript
+        "command" -> RsIcons.GutterCommand
+        else -> RsIcons.GutterOther
+    }
 }
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
@@ -15,6 +15,7 @@
                   implementationClass="io.runescript.plugin.ide.filetypes.RsFileType" fieldName="INSTANCE"
                   extensions="cs2"/>
         <fileIconProvider order="first" implementation="io.runescript.plugin.ide.icons.NeptuneIconProvider" />
+        <iconProvider implementation="io.runescript.plugin.ide.icons.RsIconProvider" />
 
         <!-- Project & Modules -->
         <moduleBuilder builderClass="io.runescript.plugin.ide.projectWizard.NeptuneModuleBuilder"/>
@@ -42,7 +43,7 @@
         <stubIndex implementation="io.runescript.plugin.lang.stubs.index.RsClientScriptIndex"/>
         <stubIndex implementation="io.runescript.plugin.lang.stubs.index.RsCommandScriptIndex"/>
         <stubIndex implementation="io.runescript.plugin.lang.stubs.index.RsScriptIndex"/>
-        <gotoClassContributor implementation="io.runescript.plugin.ide.RsGotoClassContributor"/>
+        <searchEverywhereContributor implementation="io.runescript.plugin.ide.searchEverywhere.RsSearchEverywhereContributor$Factory"/>
         <lang.elementManipulator forClass="io.runescript.plugin.lang.psi.RsGosubExpression" implementationClass="io.runescript.plugin.lang.psi.manipulator.RsGosubExpressionManipulator"/>
         <lang.elementManipulator forClass="io.runescript.plugin.lang.psi.RsStringLiteralContent" implementationClass="io.runescript.plugin.lang.psi.manipulator.RsStringLiteralContentManipulator"/>
         <lang.elementManipulator forClass="io.runescript.plugin.lang.doc.psi.impl.RsDocName" implementationClass="io.runescript.plugin.lang.psi.manipulator.RsDocNameManipulator"/>
