Commit | Line | Data |
---|---|---|
2c6f1a39 | 1 | /* Manipulation of keymaps |
0b5538bd TTN |
2 | Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, |
3 | 1998, 1999, 2000, 2001, 2002, 2003, 2004, | |
4e6835db | 4 | 2005, 2006, 2007 Free Software Foundation, Inc. |
2c6f1a39 JB |
5 | |
6 | This file is part of GNU Emacs. | |
7 | ||
8 | GNU Emacs is free software; you can redistribute it and/or modify | |
9 | it under the terms of the GNU General Public License as published by | |
502ddf23 | 10 | the Free Software Foundation; either version 2, or (at your option) |
2c6f1a39 JB |
11 | any later version. |
12 | ||
13 | GNU Emacs is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU General Public License | |
19 | along with GNU Emacs; see the file COPYING. If not, write to | |
4fc5845f LK |
20 | the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
21 | Boston, MA 02110-1301, USA. */ | |
2c6f1a39 JB |
22 | |
23 | ||
18160b98 | 24 | #include <config.h> |
2c6f1a39 | 25 | #include <stdio.h> |
08e26e8b SM |
26 | #if HAVE_ALLOCA_H |
27 | # include <alloca.h> | |
28 | #endif | |
2c6f1a39 JB |
29 | #include "lisp.h" |
30 | #include "commands.h" | |
31 | #include "buffer.h" | |
a98f1d1d | 32 | #include "charset.h" |
6bbbd9b0 | 33 | #include "keyboard.h" |
6ba6e250 | 34 | #include "termhooks.h" |
9ac0d9e0 | 35 | #include "blockinput.h" |
d964248c | 36 | #include "puresize.h" |
93d2aa1c | 37 | #include "intervals.h" |
8feddab4 | 38 | #include "keymap.h" |
b74e16a3 | 39 | #include "window.h" |
2c6f1a39 | 40 | |
f5b79c1c | 41 | /* The number of elements in keymap vectors. */ |
2c6f1a39 JB |
42 | #define DENSE_TABLE_SIZE (0200) |
43 | ||
44 | /* Actually allocate storage for these variables */ | |
45 | ||
46 | Lisp_Object current_global_map; /* Current global keymap */ | |
47 | ||
48 | Lisp_Object global_map; /* default global key bindings */ | |
49 | ||
50 | Lisp_Object meta_map; /* The keymap used for globally bound | |
51 | ESC-prefixed default commands */ | |
52 | ||
53 | Lisp_Object control_x_map; /* The keymap used for globally bound | |
54 | C-x-prefixed default commands */ | |
55 | ||
56 | /* was MinibufLocalMap */ | |
57 | Lisp_Object Vminibuffer_local_map; | |
58 | /* The keymap used by the minibuf for local | |
59 | bindings when spaces are allowed in the | |
60 | minibuf */ | |
61 | ||
62 | /* was MinibufLocalNSMap */ | |
d55627cc | 63 | Lisp_Object Vminibuffer_local_ns_map; |
2c6f1a39 JB |
64 | /* The keymap used by the minibuf for local |
65 | bindings when spaces are not encouraged | |
66 | in the minibuf */ | |
67 | ||
68 | /* keymap used for minibuffers when doing completion */ | |
69 | /* was MinibufLocalCompletionMap */ | |
70 | Lisp_Object Vminibuffer_local_completion_map; | |
71 | ||
3d866ceb EZ |
72 | /* keymap used for minibuffers when doing completion in filenames */ |
73 | Lisp_Object Vminibuffer_local_filename_completion_map; | |
74 | ||
a7f96a35 | 75 | /* keymap used for minibuffers when doing completion in filenames |
3d866ceb EZ |
76 | with require-match*/ |
77 | Lisp_Object Vminibuffer_local_must_match_filename_map; | |
78 | ||
2c6f1a39 JB |
79 | /* keymap used for minibuffers when doing completion and require a match */ |
80 | /* was MinibufLocalMustMatchMap */ | |
81 | Lisp_Object Vminibuffer_local_must_match_map; | |
82 | ||
cc0a8174 JB |
83 | /* Alist of minor mode variables and keymaps. */ |
84 | Lisp_Object Vminor_mode_map_alist; | |
85 | ||
dd9cda06 RS |
86 | /* Alist of major-mode-specific overrides for |
87 | minor mode variables and keymaps. */ | |
88 | Lisp_Object Vminor_mode_overriding_map_alist; | |
89 | ||
99cbcaca KS |
90 | /* List of emulation mode keymap alists. */ |
91 | Lisp_Object Vemulation_mode_map_alists; | |
92 | ||
6bbbd9b0 JB |
93 | /* Keymap mapping ASCII function key sequences onto their preferred forms. |
94 | Initialized by the terminal-specific lisp files. See DEFVAR for more | |
95 | documentation. */ | |
96 | Lisp_Object Vfunction_key_map; | |
97 | ||
d7bf9bf5 RS |
98 | /* Keymap mapping ASCII function key sequences onto their preferred forms. */ |
99 | Lisp_Object Vkey_translation_map; | |
100 | ||
107fd03d RS |
101 | /* A list of all commands given new bindings since a certain time |
102 | when nil was stored here. | |
103 | This is used to speed up recomputation of menu key equivalents | |
104 | when Emacs starts up. t means don't record anything here. */ | |
105 | Lisp_Object Vdefine_key_rebound_commands; | |
106 | ||
a1df473f | 107 | Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap; |
2c6f1a39 | 108 | |
ade19cac RS |
109 | /* Alist of elements like (DEL . "\d"). */ |
110 | static Lisp_Object exclude_keys; | |
111 | ||
023b93f6 KS |
112 | /* Pre-allocated 2-element vector for Fcommand_remapping to use. */ |
113 | static Lisp_Object command_remapping_vector; | |
a1df473f | 114 | |
3d248688 JB |
115 | /* A char with the CHAR_META bit set in a vector or the 0200 bit set |
116 | in a string key sequence is equivalent to prefixing with this | |
117 | character. */ | |
2c6f1a39 JB |
118 | extern Lisp_Object meta_prefix_char; |
119 | ||
7d92e329 RS |
120 | extern Lisp_Object Voverriding_local_map; |
121 | ||
1e7d1ab0 SM |
122 | /* Hash table used to cache a reverse-map to speed up calls to where-is. */ |
123 | static Lisp_Object where_is_cache; | |
124 | /* Which keymaps are reverse-stored in the cache. */ | |
125 | static Lisp_Object where_is_cache_keymaps; | |
126 | ||
57495396 SM |
127 | static Lisp_Object store_in_keymap P_ ((Lisp_Object, Lisp_Object, Lisp_Object)); |
128 | static void fix_submap_inheritance P_ ((Lisp_Object, Lisp_Object, Lisp_Object)); | |
129 | ||
130 | static Lisp_Object define_as_prefix P_ ((Lisp_Object, Lisp_Object)); | |
d55627cc SM |
131 | static void describe_command P_ ((Lisp_Object, Lisp_Object)); |
132 | static void describe_translation P_ ((Lisp_Object, Lisp_Object)); | |
57495396 | 133 | static void describe_map P_ ((Lisp_Object, Lisp_Object, |
d55627cc | 134 | void (*) P_ ((Lisp_Object, Lisp_Object)), |
b88e82fd | 135 | int, Lisp_Object, Lisp_Object*, int, int)); |
f8d8ba40 KS |
136 | static void describe_vector P_ ((Lisp_Object, Lisp_Object, Lisp_Object, |
137 | void (*) (Lisp_Object, Lisp_Object), int, | |
b88e82fd RS |
138 | Lisp_Object, Lisp_Object, int *, |
139 | int, int, int)); | |
15fff01d | 140 | static void silly_event_symbol_error P_ ((Lisp_Object)); |
2c6f1a39 | 141 | \f |
cc0a8174 JB |
142 | /* Keymap object support - constructors and predicates. */ |
143 | ||
ce6e5d0b | 144 | DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0, |
335c5470 | 145 | doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST). |
2c0a0e38 LT |
146 | CHARTABLE is a char-table that holds the bindings for all characters |
147 | without modifiers. All entries in it are initially nil, meaning | |
148 | "command undefined". ALIST is an assoc-list which holds bindings for | |
149 | function keys, mouse events, and any other things that appear in the | |
150 | input stream. Initially, ALIST is nil. | |
335c5470 PJ |
151 | |
152 | The optional arg STRING supplies a menu name for the keymap | |
153 | in case you use it as a menu with `x-popup-menu'. */) | |
154 | (string) | |
ce6e5d0b | 155 | Lisp_Object string; |
2c6f1a39 | 156 | { |
ce6e5d0b RS |
157 | Lisp_Object tail; |
158 | if (!NILP (string)) | |
159 | tail = Fcons (string, Qnil); | |
160 | else | |
161 | tail = Qnil; | |
2c6f1a39 | 162 | return Fcons (Qkeymap, |
0403641f | 163 | Fcons (Fmake_char_table (Qkeymap, Qnil), tail)); |
2c6f1a39 JB |
164 | } |
165 | ||
ce6e5d0b | 166 | DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0, |
335c5470 PJ |
167 | doc: /* Construct and return a new sparse keymap. |
168 | Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION), | |
169 | which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION), | |
170 | which binds the function key or mouse event SYMBOL to DEFINITION. | |
171 | Initially the alist is nil. | |
172 | ||
173 | The optional arg STRING supplies a menu name for the keymap | |
174 | in case you use it as a menu with `x-popup-menu'. */) | |
175 | (string) | |
ce6e5d0b | 176 | Lisp_Object string; |
2c6f1a39 | 177 | { |
ce6e5d0b RS |
178 | if (!NILP (string)) |
179 | return Fcons (Qkeymap, Fcons (string, Qnil)); | |
2c6f1a39 JB |
180 | return Fcons (Qkeymap, Qnil); |
181 | } | |
182 | ||
183 | /* This function is used for installing the standard key bindings | |
184 | at initialization time. | |
185 | ||
186 | For example: | |
187 | ||
e25c4e44 | 188 | initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */ |
2c6f1a39 JB |
189 | |
190 | void | |
191 | initial_define_key (keymap, key, defname) | |
192 | Lisp_Object keymap; | |
193 | int key; | |
194 | char *defname; | |
195 | { | |
196 | store_in_keymap (keymap, make_number (key), intern (defname)); | |
197 | } | |
198 | ||
e25c4e44 JB |
199 | void |
200 | initial_define_lispy_key (keymap, keyname, defname) | |
201 | Lisp_Object keymap; | |
202 | char *keyname; | |
203 | char *defname; | |
204 | { | |
205 | store_in_keymap (keymap, intern (keyname), intern (defname)); | |
206 | } | |
207 | ||
2c6f1a39 | 208 | DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0, |
335c5470 PJ |
209 | doc: /* Return t if OBJECT is a keymap. |
210 | ||
211 | A keymap is a list (keymap . ALIST), | |
212 | or a symbol whose function definition is itself a keymap. | |
213 | ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN); | |
214 | a vector of densely packed bindings for small character codes | |
215 | is also allowed as an element. */) | |
216 | (object) | |
2c6f1a39 JB |
217 | Lisp_Object object; |
218 | { | |
02067692 | 219 | return (KEYMAPP (object) ? Qt : Qnil); |
2c6f1a39 JB |
220 | } |
221 | ||
54cbc3d4 | 222 | DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0, |
335c5470 PJ |
223 | doc: /* Return the prompt-string of a keymap MAP. |
224 | If non-nil, the prompt is shown in the echo-area | |
225 | when reading a key-sequence to be looked-up in this keymap. */) | |
226 | (map) | |
54cbc3d4 SM |
227 | Lisp_Object map; |
228 | { | |
32e2fb04 | 229 | map = get_keymap (map, 0, 0); |
54cbc3d4 SM |
230 | while (CONSP (map)) |
231 | { | |
32e2fb04 | 232 | Lisp_Object tem = XCAR (map); |
54cbc3d4 SM |
233 | if (STRINGP (tem)) |
234 | return tem; | |
32e2fb04 | 235 | map = XCDR (map); |
54cbc3d4 SM |
236 | } |
237 | return Qnil; | |
238 | } | |
239 | ||
2c6f1a39 | 240 | /* Check that OBJECT is a keymap (after dereferencing through any |
d09b2024 JB |
241 | symbols). If it is, return it. |
242 | ||
243 | If AUTOLOAD is non-zero and OBJECT is a symbol whose function value | |
244 | is an autoload form, do the autoload and try again. | |
21a0d7a0 | 245 | If AUTOLOAD is nonzero, callers must assume GC is possible. |
d09b2024 | 246 | |
02067692 SM |
247 | If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR |
248 | is zero as well), return Qt. | |
249 | ||
d09b2024 JB |
250 | ERROR controls how we respond if OBJECT isn't a keymap. |
251 | If ERROR is non-zero, signal an error; otherwise, just return Qnil. | |
252 | ||
253 | Note that most of the time, we don't want to pursue autoloads. | |
254 | Functions like Faccessible_keymaps which scan entire keymap trees | |
255 | shouldn't load every autoloaded keymap. I'm not sure about this, | |
256 | but it seems to me that only read_key_sequence, Flookup_key, and | |
df75b1a3 GM |
257 | Fdefine_key should cause keymaps to be autoloaded. |
258 | ||
259 | This function can GC when AUTOLOAD is non-zero, because it calls | |
260 | do_autoload which can GC. */ | |
d09b2024 | 261 | |
2c6f1a39 | 262 | Lisp_Object |
02067692 | 263 | get_keymap (object, error, autoload) |
2c6f1a39 | 264 | Lisp_Object object; |
d09b2024 | 265 | int error, autoload; |
2c6f1a39 | 266 | { |
d09b2024 | 267 | Lisp_Object tem; |
2c6f1a39 | 268 | |
d09b2024 | 269 | autoload_retry: |
b1314e15 KH |
270 | if (NILP (object)) |
271 | goto end; | |
272 | if (CONSP (object) && EQ (XCAR (object), Qkeymap)) | |
273 | return object; | |
f5b79c1c | 274 | |
02067692 SM |
275 | tem = indirect_function (object); |
276 | if (CONSP (tem)) | |
d09b2024 | 277 | { |
02067692 SM |
278 | if (EQ (XCAR (tem), Qkeymap)) |
279 | return tem; | |
d09b2024 | 280 | |
02067692 SM |
281 | /* Should we do an autoload? Autoload forms for keymaps have |
282 | Qkeymap as their fifth element. */ | |
9ce78f7c SM |
283 | if ((autoload || !error) && EQ (XCAR (tem), Qautoload) |
284 | && SYMBOLP (object)) | |
8e4dfd54 | 285 | { |
02067692 | 286 | Lisp_Object tail; |
d09b2024 | 287 | |
02067692 SM |
288 | tail = Fnth (make_number (4), tem); |
289 | if (EQ (tail, Qkeymap)) | |
290 | { | |
291 | if (autoload) | |
292 | { | |
293 | struct gcpro gcpro1, gcpro2; | |
31bea176 | 294 | |
02067692 SM |
295 | GCPRO2 (tem, object); |
296 | do_autoload (tem, object); | |
297 | UNGCPRO; | |
31bea176 | 298 | |
02067692 SM |
299 | goto autoload_retry; |
300 | } | |
301 | else | |
302 | return Qt; | |
303 | } | |
8e4dfd54 | 304 | } |
d09b2024 JB |
305 | } |
306 | ||
b1314e15 | 307 | end: |
2c6f1a39 JB |
308 | if (error) |
309 | wrong_type_argument (Qkeymapp, object); | |
6bbd7a29 | 310 | return Qnil; |
2c6f1a39 | 311 | } |
7d58ed99 | 312 | \f |
31bea176 SM |
313 | /* Return the parent map of KEYMAP, or nil if it has none. |
314 | We assume that KEYMAP is a valid keymap. */ | |
7d58ed99 | 315 | |
31bea176 SM |
316 | Lisp_Object |
317 | keymap_parent (keymap, autoload) | |
7d58ed99 | 318 | Lisp_Object keymap; |
31bea176 | 319 | int autoload; |
7d58ed99 RS |
320 | { |
321 | Lisp_Object list; | |
322 | ||
31bea176 | 323 | keymap = get_keymap (keymap, 1, autoload); |
7d58ed99 RS |
324 | |
325 | /* Skip past the initial element `keymap'. */ | |
03699b14 KR |
326 | list = XCDR (keymap); |
327 | for (; CONSP (list); list = XCDR (list)) | |
7d58ed99 RS |
328 | { |
329 | /* See if there is another `keymap'. */ | |
57495396 | 330 | if (KEYMAPP (list)) |
7d58ed99 RS |
331 | return list; |
332 | } | |
333 | ||
31bea176 | 334 | return get_keymap (list, 0, autoload); |
7d58ed99 RS |
335 | } |
336 | ||
31bea176 SM |
337 | DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0, |
338 | doc: /* Return the parent keymap of KEYMAP. */) | |
339 | (keymap) | |
340 | Lisp_Object keymap; | |
341 | { | |
342 | return keymap_parent (keymap, 1); | |
343 | } | |
3015eec0 | 344 | |
b1904cd9 SM |
345 | /* Check whether MAP is one of MAPS parents. */ |
346 | int | |
347 | keymap_memberp (map, maps) | |
348 | Lisp_Object map, maps; | |
349 | { | |
7e05cdaf | 350 | if (NILP (map)) return 0; |
b1904cd9 | 351 | while (KEYMAPP (maps) && !EQ (map, maps)) |
31bea176 | 352 | maps = keymap_parent (maps, 0); |
b1904cd9 SM |
353 | return (EQ (map, maps)); |
354 | } | |
355 | ||
7d58ed99 RS |
356 | /* Set the parent keymap of MAP to PARENT. */ |
357 | ||
358 | DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0, | |
335c5470 | 359 | doc: /* Modify KEYMAP to set its parent map to PARENT. |
14923440 | 360 | Return PARENT. PARENT should be nil or another keymap. */) |
335c5470 | 361 | (keymap, parent) |
7d58ed99 RS |
362 | Lisp_Object keymap, parent; |
363 | { | |
364 | Lisp_Object list, prev; | |
31bea176 | 365 | struct gcpro gcpro1, gcpro2; |
7d58ed99 | 366 | int i; |
2c6f1a39 | 367 | |
1e7d1ab0 SM |
368 | /* Force a keymap flush for the next call to where-is. |
369 | Since this can be called from within where-is, we don't set where_is_cache | |
370 | directly but only where_is_cache_keymaps, since where_is_cache shouldn't | |
371 | be changed during where-is, while where_is_cache_keymaps is only used at | |
372 | the very beginning of where-is and can thus be changed here without any | |
373 | adverse effect. | |
374 | This is a very minor correctness (rather than safety) issue. */ | |
375 | where_is_cache_keymaps = Qt; | |
376 | ||
31bea176 | 377 | GCPRO2 (keymap, parent); |
02067692 | 378 | keymap = get_keymap (keymap, 1, 1); |
31bea176 | 379 | |
7d58ed99 | 380 | if (!NILP (parent)) |
3015eec0 | 381 | { |
02067692 | 382 | parent = get_keymap (parent, 1, 1); |
3015eec0 GM |
383 | |
384 | /* Check for cycles. */ | |
b1904cd9 | 385 | if (keymap_memberp (keymap, parent)) |
3015eec0 GM |
386 | error ("Cyclic keymap inheritance"); |
387 | } | |
2c6f1a39 | 388 | |
7d58ed99 RS |
389 | /* Skip past the initial element `keymap'. */ |
390 | prev = keymap; | |
391 | while (1) | |
392 | { | |
03699b14 | 393 | list = XCDR (prev); |
7d58ed99 RS |
394 | /* If there is a parent keymap here, replace it. |
395 | If we came to the end, add the parent in PREV. */ | |
54cbc3d4 | 396 | if (!CONSP (list) || KEYMAPP (list)) |
7d58ed99 | 397 | { |
2a5af1cf RS |
398 | /* If we already have the right parent, return now |
399 | so that we avoid the loops below. */ | |
03699b14 | 400 | if (EQ (XCDR (prev), parent)) |
df75b1a3 | 401 | RETURN_UNGCPRO (parent); |
2a5af1cf | 402 | |
49daa5b1 | 403 | CHECK_IMPURE (prev); |
f3fbd155 | 404 | XSETCDR (prev, parent); |
7d58ed99 RS |
405 | break; |
406 | } | |
407 | prev = list; | |
408 | } | |
409 | ||
410 | /* Scan through for submaps, and set their parents too. */ | |
411 | ||
03699b14 | 412 | for (list = XCDR (keymap); CONSP (list); list = XCDR (list)) |
7d58ed99 RS |
413 | { |
414 | /* Stop the scan when we come to the parent. */ | |
03699b14 | 415 | if (EQ (XCAR (list), Qkeymap)) |
7d58ed99 RS |
416 | break; |
417 | ||
418 | /* If this element holds a prefix map, deal with it. */ | |
03699b14 KR |
419 | if (CONSP (XCAR (list)) |
420 | && CONSP (XCDR (XCAR (list)))) | |
421 | fix_submap_inheritance (keymap, XCAR (XCAR (list)), | |
422 | XCDR (XCAR (list))); | |
423 | ||
424 | if (VECTORP (XCAR (list))) | |
425 | for (i = 0; i < XVECTOR (XCAR (list))->size; i++) | |
426 | if (CONSP (XVECTOR (XCAR (list))->contents[i])) | |
7d58ed99 | 427 | fix_submap_inheritance (keymap, make_number (i), |
03699b14 | 428 | XVECTOR (XCAR (list))->contents[i]); |
0403641f | 429 | |
03699b14 | 430 | if (CHAR_TABLE_P (XCAR (list))) |
0403641f | 431 | { |
23cf1efa | 432 | Lisp_Object indices[3]; |
0403641f | 433 | |
fe72189a RS |
434 | map_char_table (fix_submap_inheritance, Qnil, |
435 | XCAR (list), XCAR (list), | |
0403641f RS |
436 | keymap, 0, indices); |
437 | } | |
7d58ed99 RS |
438 | } |
439 | ||
df75b1a3 | 440 | RETURN_UNGCPRO (parent); |
7d58ed99 RS |
441 | } |
442 | ||
443 | /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition. | |
444 | if EVENT is also a prefix in MAP's parent, | |
445 | make sure that SUBMAP inherits that definition as its own parent. */ | |
446 | ||
57495396 | 447 | static void |
7d58ed99 RS |
448 | fix_submap_inheritance (map, event, submap) |
449 | Lisp_Object map, event, submap; | |
450 | { | |
451 | Lisp_Object map_parent, parent_entry; | |
452 | ||
453 | /* SUBMAP is a cons that we found as a key binding. | |
454 | Discard the other things found in a menu key binding. */ | |
455 | ||
02067692 | 456 | submap = get_keymap (get_keyelt (submap, 0), 0, 0); |
7d58ed99 RS |
457 | |
458 | /* If it isn't a keymap now, there's no work to do. */ | |
02067692 | 459 | if (!CONSP (submap)) |
7d58ed99 RS |
460 | return; |
461 | ||
31bea176 | 462 | map_parent = keymap_parent (map, 0); |
02067692 | 463 | if (!NILP (map_parent)) |
320c9428 | 464 | parent_entry = |
02067692 | 465 | get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0); |
7d58ed99 RS |
466 | else |
467 | parent_entry = Qnil; | |
468 | ||
3393c3f5 | 469 | /* If MAP's parent has something other than a keymap, |
9d0ffdd9 | 470 | our own submap shadows it completely. */ |
02067692 | 471 | if (!CONSP (parent_entry)) |
9d0ffdd9 | 472 | return; |
3393c3f5 | 473 | |
7d58ed99 | 474 | if (! EQ (parent_entry, submap)) |
61684f41 RS |
475 | { |
476 | Lisp_Object submap_parent; | |
477 | submap_parent = submap; | |
478 | while (1) | |
479 | { | |
480 | Lisp_Object tem; | |
9d0ffdd9 | 481 | |
31bea176 | 482 | tem = keymap_parent (submap_parent, 0); |
9d0ffdd9 SM |
483 | |
484 | if (KEYMAPP (tem)) | |
485 | { | |
486 | if (keymap_memberp (tem, parent_entry)) | |
487 | /* Fset_keymap_parent could create a cycle. */ | |
488 | return; | |
489 | submap_parent = tem; | |
490 | } | |
61684f41 RS |
491 | else |
492 | break; | |
493 | } | |
494 | Fset_keymap_parent (submap_parent, parent_entry); | |
495 | } | |
7d58ed99 RS |
496 | } |
497 | \f | |
2c6f1a39 | 498 | /* Look up IDX in MAP. IDX may be any sort of event. |
f5b79c1c | 499 | Note that this does only one level of lookup; IDX must be a single |
744cd66b | 500 | event, not a sequence. |
e25c4e44 JB |
501 | |
502 | If T_OK is non-zero, bindings for Qt are treated as default | |
503 | bindings; any key left unmentioned by other tables and bindings is | |
744cd66b | 504 | given the binding of Qt. |
e25c4e44 | 505 | |
c07aec97 RS |
506 | If T_OK is zero, bindings for Qt are not treated specially. |
507 | ||
508 | If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */ | |
2c6f1a39 JB |
509 | |
510 | Lisp_Object | |
db785038 | 511 | access_keymap (map, idx, t_ok, noinherit, autoload) |
2c6f1a39 JB |
512 | Lisp_Object map; |
513 | Lisp_Object idx; | |
e25c4e44 | 514 | int t_ok; |
c07aec97 | 515 | int noinherit; |
db785038 | 516 | int autoload; |
2c6f1a39 | 517 | { |
efb91645 RS |
518 | Lisp_Object val; |
519 | ||
520 | /* Qunbound in VAL means we have found no binding yet. */ | |
521 | val = Qunbound; | |
c07aec97 | 522 | |
2c6f1a39 JB |
523 | /* If idx is a list (some sort of mouse click, perhaps?), |
524 | the index we want to use is the car of the list, which | |
525 | ought to be a symbol. */ | |
cebd887d | 526 | idx = EVENT_HEAD (idx); |
2c6f1a39 | 527 | |
f5b79c1c JB |
528 | /* If idx is a symbol, it might have modifiers, which need to |
529 | be put in the canonical order. */ | |
47684cd9 | 530 | if (SYMBOLP (idx)) |
f5b79c1c | 531 | idx = reorder_modifiers (idx); |
2732bdbb RS |
532 | else if (INTEGERP (idx)) |
533 | /* Clobber the high bits that can be present on a machine | |
534 | with more than 24 bits of integer. */ | |
6e344130 | 535 | XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1))); |
2c6f1a39 | 536 | |
db785038 SM |
537 | /* Handle the special meta -> esc mapping. */ |
538 | if (INTEGERP (idx) && XUINT (idx) & meta_modifier) | |
539 | { | |
7396a36c GM |
540 | /* See if there is a meta-map. If there's none, there is |
541 | no binding for IDX, unless a default binding exists in MAP. */ | |
31bea176 SM |
542 | struct gcpro gcpro1; |
543 | Lisp_Object meta_map; | |
544 | GCPRO1 (map); | |
7f3e8859 RS |
545 | /* A strange value in which Meta is set would cause |
546 | infinite recursion. Protect against that. */ | |
996f9cde | 547 | if (XINT (meta_prefix_char) & CHAR_META) |
7f3e8859 | 548 | meta_prefix_char = make_number (27); |
31bea176 SM |
549 | meta_map = get_keymap (access_keymap (map, meta_prefix_char, |
550 | t_ok, noinherit, autoload), | |
551 | 0, autoload); | |
552 | UNGCPRO; | |
02067692 | 553 | if (CONSP (meta_map)) |
7396a36c | 554 | { |
9d0ffdd9 | 555 | map = meta_map; |
7396a36c GM |
556 | idx = make_number (XUINT (idx) & ~meta_modifier); |
557 | } | |
558 | else if (t_ok) | |
559 | /* Set IDX to t, so that we only find a default binding. */ | |
560 | idx = Qt; | |
561 | else | |
562 | /* We know there is no binding. */ | |
563 | return Qnil; | |
db785038 SM |
564 | } |
565 | ||
31bea176 SM |
566 | /* t_binding is where we put a default binding that applies, |
567 | to use in case we do not find a binding specifically | |
568 | for this key sequence. */ | |
f5b79c1c JB |
569 | { |
570 | Lisp_Object tail; | |
31bea176 SM |
571 | Lisp_Object t_binding = Qnil; |
572 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; | |
efb91645 | 573 | |
31bea176 | 574 | GCPRO4 (map, tail, idx, t_binding); |
845e4cf4 SM |
575 | |
576 | /* If `t_ok' is 2, both `t' and generic-char bindings are accepted. | |
577 | If it is 1, only generic-char bindings are accepted. | |
578 | Otherwise, neither are. */ | |
579 | t_ok = t_ok ? 2 : 0; | |
2c6f1a39 | 580 | |
db785038 | 581 | for (tail = XCDR (map); |
7396a36c | 582 | (CONSP (tail) |
02067692 | 583 | || (tail = get_keymap (tail, 0, autoload), CONSP (tail))); |
db785038 | 584 | tail = XCDR (tail)) |
2c6f1a39 | 585 | { |
e9b6dfb0 | 586 | Lisp_Object binding; |
f5b79c1c | 587 | |
03699b14 | 588 | binding = XCAR (tail); |
783a2838 | 589 | if (SYMBOLP (binding)) |
f5b79c1c | 590 | { |
c07aec97 RS |
591 | /* If NOINHERIT, stop finding prefix definitions |
592 | after we pass a second occurrence of the `keymap' symbol. */ | |
db785038 | 593 | if (noinherit && EQ (binding, Qkeymap)) |
31bea176 | 594 | RETURN_UNGCPRO (Qnil); |
783a2838 KH |
595 | } |
596 | else if (CONSP (binding)) | |
597 | { | |
859ea4b8 | 598 | Lisp_Object key = XCAR (binding); |
744cd66b | 599 | |
859ea4b8 | 600 | if (EQ (key, idx)) |
845e4cf4 SM |
601 | val = XCDR (binding); |
602 | else if (t_ok | |
603 | && INTEGERP (idx) | |
62b366ff | 604 | && (XINT (idx) & CHAR_MODIFIER_MASK) == 0 |
859ea4b8 | 605 | && INTEGERP (key) |
62b366ff | 606 | && (XINT (key) & CHAR_MODIFIER_MASK) == 0 |
859ea4b8 GM |
607 | && !SINGLE_BYTE_CHAR_P (XINT (idx)) |
608 | && !SINGLE_BYTE_CHAR_P (XINT (key)) | |
609 | && CHAR_VALID_P (XINT (key), 1) | |
610 | && !CHAR_VALID_P (XINT (key), 0) | |
611 | && (CHAR_CHARSET (XINT (key)) | |
612 | == CHAR_CHARSET (XINT (idx)))) | |
613 | { | |
614 | /* KEY is the generic character of the charset of IDX. | |
615 | Use KEY's binding if there isn't a binding for IDX | |
616 | itself. */ | |
845e4cf4 SM |
617 | t_binding = XCDR (binding); |
618 | t_ok = 0; | |
619 | } | |
620 | else if (t_ok > 1 && EQ (key, Qt)) | |
621 | { | |
622 | t_binding = XCDR (binding); | |
623 | t_ok = 1; | |
859ea4b8 | 624 | } |
783a2838 KH |
625 | } |
626 | else if (VECTORP (binding)) | |
627 | { | |
845e4cf4 SM |
628 | if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding)) |
629 | val = AREF (binding, XFASTINT (idx)); | |
f5b79c1c | 630 | } |
0403641f RS |
631 | else if (CHAR_TABLE_P (binding)) |
632 | { | |
6418ea16 RS |
633 | /* Character codes with modifiers |
634 | are not included in a char-table. | |
635 | All character codes without modifiers are included. */ | |
4dc3eb25 SM |
636 | if (NATNUMP (idx) && (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0) |
637 | { | |
638 | val = Faref (binding, idx); | |
639 | /* `nil' has a special meaning for char-tables, so | |
640 | we use something else to record an explicitly | |
641 | unbound entry. */ | |
642 | if (NILP (val)) | |
643 | val = Qunbound; | |
644 | } | |
0403641f | 645 | } |
20218e2f | 646 | |
845e4cf4 SM |
647 | /* If we found a binding, clean it up and return it. */ |
648 | if (!EQ (val, Qunbound)) | |
649 | { | |
4dc3eb25 SM |
650 | if (EQ (val, Qt)) |
651 | /* A Qt binding is just like an explicit nil binding | |
652 | (i.e. it shadows any parent binding but not bindings in | |
653 | keymaps of lower precedence). */ | |
654 | val = Qnil; | |
845e4cf4 SM |
655 | val = get_keyelt (val, autoload); |
656 | if (KEYMAPP (val)) | |
657 | fix_submap_inheritance (map, idx, val); | |
31bea176 | 658 | RETURN_UNGCPRO (val); |
845e4cf4 | 659 | } |
20218e2f | 660 | QUIT; |
2c6f1a39 | 661 | } |
31bea176 | 662 | UNGCPRO; |
db785038 | 663 | return get_keyelt (t_binding, autoload); |
e25c4e44 | 664 | } |
2c6f1a39 JB |
665 | } |
666 | ||
9d3153eb SM |
667 | static void |
668 | map_keymap_item (fun, args, key, val, data) | |
669 | map_keymap_function_t fun; | |
670 | Lisp_Object args, key, val; | |
671 | void *data; | |
672 | { | |
673 | /* We should maybe try to detect bindings shadowed by previous | |
674 | ones and things like that. */ | |
675 | if (EQ (val, Qt)) | |
676 | val = Qnil; | |
677 | (*fun) (key, val, args, data); | |
678 | } | |
679 | ||
680 | static void | |
681 | map_keymap_char_table_item (args, key, val) | |
682 | Lisp_Object args, key, val; | |
683 | { | |
684 | if (!NILP (val)) | |
685 | { | |
686 | map_keymap_function_t fun = XSAVE_VALUE (XCAR (args))->pointer; | |
687 | args = XCDR (args); | |
688 | map_keymap_item (fun, XCDR (args), key, val, | |
689 | XSAVE_VALUE (XCAR (args))->pointer); | |
690 | } | |
691 | } | |
692 | ||
693 | /* Call FUN for every binding in MAP. | |
edf505ce SM |
694 | FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA). |
695 | AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */ | |
9d3153eb SM |
696 | void |
697 | map_keymap (map, fun, args, data, autoload) | |
698 | map_keymap_function_t fun; | |
699 | Lisp_Object map, args; | |
700 | void *data; | |
701 | int autoload; | |
702 | { | |
703 | struct gcpro gcpro1, gcpro2, gcpro3; | |
704 | Lisp_Object tail; | |
705 | ||
d89b5760 | 706 | tail = Qnil; |
9d3153eb SM |
707 | GCPRO3 (map, args, tail); |
708 | map = get_keymap (map, 1, autoload); | |
709 | for (tail = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map; | |
710 | CONSP (tail) || (tail = get_keymap (tail, 0, autoload), CONSP (tail)); | |
711 | tail = XCDR (tail)) | |
712 | { | |
713 | Lisp_Object binding = XCAR (tail); | |
f8d8ba40 | 714 | |
9d3153eb SM |
715 | if (CONSP (binding)) |
716 | map_keymap_item (fun, args, XCAR (binding), XCDR (binding), data); | |
717 | else if (VECTORP (binding)) | |
718 | { | |
719 | /* Loop over the char values represented in the vector. */ | |
720 | int len = ASIZE (binding); | |
721 | int c; | |
9d3153eb SM |
722 | for (c = 0; c < len; c++) |
723 | { | |
724 | Lisp_Object character; | |
725 | XSETFASTINT (character, c); | |
726 | map_keymap_item (fun, args, character, AREF (binding, c), data); | |
727 | } | |
728 | } | |
729 | else if (CHAR_TABLE_P (binding)) | |
730 | { | |
731 | Lisp_Object indices[3]; | |
fe72189a | 732 | map_char_table (map_keymap_char_table_item, Qnil, binding, binding, |
9d3153eb SM |
733 | Fcons (make_save_value (fun, 0), |
734 | Fcons (make_save_value (data, 0), | |
735 | args)), | |
736 | 0, indices); | |
737 | } | |
738 | } | |
739 | UNGCPRO; | |
740 | } | |
741 | ||
742 | static void | |
743 | map_keymap_call (key, val, fun, dummy) | |
744 | Lisp_Object key, val, fun; | |
745 | void *dummy; | |
746 | { | |
747 | call2 (fun, key, val); | |
748 | } | |
749 | ||
0ea6ae0a | 750 | DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 3, 0, |
bb9c8a99 | 751 | doc: /* Call FUNCTION once for each event binding in KEYMAP. |
05f5847b | 752 | FUNCTION is called with two arguments: the event that is bound, and |
b5068589 KH |
753 | the definition it is bound to. If the event is an integer, it may be |
754 | a generic character (see Info node `(elisp)Splitting Characters'), and | |
755 | that means that all actual character events belonging to that generic | |
756 | character are bound to the definition. | |
05f5847b | 757 | |
2c0a0e38 LT |
758 | If KEYMAP has a parent, the parent's bindings are included as well. |
759 | This works recursively: if the parent has itself a parent, then the | |
0ea6ae0a RS |
760 | grandparent's bindings are also included and so on. |
761 | usage: (map-keymap FUNCTION KEYMAP) */) | |
762 | (function, keymap, sort_first) | |
763 | Lisp_Object function, keymap, sort_first; | |
9d3153eb SM |
764 | { |
765 | if (INTEGERP (function)) | |
766 | /* We have to stop integers early since map_keymap gives them special | |
767 | significance. */ | |
fb53f354 | 768 | xsignal1 (Qinvalid_function, function); |
0ea6ae0a RS |
769 | if (! NILP (sort_first)) |
770 | return call3 (intern ("map-keymap-internal"), function, keymap, Qt); | |
d6a31e9f | 771 | |
9d3153eb SM |
772 | map_keymap (keymap, map_keymap_call, function, NULL, 1); |
773 | return Qnil; | |
774 | } | |
775 | ||
2c6f1a39 JB |
776 | /* Given OBJECT which was found in a slot in a keymap, |
777 | trace indirect definitions to get the actual definition of that slot. | |
778 | An indirect definition is a list of the form | |
779 | (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one | |
780 | and INDEX is the object to look up in KEYMAP to yield the definition. | |
781 | ||
782 | Also if OBJECT has a menu string as the first element, | |
224a16e8 RS |
783 | remove that. Also remove a menu help string as second element. |
784 | ||
785 | If AUTOLOAD is nonzero, load autoloadable keymaps | |
18e2d91f RS |
786 | that are referred to with indirection. |
787 | ||
788 | This can GC because menu_item_eval_property calls Feval. */ | |
2c6f1a39 JB |
789 | |
790 | Lisp_Object | |
224a16e8 | 791 | get_keyelt (object, autoload) |
31bea176 | 792 | Lisp_Object object; |
224a16e8 | 793 | int autoload; |
2c6f1a39 JB |
794 | { |
795 | while (1) | |
796 | { | |
b1314e15 KH |
797 | if (!(CONSP (object))) |
798 | /* This is really the value. */ | |
799 | return object; | |
2c6f1a39 | 800 | |
b1314e15 KH |
801 | /* If the keymap contents looks like (keymap ...) or (lambda ...) |
802 | then use itself. */ | |
803 | else if (EQ (XCAR (object), Qkeymap) || EQ (XCAR (object), Qlambda)) | |
804 | return object; | |
805 | ||
806 | /* If the keymap contents looks like (menu-item name . DEFN) | |
807 | or (menu-item name DEFN ...) then use DEFN. | |
3fc720e4 | 808 | This is a new format menu item. */ |
b1314e15 | 809 | else if (EQ (XCAR (object), Qmenu_item)) |
0403641f | 810 | { |
b1314e15 | 811 | if (CONSP (XCDR (object))) |
0403641f | 812 | { |
3fc720e4 GM |
813 | Lisp_Object tem; |
814 | ||
b1314e15 | 815 | object = XCDR (XCDR (object)); |
3fc720e4 | 816 | tem = object; |
b1314e15 KH |
817 | if (CONSP (object)) |
818 | object = XCAR (object); | |
3fc720e4 GM |
819 | |
820 | /* If there's a `:filter FILTER', apply FILTER to the | |
821 | menu-item's definition to get the real definition to | |
d5b3eb1b | 822 | use. */ |
3fc720e4 | 823 | for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem)) |
d5b3eb1b | 824 | if (EQ (XCAR (tem), QCfilter) && autoload) |
3fc720e4 GM |
825 | { |
826 | Lisp_Object filter; | |
827 | filter = XCAR (XCDR (tem)); | |
828 | filter = list2 (filter, list2 (Qquote, object)); | |
829 | object = menu_item_eval_property (filter); | |
830 | break; | |
831 | } | |
0403641f RS |
832 | } |
833 | else | |
31bea176 | 834 | /* Invalid keymap. */ |
b1314e15 | 835 | return object; |
0403641f RS |
836 | } |
837 | ||
b1314e15 | 838 | /* If the keymap contents looks like (STRING . DEFN), use DEFN. |
2c6f1a39 JB |
839 | Keymap alist elements like (CHAR MENUSTRING . DEFN) |
840 | will be used by HierarKey menus. */ | |
b1314e15 | 841 | else if (STRINGP (XCAR (object))) |
1a8c3f10 | 842 | { |
b1314e15 | 843 | object = XCDR (object); |
1a8c3f10 RS |
844 | /* Also remove a menu help string, if any, |
845 | following the menu item name. */ | |
b1314e15 KH |
846 | if (CONSP (object) && STRINGP (XCAR (object))) |
847 | object = XCDR (object); | |
c6ec9f6e | 848 | /* Also remove the sublist that caches key equivalences, if any. */ |
b1314e15 | 849 | if (CONSP (object) && CONSP (XCAR (object))) |
ffab2bd6 | 850 | { |
c6ec9f6e | 851 | Lisp_Object carcar; |
b1314e15 | 852 | carcar = XCAR (XCAR (object)); |
c6ec9f6e | 853 | if (NILP (carcar) || VECTORP (carcar)) |
b1314e15 | 854 | object = XCDR (object); |
ffab2bd6 | 855 | } |
1a8c3f10 | 856 | } |
2c6f1a39 | 857 | |
b1314e15 KH |
858 | /* If the contents are (KEYMAP . ELEMENT), go indirect. */ |
859 | else | |
a3fc8840 | 860 | { |
31bea176 | 861 | struct gcpro gcpro1; |
df75b1a3 | 862 | Lisp_Object map; |
31bea176 | 863 | GCPRO1 (object); |
02067692 | 864 | map = get_keymap (Fcar_safe (object), 0, autoload); |
31bea176 | 865 | UNGCPRO; |
02067692 | 866 | return (!CONSP (map) ? object /* Invalid keymap */ |
db785038 | 867 | : access_keymap (map, Fcdr (object), 0, 0, autoload)); |
a3fc8840 | 868 | } |
2c6f1a39 JB |
869 | } |
870 | } | |
871 | ||
2d929694 | 872 | static Lisp_Object |
2c6f1a39 JB |
873 | store_in_keymap (keymap, idx, def) |
874 | Lisp_Object keymap; | |
875 | register Lisp_Object idx; | |
e89e07cc | 876 | Lisp_Object def; |
2c6f1a39 | 877 | { |
1e7d1ab0 SM |
878 | /* Flush any reverse-map cache. */ |
879 | where_is_cache = Qnil; | |
880 | where_is_cache_keymaps = Qt; | |
881 | ||
dce4372a | 882 | /* If we are preparing to dump, and DEF is a menu element |
a3fc8840 RS |
883 | with a menu item indicator, copy it to ensure it is not pure. */ |
884 | if (CONSP (def) && PURE_P (def) | |
03699b14 KR |
885 | && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def)))) |
886 | def = Fcons (XCAR (def), XCDR (def)); | |
32ce36ad | 887 | |
54cbc3d4 | 888 | if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap)) |
f5b79c1c JB |
889 | error ("attempt to define a key in a non-keymap"); |
890 | ||
2c6f1a39 JB |
891 | /* If idx is a list (some sort of mouse click, perhaps?), |
892 | the index we want to use is the car of the list, which | |
893 | ought to be a symbol. */ | |
cebd887d | 894 | idx = EVENT_HEAD (idx); |
2c6f1a39 | 895 | |
f5b79c1c JB |
896 | /* If idx is a symbol, it might have modifiers, which need to |
897 | be put in the canonical order. */ | |
416349ec | 898 | if (SYMBOLP (idx)) |
f5b79c1c | 899 | idx = reorder_modifiers (idx); |
2732bdbb RS |
900 | else if (INTEGERP (idx)) |
901 | /* Clobber the high bits that can be present on a machine | |
902 | with more than 24 bits of integer. */ | |
6e344130 | 903 | XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1))); |
f5b79c1c JB |
904 | |
905 | /* Scan the keymap for a binding of idx. */ | |
2c6f1a39 | 906 | { |
f5b79c1c | 907 | Lisp_Object tail; |
2c6f1a39 | 908 | |
f5b79c1c JB |
909 | /* The cons after which we should insert new bindings. If the |
910 | keymap has a table element, we record its position here, so new | |
911 | bindings will go after it; this way, the table will stay | |
912 | towards the front of the alist and character lookups in dense | |
913 | keymaps will remain fast. Otherwise, this just points at the | |
914 | front of the keymap. */ | |
e9b6dfb0 | 915 | Lisp_Object insertion_point; |
2c6f1a39 | 916 | |
e9b6dfb0 | 917 | insertion_point = keymap; |
03699b14 | 918 | for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail)) |
2c6f1a39 | 919 | { |
e9b6dfb0 | 920 | Lisp_Object elt; |
f5b79c1c | 921 | |
03699b14 | 922 | elt = XCAR (tail); |
783a2838 | 923 | if (VECTORP (elt)) |
f5b79c1c | 924 | { |
49801145 | 925 | if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt)) |
f5b79c1c | 926 | { |
49daa5b1 | 927 | CHECK_IMPURE (elt); |
49801145 | 928 | ASET (elt, XFASTINT (idx), def); |
f5b79c1c JB |
929 | return def; |
930 | } | |
931 | insertion_point = tail; | |
783a2838 | 932 | } |
0403641f RS |
933 | else if (CHAR_TABLE_P (elt)) |
934 | { | |
6418ea16 RS |
935 | /* Character codes with modifiers |
936 | are not included in a char-table. | |
937 | All character codes without modifiers are included. */ | |
4dc3eb25 | 938 | if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK)) |
0403641f | 939 | { |
4dc3eb25 SM |
940 | Faset (elt, idx, |
941 | /* `nil' has a special meaning for char-tables, so | |
942 | we use something else to record an explicitly | |
943 | unbound entry. */ | |
944 | NILP (def) ? Qt : def); | |
0403641f RS |
945 | return def; |
946 | } | |
947 | insertion_point = tail; | |
948 | } | |
783a2838 KH |
949 | else if (CONSP (elt)) |
950 | { | |
03699b14 | 951 | if (EQ (idx, XCAR (elt))) |
f5b79c1c | 952 | { |
49daa5b1 | 953 | CHECK_IMPURE (elt); |
f3fbd155 | 954 | XSETCDR (elt, def); |
f5b79c1c JB |
955 | return def; |
956 | } | |
783a2838 | 957 | } |
49801145 SM |
958 | else if (EQ (elt, Qkeymap)) |
959 | /* If we find a 'keymap' symbol in the spine of KEYMAP, | |
960 | then we must have found the start of a second keymap | |
961 | being used as the tail of KEYMAP, and a binding for IDX | |
962 | should be inserted before it. */ | |
963 | goto keymap_end; | |
0188441d JB |
964 | |
965 | QUIT; | |
2c6f1a39 | 966 | } |
2c6f1a39 | 967 | |
f5b79c1c JB |
968 | keymap_end: |
969 | /* We have scanned the entire keymap, and not found a binding for | |
970 | IDX. Let's add one. */ | |
49daa5b1 | 971 | CHECK_IMPURE (insertion_point); |
f3fbd155 KR |
972 | XSETCDR (insertion_point, |
973 | Fcons (Fcons (idx, def), XCDR (insertion_point))); | |
f5b79c1c | 974 | } |
31bea176 | 975 | |
2c6f1a39 JB |
976 | return def; |
977 | } | |
978 | ||
2b6748c0 SM |
979 | EXFUN (Fcopy_keymap, 1); |
980 | ||
31bea176 SM |
981 | Lisp_Object |
982 | copy_keymap_item (elt) | |
983 | Lisp_Object elt; | |
984 | { | |
985 | Lisp_Object res, tem; | |
986 | ||
987 | if (!CONSP (elt)) | |
988 | return elt; | |
989 | ||
990 | res = tem = elt; | |
991 | ||
992 | /* Is this a new format menu item. */ | |
993 | if (EQ (XCAR (tem), Qmenu_item)) | |
994 | { | |
995 | /* Copy cell with menu-item marker. */ | |
996 | res = elt = Fcons (XCAR (tem), XCDR (tem)); | |
997 | tem = XCDR (elt); | |
998 | if (CONSP (tem)) | |
999 | { | |
1000 | /* Copy cell with menu-item name. */ | |
1001 | XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem))); | |
1002 | elt = XCDR (elt); | |
1003 | tem = XCDR (elt); | |
1004 | } | |
1005 | if (CONSP (tem)) | |
1006 | { | |
1007 | /* Copy cell with binding and if the binding is a keymap, | |
1008 | copy that. */ | |
1009 | XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem))); | |
1010 | elt = XCDR (elt); | |
1011 | tem = XCAR (elt); | |
1012 | if (CONSP (tem) && EQ (XCAR (tem), Qkeymap)) | |
1013 | XSETCAR (elt, Fcopy_keymap (tem)); | |
1014 | tem = XCDR (elt); | |
1015 | if (CONSP (tem) && CONSP (XCAR (tem))) | |
1016 | /* Delete cache for key equivalences. */ | |
1017 | XSETCDR (elt, XCDR (tem)); | |
1018 | } | |
1019 | } | |
1020 | else | |
1021 | { | |
1022 | /* It may be an old fomat menu item. | |
1023 | Skip the optional menu string. */ | |
1024 | if (STRINGP (XCAR (tem))) | |
1025 | { | |
1026 | /* Copy the cell, since copy-alist didn't go this deep. */ | |
1027 | res = elt = Fcons (XCAR (tem), XCDR (tem)); | |
1028 | tem = XCDR (elt); | |
1029 | /* Also skip the optional menu help string. */ | |
1030 | if (CONSP (tem) && STRINGP (XCAR (tem))) | |
1031 | { | |
1032 | XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem))); | |
1033 | elt = XCDR (elt); | |
1034 | tem = XCDR (elt); | |
1035 | } | |
1036 | /* There may also be a list that caches key equivalences. | |
1037 | Just delete it for the new keymap. */ | |
1038 | if (CONSP (tem) | |
1039 | && CONSP (XCAR (tem)) | |
1040 | && (NILP (XCAR (XCAR (tem))) | |
1041 | || VECTORP (XCAR (XCAR (tem))))) | |
1042 | { | |
1043 | XSETCDR (elt, XCDR (tem)); | |
1044 | tem = XCDR (tem); | |
1045 | } | |
1046 | if (CONSP (tem) && EQ (XCAR (tem), Qkeymap)) | |
1047 | XSETCDR (elt, Fcopy_keymap (tem)); | |
1048 | } | |
1049 | else if (EQ (XCAR (tem), Qkeymap)) | |
1050 | res = Fcopy_keymap (elt); | |
1051 | } | |
1052 | return res; | |
1053 | } | |
1054 | ||
80951487 | 1055 | static void |
0403641f RS |
1056 | copy_keymap_1 (chartable, idx, elt) |
1057 | Lisp_Object chartable, idx, elt; | |
1058 | { | |
31bea176 | 1059 | Faset (chartable, idx, copy_keymap_item (elt)); |
0403641f | 1060 | } |
f5b79c1c | 1061 | |
2c6f1a39 | 1062 | DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0, |
335c5470 PJ |
1063 | doc: /* Return a copy of the keymap KEYMAP. |
1064 | The copy starts out with the same definitions of KEYMAP, | |
1065 | but changing either the copy or KEYMAP does not affect the other. | |
1066 | Any key definitions that are subkeymaps are recursively copied. | |
1067 | However, a key definition which is a symbol whose definition is a keymap | |
1068 | is not copied. */) | |
1069 | (keymap) | |
2c6f1a39 JB |
1070 | Lisp_Object keymap; |
1071 | { | |
1072 | register Lisp_Object copy, tail; | |
31bea176 SM |
1073 | keymap = get_keymap (keymap, 1, 0); |
1074 | copy = tail = Fcons (Qkeymap, Qnil); | |
1075 | keymap = XCDR (keymap); /* Skip the `keymap' symbol. */ | |
2c6f1a39 | 1076 | |
31bea176 | 1077 | while (CONSP (keymap) && !EQ (XCAR (keymap), Qkeymap)) |
2c6f1a39 | 1078 | { |
31bea176 | 1079 | Lisp_Object elt = XCAR (keymap); |
0403641f RS |
1080 | if (CHAR_TABLE_P (elt)) |
1081 | { | |
23cf1efa | 1082 | Lisp_Object indices[3]; |
0403641f | 1083 | elt = Fcopy_sequence (elt); |
fe72189a | 1084 | map_char_table (copy_keymap_1, Qnil, elt, elt, elt, 0, indices); |
0403641f RS |
1085 | } |
1086 | else if (VECTORP (elt)) | |
2c6f1a39 | 1087 | { |
f5b79c1c | 1088 | int i; |
f5b79c1c | 1089 | elt = Fcopy_sequence (elt); |
49801145 | 1090 | for (i = 0; i < ASIZE (elt); i++) |
31bea176 | 1091 | ASET (elt, i, copy_keymap_item (AREF (elt, i))); |
d65a13c5 | 1092 | } |
31bea176 SM |
1093 | else if (CONSP (elt)) |
1094 | elt = Fcons (XCAR (elt), copy_keymap_item (XCDR (elt))); | |
1095 | XSETCDR (tail, Fcons (elt, Qnil)); | |
1096 | tail = XCDR (tail); | |
1097 | keymap = XCDR (keymap); | |
2c6f1a39 | 1098 | } |
31bea176 | 1099 | XSETCDR (tail, keymap); |
2c6f1a39 JB |
1100 | return copy; |
1101 | } | |
1102 | \f | |
cc0a8174 JB |
1103 | /* Simple Keymap mutators and accessors. */ |
1104 | ||
21a0d7a0 RS |
1105 | /* GC is possible in this function if it autoloads a keymap. */ |
1106 | ||
2c6f1a39 | 1107 | DEFUN ("define-key", Fdefine_key, Sdefine_key, 3, 3, 0, |
2d772f45 | 1108 | doc: /* In KEYMAP, define key sequence KEY as DEF. |
0c412762 KS |
1109 | KEYMAP is a keymap. |
1110 | ||
1111 | KEY is a string or a vector of symbols and characters meaning a | |
1112 | sequence of keystrokes and events. Non-ASCII characters with codes | |
1113 | above 127 (such as ISO Latin-1) can be included if you use a vector. | |
bbc4541d | 1114 | Using [t] for KEY creates a default definition, which applies to any |
64239341 | 1115 | event type that has no other definition in this keymap. |
0c412762 | 1116 | |
335c5470 PJ |
1117 | DEF is anything that can be a key's definition: |
1118 | nil (means key is undefined in this keymap), | |
f63fd14e | 1119 | a command (a Lisp function suitable for interactive calling), |
335c5470 PJ |
1120 | a string (treated as a keyboard macro), |
1121 | a keymap (to define a prefix key), | |
f63fd14e | 1122 | a symbol (when the key is looked up, the symbol will stand for its |
335c5470 | 1123 | function definition, which should at that time be one of the above, |
f63fd14e | 1124 | or another symbol whose function definition is used, etc.), |
335c5470 PJ |
1125 | a cons (STRING . DEFN), meaning that DEFN is the definition |
1126 | (DEFN should be a valid definition in its own right), | |
b23916e7 RS |
1127 | or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP, |
1128 | or an extended menu item definition. (See info node `Extended Menu Items'.) | |
335c5470 | 1129 | |
3abeca61 KG |
1130 | If KEYMAP is a sparse keymap with a binding for KEY, the existing |
1131 | binding is altered. If there is no binding for KEY, the new pair | |
1132 | binding KEY to DEF is added at the front of KEYMAP. */) | |
335c5470 | 1133 | (keymap, key, def) |
d09b2024 | 1134 | Lisp_Object keymap; |
2c6f1a39 JB |
1135 | Lisp_Object key; |
1136 | Lisp_Object def; | |
1137 | { | |
1138 | register int idx; | |
1139 | register Lisp_Object c; | |
2c6f1a39 JB |
1140 | register Lisp_Object cmd; |
1141 | int metized = 0; | |
6ba6e250 | 1142 | int meta_bit; |
2c6f1a39 | 1143 | int length; |
d09b2024 | 1144 | struct gcpro gcpro1, gcpro2, gcpro3; |
2c6f1a39 | 1145 | |
31bea176 | 1146 | GCPRO3 (keymap, key, def); |
02067692 | 1147 | keymap = get_keymap (keymap, 1, 1); |
2c6f1a39 | 1148 | |
ce5a29a1 | 1149 | CHECK_VECTOR_OR_STRING (key); |
2c6f1a39 | 1150 | |
d09b2024 | 1151 | length = XFASTINT (Flength (key)); |
2c6f1a39 | 1152 | if (length == 0) |
31bea176 | 1153 | RETURN_UNGCPRO (Qnil); |
a1df473f | 1154 | |
107fd03d RS |
1155 | if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt)) |
1156 | Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands); | |
1157 | ||
31bea176 | 1158 | meta_bit = VECTORP (key) ? meta_modifier : 0x80; |
6ba6e250 | 1159 | |
7ae8428d | 1160 | if (VECTORP (def) && ASIZE (def) > 0 && CONSP (AREF (def, 0))) |
2db8f173 SM |
1161 | { /* DEF is apparently an XEmacs-style keyboard macro. */ |
1162 | Lisp_Object tmp = Fmake_vector (make_number (ASIZE (def)), Qnil); | |
1163 | int i = ASIZE (def); | |
1164 | while (--i >= 0) | |
1165 | { | |
1166 | Lisp_Object c = AREF (def, i); | |
1167 | if (CONSP (c) && lucid_event_type_list_p (c)) | |
1168 | c = Fevent_convert_list (c); | |
1169 | ASET (tmp, i, c); | |
1170 | } | |
1171 | def = tmp; | |
1172 | } | |
1173 | ||
2c6f1a39 JB |
1174 | idx = 0; |
1175 | while (1) | |
1176 | { | |
1177 | c = Faref (key, make_number (idx)); | |
1178 | ||
f09bc924 | 1179 | if (CONSP (c) && lucid_event_type_list_p (c)) |
41015a19 | 1180 | c = Fevent_convert_list (c); |
f09bc924 | 1181 | |
15fff01d RS |
1182 | if (SYMBOLP (c)) |
1183 | silly_event_symbol_error (c); | |
2fae9111 | 1184 | |
416349ec | 1185 | if (INTEGERP (c) |
6ba6e250 | 1186 | && (XINT (c) & meta_bit) |
2c6f1a39 JB |
1187 | && !metized) |
1188 | { | |
1189 | c = meta_prefix_char; | |
1190 | metized = 1; | |
1191 | } | |
1192 | else | |
1193 | { | |
416349ec | 1194 | if (INTEGERP (c)) |
0b8fc2d4 | 1195 | XSETINT (c, XINT (c) & ~meta_bit); |
2c6f1a39 JB |
1196 | |
1197 | metized = 0; | |
1198 | idx++; | |
1199 | } | |
1200 | ||
54cbc3d4 | 1201 | if (!INTEGERP (c) && !SYMBOLP (c) && !CONSP (c)) |
2fae9111 | 1202 | error ("Key sequence contains invalid event"); |
5907b863 | 1203 | |
2c6f1a39 | 1204 | if (idx == length) |
d09b2024 | 1205 | RETURN_UNGCPRO (store_in_keymap (keymap, c, def)); |
2c6f1a39 | 1206 | |
db785038 | 1207 | cmd = access_keymap (keymap, c, 0, 1, 1); |
2c6f1a39 | 1208 | |
c07aec97 | 1209 | /* If this key is undefined, make it a prefix. */ |
265a9e55 | 1210 | if (NILP (cmd)) |
c07aec97 | 1211 | cmd = define_as_prefix (keymap, c); |
2c6f1a39 | 1212 | |
02067692 SM |
1213 | keymap = get_keymap (cmd, 0, 1); |
1214 | if (!CONSP (keymap)) | |
e9b6dfb0 KH |
1215 | /* We must use Fkey_description rather than just passing key to |
1216 | error; key might be a vector, not a string. */ | |
9abc5f45 RS |
1217 | error ("Key sequence %s starts with non-prefix key %s", |
1218 | SDATA (Fkey_description (key, Qnil)), | |
1219 | SDATA (Fkey_description (Fsubstring (key, make_number (0), | |
1220 | make_number (idx)), | |
1221 | Qnil))); | |
2c6f1a39 JB |
1222 | } |
1223 | } | |
1224 | ||
a1df473f KS |
1225 | /* This function may GC (it calls Fkey_binding). */ |
1226 | ||
b74e16a3 | 1227 | DEFUN ("command-remapping", Fcommand_remapping, Scommand_remapping, 1, 2, 0, |
a1df473f | 1228 | doc: /* Return the remapping for command COMMAND in current keymaps. |
b74e16a3 DK |
1229 | Returns nil if COMMAND is not remapped (or not a symbol). |
1230 | ||
1231 | If the optional argument POSITION is non-nil, it specifies a mouse | |
1232 | position as returned by `event-start' and `event-end', and the | |
1233 | remapping occurs in the keymaps associated with it. It can also be a | |
1234 | number or marker, in which case the keymap properties at the specified | |
1235 | buffer position instead of point are used. */) | |
1236 | (command, position) | |
1237 | Lisp_Object command, position; | |
a1df473f | 1238 | { |
078d0f38 KS |
1239 | if (!SYMBOLP (command)) |
1240 | return Qnil; | |
1241 | ||
023b93f6 | 1242 | ASET (command_remapping_vector, 1, command); |
b74e16a3 | 1243 | return Fkey_binding (command_remapping_vector, Qnil, Qt, position); |
a1df473f KS |
1244 | } |
1245 | ||
f0529b5b | 1246 | /* Value is number if KEY is too long; nil if valid but has no definition. */ |
21a0d7a0 | 1247 | /* GC is possible in this function if it autoloads a keymap. */ |
2c6f1a39 | 1248 | |
7c140252 | 1249 | DEFUN ("lookup-key", Flookup_key, Slookup_key, 2, 3, 0, |
335c5470 | 1250 | doc: /* In keymap KEYMAP, look up key sequence KEY. Return the definition. |
64b2caa5 JB |
1251 | A value of nil means undefined. See doc of `define-key' |
1252 | for kinds of definitions. | |
335c5470 PJ |
1253 | |
1254 | A number as value means KEY is "too long"; | |
1255 | that is, characters or symbols in it except for the last one | |
1256 | fail to be a valid sequence of prefix characters in KEYMAP. | |
1257 | The number is how many characters at the front of KEY | |
49daa5b1 | 1258 | it takes to reach a non-prefix key. |
335c5470 PJ |
1259 | |
1260 | Normally, `lookup-key' ignores bindings for t, which act as default | |
1261 | bindings, used when nothing else in the keymap applies; this makes it | |
1262 | usable as a general function for probing keymaps. However, if the | |
1263 | third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will | |
1264 | recognize the default bindings, just as `read-key-sequence' does. */) | |
1265 | (keymap, key, accept_default) | |
31bea176 | 1266 | Lisp_Object keymap; |
2c6f1a39 | 1267 | Lisp_Object key; |
7c140252 | 1268 | Lisp_Object accept_default; |
2c6f1a39 JB |
1269 | { |
1270 | register int idx; | |
2c6f1a39 JB |
1271 | register Lisp_Object cmd; |
1272 | register Lisp_Object c; | |
2c6f1a39 | 1273 | int length; |
54cbc3d4 | 1274 | int t_ok = !NILP (accept_default); |
31bea176 | 1275 | struct gcpro gcpro1, gcpro2; |
2c6f1a39 | 1276 | |
31bea176 | 1277 | GCPRO2 (keymap, key); |
02067692 | 1278 | keymap = get_keymap (keymap, 1, 1); |
2c6f1a39 | 1279 | |
ce5a29a1 | 1280 | CHECK_VECTOR_OR_STRING (key); |
2c6f1a39 | 1281 | |
d09b2024 | 1282 | length = XFASTINT (Flength (key)); |
2c6f1a39 | 1283 | if (length == 0) |
31bea176 | 1284 | RETURN_UNGCPRO (keymap); |
21a0d7a0 | 1285 | |
2c6f1a39 JB |
1286 | idx = 0; |
1287 | while (1) | |
1288 | { | |
db785038 | 1289 | c = Faref (key, make_number (idx++)); |
2c6f1a39 | 1290 | |
f09bc924 | 1291 | if (CONSP (c) && lucid_event_type_list_p (c)) |
41015a19 | 1292 | c = Fevent_convert_list (c); |
f09bc924 | 1293 | |
db785038 | 1294 | /* Turn the 8th bit of string chars into a meta modifier. */ |
38cbfed4 | 1295 | if (INTEGERP (c) && XINT (c) & 0x80 && STRINGP (key)) |
db785038 | 1296 | XSETINT (c, (XINT (c) | meta_modifier) & ~0x80); |
2c6f1a39 | 1297 | |
5f245371 KS |
1298 | /* Allow string since binding for `menu-bar-select-buffer' |
1299 | includes the buffer name in the key sequence. */ | |
1300 | if (!INTEGERP (c) && !SYMBOLP (c) && !CONSP (c) && !STRINGP (c)) | |
2fae9111 RS |
1301 | error ("Key sequence contains invalid event"); |
1302 | ||
db785038 | 1303 | cmd = access_keymap (keymap, c, t_ok, 0, 1); |
2c6f1a39 | 1304 | if (idx == length) |
21a0d7a0 | 1305 | RETURN_UNGCPRO (cmd); |
2c6f1a39 | 1306 | |
02067692 SM |
1307 | keymap = get_keymap (cmd, 0, 1); |
1308 | if (!CONSP (keymap)) | |
21a0d7a0 | 1309 | RETURN_UNGCPRO (make_number (idx)); |
2c6f1a39 | 1310 | |
2c6f1a39 JB |
1311 | QUIT; |
1312 | } | |
1313 | } | |
1314 | ||
c07aec97 RS |
1315 | /* Make KEYMAP define event C as a keymap (i.e., as a prefix). |
1316 | Assume that currently it does not define C at all. | |
1317 | Return the keymap. */ | |
1318 | ||
1319 | static Lisp_Object | |
1320 | define_as_prefix (keymap, c) | |
1321 | Lisp_Object keymap, c; | |
1322 | { | |
db785038 | 1323 | Lisp_Object cmd; |
c07aec97 RS |
1324 | |
1325 | cmd = Fmake_sparse_keymap (Qnil); | |
1326 | /* If this key is defined as a prefix in an inherited keymap, | |
1327 | make it a prefix in this map, and make its definition | |
1328 | inherit the other prefix definition. */ | |
db785038 | 1329 | cmd = nconc2 (cmd, access_keymap (keymap, c, 0, 0, 0)); |
c07aec97 RS |
1330 | store_in_keymap (keymap, c, cmd); |
1331 | ||
1332 | return cmd; | |
1333 | } | |
1334 | ||
0b8fc2d4 RS |
1335 | /* Append a key to the end of a key sequence. We always make a vector. */ |
1336 | ||
2c6f1a39 JB |
1337 | Lisp_Object |
1338 | append_key (key_sequence, key) | |
1339 | Lisp_Object key_sequence, key; | |
1340 | { | |
1341 | Lisp_Object args[2]; | |
1342 | ||
1343 | args[0] = key_sequence; | |
1344 | ||
0b8fc2d4 RS |
1345 | args[1] = Fcons (key, Qnil); |
1346 | return Fvconcat (2, args); | |
2c6f1a39 JB |
1347 | } |
1348 | ||
15fff01d RS |
1349 | /* Given a event type C which is a symbol, |
1350 | signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */ | |
1351 | ||
1352 | static void | |
1353 | silly_event_symbol_error (c) | |
1354 | Lisp_Object c; | |
1355 | { | |
1356 | Lisp_Object parsed, base, name, assoc; | |
1357 | int modifiers; | |
744cd66b | 1358 | |
15fff01d RS |
1359 | parsed = parse_modifiers (c); |
1360 | modifiers = (int) XUINT (XCAR (XCDR (parsed))); | |
1361 | base = XCAR (parsed); | |
1362 | name = Fsymbol_name (base); | |
1363 | /* This alist includes elements such as ("RET" . "\\r"). */ | |
1364 | assoc = Fassoc (name, exclude_keys); | |
1365 | ||
1366 | if (! NILP (assoc)) | |
1367 | { | |
1368 | char new_mods[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")]; | |
1369 | char *p = new_mods; | |
1370 | Lisp_Object keystring; | |
1371 | if (modifiers & alt_modifier) | |
1372 | { *p++ = '\\'; *p++ = 'A'; *p++ = '-'; } | |
1373 | if (modifiers & ctrl_modifier) | |
1374 | { *p++ = '\\'; *p++ = 'C'; *p++ = '-'; } | |
1375 | if (modifiers & hyper_modifier) | |
1376 | { *p++ = '\\'; *p++ = 'H'; *p++ = '-'; } | |
1377 | if (modifiers & meta_modifier) | |
1378 | { *p++ = '\\'; *p++ = 'M'; *p++ = '-'; } | |
1379 | if (modifiers & shift_modifier) | |
1380 | { *p++ = '\\'; *p++ = 'S'; *p++ = '-'; } | |
1381 | if (modifiers & super_modifier) | |
1382 | { *p++ = '\\'; *p++ = 's'; *p++ = '-'; } | |
1383 | *p = 0; | |
1384 | ||
1385 | c = reorder_modifiers (c); | |
1386 | keystring = concat2 (build_string (new_mods), XCDR (assoc)); | |
744cd66b | 1387 | |
15fff01d RS |
1388 | error ((modifiers & ~meta_modifier |
1389 | ? "To bind the key %s, use [?%s], not [%s]" | |
1390 | : "To bind the key %s, use \"%s\", not [%s]"), | |
d5db4077 KR |
1391 | SDATA (SYMBOL_NAME (c)), SDATA (keystring), |
1392 | SDATA (SYMBOL_NAME (c))); | |
15fff01d RS |
1393 | } |
1394 | } | |
2c6f1a39 | 1395 | \f |
cc0a8174 JB |
1396 | /* Global, local, and minor mode keymap stuff. */ |
1397 | ||
265a9e55 | 1398 | /* We can't put these variables inside current_minor_maps, since under |
6bbbd9b0 JB |
1399 | some systems, static gets macro-defined to be the empty string. |
1400 | Ickypoo. */ | |
cd6db61a KS |
1401 | static Lisp_Object *cmm_modes = NULL, *cmm_maps = NULL; |
1402 | static int cmm_size = 0; | |
265a9e55 | 1403 | |
cc0a8174 JB |
1404 | /* Store a pointer to an array of the keymaps of the currently active |
1405 | minor modes in *buf, and return the number of maps it contains. | |
1406 | ||
1407 | This function always returns a pointer to the same buffer, and may | |
1408 | free or reallocate it, so if you want to keep it for a long time or | |
1409 | hand it out to lisp code, copy it. This procedure will be called | |
1410 | for every key sequence read, so the nice lispy approach (return a | |
1411 | new assoclist, list, what have you) for each invocation would | |
1412 | result in a lot of consing over time. | |
1413 | ||
1414 | If we used xrealloc/xmalloc and ran out of memory, they would throw | |
1415 | back to the command loop, which would try to read a key sequence, | |
1416 | which would call this function again, resulting in an infinite | |
1417 | loop. Instead, we'll use realloc/malloc and silently truncate the | |
1418 | list, let the key sequence be read, and hope some other piece of | |
1419 | code signals the error. */ | |
1420 | int | |
1421 | current_minor_maps (modeptr, mapptr) | |
1422 | Lisp_Object **modeptr, **mapptr; | |
1423 | { | |
cc0a8174 | 1424 | int i = 0; |
dd9cda06 | 1425 | int list_number = 0; |
6bbbd9b0 | 1426 | Lisp_Object alist, assoc, var, val; |
99cbcaca | 1427 | Lisp_Object emulation_alists; |
dd9cda06 RS |
1428 | Lisp_Object lists[2]; |
1429 | ||
99cbcaca | 1430 | emulation_alists = Vemulation_mode_map_alists; |
dd9cda06 RS |
1431 | lists[0] = Vminor_mode_overriding_map_alist; |
1432 | lists[1] = Vminor_mode_map_alist; | |
1433 | ||
1434 | for (list_number = 0; list_number < 2; list_number++) | |
99cbcaca KS |
1435 | { |
1436 | if (CONSP (emulation_alists)) | |
dd9cda06 | 1437 | { |
99cbcaca KS |
1438 | alist = XCAR (emulation_alists); |
1439 | emulation_alists = XCDR (emulation_alists); | |
1440 | if (SYMBOLP (alist)) | |
1441 | alist = find_symbol_value (alist); | |
1442 | list_number = -1; | |
1443 | } | |
1444 | else | |
1445 | alist = lists[list_number]; | |
cc0a8174 | 1446 | |
99cbcaca KS |
1447 | for ( ; CONSP (alist); alist = XCDR (alist)) |
1448 | if ((assoc = XCAR (alist), CONSP (assoc)) | |
1449 | && (var = XCAR (assoc), SYMBOLP (var)) | |
1450 | && (val = find_symbol_value (var), !EQ (val, Qunbound)) | |
1451 | && !NILP (val)) | |
1452 | { | |
1453 | Lisp_Object temp; | |
64dd3629 | 1454 | |
99cbcaca KS |
1455 | /* If a variable has an entry in Vminor_mode_overriding_map_alist, |
1456 | and also an entry in Vminor_mode_map_alist, | |
1457 | ignore the latter. */ | |
1458 | if (list_number == 1) | |
1459 | { | |
1460 | val = assq_no_quit (var, lists[0]); | |
1461 | if (!NILP (val)) | |
1462 | continue; | |
1463 | } | |
cc0a8174 | 1464 | |
99cbcaca KS |
1465 | if (i >= cmm_size) |
1466 | { | |
cd6db61a | 1467 | int newsize, allocsize; |
99cbcaca | 1468 | Lisp_Object *newmodes, *newmaps; |
cc0a8174 | 1469 | |
cd6db61a KS |
1470 | newsize = cmm_size == 0 ? 30 : cmm_size * 2; |
1471 | allocsize = newsize * sizeof *newmodes; | |
1472 | ||
744cd66b | 1473 | /* Use malloc here. See the comment above this function. |
cd6db61a KS |
1474 | Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */ |
1475 | BLOCK_INPUT; | |
1476 | newmodes = (Lisp_Object *) malloc (allocsize); | |
1477 | if (newmodes) | |
99cbcaca | 1478 | { |
cd6db61a KS |
1479 | if (cmm_modes) |
1480 | { | |
1481 | bcopy (cmm_modes, newmodes, cmm_size * sizeof cmm_modes[0]); | |
1482 | free (cmm_modes); | |
1483 | } | |
1484 | cmm_modes = newmodes; | |
99cbcaca KS |
1485 | } |
1486 | ||
cd6db61a | 1487 | newmaps = (Lisp_Object *) malloc (allocsize); |
99cbcaca | 1488 | if (newmaps) |
cd6db61a KS |
1489 | { |
1490 | if (cmm_maps) | |
1491 | { | |
1492 | bcopy (cmm_maps, newmaps, cmm_size * sizeof cmm_maps[0]); | |
1493 | free (cmm_maps); | |
1494 | } | |
1495 | cmm_maps = newmaps; | |
1496 | } | |
1497 | UNBLOCK_INPUT; | |
744cd66b | 1498 | |
99cbcaca KS |
1499 | if (newmodes == NULL || newmaps == NULL) |
1500 | break; | |
cd6db61a | 1501 | cmm_size = newsize; |
99cbcaca | 1502 | } |
fbb90829 | 1503 | |
99cbcaca | 1504 | /* Get the keymap definition--or nil if it is not defined. */ |
a7f96a35 | 1505 | temp = Findirect_function (XCDR (assoc), Qt); |
99cbcaca KS |
1506 | if (!NILP (temp)) |
1507 | { | |
1508 | cmm_modes[i] = var; | |
1509 | cmm_maps [i] = temp; | |
1510 | i++; | |
1511 | } | |
1512 | } | |
1513 | } | |
cc0a8174 | 1514 | |
265a9e55 JB |
1515 | if (modeptr) *modeptr = cmm_modes; |
1516 | if (mapptr) *mapptr = cmm_maps; | |
cc0a8174 JB |
1517 | return i; |
1518 | } | |
1519 | ||
54cbc3d4 | 1520 | DEFUN ("current-active-maps", Fcurrent_active_maps, Scurrent_active_maps, |
335c5470 PJ |
1521 | 0, 1, 0, |
1522 | doc: /* Return a list of the currently active keymaps. | |
1523 | OLP if non-nil indicates that we should obey `overriding-local-map' and | |
1524 | `overriding-terminal-local-map'. */) | |
54cbc3d4 SM |
1525 | (olp) |
1526 | Lisp_Object olp; | |
1527 | { | |
1528 | Lisp_Object keymaps = Fcons (current_global_map, Qnil); | |
1529 | ||
1530 | if (!NILP (olp)) | |
1531 | { | |
54cbc3d4 SM |
1532 | if (!NILP (current_kboard->Voverriding_terminal_local_map)) |
1533 | keymaps = Fcons (current_kboard->Voverriding_terminal_local_map, keymaps); | |
d64cdc59 RS |
1534 | /* The doc said that overriding-terminal-local-map should |
1535 | override overriding-local-map. The code used them both, | |
1536 | but it seems clearer to use just one. rms, jan 2005. */ | |
1537 | else if (!NILP (Voverriding_local_map)) | |
1538 | keymaps = Fcons (Voverriding_local_map, keymaps); | |
54cbc3d4 SM |
1539 | } |
1540 | if (NILP (XCDR (keymaps))) | |
1541 | { | |
1542 | Lisp_Object local; | |
1543 | Lisp_Object *maps; | |
1544 | int nmaps, i; | |
1545 | ||
d64cdc59 RS |
1546 | /* This usually returns the buffer's local map, |
1547 | but that can be overridden by a `local-map' property. */ | |
54cbc3d4 SM |
1548 | local = get_local_map (PT, current_buffer, Qlocal_map); |
1549 | if (!NILP (local)) | |
1550 | keymaps = Fcons (local, keymaps); | |
1551 | ||
d64cdc59 | 1552 | /* Now put all the minor mode keymaps on the list. */ |
54cbc3d4 SM |
1553 | nmaps = current_minor_maps (0, &maps); |
1554 | ||
1555 | for (i = --nmaps; i >= 0; i--) | |
1556 | if (!NILP (maps[i])) | |
1557 | keymaps = Fcons (maps[i], keymaps); | |
d1d070e3 | 1558 | |
d64cdc59 | 1559 | /* This returns nil unless there is a `keymap' property. */ |
d1d070e3 RS |
1560 | local = get_local_map (PT, current_buffer, Qkeymap); |
1561 | if (!NILP (local)) | |
1562 | keymaps = Fcons (local, keymaps); | |
54cbc3d4 | 1563 | } |
31bea176 | 1564 | |
54cbc3d4 SM |
1565 | return keymaps; |
1566 | } | |
1567 | ||
21a0d7a0 RS |
1568 | /* GC is possible in this function if it autoloads a keymap. */ |
1569 | ||
b74e16a3 | 1570 | DEFUN ("key-binding", Fkey_binding, Skey_binding, 1, 4, 0, |
335c5470 PJ |
1571 | doc: /* Return the binding for command KEY in current keymaps. |
1572 | KEY is a string or vector, a sequence of keystrokes. | |
1573 | The binding is probably a symbol with a function definition. | |
1574 | ||
1575 | Normally, `key-binding' ignores bindings for t, which act as default | |
1576 | bindings, used when nothing else in the keymap applies; this makes it | |
1577 | usable as a general function for probing keymaps. However, if the | |
1578 | optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does | |
0c412762 KS |
1579 | recognize the default bindings, just as `read-key-sequence' does. |
1580 | ||
1581 | Like the normal command loop, `key-binding' will remap the command | |
1582 | resulting from looking up KEY by looking up the command in the | |
35936c5c | 1583 | current keymaps. However, if the optional third argument NO-REMAP |
b74e16a3 DK |
1584 | is non-nil, `key-binding' returns the unmapped command. |
1585 | ||
1586 | If KEY is a key sequence initiated with the mouse, the used keymaps | |
1587 | will depend on the clicked mouse position with regard to the buffer | |
1588 | and possible local keymaps on strings. | |
1589 | ||
1590 | If the optional argument POSITION is non-nil, it specifies a mouse | |
1591 | position as returned by `event-start' and `event-end', and the lookup | |
1592 | occurs in the keymaps associated with it instead of KEY. It can also | |
1593 | be a number or marker, in which case the keymap properties at the | |
1594 | specified buffer position instead of point are used. | |
1595 | */) | |
1596 | (key, accept_default, no_remap, position) | |
1597 | Lisp_Object key, accept_default, no_remap, position; | |
2c6f1a39 | 1598 | { |
cc0a8174 JB |
1599 | Lisp_Object *maps, value; |
1600 | int nmaps, i; | |
b74e16a3 DK |
1601 | struct gcpro gcpro1, gcpro2; |
1602 | int count = SPECPDL_INDEX (); | |
21a0d7a0 | 1603 | |
b74e16a3 | 1604 | GCPRO2 (key, position); |
cc0a8174 | 1605 | |
08e26e8b | 1606 | if (NILP (position) && VECTORP (key)) |
b067ddb6 | 1607 | { |
08e26e8b SM |
1608 | Lisp_Object event |
1609 | /* mouse events may have a symbolic prefix indicating the | |
1610 | scrollbar or mode line */ | |
1611 | = AREF (key, SYMBOLP (AREF (key, 0)) && ASIZE (key) > 1 ? 1 : 0); | |
91197db4 | 1612 | |
b74e16a3 | 1613 | /* We are not interested in locations without event data */ |
91197db4 | 1614 | |
eae637ec CY |
1615 | if (EVENT_HAS_PARAMETERS (event)) |
1616 | { | |
1617 | Lisp_Object kind = EVENT_HEAD_KIND (EVENT_HEAD (event)); | |
1618 | if (CONSP (XCDR (event)) && EQ (kind, Qmouse_click)) | |
1619 | position = EVENT_START (event); | |
1620 | } | |
b067ddb6 | 1621 | } |
b067ddb6 | 1622 | |
b74e16a3 DK |
1623 | /* Key sequences beginning with mouse clicks |
1624 | are read using the keymaps of the buffer clicked on, not | |
1625 | the current buffer. So we may have to switch the buffer | |
1626 | here. */ | |
64b2caa5 | 1627 | |
b74e16a3 DK |
1628 | if (CONSP (position)) |
1629 | { | |
1630 | Lisp_Object window; | |
64b2caa5 | 1631 | |
b74e16a3 | 1632 | window = POSN_WINDOW (position); |
64b2caa5 | 1633 | |
b74e16a3 DK |
1634 | if (WINDOWP (window) |
1635 | && BUFFERP (XWINDOW (window)->buffer) | |
1636 | && XBUFFER (XWINDOW (window)->buffer) != current_buffer) | |
1637 | { | |
1638 | /* Arrange to go back to the original buffer once we're done | |
1639 | processing the key sequence. We don't use | |
1640 | save_excursion_{save,restore} here, in analogy to | |
1641 | `read-key-sequence' to avoid saving point. Maybe this | |
1642 | would not be a problem here, but it is easier to keep | |
1643 | things the same. | |
1644 | */ | |
64b2caa5 | 1645 | |
b74e16a3 | 1646 | record_unwind_protect (Fset_buffer, Fcurrent_buffer ()); |
64b2caa5 | 1647 | |
b74e16a3 DK |
1648 | set_buffer_internal (XBUFFER (XWINDOW (window)->buffer)); |
1649 | } | |
1650 | } | |
64b2caa5 | 1651 | |
b74e16a3 | 1652 | if (! NILP (current_kboard->Voverriding_terminal_local_map)) |
e784236d KH |
1653 | { |
1654 | value = Flookup_key (current_kboard->Voverriding_terminal_local_map, | |
1655 | key, accept_default); | |
1656 | if (! NILP (value) && !INTEGERP (value)) | |
0c412762 | 1657 | goto done; |
e784236d | 1658 | } |
b74e16a3 | 1659 | else if (! NILP (Voverriding_local_map)) |
2c6f1a39 | 1660 | { |
7d92e329 | 1661 | value = Flookup_key (Voverriding_local_map, key, accept_default); |
416349ec | 1662 | if (! NILP (value) && !INTEGERP (value)) |
0c412762 | 1663 | goto done; |
2c6f1a39 | 1664 | } |
7d92e329 | 1665 | else |
744cd66b | 1666 | { |
b74e16a3 DK |
1667 | Lisp_Object keymap, local_map; |
1668 | EMACS_INT pt; | |
d964248c | 1669 | |
b74e16a3 DK |
1670 | pt = INTEGERP (position) ? XINT (position) |
1671 | : MARKERP (position) ? marker_position (position) | |
1672 | : PT; | |
1673 | ||
64b2caa5 JB |
1674 | local_map = get_local_map (pt, current_buffer, Qlocal_map); |
1675 | keymap = get_local_map (pt, current_buffer, Qkeymap); | |
b74e16a3 DK |
1676 | |
1677 | if (CONSP (position)) | |
1678 | { | |
08e26e8b | 1679 | Lisp_Object string; |
b74e16a3 DK |
1680 | |
1681 | /* For a mouse click, get the local text-property keymap | |
1682 | of the place clicked on, rather than point. */ | |
64b2caa5 | 1683 | |
b74e16a3 DK |
1684 | if (POSN_INBUFFER_P (position)) |
1685 | { | |
1686 | Lisp_Object pos; | |
1687 | ||
1688 | pos = POSN_BUFFER_POSN (position); | |
1689 | if (INTEGERP (pos) | |
1690 | && XINT (pos) >= BEG && XINT (pos) <= Z) | |
1691 | { | |
1692 | local_map = get_local_map (XINT (pos), | |
1693 | current_buffer, Qlocal_map); | |
64b2caa5 | 1694 | |
b74e16a3 DK |
1695 | keymap = get_local_map (XINT (pos), |
1696 | current_buffer, Qkeymap); | |
1697 | } | |
1698 | } | |
1699 | ||
1700 | /* If on a mode line string with a local keymap, | |
1701 | or for a click on a string, i.e. overlay string or a | |
1702 | string displayed via the `display' property, | |
1703 | consider `local-map' and `keymap' properties of | |
1704 | that string. */ | |
64b2caa5 | 1705 | |
b74e16a3 DK |
1706 | if (string = POSN_STRING (position), |
1707 | (CONSP (string) && STRINGP (XCAR (string)))) | |
1708 | { | |
1709 | Lisp_Object pos, map; | |
64b2caa5 | 1710 | |
b74e16a3 DK |
1711 | pos = XCDR (string); |
1712 | string = XCAR (string); | |
eae637ec CY |
1713 | if (INTEGERP (pos) |
1714 | && XINT (pos) >= 0 | |
b74e16a3 DK |
1715 | && XINT (pos) < SCHARS (string)) |
1716 | { | |
1717 | map = Fget_text_property (pos, Qlocal_map, string); | |
1718 | if (!NILP (map)) | |
1719 | local_map = map; | |
1720 | ||
1721 | map = Fget_text_property (pos, Qkeymap, string); | |
1722 | if (!NILP (map)) | |
1723 | keymap = map; | |
1724 | } | |
1725 | } | |
64b2caa5 | 1726 | |
b74e16a3 DK |
1727 | } |
1728 | ||
1729 | if (! NILP (keymap)) | |
d1d070e3 | 1730 | { |
b74e16a3 | 1731 | value = Flookup_key (keymap, key, accept_default); |
d1d070e3 | 1732 | if (! NILP (value) && !INTEGERP (value)) |
0c412762 | 1733 | goto done; |
d1d070e3 RS |
1734 | } |
1735 | ||
7d92e329 | 1736 | nmaps = current_minor_maps (0, &maps); |
21a0d7a0 RS |
1737 | /* Note that all these maps are GCPRO'd |
1738 | in the places where we found them. */ | |
1739 | ||
7d92e329 RS |
1740 | for (i = 0; i < nmaps; i++) |
1741 | if (! NILP (maps[i])) | |
1742 | { | |
1743 | value = Flookup_key (maps[i], key, accept_default); | |
416349ec | 1744 | if (! NILP (value) && !INTEGERP (value)) |
0c412762 | 1745 | goto done; |
7d92e329 RS |
1746 | } |
1747 | ||
b74e16a3 | 1748 | if (! NILP (local_map)) |
7d92e329 | 1749 | { |
b74e16a3 | 1750 | value = Flookup_key (local_map, key, accept_default); |
416349ec | 1751 | if (! NILP (value) && !INTEGERP (value)) |
0c412762 | 1752 | goto done; |
7d92e329 RS |
1753 | } |
1754 | } | |
cc0a8174 | 1755 | |
7c140252 | 1756 | value = Flookup_key (current_global_map, key, accept_default); |
0c412762 KS |
1757 | |
1758 | done: | |
b74e16a3 DK |
1759 | unbind_to (count, Qnil); |
1760 | ||
21a0d7a0 | 1761 | UNGCPRO; |
0c412762 KS |
1762 | if (NILP (value) || INTEGERP (value)) |
1763 | return Qnil; | |
1764 | ||
1765 | /* If the result of the ordinary keymap lookup is an interactive | |
1766 | command, look for a key binding (ie. remapping) for that command. */ | |
744cd66b | 1767 | |
a1df473f | 1768 | if (NILP (no_remap) && SYMBOLP (value)) |
0c412762 KS |
1769 | { |
1770 | Lisp_Object value1; | |
b74e16a3 | 1771 | if (value1 = Fcommand_remapping (value, position), !NILP (value1)) |
0c412762 KS |
1772 | value = value1; |
1773 | } | |
744cd66b | 1774 | |
0c412762 | 1775 | return value; |
2c6f1a39 JB |
1776 | } |
1777 | ||
21a0d7a0 RS |
1778 | /* GC is possible in this function if it autoloads a keymap. */ |
1779 | ||
7c140252 | 1780 | DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 2, 0, |
335c5470 | 1781 | doc: /* Return the binding for command KEYS in current local keymap only. |
7a093e87 | 1782 | KEYS is a string or vector, a sequence of keystrokes. |
335c5470 PJ |
1783 | The binding is probably a symbol with a function definition. |
1784 | ||
1785 | If optional argument ACCEPT-DEFAULT is non-nil, recognize default | |
1786 | bindings; see the description of `lookup-key' for more details about this. */) | |
1787 | (keys, accept_default) | |
7c140252 | 1788 | Lisp_Object keys, accept_default; |
2c6f1a39 JB |
1789 | { |
1790 | register Lisp_Object map; | |
1791 | map = current_buffer->keymap; | |
265a9e55 | 1792 | if (NILP (map)) |
2c6f1a39 | 1793 | return Qnil; |
7c140252 | 1794 | return Flookup_key (map, keys, accept_default); |
2c6f1a39 JB |
1795 | } |
1796 | ||
21a0d7a0 RS |
1797 | /* GC is possible in this function if it autoloads a keymap. */ |
1798 | ||
7c140252 | 1799 | DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 2, 0, |
335c5470 | 1800 | doc: /* Return the binding for command KEYS in current global keymap only. |
7a093e87 | 1801 | KEYS is a string or vector, a sequence of keystrokes. |
335c5470 | 1802 | The binding is probably a symbol with a function definition. |
23715ea6 | 1803 | This function's return values are the same as those of `lookup-key' |
335c5470 PJ |
1804 | \(which see). |
1805 | ||
1806 | If optional argument ACCEPT-DEFAULT is non-nil, recognize default | |
1807 | bindings; see the description of `lookup-key' for more details about this. */) | |
1808 | (keys, accept_default) | |
7c140252 | 1809 | Lisp_Object keys, accept_default; |
2c6f1a39 | 1810 | { |
7c140252 | 1811 | return Flookup_key (current_global_map, keys, accept_default); |
2c6f1a39 JB |
1812 | } |
1813 | ||
21a0d7a0 RS |
1814 | /* GC is possible in this function if it autoloads a keymap. */ |
1815 | ||
7c140252 | 1816 | DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 2, 0, |
335c5470 | 1817 | doc: /* Find the visible minor mode bindings of KEY. |
15fbe81f | 1818 | Return an alist of pairs (MODENAME . BINDING), where MODENAME is |
335c5470 PJ |
1819 | the symbol which names the minor mode binding KEY, and BINDING is |
1820 | KEY's definition in that mode. In particular, if KEY has no | |
1821 | minor-mode bindings, return nil. If the first binding is a | |
1822 | non-prefix, all subsequent bindings will be omitted, since they would | |
1823 | be ignored. Similarly, the list doesn't include non-prefix bindings | |
1824 | that come after prefix bindings. | |
1825 | ||
1826 | If optional argument ACCEPT-DEFAULT is non-nil, recognize default | |
1827 | bindings; see the description of `lookup-key' for more details about this. */) | |
1828 | (key, accept_default) | |
7c140252 | 1829 | Lisp_Object key, accept_default; |
cc0a8174 JB |
1830 | { |
1831 | Lisp_Object *modes, *maps; | |
1832 | int nmaps; | |
1833 | Lisp_Object binding; | |
1834 | int i, j; | |
21a0d7a0 | 1835 | struct gcpro gcpro1, gcpro2; |
cc0a8174 JB |
1836 | |
1837 | nmaps = current_minor_maps (&modes, &maps); | |
21a0d7a0 RS |
1838 | /* Note that all these maps are GCPRO'd |
1839 | in the places where we found them. */ | |
1840 | ||
1841 | binding = Qnil; | |
1842 | GCPRO2 (key, binding); | |
cc0a8174 JB |
1843 | |
1844 | for (i = j = 0; i < nmaps; i++) | |
02067692 SM |
1845 | if (!NILP (maps[i]) |
1846 | && !NILP (binding = Flookup_key (maps[i], key, accept_default)) | |
416349ec | 1847 | && !INTEGERP (binding)) |
cc0a8174 | 1848 | { |
02067692 | 1849 | if (KEYMAPP (binding)) |
cc0a8174 JB |
1850 | maps[j++] = Fcons (modes[i], binding); |
1851 | else if (j == 0) | |
21a0d7a0 | 1852 | RETURN_UNGCPRO (Fcons (Fcons (modes[i], binding), Qnil)); |
cc0a8174 JB |
1853 | } |
1854 | ||
21a0d7a0 | 1855 | UNGCPRO; |
cc0a8174 JB |
1856 | return Flist (j, maps); |
1857 | } | |
1858 | ||
7f8f0e67 | 1859 | DEFUN ("define-prefix-command", Fdefine_prefix_command, Sdefine_prefix_command, 1, 3, 0, |
335c5470 PJ |
1860 | doc: /* Define COMMAND as a prefix command. COMMAND should be a symbol. |
1861 | A new sparse keymap is stored as COMMAND's function definition and its value. | |
1862 | If a second optional argument MAPVAR is given, the map is stored as | |
1863 | its value instead of as COMMAND's value; but COMMAND is still defined | |
1864 | as a function. | |
1865 | The third optional argument NAME, if given, supplies a menu name | |
a523ade4 LT |
1866 | string for the map. This is required to use the keymap as a menu. |
1867 | This function returns COMMAND. */) | |
335c5470 | 1868 | (command, mapvar, name) |
7f8f0e67 | 1869 | Lisp_Object command, mapvar, name; |
2c6f1a39 JB |
1870 | { |
1871 | Lisp_Object map; | |
7f8f0e67 | 1872 | map = Fmake_sparse_keymap (name); |
88539837 | 1873 | Ffset (command, map); |
265a9e55 | 1874 | if (!NILP (mapvar)) |
2c6f1a39 JB |
1875 | Fset (mapvar, map); |
1876 | else | |
88539837 EN |
1877 | Fset (command, map); |
1878 | return command; | |
2c6f1a39 JB |
1879 | } |
1880 | ||
1881 | DEFUN ("use-global-map", Fuse_global_map, Suse_global_map, 1, 1, 0, | |
335c5470 PJ |
1882 | doc: /* Select KEYMAP as the global keymap. */) |
1883 | (keymap) | |
2c6f1a39 JB |
1884 | Lisp_Object keymap; |
1885 | { | |
02067692 | 1886 | keymap = get_keymap (keymap, 1, 1); |
2c6f1a39 | 1887 | current_global_map = keymap; |
6f27e7a2 | 1888 | |
2c6f1a39 JB |
1889 | return Qnil; |
1890 | } | |
1891 | ||
1892 | DEFUN ("use-local-map", Fuse_local_map, Suse_local_map, 1, 1, 0, | |
335c5470 PJ |
1893 | doc: /* Select KEYMAP as the local keymap. |
1894 | If KEYMAP is nil, that means no local keymap. */) | |
1895 | (keymap) | |
2c6f1a39 JB |
1896 | Lisp_Object keymap; |
1897 | { | |
265a9e55 | 1898 | if (!NILP (keymap)) |
02067692 | 1899 | keymap = get_keymap (keymap, 1, 1); |
2c6f1a39 JB |
1900 | |
1901 | current_buffer->keymap = keymap; | |
1902 | ||
1903 | return Qnil; | |
1904 | } | |
1905 | ||
1906 | DEFUN ("current-local-map", Fcurrent_local_map, Scurrent_local_map, 0, 0, 0, | |
335c5470 PJ |
1907 | doc: /* Return current buffer's local keymap, or nil if it has none. */) |
1908 | () | |
2c6f1a39 JB |
1909 | { |
1910 | return current_buffer->keymap; | |
1911 | } | |
1912 | ||
1913 | DEFUN ("current-global-map", Fcurrent_global_map, Scurrent_global_map, 0, 0, 0, | |
335c5470 PJ |
1914 | doc: /* Return the current global keymap. */) |
1915 | () | |
2c6f1a39 JB |
1916 | { |
1917 | return current_global_map; | |
1918 | } | |
cc0a8174 JB |
1919 | |
1920 | DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps, Scurrent_minor_mode_maps, 0, 0, 0, | |
335c5470 PJ |
1921 | doc: /* Return a list of keymaps for the minor modes of the current buffer. */) |
1922 | () | |
cc0a8174 JB |
1923 | { |
1924 | Lisp_Object *maps; | |
1925 | int nmaps = current_minor_maps (0, &maps); | |
1926 | ||
1927 | return Flist (nmaps, maps); | |
1928 | } | |
2c6f1a39 | 1929 | \f |
cc0a8174 JB |
1930 | /* Help functions for describing and documenting keymaps. */ |
1931 | ||
54cbc3d4 SM |
1932 | |
1933 | static void | |
1934 | accessible_keymaps_1 (key, cmd, maps, tail, thisseq, is_metized) | |
1935 | Lisp_Object maps, tail, thisseq, key, cmd; | |
1936 | int is_metized; /* If 1, `key' is assumed to be INTEGERP. */ | |
1937 | { | |
1938 | Lisp_Object tem; | |
1939 | ||
73a4675c | 1940 | cmd = get_keymap (get_keyelt (cmd, 0), 0, 0); |
54cbc3d4 SM |
1941 | if (NILP (cmd)) |
1942 | return; | |
1943 | ||
73a4675c SM |
1944 | /* Look for and break cycles. */ |
1945 | while (!NILP (tem = Frassq (cmd, maps))) | |
54cbc3d4 | 1946 | { |
73a4675c SM |
1947 | Lisp_Object prefix = XCAR (tem); |
1948 | int lim = XINT (Flength (XCAR (tem))); | |
1949 | if (lim <= XINT (Flength (thisseq))) | |
1950 | { /* This keymap was already seen with a smaller prefix. */ | |
1951 | int i = 0; | |
1952 | while (i < lim && EQ (Faref (prefix, make_number (i)), | |
1953 | Faref (thisseq, make_number (i)))) | |
1954 | i++; | |
1955 | if (i >= lim) | |
1956 | /* `prefix' is a prefix of `thisseq' => there's a cycle. */ | |
1957 | return; | |
54cbc3d4 | 1958 | } |
73a4675c SM |
1959 | /* This occurrence of `cmd' in `maps' does not correspond to a cycle, |
1960 | but maybe `cmd' occurs again further down in `maps', so keep | |
1961 | looking. */ | |
1962 | maps = XCDR (Fmemq (tem, maps)); | |
1963 | } | |
1964 | ||
1965 | /* If the last key in thisseq is meta-prefix-char, | |
1966 | turn it into a meta-ized keystroke. We know | |
1967 | that the event we're about to append is an | |
1968 | ascii keystroke since we're processing a | |
1969 | keymap table. */ | |
1970 | if (is_metized) | |
1971 | { | |
1972 | int meta_bit = meta_modifier; | |
1973 | Lisp_Object last = make_number (XINT (Flength (thisseq)) - 1); | |
1974 | tem = Fcopy_sequence (thisseq); | |
f8d8ba40 | 1975 | |
73a4675c | 1976 | Faset (tem, last, make_number (XINT (key) | meta_bit)); |
f8d8ba40 | 1977 | |
73a4675c SM |
1978 | /* This new sequence is the same length as |
1979 | thisseq, so stick it in the list right | |
1980 | after this one. */ | |
1981 | XSETCDR (tail, | |
1982 | Fcons (Fcons (tem, cmd), XCDR (tail))); | |
1983 | } | |
1984 | else | |
1985 | { | |
1986 | tem = append_key (thisseq, key); | |
1987 | nconc2 (tail, Fcons (Fcons (tem, cmd), Qnil)); | |
54cbc3d4 SM |
1988 | } |
1989 | } | |
1990 | ||
1991 | static void | |
1992 | accessible_keymaps_char_table (args, index, cmd) | |
1993 | Lisp_Object args, index, cmd; | |
1994 | { | |
1995 | accessible_keymaps_1 (index, cmd, | |
1996 | XCAR (XCAR (args)), | |
1997 | XCAR (XCDR (args)), | |
1998 | XCDR (XCDR (args)), | |
1999 | XINT (XCDR (XCAR (args)))); | |
2000 | } | |
0403641f | 2001 | |
21a0d7a0 RS |
2002 | /* This function cannot GC. */ |
2003 | ||
2c6f1a39 | 2004 | DEFUN ("accessible-keymaps", Faccessible_keymaps, Saccessible_keymaps, |
335c5470 PJ |
2005 | 1, 2, 0, |
2006 | doc: /* Find all keymaps accessible via prefix characters from KEYMAP. | |
2007 | Returns a list of elements of the form (KEYS . MAP), where the sequence | |
2008 | KEYS starting from KEYMAP gets you to MAP. These elements are ordered | |
2009 | so that the KEYS increase in length. The first element is ([] . KEYMAP). | |
2010 | An optional argument PREFIX, if non-nil, should be a key sequence; | |
2011 | then the value includes only maps for prefixes that start with PREFIX. */) | |
2012 | (keymap, prefix) | |
88539837 | 2013 | Lisp_Object keymap, prefix; |
2c6f1a39 | 2014 | { |
fad865a3 | 2015 | Lisp_Object maps, tail; |
53c8f9fa RS |
2016 | int prefixlen = 0; |
2017 | ||
21a0d7a0 RS |
2018 | /* no need for gcpro because we don't autoload any keymaps. */ |
2019 | ||
53c8f9fa RS |
2020 | if (!NILP (prefix)) |
2021 | prefixlen = XINT (Flength (prefix)); | |
2c6f1a39 | 2022 | |
44a4a59b RS |
2023 | if (!NILP (prefix)) |
2024 | { | |
2025 | /* If a prefix was specified, start with the keymap (if any) for | |
2026 | that prefix, so we don't waste time considering other prefixes. */ | |
2027 | Lisp_Object tem; | |
88539837 | 2028 | tem = Flookup_key (keymap, prefix, Qt); |
1ae2097f RS |
2029 | /* Flookup_key may give us nil, or a number, |
2030 | if the prefix is not defined in this particular map. | |
2031 | It might even give us a list that isn't a keymap. */ | |
02067692 SM |
2032 | tem = get_keymap (tem, 0, 0); |
2033 | if (CONSP (tem)) | |
67fc16a3 RS |
2034 | { |
2035 | /* Convert PREFIX to a vector now, so that later on | |
2036 | we don't have to deal with the possibility of a string. */ | |
2037 | if (STRINGP (prefix)) | |
2038 | { | |
f3ba5409 | 2039 | int i, i_byte, c; |
67fc16a3 RS |
2040 | Lisp_Object copy; |
2041 | ||
d5db4077 KR |
2042 | copy = Fmake_vector (make_number (SCHARS (prefix)), Qnil); |
2043 | for (i = 0, i_byte = 0; i < SCHARS (prefix);) | |
67fc16a3 | 2044 | { |
f3ba5409 | 2045 | int i_before = i; |
54e03a4a KH |
2046 | |
2047 | FETCH_STRING_CHAR_ADVANCE (c, prefix, i, i_byte); | |
2048 | if (SINGLE_BYTE_CHAR_P (c) && (c & 0200)) | |
2049 | c ^= 0200 | meta_modifier; | |
49801145 | 2050 | ASET (copy, i_before, make_number (c)); |
67fc16a3 RS |
2051 | } |
2052 | prefix = copy; | |
2053 | } | |
2054 | maps = Fcons (Fcons (prefix, tem), Qnil); | |
2055 | } | |
44a4a59b RS |
2056 | else |
2057 | return Qnil; | |
2058 | } | |
2059 | else | |
2060 | maps = Fcons (Fcons (Fmake_vector (make_number (0), Qnil), | |
02067692 | 2061 | get_keymap (keymap, 1, 0)), |
44a4a59b | 2062 | Qnil); |
2c6f1a39 JB |
2063 | |
2064 | /* For each map in the list maps, | |
2065 | look at any other maps it points to, | |
2066 | and stick them at the end if they are not already in the list. | |
2067 | ||
2068 | This is a breadth-first traversal, where tail is the queue of | |
2069 | nodes, and maps accumulates a list of all nodes visited. */ | |
2070 | ||
03699b14 | 2071 | for (tail = maps; CONSP (tail); tail = XCDR (tail)) |
2c6f1a39 | 2072 | { |
e9b6dfb0 KH |
2073 | register Lisp_Object thisseq, thismap; |
2074 | Lisp_Object last; | |
2c6f1a39 | 2075 | /* Does the current sequence end in the meta-prefix-char? */ |
e9b6dfb0 KH |
2076 | int is_metized; |
2077 | ||
2078 | thisseq = Fcar (Fcar (tail)); | |
2079 | thismap = Fcdr (Fcar (tail)); | |
2080 | last = make_number (XINT (Flength (thisseq)) - 1); | |
2081 | is_metized = (XINT (last) >= 0 | |
97ae4b89 RS |
2082 | /* Don't metize the last char of PREFIX. */ |
2083 | && XINT (last) >= prefixlen | |
e9b6dfb0 | 2084 | && EQ (Faref (thisseq, last), meta_prefix_char)); |
2c6f1a39 | 2085 | |
03699b14 | 2086 | for (; CONSP (thismap); thismap = XCDR (thismap)) |
2c6f1a39 | 2087 | { |
e9b6dfb0 KH |
2088 | Lisp_Object elt; |
2089 | ||
03699b14 | 2090 | elt = XCAR (thismap); |
2c6f1a39 | 2091 | |
f5b79c1c JB |
2092 | QUIT; |
2093 | ||
0403641f RS |
2094 | if (CHAR_TABLE_P (elt)) |
2095 | { | |
23cf1efa | 2096 | Lisp_Object indices[3]; |
0403641f | 2097 | |
fe72189a | 2098 | map_char_table (accessible_keymaps_char_table, Qnil, elt, |
fc18e547 | 2099 | elt, Fcons (Fcons (maps, make_number (is_metized)), |
f58c6494 | 2100 | Fcons (tail, thisseq)), |
0403641f RS |
2101 | 0, indices); |
2102 | } | |
2103 | else if (VECTORP (elt)) | |
2c6f1a39 JB |
2104 | { |
2105 | register int i; | |
2106 | ||
2107 | /* Vector keymap. Scan all the elements. */ | |
49801145 | 2108 | for (i = 0; i < ASIZE (elt); i++) |
54cbc3d4 SM |
2109 | accessible_keymaps_1 (make_number (i), AREF (elt, i), |
2110 | maps, tail, thisseq, is_metized); | |
31bea176 | 2111 | |
0403641f | 2112 | } |
f5b79c1c | 2113 | else if (CONSP (elt)) |
54cbc3d4 SM |
2114 | accessible_keymaps_1 (XCAR (elt), XCDR (elt), |
2115 | maps, tail, thisseq, | |
2116 | is_metized && INTEGERP (XCAR (elt))); | |
31bea176 | 2117 | |
2c6f1a39 | 2118 | } |
2c6f1a39 JB |
2119 | } |
2120 | ||
73a4675c | 2121 | return maps; |
2c6f1a39 | 2122 | } |
0403641f | 2123 | \f |
2c6f1a39 JB |
2124 | Lisp_Object Qsingle_key_description, Qkey_description; |
2125 | ||
21a0d7a0 RS |
2126 | /* This function cannot GC. */ |
2127 | ||
f8d8ba40 | 2128 | DEFUN ("key-description", Fkey_description, Skey_description, 1, 2, 0, |
335c5470 | 2129 | doc: /* Return a pretty description of key-sequence KEYS. |
f8d8ba40 | 2130 | Optional arg PREFIX is the sequence of keys leading up to KEYS. |
23715ea6 | 2131 | Control characters turn into "C-foo" sequences, meta into "M-foo", |
335c5470 | 2132 | spaces are put between sequence elements, etc. */) |
f8d8ba40 KS |
2133 | (keys, prefix) |
2134 | Lisp_Object keys, prefix; | |
2c6f1a39 | 2135 | { |
6bbd7a29 | 2136 | int len = 0; |
f3ba5409 | 2137 | int i, i_byte; |
f8d8ba40 | 2138 | Lisp_Object *args; |
07f60146 | 2139 | int size = XINT (Flength (keys)); |
f8d8ba40 KS |
2140 | Lisp_Object list; |
2141 | Lisp_Object sep = build_string (" "); | |
2142 | Lisp_Object key; | |
2143 | int add_meta = 0; | |
2144 | ||
2145 | if (!NILP (prefix)) | |
07f60146 | 2146 | size += XINT (Flength (prefix)); |
f8d8ba40 KS |
2147 | |
2148 | /* This has one extra element at the end that we don't pass to Fconcat. */ | |
2149 | args = (Lisp_Object *) alloca (size * 4 * sizeof (Lisp_Object)); | |
2150 | ||
2151 | /* In effect, this computes | |
2152 | (mapconcat 'single-key-description keys " ") | |
2153 | but we shouldn't use mapconcat because it can do GC. */ | |
4c7d5f13 | 2154 | |
f8d8ba40 KS |
2155 | next_list: |
2156 | if (!NILP (prefix)) | |
2157 | list = prefix, prefix = Qnil; | |
2158 | else if (!NILP (keys)) | |
2159 | list = keys, keys = Qnil; | |
2160 | else | |
6ba6e250 | 2161 | { |
f8d8ba40 | 2162 | if (add_meta) |
6ba6e250 | 2163 | { |
f8d8ba40 KS |
2164 | args[len] = Fsingle_key_description (meta_prefix_char, Qnil); |
2165 | len += 2; | |
6ba6e250 | 2166 | } |
f8d8ba40 KS |
2167 | else if (len == 0) |
2168 | return empty_string; | |
2169 | return Fconcat (len - 1, args); | |
6ba6e250 | 2170 | } |
4c7d5f13 | 2171 | |
f8d8ba40 KS |
2172 | if (STRINGP (list)) |
2173 | size = SCHARS (list); | |
2174 | else if (VECTORP (list)) | |
2175 | size = XVECTOR (list)->size; | |
2176 | else if (CONSP (list)) | |
07f60146 | 2177 | size = XINT (Flength (list)); |
f8d8ba40 KS |
2178 | else |
2179 | wrong_type_argument (Qarrayp, list); | |
4c7d5f13 | 2180 | |
f8d8ba40 | 2181 | i = i_byte = 0; |
4c7d5f13 | 2182 | |
f8d8ba40 KS |
2183 | while (i < size) |
2184 | { | |
2185 | if (STRINGP (list)) | |
5c9c2c3f | 2186 | { |
f8d8ba40 KS |
2187 | int c; |
2188 | FETCH_STRING_CHAR_ADVANCE (c, list, i, i_byte); | |
2189 | if (SINGLE_BYTE_CHAR_P (c) && (c & 0200)) | |
2190 | c ^= 0200 | meta_modifier; | |
2191 | XSETFASTINT (key, c); | |
2192 | } | |
2193 | else if (VECTORP (list)) | |
2194 | { | |
2195 | key = AREF (list, i++); | |
2196 | } | |
2197 | else | |
2198 | { | |
2199 | key = XCAR (list); | |
2200 | list = XCDR (list); | |
2201 | i++; | |
5c9c2c3f | 2202 | } |
5c9c2c3f | 2203 | |
f8d8ba40 KS |
2204 | if (add_meta) |
2205 | { | |
2206 | if (!INTEGERP (key) | |
2207 | || EQ (key, meta_prefix_char) | |
2208 | || (XINT (key) & meta_modifier)) | |
2209 | { | |
2210 | args[len++] = Fsingle_key_description (meta_prefix_char, Qnil); | |
2211 | args[len++] = sep; | |
2212 | if (EQ (key, meta_prefix_char)) | |
2213 | continue; | |
2214 | } | |
2215 | else | |
2216 | XSETINT (key, (XINT (key) | meta_modifier) & ~0x80); | |
2217 | add_meta = 0; | |
2218 | } | |
2219 | else if (EQ (key, meta_prefix_char)) | |
5c9c2c3f | 2220 | { |
f8d8ba40 KS |
2221 | add_meta = 1; |
2222 | continue; | |
5c9c2c3f | 2223 | } |
f8d8ba40 KS |
2224 | args[len++] = Fsingle_key_description (key, Qnil); |
2225 | args[len++] = sep; | |
4c7d5f13 | 2226 | } |
f8d8ba40 | 2227 | goto next_list; |
2c6f1a39 JB |
2228 | } |
2229 | ||
f8d8ba40 | 2230 | |
2c6f1a39 | 2231 | char * |
f1cb0a25 | 2232 | push_key_description (c, p, force_multibyte) |
2c6f1a39 JB |
2233 | register unsigned int c; |
2234 | register char *p; | |
f1cb0a25 | 2235 | int force_multibyte; |
2c6f1a39 | 2236 | { |
bc89c609 | 2237 | unsigned c2; |
f39a0b43 | 2238 | int valid_p; |
31bea176 | 2239 | |
71ac885b RS |
2240 | /* Clear all the meaningless bits above the meta bit. */ |
2241 | c &= meta_modifier | ~ - meta_modifier; | |
bc89c609 GM |
2242 | c2 = c & ~(alt_modifier | ctrl_modifier | hyper_modifier |
2243 | | meta_modifier | shift_modifier | super_modifier); | |
71ac885b | 2244 | |
5f2c7b2a | 2245 | valid_p = SINGLE_BYTE_CHAR_P (c2) || char_valid_p (c2, 0); |
f39a0b43 KH |
2246 | if (! valid_p) |
2247 | { | |
2248 | /* KEY_DESCRIPTION_SIZE is large enough for this. */ | |
2249 | p += sprintf (p, "[%d]", c); | |
2250 | return p; | |
2251 | } | |
2252 | ||
6ba6e250 RS |
2253 | if (c & alt_modifier) |
2254 | { | |
2255 | *p++ = 'A'; | |
2256 | *p++ = '-'; | |
2257 | c -= alt_modifier; | |
2258 | } | |
bc89c609 GM |
2259 | if ((c & ctrl_modifier) != 0 |
2260 | || (c2 < ' ' && c2 != 27 && c2 != '\t' && c2 != Ctl ('M'))) | |
6ba6e250 RS |
2261 | { |
2262 | *p++ = 'C'; | |
2263 | *p++ = '-'; | |
bc89c609 | 2264 | c &= ~ctrl_modifier; |
6ba6e250 RS |
2265 | } |
2266 | if (c & hyper_modifier) | |
2267 | { | |
2268 | *p++ = 'H'; | |
2269 | *p++ = '-'; | |
2270 | c -= hyper_modifier; | |
2271 | } | |
2272 | if (c & meta_modifier) | |
2c6f1a39 JB |
2273 | { |
2274 | *p++ = 'M'; | |
2275 | *p++ = '-'; | |
6ba6e250 RS |
2276 | c -= meta_modifier; |
2277 | } | |
2278 | if (c & shift_modifier) | |
2279 | { | |
2280 | *p++ = 'S'; | |
2281 | *p++ = '-'; | |
2282 | c -= shift_modifier; | |
2283 | } | |
2284 | if (c & super_modifier) | |
2285 | { | |
2286 | *p++ = 's'; | |
2287 | *p++ = '-'; | |
2288 | c -= super_modifier; | |
2c6f1a39 JB |
2289 | } |
2290 | if (c < 040) | |
2291 | { | |
2292 | if (c == 033) | |
2293 | { | |
2294 | *p++ = 'E'; | |
2295 | *p++ = 'S'; | |
2296 | *p++ = 'C'; | |
2297 | } | |
6ba6e250 | 2298 | else if (c == '\t') |
2c6f1a39 JB |
2299 | { |
2300 | *p++ = 'T'; | |
2301 | *p++ = 'A'; | |
2302 | *p++ = 'B'; | |
2303 | } | |
b8cab006 | 2304 | else if (c == Ctl ('M')) |
2c6f1a39 JB |
2305 | { |
2306 | *p++ = 'R'; | |
2307 | *p++ = 'E'; | |
2308 | *p++ = 'T'; | |
2309 | } | |
2310 | else | |
2311 | { | |
bc89c609 | 2312 | /* `C-' already added above. */ |
2c6f1a39 JB |
2313 | if (c > 0 && c <= Ctl ('Z')) |
2314 | *p++ = c + 0140; | |
2315 | else | |
2316 | *p++ = c + 0100; | |
2317 | } | |
2318 | } | |
2319 | else if (c == 0177) | |
2320 | { | |
2321 | *p++ = 'D'; | |
2322 | *p++ = 'E'; | |
2323 | *p++ = 'L'; | |
2324 | } | |
2325 | else if (c == ' ') | |
9fb71293 | 2326 | { |
2c6f1a39 JB |
2327 | *p++ = 'S'; |
2328 | *p++ = 'P'; | |
2329 | *p++ = 'C'; | |
2330 | } | |
d3c00496 KH |
2331 | else if (c < 128 |
2332 | || (NILP (current_buffer->enable_multibyte_characters) | |
f1cb0a25 GM |
2333 | && SINGLE_BYTE_CHAR_P (c) |
2334 | && !force_multibyte)) | |
2335 | { | |
2336 | *p++ = c; | |
2337 | } | |
6ba6e250 RS |
2338 | else |
2339 | { | |
f39a0b43 | 2340 | if (force_multibyte) |
f1cb0a25 GM |
2341 | { |
2342 | if (SINGLE_BYTE_CHAR_P (c)) | |
2343 | c = unibyte_char_to_multibyte (c); | |
2344 | p += CHAR_STRING (c, p); | |
2345 | } | |
f39a0b43 | 2346 | else if (NILP (current_buffer->enable_multibyte_characters)) |
9fb71293 KH |
2347 | { |
2348 | int bit_offset; | |
2349 | *p++ = '\\'; | |
2350 | /* The biggest character code uses 19 bits. */ | |
2351 | for (bit_offset = 18; bit_offset >= 0; bit_offset -= 3) | |
2352 | { | |
2353 | if (c >= (1 << bit_offset)) | |
2354 | *p++ = ((c & (7 << bit_offset)) >> bit_offset) + '0'; | |
2355 | } | |
2356 | } | |
2357 | else | |
f1cb0a25 | 2358 | p += CHAR_STRING (c, p); |
6ba6e250 | 2359 | } |
2c6f1a39 | 2360 | |
d55627cc | 2361 | return p; |
2c6f1a39 JB |
2362 | } |
2363 | ||
21a0d7a0 RS |
2364 | /* This function cannot GC. */ |
2365 | ||
c1848a97 GM |
2366 | DEFUN ("single-key-description", Fsingle_key_description, |
2367 | Ssingle_key_description, 1, 2, 0, | |
335c5470 PJ |
2368 | doc: /* Return a pretty description of command character KEY. |
2369 | Control characters turn into C-whatever, etc. | |
2370 | Optional argument NO-ANGLES non-nil means don't put angle brackets | |
2371 | around function keys and event symbols. */) | |
2372 | (key, no_angles) | |
c1848a97 | 2373 | Lisp_Object key, no_angles; |
2c6f1a39 | 2374 | { |
5c9c2c3f RS |
2375 | if (CONSP (key) && lucid_event_type_list_p (key)) |
2376 | key = Fevent_convert_list (key); | |
2377 | ||
cebd887d | 2378 | key = EVENT_HEAD (key); |
6bbbd9b0 | 2379 | |
e958fd9a | 2380 | if (INTEGERP (key)) /* Normal character */ |
2c6f1a39 | 2381 | { |
47a18cef | 2382 | unsigned int charset, c1, c2; |
f4977051 | 2383 | int without_bits = XINT (key) & ~((-1) << CHARACTERBITS); |
47a18cef | 2384 | |
f4977051 | 2385 | if (SINGLE_BYTE_CHAR_P (without_bits)) |
47a18cef RS |
2386 | charset = 0; |
2387 | else | |
54e03a4a | 2388 | SPLIT_CHAR (without_bits, charset, c1, c2); |
47a18cef | 2389 | |
4ccaff67 KH |
2390 | if (! CHAR_VALID_P (without_bits, 1)) |
2391 | { | |
2392 | char buf[256]; | |
2393 | ||
2394 | sprintf (buf, "Invalid char code %d", XINT (key)); | |
2395 | return build_string (buf); | |
2396 | } | |
2397 | else if (charset | |
2398 | && ((c1 == 0 && c2 == -1) || c2 == 0)) | |
47a18cef RS |
2399 | { |
2400 | /* Handle a generic character. */ | |
2401 | Lisp_Object name; | |
173517c6 KH |
2402 | char buf[256]; |
2403 | ||
2404 | name = CHARSET_TABLE_INFO (charset, CHARSET_SHORT_NAME_IDX); | |
b7826503 | 2405 | CHECK_STRING (name); |
173517c6 KH |
2406 | if (c1 == 0) |
2407 | /* Only a charset is specified. */ | |
2408 | sprintf (buf, "Generic char %d: all of ", without_bits); | |
2409 | else | |
2410 | /* 1st code-point of 2-dimensional charset is specified. */ | |
2411 | sprintf (buf, "Generic char %d: row %d of ", without_bits, c1); | |
2412 | return concat2 (build_string (buf), name); | |
47a18cef RS |
2413 | } |
2414 | else | |
2415 | { | |
3d9d7a9b GM |
2416 | char tem[KEY_DESCRIPTION_SIZE], *end; |
2417 | int nbytes, nchars; | |
2418 | Lisp_Object string; | |
2419 | ||
2420 | end = push_key_description (XUINT (key), tem, 1); | |
2421 | nbytes = end - tem; | |
2422 | nchars = multibyte_chars_in_text (tem, nbytes); | |
2423 | if (nchars == nbytes) | |
e15e2828 GM |
2424 | { |
2425 | *end = '\0'; | |
2426 | string = build_string (tem); | |
2427 | } | |
3d9d7a9b GM |
2428 | else |
2429 | string = make_multibyte_string (tem, nchars, nbytes); | |
2430 | return string; | |
47a18cef | 2431 | } |
2c6f1a39 | 2432 | } |
e958fd9a | 2433 | else if (SYMBOLP (key)) /* Function key or event-symbol */ |
c7edb960 | 2434 | { |
c1848a97 GM |
2435 | if (NILP (no_angles)) |
2436 | { | |
2437 | char *buffer | |
d5db4077 KR |
2438 | = (char *) alloca (SBYTES (SYMBOL_NAME (key)) + 5); |
2439 | sprintf (buffer, "<%s>", SDATA (SYMBOL_NAME (key))); | |
c1848a97 GM |
2440 | return build_string (buffer); |
2441 | } | |
2442 | else | |
2443 | return Fsymbol_name (key); | |
c7edb960 | 2444 | } |
e958fd9a KH |
2445 | else if (STRINGP (key)) /* Buffer names in the menubar. */ |
2446 | return Fcopy_sequence (key); | |
2447 | else | |
2448 | error ("KEY must be an integer, cons, symbol, or string"); | |
6bbd7a29 | 2449 | return Qnil; |
2c6f1a39 JB |
2450 | } |
2451 | ||
2452 | char * | |
2453 | push_text_char_description (c, p) | |
2454 | register unsigned int c; | |
2455 | register char *p; | |
2456 | { | |
2457 | if (c >= 0200) | |
2458 | { | |
2459 | *p++ = 'M'; | |
2460 | *p++ = '-'; | |
2461 | c -= 0200; | |
2462 | } | |
2463 | if (c < 040) | |
2464 | { | |
2465 | *p++ = '^'; | |
2466 | *p++ = c + 64; /* 'A' - 1 */ | |
2467 | } | |
2468 | else if (c == 0177) | |
2469 | { | |
2470 | *p++ = '^'; | |
2471 | *p++ = '?'; | |
2472 | } | |
2473 | else | |
2474 | *p++ = c; | |
d55627cc | 2475 | return p; |
2c6f1a39 JB |
2476 | } |
2477 | ||
21a0d7a0 RS |
2478 | /* This function cannot GC. */ |
2479 | ||
2c6f1a39 | 2480 | DEFUN ("text-char-description", Ftext_char_description, Stext_char_description, 1, 1, 0, |
335c5470 | 2481 | doc: /* Return a pretty description of file-character CHARACTER. |
bda67d96 LT |
2482 | Control characters turn into "^char", etc. This differs from |
2483 | `single-key-description' which turns them into "C-char". | |
2484 | Also, this function recognizes the 2**7 bit as the Meta character, | |
2485 | whereas `single-key-description' uses the 2**27 bit for Meta. | |
2486 | See Info node `(elisp)Describing Characters' for examples. */) | |
335c5470 | 2487 | (character) |
88539837 | 2488 | Lisp_Object character; |
2c6f1a39 | 2489 | { |
0a16479f KH |
2490 | /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */ |
2491 | unsigned char str[6]; | |
2492 | int c; | |
2c6f1a39 | 2493 | |
b7826503 | 2494 | CHECK_NUMBER (character); |
2c6f1a39 | 2495 | |
0a16479f KH |
2496 | c = XINT (character); |
2497 | if (!SINGLE_BYTE_CHAR_P (c)) | |
a98f1d1d | 2498 | { |
0a16479f | 2499 | int len = CHAR_STRING (c, str); |
a98f1d1d | 2500 | |
f3ba5409 | 2501 | return make_multibyte_string (str, 1, len); |
a98f1d1d KH |
2502 | } |
2503 | ||
0a16479f | 2504 | *push_text_char_description (c & 0377, str) = 0; |
2c6f1a39 | 2505 | |
0a16479f | 2506 | return build_string (str); |
2c6f1a39 | 2507 | } |
2fc66973 JB |
2508 | |
2509 | /* Return non-zero if SEQ contains only ASCII characters, perhaps with | |
2510 | a meta bit. */ | |
2511 | static int | |
2512 | ascii_sequence_p (seq) | |
2513 | Lisp_Object seq; | |
2514 | { | |
6e344130 | 2515 | int i; |
2fc66973 | 2516 | int len = XINT (Flength (seq)); |
ffab2bd6 | 2517 | |
6e344130 | 2518 | for (i = 0; i < len; i++) |
2fc66973 | 2519 | { |
6e344130 | 2520 | Lisp_Object ii, elt; |
ffab2bd6 | 2521 | |
6e344130 KH |
2522 | XSETFASTINT (ii, i); |
2523 | elt = Faref (seq, ii); | |
2fc66973 | 2524 | |
416349ec | 2525 | if (!INTEGERP (elt) |
2fc66973 JB |
2526 | || (XUINT (elt) & ~CHAR_META) >= 0x80) |
2527 | return 0; | |
2528 | } | |
2529 | ||
2530 | return 1; | |
2531 | } | |
2532 | ||
2c6f1a39 | 2533 | \f |
cc0a8174 JB |
2534 | /* where-is - finding a command in a set of keymaps. */ |
2535 | ||
0c412762 | 2536 | static Lisp_Object where_is_internal (); |
0403641f | 2537 | static Lisp_Object where_is_internal_1 (); |
69248761 | 2538 | static void where_is_internal_2 (); |
0403641f | 2539 | |
49801145 SM |
2540 | /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map. |
2541 | Returns the first non-nil binding found in any of those maps. */ | |
2542 | ||
2543 | static Lisp_Object | |
2544 | shadow_lookup (shadow, key, flag) | |
2545 | Lisp_Object shadow, key, flag; | |
2546 | { | |
2547 | Lisp_Object tail, value; | |
2548 | ||
2549 | for (tail = shadow; CONSP (tail); tail = XCDR (tail)) | |
2550 | { | |
2551 | value = Flookup_key (XCAR (tail), key, flag); | |
d35f78c9 JL |
2552 | if (NATNUMP (value)) |
2553 | { | |
d7c0be75 KR |
2554 | value = Flookup_key (XCAR (tail), |
2555 | Fsubstring (key, make_number (0), value), flag); | |
d35f78c9 JL |
2556 | if (!NILP (value)) |
2557 | return Qnil; | |
2558 | } | |
2559 | else if (!NILP (value)) | |
49801145 SM |
2560 | return value; |
2561 | } | |
2562 | return Qnil; | |
2563 | } | |
2564 | ||
9d209cfe | 2565 | static Lisp_Object Vmouse_events; |
d378869e | 2566 | |
49801145 SM |
2567 | /* This function can GC if Flookup_key autoloads any keymaps. */ |
2568 | ||
1e7d1ab0 | 2569 | static Lisp_Object |
0c412762 | 2570 | where_is_internal (definition, keymaps, firstonly, noindirect, no_remap) |
1e7d1ab0 | 2571 | Lisp_Object definition, keymaps; |
0c412762 | 2572 | Lisp_Object firstonly, noindirect, no_remap; |
2c6f1a39 | 2573 | { |
49801145 | 2574 | Lisp_Object maps = Qnil; |
0403641f | 2575 | Lisp_Object found, sequences; |
21a0d7a0 | 2576 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5; |
0bc395d4 RS |
2577 | /* 1 means ignore all menu bindings entirely. */ |
2578 | int nomenus = !NILP (firstonly) && !EQ (firstonly, Qnon_ascii); | |
2c6f1a39 | 2579 | |
0c412762 KS |
2580 | /* If this command is remapped, then it has no key bindings |
2581 | of its own. */ | |
a1df473f KS |
2582 | if (NILP (no_remap) && SYMBOLP (definition)) |
2583 | { | |
2584 | Lisp_Object tem; | |
b74e16a3 | 2585 | if (tem = Fcommand_remapping (definition, Qnil), !NILP (tem)) |
a1df473f KS |
2586 | return Qnil; |
2587 | } | |
0c412762 | 2588 | |
49801145 SM |
2589 | found = keymaps; |
2590 | while (CONSP (found)) | |
93d2aa1c | 2591 | { |
49801145 | 2592 | maps = |
02067692 SM |
2593 | nconc2 (maps, |
2594 | Faccessible_keymaps (get_keymap (XCAR (found), 1, 0), Qnil)); | |
49801145 | 2595 | found = XCDR (found); |
93d2aa1c | 2596 | } |
31bea176 | 2597 | |
49801145 | 2598 | GCPRO5 (definition, keymaps, maps, found, sequences); |
2c6f1a39 | 2599 | found = Qnil; |
0403641f | 2600 | sequences = Qnil; |
2c6f1a39 | 2601 | |
265a9e55 | 2602 | for (; !NILP (maps); maps = Fcdr (maps)) |
2c6f1a39 | 2603 | { |
e9b6dfb0 | 2604 | /* Key sequence to reach map, and the map that it reaches */ |
d378869e | 2605 | register Lisp_Object this, map, tem; |
f5b79c1c | 2606 | |
2c6f1a39 JB |
2607 | /* In order to fold [META-PREFIX-CHAR CHAR] sequences into |
2608 | [M-CHAR] sequences, check if last character of the sequence | |
2609 | is the meta-prefix char. */ | |
e9b6dfb0 KH |
2610 | Lisp_Object last; |
2611 | int last_is_meta; | |
2612 | ||
2613 | this = Fcar (Fcar (maps)); | |
2614 | map = Fcdr (Fcar (maps)); | |
2615 | last = make_number (XINT (Flength (this)) - 1); | |
2616 | last_is_meta = (XINT (last) >= 0 | |
2617 | && EQ (Faref (this, last), meta_prefix_char)); | |
2c6f1a39 | 2618 | |
2ba11bbd | 2619 | /* if (nomenus && !ascii_sequence_p (this)) */ |
f58c6494 | 2620 | if (nomenus && XINT (last) >= 0 |
d378869e | 2621 | && SYMBOLP (tem = Faref (this, make_number (0))) |
9d209cfe | 2622 | && !NILP (Fmemq (XCAR (parse_modifiers (tem)), Vmouse_events))) |
88416888 SM |
2623 | /* If no menu entries should be returned, skip over the |
2624 | keymaps bound to `menu-bar' and `tool-bar' and other | |
2ba11bbd | 2625 | non-ascii prefixes like `C-down-mouse-2'. */ |
88416888 | 2626 | continue; |
31bea176 | 2627 | |
fde3a52f JB |
2628 | QUIT; |
2629 | ||
f5b79c1c | 2630 | while (CONSP (map)) |
2c6f1a39 | 2631 | { |
f5b79c1c JB |
2632 | /* Because the code we want to run on each binding is rather |
2633 | large, we don't want to have two separate loop bodies for | |
2634 | sparse keymap bindings and tables; we want to iterate one | |
2635 | loop body over both keymap and vector bindings. | |
2636 | ||
2637 | For this reason, if Fcar (map) is a vector, we don't | |
2638 | advance map to the next element until i indicates that we | |
2639 | have finished off the vector. */ | |
21a0d7a0 | 2640 | Lisp_Object elt, key, binding; |
03699b14 KR |
2641 | elt = XCAR (map); |
2642 | map = XCDR (map); | |
0403641f RS |
2643 | |
2644 | sequences = Qnil; | |
f5b79c1c | 2645 | |
fde3a52f JB |
2646 | QUIT; |
2647 | ||
f5b79c1c JB |
2648 | /* Set key and binding to the current key and binding, and |
2649 | advance map and i to the next binding. */ | |
416349ec | 2650 | if (VECTORP (elt)) |
2c6f1a39 | 2651 | { |
0403641f RS |
2652 | Lisp_Object sequence; |
2653 | int i; | |
2c6f1a39 | 2654 | /* In a vector, look at each element. */ |
0403641f | 2655 | for (i = 0; i < XVECTOR (elt)->size; i++) |
2c6f1a39 | 2656 | { |
49801145 | 2657 | binding = AREF (elt, i); |
0403641f RS |
2658 | XSETFASTINT (key, i); |
2659 | sequence = where_is_internal_1 (binding, key, definition, | |
49801145 | 2660 | noindirect, this, |
0403641f RS |
2661 | last, nomenus, last_is_meta); |
2662 | if (!NILP (sequence)) | |
2663 | sequences = Fcons (sequence, sequences); | |
2c6f1a39 | 2664 | } |
f5b79c1c | 2665 | } |
0403641f | 2666 | else if (CHAR_TABLE_P (elt)) |
f5b79c1c | 2667 | { |
23cf1efa | 2668 | Lisp_Object indices[3]; |
0403641f | 2669 | Lisp_Object args; |
23cf1efa | 2670 | |
0403641f | 2671 | args = Fcons (Fcons (Fcons (definition, noindirect), |
49801145 | 2672 | Qnil), /* Result accumulator. */ |
0403641f RS |
2673 | Fcons (Fcons (this, last), |
2674 | Fcons (make_number (nomenus), | |
2675 | make_number (last_is_meta)))); | |
fe72189a | 2676 | map_char_table (where_is_internal_2, Qnil, elt, elt, args, |
0403641f | 2677 | 0, indices); |
49801145 | 2678 | sequences = XCDR (XCAR (args)); |
2c6f1a39 | 2679 | } |
0403641f | 2680 | else if (CONSP (elt)) |
fde3a52f | 2681 | { |
0403641f | 2682 | Lisp_Object sequence; |
2c6f1a39 | 2683 | |
03699b14 KR |
2684 | key = XCAR (elt); |
2685 | binding = XCDR (elt); | |
2c6f1a39 | 2686 | |
0403641f | 2687 | sequence = where_is_internal_1 (binding, key, definition, |
49801145 | 2688 | noindirect, this, |
0403641f RS |
2689 | last, nomenus, last_is_meta); |
2690 | if (!NILP (sequence)) | |
2691 | sequences = Fcons (sequence, sequences); | |
2c6f1a39 | 2692 | } |
2c6f1a39 | 2693 | |
2c6f1a39 | 2694 | |
0c412762 | 2695 | while (!NILP (sequences)) |
2c6f1a39 | 2696 | { |
a1df473f | 2697 | Lisp_Object sequence, remapped, function; |
0403641f | 2698 | |
03699b14 | 2699 | sequence = XCAR (sequences); |
0c412762 KS |
2700 | sequences = XCDR (sequences); |
2701 | ||
a1df473f KS |
2702 | /* If the current sequence is a command remapping with |
2703 | format [remap COMMAND], find the key sequences | |
2704 | which run COMMAND, and use those sequences instead. */ | |
0c412762 KS |
2705 | remapped = Qnil; |
2706 | if (NILP (no_remap) | |
a1df473f KS |
2707 | && VECTORP (sequence) && XVECTOR (sequence)->size == 2 |
2708 | && EQ (AREF (sequence, 0), Qremap) | |
2709 | && (function = AREF (sequence, 1), SYMBOLP (function))) | |
0c412762 | 2710 | { |
a1df473f | 2711 | Lisp_Object remapped1; |
0c412762 | 2712 | |
a1df473f KS |
2713 | remapped1 = where_is_internal (function, keymaps, firstonly, noindirect, Qt); |
2714 | if (CONSP (remapped1)) | |
0c412762 | 2715 | { |
a1df473f KS |
2716 | /* Verify that this key binding actually maps to the |
2717 | remapped command (see below). */ | |
2718 | if (!EQ (shadow_lookup (keymaps, XCAR (remapped1), Qnil), function)) | |
2719 | continue; | |
2720 | sequence = XCAR (remapped1); | |
2721 | remapped = XCDR (remapped1); | |
2722 | goto record_sequence; | |
0c412762 KS |
2723 | } |
2724 | } | |
0403641f | 2725 | |
49801145 SM |
2726 | /* Verify that this key binding is not shadowed by another |
2727 | binding for the same key, before we say it exists. | |
2728 | ||
2729 | Mechanism: look for local definition of this key and if | |
2730 | it is defined and does not match what we found then | |
2731 | ignore this key. | |
2732 | ||
2733 | Either nil or number as value from Flookup_key | |
2734 | means undefined. */ | |
1e7d1ab0 | 2735 | if (!EQ (shadow_lookup (keymaps, sequence, Qnil), definition)) |
49801145 SM |
2736 | continue; |
2737 | ||
0c412762 | 2738 | record_sequence: |
18e2d91f RS |
2739 | /* Don't annoy user with strings from a menu such as |
2740 | Select Paste. Change them all to "(any string)", | |
2741 | so that there seems to be only one menu item | |
2742 | to report. */ | |
2743 | if (! NILP (sequence)) | |
2744 | { | |
2745 | Lisp_Object tem; | |
2746 | tem = Faref (sequence, make_number (XVECTOR (sequence)->size - 1)); | |
2747 | if (STRINGP (tem)) | |
2748 | Faset (sequence, make_number (XVECTOR (sequence)->size - 1), | |
2749 | build_string ("(any string)")); | |
2750 | } | |
2751 | ||
0403641f RS |
2752 | /* It is a true unshadowed match. Record it, unless it's already |
2753 | been seen (as could happen when inheriting keymaps). */ | |
2754 | if (NILP (Fmember (sequence, found))) | |
2755 | found = Fcons (sequence, found); | |
2756 | ||
2757 | /* If firstonly is Qnon_ascii, then we can return the first | |
2758 | binding we find. If firstonly is not Qnon_ascii but not | |
2759 | nil, then we should return the first ascii-only binding | |
2760 | we find. */ | |
2761 | if (EQ (firstonly, Qnon_ascii)) | |
2762 | RETURN_UNGCPRO (sequence); | |
54cbc3d4 | 2763 | else if (!NILP (firstonly) && ascii_sequence_p (sequence)) |
0403641f | 2764 | RETURN_UNGCPRO (sequence); |
0c412762 KS |
2765 | |
2766 | if (CONSP (remapped)) | |
2767 | { | |
2768 | sequence = XCAR (remapped); | |
2769 | remapped = XCDR (remapped); | |
2770 | goto record_sequence; | |
2771 | } | |
2c6f1a39 | 2772 | } |
2c6f1a39 JB |
2773 | } |
2774 | } | |
2fc66973 | 2775 | |
21a0d7a0 RS |
2776 | UNGCPRO; |
2777 | ||
2fc66973 JB |
2778 | found = Fnreverse (found); |
2779 | ||
2780 | /* firstonly may have been t, but we may have gone all the way through | |
2781 | the keymaps without finding an all-ASCII key sequence. So just | |
2782 | return the best we could find. */ | |
54cbc3d4 | 2783 | if (!NILP (firstonly)) |
2fc66973 | 2784 | return Fcar (found); |
31bea176 | 2785 | |
2fc66973 | 2786 | return found; |
2c6f1a39 | 2787 | } |
0403641f | 2788 | |
0c412762 | 2789 | DEFUN ("where-is-internal", Fwhere_is_internal, Swhere_is_internal, 1, 5, 0, |
335c5470 | 2790 | doc: /* Return list of keys that invoke DEFINITION. |
2c0a0e38 | 2791 | If KEYMAP is a keymap, search only KEYMAP and the global keymap. |
335c5470 PJ |
2792 | If KEYMAP is nil, search all the currently active keymaps. |
2793 | If KEYMAP is a list of keymaps, search only those keymaps. | |
2794 | ||
2795 | If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found, | |
2796 | rather than a list of all possible key sequences. | |
2797 | If FIRSTONLY is the symbol `non-ascii', return the first binding found, | |
2798 | no matter what it is. | |
2c0a0e38 LT |
2799 | If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters |
2800 | \(or their meta variants) and entirely reject menu bindings. | |
335c5470 PJ |
2801 | |
2802 | If optional 4th arg NOINDIRECT is non-nil, don't follow indirections | |
2803 | to other keymaps or slots. This makes it possible to search for an | |
0c412762 KS |
2804 | indirect definition itself. |
2805 | ||
2806 | If optional 5th arg NO-REMAP is non-nil, don't search for key sequences | |
2807 | that invoke a command which is remapped to DEFINITION, but include the | |
2808 | remapped command in the returned list. */) | |
2809 | (definition, keymap, firstonly, noindirect, no_remap) | |
4956d1ef | 2810 | Lisp_Object definition, keymap; |
0c412762 | 2811 | Lisp_Object firstonly, noindirect, no_remap; |
1e7d1ab0 SM |
2812 | { |
2813 | Lisp_Object sequences, keymaps; | |
1e7d1ab0 SM |
2814 | /* 1 means ignore all menu bindings entirely. */ |
2815 | int nomenus = !NILP (firstonly) && !EQ (firstonly, Qnon_ascii); | |
f9aaedb6 | 2816 | Lisp_Object result; |
1e7d1ab0 SM |
2817 | |
2818 | /* Find the relevant keymaps. */ | |
4956d1ef GM |
2819 | if (CONSP (keymap) && KEYMAPP (XCAR (keymap))) |
2820 | keymaps = keymap; | |
54cbc3d4 | 2821 | else if (!NILP (keymap)) |
4956d1ef | 2822 | keymaps = Fcons (keymap, Fcons (current_global_map, Qnil)); |
1e7d1ab0 | 2823 | else |
54cbc3d4 | 2824 | keymaps = Fcurrent_active_maps (Qnil); |
1e7d1ab0 SM |
2825 | |
2826 | /* Only use caching for the menubar (i.e. called with (def nil t nil). | |
4956d1ef GM |
2827 | We don't really need to check `keymap'. */ |
2828 | if (nomenus && NILP (noindirect) && NILP (keymap)) | |
1e7d1ab0 | 2829 | { |
f9aaedb6 | 2830 | Lisp_Object *defns; |
60dc6558 | 2831 | int i, j, n; |
0c412762 | 2832 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5; |
744cd66b | 2833 | |
1e7d1ab0 SM |
2834 | /* Check heuristic-consistency of the cache. */ |
2835 | if (NILP (Fequal (keymaps, where_is_cache_keymaps))) | |
2836 | where_is_cache = Qnil; | |
2837 | ||
2838 | if (NILP (where_is_cache)) | |
2839 | { | |
2840 | /* We need to create the cache. */ | |
2841 | Lisp_Object args[2]; | |
2842 | where_is_cache = Fmake_hash_table (0, args); | |
2843 | where_is_cache_keymaps = Qt; | |
31bea176 | 2844 | |
1e7d1ab0 | 2845 | /* Fill in the cache. */ |
0c412762 KS |
2846 | GCPRO5 (definition, keymaps, firstonly, noindirect, no_remap); |
2847 | where_is_internal (definition, keymaps, firstonly, noindirect, no_remap); | |
1e7d1ab0 SM |
2848 | UNGCPRO; |
2849 | ||
2850 | where_is_cache_keymaps = keymaps; | |
2851 | } | |
2852 | ||
f9aaedb6 GM |
2853 | /* We want to process definitions from the last to the first. |
2854 | Instead of consing, copy definitions to a vector and step | |
2855 | over that vector. */ | |
1e7d1ab0 | 2856 | sequences = Fgethash (definition, where_is_cache, Qnil); |
f58c6494 | 2857 | n = XINT (Flength (sequences)); |
f9aaedb6 GM |
2858 | defns = (Lisp_Object *) alloca (n * sizeof *defns); |
2859 | for (i = 0; CONSP (sequences); sequences = XCDR (sequences)) | |
2860 | defns[i++] = XCAR (sequences); | |
31bea176 | 2861 | |
f9aaedb6 GM |
2862 | /* Verify that the key bindings are not shadowed. Note that |
2863 | the following can GC. */ | |
2864 | GCPRO2 (definition, keymaps); | |
2865 | result = Qnil; | |
60dc6558 | 2866 | j = -1; |
f9aaedb6 | 2867 | for (i = n - 1; i >= 0; --i) |
60dc6558 SM |
2868 | if (EQ (shadow_lookup (keymaps, defns[i], Qnil), definition)) |
2869 | { | |
2870 | if (ascii_sequence_p (defns[i])) | |
2871 | break; | |
2872 | else if (j < 0) | |
2873 | j = i; | |
2874 | } | |
f9aaedb6 | 2875 | |
60dc6558 | 2876 | result = i >= 0 ? defns[i] : (j >= 0 ? defns[j] : Qnil); |
f9aaedb6 | 2877 | UNGCPRO; |
1e7d1ab0 SM |
2878 | } |
2879 | else | |
2880 | { | |
2881 | /* Kill the cache so that where_is_internal_1 doesn't think | |
2882 | we're filling it up. */ | |
2883 | where_is_cache = Qnil; | |
0c412762 | 2884 | result = where_is_internal (definition, keymaps, firstonly, noindirect, no_remap); |
1e7d1ab0 | 2885 | } |
f9aaedb6 GM |
2886 | |
2887 | return result; | |
1e7d1ab0 SM |
2888 | } |
2889 | ||
0403641f RS |
2890 | /* This is the function that Fwhere_is_internal calls using map_char_table. |
2891 | ARGS has the form | |
2892 | (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT)) | |
2893 | . | |
2894 | ((THIS . LAST) . (NOMENUS . LAST_IS_META))) | |
2895 | Since map_char_table doesn't really use the return value from this function, | |
df75b1a3 GM |
2896 | we the result append to RESULT, the slot in ARGS. |
2897 | ||
2898 | This function can GC because it calls where_is_internal_1 which can | |
2899 | GC. */ | |
0403641f | 2900 | |
69248761 | 2901 | static void |
0403641f RS |
2902 | where_is_internal_2 (args, key, binding) |
2903 | Lisp_Object args, key, binding; | |
2904 | { | |
49801145 | 2905 | Lisp_Object definition, noindirect, this, last; |
0403641f RS |
2906 | Lisp_Object result, sequence; |
2907 | int nomenus, last_is_meta; | |
df75b1a3 | 2908 | struct gcpro gcpro1, gcpro2, gcpro3; |
0403641f | 2909 | |
df75b1a3 | 2910 | GCPRO3 (args, key, binding); |
49801145 | 2911 | result = XCDR (XCAR (args)); |
03699b14 KR |
2912 | definition = XCAR (XCAR (XCAR (args))); |
2913 | noindirect = XCDR (XCAR (XCAR (args))); | |
03699b14 KR |
2914 | this = XCAR (XCAR (XCDR (args))); |
2915 | last = XCDR (XCAR (XCDR (args))); | |
2916 | nomenus = XFASTINT (XCAR (XCDR (XCDR (args)))); | |
2917 | last_is_meta = XFASTINT (XCDR (XCDR (XCDR (args)))); | |
0403641f | 2918 | |
49801145 | 2919 | sequence = where_is_internal_1 (binding, key, definition, noindirect, |
0403641f RS |
2920 | this, last, nomenus, last_is_meta); |
2921 | ||
2922 | if (!NILP (sequence)) | |
f3fbd155 | 2923 | XSETCDR (XCAR (args), Fcons (sequence, result)); |
df75b1a3 GM |
2924 | |
2925 | UNGCPRO; | |
0403641f RS |
2926 | } |
2927 | ||
df75b1a3 | 2928 | |
18e2d91f | 2929 | /* This function can GC because get_keyelt can. */ |
df75b1a3 | 2930 | |
0403641f | 2931 | static Lisp_Object |
49801145 | 2932 | where_is_internal_1 (binding, key, definition, noindirect, this, last, |
0403641f | 2933 | nomenus, last_is_meta) |
49801145 | 2934 | Lisp_Object binding, key, definition, noindirect, this, last; |
0403641f RS |
2935 | int nomenus, last_is_meta; |
2936 | { | |
2937 | Lisp_Object sequence; | |
0403641f RS |
2938 | |
2939 | /* Search through indirections unless that's not wanted. */ | |
2940 | if (NILP (noindirect)) | |
35810b6f | 2941 | binding = get_keyelt (binding, 0); |
0403641f RS |
2942 | |
2943 | /* End this iteration if this element does not match | |
2944 | the target. */ | |
2945 | ||
1e7d1ab0 SM |
2946 | if (!(!NILP (where_is_cache) /* everything "matches" during cache-fill. */ |
2947 | || EQ (binding, definition) | |
2948 | || (CONSP (definition) && !NILP (Fequal (binding, definition))))) | |
2949 | /* Doesn't match. */ | |
2950 | return Qnil; | |
0403641f | 2951 | |
1e7d1ab0 | 2952 | /* We have found a match. Construct the key sequence where we found it. */ |
0403641f RS |
2953 | if (INTEGERP (key) && last_is_meta) |
2954 | { | |
2955 | sequence = Fcopy_sequence (this); | |
2956 | Faset (sequence, last, make_number (XINT (key) | meta_modifier)); | |
2957 | } | |
2958 | else | |
2959 | sequence = append_key (this, key); | |
2960 | ||
1e7d1ab0 SM |
2961 | if (!NILP (where_is_cache)) |
2962 | { | |
2963 | Lisp_Object sequences = Fgethash (binding, where_is_cache, Qnil); | |
2964 | Fputhash (binding, Fcons (sequence, sequences), where_is_cache); | |
2965 | return Qnil; | |
2966 | } | |
2967 | else | |
2968 | return sequence; | |
0403641f | 2969 | } |
2c6f1a39 | 2970 | \f |
cc0a8174 JB |
2971 | /* describe-bindings - summarizing all the bindings in a set of keymaps. */ |
2972 | ||
54cbc3d4 | 2973 | DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings, Sdescribe_buffer_bindings, 1, 3, 0, |
335c5470 PJ |
2974 | doc: /* Insert the list of all defined keys and their definitions. |
2975 | The list is inserted in the current buffer, while the bindings are | |
2976 | looked up in BUFFER. | |
2977 | The optional argument PREFIX, if non-nil, should be a key sequence; | |
2978 | then we display only bindings that start with that prefix. | |
2979 | The optional argument MENUS, if non-nil, says to mention menu bindings. | |
2980 | \(Ordinarily these are omitted from the output.) */) | |
2981 | (buffer, prefix, menus) | |
54cbc3d4 | 2982 | Lisp_Object buffer, prefix, menus; |
2c6f1a39 | 2983 | { |
54cbc3d4 SM |
2984 | Lisp_Object outbuf, shadow; |
2985 | int nomenu = NILP (menus); | |
d7ab90a9 KH |
2986 | register Lisp_Object start1; |
2987 | struct gcpro gcpro1; | |
2c6f1a39 | 2988 | |
4726a9f1 JB |
2989 | char *alternate_heading |
2990 | = "\ | |
6cec169a RS |
2991 | Keyboard translations:\n\n\ |
2992 | You type Translation\n\ | |
2993 | -------- -----------\n"; | |
2c6f1a39 | 2994 | |
a588e041 | 2995 | shadow = Qnil; |
d7ab90a9 | 2996 | GCPRO1 (shadow); |
53c8f9fa | 2997 | |
36ca6189 | 2998 | outbuf = Fcurrent_buffer (); |
2c6f1a39 | 2999 | |
4726a9f1 | 3000 | /* Report on alternates for keys. */ |
d7bf9bf5 | 3001 | if (STRINGP (Vkeyboard_translate_table) && !NILP (prefix)) |
4726a9f1 JB |
3002 | { |
3003 | int c; | |
3141e0ab | 3004 | const unsigned char *translate = SDATA (Vkeyboard_translate_table); |
d5db4077 | 3005 | int translate_len = SCHARS (Vkeyboard_translate_table); |
4726a9f1 JB |
3006 | |
3007 | for (c = 0; c < translate_len; c++) | |
3008 | if (translate[c] != c) | |
3009 | { | |
d2d9586a | 3010 | char buf[KEY_DESCRIPTION_SIZE]; |
4726a9f1 JB |
3011 | char *bufend; |
3012 | ||
3013 | if (alternate_heading) | |
3014 | { | |
3015 | insert_string (alternate_heading); | |
3016 | alternate_heading = 0; | |
3017 | } | |
3018 | ||
f1cb0a25 | 3019 | bufend = push_key_description (translate[c], buf, 1); |
4726a9f1 JB |
3020 | insert (buf, bufend - buf); |
3021 | Findent_to (make_number (16), make_number (1)); | |
f1cb0a25 | 3022 | bufend = push_key_description (c, buf, 1); |
4726a9f1 JB |
3023 | insert (buf, bufend - buf); |
3024 | ||
3025 | insert ("\n", 1); | |
d6a31e9f KS |
3026 | |
3027 | /* Insert calls signal_after_change which may GC. */ | |
3028 | translate = SDATA (Vkeyboard_translate_table); | |
4726a9f1 JB |
3029 | } |
3030 | ||
3031 | insert ("\n", 1); | |
3032 | } | |
3033 | ||
d7bf9bf5 RS |
3034 | if (!NILP (Vkey_translation_map)) |
3035 | describe_map_tree (Vkey_translation_map, 0, Qnil, prefix, | |
b88e82fd | 3036 | "Key translations", nomenu, 1, 0, 0); |
d7bf9bf5 | 3037 | |
cc0a8174 | 3038 | |
53c8f9fa | 3039 | /* Print the (major mode) local map. */ |
36ca6189 | 3040 | start1 = Qnil; |
e784236d KH |
3041 | if (!NILP (current_kboard->Voverriding_terminal_local_map)) |
3042 | start1 = current_kboard->Voverriding_terminal_local_map; | |
3043 | else if (!NILP (Voverriding_local_map)) | |
7d92e329 | 3044 | start1 = Voverriding_local_map; |
7d92e329 | 3045 | |
265a9e55 | 3046 | if (!NILP (start1)) |
2c6f1a39 | 3047 | { |
91f64ec2 | 3048 | describe_map_tree (start1, 1, shadow, prefix, |
b88e82fd | 3049 | "\f\nOverriding Bindings", nomenu, 0, 0, 0); |
53c8f9fa | 3050 | shadow = Fcons (start1, shadow); |
2c6f1a39 | 3051 | } |
36ca6189 RS |
3052 | else |
3053 | { | |
3054 | /* Print the minor mode and major mode keymaps. */ | |
3055 | int i, nmaps; | |
3056 | Lisp_Object *modes, *maps; | |
3057 | ||
3058 | /* Temporarily switch to `buffer', so that we can get that buffer's | |
3059 | minor modes correctly. */ | |
3060 | Fset_buffer (buffer); | |
3061 | ||
3062 | nmaps = current_minor_maps (&modes, &maps); | |
3063 | Fset_buffer (outbuf); | |
3064 | ||
d1d070e3 RS |
3065 | start1 = get_local_map (BUF_PT (XBUFFER (buffer)), |
3066 | XBUFFER (buffer), Qkeymap); | |
3067 | if (!NILP (start1)) | |
3068 | { | |
3069 | describe_map_tree (start1, 1, shadow, prefix, | |
b88e82fd RS |
3070 | "\f\n`keymap' Property Bindings", nomenu, |
3071 | 0, 0, 0); | |
d1d070e3 RS |
3072 | shadow = Fcons (start1, shadow); |
3073 | } | |
3074 | ||
36ca6189 RS |
3075 | /* Print the minor mode maps. */ |
3076 | for (i = 0; i < nmaps; i++) | |
3077 | { | |
3078 | /* The title for a minor mode keymap | |
3079 | is constructed at run time. | |
3080 | We let describe_map_tree do the actual insertion | |
3081 | because it takes care of other features when doing so. */ | |
3082 | char *title, *p; | |
3083 | ||
3084 | if (!SYMBOLP (modes[i])) | |
3085 | abort(); | |
3086 | ||
d5db4077 | 3087 | p = title = (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes[i]))); |
36ca6189 RS |
3088 | *p++ = '\f'; |
3089 | *p++ = '\n'; | |
3090 | *p++ = '`'; | |
d5db4077 KR |
3091 | bcopy (SDATA (SYMBOL_NAME (modes[i])), p, |
3092 | SCHARS (SYMBOL_NAME (modes[i]))); | |
3093 | p += SCHARS (SYMBOL_NAME (modes[i])); | |
36ca6189 RS |
3094 | *p++ = '\''; |
3095 | bcopy (" Minor Mode Bindings", p, sizeof (" Minor Mode Bindings") - 1); | |
3096 | p += sizeof (" Minor Mode Bindings") - 1; | |
3097 | *p = 0; | |
3098 | ||
b88e82fd RS |
3099 | describe_map_tree (maps[i], 1, shadow, prefix, |
3100 | title, nomenu, 0, 0, 0); | |
36ca6189 RS |
3101 | shadow = Fcons (maps[i], shadow); |
3102 | } | |
3103 | ||
36ca6189 RS |
3104 | start1 = get_local_map (BUF_PT (XBUFFER (buffer)), |
3105 | XBUFFER (buffer), Qlocal_map); | |
3106 | if (!NILP (start1)) | |
3107 | { | |
3108 | if (EQ (start1, XBUFFER (buffer)->keymap)) | |
3109 | describe_map_tree (start1, 1, shadow, prefix, | |
b88e82fd | 3110 | "\f\nMajor Mode Bindings", nomenu, 0, 0, 0); |
36ca6189 RS |
3111 | else |
3112 | describe_map_tree (start1, 1, shadow, prefix, | |
d1d070e3 | 3113 | "\f\n`local-map' Property Bindings", |
b88e82fd | 3114 | nomenu, 0, 0, 0); |
36ca6189 RS |
3115 | |
3116 | shadow = Fcons (start1, shadow); | |
3117 | } | |
3118 | } | |
2c6f1a39 | 3119 | |
91f64ec2 | 3120 | describe_map_tree (current_global_map, 1, shadow, prefix, |
b88e82fd | 3121 | "\f\nGlobal Bindings", nomenu, 0, 1, 0); |
d7bf9bf5 RS |
3122 | |
3123 | /* Print the function-key-map translations under this prefix. */ | |
3124 | if (!NILP (Vfunction_key_map)) | |
3125 | describe_map_tree (Vfunction_key_map, 0, Qnil, prefix, | |
b88e82fd | 3126 | "\f\nFunction key map translations", nomenu, 1, 0, 0); |
2c6f1a39 | 3127 | |
d7ab90a9 | 3128 | UNGCPRO; |
2c6f1a39 JB |
3129 | return Qnil; |
3130 | } | |
3131 | ||
b31a4218 | 3132 | /* Insert a description of the key bindings in STARTMAP, |
2c6f1a39 JB |
3133 | followed by those of all maps reachable through STARTMAP. |
3134 | If PARTIAL is nonzero, omit certain "uninteresting" commands | |
3135 | (such as `undefined'). | |
53c8f9fa RS |
3136 | If SHADOW is non-nil, it is a list of maps; |
3137 | don't mention keys which would be shadowed by any of them. | |
3138 | PREFIX, if non-nil, says mention only keys that start with PREFIX. | |
07f15dfd | 3139 | TITLE, if not 0, is a string to insert at the beginning. |
af1d6f09 | 3140 | TITLE should not end with a colon or a newline; we supply that. |
d7bf9bf5 RS |
3141 | If NOMENU is not 0, then omit menu-bar commands. |
3142 | ||
3143 | If TRANSL is nonzero, the definitions are actually key translations | |
c2b714de RS |
3144 | so print strings and vectors differently. |
3145 | ||
3146 | If ALWAYS_TITLE is nonzero, print the title even if there are no maps | |
b88e82fd RS |
3147 | to look through. |
3148 | ||
3149 | If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW, | |
3150 | don't omit it; instead, mention it but say it is shadowed. */ | |
2c6f1a39 JB |
3151 | |
3152 | void | |
c2b714de | 3153 | describe_map_tree (startmap, partial, shadow, prefix, title, nomenu, transl, |
b88e82fd | 3154 | always_title, mention_shadow) |
53c8f9fa | 3155 | Lisp_Object startmap, shadow, prefix; |
2c6f1a39 | 3156 | int partial; |
53c8f9fa | 3157 | char *title; |
af1d6f09 | 3158 | int nomenu; |
d7bf9bf5 | 3159 | int transl; |
c2b714de | 3160 | int always_title; |
b88e82fd | 3161 | int mention_shadow; |
2c6f1a39 | 3162 | { |
e4b6f8e3 | 3163 | Lisp_Object maps, orig_maps, seen, sub_shadows; |
e3dfcd4e | 3164 | struct gcpro gcpro1, gcpro2, gcpro3; |
07f15dfd | 3165 | int something = 0; |
53c8f9fa RS |
3166 | char *key_heading |
3167 | = "\ | |
3168 | key binding\n\ | |
3169 | --- -------\n"; | |
2c6f1a39 | 3170 | |
e4b6f8e3 | 3171 | orig_maps = maps = Faccessible_keymaps (startmap, prefix); |
925083d1 | 3172 | seen = Qnil; |
e3dfcd4e KH |
3173 | sub_shadows = Qnil; |
3174 | GCPRO3 (maps, seen, sub_shadows); | |
2c6f1a39 | 3175 | |
af1d6f09 RS |
3176 | if (nomenu) |
3177 | { | |
3178 | Lisp_Object list; | |
3179 | ||
3180 | /* Delete from MAPS each element that is for the menu bar. */ | |
03699b14 | 3181 | for (list = maps; !NILP (list); list = XCDR (list)) |
af1d6f09 RS |
3182 | { |
3183 | Lisp_Object elt, prefix, tem; | |
3184 | ||
3185 | elt = Fcar (list); | |
3186 | prefix = Fcar (elt); | |
3187 | if (XVECTOR (prefix)->size >= 1) | |
3188 | { | |
3189 | tem = Faref (prefix, make_number (0)); | |
3190 | if (EQ (tem, Qmenu_bar)) | |
3191 | maps = Fdelq (elt, maps); | |
3192 | } | |
3193 | } | |
3194 | } | |
3195 | ||
c2b714de | 3196 | if (!NILP (maps) || always_title) |
53c8f9fa RS |
3197 | { |
3198 | if (title) | |
07f15dfd RS |
3199 | { |
3200 | insert_string (title); | |
3201 | if (!NILP (prefix)) | |
3202 | { | |
3203 | insert_string (" Starting With "); | |
f8d8ba40 | 3204 | insert1 (Fkey_description (prefix, Qnil)); |
07f15dfd RS |
3205 | } |
3206 | insert_string (":\n"); | |
3207 | } | |
53c8f9fa | 3208 | insert_string (key_heading); |
07f15dfd | 3209 | something = 1; |
53c8f9fa RS |
3210 | } |
3211 | ||
265a9e55 | 3212 | for (; !NILP (maps); maps = Fcdr (maps)) |
2c6f1a39 | 3213 | { |
e3dfcd4e | 3214 | register Lisp_Object elt, prefix, tail; |
53c8f9fa | 3215 | |
2c6f1a39 | 3216 | elt = Fcar (maps); |
53c8f9fa RS |
3217 | prefix = Fcar (elt); |
3218 | ||
3219 | sub_shadows = Qnil; | |
3220 | ||
03699b14 | 3221 | for (tail = shadow; CONSP (tail); tail = XCDR (tail)) |
2c6f1a39 | 3222 | { |
53c8f9fa RS |
3223 | Lisp_Object shmap; |
3224 | ||
03699b14 | 3225 | shmap = XCAR (tail); |
53c8f9fa RS |
3226 | |
3227 | /* If the sequence by which we reach this keymap is zero-length, | |
3228 | then the shadow map for this keymap is just SHADOW. */ | |
d5db4077 | 3229 | if ((STRINGP (prefix) && SCHARS (prefix) == 0) |
416349ec | 3230 | || (VECTORP (prefix) && XVECTOR (prefix)->size == 0)) |
53c8f9fa RS |
3231 | ; |
3232 | /* If the sequence by which we reach this keymap actually has | |
3233 | some elements, then the sequence's definition in SHADOW is | |
3234 | what we should use. */ | |
3235 | else | |
3236 | { | |
98234407 | 3237 | shmap = Flookup_key (shmap, Fcar (elt), Qt); |
416349ec | 3238 | if (INTEGERP (shmap)) |
53c8f9fa RS |
3239 | shmap = Qnil; |
3240 | } | |
3241 | ||
3242 | /* If shmap is not nil and not a keymap, | |
3243 | it completely shadows this map, so don't | |
3244 | describe this map at all. */ | |
02067692 | 3245 | if (!NILP (shmap) && !KEYMAPP (shmap)) |
53c8f9fa RS |
3246 | goto skip; |
3247 | ||
3248 | if (!NILP (shmap)) | |
3249 | sub_shadows = Fcons (shmap, sub_shadows); | |
2c6f1a39 JB |
3250 | } |
3251 | ||
e4b6f8e3 | 3252 | /* Maps we have already listed in this loop shadow this map. */ |
54cbc3d4 | 3253 | for (tail = orig_maps; !EQ (tail, maps); tail = XCDR (tail)) |
e4b6f8e3 RS |
3254 | { |
3255 | Lisp_Object tem; | |
3256 | tem = Fequal (Fcar (XCAR (tail)), prefix); | |
54cbc3d4 | 3257 | if (!NILP (tem)) |
e4b6f8e3 RS |
3258 | sub_shadows = Fcons (XCDR (XCAR (tail)), sub_shadows); |
3259 | } | |
3260 | ||
3261 | describe_map (Fcdr (elt), prefix, | |
d7bf9bf5 | 3262 | transl ? describe_translation : describe_command, |
b88e82fd | 3263 | partial, sub_shadows, &seen, nomenu, mention_shadow); |
53c8f9fa RS |
3264 | |
3265 | skip: ; | |
2c6f1a39 JB |
3266 | } |
3267 | ||
07f15dfd RS |
3268 | if (something) |
3269 | insert_string ("\n"); | |
3270 | ||
2c6f1a39 JB |
3271 | UNGCPRO; |
3272 | } | |
3273 | ||
c3f27064 KH |
3274 | static int previous_description_column; |
3275 | ||
2c6f1a39 | 3276 | static void |
d55627cc SM |
3277 | describe_command (definition, args) |
3278 | Lisp_Object definition, args; | |
2c6f1a39 JB |
3279 | { |
3280 | register Lisp_Object tem1; | |
744cd66b | 3281 | int column = (int) current_column (); /* iftc */ |
c3f27064 | 3282 | int description_column; |
2c6f1a39 | 3283 | |
c3f27064 KH |
3284 | /* If column 16 is no good, go to col 32; |
3285 | but don't push beyond that--go to next line instead. */ | |
3286 | if (column > 30) | |
3287 | { | |
3288 | insert_char ('\n'); | |
3289 | description_column = 32; | |
3290 | } | |
3291 | else if (column > 14 || (column > 10 && previous_description_column == 32)) | |
3292 | description_column = 32; | |
3293 | else | |
3294 | description_column = 16; | |
3295 | ||
3296 | Findent_to (make_number (description_column), make_number (1)); | |
3297 | previous_description_column = description_column; | |
2c6f1a39 | 3298 | |
416349ec | 3299 | if (SYMBOLP (definition)) |
2c6f1a39 | 3300 | { |
c85d524c | 3301 | tem1 = SYMBOL_NAME (definition); |
2c6f1a39 | 3302 | insert1 (tem1); |
055234ef | 3303 | insert_string ("\n"); |
2c6f1a39 | 3304 | } |
d7bf9bf5 | 3305 | else if (STRINGP (definition) || VECTORP (definition)) |
24065b9c | 3306 | insert_string ("Keyboard Macro\n"); |
02067692 SM |
3307 | else if (KEYMAPP (definition)) |
3308 | insert_string ("Prefix Command\n"); | |
2c6f1a39 | 3309 | else |
02067692 | 3310 | insert_string ("??\n"); |
2c6f1a39 JB |
3311 | } |
3312 | ||
d7bf9bf5 | 3313 | static void |
d55627cc SM |
3314 | describe_translation (definition, args) |
3315 | Lisp_Object definition, args; | |
d7bf9bf5 RS |
3316 | { |
3317 | register Lisp_Object tem1; | |
3318 | ||
3319 | Findent_to (make_number (16), make_number (1)); | |
3320 | ||
3321 | if (SYMBOLP (definition)) | |
3322 | { | |
c85d524c | 3323 | tem1 = SYMBOL_NAME (definition); |
d7bf9bf5 RS |
3324 | insert1 (tem1); |
3325 | insert_string ("\n"); | |
3326 | } | |
3327 | else if (STRINGP (definition) || VECTORP (definition)) | |
b902ac28 | 3328 | { |
f8d8ba40 | 3329 | insert1 (Fkey_description (definition, Qnil)); |
b902ac28 RS |
3330 | insert_string ("\n"); |
3331 | } | |
02067692 SM |
3332 | else if (KEYMAPP (definition)) |
3333 | insert_string ("Prefix Command\n"); | |
d7bf9bf5 | 3334 | else |
02067692 | 3335 | insert_string ("??\n"); |
d7bf9bf5 RS |
3336 | } |
3337 | ||
c36238ee RS |
3338 | /* describe_map puts all the usable elements of a sparse keymap |
3339 | into an array of `struct describe_map_elt', | |
3340 | then sorts them by the events. */ | |
3341 | ||
3342 | struct describe_map_elt { Lisp_Object event; Lisp_Object definition; int shadowed; }; | |
3343 | ||
3344 | /* qsort comparison function for sorting `struct describe_map_elt' by | |
3345 | the event field. */ | |
3346 | ||
3347 | static int | |
3348 | describe_map_compare (aa, bb) | |
3349 | const void *aa, *bb; | |
3350 | { | |
3351 | const struct describe_map_elt *a = aa, *b = bb; | |
3352 | if (INTEGERP (a->event) && INTEGERP (b->event)) | |
3353 | return ((XINT (a->event) > XINT (b->event)) | |
3354 | - (XINT (a->event) < XINT (b->event))); | |
3355 | if (!INTEGERP (a->event) && INTEGERP (b->event)) | |
3356 | return 1; | |
3357 | if (INTEGERP (a->event) && !INTEGERP (b->event)) | |
3358 | return -1; | |
3359 | if (SYMBOLP (a->event) && SYMBOLP (b->event)) | |
ccf0250b SM |
3360 | return (!NILP (Fstring_lessp (a->event, b->event)) ? -1 |
3361 | : !NILP (Fstring_lessp (b->event, a->event)) ? 1 | |
c36238ee RS |
3362 | : 0); |
3363 | return 0; | |
3364 | } | |
3365 | ||
c3c0ee93 | 3366 | /* Describe the contents of map MAP, assuming that this map itself is |
f8d8ba40 | 3367 | reached by the sequence of prefix keys PREFIX (a string or vector). |
279a482a | 3368 | PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */ |
2c6f1a39 JB |
3369 | |
3370 | static void | |
b88e82fd RS |
3371 | describe_map (map, prefix, elt_describer, partial, shadow, |
3372 | seen, nomenu, mention_shadow) | |
c3c0ee93 | 3373 | register Lisp_Object map; |
f8d8ba40 | 3374 | Lisp_Object prefix; |
d55627cc | 3375 | void (*elt_describer) P_ ((Lisp_Object, Lisp_Object)); |
2c6f1a39 JB |
3376 | int partial; |
3377 | Lisp_Object shadow; | |
925083d1 | 3378 | Lisp_Object *seen; |
279a482a | 3379 | int nomenu; |
b88e82fd | 3380 | int mention_shadow; |
2c6f1a39 | 3381 | { |
53c8f9fa | 3382 | Lisp_Object tail, definition, event; |
99a225a9 | 3383 | Lisp_Object tem; |
2c6f1a39 JB |
3384 | Lisp_Object suppress; |
3385 | Lisp_Object kludge; | |
3386 | int first = 1; | |
3387 | struct gcpro gcpro1, gcpro2, gcpro3; | |
3388 | ||
c36238ee RS |
3389 | /* These accumulate the values from sparse keymap bindings, |
3390 | so we can sort them and handle them in order. */ | |
3391 | int length_needed = 0; | |
3392 | struct describe_map_elt *vect; | |
3393 | int slots_used = 0; | |
3394 | int i; | |
3395 | ||
6bbd7a29 GM |
3396 | suppress = Qnil; |
3397 | ||
2c6f1a39 JB |
3398 | if (partial) |
3399 | suppress = intern ("suppress-keymap"); | |
3400 | ||
3401 | /* This vector gets used to present single keys to Flookup_key. Since | |
f5b79c1c | 3402 | that is done once per keymap element, we don't want to cons up a |
2c6f1a39 JB |
3403 | fresh vector every time. */ |
3404 | kludge = Fmake_vector (make_number (1), Qnil); | |
99a225a9 | 3405 | definition = Qnil; |
2c6f1a39 | 3406 | |
c36238ee RS |
3407 | for (tail = map; CONSP (tail); tail = XCDR (tail)) |
3408 | length_needed++; | |
3409 | ||
3410 | vect = ((struct describe_map_elt *) | |
3411 | alloca (sizeof (struct describe_map_elt) * length_needed)); | |
3412 | ||
f8d8ba40 | 3413 | GCPRO3 (prefix, definition, kludge); |
2c6f1a39 | 3414 | |
03699b14 | 3415 | for (tail = map; CONSP (tail); tail = XCDR (tail)) |
2c6f1a39 JB |
3416 | { |
3417 | QUIT; | |
2c6f1a39 | 3418 | |
03699b14 KR |
3419 | if (VECTORP (XCAR (tail)) |
3420 | || CHAR_TABLE_P (XCAR (tail))) | |
3421 | describe_vector (XCAR (tail), | |
f8d8ba40 | 3422 | prefix, Qnil, elt_describer, partial, shadow, map, |
b88e82fd | 3423 | (int *)0, 0, 1, mention_shadow); |
03699b14 | 3424 | else if (CONSP (XCAR (tail))) |
2c6f1a39 | 3425 | { |
b88e82fd | 3426 | int this_shadowed = 0; |
c36238ee | 3427 | |
03699b14 | 3428 | event = XCAR (XCAR (tail)); |
2c3b35b0 | 3429 | |
f8d8ba40 | 3430 | /* Ignore bindings whose "prefix" are not really valid events. |
2c3b35b0 | 3431 | (We get these in the frames and buffers menu.) */ |
54cbc3d4 | 3432 | if (!(SYMBOLP (event) || INTEGERP (event))) |
c96dcc01 | 3433 | continue; |
2c3b35b0 | 3434 | |
279a482a KH |
3435 | if (nomenu && EQ (event, Qmenu_bar)) |
3436 | continue; | |
3437 | ||
03699b14 | 3438 | definition = get_keyelt (XCDR (XCAR (tail)), 0); |
2c6f1a39 | 3439 | |
f5b79c1c | 3440 | /* Don't show undefined commands or suppressed commands. */ |
99a225a9 | 3441 | if (NILP (definition)) continue; |
416349ec | 3442 | if (SYMBOLP (definition) && partial) |
f5b79c1c | 3443 | { |
99a225a9 RS |
3444 | tem = Fget (definition, suppress); |
3445 | if (!NILP (tem)) | |
f5b79c1c JB |
3446 | continue; |
3447 | } | |
2c6f1a39 | 3448 | |
f5b79c1c JB |
3449 | /* Don't show a command that isn't really visible |
3450 | because a local definition of the same key shadows it. */ | |
2c6f1a39 | 3451 | |
49801145 | 3452 | ASET (kludge, 0, event); |
f5b79c1c JB |
3453 | if (!NILP (shadow)) |
3454 | { | |
53c8f9fa | 3455 | tem = shadow_lookup (shadow, kludge, Qt); |
b88e82fd RS |
3456 | if (!NILP (tem)) |
3457 | { | |
d3ee989e CY |
3458 | /* Avoid generating duplicate entries if the |
3459 | shadowed binding has the same definition. */ | |
3460 | if (mention_shadow && !EQ (tem, definition)) | |
b88e82fd RS |
3461 | this_shadowed = 1; |
3462 | else | |
3463 | continue; | |
3464 | } | |
f5b79c1c JB |
3465 | } |
3466 | ||
c3c0ee93 | 3467 | tem = Flookup_key (map, kludge, Qt); |
54cbc3d4 | 3468 | if (!EQ (tem, definition)) continue; |
99a225a9 | 3469 | |
c36238ee RS |
3470 | vect[slots_used].event = event; |
3471 | vect[slots_used].definition = definition; | |
3472 | vect[slots_used].shadowed = this_shadowed; | |
3473 | slots_used++; | |
f5b79c1c | 3474 | } |
03699b14 | 3475 | else if (EQ (XCAR (tail), Qkeymap)) |
925083d1 KH |
3476 | { |
3477 | /* The same keymap might be in the structure twice, if we're | |
3478 | using an inherited keymap. So skip anything we've already | |
3479 | encountered. */ | |
3480 | tem = Fassq (tail, *seen); | |
f8d8ba40 | 3481 | if (CONSP (tem) && !NILP (Fequal (XCAR (tem), prefix))) |
925083d1 | 3482 | break; |
f8d8ba40 | 3483 | *seen = Fcons (Fcons (tail, prefix), *seen); |
925083d1 | 3484 | } |
2c6f1a39 JB |
3485 | } |
3486 | ||
c36238ee RS |
3487 | /* If we found some sparse map events, sort them. */ |
3488 | ||
3489 | qsort (vect, slots_used, sizeof (struct describe_map_elt), | |
3490 | describe_map_compare); | |
3491 | ||
3492 | /* Now output them in sorted order. */ | |
3493 | ||
3494 | for (i = 0; i < slots_used; i++) | |
3495 | { | |
3496 | Lisp_Object start, end; | |
3497 | ||
3498 | if (first) | |
3499 | { | |
3500 | previous_description_column = 0; | |
3501 | insert ("\n", 1); | |
3502 | first = 0; | |
3503 | } | |
3504 | ||
3505 | ASET (kludge, 0, vect[i].event); | |
3506 | start = vect[i].event; | |
3507 | end = start; | |
3508 | ||
3509 | definition = vect[i].definition; | |
3510 | ||
3511 | /* Find consecutive chars that are identically defined. */ | |
3512 | if (INTEGERP (vect[i].event)) | |
3513 | { | |
3514 | while (i + 1 < slots_used | |
15fdcac7 | 3515 | && EQ (vect[i+1].event, make_number (XINT (vect[i].event) + 1)) |
c36238ee RS |
3516 | && !NILP (Fequal (vect[i + 1].definition, definition)) |
3517 | && vect[i].shadowed == vect[i + 1].shadowed) | |
3518 | i++; | |
3519 | end = vect[i].event; | |
3520 | } | |
3521 | ||
3522 | /* Now START .. END is the range to describe next. */ | |
3523 | ||
3524 | /* Insert the string to describe the event START. */ | |
3525 | insert1 (Fkey_description (kludge, prefix)); | |
3526 | ||
3527 | if (!EQ (start, end)) | |
3528 | { | |
3529 | insert (" .. ", 4); | |
3530 | ||
3531 | ASET (kludge, 0, end); | |
3532 | /* Insert the string to describe the character END. */ | |
3533 | insert1 (Fkey_description (kludge, prefix)); | |
3534 | } | |
3535 | ||
3536 | /* Print a description of the definition of this character. | |
3537 | elt_describer will take care of spacing out far enough | |
3538 | for alignment purposes. */ | |
3539 | (*elt_describer) (vect[i].definition, Qnil); | |
3540 | ||
3541 | if (vect[i].shadowed) | |
3542 | { | |
3543 | SET_PT (PT - 1); | |
5615dcc0 | 3544 | insert_string ("\n (that binding is currently shadowed by another mode)"); |
c36238ee RS |
3545 | SET_PT (PT + 1); |
3546 | } | |
3547 | } | |
3548 | ||
2c6f1a39 JB |
3549 | UNGCPRO; |
3550 | } | |
3551 | ||
69248761 | 3552 | static void |
d55627cc SM |
3553 | describe_vector_princ (elt, fun) |
3554 | Lisp_Object elt, fun; | |
2c6f1a39 | 3555 | { |
81fa9e2f | 3556 | Findent_to (make_number (16), make_number (1)); |
d55627cc | 3557 | call1 (fun, elt); |
ad4ec84a | 3558 | Fterpri (Qnil); |
2c6f1a39 JB |
3559 | } |
3560 | ||
d55627cc | 3561 | DEFUN ("describe-vector", Fdescribe_vector, Sdescribe_vector, 1, 2, 0, |
335c5470 | 3562 | doc: /* Insert a description of contents of VECTOR. |
23715ea6 JB |
3563 | This is text showing the elements of vector matched against indices. |
3564 | DESCRIBER is the output function used; nil means use `princ'. */) | |
d55627cc SM |
3565 | (vector, describer) |
3566 | Lisp_Object vector, describer; | |
2c6f1a39 | 3567 | { |
aed13378 | 3568 | int count = SPECPDL_INDEX (); |
d55627cc SM |
3569 | if (NILP (describer)) |
3570 | describer = intern ("princ"); | |
ad4ec84a | 3571 | specbind (Qstandard_output, Fcurrent_buffer ()); |
b7826503 | 3572 | CHECK_VECTOR_OR_CHAR_TABLE (vector); |
d55627cc | 3573 | describe_vector (vector, Qnil, describer, describe_vector_princ, 0, |
b88e82fd | 3574 | Qnil, Qnil, (int *)0, 0, 0, 0); |
ad4ec84a RS |
3575 | |
3576 | return unbind_to (count, Qnil); | |
2c6f1a39 JB |
3577 | } |
3578 | ||
352e5dea RS |
3579 | /* Insert in the current buffer a description of the contents of VECTOR. |
3580 | We call ELT_DESCRIBER to insert the description of one value found | |
3581 | in VECTOR. | |
3582 | ||
3583 | ELT_PREFIX describes what "comes before" the keys or indices defined | |
0403641f RS |
3584 | by this vector. This is a human-readable string whose size |
3585 | is not necessarily related to the situation. | |
352e5dea RS |
3586 | |
3587 | If the vector is in a keymap, ELT_PREFIX is a prefix key which | |
3588 | leads to this keymap. | |
3589 | ||
3590 | If the vector is a chartable, ELT_PREFIX is the vector | |
3591 | of bytes that lead to the character set or portion of a character | |
3592 | set described by this chartable. | |
3593 | ||
3594 | If PARTIAL is nonzero, it means do not mention suppressed commands | |
3595 | (that assumes the vector is in a keymap). | |
3596 | ||
3597 | SHADOW is a list of keymaps that shadow this map. | |
3598 | If it is non-nil, then we look up the key in those maps | |
3599 | and we don't mention it now if it is defined by any of them. | |
3600 | ||
3601 | ENTIRE_MAP is the keymap in which this vector appears. | |
3602 | If the definition in effect in the whole map does not match | |
0403641f RS |
3603 | the one in this vector, we ignore this one. |
3604 | ||
3605 | When describing a sub-char-table, INDICES is a list of | |
3606 | indices at higher levels in this char-table, | |
d55627cc SM |
3607 | and CHAR_TABLE_DEPTH says how many levels down we have gone. |
3608 | ||
f8d8ba40 KS |
3609 | KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-. |
3610 | ||
d55627cc | 3611 | ARGS is simply passed as the second argument to ELT_DESCRIBER. */ |
352e5dea | 3612 | |
f8d8ba40 KS |
3613 | static void |
3614 | describe_vector (vector, prefix, args, elt_describer, | |
0403641f | 3615 | partial, shadow, entire_map, |
b88e82fd RS |
3616 | indices, char_table_depth, keymap_p, |
3617 | mention_shadow) | |
2c6f1a39 | 3618 | register Lisp_Object vector; |
f8d8ba40 | 3619 | Lisp_Object prefix, args; |
d55627cc | 3620 | void (*elt_describer) P_ ((Lisp_Object, Lisp_Object)); |
2c6f1a39 JB |
3621 | int partial; |
3622 | Lisp_Object shadow; | |
32bfcae1 | 3623 | Lisp_Object entire_map; |
0403641f RS |
3624 | int *indices; |
3625 | int char_table_depth; | |
f8d8ba40 | 3626 | int keymap_p; |
b88e82fd | 3627 | int mention_shadow; |
2c6f1a39 | 3628 | { |
32bfcae1 KH |
3629 | Lisp_Object definition; |
3630 | Lisp_Object tem2; | |
f8d8ba40 | 3631 | Lisp_Object elt_prefix = Qnil; |
2c6f1a39 JB |
3632 | register int i; |
3633 | Lisp_Object suppress; | |
3634 | Lisp_Object kludge; | |
3635 | int first = 1; | |
f8d8ba40 | 3636 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; |
a98f1d1d KH |
3637 | /* Range of elements to be handled. */ |
3638 | int from, to; | |
a98f1d1d KH |
3639 | /* A flag to tell if a leaf in this level of char-table is not a |
3640 | generic character (i.e. a complete multibyte character). */ | |
3641 | int complete_char; | |
0403641f RS |
3642 | int character; |
3643 | int starting_i; | |
3644 | ||
6bbd7a29 GM |
3645 | suppress = Qnil; |
3646 | ||
0403641f | 3647 | if (indices == 0) |
2e34157c | 3648 | indices = (int *) alloca (3 * sizeof (int)); |
2c6f1a39 | 3649 | |
32bfcae1 | 3650 | definition = Qnil; |
2c6f1a39 | 3651 | |
f8d8ba40 KS |
3652 | if (!keymap_p) |
3653 | { | |
3654 | /* Call Fkey_description first, to avoid GC bug for the other string. */ | |
3655 | if (!NILP (prefix) && XFASTINT (Flength (prefix)) > 0) | |
3656 | { | |
3657 | Lisp_Object tem; | |
3658 | tem = Fkey_description (prefix, Qnil); | |
3659 | elt_prefix = concat2 (tem, build_string (" ")); | |
3660 | } | |
3661 | prefix = Qnil; | |
3662 | } | |
3663 | ||
2c6f1a39 JB |
3664 | /* This vector gets used to present single keys to Flookup_key. Since |
3665 | that is done once per vector element, we don't want to cons up a | |
3666 | fresh vector every time. */ | |
3667 | kludge = Fmake_vector (make_number (1), Qnil); | |
f8d8ba40 | 3668 | GCPRO4 (elt_prefix, prefix, definition, kludge); |
2c6f1a39 JB |
3669 | |
3670 | if (partial) | |
3671 | suppress = intern ("suppress-keymap"); | |
3672 | ||
a98f1d1d KH |
3673 | if (CHAR_TABLE_P (vector)) |
3674 | { | |
0403641f | 3675 | if (char_table_depth == 0) |
a98f1d1d | 3676 | { |
a1942d88 | 3677 | /* VECTOR is a top level char-table. */ |
0403641f | 3678 | complete_char = 1; |
a98f1d1d KH |
3679 | from = 0; |
3680 | to = CHAR_TABLE_ORDINARY_SLOTS; | |
3681 | } | |
3682 | else | |
3683 | { | |
a1942d88 | 3684 | /* VECTOR is a sub char-table. */ |
0403641f RS |
3685 | if (char_table_depth >= 3) |
3686 | /* A char-table is never that deep. */ | |
a1942d88 | 3687 | error ("Too deep char table"); |
a98f1d1d | 3688 | |
a98f1d1d | 3689 | complete_char |
0403641f RS |
3690 | = (CHARSET_VALID_P (indices[0]) |
3691 | && ((CHARSET_DIMENSION (indices[0]) == 1 | |
3692 | && char_table_depth == 1) | |
3693 | || char_table_depth == 2)); | |
a98f1d1d KH |
3694 | |
3695 | /* Meaningful elements are from 32th to 127th. */ | |
3696 | from = 32; | |
a1942d88 | 3697 | to = SUB_CHAR_TABLE_ORDINARY_SLOTS; |
a98f1d1d | 3698 | } |
a98f1d1d KH |
3699 | } |
3700 | else | |
3701 | { | |
a98f1d1d | 3702 | /* This does the right thing for ordinary vectors. */ |
0403641f RS |
3703 | |
3704 | complete_char = 1; | |
3705 | from = 0; | |
3706 | to = XVECTOR (vector)->size; | |
a98f1d1d | 3707 | } |
b5585f5c | 3708 | |
a98f1d1d | 3709 | for (i = from; i < to; i++) |
2c6f1a39 | 3710 | { |
b88e82fd | 3711 | int this_shadowed = 0; |
2c6f1a39 | 3712 | QUIT; |
2c6f1a39 | 3713 | |
a1942d88 KH |
3714 | if (CHAR_TABLE_P (vector)) |
3715 | { | |
0403641f RS |
3716 | if (char_table_depth == 0 && i >= CHAR_TABLE_SINGLE_BYTE_SLOTS) |
3717 | complete_char = 0; | |
3718 | ||
a1942d88 KH |
3719 | if (i >= CHAR_TABLE_SINGLE_BYTE_SLOTS |
3720 | && !CHARSET_DEFINED_P (i - 128)) | |
3721 | continue; | |
0403641f RS |
3722 | |
3723 | definition | |
3724 | = get_keyelt (XCHAR_TABLE (vector)->contents[i], 0); | |
a1942d88 KH |
3725 | } |
3726 | else | |
49801145 | 3727 | definition = get_keyelt (AREF (vector, i), 0); |
2c6f1a39 | 3728 | |
d55627cc | 3729 | if (NILP (definition)) continue; |
cc3e6465 | 3730 | |
2c6f1a39 | 3731 | /* Don't mention suppressed commands. */ |
32bfcae1 | 3732 | if (SYMBOLP (definition) && partial) |
2c6f1a39 | 3733 | { |
a98f1d1d KH |
3734 | Lisp_Object tem; |
3735 | ||
3736 | tem = Fget (definition, suppress); | |
3737 | ||
3738 | if (!NILP (tem)) continue; | |
2c6f1a39 JB |
3739 | } |
3740 | ||
0403641f RS |
3741 | /* Set CHARACTER to the character this entry describes, if any. |
3742 | Also update *INDICES. */ | |
3743 | if (CHAR_TABLE_P (vector)) | |
3744 | { | |
3745 | indices[char_table_depth] = i; | |
3746 | ||
3747 | if (char_table_depth == 0) | |
3748 | { | |
3749 | character = i; | |
3750 | indices[0] = i - 128; | |
3751 | } | |
3752 | else if (complete_char) | |
3753 | { | |
54e03a4a | 3754 | character = MAKE_CHAR (indices[0], indices[1], indices[2]); |
0403641f RS |
3755 | } |
3756 | else | |
3757 | character = 0; | |
3758 | } | |
3759 | else | |
3760 | character = i; | |
3761 | ||
f8d8ba40 KS |
3762 | ASET (kludge, 0, make_number (character)); |
3763 | ||
32bfcae1 | 3764 | /* If this binding is shadowed by some other map, ignore it. */ |
0403641f | 3765 | if (!NILP (shadow) && complete_char) |
2c6f1a39 JB |
3766 | { |
3767 | Lisp_Object tem; | |
31bea176 | 3768 | |
53c8f9fa | 3769 | tem = shadow_lookup (shadow, kludge, Qt); |
2c6f1a39 | 3770 | |
b88e82fd RS |
3771 | if (!NILP (tem)) |
3772 | { | |
3773 | if (mention_shadow) | |
3774 | this_shadowed = 1; | |
3775 | else | |
3776 | continue; | |
3777 | } | |
2c6f1a39 JB |
3778 | } |
3779 | ||
32bfcae1 KH |
3780 | /* Ignore this definition if it is shadowed by an earlier |
3781 | one in the same keymap. */ | |
0403641f | 3782 | if (!NILP (entire_map) && complete_char) |
32bfcae1 KH |
3783 | { |
3784 | Lisp_Object tem; | |
3785 | ||
32bfcae1 KH |
3786 | tem = Flookup_key (entire_map, kludge, Qt); |
3787 | ||
54cbc3d4 | 3788 | if (!EQ (tem, definition)) |
32bfcae1 KH |
3789 | continue; |
3790 | } | |
3791 | ||
2c6f1a39 JB |
3792 | if (first) |
3793 | { | |
0403641f | 3794 | if (char_table_depth == 0) |
a98f1d1d | 3795 | insert ("\n", 1); |
2c6f1a39 JB |
3796 | first = 0; |
3797 | } | |
3798 | ||
0403641f RS |
3799 | /* For a sub char-table, show the depth by indentation. |
3800 | CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */ | |
3801 | if (char_table_depth > 0) | |
3802 | insert (" ", char_table_depth * 2); /* depth is 1 or 2. */ | |
a98f1d1d | 3803 | |
0403641f RS |
3804 | /* Output the prefix that applies to every entry in this map. */ |
3805 | if (!NILP (elt_prefix)) | |
3806 | insert1 (elt_prefix); | |
a98f1d1d | 3807 | |
0403641f RS |
3808 | /* Insert or describe the character this slot is for, |
3809 | or a description of what it is for. */ | |
3810 | if (SUB_CHAR_TABLE_P (vector)) | |
a1942d88 | 3811 | { |
0403641f RS |
3812 | if (complete_char) |
3813 | insert_char (character); | |
3814 | else | |
3815 | { | |
3816 | /* We need an octal representation for this block of | |
3817 | characters. */ | |
542d7fd2 RS |
3818 | char work[16]; |
3819 | sprintf (work, "(row %d)", i); | |
3820 | insert (work, strlen (work)); | |
0403641f RS |
3821 | } |
3822 | } | |
3823 | else if (CHAR_TABLE_P (vector)) | |
3824 | { | |
3825 | if (complete_char) | |
f8d8ba40 | 3826 | insert1 (Fkey_description (kludge, prefix)); |
a1942d88 KH |
3827 | else |
3828 | { | |
3829 | /* Print the information for this character set. */ | |
3830 | insert_string ("<"); | |
3831 | tem2 = CHARSET_TABLE_INFO (i - 128, CHARSET_SHORT_NAME_IDX); | |
3832 | if (STRINGP (tem2)) | |
d5db4077 KR |
3833 | insert_from_string (tem2, 0, 0, SCHARS (tem2), |
3834 | SBYTES (tem2), 0); | |
a1942d88 KH |
3835 | else |
3836 | insert ("?", 1); | |
3837 | insert (">", 1); | |
3838 | } | |
3839 | } | |
352e5dea RS |
3840 | else |
3841 | { | |
f8d8ba40 | 3842 | insert1 (Fkey_description (kludge, prefix)); |
a98f1d1d | 3843 | } |
352e5dea | 3844 | |
a1942d88 | 3845 | /* If we find a sub char-table within a char-table, |
a98f1d1d KH |
3846 | scan it recursively; it defines the details for |
3847 | a character set or a portion of a character set. */ | |
f3ba5409 | 3848 | if (CHAR_TABLE_P (vector) && SUB_CHAR_TABLE_P (definition)) |
a98f1d1d | 3849 | { |
a98f1d1d | 3850 | insert ("\n", 1); |
f8d8ba40 | 3851 | describe_vector (definition, prefix, args, elt_describer, |
0403641f | 3852 | partial, shadow, entire_map, |
b88e82fd RS |
3853 | indices, char_table_depth + 1, keymap_p, |
3854 | mention_shadow); | |
a98f1d1d | 3855 | continue; |
352e5dea | 3856 | } |
2c6f1a39 | 3857 | |
0403641f RS |
3858 | starting_i = i; |
3859 | ||
542d7fd2 | 3860 | /* Find all consecutive characters or rows that have the same |
a1942d88 KH |
3861 | definition. But, for elements of a top level char table, if |
3862 | they are for charsets, we had better describe one by one even | |
3863 | if they have the same definition. */ | |
3864 | if (CHAR_TABLE_P (vector)) | |
3865 | { | |
0403641f RS |
3866 | int limit = to; |
3867 | ||
3868 | if (char_table_depth == 0) | |
3869 | limit = CHAR_TABLE_SINGLE_BYTE_SLOTS; | |
3870 | ||
3871 | while (i + 1 < limit | |
3872 | && (tem2 = get_keyelt (XCHAR_TABLE (vector)->contents[i + 1], 0), | |
3873 | !NILP (tem2)) | |
3874 | && !NILP (Fequal (tem2, definition))) | |
3875 | i++; | |
a1942d88 KH |
3876 | } |
3877 | else | |
0403641f | 3878 | while (i + 1 < to |
49801145 | 3879 | && (tem2 = get_keyelt (AREF (vector, i + 1), 0), |
a1942d88 KH |
3880 | !NILP (tem2)) |
3881 | && !NILP (Fequal (tem2, definition))) | |
3882 | i++; | |
31bea176 | 3883 | |
2c6f1a39 JB |
3884 | |
3885 | /* If we have a range of more than one character, | |
3886 | print where the range reaches to. */ | |
3887 | ||
0403641f | 3888 | if (i != starting_i) |
2c6f1a39 JB |
3889 | { |
3890 | insert (" .. ", 4); | |
0403641f | 3891 | |
f8d8ba40 KS |
3892 | ASET (kludge, 0, make_number (i)); |
3893 | ||
0403641f RS |
3894 | if (!NILP (elt_prefix)) |
3895 | insert1 (elt_prefix); | |
3896 | ||
352e5dea RS |
3897 | if (CHAR_TABLE_P (vector)) |
3898 | { | |
0403641f | 3899 | if (char_table_depth == 0) |
a98f1d1d | 3900 | { |
f8d8ba40 | 3901 | insert1 (Fkey_description (kludge, prefix)); |
a98f1d1d | 3902 | } |
0403641f | 3903 | else if (complete_char) |
352e5dea | 3904 | { |
0403641f | 3905 | indices[char_table_depth] = i; |
54e03a4a | 3906 | character = MAKE_CHAR (indices[0], indices[1], indices[2]); |
0403641f | 3907 | insert_char (character); |
352e5dea RS |
3908 | } |
3909 | else | |
3910 | { | |
542d7fd2 RS |
3911 | /* We need an octal representation for this block of |
3912 | characters. */ | |
3913 | char work[16]; | |
3914 | sprintf (work, "(row %d)", i); | |
3915 | insert (work, strlen (work)); | |
352e5dea RS |
3916 | } |
3917 | } | |
3918 | else | |
3919 | { | |
f8d8ba40 | 3920 | insert1 (Fkey_description (kludge, prefix)); |
352e5dea | 3921 | } |
2c6f1a39 JB |
3922 | } |
3923 | ||
3924 | /* Print a description of the definition of this character. | |
3925 | elt_describer will take care of spacing out far enough | |
3926 | for alignment purposes. */ | |
d55627cc | 3927 | (*elt_describer) (definition, args); |
b88e82fd RS |
3928 | |
3929 | if (this_shadowed) | |
3930 | { | |
3931 | SET_PT (PT - 1); | |
3932 | insert_string (" (binding currently shadowed)"); | |
3933 | SET_PT (PT + 1); | |
3934 | } | |
2c6f1a39 JB |
3935 | } |
3936 | ||
a1942d88 | 3937 | /* For (sub) char-table, print `defalt' slot at last. */ |
a98f1d1d KH |
3938 | if (CHAR_TABLE_P (vector) && !NILP (XCHAR_TABLE (vector)->defalt)) |
3939 | { | |
0403641f | 3940 | insert (" ", char_table_depth * 2); |
a98f1d1d | 3941 | insert_string ("<<default>>"); |
d55627cc | 3942 | (*elt_describer) (XCHAR_TABLE (vector)->defalt, args); |
a98f1d1d KH |
3943 | } |
3944 | ||
2c6f1a39 JB |
3945 | UNGCPRO; |
3946 | } | |
3947 | \f | |
cc0a8174 | 3948 | /* Apropos - finding all symbols whose names match a regexp. */ |
5d55ffd0 RS |
3949 | static Lisp_Object apropos_predicate; |
3950 | static Lisp_Object apropos_accumulate; | |
2c6f1a39 JB |
3951 | |
3952 | static void | |
3953 | apropos_accum (symbol, string) | |
3954 | Lisp_Object symbol, string; | |
3955 | { | |
3956 | register Lisp_Object tem; | |
3957 | ||
3958 | tem = Fstring_match (string, Fsymbol_name (symbol), Qnil); | |
265a9e55 | 3959 | if (!NILP (tem) && !NILP (apropos_predicate)) |
2c6f1a39 | 3960 | tem = call1 (apropos_predicate, symbol); |
265a9e55 | 3961 | if (!NILP (tem)) |
2c6f1a39 JB |
3962 | apropos_accumulate = Fcons (symbol, apropos_accumulate); |
3963 | } | |
3964 | ||
744cd66b | 3965 | DEFUN ("apropos-internal", Fapropos_internal, Sapropos_internal, 1, 2, 0, |
335c5470 PJ |
3966 | doc: /* Show all symbols whose names contain match for REGEXP. |
3967 | If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done | |
3968 | for each symbol and a symbol is mentioned only if that returns non-nil. | |
3969 | Return list of symbols found. */) | |
3970 | (regexp, predicate) | |
88539837 | 3971 | Lisp_Object regexp, predicate; |
2c6f1a39 | 3972 | { |
5d55ffd0 | 3973 | Lisp_Object tem; |
b7826503 | 3974 | CHECK_STRING (regexp); |
88539837 | 3975 | apropos_predicate = predicate; |
2c6f1a39 | 3976 | apropos_accumulate = Qnil; |
88539837 | 3977 | map_obarray (Vobarray, apropos_accum, regexp); |
5d55ffd0 RS |
3978 | tem = Fsort (apropos_accumulate, Qstring_lessp); |
3979 | apropos_accumulate = Qnil; | |
3980 | apropos_predicate = Qnil; | |
3981 | return tem; | |
2c6f1a39 JB |
3982 | } |
3983 | \f | |
dfcf069d | 3984 | void |
2c6f1a39 JB |
3985 | syms_of_keymap () |
3986 | { | |
2c6f1a39 JB |
3987 | Qkeymap = intern ("keymap"); |
3988 | staticpro (&Qkeymap); | |
5d55ffd0 RS |
3989 | staticpro (&apropos_predicate); |
3990 | staticpro (&apropos_accumulate); | |
3991 | apropos_predicate = Qnil; | |
3992 | apropos_accumulate = Qnil; | |
2c6f1a39 | 3993 | |
0403641f RS |
3994 | /* Now we are ready to set up this property, so we can |
3995 | create char tables. */ | |
3996 | Fput (Qkeymap, Qchar_table_extra_slots, make_number (0)); | |
3997 | ||
3998 | /* Initialize the keymaps standardly used. | |
3999 | Each one is the value of a Lisp variable, and is also | |
4000 | pointed to by a C variable */ | |
2c6f1a39 | 4001 | |
0403641f | 4002 | global_map = Fmake_keymap (Qnil); |
2c6f1a39 JB |
4003 | Fset (intern ("global-map"), global_map); |
4004 | ||
44bff953 | 4005 | current_global_map = global_map; |
a3e99933 | 4006 | staticpro (&global_map); |
44bff953 RS |
4007 | staticpro (¤t_global_map); |
4008 | ||
ce6e5d0b | 4009 | meta_map = Fmake_keymap (Qnil); |
2c6f1a39 JB |
4010 | Fset (intern ("esc-map"), meta_map); |
4011 | Ffset (intern ("ESC-prefix"), meta_map); | |
4012 | ||
ce6e5d0b | 4013 | control_x_map = Fmake_keymap (Qnil); |
2c6f1a39 JB |
4014 | Fset (intern ("ctl-x-map"), control_x_map); |
4015 | Ffset (intern ("Control-X-prefix"), control_x_map); | |
4016 | ||
2fae9111 RS |
4017 | exclude_keys |
4018 | = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")), | |
4019 | Fcons (Fcons (build_string ("TAB"), build_string ("\\t")), | |
4020 | Fcons (Fcons (build_string ("RET"), build_string ("\\r")), | |
4021 | Fcons (Fcons (build_string ("ESC"), build_string ("\\e")), | |
4022 | Fcons (Fcons (build_string ("SPC"), build_string (" ")), | |
4023 | Qnil))))); | |
4024 | staticpro (&exclude_keys); | |
4025 | ||
107fd03d | 4026 | DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands, |
335c5470 PJ |
4027 | doc: /* List of commands given new key bindings recently. |
4028 | This is used for internal purposes during Emacs startup; | |
4029 | don't alter it yourself. */); | |
107fd03d RS |
4030 | Vdefine_key_rebound_commands = Qt; |
4031 | ||
2c6f1a39 | 4032 | DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map, |
335c5470 | 4033 | doc: /* Default keymap to use when reading from the minibuffer. */); |
ce6e5d0b | 4034 | Vminibuffer_local_map = Fmake_sparse_keymap (Qnil); |
2c6f1a39 JB |
4035 | |
4036 | DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map, | |
335c5470 | 4037 | doc: /* Local keymap for the minibuffer when spaces are not allowed. */); |
ce6e5d0b | 4038 | Vminibuffer_local_ns_map = Fmake_sparse_keymap (Qnil); |
2b6748c0 | 4039 | Fset_keymap_parent (Vminibuffer_local_ns_map, Vminibuffer_local_map); |
2c6f1a39 JB |
4040 | |
4041 | DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map, | |
335c5470 | 4042 | doc: /* Local keymap for minibuffer input with completion. */); |
ce6e5d0b | 4043 | Vminibuffer_local_completion_map = Fmake_sparse_keymap (Qnil); |
2b6748c0 | 4044 | Fset_keymap_parent (Vminibuffer_local_completion_map, Vminibuffer_local_map); |
2c6f1a39 | 4045 | |
a7f96a35 | 4046 | DEFVAR_LISP ("minibuffer-local-filename-completion-map", |
3d866ceb EZ |
4047 | &Vminibuffer_local_filename_completion_map, |
4048 | doc: /* Local keymap for minibuffer input with completion for filenames. */); | |
4049 | Vminibuffer_local_filename_completion_map = Fmake_sparse_keymap (Qnil); | |
a7f96a35 | 4050 | Fset_keymap_parent (Vminibuffer_local_filename_completion_map, |
3d866ceb EZ |
4051 | Vminibuffer_local_completion_map); |
4052 | ||
4053 | ||
2c6f1a39 | 4054 | DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map, |
335c5470 | 4055 | doc: /* Local keymap for minibuffer input with completion, for exact match. */); |
ce6e5d0b | 4056 | Vminibuffer_local_must_match_map = Fmake_sparse_keymap (Qnil); |
2b6748c0 SM |
4057 | Fset_keymap_parent (Vminibuffer_local_must_match_map, |
4058 | Vminibuffer_local_completion_map); | |
2c6f1a39 | 4059 | |
a7f96a35 | 4060 | DEFVAR_LISP ("minibuffer-local-must-match-filename-map", |
3d866ceb EZ |
4061 | &Vminibuffer_local_must_match_filename_map, |
4062 | doc: /* Local keymap for minibuffer input with completion for filenames with exact match. */); | |
4063 | Vminibuffer_local_must_match_filename_map = Fmake_sparse_keymap (Qnil); | |
a7f96a35 | 4064 | Fset_keymap_parent (Vminibuffer_local_must_match_filename_map, |
3d866ceb EZ |
4065 | Vminibuffer_local_must_match_map); |
4066 | ||
cc0a8174 | 4067 | DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist, |
335c5470 PJ |
4068 | doc: /* Alist of keymaps to use for minor modes. |
4069 | Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read | |
4070 | key sequences and look up bindings iff VARIABLE's value is non-nil. | |
4071 | If two active keymaps bind the same key, the keymap appearing earlier | |
4072 | in the list takes precedence. */); | |
cc0a8174 JB |
4073 | Vminor_mode_map_alist = Qnil; |
4074 | ||
dd9cda06 | 4075 | DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist, |
335c5470 | 4076 | doc: /* Alist of keymaps to use for minor modes, in current major mode. |
95296eac | 4077 | This variable is an alist just like `minor-mode-map-alist', and it is |
335c5470 PJ |
4078 | used the same way (and before `minor-mode-map-alist'); however, |
4079 | it is provided for major modes to bind locally. */); | |
dd9cda06 RS |
4080 | Vminor_mode_overriding_map_alist = Qnil; |
4081 | ||
99cbcaca KS |
4082 | DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists, |
4083 | doc: /* List of keymap alists to use for emulations modes. | |
4084 | It is intended for modes or packages using multiple minor-mode keymaps. | |
4085 | Each element is a keymap alist just like `minor-mode-map-alist', or a | |
4086 | symbol with a variable binding which is a keymap alist, and it is used | |
4087 | the same way. The "active" keymaps in each alist are used before | |
744cd66b | 4088 | `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */); |
99cbcaca KS |
4089 | Vemulation_mode_map_alists = Qnil; |
4090 | ||
4091 | ||
6bbbd9b0 | 4092 | DEFVAR_LISP ("function-key-map", &Vfunction_key_map, |
49daa5b1 RS |
4093 | doc: /* Keymap that translates key sequences to key sequences during input. |
4094 | This is used mainly for mapping ASCII function key sequences into | |
4095 | real Emacs function key events (symbols). | |
335c5470 PJ |
4096 | |
4097 | The `read-key-sequence' function replaces any subsequence bound by | |
4098 | `function-key-map' with its binding. More precisely, when the active | |
4099 | keymaps have no binding for the current key sequence but | |
4100 | `function-key-map' binds a suffix of the sequence to a vector or string, | |
4101 | `read-key-sequence' replaces the matching suffix with its binding, and | |
4102 | continues with the new sequence. | |
4103 | ||
addcdb7c SM |
4104 | If the binding is a function, it is called with one argument (the prompt) |
4105 | and its return value (a key sequence) is used. | |
4106 | ||
335c5470 PJ |
4107 | The events that come from bindings in `function-key-map' are not |
4108 | themselves looked up in `function-key-map'. | |
4109 | ||
4110 | For example, suppose `function-key-map' binds `ESC O P' to [f1]. | |
4111 | Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing | |
4112 | `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix | |
4113 | key, typing `ESC O P x' would return [f1 x]. */); | |
ce6e5d0b | 4114 | Vfunction_key_map = Fmake_sparse_keymap (Qnil); |
6bbbd9b0 | 4115 | |
d7bf9bf5 | 4116 | DEFVAR_LISP ("key-translation-map", &Vkey_translation_map, |
335c5470 PJ |
4117 | doc: /* Keymap of key translations that can override keymaps. |
4118 | This keymap works like `function-key-map', but comes after that, | |
7a093e87 | 4119 | and its non-prefix bindings override ordinary bindings. */); |
d7bf9bf5 RS |
4120 | Vkey_translation_map = Qnil; |
4121 | ||
9d209cfe SM |
4122 | staticpro (&Vmouse_events); |
4123 | Vmouse_events = Fcons (intern ("menu-bar"), | |
4124 | Fcons (intern ("tool-bar"), | |
4125 | Fcons (intern ("header-line"), | |
4126 | Fcons (intern ("mode-line"), | |
4127 | Fcons (intern ("mouse-1"), | |
4128 | Fcons (intern ("mouse-2"), | |
4129 | Fcons (intern ("mouse-3"), | |
4130 | Fcons (intern ("mouse-4"), | |
4131 | Fcons (intern ("mouse-5"), | |
4132 | Qnil))))))))); | |
d378869e SM |
4133 | |
4134 | ||
2c6f1a39 JB |
4135 | Qsingle_key_description = intern ("single-key-description"); |
4136 | staticpro (&Qsingle_key_description); | |
4137 | ||
4138 | Qkey_description = intern ("key-description"); | |
4139 | staticpro (&Qkey_description); | |
4140 | ||
4141 | Qkeymapp = intern ("keymapp"); | |
4142 | staticpro (&Qkeymapp); | |
4143 | ||
2fc66973 JB |
4144 | Qnon_ascii = intern ("non-ascii"); |
4145 | staticpro (&Qnon_ascii); | |
4146 | ||
a3fc8840 RS |
4147 | Qmenu_item = intern ("menu-item"); |
4148 | staticpro (&Qmenu_item); | |
4149 | ||
a1df473f KS |
4150 | Qremap = intern ("remap"); |
4151 | staticpro (&Qremap); | |
4152 | ||
023b93f6 KS |
4153 | command_remapping_vector = Fmake_vector (make_number (2), Qremap); |
4154 | staticpro (&command_remapping_vector); | |
a1df473f | 4155 | |
1e7d1ab0 SM |
4156 | where_is_cache_keymaps = Qt; |
4157 | where_is_cache = Qnil; | |
4158 | staticpro (&where_is_cache); | |
4159 | staticpro (&where_is_cache_keymaps); | |
4160 | ||
2c6f1a39 | 4161 | defsubr (&Skeymapp); |
7d58ed99 | 4162 | defsubr (&Skeymap_parent); |
54cbc3d4 | 4163 | defsubr (&Skeymap_prompt); |
7d58ed99 | 4164 | defsubr (&Sset_keymap_parent); |
2c6f1a39 JB |
4165 | defsubr (&Smake_keymap); |
4166 | defsubr (&Smake_sparse_keymap); | |
9d3153eb | 4167 | defsubr (&Smap_keymap); |
2c6f1a39 | 4168 | defsubr (&Scopy_keymap); |
023b93f6 | 4169 | defsubr (&Scommand_remapping); |
2c6f1a39 JB |
4170 | defsubr (&Skey_binding); |
4171 | defsubr (&Slocal_key_binding); | |
4172 | defsubr (&Sglobal_key_binding); | |
cc0a8174 | 4173 | defsubr (&Sminor_mode_key_binding); |
2c6f1a39 JB |
4174 | defsubr (&Sdefine_key); |
4175 | defsubr (&Slookup_key); | |
2c6f1a39 JB |
4176 | defsubr (&Sdefine_prefix_command); |
4177 | defsubr (&Suse_global_map); | |
4178 | defsubr (&Suse_local_map); | |
4179 | defsubr (&Scurrent_local_map); | |
4180 | defsubr (&Scurrent_global_map); | |
cc0a8174 | 4181 | defsubr (&Scurrent_minor_mode_maps); |
54cbc3d4 | 4182 | defsubr (&Scurrent_active_maps); |
2c6f1a39 JB |
4183 | defsubr (&Saccessible_keymaps); |
4184 | defsubr (&Skey_description); | |
4185 | defsubr (&Sdescribe_vector); | |
4186 | defsubr (&Ssingle_key_description); | |
4187 | defsubr (&Stext_char_description); | |
4188 | defsubr (&Swhere_is_internal); | |
54cbc3d4 | 4189 | defsubr (&Sdescribe_buffer_bindings); |
2c6f1a39 JB |
4190 | defsubr (&Sapropos_internal); |
4191 | } | |
4192 | ||
dfcf069d | 4193 | void |
2c6f1a39 JB |
4194 | keys_of_keymap () |
4195 | { | |
2c6f1a39 JB |
4196 | initial_define_key (global_map, 033, "ESC-prefix"); |
4197 | initial_define_key (global_map, Ctl('X'), "Control-X-prefix"); | |
4198 | } | |
ab5796a9 MB |
4199 | |
4200 | /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463 | |
4201 | (do not change this comment) */ |