Implement vim-style navigation for menu popups

src/main/kotlin/com/chylex/intellij/keyboardmaster/PluginStartup.kt

@@ -1,6 +1,8 @@
 package com.chylex.intellij.keyboardmaster
 
+import com.chylex.intellij.keyboardmaster.configuration.PluginConfiguration
 import com.chylex.intellij.keyboardmaster.feature.codeCompletion.CodeCompletionPopupKeyHandler
+import com.chylex.intellij.keyboardmaster.feature.vimNavigation.VimNavigation
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.startup.ProjectActivity
@@ -12,13 +14,20 @@ class PluginStartup : ProjectActivity {
 		if (!isInitialized) {
 			isInitialized = true
 			
+			PluginConfiguration.load()
+			
 			val application = ApplicationManager.getApplication()
 			if (application.isUnitTestMode) {
-				CodeCompletionPopupKeyHandler.registerRawHandler()
+				initialize()
 			}
 			else {
-				application.invokeLater(CodeCompletionPopupKeyHandler.Companion::registerRawHandler)
+				application.invokeLater(::initialize)
 			}
 		}
 	}
+	
+	private fun initialize() {
+		CodeCompletionPopupKeyHandler.registerRawHandler()
+		VimNavigation.register()
+	}
 }

src/main/kotlin/com/chylex/intellij/keyboardmaster/configuration/PluginConfigurable.kt

@@ -1,6 +1,8 @@
 package com.chylex.intellij.keyboardmaster.configuration
 
 import com.intellij.openapi.options.Configurable
+import com.intellij.openapi.ui.Messages
+import com.intellij.ui.components.JBCheckBox
 import com.intellij.ui.components.JBTextField
 import com.intellij.ui.dsl.builder.panel
 import javax.swing.JComponent
@@ -12,6 +14,14 @@ class PluginConfigurable : Configurable {
 	private val codeCompletionNextPageShortcut = JBTextField(2)
 	private val codeCompletionPrevPageShortcut = JBTextField(2)
 	
+	private val enableVimNavigation = JBCheckBox("Vim-style navigation in lists / trees / tables").also { checkBox ->
+		checkBox.addActionListener {
+			if (!checkBox.isSelected) {
+				Messages.showInfoMessage(checkBox, "Vim-style navigation will be disabled after restarting the IDE.", "Keyboard Master")
+			}
+		}
+	}
+	
 	override fun getDisplayName(): String {
 		return "Keyboard Master"
 	}
@@ -23,6 +33,10 @@ class PluginConfigurable : Configurable {
 				row("Next page shortcut:") { cell(codeCompletionNextPageShortcut) }
 				row("Prev page shortcut:") { cell(codeCompletionPrevPageShortcut) }
 			}
+			
+			group("Navigation") {
+				row { cell(enableVimNavigation) }
+			}
 		}
 		
 		return component
@@ -37,6 +51,8 @@ class PluginConfigurable : Configurable {
 			it.codeCompletionItemShortcuts = codeCompletionItemShortcuts.text
 			it.codeCompletionNextPageShortcut = codeCompletionNextPageShortcut.text.firstOrNull()?.code ?: 0
 			it.codeCompletionPrevPageShortcut = codeCompletionPrevPageShortcut.text.firstOrNull()?.code ?: 0
+			
+			it.enableVimNavigation = enableVimNavigation.isSelected
 		}
 	}
 	
@@ -45,6 +61,8 @@ class PluginConfigurable : Configurable {
 			codeCompletionItemShortcuts.text = it.codeCompletionItemShortcuts
 			codeCompletionNextPageShortcut.text = it.codeCompletionNextPageShortcut.let { code -> if (code == 0) "" else code.toChar().toString() }
 			codeCompletionPrevPageShortcut.text = it.codeCompletionPrevPageShortcut.let { code -> if (code == 0) "" else code.toChar().toString() }
+			
+			enableVimNavigation.isSelected = it.enableVimNavigation
 		}
 	}
 }

src/main/kotlin/com/chylex/intellij/keyboardmaster/configuration/PluginConfiguration.kt

@@ -1,6 +1,7 @@
 package com.chylex.intellij.keyboardmaster.configuration
 
 import com.chylex.intellij.keyboardmaster.feature.codeCompletion.CodeCompletionPopupConfiguration
+import com.chylex.intellij.keyboardmaster.feature.vimNavigation.VimNavigation
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.components.PersistentStateComponent
 import com.intellij.openapi.components.State
@@ -16,6 +17,8 @@ class PluginConfiguration : PersistentStateComponent<PluginConfiguration> {
 	var codeCompletionNextPageShortcut: Int = '0'.code
 	var codeCompletionPrevPageShortcut: Int = 0
 	
+	var enableVimNavigation = false
+	
 	companion object {
 		private val instance: PluginConfiguration
 			get() = ApplicationManager.getApplication().getService(PluginConfiguration::class.java)
@@ -34,6 +37,7 @@ class PluginConfiguration : PersistentStateComponent<PluginConfiguration> {
 		
 		private fun update(instance: PluginConfiguration) = with(instance) {
 			CodeCompletionPopupConfiguration.updateShortcuts(codeCompletionItemShortcuts, codeCompletionNextPageShortcut, codeCompletionPrevPageShortcut)
+			VimNavigation.setEnabled(enableVimNavigation)
 		}
 	}
 	

src/main/kotlin/com/chylex/intellij/keyboardmaster/feature/codeCompletion/CodeCompletionPopupConfiguration.kt

@@ -1,6 +1,5 @@
 package com.chylex.intellij.keyboardmaster.feature.codeCompletion
 
-import com.chylex.intellij.keyboardmaster.configuration.PluginConfiguration
 import com.intellij.util.containers.IntIntHashMap
 
 object CodeCompletionPopupConfiguration {
@@ -14,10 +13,6 @@ object CodeCompletionPopupConfiguration {
 	val itemShortcutCount
 		get() = hintTexts.size
 	
-	init {
-		PluginConfiguration.load()
-	}
-	
 	fun updateShortcuts(itemShortcutChars: String, nextPageShortcutCode: Int, previousPageShortcutCode: Int) {
 		charToShortcutMap.clear()
 		

src/main/kotlin/com/chylex/intellij/keyboardmaster/feature/vimNavigation/ComponentHolder.kt

@@ -1,7 +1,11 @@
 package com.chylex.intellij.keyboardmaster.feature.vimNavigation
 
+import com.intellij.ui.popup.WizardPopup
 import javax.swing.JComponent
 
 internal interface ComponentHolder {
 	val component: JComponent
+	
+	val popup: WizardPopup?
+		get() = null
 }

src/main/kotlin/com/chylex/intellij/keyboardmaster/feature/vimNavigation/VimNavigation.kt

@@ -4,28 +4,62 @@ import com.chylex.intellij.keyboardmaster.PluginDisposableService
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.components.VimListNavigation
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.components.VimTableNavigation
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.components.VimTreeNavigation
-import com.intellij.ide.ApplicationInitializedListener
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.ui.UiInterceptors
 import com.intellij.util.ui.StartupUiUtil
-import kotlinx.coroutines.CoroutineScope
 import java.awt.AWTEvent
 import java.awt.event.FocusEvent
+import java.util.concurrent.atomic.AtomicBoolean
 import javax.swing.JList
 import javax.swing.JTable
 import javax.swing.JTree
+import javax.swing.KeyStroke
+import javax.swing.UIManager
 
-@Suppress("UnstableApiUsage")
+object VimNavigation {
-internal class VimNavigationApplicationListener : ApplicationInitializedListener {
+	private val isEnabled = AtomicBoolean(false)
-	override suspend fun execute(asyncScope: CoroutineScope) {
+	private var originalPopupBindings: Array<*>? = null
+	
+	fun register() {
 		val disposable = ApplicationManager.getApplication().getService(PluginDisposableService::class.java)
 		
 		StartupUiUtil.addAwtListener(::handleEvent, AWTEvent.FOCUS_EVENT_MASK, disposable)
 		UiInterceptors.registerPersistent(disposable, PopupInterceptor)
 	}
 	
+	fun setEnabled(enabled: Boolean) {
+		if (!isEnabled.compareAndSet(!enabled, enabled)) {
+			return
+		}
+		
+		if (enabled) {
+			val originalBindings = (UIManager.get("PopupMenu.selectedWindowInputMapBindings") as Array<*>).also { originalPopupBindings = it }
+			val updatedBindings = mutableListOf(*originalBindings)
+			
+			updatedBindings.add(KeyStroke.getKeyStroke('h'))
+			updatedBindings.add("selectParent")
+			
+			updatedBindings.add(KeyStroke.getKeyStroke('j'))
+			updatedBindings.add("selectNext")
+			
+			updatedBindings.add(KeyStroke.getKeyStroke('k'))
+			updatedBindings.add("selectPrevious")
+			
+			updatedBindings.add(KeyStroke.getKeyStroke('l'))
+			updatedBindings.add("selectChild")
+			
+			updatedBindings.add(KeyStroke.getKeyStroke('q'))
+			updatedBindings.add("cancel")
+			
+			UIManager.put("PopupMenu.selectedWindowInputMapBindings", updatedBindings.toTypedArray())
+		}
+		else {
+			UIManager.put("PopupMenu.selectedWindowInputMapBindings", originalPopupBindings)
+		}
+	}
+	
 	private fun handleEvent(event: AWTEvent) {
-		if (event is FocusEvent && event.id == FocusEvent.FOCUS_GAINED) {
+		if (event is FocusEvent && event.id == FocusEvent.FOCUS_GAINED && isEnabled.get()) {
 			when (val source = event.source) {
 				is JList<*> -> VimListNavigation.install(source)
 				is JTree    -> VimTreeNavigation.install(source)

src/main/kotlin/com/chylex/intellij/keyboardmaster/feature/vimNavigation/VimNavigationDispatcher.kt

@@ -3,8 +3,13 @@ package com.chylex.intellij.keyboardmaster.feature.vimNavigation
 import com.chylex.intellij.keyboardmaster.PluginDisposableService
 import com.intellij.openapi.actionSystem.ActionUpdateThread
 import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.actionSystem.CommonDataKeys
+import com.intellij.openapi.actionSystem.DataContext
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.project.DumbAwareAction
+import com.intellij.openapi.wm.ex.ToolWindowManagerEx
+import com.intellij.pom.Navigatable
+import com.intellij.toolWindow.InternalDecoratorImpl
 import com.intellij.ui.SpeedSearchBase
 import com.intellij.ui.speedSearch.SpeedSearch
 import com.intellij.ui.speedSearch.SpeedSearchActivator
@@ -44,7 +49,7 @@ internal open class VimNavigationDispatcher<T : JComponent>(final override val c
 	final override fun actionPerformed(e: AnActionEvent) {
 		val keyEvent = e.inputEvent as? KeyEvent ?: return
 		
-		if (keyEvent.id == KeyEvent.KEY_PRESSED && handleSpecialKeyPress(keyEvent)) {
+		if (keyEvent.id == KeyEvent.KEY_PRESSED && handleSpecialKeyPress(keyEvent, e.dataContext)) {
 			currentNode = rootNode
 			return
 		}
@@ -58,25 +63,34 @@ internal open class VimNavigationDispatcher<T : JComponent>(final override val c
 		}
 	}
 	
-	private fun handleSpecialKeyPress(keyEvent: KeyEvent): Boolean {
+	private fun handleSpecialKeyPress(keyEvent: KeyEvent, dataContext: DataContext): Boolean {
 		if (keyEvent.keyCode == KeyEvent.VK_ESCAPE) {
 			return true
 		}
 		
 		if (keyEvent.keyCode == KeyEvent.VK_ENTER) {
-			if (isSearching.compareAndSet(true, false)) {
+			handleEnterKeyPress(dataContext)
-				when (val supply = SpeedSearchSupply.getSupply(component)) {
-					is SpeedSearchBase<*> -> supply.hidePopup()
-					is SpeedSearch        -> supply.reset()
-				}
-			}
-			
 			return true
 		}
 		
 		return false
 	}
 	
+	private fun handleEnterKeyPress(dataContext: DataContext) {
+		if (isSearching.compareAndSet(true, false)) {
+			when (val supply = SpeedSearchSupply.getSupply(component)) {
+				is SpeedSearchBase<*> -> supply.hidePopup()
+				is SpeedSearch        -> supply.reset()
+			}
+		}
+		else {
+			val navigatables = dataContext.getData(CommonDataKeys.NAVIGATABLE_ARRAY)?.filter(Navigatable::canNavigate).orEmpty()
+			for ((index, navigatable) in navigatables.withIndex()) {
+				navigatable.navigate(index == navigatables.lastIndex)
+			}
+		}
+	}
+	
 	final override fun update(e: AnActionEvent) {
 		e.presentation.isEnabled = !isSearching.get() || e.inputEvent.let { it is KeyEvent && it.id == KeyEvent.KEY_PRESSED && it.keyCode == KeyEvent.VK_ENTER }
 	}
@@ -91,7 +105,23 @@ internal open class VimNavigationDispatcher<T : JComponent>(final override val c
 			val speedSearch = SpeedSearchSupply.getSupply(holder.component, true) as? SpeedSearchActivator ?: return
 			if (speedSearch.isAvailable) {
 				holder.isSearching.set(true)
+				speedSearch.activate()
 			}
 		}
 	}
+	
+	@Suppress("UnstableApiUsage")
+	class CloseParentPopupOrToolWindow<T : JComponent> : KeyStrokeNode.ActionNode<VimNavigationDispatcher<T>> {
+		override fun performAction(holder: VimNavigationDispatcher<T>, actionEvent: AnActionEvent, keyEvent: KeyEvent) {
+			val popup = holder.popup
+			if (popup != null) {
+				popup.cancel()
+				return
+			}
+			
+			val project = actionEvent.project ?: return
+			val decorator = InternalDecoratorImpl.findNearestDecorator(holder.component) ?: return
+			ToolWindowManagerEx.getInstanceEx(project).hideToolWindow(decorator.toolWindowId, true)
+		}
+	}
 }

src/main/kotlin/com/chylex/intellij/keyboardmaster/feature/vimNavigation/components/VimListNavigation.kt

@@ -3,6 +3,7 @@ package com.chylex.intellij.keyboardmaster.feature.vimNavigation.components
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.KeyStrokeNode.IdeaAction
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.KeyStrokeNode.Parent
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.VimNavigationDispatcher
+import com.chylex.intellij.keyboardmaster.feature.vimNavigation.VimNavigationDispatcher.CloseParentPopupOrToolWindow
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.VimNavigationDispatcher.StartSearch
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.ui.getUserData
@@ -30,18 +31,18 @@ internal object VimListNavigation {
 				)
 			),
 			KeyStroke.getKeyStroke('G') to IdeaAction("List-selectLastRow"),
+			KeyStroke.getKeyStroke('h') to IdeaAction("List-selectPreviousColumn"),
 			KeyStroke.getKeyStroke('j') to IdeaAction("List-selectNextRow"),
 			KeyStroke.getKeyStroke('k') to IdeaAction("List-selectPreviousRow"),
+			KeyStroke.getKeyStroke('l') to IdeaAction("List-selectNextColumn"),
 			KeyStroke.getKeyStroke('m') to IdeaAction("ShowPopupMenu"),
-			KeyStroke.getKeyStroke('o') to IdeaAction("List-selectNextColumn"),
+			KeyStroke.getKeyStroke('q') to CloseParentPopupOrToolWindow(),
-			KeyStroke.getKeyStroke('q') to IdeaAction("HideActiveWindow"),
-			KeyStroke.getKeyStroke('x') to IdeaAction("List-selectPreviousColumn"),
 			KeyStroke.getKeyStroke('/') to StartSearch(),
 		)
 	)
 	
 	fun install(component: JList<*>) {
-		if (component.getUserData(KEY) == null && component.javaClass.enclosingClass.let { it == null || WizardPopup::class.java.isAssignableFrom(it) }) {
+		if (component.getUserData(KEY) == null && component.javaClass.enclosingClass.let { it == null || !WizardPopup::class.java.isAssignableFrom(it) }) {
 			component.putUserData(KEY, VimNavigationDispatcher(component, ROOT_NODE))
 		}
 	}
@@ -53,7 +54,7 @@ internal object VimListNavigation {
 	}
 	
 	@Suppress("serial")
-	private class VimPopupListNavigationDispatcher(component: JList<*>, popup: WizardPopup) : VimNavigationDispatcher<JList<*>>(component, ROOT_NODE) {
+	private class VimPopupListNavigationDispatcher(component: JList<*>, override val popup: WizardPopup) : VimNavigationDispatcher<JList<*>>(component, ROOT_NODE) {
 		init {
 			val speedSearch = SpeedSearchSupply.getSupply(component, true) as? SpeedSearch
 			if (speedSearch != null) {

src/main/kotlin/com/chylex/intellij/keyboardmaster/feature/vimNavigation/components/VimTableNavigation.kt

@@ -3,6 +3,7 @@ package com.chylex.intellij.keyboardmaster.feature.vimNavigation.components
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.KeyStrokeNode.IdeaAction
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.KeyStrokeNode.Parent
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.VimNavigationDispatcher
+import com.chylex.intellij.keyboardmaster.feature.vimNavigation.VimNavigationDispatcher.CloseParentPopupOrToolWindow
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.VimNavigationDispatcher.StartSearch
 import com.intellij.openapi.ui.getUserData
 import com.intellij.openapi.ui.putUserData
@@ -28,7 +29,7 @@ internal object VimTableNavigation {
 			KeyStroke.getKeyStroke('k') to IdeaAction("Table-selectPreviousRow"),
 			KeyStroke.getKeyStroke('l') to IdeaAction("Table-selectNextColumn"),
 			KeyStroke.getKeyStroke('m') to IdeaAction("ShowPopupMenu"),
-			KeyStroke.getKeyStroke('q') to IdeaAction("HideActiveWindow"),
+			KeyStroke.getKeyStroke('q') to CloseParentPopupOrToolWindow(),
 			KeyStroke.getKeyStroke('/') to StartSearch(),
 		)
 	)

src/main/kotlin/com/chylex/intellij/keyboardmaster/feature/vimNavigation/components/VimTreeNavigation.kt

@@ -4,6 +4,7 @@ import com.chylex.intellij.keyboardmaster.feature.vimNavigation.KeyStrokeNode.Ac
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.KeyStrokeNode.IdeaAction
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.KeyStrokeNode.Parent
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.VimNavigationDispatcher
+import com.chylex.intellij.keyboardmaster.feature.vimNavigation.VimNavigationDispatcher.CloseParentPopupOrToolWindow
 import com.chylex.intellij.keyboardmaster.feature.vimNavigation.VimNavigationDispatcher.StartSearch
 import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.ui.getUserData
@@ -28,13 +29,15 @@ internal object VimTreeNavigation {
 			KeyStroke.getKeyStroke('G') to IdeaAction("Tree-selectLast"),
 			KeyStroke.getKeyStroke('j') to IdeaAction("Tree-selectNext"),
 			KeyStroke.getKeyStroke('j', KeyEvent.ALT_DOWN_MASK) to IdeaAction("Tree-selectNextSibling"),
+			KeyStroke.getKeyStroke('J') to SelectLastSibling,
 			KeyStroke.getKeyStroke('k') to IdeaAction("Tree-selectPrevious"),
 			KeyStroke.getKeyStroke('k', KeyEvent.ALT_DOWN_MASK) to IdeaAction("Tree-selectPreviousSibling"),
+			KeyStroke.getKeyStroke('K') to SelectFirstSibling,
 			KeyStroke.getKeyStroke('m') to IdeaAction("ShowPopupMenu"),
 			KeyStroke.getKeyStroke('o') to ExpandOrCollapseTreeNode,
 			KeyStroke.getKeyStroke('O') to IdeaAction("FullyExpandTreeNode"),
 			KeyStroke.getKeyStroke('p') to IdeaAction("Tree-selectParentNoCollapse"),
-			KeyStroke.getKeyStroke('q') to IdeaAction("HideActiveWindow"),
+			KeyStroke.getKeyStroke('q') to CloseParentPopupOrToolWindow(),
 			KeyStroke.getKeyStroke('x') to CollapseSelfOrParentNode,
 			KeyStroke.getKeyStroke('X') to IdeaAction("CollapseTreeNode"),
 			KeyStroke.getKeyStroke('/') to StartSearch(),
@@ -77,4 +80,42 @@ internal object VimTreeNavigation {
 			}
 		}
 	}
+	
+	private data object SelectFirstSibling : ActionNode<VimNavigationDispatcher<JTree>> {
+		override fun performAction(holder: VimNavigationDispatcher<JTree>, actionEvent: AnActionEvent, keyEvent: KeyEvent) {
+			val tree = holder.component
+			val path = tree.selectionPath ?: return
+			
+			val parentPath = path.parentPath ?: return
+			val parentRow = tree.getRowForPath(parentPath)
+			
+			tree.setSelectionRow(parentRow + 1)
+		}
+	}
+	
+	private data object SelectLastSibling : ActionNode<VimNavigationDispatcher<JTree>> {
+		override fun performAction(holder: VimNavigationDispatcher<JTree>, actionEvent: AnActionEvent, keyEvent: KeyEvent) {
+			val tree = holder.component
+			val path = tree.selectionPath ?: return
+			
+			val siblingPathCount = path.pathCount
+			var testRow = tree.getRowForPath(path)
+			var targetRow = testRow
+			
+			while (true) {
+				testRow++
+				
+				val testPath = tree.getPathForRow(testRow) ?: break
+				val testPathCount = testPath.pathCount
+				if (testPathCount < siblingPathCount) {
+					break
+				}
+				else if (testPathCount == siblingPathCount) {
+					targetRow = testRow
+				}
+			}
+			
+			tree.setSelectionRow(targetRow)
+		}
+	}
 }

src/main/resources/META-INF/plugin.xml

@@ -22,7 +22,6 @@
   <extensions defaultExtensionNs="com.intellij">
     <applicationService serviceImplementation="com.chylex.intellij.keyboardmaster.configuration.PluginConfiguration" />
     <applicationConfigurable parentId="tools" instance="com.chylex.intellij.keyboardmaster.configuration.PluginConfigurable" id="com.chylex.keyboardmaster" displayName="Keyboard Master" />
-    <applicationInitializedListener implementation="com.chylex.intellij.keyboardmaster.feature.vimNavigation.VimNavigationApplicationListener" />
     <postStartupActivity implementation="com.chylex.intellij.keyboardmaster.PluginStartup" order="last" />
   </extensions>