complete: allow setting the completion key binding

Until now, if less than complete-min-chars were entered or if
completion-delay had not expired yet, the only way to force trigger
completion was to press <tab>.

In some cases, <tab> is already bound to another action (for example
:next-field in the compose::editor context). This makes forcing the
completion impossible.

Allow defining a key to trigger manual completion via the new $complete
special entry in binds.conf.

Leave the default binding to <tab>. Set it to <C-o> in the
[compose::editor] to avoid conflicting with the existing <tab> binding.

Changelog-added: Customize key to trigger completion with `$complete` in
 `binds.conf`.
Signed-off-by: Robin Jarry <robin@jarry.cc>
Reviewed-by: Tim Culverhouse <tim@timculverhouse.com>

1 files changed, 12 insertions, 18 deletions

diff --git a/lib/ui/textinput.go b/lib/ui/textinput.go
index dd946aec..4b051d88 100644
--- a/lib/ui/textinput.go
+++ b/lib/ui/textinput.go
@@ -35,6 +35,7 @@ type TextInput struct {
 	completeDelay     time.Duration
 	completeDebouncer *time.Timer
 	completeMinChars  int
+	completeKey       *config.KeyStroke
 	uiConfig          *config.UIConfig
 }
 
@@ -62,12 +63,12 @@ func (ti *TextInput) Prompt(prompt string) *TextInput {
 
 func (ti *TextInput) TabComplete(
 	tabcomplete func(s string) ([]string, string),
-	d time.Duration,
-	minChars int,
+	d time.Duration, minChars int, key *config.KeyStroke,
 ) *TextInput {
 	ti.tabcomplete = tabcomplete
 	ti.completeDelay = d
 	ti.completeMinChars = minChars
+	ti.completeKey = key
 	return ti
 }
 
@@ -344,55 +345,48 @@ func (ti *TextInput) Event(event tcell.Event) bool {
 	ti.Lock()
 	defer ti.Unlock()
 	if event, ok := event.(*tcell.EventKey); ok {
+		c := ti.completeKey
+		if c != nil && c.Key == event.Key() && c.Modifiers == event.Modifiers() {
+			ti.showCompletions()
+			return true
+		}
+
+		ti.invalidateCompletions()
+
 		switch event.Key() {
 		case tcell.KeyBackspace, tcell.KeyBackspace2:
-			ti.invalidateCompletions()
 			ti.backspace()
 		case tcell.KeyCtrlD, tcell.KeyDelete:
-			ti.invalidateCompletions()
 			ti.deleteChar()
 		case tcell.KeyCtrlB, tcell.KeyLeft:
-			ti.invalidateCompletions()
 			if ti.index > 0 {
 				ti.index--
 				ti.ensureScroll()
 				ti.Invalidate()
 			}
 		case tcell.KeyCtrlF, tcell.KeyRight:
-			ti.invalidateCompletions()
 			if ti.index < len(ti.text) {
 				ti.index++
 				ti.ensureScroll()
 				ti.Invalidate()
 			}
 		case tcell.KeyCtrlA, tcell.KeyHome:
-			ti.invalidateCompletions()
 			ti.index = 0
 			ti.ensureScroll()
 			ti.Invalidate()
 		case tcell.KeyCtrlE, tcell.KeyEnd:
-			ti.invalidateCompletions()
 			ti.index = len(ti.text)
 			ti.ensureScroll()
 			ti.Invalidate()
 		case tcell.KeyCtrlK:
-			ti.invalidateCompletions()
 			ti.deleteLineForward()
 		case tcell.KeyCtrlW:
-			ti.invalidateCompletions()
 			ti.deleteWord()
 		case tcell.KeyCtrlU:
-			ti.invalidateCompletions()
 			ti.deleteLineBackward()
 		case tcell.KeyESC:
-			if ti.completions != nil {
-				ti.invalidateCompletions()
-				ti.Invalidate()
-			}
-		case tcell.KeyTab:
-			ti.showCompletions()
+			ti.Invalidate()
 		case tcell.KeyRune:
-			ti.invalidateCompletions()
 			ti.insert(event.Rune())
 		}
 	}