Commit | Line | Data |
---|---|---|
058ff27c | 1 | /* Functions to manipulate keymaps. |
ab422c4d | 2 | Copyright (C) 2001-2013 Free Software Foundation, Inc. |
058ff27c SM |
3 | |
4 | This file is part of GNU Emacs. | |
5 | ||
b9b1cc14 | 6 | GNU Emacs is free software: you can redistribute it and/or modify |
058ff27c | 7 | it under the terms of the GNU General Public License as published by |
b9b1cc14 GM |
8 | the Free Software Foundation, either version 3 of the License, or |
9 | (at your option) any later version. | |
058ff27c SM |
10 | |
11 | GNU Emacs is distributed in the hope that it will be useful, | |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
b9b1cc14 | 17 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
058ff27c SM |
18 | |
19 | #ifndef KEYMAP_H | |
20 | #define KEYMAP_H | |
21 | ||
6612f0bf PE |
22 | /* The maximum byte size consumed by push_key_description. |
23 | All callers should assure that at least this size of memory is | |
24 | allocated at the place pointed by the second argument. | |
25 | ||
26 | There are 6 modifiers, each consumes 2 chars. | |
27 | The octal form of a character code consumes | |
28 | (1 + CHARACTERBITS / 3 + 1) chars (including backslash at the head). | |
29 | We need one more byte for string terminator `\0'. */ | |
30 | #define KEY_DESCRIPTION_SIZE ((2 * 6) + 1 + (CHARACTERBITS / 3) + 1 + 1) | |
31 | ||
058ff27c SM |
32 | #define KEYMAPP(m) (!NILP (get_keymap (m, 0, 0))) |
33 | extern Lisp_Object Qkeymap, Qmenu_bar; | |
e6cba650 DN |
34 | extern Lisp_Object Qremap; |
35 | extern Lisp_Object Qmenu_item; | |
058ff27c | 36 | extern Lisp_Object current_global_map; |
9fa1de30 PE |
37 | extern char *push_key_description (EMACS_INT, char *); |
38 | extern Lisp_Object access_keymap (Lisp_Object, Lisp_Object, bool, bool, bool); | |
39 | extern Lisp_Object get_keymap (Lisp_Object, bool, bool); | |
40 | extern void describe_map_tree (Lisp_Object, bool, Lisp_Object, Lisp_Object, | |
41 | const char *, bool, bool, bool, bool); | |
dbe2216b | 42 | extern ptrdiff_t current_minor_maps (Lisp_Object **, Lisp_Object **); |
675e2c69 DN |
43 | extern void initial_define_key (Lisp_Object, int, const char *); |
44 | extern void initial_define_lispy_key (Lisp_Object, const char *, const char *); | |
383e0970 J |
45 | extern void syms_of_keymap (void); |
46 | extern void keys_of_keymap (void); | |
058ff27c | 47 | |
b41ea33e | 48 | typedef void (*map_keymap_function_t) |
383e0970 | 49 | (Lisp_Object key, Lisp_Object val, Lisp_Object args, void* data); |
9fa1de30 PE |
50 | extern void map_keymap (Lisp_Object, map_keymap_function_t, Lisp_Object, |
51 | void *, bool); | |
492d9fd6 SM |
52 | extern void map_keymap_canonical (Lisp_Object map, |
53 | map_keymap_function_t fun, | |
54 | Lisp_Object args, void *data); | |
058ff27c SM |
55 | |
56 | #endif |