keymap.go

package selection

import (
	"fmt"

	tea "github.com/charmbracelet/bubbletea"
)

// NewDefaultKeyMap returns a KeyMap with sensible default key mappings that can
// also be used as a starting point for customization.
func NewDefaultKeyMap() *KeyMap {
	return &KeyMap{
		Down:        []string{"down"},
		Up:          []string{"up"},
		Select:      []string{"enter"},
		Abort:       []string{"ctrl+c"},
		ClearFilter: []string{"esc"},
		ScrollDown:  []string{"pgdown"},
		ScrollUp:    []string{"pgup"},
		Left:        []string{"left"},
		Right:       []string{"right"},
	}
}

// KeyMap defines the keys that trigger certain actions.
type KeyMap struct {
	Down        []string
	Up          []string
	Select      []string
	Abort       []string
	ClearFilter []string
	ScrollDown  []string
	ScrollUp    []string
	Left        []string
	Right       []string
}

func keyMatches(key tea.KeyMsg, mapping []string) bool {
	for _, m := range mapping {
		if m == key.String() {
			return true
		}
	}

	return false
}

// validateKeyMap returns true if the given key map contains at
// least the bare minimum set of key bindings for the functional
// prompt and false otherwise.
func validateKeyMap(km *KeyMap) error {
	if len(km.Up) == 0 {
		return fmt.Errorf("no up key")
	}

	if len(km.Down) == 0 {
		return fmt.Errorf("no down key")
	}

	if len(km.Select) == 0 {
		return fmt.Errorf("no select key")
	}

	if len(km.Abort) == 0 {
		return fmt.Errorf("no abort key")
	}

	return nil
}