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