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