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