Merged from the latest developing branch.
[MacVim.git] / src / keymap.h
blob39837e554b1fb50f1d31f0efc176c0a7d598ee76
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
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 */
9 /*
10 * Keycode definitions for special keys.
12 * Any special key code sequences are replaced by these codes.
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).
19 #define K_NUL (0xce) /* for MSDOS: special key follows */
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.
29 #define K_SPECIAL (0x80)
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.
37 #define IS_SPECIAL(c) ((c) < 0)
40 * Characters 0x0100 - 0x01ff have a special meaning for abbreviations.
41 * Multi-byte characters also have ABBR_OFF added, thus are above 0x0200.
43 #define ABBR_OFF 0x100
46 * NUL cannot be in the input string, therefore it is replaced by
47 * K_SPECIAL KS_ZERO KE_FILLER
49 #define KS_ZERO 255
52 * K_SPECIAL cannot be in the input string, therefore it is replaced by
53 * K_SPECIAL KS_SPECIAL KE_FILLER
55 #define KS_SPECIAL 254
58 * KS_EXTRA is used for keys that have no termcap name
59 * K_SPECIAL KS_EXTRA KE_xxx
61 #define KS_EXTRA 253
64 * KS_MODIFIER is used when a modifier is given for a (special) key
65 * K_SPECIAL KS_MODIFIER bitmask
67 #define KS_MODIFIER 252
70 * These are used for the GUI
71 * K_SPECIAL KS_xxx KE_FILLER
73 #define KS_MOUSE 251
74 #define KS_MENU 250
75 #define KS_VER_SCROLLBAR 249
76 #define KS_HOR_SCROLLBAR 248
79 * These are used for DEC mouse
81 #define KS_NETTERM_MOUSE 247
82 #define KS_DEC_MOUSE 246
85 * Used for switching Select mode back on after a mapping or menu.
87 #define KS_SELECT 245
88 #define K_SELECT_STRING (char_u *)"\200\365X"
91 * Used for tearing off a menu.
93 #define KS_TEAROFF 244
95 /* used for JSB term mouse */
96 #define KS_JSBTERM_MOUSE 243
98 /* used a termcap entry that produces a normal character */
99 #define KS_KEY 242
101 /* Used for the qnx pterm mouse */
102 #define KS_PTERM_MOUSE 241
104 /* Used for click in a tab pages label. */
105 #define KS_TABLINE 240
107 /* Used for menu in a tab pages line. */
108 #define KS_TABMENU 239
111 * Filler used after KS_SPECIAL and others
113 #define KE_FILLER ('X')
116 * translation of three byte code "K_SPECIAL a b" into int "K_xxx" and back
118 #define TERMCAP2KEY(a, b) (-((a) + ((int)(b) << 8)))
119 #define KEY2TERMCAP0(x) ((-(x)) & 0xff)
120 #define KEY2TERMCAP1(x) (((unsigned)(-(x)) >> 8) & 0xff)
123 * get second or third byte when translating special key code into three bytes
125 #define K_SECOND(c) ((c) == K_SPECIAL ? KS_SPECIAL : (c) == NUL ? KS_ZERO : KEY2TERMCAP0(c))
127 #define K_THIRD(c) (((c) == K_SPECIAL || (c) == NUL) ? KE_FILLER : KEY2TERMCAP1(c))
130 * get single int code from second byte after K_SPECIAL
132 #define TO_SPECIAL(a, b) ((a) == KS_SPECIAL ? K_SPECIAL : (a) == KS_ZERO ? K_ZERO : TERMCAP2KEY(a, b))
135 * Codes for keys that do not have a termcap name.
137 * K_SPECIAL KS_EXTRA KE_xxx
139 enum key_extra
141 KE_NAME = 3 /* name of this terminal entry */
143 , KE_S_UP /* shift-up */
144 , KE_S_DOWN /* shift-down */
146 , KE_S_F1 /* shifted function keys */
147 , KE_S_F2
148 , KE_S_F3
149 , KE_S_F4
150 , KE_S_F5
151 , KE_S_F6
152 , KE_S_F7
153 , KE_S_F8
154 , KE_S_F9
155 , KE_S_F10
157 , KE_S_F11
158 , KE_S_F12
159 , KE_S_F13
160 , KE_S_F14
161 , KE_S_F15
162 , KE_S_F16
163 , KE_S_F17
164 , KE_S_F18
165 , KE_S_F19
166 , KE_S_F20
168 , KE_S_F21
169 , KE_S_F22
170 , KE_S_F23
171 , KE_S_F24
172 , KE_S_F25
173 , KE_S_F26
174 , KE_S_F27
175 , KE_S_F28
176 , KE_S_F29
177 , KE_S_F30
179 , KE_S_F31
180 , KE_S_F32
181 , KE_S_F33
182 , KE_S_F34
183 , KE_S_F35
184 , KE_S_F36
185 , KE_S_F37
187 , KE_MOUSE /* mouse event start */
190 * Symbols for pseudo keys which are translated from the real key symbols
191 * above.
193 , KE_LEFTMOUSE /* Left mouse button click */
194 , KE_LEFTDRAG /* Drag with left mouse button down */
195 , KE_LEFTRELEASE /* Left mouse button release */
196 , KE_MIDDLEMOUSE /* Middle mouse button click */
197 , KE_MIDDLEDRAG /* Drag with middle mouse button down */
198 , KE_MIDDLERELEASE /* Middle mouse button release */
199 , KE_RIGHTMOUSE /* Right mouse button click */
200 , KE_RIGHTDRAG /* Drag with right mouse button down */
201 , KE_RIGHTRELEASE /* Right mouse button release */
203 , KE_IGNORE /* Ignored mouse drag/release */
205 , KE_TAB /* unshifted TAB key */
206 , KE_S_TAB_OLD /* shifted TAB key (no longer used) */
208 , KE_SNIFF /* SNiFF+ input waiting */
210 , KE_XF1 /* extra vt100 function keys for xterm */
211 , KE_XF2
212 , KE_XF3
213 , KE_XF4
214 , KE_XEND /* extra (vt100) end key for xterm */
215 , KE_ZEND /* extra (vt100) end key for xterm */
216 , KE_XHOME /* extra (vt100) home key for xterm */
217 , KE_ZHOME /* extra (vt100) home key for xterm */
218 , KE_XUP /* extra vt100 cursor keys for xterm */
219 , KE_XDOWN
220 , KE_XLEFT
221 , KE_XRIGHT
223 , KE_LEFTMOUSE_NM /* non-mappable Left mouse button click */
224 , KE_LEFTRELEASE_NM /* non-mappable left mouse button release */
226 , KE_S_XF1 /* extra vt100 shifted function keys for xterm */
227 , KE_S_XF2
228 , KE_S_XF3
229 , KE_S_XF4
231 , KE_MOUSEDOWN /* scroll wheel pseudo-button Down */
232 , KE_MOUSEUP /* scroll wheel pseudo-button Up */
234 , KE_KINS /* keypad Insert key */
235 , KE_KDEL /* keypad Delete key */
237 , KE_CSI /* CSI typed directly */
238 , KE_SNR /* <SNR> */
239 , KE_PLUG /* <Plug> */
240 , KE_CMDWIN /* open command-line window from Command-line Mode */
242 , KE_C_LEFT /* control-left */
243 , KE_C_RIGHT /* control-right */
244 , KE_C_HOME /* control-home */
245 , KE_C_END /* control-end */
247 , KE_X1MOUSE /* X1/X2 mouse-buttons */
248 , KE_X1DRAG
249 , KE_X1RELEASE
250 , KE_X2MOUSE
251 , KE_X2DRAG
252 , KE_X2RELEASE
254 , KE_DROP /* DnD data is available */
255 , KE_CURSORHOLD /* CursorHold event */
256 , KE_NOP /* doesn't do something */
257 , KE_FOCUSGAINED /* focus gained */
258 , KE_FOCUSLOST /* focus lost */
262 * the three byte codes are replaced with the following int when using vgetc()
264 #define K_ZERO TERMCAP2KEY(KS_ZERO, KE_FILLER)
266 #define K_UP TERMCAP2KEY('k', 'u')
267 #define K_DOWN TERMCAP2KEY('k', 'd')
268 #define K_LEFT TERMCAP2KEY('k', 'l')
269 #define K_RIGHT TERMCAP2KEY('k', 'r')
270 #define K_S_UP TERMCAP2KEY(KS_EXTRA, KE_S_UP)
271 #define K_S_DOWN TERMCAP2KEY(KS_EXTRA, KE_S_DOWN)
272 #define K_S_LEFT TERMCAP2KEY('#', '4')
273 #define K_C_LEFT TERMCAP2KEY(KS_EXTRA, KE_C_LEFT)
274 #define K_S_RIGHT TERMCAP2KEY('%', 'i')
275 #define K_C_RIGHT TERMCAP2KEY(KS_EXTRA, KE_C_RIGHT)
276 #define K_S_HOME TERMCAP2KEY('#', '2')
277 #define K_C_HOME TERMCAP2KEY(KS_EXTRA, KE_C_HOME)
278 #define K_S_END TERMCAP2KEY('*', '7')
279 #define K_C_END TERMCAP2KEY(KS_EXTRA, KE_C_END)
280 #define K_TAB TERMCAP2KEY(KS_EXTRA, KE_TAB)
281 #define K_S_TAB TERMCAP2KEY('k', 'B')
283 /* extra set of function keys F1-F4, for vt100 compatible xterm */
284 #define K_XF1 TERMCAP2KEY(KS_EXTRA, KE_XF1)
285 #define K_XF2 TERMCAP2KEY(KS_EXTRA, KE_XF2)
286 #define K_XF3 TERMCAP2KEY(KS_EXTRA, KE_XF3)
287 #define K_XF4 TERMCAP2KEY(KS_EXTRA, KE_XF4)
289 /* extra set of cursor keys for vt100 compatible xterm */
290 #define K_XUP TERMCAP2KEY(KS_EXTRA, KE_XUP)
291 #define K_XDOWN TERMCAP2KEY(KS_EXTRA, KE_XDOWN)
292 #define K_XLEFT TERMCAP2KEY(KS_EXTRA, KE_XLEFT)
293 #define K_XRIGHT TERMCAP2KEY(KS_EXTRA, KE_XRIGHT)
295 #define K_F1 TERMCAP2KEY('k', '1') /* function keys */
296 #define K_F2 TERMCAP2KEY('k', '2')
297 #define K_F3 TERMCAP2KEY('k', '3')
298 #define K_F4 TERMCAP2KEY('k', '4')
299 #define K_F5 TERMCAP2KEY('k', '5')
300 #define K_F6 TERMCAP2KEY('k', '6')
301 #define K_F7 TERMCAP2KEY('k', '7')
302 #define K_F8 TERMCAP2KEY('k', '8')
303 #define K_F9 TERMCAP2KEY('k', '9')
304 #define K_F10 TERMCAP2KEY('k', ';')
306 #define K_F11 TERMCAP2KEY('F', '1')
307 #define K_F12 TERMCAP2KEY('F', '2')
308 #define K_F13 TERMCAP2KEY('F', '3')
309 #define K_F14 TERMCAP2KEY('F', '4')
310 #define K_F15 TERMCAP2KEY('F', '5')
311 #define K_F16 TERMCAP2KEY('F', '6')
312 #define K_F17 TERMCAP2KEY('F', '7')
313 #define K_F18 TERMCAP2KEY('F', '8')
314 #define K_F19 TERMCAP2KEY('F', '9')
315 #define K_F20 TERMCAP2KEY('F', 'A')
317 #define K_F21 TERMCAP2KEY('F', 'B')
318 #define K_F22 TERMCAP2KEY('F', 'C')
319 #define K_F23 TERMCAP2KEY('F', 'D')
320 #define K_F24 TERMCAP2KEY('F', 'E')
321 #define K_F25 TERMCAP2KEY('F', 'F')
322 #define K_F26 TERMCAP2KEY('F', 'G')
323 #define K_F27 TERMCAP2KEY('F', 'H')
324 #define K_F28 TERMCAP2KEY('F', 'I')
325 #define K_F29 TERMCAP2KEY('F', 'J')
326 #define K_F30 TERMCAP2KEY('F', 'K')
328 #define K_F31 TERMCAP2KEY('F', 'L')
329 #define K_F32 TERMCAP2KEY('F', 'M')
330 #define K_F33 TERMCAP2KEY('F', 'N')
331 #define K_F34 TERMCAP2KEY('F', 'O')
332 #define K_F35 TERMCAP2KEY('F', 'P')
333 #define K_F36 TERMCAP2KEY('F', 'Q')
334 #define K_F37 TERMCAP2KEY('F', 'R')
336 /* extra set of shifted function keys F1-F4, for vt100 compatible xterm */
337 #define K_S_XF1 TERMCAP2KEY(KS_EXTRA, KE_S_XF1)
338 #define K_S_XF2 TERMCAP2KEY(KS_EXTRA, KE_S_XF2)
339 #define K_S_XF3 TERMCAP2KEY(KS_EXTRA, KE_S_XF3)
340 #define K_S_XF4 TERMCAP2KEY(KS_EXTRA, KE_S_XF4)
342 #define K_S_F1 TERMCAP2KEY(KS_EXTRA, KE_S_F1) /* shifted func. keys */
343 #define K_S_F2 TERMCAP2KEY(KS_EXTRA, KE_S_F2)
344 #define K_S_F3 TERMCAP2KEY(KS_EXTRA, KE_S_F3)
345 #define K_S_F4 TERMCAP2KEY(KS_EXTRA, KE_S_F4)
346 #define K_S_F5 TERMCAP2KEY(KS_EXTRA, KE_S_F5)
347 #define K_S_F6 TERMCAP2KEY(KS_EXTRA, KE_S_F6)
348 #define K_S_F7 TERMCAP2KEY(KS_EXTRA, KE_S_F7)
349 #define K_S_F8 TERMCAP2KEY(KS_EXTRA, KE_S_F8)
350 #define K_S_F9 TERMCAP2KEY(KS_EXTRA, KE_S_F9)
351 #define K_S_F10 TERMCAP2KEY(KS_EXTRA, KE_S_F10)
353 #define K_S_F11 TERMCAP2KEY(KS_EXTRA, KE_S_F11)
354 #define K_S_F12 TERMCAP2KEY(KS_EXTRA, KE_S_F12)
355 /* K_S_F13 to K_S_F37 are currently not used */
357 #define K_HELP TERMCAP2KEY('%', '1')
358 #define K_UNDO TERMCAP2KEY('&', '8')
360 #define K_BS TERMCAP2KEY('k', 'b')
362 #define K_INS TERMCAP2KEY('k', 'I')
363 #define K_KINS TERMCAP2KEY(KS_EXTRA, KE_KINS)
364 #define K_DEL TERMCAP2KEY('k', 'D')
365 #define K_KDEL TERMCAP2KEY(KS_EXTRA, KE_KDEL)
366 #define K_HOME TERMCAP2KEY('k', 'h')
367 #define K_KHOME TERMCAP2KEY('K', '1') /* keypad home (upper left) */
368 #define K_XHOME TERMCAP2KEY(KS_EXTRA, KE_XHOME)
369 #define K_ZHOME TERMCAP2KEY(KS_EXTRA, KE_ZHOME)
370 #define K_END TERMCAP2KEY('@', '7')
371 #define K_KEND TERMCAP2KEY('K', '4') /* keypad end (lower left) */
372 #define K_XEND TERMCAP2KEY(KS_EXTRA, KE_XEND)
373 #define K_ZEND TERMCAP2KEY(KS_EXTRA, KE_ZEND)
374 #define K_PAGEUP TERMCAP2KEY('k', 'P')
375 #define K_PAGEDOWN TERMCAP2KEY('k', 'N')
376 #define K_KPAGEUP TERMCAP2KEY('K', '3') /* keypad pageup (upper R.) */
377 #define K_KPAGEDOWN TERMCAP2KEY('K', '5') /* keypad pagedown (lower R.) */
379 #define K_KPLUS TERMCAP2KEY('K', '6') /* keypad plus */
380 #define K_KMINUS TERMCAP2KEY('K', '7') /* keypad minus */
381 #define K_KDIVIDE TERMCAP2KEY('K', '8') /* keypad / */
382 #define K_KMULTIPLY TERMCAP2KEY('K', '9') /* keypad * */
383 #define K_KENTER TERMCAP2KEY('K', 'A') /* keypad Enter */
384 #define K_KPOINT TERMCAP2KEY('K', 'B') /* keypad . or ,*/
386 #define K_K0 TERMCAP2KEY('K', 'C') /* keypad 0 */
387 #define K_K1 TERMCAP2KEY('K', 'D') /* keypad 1 */
388 #define K_K2 TERMCAP2KEY('K', 'E') /* keypad 2 */
389 #define K_K3 TERMCAP2KEY('K', 'F') /* keypad 3 */
390 #define K_K4 TERMCAP2KEY('K', 'G') /* keypad 4 */
391 #define K_K5 TERMCAP2KEY('K', 'H') /* keypad 5 */
392 #define K_K6 TERMCAP2KEY('K', 'I') /* keypad 6 */
393 #define K_K7 TERMCAP2KEY('K', 'J') /* keypad 7 */
394 #define K_K8 TERMCAP2KEY('K', 'K') /* keypad 8 */
395 #define K_K9 TERMCAP2KEY('K', 'L') /* keypad 9 */
397 #define K_MOUSE TERMCAP2KEY(KS_MOUSE, KE_FILLER)
398 #define K_MENU TERMCAP2KEY(KS_MENU, KE_FILLER)
399 #define K_VER_SCROLLBAR TERMCAP2KEY(KS_VER_SCROLLBAR, KE_FILLER)
400 #define K_HOR_SCROLLBAR TERMCAP2KEY(KS_HOR_SCROLLBAR, KE_FILLER)
402 #define K_NETTERM_MOUSE TERMCAP2KEY(KS_NETTERM_MOUSE, KE_FILLER)
403 #define K_DEC_MOUSE TERMCAP2KEY(KS_DEC_MOUSE, KE_FILLER)
404 #define K_JSBTERM_MOUSE TERMCAP2KEY(KS_JSBTERM_MOUSE, KE_FILLER)
405 #define K_PTERM_MOUSE TERMCAP2KEY(KS_PTERM_MOUSE, KE_FILLER)
407 #define K_SELECT TERMCAP2KEY(KS_SELECT, KE_FILLER)
408 #define K_TEAROFF TERMCAP2KEY(KS_TEAROFF, KE_FILLER)
410 #define K_TABLINE TERMCAP2KEY(KS_TABLINE, KE_FILLER)
411 #define K_TABMENU TERMCAP2KEY(KS_TABMENU, KE_FILLER)
414 * Symbols for pseudo keys which are translated from the real key symbols
415 * above.
417 #define K_LEFTMOUSE TERMCAP2KEY(KS_EXTRA, KE_LEFTMOUSE)
418 #define K_LEFTMOUSE_NM TERMCAP2KEY(KS_EXTRA, KE_LEFTMOUSE_NM)
419 #define K_LEFTDRAG TERMCAP2KEY(KS_EXTRA, KE_LEFTDRAG)
420 #define K_LEFTRELEASE TERMCAP2KEY(KS_EXTRA, KE_LEFTRELEASE)
421 #define K_LEFTRELEASE_NM TERMCAP2KEY(KS_EXTRA, KE_LEFTRELEASE_NM)
422 #define K_MIDDLEMOUSE TERMCAP2KEY(KS_EXTRA, KE_MIDDLEMOUSE)
423 #define K_MIDDLEDRAG TERMCAP2KEY(KS_EXTRA, KE_MIDDLEDRAG)
424 #define K_MIDDLERELEASE TERMCAP2KEY(KS_EXTRA, KE_MIDDLERELEASE)
425 #define K_RIGHTMOUSE TERMCAP2KEY(KS_EXTRA, KE_RIGHTMOUSE)
426 #define K_RIGHTDRAG TERMCAP2KEY(KS_EXTRA, KE_RIGHTDRAG)
427 #define K_RIGHTRELEASE TERMCAP2KEY(KS_EXTRA, KE_RIGHTRELEASE)
428 #define K_X1MOUSE TERMCAP2KEY(KS_EXTRA, KE_X1MOUSE)
429 #define K_X1MOUSE TERMCAP2KEY(KS_EXTRA, KE_X1MOUSE)
430 #define K_X1DRAG TERMCAP2KEY(KS_EXTRA, KE_X1DRAG)
431 #define K_X1RELEASE TERMCAP2KEY(KS_EXTRA, KE_X1RELEASE)
432 #define K_X2MOUSE TERMCAP2KEY(KS_EXTRA, KE_X2MOUSE)
433 #define K_X2DRAG TERMCAP2KEY(KS_EXTRA, KE_X2DRAG)
434 #define K_X2RELEASE TERMCAP2KEY(KS_EXTRA, KE_X2RELEASE)
436 #define K_IGNORE TERMCAP2KEY(KS_EXTRA, KE_IGNORE)
437 #define K_NOP TERMCAP2KEY(KS_EXTRA, KE_NOP)
439 #define K_SNIFF TERMCAP2KEY(KS_EXTRA, KE_SNIFF)
441 #define K_MOUSEDOWN TERMCAP2KEY(KS_EXTRA, KE_MOUSEDOWN)
442 #define K_MOUSEUP TERMCAP2KEY(KS_EXTRA, KE_MOUSEUP)
444 #define K_CSI TERMCAP2KEY(KS_EXTRA, KE_CSI)
445 #define K_SNR TERMCAP2KEY(KS_EXTRA, KE_SNR)
446 #define K_PLUG TERMCAP2KEY(KS_EXTRA, KE_PLUG)
447 #define K_CMDWIN TERMCAP2KEY(KS_EXTRA, KE_CMDWIN)
449 #define K_DROP TERMCAP2KEY(KS_EXTRA, KE_DROP)
450 #define K_FOCUSGAINED TERMCAP2KEY(KS_EXTRA, KE_FOCUSGAINED)
451 #define K_FOCUSLOST TERMCAP2KEY(KS_EXTRA, KE_FOCUSLOST)
453 #define K_CURSORHOLD TERMCAP2KEY(KS_EXTRA, KE_CURSORHOLD)
455 /* Bits for modifier mask */
456 /* 0x01 cannot be used, because the modifier must be 0x02 or higher */
457 #define MOD_MASK_SHIFT 0x02
458 #define MOD_MASK_CTRL 0x04
459 #define MOD_MASK_ALT 0x08 /* aka META */
460 #define MOD_MASK_META 0x10 /* META when it's different from ALT */
461 #define MOD_MASK_2CLICK 0x20 /* use MOD_MASK_MULTI_CLICK */
462 #define MOD_MASK_3CLICK 0x40 /* use MOD_MASK_MULTI_CLICK */
463 #define MOD_MASK_4CLICK 0x60 /* use MOD_MASK_MULTI_CLICK */
464 #ifdef MACOS
465 # define MOD_MASK_CMD 0x80
466 #endif
468 #define MOD_MASK_MULTI_CLICK (MOD_MASK_2CLICK|MOD_MASK_3CLICK|MOD_MASK_4CLICK)
471 * The length of the longest special key name, including modifiers.
472 * Current longest is <M-C-S-T-4-MiddleRelease> (length includes '<' and '>').
474 #define MAX_KEY_NAME_LEN 25
476 /* Maximum length of a special key event as tokens. This includes modifiers.
477 * The longest event is something like <M-C-S-T-4-LeftDrag> which would be the
478 * following string of tokens:
480 * <K_SPECIAL> <KS_MODIFIER> bitmask <K_SPECIAL> <KS_EXTRA> <KT_LEFTDRAG>.
482 * This is a total of 6 tokens, and is currently the longest one possible.
484 #define MAX_KEY_CODE_LEN 6