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