(looking_at_1): Use current_buffer->case_canon_table,
[emacs.git] / src / keymap.c
blob10ae718ba0deabf69d6e657dc2478c6a8d718018
1 /* Manipulation of keymaps
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1998, 1999, 2000,
3 2001, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
23 #include <config.h>
24 #include <stdio.h>
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 #include "intervals.h"
34 #include "keymap.h"
36 /* The number of elements in keymap vectors. */
37 #define DENSE_TABLE_SIZE (0200)
39 /* Actually allocate storage for these variables */
41 Lisp_Object current_global_map; /* Current global keymap */
43 Lisp_Object global_map; /* default global key bindings */
45 Lisp_Object meta_map; /* The keymap used for globally bound
46 ESC-prefixed default commands */
48 Lisp_Object control_x_map; /* The keymap used for globally bound
49 C-x-prefixed default commands */
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 */
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 */
63 /* keymap used for minibuffers when doing completion */
64 /* was MinibufLocalCompletionMap */
65 Lisp_Object Vminibuffer_local_completion_map;
67 /* keymap used for minibuffers when doing completion and require a match */
68 /* was MinibufLocalMustMatchMap */
69 Lisp_Object Vminibuffer_local_must_match_map;
71 /* Alist of minor mode variables and keymaps. */
72 Lisp_Object Vminor_mode_map_alist;
74 /* Alist of major-mode-specific overrides for
75 minor mode variables and keymaps. */
76 Lisp_Object Vminor_mode_overriding_map_alist;
78 /* List of emulation mode keymap alists. */
79 Lisp_Object Vemulation_mode_map_alists;
81 /* Keymap mapping ASCII function key sequences onto their preferred forms.
82 Initialized by the terminal-specific lisp files. See DEFVAR for more
83 documentation. */
84 Lisp_Object Vfunction_key_map;
86 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
87 Lisp_Object Vkey_translation_map;
89 /* A list of all commands given new bindings since a certain time
90 when nil was stored here.
91 This is used to speed up recomputation of menu key equivalents
92 when Emacs starts up. t means don't record anything here. */
93 Lisp_Object Vdefine_key_rebound_commands;
95 Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
97 /* Alist of elements like (DEL . "\d"). */
98 static Lisp_Object exclude_keys;
100 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
101 static Lisp_Object command_remapping_vector;
103 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
104 in a string key sequence is equivalent to prefixing with this
105 character. */
106 extern Lisp_Object meta_prefix_char;
108 extern Lisp_Object Voverriding_local_map;
110 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
111 static Lisp_Object where_is_cache;
112 /* Which keymaps are reverse-stored in the cache. */
113 static Lisp_Object where_is_cache_keymaps;
115 static Lisp_Object store_in_keymap P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
116 static void fix_submap_inheritance P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
118 static Lisp_Object define_as_prefix P_ ((Lisp_Object, Lisp_Object));
119 static void describe_command P_ ((Lisp_Object, Lisp_Object));
120 static void describe_translation P_ ((Lisp_Object, Lisp_Object));
121 static void describe_map P_ ((Lisp_Object, Lisp_Object,
122 void (*) P_ ((Lisp_Object, Lisp_Object)),
123 int, Lisp_Object, Lisp_Object*, int, int));
124 static void describe_vector P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
125 void (*) (Lisp_Object, Lisp_Object), int,
126 Lisp_Object, Lisp_Object, int *,
127 int, int, int));
128 static void silly_event_symbol_error P_ ((Lisp_Object));
130 /* Keymap object support - constructors and predicates. */
132 DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
133 doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
134 CHARTABLE is a char-table that holds the bindings for all characters
135 without modifiers. All entries in it are initially nil, meaning
136 "command undefined". ALIST is an assoc-list which holds bindings for
137 function keys, mouse events, and any other things that appear in the
138 input stream. Initially, ALIST is nil.
140 The optional arg STRING supplies a menu name for the keymap
141 in case you use it as a menu with `x-popup-menu'. */)
142 (string)
143 Lisp_Object string;
145 Lisp_Object tail;
146 if (!NILP (string))
147 tail = Fcons (string, Qnil);
148 else
149 tail = Qnil;
150 return Fcons (Qkeymap,
151 Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
154 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
155 doc: /* Construct and return a new sparse keymap.
156 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
157 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
158 which binds the function key or mouse event SYMBOL to DEFINITION.
159 Initially the alist is nil.
161 The optional arg STRING supplies a menu name for the keymap
162 in case you use it as a menu with `x-popup-menu'. */)
163 (string)
164 Lisp_Object string;
166 if (!NILP (string))
167 return Fcons (Qkeymap, Fcons (string, Qnil));
168 return Fcons (Qkeymap, Qnil);
171 /* This function is used for installing the standard key bindings
172 at initialization time.
174 For example:
176 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
178 void
179 initial_define_key (keymap, key, defname)
180 Lisp_Object keymap;
181 int key;
182 char *defname;
184 store_in_keymap (keymap, make_number (key), intern (defname));
187 void
188 initial_define_lispy_key (keymap, keyname, defname)
189 Lisp_Object keymap;
190 char *keyname;
191 char *defname;
193 store_in_keymap (keymap, intern (keyname), intern (defname));
196 DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
197 doc: /* Return t if OBJECT is a keymap.
199 A keymap is a list (keymap . ALIST),
200 or a symbol whose function definition is itself a keymap.
201 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
202 a vector of densely packed bindings for small character codes
203 is also allowed as an element. */)
204 (object)
205 Lisp_Object object;
207 return (KEYMAPP (object) ? Qt : Qnil);
210 DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
211 doc: /* Return the prompt-string of a keymap MAP.
212 If non-nil, the prompt is shown in the echo-area
213 when reading a key-sequence to be looked-up in this keymap. */)
214 (map)
215 Lisp_Object map;
217 map = get_keymap (map, 0, 0);
218 while (CONSP (map))
220 Lisp_Object tem = XCAR (map);
221 if (STRINGP (tem))
222 return tem;
223 map = XCDR (map);
225 return Qnil;
228 /* Check that OBJECT is a keymap (after dereferencing through any
229 symbols). If it is, return it.
231 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
232 is an autoload form, do the autoload and try again.
233 If AUTOLOAD is nonzero, callers must assume GC is possible.
235 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
236 is zero as well), return Qt.
238 ERROR controls how we respond if OBJECT isn't a keymap.
239 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
241 Note that most of the time, we don't want to pursue autoloads.
242 Functions like Faccessible_keymaps which scan entire keymap trees
243 shouldn't load every autoloaded keymap. I'm not sure about this,
244 but it seems to me that only read_key_sequence, Flookup_key, and
245 Fdefine_key should cause keymaps to be autoloaded.
247 This function can GC when AUTOLOAD is non-zero, because it calls
248 do_autoload which can GC. */
250 Lisp_Object
251 get_keymap (object, error, autoload)
252 Lisp_Object object;
253 int error, autoload;
255 Lisp_Object tem;
257 autoload_retry:
258 if (NILP (object))
259 goto end;
260 if (CONSP (object) && EQ (XCAR (object), Qkeymap))
261 return object;
263 tem = indirect_function (object);
264 if (CONSP (tem))
266 if (EQ (XCAR (tem), Qkeymap))
267 return tem;
269 /* Should we do an autoload? Autoload forms for keymaps have
270 Qkeymap as their fifth element. */
271 if ((autoload || !error) && EQ (XCAR (tem), Qautoload)
272 && SYMBOLP (object))
274 Lisp_Object tail;
276 tail = Fnth (make_number (4), tem);
277 if (EQ (tail, Qkeymap))
279 if (autoload)
281 struct gcpro gcpro1, gcpro2;
283 GCPRO2 (tem, object);
284 do_autoload (tem, object);
285 UNGCPRO;
287 goto autoload_retry;
289 else
290 return Qt;
295 end:
296 if (error)
297 wrong_type_argument (Qkeymapp, object);
298 return Qnil;
301 /* Return the parent map of KEYMAP, or nil if it has none.
302 We assume that KEYMAP is a valid keymap. */
304 Lisp_Object
305 keymap_parent (keymap, autoload)
306 Lisp_Object keymap;
307 int autoload;
309 Lisp_Object list;
311 keymap = get_keymap (keymap, 1, autoload);
313 /* Skip past the initial element `keymap'. */
314 list = XCDR (keymap);
315 for (; CONSP (list); list = XCDR (list))
317 /* See if there is another `keymap'. */
318 if (KEYMAPP (list))
319 return list;
322 return get_keymap (list, 0, autoload);
325 DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
326 doc: /* Return the parent keymap of KEYMAP. */)
327 (keymap)
328 Lisp_Object keymap;
330 return keymap_parent (keymap, 1);
333 /* Check whether MAP is one of MAPS parents. */
335 keymap_memberp (map, maps)
336 Lisp_Object map, maps;
338 if (NILP (map)) return 0;
339 while (KEYMAPP (maps) && !EQ (map, maps))
340 maps = keymap_parent (maps, 0);
341 return (EQ (map, maps));
344 /* Set the parent keymap of MAP to PARENT. */
346 DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
347 doc: /* Modify KEYMAP to set its parent map to PARENT.
348 Return PARENT. PARENT should be nil or another keymap. */)
349 (keymap, parent)
350 Lisp_Object keymap, parent;
352 Lisp_Object list, prev;
353 struct gcpro gcpro1, gcpro2;
354 int i;
356 /* Force a keymap flush for the next call to where-is.
357 Since this can be called from within where-is, we don't set where_is_cache
358 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
359 be changed during where-is, while where_is_cache_keymaps is only used at
360 the very beginning of where-is and can thus be changed here without any
361 adverse effect.
362 This is a very minor correctness (rather than safety) issue. */
363 where_is_cache_keymaps = Qt;
365 GCPRO2 (keymap, parent);
366 keymap = get_keymap (keymap, 1, 1);
368 if (!NILP (parent))
370 parent = get_keymap (parent, 1, 1);
372 /* Check for cycles. */
373 if (keymap_memberp (keymap, parent))
374 error ("Cyclic keymap inheritance");
377 /* Skip past the initial element `keymap'. */
378 prev = keymap;
379 while (1)
381 list = XCDR (prev);
382 /* If there is a parent keymap here, replace it.
383 If we came to the end, add the parent in PREV. */
384 if (!CONSP (list) || KEYMAPP (list))
386 /* If we already have the right parent, return now
387 so that we avoid the loops below. */
388 if (EQ (XCDR (prev), parent))
389 RETURN_UNGCPRO (parent);
391 XSETCDR (prev, parent);
392 break;
394 prev = list;
397 /* Scan through for submaps, and set their parents too. */
399 for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
401 /* Stop the scan when we come to the parent. */
402 if (EQ (XCAR (list), Qkeymap))
403 break;
405 /* If this element holds a prefix map, deal with it. */
406 if (CONSP (XCAR (list))
407 && CONSP (XCDR (XCAR (list))))
408 fix_submap_inheritance (keymap, XCAR (XCAR (list)),
409 XCDR (XCAR (list)));
411 if (VECTORP (XCAR (list)))
412 for (i = 0; i < XVECTOR (XCAR (list))->size; i++)
413 if (CONSP (XVECTOR (XCAR (list))->contents[i]))
414 fix_submap_inheritance (keymap, make_number (i),
415 XVECTOR (XCAR (list))->contents[i]);
417 if (CHAR_TABLE_P (XCAR (list)))
419 Lisp_Object indices[3];
421 map_char_table (fix_submap_inheritance, Qnil,
422 XCAR (list), XCAR (list),
423 keymap, 0, indices);
427 RETURN_UNGCPRO (parent);
430 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
431 if EVENT is also a prefix in MAP's parent,
432 make sure that SUBMAP inherits that definition as its own parent. */
434 static void
435 fix_submap_inheritance (map, event, submap)
436 Lisp_Object map, event, submap;
438 Lisp_Object map_parent, parent_entry;
440 /* SUBMAP is a cons that we found as a key binding.
441 Discard the other things found in a menu key binding. */
443 submap = get_keymap (get_keyelt (submap, 0), 0, 0);
445 /* If it isn't a keymap now, there's no work to do. */
446 if (!CONSP (submap))
447 return;
449 map_parent = keymap_parent (map, 0);
450 if (!NILP (map_parent))
451 parent_entry =
452 get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
453 else
454 parent_entry = Qnil;
456 /* If MAP's parent has something other than a keymap,
457 our own submap shadows it completely. */
458 if (!CONSP (parent_entry))
459 return;
461 if (! EQ (parent_entry, submap))
463 Lisp_Object submap_parent;
464 submap_parent = submap;
465 while (1)
467 Lisp_Object tem;
469 tem = keymap_parent (submap_parent, 0);
471 if (KEYMAPP (tem))
473 if (keymap_memberp (tem, parent_entry))
474 /* Fset_keymap_parent could create a cycle. */
475 return;
476 submap_parent = tem;
478 else
479 break;
481 Fset_keymap_parent (submap_parent, parent_entry);
485 /* Look up IDX in MAP. IDX may be any sort of event.
486 Note that this does only one level of lookup; IDX must be a single
487 event, not a sequence.
489 If T_OK is non-zero, bindings for Qt are treated as default
490 bindings; any key left unmentioned by other tables and bindings is
491 given the binding of Qt.
493 If T_OK is zero, bindings for Qt are not treated specially.
495 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
497 Lisp_Object
498 access_keymap (map, idx, t_ok, noinherit, autoload)
499 Lisp_Object map;
500 Lisp_Object idx;
501 int t_ok;
502 int noinherit;
503 int autoload;
505 Lisp_Object val;
507 /* Qunbound in VAL means we have found no binding yet. */
508 val = Qunbound;
510 /* If idx is a list (some sort of mouse click, perhaps?),
511 the index we want to use is the car of the list, which
512 ought to be a symbol. */
513 idx = EVENT_HEAD (idx);
515 /* If idx is a symbol, it might have modifiers, which need to
516 be put in the canonical order. */
517 if (SYMBOLP (idx))
518 idx = reorder_modifiers (idx);
519 else if (INTEGERP (idx))
520 /* Clobber the high bits that can be present on a machine
521 with more than 24 bits of integer. */
522 XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
524 /* Handle the special meta -> esc mapping. */
525 if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
527 /* See if there is a meta-map. If there's none, there is
528 no binding for IDX, unless a default binding exists in MAP. */
529 struct gcpro gcpro1;
530 Lisp_Object meta_map;
531 GCPRO1 (map);
532 /* A strange value in which Meta is set would cause
533 infinite recursion. Protect against that. */
534 if (XINT (meta_prefix_char) & CHAR_META)
535 meta_prefix_char = make_number (27);
536 meta_map = get_keymap (access_keymap (map, meta_prefix_char,
537 t_ok, noinherit, autoload),
538 0, autoload);
539 UNGCPRO;
540 if (CONSP (meta_map))
542 map = meta_map;
543 idx = make_number (XUINT (idx) & ~meta_modifier);
545 else if (t_ok)
546 /* Set IDX to t, so that we only find a default binding. */
547 idx = Qt;
548 else
549 /* We know there is no binding. */
550 return Qnil;
553 /* t_binding is where we put a default binding that applies,
554 to use in case we do not find a binding specifically
555 for this key sequence. */
557 Lisp_Object tail;
558 Lisp_Object t_binding = Qnil;
559 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
561 GCPRO4 (map, tail, idx, t_binding);
563 /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
564 If it is 1, only generic-char bindings are accepted.
565 Otherwise, neither are. */
566 t_ok = t_ok ? 2 : 0;
568 for (tail = XCDR (map);
569 (CONSP (tail)
570 || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
571 tail = XCDR (tail))
573 Lisp_Object binding;
575 binding = XCAR (tail);
576 if (SYMBOLP (binding))
578 /* If NOINHERIT, stop finding prefix definitions
579 after we pass a second occurrence of the `keymap' symbol. */
580 if (noinherit && EQ (binding, Qkeymap))
581 RETURN_UNGCPRO (Qnil);
583 else if (CONSP (binding))
585 Lisp_Object key = XCAR (binding);
587 if (EQ (key, idx))
588 val = XCDR (binding);
589 else if (t_ok
590 && INTEGERP (idx)
591 && (XINT (idx) & CHAR_MODIFIER_MASK) == 0
592 && INTEGERP (key)
593 && (XINT (key) & CHAR_MODIFIER_MASK) == 0
594 && !SINGLE_BYTE_CHAR_P (XINT (idx))
595 && !SINGLE_BYTE_CHAR_P (XINT (key))
596 && CHAR_VALID_P (XINT (key), 1)
597 && !CHAR_VALID_P (XINT (key), 0)
598 && (CHAR_CHARSET (XINT (key))
599 == CHAR_CHARSET (XINT (idx))))
601 /* KEY is the generic character of the charset of IDX.
602 Use KEY's binding if there isn't a binding for IDX
603 itself. */
604 t_binding = XCDR (binding);
605 t_ok = 0;
607 else if (t_ok > 1 && EQ (key, Qt))
609 t_binding = XCDR (binding);
610 t_ok = 1;
613 else if (VECTORP (binding))
615 if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
616 val = AREF (binding, XFASTINT (idx));
618 else if (CHAR_TABLE_P (binding))
620 /* Character codes with modifiers
621 are not included in a char-table.
622 All character codes without modifiers are included. */
623 if (NATNUMP (idx) && (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0)
625 val = Faref (binding, idx);
626 /* `nil' has a special meaning for char-tables, so
627 we use something else to record an explicitly
628 unbound entry. */
629 if (NILP (val))
630 val = Qunbound;
634 /* If we found a binding, clean it up and return it. */
635 if (!EQ (val, Qunbound))
637 if (EQ (val, Qt))
638 /* A Qt binding is just like an explicit nil binding
639 (i.e. it shadows any parent binding but not bindings in
640 keymaps of lower precedence). */
641 val = Qnil;
642 val = get_keyelt (val, autoload);
643 if (KEYMAPP (val))
644 fix_submap_inheritance (map, idx, val);
645 RETURN_UNGCPRO (val);
647 QUIT;
649 UNGCPRO;
650 return get_keyelt (t_binding, autoload);
654 static void
655 map_keymap_item (fun, args, key, val, data)
656 map_keymap_function_t fun;
657 Lisp_Object args, key, val;
658 void *data;
660 /* We should maybe try to detect bindings shadowed by previous
661 ones and things like that. */
662 if (EQ (val, Qt))
663 val = Qnil;
664 (*fun) (key, val, args, data);
667 static void
668 map_keymap_char_table_item (args, key, val)
669 Lisp_Object args, key, val;
671 if (!NILP (val))
673 map_keymap_function_t fun = XSAVE_VALUE (XCAR (args))->pointer;
674 args = XCDR (args);
675 map_keymap_item (fun, XCDR (args), key, val,
676 XSAVE_VALUE (XCAR (args))->pointer);
680 /* Call FUN for every binding in MAP.
681 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
682 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
683 void
684 map_keymap (map, fun, args, data, autoload)
685 map_keymap_function_t fun;
686 Lisp_Object map, args;
687 void *data;
688 int autoload;
690 struct gcpro gcpro1, gcpro2, gcpro3;
691 Lisp_Object tail;
693 GCPRO3 (map, args, tail);
694 map = get_keymap (map, 1, autoload);
695 for (tail = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
696 CONSP (tail) || (tail = get_keymap (tail, 0, autoload), CONSP (tail));
697 tail = XCDR (tail))
699 Lisp_Object binding = XCAR (tail);
701 if (CONSP (binding))
702 map_keymap_item (fun, args, XCAR (binding), XCDR (binding), data);
703 else if (VECTORP (binding))
705 /* Loop over the char values represented in the vector. */
706 int len = ASIZE (binding);
707 int c;
708 for (c = 0; c < len; c++)
710 Lisp_Object character;
711 XSETFASTINT (character, c);
712 map_keymap_item (fun, args, character, AREF (binding, c), data);
715 else if (CHAR_TABLE_P (binding))
717 Lisp_Object indices[3];
718 map_char_table (map_keymap_char_table_item, Qnil, binding, binding,
719 Fcons (make_save_value (fun, 0),
720 Fcons (make_save_value (data, 0),
721 args)),
722 0, indices);
725 UNGCPRO;
728 static void
729 map_keymap_call (key, val, fun, dummy)
730 Lisp_Object key, val, fun;
731 void *dummy;
733 call2 (fun, key, val);
736 DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 3, 0,
737 doc: /* Call FUNCTION for every binding in KEYMAP.
738 FUNCTION is called with two arguments: the event and its binding.
739 If KEYMAP has a parent, the parent's bindings are included as well.
740 This works recursively: if the parent has itself a parent, then the
741 grandparent's bindings are also included and so on.
742 usage: (map-keymap FUNCTION KEYMAP) */)
743 (function, keymap, sort_first)
744 Lisp_Object function, keymap, sort_first;
746 if (INTEGERP (function))
747 /* We have to stop integers early since map_keymap gives them special
748 significance. */
749 Fsignal (Qinvalid_function, Fcons (function, Qnil));
750 if (! NILP (sort_first))
751 return call3 (intern ("map-keymap-internal"), function, keymap, Qt);
753 map_keymap (keymap, map_keymap_call, function, NULL, 1);
754 return Qnil;
757 /* Given OBJECT which was found in a slot in a keymap,
758 trace indirect definitions to get the actual definition of that slot.
759 An indirect definition is a list of the form
760 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
761 and INDEX is the object to look up in KEYMAP to yield the definition.
763 Also if OBJECT has a menu string as the first element,
764 remove that. Also remove a menu help string as second element.
766 If AUTOLOAD is nonzero, load autoloadable keymaps
767 that are referred to with indirection. */
769 Lisp_Object
770 get_keyelt (object, autoload)
771 Lisp_Object object;
772 int autoload;
774 while (1)
776 if (!(CONSP (object)))
777 /* This is really the value. */
778 return object;
780 /* If the keymap contents looks like (keymap ...) or (lambda ...)
781 then use itself. */
782 else if (EQ (XCAR (object), Qkeymap) || EQ (XCAR (object), Qlambda))
783 return object;
785 /* If the keymap contents looks like (menu-item name . DEFN)
786 or (menu-item name DEFN ...) then use DEFN.
787 This is a new format menu item. */
788 else if (EQ (XCAR (object), Qmenu_item))
790 if (CONSP (XCDR (object)))
792 Lisp_Object tem;
794 object = XCDR (XCDR (object));
795 tem = object;
796 if (CONSP (object))
797 object = XCAR (object);
799 /* If there's a `:filter FILTER', apply FILTER to the
800 menu-item's definition to get the real definition to
801 use. */
802 for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
803 if (EQ (XCAR (tem), QCfilter) && autoload)
805 Lisp_Object filter;
806 filter = XCAR (XCDR (tem));
807 filter = list2 (filter, list2 (Qquote, object));
808 object = menu_item_eval_property (filter);
809 break;
812 else
813 /* Invalid keymap. */
814 return object;
817 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
818 Keymap alist elements like (CHAR MENUSTRING . DEFN)
819 will be used by HierarKey menus. */
820 else if (STRINGP (XCAR (object)))
822 object = XCDR (object);
823 /* Also remove a menu help string, if any,
824 following the menu item name. */
825 if (CONSP (object) && STRINGP (XCAR (object)))
826 object = XCDR (object);
827 /* Also remove the sublist that caches key equivalences, if any. */
828 if (CONSP (object) && CONSP (XCAR (object)))
830 Lisp_Object carcar;
831 carcar = XCAR (XCAR (object));
832 if (NILP (carcar) || VECTORP (carcar))
833 object = XCDR (object);
837 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
838 else
840 struct gcpro gcpro1;
841 Lisp_Object map;
842 GCPRO1 (object);
843 map = get_keymap (Fcar_safe (object), 0, autoload);
844 UNGCPRO;
845 return (!CONSP (map) ? object /* Invalid keymap */
846 : access_keymap (map, Fcdr (object), 0, 0, autoload));
851 static Lisp_Object
852 store_in_keymap (keymap, idx, def)
853 Lisp_Object keymap;
854 register Lisp_Object idx;
855 register Lisp_Object def;
857 /* Flush any reverse-map cache. */
858 where_is_cache = Qnil;
859 where_is_cache_keymaps = Qt;
861 /* If we are preparing to dump, and DEF is a menu element
862 with a menu item indicator, copy it to ensure it is not pure. */
863 if (CONSP (def) && PURE_P (def)
864 && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
865 def = Fcons (XCAR (def), XCDR (def));
867 if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
868 error ("attempt to define a key in a non-keymap");
870 /* If idx is a list (some sort of mouse click, perhaps?),
871 the index we want to use is the car of the list, which
872 ought to be a symbol. */
873 idx = EVENT_HEAD (idx);
875 /* If idx is a symbol, it might have modifiers, which need to
876 be put in the canonical order. */
877 if (SYMBOLP (idx))
878 idx = reorder_modifiers (idx);
879 else if (INTEGERP (idx))
880 /* Clobber the high bits that can be present on a machine
881 with more than 24 bits of integer. */
882 XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
884 /* Scan the keymap for a binding of idx. */
886 Lisp_Object tail;
888 /* The cons after which we should insert new bindings. If the
889 keymap has a table element, we record its position here, so new
890 bindings will go after it; this way, the table will stay
891 towards the front of the alist and character lookups in dense
892 keymaps will remain fast. Otherwise, this just points at the
893 front of the keymap. */
894 Lisp_Object insertion_point;
896 insertion_point = keymap;
897 for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
899 Lisp_Object elt;
901 elt = XCAR (tail);
902 if (VECTORP (elt))
904 if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
906 ASET (elt, XFASTINT (idx), def);
907 return def;
909 insertion_point = tail;
911 else if (CHAR_TABLE_P (elt))
913 /* Character codes with modifiers
914 are not included in a char-table.
915 All character codes without modifiers are included. */
916 if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
918 Faset (elt, idx,
919 /* `nil' has a special meaning for char-tables, so
920 we use something else to record an explicitly
921 unbound entry. */
922 NILP (def) ? Qt : def);
923 return def;
925 insertion_point = tail;
927 else if (CONSP (elt))
929 if (EQ (idx, XCAR (elt)))
931 XSETCDR (elt, def);
932 return def;
935 else if (EQ (elt, Qkeymap))
936 /* If we find a 'keymap' symbol in the spine of KEYMAP,
937 then we must have found the start of a second keymap
938 being used as the tail of KEYMAP, and a binding for IDX
939 should be inserted before it. */
940 goto keymap_end;
942 QUIT;
945 keymap_end:
946 /* We have scanned the entire keymap, and not found a binding for
947 IDX. Let's add one. */
948 XSETCDR (insertion_point,
949 Fcons (Fcons (idx, def), XCDR (insertion_point)));
952 return def;
955 EXFUN (Fcopy_keymap, 1);
957 Lisp_Object
958 copy_keymap_item (elt)
959 Lisp_Object elt;
961 Lisp_Object res, tem;
963 if (!CONSP (elt))
964 return elt;
966 res = tem = elt;
968 /* Is this a new format menu item. */
969 if (EQ (XCAR (tem), Qmenu_item))
971 /* Copy cell with menu-item marker. */
972 res = elt = Fcons (XCAR (tem), XCDR (tem));
973 tem = XCDR (elt);
974 if (CONSP (tem))
976 /* Copy cell with menu-item name. */
977 XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
978 elt = XCDR (elt);
979 tem = XCDR (elt);
981 if (CONSP (tem))
983 /* Copy cell with binding and if the binding is a keymap,
984 copy that. */
985 XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
986 elt = XCDR (elt);
987 tem = XCAR (elt);
988 if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
989 XSETCAR (elt, Fcopy_keymap (tem));
990 tem = XCDR (elt);
991 if (CONSP (tem) && CONSP (XCAR (tem)))
992 /* Delete cache for key equivalences. */
993 XSETCDR (elt, XCDR (tem));
996 else
998 /* It may be an old fomat menu item.
999 Skip the optional menu string. */
1000 if (STRINGP (XCAR (tem)))
1002 /* Copy the cell, since copy-alist didn't go this deep. */
1003 res = elt = Fcons (XCAR (tem), XCDR (tem));
1004 tem = XCDR (elt);
1005 /* Also skip the optional menu help string. */
1006 if (CONSP (tem) && STRINGP (XCAR (tem)))
1008 XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
1009 elt = XCDR (elt);
1010 tem = XCDR (elt);
1012 /* There may also be a list that caches key equivalences.
1013 Just delete it for the new keymap. */
1014 if (CONSP (tem)
1015 && CONSP (XCAR (tem))
1016 && (NILP (XCAR (XCAR (tem)))
1017 || VECTORP (XCAR (XCAR (tem)))))
1019 XSETCDR (elt, XCDR (tem));
1020 tem = XCDR (tem);
1022 if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
1023 XSETCDR (elt, Fcopy_keymap (tem));
1025 else if (EQ (XCAR (tem), Qkeymap))
1026 res = Fcopy_keymap (elt);
1028 return res;
1031 static void
1032 copy_keymap_1 (chartable, idx, elt)
1033 Lisp_Object chartable, idx, elt;
1035 Faset (chartable, idx, copy_keymap_item (elt));
1038 DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0,
1039 doc: /* Return a copy of the keymap KEYMAP.
1040 The copy starts out with the same definitions of KEYMAP,
1041 but changing either the copy or KEYMAP does not affect the other.
1042 Any key definitions that are subkeymaps are recursively copied.
1043 However, a key definition which is a symbol whose definition is a keymap
1044 is not copied. */)
1045 (keymap)
1046 Lisp_Object keymap;
1048 register Lisp_Object copy, tail;
1049 keymap = get_keymap (keymap, 1, 0);
1050 copy = tail = Fcons (Qkeymap, Qnil);
1051 keymap = XCDR (keymap); /* Skip the `keymap' symbol. */
1053 while (CONSP (keymap) && !EQ (XCAR (keymap), Qkeymap))
1055 Lisp_Object elt = XCAR (keymap);
1056 if (CHAR_TABLE_P (elt))
1058 Lisp_Object indices[3];
1059 elt = Fcopy_sequence (elt);
1060 map_char_table (copy_keymap_1, Qnil, elt, elt, elt, 0, indices);
1062 else if (VECTORP (elt))
1064 int i;
1065 elt = Fcopy_sequence (elt);
1066 for (i = 0; i < ASIZE (elt); i++)
1067 ASET (elt, i, copy_keymap_item (AREF (elt, i)));
1069 else if (CONSP (elt))
1070 elt = Fcons (XCAR (elt), copy_keymap_item (XCDR (elt)));
1071 XSETCDR (tail, Fcons (elt, Qnil));
1072 tail = XCDR (tail);
1073 keymap = XCDR (keymap);
1075 XSETCDR (tail, keymap);
1076 return copy;
1079 /* Simple Keymap mutators and accessors. */
1081 /* GC is possible in this function if it autoloads a keymap. */
1083 DEFUN ("define-key", Fdefine_key, Sdefine_key, 3, 3, 0,
1084 doc: /* In KEYMAP, define key sequence KEY as DEF.
1085 KEYMAP is a keymap.
1087 KEY is a string or a vector of symbols and characters meaning a
1088 sequence of keystrokes and events. Non-ASCII characters with codes
1089 above 127 (such as ISO Latin-1) can be included if you use a vector.
1090 Using [t] for KEY creates a default definition, which applies to any
1091 event type that has no other definition in this keymap.
1093 DEF is anything that can be a key's definition:
1094 nil (means key is undefined in this keymap),
1095 a command (a Lisp function suitable for interactive calling),
1096 a string (treated as a keyboard macro),
1097 a keymap (to define a prefix key),
1098 a symbol (when the key is looked up, the symbol will stand for its
1099 function definition, which should at that time be one of the above,
1100 or another symbol whose function definition is used, etc.),
1101 a cons (STRING . DEFN), meaning that DEFN is the definition
1102 (DEFN should be a valid definition in its own right),
1103 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1105 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1106 binding is altered. If there is no binding for KEY, the new pair
1107 binding KEY to DEF is added at the front of KEYMAP. */)
1108 (keymap, key, def)
1109 Lisp_Object keymap;
1110 Lisp_Object key;
1111 Lisp_Object def;
1113 register int idx;
1114 register Lisp_Object c;
1115 register Lisp_Object cmd;
1116 int metized = 0;
1117 int meta_bit;
1118 int length;
1119 struct gcpro gcpro1, gcpro2, gcpro3;
1121 GCPRO3 (keymap, key, def);
1122 keymap = get_keymap (keymap, 1, 1);
1124 if (!VECTORP (key) && !STRINGP (key))
1125 key = wrong_type_argument (Qarrayp, key);
1127 length = XFASTINT (Flength (key));
1128 if (length == 0)
1129 RETURN_UNGCPRO (Qnil);
1131 if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
1132 Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);
1134 meta_bit = VECTORP (key) ? meta_modifier : 0x80;
1136 idx = 0;
1137 while (1)
1139 c = Faref (key, make_number (idx));
1141 if (CONSP (c) && lucid_event_type_list_p (c))
1142 c = Fevent_convert_list (c);
1144 if (SYMBOLP (c))
1145 silly_event_symbol_error (c);
1147 if (INTEGERP (c)
1148 && (XINT (c) & meta_bit)
1149 && !metized)
1151 c = meta_prefix_char;
1152 metized = 1;
1154 else
1156 if (INTEGERP (c))
1157 XSETINT (c, XINT (c) & ~meta_bit);
1159 metized = 0;
1160 idx++;
1163 if (!INTEGERP (c) && !SYMBOLP (c) && !CONSP (c))
1164 error ("Key sequence contains invalid event");
1166 if (idx == length)
1167 RETURN_UNGCPRO (store_in_keymap (keymap, c, def));
1169 cmd = access_keymap (keymap, c, 0, 1, 1);
1171 /* If this key is undefined, make it a prefix. */
1172 if (NILP (cmd))
1173 cmd = define_as_prefix (keymap, c);
1175 keymap = get_keymap (cmd, 0, 1);
1176 if (!CONSP (keymap))
1177 /* We must use Fkey_description rather than just passing key to
1178 error; key might be a vector, not a string. */
1179 error ("Key sequence %s uses invalid prefix characters",
1180 SDATA (Fkey_description (key, Qnil)));
1184 /* This function may GC (it calls Fkey_binding). */
1186 DEFUN ("command-remapping", Fcommand_remapping, Scommand_remapping, 1, 1, 0,
1187 doc: /* Return the remapping for command COMMAND in current keymaps.
1188 Returns nil if COMMAND is not remapped (or not a symbol). */)
1189 (command)
1190 Lisp_Object command;
1192 if (!SYMBOLP (command))
1193 return Qnil;
1195 ASET (command_remapping_vector, 1, command);
1196 return Fkey_binding (command_remapping_vector, Qnil, Qt);
1199 /* Value is number if KEY is too long; nil if valid but has no definition. */
1200 /* GC is possible in this function if it autoloads a keymap. */
1202 DEFUN ("lookup-key", Flookup_key, Slookup_key, 2, 3, 0,
1203 doc: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1204 nil means undefined. See doc of `define-key' for kinds of definitions.
1206 A number as value means KEY is "too long";
1207 that is, characters or symbols in it except for the last one
1208 fail to be a valid sequence of prefix characters in KEYMAP.
1209 The number is how many characters at the front of KEY
1210 it takes to reach a non-prefix command.
1212 Normally, `lookup-key' ignores bindings for t, which act as default
1213 bindings, used when nothing else in the keymap applies; this makes it
1214 usable as a general function for probing keymaps. However, if the
1215 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1216 recognize the default bindings, just as `read-key-sequence' does. */)
1217 (keymap, key, accept_default)
1218 Lisp_Object keymap;
1219 Lisp_Object key;
1220 Lisp_Object accept_default;
1222 register int idx;
1223 register Lisp_Object cmd;
1224 register Lisp_Object c;
1225 int length;
1226 int t_ok = !NILP (accept_default);
1227 struct gcpro gcpro1, gcpro2;
1229 GCPRO2 (keymap, key);
1230 keymap = get_keymap (keymap, 1, 1);
1232 if (!VECTORP (key) && !STRINGP (key))
1233 key = wrong_type_argument (Qarrayp, key);
1235 length = XFASTINT (Flength (key));
1236 if (length == 0)
1237 RETURN_UNGCPRO (keymap);
1239 idx = 0;
1240 while (1)
1242 c = Faref (key, make_number (idx++));
1244 if (CONSP (c) && lucid_event_type_list_p (c))
1245 c = Fevent_convert_list (c);
1247 /* Turn the 8th bit of string chars into a meta modifier. */
1248 if (INTEGERP (c) && XINT (c) & 0x80 && STRINGP (key))
1249 XSETINT (c, (XINT (c) | meta_modifier) & ~0x80);
1251 /* Allow string since binding for `menu-bar-select-buffer'
1252 includes the buffer name in the key sequence. */
1253 if (!INTEGERP (c) && !SYMBOLP (c) && !CONSP (c) && !STRINGP (c))
1254 error ("Key sequence contains invalid event");
1256 cmd = access_keymap (keymap, c, t_ok, 0, 1);
1257 if (idx == length)
1258 RETURN_UNGCPRO (cmd);
1260 keymap = get_keymap (cmd, 0, 1);
1261 if (!CONSP (keymap))
1262 RETURN_UNGCPRO (make_number (idx));
1264 QUIT;
1268 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1269 Assume that currently it does not define C at all.
1270 Return the keymap. */
1272 static Lisp_Object
1273 define_as_prefix (keymap, c)
1274 Lisp_Object keymap, c;
1276 Lisp_Object cmd;
1278 cmd = Fmake_sparse_keymap (Qnil);
1279 /* If this key is defined as a prefix in an inherited keymap,
1280 make it a prefix in this map, and make its definition
1281 inherit the other prefix definition. */
1282 cmd = nconc2 (cmd, access_keymap (keymap, c, 0, 0, 0));
1283 store_in_keymap (keymap, c, cmd);
1285 return cmd;
1288 /* Append a key to the end of a key sequence. We always make a vector. */
1290 Lisp_Object
1291 append_key (key_sequence, key)
1292 Lisp_Object key_sequence, key;
1294 Lisp_Object args[2];
1296 args[0] = key_sequence;
1298 args[1] = Fcons (key, Qnil);
1299 return Fvconcat (2, args);
1302 /* Given a event type C which is a symbol,
1303 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1305 static void
1306 silly_event_symbol_error (c)
1307 Lisp_Object c;
1309 Lisp_Object parsed, base, name, assoc;
1310 int modifiers;
1312 parsed = parse_modifiers (c);
1313 modifiers = (int) XUINT (XCAR (XCDR (parsed)));
1314 base = XCAR (parsed);
1315 name = Fsymbol_name (base);
1316 /* This alist includes elements such as ("RET" . "\\r"). */
1317 assoc = Fassoc (name, exclude_keys);
1319 if (! NILP (assoc))
1321 char new_mods[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1322 char *p = new_mods;
1323 Lisp_Object keystring;
1324 if (modifiers & alt_modifier)
1325 { *p++ = '\\'; *p++ = 'A'; *p++ = '-'; }
1326 if (modifiers & ctrl_modifier)
1327 { *p++ = '\\'; *p++ = 'C'; *p++ = '-'; }
1328 if (modifiers & hyper_modifier)
1329 { *p++ = '\\'; *p++ = 'H'; *p++ = '-'; }
1330 if (modifiers & meta_modifier)
1331 { *p++ = '\\'; *p++ = 'M'; *p++ = '-'; }
1332 if (modifiers & shift_modifier)
1333 { *p++ = '\\'; *p++ = 'S'; *p++ = '-'; }
1334 if (modifiers & super_modifier)
1335 { *p++ = '\\'; *p++ = 's'; *p++ = '-'; }
1336 *p = 0;
1338 c = reorder_modifiers (c);
1339 keystring = concat2 (build_string (new_mods), XCDR (assoc));
1341 error ((modifiers & ~meta_modifier
1342 ? "To bind the key %s, use [?%s], not [%s]"
1343 : "To bind the key %s, use \"%s\", not [%s]"),
1344 SDATA (SYMBOL_NAME (c)), SDATA (keystring),
1345 SDATA (SYMBOL_NAME (c)));
1349 /* Global, local, and minor mode keymap stuff. */
1351 /* We can't put these variables inside current_minor_maps, since under
1352 some systems, static gets macro-defined to be the empty string.
1353 Ickypoo. */
1354 static Lisp_Object *cmm_modes = NULL, *cmm_maps = NULL;
1355 static int cmm_size = 0;
1357 /* Error handler used in current_minor_maps. */
1358 static Lisp_Object
1359 current_minor_maps_error ()
1361 return Qnil;
1364 /* Store a pointer to an array of the keymaps of the currently active
1365 minor modes in *buf, and return the number of maps it contains.
1367 This function always returns a pointer to the same buffer, and may
1368 free or reallocate it, so if you want to keep it for a long time or
1369 hand it out to lisp code, copy it. This procedure will be called
1370 for every key sequence read, so the nice lispy approach (return a
1371 new assoclist, list, what have you) for each invocation would
1372 result in a lot of consing over time.
1374 If we used xrealloc/xmalloc and ran out of memory, they would throw
1375 back to the command loop, which would try to read a key sequence,
1376 which would call this function again, resulting in an infinite
1377 loop. Instead, we'll use realloc/malloc and silently truncate the
1378 list, let the key sequence be read, and hope some other piece of
1379 code signals the error. */
1381 current_minor_maps (modeptr, mapptr)
1382 Lisp_Object **modeptr, **mapptr;
1384 int i = 0;
1385 int list_number = 0;
1386 Lisp_Object alist, assoc, var, val;
1387 Lisp_Object emulation_alists;
1388 Lisp_Object lists[2];
1390 emulation_alists = Vemulation_mode_map_alists;
1391 lists[0] = Vminor_mode_overriding_map_alist;
1392 lists[1] = Vminor_mode_map_alist;
1394 for (list_number = 0; list_number < 2; list_number++)
1396 if (CONSP (emulation_alists))
1398 alist = XCAR (emulation_alists);
1399 emulation_alists = XCDR (emulation_alists);
1400 if (SYMBOLP (alist))
1401 alist = find_symbol_value (alist);
1402 list_number = -1;
1404 else
1405 alist = lists[list_number];
1407 for ( ; CONSP (alist); alist = XCDR (alist))
1408 if ((assoc = XCAR (alist), CONSP (assoc))
1409 && (var = XCAR (assoc), SYMBOLP (var))
1410 && (val = find_symbol_value (var), !EQ (val, Qunbound))
1411 && !NILP (val))
1413 Lisp_Object temp;
1415 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1416 and also an entry in Vminor_mode_map_alist,
1417 ignore the latter. */
1418 if (list_number == 1)
1420 val = assq_no_quit (var, lists[0]);
1421 if (!NILP (val))
1422 continue;
1425 if (i >= cmm_size)
1427 int newsize, allocsize;
1428 Lisp_Object *newmodes, *newmaps;
1430 newsize = cmm_size == 0 ? 30 : cmm_size * 2;
1431 allocsize = newsize * sizeof *newmodes;
1433 /* Use malloc here. See the comment above this function.
1434 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1435 BLOCK_INPUT;
1436 newmodes = (Lisp_Object *) malloc (allocsize);
1437 if (newmodes)
1439 if (cmm_modes)
1441 bcopy (cmm_modes, newmodes, cmm_size * sizeof cmm_modes[0]);
1442 free (cmm_modes);
1444 cmm_modes = newmodes;
1447 newmaps = (Lisp_Object *) malloc (allocsize);
1448 if (newmaps)
1450 if (cmm_maps)
1452 bcopy (cmm_maps, newmaps, cmm_size * sizeof cmm_maps[0]);
1453 free (cmm_maps);
1455 cmm_maps = newmaps;
1457 UNBLOCK_INPUT;
1459 if (newmodes == NULL || newmaps == NULL)
1460 break;
1461 cmm_size = newsize;
1464 /* Get the keymap definition--or nil if it is not defined. */
1465 temp = internal_condition_case_1 (Findirect_function,
1466 XCDR (assoc),
1467 Qerror, current_minor_maps_error);
1468 if (!NILP (temp))
1470 cmm_modes[i] = var;
1471 cmm_maps [i] = temp;
1472 i++;
1477 if (modeptr) *modeptr = cmm_modes;
1478 if (mapptr) *mapptr = cmm_maps;
1479 return i;
1482 DEFUN ("current-active-maps", Fcurrent_active_maps, Scurrent_active_maps,
1483 0, 1, 0,
1484 doc: /* Return a list of the currently active keymaps.
1485 OLP if non-nil indicates that we should obey `overriding-local-map' and
1486 `overriding-terminal-local-map'. */)
1487 (olp)
1488 Lisp_Object olp;
1490 Lisp_Object keymaps = Fcons (current_global_map, Qnil);
1492 if (!NILP (olp))
1494 if (!NILP (current_kboard->Voverriding_terminal_local_map))
1495 keymaps = Fcons (current_kboard->Voverriding_terminal_local_map, keymaps);
1496 /* The doc said that overriding-terminal-local-map should
1497 override overriding-local-map. The code used them both,
1498 but it seems clearer to use just one. rms, jan 2005. */
1499 else if (!NILP (Voverriding_local_map))
1500 keymaps = Fcons (Voverriding_local_map, keymaps);
1502 if (NILP (XCDR (keymaps)))
1504 Lisp_Object local;
1505 Lisp_Object *maps;
1506 int nmaps, i;
1508 /* This usually returns the buffer's local map,
1509 but that can be overridden by a `local-map' property. */
1510 local = get_local_map (PT, current_buffer, Qlocal_map);
1511 if (!NILP (local))
1512 keymaps = Fcons (local, keymaps);
1514 /* Now put all the minor mode keymaps on the list. */
1515 nmaps = current_minor_maps (0, &maps);
1517 for (i = --nmaps; i >= 0; i--)
1518 if (!NILP (maps[i]))
1519 keymaps = Fcons (maps[i], keymaps);
1521 /* This returns nil unless there is a `keymap' property. */
1522 local = get_local_map (PT, current_buffer, Qkeymap);
1523 if (!NILP (local))
1524 keymaps = Fcons (local, keymaps);
1527 return keymaps;
1530 /* GC is possible in this function if it autoloads a keymap. */
1532 DEFUN ("key-binding", Fkey_binding, Skey_binding, 1, 3, 0,
1533 doc: /* Return the binding for command KEY in current keymaps.
1534 KEY is a string or vector, a sequence of keystrokes.
1535 The binding is probably a symbol with a function definition.
1537 Normally, `key-binding' ignores bindings for t, which act as default
1538 bindings, used when nothing else in the keymap applies; this makes it
1539 usable as a general function for probing keymaps. However, if the
1540 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1541 recognize the default bindings, just as `read-key-sequence' does.
1543 Like the normal command loop, `key-binding' will remap the command
1544 resulting from looking up KEY by looking up the command in the
1545 current keymaps. However, if the optional third argument NO-REMAP
1546 is non-nil, `key-binding' returns the unmapped command. */)
1547 (key, accept_default, no_remap)
1548 Lisp_Object key, accept_default, no_remap;
1550 Lisp_Object *maps, value;
1551 int nmaps, i;
1552 struct gcpro gcpro1;
1554 GCPRO1 (key);
1556 if (!NILP (current_kboard->Voverriding_terminal_local_map))
1558 value = Flookup_key (current_kboard->Voverriding_terminal_local_map,
1559 key, accept_default);
1560 if (! NILP (value) && !INTEGERP (value))
1561 goto done;
1563 else if (!NILP (Voverriding_local_map))
1565 value = Flookup_key (Voverriding_local_map, key, accept_default);
1566 if (! NILP (value) && !INTEGERP (value))
1567 goto done;
1569 else
1571 Lisp_Object local;
1573 local = get_local_map (PT, current_buffer, Qkeymap);
1574 if (! NILP (local))
1576 value = Flookup_key (local, key, accept_default);
1577 if (! NILP (value) && !INTEGERP (value))
1578 goto done;
1581 nmaps = current_minor_maps (0, &maps);
1582 /* Note that all these maps are GCPRO'd
1583 in the places where we found them. */
1585 for (i = 0; i < nmaps; i++)
1586 if (! NILP (maps[i]))
1588 value = Flookup_key (maps[i], key, accept_default);
1589 if (! NILP (value) && !INTEGERP (value))
1590 goto done;
1593 local = get_local_map (PT, current_buffer, Qlocal_map);
1594 if (! NILP (local))
1596 value = Flookup_key (local, key, accept_default);
1597 if (! NILP (value) && !INTEGERP (value))
1598 goto done;
1602 value = Flookup_key (current_global_map, key, accept_default);
1604 done:
1605 UNGCPRO;
1606 if (NILP (value) || INTEGERP (value))
1607 return Qnil;
1609 /* If the result of the ordinary keymap lookup is an interactive
1610 command, look for a key binding (ie. remapping) for that command. */
1612 if (NILP (no_remap) && SYMBOLP (value))
1614 Lisp_Object value1;
1615 if (value1 = Fcommand_remapping (value), !NILP (value1))
1616 value = value1;
1619 return value;
1622 /* GC is possible in this function if it autoloads a keymap. */
1624 DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 2, 0,
1625 doc: /* Return the binding for command KEYS in current local keymap only.
1626 KEYS is a string or vector, a sequence of keystrokes.
1627 The binding is probably a symbol with a function definition.
1629 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1630 bindings; see the description of `lookup-key' for more details about this. */)
1631 (keys, accept_default)
1632 Lisp_Object keys, accept_default;
1634 register Lisp_Object map;
1635 map = current_buffer->keymap;
1636 if (NILP (map))
1637 return Qnil;
1638 return Flookup_key (map, keys, accept_default);
1641 /* GC is possible in this function if it autoloads a keymap. */
1643 DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 2, 0,
1644 doc: /* Return the binding for command KEYS in current global keymap only.
1645 KEYS is a string or vector, a sequence of keystrokes.
1646 The binding is probably a symbol with a function definition.
1647 This function's return values are the same as those of `lookup-key'
1648 \(which see).
1650 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1651 bindings; see the description of `lookup-key' for more details about this. */)
1652 (keys, accept_default)
1653 Lisp_Object keys, accept_default;
1655 return Flookup_key (current_global_map, keys, accept_default);
1658 /* GC is possible in this function if it autoloads a keymap. */
1660 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 2, 0,
1661 doc: /* Find the visible minor mode bindings of KEY.
1662 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the
1663 the symbol which names the minor mode binding KEY, and BINDING is
1664 KEY's definition in that mode. In particular, if KEY has no
1665 minor-mode bindings, return nil. If the first binding is a
1666 non-prefix, all subsequent bindings will be omitted, since they would
1667 be ignored. Similarly, the list doesn't include non-prefix bindings
1668 that come after prefix bindings.
1670 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1671 bindings; see the description of `lookup-key' for more details about this. */)
1672 (key, accept_default)
1673 Lisp_Object key, accept_default;
1675 Lisp_Object *modes, *maps;
1676 int nmaps;
1677 Lisp_Object binding;
1678 int i, j;
1679 struct gcpro gcpro1, gcpro2;
1681 nmaps = current_minor_maps (&modes, &maps);
1682 /* Note that all these maps are GCPRO'd
1683 in the places where we found them. */
1685 binding = Qnil;
1686 GCPRO2 (key, binding);
1688 for (i = j = 0; i < nmaps; i++)
1689 if (!NILP (maps[i])
1690 && !NILP (binding = Flookup_key (maps[i], key, accept_default))
1691 && !INTEGERP (binding))
1693 if (KEYMAPP (binding))
1694 maps[j++] = Fcons (modes[i], binding);
1695 else if (j == 0)
1696 RETURN_UNGCPRO (Fcons (Fcons (modes[i], binding), Qnil));
1699 UNGCPRO;
1700 return Flist (j, maps);
1703 DEFUN ("define-prefix-command", Fdefine_prefix_command, Sdefine_prefix_command, 1, 3, 0,
1704 doc: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1705 A new sparse keymap is stored as COMMAND's function definition and its value.
1706 If a second optional argument MAPVAR is given, the map is stored as
1707 its value instead of as COMMAND's value; but COMMAND is still defined
1708 as a function.
1709 The third optional argument NAME, if given, supplies a menu name
1710 string for the map. This is required to use the keymap as a menu.
1711 This function returns COMMAND. */)
1712 (command, mapvar, name)
1713 Lisp_Object command, mapvar, name;
1715 Lisp_Object map;
1716 map = Fmake_sparse_keymap (name);
1717 Ffset (command, map);
1718 if (!NILP (mapvar))
1719 Fset (mapvar, map);
1720 else
1721 Fset (command, map);
1722 return command;
1725 DEFUN ("use-global-map", Fuse_global_map, Suse_global_map, 1, 1, 0,
1726 doc: /* Select KEYMAP as the global keymap. */)
1727 (keymap)
1728 Lisp_Object keymap;
1730 keymap = get_keymap (keymap, 1, 1);
1731 current_global_map = keymap;
1733 return Qnil;
1736 DEFUN ("use-local-map", Fuse_local_map, Suse_local_map, 1, 1, 0,
1737 doc: /* Select KEYMAP as the local keymap.
1738 If KEYMAP is nil, that means no local keymap. */)
1739 (keymap)
1740 Lisp_Object keymap;
1742 if (!NILP (keymap))
1743 keymap = get_keymap (keymap, 1, 1);
1745 current_buffer->keymap = keymap;
1747 return Qnil;
1750 DEFUN ("current-local-map", Fcurrent_local_map, Scurrent_local_map, 0, 0, 0,
1751 doc: /* Return current buffer's local keymap, or nil if it has none. */)
1754 return current_buffer->keymap;
1757 DEFUN ("current-global-map", Fcurrent_global_map, Scurrent_global_map, 0, 0, 0,
1758 doc: /* Return the current global keymap. */)
1761 return current_global_map;
1764 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps, Scurrent_minor_mode_maps, 0, 0, 0,
1765 doc: /* Return a list of keymaps for the minor modes of the current buffer. */)
1768 Lisp_Object *maps;
1769 int nmaps = current_minor_maps (0, &maps);
1771 return Flist (nmaps, maps);
1774 /* Help functions for describing and documenting keymaps. */
1777 static void
1778 accessible_keymaps_1 (key, cmd, maps, tail, thisseq, is_metized)
1779 Lisp_Object maps, tail, thisseq, key, cmd;
1780 int is_metized; /* If 1, `key' is assumed to be INTEGERP. */
1782 Lisp_Object tem;
1784 cmd = get_keymap (get_keyelt (cmd, 0), 0, 0);
1785 if (NILP (cmd))
1786 return;
1788 /* Look for and break cycles. */
1789 while (!NILP (tem = Frassq (cmd, maps)))
1791 Lisp_Object prefix = XCAR (tem);
1792 int lim = XINT (Flength (XCAR (tem)));
1793 if (lim <= XINT (Flength (thisseq)))
1794 { /* This keymap was already seen with a smaller prefix. */
1795 int i = 0;
1796 while (i < lim && EQ (Faref (prefix, make_number (i)),
1797 Faref (thisseq, make_number (i))))
1798 i++;
1799 if (i >= lim)
1800 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1801 return;
1803 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1804 but maybe `cmd' occurs again further down in `maps', so keep
1805 looking. */
1806 maps = XCDR (Fmemq (tem, maps));
1809 /* If the last key in thisseq is meta-prefix-char,
1810 turn it into a meta-ized keystroke. We know
1811 that the event we're about to append is an
1812 ascii keystroke since we're processing a
1813 keymap table. */
1814 if (is_metized)
1816 int meta_bit = meta_modifier;
1817 Lisp_Object last = make_number (XINT (Flength (thisseq)) - 1);
1818 tem = Fcopy_sequence (thisseq);
1820 Faset (tem, last, make_number (XINT (key) | meta_bit));
1822 /* This new sequence is the same length as
1823 thisseq, so stick it in the list right
1824 after this one. */
1825 XSETCDR (tail,
1826 Fcons (Fcons (tem, cmd), XCDR (tail)));
1828 else
1830 tem = append_key (thisseq, key);
1831 nconc2 (tail, Fcons (Fcons (tem, cmd), Qnil));
1835 static void
1836 accessible_keymaps_char_table (args, index, cmd)
1837 Lisp_Object args, index, cmd;
1839 accessible_keymaps_1 (index, cmd,
1840 XCAR (XCAR (args)),
1841 XCAR (XCDR (args)),
1842 XCDR (XCDR (args)),
1843 XINT (XCDR (XCAR (args))));
1846 /* This function cannot GC. */
1848 DEFUN ("accessible-keymaps", Faccessible_keymaps, Saccessible_keymaps,
1849 1, 2, 0,
1850 doc: /* Find all keymaps accessible via prefix characters from KEYMAP.
1851 Returns a list of elements of the form (KEYS . MAP), where the sequence
1852 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1853 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1854 An optional argument PREFIX, if non-nil, should be a key sequence;
1855 then the value includes only maps for prefixes that start with PREFIX. */)
1856 (keymap, prefix)
1857 Lisp_Object keymap, prefix;
1859 Lisp_Object maps, tail;
1860 int prefixlen = 0;
1862 /* no need for gcpro because we don't autoload any keymaps. */
1864 if (!NILP (prefix))
1865 prefixlen = XINT (Flength (prefix));
1867 if (!NILP (prefix))
1869 /* If a prefix was specified, start with the keymap (if any) for
1870 that prefix, so we don't waste time considering other prefixes. */
1871 Lisp_Object tem;
1872 tem = Flookup_key (keymap, prefix, Qt);
1873 /* Flookup_key may give us nil, or a number,
1874 if the prefix is not defined in this particular map.
1875 It might even give us a list that isn't a keymap. */
1876 tem = get_keymap (tem, 0, 0);
1877 if (CONSP (tem))
1879 /* Convert PREFIX to a vector now, so that later on
1880 we don't have to deal with the possibility of a string. */
1881 if (STRINGP (prefix))
1883 int i, i_byte, c;
1884 Lisp_Object copy;
1886 copy = Fmake_vector (make_number (SCHARS (prefix)), Qnil);
1887 for (i = 0, i_byte = 0; i < SCHARS (prefix);)
1889 int i_before = i;
1891 FETCH_STRING_CHAR_ADVANCE (c, prefix, i, i_byte);
1892 if (SINGLE_BYTE_CHAR_P (c) && (c & 0200))
1893 c ^= 0200 | meta_modifier;
1894 ASET (copy, i_before, make_number (c));
1896 prefix = copy;
1898 maps = Fcons (Fcons (prefix, tem), Qnil);
1900 else
1901 return Qnil;
1903 else
1904 maps = Fcons (Fcons (Fmake_vector (make_number (0), Qnil),
1905 get_keymap (keymap, 1, 0)),
1906 Qnil);
1908 /* For each map in the list maps,
1909 look at any other maps it points to,
1910 and stick them at the end if they are not already in the list.
1912 This is a breadth-first traversal, where tail is the queue of
1913 nodes, and maps accumulates a list of all nodes visited. */
1915 for (tail = maps; CONSP (tail); tail = XCDR (tail))
1917 register Lisp_Object thisseq, thismap;
1918 Lisp_Object last;
1919 /* Does the current sequence end in the meta-prefix-char? */
1920 int is_metized;
1922 thisseq = Fcar (Fcar (tail));
1923 thismap = Fcdr (Fcar (tail));
1924 last = make_number (XINT (Flength (thisseq)) - 1);
1925 is_metized = (XINT (last) >= 0
1926 /* Don't metize the last char of PREFIX. */
1927 && XINT (last) >= prefixlen
1928 && EQ (Faref (thisseq, last), meta_prefix_char));
1930 for (; CONSP (thismap); thismap = XCDR (thismap))
1932 Lisp_Object elt;
1934 elt = XCAR (thismap);
1936 QUIT;
1938 if (CHAR_TABLE_P (elt))
1940 Lisp_Object indices[3];
1942 map_char_table (accessible_keymaps_char_table, Qnil, elt,
1943 elt, Fcons (Fcons (maps, make_number (is_metized)),
1944 Fcons (tail, thisseq)),
1945 0, indices);
1947 else if (VECTORP (elt))
1949 register int i;
1951 /* Vector keymap. Scan all the elements. */
1952 for (i = 0; i < ASIZE (elt); i++)
1953 accessible_keymaps_1 (make_number (i), AREF (elt, i),
1954 maps, tail, thisseq, is_metized);
1957 else if (CONSP (elt))
1958 accessible_keymaps_1 (XCAR (elt), XCDR (elt),
1959 maps, tail, thisseq,
1960 is_metized && INTEGERP (XCAR (elt)));
1965 return maps;
1968 Lisp_Object Qsingle_key_description, Qkey_description;
1970 /* This function cannot GC. */
1972 DEFUN ("key-description", Fkey_description, Skey_description, 1, 2, 0,
1973 doc: /* Return a pretty description of key-sequence KEYS.
1974 Optional arg PREFIX is the sequence of keys leading up to KEYS.
1975 Control characters turn into "C-foo" sequences, meta into "M-foo",
1976 spaces are put between sequence elements, etc. */)
1977 (keys, prefix)
1978 Lisp_Object keys, prefix;
1980 int len = 0;
1981 int i, i_byte;
1982 Lisp_Object *args;
1983 int size = XINT (Flength (keys));
1984 Lisp_Object list;
1985 Lisp_Object sep = build_string (" ");
1986 Lisp_Object key;
1987 int add_meta = 0;
1989 if (!NILP (prefix))
1990 size += XINT (Flength (prefix));
1992 /* This has one extra element at the end that we don't pass to Fconcat. */
1993 args = (Lisp_Object *) alloca (size * 4 * sizeof (Lisp_Object));
1995 /* In effect, this computes
1996 (mapconcat 'single-key-description keys " ")
1997 but we shouldn't use mapconcat because it can do GC. */
1999 next_list:
2000 if (!NILP (prefix))
2001 list = prefix, prefix = Qnil;
2002 else if (!NILP (keys))
2003 list = keys, keys = Qnil;
2004 else
2006 if (add_meta)
2008 args[len] = Fsingle_key_description (meta_prefix_char, Qnil);
2009 len += 2;
2011 else if (len == 0)
2012 return empty_string;
2013 return Fconcat (len - 1, args);
2016 if (STRINGP (list))
2017 size = SCHARS (list);
2018 else if (VECTORP (list))
2019 size = XVECTOR (list)->size;
2020 else if (CONSP (list))
2021 size = XINT (Flength (list));
2022 else
2023 wrong_type_argument (Qarrayp, list);
2025 i = i_byte = 0;
2027 while (i < size)
2029 if (STRINGP (list))
2031 int c;
2032 FETCH_STRING_CHAR_ADVANCE (c, list, i, i_byte);
2033 if (SINGLE_BYTE_CHAR_P (c) && (c & 0200))
2034 c ^= 0200 | meta_modifier;
2035 XSETFASTINT (key, c);
2037 else if (VECTORP (list))
2039 key = AREF (list, i++);
2041 else
2043 key = XCAR (list);
2044 list = XCDR (list);
2045 i++;
2048 if (add_meta)
2050 if (!INTEGERP (key)
2051 || EQ (key, meta_prefix_char)
2052 || (XINT (key) & meta_modifier))
2054 args[len++] = Fsingle_key_description (meta_prefix_char, Qnil);
2055 args[len++] = sep;
2056 if (EQ (key, meta_prefix_char))
2057 continue;
2059 else
2060 XSETINT (key, (XINT (key) | meta_modifier) & ~0x80);
2061 add_meta = 0;
2063 else if (EQ (key, meta_prefix_char))
2065 add_meta = 1;
2066 continue;
2068 args[len++] = Fsingle_key_description (key, Qnil);
2069 args[len++] = sep;
2071 goto next_list;
2075 char *
2076 push_key_description (c, p, force_multibyte)
2077 register unsigned int c;
2078 register char *p;
2079 int force_multibyte;
2081 unsigned c2;
2083 /* Clear all the meaningless bits above the meta bit. */
2084 c &= meta_modifier | ~ - meta_modifier;
2085 c2 = c & ~(alt_modifier | ctrl_modifier | hyper_modifier
2086 | meta_modifier | shift_modifier | super_modifier);
2088 if (c & alt_modifier)
2090 *p++ = 'A';
2091 *p++ = '-';
2092 c -= alt_modifier;
2094 if ((c & ctrl_modifier) != 0
2095 || (c2 < ' ' && c2 != 27 && c2 != '\t' && c2 != Ctl ('M')))
2097 *p++ = 'C';
2098 *p++ = '-';
2099 c &= ~ctrl_modifier;
2101 if (c & hyper_modifier)
2103 *p++ = 'H';
2104 *p++ = '-';
2105 c -= hyper_modifier;
2107 if (c & meta_modifier)
2109 *p++ = 'M';
2110 *p++ = '-';
2111 c -= meta_modifier;
2113 if (c & shift_modifier)
2115 *p++ = 'S';
2116 *p++ = '-';
2117 c -= shift_modifier;
2119 if (c & super_modifier)
2121 *p++ = 's';
2122 *p++ = '-';
2123 c -= super_modifier;
2125 if (c < 040)
2127 if (c == 033)
2129 *p++ = 'E';
2130 *p++ = 'S';
2131 *p++ = 'C';
2133 else if (c == '\t')
2135 *p++ = 'T';
2136 *p++ = 'A';
2137 *p++ = 'B';
2139 else if (c == Ctl ('M'))
2141 *p++ = 'R';
2142 *p++ = 'E';
2143 *p++ = 'T';
2145 else
2147 /* `C-' already added above. */
2148 if (c > 0 && c <= Ctl ('Z'))
2149 *p++ = c + 0140;
2150 else
2151 *p++ = c + 0100;
2154 else if (c == 0177)
2156 *p++ = 'D';
2157 *p++ = 'E';
2158 *p++ = 'L';
2160 else if (c == ' ')
2162 *p++ = 'S';
2163 *p++ = 'P';
2164 *p++ = 'C';
2166 else if (c < 128
2167 || (NILP (current_buffer->enable_multibyte_characters)
2168 && SINGLE_BYTE_CHAR_P (c)
2169 && !force_multibyte))
2171 *p++ = c;
2173 else
2175 int valid_p = SINGLE_BYTE_CHAR_P (c) || char_valid_p (c, 0);
2177 if (force_multibyte && valid_p)
2179 if (SINGLE_BYTE_CHAR_P (c))
2180 c = unibyte_char_to_multibyte (c);
2181 p += CHAR_STRING (c, p);
2183 else if (NILP (current_buffer->enable_multibyte_characters)
2184 || valid_p)
2186 int bit_offset;
2187 *p++ = '\\';
2188 /* The biggest character code uses 19 bits. */
2189 for (bit_offset = 18; bit_offset >= 0; bit_offset -= 3)
2191 if (c >= (1 << bit_offset))
2192 *p++ = ((c & (7 << bit_offset)) >> bit_offset) + '0';
2195 else
2196 p += CHAR_STRING (c, p);
2199 return p;
2202 /* This function cannot GC. */
2204 DEFUN ("single-key-description", Fsingle_key_description,
2205 Ssingle_key_description, 1, 2, 0,
2206 doc: /* Return a pretty description of command character KEY.
2207 Control characters turn into C-whatever, etc.
2208 Optional argument NO-ANGLES non-nil means don't put angle brackets
2209 around function keys and event symbols. */)
2210 (key, no_angles)
2211 Lisp_Object key, no_angles;
2213 if (CONSP (key) && lucid_event_type_list_p (key))
2214 key = Fevent_convert_list (key);
2216 key = EVENT_HEAD (key);
2218 if (INTEGERP (key)) /* Normal character */
2220 unsigned int charset, c1, c2;
2221 int without_bits = XINT (key) & ~((-1) << CHARACTERBITS);
2223 if (SINGLE_BYTE_CHAR_P (without_bits))
2224 charset = 0;
2225 else
2226 SPLIT_CHAR (without_bits, charset, c1, c2);
2228 if (charset
2229 && CHARSET_DEFINED_P (charset)
2230 && ((c1 >= 0 && c1 < 32)
2231 || (c2 >= 0 && c2 < 32)))
2233 /* Handle a generic character. */
2234 Lisp_Object name;
2235 name = CHARSET_TABLE_INFO (charset, CHARSET_LONG_NAME_IDX);
2236 CHECK_STRING (name);
2237 return concat2 (build_string ("Character set "), name);
2239 else
2241 char tem[KEY_DESCRIPTION_SIZE], *end;
2242 int nbytes, nchars;
2243 Lisp_Object string;
2245 end = push_key_description (XUINT (key), tem, 1);
2246 nbytes = end - tem;
2247 nchars = multibyte_chars_in_text (tem, nbytes);
2248 if (nchars == nbytes)
2250 *end = '\0';
2251 string = build_string (tem);
2253 else
2254 string = make_multibyte_string (tem, nchars, nbytes);
2255 return string;
2258 else if (SYMBOLP (key)) /* Function key or event-symbol */
2260 if (NILP (no_angles))
2262 char *buffer
2263 = (char *) alloca (SBYTES (SYMBOL_NAME (key)) + 5);
2264 sprintf (buffer, "<%s>", SDATA (SYMBOL_NAME (key)));
2265 return build_string (buffer);
2267 else
2268 return Fsymbol_name (key);
2270 else if (STRINGP (key)) /* Buffer names in the menubar. */
2271 return Fcopy_sequence (key);
2272 else
2273 error ("KEY must be an integer, cons, symbol, or string");
2274 return Qnil;
2277 char *
2278 push_text_char_description (c, p)
2279 register unsigned int c;
2280 register char *p;
2282 if (c >= 0200)
2284 *p++ = 'M';
2285 *p++ = '-';
2286 c -= 0200;
2288 if (c < 040)
2290 *p++ = '^';
2291 *p++ = c + 64; /* 'A' - 1 */
2293 else if (c == 0177)
2295 *p++ = '^';
2296 *p++ = '?';
2298 else
2299 *p++ = c;
2300 return p;
2303 /* This function cannot GC. */
2305 DEFUN ("text-char-description", Ftext_char_description, Stext_char_description, 1, 1, 0,
2306 doc: /* Return a pretty description of file-character CHARACTER.
2307 Control characters turn into "^char", etc. This differs from
2308 `single-key-description' which turns them into "C-char".
2309 Also, this function recognizes the 2**7 bit as the Meta character,
2310 whereas `single-key-description' uses the 2**27 bit for Meta.
2311 See Info node `(elisp)Describing Characters' for examples. */)
2312 (character)
2313 Lisp_Object character;
2315 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2316 unsigned char str[6];
2317 int c;
2319 CHECK_NUMBER (character);
2321 c = XINT (character);
2322 if (!SINGLE_BYTE_CHAR_P (c))
2324 int len = CHAR_STRING (c, str);
2326 return make_multibyte_string (str, 1, len);
2329 *push_text_char_description (c & 0377, str) = 0;
2331 return build_string (str);
2334 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2335 a meta bit. */
2336 static int
2337 ascii_sequence_p (seq)
2338 Lisp_Object seq;
2340 int i;
2341 int len = XINT (Flength (seq));
2343 for (i = 0; i < len; i++)
2345 Lisp_Object ii, elt;
2347 XSETFASTINT (ii, i);
2348 elt = Faref (seq, ii);
2350 if (!INTEGERP (elt)
2351 || (XUINT (elt) & ~CHAR_META) >= 0x80)
2352 return 0;
2355 return 1;
2359 /* where-is - finding a command in a set of keymaps. */
2361 static Lisp_Object where_is_internal ();
2362 static Lisp_Object where_is_internal_1 ();
2363 static void where_is_internal_2 ();
2365 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2366 Returns the first non-nil binding found in any of those maps. */
2368 static Lisp_Object
2369 shadow_lookup (shadow, key, flag)
2370 Lisp_Object shadow, key, flag;
2372 Lisp_Object tail, value;
2374 for (tail = shadow; CONSP (tail); tail = XCDR (tail))
2376 value = Flookup_key (XCAR (tail), key, flag);
2377 if (!NILP (value) && !NATNUMP (value))
2378 return value;
2380 return Qnil;
2383 static Lisp_Object Vmouse_events;
2385 /* This function can GC if Flookup_key autoloads any keymaps. */
2387 static Lisp_Object
2388 where_is_internal (definition, keymaps, firstonly, noindirect, no_remap)
2389 Lisp_Object definition, keymaps;
2390 Lisp_Object firstonly, noindirect, no_remap;
2392 Lisp_Object maps = Qnil;
2393 Lisp_Object found, sequences;
2394 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2395 /* 1 means ignore all menu bindings entirely. */
2396 int nomenus = !NILP (firstonly) && !EQ (firstonly, Qnon_ascii);
2398 /* If this command is remapped, then it has no key bindings
2399 of its own. */
2400 if (NILP (no_remap) && SYMBOLP (definition))
2402 Lisp_Object tem;
2403 if (tem = Fcommand_remapping (definition), !NILP (tem))
2404 return Qnil;
2407 found = keymaps;
2408 while (CONSP (found))
2410 maps =
2411 nconc2 (maps,
2412 Faccessible_keymaps (get_keymap (XCAR (found), 1, 0), Qnil));
2413 found = XCDR (found);
2416 GCPRO5 (definition, keymaps, maps, found, sequences);
2417 found = Qnil;
2418 sequences = Qnil;
2420 for (; !NILP (maps); maps = Fcdr (maps))
2422 /* Key sequence to reach map, and the map that it reaches */
2423 register Lisp_Object this, map, tem;
2425 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2426 [M-CHAR] sequences, check if last character of the sequence
2427 is the meta-prefix char. */
2428 Lisp_Object last;
2429 int last_is_meta;
2431 this = Fcar (Fcar (maps));
2432 map = Fcdr (Fcar (maps));
2433 last = make_number (XINT (Flength (this)) - 1);
2434 last_is_meta = (XINT (last) >= 0
2435 && EQ (Faref (this, last), meta_prefix_char));
2437 /* if (nomenus && !ascii_sequence_p (this)) */
2438 if (nomenus && XINT (last) >= 0
2439 && SYMBOLP (tem = Faref (this, make_number (0)))
2440 && !NILP (Fmemq (XCAR (parse_modifiers (tem)), Vmouse_events)))
2441 /* If no menu entries should be returned, skip over the
2442 keymaps bound to `menu-bar' and `tool-bar' and other
2443 non-ascii prefixes like `C-down-mouse-2'. */
2444 continue;
2446 QUIT;
2448 while (CONSP (map))
2450 /* Because the code we want to run on each binding is rather
2451 large, we don't want to have two separate loop bodies for
2452 sparse keymap bindings and tables; we want to iterate one
2453 loop body over both keymap and vector bindings.
2455 For this reason, if Fcar (map) is a vector, we don't
2456 advance map to the next element until i indicates that we
2457 have finished off the vector. */
2458 Lisp_Object elt, key, binding;
2459 elt = XCAR (map);
2460 map = XCDR (map);
2462 sequences = Qnil;
2464 QUIT;
2466 /* Set key and binding to the current key and binding, and
2467 advance map and i to the next binding. */
2468 if (VECTORP (elt))
2470 Lisp_Object sequence;
2471 int i;
2472 /* In a vector, look at each element. */
2473 for (i = 0; i < XVECTOR (elt)->size; i++)
2475 binding = AREF (elt, i);
2476 XSETFASTINT (key, i);
2477 sequence = where_is_internal_1 (binding, key, definition,
2478 noindirect, this,
2479 last, nomenus, last_is_meta);
2480 if (!NILP (sequence))
2481 sequences = Fcons (sequence, sequences);
2484 else if (CHAR_TABLE_P (elt))
2486 Lisp_Object indices[3];
2487 Lisp_Object args;
2489 args = Fcons (Fcons (Fcons (definition, noindirect),
2490 Qnil), /* Result accumulator. */
2491 Fcons (Fcons (this, last),
2492 Fcons (make_number (nomenus),
2493 make_number (last_is_meta))));
2494 map_char_table (where_is_internal_2, Qnil, elt, elt, args,
2495 0, indices);
2496 sequences = XCDR (XCAR (args));
2498 else if (CONSP (elt))
2500 Lisp_Object sequence;
2502 key = XCAR (elt);
2503 binding = XCDR (elt);
2505 sequence = where_is_internal_1 (binding, key, definition,
2506 noindirect, this,
2507 last, nomenus, last_is_meta);
2508 if (!NILP (sequence))
2509 sequences = Fcons (sequence, sequences);
2513 while (!NILP (sequences))
2515 Lisp_Object sequence, remapped, function;
2517 sequence = XCAR (sequences);
2518 sequences = XCDR (sequences);
2520 /* If the current sequence is a command remapping with
2521 format [remap COMMAND], find the key sequences
2522 which run COMMAND, and use those sequences instead. */
2523 remapped = Qnil;
2524 if (NILP (no_remap)
2525 && VECTORP (sequence) && XVECTOR (sequence)->size == 2
2526 && EQ (AREF (sequence, 0), Qremap)
2527 && (function = AREF (sequence, 1), SYMBOLP (function)))
2529 Lisp_Object remapped1;
2531 remapped1 = where_is_internal (function, keymaps, firstonly, noindirect, Qt);
2532 if (CONSP (remapped1))
2534 /* Verify that this key binding actually maps to the
2535 remapped command (see below). */
2536 if (!EQ (shadow_lookup (keymaps, XCAR (remapped1), Qnil), function))
2537 continue;
2538 sequence = XCAR (remapped1);
2539 remapped = XCDR (remapped1);
2540 goto record_sequence;
2544 /* Verify that this key binding is not shadowed by another
2545 binding for the same key, before we say it exists.
2547 Mechanism: look for local definition of this key and if
2548 it is defined and does not match what we found then
2549 ignore this key.
2551 Either nil or number as value from Flookup_key
2552 means undefined. */
2553 if (!EQ (shadow_lookup (keymaps, sequence, Qnil), definition))
2554 continue;
2556 record_sequence:
2557 /* It is a true unshadowed match. Record it, unless it's already
2558 been seen (as could happen when inheriting keymaps). */
2559 if (NILP (Fmember (sequence, found)))
2560 found = Fcons (sequence, found);
2562 /* If firstonly is Qnon_ascii, then we can return the first
2563 binding we find. If firstonly is not Qnon_ascii but not
2564 nil, then we should return the first ascii-only binding
2565 we find. */
2566 if (EQ (firstonly, Qnon_ascii))
2567 RETURN_UNGCPRO (sequence);
2568 else if (!NILP (firstonly) && ascii_sequence_p (sequence))
2569 RETURN_UNGCPRO (sequence);
2571 if (CONSP (remapped))
2573 sequence = XCAR (remapped);
2574 remapped = XCDR (remapped);
2575 goto record_sequence;
2581 UNGCPRO;
2583 found = Fnreverse (found);
2585 /* firstonly may have been t, but we may have gone all the way through
2586 the keymaps without finding an all-ASCII key sequence. So just
2587 return the best we could find. */
2588 if (!NILP (firstonly))
2589 return Fcar (found);
2591 return found;
2594 DEFUN ("where-is-internal", Fwhere_is_internal, Swhere_is_internal, 1, 5, 0,
2595 doc: /* Return list of keys that invoke DEFINITION.
2596 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2597 If KEYMAP is nil, search all the currently active keymaps.
2598 If KEYMAP is a list of keymaps, search only those keymaps.
2600 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2601 rather than a list of all possible key sequences.
2602 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2603 no matter what it is.
2604 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2605 \(or their meta variants) and entirely reject menu bindings.
2607 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2608 to other keymaps or slots. This makes it possible to search for an
2609 indirect definition itself.
2611 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2612 that invoke a command which is remapped to DEFINITION, but include the
2613 remapped command in the returned list. */)
2614 (definition, keymap, firstonly, noindirect, no_remap)
2615 Lisp_Object definition, keymap;
2616 Lisp_Object firstonly, noindirect, no_remap;
2618 Lisp_Object sequences, keymaps;
2619 /* 1 means ignore all menu bindings entirely. */
2620 int nomenus = !NILP (firstonly) && !EQ (firstonly, Qnon_ascii);
2621 Lisp_Object result;
2623 /* Find the relevant keymaps. */
2624 if (CONSP (keymap) && KEYMAPP (XCAR (keymap)))
2625 keymaps = keymap;
2626 else if (!NILP (keymap))
2627 keymaps = Fcons (keymap, Fcons (current_global_map, Qnil));
2628 else
2629 keymaps = Fcurrent_active_maps (Qnil);
2631 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2632 We don't really need to check `keymap'. */
2633 if (nomenus && NILP (noindirect) && NILP (keymap))
2635 Lisp_Object *defns;
2636 int i, j, n;
2637 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2639 /* Check heuristic-consistency of the cache. */
2640 if (NILP (Fequal (keymaps, where_is_cache_keymaps)))
2641 where_is_cache = Qnil;
2643 if (NILP (where_is_cache))
2645 /* We need to create the cache. */
2646 Lisp_Object args[2];
2647 where_is_cache = Fmake_hash_table (0, args);
2648 where_is_cache_keymaps = Qt;
2650 /* Fill in the cache. */
2651 GCPRO5 (definition, keymaps, firstonly, noindirect, no_remap);
2652 where_is_internal (definition, keymaps, firstonly, noindirect, no_remap);
2653 UNGCPRO;
2655 where_is_cache_keymaps = keymaps;
2658 /* We want to process definitions from the last to the first.
2659 Instead of consing, copy definitions to a vector and step
2660 over that vector. */
2661 sequences = Fgethash (definition, where_is_cache, Qnil);
2662 n = XINT (Flength (sequences));
2663 defns = (Lisp_Object *) alloca (n * sizeof *defns);
2664 for (i = 0; CONSP (sequences); sequences = XCDR (sequences))
2665 defns[i++] = XCAR (sequences);
2667 /* Verify that the key bindings are not shadowed. Note that
2668 the following can GC. */
2669 GCPRO2 (definition, keymaps);
2670 result = Qnil;
2671 j = -1;
2672 for (i = n - 1; i >= 0; --i)
2673 if (EQ (shadow_lookup (keymaps, defns[i], Qnil), definition))
2675 if (ascii_sequence_p (defns[i]))
2676 break;
2677 else if (j < 0)
2678 j = i;
2681 result = i >= 0 ? defns[i] : (j >= 0 ? defns[j] : Qnil);
2682 UNGCPRO;
2684 else
2686 /* Kill the cache so that where_is_internal_1 doesn't think
2687 we're filling it up. */
2688 where_is_cache = Qnil;
2689 result = where_is_internal (definition, keymaps, firstonly, noindirect, no_remap);
2692 return result;
2695 /* This is the function that Fwhere_is_internal calls using map_char_table.
2696 ARGS has the form
2697 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2699 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2700 Since map_char_table doesn't really use the return value from this function,
2701 we the result append to RESULT, the slot in ARGS.
2703 This function can GC because it calls where_is_internal_1 which can
2704 GC. */
2706 static void
2707 where_is_internal_2 (args, key, binding)
2708 Lisp_Object args, key, binding;
2710 Lisp_Object definition, noindirect, this, last;
2711 Lisp_Object result, sequence;
2712 int nomenus, last_is_meta;
2713 struct gcpro gcpro1, gcpro2, gcpro3;
2715 GCPRO3 (args, key, binding);
2716 result = XCDR (XCAR (args));
2717 definition = XCAR (XCAR (XCAR (args)));
2718 noindirect = XCDR (XCAR (XCAR (args)));
2719 this = XCAR (XCAR (XCDR (args)));
2720 last = XCDR (XCAR (XCDR (args)));
2721 nomenus = XFASTINT (XCAR (XCDR (XCDR (args))));
2722 last_is_meta = XFASTINT (XCDR (XCDR (XCDR (args))));
2724 sequence = where_is_internal_1 (binding, key, definition, noindirect,
2725 this, last, nomenus, last_is_meta);
2727 if (!NILP (sequence))
2728 XSETCDR (XCAR (args), Fcons (sequence, result));
2730 UNGCPRO;
2734 /* This function cannot GC. */
2736 static Lisp_Object
2737 where_is_internal_1 (binding, key, definition, noindirect, this, last,
2738 nomenus, last_is_meta)
2739 Lisp_Object binding, key, definition, noindirect, this, last;
2740 int nomenus, last_is_meta;
2742 Lisp_Object sequence;
2744 /* Search through indirections unless that's not wanted. */
2745 if (NILP (noindirect))
2746 binding = get_keyelt (binding, 0);
2748 /* End this iteration if this element does not match
2749 the target. */
2751 if (!(!NILP (where_is_cache) /* everything "matches" during cache-fill. */
2752 || EQ (binding, definition)
2753 || (CONSP (definition) && !NILP (Fequal (binding, definition)))))
2754 /* Doesn't match. */
2755 return Qnil;
2757 /* We have found a match. Construct the key sequence where we found it. */
2758 if (INTEGERP (key) && last_is_meta)
2760 sequence = Fcopy_sequence (this);
2761 Faset (sequence, last, make_number (XINT (key) | meta_modifier));
2763 else
2764 sequence = append_key (this, key);
2766 if (!NILP (where_is_cache))
2768 Lisp_Object sequences = Fgethash (binding, where_is_cache, Qnil);
2769 Fputhash (binding, Fcons (sequence, sequences), where_is_cache);
2770 return Qnil;
2772 else
2773 return sequence;
2776 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2778 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings, Sdescribe_buffer_bindings, 1, 3, 0,
2779 doc: /* Insert the list of all defined keys and their definitions.
2780 The list is inserted in the current buffer, while the bindings are
2781 looked up in BUFFER.
2782 The optional argument PREFIX, if non-nil, should be a key sequence;
2783 then we display only bindings that start with that prefix.
2784 The optional argument MENUS, if non-nil, says to mention menu bindings.
2785 \(Ordinarily these are omitted from the output.) */)
2786 (buffer, prefix, menus)
2787 Lisp_Object buffer, prefix, menus;
2789 Lisp_Object outbuf, shadow;
2790 int nomenu = NILP (menus);
2791 register Lisp_Object start1;
2792 struct gcpro gcpro1;
2794 char *alternate_heading
2795 = "\
2796 Keyboard translations:\n\n\
2797 You type Translation\n\
2798 -------- -----------\n";
2800 shadow = Qnil;
2801 GCPRO1 (shadow);
2803 outbuf = Fcurrent_buffer ();
2805 /* Report on alternates for keys. */
2806 if (STRINGP (Vkeyboard_translate_table) && !NILP (prefix))
2808 int c;
2809 const unsigned char *translate = SDATA (Vkeyboard_translate_table);
2810 int translate_len = SCHARS (Vkeyboard_translate_table);
2812 for (c = 0; c < translate_len; c++)
2813 if (translate[c] != c)
2815 char buf[KEY_DESCRIPTION_SIZE];
2816 char *bufend;
2818 if (alternate_heading)
2820 insert_string (alternate_heading);
2821 alternate_heading = 0;
2824 bufend = push_key_description (translate[c], buf, 1);
2825 insert (buf, bufend - buf);
2826 Findent_to (make_number (16), make_number (1));
2827 bufend = push_key_description (c, buf, 1);
2828 insert (buf, bufend - buf);
2830 insert ("\n", 1);
2833 insert ("\n", 1);
2836 if (!NILP (Vkey_translation_map))
2837 describe_map_tree (Vkey_translation_map, 0, Qnil, prefix,
2838 "Key translations", nomenu, 1, 0, 0);
2841 /* Print the (major mode) local map. */
2842 start1 = Qnil;
2843 if (!NILP (current_kboard->Voverriding_terminal_local_map))
2844 start1 = current_kboard->Voverriding_terminal_local_map;
2845 else if (!NILP (Voverriding_local_map))
2846 start1 = Voverriding_local_map;
2848 if (!NILP (start1))
2850 describe_map_tree (start1, 1, shadow, prefix,
2851 "\f\nOverriding Bindings", nomenu, 0, 0, 0);
2852 shadow = Fcons (start1, shadow);
2854 else
2856 /* Print the minor mode and major mode keymaps. */
2857 int i, nmaps;
2858 Lisp_Object *modes, *maps;
2860 /* Temporarily switch to `buffer', so that we can get that buffer's
2861 minor modes correctly. */
2862 Fset_buffer (buffer);
2864 nmaps = current_minor_maps (&modes, &maps);
2865 Fset_buffer (outbuf);
2867 start1 = get_local_map (BUF_PT (XBUFFER (buffer)),
2868 XBUFFER (buffer), Qkeymap);
2869 if (!NILP (start1))
2871 describe_map_tree (start1, 1, shadow, prefix,
2872 "\f\n`keymap' Property Bindings", nomenu,
2873 0, 0, 0);
2874 shadow = Fcons (start1, shadow);
2877 /* Print the minor mode maps. */
2878 for (i = 0; i < nmaps; i++)
2880 /* The title for a minor mode keymap
2881 is constructed at run time.
2882 We let describe_map_tree do the actual insertion
2883 because it takes care of other features when doing so. */
2884 char *title, *p;
2886 if (!SYMBOLP (modes[i]))
2887 abort();
2889 p = title = (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes[i])));
2890 *p++ = '\f';
2891 *p++ = '\n';
2892 *p++ = '`';
2893 bcopy (SDATA (SYMBOL_NAME (modes[i])), p,
2894 SCHARS (SYMBOL_NAME (modes[i])));
2895 p += SCHARS (SYMBOL_NAME (modes[i]));
2896 *p++ = '\'';
2897 bcopy (" Minor Mode Bindings", p, sizeof (" Minor Mode Bindings") - 1);
2898 p += sizeof (" Minor Mode Bindings") - 1;
2899 *p = 0;
2901 describe_map_tree (maps[i], 1, shadow, prefix,
2902 title, nomenu, 0, 0, 0);
2903 shadow = Fcons (maps[i], shadow);
2906 start1 = get_local_map (BUF_PT (XBUFFER (buffer)),
2907 XBUFFER (buffer), Qlocal_map);
2908 if (!NILP (start1))
2910 if (EQ (start1, XBUFFER (buffer)->keymap))
2911 describe_map_tree (start1, 1, shadow, prefix,
2912 "\f\nMajor Mode Bindings", nomenu, 0, 0, 0);
2913 else
2914 describe_map_tree (start1, 1, shadow, prefix,
2915 "\f\n`local-map' Property Bindings",
2916 nomenu, 0, 0, 0);
2918 shadow = Fcons (start1, shadow);
2922 describe_map_tree (current_global_map, 1, shadow, prefix,
2923 "\f\nGlobal Bindings", nomenu, 0, 1, 0);
2925 /* Print the function-key-map translations under this prefix. */
2926 if (!NILP (Vfunction_key_map))
2927 describe_map_tree (Vfunction_key_map, 0, Qnil, prefix,
2928 "\f\nFunction key map translations", nomenu, 1, 0, 0);
2930 UNGCPRO;
2931 return Qnil;
2934 /* Insert a description of the key bindings in STARTMAP,
2935 followed by those of all maps reachable through STARTMAP.
2936 If PARTIAL is nonzero, omit certain "uninteresting" commands
2937 (such as `undefined').
2938 If SHADOW is non-nil, it is a list of maps;
2939 don't mention keys which would be shadowed by any of them.
2940 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2941 TITLE, if not 0, is a string to insert at the beginning.
2942 TITLE should not end with a colon or a newline; we supply that.
2943 If NOMENU is not 0, then omit menu-bar commands.
2945 If TRANSL is nonzero, the definitions are actually key translations
2946 so print strings and vectors differently.
2948 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2949 to look through.
2951 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
2952 don't omit it; instead, mention it but say it is shadowed. */
2954 void
2955 describe_map_tree (startmap, partial, shadow, prefix, title, nomenu, transl,
2956 always_title, mention_shadow)
2957 Lisp_Object startmap, shadow, prefix;
2958 int partial;
2959 char *title;
2960 int nomenu;
2961 int transl;
2962 int always_title;
2963 int mention_shadow;
2965 Lisp_Object maps, orig_maps, seen, sub_shadows;
2966 struct gcpro gcpro1, gcpro2, gcpro3;
2967 int something = 0;
2968 char *key_heading
2969 = "\
2970 key binding\n\
2971 --- -------\n";
2973 orig_maps = maps = Faccessible_keymaps (startmap, prefix);
2974 seen = Qnil;
2975 sub_shadows = Qnil;
2976 GCPRO3 (maps, seen, sub_shadows);
2978 if (nomenu)
2980 Lisp_Object list;
2982 /* Delete from MAPS each element that is for the menu bar. */
2983 for (list = maps; !NILP (list); list = XCDR (list))
2985 Lisp_Object elt, prefix, tem;
2987 elt = Fcar (list);
2988 prefix = Fcar (elt);
2989 if (XVECTOR (prefix)->size >= 1)
2991 tem = Faref (prefix, make_number (0));
2992 if (EQ (tem, Qmenu_bar))
2993 maps = Fdelq (elt, maps);
2998 if (!NILP (maps) || always_title)
3000 if (title)
3002 insert_string (title);
3003 if (!NILP (prefix))
3005 insert_string (" Starting With ");
3006 insert1 (Fkey_description (prefix, Qnil));
3008 insert_string (":\n");
3010 insert_string (key_heading);
3011 something = 1;
3014 for (; !NILP (maps); maps = Fcdr (maps))
3016 register Lisp_Object elt, prefix, tail;
3018 elt = Fcar (maps);
3019 prefix = Fcar (elt);
3021 sub_shadows = Qnil;
3023 for (tail = shadow; CONSP (tail); tail = XCDR (tail))
3025 Lisp_Object shmap;
3027 shmap = XCAR (tail);
3029 /* If the sequence by which we reach this keymap is zero-length,
3030 then the shadow map for this keymap is just SHADOW. */
3031 if ((STRINGP (prefix) && SCHARS (prefix) == 0)
3032 || (VECTORP (prefix) && XVECTOR (prefix)->size == 0))
3034 /* If the sequence by which we reach this keymap actually has
3035 some elements, then the sequence's definition in SHADOW is
3036 what we should use. */
3037 else
3039 shmap = Flookup_key (shmap, Fcar (elt), Qt);
3040 if (INTEGERP (shmap))
3041 shmap = Qnil;
3044 /* If shmap is not nil and not a keymap,
3045 it completely shadows this map, so don't
3046 describe this map at all. */
3047 if (!NILP (shmap) && !KEYMAPP (shmap))
3048 goto skip;
3050 if (!NILP (shmap))
3051 sub_shadows = Fcons (shmap, sub_shadows);
3054 /* Maps we have already listed in this loop shadow this map. */
3055 for (tail = orig_maps; !EQ (tail, maps); tail = XCDR (tail))
3057 Lisp_Object tem;
3058 tem = Fequal (Fcar (XCAR (tail)), prefix);
3059 if (!NILP (tem))
3060 sub_shadows = Fcons (XCDR (XCAR (tail)), sub_shadows);
3063 describe_map (Fcdr (elt), prefix,
3064 transl ? describe_translation : describe_command,
3065 partial, sub_shadows, &seen, nomenu, mention_shadow);
3067 skip: ;
3070 if (something)
3071 insert_string ("\n");
3073 UNGCPRO;
3076 static int previous_description_column;
3078 static void
3079 describe_command (definition, args)
3080 Lisp_Object definition, args;
3082 register Lisp_Object tem1;
3083 int column = (int) current_column (); /* iftc */
3084 int description_column;
3086 /* If column 16 is no good, go to col 32;
3087 but don't push beyond that--go to next line instead. */
3088 if (column > 30)
3090 insert_char ('\n');
3091 description_column = 32;
3093 else if (column > 14 || (column > 10 && previous_description_column == 32))
3094 description_column = 32;
3095 else
3096 description_column = 16;
3098 Findent_to (make_number (description_column), make_number (1));
3099 previous_description_column = description_column;
3101 if (SYMBOLP (definition))
3103 tem1 = SYMBOL_NAME (definition);
3104 insert1 (tem1);
3105 insert_string ("\n");
3107 else if (STRINGP (definition) || VECTORP (definition))
3108 insert_string ("Keyboard Macro\n");
3109 else if (KEYMAPP (definition))
3110 insert_string ("Prefix Command\n");
3111 else
3112 insert_string ("??\n");
3115 static void
3116 describe_translation (definition, args)
3117 Lisp_Object definition, args;
3119 register Lisp_Object tem1;
3121 Findent_to (make_number (16), make_number (1));
3123 if (SYMBOLP (definition))
3125 tem1 = SYMBOL_NAME (definition);
3126 insert1 (tem1);
3127 insert_string ("\n");
3129 else if (STRINGP (definition) || VECTORP (definition))
3131 insert1 (Fkey_description (definition, Qnil));
3132 insert_string ("\n");
3134 else if (KEYMAPP (definition))
3135 insert_string ("Prefix Command\n");
3136 else
3137 insert_string ("??\n");
3140 /* Describe the contents of map MAP, assuming that this map itself is
3141 reached by the sequence of prefix keys PREFIX (a string or vector).
3142 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3144 static void
3145 describe_map (map, prefix, elt_describer, partial, shadow,
3146 seen, nomenu, mention_shadow)
3147 register Lisp_Object map;
3148 Lisp_Object prefix;
3149 void (*elt_describer) P_ ((Lisp_Object, Lisp_Object));
3150 int partial;
3151 Lisp_Object shadow;
3152 Lisp_Object *seen;
3153 int nomenu;
3154 int mention_shadow;
3156 Lisp_Object tail, definition, event;
3157 Lisp_Object tem;
3158 Lisp_Object suppress;
3159 Lisp_Object kludge;
3160 int first = 1;
3161 struct gcpro gcpro1, gcpro2, gcpro3;
3163 suppress = Qnil;
3165 if (partial)
3166 suppress = intern ("suppress-keymap");
3168 /* This vector gets used to present single keys to Flookup_key. Since
3169 that is done once per keymap element, we don't want to cons up a
3170 fresh vector every time. */
3171 kludge = Fmake_vector (make_number (1), Qnil);
3172 definition = Qnil;
3174 GCPRO3 (prefix, definition, kludge);
3176 for (tail = map; CONSP (tail); tail = XCDR (tail))
3178 QUIT;
3180 if (VECTORP (XCAR (tail))
3181 || CHAR_TABLE_P (XCAR (tail)))
3182 describe_vector (XCAR (tail),
3183 prefix, Qnil, elt_describer, partial, shadow, map,
3184 (int *)0, 0, 1, mention_shadow);
3185 else if (CONSP (XCAR (tail)))
3187 int this_shadowed = 0;
3188 event = XCAR (XCAR (tail));
3190 /* Ignore bindings whose "prefix" are not really valid events.
3191 (We get these in the frames and buffers menu.) */
3192 if (!(SYMBOLP (event) || INTEGERP (event)))
3193 continue;
3195 if (nomenu && EQ (event, Qmenu_bar))
3196 continue;
3198 definition = get_keyelt (XCDR (XCAR (tail)), 0);
3200 /* Don't show undefined commands or suppressed commands. */
3201 if (NILP (definition)) continue;
3202 if (SYMBOLP (definition) && partial)
3204 tem = Fget (definition, suppress);
3205 if (!NILP (tem))
3206 continue;
3209 /* Don't show a command that isn't really visible
3210 because a local definition of the same key shadows it. */
3212 ASET (kludge, 0, event);
3213 if (!NILP (shadow))
3215 tem = shadow_lookup (shadow, kludge, Qt);
3216 if (!NILP (tem))
3218 if (mention_shadow)
3219 this_shadowed = 1;
3220 else
3221 continue;
3225 tem = Flookup_key (map, kludge, Qt);
3226 if (!EQ (tem, definition)) continue;
3228 if (first)
3230 previous_description_column = 0;
3231 insert ("\n", 1);
3232 first = 0;
3235 /* THIS gets the string to describe the character EVENT. */
3236 insert1 (Fkey_description (kludge, prefix));
3238 /* Print a description of the definition of this character.
3239 elt_describer will take care of spacing out far enough
3240 for alignment purposes. */
3241 (*elt_describer) (definition, Qnil);
3243 if (this_shadowed)
3245 SET_PT (PT - 1);
3246 insert_string (" (binding currently shadowed)");
3247 SET_PT (PT + 1);
3250 else if (EQ (XCAR (tail), Qkeymap))
3252 /* The same keymap might be in the structure twice, if we're
3253 using an inherited keymap. So skip anything we've already
3254 encountered. */
3255 tem = Fassq (tail, *seen);
3256 if (CONSP (tem) && !NILP (Fequal (XCAR (tem), prefix)))
3257 break;
3258 *seen = Fcons (Fcons (tail, prefix), *seen);
3262 UNGCPRO;
3265 static void
3266 describe_vector_princ (elt, fun)
3267 Lisp_Object elt, fun;
3269 Findent_to (make_number (16), make_number (1));
3270 call1 (fun, elt);
3271 Fterpri (Qnil);
3274 DEFUN ("describe-vector", Fdescribe_vector, Sdescribe_vector, 1, 2, 0,
3275 doc: /* Insert a description of contents of VECTOR.
3276 This is text showing the elements of vector matched against indices.
3277 DESCRIBER is the output function used; nil means use `princ'. */)
3278 (vector, describer)
3279 Lisp_Object vector, describer;
3281 int count = SPECPDL_INDEX ();
3282 if (NILP (describer))
3283 describer = intern ("princ");
3284 specbind (Qstandard_output, Fcurrent_buffer ());
3285 CHECK_VECTOR_OR_CHAR_TABLE (vector);
3286 describe_vector (vector, Qnil, describer, describe_vector_princ, 0,
3287 Qnil, Qnil, (int *)0, 0, 0, 0);
3289 return unbind_to (count, Qnil);
3292 /* Insert in the current buffer a description of the contents of VECTOR.
3293 We call ELT_DESCRIBER to insert the description of one value found
3294 in VECTOR.
3296 ELT_PREFIX describes what "comes before" the keys or indices defined
3297 by this vector. This is a human-readable string whose size
3298 is not necessarily related to the situation.
3300 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3301 leads to this keymap.
3303 If the vector is a chartable, ELT_PREFIX is the vector
3304 of bytes that lead to the character set or portion of a character
3305 set described by this chartable.
3307 If PARTIAL is nonzero, it means do not mention suppressed commands
3308 (that assumes the vector is in a keymap).
3310 SHADOW is a list of keymaps that shadow this map.
3311 If it is non-nil, then we look up the key in those maps
3312 and we don't mention it now if it is defined by any of them.
3314 ENTIRE_MAP is the keymap in which this vector appears.
3315 If the definition in effect in the whole map does not match
3316 the one in this vector, we ignore this one.
3318 When describing a sub-char-table, INDICES is a list of
3319 indices at higher levels in this char-table,
3320 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3322 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3324 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3326 static void
3327 describe_vector (vector, prefix, args, elt_describer,
3328 partial, shadow, entire_map,
3329 indices, char_table_depth, keymap_p,
3330 mention_shadow)
3331 register Lisp_Object vector;
3332 Lisp_Object prefix, args;
3333 void (*elt_describer) P_ ((Lisp_Object, Lisp_Object));
3334 int partial;
3335 Lisp_Object shadow;
3336 Lisp_Object entire_map;
3337 int *indices;
3338 int char_table_depth;
3339 int keymap_p;
3340 int mention_shadow;
3342 Lisp_Object definition;
3343 Lisp_Object tem2;
3344 Lisp_Object elt_prefix = Qnil;
3345 register int i;
3346 Lisp_Object suppress;
3347 Lisp_Object kludge;
3348 int first = 1;
3349 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3350 /* Range of elements to be handled. */
3351 int from, to;
3352 /* A flag to tell if a leaf in this level of char-table is not a
3353 generic character (i.e. a complete multibyte character). */
3354 int complete_char;
3355 int character;
3356 int starting_i;
3358 suppress = Qnil;
3360 if (indices == 0)
3361 indices = (int *) alloca (3 * sizeof (int));
3363 definition = Qnil;
3365 if (!keymap_p)
3367 /* Call Fkey_description first, to avoid GC bug for the other string. */
3368 if (!NILP (prefix) && XFASTINT (Flength (prefix)) > 0)
3370 Lisp_Object tem;
3371 tem = Fkey_description (prefix, Qnil);
3372 elt_prefix = concat2 (tem, build_string (" "));
3374 prefix = Qnil;
3377 /* This vector gets used to present single keys to Flookup_key. Since
3378 that is done once per vector element, we don't want to cons up a
3379 fresh vector every time. */
3380 kludge = Fmake_vector (make_number (1), Qnil);
3381 GCPRO4 (elt_prefix, prefix, definition, kludge);
3383 if (partial)
3384 suppress = intern ("suppress-keymap");
3386 if (CHAR_TABLE_P (vector))
3388 if (char_table_depth == 0)
3390 /* VECTOR is a top level char-table. */
3391 complete_char = 1;
3392 from = 0;
3393 to = CHAR_TABLE_ORDINARY_SLOTS;
3395 else
3397 /* VECTOR is a sub char-table. */
3398 if (char_table_depth >= 3)
3399 /* A char-table is never that deep. */
3400 error ("Too deep char table");
3402 complete_char
3403 = (CHARSET_VALID_P (indices[0])
3404 && ((CHARSET_DIMENSION (indices[0]) == 1
3405 && char_table_depth == 1)
3406 || char_table_depth == 2));
3408 /* Meaningful elements are from 32th to 127th. */
3409 from = 32;
3410 to = SUB_CHAR_TABLE_ORDINARY_SLOTS;
3413 else
3415 /* This does the right thing for ordinary vectors. */
3417 complete_char = 1;
3418 from = 0;
3419 to = XVECTOR (vector)->size;
3422 for (i = from; i < to; i++)
3424 int this_shadowed = 0;
3425 QUIT;
3427 if (CHAR_TABLE_P (vector))
3429 if (char_table_depth == 0 && i >= CHAR_TABLE_SINGLE_BYTE_SLOTS)
3430 complete_char = 0;
3432 if (i >= CHAR_TABLE_SINGLE_BYTE_SLOTS
3433 && !CHARSET_DEFINED_P (i - 128))
3434 continue;
3436 definition
3437 = get_keyelt (XCHAR_TABLE (vector)->contents[i], 0);
3439 else
3440 definition = get_keyelt (AREF (vector, i), 0);
3442 if (NILP (definition)) continue;
3444 /* Don't mention suppressed commands. */
3445 if (SYMBOLP (definition) && partial)
3447 Lisp_Object tem;
3449 tem = Fget (definition, suppress);
3451 if (!NILP (tem)) continue;
3454 /* Set CHARACTER to the character this entry describes, if any.
3455 Also update *INDICES. */
3456 if (CHAR_TABLE_P (vector))
3458 indices[char_table_depth] = i;
3460 if (char_table_depth == 0)
3462 character = i;
3463 indices[0] = i - 128;
3465 else if (complete_char)
3467 character = MAKE_CHAR (indices[0], indices[1], indices[2]);
3469 else
3470 character = 0;
3472 else
3473 character = i;
3475 ASET (kludge, 0, make_number (character));
3477 /* If this binding is shadowed by some other map, ignore it. */
3478 if (!NILP (shadow) && complete_char)
3480 Lisp_Object tem;
3482 tem = shadow_lookup (shadow, kludge, Qt);
3484 if (!NILP (tem))
3486 if (mention_shadow)
3487 this_shadowed = 1;
3488 else
3489 continue;
3493 /* Ignore this definition if it is shadowed by an earlier
3494 one in the same keymap. */
3495 if (!NILP (entire_map) && complete_char)
3497 Lisp_Object tem;
3499 tem = Flookup_key (entire_map, kludge, Qt);
3501 if (!EQ (tem, definition))
3502 continue;
3505 if (first)
3507 if (char_table_depth == 0)
3508 insert ("\n", 1);
3509 first = 0;
3512 /* For a sub char-table, show the depth by indentation.
3513 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3514 if (char_table_depth > 0)
3515 insert (" ", char_table_depth * 2); /* depth is 1 or 2. */
3517 /* Output the prefix that applies to every entry in this map. */
3518 if (!NILP (elt_prefix))
3519 insert1 (elt_prefix);
3521 /* Insert or describe the character this slot is for,
3522 or a description of what it is for. */
3523 if (SUB_CHAR_TABLE_P (vector))
3525 if (complete_char)
3526 insert_char (character);
3527 else
3529 /* We need an octal representation for this block of
3530 characters. */
3531 char work[16];
3532 sprintf (work, "(row %d)", i);
3533 insert (work, strlen (work));
3536 else if (CHAR_TABLE_P (vector))
3538 if (complete_char)
3539 insert1 (Fkey_description (kludge, prefix));
3540 else
3542 /* Print the information for this character set. */
3543 insert_string ("<");
3544 tem2 = CHARSET_TABLE_INFO (i - 128, CHARSET_SHORT_NAME_IDX);
3545 if (STRINGP (tem2))
3546 insert_from_string (tem2, 0, 0, SCHARS (tem2),
3547 SBYTES (tem2), 0);
3548 else
3549 insert ("?", 1);
3550 insert (">", 1);
3553 else
3555 insert1 (Fkey_description (kludge, prefix));
3558 /* If we find a sub char-table within a char-table,
3559 scan it recursively; it defines the details for
3560 a character set or a portion of a character set. */
3561 if (CHAR_TABLE_P (vector) && SUB_CHAR_TABLE_P (definition))
3563 insert ("\n", 1);
3564 describe_vector (definition, prefix, args, elt_describer,
3565 partial, shadow, entire_map,
3566 indices, char_table_depth + 1, keymap_p,
3567 mention_shadow);
3568 continue;
3571 starting_i = i;
3573 /* Find all consecutive characters or rows that have the same
3574 definition. But, for elements of a top level char table, if
3575 they are for charsets, we had better describe one by one even
3576 if they have the same definition. */
3577 if (CHAR_TABLE_P (vector))
3579 int limit = to;
3581 if (char_table_depth == 0)
3582 limit = CHAR_TABLE_SINGLE_BYTE_SLOTS;
3584 while (i + 1 < limit
3585 && (tem2 = get_keyelt (XCHAR_TABLE (vector)->contents[i + 1], 0),
3586 !NILP (tem2))
3587 && !NILP (Fequal (tem2, definition)))
3588 i++;
3590 else
3591 while (i + 1 < to
3592 && (tem2 = get_keyelt (AREF (vector, i + 1), 0),
3593 !NILP (tem2))
3594 && !NILP (Fequal (tem2, definition)))
3595 i++;
3598 /* If we have a range of more than one character,
3599 print where the range reaches to. */
3601 if (i != starting_i)
3603 insert (" .. ", 4);
3605 ASET (kludge, 0, make_number (i));
3607 if (!NILP (elt_prefix))
3608 insert1 (elt_prefix);
3610 if (CHAR_TABLE_P (vector))
3612 if (char_table_depth == 0)
3614 insert1 (Fkey_description (kludge, prefix));
3616 else if (complete_char)
3618 indices[char_table_depth] = i;
3619 character = MAKE_CHAR (indices[0], indices[1], indices[2]);
3620 insert_char (character);
3622 else
3624 /* We need an octal representation for this block of
3625 characters. */
3626 char work[16];
3627 sprintf (work, "(row %d)", i);
3628 insert (work, strlen (work));
3631 else
3633 insert1 (Fkey_description (kludge, prefix));
3637 /* Print a description of the definition of this character.
3638 elt_describer will take care of spacing out far enough
3639 for alignment purposes. */
3640 (*elt_describer) (definition, args);
3642 if (this_shadowed)
3644 SET_PT (PT - 1);
3645 insert_string (" (binding currently shadowed)");
3646 SET_PT (PT + 1);
3650 /* For (sub) char-table, print `defalt' slot at last. */
3651 if (CHAR_TABLE_P (vector) && !NILP (XCHAR_TABLE (vector)->defalt))
3653 insert (" ", char_table_depth * 2);
3654 insert_string ("<<default>>");
3655 (*elt_describer) (XCHAR_TABLE (vector)->defalt, args);
3658 UNGCPRO;
3661 /* Apropos - finding all symbols whose names match a regexp. */
3662 static Lisp_Object apropos_predicate;
3663 static Lisp_Object apropos_accumulate;
3665 static void
3666 apropos_accum (symbol, string)
3667 Lisp_Object symbol, string;
3669 register Lisp_Object tem;
3671 tem = Fstring_match (string, Fsymbol_name (symbol), Qnil);
3672 if (!NILP (tem) && !NILP (apropos_predicate))
3673 tem = call1 (apropos_predicate, symbol);
3674 if (!NILP (tem))
3675 apropos_accumulate = Fcons (symbol, apropos_accumulate);
3678 DEFUN ("apropos-internal", Fapropos_internal, Sapropos_internal, 1, 2, 0,
3679 doc: /* Show all symbols whose names contain match for REGEXP.
3680 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3681 for each symbol and a symbol is mentioned only if that returns non-nil.
3682 Return list of symbols found. */)
3683 (regexp, predicate)
3684 Lisp_Object regexp, predicate;
3686 Lisp_Object tem;
3687 CHECK_STRING (regexp);
3688 apropos_predicate = predicate;
3689 apropos_accumulate = Qnil;
3690 map_obarray (Vobarray, apropos_accum, regexp);
3691 tem = Fsort (apropos_accumulate, Qstring_lessp);
3692 apropos_accumulate = Qnil;
3693 apropos_predicate = Qnil;
3694 return tem;
3697 void
3698 syms_of_keymap ()
3700 Qkeymap = intern ("keymap");
3701 staticpro (&Qkeymap);
3702 staticpro (&apropos_predicate);
3703 staticpro (&apropos_accumulate);
3704 apropos_predicate = Qnil;
3705 apropos_accumulate = Qnil;
3707 /* Now we are ready to set up this property, so we can
3708 create char tables. */
3709 Fput (Qkeymap, Qchar_table_extra_slots, make_number (0));
3711 /* Initialize the keymaps standardly used.
3712 Each one is the value of a Lisp variable, and is also
3713 pointed to by a C variable */
3715 global_map = Fmake_keymap (Qnil);
3716 Fset (intern ("global-map"), global_map);
3718 current_global_map = global_map;
3719 staticpro (&global_map);
3720 staticpro (&current_global_map);
3722 meta_map = Fmake_keymap (Qnil);
3723 Fset (intern ("esc-map"), meta_map);
3724 Ffset (intern ("ESC-prefix"), meta_map);
3726 control_x_map = Fmake_keymap (Qnil);
3727 Fset (intern ("ctl-x-map"), control_x_map);
3728 Ffset (intern ("Control-X-prefix"), control_x_map);
3730 exclude_keys
3731 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3732 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3733 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3734 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3735 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3736 Qnil)))));
3737 staticpro (&exclude_keys);
3739 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands,
3740 doc: /* List of commands given new key bindings recently.
3741 This is used for internal purposes during Emacs startup;
3742 don't alter it yourself. */);
3743 Vdefine_key_rebound_commands = Qt;
3745 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map,
3746 doc: /* Default keymap to use when reading from the minibuffer. */);
3747 Vminibuffer_local_map = Fmake_sparse_keymap (Qnil);
3749 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map,
3750 doc: /* Local keymap for the minibuffer when spaces are not allowed. */);
3751 Vminibuffer_local_ns_map = Fmake_sparse_keymap (Qnil);
3752 Fset_keymap_parent (Vminibuffer_local_ns_map, Vminibuffer_local_map);
3754 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map,
3755 doc: /* Local keymap for minibuffer input with completion. */);
3756 Vminibuffer_local_completion_map = Fmake_sparse_keymap (Qnil);
3757 Fset_keymap_parent (Vminibuffer_local_completion_map, Vminibuffer_local_map);
3759 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map,
3760 doc: /* Local keymap for minibuffer input with completion, for exact match. */);
3761 Vminibuffer_local_must_match_map = Fmake_sparse_keymap (Qnil);
3762 Fset_keymap_parent (Vminibuffer_local_must_match_map,
3763 Vminibuffer_local_completion_map);
3765 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist,
3766 doc: /* Alist of keymaps to use for minor modes.
3767 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3768 key sequences and look up bindings iff VARIABLE's value is non-nil.
3769 If two active keymaps bind the same key, the keymap appearing earlier
3770 in the list takes precedence. */);
3771 Vminor_mode_map_alist = Qnil;
3773 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist,
3774 doc: /* Alist of keymaps to use for minor modes, in current major mode.
3775 This variable is an alist just like `minor-mode-map-alist', and it is
3776 used the same way (and before `minor-mode-map-alist'); however,
3777 it is provided for major modes to bind locally. */);
3778 Vminor_mode_overriding_map_alist = Qnil;
3780 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists,
3781 doc: /* List of keymap alists to use for emulations modes.
3782 It is intended for modes or packages using multiple minor-mode keymaps.
3783 Each element is a keymap alist just like `minor-mode-map-alist', or a
3784 symbol with a variable binding which is a keymap alist, and it is used
3785 the same way. The "active" keymaps in each alist are used before
3786 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3787 Vemulation_mode_map_alists = Qnil;
3790 DEFVAR_LISP ("function-key-map", &Vfunction_key_map,
3791 doc: /* Keymap mapping ASCII function key sequences onto their preferred forms.
3792 This allows Emacs to recognize function keys sent from ASCII
3793 terminals at any point in a key sequence.
3795 The `read-key-sequence' function replaces any subsequence bound by
3796 `function-key-map' with its binding. More precisely, when the active
3797 keymaps have no binding for the current key sequence but
3798 `function-key-map' binds a suffix of the sequence to a vector or string,
3799 `read-key-sequence' replaces the matching suffix with its binding, and
3800 continues with the new sequence.
3802 The events that come from bindings in `function-key-map' are not
3803 themselves looked up in `function-key-map'.
3805 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3806 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3807 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3808 key, typing `ESC O P x' would return [f1 x]. */);
3809 Vfunction_key_map = Fmake_sparse_keymap (Qnil);
3811 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map,
3812 doc: /* Keymap of key translations that can override keymaps.
3813 This keymap works like `function-key-map', but comes after that,
3814 and its non-prefix bindings override ordinary bindings. */);
3815 Vkey_translation_map = Qnil;
3817 staticpro (&Vmouse_events);
3818 Vmouse_events = Fcons (intern ("menu-bar"),
3819 Fcons (intern ("tool-bar"),
3820 Fcons (intern ("header-line"),
3821 Fcons (intern ("mode-line"),
3822 Fcons (intern ("mouse-1"),
3823 Fcons (intern ("mouse-2"),
3824 Fcons (intern ("mouse-3"),
3825 Fcons (intern ("mouse-4"),
3826 Fcons (intern ("mouse-5"),
3827 Qnil)))))))));
3830 Qsingle_key_description = intern ("single-key-description");
3831 staticpro (&Qsingle_key_description);
3833 Qkey_description = intern ("key-description");
3834 staticpro (&Qkey_description);
3836 Qkeymapp = intern ("keymapp");
3837 staticpro (&Qkeymapp);
3839 Qnon_ascii = intern ("non-ascii");
3840 staticpro (&Qnon_ascii);
3842 Qmenu_item = intern ("menu-item");
3843 staticpro (&Qmenu_item);
3845 Qremap = intern ("remap");
3846 staticpro (&Qremap);
3848 command_remapping_vector = Fmake_vector (make_number (2), Qremap);
3849 staticpro (&command_remapping_vector);
3851 where_is_cache_keymaps = Qt;
3852 where_is_cache = Qnil;
3853 staticpro (&where_is_cache);
3854 staticpro (&where_is_cache_keymaps);
3856 defsubr (&Skeymapp);
3857 defsubr (&Skeymap_parent);
3858 defsubr (&Skeymap_prompt);
3859 defsubr (&Sset_keymap_parent);
3860 defsubr (&Smake_keymap);
3861 defsubr (&Smake_sparse_keymap);
3862 defsubr (&Smap_keymap);
3863 defsubr (&Scopy_keymap);
3864 defsubr (&Scommand_remapping);
3865 defsubr (&Skey_binding);
3866 defsubr (&Slocal_key_binding);
3867 defsubr (&Sglobal_key_binding);
3868 defsubr (&Sminor_mode_key_binding);
3869 defsubr (&Sdefine_key);
3870 defsubr (&Slookup_key);
3871 defsubr (&Sdefine_prefix_command);
3872 defsubr (&Suse_global_map);
3873 defsubr (&Suse_local_map);
3874 defsubr (&Scurrent_local_map);
3875 defsubr (&Scurrent_global_map);
3876 defsubr (&Scurrent_minor_mode_maps);
3877 defsubr (&Scurrent_active_maps);
3878 defsubr (&Saccessible_keymaps);
3879 defsubr (&Skey_description);
3880 defsubr (&Sdescribe_vector);
3881 defsubr (&Ssingle_key_description);
3882 defsubr (&Stext_char_description);
3883 defsubr (&Swhere_is_internal);
3884 defsubr (&Sdescribe_buffer_bindings);
3885 defsubr (&Sapropos_internal);
3888 void
3889 keys_of_keymap ()
3891 initial_define_key (global_map, 033, "ESC-prefix");
3892 initial_define_key (global_map, Ctl('X'), "Control-X-prefix");
3895 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
3896 (do not change this comment) */