Function KeyEventToString

internal/keyseq/keys.go:215–244

KeyEventToString returns a human-readable name for a key event described by the given key type, character, and modifier.

(key KeyType, ch rune, mod ModifierKey)

// KeyEventToString returns a human-readable name for a key event described
// by the given key type, character, and modifier.
func KeyEventToString(key KeyType, ch rune, mod ModifierKey) (string, error) {
	var s string
	if key == 0 {
		s = string([]rune{ch})
	} else {
		var ok bool
		s, ok = keyToString[key]
		if !ok {
			return "", fmt.Errorf("no such key %d (ch=%c)", key, ch)
		}

		// Special case for ArrowUp/Down/Left/Right
		switch s {
		case "ArrowUp":
			s = "^"
		case "ArrowDown":
			s = "v"
		case "ArrowLeft":
			s = "<"
		case "ArrowRight":
			s = ">"
		}
	}

	if m := mod.String(); m != "" {
		return m + "-" + s, nil
	}

	return s, nil
}

// ToKey parses a single key name string into its KeyType, modifier, and rune components.
func ToKey(key string) (KeyType, ModifierKey, rune, error) {