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