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