xref: /vim-8.2.3635/src/keymap.h (revision e16b00a1)
1 /* vi:set ts=8 sts=4 sw=4 noet:
2  *
3  * VIM - Vi IMproved	by Bram Moolenaar
4  *
5  * Do ":help uganda"  in Vim to read copying and usage conditions.
6  * Do ":help credits" in Vim to see a list of people who contributed.
7  */
8 
9 /*
10  * Keycode definitions for special keys.
11  *
12  * Any special key code sequences are replaced by these codes.
13  */
14 
15 /*
16  * For MSDOS some keys produce codes larger than 0xff. They are split into two
17  * chars, the first one is K_NUL (same value used in term.h).
18  */
19 #define K_NUL			(0xce)	/* for MSDOS: special key follows */
20 
21 /*
22  * K_SPECIAL is the first byte of a special key code and is always followed by
23  * two bytes.
24  * The second byte can have any value. ASCII is used for normal termcap
25  * entries, 0x80 and higher for special keys, see below.
26  * The third byte is guaranteed to be between 0x02 and 0x7f.
27  */
28 
29 #define K_SPECIAL		(0x80)
30 
31 /*
32  * Positive characters are "normal" characters.
33  * Negative characters are special key codes.  Only characters below -0x200
34  * are used to so that the absolute value can't be mistaken for a single-byte
35  * character.
36  */
37 #define IS_SPECIAL(c)		((c) < 0)
38 
39 /*
40  * Characters 0x0100 - 0x01ff have a special meaning for abbreviations.
41  * Multi-byte characters also have ABBR_OFF added, thus are above 0x0200.
42  */
43 #define ABBR_OFF		0x100
44 
45 /*
46  * NUL cannot be in the input string, therefore it is replaced by
47  *	K_SPECIAL   KS_ZERO	KE_FILLER
48  */
49 #define KS_ZERO			255
50 
51 /*
52  * K_SPECIAL cannot be in the input string, therefore it is replaced by
53  *	K_SPECIAL   KS_SPECIAL	KE_FILLER
54  */
55 #define KS_SPECIAL		254
56 
57 /*
58  * KS_EXTRA is used for keys that have no termcap name
59  *	K_SPECIAL   KS_EXTRA	KE_xxx
60  */
61 #define KS_EXTRA		253
62 
63 /*
64  * KS_MODIFIER is used when a modifier is given for a (special) key
65  *	K_SPECIAL   KS_MODIFIER	bitmask
66  */
67 #define KS_MODIFIER		252
68 
69 /*
70  * These are used for the GUI
71  *	K_SPECIAL   KS_xxx	KE_FILLER
72  */
73 #define KS_MOUSE		251
74 #define KS_MENU			250
75 #define KS_VER_SCROLLBAR	249
76 #define KS_HOR_SCROLLBAR	248
77 
78 /*
79  * These are used for DEC mouse
80  */
81 #define KS_NETTERM_MOUSE	247
82 #define KS_DEC_MOUSE		246
83 
84 /*
85  * Used for switching Select mode back on after a mapping or menu.
86  */
87 #define KS_SELECT		245
88 #define K_SELECT_STRING		(char_u *)"\200\365X"
89 
90 /*
91  * Used for tearing off a menu.
92  */
93 #define KS_TEAROFF		244
94 
95 /* Used for JSB term mouse. */
96 #define KS_JSBTERM_MOUSE	243
97 
98 /* Used a termcap entry that produces a normal character. */
99 #define KS_KEY			242
100 
101 /* Used for the qnx pterm mouse. */
102 #define KS_PTERM_MOUSE		241
103 
104 /* Used for click in a tab pages label. */
105 #define KS_TABLINE		240
106 
107 /* Used for menu in a tab pages line. */
108 #define KS_TABMENU		239
109 
110 /* Used for the urxvt mouse. */
111 #define KS_URXVT_MOUSE		238
112 
113 /* Used for the sgr mouse. */
114 #define KS_SGR_MOUSE		237
115 #define KS_SGR_MOUSE_RELEASE	236
116 
117 /*
118  * Filler used after KS_SPECIAL and others
119  */
120 #define KE_FILLER		('X')
121 
122 /*
123  * translation of three byte code "K_SPECIAL a b" into int "K_xxx" and back
124  */
125 #define TERMCAP2KEY(a, b)	(-((a) + ((int)(b) << 8)))
126 #define KEY2TERMCAP0(x)		((-(x)) & 0xff)
127 #define KEY2TERMCAP1(x)		(((unsigned)(-(x)) >> 8) & 0xff)
128 
129 /*
130  * get second or third byte when translating special key code into three bytes
131  */
132 #define K_SECOND(c)	((c) == K_SPECIAL ? KS_SPECIAL : (c) == NUL ? KS_ZERO : KEY2TERMCAP0(c))
133 
134 #define K_THIRD(c)	(((c) == K_SPECIAL || (c) == NUL) ? KE_FILLER : KEY2TERMCAP1(c))
135 
136 /*
137  * get single int code from second byte after K_SPECIAL
138  */
139 #define TO_SPECIAL(a, b)    ((a) == KS_SPECIAL ? K_SPECIAL : (a) == KS_ZERO ? K_ZERO : TERMCAP2KEY(a, b))
140 
141 /*
142  * Codes for keys that do not have a termcap name.
143  * The numbers are fixed to make sure that recorded key sequences remain valid.
144  * Add new entries at the end, not halfway.
145  *
146  * K_SPECIAL KS_EXTRA KE_xxx
147  */
148 enum key_extra
149 {
150     KE_NAME = 3		/* name of this terminal entry */
151 
152     , KE_S_UP = 4		/* shift-up */
153     , KE_S_DOWN = 5		/* shift-down */
154 
155     , KE_S_F1 = 6		/* shifted function keys */
156     , KE_S_F2 = 7
157     , KE_S_F3 = 8
158     , KE_S_F4 = 9
159     , KE_S_F5 = 10
160     , KE_S_F6 = 11
161     , KE_S_F7 = 12
162     , KE_S_F8 = 13
163     , KE_S_F9 = 14
164     , KE_S_F10 = 15
165 
166     , KE_S_F11 = 16
167     , KE_S_F12 = 17
168     , KE_S_F13 = 18
169     , KE_S_F14 = 19
170     , KE_S_F15 = 20
171     , KE_S_F16 = 21
172     , KE_S_F17 = 22
173     , KE_S_F18 = 23
174     , KE_S_F19 = 24
175     , KE_S_F20 = 25
176 
177     , KE_S_F21 = 26
178     , KE_S_F22 = 27
179     , KE_S_F23 = 28
180     , KE_S_F24 = 29
181     , KE_S_F25 = 30
182     , KE_S_F26 = 31
183     , KE_S_F27 = 32
184     , KE_S_F28 = 33
185     , KE_S_F29 = 34
186     , KE_S_F30 = 35
187 
188     , KE_S_F31 = 36
189     , KE_S_F32 = 37
190     , KE_S_F33 = 38
191     , KE_S_F34 = 39
192     , KE_S_F35 = 40
193     , KE_S_F36 = 41
194     , KE_S_F37 = 42
195 
196     , KE_MOUSE = 43		/* mouse event start */
197 
198 /*
199  * Symbols for pseudo keys which are translated from the real key symbols
200  * above.
201  */
202     , KE_LEFTMOUSE = 44		/* Left mouse button click */
203     , KE_LEFTDRAG = 45		/* Drag with left mouse button down */
204     , KE_LEFTRELEASE = 46	/* Left mouse button release */
205     , KE_MIDDLEMOUSE = 47	/* Middle mouse button click */
206     , KE_MIDDLEDRAG = 48	/* Drag with middle mouse button down */
207     , KE_MIDDLERELEASE = 49	/* Middle mouse button release */
208     , KE_RIGHTMOUSE = 50	/* Right mouse button click */
209     , KE_RIGHTDRAG = 51		/* Drag with right mouse button down */
210     , KE_RIGHTRELEASE = 52	/* Right mouse button release */
211 
212     , KE_IGNORE = 53		/* Ignored mouse drag/release */
213 
214     , KE_TAB = 54		/* unshifted TAB key */
215     , KE_S_TAB_OLD = 55		/* shifted TAB key (no longer used) */
216 
217     , KE_SNIFF_UNUSED = 56	/* obsolete */
218     , KE_XF1 = 57		/* extra vt100 function keys for xterm */
219     , KE_XF2 = 58
220     , KE_XF3 = 59
221     , KE_XF4 = 60
222     , KE_XEND = 61		/* extra (vt100) end key for xterm */
223     , KE_ZEND = 62		/* extra (vt100) end key for xterm */
224     , KE_XHOME = 63		/* extra (vt100) home key for xterm */
225     , KE_ZHOME = 64		/* extra (vt100) home key for xterm */
226     , KE_XUP = 65		/* extra vt100 cursor keys for xterm */
227     , KE_XDOWN = 66
228     , KE_XLEFT = 67
229     , KE_XRIGHT = 68
230 
231     , KE_LEFTMOUSE_NM = 69	/* non-mappable Left mouse button click */
232     , KE_LEFTRELEASE_NM = 70	/* non-mappable left mouse button release */
233 
234     , KE_S_XF1 = 71		/* vt100 shifted function keys for xterm */
235     , KE_S_XF2 = 72
236     , KE_S_XF3 = 73
237     , KE_S_XF4 = 74
238 
239     /* NOTE: The scroll wheel events are inverted: i.e. UP is the same as
240      * moving the actual scroll wheel down, LEFT is the same as moving the
241      * scroll wheel right. */
242     , KE_MOUSEDOWN = 75		/* scroll wheel pseudo-button Down */
243     , KE_MOUSEUP = 76		/* scroll wheel pseudo-button Up */
244     , KE_MOUSELEFT = 77		/* scroll wheel pseudo-button Left */
245     , KE_MOUSERIGHT = 78	/* scroll wheel pseudo-button Right */
246 
247     , KE_KINS = 79		/* keypad Insert key */
248     , KE_KDEL = 80		/* keypad Delete key */
249 
250     , KE_CSI = 81		/* CSI typed directly */
251     , KE_SNR = 82		/* <SNR> */
252     , KE_PLUG = 83		/* <Plug> */
253     , KE_CMDWIN = 84		/* open command-line window from Command-line Mode */
254 
255     , KE_C_LEFT = 85		/* control-left */
256     , KE_C_RIGHT = 86		/* control-right */
257     , KE_C_HOME = 87		/* control-home */
258     , KE_C_END = 88		/* control-end */
259 
260     , KE_X1MOUSE = 89		/* X1/X2 mouse-buttons */
261     , KE_X1DRAG = 90
262     , KE_X1RELEASE = 91
263     , KE_X2MOUSE = 92
264     , KE_X2DRAG = 93
265     , KE_X2RELEASE = 94
266 
267     , KE_DROP = 95		/* DnD data is available */
268     , KE_CURSORHOLD = 96	/* CursorHold event */
269     , KE_NOP = 97		/* doesn't do something */
270     , KE_FOCUSGAINED = 98	/* focus gained */
271     , KE_FOCUSLOST = 99		/* focus lost */
272 };
273 
274 /*
275  * the three byte codes are replaced with the following int when using vgetc()
276  */
277 #define K_ZERO		TERMCAP2KEY(KS_ZERO, KE_FILLER)
278 
279 #define K_UP		TERMCAP2KEY('k', 'u')
280 #define K_DOWN		TERMCAP2KEY('k', 'd')
281 #define K_LEFT		TERMCAP2KEY('k', 'l')
282 #define K_RIGHT		TERMCAP2KEY('k', 'r')
283 #define K_S_UP		TERMCAP2KEY(KS_EXTRA, KE_S_UP)
284 #define K_S_DOWN	TERMCAP2KEY(KS_EXTRA, KE_S_DOWN)
285 #define K_S_LEFT	TERMCAP2KEY('#', '4')
286 #define K_C_LEFT	TERMCAP2KEY(KS_EXTRA, KE_C_LEFT)
287 #define K_S_RIGHT	TERMCAP2KEY('%', 'i')
288 #define K_C_RIGHT	TERMCAP2KEY(KS_EXTRA, KE_C_RIGHT)
289 #define K_S_HOME	TERMCAP2KEY('#', '2')
290 #define K_C_HOME	TERMCAP2KEY(KS_EXTRA, KE_C_HOME)
291 #define K_S_END		TERMCAP2KEY('*', '7')
292 #define K_C_END		TERMCAP2KEY(KS_EXTRA, KE_C_END)
293 #define K_TAB		TERMCAP2KEY(KS_EXTRA, KE_TAB)
294 #define K_S_TAB		TERMCAP2KEY('k', 'B')
295 
296 /* extra set of function keys F1-F4, for vt100 compatible xterm */
297 #define K_XF1		TERMCAP2KEY(KS_EXTRA, KE_XF1)
298 #define K_XF2		TERMCAP2KEY(KS_EXTRA, KE_XF2)
299 #define K_XF3		TERMCAP2KEY(KS_EXTRA, KE_XF3)
300 #define K_XF4		TERMCAP2KEY(KS_EXTRA, KE_XF4)
301 
302 /* extra set of cursor keys for vt100 compatible xterm */
303 #define K_XUP		TERMCAP2KEY(KS_EXTRA, KE_XUP)
304 #define K_XDOWN		TERMCAP2KEY(KS_EXTRA, KE_XDOWN)
305 #define K_XLEFT		TERMCAP2KEY(KS_EXTRA, KE_XLEFT)
306 #define K_XRIGHT	TERMCAP2KEY(KS_EXTRA, KE_XRIGHT)
307 
308 #define K_F1		TERMCAP2KEY('k', '1')	/* function keys */
309 #define K_F2		TERMCAP2KEY('k', '2')
310 #define K_F3		TERMCAP2KEY('k', '3')
311 #define K_F4		TERMCAP2KEY('k', '4')
312 #define K_F5		TERMCAP2KEY('k', '5')
313 #define K_F6		TERMCAP2KEY('k', '6')
314 #define K_F7		TERMCAP2KEY('k', '7')
315 #define K_F8		TERMCAP2KEY('k', '8')
316 #define K_F9		TERMCAP2KEY('k', '9')
317 #define K_F10		TERMCAP2KEY('k', ';')
318 
319 #define K_F11		TERMCAP2KEY('F', '1')
320 #define K_F12		TERMCAP2KEY('F', '2')
321 #define K_F13		TERMCAP2KEY('F', '3')
322 #define K_F14		TERMCAP2KEY('F', '4')
323 #define K_F15		TERMCAP2KEY('F', '5')
324 #define K_F16		TERMCAP2KEY('F', '6')
325 #define K_F17		TERMCAP2KEY('F', '7')
326 #define K_F18		TERMCAP2KEY('F', '8')
327 #define K_F19		TERMCAP2KEY('F', '9')
328 #define K_F20		TERMCAP2KEY('F', 'A')
329 
330 #define K_F21		TERMCAP2KEY('F', 'B')
331 #define K_F22		TERMCAP2KEY('F', 'C')
332 #define K_F23		TERMCAP2KEY('F', 'D')
333 #define K_F24		TERMCAP2KEY('F', 'E')
334 #define K_F25		TERMCAP2KEY('F', 'F')
335 #define K_F26		TERMCAP2KEY('F', 'G')
336 #define K_F27		TERMCAP2KEY('F', 'H')
337 #define K_F28		TERMCAP2KEY('F', 'I')
338 #define K_F29		TERMCAP2KEY('F', 'J')
339 #define K_F30		TERMCAP2KEY('F', 'K')
340 
341 #define K_F31		TERMCAP2KEY('F', 'L')
342 #define K_F32		TERMCAP2KEY('F', 'M')
343 #define K_F33		TERMCAP2KEY('F', 'N')
344 #define K_F34		TERMCAP2KEY('F', 'O')
345 #define K_F35		TERMCAP2KEY('F', 'P')
346 #define K_F36		TERMCAP2KEY('F', 'Q')
347 #define K_F37		TERMCAP2KEY('F', 'R')
348 
349 /* extra set of shifted function keys F1-F4, for vt100 compatible xterm */
350 #define K_S_XF1		TERMCAP2KEY(KS_EXTRA, KE_S_XF1)
351 #define K_S_XF2		TERMCAP2KEY(KS_EXTRA, KE_S_XF2)
352 #define K_S_XF3		TERMCAP2KEY(KS_EXTRA, KE_S_XF3)
353 #define K_S_XF4		TERMCAP2KEY(KS_EXTRA, KE_S_XF4)
354 
355 #define K_S_F1		TERMCAP2KEY(KS_EXTRA, KE_S_F1)	/* shifted func. keys */
356 #define K_S_F2		TERMCAP2KEY(KS_EXTRA, KE_S_F2)
357 #define K_S_F3		TERMCAP2KEY(KS_EXTRA, KE_S_F3)
358 #define K_S_F4		TERMCAP2KEY(KS_EXTRA, KE_S_F4)
359 #define K_S_F5		TERMCAP2KEY(KS_EXTRA, KE_S_F5)
360 #define K_S_F6		TERMCAP2KEY(KS_EXTRA, KE_S_F6)
361 #define K_S_F7		TERMCAP2KEY(KS_EXTRA, KE_S_F7)
362 #define K_S_F8		TERMCAP2KEY(KS_EXTRA, KE_S_F8)
363 #define K_S_F9		TERMCAP2KEY(KS_EXTRA, KE_S_F9)
364 #define K_S_F10		TERMCAP2KEY(KS_EXTRA, KE_S_F10)
365 
366 #define K_S_F11		TERMCAP2KEY(KS_EXTRA, KE_S_F11)
367 #define K_S_F12		TERMCAP2KEY(KS_EXTRA, KE_S_F12)
368 /* K_S_F13 to K_S_F37  are currently not used */
369 
370 #define K_HELP		TERMCAP2KEY('%', '1')
371 #define K_UNDO		TERMCAP2KEY('&', '8')
372 
373 #define K_BS		TERMCAP2KEY('k', 'b')
374 
375 #define K_INS		TERMCAP2KEY('k', 'I')
376 #define K_KINS		TERMCAP2KEY(KS_EXTRA, KE_KINS)
377 #define K_DEL		TERMCAP2KEY('k', 'D')
378 #define K_KDEL		TERMCAP2KEY(KS_EXTRA, KE_KDEL)
379 #define K_HOME		TERMCAP2KEY('k', 'h')
380 #define K_KHOME		TERMCAP2KEY('K', '1')	/* keypad home (upper left) */
381 #define K_XHOME		TERMCAP2KEY(KS_EXTRA, KE_XHOME)
382 #define K_ZHOME		TERMCAP2KEY(KS_EXTRA, KE_ZHOME)
383 #define K_END		TERMCAP2KEY('@', '7')
384 #define K_KEND		TERMCAP2KEY('K', '4')	/* keypad end (lower left) */
385 #define K_XEND		TERMCAP2KEY(KS_EXTRA, KE_XEND)
386 #define K_ZEND		TERMCAP2KEY(KS_EXTRA, KE_ZEND)
387 #define K_PAGEUP	TERMCAP2KEY('k', 'P')
388 #define K_PAGEDOWN	TERMCAP2KEY('k', 'N')
389 #define K_KPAGEUP	TERMCAP2KEY('K', '3')	/* keypad pageup (upper R.) */
390 #define K_KPAGEDOWN	TERMCAP2KEY('K', '5')	/* keypad pagedown (lower R.) */
391 
392 #define K_KPLUS		TERMCAP2KEY('K', '6')	/* keypad plus */
393 #define K_KMINUS	TERMCAP2KEY('K', '7')	/* keypad minus */
394 #define K_KDIVIDE	TERMCAP2KEY('K', '8')	/* keypad / */
395 #define K_KMULTIPLY	TERMCAP2KEY('K', '9')	/* keypad * */
396 #define K_KENTER	TERMCAP2KEY('K', 'A')	/* keypad Enter */
397 #define K_KPOINT	TERMCAP2KEY('K', 'B')	/* keypad . or ,*/
398 #define K_PS		TERMCAP2KEY('P', 'S')	/* paste start */
399 #define K_PE		TERMCAP2KEY('P', 'E')	/* paste end */
400 
401 #define K_K0		TERMCAP2KEY('K', 'C')	/* keypad 0 */
402 #define K_K1		TERMCAP2KEY('K', 'D')	/* keypad 1 */
403 #define K_K2		TERMCAP2KEY('K', 'E')	/* keypad 2 */
404 #define K_K3		TERMCAP2KEY('K', 'F')	/* keypad 3 */
405 #define K_K4		TERMCAP2KEY('K', 'G')	/* keypad 4 */
406 #define K_K5		TERMCAP2KEY('K', 'H')	/* keypad 5 */
407 #define K_K6		TERMCAP2KEY('K', 'I')	/* keypad 6 */
408 #define K_K7		TERMCAP2KEY('K', 'J')	/* keypad 7 */
409 #define K_K8		TERMCAP2KEY('K', 'K')	/* keypad 8 */
410 #define K_K9		TERMCAP2KEY('K', 'L')	/* keypad 9 */
411 
412 #define K_MOUSE		TERMCAP2KEY(KS_MOUSE, KE_FILLER)
413 #define K_MENU		TERMCAP2KEY(KS_MENU, KE_FILLER)
414 #define K_VER_SCROLLBAR	TERMCAP2KEY(KS_VER_SCROLLBAR, KE_FILLER)
415 #define K_HOR_SCROLLBAR   TERMCAP2KEY(KS_HOR_SCROLLBAR, KE_FILLER)
416 
417 #define K_NETTERM_MOUSE	TERMCAP2KEY(KS_NETTERM_MOUSE, KE_FILLER)
418 #define K_DEC_MOUSE	TERMCAP2KEY(KS_DEC_MOUSE, KE_FILLER)
419 #define K_JSBTERM_MOUSE	TERMCAP2KEY(KS_JSBTERM_MOUSE, KE_FILLER)
420 #define K_PTERM_MOUSE	TERMCAP2KEY(KS_PTERM_MOUSE, KE_FILLER)
421 #define K_URXVT_MOUSE	TERMCAP2KEY(KS_URXVT_MOUSE, KE_FILLER)
422 #define K_SGR_MOUSE	TERMCAP2KEY(KS_SGR_MOUSE, KE_FILLER)
423 #define K_SGR_MOUSERELEASE TERMCAP2KEY(KS_SGR_MOUSE_RELEASE, KE_FILLER)
424 
425 #define K_SELECT	TERMCAP2KEY(KS_SELECT, KE_FILLER)
426 #define K_TEAROFF	TERMCAP2KEY(KS_TEAROFF, KE_FILLER)
427 
428 #define K_TABLINE	TERMCAP2KEY(KS_TABLINE, KE_FILLER)
429 #define K_TABMENU	TERMCAP2KEY(KS_TABMENU, KE_FILLER)
430 
431 /*
432  * Symbols for pseudo keys which are translated from the real key symbols
433  * above.
434  */
435 #define K_LEFTMOUSE	TERMCAP2KEY(KS_EXTRA, KE_LEFTMOUSE)
436 #define K_LEFTMOUSE_NM	TERMCAP2KEY(KS_EXTRA, KE_LEFTMOUSE_NM)
437 #define K_LEFTDRAG	TERMCAP2KEY(KS_EXTRA, KE_LEFTDRAG)
438 #define K_LEFTRELEASE	TERMCAP2KEY(KS_EXTRA, KE_LEFTRELEASE)
439 #define K_LEFTRELEASE_NM TERMCAP2KEY(KS_EXTRA, KE_LEFTRELEASE_NM)
440 #define K_MIDDLEMOUSE	TERMCAP2KEY(KS_EXTRA, KE_MIDDLEMOUSE)
441 #define K_MIDDLEDRAG	TERMCAP2KEY(KS_EXTRA, KE_MIDDLEDRAG)
442 #define K_MIDDLERELEASE	TERMCAP2KEY(KS_EXTRA, KE_MIDDLERELEASE)
443 #define K_RIGHTMOUSE	TERMCAP2KEY(KS_EXTRA, KE_RIGHTMOUSE)
444 #define K_RIGHTDRAG	TERMCAP2KEY(KS_EXTRA, KE_RIGHTDRAG)
445 #define K_RIGHTRELEASE	TERMCAP2KEY(KS_EXTRA, KE_RIGHTRELEASE)
446 #define K_X1MOUSE       TERMCAP2KEY(KS_EXTRA, KE_X1MOUSE)
447 #define K_X1MOUSE       TERMCAP2KEY(KS_EXTRA, KE_X1MOUSE)
448 #define K_X1DRAG	TERMCAP2KEY(KS_EXTRA, KE_X1DRAG)
449 #define K_X1RELEASE     TERMCAP2KEY(KS_EXTRA, KE_X1RELEASE)
450 #define K_X2MOUSE       TERMCAP2KEY(KS_EXTRA, KE_X2MOUSE)
451 #define K_X2DRAG	TERMCAP2KEY(KS_EXTRA, KE_X2DRAG)
452 #define K_X2RELEASE     TERMCAP2KEY(KS_EXTRA, KE_X2RELEASE)
453 
454 #define K_IGNORE	TERMCAP2KEY(KS_EXTRA, KE_IGNORE)
455 #define K_NOP		TERMCAP2KEY(KS_EXTRA, KE_NOP)
456 
457 #define K_MOUSEDOWN	TERMCAP2KEY(KS_EXTRA, KE_MOUSEDOWN)
458 #define K_MOUSEUP	TERMCAP2KEY(KS_EXTRA, KE_MOUSEUP)
459 #define K_MOUSELEFT	TERMCAP2KEY(KS_EXTRA, KE_MOUSELEFT)
460 #define K_MOUSERIGHT	TERMCAP2KEY(KS_EXTRA, KE_MOUSERIGHT)
461 
462 #define K_CSI		TERMCAP2KEY(KS_EXTRA, KE_CSI)
463 #define K_SNR		TERMCAP2KEY(KS_EXTRA, KE_SNR)
464 #define K_PLUG		TERMCAP2KEY(KS_EXTRA, KE_PLUG)
465 #define K_CMDWIN	TERMCAP2KEY(KS_EXTRA, KE_CMDWIN)
466 
467 #define K_DROP		TERMCAP2KEY(KS_EXTRA, KE_DROP)
468 #define K_FOCUSGAINED	TERMCAP2KEY(KS_EXTRA, KE_FOCUSGAINED)
469 #define K_FOCUSLOST	TERMCAP2KEY(KS_EXTRA, KE_FOCUSLOST)
470 
471 #define K_CURSORHOLD	TERMCAP2KEY(KS_EXTRA, KE_CURSORHOLD)
472 
473 /* Bits for modifier mask */
474 /* 0x01 cannot be used, because the modifier must be 0x02 or higher */
475 #define MOD_MASK_SHIFT	    0x02
476 #define MOD_MASK_CTRL	    0x04
477 #define MOD_MASK_ALT	    0x08	/* aka META */
478 #define MOD_MASK_META	    0x10	/* META when it's different from ALT */
479 #define MOD_MASK_2CLICK	    0x20	/* use MOD_MASK_MULTI_CLICK */
480 #define MOD_MASK_3CLICK	    0x40	/* use MOD_MASK_MULTI_CLICK */
481 #define MOD_MASK_4CLICK	    0x60	/* use MOD_MASK_MULTI_CLICK */
482 #ifdef MACOS
483 # define MOD_MASK_CMD	    0x80
484 #endif
485 
486 #define MOD_MASK_MULTI_CLICK	(MOD_MASK_2CLICK|MOD_MASK_3CLICK|MOD_MASK_4CLICK)
487 
488 /*
489  * The length of the longest special key name, including modifiers.
490  * Current longest is <M-C-S-T-D-A-4-ScrollWheelRight> (length includes '<' and
491  * '>').
492  */
493 #define MAX_KEY_NAME_LEN    32
494 
495 /* Maximum length of a special key event as tokens.  This includes modifiers.
496  * The longest event is something like <M-C-S-T-4-LeftDrag> which would be the
497  * following string of tokens:
498  *
499  * <K_SPECIAL> <KS_MODIFIER> bitmask <K_SPECIAL> <KS_EXTRA> <KT_LEFTDRAG>.
500  *
501  * This is a total of 6 tokens, and is currently the longest one possible.
502  */
503 #define MAX_KEY_CODE_LEN    6
504