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