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
|
//go:build unix
package term
import (
"os"
"strings"
"testing"
"src.elv.sh/pkg/must"
"src.elv.sh/pkg/ui"
)
var readEventTests = []struct {
input string
want Event
}{
// Simple graphical key.
{"x", K('x')},
{"X", K('X')},
{" ", K(' ')},
// Ctrl key.
{"\001", K('A', ui.Ctrl)},
{"\033", K('[', ui.Ctrl)},
// Special Ctrl keys that do not obey the usual 0x40 rule.
{"\000", K('`', ui.Ctrl)},
{"\x1e", K('6', ui.Ctrl)},
{"\x1f", K('/', ui.Ctrl)},
// Ambiguous Ctrl keys; the reader uses the non-Ctrl form as canonical.
{"\n", K('\n')},
{"\t", K('\t')},
{"\x7f", K('\x7f')}, // backspace
// Alt plus simple graphical key.
{"\033a", K('a', ui.Alt)},
{"\033[", K('[', ui.Alt)},
// G3-style key.
{"\033OA", K(ui.Up)},
{"\033OH", K(ui.Home)},
// G3-style key with leading Escape.
{"\033\033OA", K(ui.Up, ui.Alt)},
{"\033\033OH", K(ui.Home, ui.Alt)},
// Alt-O. This is handled as a special case because it looks like a G3-style
// key.
{"\033O", K('O', ui.Alt)},
// CSI-sequence key identified by the ending rune.
{"\033[A", K(ui.Up)},
{"\033[H", K(ui.Home)},
// Modifiers.
{"\033[1;0A", K(ui.Up)},
{"\033[1;1A", K(ui.Up)},
{"\033[1;2A", K(ui.Up, ui.Shift)},
{"\033[1;3A", K(ui.Up, ui.Alt)},
{"\033[1;4A", K(ui.Up, ui.Shift, ui.Alt)},
{"\033[1;5A", K(ui.Up, ui.Ctrl)},
{"\033[1;6A", K(ui.Up, ui.Shift, ui.Ctrl)},
{"\033[1;7A", K(ui.Up, ui.Alt, ui.Ctrl)},
{"\033[1;8A", K(ui.Up, ui.Shift, ui.Alt, ui.Ctrl)},
// The modifiers below should be for Meta, but we conflate Alt and Meta.
{"\033[1;9A", K(ui.Up, ui.Alt)},
{"\033[1;10A", K(ui.Up, ui.Shift, ui.Alt)},
{"\033[1;11A", K(ui.Up, ui.Alt)},
{"\033[1;12A", K(ui.Up, ui.Shift, ui.Alt)},
{"\033[1;13A", K(ui.Up, ui.Alt, ui.Ctrl)},
{"\033[1;14A", K(ui.Up, ui.Shift, ui.Alt, ui.Ctrl)},
{"\033[1;15A", K(ui.Up, ui.Alt, ui.Ctrl)},
{"\033[1;16A", K(ui.Up, ui.Shift, ui.Alt, ui.Ctrl)},
// CSI-sequence key with one argument, ending in '~'.
{"\033[1~", K(ui.Home)},
{"\033[11~", K(ui.F1)},
// Modified.
{"\033[1;2~", K(ui.Home, ui.Shift)},
// Urxvt-flavor modifier, shifting the '~' to reflect the modifier
{"\033[1$", K(ui.Home, ui.Shift)},
{"\033[1^", K(ui.Home, ui.Ctrl)},
{"\033[1@", K(ui.Home, ui.Shift, ui.Ctrl)},
// With a leading Escape.
{"\033\033[1~", K(ui.Home, ui.Alt)},
// CSI-sequence key with three arguments and ending in '~'. The first
// argument is always 27, the second identifies the modifier and the last
// identifies the key.
{"\033[27;4;63~", K(';', ui.Shift, ui.Alt)},
// Cursor Position Report.
{"\033[3;4R", CursorPosition{3, 4}},
// Paste setting.
{"\033[200~", PasteSetting(true)},
{"\033[201~", PasteSetting(false)},
// Mouse event.
{"\033[M\x00\x23\x24", MouseEvent{Pos{4, 3}, true, 0, 0}},
// Other buttons.
{"\033[M\x01\x23\x24", MouseEvent{Pos{4, 3}, true, 1, 0}},
// Button up.
{"\033[M\x03\x23\x24", MouseEvent{Pos{4, 3}, false, -1, 0}},
// Modified.
{"\033[M\x04\x23\x24", MouseEvent{Pos{4, 3}, true, 0, ui.Shift}},
{"\033[M\x08\x23\x24", MouseEvent{Pos{4, 3}, true, 0, ui.Alt}},
{"\033[M\x10\x23\x24", MouseEvent{Pos{4, 3}, true, 0, ui.Ctrl}},
{"\033[M\x14\x23\x24", MouseEvent{Pos{4, 3}, true, 0, ui.Shift | ui.Ctrl}},
// SGR-style mouse event.
{"\033[<0;3;4M", MouseEvent{Pos{4, 3}, true, 0, 0}},
// Other buttons.
{"\033[<1;3;4M", MouseEvent{Pos{4, 3}, true, 1, 0}},
// Button up.
{"\033[<0;3;4m", MouseEvent{Pos{4, 3}, false, 0, 0}},
// Modified.
{"\033[<4;3;4M", MouseEvent{Pos{4, 3}, true, 0, ui.Shift}},
{"\033[<16;3;4M", MouseEvent{Pos{4, 3}, true, 0, ui.Ctrl}},
}
func TestReader_ReadEvent(t *testing.T) {
r, w := setupReader(t)
for _, test := range readEventTests {
t.Run(test.input, func(t *testing.T) {
w.WriteString(test.input)
ev, err := r.ReadEvent()
if ev != test.want {
t.Errorf("got event %v, want %v", ev, test.want)
}
if err != nil {
t.Errorf("got err %v, want %v", err, nil)
}
})
}
}
var readEventBadSeqTests = []struct {
input string
wantErrMsg string
}{
// mouse event should have exactly 3 bytes after \033[M
{"\033[M", "incomplete mouse event"},
{"\033[M1", "incomplete mouse event"},
{"\033[M12", "incomplete mouse event"},
// CSI needs to be terminated by something that is not a parameter
{"\033[1", "incomplete CSI"},
{"\033[;", "incomplete CSI"},
{"\033[1;", "incomplete CSI"},
// CPR should have exactly 2 parameters
{"\033[1R", "bad CPR"},
{"\033[1;2;3R", "bad CPR"},
// SGR mouse event should have exactly 3 parameters
{"\033[<1;2m", "bad SGR mouse event"},
// csiSeqByLast should have 0 or 2 parameters
{"\033[1;2;3A", "bad CSI"},
// csiSeqByLast with 2 parameters should have first parameter = 1
{"\033[2;1A", "bad CSI"},
// xterm-style modifier should be 0 to 16
{"\033[1;17A", "bad CSI"},
// unknown CSI terminator
{"\033[x", "bad CSI"},
// G3 allows a small list of allowed bytes after \033O
{"\033Ox", "bad G3"},
}
func TestReader_ReadEvent_BadSeq(t *testing.T) {
r, w := setupReader(t)
for _, test := range readEventBadSeqTests {
t.Run(test.input, func(t *testing.T) {
w.WriteString(test.input)
ev, err := r.ReadEvent()
if err == nil {
t.Fatalf("got nil err with event %v, want non-nil error", ev)
}
errMsg := err.Error()
if !strings.HasPrefix(errMsg, test.wantErrMsg) {
t.Errorf("got err with message %v, want message starting with %v",
errMsg, test.wantErrMsg)
}
})
}
}
func TestReader_ReadRawEvent(t *testing.T) {
rd, w := setupReader(t)
for _, test := range readEventTests {
input := test.input
t.Run(input, func(t *testing.T) {
w.WriteString(input)
for _, r := range input {
ev, err := rd.ReadRawEvent()
if err != nil {
t.Errorf("got error %v, want nil", err)
}
if ev != K(r) {
t.Errorf("got event %v, want %v", ev, K(r))
}
}
})
}
}
func setupReader(t *testing.T) (Reader, *os.File) {
pr, pw := must.Pipe()
r := NewReader(pr)
t.Cleanup(func() {
r.Close()
pr.Close()
pw.Close()
})
return r, pw
}
|