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