1 /* Manipulation of keymaps
2 Copyright (C) 1985-1988, 1993-1995, 1998-2012 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
46 #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
store_in_keymap (Lisp_Object
, Lisp_Object
, Lisp_Object
);
97 static Lisp_Object
define_as_prefix (Lisp_Object
, Lisp_Object
);
98 static void describe_command (Lisp_Object
, Lisp_Object
);
99 static void describe_translation (Lisp_Object
, Lisp_Object
);
100 static void describe_map (Lisp_Object
, Lisp_Object
,
101 void (*) (Lisp_Object
, Lisp_Object
),
102 int, Lisp_Object
, Lisp_Object
*, int, int);
103 static void describe_vector (Lisp_Object
, Lisp_Object
, Lisp_Object
,
104 void (*) (Lisp_Object
, Lisp_Object
), int,
105 Lisp_Object
, Lisp_Object
, int, int);
106 static void silly_event_symbol_error (Lisp_Object
);
107 static Lisp_Object
get_keyelt (Lisp_Object
, int);
109 /* Keymap object support - constructors and predicates. */
111 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
112 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
113 CHARTABLE is a char-table that holds the bindings for all characters
114 without modifiers. All entries in it are initially nil, meaning
115 "command undefined". ALIST is an assoc-list which holds bindings for
116 function keys, mouse events, and any other things that appear in the
117 input stream. Initially, ALIST is nil.
119 The optional arg STRING supplies a menu name for the keymap
120 in case you use it as a menu with `x-popup-menu'. */)
125 tail
= Fcons (string
, Qnil
);
128 return Fcons (Qkeymap
,
129 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
132 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
133 doc
: /* Construct and return a new sparse keymap.
134 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
135 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
136 which binds the function key or mouse event SYMBOL to DEFINITION.
137 Initially the alist is nil.
139 The optional arg STRING supplies a menu name for the keymap
140 in case you use it as a menu with `x-popup-menu'. */)
145 if (!NILP (Vpurify_flag
))
146 string
= Fpurecopy (string
);
147 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
149 return Fcons (Qkeymap
, Qnil
);
152 /* This function is used for installing the standard key bindings
153 at initialization time.
157 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
160 initial_define_key (Lisp_Object keymap
, int key
, const char *defname
)
162 store_in_keymap (keymap
, make_number (key
), intern_c_string (defname
));
166 initial_define_lispy_key (Lisp_Object keymap
, const char *keyname
, const char *defname
)
168 store_in_keymap (keymap
, intern_c_string (keyname
), intern_c_string (defname
));
171 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
172 doc
: /* Return t if OBJECT is a keymap.
174 A keymap is a list (keymap . ALIST),
175 or a symbol whose function definition is itself a keymap.
176 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
177 a vector of densely packed bindings for small character codes
178 is also allowed as an element. */)
181 return (KEYMAPP (object
) ? Qt
: Qnil
);
184 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
185 doc
: /* Return the prompt-string of a keymap MAP.
186 If non-nil, the prompt is shown in the echo-area
187 when reading a key-sequence to be looked-up in this keymap. */)
190 map
= get_keymap (map
, 0, 0);
193 Lisp_Object tem
= XCAR (map
);
196 else if (KEYMAPP (tem
))
198 tem
= Fkeymap_prompt (tem
);
207 /* Check that OBJECT is a keymap (after dereferencing through any
208 symbols). If it is, return it.
210 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
211 is an autoload form, do the autoload and try again.
212 If AUTOLOAD is nonzero, callers must assume GC is possible.
214 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
215 is zero as well), return Qt.
217 ERROR_IF_NOT_KEYMAP controls how we respond if OBJECT isn't a keymap.
218 If ERROR_IF_NOT_KEYMAP is non-zero, signal an error; otherwise,
221 Note that most of the time, we don't want to pursue autoloads.
222 Functions like Faccessible_keymaps which scan entire keymap trees
223 shouldn't load every autoloaded keymap. I'm not sure about this,
224 but it seems to me that only read_key_sequence, Flookup_key, and
225 Fdefine_key should cause keymaps to be autoloaded.
227 This function can GC when AUTOLOAD is non-zero, because it calls
228 Fautoload_do_load which can GC. */
231 get_keymap (Lisp_Object object
, int error_if_not_keymap
, int autoload
)
238 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
241 tem
= indirect_function (object
);
244 if (EQ (XCAR (tem
), Qkeymap
))
247 /* Should we do an autoload? Autoload forms for keymaps have
248 Qkeymap as their fifth element. */
249 if ((autoload
|| !error_if_not_keymap
) && EQ (XCAR (tem
), Qautoload
)
254 tail
= Fnth (make_number (4), tem
);
255 if (EQ (tail
, Qkeymap
))
259 struct gcpro gcpro1
, gcpro2
;
261 GCPRO2 (tem
, object
);
262 Fautoload_do_load (tem
, object
, Qnil
);
274 if (error_if_not_keymap
)
275 wrong_type_argument (Qkeymapp
, object
);
279 /* Return the parent map of KEYMAP, or nil if it has none.
280 We assume that KEYMAP is a valid keymap. */
283 keymap_parent (Lisp_Object keymap
, int autoload
)
287 keymap
= get_keymap (keymap
, 1, autoload
);
289 /* Skip past the initial element `keymap'. */
290 list
= XCDR (keymap
);
291 for (; CONSP (list
); list
= XCDR (list
))
293 /* See if there is another `keymap'. */
298 return get_keymap (list
, 0, autoload
);
301 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
302 doc
: /* Return the parent keymap of KEYMAP.
303 If KEYMAP has no parent, return nil. */)
306 return keymap_parent (keymap
, 1);
309 /* Check whether MAP is one of MAPS parents. */
311 keymap_memberp (Lisp_Object map
, Lisp_Object maps
)
313 if (NILP (map
)) return 0;
314 while (KEYMAPP (maps
) && !EQ (map
, maps
))
315 maps
= keymap_parent (maps
, 0);
316 return (EQ (map
, maps
));
319 /* Set the parent keymap of MAP to PARENT. */
321 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
322 doc
: /* Modify KEYMAP to set its parent map to PARENT.
323 Return PARENT. PARENT should be nil or another keymap. */)
324 (Lisp_Object keymap
, Lisp_Object parent
)
326 Lisp_Object list
, prev
;
327 struct gcpro gcpro1
, gcpro2
;
329 /* Flush any reverse-map cache. */
330 where_is_cache
= Qnil
; where_is_cache_keymaps
= Qt
;
332 GCPRO2 (keymap
, parent
);
333 keymap
= get_keymap (keymap
, 1, 1);
337 parent
= get_keymap (parent
, 1, 0);
339 /* Check for cycles. */
340 if (keymap_memberp (keymap
, parent
))
341 error ("Cyclic keymap inheritance");
344 /* Skip past the initial element `keymap'. */
349 /* If there is a parent keymap here, replace it.
350 If we came to the end, add the parent in PREV. */
351 if (!CONSP (list
) || KEYMAPP (list
))
354 XSETCDR (prev
, parent
);
355 RETURN_UNGCPRO (parent
);
362 /* Look up IDX in MAP. IDX may be any sort of event.
363 Note that this does only one level of lookup; IDX must be a single
364 event, not a sequence.
366 MAP must be a keymap or a list of keymaps.
368 If T_OK is non-zero, bindings for Qt are treated as default
369 bindings; any key left unmentioned by other tables and bindings is
370 given the binding of Qt.
372 If T_OK is zero, bindings for Qt are not treated specially.
374 If NOINHERIT, don't accept a subkeymap found in an inherited keymap.
376 Returns Qunbound if no binding was found (and returns Qnil if a nil
377 binding was found). */
380 access_keymap_1 (Lisp_Object map
, Lisp_Object idx
, int t_ok
, int noinherit
, int autoload
)
382 /* If idx is a list (some sort of mouse click, perhaps?),
383 the index we want to use is the car of the list, which
384 ought to be a symbol. */
385 idx
= EVENT_HEAD (idx
);
387 /* If idx is a symbol, it might have modifiers, which need to
388 be put in the canonical order. */
390 idx
= reorder_modifiers (idx
);
391 else if (INTEGERP (idx
))
392 /* Clobber the high bits that can be present on a machine
393 with more than 24 bits of integer. */
394 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
396 /* Handle the special meta -> esc mapping. */
397 if (INTEGERP (idx
) && XFASTINT (idx
) & meta_modifier
)
399 /* See if there is a meta-map. If there's none, there is
400 no binding for IDX, unless a default binding exists in MAP. */
402 Lisp_Object event_meta_binding
, event_meta_map
;
404 /* A strange value in which Meta is set would cause
405 infinite recursion. Protect against that. */
406 if (XINT (meta_prefix_char
) & CHAR_META
)
407 meta_prefix_char
= make_number (27);
408 event_meta_binding
= access_keymap_1 (map
, meta_prefix_char
, t_ok
,
409 noinherit
, autoload
);
410 event_meta_map
= get_keymap (event_meta_binding
, 0, autoload
);
412 if (CONSP (event_meta_map
))
414 map
= event_meta_map
;
415 idx
= make_number (XFASTINT (idx
) & ~meta_modifier
);
418 /* Set IDX to t, so that we only find a default binding. */
421 /* An explicit nil binding, or no binding at all. */
422 return NILP (event_meta_binding
) ? Qnil
: Qunbound
;
425 /* t_binding is where we put a default binding that applies,
426 to use in case we do not find a binding specifically
427 for this key sequence. */
430 Lisp_Object t_binding
= Qunbound
;
431 Lisp_Object retval
= Qunbound
;
432 Lisp_Object retval_tail
= Qnil
;
433 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
435 GCPRO4 (tail
, idx
, t_binding
, retval
);
437 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
439 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
442 /* Qunbound in VAL means we have found no binding. */
443 Lisp_Object val
= Qunbound
;
444 Lisp_Object binding
= XCAR (tail
);
445 Lisp_Object submap
= get_keymap (binding
, 0, autoload
);
447 if (EQ (binding
, Qkeymap
))
449 if (noinherit
|| NILP (retval
))
450 /* If NOINHERIT, stop here, the rest is inherited. */
452 else if (!EQ (retval
, Qunbound
))
454 Lisp_Object parent_entry
;
455 eassert (KEYMAPP (retval
));
457 = get_keymap (access_keymap_1 (tail
, idx
,
460 if (KEYMAPP (parent_entry
))
462 if (CONSP (retval_tail
))
463 XSETCDR (retval_tail
, parent_entry
);
466 retval_tail
= Fcons (retval
, parent_entry
);
467 retval
= Fcons (Qkeymap
, retval_tail
);
473 else if (CONSP (submap
))
475 val
= access_keymap_1 (submap
, idx
, t_ok
, noinherit
, autoload
);
477 else if (CONSP (binding
))
479 Lisp_Object key
= XCAR (binding
);
482 val
= XCDR (binding
);
483 else if (t_ok
&& EQ (key
, Qt
))
485 t_binding
= XCDR (binding
);
489 else if (VECTORP (binding
))
491 if (INTEGERP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
492 val
= AREF (binding
, XFASTINT (idx
));
494 else if (CHAR_TABLE_P (binding
))
496 /* Character codes with modifiers
497 are not included in a char-table.
498 All character codes without modifiers are included. */
499 if (INTEGERP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
501 val
= Faref (binding
, idx
);
502 /* `nil' has a special meaning for char-tables, so
503 we use something else to record an explicitly
510 /* If we found a binding, clean it up and return it. */
511 if (!EQ (val
, Qunbound
))
514 /* A Qt binding is just like an explicit nil binding
515 (i.e. it shadows any parent binding but not bindings in
516 keymaps of lower precedence). */
519 val
= get_keyelt (val
, autoload
);
523 if (NILP (retval
) || EQ (retval
, Qunbound
))
526 break; /* Shadows everything that follows. */
528 else if (NILP (retval
) || EQ (retval
, Qunbound
))
530 else if (CONSP (retval_tail
))
532 XSETCDR (retval_tail
, Fcons (val
, Qnil
));
533 retval_tail
= XCDR (retval_tail
);
537 retval_tail
= Fcons (val
, Qnil
);
538 retval
= Fcons (Qkeymap
, Fcons (retval
, retval_tail
));
544 return EQ (Qunbound
, retval
) ? get_keyelt (t_binding
, autoload
) : retval
;
549 access_keymap (Lisp_Object map
, Lisp_Object idx
,
550 int t_ok
, int noinherit
, int autoload
)
552 Lisp_Object val
= access_keymap_1 (map
, idx
, t_ok
, noinherit
, autoload
);
553 return EQ (val
, Qunbound
) ? Qnil
: val
;
557 map_keymap_item (map_keymap_function_t fun
, Lisp_Object args
, Lisp_Object key
, Lisp_Object val
, void *data
)
561 (*fun
) (key
, val
, args
, data
);
565 map_keymap_char_table_item (Lisp_Object args
, Lisp_Object key
, Lisp_Object val
)
569 map_keymap_function_t fun
570 = (map_keymap_function_t
) XSAVE_VALUE (XCAR (args
))->pointer
;
572 /* If the key is a range, make a copy since map_char_table modifies
575 key
= Fcons (XCAR (key
), XCDR (key
));
576 map_keymap_item (fun
, XCDR (args
), key
, val
,
577 XSAVE_VALUE (XCAR (args
))->pointer
);
581 /* Call FUN for every binding in MAP and stop at (and return) the parent.
582 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA). */
584 map_keymap_internal (Lisp_Object map
,
585 map_keymap_function_t fun
,
589 struct gcpro gcpro1
, gcpro2
, gcpro3
;
591 = (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
593 GCPRO3 (map
, args
, tail
);
594 for (; CONSP (tail
) && !EQ (Qkeymap
, XCAR (tail
)); tail
= XCDR (tail
))
596 Lisp_Object binding
= XCAR (tail
);
598 if (KEYMAPP (binding
)) /* An embedded parent. */
600 else if (CONSP (binding
))
601 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
602 else if (VECTORP (binding
))
604 /* Loop over the char values represented in the vector. */
605 int len
= ASIZE (binding
);
607 for (c
= 0; c
< len
; c
++)
609 Lisp_Object character
;
610 XSETFASTINT (character
, c
);
611 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
614 else if (CHAR_TABLE_P (binding
))
616 map_char_table (map_keymap_char_table_item
, Qnil
, binding
,
617 Fcons (make_save_value ((void *) fun
, 0),
618 Fcons (make_save_value (data
, 0),
627 map_keymap_call (Lisp_Object key
, Lisp_Object val
, Lisp_Object fun
, void *dummy
)
629 call2 (fun
, key
, val
);
632 /* Same as map_keymap_internal, but traverses parent keymaps as well.
633 A non-zero AUTOLOAD indicates that autoloaded keymaps should be loaded. */
635 map_keymap (Lisp_Object map
, map_keymap_function_t fun
, Lisp_Object args
, void *data
, int autoload
)
639 map
= get_keymap (map
, 1, autoload
);
642 if (KEYMAPP (XCAR (map
)))
644 map_keymap (XCAR (map
), fun
, args
, data
, autoload
);
648 map
= map_keymap_internal (map
, fun
, args
, data
);
650 map
= get_keymap (map
, 0, autoload
);
655 static Lisp_Object Qkeymap_canonicalize
;
657 /* Same as map_keymap, but does it right, properly eliminating duplicate
658 bindings due to inheritance. */
660 map_keymap_canonical (Lisp_Object map
, map_keymap_function_t fun
, Lisp_Object args
, void *data
)
664 /* map_keymap_canonical may be used from redisplay (e.g. when building menus)
665 so be careful to ignore errors and to inhibit redisplay. */
666 map
= safe_call1 (Qkeymap_canonicalize
, map
);
667 /* No need to use `map_keymap' here because canonical map has no parent. */
668 map_keymap_internal (map
, fun
, args
, data
);
672 DEFUN ("map-keymap-internal", Fmap_keymap_internal
, Smap_keymap_internal
, 2, 2, 0,
673 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
674 FUNCTION is called with two arguments: the event that is bound, and
675 the definition it is bound to. The event may be a character range.
676 If KEYMAP has a parent, this function returns it without processing it. */)
677 (Lisp_Object function
, Lisp_Object keymap
)
681 keymap
= get_keymap (keymap
, 1, 1);
682 keymap
= map_keymap_internal (keymap
, map_keymap_call
, function
, NULL
);
687 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
688 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
689 FUNCTION is called with two arguments: the event that is bound, and
690 the definition it is bound to. The event may be a character range.
692 If KEYMAP has a parent, the parent's bindings are included as well.
693 This works recursively: if the parent has itself a parent, then the
694 grandparent's bindings are also included and so on.
695 usage: (map-keymap FUNCTION KEYMAP) */)
696 (Lisp_Object function
, Lisp_Object keymap
, Lisp_Object sort_first
)
698 if (! NILP (sort_first
))
699 return call2 (intern ("map-keymap-sorted"), function
, keymap
);
701 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
705 /* Given OBJECT which was found in a slot in a keymap,
706 trace indirect definitions to get the actual definition of that slot.
707 An indirect definition is a list of the form
708 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
709 and INDEX is the object to look up in KEYMAP to yield the definition.
711 Also if OBJECT has a menu string as the first element,
712 remove that. Also remove a menu help string as second element.
714 If AUTOLOAD is nonzero, load autoloadable keymaps
715 that are referred to with indirection.
717 This can GC because menu_item_eval_property calls Feval. */
720 get_keyelt (Lisp_Object object
, int autoload
)
724 if (!(CONSP (object
)))
725 /* This is really the value. */
728 /* If the keymap contents looks like (keymap ...) or (lambda ...)
730 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
733 /* If the keymap contents looks like (menu-item name . DEFN)
734 or (menu-item name DEFN ...) then use DEFN.
735 This is a new format menu item. */
736 else if (EQ (XCAR (object
), Qmenu_item
))
738 if (CONSP (XCDR (object
)))
742 object
= XCDR (XCDR (object
));
745 object
= XCAR (object
);
747 /* If there's a `:filter FILTER', apply FILTER to the
748 menu-item's definition to get the real definition to
750 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
751 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
754 filter
= XCAR (XCDR (tem
));
755 filter
= list2 (filter
, list2 (Qquote
, object
));
756 object
= menu_item_eval_property (filter
);
761 /* Invalid keymap. */
765 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
766 Keymap alist elements like (CHAR MENUSTRING . DEFN)
767 will be used by HierarKey menus. */
768 else if (STRINGP (XCAR (object
)))
770 object
= XCDR (object
);
771 /* Also remove a menu help string, if any,
772 following the menu item name. */
773 if (CONSP (object
) && STRINGP (XCAR (object
)))
774 object
= XCDR (object
);
775 /* Also remove the sublist that caches key equivalences, if any. */
776 if (CONSP (object
) && CONSP (XCAR (object
)))
779 carcar
= XCAR (XCAR (object
));
780 if (NILP (carcar
) || VECTORP (carcar
))
781 object
= XCDR (object
);
785 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
786 else if (KEYMAPP (XCAR (object
)))
787 error ("Wow, indirect keymap entry!!");
794 store_in_keymap (Lisp_Object keymap
, register Lisp_Object idx
, Lisp_Object def
)
796 /* Flush any reverse-map cache. */
797 where_is_cache
= Qnil
;
798 where_is_cache_keymaps
= Qt
;
800 if (EQ (idx
, Qkeymap
))
801 error ("`keymap' is reserved for embedded parent maps");
803 /* If we are preparing to dump, and DEF is a menu element
804 with a menu item indicator, copy it to ensure it is not pure. */
805 if (CONSP (def
) && PURE_P (def
)
806 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
807 def
= Fcons (XCAR (def
), XCDR (def
));
809 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
810 error ("attempt to define a key in a non-keymap");
812 /* If idx is a cons, and the car part is a character, idx must be of
813 the form (FROM-CHAR . TO-CHAR). */
814 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
815 CHECK_CHARACTER_CDR (idx
);
817 /* If idx is a list (some sort of mouse click, perhaps?),
818 the index we want to use is the car of the list, which
819 ought to be a symbol. */
820 idx
= EVENT_HEAD (idx
);
822 /* If idx is a symbol, it might have modifiers, which need to
823 be put in the canonical order. */
825 idx
= reorder_modifiers (idx
);
826 else if (INTEGERP (idx
))
827 /* Clobber the high bits that can be present on a machine
828 with more than 24 bits of integer. */
829 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
831 /* Scan the keymap for a binding of idx. */
835 /* The cons after which we should insert new bindings. If the
836 keymap has a table element, we record its position here, so new
837 bindings will go after it; this way, the table will stay
838 towards the front of the alist and character lookups in dense
839 keymaps will remain fast. Otherwise, this just points at the
840 front of the keymap. */
841 Lisp_Object insertion_point
;
843 insertion_point
= keymap
;
844 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
851 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
854 ASET (elt
, XFASTINT (idx
), def
);
857 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
859 int from
= XFASTINT (XCAR (idx
));
860 int to
= XFASTINT (XCDR (idx
));
862 if (to
>= ASIZE (elt
))
863 to
= ASIZE (elt
) - 1;
864 for (; from
<= to
; from
++)
865 ASET (elt
, from
, def
);
866 if (to
== XFASTINT (XCDR (idx
)))
867 /* We have defined all keys in IDX. */
870 insertion_point
= tail
;
872 else if (CHAR_TABLE_P (elt
))
874 /* Character codes with modifiers
875 are not included in a char-table.
876 All character codes without modifiers are included. */
877 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
880 /* `nil' has a special meaning for char-tables, so
881 we use something else to record an explicitly
883 NILP (def
) ? Qt
: def
);
886 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
888 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
891 insertion_point
= tail
;
893 else if (CONSP (elt
))
895 if (EQ (Qkeymap
, XCAR (elt
)))
896 { /* A sub keymap. This might be due to a lookup that found
897 two matching bindings (maybe because of a sub keymap).
898 It almost never happens (since the second binding normally
899 only happens in the inherited part of the keymap), but
900 if it does, we want to update the sub-keymap since the
901 main one might be temporary (built by access_keymap). */
902 tail
= insertion_point
= elt
;
904 else if (EQ (idx
, XCAR (elt
)))
910 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
912 int from
= XFASTINT (XCAR (idx
));
913 int to
= XFASTINT (XCDR (idx
));
915 if (from
<= XFASTINT (XCAR (elt
))
916 && to
>= XFASTINT (XCAR (elt
)))
924 else if (EQ (elt
, Qkeymap
))
925 /* If we find a 'keymap' symbol in the spine of KEYMAP,
926 then we must have found the start of a second keymap
927 being used as the tail of KEYMAP, and a binding for IDX
928 should be inserted before it. */
935 /* We have scanned the entire keymap, and not found a binding for
936 IDX. Let's add one. */
940 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
942 /* IDX specifies a range of characters, and not all of them
943 were handled yet, which means this keymap doesn't have a
944 char-table. So, we insert a char-table now. */
945 elt
= Fmake_char_table (Qkeymap
, Qnil
);
946 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
949 elt
= Fcons (idx
, def
);
950 CHECK_IMPURE (insertion_point
);
951 XSETCDR (insertion_point
, Fcons (elt
, XCDR (insertion_point
)));
959 copy_keymap_item (Lisp_Object elt
)
961 Lisp_Object res
, tem
;
968 /* Is this a new format menu item. */
969 if (EQ (XCAR (tem
), Qmenu_item
))
971 /* Copy cell with menu-item marker. */
972 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
976 /* Copy cell with menu-item name. */
977 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
983 /* Copy cell with binding and if the binding is a keymap,
985 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
988 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
989 XSETCAR (elt
, Fcopy_keymap (tem
));
991 if (CONSP (tem
) && CONSP (XCAR (tem
)))
992 /* Delete cache for key equivalences. */
993 XSETCDR (elt
, XCDR (tem
));
998 /* It may be an old format menu item.
999 Skip the optional menu string. */
1000 if (STRINGP (XCAR (tem
)))
1002 /* Copy the cell, since copy-alist didn't go this deep. */
1003 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1005 /* Also skip the optional menu help string. */
1006 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1008 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1012 /* There may also be a list that caches key equivalences.
1013 Just delete it for the new keymap. */
1015 && CONSP (XCAR (tem
))
1016 && (NILP (XCAR (XCAR (tem
)))
1017 || VECTORP (XCAR (XCAR (tem
)))))
1019 XSETCDR (elt
, XCDR (tem
));
1022 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1023 XSETCDR (elt
, Fcopy_keymap (tem
));
1025 else if (EQ (XCAR (tem
), Qkeymap
))
1026 res
= Fcopy_keymap (elt
);
1032 copy_keymap_1 (Lisp_Object chartable
, Lisp_Object idx
, Lisp_Object elt
)
1034 Fset_char_table_range (chartable
, idx
, copy_keymap_item (elt
));
1037 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1038 doc
: /* Return a copy of the keymap KEYMAP.
1039 The copy starts out with the same definitions of KEYMAP,
1040 but changing either the copy or KEYMAP does not affect the other.
1041 Any key definitions that are subkeymaps are recursively copied.
1042 However, a key definition which is a symbol whose definition is a keymap
1044 (Lisp_Object keymap
)
1046 register Lisp_Object copy
, tail
;
1047 keymap
= get_keymap (keymap
, 1, 0);
1048 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1049 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1051 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1053 Lisp_Object elt
= XCAR (keymap
);
1054 if (CHAR_TABLE_P (elt
))
1056 elt
= Fcopy_sequence (elt
);
1057 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
);
1059 else if (VECTORP (elt
))
1062 elt
= Fcopy_sequence (elt
);
1063 for (i
= 0; i
< ASIZE (elt
); i
++)
1064 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1066 else if (CONSP (elt
))
1068 if (EQ (XCAR (elt
), Qkeymap
))
1069 /* This is a sub keymap. */
1070 elt
= Fcopy_keymap (elt
);
1072 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1074 XSETCDR (tail
, Fcons (elt
, Qnil
));
1076 keymap
= XCDR (keymap
);
1078 XSETCDR (tail
, keymap
);
1082 /* Simple Keymap mutators and accessors. */
1084 /* GC is possible in this function if it autoloads a keymap. */
1086 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1087 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1090 KEY is a string or a vector of symbols and characters, representing a
1091 sequence of keystrokes and events. Non-ASCII characters with codes
1092 above 127 (such as ISO Latin-1) can be represented by vectors.
1093 Two types of vector have special meanings:
1094 [remap COMMAND] remaps any key binding for COMMAND.
1095 [t] creates a default definition, which applies to any event with no
1096 other definition in KEYMAP.
1098 DEF is anything that can be a key's definition:
1099 nil (means key is undefined in this keymap),
1100 a command (a Lisp function suitable for interactive calling),
1101 a string (treated as a keyboard macro),
1102 a keymap (to define a prefix key),
1103 a symbol (when the key is looked up, the symbol will stand for its
1104 function definition, which should at that time be one of the above,
1105 or another symbol whose function definition is used, etc.),
1106 a cons (STRING . DEFN), meaning that DEFN is the definition
1107 (DEFN should be a valid definition in its own right),
1108 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP,
1109 or an extended menu item definition.
1110 (See info node `(elisp)Extended Menu Items'.)
1112 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1113 binding is altered. If there is no binding for KEY, the new pair
1114 binding KEY to DEF is added at the front of KEYMAP. */)
1115 (Lisp_Object keymap
, Lisp_Object key
, Lisp_Object def
)
1117 register ptrdiff_t idx
;
1118 register Lisp_Object c
;
1119 register Lisp_Object cmd
;
1123 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1125 GCPRO3 (keymap
, key
, def
);
1126 keymap
= get_keymap (keymap
, 1, 1);
1128 CHECK_VECTOR_OR_STRING (key
);
1130 length
= XFASTINT (Flength (key
));
1132 RETURN_UNGCPRO (Qnil
);
1134 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1135 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1137 meta_bit
= (VECTORP (key
) || (STRINGP (key
) && STRING_MULTIBYTE (key
))
1138 ? meta_modifier
: 0x80);
1140 if (VECTORP (def
) && ASIZE (def
) > 0 && CONSP (AREF (def
, 0)))
1141 { /* DEF is apparently an XEmacs-style keyboard macro. */
1142 Lisp_Object tmp
= Fmake_vector (make_number (ASIZE (def
)), Qnil
);
1143 ptrdiff_t i
= ASIZE (def
);
1146 Lisp_Object defi
= AREF (def
, i
);
1147 if (CONSP (defi
) && lucid_event_type_list_p (defi
))
1148 defi
= Fevent_convert_list (defi
);
1149 ASET (tmp
, i
, defi
);
1157 c
= Faref (key
, make_number (idx
));
1161 /* C may be a Lucid style event type list or a cons (FROM .
1162 TO) specifying a range of characters. */
1163 if (lucid_event_type_list_p (c
))
1164 c
= Fevent_convert_list (c
);
1165 else if (CHARACTERP (XCAR (c
)))
1166 CHECK_CHARACTER_CDR (c
);
1170 silly_event_symbol_error (c
);
1173 && (XINT (c
) & meta_bit
)
1176 c
= meta_prefix_char
;
1182 XSETINT (c
, XINT (c
) & ~meta_bit
);
1188 if (!INTEGERP (c
) && !SYMBOLP (c
)
1190 /* If C is a range, it must be a leaf. */
1191 || (INTEGERP (XCAR (c
)) && idx
!= length
)))
1192 message_with_string ("Key sequence contains invalid event %s", c
, 1);
1195 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1197 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1199 /* If this key is undefined, make it a prefix. */
1201 cmd
= define_as_prefix (keymap
, c
);
1203 keymap
= get_keymap (cmd
, 0, 1);
1204 if (!CONSP (keymap
))
1206 const char *trailing_esc
= ((EQ (c
, meta_prefix_char
) && metized
)
1207 ? (idx
== 0 ? "ESC" : " ESC")
1210 /* We must use Fkey_description rather than just passing key to
1211 error; key might be a vector, not a string. */
1212 error ("Key sequence %s starts with non-prefix key %s%s",
1213 SDATA (Fkey_description (key
, Qnil
)),
1214 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1222 /* This function may GC (it calls Fkey_binding). */
1224 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 3, 0,
1225 doc
: /* Return the remapping for command COMMAND.
1226 Returns nil if COMMAND is not remapped (or not a symbol).
1228 If the optional argument POSITION is non-nil, it specifies a mouse
1229 position as returned by `event-start' and `event-end', and the
1230 remapping occurs in the keymaps associated with it. It can also be a
1231 number or marker, in which case the keymap properties at the specified
1232 buffer position instead of point are used. The KEYMAPS argument is
1233 ignored if POSITION is non-nil.
1235 If the optional argument KEYMAPS is non-nil, it should be a list of
1236 keymaps to search for command remapping. Otherwise, search for the
1237 remapping in all currently active keymaps. */)
1238 (Lisp_Object command
, Lisp_Object position
, Lisp_Object keymaps
)
1240 if (!SYMBOLP (command
))
1243 ASET (command_remapping_vector
, 1, command
);
1246 command
= Fkey_binding (command_remapping_vector
, Qnil
, Qt
, position
);
1248 command
= Flookup_key (Fcons (Qkeymap
, keymaps
),
1249 command_remapping_vector
, Qnil
);
1250 return INTEGERP (command
) ? Qnil
: command
;
1253 /* Value is number if KEY is too long; nil if valid but has no definition. */
1254 /* GC is possible in this function. */
1256 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1257 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1258 A value of nil means undefined. See doc of `define-key'
1259 for kinds of definitions.
1261 A number as value means KEY is "too long";
1262 that is, characters or symbols in it except for the last one
1263 fail to be a valid sequence of prefix characters in KEYMAP.
1264 The number is how many characters at the front of KEY
1265 it takes to reach a non-prefix key.
1267 Normally, `lookup-key' ignores bindings for t, which act as default
1268 bindings, used when nothing else in the keymap applies; this makes it
1269 usable as a general function for probing keymaps. However, if the
1270 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1271 recognize the default bindings, just as `read-key-sequence' does. */)
1272 (Lisp_Object keymap
, Lisp_Object key
, Lisp_Object accept_default
)
1274 register ptrdiff_t idx
;
1275 register Lisp_Object cmd
;
1276 register Lisp_Object c
;
1278 int t_ok
= !NILP (accept_default
);
1279 struct gcpro gcpro1
, gcpro2
;
1281 GCPRO2 (keymap
, key
);
1282 keymap
= get_keymap (keymap
, 1, 1);
1284 CHECK_VECTOR_OR_STRING (key
);
1286 length
= XFASTINT (Flength (key
));
1288 RETURN_UNGCPRO (keymap
);
1293 c
= Faref (key
, make_number (idx
++));
1295 if (CONSP (c
) && lucid_event_type_list_p (c
))
1296 c
= Fevent_convert_list (c
);
1298 /* Turn the 8th bit of string chars into a meta modifier. */
1299 if (STRINGP (key
) && XINT (c
) & 0x80 && !STRING_MULTIBYTE (key
))
1300 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1302 /* Allow string since binding for `menu-bar-select-buffer'
1303 includes the buffer name in the key sequence. */
1304 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1305 message_with_string ("Key sequence contains invalid event %s", c
, 1);
1307 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1309 RETURN_UNGCPRO (cmd
);
1311 keymap
= get_keymap (cmd
, 0, 1);
1312 if (!CONSP (keymap
))
1313 RETURN_UNGCPRO (make_number (idx
));
1319 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1320 Assume that currently it does not define C at all.
1321 Return the keymap. */
1324 define_as_prefix (Lisp_Object keymap
, Lisp_Object c
)
1328 cmd
= Fmake_sparse_keymap (Qnil
);
1329 store_in_keymap (keymap
, c
, cmd
);
1334 /* Append a key to the end of a key sequence. We always make a vector. */
1337 append_key (Lisp_Object key_sequence
, Lisp_Object key
)
1339 Lisp_Object args
[2];
1341 args
[0] = key_sequence
;
1343 args
[1] = Fcons (key
, Qnil
);
1344 return Fvconcat (2, args
);
1347 /* Given a event type C which is a symbol,
1348 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1351 silly_event_symbol_error (Lisp_Object c
)
1353 Lisp_Object parsed
, base
, name
, assoc
;
1356 parsed
= parse_modifiers (c
);
1357 modifiers
= XFASTINT (XCAR (XCDR (parsed
)));
1358 base
= XCAR (parsed
);
1359 name
= Fsymbol_name (base
);
1360 /* This alist includes elements such as ("RET" . "\\r"). */
1361 assoc
= Fassoc (name
, exclude_keys
);
1365 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1367 Lisp_Object keystring
;
1368 if (modifiers
& alt_modifier
)
1369 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1370 if (modifiers
& ctrl_modifier
)
1371 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1372 if (modifiers
& hyper_modifier
)
1373 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1374 if (modifiers
& meta_modifier
)
1375 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1376 if (modifiers
& shift_modifier
)
1377 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1378 if (modifiers
& super_modifier
)
1379 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1382 c
= reorder_modifiers (c
);
1383 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1385 error ((modifiers
& ~meta_modifier
1386 ? "To bind the key %s, use [?%s], not [%s]"
1387 : "To bind the key %s, use \"%s\", not [%s]"),
1388 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1389 SDATA (SYMBOL_NAME (c
)));
1393 /* Global, local, and minor mode keymap stuff. */
1395 /* We can't put these variables inside current_minor_maps, since under
1396 some systems, static gets macro-defined to be the empty string.
1398 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1399 static ptrdiff_t cmm_size
= 0;
1401 /* Store a pointer to an array of the currently active minor modes in
1402 *modeptr, a pointer to an array of the keymaps of the currently
1403 active minor modes in *mapptr, and return the number of maps
1406 This function always returns a pointer to the same buffer, and may
1407 free or reallocate it, so if you want to keep it for a long time or
1408 hand it out to lisp code, copy it. This procedure will be called
1409 for every key sequence read, so the nice lispy approach (return a
1410 new assoclist, list, what have you) for each invocation would
1411 result in a lot of consing over time.
1413 If we used xrealloc/xmalloc and ran out of memory, they would throw
1414 back to the command loop, which would try to read a key sequence,
1415 which would call this function again, resulting in an infinite
1416 loop. Instead, we'll use realloc/malloc and silently truncate the
1417 list, let the key sequence be read, and hope some other piece of
1418 code signals the error. */
1420 current_minor_maps (Lisp_Object
**modeptr
, Lisp_Object
**mapptr
)
1423 int list_number
= 0;
1424 Lisp_Object alist
, assoc
, var
, val
;
1425 Lisp_Object emulation_alists
;
1426 Lisp_Object lists
[2];
1428 emulation_alists
= Vemulation_mode_map_alists
;
1429 lists
[0] = Vminor_mode_overriding_map_alist
;
1430 lists
[1] = Vminor_mode_map_alist
;
1432 for (list_number
= 0; list_number
< 2; list_number
++)
1434 if (CONSP (emulation_alists
))
1436 alist
= XCAR (emulation_alists
);
1437 emulation_alists
= XCDR (emulation_alists
);
1438 if (SYMBOLP (alist
))
1439 alist
= find_symbol_value (alist
);
1443 alist
= lists
[list_number
];
1445 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1446 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1447 && (var
= XCAR (assoc
), SYMBOLP (var
))
1448 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1453 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1454 and also an entry in Vminor_mode_map_alist,
1455 ignore the latter. */
1456 if (list_number
== 1)
1458 val
= assq_no_quit (var
, lists
[0]);
1465 ptrdiff_t newsize
, allocsize
;
1466 Lisp_Object
*newmodes
, *newmaps
;
1468 /* Check for size calculation overflow. Other code
1469 (e.g., read_key_sequence) adds 3 to the count
1470 later, so subtract 3 from the limit here. */
1471 if (min (PTRDIFF_MAX
, SIZE_MAX
) / (2 * sizeof *newmodes
) - 3
1475 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1476 allocsize
= newsize
* sizeof *newmodes
;
1478 /* Use malloc here. See the comment above this function.
1479 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1481 newmodes
= malloc (allocsize
);
1486 memcpy (newmodes
, cmm_modes
,
1487 cmm_size
* sizeof cmm_modes
[0]);
1490 cmm_modes
= newmodes
;
1493 newmaps
= malloc (allocsize
);
1498 memcpy (newmaps
, cmm_maps
,
1499 cmm_size
* sizeof cmm_maps
[0]);
1506 if (newmodes
== NULL
|| newmaps
== NULL
)
1511 /* Get the keymap definition--or nil if it is not defined. */
1512 temp
= Findirect_function (XCDR (assoc
), Qt
);
1516 cmm_maps
[i
] = temp
;
1522 if (modeptr
) *modeptr
= cmm_modes
;
1523 if (mapptr
) *mapptr
= cmm_maps
;
1527 /* Return the offset of POSITION, a click position, in the style of
1528 the respective argument of Fkey_binding. */
1530 click_position (Lisp_Object position
)
1532 EMACS_INT pos
= (INTEGERP (position
) ? XINT (position
)
1533 : MARKERP (position
) ? marker_position (position
)
1535 if (! (BEGV
<= pos
&& pos
<= ZV
))
1536 args_out_of_range (Fcurrent_buffer (), position
);
1540 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1542 doc
: /* Return a list of the currently active keymaps.
1543 OLP if non-nil indicates that we should obey `overriding-local-map' and
1544 `overriding-terminal-local-map'. POSITION can specify a click position
1545 like in the respective argument of `key-binding'. */)
1546 (Lisp_Object olp
, Lisp_Object position
)
1548 ptrdiff_t count
= SPECPDL_INDEX ();
1550 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1552 /* If a mouse click position is given, our variables are based on
1553 the buffer clicked on, not the current buffer. So we may have to
1554 switch the buffer here. */
1556 if (CONSP (position
))
1560 window
= POSN_WINDOW (position
);
1562 if (WINDOWP (window
)
1563 && BUFFERP (XWINDOW (window
)->buffer
)
1564 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
1566 /* Arrange to go back to the original buffer once we're done
1567 processing the key sequence. We don't use
1568 save_excursion_{save,restore} here, in analogy to
1569 `read-key-sequence' to avoid saving point. Maybe this
1570 would not be a problem here, but it is easier to keep
1573 record_unwind_current_buffer ();
1574 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
1580 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
1581 keymaps
= Fcons (KVAR (current_kboard
, Voverriding_terminal_local_map
),
1583 /* The doc said that overriding-terminal-local-map should
1584 override overriding-local-map. The code used them both,
1585 but it seems clearer to use just one. rms, jan 2005. */
1586 else if (!NILP (Voverriding_local_map
))
1587 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1589 if (NILP (XCDR (keymaps
)))
1593 ptrdiff_t pt
= click_position (position
);
1594 /* This usually returns the buffer's local map,
1595 but that can be overridden by a `local-map' property. */
1596 Lisp_Object local_map
= get_local_map (pt
, current_buffer
, Qlocal_map
);
1597 /* This returns nil unless there is a `keymap' property. */
1598 Lisp_Object keymap
= get_local_map (pt
, current_buffer
, Qkeymap
);
1600 if (CONSP (position
))
1602 Lisp_Object string
= POSN_STRING (position
);
1604 /* For a mouse click, get the local text-property keymap
1605 of the place clicked on, rather than point. */
1607 if (POSN_INBUFFER_P (position
))
1611 pos
= POSN_BUFFER_POSN (position
);
1613 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
1615 local_map
= get_local_map (XINT (pos
),
1616 current_buffer
, Qlocal_map
);
1618 keymap
= get_local_map (XINT (pos
),
1619 current_buffer
, Qkeymap
);
1623 /* If on a mode line string with a local keymap,
1624 or for a click on a string, i.e. overlay string or a
1625 string displayed via the `display' property,
1626 consider `local-map' and `keymap' properties of
1629 if (CONSP (string
) && STRINGP (XCAR (string
)))
1631 Lisp_Object pos
, map
;
1633 pos
= XCDR (string
);
1634 string
= XCAR (string
);
1637 && XINT (pos
) < SCHARS (string
))
1639 map
= Fget_text_property (pos
, Qlocal_map
, string
);
1643 map
= Fget_text_property (pos
, Qkeymap
, string
);
1651 if (!NILP (local_map
))
1652 keymaps
= Fcons (local_map
, keymaps
);
1654 /* Now put all the minor mode keymaps on the list. */
1655 nmaps
= current_minor_maps (0, &maps
);
1657 for (i
= --nmaps
; i
>= 0; i
--)
1658 if (!NILP (maps
[i
]))
1659 keymaps
= Fcons (maps
[i
], keymaps
);
1662 keymaps
= Fcons (keymap
, keymaps
);
1665 unbind_to (count
, Qnil
);
1670 /* GC is possible in this function if it autoloads a keymap. */
1672 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 4, 0,
1673 doc
: /* Return the binding for command KEY in current keymaps.
1674 KEY is a string or vector, a sequence of keystrokes.
1675 The binding is probably a symbol with a function definition.
1677 Normally, `key-binding' ignores bindings for t, which act as default
1678 bindings, used when nothing else in the keymap applies; this makes it
1679 usable as a general function for probing keymaps. However, if the
1680 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1681 recognize the default bindings, just as `read-key-sequence' does.
1683 Like the normal command loop, `key-binding' will remap the command
1684 resulting from looking up KEY by looking up the command in the
1685 current keymaps. However, if the optional third argument NO-REMAP
1686 is non-nil, `key-binding' returns the unmapped command.
1688 If KEY is a key sequence initiated with the mouse, the used keymaps
1689 will depend on the clicked mouse position with regard to the buffer
1690 and possible local keymaps on strings.
1692 If the optional argument POSITION is non-nil, it specifies a mouse
1693 position as returned by `event-start' and `event-end', and the lookup
1694 occurs in the keymaps associated with it instead of KEY. It can also
1695 be a number or marker, in which case the keymap properties at the
1696 specified buffer position instead of point are used.
1698 (Lisp_Object key
, Lisp_Object accept_default
, Lisp_Object no_remap
, Lisp_Object position
)
1702 if (NILP (position
) && VECTORP (key
))
1705 /* mouse events may have a symbolic prefix indicating the
1706 scrollbar or mode line */
1707 = AREF (key
, SYMBOLP (AREF (key
, 0)) && ASIZE (key
) > 1 ? 1 : 0);
1709 /* We are not interested in locations without event data */
1711 if (EVENT_HAS_PARAMETERS (event
) && CONSP (XCDR (event
)))
1713 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (event
));
1714 if (EQ (kind
, Qmouse_click
))
1715 position
= EVENT_START (event
);
1719 value
= Flookup_key (Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
)),
1720 key
, accept_default
);
1722 if (NILP (value
) || INTEGERP (value
))
1725 /* If the result of the ordinary keymap lookup is an interactive
1726 command, look for a key binding (ie. remapping) for that command. */
1728 if (NILP (no_remap
) && SYMBOLP (value
))
1731 if (value1
= Fcommand_remapping (value
, position
, Qnil
), !NILP (value1
))
1738 /* GC is possible in this function if it autoloads a keymap. */
1740 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1741 doc
: /* Return the binding for command KEYS in current local keymap only.
1742 KEYS is a string or vector, a sequence of keystrokes.
1743 The binding is probably a symbol with a function definition.
1745 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1746 bindings; see the description of `lookup-key' for more details about this. */)
1747 (Lisp_Object keys
, Lisp_Object accept_default
)
1749 register Lisp_Object map
;
1750 map
= BVAR (current_buffer
, keymap
);
1753 return Flookup_key (map
, keys
, accept_default
);
1756 /* GC is possible in this function if it autoloads a keymap. */
1758 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1759 doc
: /* Return the binding for command KEYS in current global keymap only.
1760 KEYS is a string or vector, a sequence of keystrokes.
1761 The binding is probably a symbol with a function definition.
1762 This function's return values are the same as those of `lookup-key'
1765 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1766 bindings; see the description of `lookup-key' for more details about this. */)
1767 (Lisp_Object keys
, Lisp_Object accept_default
)
1769 return Flookup_key (current_global_map
, keys
, accept_default
);
1772 /* GC is possible in this function if it autoloads a keymap. */
1774 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1775 doc
: /* Find the visible minor mode bindings of KEY.
1776 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1777 the symbol which names the minor mode binding KEY, and BINDING is
1778 KEY's definition in that mode. In particular, if KEY has no
1779 minor-mode bindings, return nil. If the first binding is a
1780 non-prefix, all subsequent bindings will be omitted, since they would
1781 be ignored. Similarly, the list doesn't include non-prefix bindings
1782 that come after prefix bindings.
1784 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1785 bindings; see the description of `lookup-key' for more details about this. */)
1786 (Lisp_Object key
, Lisp_Object accept_default
)
1788 Lisp_Object
*modes
, *maps
;
1790 Lisp_Object binding
;
1792 struct gcpro gcpro1
, gcpro2
;
1794 nmaps
= current_minor_maps (&modes
, &maps
);
1795 /* Note that all these maps are GCPRO'd
1796 in the places where we found them. */
1799 GCPRO2 (key
, binding
);
1801 for (i
= j
= 0; i
< nmaps
; i
++)
1803 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1804 && !INTEGERP (binding
))
1806 if (KEYMAPP (binding
))
1807 maps
[j
++] = Fcons (modes
[i
], binding
);
1809 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1813 return Flist (j
, maps
);
1816 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1817 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1818 A new sparse keymap is stored as COMMAND's function definition and its value.
1819 If a second optional argument MAPVAR is given, the map is stored as
1820 its value instead of as COMMAND's value; but COMMAND is still defined
1822 The third optional argument NAME, if given, supplies a menu name
1823 string for the map. This is required to use the keymap as a menu.
1824 This function returns COMMAND. */)
1825 (Lisp_Object command
, Lisp_Object mapvar
, Lisp_Object name
)
1828 map
= Fmake_sparse_keymap (name
);
1829 Ffset (command
, map
);
1833 Fset (command
, map
);
1837 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1838 doc
: /* Select KEYMAP as the global keymap. */)
1839 (Lisp_Object keymap
)
1841 keymap
= get_keymap (keymap
, 1, 1);
1842 current_global_map
= keymap
;
1847 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1848 doc
: /* Select KEYMAP as the local keymap.
1849 If KEYMAP is nil, that means no local keymap. */)
1850 (Lisp_Object keymap
)
1853 keymap
= get_keymap (keymap
, 1, 1);
1855 bset_keymap (current_buffer
, keymap
);
1860 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1861 doc
: /* Return current buffer's local keymap, or nil if it has none.
1862 Normally the local keymap is set by the major mode with `use-local-map'. */)
1865 return BVAR (current_buffer
, keymap
);
1868 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1869 doc
: /* Return the current global keymap. */)
1872 return current_global_map
;
1875 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1876 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1880 int nmaps
= current_minor_maps (0, &maps
);
1882 return Flist (nmaps
, maps
);
1885 /* Help functions for describing and documenting keymaps. */
1887 struct accessible_keymaps_data
{
1888 Lisp_Object maps
, tail
, thisseq
;
1889 /* Does the current sequence end in the meta-prefix-char? */
1894 accessible_keymaps_1 (Lisp_Object key
, Lisp_Object cmd
, Lisp_Object args
, void *data
)
1895 /* Use void* data to be compatible with map_keymap_function_t. */
1897 struct accessible_keymaps_data
*d
= data
; /* Cast! */
1898 Lisp_Object maps
= d
->maps
;
1899 Lisp_Object tail
= d
->tail
;
1900 Lisp_Object thisseq
= d
->thisseq
;
1901 int is_metized
= d
->is_metized
&& INTEGERP (key
);
1904 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1908 /* Look for and break cycles. */
1909 while (!NILP (tem
= Frassq (cmd
, maps
)))
1911 Lisp_Object prefix
= XCAR (tem
);
1912 ptrdiff_t lim
= XINT (Flength (XCAR (tem
)));
1913 if (lim
<= XINT (Flength (thisseq
)))
1914 { /* This keymap was already seen with a smaller prefix. */
1916 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1917 Faref (thisseq
, make_number (i
))))
1920 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1923 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1924 but maybe `cmd' occurs again further down in `maps', so keep
1926 maps
= XCDR (Fmemq (tem
, maps
));
1929 /* If the last key in thisseq is meta-prefix-char,
1930 turn it into a meta-ized keystroke. We know
1931 that the event we're about to append is an
1932 ascii keystroke since we're processing a
1936 int meta_bit
= meta_modifier
;
1937 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1938 tem
= Fcopy_sequence (thisseq
);
1940 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1942 /* This new sequence is the same length as
1943 thisseq, so stick it in the list right
1946 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1950 tem
= append_key (thisseq
, key
);
1951 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1955 /* This function cannot GC. */
1957 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1959 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1960 Returns a list of elements of the form (KEYS . MAP), where the sequence
1961 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1962 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1963 An optional argument PREFIX, if non-nil, should be a key sequence;
1964 then the value includes only maps for prefixes that start with PREFIX. */)
1965 (Lisp_Object keymap
, Lisp_Object prefix
)
1967 Lisp_Object maps
, tail
;
1968 EMACS_INT prefixlen
= XFASTINT (Flength (prefix
));
1970 /* no need for gcpro because we don't autoload any keymaps. */
1974 /* If a prefix was specified, start with the keymap (if any) for
1975 that prefix, so we don't waste time considering other prefixes. */
1977 tem
= Flookup_key (keymap
, prefix
, Qt
);
1978 /* Flookup_key may give us nil, or a number,
1979 if the prefix is not defined in this particular map.
1980 It might even give us a list that isn't a keymap. */
1981 tem
= get_keymap (tem
, 0, 0);
1982 /* If the keymap is autoloaded `tem' is not a cons-cell, but we still
1983 want to return it. */
1986 /* Convert PREFIX to a vector now, so that later on
1987 we don't have to deal with the possibility of a string. */
1988 if (STRINGP (prefix
))
1993 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1994 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1998 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1999 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2000 c
^= 0200 | meta_modifier
;
2001 ASET (copy
, i_before
, make_number (c
));
2005 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
2011 maps
= Fcons (Fcons (zero_vector
, get_keymap (keymap
, 1, 0)), Qnil
);
2013 /* For each map in the list maps,
2014 look at any other maps it points to,
2015 and stick them at the end if they are not already in the list.
2017 This is a breadth-first traversal, where tail is the queue of
2018 nodes, and maps accumulates a list of all nodes visited. */
2020 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
2022 struct accessible_keymaps_data data
;
2023 register Lisp_Object thismap
= Fcdr (XCAR (tail
));
2026 data
.thisseq
= Fcar (XCAR (tail
));
2029 last
= make_number (XINT (Flength (data
.thisseq
)) - 1);
2030 /* Does the current sequence end in the meta-prefix-char? */
2031 data
.is_metized
= (XINT (last
) >= 0
2032 /* Don't metize the last char of PREFIX. */
2033 && XINT (last
) >= prefixlen
2034 && EQ (Faref (data
.thisseq
, last
), meta_prefix_char
));
2036 /* Since we can't run lisp code, we can't scan autoloaded maps. */
2037 if (CONSP (thismap
))
2038 map_keymap (thismap
, accessible_keymaps_1
, Qnil
, &data
, 0);
2042 static Lisp_Object Qsingle_key_description
, Qkey_description
;
2044 /* This function cannot GC. */
2046 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2047 doc
: /* Return a pretty description of key-sequence KEYS.
2048 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2049 For example, [?\C-x ?l] is converted into the string \"C-x l\".
2051 The `kbd' macro is an approximate inverse of this. */)
2052 (Lisp_Object keys
, Lisp_Object prefix
)
2058 EMACS_INT size
= XINT (Flength (keys
));
2060 Lisp_Object sep
= build_string (" ");
2067 size
+= XINT (Flength (prefix
));
2069 /* This has one extra element at the end that we don't pass to Fconcat. */
2070 if (min (PTRDIFF_MAX
, SIZE_MAX
) / word_size
/ 4 < size
)
2071 memory_full (SIZE_MAX
);
2072 SAFE_ALLOCA_LISP (args
, size
* 4);
2074 /* In effect, this computes
2075 (mapconcat 'single-key-description keys " ")
2076 but we shouldn't use mapconcat because it can do GC. */
2080 list
= prefix
, prefix
= Qnil
;
2081 else if (!NILP (keys
))
2082 list
= keys
, keys
= Qnil
;
2087 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2088 result
= Fconcat (len
+ 1, args
);
2091 result
= empty_unibyte_string
;
2093 result
= Fconcat (len
- 1, args
);
2099 size
= SCHARS (list
);
2100 else if (VECTORP (list
))
2101 size
= ASIZE (list
);
2102 else if (CONSP (list
))
2103 size
= XINT (Flength (list
));
2105 wrong_type_argument (Qarrayp
, list
);
2114 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2115 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2116 c
^= 0200 | meta_modifier
;
2117 XSETFASTINT (key
, c
);
2119 else if (VECTORP (list
))
2121 key
= AREF (list
, i
); i
++;
2133 || EQ (key
, meta_prefix_char
)
2134 || (XINT (key
) & meta_modifier
))
2136 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2138 if (EQ (key
, meta_prefix_char
))
2142 XSETINT (key
, XINT (key
) | meta_modifier
);
2145 else if (EQ (key
, meta_prefix_char
))
2150 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2158 push_key_description (EMACS_INT ch
, char *p
, int force_multibyte
)
2162 /* Clear all the meaningless bits above the meta bit. */
2163 c
= ch
& (meta_modifier
| ~ - meta_modifier
);
2164 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2165 | meta_modifier
| shift_modifier
| super_modifier
);
2167 if (! CHARACTERP (make_number (c2
)))
2169 /* KEY_DESCRIPTION_SIZE is large enough for this. */
2170 p
+= sprintf (p
, "[%d]", c
);
2174 if (c
& alt_modifier
)
2180 if ((c
& ctrl_modifier
) != 0
2181 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2185 c
&= ~ctrl_modifier
;
2187 if (c
& hyper_modifier
)
2191 c
-= hyper_modifier
;
2193 if (c
& meta_modifier
)
2199 if (c
& shift_modifier
)
2203 c
-= shift_modifier
;
2205 if (c
& super_modifier
)
2209 c
-= super_modifier
;
2225 else if (c
== Ctl ('M'))
2233 /* `C-' already added above. */
2234 if (c
> 0 && c
<= Ctl ('Z'))
2253 || (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
2254 && SINGLE_BYTE_CHAR_P (c
)
2255 && !force_multibyte
))
2261 /* Now we are sure that C is a valid character code. */
2262 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
2263 && ! force_multibyte
)
2264 *p
++ = multibyte_char_to_unibyte (c
);
2266 p
+= CHAR_STRING (c
, (unsigned char *) p
);
2272 /* This function cannot GC. */
2274 DEFUN ("single-key-description", Fsingle_key_description
,
2275 Ssingle_key_description
, 1, 2, 0,
2276 doc
: /* Return a pretty description of command character KEY.
2277 Control characters turn into C-whatever, etc.
2278 Optional argument NO-ANGLES non-nil means don't put angle brackets
2279 around function keys and event symbols. */)
2280 (Lisp_Object key
, Lisp_Object no_angles
)
2282 if (CONSP (key
) && lucid_event_type_list_p (key
))
2283 key
= Fevent_convert_list (key
);
2285 if (CONSP (key
) && INTEGERP (XCAR (key
)) && INTEGERP (XCDR (key
)))
2286 /* An interval from a map-char-table. */
2287 return concat3 (Fsingle_key_description (XCAR (key
), no_angles
),
2288 build_string (".."),
2289 Fsingle_key_description (XCDR (key
), no_angles
));
2291 key
= EVENT_HEAD (key
);
2293 if (INTEGERP (key
)) /* Normal character. */
2295 char tem
[KEY_DESCRIPTION_SIZE
], *p
;
2297 p
= push_key_description (XINT (key
), tem
, 1);
2299 return make_specified_string (tem
, -1, p
- tem
, 1);
2301 else if (SYMBOLP (key
)) /* Function key or event-symbol. */
2303 if (NILP (no_angles
))
2307 char *buffer
= SAFE_ALLOCA (sizeof "<>"
2308 + SBYTES (SYMBOL_NAME (key
)));
2309 esprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2310 result
= build_string (buffer
);
2315 return Fsymbol_name (key
);
2317 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2318 return Fcopy_sequence (key
);
2320 error ("KEY must be an integer, cons, symbol, or string");
2325 push_text_char_description (register unsigned int c
, register char *p
)
2336 *p
++ = c
+ 64; /* 'A' - 1 */
2348 /* This function cannot GC. */
2350 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2351 doc
: /* Return a pretty description of file-character CHARACTER.
2352 Control characters turn into "^char", etc. This differs from
2353 `single-key-description' which turns them into "C-char".
2354 Also, this function recognizes the 2**7 bit as the Meta character,
2355 whereas `single-key-description' uses the 2**27 bit for Meta.
2356 See Info node `(elisp)Describing Characters' for examples. */)
2357 (Lisp_Object character
)
2359 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2363 CHECK_CHARACTER (character
);
2365 c
= XINT (character
);
2366 if (!ASCII_CHAR_P (c
))
2368 int len
= CHAR_STRING (c
, (unsigned char *) str
);
2370 return make_multibyte_string (str
, 1, len
);
2373 *push_text_char_description (c
& 0377, str
) = 0;
2375 return build_string (str
);
2378 static int where_is_preferred_modifier
;
2380 /* Return 0 if SEQ uses non-preferred modifiers or non-char events.
2381 Else, return 2 if SEQ uses the where_is_preferred_modifier,
2384 preferred_sequence_p (Lisp_Object seq
)
2387 EMACS_INT len
= XFASTINT (Flength (seq
));
2390 for (i
= 0; i
< len
; i
++)
2392 Lisp_Object ii
, elt
;
2394 XSETFASTINT (ii
, i
);
2395 elt
= Faref (seq
, ii
);
2397 if (!INTEGERP (elt
))
2401 int modifiers
= XINT (elt
) & (CHAR_MODIFIER_MASK
& ~CHAR_META
);
2402 if (modifiers
== where_is_preferred_modifier
)
2413 /* where-is - finding a command in a set of keymaps. */
2415 static void where_is_internal_1 (Lisp_Object key
, Lisp_Object binding
,
2416 Lisp_Object args
, void *data
);
2418 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2419 Returns the first non-nil binding found in any of those maps.
2420 If REMAP is true, pass the result of the lookup through command
2421 remapping before returning it. */
2424 shadow_lookup (Lisp_Object shadow
, Lisp_Object key
, Lisp_Object flag
,
2427 Lisp_Object tail
, value
;
2429 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2431 value
= Flookup_key (XCAR (tail
), key
, flag
);
2432 if (NATNUMP (value
))
2434 value
= Flookup_key (XCAR (tail
),
2435 Fsubstring (key
, make_number (0), value
), flag
);
2439 else if (!NILP (value
))
2441 Lisp_Object remapping
;
2442 if (remap
&& SYMBOLP (value
)
2443 && (remapping
= Fcommand_remapping (value
, Qnil
, shadow
),
2453 static Lisp_Object Vmouse_events
;
2455 struct where_is_internal_data
{
2456 Lisp_Object definition
, this, last
;
2457 int last_is_meta
, noindirect
;
2458 Lisp_Object sequences
;
2461 /* This function can't GC, AFAIK. */
2462 /* Return the list of bindings found. This list is ordered "longest
2463 to shortest". It may include bindings that are actually shadowed
2464 by others, as well as duplicate bindings and remapping bindings.
2465 The list returned is potentially shared with where_is_cache, so
2466 be careful not to modify it via side-effects. */
2469 where_is_internal (Lisp_Object definition
, Lisp_Object keymaps
,
2470 int noindirect
, int nomenus
)
2472 Lisp_Object maps
= Qnil
;
2474 struct where_is_internal_data data
;
2476 /* Only important use of caching is for the menubar
2477 (i.e. where-is-internal called with (def nil t nil nil)). */
2478 if (nomenus
&& !noindirect
)
2480 /* Check heuristic-consistency of the cache. */
2481 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2482 where_is_cache
= Qnil
;
2484 if (NILP (where_is_cache
))
2486 /* We need to create the cache. */
2487 Lisp_Object args
[2];
2488 where_is_cache
= Fmake_hash_table (0, args
);
2489 where_is_cache_keymaps
= Qt
;
2492 /* We can reuse the cache. */
2493 return Fgethash (definition
, where_is_cache
, Qnil
);
2496 /* Kill the cache so that where_is_internal_1 doesn't think
2497 we're filling it up. */
2498 where_is_cache
= Qnil
;
2501 while (CONSP (found
))
2505 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2506 found
= XCDR (found
);
2509 data
.sequences
= Qnil
;
2510 for (; CONSP (maps
); maps
= XCDR (maps
))
2512 /* Key sequence to reach map, and the map that it reaches */
2513 register Lisp_Object
this, map
, tem
;
2515 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2516 [M-CHAR] sequences, check if last character of the sequence
2517 is the meta-prefix char. */
2521 this = Fcar (XCAR (maps
));
2522 map
= Fcdr (XCAR (maps
));
2523 last
= make_number (XINT (Flength (this)) - 1);
2524 last_is_meta
= (XINT (last
) >= 0
2525 && EQ (Faref (this, last
), meta_prefix_char
));
2527 /* if (nomenus && !preferred_sequence_p (this)) */
2528 if (nomenus
&& XINT (last
) >= 0
2529 && SYMBOLP (tem
= Faref (this, make_number (0)))
2530 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2531 /* If no menu entries should be returned, skip over the
2532 keymaps bound to `menu-bar' and `tool-bar' and other
2533 non-ascii prefixes like `C-down-mouse-2'. */
2538 data
.definition
= definition
;
2539 data
.noindirect
= noindirect
;
2542 data
.last_is_meta
= last_is_meta
;
2545 map_keymap (map
, where_is_internal_1
, Qnil
, &data
, 0);
2548 if (nomenus
&& !noindirect
)
2549 { /* Remember for which keymaps this cache was built.
2550 We do it here (late) because we want to keep where_is_cache_keymaps
2551 set to t while the cache isn't fully filled. */
2552 where_is_cache_keymaps
= keymaps
;
2553 /* During cache-filling, data.sequences is not filled by
2554 where_is_internal_1. */
2555 return Fgethash (definition
, where_is_cache
, Qnil
);
2558 return data
.sequences
;
2561 /* This function can GC if Flookup_key autoloads any keymaps. */
2563 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2564 doc
: /* Return list of keys that invoke DEFINITION.
2565 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2566 If KEYMAP is nil, search all the currently active keymaps, except
2567 for `overriding-local-map' (which is ignored).
2568 If KEYMAP is a list of keymaps, search only those keymaps.
2570 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2571 rather than a list of all possible key sequences.
2572 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2573 no matter what it is.
2574 If FIRSTONLY has another non-nil value, prefer bindings
2575 that use the modifier key specified in `where-is-preferred-modifier'
2576 \(or their meta variants) and entirely reject menu bindings.
2578 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2579 to other keymaps or slots. This makes it possible to search for an
2580 indirect definition itself.
2582 The optional 5th arg NO-REMAP alters how command remapping is handled:
2584 - If another command OTHER-COMMAND is remapped to DEFINITION, normally
2585 search for the bindings of OTHER-COMMAND and include them in the
2586 returned list. But if NO-REMAP is non-nil, include the vector
2587 [remap OTHER-COMMAND] in the returned list instead, without
2588 searching for those other bindings.
2590 - If DEFINITION is remapped to OTHER-COMMAND, normally return the
2591 bindings for OTHER-COMMAND. But if NO-REMAP is non-nil, return the
2592 bindings for DEFINITION instead, ignoring its remapping. */)
2593 (Lisp_Object definition
, Lisp_Object keymap
, Lisp_Object firstonly
, Lisp_Object noindirect
, Lisp_Object no_remap
)
2595 /* The keymaps in which to search. */
2596 Lisp_Object keymaps
;
2597 /* Potentially relevant bindings in "shortest to longest" order. */
2598 Lisp_Object sequences
= Qnil
;
2599 /* Actually relevant bindings. */
2600 Lisp_Object found
= Qnil
;
2601 /* 1 means ignore all menu bindings entirely. */
2602 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2603 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
, gcpro6
;
2604 /* List of sequences found via remapping. Keep them in a separate
2605 variable, so as to push them later, since we prefer
2606 non-remapped binding. */
2607 Lisp_Object remapped_sequences
= Qnil
;
2608 /* Whether or not we're handling remapped sequences. This is needed
2609 because remapping is not done recursively by Fcommand_remapping: you
2610 can't remap a remapped command. */
2612 Lisp_Object tem
= Qnil
;
2614 /* Refresh the C version of the modifier preference. */
2615 where_is_preferred_modifier
2616 = parse_solitary_modifier (Vwhere_is_preferred_modifier
);
2618 /* Find the relevant keymaps. */
2619 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2621 else if (!NILP (keymap
))
2622 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2624 keymaps
= Fcurrent_active_maps (Qnil
, Qnil
);
2626 GCPRO6 (definition
, keymaps
, found
, sequences
, remapped_sequences
, tem
);
2628 tem
= Fcommand_remapping (definition
, Qnil
, keymaps
);
2629 /* If `definition' is remapped to tem', then OT1H no key will run
2630 that command (since they will run `tem' instead), so we should
2631 return nil; but OTOH all keys bound to `definition' (or to `tem')
2632 will run the same command.
2633 So for menu-shortcut purposes, we want to find all the keys bound (maybe
2634 via remapping) to `tem'. But for the purpose of finding the keys that
2635 run `definition', then we'd want to just return nil.
2636 We choose to make it work right for menu-shortcuts, since it's the most
2638 Known bugs: if you remap switch-to-buffer to toto, C-h f switch-to-buffer
2639 will tell you that switch-to-buffer is bound to C-x b even though C-x b
2640 will run toto instead. And if `toto' is itself remapped to forward-char,
2641 then C-h f toto will tell you that it's bound to C-f even though C-f does
2642 not run toto and it won't tell you that C-x b does run toto. */
2643 if (NILP (no_remap
) && !NILP (tem
))
2646 if (SYMBOLP (definition
)
2647 && !NILP (firstonly
)
2648 && !NILP (tem
= Fget (definition
, QCadvertised_binding
)))
2650 /* We have a list of advertised bindings. */
2652 if (EQ (shadow_lookup (keymaps
, XCAR (tem
), Qnil
, 0), definition
))
2653 RETURN_UNGCPRO (XCAR (tem
));
2656 if (EQ (shadow_lookup (keymaps
, tem
, Qnil
, 0), definition
))
2657 RETURN_UNGCPRO (tem
);
2660 sequences
= Freverse (where_is_internal (definition
, keymaps
,
2661 !NILP (noindirect
), nomenus
));
2663 while (CONSP (sequences
)
2664 /* If we're at the end of the `sequences' list and we haven't
2665 considered remapped sequences yet, copy them over and
2667 || (!remapped
&& (sequences
= remapped_sequences
,
2669 CONSP (sequences
))))
2671 Lisp_Object sequence
, function
;
2673 sequence
= XCAR (sequences
);
2674 sequences
= XCDR (sequences
);
2676 /* Verify that this key binding is not shadowed by another
2677 binding for the same key, before we say it exists.
2679 Mechanism: look for local definition of this key and if
2680 it is defined and does not match what we found then
2683 Either nil or number as value from Flookup_key
2685 if (NILP (Fequal (shadow_lookup (keymaps
, sequence
, Qnil
, remapped
),
2689 /* If the current sequence is a command remapping with
2690 format [remap COMMAND], find the key sequences
2691 which run COMMAND, and use those sequences instead. */
2692 if (NILP (no_remap
) && !remapped
2693 && VECTORP (sequence
) && ASIZE (sequence
) == 2
2694 && EQ (AREF (sequence
, 0), Qremap
)
2695 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2697 Lisp_Object seqs
= where_is_internal (function
, keymaps
,
2698 !NILP (noindirect
), nomenus
);
2699 remapped_sequences
= nconc2 (Freverse (seqs
), remapped_sequences
);
2703 /* Don't annoy user with strings from a menu such as the
2704 entries from the "Edit => Paste from Kill Menu".
2705 Change them all to "(any string)", so that there
2706 seems to be only one menu item to report. */
2707 if (! NILP (sequence
))
2710 tem1
= Faref (sequence
, make_number (ASIZE (sequence
) - 1));
2712 Faset (sequence
, make_number (ASIZE (sequence
) - 1),
2713 build_string ("(any string)"));
2716 /* It is a true unshadowed match. Record it, unless it's already
2717 been seen (as could happen when inheriting keymaps). */
2718 if (NILP (Fmember (sequence
, found
)))
2719 found
= Fcons (sequence
, found
);
2721 /* If firstonly is Qnon_ascii, then we can return the first
2722 binding we find. If firstonly is not Qnon_ascii but not
2723 nil, then we should return the first ascii-only binding
2725 if (EQ (firstonly
, Qnon_ascii
))
2726 RETURN_UNGCPRO (sequence
);
2727 else if (!NILP (firstonly
)
2728 && 2 == preferred_sequence_p (sequence
))
2729 RETURN_UNGCPRO (sequence
);
2734 found
= Fnreverse (found
);
2736 /* firstonly may have been t, but we may have gone all the way through
2737 the keymaps without finding an all-ASCII key sequence. So just
2738 return the best we could find. */
2739 if (NILP (firstonly
))
2741 else if (where_is_preferred_modifier
== 0)
2742 return Fcar (found
);
2744 { /* Maybe we did not find a preferred_modifier binding, but we did find
2745 some ASCII binding. */
2746 Lisp_Object bindings
= found
;
2747 while (CONSP (bindings
))
2748 if (preferred_sequence_p (XCAR (bindings
)))
2749 return XCAR (bindings
);
2751 bindings
= XCDR (bindings
);
2752 return Fcar (found
);
2756 /* This function can GC because get_keyelt can. */
2759 where_is_internal_1 (Lisp_Object key
, Lisp_Object binding
, Lisp_Object args
, void *data
)
2761 struct where_is_internal_data
*d
= data
; /* Cast! */
2762 Lisp_Object definition
= d
->definition
;
2763 int noindirect
= d
->noindirect
;
2764 Lisp_Object
this = d
->this;
2765 Lisp_Object last
= d
->last
;
2766 int last_is_meta
= d
->last_is_meta
;
2767 Lisp_Object sequence
;
2769 /* Search through indirections unless that's not wanted. */
2771 binding
= get_keyelt (binding
, 0);
2773 /* End this iteration if this element does not match
2776 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2777 || EQ (binding
, definition
)
2778 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2779 /* Doesn't match. */
2782 /* We have found a match. Construct the key sequence where we found it. */
2783 if (INTEGERP (key
) && last_is_meta
)
2785 sequence
= Fcopy_sequence (this);
2786 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2791 key
= Fcons (XCAR (key
), XCDR (key
));
2792 sequence
= append_key (this, key
);
2795 if (!NILP (where_is_cache
))
2797 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2798 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2801 d
->sequences
= Fcons (sequence
, d
->sequences
);
2804 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2806 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2807 doc
: /* Insert the list of all defined keys and their definitions.
2808 The list is inserted in the current buffer, while the bindings are
2809 looked up in BUFFER.
2810 The optional argument PREFIX, if non-nil, should be a key sequence;
2811 then we display only bindings that start with that prefix.
2812 The optional argument MENUS, if non-nil, says to mention menu bindings.
2813 \(Ordinarily these are omitted from the output.) */)
2814 (Lisp_Object buffer
, Lisp_Object prefix
, Lisp_Object menus
)
2816 Lisp_Object outbuf
, shadow
;
2817 int nomenu
= NILP (menus
);
2818 register Lisp_Object start1
;
2819 struct gcpro gcpro1
;
2821 const char *alternate_heading
2823 Keyboard translations:\n\n\
2824 You type Translation\n\
2825 -------- -----------\n";
2827 CHECK_BUFFER (buffer
);
2832 outbuf
= Fcurrent_buffer ();
2834 /* Report on alternates for keys. */
2835 if (STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
)) && !NILP (prefix
))
2838 const unsigned char *translate
= SDATA (KVAR (current_kboard
, Vkeyboard_translate_table
));
2839 int translate_len
= SCHARS (KVAR (current_kboard
, Vkeyboard_translate_table
));
2841 for (c
= 0; c
< translate_len
; c
++)
2842 if (translate
[c
] != c
)
2844 char buf
[KEY_DESCRIPTION_SIZE
];
2847 if (alternate_heading
)
2849 insert_string (alternate_heading
);
2850 alternate_heading
= 0;
2853 bufend
= push_key_description (translate
[c
], buf
, 1);
2854 insert (buf
, bufend
- buf
);
2855 Findent_to (make_number (16), make_number (1));
2856 bufend
= push_key_description (c
, buf
, 1);
2857 insert (buf
, bufend
- buf
);
2861 /* Insert calls signal_after_change which may GC. */
2862 translate
= SDATA (KVAR (current_kboard
, Vkeyboard_translate_table
));
2868 if (!NILP (Vkey_translation_map
))
2869 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2870 "Key translations", nomenu
, 1, 0, 0);
2873 /* Print the (major mode) local map. */
2875 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
2876 start1
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
2877 else if (!NILP (Voverriding_local_map
))
2878 start1
= Voverriding_local_map
;
2882 describe_map_tree (start1
, 1, shadow
, prefix
,
2883 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2884 shadow
= Fcons (start1
, shadow
);
2888 /* Print the minor mode and major mode keymaps. */
2890 Lisp_Object
*modes
, *maps
;
2892 /* Temporarily switch to `buffer', so that we can get that buffer's
2893 minor modes correctly. */
2894 Fset_buffer (buffer
);
2896 nmaps
= current_minor_maps (&modes
, &maps
);
2897 Fset_buffer (outbuf
);
2899 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2900 XBUFFER (buffer
), Qkeymap
);
2903 describe_map_tree (start1
, 1, shadow
, prefix
,
2904 "\f\n`keymap' Property Bindings", nomenu
,
2906 shadow
= Fcons (start1
, shadow
);
2909 /* Print the minor mode maps. */
2910 for (i
= 0; i
< nmaps
; i
++)
2912 /* The title for a minor mode keymap
2913 is constructed at run time.
2914 We let describe_map_tree do the actual insertion
2915 because it takes care of other features when doing so. */
2918 if (!SYMBOLP (modes
[i
]))
2921 p
= title
= alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2925 memcpy (p
, SDATA (SYMBOL_NAME (modes
[i
])),
2926 SCHARS (SYMBOL_NAME (modes
[i
])));
2927 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2929 memcpy (p
, " Minor Mode Bindings", strlen (" Minor Mode Bindings"));
2930 p
+= strlen (" Minor Mode Bindings");
2933 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2934 title
, nomenu
, 0, 0, 0);
2935 shadow
= Fcons (maps
[i
], shadow
);
2938 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2939 XBUFFER (buffer
), Qlocal_map
);
2942 if (EQ (start1
, BVAR (XBUFFER (buffer
), keymap
)))
2943 describe_map_tree (start1
, 1, shadow
, prefix
,
2944 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2946 describe_map_tree (start1
, 1, shadow
, prefix
,
2947 "\f\n`local-map' Property Bindings",
2950 shadow
= Fcons (start1
, shadow
);
2954 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2955 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2957 /* Print the function-key-map translations under this prefix. */
2958 if (!NILP (KVAR (current_kboard
, Vlocal_function_key_map
)))
2959 describe_map_tree (KVAR (current_kboard
, Vlocal_function_key_map
), 0, Qnil
, prefix
,
2960 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2962 /* Print the input-decode-map translations under this prefix. */
2963 if (!NILP (KVAR (current_kboard
, Vinput_decode_map
)))
2964 describe_map_tree (KVAR (current_kboard
, Vinput_decode_map
), 0, Qnil
, prefix
,
2965 "\f\nInput decoding map translations", nomenu
, 1, 0, 0);
2971 /* Insert a description of the key bindings in STARTMAP,
2972 followed by those of all maps reachable through STARTMAP.
2973 If PARTIAL is nonzero, omit certain "uninteresting" commands
2974 (such as `undefined').
2975 If SHADOW is non-nil, it is a list of maps;
2976 don't mention keys which would be shadowed by any of them.
2977 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2978 TITLE, if not 0, is a string to insert at the beginning.
2979 TITLE should not end with a colon or a newline; we supply that.
2980 If NOMENU is not 0, then omit menu-bar commands.
2982 If TRANSL is nonzero, the definitions are actually key translations
2983 so print strings and vectors differently.
2985 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2988 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
2989 don't omit it; instead, mention it but say it is shadowed.
2991 Any inserted text ends in two newlines (used by `help-make-xrefs'). */
2994 describe_map_tree (Lisp_Object startmap
, int partial
, Lisp_Object shadow
,
2995 Lisp_Object prefix
, const char *title
, int nomenu
, int transl
,
2996 int always_title
, int mention_shadow
)
2998 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2999 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3001 const char *key_heading
3006 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3009 GCPRO3 (maps
, seen
, sub_shadows
);
3015 /* Delete from MAPS each element that is for the menu bar. */
3016 for (list
= maps
; CONSP (list
); list
= XCDR (list
))
3018 Lisp_Object elt
, elt_prefix
, tem
;
3021 elt_prefix
= Fcar (elt
);
3022 if (ASIZE (elt_prefix
) >= 1)
3024 tem
= Faref (elt_prefix
, make_number (0));
3025 if (EQ (tem
, Qmenu_bar
))
3026 maps
= Fdelq (elt
, maps
);
3031 if (!NILP (maps
) || always_title
)
3035 insert_string (title
);
3038 insert_string (" Starting With ");
3039 insert1 (Fkey_description (prefix
, Qnil
));
3041 insert_string (":\n");
3043 insert_string (key_heading
);
3047 for (; CONSP (maps
); maps
= XCDR (maps
))
3049 register Lisp_Object elt
, elt_prefix
, tail
;
3052 elt_prefix
= Fcar (elt
);
3056 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3060 shmap
= XCAR (tail
);
3062 /* If the sequence by which we reach this keymap is zero-length,
3063 then the shadow map for this keymap is just SHADOW. */
3064 if ((STRINGP (elt_prefix
) && SCHARS (elt_prefix
) == 0)
3065 || (VECTORP (elt_prefix
) && ASIZE (elt_prefix
) == 0))
3067 /* If the sequence by which we reach this keymap actually has
3068 some elements, then the sequence's definition in SHADOW is
3069 what we should use. */
3072 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3073 if (INTEGERP (shmap
))
3077 /* If shmap is not nil and not a keymap,
3078 it completely shadows this map, so don't
3079 describe this map at all. */
3080 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3084 sub_shadows
= Fcons (shmap
, sub_shadows
);
3087 /* Maps we have already listed in this loop shadow this map. */
3088 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3091 tem
= Fequal (Fcar (XCAR (tail
)), elt_prefix
);
3093 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3096 describe_map (Fcdr (elt
), elt_prefix
,
3097 transl
? describe_translation
: describe_command
,
3098 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3104 insert_string ("\n");
3109 static int previous_description_column
;
3112 describe_command (Lisp_Object definition
, Lisp_Object args
)
3114 register Lisp_Object tem1
;
3115 ptrdiff_t column
= current_column ();
3116 int description_column
;
3118 /* If column 16 is no good, go to col 32;
3119 but don't push beyond that--go to next line instead. */
3123 description_column
= 32;
3125 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3126 description_column
= 32;
3128 description_column
= 16;
3130 Findent_to (make_number (description_column
), make_number (1));
3131 previous_description_column
= description_column
;
3133 if (SYMBOLP (definition
))
3135 tem1
= SYMBOL_NAME (definition
);
3137 insert_string ("\n");
3139 else if (STRINGP (definition
) || VECTORP (definition
))
3140 insert_string ("Keyboard Macro\n");
3141 else if (KEYMAPP (definition
))
3142 insert_string ("Prefix Command\n");
3144 insert_string ("??\n");
3148 describe_translation (Lisp_Object definition
, Lisp_Object args
)
3150 register Lisp_Object tem1
;
3152 Findent_to (make_number (16), make_number (1));
3154 if (SYMBOLP (definition
))
3156 tem1
= SYMBOL_NAME (definition
);
3158 insert_string ("\n");
3160 else if (STRINGP (definition
) || VECTORP (definition
))
3162 insert1 (Fkey_description (definition
, Qnil
));
3163 insert_string ("\n");
3165 else if (KEYMAPP (definition
))
3166 insert_string ("Prefix Command\n");
3168 insert_string ("??\n");
3171 /* describe_map puts all the usable elements of a sparse keymap
3172 into an array of `struct describe_map_elt',
3173 then sorts them by the events. */
3175 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3177 /* qsort comparison function for sorting `struct describe_map_elt' by
3181 describe_map_compare (const void *aa
, const void *bb
)
3183 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3184 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3185 return ((XINT (a
->event
) > XINT (b
->event
))
3186 - (XINT (a
->event
) < XINT (b
->event
)));
3187 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3189 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3191 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3192 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3193 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3198 /* Describe the contents of map MAP, assuming that this map itself is
3199 reached by the sequence of prefix keys PREFIX (a string or vector).
3200 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3203 describe_map (Lisp_Object map
, Lisp_Object prefix
,
3204 void (*elt_describer
) (Lisp_Object
, Lisp_Object
),
3205 int partial
, Lisp_Object shadow
,
3206 Lisp_Object
*seen
, int nomenu
, int mention_shadow
)
3208 Lisp_Object tail
, definition
, event
;
3210 Lisp_Object suppress
;
3213 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3215 /* These accumulate the values from sparse keymap bindings,
3216 so we can sort them and handle them in order. */
3217 int length_needed
= 0;
3218 struct describe_map_elt
*vect
;
3225 suppress
= intern ("suppress-keymap");
3227 /* This vector gets used to present single keys to Flookup_key. Since
3228 that is done once per keymap element, we don't want to cons up a
3229 fresh vector every time. */
3230 kludge
= Fmake_vector (make_number (1), Qnil
);
3233 GCPRO3 (prefix
, definition
, kludge
);
3235 map
= call1 (Qkeymap_canonicalize
, map
);
3237 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3240 vect
= ((struct describe_map_elt
*)
3241 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3243 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3247 if (VECTORP (XCAR (tail
))
3248 || CHAR_TABLE_P (XCAR (tail
)))
3249 describe_vector (XCAR (tail
),
3250 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3252 else if (CONSP (XCAR (tail
)))
3254 int this_shadowed
= 0;
3256 event
= XCAR (XCAR (tail
));
3258 /* Ignore bindings whose "prefix" are not really valid events.
3259 (We get these in the frames and buffers menu.) */
3260 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3263 if (nomenu
&& EQ (event
, Qmenu_bar
))
3266 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3268 /* Don't show undefined commands or suppressed commands. */
3269 if (NILP (definition
)) continue;
3270 if (SYMBOLP (definition
) && partial
)
3272 tem
= Fget (definition
, suppress
);
3277 /* Don't show a command that isn't really visible
3278 because a local definition of the same key shadows it. */
3280 ASET (kludge
, 0, event
);
3283 tem
= shadow_lookup (shadow
, kludge
, Qt
, 0);
3286 /* If both bindings are keymaps, this key is a prefix key,
3287 so don't say it is shadowed. */
3288 if (KEYMAPP (definition
) && KEYMAPP (tem
))
3290 /* Avoid generating duplicate entries if the
3291 shadowed binding has the same definition. */
3292 else if (mention_shadow
&& !EQ (tem
, definition
))
3299 tem
= Flookup_key (map
, kludge
, Qt
);
3300 if (!EQ (tem
, definition
)) continue;
3302 vect
[slots_used
].event
= event
;
3303 vect
[slots_used
].definition
= definition
;
3304 vect
[slots_used
].shadowed
= this_shadowed
;
3307 else if (EQ (XCAR (tail
), Qkeymap
))
3309 /* The same keymap might be in the structure twice, if we're
3310 using an inherited keymap. So skip anything we've already
3312 tem
= Fassq (tail
, *seen
);
3313 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3315 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3319 /* If we found some sparse map events, sort them. */
3321 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3322 describe_map_compare
);
3324 /* Now output them in sorted order. */
3326 for (i
= 0; i
< slots_used
; i
++)
3328 Lisp_Object start
, end
;
3332 previous_description_column
= 0;
3337 ASET (kludge
, 0, vect
[i
].event
);
3338 start
= vect
[i
].event
;
3341 definition
= vect
[i
].definition
;
3343 /* Find consecutive chars that are identically defined. */
3344 if (INTEGERP (vect
[i
].event
))
3346 while (i
+ 1 < slots_used
3347 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3348 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3349 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3351 end
= vect
[i
].event
;
3354 /* Now START .. END is the range to describe next. */
3356 /* Insert the string to describe the event START. */
3357 insert1 (Fkey_description (kludge
, prefix
));
3359 if (!EQ (start
, end
))
3363 ASET (kludge
, 0, end
);
3364 /* Insert the string to describe the character END. */
3365 insert1 (Fkey_description (kludge
, prefix
));
3368 /* Print a description of the definition of this character.
3369 elt_describer will take care of spacing out far enough
3370 for alignment purposes. */
3371 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3373 if (vect
[i
].shadowed
)
3376 insert_string ("\n (that binding is currently shadowed by another mode)");
3385 describe_vector_princ (Lisp_Object elt
, Lisp_Object fun
)
3387 Findent_to (make_number (16), make_number (1));
3392 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3393 doc
: /* Insert a description of contents of VECTOR.
3394 This is text showing the elements of vector matched against indices.
3395 DESCRIBER is the output function used; nil means use `princ'. */)
3396 (Lisp_Object vector
, Lisp_Object describer
)
3398 ptrdiff_t count
= SPECPDL_INDEX ();
3399 if (NILP (describer
))
3400 describer
= intern ("princ");
3401 specbind (Qstandard_output
, Fcurrent_buffer ());
3402 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3403 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3406 return unbind_to (count
, Qnil
);
3409 /* Insert in the current buffer a description of the contents of VECTOR.
3410 We call ELT_DESCRIBER to insert the description of one value found
3413 ELT_PREFIX describes what "comes before" the keys or indices defined
3414 by this vector. This is a human-readable string whose size
3415 is not necessarily related to the situation.
3417 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3418 leads to this keymap.
3420 If the vector is a chartable, ELT_PREFIX is the vector
3421 of bytes that lead to the character set or portion of a character
3422 set described by this chartable.
3424 If PARTIAL is nonzero, it means do not mention suppressed commands
3425 (that assumes the vector is in a keymap).
3427 SHADOW is a list of keymaps that shadow this map.
3428 If it is non-nil, then we look up the key in those maps
3429 and we don't mention it now if it is defined by any of them.
3431 ENTIRE_MAP is the keymap in which this vector appears.
3432 If the definition in effect in the whole map does not match
3433 the one in this vector, we ignore this one.
3435 ARGS is simply passed as the second argument to ELT_DESCRIBER.
3437 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3439 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3442 describe_vector (Lisp_Object vector
, Lisp_Object prefix
, Lisp_Object args
,
3443 void (*elt_describer
) (Lisp_Object
, Lisp_Object
),
3444 int partial
, Lisp_Object shadow
, Lisp_Object entire_map
,
3445 int keymap_p
, int mention_shadow
)
3447 Lisp_Object definition
;
3449 Lisp_Object elt_prefix
= Qnil
;
3451 Lisp_Object suppress
;
3454 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3455 /* Range of elements to be handled. */
3457 Lisp_Object character
;
3466 /* Call Fkey_description first, to avoid GC bug for the other string. */
3467 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3470 tem
= Fkey_description (prefix
, Qnil
);
3471 elt_prefix
= concat2 (tem
, build_string (" "));
3476 /* This vector gets used to present single keys to Flookup_key. Since
3477 that is done once per vector element, we don't want to cons up a
3478 fresh vector every time. */
3479 kludge
= Fmake_vector (make_number (1), Qnil
);
3480 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3483 suppress
= intern ("suppress-keymap");
3486 if (CHAR_TABLE_P (vector
))
3487 stop
= MAX_5_BYTE_CHAR
+ 1, to
= MAX_CHAR
+ 1;
3489 stop
= to
= ASIZE (vector
);
3491 for (i
= from
; ; i
++)
3493 int this_shadowed
= 0;
3494 int range_beg
, range_end
;
3508 if (CHAR_TABLE_P (vector
))
3512 val
= char_table_ref_and_range (vector
, range_beg
, &range_beg
, &i
);
3515 val
= AREF (vector
, i
);
3516 definition
= get_keyelt (val
, 0);
3518 if (NILP (definition
)) continue;
3520 /* Don't mention suppressed commands. */
3521 if (SYMBOLP (definition
) && partial
)
3525 tem
= Fget (definition
, suppress
);
3527 if (!NILP (tem
)) continue;
3530 character
= make_number (starting_i
);
3531 ASET (kludge
, 0, character
);
3533 /* If this binding is shadowed by some other map, ignore it. */
3538 tem
= shadow_lookup (shadow
, kludge
, Qt
, 0);
3549 /* Ignore this definition if it is shadowed by an earlier
3550 one in the same keymap. */
3551 if (!NILP (entire_map
))
3555 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3557 if (!EQ (tem
, definition
))
3567 /* Output the prefix that applies to every entry in this map. */
3568 if (!NILP (elt_prefix
))
3569 insert1 (elt_prefix
);
3571 insert1 (Fkey_description (kludge
, prefix
));
3573 /* Find all consecutive characters or rows that have the same
3574 definition. But, VECTOR is a char-table, we had better put a
3575 boundary between normal characters (-#x3FFF7F) and 8-bit
3576 characters (#x3FFF80-). */
3577 if (CHAR_TABLE_P (vector
))
3580 && (range_beg
= i
+ 1, range_end
= stop
- 1,
3581 val
= char_table_ref_and_range (vector
, range_beg
,
3582 &range_beg
, &range_end
),
3583 tem2
= get_keyelt (val
, 0),
3585 && !NILP (Fequal (tem2
, definition
)))
3590 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3592 && !NILP (Fequal (tem2
, definition
)))
3595 /* If we have a range of more than one character,
3596 print where the range reaches to. */
3598 if (i
!= starting_i
)
3602 ASET (kludge
, 0, make_number (i
));
3604 if (!NILP (elt_prefix
))
3605 insert1 (elt_prefix
);
3607 insert1 (Fkey_description (kludge
, prefix
));
3610 /* Print a description of the definition of this character.
3611 elt_describer will take care of spacing out far enough
3612 for alignment purposes. */
3613 (*elt_describer
) (definition
, args
);
3618 insert_string (" (binding currently shadowed)");
3623 if (CHAR_TABLE_P (vector
) && ! NILP (XCHAR_TABLE (vector
)->defalt
))
3625 if (!NILP (elt_prefix
))
3626 insert1 (elt_prefix
);
3627 insert ("default", 7);
3628 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3634 /* Apropos - finding all symbols whose names match a regexp. */
3635 static Lisp_Object apropos_predicate
;
3636 static Lisp_Object apropos_accumulate
;
3639 apropos_accum (Lisp_Object symbol
, Lisp_Object string
)
3641 register Lisp_Object tem
;
3643 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3644 if (!NILP (tem
) && !NILP (apropos_predicate
))
3645 tem
= call1 (apropos_predicate
, symbol
);
3647 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3650 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3651 doc
: /* Show all symbols whose names contain match for REGEXP.
3652 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3653 for each symbol and a symbol is mentioned only if that returns non-nil.
3654 Return list of symbols found. */)
3655 (Lisp_Object regexp
, Lisp_Object predicate
)
3658 CHECK_STRING (regexp
);
3659 apropos_predicate
= predicate
;
3660 apropos_accumulate
= Qnil
;
3661 map_obarray (Vobarray
, apropos_accum
, regexp
);
3662 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3663 apropos_accumulate
= Qnil
;
3664 apropos_predicate
= Qnil
;
3669 syms_of_keymap (void)
3671 DEFSYM (Qkeymap
, "keymap");
3672 staticpro (&apropos_predicate
);
3673 staticpro (&apropos_accumulate
);
3674 apropos_predicate
= Qnil
;
3675 apropos_accumulate
= Qnil
;
3677 DEFSYM (Qkeymap_canonicalize
, "keymap-canonicalize");
3679 /* Now we are ready to set up this property, so we can
3680 create char tables. */
3681 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3683 /* Initialize the keymaps standardly used.
3684 Each one is the value of a Lisp variable, and is also
3685 pointed to by a C variable */
3687 global_map
= Fmake_keymap (Qnil
);
3688 Fset (intern_c_string ("global-map"), global_map
);
3690 current_global_map
= global_map
;
3691 staticpro (&global_map
);
3692 staticpro (¤t_global_map
);
3694 meta_map
= Fmake_keymap (Qnil
);
3695 Fset (intern_c_string ("esc-map"), meta_map
);
3696 Ffset (intern_c_string ("ESC-prefix"), meta_map
);
3698 control_x_map
= Fmake_keymap (Qnil
);
3699 Fset (intern_c_string ("ctl-x-map"), control_x_map
);
3700 Ffset (intern_c_string ("Control-X-prefix"), control_x_map
);
3702 exclude_keys
= listn (CONSTYPE_PURE
, 5,
3703 pure_cons (build_pure_c_string ("DEL"), build_pure_c_string ("\\d")),
3704 pure_cons (build_pure_c_string ("TAB"), build_pure_c_string ("\\t")),
3705 pure_cons (build_pure_c_string ("RET"), build_pure_c_string ("\\r")),
3706 pure_cons (build_pure_c_string ("ESC"), build_pure_c_string ("\\e")),
3707 pure_cons (build_pure_c_string ("SPC"), build_pure_c_string (" ")));
3708 staticpro (&exclude_keys
);
3710 DEFVAR_LISP ("define-key-rebound-commands", Vdefine_key_rebound_commands
,
3711 doc
: /* List of commands given new key bindings recently.
3712 This is used for internal purposes during Emacs startup;
3713 don't alter it yourself. */);
3714 Vdefine_key_rebound_commands
= Qt
;
3716 DEFVAR_LISP ("minibuffer-local-map", Vminibuffer_local_map
,
3717 doc
: /* Default keymap to use when reading from the minibuffer. */);
3718 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3720 DEFVAR_LISP ("minibuffer-local-ns-map", Vminibuffer_local_ns_map
,
3721 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3722 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3723 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3726 DEFVAR_LISP ("minor-mode-map-alist", Vminor_mode_map_alist
,
3727 doc
: /* Alist of keymaps to use for minor modes.
3728 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3729 key sequences and look up bindings if VARIABLE's value is non-nil.
3730 If two active keymaps bind the same key, the keymap appearing earlier
3731 in the list takes precedence. */);
3732 Vminor_mode_map_alist
= Qnil
;
3734 DEFVAR_LISP ("minor-mode-overriding-map-alist", Vminor_mode_overriding_map_alist
,
3735 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3736 This variable is an alist just like `minor-mode-map-alist', and it is
3737 used the same way (and before `minor-mode-map-alist'); however,
3738 it is provided for major modes to bind locally. */);
3739 Vminor_mode_overriding_map_alist
= Qnil
;
3741 DEFVAR_LISP ("emulation-mode-map-alists", Vemulation_mode_map_alists
,
3742 doc
: /* List of keymap alists to use for emulations modes.
3743 It is intended for modes or packages using multiple minor-mode keymaps.
3744 Each element is a keymap alist just like `minor-mode-map-alist', or a
3745 symbol with a variable binding which is a keymap alist, and it is used
3746 the same way. The "active" keymaps in each alist are used before
3747 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3748 Vemulation_mode_map_alists
= Qnil
;
3750 DEFVAR_LISP ("where-is-preferred-modifier", Vwhere_is_preferred_modifier
,
3751 doc
: /* Preferred modifier key to use for `where-is'.
3752 When a single binding is requested, `where-is' will return one that
3753 uses this modifier key if possible. If nil, or if no such binding
3754 exists, bindings using keys without modifiers (or only with meta) will
3756 Vwhere_is_preferred_modifier
= Qnil
;
3757 where_is_preferred_modifier
= 0;
3759 staticpro (&Vmouse_events
);
3760 Vmouse_events
= listn (CONSTYPE_PURE
, 9,
3761 intern_c_string ("menu-bar"),
3762 intern_c_string ("tool-bar"),
3763 intern_c_string ("header-line"),
3764 intern_c_string ("mode-line"),
3765 intern_c_string ("mouse-1"),
3766 intern_c_string ("mouse-2"),
3767 intern_c_string ("mouse-3"),
3768 intern_c_string ("mouse-4"),
3769 intern_c_string ("mouse-5"));
3771 DEFSYM (Qsingle_key_description
, "single-key-description");
3772 DEFSYM (Qkey_description
, "key-description");
3773 DEFSYM (Qkeymapp
, "keymapp");
3774 DEFSYM (Qnon_ascii
, "non-ascii");
3775 DEFSYM (Qmenu_item
, "menu-item");
3776 DEFSYM (Qremap
, "remap");
3777 DEFSYM (QCadvertised_binding
, ":advertised-binding");
3779 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3780 staticpro (&command_remapping_vector
);
3782 where_is_cache_keymaps
= Qt
;
3783 where_is_cache
= Qnil
;
3784 staticpro (&where_is_cache
);
3785 staticpro (&where_is_cache_keymaps
);
3787 defsubr (&Skeymapp
);
3788 defsubr (&Skeymap_parent
);
3789 defsubr (&Skeymap_prompt
);
3790 defsubr (&Sset_keymap_parent
);
3791 defsubr (&Smake_keymap
);
3792 defsubr (&Smake_sparse_keymap
);
3793 defsubr (&Smap_keymap_internal
);
3794 defsubr (&Smap_keymap
);
3795 defsubr (&Scopy_keymap
);
3796 defsubr (&Scommand_remapping
);
3797 defsubr (&Skey_binding
);
3798 defsubr (&Slocal_key_binding
);
3799 defsubr (&Sglobal_key_binding
);
3800 defsubr (&Sminor_mode_key_binding
);
3801 defsubr (&Sdefine_key
);
3802 defsubr (&Slookup_key
);
3803 defsubr (&Sdefine_prefix_command
);
3804 defsubr (&Suse_global_map
);
3805 defsubr (&Suse_local_map
);
3806 defsubr (&Scurrent_local_map
);
3807 defsubr (&Scurrent_global_map
);
3808 defsubr (&Scurrent_minor_mode_maps
);
3809 defsubr (&Scurrent_active_maps
);
3810 defsubr (&Saccessible_keymaps
);
3811 defsubr (&Skey_description
);
3812 defsubr (&Sdescribe_vector
);
3813 defsubr (&Ssingle_key_description
);
3814 defsubr (&Stext_char_description
);
3815 defsubr (&Swhere_is_internal
);
3816 defsubr (&Sdescribe_buffer_bindings
);
3817 defsubr (&Sapropos_internal
);
3821 keys_of_keymap (void)
3823 initial_define_key (global_map
, 033, "ESC-prefix");
3824 initial_define_key (global_map
, Ctl ('X'), "Control-X-prefix");