1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
|
package ui
import (
"bytes"
"fmt"
"strings"
"src.elv.sh/pkg/parse"
"src.elv.sh/pkg/persistent/hash"
)
// Key represents a single keyboard input, typically assembled from a escape
// sequence.
type Key struct {
Rune rune
Mod Mod
}
// K constructs a new Key.
func K(r rune, mods ...Mod) Key {
var mod Mod
for _, m := range mods {
mod |= m
}
return Key{r, mod}
}
// Default is used in the key binding table to indicate a default binding.
var DefaultKey = Key{DefaultBindingRune, 0}
// Mod represents a modifier key.
type Mod byte
// Values for Mod.
const (
// Shift is the shift modifier. It is only applied to special keys (e.g.
// Shift-F1). For instance 'A' and '@' which are typically entered with the
// shift key pressed, are not considered to be shift-modified.
Shift Mod = 1 << iota
// Alt is the alt modifier, traditionally known as the meta modifier.
Alt
Ctrl
)
const functionKeyOffset = 1000
// Special negative runes to represent function keys, used in the Rune field
// of the Key struct. This also has a few function names that are aliases for
// simple runes. See keyNames below for mapping these values to strings.
const (
// DefaultBindingRune is a special value to represent a default binding.
DefaultBindingRune rune = iota - functionKeyOffset
F1
F2
F3
F4
F5
F6
F7
F8
F9
F10
F11
F12
Up
Down
Right
Left
Home
Insert
Delete
End
PageUp
PageDown
// Function key names that are aliases for their ASCII representation.
Tab = '\t'
Enter = '\n'
Backspace = 0x7f
)
// keyNames maps runes, whether simple or function, to symbolic key names.
var keyNames = map[rune]string{
DefaultBindingRune: "Default",
F1: "F1",
F2: "F2",
F3: "F3",
F4: "F4",
F5: "F5",
F6: "F6",
F7: "F7",
F8: "F8",
F9: "F9",
F10: "F10",
F11: "F11",
F12: "F12",
Up: "Up",
Down: "Down",
Right: "Right",
Left: "Left",
Home: "Home",
Insert: "Insert",
Delete: "Delete",
End: "End",
PageUp: "PageUp",
PageDown: "PageDown",
Tab: "Tab",
Enter: "Enter",
Backspace: "Backspace",
}
func (k Key) Kind() string {
return "edit:key"
}
func (k Key) Equal(other any) bool {
return k == other
}
func (k Key) Hash() uint32 {
return hash.DJB(uint32(k.Rune), uint32(k.Mod))
}
func (k Key) Repr(int) string {
return "(edit:key " + parse.Quote(k.String()) + ")"
}
func (k Key) String() string {
var b bytes.Buffer
if k.Mod&Ctrl != 0 {
b.WriteString("Ctrl-")
}
if k.Mod&Alt != 0 {
b.WriteString("Alt-")
}
if k.Mod&Shift != 0 {
b.WriteString("Shift-")
}
if name, ok := keyNames[k.Rune]; ok {
b.WriteString(name)
} else {
if k.Rune >= 0 {
b.WriteRune(k.Rune)
} else {
fmt.Fprintf(&b, "(bad function key %d)", k.Rune)
}
}
return b.String()
}
// modifierByName maps a name to an modifier. It is used for parsing keys where
// the modifier string is first turned to lower case, so that all of C, c,
// CTRL, Ctrl and ctrl can represent the Ctrl modifier.
var modifierByName = map[string]Mod{
"S": Shift, "Shift": Shift,
"A": Alt, "Alt": Alt,
"M": Alt, "Meta": Alt,
"C": Ctrl, "Ctrl": Ctrl,
}
// ParseKey parses a symbolic key. The syntax is:
//
// Key = { Mod ('+' | '-') } BareKey
//
// BareKey = FunctionKeyName | SingleRune
func ParseKey(s string) (Key, error) {
var k Key
// Parse modifiers.
for {
i := strings.IndexAny(s, "+-")
if i == -1 {
break
}
modname := s[:i]
if mod, ok := modifierByName[modname]; ok {
k.Mod |= mod
s = s[i+1:]
} else {
return Key{}, fmt.Errorf("bad modifier: %s", parse.Quote(modname))
}
}
if len(s) == 1 {
k.Rune = rune(s[0])
if k.Rune < 0x20 {
if k.Mod&Ctrl != 0 {
//lint:ignore ST1005 We want this error to begin with "Ctrl" rather than "ctrl"
// since the user has to use the capitalized form when creating a key binding.
return Key{}, fmt.Errorf("Ctrl modifier with literal control char: %q", k.Rune)
}
// Convert literal control char to the equivalent canonical form,
// e.g. "\e" to Ctrl-'[' and "\t" to Ctrl-I.
k.Mod |= Ctrl
k.Rune += 0x40
}
// TODO(xiaq): The following assumptions about keys with Ctrl are not
// checked with all terminals.
if k.Mod&Ctrl != 0 {
// Keys with Ctrl as one of the modifiers and a single ASCII letter
// as the base rune do not distinguish between cases. So we
// normalize the base rune to upper case.
if 'a' <= k.Rune && k.Rune <= 'z' {
k.Rune += 'A' - 'a'
}
// Normalize Ctrl-I to Tab, Ctrl-J to Enter, and Ctrl-? to Backspace.
if k.Rune == 'I' {
k.Mod &= ^Ctrl
k.Rune = Tab
} else if k.Rune == 'J' {
k.Mod &= ^Ctrl
k.Rune = Enter
}
}
return k, nil
}
// Is this is a symbolic key name, such as `Enter`, we recognize?
for r, name := range keyNames {
if s == name {
k.Rune = r
return k, nil
}
}
return Key{}, fmt.Errorf("bad key: %s", parse.Quote(s))
}
// Keys implements sort.Interface.
type Keys []Key
func (ks Keys) Len() int { return len(ks) }
func (ks Keys) Swap(i, j int) { ks[i], ks[j] = ks[j], ks[i] }
func (ks Keys) Less(i, j int) bool {
return ks[i].Mod < ks[j].Mod ||
(ks[i].Mod == ks[j].Mod && ks[i].Rune < ks[j].Rune)
}
|