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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
vim9script
# Script to get various codes that keys send, depending on the protocol used.
#
# Usage: vim -u keycode_check.vim
#
# Author: Bram Moolenaar
# Last Update: 2022 Nov 15
#
# The codes are stored in the file "keycode_check.json", so that you can
# compare the results of various terminals.
#
# You can select what protocol to enable:
# - None
# - modifyOtherKeys level 2
# - kitty keyboard protocol
# Change directory to where this script is, so that the json file is found
# there.
exe 'cd ' .. expand('<sfile>:h')
echo 'working in directory: ' .. getcwd()
const filename = 'keycode_check.json'
# Dictionary of dictionaries with the results in the form:
# {'xterm': {protocol: 'none', 'Tab': '09', 'S-Tab': '09'},
# 'xterm2': {protocol: 'mok2', 'Tab': '09', 'S-Tab': '09'},
# 'kitty': {protocol: 'kitty', 'Tab': '09', 'S-Tab': '09'},
# }
# The values are in hex form.
var keycodes = {}
if filereadable(filename)
keycodes = readfile(filename)->join()->json_decode()
else
# Use some dummy entries to try out with
keycodes = {
'xterm': {protocol: 'none', 'Tab': '09', 'S-Tab': '09'},
'kitty': {protocol: 'kitty', 'Tab': '09', 'S-Tab': '1b5b393b3275'},
}
endif
var orig_keycodes = deepcopy(keycodes) # used to detect something changed
# Write the "keycodes" variable in JSON form to "filename".
def WriteKeycodes()
# If the file already exists move it to become the backup file.
if filereadable(filename)
if rename(filename, filename .. '~')
echoerr $'Renaming {filename} to {filename}~ failed!'
return
endif
endif
if writefile([json_encode(keycodes)], filename) != 0
echoerr $'Writing {filename} failed!'
endif
enddef
# The key entries that we want to list, in this order.
# The first item is displayed in the prompt, the second is the key in
# the keycodes dictionary.
var key_entries = [
['Tab', 'Tab'],
['Shift-Tab', 'S-Tab'],
['Ctrl-Tab', 'C-Tab'],
['Alt-Tab', 'A-Tab'],
['Ctrl-I', 'C-I'],
['Shift-Ctrl-I', 'S-C-I'],
['Esc', 'Esc'],
['Shift-Esc', 'S-Esc'],
['Ctrl-Esc', 'C-Esc'],
['Alt-Esc', 'A-Esc'],
['Space', 'Space'],
['Shift-Space', 'S-Space'],
['Ctrl-Space', 'C-Space'],
['Alt-Space', 'A-Space'],
]
# Action: list the information in "keycodes" in a more or less nice way.
def ActionList()
var terms = keys(keycodes)
if len(terms) == 0
echo 'No terminal results yet'
return
endif
# Use one column of width 10 for the item name, then columns of 20
# characters to fit most codes. You will need to increase the terminal
# width to avoid wrapping.
echon printf(' ')
for term in terms
echon printf('%-20s', term)
endfor
echo "\n"
var items = ['protocol'] + key_entries->copy()->map((_, v) => v[1])
for item in items
echon printf('%8s ', item)
for term in terms
var val = get(keycodes[term], item, '')
# see if we can pretty-print this one
var pretty = val
if val[0 : 1] == '1b'
pretty = 'ESC'
var idx = 2
if val[0 : 3] == '1b5b'
pretty = 'CSI'
idx = 4
endif
var digits = false
while idx < len(val)
var cc = val[idx : idx + 1]
var nr = str2nr('0x' .. cc, 16)
idx += 2
if nr >= char2nr('0') && nr <= char2nr('9')
if !digits
pretty ..= ' '
endif
digits = true
pretty ..= cc[1]
else
digits = false
if nr >= char2nr(' ') && nr <= char2nr('~')
# printable character
pretty ..= ' ' .. printf('%c', nr)
else
# non-printable, use hex code
pretty = val
break
endif
endif
endwhile
endif
echon printf('%-20s', pretty)
endfor
echo ''
endfor
echo "\n"
enddef
def GetTermName(): string
var name = input('Enter the name of the terminal: ')
return name
enddef
# Gather key codes for terminal "name".
def DoTerm(name: string)
var proto = inputlist([$'What protocol to enable for {name}:',
'1. None',
'2. modifyOtherKeys level 2',
'3. kitty',
])
echo "\n"
&t_TE = "\<Esc>[>4;m"
var proto_name = 'none'
if proto == 1
&t_TI = ""
elseif proto == 2
&t_TI = "\<Esc>[>4;2m"
proto_name = 'mok2'
elseif proto == 3
&t_TI = "\<Esc>[>1u"
proto_name = 'kitty'
else
echoerr 'invalid protocol choice'
return
endif
# executing a dummy shell command will output t_TI
!echo >/dev/null
if !has_key(keycodes, name)
keycodes[name] = {}
endif
keycodes[name]['protocol'] = proto_name
echo "When a key press doesn't get to Vim (e.g. when using Alt) press Space"
for entry in key_entries
ch_logfile('keylog', 'w')
echo $'Press the {entry[0]} key (q to quit):'
var r = getcharstr()
ch_logfile('', '')
if r == 'q'
break
endif
var log = readfile('keylog')
delete('keylog')
if len(log) < 2
echoerr 'failed to read result'
return
endif
var done = false
for line in log
if line =~ 'raw key input'
var code = substitute(line, '.*raw key input: "\([^"]*\).*', '\1', '')
# convert the literal bytes into hex
var hex = ''
for i in range(len(code))
hex ..= printf('%02x', char2nr(code[i]))
endfor
keycodes[name][entry[1]] = hex
done = true
break
endif
endfor
if !done
echo 'Code not found in log'
endif
endfor
enddef
# Action: Add key codes for a new terminal.
def ActionAdd()
var name = input('Enter name of the terminal: ')
echo "\n"
if index(keys(keycodes), name) >= 0
echoerr $'Terminal {name} already exists'
return
endif
DoTerm(name)
enddef
# Action: Replace key codes for an already known terminal.
def ActionReplace()
var terms = keys(keycodes)
if len(terms) == 0
echo 'No terminal results yet'
return
endif
var choice = inputlist(['Select:'] + terms->copy()->map((idx, arg) => (idx + 1) .. ': ' .. arg))
echo "\n"
if choice > 0 && choice <= len(terms)
DoTerm(terms[choice - 1])
endif
echo 'invalid index'
enddef
# Action: Quit, possibly after saving the results first.
def ActionQuit()
# If nothing was changed just quit
if keycodes == orig_keycodes
quit
endif
while true
var res = input("Save the changed key codes (y/n)? ")
if res == 'n'
quit
endif
if res == 'y'
WriteKeycodes()
quit
endif
echo 'invalid reply'
endwhile
enddef
# The main loop
while true
var action = inputlist(['Select operation:',
'1. List results',
'2. Add results for a new terminal',
'3. Replace results',
'4. Quit',
])
echo "\n"
if action == 1
ActionList()
elseif action == 2
ActionAdd()
elseif action == 3
ActionReplace()
elseif action == 4
ActionQuit()
endif
endwhile
|