1 /* Manipulation of keymaps
2 Copyright (C) 1985-1988, 1993-1995, 1998-2011 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 3 of the License, or
9 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
20 - [M-C-a] != [?\M-\C-a]
22 - (define-key map [menu-bar foo] <bla>) does not always place <bla>
23 at the head of the menu (if `foo' was already bound earlier and
24 then unbound, for example).
26 - allow many more Meta -> ESC mappings (like Hyper -> C-e for Emacspeak)
27 - Think about the various defaulting that's currently hard-coded in
28 keyboard.c (uppercase->lowercase, char->charset, button-events, ...)
29 and make it more generic. Maybe we should allow mappings of the
30 form (PREDICATE . BINDING) as generalization of the default binding,
31 tho probably a cleaner way to attack this is to allow functional
32 keymaps (i.e. keymaps that are implemented as functions that implement
33 a few different methods like `lookup', `map', ...).
34 - Make [a] equivalent to [?a].
36 - map-keymap should work meaningfully even if entries are added/removed
37 to the keymap while iterating through it:
38 start - removed <= visited <= start + added
47 #include "character.h"
51 #include "termhooks.h"
52 #include "blockinput.h"
54 #include "intervals.h"
58 /* Actually allocate storage for these variables */
60 Lisp_Object current_global_map
; /* Current global keymap */
62 Lisp_Object global_map
; /* default global key bindings */
64 Lisp_Object meta_map
; /* The keymap used for globally bound
65 ESC-prefixed default commands */
67 Lisp_Object control_x_map
; /* The keymap used for globally bound
68 C-x-prefixed default commands */
70 /* The keymap used by the minibuf for local
71 bindings when spaces are allowed in the
74 /* The keymap used by the minibuf for local
75 bindings when spaces are not encouraged
78 /* keymap used for minibuffers when doing completion */
79 /* keymap used for minibuffers when doing completion and require a match */
80 static Lisp_Object Qkeymapp
, Qnon_ascii
;
81 Lisp_Object Qkeymap
, Qmenu_item
, Qremap
;
82 static Lisp_Object QCadvertised_binding
;
84 /* Alist of elements like (DEL . "\d"). */
85 static Lisp_Object exclude_keys
;
87 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
88 static Lisp_Object command_remapping_vector
;
90 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
91 static Lisp_Object where_is_cache
;
92 /* Which keymaps are reverse-stored in the cache. */
93 static Lisp_Object where_is_cache_keymaps
;
95 static Lisp_Object
Flookup_key (Lisp_Object
, Lisp_Object
, Lisp_Object
);
96 static Lisp_Object
store_in_keymap (Lisp_Object
, Lisp_Object
, Lisp_Object
);
98 static Lisp_Object
define_as_prefix (Lisp_Object
, Lisp_Object
);
99 static void describe_command (Lisp_Object
, Lisp_Object
);
100 static void describe_translation (Lisp_Object
, Lisp_Object
);
101 static void describe_map (Lisp_Object
, Lisp_Object
,
102 void (*) (Lisp_Object
, Lisp_Object
),
103 int, Lisp_Object
, Lisp_Object
*, int, int);
104 static void describe_vector (Lisp_Object
, Lisp_Object
, Lisp_Object
,
105 void (*) (Lisp_Object
, Lisp_Object
), int,
106 Lisp_Object
, Lisp_Object
, int, int);
107 static void silly_event_symbol_error (Lisp_Object
);
108 static Lisp_Object
get_keyelt (Lisp_Object
, int);
110 /* Keymap object support - constructors and predicates. */
112 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
113 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
114 CHARTABLE is a char-table that holds the bindings for all characters
115 without modifiers. All entries in it are initially nil, meaning
116 "command undefined". ALIST is an assoc-list which holds bindings for
117 function keys, mouse events, and any other things that appear in the
118 input stream. Initially, ALIST is nil.
120 The optional arg STRING supplies a menu name for the keymap
121 in case you use it as a menu with `x-popup-menu'. */)
126 tail
= Fcons (string
, Qnil
);
129 return Fcons (Qkeymap
,
130 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
133 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
134 doc
: /* Construct and return a new sparse keymap.
135 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
136 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
137 which binds the function key or mouse event SYMBOL to DEFINITION.
138 Initially the 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'. */)
146 if (!NILP (Vpurify_flag
))
147 string
= Fpurecopy (string
);
148 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
150 return Fcons (Qkeymap
, Qnil
);
153 /* This function is used for installing the standard key bindings
154 at initialization time.
158 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
161 initial_define_key (Lisp_Object keymap
, int key
, const char *defname
)
163 store_in_keymap (keymap
, make_number (key
), intern_c_string (defname
));
167 initial_define_lispy_key (Lisp_Object keymap
, const char *keyname
, const char *defname
)
169 store_in_keymap (keymap
, intern_c_string (keyname
), intern_c_string (defname
));
172 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
173 doc
: /* Return t if OBJECT is a keymap.
175 A keymap is a list (keymap . ALIST),
176 or a symbol whose function definition is itself a keymap.
177 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
178 a vector of densely packed bindings for small character codes
179 is also allowed as an element. */)
182 return (KEYMAPP (object
) ? Qt
: Qnil
);
185 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
186 doc
: /* Return the prompt-string of a keymap MAP.
187 If non-nil, the prompt is shown in the echo-area
188 when reading a key-sequence to be looked-up in this keymap. */)
191 map
= get_keymap (map
, 0, 0);
194 Lisp_Object tem
= XCAR (map
);
197 else if (KEYMAPP (tem
))
199 tem
= Fkeymap_prompt (tem
);
208 /* Check that OBJECT is a keymap (after dereferencing through any
209 symbols). If it is, return it.
211 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
212 is an autoload form, do the autoload and try again.
213 If AUTOLOAD is nonzero, callers must assume GC is possible.
215 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
216 is zero as well), return Qt.
218 ERROR_IF_NOT_KEYMAP controls how we respond if OBJECT isn't a keymap.
219 If ERROR_IF_NOT_KEYMAP is non-zero, signal an error; otherwise,
222 Note that most of the time, we don't want to pursue autoloads.
223 Functions like Faccessible_keymaps which scan entire keymap trees
224 shouldn't load every autoloaded keymap. I'm not sure about this,
225 but it seems to me that only read_key_sequence, Flookup_key, and
226 Fdefine_key should cause keymaps to be autoloaded.
228 This function can GC when AUTOLOAD is non-zero, because it calls
229 do_autoload which can GC. */
232 get_keymap (Lisp_Object object
, int error_if_not_keymap
, int autoload
)
239 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
242 tem
= indirect_function (object
);
245 if (EQ (XCAR (tem
), Qkeymap
))
248 /* Should we do an autoload? Autoload forms for keymaps have
249 Qkeymap as their fifth element. */
250 if ((autoload
|| !error_if_not_keymap
) && EQ (XCAR (tem
), Qautoload
)
255 tail
= Fnth (make_number (4), tem
);
256 if (EQ (tail
, Qkeymap
))
260 struct gcpro gcpro1
, gcpro2
;
262 GCPRO2 (tem
, object
);
263 do_autoload (tem
, object
);
275 if (error_if_not_keymap
)
276 wrong_type_argument (Qkeymapp
, object
);
280 /* Return the parent map of KEYMAP, or nil if it has none.
281 We assume that KEYMAP is a valid keymap. */
284 keymap_parent (Lisp_Object keymap
, int autoload
)
288 keymap
= get_keymap (keymap
, 1, autoload
);
290 /* Skip past the initial element `keymap'. */
291 list
= XCDR (keymap
);
292 for (; CONSP (list
); list
= XCDR (list
))
294 /* See if there is another `keymap'. */
299 return get_keymap (list
, 0, autoload
);
302 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
303 doc
: /* Return the parent keymap of KEYMAP.
304 If KEYMAP has no parent, return nil. */)
307 return keymap_parent (keymap
, 1);
310 /* Check whether MAP is one of MAPS parents. */
312 keymap_memberp (Lisp_Object map
, Lisp_Object maps
)
314 if (NILP (map
)) return 0;
315 while (KEYMAPP (maps
) && !EQ (map
, maps
))
316 maps
= keymap_parent (maps
, 0);
317 return (EQ (map
, maps
));
320 /* Set the parent keymap of MAP to PARENT. */
322 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
323 doc
: /* Modify KEYMAP to set its parent map to PARENT.
324 Return PARENT. PARENT should be nil or another keymap. */)
325 (Lisp_Object keymap
, Lisp_Object parent
)
327 Lisp_Object list
, prev
;
328 struct gcpro gcpro1
, gcpro2
;
330 /* Flush any reverse-map cache. */
331 where_is_cache
= Qnil
; where_is_cache_keymaps
= Qt
;
333 GCPRO2 (keymap
, parent
);
334 keymap
= get_keymap (keymap
, 1, 1);
338 parent
= get_keymap (parent
, 1, 0);
340 /* Check for cycles. */
341 if (keymap_memberp (keymap
, parent
))
342 error ("Cyclic keymap inheritance");
345 /* Skip past the initial element `keymap'. */
350 /* If there is a parent keymap here, replace it.
351 If we came to the end, add the parent in PREV. */
352 if (!CONSP (list
) || KEYMAPP (list
))
355 XSETCDR (prev
, parent
);
356 RETURN_UNGCPRO (parent
);
363 /* Look up IDX in MAP. IDX may be any sort of event.
364 Note that this does only one level of lookup; IDX must be a single
365 event, not a sequence.
367 MAP must be a keymap or a list of keymaps.
369 If T_OK is non-zero, bindings for Qt are treated as default
370 bindings; any key left unmentioned by other tables and bindings is
371 given the binding of Qt.
373 If T_OK is zero, bindings for Qt are not treated specially.
375 If NOINHERIT, don't accept a subkeymap found in an inherited keymap.
377 Returns Qunbound if no binding was found (and returns Qnil if a nil
378 binding was found). */
381 access_keymap_1 (Lisp_Object map
, Lisp_Object idx
, int t_ok
, int noinherit
, int autoload
)
383 /* If idx is a list (some sort of mouse click, perhaps?),
384 the index we want to use is the car of the list, which
385 ought to be a symbol. */
386 idx
= EVENT_HEAD (idx
);
388 /* If idx is a symbol, it might have modifiers, which need to
389 be put in the canonical order. */
391 idx
= reorder_modifiers (idx
);
392 else if (INTEGERP (idx
))
393 /* Clobber the high bits that can be present on a machine
394 with more than 24 bits of integer. */
395 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
397 /* Handle the special meta -> esc mapping. */
398 if (INTEGERP (idx
) && XFASTINT (idx
) & meta_modifier
)
400 /* See if there is a meta-map. If there's none, there is
401 no binding for IDX, unless a default binding exists in MAP. */
403 Lisp_Object event_meta_binding
, event_meta_map
;
405 /* A strange value in which Meta is set would cause
406 infinite recursion. Protect against that. */
407 if (XINT (meta_prefix_char
) & CHAR_META
)
408 meta_prefix_char
= make_number (27);
409 event_meta_binding
= access_keymap_1 (map
, meta_prefix_char
, t_ok
,
410 noinherit
, autoload
);
411 event_meta_map
= get_keymap (event_meta_binding
, 0, autoload
);
413 if (CONSP (event_meta_map
))
415 map
= event_meta_map
;
416 idx
= make_number (XFASTINT (idx
) & ~meta_modifier
);
419 /* Set IDX to t, so that we only find a default binding. */
422 /* An explicit nil binding, or no binding at all. */
423 return NILP (event_meta_binding
) ? Qnil
: Qunbound
;
426 /* t_binding is where we put a default binding that applies,
427 to use in case we do not find a binding specifically
428 for this key sequence. */
431 Lisp_Object t_binding
= Qunbound
;
432 Lisp_Object retval
= Qunbound
;
433 Lisp_Object retval_tail
= Qnil
;
434 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
436 GCPRO4 (tail
, idx
, t_binding
, retval
);
438 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
440 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
443 /* Qunbound in VAL means we have found no binding. */
444 Lisp_Object val
= Qunbound
;
445 Lisp_Object binding
= XCAR (tail
);
446 Lisp_Object submap
= get_keymap (binding
, 0, autoload
);
448 if (EQ (binding
, Qkeymap
))
450 if (noinherit
|| NILP (retval
))
451 /* If NOINHERIT, stop here, the rest is inherited. */
453 else if (!EQ (retval
, Qunbound
))
455 Lisp_Object parent_entry
;
456 eassert (KEYMAPP (retval
));
458 = get_keymap (access_keymap_1 (tail
, idx
,
461 if (KEYMAPP (parent_entry
))
463 if (CONSP (retval_tail
))
464 XSETCDR (retval_tail
, parent_entry
);
467 retval_tail
= Fcons (retval
, parent_entry
);
468 retval
= Fcons (Qkeymap
, retval_tail
);
474 else if (CONSP (submap
))
476 val
= access_keymap_1 (submap
, idx
, t_ok
, noinherit
, autoload
);
478 else if (CONSP (binding
))
480 Lisp_Object key
= XCAR (binding
);
483 val
= XCDR (binding
);
484 else if (t_ok
&& EQ (key
, Qt
))
486 t_binding
= XCDR (binding
);
490 else if (VECTORP (binding
))
492 if (INTEGERP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
493 val
= AREF (binding
, XFASTINT (idx
));
495 else if (CHAR_TABLE_P (binding
))
497 /* Character codes with modifiers
498 are not included in a char-table.
499 All character codes without modifiers are included. */
500 if (INTEGERP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
502 val
= Faref (binding
, idx
);
503 /* `nil' has a special meaning for char-tables, so
504 we use something else to record an explicitly
511 /* If we found a binding, clean it up and return it. */
512 if (!EQ (val
, Qunbound
))
515 /* A Qt binding is just like an explicit nil binding
516 (i.e. it shadows any parent binding but not bindings in
517 keymaps of lower precedence). */
520 val
= get_keyelt (val
, autoload
);
524 if (NILP (retval
) || EQ (retval
, Qunbound
))
527 break; /* Shadows everything that follows. */
529 else if (NILP (retval
) || EQ (retval
, Qunbound
))
531 else if (CONSP (retval_tail
))
533 XSETCDR (retval_tail
, Fcons (val
, Qnil
));
534 retval_tail
= XCDR (retval_tail
);
538 retval_tail
= Fcons (val
, Qnil
);
539 retval
= Fcons (Qkeymap
, Fcons (retval
, retval_tail
));
545 return EQ (Qunbound
, retval
) ? get_keyelt (t_binding
, autoload
) : retval
;
550 access_keymap (Lisp_Object map
, Lisp_Object idx
,
551 int t_ok
, int noinherit
, int autoload
)
553 Lisp_Object val
= access_keymap_1 (map
, idx
, t_ok
, noinherit
, autoload
);
554 return EQ (val
, Qunbound
) ? Qnil
: val
;
558 map_keymap_item (map_keymap_function_t fun
, Lisp_Object args
, Lisp_Object key
, Lisp_Object val
, void *data
)
562 (*fun
) (key
, val
, args
, data
);
566 map_keymap_char_table_item (Lisp_Object args
, Lisp_Object key
, Lisp_Object val
)
570 map_keymap_function_t fun
571 = (map_keymap_function_t
) XSAVE_VALUE (XCAR (args
))->pointer
;
573 /* If the key is a range, make a copy since map_char_table modifies
576 key
= Fcons (XCAR (key
), XCDR (key
));
577 map_keymap_item (fun
, XCDR (args
), key
, val
,
578 XSAVE_VALUE (XCAR (args
))->pointer
);
582 /* Call FUN for every binding in MAP and stop at (and return) the parent.
583 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA). */
585 map_keymap_internal (Lisp_Object map
,
586 map_keymap_function_t fun
,
590 struct gcpro gcpro1
, gcpro2
, gcpro3
;
592 = (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
594 GCPRO3 (map
, args
, tail
);
595 for (; CONSP (tail
) && !EQ (Qkeymap
, XCAR (tail
)); tail
= XCDR (tail
))
597 Lisp_Object binding
= XCAR (tail
);
599 if (KEYMAPP (binding
)) /* An embedded parent. */
601 else if (CONSP (binding
))
602 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
603 else if (VECTORP (binding
))
605 /* Loop over the char values represented in the vector. */
606 int len
= ASIZE (binding
);
608 for (c
= 0; c
< len
; c
++)
610 Lisp_Object character
;
611 XSETFASTINT (character
, c
);
612 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
615 else if (CHAR_TABLE_P (binding
))
617 map_char_table (map_keymap_char_table_item
, Qnil
, binding
,
618 Fcons (make_save_value ((void *) fun
, 0),
619 Fcons (make_save_value (data
, 0),
628 map_keymap_call (Lisp_Object key
, Lisp_Object val
, Lisp_Object fun
, void *dummy
)
630 call2 (fun
, key
, val
);
633 /* Same as map_keymap_internal, but traverses parent keymaps as well.
634 A non-zero AUTOLOAD indicates that autoloaded keymaps should be loaded. */
636 map_keymap (Lisp_Object map
, map_keymap_function_t fun
, Lisp_Object args
, void *data
, int autoload
)
640 map
= get_keymap (map
, 1, autoload
);
643 if (KEYMAPP (XCAR (map
)))
645 map_keymap (XCAR (map
), fun
, args
, data
, autoload
);
649 map
= map_keymap_internal (map
, fun
, args
, data
);
651 map
= get_keymap (map
, 0, autoload
);
656 static Lisp_Object Qkeymap_canonicalize
;
658 /* Same as map_keymap, but does it right, properly eliminating duplicate
659 bindings due to inheritance. */
661 map_keymap_canonical (Lisp_Object map
, map_keymap_function_t fun
, Lisp_Object args
, void *data
)
665 /* map_keymap_canonical may be used from redisplay (e.g. when building menus)
666 so be careful to ignore errors and to inhibit redisplay. */
667 map
= safe_call1 (Qkeymap_canonicalize
, map
);
668 /* No need to use `map_keymap' here because canonical map has no parent. */
669 map_keymap_internal (map
, fun
, args
, data
);
673 DEFUN ("map-keymap-internal", Fmap_keymap_internal
, Smap_keymap_internal
, 2, 2, 0,
674 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
675 FUNCTION is called with two arguments: the event that is bound, and
676 the definition it is bound to. The event may be a character range.
677 If KEYMAP has a parent, this function returns it without processing it. */)
678 (Lisp_Object function
, Lisp_Object keymap
)
682 keymap
= get_keymap (keymap
, 1, 1);
683 keymap
= map_keymap_internal (keymap
, map_keymap_call
, function
, NULL
);
688 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
689 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
690 FUNCTION is called with two arguments: the event that is bound, and
691 the definition it is bound to. The event may be a character range.
693 If KEYMAP has a parent, the parent's bindings are included as well.
694 This works recursively: if the parent has itself a parent, then the
695 grandparent's bindings are also included and so on.
696 usage: (map-keymap FUNCTION KEYMAP) */)
697 (Lisp_Object function
, Lisp_Object keymap
, Lisp_Object sort_first
)
699 if (! NILP (sort_first
))
700 return call2 (intern ("map-keymap-sorted"), function
, keymap
);
702 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
706 /* Given OBJECT which was found in a slot in a keymap,
707 trace indirect definitions to get the actual definition of that slot.
708 An indirect definition is a list of the form
709 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
710 and INDEX is the object to look up in KEYMAP to yield the definition.
712 Also if OBJECT has a menu string as the first element,
713 remove that. Also remove a menu help string as second element.
715 If AUTOLOAD is nonzero, load autoloadable keymaps
716 that are referred to with indirection.
718 This can GC because menu_item_eval_property calls Feval. */
721 get_keyelt (Lisp_Object object
, int autoload
)
725 if (!(CONSP (object
)))
726 /* This is really the value. */
729 /* If the keymap contents looks like (keymap ...) or (lambda ...)
731 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
734 /* If the keymap contents looks like (menu-item name . DEFN)
735 or (menu-item name DEFN ...) then use DEFN.
736 This is a new format menu item. */
737 else if (EQ (XCAR (object
), Qmenu_item
))
739 if (CONSP (XCDR (object
)))
743 object
= XCDR (XCDR (object
));
746 object
= XCAR (object
);
748 /* If there's a `:filter FILTER', apply FILTER to the
749 menu-item's definition to get the real definition to
751 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
752 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
755 filter
= XCAR (XCDR (tem
));
756 filter
= list2 (filter
, list2 (Qquote
, object
));
757 object
= menu_item_eval_property (filter
);
762 /* Invalid keymap. */
766 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
767 Keymap alist elements like (CHAR MENUSTRING . DEFN)
768 will be used by HierarKey menus. */
769 else if (STRINGP (XCAR (object
)))
771 object
= XCDR (object
);
772 /* Also remove a menu help string, if any,
773 following the menu item name. */
774 if (CONSP (object
) && STRINGP (XCAR (object
)))
775 object
= XCDR (object
);
776 /* Also remove the sublist that caches key equivalences, if any. */
777 if (CONSP (object
) && CONSP (XCAR (object
)))
780 carcar
= XCAR (XCAR (object
));
781 if (NILP (carcar
) || VECTORP (carcar
))
782 object
= XCDR (object
);
786 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
787 else if (KEYMAPP (XCAR (object
)))
788 error ("Wow, indirect keymap entry!!");
795 store_in_keymap (Lisp_Object keymap
, register Lisp_Object idx
, Lisp_Object def
)
797 /* Flush any reverse-map cache. */
798 where_is_cache
= Qnil
;
799 where_is_cache_keymaps
= Qt
;
801 if (EQ (idx
, Qkeymap
))
802 error ("`keymap' is reserved for embedded parent maps");
804 /* If we are preparing to dump, and DEF is a menu element
805 with a menu item indicator, copy it to ensure it is not pure. */
806 if (CONSP (def
) && PURE_P (def
)
807 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
808 def
= Fcons (XCAR (def
), XCDR (def
));
810 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
811 error ("attempt to define a key in a non-keymap");
813 /* If idx is a cons, and the car part is a character, idx must be of
814 the form (FROM-CHAR . TO-CHAR). */
815 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
816 CHECK_CHARACTER_CDR (idx
);
818 /* If idx is a list (some sort of mouse click, perhaps?),
819 the index we want to use is the car of the list, which
820 ought to be a symbol. */
821 idx
= EVENT_HEAD (idx
);
823 /* If idx is a symbol, it might have modifiers, which need to
824 be put in the canonical order. */
826 idx
= reorder_modifiers (idx
);
827 else if (INTEGERP (idx
))
828 /* Clobber the high bits that can be present on a machine
829 with more than 24 bits of integer. */
830 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
832 /* Scan the keymap for a binding of idx. */
836 /* The cons after which we should insert new bindings. If the
837 keymap has a table element, we record its position here, so new
838 bindings will go after it; this way, the table will stay
839 towards the front of the alist and character lookups in dense
840 keymaps will remain fast. Otherwise, this just points at the
841 front of the keymap. */
842 Lisp_Object insertion_point
;
844 insertion_point
= keymap
;
845 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
852 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
855 ASET (elt
, XFASTINT (idx
), def
);
858 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
860 int from
= XFASTINT (XCAR (idx
));
861 int to
= XFASTINT (XCDR (idx
));
863 if (to
>= ASIZE (elt
))
864 to
= ASIZE (elt
) - 1;
865 for (; from
<= to
; from
++)
866 ASET (elt
, from
, def
);
867 if (to
== XFASTINT (XCDR (idx
)))
868 /* We have defined all keys in IDX. */
871 insertion_point
= tail
;
873 else if (CHAR_TABLE_P (elt
))
875 /* Character codes with modifiers
876 are not included in a char-table.
877 All character codes without modifiers are included. */
878 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
881 /* `nil' has a special meaning for char-tables, so
882 we use something else to record an explicitly
884 NILP (def
) ? Qt
: def
);
887 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
889 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
892 insertion_point
= tail
;
894 else if (CONSP (elt
))
896 if (EQ (Qkeymap
, XCAR (elt
)))
897 { /* A sub keymap. This might be due to a lookup that found
898 two matching bindings (maybe because of a sub keymap).
899 It almost never happens (since the second binding normally
900 only happens in the inherited part of the keymap), but
901 if it does, we want to update the sub-keymap since the
902 main one might be temporary (built by access_keymap). */
903 tail
= insertion_point
= elt
;
905 else if (EQ (idx
, XCAR (elt
)))
911 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
913 int from
= XFASTINT (XCAR (idx
));
914 int to
= XFASTINT (XCDR (idx
));
916 if (from
<= XFASTINT (XCAR (elt
))
917 && to
>= XFASTINT (XCAR (elt
)))
925 else if (EQ (elt
, Qkeymap
))
926 /* If we find a 'keymap' symbol in the spine of KEYMAP,
927 then we must have found the start of a second keymap
928 being used as the tail of KEYMAP, and a binding for IDX
929 should be inserted before it. */
936 /* We have scanned the entire keymap, and not found a binding for
937 IDX. Let's add one. */
941 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
943 /* IDX specifies a range of characters, and not all of them
944 were handled yet, which means this keymap doesn't have a
945 char-table. So, we insert a char-table now. */
946 elt
= Fmake_char_table (Qkeymap
, Qnil
);
947 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
950 elt
= Fcons (idx
, def
);
951 CHECK_IMPURE (insertion_point
);
952 XSETCDR (insertion_point
, Fcons (elt
, XCDR (insertion_point
)));
959 static Lisp_Object
Fcopy_keymap (Lisp_Object
);
962 copy_keymap_item (Lisp_Object elt
)
964 Lisp_Object res
, tem
;
971 /* Is this a new format menu item. */
972 if (EQ (XCAR (tem
), Qmenu_item
))
974 /* Copy cell with menu-item marker. */
975 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
979 /* Copy cell with menu-item name. */
980 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
986 /* Copy cell with binding and if the binding is a keymap,
988 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
991 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
992 XSETCAR (elt
, Fcopy_keymap (tem
));
994 if (CONSP (tem
) && CONSP (XCAR (tem
)))
995 /* Delete cache for key equivalences. */
996 XSETCDR (elt
, XCDR (tem
));
1001 /* It may be an old fomat menu item.
1002 Skip the optional menu string. */
1003 if (STRINGP (XCAR (tem
)))
1005 /* Copy the cell, since copy-alist didn't go this deep. */
1006 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1008 /* Also skip the optional menu help string. */
1009 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1011 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1015 /* There may also be a list that caches key equivalences.
1016 Just delete it for the new keymap. */
1018 && CONSP (XCAR (tem
))
1019 && (NILP (XCAR (XCAR (tem
)))
1020 || VECTORP (XCAR (XCAR (tem
)))))
1022 XSETCDR (elt
, XCDR (tem
));
1025 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1026 XSETCDR (elt
, Fcopy_keymap (tem
));
1028 else if (EQ (XCAR (tem
), Qkeymap
))
1029 res
= Fcopy_keymap (elt
);
1035 copy_keymap_1 (Lisp_Object chartable
, Lisp_Object idx
, Lisp_Object elt
)
1037 Fset_char_table_range (chartable
, idx
, copy_keymap_item (elt
));
1040 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1041 doc
: /* Return a copy of the keymap KEYMAP.
1042 The copy starts out with the same definitions of KEYMAP,
1043 but changing either the copy or KEYMAP does not affect the other.
1044 Any key definitions that are subkeymaps are recursively copied.
1045 However, a key definition which is a symbol whose definition is a keymap
1047 (Lisp_Object keymap
)
1049 register Lisp_Object copy
, tail
;
1050 keymap
= get_keymap (keymap
, 1, 0);
1051 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1052 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1054 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1056 Lisp_Object elt
= XCAR (keymap
);
1057 if (CHAR_TABLE_P (elt
))
1059 elt
= Fcopy_sequence (elt
);
1060 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
);
1062 else if (VECTORP (elt
))
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
))
1071 if (EQ (XCAR (elt
), Qkeymap
))
1072 /* This is a sub keymap. */
1073 elt
= Fcopy_keymap (elt
);
1075 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1077 XSETCDR (tail
, Fcons (elt
, Qnil
));
1079 keymap
= XCDR (keymap
);
1081 XSETCDR (tail
, keymap
);
1085 /* Simple Keymap mutators and accessors. */
1087 /* GC is possible in this function if it autoloads a keymap. */
1089 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1090 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1093 KEY is a string or a vector of symbols and characters, representing a
1094 sequence of keystrokes and events. Non-ASCII characters with codes
1095 above 127 (such as ISO Latin-1) can be represented by vectors.
1096 Two types of vector have special meanings:
1097 [remap COMMAND] remaps any key binding for COMMAND.
1098 [t] creates a default definition, which applies to any event with no
1099 other definition in KEYMAP.
1101 DEF is anything that can be a key's definition:
1102 nil (means key is undefined in this keymap),
1103 a command (a Lisp function suitable for interactive calling),
1104 a string (treated as a keyboard macro),
1105 a keymap (to define a prefix key),
1106 a symbol (when the key is looked up, the symbol will stand for its
1107 function definition, which should at that time be one of the above,
1108 or another symbol whose function definition is used, etc.),
1109 a cons (STRING . DEFN), meaning that DEFN is the definition
1110 (DEFN should be a valid definition in its own right),
1111 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP,
1112 or an extended menu item definition.
1113 (See info node `(elisp)Extended Menu Items'.)
1115 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1116 binding is altered. If there is no binding for KEY, the new pair
1117 binding KEY to DEF is added at the front of KEYMAP. */)
1118 (Lisp_Object keymap
, Lisp_Object key
, Lisp_Object def
)
1120 register ptrdiff_t idx
;
1121 register Lisp_Object c
;
1122 register Lisp_Object cmd
;
1126 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1128 GCPRO3 (keymap
, key
, def
);
1129 keymap
= get_keymap (keymap
, 1, 1);
1131 CHECK_VECTOR_OR_STRING (key
);
1133 length
= XFASTINT (Flength (key
));
1135 RETURN_UNGCPRO (Qnil
);
1137 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1138 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1140 meta_bit
= (VECTORP (key
) || (STRINGP (key
) && STRING_MULTIBYTE (key
))
1141 ? meta_modifier
: 0x80);
1143 if (VECTORP (def
) && ASIZE (def
) > 0 && CONSP (AREF (def
, 0)))
1144 { /* DEF is apparently an XEmacs-style keyboard macro. */
1145 Lisp_Object tmp
= Fmake_vector (make_number (ASIZE (def
)), Qnil
);
1146 int i
= ASIZE (def
);
1149 Lisp_Object defi
= AREF (def
, i
);
1150 if (CONSP (defi
) && lucid_event_type_list_p (defi
))
1151 defi
= Fevent_convert_list (defi
);
1152 ASET (tmp
, i
, defi
);
1160 c
= Faref (key
, make_number (idx
));
1164 /* C may be a Lucid style event type list or a cons (FROM .
1165 TO) specifying a range of characters. */
1166 if (lucid_event_type_list_p (c
))
1167 c
= Fevent_convert_list (c
);
1168 else if (CHARACTERP (XCAR (c
)))
1169 CHECK_CHARACTER_CDR (c
);
1173 silly_event_symbol_error (c
);
1176 && (XINT (c
) & meta_bit
)
1179 c
= meta_prefix_char
;
1185 XSETINT (c
, XINT (c
) & ~meta_bit
);
1191 if (!INTEGERP (c
) && !SYMBOLP (c
)
1193 /* If C is a range, it must be a leaf. */
1194 || (INTEGERP (XCAR (c
)) && idx
!= length
)))
1195 message_with_string ("Key sequence contains invalid event %s", c
, 1);
1198 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1200 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1202 /* If this key is undefined, make it a prefix. */
1204 cmd
= define_as_prefix (keymap
, c
);
1206 keymap
= get_keymap (cmd
, 0, 1);
1207 if (!CONSP (keymap
))
1209 const char *trailing_esc
= ((EQ (c
, meta_prefix_char
) && metized
)
1210 ? (idx
== 0 ? "ESC" : " ESC")
1213 /* We must use Fkey_description rather than just passing key to
1214 error; key might be a vector, not a string. */
1215 error ("Key sequence %s starts with non-prefix key %s%s",
1216 SDATA (Fkey_description (key
, Qnil
)),
1217 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1225 /* This function may GC (it calls Fkey_binding). */
1227 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 3, 0,
1228 doc
: /* Return the remapping for command COMMAND.
1229 Returns nil if COMMAND is not remapped (or not a symbol).
1231 If the optional argument POSITION is non-nil, it specifies a mouse
1232 position as returned by `event-start' and `event-end', and the
1233 remapping occurs in the keymaps associated with it. It can also be a
1234 number or marker, in which case the keymap properties at the specified
1235 buffer position instead of point are used. The KEYMAPS argument is
1236 ignored if POSITION is non-nil.
1238 If the optional argument KEYMAPS is non-nil, it should be a list of
1239 keymaps to search for command remapping. Otherwise, search for the
1240 remapping in all currently active keymaps. */)
1241 (Lisp_Object command
, Lisp_Object position
, Lisp_Object keymaps
)
1243 if (!SYMBOLP (command
))
1246 ASET (command_remapping_vector
, 1, command
);
1249 command
= Fkey_binding (command_remapping_vector
, Qnil
, Qt
, position
);
1251 command
= Flookup_key (Fcons (Qkeymap
, keymaps
),
1252 command_remapping_vector
, Qnil
);
1253 return INTEGERP (command
) ? Qnil
: command
;
1256 /* Value is number if KEY is too long; nil if valid but has no definition. */
1257 /* GC is possible in this function. */
1259 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1260 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1261 A value of nil means undefined. See doc of `define-key'
1262 for kinds of definitions.
1264 A number as value means KEY is "too long";
1265 that is, characters or symbols in it except for the last one
1266 fail to be a valid sequence of prefix characters in KEYMAP.
1267 The number is how many characters at the front of KEY
1268 it takes to reach a non-prefix key.
1270 Normally, `lookup-key' ignores bindings for t, which act as default
1271 bindings, used when nothing else in the keymap applies; this makes it
1272 usable as a general function for probing keymaps. However, if the
1273 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1274 recognize the default bindings, just as `read-key-sequence' does. */)
1275 (Lisp_Object keymap
, Lisp_Object key
, Lisp_Object accept_default
)
1277 register ptrdiff_t idx
;
1278 register Lisp_Object cmd
;
1279 register Lisp_Object c
;
1281 int t_ok
= !NILP (accept_default
);
1282 struct gcpro gcpro1
, gcpro2
;
1284 GCPRO2 (keymap
, key
);
1285 keymap
= get_keymap (keymap
, 1, 1);
1287 CHECK_VECTOR_OR_STRING (key
);
1289 length
= XFASTINT (Flength (key
));
1291 RETURN_UNGCPRO (keymap
);
1296 c
= Faref (key
, make_number (idx
++));
1298 if (CONSP (c
) && lucid_event_type_list_p (c
))
1299 c
= Fevent_convert_list (c
);
1301 /* Turn the 8th bit of string chars into a meta modifier. */
1302 if (STRINGP (key
) && XINT (c
) & 0x80 && !STRING_MULTIBYTE (key
))
1303 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1305 /* Allow string since binding for `menu-bar-select-buffer'
1306 includes the buffer name in the key sequence. */
1307 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1308 message_with_string ("Key sequence contains invalid event %s", c
, 1);
1310 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1312 RETURN_UNGCPRO (cmd
);
1314 keymap
= get_keymap (cmd
, 0, 1);
1315 if (!CONSP (keymap
))
1316 RETURN_UNGCPRO (make_number (idx
));
1322 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1323 Assume that currently it does not define C at all.
1324 Return the keymap. */
1327 define_as_prefix (Lisp_Object keymap
, Lisp_Object c
)
1331 cmd
= Fmake_sparse_keymap (Qnil
);
1332 store_in_keymap (keymap
, c
, cmd
);
1337 /* Append a key to the end of a key sequence. We always make a vector. */
1340 append_key (Lisp_Object key_sequence
, Lisp_Object key
)
1342 Lisp_Object args
[2];
1344 args
[0] = key_sequence
;
1346 args
[1] = Fcons (key
, Qnil
);
1347 return Fvconcat (2, args
);
1350 /* Given a event type C which is a symbol,
1351 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1354 silly_event_symbol_error (Lisp_Object c
)
1356 Lisp_Object parsed
, base
, name
, assoc
;
1359 parsed
= parse_modifiers (c
);
1360 modifiers
= XFASTINT (XCAR (XCDR (parsed
)));
1361 base
= XCAR (parsed
);
1362 name
= Fsymbol_name (base
);
1363 /* This alist includes elements such as ("RET" . "\\r"). */
1364 assoc
= Fassoc (name
, exclude_keys
);
1368 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1370 Lisp_Object keystring
;
1371 if (modifiers
& alt_modifier
)
1372 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1373 if (modifiers
& ctrl_modifier
)
1374 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1375 if (modifiers
& hyper_modifier
)
1376 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1377 if (modifiers
& meta_modifier
)
1378 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1379 if (modifiers
& shift_modifier
)
1380 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1381 if (modifiers
& super_modifier
)
1382 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1385 c
= reorder_modifiers (c
);
1386 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1388 error ((modifiers
& ~meta_modifier
1389 ? "To bind the key %s, use [?%s], not [%s]"
1390 : "To bind the key %s, use \"%s\", not [%s]"),
1391 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1392 SDATA (SYMBOL_NAME (c
)));
1396 /* Global, local, and minor mode keymap stuff. */
1398 /* We can't put these variables inside current_minor_maps, since under
1399 some systems, static gets macro-defined to be the empty string.
1401 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1402 static ptrdiff_t cmm_size
= 0;
1404 /* Store a pointer to an array of the currently active minor modes in
1405 *modeptr, a pointer to an array of the keymaps of the currently
1406 active minor modes in *mapptr, and return the number of maps
1409 This function always returns a pointer to the same buffer, and may
1410 free or reallocate it, so if you want to keep it for a long time or
1411 hand it out to lisp code, copy it. This procedure will be called
1412 for every key sequence read, so the nice lispy approach (return a
1413 new assoclist, list, what have you) for each invocation would
1414 result in a lot of consing over time.
1416 If we used xrealloc/xmalloc and ran out of memory, they would throw
1417 back to the command loop, which would try to read a key sequence,
1418 which would call this function again, resulting in an infinite
1419 loop. Instead, we'll use realloc/malloc and silently truncate the
1420 list, let the key sequence be read, and hope some other piece of
1421 code signals the error. */
1423 current_minor_maps (Lisp_Object
**modeptr
, Lisp_Object
**mapptr
)
1426 int list_number
= 0;
1427 Lisp_Object alist
, assoc
, var
, val
;
1428 Lisp_Object emulation_alists
;
1429 Lisp_Object lists
[2];
1431 emulation_alists
= Vemulation_mode_map_alists
;
1432 lists
[0] = Vminor_mode_overriding_map_alist
;
1433 lists
[1] = Vminor_mode_map_alist
;
1435 for (list_number
= 0; list_number
< 2; list_number
++)
1437 if (CONSP (emulation_alists
))
1439 alist
= XCAR (emulation_alists
);
1440 emulation_alists
= XCDR (emulation_alists
);
1441 if (SYMBOLP (alist
))
1442 alist
= find_symbol_value (alist
);
1446 alist
= lists
[list_number
];
1448 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1449 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1450 && (var
= XCAR (assoc
), SYMBOLP (var
))
1451 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1456 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1457 and also an entry in Vminor_mode_map_alist,
1458 ignore the latter. */
1459 if (list_number
== 1)
1461 val
= assq_no_quit (var
, lists
[0]);
1468 ptrdiff_t newsize
, allocsize
;
1469 Lisp_Object
*newmodes
, *newmaps
;
1471 /* Check for size calculation overflow. Other code
1472 (e.g., read_key_sequence) adds 3 to the count
1473 later, so subtract 3 from the limit here. */
1474 if (min (PTRDIFF_MAX
, SIZE_MAX
) / (2 * sizeof *newmodes
) - 3
1478 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1479 allocsize
= newsize
* sizeof *newmodes
;
1481 /* Use malloc here. See the comment above this function.
1482 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1484 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1489 memcpy (newmodes
, cmm_modes
,
1490 cmm_size
* sizeof cmm_modes
[0]);
1493 cmm_modes
= newmodes
;
1496 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1501 memcpy (newmaps
, cmm_maps
,
1502 cmm_size
* sizeof cmm_maps
[0]);
1509 if (newmodes
== NULL
|| newmaps
== NULL
)
1514 /* Get the keymap definition--or nil if it is not defined. */
1515 temp
= Findirect_function (XCDR (assoc
), Qt
);
1519 cmm_maps
[i
] = temp
;
1525 if (modeptr
) *modeptr
= cmm_modes
;
1526 if (mapptr
) *mapptr
= cmm_maps
;
1530 /* Return the offset of POSITION, a click position, in the style of
1531 the respective argument of Fkey_binding. */
1533 click_position (Lisp_Object position
)
1535 EMACS_INT pos
= (INTEGERP (position
) ? XINT (position
)
1536 : MARKERP (position
) ? marker_position (position
)
1538 if (! (BEGV
<= pos
&& pos
<= ZV
))
1539 args_out_of_range (Fcurrent_buffer (), position
);
1543 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1545 doc
: /* Return a list of the currently active keymaps.
1546 OLP if non-nil indicates that we should obey `overriding-local-map' and
1547 `overriding-terminal-local-map'. POSITION can specify a click position
1548 like in the respective argument of `key-binding'. */)
1549 (Lisp_Object olp
, Lisp_Object position
)
1551 ptrdiff_t count
= SPECPDL_INDEX ();
1553 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1555 /* If a mouse click position is given, our variables are based on
1556 the buffer clicked on, not the current buffer. So we may have to
1557 switch the buffer here. */
1559 if (CONSP (position
))
1563 window
= POSN_WINDOW (position
);
1565 if (WINDOWP (window
)
1566 && BUFFERP (XWINDOW (window
)->buffer
)
1567 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
1569 /* Arrange to go back to the original buffer once we're done
1570 processing the key sequence. We don't use
1571 save_excursion_{save,restore} here, in analogy to
1572 `read-key-sequence' to avoid saving point. Maybe this
1573 would not be a problem here, but it is easier to keep
1577 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
1579 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
1585 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
1586 keymaps
= Fcons (KVAR (current_kboard
, Voverriding_terminal_local_map
),
1588 /* The doc said that overriding-terminal-local-map should
1589 override overriding-local-map. The code used them both,
1590 but it seems clearer to use just one. rms, jan 2005. */
1591 else if (!NILP (Voverriding_local_map
))
1592 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1594 if (NILP (XCDR (keymaps
)))
1598 ptrdiff_t pt
= click_position (position
);
1599 /* This usually returns the buffer's local map,
1600 but that can be overridden by a `local-map' property. */
1601 Lisp_Object local_map
= get_local_map (pt
, current_buffer
, Qlocal_map
);
1602 /* This returns nil unless there is a `keymap' property. */
1603 Lisp_Object keymap
= get_local_map (pt
, current_buffer
, Qkeymap
);
1605 if (CONSP (position
))
1607 Lisp_Object string
= POSN_STRING (position
);
1609 /* For a mouse click, get the local text-property keymap
1610 of the place clicked on, rather than point. */
1612 if (POSN_INBUFFER_P (position
))
1616 pos
= POSN_BUFFER_POSN (position
);
1618 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
1620 local_map
= get_local_map (XINT (pos
),
1621 current_buffer
, Qlocal_map
);
1623 keymap
= get_local_map (XINT (pos
),
1624 current_buffer
, Qkeymap
);
1628 /* If on a mode line string with a local keymap,
1629 or for a click on a string, i.e. overlay string or a
1630 string displayed via the `display' property,
1631 consider `local-map' and `keymap' properties of
1634 if (CONSP (string
) && STRINGP (XCAR (string
)))
1636 Lisp_Object pos
, map
;
1638 pos
= XCDR (string
);
1639 string
= XCAR (string
);
1642 && XINT (pos
) < SCHARS (string
))
1644 map
= Fget_text_property (pos
, Qlocal_map
, string
);
1648 map
= Fget_text_property (pos
, Qkeymap
, string
);
1656 if (!NILP (local_map
))
1657 keymaps
= Fcons (local_map
, keymaps
);
1659 /* Now put all the minor mode keymaps on the list. */
1660 nmaps
= current_minor_maps (0, &maps
);
1662 for (i
= --nmaps
; i
>= 0; i
--)
1663 if (!NILP (maps
[i
]))
1664 keymaps
= Fcons (maps
[i
], keymaps
);
1667 keymaps
= Fcons (keymap
, keymaps
);
1670 unbind_to (count
, Qnil
);
1675 /* GC is possible in this function if it autoloads a keymap. */
1677 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 4, 0,
1678 doc
: /* Return the binding for command KEY in current keymaps.
1679 KEY is a string or vector, a sequence of keystrokes.
1680 The binding is probably a symbol with a function definition.
1682 Normally, `key-binding' ignores bindings for t, which act as default
1683 bindings, used when nothing else in the keymap applies; this makes it
1684 usable as a general function for probing keymaps. However, if the
1685 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1686 recognize the default bindings, just as `read-key-sequence' does.
1688 Like the normal command loop, `key-binding' will remap the command
1689 resulting from looking up KEY by looking up the command in the
1690 current keymaps. However, if the optional third argument NO-REMAP
1691 is non-nil, `key-binding' returns the unmapped command.
1693 If KEY is a key sequence initiated with the mouse, the used keymaps
1694 will depend on the clicked mouse position with regard to the buffer
1695 and possible local keymaps on strings.
1697 If the optional argument POSITION is non-nil, it specifies a mouse
1698 position as returned by `event-start' and `event-end', and the lookup
1699 occurs in the keymaps associated with it instead of KEY. It can also
1700 be a number or marker, in which case the keymap properties at the
1701 specified buffer position instead of point are used.
1703 (Lisp_Object key
, Lisp_Object accept_default
, Lisp_Object no_remap
, Lisp_Object position
)
1707 if (NILP (position
) && VECTORP (key
))
1710 /* mouse events may have a symbolic prefix indicating the
1711 scrollbar or mode line */
1712 = AREF (key
, SYMBOLP (AREF (key
, 0)) && ASIZE (key
) > 1 ? 1 : 0);
1714 /* We are not interested in locations without event data */
1716 if (EVENT_HAS_PARAMETERS (event
) && CONSP (XCDR (event
)))
1718 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (event
));
1719 if (EQ (kind
, Qmouse_click
))
1720 position
= EVENT_START (event
);
1724 value
= Flookup_key (Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
)),
1725 key
, accept_default
);
1727 if (NILP (value
) || INTEGERP (value
))
1730 /* If the result of the ordinary keymap lookup is an interactive
1731 command, look for a key binding (ie. remapping) for that command. */
1733 if (NILP (no_remap
) && SYMBOLP (value
))
1736 if (value1
= Fcommand_remapping (value
, position
, Qnil
), !NILP (value1
))
1743 /* GC is possible in this function if it autoloads a keymap. */
1745 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1746 doc
: /* Return the binding for command KEYS in current local keymap only.
1747 KEYS is a string or vector, a sequence of keystrokes.
1748 The binding is probably a symbol with a function definition.
1750 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1751 bindings; see the description of `lookup-key' for more details about this. */)
1752 (Lisp_Object keys
, Lisp_Object accept_default
)
1754 register Lisp_Object map
;
1755 map
= BVAR (current_buffer
, keymap
);
1758 return Flookup_key (map
, keys
, accept_default
);
1761 /* GC is possible in this function if it autoloads a keymap. */
1763 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1764 doc
: /* Return the binding for command KEYS in current global keymap only.
1765 KEYS is a string or vector, a sequence of keystrokes.
1766 The binding is probably a symbol with a function definition.
1767 This function's return values are the same as those of `lookup-key'
1770 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1771 bindings; see the description of `lookup-key' for more details about this. */)
1772 (Lisp_Object keys
, Lisp_Object accept_default
)
1774 return Flookup_key (current_global_map
, keys
, accept_default
);
1777 /* GC is possible in this function if it autoloads a keymap. */
1779 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1780 doc
: /* Find the visible minor mode bindings of KEY.
1781 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1782 the symbol which names the minor mode binding KEY, and BINDING is
1783 KEY's definition in that mode. In particular, if KEY has no
1784 minor-mode bindings, return nil. If the first binding is a
1785 non-prefix, all subsequent bindings will be omitted, since they would
1786 be ignored. Similarly, the list doesn't include non-prefix bindings
1787 that come after prefix bindings.
1789 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1790 bindings; see the description of `lookup-key' for more details about this. */)
1791 (Lisp_Object key
, Lisp_Object accept_default
)
1793 Lisp_Object
*modes
, *maps
;
1795 Lisp_Object binding
;
1797 struct gcpro gcpro1
, gcpro2
;
1799 nmaps
= current_minor_maps (&modes
, &maps
);
1800 /* Note that all these maps are GCPRO'd
1801 in the places where we found them. */
1804 GCPRO2 (key
, binding
);
1806 for (i
= j
= 0; i
< nmaps
; i
++)
1808 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1809 && !INTEGERP (binding
))
1811 if (KEYMAPP (binding
))
1812 maps
[j
++] = Fcons (modes
[i
], binding
);
1814 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1818 return Flist (j
, maps
);
1821 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1822 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1823 A new sparse keymap is stored as COMMAND's function definition and its value.
1824 If a second optional argument MAPVAR is given, the map is stored as
1825 its value instead of as COMMAND's value; but COMMAND is still defined
1827 The third optional argument NAME, if given, supplies a menu name
1828 string for the map. This is required to use the keymap as a menu.
1829 This function returns COMMAND. */)
1830 (Lisp_Object command
, Lisp_Object mapvar
, Lisp_Object name
)
1833 map
= Fmake_sparse_keymap (name
);
1834 Ffset (command
, map
);
1838 Fset (command
, map
);
1842 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1843 doc
: /* Select KEYMAP as the global keymap. */)
1844 (Lisp_Object keymap
)
1846 keymap
= get_keymap (keymap
, 1, 1);
1847 current_global_map
= keymap
;
1852 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1853 doc
: /* Select KEYMAP as the local keymap.
1854 If KEYMAP is nil, that means no local keymap. */)
1855 (Lisp_Object keymap
)
1858 keymap
= get_keymap (keymap
, 1, 1);
1860 BVAR (current_buffer
, keymap
) = keymap
;
1865 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1866 doc
: /* Return current buffer's local keymap, or nil if it has none.
1867 Normally the local keymap is set by the major mode with `use-local-map'. */)
1870 return BVAR (current_buffer
, keymap
);
1873 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1874 doc
: /* Return the current global keymap. */)
1877 return current_global_map
;
1880 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1881 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1885 int nmaps
= current_minor_maps (0, &maps
);
1887 return Flist (nmaps
, maps
);
1890 /* Help functions for describing and documenting keymaps. */
1892 struct accessible_keymaps_data
{
1893 Lisp_Object maps
, tail
, thisseq
;
1894 /* Does the current sequence end in the meta-prefix-char? */
1899 accessible_keymaps_1 (Lisp_Object key
, Lisp_Object cmd
, Lisp_Object args
, void *data
)
1900 /* Use void* data to be compatible with map_keymap_function_t. */
1902 struct accessible_keymaps_data
*d
= data
; /* Cast! */
1903 Lisp_Object maps
= d
->maps
;
1904 Lisp_Object tail
= d
->tail
;
1905 Lisp_Object thisseq
= d
->thisseq
;
1906 int is_metized
= d
->is_metized
&& INTEGERP (key
);
1909 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1913 /* Look for and break cycles. */
1914 while (!NILP (tem
= Frassq (cmd
, maps
)))
1916 Lisp_Object prefix
= XCAR (tem
);
1917 ptrdiff_t lim
= XINT (Flength (XCAR (tem
)));
1918 if (lim
<= XINT (Flength (thisseq
)))
1919 { /* This keymap was already seen with a smaller prefix. */
1921 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1922 Faref (thisseq
, make_number (i
))))
1925 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1928 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1929 but maybe `cmd' occurs again further down in `maps', so keep
1931 maps
= XCDR (Fmemq (tem
, maps
));
1934 /* If the last key in thisseq is meta-prefix-char,
1935 turn it into a meta-ized keystroke. We know
1936 that the event we're about to append is an
1937 ascii keystroke since we're processing a
1941 int meta_bit
= meta_modifier
;
1942 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1943 tem
= Fcopy_sequence (thisseq
);
1945 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1947 /* This new sequence is the same length as
1948 thisseq, so stick it in the list right
1951 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1955 tem
= append_key (thisseq
, key
);
1956 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1960 /* This function cannot GC. */
1962 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1964 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1965 Returns a list of elements of the form (KEYS . MAP), where the sequence
1966 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1967 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1968 An optional argument PREFIX, if non-nil, should be a key sequence;
1969 then the value includes only maps for prefixes that start with PREFIX. */)
1970 (Lisp_Object keymap
, Lisp_Object prefix
)
1972 Lisp_Object maps
, tail
;
1973 EMACS_INT prefixlen
= XFASTINT (Flength (prefix
));
1975 /* no need for gcpro because we don't autoload any keymaps. */
1979 /* If a prefix was specified, start with the keymap (if any) for
1980 that prefix, so we don't waste time considering other prefixes. */
1982 tem
= Flookup_key (keymap
, prefix
, Qt
);
1983 /* Flookup_key may give us nil, or a number,
1984 if the prefix is not defined in this particular map.
1985 It might even give us a list that isn't a keymap. */
1986 tem
= get_keymap (tem
, 0, 0);
1987 /* If the keymap is autoloaded `tem' is not a cons-cell, but we still
1988 want to return it. */
1991 /* Convert PREFIX to a vector now, so that later on
1992 we don't have to deal with the possibility of a string. */
1993 if (STRINGP (prefix
))
1998 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1999 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
2003 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
2004 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2005 c
^= 0200 | meta_modifier
;
2006 ASET (copy
, i_before
, make_number (c
));
2010 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
2016 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
2017 get_keymap (keymap
, 1, 0)),
2020 /* For each map in the list maps,
2021 look at any other maps it points to,
2022 and stick them at the end if they are not already in the list.
2024 This is a breadth-first traversal, where tail is the queue of
2025 nodes, and maps accumulates a list of all nodes visited. */
2027 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
2029 struct accessible_keymaps_data data
;
2030 register Lisp_Object thismap
= Fcdr (XCAR (tail
));
2033 data
.thisseq
= Fcar (XCAR (tail
));
2036 last
= make_number (XINT (Flength (data
.thisseq
)) - 1);
2037 /* Does the current sequence end in the meta-prefix-char? */
2038 data
.is_metized
= (XINT (last
) >= 0
2039 /* Don't metize the last char of PREFIX. */
2040 && XINT (last
) >= prefixlen
2041 && EQ (Faref (data
.thisseq
, last
), meta_prefix_char
));
2043 /* Since we can't run lisp code, we can't scan autoloaded maps. */
2044 if (CONSP (thismap
))
2045 map_keymap (thismap
, accessible_keymaps_1
, Qnil
, &data
, 0);
2049 static Lisp_Object Qsingle_key_description
, Qkey_description
;
2051 /* This function cannot GC. */
2053 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2054 doc
: /* Return a pretty description of key-sequence KEYS.
2055 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2056 Control characters turn into "C-foo" sequences, meta into "M-foo",
2057 spaces are put between sequence elements, etc. */)
2058 (Lisp_Object keys
, Lisp_Object prefix
)
2064 EMACS_INT size
= XINT (Flength (keys
));
2066 Lisp_Object sep
= build_string (" ");
2073 size
+= XINT (Flength (prefix
));
2075 /* This has one extra element at the end that we don't pass to Fconcat. */
2076 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (Lisp_Object
) / 4 < size
)
2077 memory_full (SIZE_MAX
);
2078 SAFE_ALLOCA_LISP (args
, size
* 4);
2080 /* In effect, this computes
2081 (mapconcat 'single-key-description keys " ")
2082 but we shouldn't use mapconcat because it can do GC. */
2086 list
= prefix
, prefix
= Qnil
;
2087 else if (!NILP (keys
))
2088 list
= keys
, keys
= Qnil
;
2093 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2096 result
= len
== 0 ? empty_unibyte_string
: Fconcat (len
- 1, args
);
2102 size
= SCHARS (list
);
2103 else if (VECTORP (list
))
2104 size
= ASIZE (list
);
2105 else if (CONSP (list
))
2106 size
= XINT (Flength (list
));
2108 wrong_type_argument (Qarrayp
, list
);
2117 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2118 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2119 c
^= 0200 | meta_modifier
;
2120 XSETFASTINT (key
, c
);
2122 else if (VECTORP (list
))
2124 key
= AREF (list
, i
); i
++;
2136 || EQ (key
, meta_prefix_char
)
2137 || (XINT (key
) & meta_modifier
))
2139 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2141 if (EQ (key
, meta_prefix_char
))
2145 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2148 else if (EQ (key
, meta_prefix_char
))
2153 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2161 push_key_description (EMACS_INT ch
, char *p
, int force_multibyte
)
2165 /* Clear all the meaningless bits above the meta bit. */
2166 c
= ch
& (meta_modifier
| ~ - meta_modifier
);
2167 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2168 | meta_modifier
| shift_modifier
| super_modifier
);
2170 if (! CHARACTERP (make_number (c2
)))
2172 /* KEY_DESCRIPTION_SIZE is large enough for this. */
2173 p
+= sprintf (p
, "[%d]", c
);
2177 if (c
& alt_modifier
)
2183 if ((c
& ctrl_modifier
) != 0
2184 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2188 c
&= ~ctrl_modifier
;
2190 if (c
& hyper_modifier
)
2194 c
-= hyper_modifier
;
2196 if (c
& meta_modifier
)
2202 if (c
& shift_modifier
)
2206 c
-= shift_modifier
;
2208 if (c
& super_modifier
)
2212 c
-= super_modifier
;
2228 else if (c
== Ctl ('M'))
2236 /* `C-' already added above. */
2237 if (c
> 0 && c
<= Ctl ('Z'))
2256 || (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
2257 && SINGLE_BYTE_CHAR_P (c
)
2258 && !force_multibyte
))
2264 /* Now we are sure that C is a valid character code. */
2265 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
2266 && ! force_multibyte
)
2267 *p
++ = multibyte_char_to_unibyte (c
);
2269 p
+= CHAR_STRING (c
, (unsigned char *) p
);
2275 /* This function cannot GC. */
2277 DEFUN ("single-key-description", Fsingle_key_description
,
2278 Ssingle_key_description
, 1, 2, 0,
2279 doc
: /* Return a pretty description of command character KEY.
2280 Control characters turn into C-whatever, etc.
2281 Optional argument NO-ANGLES non-nil means don't put angle brackets
2282 around function keys and event symbols. */)
2283 (Lisp_Object key
, Lisp_Object no_angles
)
2285 if (CONSP (key
) && lucid_event_type_list_p (key
))
2286 key
= Fevent_convert_list (key
);
2288 key
= EVENT_HEAD (key
);
2290 if (INTEGERP (key
)) /* Normal character */
2292 char tem
[KEY_DESCRIPTION_SIZE
];
2294 *push_key_description (XINT (key
), tem
, 1) = 0;
2295 return build_string (tem
);
2297 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2299 if (NILP (no_angles
))
2304 SAFE_ALLOCA (buffer
, char *,
2305 sizeof "<>" + SBYTES (SYMBOL_NAME (key
)));
2306 esprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2307 result
= build_string (buffer
);
2312 return Fsymbol_name (key
);
2314 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2315 return Fcopy_sequence (key
);
2317 error ("KEY must be an integer, cons, symbol, or string");
2322 push_text_char_description (register unsigned int c
, register char *p
)
2333 *p
++ = c
+ 64; /* 'A' - 1 */
2345 /* This function cannot GC. */
2347 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2348 doc
: /* Return a pretty description of file-character CHARACTER.
2349 Control characters turn into "^char", etc. This differs from
2350 `single-key-description' which turns them into "C-char".
2351 Also, this function recognizes the 2**7 bit as the Meta character,
2352 whereas `single-key-description' uses the 2**27 bit for Meta.
2353 See Info node `(elisp)Describing Characters' for examples. */)
2354 (Lisp_Object character
)
2356 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2360 CHECK_CHARACTER (character
);
2362 c
= XINT (character
);
2363 if (!ASCII_CHAR_P (c
))
2365 int len
= CHAR_STRING (c
, (unsigned char *) str
);
2367 return make_multibyte_string (str
, 1, len
);
2370 *push_text_char_description (c
& 0377, str
) = 0;
2372 return build_string (str
);
2375 static int where_is_preferred_modifier
;
2377 /* Return 0 if SEQ uses non-preferred modifiers or non-char events.
2378 Else, return 2 if SEQ uses the where_is_preferred_modifier,
2381 preferred_sequence_p (Lisp_Object seq
)
2384 EMACS_INT len
= XFASTINT (Flength (seq
));
2387 for (i
= 0; i
< len
; i
++)
2389 Lisp_Object ii
, elt
;
2391 XSETFASTINT (ii
, i
);
2392 elt
= Faref (seq
, ii
);
2394 if (!INTEGERP (elt
))
2398 int modifiers
= XINT (elt
) & (CHAR_MODIFIER_MASK
& ~CHAR_META
);
2399 if (modifiers
== where_is_preferred_modifier
)
2410 /* where-is - finding a command in a set of keymaps. */
2412 static void where_is_internal_1 (Lisp_Object key
, Lisp_Object binding
,
2413 Lisp_Object args
, void *data
);
2415 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2416 Returns the first non-nil binding found in any of those maps.
2417 If REMAP is true, pass the result of the lookup through command
2418 remapping before returning it. */
2421 shadow_lookup (Lisp_Object shadow
, Lisp_Object key
, Lisp_Object flag
,
2424 Lisp_Object tail
, value
;
2426 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2428 value
= Flookup_key (XCAR (tail
), key
, flag
);
2429 if (NATNUMP (value
))
2431 value
= Flookup_key (XCAR (tail
),
2432 Fsubstring (key
, make_number (0), value
), flag
);
2436 else if (!NILP (value
))
2438 Lisp_Object remapping
;
2439 if (remap
&& SYMBOLP (value
)
2440 && (remapping
= Fcommand_remapping (value
, Qnil
, shadow
),
2450 static Lisp_Object Vmouse_events
;
2452 struct where_is_internal_data
{
2453 Lisp_Object definition
, this, last
;
2454 int last_is_meta
, noindirect
;
2455 Lisp_Object sequences
;
2458 /* This function can't GC, AFAIK. */
2459 /* Return the list of bindings found. This list is ordered "longest
2460 to shortest". It may include bindings that are actually shadowed
2461 by others, as well as duplicate bindings and remapping bindings.
2462 The list returned is potentially shared with where_is_cache, so
2463 be careful not to modify it via side-effects. */
2466 where_is_internal (Lisp_Object definition
, Lisp_Object keymaps
,
2467 int noindirect
, int nomenus
)
2469 Lisp_Object maps
= Qnil
;
2471 struct where_is_internal_data data
;
2473 /* Only important use of caching is for the menubar
2474 (i.e. where-is-internal called with (def nil t nil nil)). */
2475 if (nomenus
&& !noindirect
)
2477 /* Check heuristic-consistency of the cache. */
2478 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2479 where_is_cache
= Qnil
;
2481 if (NILP (where_is_cache
))
2483 /* We need to create the cache. */
2484 Lisp_Object args
[2];
2485 where_is_cache
= Fmake_hash_table (0, args
);
2486 where_is_cache_keymaps
= Qt
;
2489 /* We can reuse the cache. */
2490 return Fgethash (definition
, where_is_cache
, Qnil
);
2493 /* Kill the cache so that where_is_internal_1 doesn't think
2494 we're filling it up. */
2495 where_is_cache
= Qnil
;
2498 while (CONSP (found
))
2502 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2503 found
= XCDR (found
);
2506 data
.sequences
= Qnil
;
2507 for (; CONSP (maps
); maps
= XCDR (maps
))
2509 /* Key sequence to reach map, and the map that it reaches */
2510 register Lisp_Object
this, map
, tem
;
2512 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2513 [M-CHAR] sequences, check if last character of the sequence
2514 is the meta-prefix char. */
2518 this = Fcar (XCAR (maps
));
2519 map
= Fcdr (XCAR (maps
));
2520 last
= make_number (XINT (Flength (this)) - 1);
2521 last_is_meta
= (XINT (last
) >= 0
2522 && EQ (Faref (this, last
), meta_prefix_char
));
2524 /* if (nomenus && !preferred_sequence_p (this)) */
2525 if (nomenus
&& XINT (last
) >= 0
2526 && SYMBOLP (tem
= Faref (this, make_number (0)))
2527 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2528 /* If no menu entries should be returned, skip over the
2529 keymaps bound to `menu-bar' and `tool-bar' and other
2530 non-ascii prefixes like `C-down-mouse-2'. */
2535 data
.definition
= definition
;
2536 data
.noindirect
= noindirect
;
2539 data
.last_is_meta
= last_is_meta
;
2542 map_keymap (map
, where_is_internal_1
, Qnil
, &data
, 0);
2545 if (nomenus
&& !noindirect
)
2546 { /* Remember for which keymaps this cache was built.
2547 We do it here (late) because we want to keep where_is_cache_keymaps
2548 set to t while the cache isn't fully filled. */
2549 where_is_cache_keymaps
= keymaps
;
2550 /* During cache-filling, data.sequences is not filled by
2551 where_is_internal_1. */
2552 return Fgethash (definition
, where_is_cache
, Qnil
);
2555 return data
.sequences
;
2558 /* This function can GC if Flookup_key autoloads any keymaps. */
2560 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2561 doc
: /* Return list of keys that invoke DEFINITION.
2562 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2563 If KEYMAP is nil, search all the currently active keymaps.
2564 If KEYMAP is a list of keymaps, search only those keymaps.
2566 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2567 rather than a list of all possible key sequences.
2568 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2569 no matter what it is.
2570 If FIRSTONLY has another non-nil value, prefer bindings
2571 that use the modifier key specified in `where-is-preferred-modifier'
2572 \(or their meta variants) and entirely reject menu bindings.
2574 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2575 to other keymaps or slots. This makes it possible to search for an
2576 indirect definition itself.
2578 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2579 that invoke a command which is remapped to DEFINITION, but include the
2580 remapped command in the returned list. */)
2581 (Lisp_Object definition
, Lisp_Object keymap
, Lisp_Object firstonly
, Lisp_Object noindirect
, Lisp_Object no_remap
)
2583 /* The keymaps in which to search. */
2584 Lisp_Object keymaps
;
2585 /* Potentially relevant bindings in "shortest to longest" order. */
2586 Lisp_Object sequences
= Qnil
;
2587 /* Actually relevant bindings. */
2588 Lisp_Object found
= Qnil
;
2589 /* 1 means ignore all menu bindings entirely. */
2590 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2591 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
, gcpro6
;
2592 /* List of sequences found via remapping. Keep them in a separate
2593 variable, so as to push them later, since we prefer
2594 non-remapped binding. */
2595 Lisp_Object remapped_sequences
= Qnil
;
2596 /* Whether or not we're handling remapped sequences. This is needed
2597 because remapping is not done recursively by Fcommand_remapping: you
2598 can't remap a remapped command. */
2600 Lisp_Object tem
= Qnil
;
2602 /* Refresh the C version of the modifier preference. */
2603 where_is_preferred_modifier
2604 = parse_solitary_modifier (Vwhere_is_preferred_modifier
);
2606 /* Find the relevant keymaps. */
2607 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2609 else if (!NILP (keymap
))
2610 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2612 keymaps
= Fcurrent_active_maps (Qnil
, Qnil
);
2614 GCPRO6 (definition
, keymaps
, found
, sequences
, remapped_sequences
, tem
);
2616 tem
= Fcommand_remapping (definition
, Qnil
, keymaps
);
2617 /* If `definition' is remapped to tem', then OT1H no key will run
2618 that command (since they will run `tem' instead), so we should
2619 return nil; but OTOH all keys bound to `definition' (or to `tem')
2620 will run the same command.
2621 So for menu-shortcut purposes, we want to find all the keys bound (maybe
2622 via remapping) to `tem'. But for the purpose of finding the keys that
2623 run `definition', then we'd want to just return nil.
2624 We choose to make it work right for menu-shortcuts, since it's the most
2626 Known bugs: if you remap switch-to-buffer to toto, C-h f switch-to-buffer
2627 will tell you that switch-to-buffer is bound to C-x b even though C-x b
2628 will run toto instead. And if `toto' is itself remapped to forward-char,
2629 then C-h f toto will tell you that it's bound to C-f even though C-f does
2630 not run toto and it won't tell you that C-x b does run toto. */
2631 if (NILP (no_remap
) && !NILP (tem
))
2634 if (SYMBOLP (definition
)
2635 && !NILP (firstonly
)
2636 && !NILP (tem
= Fget (definition
, QCadvertised_binding
)))
2638 /* We have a list of advertised bindings. */
2640 if (EQ (shadow_lookup (keymaps
, XCAR (tem
), Qnil
, 0), definition
))
2644 if (EQ (shadow_lookup (keymaps
, tem
, Qnil
, 0), definition
))
2648 sequences
= Freverse (where_is_internal (definition
, keymaps
,
2649 !NILP (noindirect
), nomenus
));
2651 while (CONSP (sequences
)
2652 /* If we're at the end of the `sequences' list and we haven't
2653 considered remapped sequences yet, copy them over and
2655 || (!remapped
&& (sequences
= remapped_sequences
,
2657 CONSP (sequences
))))
2659 Lisp_Object sequence
, function
;
2661 sequence
= XCAR (sequences
);
2662 sequences
= XCDR (sequences
);
2664 /* Verify that this key binding is not shadowed by another
2665 binding for the same key, before we say it exists.
2667 Mechanism: look for local definition of this key and if
2668 it is defined and does not match what we found then
2671 Either nil or number as value from Flookup_key
2673 if (NILP (Fequal (shadow_lookup (keymaps
, sequence
, Qnil
, remapped
),
2677 /* If the current sequence is a command remapping with
2678 format [remap COMMAND], find the key sequences
2679 which run COMMAND, and use those sequences instead. */
2680 if (NILP (no_remap
) && !remapped
2681 && VECTORP (sequence
) && ASIZE (sequence
) == 2
2682 && EQ (AREF (sequence
, 0), Qremap
)
2683 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2685 Lisp_Object seqs
= where_is_internal (function
, keymaps
,
2686 !NILP (noindirect
), nomenus
);
2687 remapped_sequences
= nconc2 (Freverse (seqs
), remapped_sequences
);
2691 /* Don't annoy user with strings from a menu such as the
2692 entries from the "Edit => Paste from Kill Menu".
2693 Change them all to "(any string)", so that there
2694 seems to be only one menu item to report. */
2695 if (! NILP (sequence
))
2698 tem1
= Faref (sequence
, make_number (ASIZE (sequence
) - 1));
2700 Faset (sequence
, make_number (ASIZE (sequence
) - 1),
2701 build_string ("(any string)"));
2704 /* It is a true unshadowed match. Record it, unless it's already
2705 been seen (as could happen when inheriting keymaps). */
2706 if (NILP (Fmember (sequence
, found
)))
2707 found
= Fcons (sequence
, found
);
2709 /* If firstonly is Qnon_ascii, then we can return the first
2710 binding we find. If firstonly is not Qnon_ascii but not
2711 nil, then we should return the first ascii-only binding
2713 if (EQ (firstonly
, Qnon_ascii
))
2714 RETURN_UNGCPRO (sequence
);
2715 else if (!NILP (firstonly
)
2716 && 2 == preferred_sequence_p (sequence
))
2717 RETURN_UNGCPRO (sequence
);
2722 found
= Fnreverse (found
);
2724 /* firstonly may have been t, but we may have gone all the way through
2725 the keymaps without finding an all-ASCII key sequence. So just
2726 return the best we could find. */
2727 if (NILP (firstonly
))
2729 else if (where_is_preferred_modifier
== 0)
2730 return Fcar (found
);
2732 { /* Maybe we did not find a preferred_modifier binding, but we did find
2733 some ASCII binding. */
2734 Lisp_Object bindings
= found
;
2735 while (CONSP (bindings
))
2736 if (preferred_sequence_p (XCAR (bindings
)))
2737 return XCAR (bindings
);
2739 bindings
= XCDR (bindings
);
2740 return Fcar (found
);
2744 /* This function can GC because get_keyelt can. */
2747 where_is_internal_1 (Lisp_Object key
, Lisp_Object binding
, Lisp_Object args
, void *data
)
2749 struct where_is_internal_data
*d
= data
; /* Cast! */
2750 Lisp_Object definition
= d
->definition
;
2751 int noindirect
= d
->noindirect
;
2752 Lisp_Object
this = d
->this;
2753 Lisp_Object last
= d
->last
;
2754 int last_is_meta
= d
->last_is_meta
;
2755 Lisp_Object sequence
;
2757 /* Search through indirections unless that's not wanted. */
2759 binding
= get_keyelt (binding
, 0);
2761 /* End this iteration if this element does not match
2764 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2765 || EQ (binding
, definition
)
2766 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2767 /* Doesn't match. */
2770 /* We have found a match. Construct the key sequence where we found it. */
2771 if (INTEGERP (key
) && last_is_meta
)
2773 sequence
= Fcopy_sequence (this);
2774 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2779 key
= Fcons (XCAR (key
), XCDR (key
));
2780 sequence
= append_key (this, key
);
2783 if (!NILP (where_is_cache
))
2785 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2786 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2789 d
->sequences
= Fcons (sequence
, d
->sequences
);
2792 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2794 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2795 doc
: /* Insert the list of all defined keys and their definitions.
2796 The list is inserted in the current buffer, while the bindings are
2797 looked up in BUFFER.
2798 The optional argument PREFIX, if non-nil, should be a key sequence;
2799 then we display only bindings that start with that prefix.
2800 The optional argument MENUS, if non-nil, says to mention menu bindings.
2801 \(Ordinarily these are omitted from the output.) */)
2802 (Lisp_Object buffer
, Lisp_Object prefix
, Lisp_Object menus
)
2804 Lisp_Object outbuf
, shadow
;
2805 int nomenu
= NILP (menus
);
2806 register Lisp_Object start1
;
2807 struct gcpro gcpro1
;
2809 const char *alternate_heading
2811 Keyboard translations:\n\n\
2812 You type Translation\n\
2813 -------- -----------\n";
2815 CHECK_BUFFER (buffer
);
2820 outbuf
= Fcurrent_buffer ();
2822 /* Report on alternates for keys. */
2823 if (STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
)) && !NILP (prefix
))
2826 const unsigned char *translate
= SDATA (KVAR (current_kboard
, Vkeyboard_translate_table
));
2827 int translate_len
= SCHARS (KVAR (current_kboard
, Vkeyboard_translate_table
));
2829 for (c
= 0; c
< translate_len
; c
++)
2830 if (translate
[c
] != c
)
2832 char buf
[KEY_DESCRIPTION_SIZE
];
2835 if (alternate_heading
)
2837 insert_string (alternate_heading
);
2838 alternate_heading
= 0;
2841 bufend
= push_key_description (translate
[c
], buf
, 1);
2842 insert (buf
, bufend
- buf
);
2843 Findent_to (make_number (16), make_number (1));
2844 bufend
= push_key_description (c
, buf
, 1);
2845 insert (buf
, bufend
- buf
);
2849 /* Insert calls signal_after_change which may GC. */
2850 translate
= SDATA (KVAR (current_kboard
, Vkeyboard_translate_table
));
2856 if (!NILP (Vkey_translation_map
))
2857 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2858 "Key translations", nomenu
, 1, 0, 0);
2861 /* Print the (major mode) local map. */
2863 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
2864 start1
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
2865 else if (!NILP (Voverriding_local_map
))
2866 start1
= Voverriding_local_map
;
2870 describe_map_tree (start1
, 1, shadow
, prefix
,
2871 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2872 shadow
= Fcons (start1
, shadow
);
2876 /* Print the minor mode and major mode keymaps. */
2878 Lisp_Object
*modes
, *maps
;
2880 /* Temporarily switch to `buffer', so that we can get that buffer's
2881 minor modes correctly. */
2882 Fset_buffer (buffer
);
2884 nmaps
= current_minor_maps (&modes
, &maps
);
2885 Fset_buffer (outbuf
);
2887 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2888 XBUFFER (buffer
), Qkeymap
);
2891 describe_map_tree (start1
, 1, shadow
, prefix
,
2892 "\f\n`keymap' Property Bindings", nomenu
,
2894 shadow
= Fcons (start1
, shadow
);
2897 /* Print the minor mode maps. */
2898 for (i
= 0; i
< nmaps
; i
++)
2900 /* The title for a minor mode keymap
2901 is constructed at run time.
2902 We let describe_map_tree do the actual insertion
2903 because it takes care of other features when doing so. */
2906 if (!SYMBOLP (modes
[i
]))
2909 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2913 memcpy (p
, SDATA (SYMBOL_NAME (modes
[i
])),
2914 SCHARS (SYMBOL_NAME (modes
[i
])));
2915 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2917 memcpy (p
, " Minor Mode Bindings", strlen (" Minor Mode Bindings"));
2918 p
+= strlen (" Minor Mode Bindings");
2921 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2922 title
, nomenu
, 0, 0, 0);
2923 shadow
= Fcons (maps
[i
], shadow
);
2926 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2927 XBUFFER (buffer
), Qlocal_map
);
2930 if (EQ (start1
, BVAR (XBUFFER (buffer
), keymap
)))
2931 describe_map_tree (start1
, 1, shadow
, prefix
,
2932 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2934 describe_map_tree (start1
, 1, shadow
, prefix
,
2935 "\f\n`local-map' Property Bindings",
2938 shadow
= Fcons (start1
, shadow
);
2942 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2943 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2945 /* Print the function-key-map translations under this prefix. */
2946 if (!NILP (KVAR (current_kboard
, Vlocal_function_key_map
)))
2947 describe_map_tree (KVAR (current_kboard
, Vlocal_function_key_map
), 0, Qnil
, prefix
,
2948 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2950 /* Print the input-decode-map translations under this prefix. */
2951 if (!NILP (KVAR (current_kboard
, Vinput_decode_map
)))
2952 describe_map_tree (KVAR (current_kboard
, Vinput_decode_map
), 0, Qnil
, prefix
,
2953 "\f\nInput decoding map translations", nomenu
, 1, 0, 0);
2959 /* Insert a description of the key bindings in STARTMAP,
2960 followed by those of all maps reachable through STARTMAP.
2961 If PARTIAL is nonzero, omit certain "uninteresting" commands
2962 (such as `undefined').
2963 If SHADOW is non-nil, it is a list of maps;
2964 don't mention keys which would be shadowed by any of them.
2965 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2966 TITLE, if not 0, is a string to insert at the beginning.
2967 TITLE should not end with a colon or a newline; we supply that.
2968 If NOMENU is not 0, then omit menu-bar commands.
2970 If TRANSL is nonzero, the definitions are actually key translations
2971 so print strings and vectors differently.
2973 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2976 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
2977 don't omit it; instead, mention it but say it is shadowed.
2979 Return whether something was inserted or not. */
2982 describe_map_tree (Lisp_Object startmap
, int partial
, Lisp_Object shadow
,
2983 Lisp_Object prefix
, const char *title
, int nomenu
, int transl
,
2984 int always_title
, int mention_shadow
)
2986 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2987 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2989 const char *key_heading
2994 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
2997 GCPRO3 (maps
, seen
, sub_shadows
);
3003 /* Delete from MAPS each element that is for the menu bar. */
3004 for (list
= maps
; CONSP (list
); list
= XCDR (list
))
3006 Lisp_Object elt
, elt_prefix
, tem
;
3009 elt_prefix
= Fcar (elt
);
3010 if (ASIZE (elt_prefix
) >= 1)
3012 tem
= Faref (elt_prefix
, make_number (0));
3013 if (EQ (tem
, Qmenu_bar
))
3014 maps
= Fdelq (elt
, maps
);
3019 if (!NILP (maps
) || always_title
)
3023 insert_string (title
);
3026 insert_string (" Starting With ");
3027 insert1 (Fkey_description (prefix
, Qnil
));
3029 insert_string (":\n");
3031 insert_string (key_heading
);
3035 for (; CONSP (maps
); maps
= XCDR (maps
))
3037 register Lisp_Object elt
, elt_prefix
, tail
;
3040 elt_prefix
= Fcar (elt
);
3044 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3048 shmap
= XCAR (tail
);
3050 /* If the sequence by which we reach this keymap is zero-length,
3051 then the shadow map for this keymap is just SHADOW. */
3052 if ((STRINGP (elt_prefix
) && SCHARS (elt_prefix
) == 0)
3053 || (VECTORP (elt_prefix
) && ASIZE (elt_prefix
) == 0))
3055 /* If the sequence by which we reach this keymap actually has
3056 some elements, then the sequence's definition in SHADOW is
3057 what we should use. */
3060 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3061 if (INTEGERP (shmap
))
3065 /* If shmap is not nil and not a keymap,
3066 it completely shadows this map, so don't
3067 describe this map at all. */
3068 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3072 sub_shadows
= Fcons (shmap
, sub_shadows
);
3075 /* Maps we have already listed in this loop shadow this map. */
3076 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3079 tem
= Fequal (Fcar (XCAR (tail
)), elt_prefix
);
3081 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3084 describe_map (Fcdr (elt
), elt_prefix
,
3085 transl
? describe_translation
: describe_command
,
3086 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3095 static int previous_description_column
;
3098 describe_command (Lisp_Object definition
, Lisp_Object args
)
3100 register Lisp_Object tem1
;
3101 ptrdiff_t column
= current_column ();
3102 int description_column
;
3104 /* If column 16 is no good, go to col 32;
3105 but don't push beyond that--go to next line instead. */
3109 description_column
= 32;
3111 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3112 description_column
= 32;
3114 description_column
= 16;
3116 Findent_to (make_number (description_column
), make_number (1));
3117 previous_description_column
= description_column
;
3119 if (SYMBOLP (definition
))
3121 tem1
= SYMBOL_NAME (definition
);
3123 insert_string ("\n");
3125 else if (STRINGP (definition
) || VECTORP (definition
))
3126 insert_string ("Keyboard Macro\n");
3127 else if (KEYMAPP (definition
))
3128 insert_string ("Prefix Command\n");
3130 insert_string ("??\n");
3134 describe_translation (Lisp_Object definition
, Lisp_Object args
)
3136 register Lisp_Object tem1
;
3138 Findent_to (make_number (16), make_number (1));
3140 if (SYMBOLP (definition
))
3142 tem1
= SYMBOL_NAME (definition
);
3144 insert_string ("\n");
3146 else if (STRINGP (definition
) || VECTORP (definition
))
3148 insert1 (Fkey_description (definition
, Qnil
));
3149 insert_string ("\n");
3151 else if (KEYMAPP (definition
))
3152 insert_string ("Prefix Command\n");
3154 insert_string ("??\n");
3157 /* describe_map puts all the usable elements of a sparse keymap
3158 into an array of `struct describe_map_elt',
3159 then sorts them by the events. */
3161 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3163 /* qsort comparison function for sorting `struct describe_map_elt' by
3167 describe_map_compare (const void *aa
, const void *bb
)
3169 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3170 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3171 return ((XINT (a
->event
) > XINT (b
->event
))
3172 - (XINT (a
->event
) < XINT (b
->event
)));
3173 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3175 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3177 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3178 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3179 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3184 /* Describe the contents of map MAP, assuming that this map itself is
3185 reached by the sequence of prefix keys PREFIX (a string or vector).
3186 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3189 describe_map (Lisp_Object map
, Lisp_Object prefix
,
3190 void (*elt_describer
) (Lisp_Object
, Lisp_Object
),
3191 int partial
, Lisp_Object shadow
,
3192 Lisp_Object
*seen
, int nomenu
, int mention_shadow
)
3194 Lisp_Object tail
, definition
, event
;
3196 Lisp_Object suppress
;
3199 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3201 /* These accumulate the values from sparse keymap bindings,
3202 so we can sort them and handle them in order. */
3203 int length_needed
= 0;
3204 struct describe_map_elt
*vect
;
3211 suppress
= intern ("suppress-keymap");
3213 /* This vector gets used to present single keys to Flookup_key. Since
3214 that is done once per keymap element, we don't want to cons up a
3215 fresh vector every time. */
3216 kludge
= Fmake_vector (make_number (1), Qnil
);
3219 GCPRO3 (prefix
, definition
, kludge
);
3221 map
= call1 (Qkeymap_canonicalize
, map
);
3223 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3226 vect
= ((struct describe_map_elt
*)
3227 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3229 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3233 if (VECTORP (XCAR (tail
))
3234 || CHAR_TABLE_P (XCAR (tail
)))
3235 describe_vector (XCAR (tail
),
3236 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3238 else if (CONSP (XCAR (tail
)))
3240 int this_shadowed
= 0;
3242 event
= XCAR (XCAR (tail
));
3244 /* Ignore bindings whose "prefix" are not really valid events.
3245 (We get these in the frames and buffers menu.) */
3246 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3249 if (nomenu
&& EQ (event
, Qmenu_bar
))
3252 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3254 /* Don't show undefined commands or suppressed commands. */
3255 if (NILP (definition
)) continue;
3256 if (SYMBOLP (definition
) && partial
)
3258 tem
= Fget (definition
, suppress
);
3263 /* Don't show a command that isn't really visible
3264 because a local definition of the same key shadows it. */
3266 ASET (kludge
, 0, event
);
3269 tem
= shadow_lookup (shadow
, kludge
, Qt
, 0);
3272 /* If both bindings are keymaps, this key is a prefix key,
3273 so don't say it is shadowed. */
3274 if (KEYMAPP (definition
) && KEYMAPP (tem
))
3276 /* Avoid generating duplicate entries if the
3277 shadowed binding has the same definition. */
3278 else if (mention_shadow
&& !EQ (tem
, definition
))
3285 tem
= Flookup_key (map
, kludge
, Qt
);
3286 if (!EQ (tem
, definition
)) continue;
3288 vect
[slots_used
].event
= event
;
3289 vect
[slots_used
].definition
= definition
;
3290 vect
[slots_used
].shadowed
= this_shadowed
;
3293 else if (EQ (XCAR (tail
), Qkeymap
))
3295 /* The same keymap might be in the structure twice, if we're
3296 using an inherited keymap. So skip anything we've already
3298 tem
= Fassq (tail
, *seen
);
3299 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3301 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3305 /* If we found some sparse map events, sort them. */
3307 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3308 describe_map_compare
);
3310 /* Now output them in sorted order. */
3312 for (i
= 0; i
< slots_used
; i
++)
3314 Lisp_Object start
, end
;
3318 previous_description_column
= 0;
3323 ASET (kludge
, 0, vect
[i
].event
);
3324 start
= vect
[i
].event
;
3327 definition
= vect
[i
].definition
;
3329 /* Find consecutive chars that are identically defined. */
3330 if (INTEGERP (vect
[i
].event
))
3332 while (i
+ 1 < slots_used
3333 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3334 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3335 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3337 end
= vect
[i
].event
;
3340 /* Now START .. END is the range to describe next. */
3342 /* Insert the string to describe the event START. */
3343 insert1 (Fkey_description (kludge
, prefix
));
3345 if (!EQ (start
, end
))
3349 ASET (kludge
, 0, end
);
3350 /* Insert the string to describe the character END. */
3351 insert1 (Fkey_description (kludge
, prefix
));
3354 /* Print a description of the definition of this character.
3355 elt_describer will take care of spacing out far enough
3356 for alignment purposes. */
3357 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3359 if (vect
[i
].shadowed
)
3362 insert_string ("\n (that binding is currently shadowed by another mode)");
3371 describe_vector_princ (Lisp_Object elt
, Lisp_Object fun
)
3373 Findent_to (make_number (16), make_number (1));
3378 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3379 doc
: /* Insert a description of contents of VECTOR.
3380 This is text showing the elements of vector matched against indices.
3381 DESCRIBER is the output function used; nil means use `princ'. */)
3382 (Lisp_Object vector
, Lisp_Object describer
)
3384 ptrdiff_t count
= SPECPDL_INDEX ();
3385 if (NILP (describer
))
3386 describer
= intern ("princ");
3387 specbind (Qstandard_output
, Fcurrent_buffer ());
3388 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3389 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3392 return unbind_to (count
, Qnil
);
3395 /* Insert in the current buffer a description of the contents of VECTOR.
3396 We call ELT_DESCRIBER to insert the description of one value found
3399 ELT_PREFIX describes what "comes before" the keys or indices defined
3400 by this vector. This is a human-readable string whose size
3401 is not necessarily related to the situation.
3403 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3404 leads to this keymap.
3406 If the vector is a chartable, ELT_PREFIX is the vector
3407 of bytes that lead to the character set or portion of a character
3408 set described by this chartable.
3410 If PARTIAL is nonzero, it means do not mention suppressed commands
3411 (that assumes the vector is in a keymap).
3413 SHADOW is a list of keymaps that shadow this map.
3414 If it is non-nil, then we look up the key in those maps
3415 and we don't mention it now if it is defined by any of them.
3417 ENTIRE_MAP is the keymap in which this vector appears.
3418 If the definition in effect in the whole map does not match
3419 the one in this vector, we ignore this one.
3421 ARGS is simply passed as the second argument to ELT_DESCRIBER.
3423 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3425 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3428 describe_vector (Lisp_Object vector
, Lisp_Object prefix
, Lisp_Object args
,
3429 void (*elt_describer
) (Lisp_Object
, Lisp_Object
),
3430 int partial
, Lisp_Object shadow
, Lisp_Object entire_map
,
3431 int keymap_p
, int mention_shadow
)
3433 Lisp_Object definition
;
3435 Lisp_Object elt_prefix
= Qnil
;
3437 Lisp_Object suppress
;
3440 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3441 /* Range of elements to be handled. */
3443 Lisp_Object character
;
3452 /* Call Fkey_description first, to avoid GC bug for the other string. */
3453 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3456 tem
= Fkey_description (prefix
, Qnil
);
3457 elt_prefix
= concat2 (tem
, build_string (" "));
3462 /* This vector gets used to present single keys to Flookup_key. Since
3463 that is done once per vector element, we don't want to cons up a
3464 fresh vector every time. */
3465 kludge
= Fmake_vector (make_number (1), Qnil
);
3466 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3469 suppress
= intern ("suppress-keymap");
3472 if (CHAR_TABLE_P (vector
))
3473 stop
= MAX_5_BYTE_CHAR
+ 1, to
= MAX_CHAR
+ 1;
3475 stop
= to
= ASIZE (vector
);
3477 for (i
= from
; ; i
++)
3479 int this_shadowed
= 0;
3480 int range_beg
, range_end
;
3494 if (CHAR_TABLE_P (vector
))
3498 val
= char_table_ref_and_range (vector
, range_beg
, &range_beg
, &i
);
3501 val
= AREF (vector
, i
);
3502 definition
= get_keyelt (val
, 0);
3504 if (NILP (definition
)) continue;
3506 /* Don't mention suppressed commands. */
3507 if (SYMBOLP (definition
) && partial
)
3511 tem
= Fget (definition
, suppress
);
3513 if (!NILP (tem
)) continue;
3516 character
= make_number (starting_i
);
3517 ASET (kludge
, 0, character
);
3519 /* If this binding is shadowed by some other map, ignore it. */
3524 tem
= shadow_lookup (shadow
, kludge
, Qt
, 0);
3535 /* Ignore this definition if it is shadowed by an earlier
3536 one in the same keymap. */
3537 if (!NILP (entire_map
))
3541 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3543 if (!EQ (tem
, definition
))
3553 /* Output the prefix that applies to every entry in this map. */
3554 if (!NILP (elt_prefix
))
3555 insert1 (elt_prefix
);
3557 insert1 (Fkey_description (kludge
, prefix
));
3559 /* Find all consecutive characters or rows that have the same
3560 definition. But, VECTOR is a char-table, we had better put a
3561 boundary between normal characters (-#x3FFF7F) and 8-bit
3562 characters (#x3FFF80-). */
3563 if (CHAR_TABLE_P (vector
))
3566 && (range_beg
= i
+ 1, range_end
= stop
- 1,
3567 val
= char_table_ref_and_range (vector
, range_beg
,
3568 &range_beg
, &range_end
),
3569 tem2
= get_keyelt (val
, 0),
3571 && !NILP (Fequal (tem2
, definition
)))
3576 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3578 && !NILP (Fequal (tem2
, definition
)))
3581 /* If we have a range of more than one character,
3582 print where the range reaches to. */
3584 if (i
!= starting_i
)
3588 ASET (kludge
, 0, make_number (i
));
3590 if (!NILP (elt_prefix
))
3591 insert1 (elt_prefix
);
3593 insert1 (Fkey_description (kludge
, prefix
));
3596 /* Print a description of the definition of this character.
3597 elt_describer will take care of spacing out far enough
3598 for alignment purposes. */
3599 (*elt_describer
) (definition
, args
);
3604 insert_string (" (binding currently shadowed)");
3609 if (CHAR_TABLE_P (vector
) && ! NILP (XCHAR_TABLE (vector
)->defalt
))
3611 if (!NILP (elt_prefix
))
3612 insert1 (elt_prefix
);
3613 insert ("default", 7);
3614 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3620 /* Apropos - finding all symbols whose names match a regexp. */
3621 static Lisp_Object apropos_predicate
;
3622 static Lisp_Object apropos_accumulate
;
3625 apropos_accum (Lisp_Object symbol
, Lisp_Object string
)
3627 register Lisp_Object tem
;
3629 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3630 if (!NILP (tem
) && !NILP (apropos_predicate
))
3631 tem
= call1 (apropos_predicate
, symbol
);
3633 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3636 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3637 doc
: /* Show all symbols whose names contain match for REGEXP.
3638 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3639 for each symbol and a symbol is mentioned only if that returns non-nil.
3640 Return list of symbols found. */)
3641 (Lisp_Object regexp
, Lisp_Object predicate
)
3644 CHECK_STRING (regexp
);
3645 apropos_predicate
= predicate
;
3646 apropos_accumulate
= Qnil
;
3647 map_obarray (Vobarray
, apropos_accum
, regexp
);
3648 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3649 apropos_accumulate
= Qnil
;
3650 apropos_predicate
= Qnil
;
3655 syms_of_keymap (void)
3657 DEFSYM (Qkeymap
, "keymap");
3658 staticpro (&apropos_predicate
);
3659 staticpro (&apropos_accumulate
);
3660 apropos_predicate
= Qnil
;
3661 apropos_accumulate
= Qnil
;
3663 DEFSYM (Qkeymap_canonicalize
, "keymap-canonicalize");
3665 /* Now we are ready to set up this property, so we can
3666 create char tables. */
3667 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3669 /* Initialize the keymaps standardly used.
3670 Each one is the value of a Lisp variable, and is also
3671 pointed to by a C variable */
3673 global_map
= Fmake_keymap (Qnil
);
3674 Fset (intern_c_string ("global-map"), global_map
);
3676 current_global_map
= global_map
;
3677 staticpro (&global_map
);
3678 staticpro (¤t_global_map
);
3680 meta_map
= Fmake_keymap (Qnil
);
3681 Fset (intern_c_string ("esc-map"), meta_map
);
3682 Ffset (intern_c_string ("ESC-prefix"), meta_map
);
3684 control_x_map
= Fmake_keymap (Qnil
);
3685 Fset (intern_c_string ("ctl-x-map"), control_x_map
);
3686 Ffset (intern_c_string ("Control-X-prefix"), control_x_map
);
3689 = pure_cons (pure_cons (make_pure_c_string ("DEL"), make_pure_c_string ("\\d")),
3690 pure_cons (pure_cons (make_pure_c_string ("TAB"), make_pure_c_string ("\\t")),
3691 pure_cons (pure_cons (make_pure_c_string ("RET"), make_pure_c_string ("\\r")),
3692 pure_cons (pure_cons (make_pure_c_string ("ESC"), make_pure_c_string ("\\e")),
3693 pure_cons (pure_cons (make_pure_c_string ("SPC"), make_pure_c_string (" ")),
3695 staticpro (&exclude_keys
);
3697 DEFVAR_LISP ("define-key-rebound-commands", Vdefine_key_rebound_commands
,
3698 doc
: /* List of commands given new key bindings recently.
3699 This is used for internal purposes during Emacs startup;
3700 don't alter it yourself. */);
3701 Vdefine_key_rebound_commands
= Qt
;
3703 DEFVAR_LISP ("minibuffer-local-map", Vminibuffer_local_map
,
3704 doc
: /* Default keymap to use when reading from the minibuffer. */);
3705 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3707 DEFVAR_LISP ("minibuffer-local-ns-map", Vminibuffer_local_ns_map
,
3708 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3709 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3710 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3713 DEFVAR_LISP ("minor-mode-map-alist", Vminor_mode_map_alist
,
3714 doc
: /* Alist of keymaps to use for minor modes.
3715 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3716 key sequences and look up bindings if VARIABLE's value is non-nil.
3717 If two active keymaps bind the same key, the keymap appearing earlier
3718 in the list takes precedence. */);
3719 Vminor_mode_map_alist
= Qnil
;
3721 DEFVAR_LISP ("minor-mode-overriding-map-alist", Vminor_mode_overriding_map_alist
,
3722 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3723 This variable is an alist just like `minor-mode-map-alist', and it is
3724 used the same way (and before `minor-mode-map-alist'); however,
3725 it is provided for major modes to bind locally. */);
3726 Vminor_mode_overriding_map_alist
= Qnil
;
3728 DEFVAR_LISP ("emulation-mode-map-alists", Vemulation_mode_map_alists
,
3729 doc
: /* List of keymap alists to use for emulations modes.
3730 It is intended for modes or packages using multiple minor-mode keymaps.
3731 Each element is a keymap alist just like `minor-mode-map-alist', or a
3732 symbol with a variable binding which is a keymap alist, and it is used
3733 the same way. The "active" keymaps in each alist are used before
3734 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3735 Vemulation_mode_map_alists
= Qnil
;
3737 DEFVAR_LISP ("where-is-preferred-modifier", Vwhere_is_preferred_modifier
,
3738 doc
: /* Preferred modifier key to use for `where-is'.
3739 When a single binding is requested, `where-is' will return one that
3740 uses this modifier key if possible. If nil, or if no such binding
3741 exists, bindings using keys without modifiers (or only with meta) will
3743 Vwhere_is_preferred_modifier
= Qnil
;
3744 where_is_preferred_modifier
= 0;
3746 staticpro (&Vmouse_events
);
3747 Vmouse_events
= pure_cons (intern_c_string ("menu-bar"),
3748 pure_cons (intern_c_string ("tool-bar"),
3749 pure_cons (intern_c_string ("header-line"),
3750 pure_cons (intern_c_string ("mode-line"),
3751 pure_cons (intern_c_string ("mouse-1"),
3752 pure_cons (intern_c_string ("mouse-2"),
3753 pure_cons (intern_c_string ("mouse-3"),
3754 pure_cons (intern_c_string ("mouse-4"),
3755 pure_cons (intern_c_string ("mouse-5"),
3758 DEFSYM (Qsingle_key_description
, "single-key-description");
3759 DEFSYM (Qkey_description
, "key-description");
3760 DEFSYM (Qkeymapp
, "keymapp");
3761 DEFSYM (Qnon_ascii
, "non-ascii");
3762 DEFSYM (Qmenu_item
, "menu-item");
3763 DEFSYM (Qremap
, "remap");
3764 DEFSYM (QCadvertised_binding
, ":advertised-binding");
3766 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3767 staticpro (&command_remapping_vector
);
3769 where_is_cache_keymaps
= Qt
;
3770 where_is_cache
= Qnil
;
3771 staticpro (&where_is_cache
);
3772 staticpro (&where_is_cache_keymaps
);
3774 defsubr (&Skeymapp
);
3775 defsubr (&Skeymap_parent
);
3776 defsubr (&Skeymap_prompt
);
3777 defsubr (&Sset_keymap_parent
);
3778 defsubr (&Smake_keymap
);
3779 defsubr (&Smake_sparse_keymap
);
3780 defsubr (&Smap_keymap_internal
);
3781 defsubr (&Smap_keymap
);
3782 defsubr (&Scopy_keymap
);
3783 defsubr (&Scommand_remapping
);
3784 defsubr (&Skey_binding
);
3785 defsubr (&Slocal_key_binding
);
3786 defsubr (&Sglobal_key_binding
);
3787 defsubr (&Sminor_mode_key_binding
);
3788 defsubr (&Sdefine_key
);
3789 defsubr (&Slookup_key
);
3790 defsubr (&Sdefine_prefix_command
);
3791 defsubr (&Suse_global_map
);
3792 defsubr (&Suse_local_map
);
3793 defsubr (&Scurrent_local_map
);
3794 defsubr (&Scurrent_global_map
);
3795 defsubr (&Scurrent_minor_mode_maps
);
3796 defsubr (&Scurrent_active_maps
);
3797 defsubr (&Saccessible_keymaps
);
3798 defsubr (&Skey_description
);
3799 defsubr (&Sdescribe_vector
);
3800 defsubr (&Ssingle_key_description
);
3801 defsubr (&Stext_char_description
);
3802 defsubr (&Swhere_is_internal
);
3803 defsubr (&Sdescribe_buffer_bindings
);
3804 defsubr (&Sapropos_internal
);
3808 keys_of_keymap (void)
3810 initial_define_key (global_map
, 033, "ESC-prefix");
3811 initial_define_key (global_map
, Ctl ('X'), "Control-X-prefix");