1 /* Manipulation of keymaps
2 Copyright (C) 1985, 86,87,88,93,94,95,98 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
33 #include "termhooks.h"
34 #include "blockinput.h"
37 #define min(a, b) ((a) < (b) ? (a) : (b))
39 /* The number of elements in keymap vectors. */
40 #define DENSE_TABLE_SIZE (0200)
42 /* Actually allocate storage for these variables */
44 Lisp_Object current_global_map
; /* Current global keymap */
46 Lisp_Object global_map
; /* default global key bindings */
48 Lisp_Object meta_map
; /* The keymap used for globally bound
49 ESC-prefixed default commands */
51 Lisp_Object control_x_map
; /* The keymap used for globally bound
52 C-x-prefixed default commands */
54 /* was MinibufLocalMap */
55 Lisp_Object Vminibuffer_local_map
;
56 /* The keymap used by the minibuf for local
57 bindings when spaces are allowed in the
60 /* was MinibufLocalNSMap */
61 Lisp_Object Vminibuffer_local_ns_map
;
62 /* The keymap used by the minibuf for local
63 bindings when spaces are not encouraged
66 /* keymap used for minibuffers when doing completion */
67 /* was MinibufLocalCompletionMap */
68 Lisp_Object Vminibuffer_local_completion_map
;
70 /* keymap used for minibuffers when doing completion and require a match */
71 /* was MinibufLocalMustMatchMap */
72 Lisp_Object Vminibuffer_local_must_match_map
;
74 /* Alist of minor mode variables and keymaps. */
75 Lisp_Object Vminor_mode_map_alist
;
77 /* Alist of major-mode-specific overrides for
78 minor mode variables and keymaps. */
79 Lisp_Object Vminor_mode_overriding_map_alist
;
81 /* Keymap mapping ASCII function key sequences onto their preferred forms.
82 Initialized by the terminal-specific lisp files. See DEFVAR for more
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
;
97 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
98 in a string key sequence is equivalent to prefixing with this
100 extern Lisp_Object meta_prefix_char
;
102 extern Lisp_Object Voverriding_local_map
;
104 static Lisp_Object
define_as_prefix ();
105 static Lisp_Object
describe_buffer_bindings ();
106 static void describe_command (), describe_translation ();
107 static void describe_map ();
109 /* Keymap object support - constructors and predicates. */
111 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
112 "Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).\n\
113 CHARTABLE is a char-table that holds the bindings for the ASCII\n\
114 characters. ALIST is an assoc-list which holds bindings for function keys,\n\
115 mouse events, and any other things that appear in the input stream.\n\
116 All entries in it are initially nil, meaning \"command undefined\".\n\n\
117 The optional arg STRING supplies a menu name for the keymap\n\
118 in case you use it as a menu with `x-popup-menu'.")
124 tail
= Fcons (string
, Qnil
);
127 return Fcons (Qkeymap
,
128 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
131 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
132 "Construct and return a new sparse-keymap list.\n\
133 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),\n\
134 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),\n\
135 which binds the function key or mouse event SYMBOL to DEFINITION.\n\
136 Initially the alist is nil.\n\n\
137 The optional arg STRING supplies a menu name for the keymap\n\
138 in case you use it as a menu with `x-popup-menu'.")
143 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
144 return Fcons (Qkeymap
, Qnil
);
147 /* This function is used for installing the standard key bindings
148 at initialization time.
152 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
155 initial_define_key (keymap
, key
, defname
)
160 store_in_keymap (keymap
, make_number (key
), intern (defname
));
164 initial_define_lispy_key (keymap
, keyname
, defname
)
169 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
172 /* Define character fromchar in map frommap as an alias for character
173 tochar in map tomap. Subsequent redefinitions of the latter WILL
174 affect the former. */
178 synkey (frommap
, fromchar
, tomap
, tochar
)
179 struct Lisp_Vector
*frommap
, *tomap
;
180 int fromchar
, tochar
;
183 XSETVECTOR (v
, tomap
);
184 XSETFASTINT (c
, tochar
);
185 frommap
->contents
[fromchar
] = Fcons (v
, c
);
189 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
190 "Return t if OBJECT is a keymap.\n\
192 A keymap is a list (keymap . ALIST),\n\
193 or a symbol whose function definition is itself a keymap.\n\
194 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
195 a vector of densely packed bindings for small character codes\n\
196 is also allowed as an element.")
200 return (NILP (get_keymap_1 (object
, 0, 0)) ? Qnil
: Qt
);
203 /* Check that OBJECT is a keymap (after dereferencing through any
204 symbols). If it is, return it.
206 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
207 is an autoload form, do the autoload and try again.
208 If AUTOLOAD is nonzero, callers must assume GC is possible.
210 ERROR controls how we respond if OBJECT isn't a keymap.
211 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
213 Note that most of the time, we don't want to pursue autoloads.
214 Functions like Faccessible_keymaps which scan entire keymap trees
215 shouldn't load every autoloaded keymap. I'm not sure about this,
216 but it seems to me that only read_key_sequence, Flookup_key, and
217 Fdefine_key should cause keymaps to be autoloaded. */
220 get_keymap_1 (object
, error
, autoload
)
229 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
233 tem
= indirect_function (object
);
234 if (CONSP (tem
) && EQ (XCONS (tem
)->car
, Qkeymap
))
238 /* Should we do an autoload? Autoload forms for keymaps have
239 Qkeymap as their fifth element. */
243 && EQ (XCONS (tem
)->car
, Qautoload
))
247 tail
= Fnth (make_number (4), tem
);
248 if (EQ (tail
, Qkeymap
))
250 struct gcpro gcpro1
, gcpro2
;
252 GCPRO2 (tem
, object
);
253 do_autoload (tem
, object
);
262 wrong_type_argument (Qkeymapp
, object
);
268 /* Follow any symbol chaining, and return the keymap denoted by OBJECT.
269 If OBJECT doesn't denote a keymap at all, signal an error. */
274 return get_keymap_1 (object
, 1, 0);
277 /* Return the parent map of the keymap MAP, or nil if it has none.
278 We assume that MAP is a valid keymap. */
280 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
281 "Return the parent keymap of KEYMAP.")
287 keymap
= get_keymap_1 (keymap
, 1, 1);
289 /* Skip past the initial element `keymap'. */
290 list
= XCONS (keymap
)->cdr
;
291 for (; CONSP (list
); list
= XCONS (list
)->cdr
)
293 /* See if there is another `keymap'. */
294 if (EQ (Qkeymap
, XCONS (list
)->car
))
301 /* Set the parent keymap of MAP to PARENT. */
303 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
304 "Modify KEYMAP to set its parent map to PARENT.\n\
305 PARENT should be nil or another keymap.")
307 Lisp_Object keymap
, parent
;
309 Lisp_Object list
, prev
;
312 keymap
= get_keymap_1 (keymap
, 1, 1);
314 parent
= get_keymap_1 (parent
, 1, 1);
316 /* Skip past the initial element `keymap'. */
320 list
= XCONS (prev
)->cdr
;
321 /* If there is a parent keymap here, replace it.
322 If we came to the end, add the parent in PREV. */
323 if (! CONSP (list
) || EQ (Qkeymap
, XCONS (list
)->car
))
325 /* If we already have the right parent, return now
326 so that we avoid the loops below. */
327 if (EQ (XCONS (prev
)->cdr
, parent
))
330 XCONS (prev
)->cdr
= parent
;
336 /* Scan through for submaps, and set their parents too. */
338 for (list
= XCONS (keymap
)->cdr
; CONSP (list
); list
= XCONS (list
)->cdr
)
340 /* Stop the scan when we come to the parent. */
341 if (EQ (XCONS (list
)->car
, Qkeymap
))
344 /* If this element holds a prefix map, deal with it. */
345 if (CONSP (XCONS (list
)->car
)
346 && CONSP (XCONS (XCONS (list
)->car
)->cdr
))
347 fix_submap_inheritance (keymap
, XCONS (XCONS (list
)->car
)->car
,
348 XCONS (XCONS (list
)->car
)->cdr
);
350 if (VECTORP (XCONS (list
)->car
))
351 for (i
= 0; i
< XVECTOR (XCONS (list
)->car
)->size
; i
++)
352 if (CONSP (XVECTOR (XCONS (list
)->car
)->contents
[i
]))
353 fix_submap_inheritance (keymap
, make_number (i
),
354 XVECTOR (XCONS (list
)->car
)->contents
[i
]);
356 if (CHAR_TABLE_P (XCONS (list
)->car
))
358 Lisp_Object indices
[3];
360 map_char_table (fix_submap_inheritance
, Qnil
, XCONS (list
)->car
,
368 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
369 if EVENT is also a prefix in MAP's parent,
370 make sure that SUBMAP inherits that definition as its own parent. */
373 fix_submap_inheritance (map
, event
, submap
)
374 Lisp_Object map
, event
, submap
;
376 Lisp_Object map_parent
, parent_entry
;
378 /* SUBMAP is a cons that we found as a key binding.
379 Discard the other things found in a menu key binding. */
383 /* May be an old format menu item */
384 if (STRINGP (XCONS (submap
)->car
))
386 submap
= XCONS (submap
)->cdr
;
387 /* Also remove a menu help string, if any,
388 following the menu item name. */
389 if (CONSP (submap
) && STRINGP (XCONS (submap
)->car
))
390 submap
= XCONS (submap
)->cdr
;
391 /* Also remove the sublist that caches key equivalences, if any. */
393 && CONSP (XCONS (submap
)->car
))
396 carcar
= XCONS (XCONS (submap
)->car
)->car
;
397 if (NILP (carcar
) || VECTORP (carcar
))
398 submap
= XCONS (submap
)->cdr
;
402 /* Or a new format menu item */
403 else if (EQ (XCONS (submap
)->car
, Qmenu_item
)
404 && CONSP (XCONS (submap
)->cdr
))
406 submap
= XCONS (XCONS (submap
)->cdr
)->cdr
;
408 submap
= XCONS (submap
)->car
;
412 /* If it isn't a keymap now, there's no work to do. */
414 || ! EQ (XCONS (submap
)->car
, Qkeymap
))
417 map_parent
= Fkeymap_parent (map
);
418 if (! NILP (map_parent
))
419 parent_entry
= access_keymap (map_parent
, event
, 0, 0);
423 /* If MAP's parent has something other than a keymap,
424 our own submap shadows it completely, so use nil as SUBMAP's parent. */
425 if (! (CONSP (parent_entry
) && EQ (XCONS (parent_entry
)->car
, Qkeymap
)))
428 if (! EQ (parent_entry
, submap
))
430 Lisp_Object submap_parent
;
431 submap_parent
= submap
;
435 tem
= Fkeymap_parent (submap_parent
);
436 if (EQ (tem
, parent_entry
))
439 && EQ (XCONS (tem
)->car
, Qkeymap
))
444 Fset_keymap_parent (submap_parent
, parent_entry
);
448 /* Look up IDX in MAP. IDX may be any sort of event.
449 Note that this does only one level of lookup; IDX must be a single
450 event, not a sequence.
452 If T_OK is non-zero, bindings for Qt are treated as default
453 bindings; any key left unmentioned by other tables and bindings is
454 given the binding of Qt.
456 If T_OK is zero, bindings for Qt are not treated specially.
458 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
461 access_keymap (map
, idx
, t_ok
, noinherit
)
470 /* If idx is a list (some sort of mouse click, perhaps?),
471 the index we want to use is the car of the list, which
472 ought to be a symbol. */
473 idx
= EVENT_HEAD (idx
);
475 /* If idx is a symbol, it might have modifiers, which need to
476 be put in the canonical order. */
478 idx
= reorder_modifiers (idx
);
479 else if (INTEGERP (idx
))
480 /* Clobber the high bits that can be present on a machine
481 with more than 24 bits of integer. */
482 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
486 Lisp_Object t_binding
;
489 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
493 binding
= XCONS (tail
)->car
;
494 if (SYMBOLP (binding
))
496 /* If NOINHERIT, stop finding prefix definitions
497 after we pass a second occurrence of the `keymap' symbol. */
498 if (noinherit
&& EQ (binding
, Qkeymap
) && ! EQ (tail
, map
))
501 else if (CONSP (binding
))
503 if (EQ (XCONS (binding
)->car
, idx
))
505 val
= XCONS (binding
)->cdr
;
506 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
509 fix_submap_inheritance (map
, idx
, val
);
512 if (t_ok
&& EQ (XCONS (binding
)->car
, Qt
))
513 t_binding
= XCONS (binding
)->cdr
;
515 else if (VECTORP (binding
))
517 if (NATNUMP (idx
) && XFASTINT (idx
) < XVECTOR (binding
)->size
)
519 val
= XVECTOR (binding
)->contents
[XFASTINT (idx
)];
520 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
523 fix_submap_inheritance (map
, idx
, val
);
527 else if (CHAR_TABLE_P (binding
))
529 /* Character codes with modifiers
530 are not included in a char-table.
531 All character codes without modifiers are included. */
534 & (CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
535 | CHAR_SHIFT
| CHAR_CTL
| CHAR_META
)))
537 val
= Faref (binding
, idx
);
538 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
541 fix_submap_inheritance (map
, idx
, val
);
553 /* Given OBJECT which was found in a slot in a keymap,
554 trace indirect definitions to get the actual definition of that slot.
555 An indirect definition is a list of the form
556 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
557 and INDEX is the object to look up in KEYMAP to yield the definition.
559 Also if OBJECT has a menu string as the first element,
560 remove that. Also remove a menu help string as second element.
562 If AUTOLOAD is nonzero, load autoloadable keymaps
563 that are referred to with indirection. */
566 get_keyelt (object
, autoload
)
567 register Lisp_Object object
;
572 if (!(CONSP (object
)))
573 /* This is really the value. */
576 /* If the keymap contents looks like (keymap ...) or (lambda ...)
578 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
581 /* If the keymap contents looks like (menu-item name . DEFN)
582 or (menu-item name DEFN ...) then use DEFN.
583 This is a new format menu item.
585 else if (EQ (XCAR (object
), Qmenu_item
))
587 if (CONSP (XCDR (object
)))
589 object
= XCDR (XCDR (object
));
591 object
= XCAR (object
);
598 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
599 Keymap alist elements like (CHAR MENUSTRING . DEFN)
600 will be used by HierarKey menus. */
601 else if (STRINGP (XCAR (object
)))
603 object
= XCDR (object
);
604 /* Also remove a menu help string, if any,
605 following the menu item name. */
606 if (CONSP (object
) && STRINGP (XCAR (object
)))
607 object
= XCDR (object
);
608 /* Also remove the sublist that caches key equivalences, if any. */
609 if (CONSP (object
) && CONSP (XCAR (object
)))
612 carcar
= XCAR (XCAR (object
));
613 if (NILP (carcar
) || VECTORP (carcar
))
614 object
= XCDR (object
);
618 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
621 register Lisp_Object map
;
622 map
= get_keymap_1 (Fcar_safe (object
), 0, autoload
);
630 if (INTEGERP (key
) && (XINT (key
) & meta_modifier
))
632 object
= access_keymap (map
, meta_prefix_char
, 0, 0);
633 map
= get_keymap_1 (object
, 0, autoload
);
634 object
= access_keymap (map
, make_number (XINT (key
)
639 object
= access_keymap (map
, key
, 0, 0);
646 store_in_keymap (keymap
, idx
, def
)
648 register Lisp_Object idx
;
649 register Lisp_Object def
;
651 /* If we are preparing to dump, and DEF is a menu element
652 with a menu item indicator, copy it to ensure it is not pure. */
653 if (CONSP (def
) && PURE_P (def
)
654 && (EQ (XCONS (def
)->car
, Qmenu_item
) || STRINGP (XCONS (def
)->car
)))
655 def
= Fcons (XCONS (def
)->car
, XCONS (def
)->cdr
);
657 if (!CONSP (keymap
) || ! EQ (XCONS (keymap
)->car
, Qkeymap
))
658 error ("attempt to define a key in a non-keymap");
660 /* If idx is a list (some sort of mouse click, perhaps?),
661 the index we want to use is the car of the list, which
662 ought to be a symbol. */
663 idx
= EVENT_HEAD (idx
);
665 /* If idx is a symbol, it might have modifiers, which need to
666 be put in the canonical order. */
668 idx
= reorder_modifiers (idx
);
669 else if (INTEGERP (idx
))
670 /* Clobber the high bits that can be present on a machine
671 with more than 24 bits of integer. */
672 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
674 /* Scan the keymap for a binding of idx. */
678 /* The cons after which we should insert new bindings. If the
679 keymap has a table element, we record its position here, so new
680 bindings will go after it; this way, the table will stay
681 towards the front of the alist and character lookups in dense
682 keymaps will remain fast. Otherwise, this just points at the
683 front of the keymap. */
684 Lisp_Object insertion_point
;
686 insertion_point
= keymap
;
687 for (tail
= XCONS (keymap
)->cdr
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
691 elt
= XCONS (tail
)->car
;
694 if (NATNUMP (idx
) && XFASTINT (idx
) < XVECTOR (elt
)->size
)
696 XVECTOR (elt
)->contents
[XFASTINT (idx
)] = def
;
699 insertion_point
= tail
;
701 else if (CHAR_TABLE_P (elt
))
703 /* Character codes with modifiers
704 are not included in a char-table.
705 All character codes without modifiers are included. */
708 & (CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
709 | CHAR_SHIFT
| CHAR_CTL
| CHAR_META
)))
711 Faset (elt
, idx
, def
);
714 insertion_point
= tail
;
716 else if (CONSP (elt
))
718 if (EQ (idx
, XCONS (elt
)->car
))
720 XCONS (elt
)->cdr
= def
;
724 else if (SYMBOLP (elt
))
726 /* If we find a 'keymap' symbol in the spine of KEYMAP,
727 then we must have found the start of a second keymap
728 being used as the tail of KEYMAP, and a binding for IDX
729 should be inserted before it. */
730 if (EQ (elt
, Qkeymap
))
738 /* We have scanned the entire keymap, and not found a binding for
739 IDX. Let's add one. */
740 XCONS (insertion_point
)->cdr
741 = Fcons (Fcons (idx
, def
), XCONS (insertion_point
)->cdr
);
748 copy_keymap_1 (chartable
, idx
, elt
)
749 Lisp_Object chartable
, idx
, elt
;
751 if (!SYMBOLP (elt
) && ! NILP (Fkeymapp (elt
)))
752 Faset (chartable
, idx
, Fcopy_keymap (elt
));
755 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
756 "Return a copy of the keymap KEYMAP.\n\
757 The copy starts out with the same definitions of KEYMAP,\n\
758 but changing either the copy or KEYMAP does not affect the other.\n\
759 Any key definitions that are subkeymaps are recursively copied.\n\
760 However, a key definition which is a symbol whose definition is a keymap\n\
765 register Lisp_Object copy
, tail
;
767 copy
= Fcopy_alist (get_keymap (keymap
));
769 for (tail
= copy
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
773 elt
= XCONS (tail
)->car
;
774 if (CHAR_TABLE_P (elt
))
776 Lisp_Object indices
[3];
778 elt
= Fcopy_sequence (elt
);
779 XCONS (tail
)->car
= elt
;
781 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, 0, indices
);
783 else if (VECTORP (elt
))
787 elt
= Fcopy_sequence (elt
);
788 XCONS (tail
)->car
= elt
;
790 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
791 if (!SYMBOLP (XVECTOR (elt
)->contents
[i
])
792 && ! NILP (Fkeymapp (XVECTOR (elt
)->contents
[i
])))
793 XVECTOR (elt
)->contents
[i
]
794 = Fcopy_keymap (XVECTOR (elt
)->contents
[i
]);
796 else if (CONSP (elt
) && CONSP (XCONS (elt
)->cdr
))
799 tem
= XCONS (elt
)->cdr
;
801 /* Is this a new format menu item. */
802 if (EQ (XCONS (tem
)->car
,Qmenu_item
))
804 /* Copy cell with menu-item marker. */
806 = Fcons (XCONS (tem
)->car
, XCONS (tem
)->cdr
);
807 elt
= XCONS (elt
)->cdr
;
808 tem
= XCONS (elt
)->cdr
;
811 /* Copy cell with menu-item name. */
813 = Fcons (XCONS (tem
)->car
, XCONS (tem
)->cdr
);
814 elt
= XCONS (elt
)->cdr
;
815 tem
= XCONS (elt
)->cdr
;
819 /* Copy cell with binding and if the binding is a keymap,
822 = Fcons (XCONS (tem
)->car
, XCONS (tem
)->cdr
);
823 elt
= XCONS (elt
)->cdr
;
824 tem
= XCONS (elt
)->car
;
825 if (!(SYMBOLP (tem
) || NILP (Fkeymapp (tem
))))
826 XCONS (elt
)->car
= Fcopy_keymap (tem
);
827 tem
= XCONS (elt
)->cdr
;
828 if (CONSP (tem
) && CONSP (XCONS (tem
)->car
))
829 /* Delete cache for key equivalences. */
830 XCONS (elt
)->cdr
= XCONS (tem
)->cdr
;
835 /* It may be an old fomat menu item.
836 Skip the optional menu string.
838 if (STRINGP (XCONS (tem
)->car
))
840 /* Copy the cell, since copy-alist didn't go this deep. */
842 = Fcons (XCONS (tem
)->car
, XCONS (tem
)->cdr
);
843 elt
= XCONS (elt
)->cdr
;
844 tem
= XCONS (elt
)->cdr
;
845 /* Also skip the optional menu help string. */
846 if (CONSP (tem
) && STRINGP (XCONS (tem
)->car
))
849 = Fcons (XCONS (tem
)->car
, XCONS (tem
)->cdr
);
850 elt
= XCONS (elt
)->cdr
;
851 tem
= XCONS (elt
)->cdr
;
853 /* There may also be a list that caches key equivalences.
854 Just delete it for the new keymap. */
856 && CONSP (XCONS (tem
)->car
)
857 && (NILP (XCONS (XCONS (tem
)->car
)->car
)
858 || VECTORP (XCONS (XCONS (tem
)->car
)->car
)))
859 XCONS (elt
)->cdr
= XCONS (tem
)->cdr
;
862 && ! SYMBOLP (XCONS (elt
)->cdr
)
863 && ! NILP (Fkeymapp (XCONS (elt
)->cdr
)))
864 XCONS (elt
)->cdr
= Fcopy_keymap (XCONS (elt
)->cdr
);
873 /* Simple Keymap mutators and accessors. */
875 /* GC is possible in this function if it autoloads a keymap. */
877 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
878 "Args KEYMAP, KEY, DEF. Define key sequence KEY, in KEYMAP, as DEF.\n\
879 KEYMAP is a keymap. KEY is a string or a vector of symbols and characters\n\
880 meaning a sequence of keystrokes and events.\n\
881 Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
882 can be included if you use a vector.\n\
883 DEF is anything that can be a key's definition:\n\
884 nil (means key is undefined in this keymap),\n\
885 a command (a Lisp function suitable for interactive calling)\n\
886 a string (treated as a keyboard macro),\n\
887 a keymap (to define a prefix key),\n\
888 a symbol. When the key is looked up, the symbol will stand for its\n\
889 function definition, which should at that time be one of the above,\n\
890 or another symbol whose function definition is used, etc.\n\
891 a cons (STRING . DEFN), meaning that DEFN is the definition\n\
892 (DEFN should be a valid definition in its own right),\n\
893 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.\n\
895 If KEYMAP is a sparse keymap, the pair binding KEY to DEF is added at\n\
896 the front of KEYMAP.")
903 register Lisp_Object c
;
904 register Lisp_Object tem
;
905 register Lisp_Object cmd
;
909 struct gcpro gcpro1
, gcpro2
, gcpro3
;
911 keymap
= get_keymap_1 (keymap
, 1, 1);
913 if (!VECTORP (key
) && !STRINGP (key
))
914 key
= wrong_type_argument (Qarrayp
, key
);
916 length
= XFASTINT (Flength (key
));
920 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
921 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
923 GCPRO3 (keymap
, key
, def
);
926 meta_bit
= meta_modifier
;
933 c
= Faref (key
, make_number (idx
));
935 if (CONSP (c
) && lucid_event_type_list_p (c
))
936 c
= Fevent_convert_list (c
);
939 && (XINT (c
) & meta_bit
)
942 c
= meta_prefix_char
;
948 XSETINT (c
, XINT (c
) & ~meta_bit
);
954 if (! INTEGERP (c
) && ! SYMBOLP (c
) && ! CONSP (c
))
955 error ("Key sequence contains invalid events");
958 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
960 cmd
= get_keyelt (access_keymap (keymap
, c
, 0, 1), 1);
962 /* If this key is undefined, make it a prefix. */
964 cmd
= define_as_prefix (keymap
, c
);
966 keymap
= get_keymap_1 (cmd
, 0, 1);
968 /* We must use Fkey_description rather than just passing key to
969 error; key might be a vector, not a string. */
970 error ("Key sequence %s uses invalid prefix characters",
971 XSTRING (Fkey_description (key
))->data
);
975 /* Value is number if KEY is too long; NIL if valid but has no definition. */
976 /* GC is possible in this function if it autoloads a keymap. */
978 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
979 "In keymap KEYMAP, look up key sequence KEY. Return the definition.\n\
980 nil means undefined. See doc of `define-key' for kinds of definitions.\n\
982 A number as value means KEY is \"too long\";\n\
983 that is, characters or symbols in it except for the last one\n\
984 fail to be a valid sequence of prefix characters in KEYMAP.\n\
985 The number is how many characters at the front of KEY\n\
986 it takes to reach a non-prefix command.\n\
988 Normally, `lookup-key' ignores bindings for t, which act as default\n\
989 bindings, used when nothing else in the keymap applies; this makes it\n\
990 usable as a general function for probing keymaps. However, if the\n\
991 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will\n\
992 recognize the default bindings, just as `read-key-sequence' does.")
993 (keymap
, key
, accept_default
)
994 register Lisp_Object keymap
;
996 Lisp_Object accept_default
;
999 register Lisp_Object tem
;
1000 register Lisp_Object cmd
;
1001 register Lisp_Object c
;
1004 int t_ok
= ! NILP (accept_default
);
1006 struct gcpro gcpro1
;
1008 keymap
= get_keymap_1 (keymap
, 1, 1);
1010 if (!VECTORP (key
) && !STRINGP (key
))
1011 key
= wrong_type_argument (Qarrayp
, key
);
1013 length
= XFASTINT (Flength (key
));
1018 meta_bit
= meta_modifier
;
1027 c
= Faref (key
, make_number (idx
));
1029 if (CONSP (c
) && lucid_event_type_list_p (c
))
1030 c
= Fevent_convert_list (c
);
1033 && (XINT (c
) & meta_bit
)
1036 c
= meta_prefix_char
;
1042 XSETINT (c
, XINT (c
) & ~meta_bit
);
1048 cmd
= get_keyelt (access_keymap (keymap
, c
, t_ok
, 0), 1);
1050 RETURN_UNGCPRO (cmd
);
1052 keymap
= get_keymap_1 (cmd
, 0, 1);
1054 RETURN_UNGCPRO (make_number (idx
));
1060 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1061 Assume that currently it does not define C at all.
1062 Return the keymap. */
1065 define_as_prefix (keymap
, c
)
1066 Lisp_Object keymap
, c
;
1068 Lisp_Object inherit
, cmd
;
1070 cmd
= Fmake_sparse_keymap (Qnil
);
1071 /* If this key is defined as a prefix in an inherited keymap,
1072 make it a prefix in this map, and make its definition
1073 inherit the other prefix definition. */
1074 inherit
= access_keymap (keymap
, c
, 0, 0);
1076 /* This code is needed to do the right thing in the following case:
1077 keymap A inherits from B,
1078 you define KEY as a prefix in A,
1079 then later you define KEY as a prefix in B.
1080 We want the old prefix definition in A to inherit from that in B.
1081 It is hard to do that retroactively, so this code
1082 creates the prefix in B right away.
1084 But it turns out that this code causes problems immediately
1085 when the prefix in A is defined: it causes B to define KEY
1086 as a prefix with no subcommands.
1088 So I took out this code. */
1091 /* If there's an inherited keymap
1092 and it doesn't define this key,
1093 make it define this key. */
1096 for (tail
= Fcdr (keymap
); CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1097 if (EQ (XCONS (tail
)->car
, Qkeymap
))
1101 inherit
= define_as_prefix (tail
, c
);
1105 cmd
= nconc2 (cmd
, inherit
);
1106 store_in_keymap (keymap
, c
, cmd
);
1111 /* Append a key to the end of a key sequence. We always make a vector. */
1114 append_key (key_sequence
, key
)
1115 Lisp_Object key_sequence
, key
;
1117 Lisp_Object args
[2];
1119 args
[0] = key_sequence
;
1121 args
[1] = Fcons (key
, Qnil
);
1122 return Fvconcat (2, args
);
1126 /* Global, local, and minor mode keymap stuff. */
1128 /* We can't put these variables inside current_minor_maps, since under
1129 some systems, static gets macro-defined to be the empty string.
1131 static Lisp_Object
*cmm_modes
, *cmm_maps
;
1132 static int cmm_size
;
1134 /* Error handler used in current_minor_maps. */
1136 current_minor_maps_error ()
1141 /* Store a pointer to an array of the keymaps of the currently active
1142 minor modes in *buf, and return the number of maps it contains.
1144 This function always returns a pointer to the same buffer, and may
1145 free or reallocate it, so if you want to keep it for a long time or
1146 hand it out to lisp code, copy it. This procedure will be called
1147 for every key sequence read, so the nice lispy approach (return a
1148 new assoclist, list, what have you) for each invocation would
1149 result in a lot of consing over time.
1151 If we used xrealloc/xmalloc and ran out of memory, they would throw
1152 back to the command loop, which would try to read a key sequence,
1153 which would call this function again, resulting in an infinite
1154 loop. Instead, we'll use realloc/malloc and silently truncate the
1155 list, let the key sequence be read, and hope some other piece of
1156 code signals the error. */
1158 current_minor_maps (modeptr
, mapptr
)
1159 Lisp_Object
**modeptr
, **mapptr
;
1162 int list_number
= 0;
1163 Lisp_Object alist
, assoc
, var
, val
;
1164 Lisp_Object lists
[2];
1166 lists
[0] = Vminor_mode_overriding_map_alist
;
1167 lists
[1] = Vminor_mode_map_alist
;
1169 for (list_number
= 0; list_number
< 2; list_number
++)
1170 for (alist
= lists
[list_number
];
1172 alist
= XCONS (alist
)->cdr
)
1173 if ((assoc
= XCONS (alist
)->car
, CONSP (assoc
))
1174 && (var
= XCONS (assoc
)->car
, SYMBOLP (var
))
1175 && (val
= find_symbol_value (var
), ! EQ (val
, Qunbound
))
1180 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1181 and also an entry in Vminor_mode_map_alist,
1182 ignore the latter. */
1183 if (list_number
== 1)
1185 val
= assq_no_quit (var
, lists
[0]);
1192 Lisp_Object
*newmodes
, *newmaps
;
1199 = (Lisp_Object
*) realloc (cmm_modes
,
1200 cmm_size
* sizeof (Lisp_Object
));
1202 = (Lisp_Object
*) realloc (cmm_maps
,
1203 cmm_size
* sizeof (Lisp_Object
));
1211 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
1213 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
1217 if (newmaps
&& newmodes
)
1219 cmm_modes
= newmodes
;
1226 /* Get the keymap definition--or nil if it is not defined. */
1227 temp
= internal_condition_case_1 (Findirect_function
,
1229 Qerror
, current_minor_maps_error
);
1233 cmm_maps
[i
] = temp
;
1238 if (modeptr
) *modeptr
= cmm_modes
;
1239 if (mapptr
) *mapptr
= cmm_maps
;
1243 /* GC is possible in this function if it autoloads a keymap. */
1245 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 2, 0,
1246 "Return the binding for command KEY in current keymaps.\n\
1247 KEY is a string or vector, a sequence of keystrokes.\n\
1248 The binding is probably a symbol with a function definition.\n\
1250 Normally, `key-binding' ignores bindings for t, which act as default\n\
1251 bindings, used when nothing else in the keymap applies; this makes it\n\
1252 usable as a general function for probing keymaps. However, if the\n\
1253 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\
1254 recognize the default bindings, just as `read-key-sequence' does.")
1255 (key
, accept_default
)
1256 Lisp_Object key
, accept_default
;
1258 Lisp_Object
*maps
, value
;
1260 struct gcpro gcpro1
;
1264 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1266 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1267 key
, accept_default
);
1268 if (! NILP (value
) && !INTEGERP (value
))
1269 RETURN_UNGCPRO (value
);
1271 else if (!NILP (Voverriding_local_map
))
1273 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1274 if (! NILP (value
) && !INTEGERP (value
))
1275 RETURN_UNGCPRO (value
);
1281 nmaps
= current_minor_maps (0, &maps
);
1282 /* Note that all these maps are GCPRO'd
1283 in the places where we found them. */
1285 for (i
= 0; i
< nmaps
; i
++)
1286 if (! NILP (maps
[i
]))
1288 value
= Flookup_key (maps
[i
], key
, accept_default
);
1289 if (! NILP (value
) && !INTEGERP (value
))
1290 RETURN_UNGCPRO (value
);
1293 local
= get_local_map (PT
, current_buffer
);
1297 value
= Flookup_key (local
, key
, accept_default
);
1298 if (! NILP (value
) && !INTEGERP (value
))
1299 RETURN_UNGCPRO (value
);
1303 value
= Flookup_key (current_global_map
, key
, accept_default
);
1305 if (! NILP (value
) && !INTEGERP (value
))
1311 /* GC is possible in this function if it autoloads a keymap. */
1313 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1314 "Return the binding for command KEYS in current local keymap only.\n\
1315 KEYS is a string, a sequence of keystrokes.\n\
1316 The binding is probably a symbol with a function definition.\n\
1318 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1319 bindings; see the description of `lookup-key' for more details about this.")
1320 (keys
, accept_default
)
1321 Lisp_Object keys
, accept_default
;
1323 register Lisp_Object map
;
1324 map
= current_buffer
->keymap
;
1327 return Flookup_key (map
, keys
, accept_default
);
1330 /* GC is possible in this function if it autoloads a keymap. */
1332 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1333 "Return the binding for command KEYS in current global keymap only.\n\
1334 KEYS is a string, a sequence of keystrokes.\n\
1335 The binding is probably a symbol with a function definition.\n\
1336 This function's return values are the same as those of lookup-key\n\
1339 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1340 bindings; see the description of `lookup-key' for more details about this.")
1341 (keys
, accept_default
)
1342 Lisp_Object keys
, accept_default
;
1344 return Flookup_key (current_global_map
, keys
, accept_default
);
1347 /* GC is possible in this function if it autoloads a keymap. */
1349 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1350 "Find the visible minor mode bindings of KEY.\n\
1351 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the\n\
1352 the symbol which names the minor mode binding KEY, and BINDING is\n\
1353 KEY's definition in that mode. In particular, if KEY has no\n\
1354 minor-mode bindings, return nil. If the first binding is a\n\
1355 non-prefix, all subsequent bindings will be omitted, since they would\n\
1356 be ignored. Similarly, the list doesn't include non-prefix bindings\n\
1357 that come after prefix bindings.\n\
1359 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1360 bindings; see the description of `lookup-key' for more details about this.")
1361 (key
, accept_default
)
1362 Lisp_Object key
, accept_default
;
1364 Lisp_Object
*modes
, *maps
;
1366 Lisp_Object binding
;
1368 struct gcpro gcpro1
, gcpro2
;
1370 nmaps
= current_minor_maps (&modes
, &maps
);
1371 /* Note that all these maps are GCPRO'd
1372 in the places where we found them. */
1375 GCPRO2 (key
, binding
);
1377 for (i
= j
= 0; i
< nmaps
; i
++)
1378 if (! NILP (maps
[i
])
1379 && ! NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1380 && !INTEGERP (binding
))
1382 if (! NILP (get_keymap (binding
)))
1383 maps
[j
++] = Fcons (modes
[i
], binding
);
1385 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1389 return Flist (j
, maps
);
1392 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1393 "Define COMMAND as a prefix command. COMMAND should be a symbol.\n\
1394 A new sparse keymap is stored as COMMAND's function definition and its value.\n\
1395 If a second optional argument MAPVAR is given, the map is stored as\n\
1396 its value instead of as COMMAND's value; but COMMAND is still defined\n\
1398 The third optional argument NAME, if given, supplies a menu name\n\
1399 string for the map. This is required to use the keymap as a menu.")
1400 (command
, mapvar
, name
)
1401 Lisp_Object command
, mapvar
, name
;
1404 map
= Fmake_sparse_keymap (name
);
1405 Ffset (command
, map
);
1409 Fset (command
, map
);
1413 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1414 "Select KEYMAP as the global keymap.")
1418 keymap
= get_keymap (keymap
);
1419 current_global_map
= keymap
;
1424 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1425 "Select KEYMAP as the local keymap.\n\
1426 If KEYMAP is nil, that means no local keymap.")
1431 keymap
= get_keymap (keymap
);
1433 current_buffer
->keymap
= keymap
;
1438 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1439 "Return current buffer's local keymap, or nil if it has none.")
1442 return current_buffer
->keymap
;
1445 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1446 "Return the current global keymap.")
1449 return current_global_map
;
1452 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1453 "Return a list of keymaps for the minor modes of the current buffer.")
1457 int nmaps
= current_minor_maps (0, &maps
);
1459 return Flist (nmaps
, maps
);
1462 /* Help functions for describing and documenting keymaps. */
1464 static void accessible_keymaps_char_table ();
1466 /* This function cannot GC. */
1468 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1470 "Find all keymaps accessible via prefix characters from KEYMAP.\n\
1471 Returns a list of elements of the form (KEYS . MAP), where the sequence\n\
1472 KEYS starting from KEYMAP gets you to MAP. These elements are ordered\n\
1473 so that the KEYS increase in length. The first element is ([] . KEYMAP).\n\
1474 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
1475 then the value includes only maps for prefixes that start with PREFIX.")
1477 Lisp_Object keymap
, prefix
;
1479 Lisp_Object maps
, good_maps
, tail
;
1482 /* no need for gcpro because we don't autoload any keymaps. */
1485 prefixlen
= XINT (Flength (prefix
));
1489 /* If a prefix was specified, start with the keymap (if any) for
1490 that prefix, so we don't waste time considering other prefixes. */
1492 tem
= Flookup_key (keymap
, prefix
, Qt
);
1493 /* Flookup_key may give us nil, or a number,
1494 if the prefix is not defined in this particular map.
1495 It might even give us a list that isn't a keymap. */
1496 tem
= get_keymap_1 (tem
, 0, 0);
1499 /* Convert PREFIX to a vector now, so that later on
1500 we don't have to deal with the possibility of a string. */
1501 if (STRINGP (prefix
))
1506 copy
= Fmake_vector (make_number (XSTRING (prefix
)->size
), Qnil
);
1507 for (i
= 0, i_byte
= 0; i
< XSTRING (prefix
)->size
;)
1510 if (STRING_MULTIBYTE (prefix
))
1511 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1514 c
= XSTRING (prefix
)->data
[i
++];
1516 c
^= 0200 | meta_modifier
;
1518 XVECTOR (copy
)->contents
[i_before
] = make_number (c
);
1522 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1528 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1529 get_keymap (keymap
)),
1532 /* For each map in the list maps,
1533 look at any other maps it points to,
1534 and stick them at the end if they are not already in the list.
1536 This is a breadth-first traversal, where tail is the queue of
1537 nodes, and maps accumulates a list of all nodes visited. */
1539 for (tail
= maps
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1541 register Lisp_Object thisseq
, thismap
;
1543 /* Does the current sequence end in the meta-prefix-char? */
1546 thisseq
= Fcar (Fcar (tail
));
1547 thismap
= Fcdr (Fcar (tail
));
1548 last
= make_number (XINT (Flength (thisseq
)) - 1);
1549 is_metized
= (XINT (last
) >= 0
1550 /* Don't metize the last char of PREFIX. */
1551 && XINT (last
) >= prefixlen
1552 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1554 for (; CONSP (thismap
); thismap
= XCONS (thismap
)->cdr
)
1558 elt
= XCONS (thismap
)->car
;
1562 if (CHAR_TABLE_P (elt
))
1564 Lisp_Object indices
[3];
1566 map_char_table (accessible_keymaps_char_table
, Qnil
,
1567 elt
, Fcons (maps
, Fcons (tail
, thisseq
)),
1570 else if (VECTORP (elt
))
1574 /* Vector keymap. Scan all the elements. */
1575 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
1577 register Lisp_Object tem
;
1578 register Lisp_Object cmd
;
1580 cmd
= get_keyelt (XVECTOR (elt
)->contents
[i
], 0);
1581 if (NILP (cmd
)) continue;
1582 tem
= Fkeymapp (cmd
);
1585 cmd
= get_keymap (cmd
);
1586 /* Ignore keymaps that are already added to maps. */
1587 tem
= Frassq (cmd
, maps
);
1590 /* If the last key in thisseq is meta-prefix-char,
1591 turn it into a meta-ized keystroke. We know
1592 that the event we're about to append is an
1593 ascii keystroke since we're processing a
1597 int meta_bit
= meta_modifier
;
1598 tem
= Fcopy_sequence (thisseq
);
1600 Faset (tem
, last
, make_number (i
| meta_bit
));
1602 /* This new sequence is the same length as
1603 thisseq, so stick it in the list right
1606 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1610 tem
= append_key (thisseq
, make_number (i
));
1611 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1617 else if (CONSP (elt
))
1619 register Lisp_Object cmd
, tem
, filter
;
1621 cmd
= get_keyelt (XCONS (elt
)->cdr
, 0);
1622 /* Ignore definitions that aren't keymaps themselves. */
1623 tem
= Fkeymapp (cmd
);
1626 /* Ignore keymaps that have been seen already. */
1627 cmd
= get_keymap (cmd
);
1628 tem
= Frassq (cmd
, maps
);
1631 /* Let elt be the event defined by this map entry. */
1632 elt
= XCONS (elt
)->car
;
1634 /* If the last key in thisseq is meta-prefix-char, and
1635 this entry is a binding for an ascii keystroke,
1636 turn it into a meta-ized keystroke. */
1637 if (is_metized
&& INTEGERP (elt
))
1639 Lisp_Object element
;
1642 tem
= Fvconcat (1, &element
);
1643 XSETFASTINT (XVECTOR (tem
)->contents
[XINT (last
)],
1644 XINT (elt
) | meta_modifier
);
1646 /* This new sequence is the same length as
1647 thisseq, so stick it in the list right
1650 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1654 Fcons (Fcons (append_key (thisseq
, elt
), cmd
),
1665 /* Now find just the maps whose access prefixes start with PREFIX. */
1668 for (; CONSP (maps
); maps
= XCONS (maps
)->cdr
)
1670 Lisp_Object elt
, thisseq
;
1671 elt
= XCONS (maps
)->car
;
1672 thisseq
= XCONS (elt
)->car
;
1673 /* The access prefix must be at least as long as PREFIX,
1674 and the first elements must match those of PREFIX. */
1675 if (XINT (Flength (thisseq
)) >= prefixlen
)
1678 for (i
= 0; i
< prefixlen
; i
++)
1681 XSETFASTINT (i1
, i
);
1682 if (!EQ (Faref (thisseq
, i1
), Faref (prefix
, i1
)))
1686 good_maps
= Fcons (elt
, good_maps
);
1690 return Fnreverse (good_maps
);
1694 accessible_keymaps_char_table (args
, index
, cmd
)
1695 Lisp_Object args
, index
, cmd
;
1698 Lisp_Object maps
, tail
, thisseq
;
1703 maps
= XCONS (args
)->car
;
1704 tail
= XCONS (XCONS (args
)->cdr
)->car
;
1705 thisseq
= XCONS (XCONS (args
)->cdr
)->cdr
;
1707 tem
= Fkeymapp (cmd
);
1710 cmd
= get_keymap (cmd
);
1711 /* Ignore keymaps that are already added to maps. */
1712 tem
= Frassq (cmd
, maps
);
1715 tem
= append_key (thisseq
, index
);
1716 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1721 Lisp_Object Qsingle_key_description
, Qkey_description
;
1723 /* This function cannot GC. */
1725 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 1, 0,
1726 "Return a pretty description of key-sequence KEYS.\n\
1727 Control characters turn into \"C-foo\" sequences, meta into \"M-foo\"\n\
1728 spaces are put between sequence elements, etc.")
1740 vector
= Fmake_vector (Flength (keys
), Qnil
);
1741 for (i
= 0, i_byte
= 0; i
< XSTRING (keys
)->size
; )
1746 if (STRING_MULTIBYTE (keys
))
1747 FETCH_STRING_CHAR_ADVANCE (c
, keys
, i
, i_byte
);
1750 c
= XSTRING (keys
)->data
[i
++];
1752 c
^= 0200 | meta_modifier
;
1755 XSETFASTINT (XVECTOR (vector
)->contents
[i_before
], c
);
1762 /* In effect, this computes
1763 (mapconcat 'single-key-description keys " ")
1764 but we shouldn't use mapconcat because it can do GC. */
1766 len
= XVECTOR (keys
)->size
;
1767 sep
= build_string (" ");
1768 /* This has one extra element at the end that we don't pass to Fconcat. */
1769 args
= (Lisp_Object
*) alloca (len
* 2 * sizeof (Lisp_Object
));
1771 for (i
= 0; i
< len
; i
++)
1773 args
[i
* 2] = Fsingle_key_description (XVECTOR (keys
)->contents
[i
]);
1774 args
[i
* 2 + 1] = sep
;
1777 else if (CONSP (keys
))
1779 /* In effect, this computes
1780 (mapconcat 'single-key-description keys " ")
1781 but we shouldn't use mapconcat because it can do GC. */
1783 len
= XFASTINT (Flength (keys
));
1784 sep
= build_string (" ");
1785 /* This has one extra element at the end that we don't pass to Fconcat. */
1786 args
= (Lisp_Object
*) alloca (len
* 2 * sizeof (Lisp_Object
));
1788 for (i
= 0; i
< len
; i
++)
1790 args
[i
* 2] = Fsingle_key_description (XCONS (keys
)->car
);
1791 args
[i
* 2 + 1] = sep
;
1792 keys
= XCONS (keys
)->cdr
;
1796 keys
= wrong_type_argument (Qarrayp
, keys
);
1798 return Fconcat (len
* 2 - 1, args
);
1802 push_key_description (c
, p
)
1803 register unsigned int c
;
1806 /* Clear all the meaningless bits above the meta bit. */
1807 c
&= meta_modifier
| ~ - meta_modifier
;
1809 if (c
& alt_modifier
)
1815 if (c
& ctrl_modifier
)
1821 if (c
& hyper_modifier
)
1825 c
-= hyper_modifier
;
1827 if (c
& meta_modifier
)
1833 if (c
& shift_modifier
)
1837 c
-= shift_modifier
;
1839 if (c
& super_modifier
)
1843 c
-= super_modifier
;
1859 else if (c
== Ctl ('M'))
1869 if (c
> 0 && c
<= Ctl ('Z'))
1888 || (NILP (current_buffer
->enable_multibyte_characters
)
1889 && SINGLE_BYTE_CHAR_P (c
)))
1893 if (! NILP (current_buffer
->enable_multibyte_characters
))
1894 c
= unibyte_char_to_multibyte (c
);
1896 if (NILP (current_buffer
->enable_multibyte_characters
)
1897 || SINGLE_BYTE_CHAR_P (c
)
1898 || ! char_valid_p (c
, 0))
1902 /* The biggest character code uses 19 bits. */
1903 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
1905 if (c
>= (1 << bit_offset
))
1906 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
1911 unsigned char work
[4], *str
;
1912 int i
= CHAR_STRING (c
, work
, str
);
1921 /* This function cannot GC. */
1923 DEFUN ("single-key-description", Fsingle_key_description
, Ssingle_key_description
, 1, 1, 0,
1924 "Return a pretty description of command character KEY.\n\
1925 Control characters turn into C-whatever, etc.")
1929 if (CONSP (key
) && lucid_event_type_list_p (key
))
1930 key
= Fevent_convert_list (key
);
1932 key
= EVENT_HEAD (key
);
1934 if (INTEGERP (key
)) /* Normal character */
1936 unsigned int charset
, c1
, c2
;
1937 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
1939 if (SINGLE_BYTE_CHAR_P (without_bits
))
1942 SPLIT_NON_ASCII_CHAR (without_bits
, charset
, c1
, c2
);
1945 && CHARSET_DEFINED_P (charset
)
1946 && ((c1
>= 0 && c1
< 32)
1947 || (c2
>= 0 && c2
< 32)))
1949 /* Handle a generic character. */
1951 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
1952 CHECK_STRING (name
, 0);
1953 return concat2 (build_string ("Character set "), name
);
1959 *push_key_description (XUINT (key
), tem
) = 0;
1960 return build_string (tem
);
1963 else if (SYMBOLP (key
)) /* Function key or event-symbol */
1964 return Fsymbol_name (key
);
1965 else if (STRINGP (key
)) /* Buffer names in the menubar. */
1966 return Fcopy_sequence (key
);
1968 error ("KEY must be an integer, cons, symbol, or string");
1972 push_text_char_description (c
, p
)
1973 register unsigned int c
;
1985 *p
++ = c
+ 64; /* 'A' - 1 */
1997 /* This function cannot GC. */
1999 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2000 "Return a pretty description of file-character CHARACTER.\n\
2001 Control characters turn into \"^char\", etc.")
2003 Lisp_Object character
;
2007 CHECK_NUMBER (character
, 0);
2009 if (!SINGLE_BYTE_CHAR_P (XFASTINT (character
)))
2012 int len
= non_ascii_char_to_string (XFASTINT (character
), tem
, &str
);
2014 return make_multibyte_string (str
, 1, len
);
2017 *push_text_char_description (XINT (character
) & 0377, tem
) = 0;
2019 return build_string (tem
);
2022 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2025 ascii_sequence_p (seq
)
2029 int len
= XINT (Flength (seq
));
2031 for (i
= 0; i
< len
; i
++)
2033 Lisp_Object ii
, elt
;
2035 XSETFASTINT (ii
, i
);
2036 elt
= Faref (seq
, ii
);
2039 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2047 /* where-is - finding a command in a set of keymaps. */
2049 static Lisp_Object
where_is_internal_1 ();
2050 static void where_is_internal_2 ();
2052 /* This function can GC if Flookup_key autoloads any keymaps. */
2054 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 4, 0,
2055 "Return list of keys that invoke DEFINITION.\n\
2056 If KEYMAP is non-nil, search only KEYMAP and the global keymap.\n\
2057 If KEYMAP is nil, search all the currently active keymaps.\n\
2059 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,\n\
2060 rather than a list of all possible key sequences.\n\
2061 If FIRSTONLY is the symbol `non-ascii', return the first binding found,\n\
2062 no matter what it is.\n\
2063 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters,\n\
2064 and entirely reject menu bindings.\n\
2066 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections\n\
2067 to other keymaps or slots. This makes it possible to search for an\n\
2068 indirect definition itself.")
2069 (definition
, keymap
, firstonly
, noindirect
)
2070 Lisp_Object definition
, keymap
;
2071 Lisp_Object firstonly
, noindirect
;
2074 Lisp_Object found
, sequences
;
2075 Lisp_Object keymap1
;
2076 int keymap_specified
= !NILP (keymap
);
2077 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2078 /* 1 means ignore all menu bindings entirely. */
2079 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2081 /* Find keymaps accessible from `keymap' or the current
2082 context. But don't muck with the value of `keymap',
2083 because `where_is_internal_1' uses it to check for
2084 shadowed bindings. */
2086 if (! keymap_specified
)
2088 #ifdef USE_TEXT_PROPERTIES
2089 keymap1
= get_local_map (PT
, current_buffer
);
2091 keymap1
= current_buffer
->keymap
;
2095 if (!NILP (keymap1
))
2096 maps
= nconc2 (Faccessible_keymaps (get_keymap (keymap1
), Qnil
),
2097 Faccessible_keymaps (get_keymap (current_global_map
),
2100 maps
= Faccessible_keymaps (get_keymap (current_global_map
), Qnil
);
2102 /* Put the minor mode keymaps on the front. */
2103 if (! keymap_specified
)
2106 minors
= Fnreverse (Fcurrent_minor_mode_maps ());
2107 while (!NILP (minors
))
2109 maps
= nconc2 (Faccessible_keymaps (get_keymap (XCONS (minors
)->car
),
2112 minors
= XCONS (minors
)->cdr
;
2116 GCPRO5 (definition
, keymap
, maps
, found
, sequences
);
2120 for (; !NILP (maps
); maps
= Fcdr (maps
))
2122 /* Key sequence to reach map, and the map that it reaches */
2123 register Lisp_Object
this, map
;
2125 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2126 [M-CHAR] sequences, check if last character of the sequence
2127 is the meta-prefix char. */
2131 this = Fcar (Fcar (maps
));
2132 map
= Fcdr (Fcar (maps
));
2133 last
= make_number (XINT (Flength (this)) - 1);
2134 last_is_meta
= (XINT (last
) >= 0
2135 && EQ (Faref (this, last
), meta_prefix_char
));
2141 /* Because the code we want to run on each binding is rather
2142 large, we don't want to have two separate loop bodies for
2143 sparse keymap bindings and tables; we want to iterate one
2144 loop body over both keymap and vector bindings.
2146 For this reason, if Fcar (map) is a vector, we don't
2147 advance map to the next element until i indicates that we
2148 have finished off the vector. */
2149 Lisp_Object elt
, key
, binding
;
2150 elt
= XCONS (map
)->car
;
2151 map
= XCONS (map
)->cdr
;
2157 /* Set key and binding to the current key and binding, and
2158 advance map and i to the next binding. */
2161 Lisp_Object sequence
;
2163 /* In a vector, look at each element. */
2164 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2166 binding
= XVECTOR (elt
)->contents
[i
];
2167 XSETFASTINT (key
, i
);
2168 sequence
= where_is_internal_1 (binding
, key
, definition
,
2169 noindirect
, keymap
, this,
2170 last
, nomenus
, last_is_meta
);
2171 if (!NILP (sequence
))
2172 sequences
= Fcons (sequence
, sequences
);
2175 else if (CHAR_TABLE_P (elt
))
2177 Lisp_Object indices
[3];
2180 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2181 Fcons (keymap
, Qnil
)),
2182 Fcons (Fcons (this, last
),
2183 Fcons (make_number (nomenus
),
2184 make_number (last_is_meta
))));
2186 map_char_table (where_is_internal_2
, Qnil
, elt
, args
,
2188 sequences
= XCONS (XCONS (XCONS (args
)->car
)->cdr
)->cdr
;
2190 else if (CONSP (elt
))
2192 Lisp_Object sequence
;
2194 key
= XCONS (elt
)->car
;
2195 binding
= XCONS (elt
)->cdr
;
2197 sequence
= where_is_internal_1 (binding
, key
, definition
,
2198 noindirect
, keymap
, this,
2199 last
, nomenus
, last_is_meta
);
2200 if (!NILP (sequence
))
2201 sequences
= Fcons (sequence
, sequences
);
2205 for (; ! NILP (sequences
); sequences
= XCONS (sequences
)->cdr
)
2207 Lisp_Object sequence
;
2209 sequence
= XCONS (sequences
)->car
;
2211 /* It is a true unshadowed match. Record it, unless it's already
2212 been seen (as could happen when inheriting keymaps). */
2213 if (NILP (Fmember (sequence
, found
)))
2214 found
= Fcons (sequence
, found
);
2216 /* If firstonly is Qnon_ascii, then we can return the first
2217 binding we find. If firstonly is not Qnon_ascii but not
2218 nil, then we should return the first ascii-only binding
2220 if (EQ (firstonly
, Qnon_ascii
))
2221 RETURN_UNGCPRO (sequence
);
2222 else if (! NILP (firstonly
) && ascii_sequence_p (sequence
))
2223 RETURN_UNGCPRO (sequence
);
2230 found
= Fnreverse (found
);
2232 /* firstonly may have been t, but we may have gone all the way through
2233 the keymaps without finding an all-ASCII key sequence. So just
2234 return the best we could find. */
2235 if (! NILP (firstonly
))
2236 return Fcar (found
);
2241 /* This is the function that Fwhere_is_internal calls using map_char_table.
2243 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2245 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2246 Since map_char_table doesn't really use the return value from this function,
2247 we the result append to RESULT, the slot in ARGS. */
2250 where_is_internal_2 (args
, key
, binding
)
2251 Lisp_Object args
, key
, binding
;
2253 Lisp_Object definition
, noindirect
, keymap
, this, last
;
2254 Lisp_Object result
, sequence
;
2255 int nomenus
, last_is_meta
;
2257 result
= XCONS (XCONS (XCONS (args
)->car
)->cdr
)->cdr
;
2258 definition
= XCONS (XCONS (XCONS (args
)->car
)->car
)->car
;
2259 noindirect
= XCONS (XCONS (XCONS (args
)->car
)->car
)->cdr
;
2260 keymap
= XCONS (XCONS (XCONS (args
)->car
)->cdr
)->car
;
2261 this = XCONS (XCONS (XCONS (args
)->cdr
)->car
)->car
;
2262 last
= XCONS (XCONS (XCONS (args
)->cdr
)->car
)->cdr
;
2263 nomenus
= XFASTINT (XCONS (XCONS (XCONS (args
)->cdr
)->cdr
)->car
);
2264 last_is_meta
= XFASTINT (XCONS (XCONS (XCONS (args
)->cdr
)->cdr
)->cdr
);
2266 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
, keymap
,
2267 this, last
, nomenus
, last_is_meta
);
2269 if (!NILP (sequence
))
2270 XCONS (XCONS (XCONS (args
)->car
)->cdr
)->cdr
2271 = Fcons (sequence
, result
);
2275 where_is_internal_1 (binding
, key
, definition
, noindirect
, keymap
, this, last
,
2276 nomenus
, last_is_meta
)
2277 Lisp_Object binding
, key
, definition
, noindirect
, keymap
, this, last
;
2278 int nomenus
, last_is_meta
;
2280 Lisp_Object sequence
;
2281 int keymap_specified
= !NILP (keymap
);
2283 /* Search through indirections unless that's not wanted. */
2284 if (NILP (noindirect
))
2290 Lisp_Object map
, tem
;
2291 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
2292 map
= get_keymap_1 (Fcar_safe (definition
), 0, 0);
2293 tem
= Fkeymapp (map
);
2295 definition
= access_keymap (map
, Fcdr (definition
), 0, 0);
2299 /* If the contents are (menu-item ...) or (STRING ...), reject. */
2300 if (CONSP (definition
)
2301 && (EQ (XCONS (definition
)->car
,Qmenu_item
)
2302 || STRINGP (XCONS (definition
)->car
)))
2306 binding
= get_keyelt (binding
, 0);
2309 /* End this iteration if this element does not match
2312 if (CONSP (definition
))
2315 tem
= Fequal (binding
, definition
);
2320 if (!EQ (binding
, definition
))
2323 /* We have found a match.
2324 Construct the key sequence where we found it. */
2325 if (INTEGERP (key
) && last_is_meta
)
2327 sequence
= Fcopy_sequence (this);
2328 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2331 sequence
= append_key (this, key
);
2333 /* Verify that this key binding is not shadowed by another
2334 binding for the same key, before we say it exists.
2336 Mechanism: look for local definition of this key and if
2337 it is defined and does not match what we found then
2340 Either nil or number as value from Flookup_key
2342 if (keymap_specified
)
2344 binding
= Flookup_key (keymap
, sequence
, Qnil
);
2345 if (!NILP (binding
) && !INTEGERP (binding
))
2347 if (CONSP (definition
))
2350 tem
= Fequal (binding
, definition
);
2355 if (!EQ (binding
, definition
))
2361 binding
= Fkey_binding (sequence
, Qnil
);
2362 if (!EQ (binding
, definition
))
2369 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2371 DEFUN ("describe-bindings-internal", Fdescribe_bindings_internal
, Sdescribe_bindings_internal
, 0, 2, "",
2372 "Show a list of all defined keys, and their definitions.\n\
2373 We put that list in a buffer, and display the buffer.\n\
2375 The optional argument MENUS, if non-nil, says to mention menu bindings.\n\
2376 \(Ordinarily these are omitted from the output.)\n\
2377 The optional argument PREFIX, if non-nil, should be a key sequence;\n\
2378 then we display only bindings that start with that prefix.")
2380 Lisp_Object menus
, prefix
;
2382 register Lisp_Object thisbuf
;
2383 XSETBUFFER (thisbuf
, current_buffer
);
2384 internal_with_output_to_temp_buffer ("*Help*",
2385 describe_buffer_bindings
,
2386 list3 (thisbuf
, prefix
, menus
));
2390 /* ARG is (BUFFER PREFIX MENU-FLAG). */
2393 describe_buffer_bindings (arg
)
2396 Lisp_Object descbuf
, prefix
, shadow
;
2398 register Lisp_Object start1
;
2399 struct gcpro gcpro1
;
2401 char *alternate_heading
2403 Keyboard translations:\n\n\
2404 You type Translation\n\
2405 -------- -----------\n";
2407 descbuf
= XCONS (arg
)->car
;
2408 arg
= XCONS (arg
)->cdr
;
2409 prefix
= XCONS (arg
)->car
;
2410 arg
= XCONS (arg
)->cdr
;
2411 nomenu
= NILP (XCONS (arg
)->car
);
2416 Fset_buffer (Vstandard_output
);
2418 /* Report on alternates for keys. */
2419 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2422 unsigned char *translate
= XSTRING (Vkeyboard_translate_table
)->data
;
2423 int translate_len
= XSTRING (Vkeyboard_translate_table
)->size
;
2425 for (c
= 0; c
< translate_len
; c
++)
2426 if (translate
[c
] != c
)
2431 if (alternate_heading
)
2433 insert_string (alternate_heading
);
2434 alternate_heading
= 0;
2437 bufend
= push_key_description (translate
[c
], buf
);
2438 insert (buf
, bufend
- buf
);
2439 Findent_to (make_number (16), make_number (1));
2440 bufend
= push_key_description (c
, buf
);
2441 insert (buf
, bufend
- buf
);
2449 if (!NILP (Vkey_translation_map
))
2450 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2451 "Key translations", nomenu
, 1, 0);
2455 Lisp_Object
*modes
, *maps
;
2457 /* Temporarily switch to descbuf, so that we can get that buffer's
2458 minor modes correctly. */
2459 Fset_buffer (descbuf
);
2461 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
2462 || !NILP (Voverriding_local_map
))
2465 nmaps
= current_minor_maps (&modes
, &maps
);
2466 Fset_buffer (Vstandard_output
);
2468 /* Print the minor mode maps. */
2469 for (i
= 0; i
< nmaps
; i
++)
2471 /* The title for a minor mode keymap
2472 is constructed at run time.
2473 We let describe_map_tree do the actual insertion
2474 because it takes care of other features when doing so. */
2477 if (!SYMBOLP (modes
[i
]))
2480 p
= title
= (char *) alloca (40 + XSYMBOL (modes
[i
])->name
->size
);
2482 bcopy (XSYMBOL (modes
[i
])->name
->data
, p
,
2483 XSYMBOL (modes
[i
])->name
->size
);
2484 p
+= XSYMBOL (modes
[i
])->name
->size
;
2486 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2487 p
+= sizeof (" Minor Mode Bindings") - 1;
2490 describe_map_tree (maps
[i
], 1, shadow
, prefix
, title
, nomenu
, 0, 0);
2491 shadow
= Fcons (maps
[i
], shadow
);
2495 /* Print the (major mode) local map. */
2496 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2497 start1
= current_kboard
->Voverriding_terminal_local_map
;
2498 else if (!NILP (Voverriding_local_map
))
2499 start1
= Voverriding_local_map
;
2501 start1
= XBUFFER (descbuf
)->keymap
;
2505 describe_map_tree (start1
, 1, shadow
, prefix
,
2506 "Major Mode Bindings", nomenu
, 0, 0);
2507 shadow
= Fcons (start1
, shadow
);
2510 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2511 "Global Bindings", nomenu
, 0, 1);
2513 /* Print the function-key-map translations under this prefix. */
2514 if (!NILP (Vfunction_key_map
))
2515 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2516 "Function key map translations", nomenu
, 1, 0);
2518 call0 (intern ("help-mode"));
2519 Fset_buffer (descbuf
);
2524 /* Insert a description of the key bindings in STARTMAP,
2525 followed by those of all maps reachable through STARTMAP.
2526 If PARTIAL is nonzero, omit certain "uninteresting" commands
2527 (such as `undefined').
2528 If SHADOW is non-nil, it is a list of maps;
2529 don't mention keys which would be shadowed by any of them.
2530 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2531 TITLE, if not 0, is a string to insert at the beginning.
2532 TITLE should not end with a colon or a newline; we supply that.
2533 If NOMENU is not 0, then omit menu-bar commands.
2535 If TRANSL is nonzero, the definitions are actually key translations
2536 so print strings and vectors differently.
2538 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2542 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2544 Lisp_Object startmap
, shadow
, prefix
;
2551 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2552 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2559 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
2562 GCPRO3 (maps
, seen
, sub_shadows
);
2568 /* Delete from MAPS each element that is for the menu bar. */
2569 for (list
= maps
; !NILP (list
); list
= XCONS (list
)->cdr
)
2571 Lisp_Object elt
, prefix
, tem
;
2574 prefix
= Fcar (elt
);
2575 if (XVECTOR (prefix
)->size
>= 1)
2577 tem
= Faref (prefix
, make_number (0));
2578 if (EQ (tem
, Qmenu_bar
))
2579 maps
= Fdelq (elt
, maps
);
2584 if (!NILP (maps
) || always_title
)
2588 insert_string (title
);
2591 insert_string (" Starting With ");
2592 insert1 (Fkey_description (prefix
));
2594 insert_string (":\n");
2596 insert_string (key_heading
);
2600 for (; !NILP (maps
); maps
= Fcdr (maps
))
2602 register Lisp_Object elt
, prefix
, tail
;
2605 prefix
= Fcar (elt
);
2609 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2613 shmap
= XCONS (tail
)->car
;
2615 /* If the sequence by which we reach this keymap is zero-length,
2616 then the shadow map for this keymap is just SHADOW. */
2617 if ((STRINGP (prefix
) && XSTRING (prefix
)->size
== 0)
2618 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
2620 /* If the sequence by which we reach this keymap actually has
2621 some elements, then the sequence's definition in SHADOW is
2622 what we should use. */
2625 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
2626 if (INTEGERP (shmap
))
2630 /* If shmap is not nil and not a keymap,
2631 it completely shadows this map, so don't
2632 describe this map at all. */
2633 if (!NILP (shmap
) && NILP (Fkeymapp (shmap
)))
2637 sub_shadows
= Fcons (shmap
, sub_shadows
);
2640 /* Maps we have already listed in this loop shadow this map. */
2641 for (tail
= orig_maps
; ! EQ (tail
, maps
); tail
= XCDR (tail
))
2644 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
2646 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
2649 describe_map (Fcdr (elt
), prefix
,
2650 transl
? describe_translation
: describe_command
,
2651 partial
, sub_shadows
, &seen
, nomenu
);
2657 insert_string ("\n");
2662 static int previous_description_column
;
2665 describe_command (definition
)
2666 Lisp_Object definition
;
2668 register Lisp_Object tem1
;
2669 int column
= current_column ();
2670 int description_column
;
2672 /* If column 16 is no good, go to col 32;
2673 but don't push beyond that--go to next line instead. */
2677 description_column
= 32;
2679 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
2680 description_column
= 32;
2682 description_column
= 16;
2684 Findent_to (make_number (description_column
), make_number (1));
2685 previous_description_column
= description_column
;
2687 if (SYMBOLP (definition
))
2689 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2691 insert_string ("\n");
2693 else if (STRINGP (definition
) || VECTORP (definition
))
2694 insert_string ("Keyboard Macro\n");
2697 tem1
= Fkeymapp (definition
);
2699 insert_string ("Prefix Command\n");
2701 insert_string ("??\n");
2706 describe_translation (definition
)
2707 Lisp_Object definition
;
2709 register Lisp_Object tem1
;
2711 Findent_to (make_number (16), make_number (1));
2713 if (SYMBOLP (definition
))
2715 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2717 insert_string ("\n");
2719 else if (STRINGP (definition
) || VECTORP (definition
))
2721 insert1 (Fkey_description (definition
));
2722 insert_string ("\n");
2726 tem1
= Fkeymapp (definition
);
2728 insert_string ("Prefix Command\n");
2730 insert_string ("??\n");
2734 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2735 Returns the first non-nil binding found in any of those maps. */
2738 shadow_lookup (shadow
, key
, flag
)
2739 Lisp_Object shadow
, key
, flag
;
2741 Lisp_Object tail
, value
;
2743 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2745 value
= Flookup_key (XCONS (tail
)->car
, key
, flag
);
2752 /* Describe the contents of map MAP, assuming that this map itself is
2753 reached by the sequence of prefix keys KEYS (a string or vector).
2754 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
2757 describe_map (map
, keys
, elt_describer
, partial
, shadow
, seen
, nomenu
)
2758 register Lisp_Object map
;
2760 void (*elt_describer
) P_ ((Lisp_Object
));
2766 Lisp_Object elt_prefix
;
2767 Lisp_Object tail
, definition
, event
;
2769 Lisp_Object suppress
;
2772 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2774 if (!NILP (keys
) && XFASTINT (Flength (keys
)) > 0)
2776 /* Call Fkey_description first, to avoid GC bug for the other string. */
2777 tem
= Fkey_description (keys
);
2778 elt_prefix
= concat2 (tem
, build_string (" "));
2784 suppress
= intern ("suppress-keymap");
2786 /* This vector gets used to present single keys to Flookup_key. Since
2787 that is done once per keymap element, we don't want to cons up a
2788 fresh vector every time. */
2789 kludge
= Fmake_vector (make_number (1), Qnil
);
2792 GCPRO3 (elt_prefix
, definition
, kludge
);
2794 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2798 if (VECTORP (XCONS (tail
)->car
)
2799 || CHAR_TABLE_P (XCONS (tail
)->car
))
2800 describe_vector (XCONS (tail
)->car
,
2801 elt_prefix
, elt_describer
, partial
, shadow
, map
,
2803 else if (CONSP (XCONS (tail
)->car
))
2805 event
= XCONS (XCONS (tail
)->car
)->car
;
2807 /* Ignore bindings whose "keys" are not really valid events.
2808 (We get these in the frames and buffers menu.) */
2809 if (! (SYMBOLP (event
) || INTEGERP (event
)))
2812 if (nomenu
&& EQ (event
, Qmenu_bar
))
2815 definition
= get_keyelt (XCONS (XCONS (tail
)->car
)->cdr
, 0);
2817 /* Don't show undefined commands or suppressed commands. */
2818 if (NILP (definition
)) continue;
2819 if (SYMBOLP (definition
) && partial
)
2821 tem
= Fget (definition
, suppress
);
2826 /* Don't show a command that isn't really visible
2827 because a local definition of the same key shadows it. */
2829 XVECTOR (kludge
)->contents
[0] = event
;
2832 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2833 if (!NILP (tem
)) continue;
2836 tem
= Flookup_key (map
, kludge
, Qt
);
2837 if (! EQ (tem
, definition
)) continue;
2841 previous_description_column
= 0;
2846 if (!NILP (elt_prefix
))
2847 insert1 (elt_prefix
);
2849 /* THIS gets the string to describe the character EVENT. */
2850 insert1 (Fsingle_key_description (event
));
2852 /* Print a description of the definition of this character.
2853 elt_describer will take care of spacing out far enough
2854 for alignment purposes. */
2855 (*elt_describer
) (definition
);
2857 else if (EQ (XCONS (tail
)->car
, Qkeymap
))
2859 /* The same keymap might be in the structure twice, if we're
2860 using an inherited keymap. So skip anything we've already
2862 tem
= Fassq (tail
, *seen
);
2863 if (CONSP (tem
) && !NILP (Fequal (XCONS (tem
)->car
, keys
)))
2865 *seen
= Fcons (Fcons (tail
, keys
), *seen
);
2873 describe_vector_princ (elt
)
2876 Findent_to (make_number (16), make_number (1));
2881 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 1, 0,
2882 "Insert a description of contents of VECTOR.\n\
2883 This is text showing the elements of vector matched against indices.")
2887 int count
= specpdl_ptr
- specpdl
;
2889 specbind (Qstandard_output
, Fcurrent_buffer ());
2890 CHECK_VECTOR_OR_CHAR_TABLE (vector
, 0);
2891 describe_vector (vector
, Qnil
, describe_vector_princ
, 0,
2892 Qnil
, Qnil
, (int *)0, 0);
2894 return unbind_to (count
, Qnil
);
2897 /* Insert in the current buffer a description of the contents of VECTOR.
2898 We call ELT_DESCRIBER to insert the description of one value found
2901 ELT_PREFIX describes what "comes before" the keys or indices defined
2902 by this vector. This is a human-readable string whose size
2903 is not necessarily related to the situation.
2905 If the vector is in a keymap, ELT_PREFIX is a prefix key which
2906 leads to this keymap.
2908 If the vector is a chartable, ELT_PREFIX is the vector
2909 of bytes that lead to the character set or portion of a character
2910 set described by this chartable.
2912 If PARTIAL is nonzero, it means do not mention suppressed commands
2913 (that assumes the vector is in a keymap).
2915 SHADOW is a list of keymaps that shadow this map.
2916 If it is non-nil, then we look up the key in those maps
2917 and we don't mention it now if it is defined by any of them.
2919 ENTIRE_MAP is the keymap in which this vector appears.
2920 If the definition in effect in the whole map does not match
2921 the one in this vector, we ignore this one.
2923 When describing a sub-char-table, INDICES is a list of
2924 indices at higher levels in this char-table,
2925 and CHAR_TABLE_DEPTH says how many levels down we have gone. */
2928 describe_vector (vector
, elt_prefix
, elt_describer
,
2929 partial
, shadow
, entire_map
,
2930 indices
, char_table_depth
)
2931 register Lisp_Object vector
;
2932 Lisp_Object elt_prefix
;
2933 void (*elt_describer
) P_ ((Lisp_Object
));
2936 Lisp_Object entire_map
;
2938 int char_table_depth
;
2940 Lisp_Object definition
;
2943 Lisp_Object suppress
;
2946 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2947 /* Range of elements to be handled. */
2949 /* A flag to tell if a leaf in this level of char-table is not a
2950 generic character (i.e. a complete multibyte character). */
2956 indices
= (int *) alloca (3 * sizeof (int));
2960 /* This vector gets used to present single keys to Flookup_key. Since
2961 that is done once per vector element, we don't want to cons up a
2962 fresh vector every time. */
2963 kludge
= Fmake_vector (make_number (1), Qnil
);
2964 GCPRO3 (elt_prefix
, definition
, kludge
);
2967 suppress
= intern ("suppress-keymap");
2969 if (CHAR_TABLE_P (vector
))
2971 if (char_table_depth
== 0)
2973 /* VECTOR is a top level char-table. */
2976 to
= CHAR_TABLE_ORDINARY_SLOTS
;
2980 /* VECTOR is a sub char-table. */
2981 if (char_table_depth
>= 3)
2982 /* A char-table is never that deep. */
2983 error ("Too deep char table");
2986 = (CHARSET_VALID_P (indices
[0])
2987 && ((CHARSET_DIMENSION (indices
[0]) == 1
2988 && char_table_depth
== 1)
2989 || char_table_depth
== 2));
2991 /* Meaningful elements are from 32th to 127th. */
2993 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
2998 /* This does the right thing for ordinary vectors. */
3002 to
= XVECTOR (vector
)->size
;
3005 for (i
= from
; i
< to
; i
++)
3009 if (CHAR_TABLE_P (vector
))
3011 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3014 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3015 && !CHARSET_DEFINED_P (i
- 128))
3019 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3022 definition
= get_keyelt (XVECTOR (vector
)->contents
[i
], 0);
3024 if (NILP (definition
)) continue;
3026 /* Don't mention suppressed commands. */
3027 if (SYMBOLP (definition
) && partial
)
3031 tem
= Fget (definition
, suppress
);
3033 if (!NILP (tem
)) continue;
3036 /* Set CHARACTER to the character this entry describes, if any.
3037 Also update *INDICES. */
3038 if (CHAR_TABLE_P (vector
))
3040 indices
[char_table_depth
] = i
;
3042 if (char_table_depth
== 0)
3045 indices
[0] = i
- 128;
3047 else if (complete_char
)
3050 = MAKE_NON_ASCII_CHAR (indices
[0], indices
[1], indices
[2]);
3058 /* If this binding is shadowed by some other map, ignore it. */
3059 if (!NILP (shadow
) && complete_char
)
3063 XVECTOR (kludge
)->contents
[0] = make_number (character
);
3064 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3066 if (!NILP (tem
)) continue;
3069 /* Ignore this definition if it is shadowed by an earlier
3070 one in the same keymap. */
3071 if (!NILP (entire_map
) && complete_char
)
3075 XVECTOR (kludge
)->contents
[0] = make_number (character
);
3076 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3078 if (! EQ (tem
, definition
))
3084 if (char_table_depth
== 0)
3089 /* For a sub char-table, show the depth by indentation.
3090 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3091 if (char_table_depth
> 0)
3092 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3094 /* Output the prefix that applies to every entry in this map. */
3095 if (!NILP (elt_prefix
))
3096 insert1 (elt_prefix
);
3098 /* Insert or describe the character this slot is for,
3099 or a description of what it is for. */
3100 if (SUB_CHAR_TABLE_P (vector
))
3103 insert_char (character
);
3106 /* We need an octal representation for this block of
3109 sprintf (work
, "(row %d)", i
);
3110 insert (work
, strlen (work
));
3113 else if (CHAR_TABLE_P (vector
))
3116 insert1 (Fsingle_key_description (make_number (character
)));
3119 /* Print the information for this character set. */
3120 insert_string ("<");
3121 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3123 insert_from_string (tem2
, 0, 0, XSTRING (tem2
)->size
,
3124 STRING_BYTES (XSTRING (tem2
)), 0);
3132 insert1 (Fsingle_key_description (make_number (character
)));
3135 /* If we find a sub char-table within a char-table,
3136 scan it recursively; it defines the details for
3137 a character set or a portion of a character set. */
3138 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3141 describe_vector (definition
, elt_prefix
, elt_describer
,
3142 partial
, shadow
, entire_map
,
3143 indices
, char_table_depth
+ 1);
3149 /* Find all consecutive characters or rows that have the same
3150 definition. But, for elements of a top level char table, if
3151 they are for charsets, we had better describe one by one even
3152 if they have the same definition. */
3153 if (CHAR_TABLE_P (vector
))
3157 if (char_table_depth
== 0)
3158 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3160 while (i
+ 1 < limit
3161 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3163 && !NILP (Fequal (tem2
, definition
)))
3168 && (tem2
= get_keyelt (XVECTOR (vector
)->contents
[i
+ 1], 0),
3170 && !NILP (Fequal (tem2
, definition
)))
3174 /* If we have a range of more than one character,
3175 print where the range reaches to. */
3177 if (i
!= starting_i
)
3181 if (!NILP (elt_prefix
))
3182 insert1 (elt_prefix
);
3184 if (CHAR_TABLE_P (vector
))
3186 if (char_table_depth
== 0)
3188 insert1 (Fsingle_key_description (make_number (i
)));
3190 else if (complete_char
)
3192 indices
[char_table_depth
] = i
;
3194 = MAKE_NON_ASCII_CHAR (indices
[0], indices
[1], indices
[2]);
3195 insert_char (character
);
3199 /* We need an octal representation for this block of
3202 sprintf (work
, "(row %d)", i
);
3203 insert (work
, strlen (work
));
3208 insert1 (Fsingle_key_description (make_number (i
)));
3212 /* Print a description of the definition of this character.
3213 elt_describer will take care of spacing out far enough
3214 for alignment purposes. */
3215 (*elt_describer
) (definition
);
3218 /* For (sub) char-table, print `defalt' slot at last. */
3219 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3221 insert (" ", char_table_depth
* 2);
3222 insert_string ("<<default>>");
3223 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
);
3229 /* Apropos - finding all symbols whose names match a regexp. */
3230 Lisp_Object apropos_predicate
;
3231 Lisp_Object apropos_accumulate
;
3234 apropos_accum (symbol
, string
)
3235 Lisp_Object symbol
, string
;
3237 register Lisp_Object tem
;
3239 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3240 if (!NILP (tem
) && !NILP (apropos_predicate
))
3241 tem
= call1 (apropos_predicate
, symbol
);
3243 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3246 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3247 "Show all symbols whose names contain match for REGEXP.\n\
3248 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done\n\
3249 for each symbol and a symbol is mentioned only if that returns non-nil.\n\
3250 Return list of symbols found.")
3252 Lisp_Object regexp
, predicate
;
3254 struct gcpro gcpro1
, gcpro2
;
3255 CHECK_STRING (regexp
, 0);
3256 apropos_predicate
= predicate
;
3257 GCPRO2 (apropos_predicate
, apropos_accumulate
);
3258 apropos_accumulate
= Qnil
;
3259 map_obarray (Vobarray
, apropos_accum
, regexp
);
3260 apropos_accumulate
= Fsort (apropos_accumulate
, Qstring_lessp
);
3262 return apropos_accumulate
;
3270 Qkeymap
= intern ("keymap");
3271 staticpro (&Qkeymap
);
3273 /* Now we are ready to set up this property, so we can
3274 create char tables. */
3275 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3277 /* Initialize the keymaps standardly used.
3278 Each one is the value of a Lisp variable, and is also
3279 pointed to by a C variable */
3281 global_map
= Fmake_keymap (Qnil
);
3282 Fset (intern ("global-map"), global_map
);
3284 current_global_map
= global_map
;
3285 staticpro (&global_map
);
3286 staticpro (¤t_global_map
);
3288 meta_map
= Fmake_keymap (Qnil
);
3289 Fset (intern ("esc-map"), meta_map
);
3290 Ffset (intern ("ESC-prefix"), meta_map
);
3292 control_x_map
= Fmake_keymap (Qnil
);
3293 Fset (intern ("ctl-x-map"), control_x_map
);
3294 Ffset (intern ("Control-X-prefix"), control_x_map
);
3296 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3297 "List of commands given new key bindings recently.\n\
3298 This is used for internal purposes during Emacs startup;\n\
3299 don't alter it yourself.");
3300 Vdefine_key_rebound_commands
= Qt
;
3302 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3303 "Default keymap to use when reading from the minibuffer.");
3304 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3306 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3307 "Local keymap for the minibuffer when spaces are not allowed.");
3308 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3310 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3311 "Local keymap for minibuffer input with completion.");
3312 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3314 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3315 "Local keymap for minibuffer input with completion, for exact match.");
3316 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3318 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3319 "Alist of keymaps to use for minor modes.\n\
3320 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read\n\
3321 key sequences and look up bindings iff VARIABLE's value is non-nil.\n\
3322 If two active keymaps bind the same key, the keymap appearing earlier\n\
3323 in the list takes precedence.");
3324 Vminor_mode_map_alist
= Qnil
;
3326 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3327 "Alist of keymaps to use for minor modes, in current major mode.\n\
3328 This variable is a alist just like `minor-mode-map-alist', and it is\n\
3329 used the same way (and before `minor-mode-map-alist'); however,\n\
3330 it is provided for major modes to bind locally.");
3331 Vminor_mode_overriding_map_alist
= Qnil
;
3333 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3334 "Keymap mapping ASCII function key sequences onto their preferred forms.\n\
3335 This allows Emacs to recognize function keys sent from ASCII\n\
3336 terminals at any point in a key sequence.\n\
3338 The `read-key-sequence' function replaces any subsequence bound by\n\
3339 `function-key-map' with its binding. More precisely, when the active\n\
3340 keymaps have no binding for the current key sequence but\n\
3341 `function-key-map' binds a suffix of the sequence to a vector or string,\n\
3342 `read-key-sequence' replaces the matching suffix with its binding, and\n\
3343 continues with the new sequence.\n\
3345 The events that come from bindings in `function-key-map' are not\n\
3346 themselves looked up in `function-key-map'.\n\
3348 For example, suppose `function-key-map' binds `ESC O P' to [f1].\n\
3349 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing\n\
3350 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix\n\
3351 key, typing `ESC O P x' would return [f1 x].");
3352 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3354 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3355 "Keymap of key translations that can override keymaps.\n\
3356 This keymap works like `function-key-map', but comes after that,\n\
3357 and applies even for keys that have ordinary bindings.");
3358 Vkey_translation_map
= Qnil
;
3360 Qsingle_key_description
= intern ("single-key-description");
3361 staticpro (&Qsingle_key_description
);
3363 Qkey_description
= intern ("key-description");
3364 staticpro (&Qkey_description
);
3366 Qkeymapp
= intern ("keymapp");
3367 staticpro (&Qkeymapp
);
3369 Qnon_ascii
= intern ("non-ascii");
3370 staticpro (&Qnon_ascii
);
3372 Qmenu_item
= intern ("menu-item");
3373 staticpro (&Qmenu_item
);
3375 defsubr (&Skeymapp
);
3376 defsubr (&Skeymap_parent
);
3377 defsubr (&Sset_keymap_parent
);
3378 defsubr (&Smake_keymap
);
3379 defsubr (&Smake_sparse_keymap
);
3380 defsubr (&Scopy_keymap
);
3381 defsubr (&Skey_binding
);
3382 defsubr (&Slocal_key_binding
);
3383 defsubr (&Sglobal_key_binding
);
3384 defsubr (&Sminor_mode_key_binding
);
3385 defsubr (&Sdefine_key
);
3386 defsubr (&Slookup_key
);
3387 defsubr (&Sdefine_prefix_command
);
3388 defsubr (&Suse_global_map
);
3389 defsubr (&Suse_local_map
);
3390 defsubr (&Scurrent_local_map
);
3391 defsubr (&Scurrent_global_map
);
3392 defsubr (&Scurrent_minor_mode_maps
);
3393 defsubr (&Saccessible_keymaps
);
3394 defsubr (&Skey_description
);
3395 defsubr (&Sdescribe_vector
);
3396 defsubr (&Ssingle_key_description
);
3397 defsubr (&Stext_char_description
);
3398 defsubr (&Swhere_is_internal
);
3399 defsubr (&Sdescribe_bindings_internal
);
3400 defsubr (&Sapropos_internal
);
3408 initial_define_key (global_map
, 033, "ESC-prefix");
3409 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");