xref: /vim-8.2.3635/src/keymap.h (revision cf2d8dee)
1 /* vi:set ts=8 sts=4 sw=4:
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 
116 /*
117  * Filler used after KS_SPECIAL and others
118  */
119 #define KE_FILLER		('X')
120 
121 /*
122  * translation of three byte code "K_SPECIAL a b" into int "K_xxx" and back
123  */
124 #define TERMCAP2KEY(a, b)	(-((a) + ((int)(b) << 8)))
125 #define KEY2TERMCAP0(x)		((-(x)) & 0xff)
126 #define KEY2TERMCAP1(x)		(((unsigned)(-(x)) >> 8) & 0xff)
127 
128 /*
129  * get second or third byte when translating special key code into three bytes
130  */
131 #define K_SECOND(c)	((c) == K_SPECIAL ? KS_SPECIAL : (c) == NUL ? KS_ZERO : KEY2TERMCAP0(c))
132 
133 #define K_THIRD(c)	(((c) == K_SPECIAL || (c) == NUL) ? KE_FILLER : KEY2TERMCAP1(c))
134 
135 /*
136  * get single int code from second byte after K_SPECIAL
137  */
138 #define TO_SPECIAL(a, b)    ((a) == KS_SPECIAL ? K_SPECIAL : (a) == KS_ZERO ? K_ZERO : TERMCAP2KEY(a, b))
139 
140 /*
141  * Codes for keys that do not have a termcap name.
142  *
143  * K_SPECIAL KS_EXTRA KE_xxx
144  */
145 enum key_extra
146 {
147     KE_NAME = 3		/* name of this terminal entry */
148 
149     , KE_S_UP		/* shift-up */
150     , KE_S_DOWN		/* shift-down */
151 
152     , KE_S_F1		/* shifted function keys */
153     , KE_S_F2
154     , KE_S_F3
155     , KE_S_F4
156     , KE_S_F5
157     , KE_S_F6
158     , KE_S_F7
159     , KE_S_F8
160     , KE_S_F9
161     , KE_S_F10
162 
163     , KE_S_F11
164     , KE_S_F12
165     , KE_S_F13
166     , KE_S_F14
167     , KE_S_F15
168     , KE_S_F16
169     , KE_S_F17
170     , KE_S_F18
171     , KE_S_F19
172     , KE_S_F20
173 
174     , KE_S_F21
175     , KE_S_F22
176     , KE_S_F23
177     , KE_S_F24
178     , KE_S_F25
179     , KE_S_F26
180     , KE_S_F27
181     , KE_S_F28
182     , KE_S_F29
183     , KE_S_F30
184 
185     , KE_S_F31
186     , KE_S_F32
187     , KE_S_F33
188     , KE_S_F34
189     , KE_S_F35
190     , KE_S_F36
191     , KE_S_F37
192 
193     , KE_MOUSE		/* mouse event start */
194 
195 /*
196  * Symbols for pseudo keys which are translated from the real key symbols
197  * above.
198  */
199     , KE_LEFTMOUSE	/* Left mouse button click */
200     , KE_LEFTDRAG	/* Drag with left mouse button down */
201     , KE_LEFTRELEASE	/* Left mouse button release */
202     , KE_MIDDLEMOUSE	/* Middle mouse button click */
203     , KE_MIDDLEDRAG	/* Drag with middle mouse button down */
204     , KE_MIDDLERELEASE	/* Middle mouse button release */
205     , KE_RIGHTMOUSE	/* Right mouse button click */
206     , KE_RIGHTDRAG	/* Drag with right mouse button down */
207     , KE_RIGHTRELEASE	/* Right mouse button release */
208 
209     , KE_IGNORE		/* Ignored mouse drag/release */
210 
211     , KE_TAB		/* unshifted TAB key */
212     , KE_S_TAB_OLD	/* shifted TAB key (no longer used) */
213 
214     , KE_XF1		/* extra vt100 function keys for xterm */
215     , KE_XF2
216     , KE_XF3
217     , KE_XF4
218     , KE_XEND		/* extra (vt100) end key for xterm */
219     , KE_ZEND		/* extra (vt100) end key for xterm */
220     , KE_XHOME		/* extra (vt100) home key for xterm */
221     , KE_ZHOME		/* extra (vt100) home key for xterm */
222     , KE_XUP		/* extra vt100 cursor keys for xterm */
223     , KE_XDOWN
224     , KE_XLEFT
225     , KE_XRIGHT
226 
227     , KE_LEFTMOUSE_NM	/* non-mappable Left mouse button click */
228     , KE_LEFTRELEASE_NM	/* non-mappable left mouse button release */
229 
230     , KE_S_XF1		/* extra vt100 shifted function keys for xterm */
231     , KE_S_XF2
232     , KE_S_XF3
233     , KE_S_XF4
234 
235     /* NOTE: The scroll wheel events are inverted: i.e. UP is the same as
236      * moving the actual scroll wheel down, LEFT is the same as moving the
237      * scroll wheel right. */
238     , KE_MOUSEDOWN	/* scroll wheel pseudo-button Down */
239     , KE_MOUSEUP	/* scroll wheel pseudo-button Up */
240     , KE_MOUSELEFT	/* scroll wheel pseudo-button Left */
241     , KE_MOUSERIGHT	/* scroll wheel pseudo-button Right */
242 
243     , KE_KINS		/* keypad Insert key */
244     , KE_KDEL		/* keypad Delete key */
245 
246     , KE_CSI		/* CSI typed directly */
247     , KE_SNR		/* <SNR> */
248     , KE_PLUG		/* <Plug> */
249     , KE_CMDWIN		/* open command-line window from Command-line Mode */
250 
251     , KE_C_LEFT		/* control-left */
252     , KE_C_RIGHT	/* control-right */
253     , KE_C_HOME		/* control-home */
254     , KE_C_END		/* control-end */
255 
256     , KE_X1MOUSE	/* X1/X2 mouse-buttons */
257     , KE_X1DRAG
258     , KE_X1RELEASE
259     , KE_X2MOUSE
260     , KE_X2DRAG
261     , KE_X2RELEASE
262 
263     , KE_DROP		/* DnD data is available */
264     , KE_CURSORHOLD	/* CursorHold event */
265     , KE_NOP		/* doesn't do something */
266     , KE_FOCUSGAINED	/* focus gained */
267     , KE_FOCUSLOST	/* focus lost */
268 };
269 
270 /*
271  * the three byte codes are replaced with the following int when using vgetc()
272  */
273 #define K_ZERO		TERMCAP2KEY(KS_ZERO, KE_FILLER)
274 
275 #define K_UP		TERMCAP2KEY('k', 'u')
276 #define K_DOWN		TERMCAP2KEY('k', 'd')
277 #define K_LEFT		TERMCAP2KEY('k', 'l')
278 #define K_RIGHT		TERMCAP2KEY('k', 'r')
279 #define K_S_UP		TERMCAP2KEY(KS_EXTRA, KE_S_UP)
280 #define K_S_DOWN	TERMCAP2KEY(KS_EXTRA, KE_S_DOWN)
281 #define K_S_LEFT	TERMCAP2KEY('#', '4')
282 #define K_C_LEFT	TERMCAP2KEY(KS_EXTRA, KE_C_LEFT)
283 #define K_S_RIGHT	TERMCAP2KEY('%', 'i')
284 #define K_C_RIGHT	TERMCAP2KEY(KS_EXTRA, KE_C_RIGHT)
285 #define K_S_HOME	TERMCAP2KEY('#', '2')
286 #define K_C_HOME	TERMCAP2KEY(KS_EXTRA, KE_C_HOME)
287 #define K_S_END		TERMCAP2KEY('*', '7')
288 #define K_C_END		TERMCAP2KEY(KS_EXTRA, KE_C_END)
289 #define K_TAB		TERMCAP2KEY(KS_EXTRA, KE_TAB)
290 #define K_S_TAB		TERMCAP2KEY('k', 'B')
291 
292 /* extra set of function keys F1-F4, for vt100 compatible xterm */
293 #define K_XF1		TERMCAP2KEY(KS_EXTRA, KE_XF1)
294 #define K_XF2		TERMCAP2KEY(KS_EXTRA, KE_XF2)
295 #define K_XF3		TERMCAP2KEY(KS_EXTRA, KE_XF3)
296 #define K_XF4		TERMCAP2KEY(KS_EXTRA, KE_XF4)
297 
298 /* extra set of cursor keys for vt100 compatible xterm */
299 #define K_XUP		TERMCAP2KEY(KS_EXTRA, KE_XUP)
300 #define K_XDOWN		TERMCAP2KEY(KS_EXTRA, KE_XDOWN)
301 #define K_XLEFT		TERMCAP2KEY(KS_EXTRA, KE_XLEFT)
302 #define K_XRIGHT	TERMCAP2KEY(KS_EXTRA, KE_XRIGHT)
303 
304 #define K_F1		TERMCAP2KEY('k', '1')	/* function keys */
305 #define K_F2		TERMCAP2KEY('k', '2')
306 #define K_F3		TERMCAP2KEY('k', '3')
307 #define K_F4		TERMCAP2KEY('k', '4')
308 #define K_F5		TERMCAP2KEY('k', '5')
309 #define K_F6		TERMCAP2KEY('k', '6')
310 #define K_F7		TERMCAP2KEY('k', '7')
311 #define K_F8		TERMCAP2KEY('k', '8')
312 #define K_F9		TERMCAP2KEY('k', '9')
313 #define K_F10		TERMCAP2KEY('k', ';')
314 
315 #define K_F11		TERMCAP2KEY('F', '1')
316 #define K_F12		TERMCAP2KEY('F', '2')
317 #define K_F13		TERMCAP2KEY('F', '3')
318 #define K_F14		TERMCAP2KEY('F', '4')
319 #define K_F15		TERMCAP2KEY('F', '5')
320 #define K_F16		TERMCAP2KEY('F', '6')
321 #define K_F17		TERMCAP2KEY('F', '7')
322 #define K_F18		TERMCAP2KEY('F', '8')
323 #define K_F19		TERMCAP2KEY('F', '9')
324 #define K_F20		TERMCAP2KEY('F', 'A')
325 
326 #define K_F21		TERMCAP2KEY('F', 'B')
327 #define K_F22		TERMCAP2KEY('F', 'C')
328 #define K_F23		TERMCAP2KEY('F', 'D')
329 #define K_F24		TERMCAP2KEY('F', 'E')
330 #define K_F25		TERMCAP2KEY('F', 'F')
331 #define K_F26		TERMCAP2KEY('F', 'G')
332 #define K_F27		TERMCAP2KEY('F', 'H')
333 #define K_F28		TERMCAP2KEY('F', 'I')
334 #define K_F29		TERMCAP2KEY('F', 'J')
335 #define K_F30		TERMCAP2KEY('F', 'K')
336 
337 #define K_F31		TERMCAP2KEY('F', 'L')
338 #define K_F32		TERMCAP2KEY('F', 'M')
339 #define K_F33		TERMCAP2KEY('F', 'N')
340 #define K_F34		TERMCAP2KEY('F', 'O')
341 #define K_F35		TERMCAP2KEY('F', 'P')
342 #define K_F36		TERMCAP2KEY('F', 'Q')
343 #define K_F37		TERMCAP2KEY('F', 'R')
344 
345 /* extra set of shifted function keys F1-F4, for vt100 compatible xterm */
346 #define K_S_XF1		TERMCAP2KEY(KS_EXTRA, KE_S_XF1)
347 #define K_S_XF2		TERMCAP2KEY(KS_EXTRA, KE_S_XF2)
348 #define K_S_XF3		TERMCAP2KEY(KS_EXTRA, KE_S_XF3)
349 #define K_S_XF4		TERMCAP2KEY(KS_EXTRA, KE_S_XF4)
350 
351 #define K_S_F1		TERMCAP2KEY(KS_EXTRA, KE_S_F1)	/* shifted func. keys */
352 #define K_S_F2		TERMCAP2KEY(KS_EXTRA, KE_S_F2)
353 #define K_S_F3		TERMCAP2KEY(KS_EXTRA, KE_S_F3)
354 #define K_S_F4		TERMCAP2KEY(KS_EXTRA, KE_S_F4)
355 #define K_S_F5		TERMCAP2KEY(KS_EXTRA, KE_S_F5)
356 #define K_S_F6		TERMCAP2KEY(KS_EXTRA, KE_S_F6)
357 #define K_S_F7		TERMCAP2KEY(KS_EXTRA, KE_S_F7)
358 #define K_S_F8		TERMCAP2KEY(KS_EXTRA, KE_S_F8)
359 #define K_S_F9		TERMCAP2KEY(KS_EXTRA, KE_S_F9)
360 #define K_S_F10		TERMCAP2KEY(KS_EXTRA, KE_S_F10)
361 
362 #define K_S_F11		TERMCAP2KEY(KS_EXTRA, KE_S_F11)
363 #define K_S_F12		TERMCAP2KEY(KS_EXTRA, KE_S_F12)
364 /* K_S_F13 to K_S_F37  are currently not used */
365 
366 #define K_HELP		TERMCAP2KEY('%', '1')
367 #define K_UNDO		TERMCAP2KEY('&', '8')
368 
369 #define K_BS		TERMCAP2KEY('k', 'b')
370 
371 #define K_INS		TERMCAP2KEY('k', 'I')
372 #define K_KINS		TERMCAP2KEY(KS_EXTRA, KE_KINS)
373 #define K_DEL		TERMCAP2KEY('k', 'D')
374 #define K_KDEL		TERMCAP2KEY(KS_EXTRA, KE_KDEL)
375 #define K_HOME		TERMCAP2KEY('k', 'h')
376 #define K_KHOME		TERMCAP2KEY('K', '1')	/* keypad home (upper left) */
377 #define K_XHOME		TERMCAP2KEY(KS_EXTRA, KE_XHOME)
378 #define K_ZHOME		TERMCAP2KEY(KS_EXTRA, KE_ZHOME)
379 #define K_END		TERMCAP2KEY('@', '7')
380 #define K_KEND		TERMCAP2KEY('K', '4')	/* keypad end (lower left) */
381 #define K_XEND		TERMCAP2KEY(KS_EXTRA, KE_XEND)
382 #define K_ZEND		TERMCAP2KEY(KS_EXTRA, KE_ZEND)
383 #define K_PAGEUP	TERMCAP2KEY('k', 'P')
384 #define K_PAGEDOWN	TERMCAP2KEY('k', 'N')
385 #define K_KPAGEUP	TERMCAP2KEY('K', '3')	/* keypad pageup (upper R.) */
386 #define K_KPAGEDOWN	TERMCAP2KEY('K', '5')	/* keypad pagedown (lower R.) */
387 
388 #define K_KPLUS		TERMCAP2KEY('K', '6')	/* keypad plus */
389 #define K_KMINUS	TERMCAP2KEY('K', '7')	/* keypad minus */
390 #define K_KDIVIDE	TERMCAP2KEY('K', '8')	/* keypad / */
391 #define K_KMULTIPLY	TERMCAP2KEY('K', '9')	/* keypad * */
392 #define K_KENTER	TERMCAP2KEY('K', 'A')	/* keypad Enter */
393 #define K_KPOINT	TERMCAP2KEY('K', 'B')	/* keypad . or ,*/
394 
395 #define K_K0		TERMCAP2KEY('K', 'C')	/* keypad 0 */
396 #define K_K1		TERMCAP2KEY('K', 'D')	/* keypad 1 */
397 #define K_K2		TERMCAP2KEY('K', 'E')	/* keypad 2 */
398 #define K_K3		TERMCAP2KEY('K', 'F')	/* keypad 3 */
399 #define K_K4		TERMCAP2KEY('K', 'G')	/* keypad 4 */
400 #define K_K5		TERMCAP2KEY('K', 'H')	/* keypad 5 */
401 #define K_K6		TERMCAP2KEY('K', 'I')	/* keypad 6 */
402 #define K_K7		TERMCAP2KEY('K', 'J')	/* keypad 7 */
403 #define K_K8		TERMCAP2KEY('K', 'K')	/* keypad 8 */
404 #define K_K9		TERMCAP2KEY('K', 'L')	/* keypad 9 */
405 
406 #define K_MOUSE		TERMCAP2KEY(KS_MOUSE, KE_FILLER)
407 #define K_MENU		TERMCAP2KEY(KS_MENU, KE_FILLER)
408 #define K_VER_SCROLLBAR	TERMCAP2KEY(KS_VER_SCROLLBAR, KE_FILLER)
409 #define K_HOR_SCROLLBAR   TERMCAP2KEY(KS_HOR_SCROLLBAR, KE_FILLER)
410 
411 #define K_NETTERM_MOUSE	TERMCAP2KEY(KS_NETTERM_MOUSE, KE_FILLER)
412 #define K_DEC_MOUSE	TERMCAP2KEY(KS_DEC_MOUSE, KE_FILLER)
413 #define K_JSBTERM_MOUSE	TERMCAP2KEY(KS_JSBTERM_MOUSE, KE_FILLER)
414 #define K_PTERM_MOUSE	TERMCAP2KEY(KS_PTERM_MOUSE, KE_FILLER)
415 #define K_URXVT_MOUSE	TERMCAP2KEY(KS_URXVT_MOUSE, KE_FILLER)
416 #define K_SGR_MOUSE	TERMCAP2KEY(KS_SGR_MOUSE, KE_FILLER)
417 
418 #define K_SELECT	TERMCAP2KEY(KS_SELECT, KE_FILLER)
419 #define K_TEAROFF	TERMCAP2KEY(KS_TEAROFF, KE_FILLER)
420 
421 #define K_TABLINE	TERMCAP2KEY(KS_TABLINE, KE_FILLER)
422 #define K_TABMENU	TERMCAP2KEY(KS_TABMENU, KE_FILLER)
423 
424 /*
425  * Symbols for pseudo keys which are translated from the real key symbols
426  * above.
427  */
428 #define K_LEFTMOUSE	TERMCAP2KEY(KS_EXTRA, KE_LEFTMOUSE)
429 #define K_LEFTMOUSE_NM	TERMCAP2KEY(KS_EXTRA, KE_LEFTMOUSE_NM)
430 #define K_LEFTDRAG	TERMCAP2KEY(KS_EXTRA, KE_LEFTDRAG)
431 #define K_LEFTRELEASE	TERMCAP2KEY(KS_EXTRA, KE_LEFTRELEASE)
432 #define K_LEFTRELEASE_NM TERMCAP2KEY(KS_EXTRA, KE_LEFTRELEASE_NM)
433 #define K_MIDDLEMOUSE	TERMCAP2KEY(KS_EXTRA, KE_MIDDLEMOUSE)
434 #define K_MIDDLEDRAG	TERMCAP2KEY(KS_EXTRA, KE_MIDDLEDRAG)
435 #define K_MIDDLERELEASE	TERMCAP2KEY(KS_EXTRA, KE_MIDDLERELEASE)
436 #define K_RIGHTMOUSE	TERMCAP2KEY(KS_EXTRA, KE_RIGHTMOUSE)
437 #define K_RIGHTDRAG	TERMCAP2KEY(KS_EXTRA, KE_RIGHTDRAG)
438 #define K_RIGHTRELEASE	TERMCAP2KEY(KS_EXTRA, KE_RIGHTRELEASE)
439 #define K_X1MOUSE       TERMCAP2KEY(KS_EXTRA, KE_X1MOUSE)
440 #define K_X1MOUSE       TERMCAP2KEY(KS_EXTRA, KE_X1MOUSE)
441 #define K_X1DRAG	TERMCAP2KEY(KS_EXTRA, KE_X1DRAG)
442 #define K_X1RELEASE     TERMCAP2KEY(KS_EXTRA, KE_X1RELEASE)
443 #define K_X2MOUSE       TERMCAP2KEY(KS_EXTRA, KE_X2MOUSE)
444 #define K_X2DRAG	TERMCAP2KEY(KS_EXTRA, KE_X2DRAG)
445 #define K_X2RELEASE     TERMCAP2KEY(KS_EXTRA, KE_X2RELEASE)
446 
447 #define K_IGNORE	TERMCAP2KEY(KS_EXTRA, KE_IGNORE)
448 #define K_NOP		TERMCAP2KEY(KS_EXTRA, KE_NOP)
449 
450 #define K_MOUSEDOWN	TERMCAP2KEY(KS_EXTRA, KE_MOUSEDOWN)
451 #define K_MOUSEUP	TERMCAP2KEY(KS_EXTRA, KE_MOUSEUP)
452 #define K_MOUSELEFT	TERMCAP2KEY(KS_EXTRA, KE_MOUSELEFT)
453 #define K_MOUSERIGHT	TERMCAP2KEY(KS_EXTRA, KE_MOUSERIGHT)
454 
455 #define K_CSI		TERMCAP2KEY(KS_EXTRA, KE_CSI)
456 #define K_SNR		TERMCAP2KEY(KS_EXTRA, KE_SNR)
457 #define K_PLUG		TERMCAP2KEY(KS_EXTRA, KE_PLUG)
458 #define K_CMDWIN	TERMCAP2KEY(KS_EXTRA, KE_CMDWIN)
459 
460 #define K_DROP		TERMCAP2KEY(KS_EXTRA, KE_DROP)
461 #define K_FOCUSGAINED	TERMCAP2KEY(KS_EXTRA, KE_FOCUSGAINED)
462 #define K_FOCUSLOST	TERMCAP2KEY(KS_EXTRA, KE_FOCUSLOST)
463 
464 #define K_CURSORHOLD	TERMCAP2KEY(KS_EXTRA, KE_CURSORHOLD)
465 
466 /* Bits for modifier mask */
467 /* 0x01 cannot be used, because the modifier must be 0x02 or higher */
468 #define MOD_MASK_SHIFT	    0x02
469 #define MOD_MASK_CTRL	    0x04
470 #define MOD_MASK_ALT	    0x08	/* aka META */
471 #define MOD_MASK_META	    0x10	/* META when it's different from ALT */
472 #define MOD_MASK_2CLICK	    0x20	/* use MOD_MASK_MULTI_CLICK */
473 #define MOD_MASK_3CLICK	    0x40	/* use MOD_MASK_MULTI_CLICK */
474 #define MOD_MASK_4CLICK	    0x60	/* use MOD_MASK_MULTI_CLICK */
475 #ifdef MACOS
476 # define MOD_MASK_CMD	    0x80
477 #endif
478 
479 #define MOD_MASK_MULTI_CLICK	(MOD_MASK_2CLICK|MOD_MASK_3CLICK|MOD_MASK_4CLICK)
480 
481 /*
482  * The length of the longest special key name, including modifiers.
483  * Current longest is <M-C-S-T-4-MiddleRelease> (length includes '<' and '>').
484  */
485 #define MAX_KEY_NAME_LEN    25
486 
487 /* Maximum length of a special key event as tokens.  This includes modifiers.
488  * The longest event is something like <M-C-S-T-4-LeftDrag> which would be the
489  * following string of tokens:
490  *
491  * <K_SPECIAL> <KS_MODIFIER> bitmask <K_SPECIAL> <KS_EXTRA> <KT_LEFTDRAG>.
492  *
493  * This is a total of 6 tokens, and is currently the longest one possible.
494  */
495 #define MAX_KEY_CODE_LEN    6
496