1 /* Manipulation of keymaps
2 Copyright (C) 1985-1988, 1993-1995, 1998-2011 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 - [M-C-a] != [?\M-\C-a]
22 - (define-key map [menu-bar foo] <bla>) does not always place <bla>
23 at the head of the menu (if `foo' was already bound earlier and
24 then unbound, for example).
26 - allow many more Meta -> ESC mappings (like Hyper -> C-e for Emacspeak)
27 - Think about the various defaulting that's currently hard-coded in
28 keyboard.c (uppercase->lowercase, char->charset, button-events, ...)
29 and make it more generic. Maybe we should allow mappings of the
30 form (PREDICATE . BINDING) as generalization of the default binding,
31 tho probably a cleaner way to attack this is to allow functional
32 keymaps (i.e. keymaps that are implemented as functions that implement
33 a few different methods like `lookup', `map', ...).
34 - Make [a] equivalent to [?a].
36 - map-keymap should work meaningfully even if entries are added/removed
37 to the keymap while iterating through it:
38 start - removed <= visited <= start + added
47 #include "character.h"
51 #include "termhooks.h"
52 #include "blockinput.h"
54 #include "intervals.h"
58 /* Actually allocate storage for these variables */
60 Lisp_Object current_global_map
; /* Current global keymap */
62 Lisp_Object global_map
; /* default global key bindings */
64 Lisp_Object meta_map
; /* The keymap used for globally bound
65 ESC-prefixed default commands */
67 Lisp_Object control_x_map
; /* The keymap used for globally bound
68 C-x-prefixed default commands */
70 /* The keymap used by the minibuf for local
71 bindings when spaces are allowed in the
74 /* The keymap used by the minibuf for local
75 bindings when spaces are not encouraged
78 /* keymap used for minibuffers when doing completion */
79 /* keymap used for minibuffers when doing completion and require a match */
80 static Lisp_Object Qkeymapp
, Qnon_ascii
;
81 Lisp_Object Qkeymap
, Qmenu_item
, Qremap
;
82 static Lisp_Object QCadvertised_binding
;
84 /* Alist of elements like (DEL . "\d"). */
85 static Lisp_Object exclude_keys
;
87 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
88 static Lisp_Object command_remapping_vector
;
90 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
91 static Lisp_Object where_is_cache
;
92 /* Which keymaps are reverse-stored in the cache. */
93 static Lisp_Object where_is_cache_keymaps
;
95 static Lisp_Object
Flookup_key (Lisp_Object
, Lisp_Object
, Lisp_Object
);
96 static Lisp_Object
store_in_keymap (Lisp_Object
, Lisp_Object
, Lisp_Object
);
98 static Lisp_Object
define_as_prefix (Lisp_Object
, Lisp_Object
);
99 static void describe_command (Lisp_Object
, Lisp_Object
);
100 static void describe_translation (Lisp_Object
, Lisp_Object
);
101 static void describe_map (Lisp_Object
, Lisp_Object
,
102 void (*) (Lisp_Object
, Lisp_Object
),
103 int, Lisp_Object
, Lisp_Object
*, int, int);
104 static void describe_vector (Lisp_Object
, Lisp_Object
, Lisp_Object
,
105 void (*) (Lisp_Object
, Lisp_Object
), int,
106 Lisp_Object
, Lisp_Object
, int, int);
107 static void silly_event_symbol_error (Lisp_Object
);
108 static Lisp_Object
get_keyelt (Lisp_Object
, int);
110 /* Keymap object support - constructors and predicates. */
112 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
113 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
114 CHARTABLE is a char-table that holds the bindings for all characters
115 without modifiers. All entries in it are initially nil, meaning
116 "command undefined". ALIST is an assoc-list which holds bindings for
117 function keys, mouse events, and any other things that appear in the
118 input stream. Initially, ALIST is nil.
120 The optional arg STRING supplies a menu name for the keymap
121 in case you use it as a menu with `x-popup-menu'. */)
126 tail
= Fcons (string
, Qnil
);
129 return Fcons (Qkeymap
,
130 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
133 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
134 doc
: /* Construct and return a new sparse keymap.
135 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
136 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
137 which binds the function key or mouse event SYMBOL to DEFINITION.
138 Initially the alist is nil.
140 The optional arg STRING supplies a menu name for the keymap
141 in case you use it as a menu with `x-popup-menu'. */)
146 if (!NILP (Vpurify_flag
))
147 string
= Fpurecopy (string
);
148 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
150 return Fcons (Qkeymap
, Qnil
);
153 DEFUN ("make-composed-keymap", Fmake_composed_keymap
, Smake_composed_keymap
,
155 doc
: /* Construct and return a new keymap composed of KEYMAPS.
156 When looking up a key in the returned map, the key is looked in each
157 keymap in turn until a binding is found.
158 usage: (make-composed-keymap &rest KEYMAPS) */)
159 (ptrdiff_t nargs
, Lisp_Object
*args
)
161 return Fcons (Qkeymap
, Flist (nargs
, args
));
164 /* This function is used for installing the standard key bindings
165 at initialization time.
169 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
172 initial_define_key (Lisp_Object keymap
, int key
, const char *defname
)
174 store_in_keymap (keymap
, make_number (key
), intern_c_string (defname
));
178 initial_define_lispy_key (Lisp_Object keymap
, const char *keyname
, const char *defname
)
180 store_in_keymap (keymap
, intern_c_string (keyname
), intern_c_string (defname
));
183 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
184 doc
: /* Return t if OBJECT is a keymap.
186 A keymap is a list (keymap . ALIST),
187 or a symbol whose function definition is itself a keymap.
188 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
189 a vector of densely packed bindings for small character codes
190 is also allowed as an element. */)
193 return (KEYMAPP (object
) ? Qt
: Qnil
);
196 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
197 doc
: /* Return the prompt-string of a keymap MAP.
198 If non-nil, the prompt is shown in the echo-area
199 when reading a key-sequence to be looked-up in this keymap. */)
202 map
= get_keymap (map
, 0, 0);
205 Lisp_Object tem
= XCAR (map
);
208 else if (KEYMAPP (tem
))
210 tem
= Fkeymap_prompt (tem
);
219 /* Check that OBJECT is a keymap (after dereferencing through any
220 symbols). If it is, return it.
222 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
223 is an autoload form, do the autoload and try again.
224 If AUTOLOAD is nonzero, callers must assume GC is possible.
226 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
227 is zero as well), return Qt.
229 ERROR_IF_NOT_KEYMAP controls how we respond if OBJECT isn't a keymap.
230 If ERROR_IF_NOT_KEYMAP is non-zero, signal an error; otherwise,
233 Note that most of the time, we don't want to pursue autoloads.
234 Functions like Faccessible_keymaps which scan entire keymap trees
235 shouldn't load every autoloaded keymap. I'm not sure about this,
236 but it seems to me that only read_key_sequence, Flookup_key, and
237 Fdefine_key should cause keymaps to be autoloaded.
239 This function can GC when AUTOLOAD is non-zero, because it calls
240 do_autoload which can GC. */
243 get_keymap (Lisp_Object object
, int error_if_not_keymap
, int autoload
)
250 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
253 tem
= indirect_function (object
);
256 if (EQ (XCAR (tem
), Qkeymap
))
259 /* Should we do an autoload? Autoload forms for keymaps have
260 Qkeymap as their fifth element. */
261 if ((autoload
|| !error_if_not_keymap
) && EQ (XCAR (tem
), Qautoload
)
266 tail
= Fnth (make_number (4), tem
);
267 if (EQ (tail
, Qkeymap
))
271 struct gcpro gcpro1
, gcpro2
;
273 GCPRO2 (tem
, object
);
274 do_autoload (tem
, object
);
286 if (error_if_not_keymap
)
287 wrong_type_argument (Qkeymapp
, object
);
291 /* Return the parent map of KEYMAP, or nil if it has none.
292 We assume that KEYMAP is a valid keymap. */
295 keymap_parent (Lisp_Object keymap
, int autoload
)
299 keymap
= get_keymap (keymap
, 1, autoload
);
301 /* Skip past the initial element `keymap'. */
302 list
= XCDR (keymap
);
303 for (; CONSP (list
); list
= XCDR (list
))
305 /* See if there is another `keymap'. */
310 return get_keymap (list
, 0, autoload
);
313 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
314 doc
: /* Return the parent keymap of KEYMAP.
315 If KEYMAP has no parent, return nil. */)
318 return keymap_parent (keymap
, 1);
321 /* Check whether MAP is one of MAPS parents. */
323 keymap_memberp (Lisp_Object map
, Lisp_Object maps
)
325 if (NILP (map
)) return 0;
326 while (KEYMAPP (maps
) && !EQ (map
, maps
))
327 maps
= keymap_parent (maps
, 0);
328 return (EQ (map
, maps
));
331 /* Set the parent keymap of MAP to PARENT. */
333 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
334 doc
: /* Modify KEYMAP to set its parent map to PARENT.
335 Return PARENT. PARENT should be nil or another keymap. */)
336 (Lisp_Object keymap
, Lisp_Object parent
)
338 Lisp_Object list
, prev
;
339 struct gcpro gcpro1
, gcpro2
;
341 /* Flush any reverse-map cache. */
342 where_is_cache
= Qnil
; where_is_cache_keymaps
= Qt
;
344 GCPRO2 (keymap
, parent
);
345 keymap
= get_keymap (keymap
, 1, 1);
349 parent
= get_keymap (parent
, 1, 0);
351 /* Check for cycles. */
352 if (keymap_memberp (keymap
, parent
))
353 error ("Cyclic keymap inheritance");
356 /* Skip past the initial element `keymap'. */
361 /* If there is a parent keymap here, replace it.
362 If we came to the end, add the parent in PREV. */
363 if (!CONSP (list
) || KEYMAPP (list
))
366 XSETCDR (prev
, parent
);
367 RETURN_UNGCPRO (parent
);
374 /* Look up IDX in MAP. IDX may be any sort of event.
375 Note that this does only one level of lookup; IDX must be a single
376 event, not a sequence.
378 MAP must be a keymap or a list of keymaps.
380 If T_OK is non-zero, bindings for Qt are treated as default
381 bindings; any key left unmentioned by other tables and bindings is
382 given the binding of Qt.
384 If T_OK is zero, bindings for Qt are not treated specially.
386 If NOINHERIT, don't accept a subkeymap found in an inherited keymap.
388 Returns Qunbound if no binding was found (and returns Qnil if a nil
389 binding was found). */
392 access_keymap_1 (Lisp_Object map
, Lisp_Object idx
, int t_ok
, int noinherit
, int autoload
)
394 /* If idx is a list (some sort of mouse click, perhaps?),
395 the index we want to use is the car of the list, which
396 ought to be a symbol. */
397 idx
= EVENT_HEAD (idx
);
399 /* If idx is a symbol, it might have modifiers, which need to
400 be put in the canonical order. */
402 idx
= reorder_modifiers (idx
);
403 else if (INTEGERP (idx
))
404 /* Clobber the high bits that can be present on a machine
405 with more than 24 bits of integer. */
406 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
408 /* Handle the special meta -> esc mapping. */
409 if (INTEGERP (idx
) && XFASTINT (idx
) & meta_modifier
)
411 /* See if there is a meta-map. If there's none, there is
412 no binding for IDX, unless a default binding exists in MAP. */
414 Lisp_Object event_meta_binding
, event_meta_map
;
416 /* A strange value in which Meta is set would cause
417 infinite recursion. Protect against that. */
418 if (XINT (meta_prefix_char
) & CHAR_META
)
419 meta_prefix_char
= make_number (27);
420 event_meta_binding
= access_keymap_1 (map
, meta_prefix_char
, t_ok
,
421 noinherit
, autoload
);
422 event_meta_map
= get_keymap (event_meta_binding
, 0, autoload
);
424 if (CONSP (event_meta_map
))
426 map
= event_meta_map
;
427 idx
= make_number (XFASTINT (idx
) & ~meta_modifier
);
430 /* Set IDX to t, so that we only find a default binding. */
433 /* An explicit nil binding, or no binding at all. */
434 return NILP (event_meta_binding
) ? Qnil
: Qunbound
;
437 /* t_binding is where we put a default binding that applies,
438 to use in case we do not find a binding specifically
439 for this key sequence. */
442 Lisp_Object t_binding
= Qunbound
;
443 Lisp_Object retval
= Qunbound
;
444 Lisp_Object retval_tail
= Qnil
;
445 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
447 GCPRO4 (tail
, idx
, t_binding
, retval
);
449 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
451 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
454 /* Qunbound in VAL means we have found no binding. */
455 Lisp_Object val
= Qunbound
;
456 Lisp_Object binding
= XCAR (tail
);
457 Lisp_Object submap
= get_keymap (binding
, 0, autoload
);
459 if (EQ (binding
, Qkeymap
))
461 if (noinherit
|| NILP (retval
))
462 /* If NOINHERIT, stop here, the rest is inherited. */
464 else if (!EQ (retval
, Qunbound
))
466 Lisp_Object parent_entry
;
467 eassert (KEYMAPP (retval
));
469 = get_keymap (access_keymap_1 (tail
, idx
,
472 if (KEYMAPP (parent_entry
))
474 if (CONSP (retval_tail
))
475 XSETCDR (retval_tail
, parent_entry
);
478 retval_tail
= Fcons (retval
, parent_entry
);
479 retval
= Fcons (Qkeymap
, retval_tail
);
485 else if (CONSP (submap
))
487 val
= access_keymap_1 (submap
, idx
, t_ok
, noinherit
, autoload
);
489 else if (CONSP (binding
))
491 Lisp_Object key
= XCAR (binding
);
494 val
= XCDR (binding
);
495 else if (t_ok
&& EQ (key
, Qt
))
497 t_binding
= XCDR (binding
);
501 else if (VECTORP (binding
))
503 if (INTEGERP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
504 val
= AREF (binding
, XFASTINT (idx
));
506 else if (CHAR_TABLE_P (binding
))
508 /* Character codes with modifiers
509 are not included in a char-table.
510 All character codes without modifiers are included. */
511 if (INTEGERP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
513 val
= Faref (binding
, idx
);
514 /* `nil' has a special meaning for char-tables, so
515 we use something else to record an explicitly
522 /* If we found a binding, clean it up and return it. */
523 if (!EQ (val
, Qunbound
))
526 /* A Qt binding is just like an explicit nil binding
527 (i.e. it shadows any parent binding but not bindings in
528 keymaps of lower precedence). */
531 val
= get_keyelt (val
, autoload
);
535 if (NILP (retval
) || EQ (retval
, Qunbound
))
538 break; /* Shadows everything that follows. */
540 else if (NILP (retval
) || EQ (retval
, Qunbound
))
542 else if (CONSP (retval_tail
))
544 XSETCDR (retval_tail
, Fcons (val
, Qnil
));
545 retval_tail
= XCDR (retval_tail
);
549 retval_tail
= Fcons (val
, Qnil
);
550 retval
= Fcons (Qkeymap
, Fcons (retval
, retval_tail
));
556 return EQ (Qunbound
, retval
) ? get_keyelt (t_binding
, autoload
) : retval
;
561 access_keymap (Lisp_Object map
, Lisp_Object idx
,
562 int t_ok
, int noinherit
, int autoload
)
564 Lisp_Object val
= access_keymap_1 (map
, idx
, t_ok
, noinherit
, autoload
);
565 return EQ (val
, Qunbound
) ? Qnil
: val
;
569 map_keymap_item (map_keymap_function_t fun
, Lisp_Object args
, Lisp_Object key
, Lisp_Object val
, void *data
)
573 (*fun
) (key
, val
, args
, data
);
577 map_keymap_char_table_item (Lisp_Object args
, Lisp_Object key
, Lisp_Object val
)
581 map_keymap_function_t fun
582 = (map_keymap_function_t
) XSAVE_VALUE (XCAR (args
))->pointer
;
584 /* If the key is a range, make a copy since map_char_table modifies
587 key
= Fcons (XCAR (key
), XCDR (key
));
588 map_keymap_item (fun
, XCDR (args
), key
, val
,
589 XSAVE_VALUE (XCAR (args
))->pointer
);
593 /* Call FUN for every binding in MAP and stop at (and return) the parent.
594 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA). */
596 map_keymap_internal (Lisp_Object map
,
597 map_keymap_function_t fun
,
601 struct gcpro gcpro1
, gcpro2
, gcpro3
;
603 = (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
605 GCPRO3 (map
, args
, tail
);
606 for (; CONSP (tail
) && !EQ (Qkeymap
, XCAR (tail
)); tail
= XCDR (tail
))
608 Lisp_Object binding
= XCAR (tail
);
610 if (KEYMAPP (binding
)) /* An embedded parent. */
612 else if (CONSP (binding
))
613 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
614 else if (VECTORP (binding
))
616 /* Loop over the char values represented in the vector. */
617 int len
= ASIZE (binding
);
619 for (c
= 0; c
< len
; c
++)
621 Lisp_Object character
;
622 XSETFASTINT (character
, c
);
623 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
626 else if (CHAR_TABLE_P (binding
))
628 map_char_table (map_keymap_char_table_item
, Qnil
, binding
,
629 Fcons (make_save_value ((void *) fun
, 0),
630 Fcons (make_save_value (data
, 0),
639 map_keymap_call (Lisp_Object key
, Lisp_Object val
, Lisp_Object fun
, void *dummy
)
641 call2 (fun
, key
, val
);
644 /* Same as map_keymap_internal, but traverses parent keymaps as well.
645 A non-zero AUTOLOAD indicates that autoloaded keymaps should be loaded. */
647 map_keymap (Lisp_Object map
, map_keymap_function_t fun
, Lisp_Object args
, void *data
, int autoload
)
651 map
= get_keymap (map
, 1, autoload
);
654 if (KEYMAPP (XCAR (map
)))
656 map_keymap (XCAR (map
), fun
, args
, data
, autoload
);
660 map
= map_keymap_internal (map
, fun
, args
, data
);
662 map
= get_keymap (map
, 0, autoload
);
667 static Lisp_Object Qkeymap_canonicalize
;
669 /* Same as map_keymap, but does it right, properly eliminating duplicate
670 bindings due to inheritance. */
672 map_keymap_canonical (Lisp_Object map
, map_keymap_function_t fun
, Lisp_Object args
, void *data
)
676 /* map_keymap_canonical may be used from redisplay (e.g. when building menus)
677 so be careful to ignore errors and to inhibit redisplay. */
678 map
= safe_call1 (Qkeymap_canonicalize
, map
);
679 /* No need to use `map_keymap' here because canonical map has no parent. */
680 map_keymap_internal (map
, fun
, args
, data
);
684 DEFUN ("map-keymap-internal", Fmap_keymap_internal
, Smap_keymap_internal
, 2, 2, 0,
685 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
686 FUNCTION is called with two arguments: the event that is bound, and
687 the definition it is bound to. The event may be a character range.
688 If KEYMAP has a parent, this function returns it without processing it. */)
689 (Lisp_Object function
, Lisp_Object keymap
)
693 keymap
= get_keymap (keymap
, 1, 1);
694 keymap
= map_keymap_internal (keymap
, map_keymap_call
, function
, NULL
);
699 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
700 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
701 FUNCTION is called with two arguments: the event that is bound, and
702 the definition it is bound to. The event may be a character range.
704 If KEYMAP has a parent, the parent's bindings are included as well.
705 This works recursively: if the parent has itself a parent, then the
706 grandparent's bindings are also included and so on.
707 usage: (map-keymap FUNCTION KEYMAP) */)
708 (Lisp_Object function
, Lisp_Object keymap
, Lisp_Object sort_first
)
710 if (! NILP (sort_first
))
711 return call2 (intern ("map-keymap-sorted"), function
, keymap
);
713 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
717 /* Given OBJECT which was found in a slot in a keymap,
718 trace indirect definitions to get the actual definition of that slot.
719 An indirect definition is a list of the form
720 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
721 and INDEX is the object to look up in KEYMAP to yield the definition.
723 Also if OBJECT has a menu string as the first element,
724 remove that. Also remove a menu help string as second element.
726 If AUTOLOAD is nonzero, load autoloadable keymaps
727 that are referred to with indirection.
729 This can GC because menu_item_eval_property calls Feval. */
732 get_keyelt (Lisp_Object object
, int autoload
)
736 if (!(CONSP (object
)))
737 /* This is really the value. */
740 /* If the keymap contents looks like (keymap ...) or (lambda ...)
742 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
745 /* If the keymap contents looks like (menu-item name . DEFN)
746 or (menu-item name DEFN ...) then use DEFN.
747 This is a new format menu item. */
748 else if (EQ (XCAR (object
), Qmenu_item
))
750 if (CONSP (XCDR (object
)))
754 object
= XCDR (XCDR (object
));
757 object
= XCAR (object
);
759 /* If there's a `:filter FILTER', apply FILTER to the
760 menu-item's definition to get the real definition to
762 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
763 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
766 filter
= XCAR (XCDR (tem
));
767 filter
= list2 (filter
, list2 (Qquote
, object
));
768 object
= menu_item_eval_property (filter
);
773 /* Invalid keymap. */
777 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
778 Keymap alist elements like (CHAR MENUSTRING . DEFN)
779 will be used by HierarKey menus. */
780 else if (STRINGP (XCAR (object
)))
782 object
= XCDR (object
);
783 /* Also remove a menu help string, if any,
784 following the menu item name. */
785 if (CONSP (object
) && STRINGP (XCAR (object
)))
786 object
= XCDR (object
);
787 /* Also remove the sublist that caches key equivalences, if any. */
788 if (CONSP (object
) && CONSP (XCAR (object
)))
791 carcar
= XCAR (XCAR (object
));
792 if (NILP (carcar
) || VECTORP (carcar
))
793 object
= XCDR (object
);
797 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
798 else if (KEYMAPP (XCAR (object
)))
799 error ("Wow, indirect keymap entry!!");
806 store_in_keymap (Lisp_Object keymap
, register Lisp_Object idx
, Lisp_Object def
)
808 /* Flush any reverse-map cache. */
809 where_is_cache
= Qnil
;
810 where_is_cache_keymaps
= Qt
;
812 if (EQ (idx
, Qkeymap
))
813 error ("`keymap' is reserved for embedded parent maps");
815 /* If we are preparing to dump, and DEF is a menu element
816 with a menu item indicator, copy it to ensure it is not pure. */
817 if (CONSP (def
) && PURE_P (def
)
818 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
819 def
= Fcons (XCAR (def
), XCDR (def
));
821 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
822 error ("attempt to define a key in a non-keymap");
824 /* If idx is a cons, and the car part is a character, idx must be of
825 the form (FROM-CHAR . TO-CHAR). */
826 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
827 CHECK_CHARACTER_CDR (idx
);
829 /* If idx is a list (some sort of mouse click, perhaps?),
830 the index we want to use is the car of the list, which
831 ought to be a symbol. */
832 idx
= EVENT_HEAD (idx
);
834 /* If idx is a symbol, it might have modifiers, which need to
835 be put in the canonical order. */
837 idx
= reorder_modifiers (idx
);
838 else if (INTEGERP (idx
))
839 /* Clobber the high bits that can be present on a machine
840 with more than 24 bits of integer. */
841 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
843 /* Scan the keymap for a binding of idx. */
847 /* The cons after which we should insert new bindings. If the
848 keymap has a table element, we record its position here, so new
849 bindings will go after it; this way, the table will stay
850 towards the front of the alist and character lookups in dense
851 keymaps will remain fast. Otherwise, this just points at the
852 front of the keymap. */
853 Lisp_Object insertion_point
;
855 insertion_point
= keymap
;
856 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
863 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
866 ASET (elt
, XFASTINT (idx
), def
);
869 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
871 int from
= XFASTINT (XCAR (idx
));
872 int to
= XFASTINT (XCDR (idx
));
874 if (to
>= ASIZE (elt
))
875 to
= ASIZE (elt
) - 1;
876 for (; from
<= to
; from
++)
877 ASET (elt
, from
, def
);
878 if (to
== XFASTINT (XCDR (idx
)))
879 /* We have defined all keys in IDX. */
882 insertion_point
= tail
;
884 else if (CHAR_TABLE_P (elt
))
886 /* Character codes with modifiers
887 are not included in a char-table.
888 All character codes without modifiers are included. */
889 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
892 /* `nil' has a special meaning for char-tables, so
893 we use something else to record an explicitly
895 NILP (def
) ? Qt
: def
);
898 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
900 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
903 insertion_point
= tail
;
905 else if (CONSP (elt
))
907 if (EQ (Qkeymap
, XCAR (elt
)))
908 { /* A sub keymap. This might be due to a lookup that found
909 two matching bindings (maybe because of a sub keymap).
910 It almost never happens (since the second binding normally
911 only happens in the inherited part of the keymap), but
912 if it does, we want to update the sub-keymap since the
913 main one might be temporary (built by access_keymap). */
914 tail
= insertion_point
= elt
;
916 else if (EQ (idx
, XCAR (elt
)))
922 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
924 int from
= XFASTINT (XCAR (idx
));
925 int to
= XFASTINT (XCDR (idx
));
927 if (from
<= XFASTINT (XCAR (elt
))
928 && to
>= XFASTINT (XCAR (elt
)))
936 else if (EQ (elt
, Qkeymap
))
937 /* If we find a 'keymap' symbol in the spine of KEYMAP,
938 then we must have found the start of a second keymap
939 being used as the tail of KEYMAP, and a binding for IDX
940 should be inserted before it. */
947 /* We have scanned the entire keymap, and not found a binding for
948 IDX. Let's add one. */
952 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
954 /* IDX specifies a range of characters, and not all of them
955 were handled yet, which means this keymap doesn't have a
956 char-table. So, we insert a char-table now. */
957 elt
= Fmake_char_table (Qkeymap
, Qnil
);
958 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
961 elt
= Fcons (idx
, def
);
962 CHECK_IMPURE (insertion_point
);
963 XSETCDR (insertion_point
, Fcons (elt
, XCDR (insertion_point
)));
970 static Lisp_Object
Fcopy_keymap (Lisp_Object
);
973 copy_keymap_item (Lisp_Object elt
)
975 Lisp_Object res
, tem
;
982 /* Is this a new format menu item. */
983 if (EQ (XCAR (tem
), Qmenu_item
))
985 /* Copy cell with menu-item marker. */
986 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
990 /* Copy cell with menu-item name. */
991 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
997 /* Copy cell with binding and if the binding is a keymap,
999 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1002 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1003 XSETCAR (elt
, Fcopy_keymap (tem
));
1005 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1006 /* Delete cache for key equivalences. */
1007 XSETCDR (elt
, XCDR (tem
));
1012 /* It may be an old fomat menu item.
1013 Skip the optional menu string. */
1014 if (STRINGP (XCAR (tem
)))
1016 /* Copy the cell, since copy-alist didn't go this deep. */
1017 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1019 /* Also skip the optional menu help string. */
1020 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1022 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1026 /* There may also be a list that caches key equivalences.
1027 Just delete it for the new keymap. */
1029 && CONSP (XCAR (tem
))
1030 && (NILP (XCAR (XCAR (tem
)))
1031 || VECTORP (XCAR (XCAR (tem
)))))
1033 XSETCDR (elt
, XCDR (tem
));
1036 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1037 XSETCDR (elt
, Fcopy_keymap (tem
));
1039 else if (EQ (XCAR (tem
), Qkeymap
))
1040 res
= Fcopy_keymap (elt
);
1046 copy_keymap_1 (Lisp_Object chartable
, Lisp_Object idx
, Lisp_Object elt
)
1048 Fset_char_table_range (chartable
, idx
, copy_keymap_item (elt
));
1051 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1052 doc
: /* Return a copy of the keymap KEYMAP.
1053 The copy starts out with the same definitions of KEYMAP,
1054 but changing either the copy or KEYMAP does not affect the other.
1055 Any key definitions that are subkeymaps are recursively copied.
1056 However, a key definition which is a symbol whose definition is a keymap
1058 (Lisp_Object keymap
)
1060 register Lisp_Object copy
, tail
;
1061 keymap
= get_keymap (keymap
, 1, 0);
1062 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1063 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1065 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1067 Lisp_Object elt
= XCAR (keymap
);
1068 if (CHAR_TABLE_P (elt
))
1070 elt
= Fcopy_sequence (elt
);
1071 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
);
1073 else if (VECTORP (elt
))
1076 elt
= Fcopy_sequence (elt
);
1077 for (i
= 0; i
< ASIZE (elt
); i
++)
1078 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1080 else if (CONSP (elt
))
1082 if (EQ (XCAR (elt
), Qkeymap
))
1083 /* This is a sub keymap. */
1084 elt
= Fcopy_keymap (elt
);
1086 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1088 XSETCDR (tail
, Fcons (elt
, Qnil
));
1090 keymap
= XCDR (keymap
);
1092 XSETCDR (tail
, keymap
);
1096 /* Simple Keymap mutators and accessors. */
1098 /* GC is possible in this function if it autoloads a keymap. */
1100 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1101 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1104 KEY is a string or a vector of symbols and characters, representing a
1105 sequence of keystrokes and events. Non-ASCII characters with codes
1106 above 127 (such as ISO Latin-1) can be represented by vectors.
1107 Two types of vector have special meanings:
1108 [remap COMMAND] remaps any key binding for COMMAND.
1109 [t] creates a default definition, which applies to any event with no
1110 other definition in KEYMAP.
1112 DEF is anything that can be a key's definition:
1113 nil (means key is undefined in this keymap),
1114 a command (a Lisp function suitable for interactive calling),
1115 a string (treated as a keyboard macro),
1116 a keymap (to define a prefix key),
1117 a symbol (when the key is looked up, the symbol will stand for its
1118 function definition, which should at that time be one of the above,
1119 or another symbol whose function definition is used, etc.),
1120 a cons (STRING . DEFN), meaning that DEFN is the definition
1121 (DEFN should be a valid definition in its own right),
1122 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP,
1123 or an extended menu item definition.
1124 (See info node `(elisp)Extended Menu Items'.)
1126 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1127 binding is altered. If there is no binding for KEY, the new pair
1128 binding KEY to DEF is added at the front of KEYMAP. */)
1129 (Lisp_Object keymap
, Lisp_Object key
, Lisp_Object def
)
1132 register Lisp_Object c
;
1133 register Lisp_Object cmd
;
1137 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1139 GCPRO3 (keymap
, key
, def
);
1140 keymap
= get_keymap (keymap
, 1, 1);
1142 CHECK_VECTOR_OR_STRING (key
);
1144 length
= XFASTINT (Flength (key
));
1146 RETURN_UNGCPRO (Qnil
);
1148 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1149 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1151 meta_bit
= (VECTORP (key
) || (STRINGP (key
) && STRING_MULTIBYTE (key
))
1152 ? meta_modifier
: 0x80);
1154 if (VECTORP (def
) && ASIZE (def
) > 0 && CONSP (AREF (def
, 0)))
1155 { /* DEF is apparently an XEmacs-style keyboard macro. */
1156 Lisp_Object tmp
= Fmake_vector (make_number (ASIZE (def
)), Qnil
);
1157 int i
= ASIZE (def
);
1160 Lisp_Object defi
= AREF (def
, i
);
1161 if (CONSP (defi
) && lucid_event_type_list_p (defi
))
1162 defi
= Fevent_convert_list (defi
);
1163 ASET (tmp
, i
, defi
);
1171 c
= Faref (key
, make_number (idx
));
1175 /* C may be a Lucid style event type list or a cons (FROM .
1176 TO) specifying a range of characters. */
1177 if (lucid_event_type_list_p (c
))
1178 c
= Fevent_convert_list (c
);
1179 else if (CHARACTERP (XCAR (c
)))
1180 CHECK_CHARACTER_CDR (c
);
1184 silly_event_symbol_error (c
);
1187 && (XINT (c
) & meta_bit
)
1190 c
= meta_prefix_char
;
1196 XSETINT (c
, XINT (c
) & ~meta_bit
);
1202 if (!INTEGERP (c
) && !SYMBOLP (c
)
1204 /* If C is a range, it must be a leaf. */
1205 || (INTEGERP (XCAR (c
)) && idx
!= length
)))
1206 message_with_string ("Key sequence contains invalid event %s", c
, 1);
1209 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1211 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1213 /* If this key is undefined, make it a prefix. */
1215 cmd
= define_as_prefix (keymap
, c
);
1217 keymap
= get_keymap (cmd
, 0, 1);
1218 if (!CONSP (keymap
))
1220 const char *trailing_esc
= ((EQ (c
, meta_prefix_char
) && metized
)
1221 ? (idx
== 0 ? "ESC" : " ESC")
1224 /* We must use Fkey_description rather than just passing key to
1225 error; key might be a vector, not a string. */
1226 error ("Key sequence %s starts with non-prefix key %s%s",
1227 SDATA (Fkey_description (key
, Qnil
)),
1228 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1236 /* This function may GC (it calls Fkey_binding). */
1238 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 3, 0,
1239 doc
: /* Return the remapping for command COMMAND.
1240 Returns nil if COMMAND is not remapped (or not a symbol).
1242 If the optional argument POSITION is non-nil, it specifies a mouse
1243 position as returned by `event-start' and `event-end', and the
1244 remapping occurs in the keymaps associated with it. It can also be a
1245 number or marker, in which case the keymap properties at the specified
1246 buffer position instead of point are used. The KEYMAPS argument is
1247 ignored if POSITION is non-nil.
1249 If the optional argument KEYMAPS is non-nil, it should be a list of
1250 keymaps to search for command remapping. Otherwise, search for the
1251 remapping in all currently active keymaps. */)
1252 (Lisp_Object command
, Lisp_Object position
, Lisp_Object keymaps
)
1254 if (!SYMBOLP (command
))
1257 ASET (command_remapping_vector
, 1, command
);
1260 command
= Fkey_binding (command_remapping_vector
, Qnil
, Qt
, position
);
1262 command
= Flookup_key (Fcons (Qkeymap
, keymaps
),
1263 command_remapping_vector
, Qnil
);
1264 return INTEGERP (command
) ? Qnil
: command
;
1267 /* Value is number if KEY is too long; nil if valid but has no definition. */
1268 /* GC is possible in this function. */
1270 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1271 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1272 A value of nil means undefined. See doc of `define-key'
1273 for kinds of definitions.
1275 A number as value means KEY is "too long";
1276 that is, characters or symbols in it except for the last one
1277 fail to be a valid sequence of prefix characters in KEYMAP.
1278 The number is how many characters at the front of KEY
1279 it takes to reach a non-prefix key.
1281 Normally, `lookup-key' ignores bindings for t, which act as default
1282 bindings, used when nothing else in the keymap applies; this makes it
1283 usable as a general function for probing keymaps. However, if the
1284 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1285 recognize the default bindings, just as `read-key-sequence' does. */)
1286 (Lisp_Object keymap
, Lisp_Object key
, Lisp_Object accept_default
)
1289 register Lisp_Object cmd
;
1290 register Lisp_Object c
;
1292 int t_ok
= !NILP (accept_default
);
1293 struct gcpro gcpro1
, gcpro2
;
1295 GCPRO2 (keymap
, key
);
1296 keymap
= get_keymap (keymap
, 1, 1);
1298 CHECK_VECTOR_OR_STRING (key
);
1300 length
= XFASTINT (Flength (key
));
1302 RETURN_UNGCPRO (keymap
);
1307 c
= Faref (key
, make_number (idx
++));
1309 if (CONSP (c
) && lucid_event_type_list_p (c
))
1310 c
= Fevent_convert_list (c
);
1312 /* Turn the 8th bit of string chars into a meta modifier. */
1313 if (STRINGP (key
) && XINT (c
) & 0x80 && !STRING_MULTIBYTE (key
))
1314 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1316 /* Allow string since binding for `menu-bar-select-buffer'
1317 includes the buffer name in the key sequence. */
1318 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1319 message_with_string ("Key sequence contains invalid event %s", c
, 1);
1321 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1323 RETURN_UNGCPRO (cmd
);
1325 keymap
= get_keymap (cmd
, 0, 1);
1326 if (!CONSP (keymap
))
1327 RETURN_UNGCPRO (make_number (idx
));
1333 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1334 Assume that currently it does not define C at all.
1335 Return the keymap. */
1338 define_as_prefix (Lisp_Object keymap
, Lisp_Object c
)
1342 cmd
= Fmake_sparse_keymap (Qnil
);
1343 store_in_keymap (keymap
, c
, cmd
);
1348 /* Append a key to the end of a key sequence. We always make a vector. */
1351 append_key (Lisp_Object key_sequence
, Lisp_Object key
)
1353 Lisp_Object args
[2];
1355 args
[0] = key_sequence
;
1357 args
[1] = Fcons (key
, Qnil
);
1358 return Fvconcat (2, args
);
1361 /* Given a event type C which is a symbol,
1362 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1365 silly_event_symbol_error (Lisp_Object c
)
1367 Lisp_Object parsed
, base
, name
, assoc
;
1370 parsed
= parse_modifiers (c
);
1371 modifiers
= XFASTINT (XCAR (XCDR (parsed
)));
1372 base
= XCAR (parsed
);
1373 name
= Fsymbol_name (base
);
1374 /* This alist includes elements such as ("RET" . "\\r"). */
1375 assoc
= Fassoc (name
, exclude_keys
);
1379 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1381 Lisp_Object keystring
;
1382 if (modifiers
& alt_modifier
)
1383 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1384 if (modifiers
& ctrl_modifier
)
1385 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1386 if (modifiers
& hyper_modifier
)
1387 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1388 if (modifiers
& meta_modifier
)
1389 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1390 if (modifiers
& shift_modifier
)
1391 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1392 if (modifiers
& super_modifier
)
1393 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1396 c
= reorder_modifiers (c
);
1397 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1399 error ((modifiers
& ~meta_modifier
1400 ? "To bind the key %s, use [?%s], not [%s]"
1401 : "To bind the key %s, use \"%s\", not [%s]"),
1402 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1403 SDATA (SYMBOL_NAME (c
)));
1407 /* Global, local, and minor mode keymap stuff. */
1409 /* We can't put these variables inside current_minor_maps, since under
1410 some systems, static gets macro-defined to be the empty string.
1412 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1413 static int cmm_size
= 0;
1415 /* Store a pointer to an array of the currently active minor modes in
1416 *modeptr, a pointer to an array of the keymaps of the currently
1417 active minor modes in *mapptr, and return the number of maps
1420 This function always returns a pointer to the same buffer, and may
1421 free or reallocate it, so if you want to keep it for a long time or
1422 hand it out to lisp code, copy it. This procedure will be called
1423 for every key sequence read, so the nice lispy approach (return a
1424 new assoclist, list, what have you) for each invocation would
1425 result in a lot of consing over time.
1427 If we used xrealloc/xmalloc and ran out of memory, they would throw
1428 back to the command loop, which would try to read a key sequence,
1429 which would call this function again, resulting in an infinite
1430 loop. Instead, we'll use realloc/malloc and silently truncate the
1431 list, let the key sequence be read, and hope some other piece of
1432 code signals the error. */
1434 current_minor_maps (Lisp_Object
**modeptr
, Lisp_Object
**mapptr
)
1437 int list_number
= 0;
1438 Lisp_Object alist
, assoc
, var
, val
;
1439 Lisp_Object emulation_alists
;
1440 Lisp_Object lists
[2];
1442 emulation_alists
= Vemulation_mode_map_alists
;
1443 lists
[0] = Vminor_mode_overriding_map_alist
;
1444 lists
[1] = Vminor_mode_map_alist
;
1446 for (list_number
= 0; list_number
< 2; list_number
++)
1448 if (CONSP (emulation_alists
))
1450 alist
= XCAR (emulation_alists
);
1451 emulation_alists
= XCDR (emulation_alists
);
1452 if (SYMBOLP (alist
))
1453 alist
= find_symbol_value (alist
);
1457 alist
= lists
[list_number
];
1459 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1460 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1461 && (var
= XCAR (assoc
), SYMBOLP (var
))
1462 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1467 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1468 and also an entry in Vminor_mode_map_alist,
1469 ignore the latter. */
1470 if (list_number
== 1)
1472 val
= assq_no_quit (var
, lists
[0]);
1479 int newsize
, allocsize
;
1480 Lisp_Object
*newmodes
, *newmaps
;
1482 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1483 allocsize
= newsize
* sizeof *newmodes
;
1485 /* Use malloc here. See the comment above this function.
1486 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1488 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1493 memcpy (newmodes
, cmm_modes
,
1494 cmm_size
* sizeof cmm_modes
[0]);
1497 cmm_modes
= newmodes
;
1500 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1505 memcpy (newmaps
, cmm_maps
,
1506 cmm_size
* sizeof cmm_maps
[0]);
1513 if (newmodes
== NULL
|| newmaps
== NULL
)
1518 /* Get the keymap definition--or nil if it is not defined. */
1519 temp
= Findirect_function (XCDR (assoc
), Qt
);
1523 cmm_maps
[i
] = temp
;
1529 if (modeptr
) *modeptr
= cmm_modes
;
1530 if (mapptr
) *mapptr
= cmm_maps
;
1534 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1536 doc
: /* Return a list of the currently active keymaps.
1537 OLP if non-nil indicates that we should obey `overriding-local-map' and
1538 `overriding-terminal-local-map'. POSITION can specify a click position
1539 like in the respective argument of `key-binding'. */)
1540 (Lisp_Object olp
, Lisp_Object position
)
1542 int count
= SPECPDL_INDEX ();
1544 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1546 /* If a mouse click position is given, our variables are based on
1547 the buffer clicked on, not the current buffer. So we may have to
1548 switch the buffer here. */
1550 if (CONSP (position
))
1554 window
= POSN_WINDOW (position
);
1556 if (WINDOWP (window
)
1557 && BUFFERP (XWINDOW (window
)->buffer
)
1558 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
1560 /* Arrange to go back to the original buffer once we're done
1561 processing the key sequence. We don't use
1562 save_excursion_{save,restore} here, in analogy to
1563 `read-key-sequence' to avoid saving point. Maybe this
1564 would not be a problem here, but it is easier to keep
1568 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
1570 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
1576 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
1577 keymaps
= Fcons (KVAR (current_kboard
, Voverriding_terminal_local_map
),
1579 /* The doc said that overriding-terminal-local-map should
1580 override overriding-local-map. The code used them both,
1581 but it seems clearer to use just one. rms, jan 2005. */
1582 else if (!NILP (Voverriding_local_map
))
1583 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1585 if (NILP (XCDR (keymaps
)))
1590 = INTEGERP (position
) ? XINT (position
)
1591 : MARKERP (position
) ? marker_position (position
)
1593 /* This usually returns the buffer's local map,
1594 but that can be overridden by a `local-map' property. */
1595 Lisp_Object local_map
= get_local_map (pt
, current_buffer
, Qlocal_map
);
1596 /* This returns nil unless there is a `keymap' property. */
1597 Lisp_Object keymap
= get_local_map (pt
, current_buffer
, Qkeymap
);
1599 if (CONSP (position
))
1601 Lisp_Object string
= POSN_STRING (position
);
1603 /* For a mouse click, get the local text-property keymap
1604 of the place clicked on, rather than point. */
1606 if (POSN_INBUFFER_P (position
))
1610 pos
= POSN_BUFFER_POSN (position
);
1612 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
1614 local_map
= get_local_map (XINT (pos
),
1615 current_buffer
, Qlocal_map
);
1617 keymap
= get_local_map (XINT (pos
),
1618 current_buffer
, Qkeymap
);
1622 /* If on a mode line string with a local keymap,
1623 or for a click on a string, i.e. overlay string or a
1624 string displayed via the `display' property,
1625 consider `local-map' and `keymap' properties of
1628 if (CONSP (string
) && STRINGP (XCAR (string
)))
1630 Lisp_Object pos
, map
;
1632 pos
= XCDR (string
);
1633 string
= XCAR (string
);
1636 && XINT (pos
) < SCHARS (string
))
1638 map
= Fget_text_property (pos
, Qlocal_map
, string
);
1642 map
= Fget_text_property (pos
, Qkeymap
, string
);
1650 if (!NILP (local_map
))
1651 keymaps
= Fcons (local_map
, keymaps
);
1653 /* Now put all the minor mode keymaps on the list. */
1654 nmaps
= current_minor_maps (0, &maps
);
1656 for (i
= --nmaps
; i
>= 0; i
--)
1657 if (!NILP (maps
[i
]))
1658 keymaps
= Fcons (maps
[i
], keymaps
);
1661 keymaps
= Fcons (keymap
, keymaps
);
1664 unbind_to (count
, Qnil
);
1669 /* GC is possible in this function if it autoloads a keymap. */
1671 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 4, 0,
1672 doc
: /* Return the binding for command KEY in current keymaps.
1673 KEY is a string or vector, a sequence of keystrokes.
1674 The binding is probably a symbol with a function definition.
1676 Normally, `key-binding' ignores bindings for t, which act as default
1677 bindings, used when nothing else in the keymap applies; this makes it
1678 usable as a general function for probing keymaps. However, if the
1679 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1680 recognize the default bindings, just as `read-key-sequence' does.
1682 Like the normal command loop, `key-binding' will remap the command
1683 resulting from looking up KEY by looking up the command in the
1684 current keymaps. However, if the optional third argument NO-REMAP
1685 is non-nil, `key-binding' returns the unmapped command.
1687 If KEY is a key sequence initiated with the mouse, the used keymaps
1688 will depend on the clicked mouse position with regard to the buffer
1689 and possible local keymaps on strings.
1691 If the optional argument POSITION is non-nil, it specifies a mouse
1692 position as returned by `event-start' and `event-end', and the lookup
1693 occurs in the keymaps associated with it instead of KEY. It can also
1694 be a number or marker, in which case the keymap properties at the
1695 specified buffer position instead of point are used.
1697 (Lisp_Object key
, Lisp_Object accept_default
, Lisp_Object no_remap
, Lisp_Object position
)
1701 if (NILP (position
) && VECTORP (key
))
1704 /* mouse events may have a symbolic prefix indicating the
1705 scrollbar or mode line */
1706 = AREF (key
, SYMBOLP (AREF (key
, 0)) && ASIZE (key
) > 1 ? 1 : 0);
1708 /* We are not interested in locations without event data */
1710 if (EVENT_HAS_PARAMETERS (event
) && CONSP (XCDR (event
)))
1712 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (event
));
1713 if (EQ (kind
, Qmouse_click
))
1714 position
= EVENT_START (event
);
1718 value
= Flookup_key (Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
)),
1719 key
, accept_default
);
1721 if (NILP (value
) || INTEGERP (value
))
1724 /* If the result of the ordinary keymap lookup is an interactive
1725 command, look for a key binding (ie. remapping) for that command. */
1727 if (NILP (no_remap
) && SYMBOLP (value
))
1730 if (value1
= Fcommand_remapping (value
, position
, Qnil
), !NILP (value1
))
1737 /* GC is possible in this function if it autoloads a keymap. */
1739 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1740 doc
: /* Return the binding for command KEYS in current local keymap only.
1741 KEYS is a string or vector, a sequence of keystrokes.
1742 The binding is probably a symbol with a function definition.
1744 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1745 bindings; see the description of `lookup-key' for more details about this. */)
1746 (Lisp_Object keys
, Lisp_Object accept_default
)
1748 register Lisp_Object map
;
1749 map
= BVAR (current_buffer
, keymap
);
1752 return Flookup_key (map
, keys
, accept_default
);
1755 /* GC is possible in this function if it autoloads a keymap. */
1757 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1758 doc
: /* Return the binding for command KEYS in current global keymap only.
1759 KEYS is a string or vector, a sequence of keystrokes.
1760 The binding is probably a symbol with a function definition.
1761 This function's return values are the same as those of `lookup-key'
1764 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1765 bindings; see the description of `lookup-key' for more details about this. */)
1766 (Lisp_Object keys
, Lisp_Object accept_default
)
1768 return Flookup_key (current_global_map
, keys
, accept_default
);
1771 /* GC is possible in this function if it autoloads a keymap. */
1773 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1774 doc
: /* Find the visible minor mode bindings of KEY.
1775 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1776 the symbol which names the minor mode binding KEY, and BINDING is
1777 KEY's definition in that mode. In particular, if KEY has no
1778 minor-mode bindings, return nil. If the first binding is a
1779 non-prefix, all subsequent bindings will be omitted, since they would
1780 be ignored. Similarly, the list doesn't include non-prefix bindings
1781 that come after prefix bindings.
1783 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1784 bindings; see the description of `lookup-key' for more details about this. */)
1785 (Lisp_Object key
, Lisp_Object accept_default
)
1787 Lisp_Object
*modes
, *maps
;
1789 Lisp_Object binding
;
1791 struct gcpro gcpro1
, gcpro2
;
1793 nmaps
= current_minor_maps (&modes
, &maps
);
1794 /* Note that all these maps are GCPRO'd
1795 in the places where we found them. */
1798 GCPRO2 (key
, binding
);
1800 for (i
= j
= 0; i
< nmaps
; i
++)
1802 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1803 && !INTEGERP (binding
))
1805 if (KEYMAPP (binding
))
1806 maps
[j
++] = Fcons (modes
[i
], binding
);
1808 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1812 return Flist (j
, maps
);
1815 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1816 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1817 A new sparse keymap is stored as COMMAND's function definition and its value.
1818 If a second optional argument MAPVAR is given, the map is stored as
1819 its value instead of as COMMAND's value; but COMMAND is still defined
1821 The third optional argument NAME, if given, supplies a menu name
1822 string for the map. This is required to use the keymap as a menu.
1823 This function returns COMMAND. */)
1824 (Lisp_Object command
, Lisp_Object mapvar
, Lisp_Object name
)
1827 map
= Fmake_sparse_keymap (name
);
1828 Ffset (command
, map
);
1832 Fset (command
, map
);
1836 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1837 doc
: /* Select KEYMAP as the global keymap. */)
1838 (Lisp_Object keymap
)
1840 keymap
= get_keymap (keymap
, 1, 1);
1841 current_global_map
= keymap
;
1846 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1847 doc
: /* Select KEYMAP as the local keymap.
1848 If KEYMAP is nil, that means no local keymap. */)
1849 (Lisp_Object keymap
)
1852 keymap
= get_keymap (keymap
, 1, 1);
1854 BVAR (current_buffer
, keymap
) = keymap
;
1859 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1860 doc
: /* Return current buffer's local keymap, or nil if it has none.
1861 Normally the local keymap is set by the major mode with `use-local-map'. */)
1864 return BVAR (current_buffer
, keymap
);
1867 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1868 doc
: /* Return the current global keymap. */)
1871 return current_global_map
;
1874 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1875 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1879 int nmaps
= current_minor_maps (0, &maps
);
1881 return Flist (nmaps
, maps
);
1884 /* Help functions for describing and documenting keymaps. */
1886 struct accessible_keymaps_data
{
1887 Lisp_Object maps
, tail
, thisseq
;
1888 /* Does the current sequence end in the meta-prefix-char? */
1893 accessible_keymaps_1 (Lisp_Object key
, Lisp_Object cmd
, Lisp_Object args
, void *data
)
1894 /* Use void* data to be compatible with map_keymap_function_t. */
1896 struct accessible_keymaps_data
*d
= data
; /* Cast! */
1897 Lisp_Object maps
= d
->maps
;
1898 Lisp_Object tail
= d
->tail
;
1899 Lisp_Object thisseq
= d
->thisseq
;
1900 int is_metized
= d
->is_metized
&& INTEGERP (key
);
1903 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1907 /* Look for and break cycles. */
1908 while (!NILP (tem
= Frassq (cmd
, maps
)))
1910 Lisp_Object prefix
= XCAR (tem
);
1911 int lim
= XINT (Flength (XCAR (tem
)));
1912 if (lim
<= XINT (Flength (thisseq
)))
1913 { /* This keymap was already seen with a smaller prefix. */
1915 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1916 Faref (thisseq
, make_number (i
))))
1919 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1922 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1923 but maybe `cmd' occurs again further down in `maps', so keep
1925 maps
= XCDR (Fmemq (tem
, maps
));
1928 /* If the last key in thisseq is meta-prefix-char,
1929 turn it into a meta-ized keystroke. We know
1930 that the event we're about to append is an
1931 ascii keystroke since we're processing a
1935 int meta_bit
= meta_modifier
;
1936 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1937 tem
= Fcopy_sequence (thisseq
);
1939 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1941 /* This new sequence is the same length as
1942 thisseq, so stick it in the list right
1945 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1949 tem
= append_key (thisseq
, key
);
1950 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1954 /* This function cannot GC. */
1956 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1958 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1959 Returns a list of elements of the form (KEYS . MAP), where the sequence
1960 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1961 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1962 An optional argument PREFIX, if non-nil, should be a key sequence;
1963 then the value includes only maps for prefixes that start with PREFIX. */)
1964 (Lisp_Object keymap
, Lisp_Object prefix
)
1966 Lisp_Object maps
, tail
;
1967 int prefixlen
= XINT (Flength (prefix
));
1969 /* no need for gcpro because we don't autoload any keymaps. */
1973 /* If a prefix was specified, start with the keymap (if any) for
1974 that prefix, so we don't waste time considering other prefixes. */
1976 tem
= Flookup_key (keymap
, prefix
, Qt
);
1977 /* Flookup_key may give us nil, or a number,
1978 if the prefix is not defined in this particular map.
1979 It might even give us a list that isn't a keymap. */
1980 tem
= get_keymap (tem
, 0, 0);
1981 /* If the keymap is autoloaded `tem' is not a cons-cell, but we still
1982 want to return it. */
1985 /* Convert PREFIX to a vector now, so that later on
1986 we don't have to deal with the possibility of a string. */
1987 if (STRINGP (prefix
))
1992 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1993 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1997 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1998 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1999 c
^= 0200 | meta_modifier
;
2000 ASET (copy
, i_before
, make_number (c
));
2004 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
2010 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
2011 get_keymap (keymap
, 1, 0)),
2014 /* For each map in the list maps,
2015 look at any other maps it points to,
2016 and stick them at the end if they are not already in the list.
2018 This is a breadth-first traversal, where tail is the queue of
2019 nodes, and maps accumulates a list of all nodes visited. */
2021 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
2023 struct accessible_keymaps_data data
;
2024 register Lisp_Object thismap
= Fcdr (XCAR (tail
));
2027 data
.thisseq
= Fcar (XCAR (tail
));
2030 last
= make_number (XINT (Flength (data
.thisseq
)) - 1);
2031 /* Does the current sequence end in the meta-prefix-char? */
2032 data
.is_metized
= (XINT (last
) >= 0
2033 /* Don't metize the last char of PREFIX. */
2034 && XINT (last
) >= prefixlen
2035 && EQ (Faref (data
.thisseq
, last
), meta_prefix_char
));
2037 /* Since we can't run lisp code, we can't scan autoloaded maps. */
2038 if (CONSP (thismap
))
2039 map_keymap (thismap
, accessible_keymaps_1
, Qnil
, &data
, 0);
2043 static Lisp_Object Qsingle_key_description
, Qkey_description
;
2045 /* This function cannot GC. */
2047 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2048 doc
: /* Return a pretty description of key-sequence KEYS.
2049 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2050 Control characters turn into "C-foo" sequences, meta into "M-foo",
2051 spaces are put between sequence elements, etc. */)
2052 (Lisp_Object keys
, Lisp_Object prefix
)
2057 int size
= XINT (Flength (keys
));
2059 Lisp_Object sep
= build_string (" ");
2064 size
+= XINT (Flength (prefix
));
2066 /* This has one extra element at the end that we don't pass to Fconcat. */
2067 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2069 /* In effect, this computes
2070 (mapconcat 'single-key-description keys " ")
2071 but we shouldn't use mapconcat because it can do GC. */
2075 list
= prefix
, prefix
= Qnil
;
2076 else if (!NILP (keys
))
2077 list
= keys
, keys
= Qnil
;
2082 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2086 return empty_unibyte_string
;
2087 return Fconcat (len
- 1, args
);
2091 size
= SCHARS (list
);
2092 else if (VECTORP (list
))
2093 size
= ASIZE (list
);
2094 else if (CONSP (list
))
2095 size
= XINT (Flength (list
));
2097 wrong_type_argument (Qarrayp
, list
);
2106 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2107 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2108 c
^= 0200 | meta_modifier
;
2109 XSETFASTINT (key
, c
);
2111 else if (VECTORP (list
))
2113 key
= AREF (list
, i
); i
++;
2125 || EQ (key
, meta_prefix_char
)
2126 || (XINT (key
) & meta_modifier
))
2128 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2130 if (EQ (key
, meta_prefix_char
))
2134 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2137 else if (EQ (key
, meta_prefix_char
))
2142 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2150 push_key_description (register unsigned int c
, register char *p
, int force_multibyte
)
2154 /* Clear all the meaningless bits above the meta bit. */
2155 c
&= meta_modifier
| ~ - meta_modifier
;
2156 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2157 | meta_modifier
| shift_modifier
| super_modifier
);
2159 if (! CHARACTERP (make_number (c2
)))
2161 /* KEY_DESCRIPTION_SIZE is large enough for this. */
2162 p
+= sprintf (p
, "[%d]", c
);
2166 if (c
& alt_modifier
)
2172 if ((c
& ctrl_modifier
) != 0
2173 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2177 c
&= ~ctrl_modifier
;
2179 if (c
& hyper_modifier
)
2183 c
-= hyper_modifier
;
2185 if (c
& meta_modifier
)
2191 if (c
& shift_modifier
)
2195 c
-= shift_modifier
;
2197 if (c
& super_modifier
)
2201 c
-= super_modifier
;
2217 else if (c
== Ctl ('M'))
2225 /* `C-' already added above. */
2226 if (c
> 0 && c
<= Ctl ('Z'))
2245 || (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
2246 && SINGLE_BYTE_CHAR_P (c
)
2247 && !force_multibyte
))
2253 /* Now we are sure that C is a valid character code. */
2254 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
2255 && ! force_multibyte
)
2256 *p
++ = multibyte_char_to_unibyte (c
);
2258 p
+= CHAR_STRING (c
, (unsigned char *) p
);
2264 /* This function cannot GC. */
2266 DEFUN ("single-key-description", Fsingle_key_description
,
2267 Ssingle_key_description
, 1, 2, 0,
2268 doc
: /* Return a pretty description of command character KEY.
2269 Control characters turn into C-whatever, etc.
2270 Optional argument NO-ANGLES non-nil means don't put angle brackets
2271 around function keys and event symbols. */)
2272 (Lisp_Object key
, Lisp_Object no_angles
)
2274 if (CONSP (key
) && lucid_event_type_list_p (key
))
2275 key
= Fevent_convert_list (key
);
2277 key
= EVENT_HEAD (key
);
2279 if (INTEGERP (key
)) /* Normal character */
2281 char tem
[KEY_DESCRIPTION_SIZE
];
2283 *push_key_description (XINT (key
), tem
, 1) = 0;
2284 return build_string (tem
);
2286 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2288 if (NILP (no_angles
))
2291 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2292 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2293 return build_string (buffer
);
2296 return Fsymbol_name (key
);
2298 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2299 return Fcopy_sequence (key
);
2301 error ("KEY must be an integer, cons, symbol, or string");
2306 push_text_char_description (register unsigned int c
, register char *p
)
2317 *p
++ = c
+ 64; /* 'A' - 1 */
2329 /* This function cannot GC. */
2331 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2332 doc
: /* Return a pretty description of file-character CHARACTER.
2333 Control characters turn into "^char", etc. This differs from
2334 `single-key-description' which turns them into "C-char".
2335 Also, this function recognizes the 2**7 bit as the Meta character,
2336 whereas `single-key-description' uses the 2**27 bit for Meta.
2337 See Info node `(elisp)Describing Characters' for examples. */)
2338 (Lisp_Object character
)
2340 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2344 CHECK_NUMBER (character
);
2346 c
= XINT (character
);
2347 if (!ASCII_CHAR_P (c
))
2349 int len
= CHAR_STRING (c
, (unsigned char *) str
);
2351 return make_multibyte_string (str
, 1, len
);
2354 *push_text_char_description (c
& 0377, str
) = 0;
2356 return build_string (str
);
2359 static int where_is_preferred_modifier
;
2361 /* Return 0 if SEQ uses non-preferred modifiers or non-char events.
2362 Else, return 2 if SEQ uses the where_is_preferred_modifier,
2365 preferred_sequence_p (Lisp_Object seq
)
2368 int len
= XINT (Flength (seq
));
2371 for (i
= 0; i
< len
; i
++)
2373 Lisp_Object ii
, elt
;
2375 XSETFASTINT (ii
, i
);
2376 elt
= Faref (seq
, ii
);
2378 if (!INTEGERP (elt
))
2382 int modifiers
= XINT (elt
) & (CHAR_MODIFIER_MASK
& ~CHAR_META
);
2383 if (modifiers
== where_is_preferred_modifier
)
2394 /* where-is - finding a command in a set of keymaps. */
2396 static void where_is_internal_1 (Lisp_Object key
, Lisp_Object binding
,
2397 Lisp_Object args
, void *data
);
2399 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2400 Returns the first non-nil binding found in any of those maps.
2401 If REMAP is true, pass the result of the lookup through command
2402 remapping before returning it. */
2405 shadow_lookup (Lisp_Object shadow
, Lisp_Object key
, Lisp_Object flag
,
2408 Lisp_Object tail
, value
;
2410 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2412 value
= Flookup_key (XCAR (tail
), key
, flag
);
2413 if (NATNUMP (value
))
2415 value
= Flookup_key (XCAR (tail
),
2416 Fsubstring (key
, make_number (0), value
), flag
);
2420 else if (!NILP (value
))
2422 Lisp_Object remapping
;
2423 if (remap
&& SYMBOLP (value
)
2424 && (remapping
= Fcommand_remapping (value
, Qnil
, shadow
),
2434 static Lisp_Object Vmouse_events
;
2436 struct where_is_internal_data
{
2437 Lisp_Object definition
, this, last
;
2438 int last_is_meta
, noindirect
;
2439 Lisp_Object sequences
;
2442 /* This function can't GC, AFAIK. */
2443 /* Return the list of bindings found. This list is ordered "longest
2444 to shortest". It may include bindings that are actually shadowed
2445 by others, as well as duplicate bindings and remapping bindings.
2446 The list returned is potentially shared with where_is_cache, so
2447 be careful not to modify it via side-effects. */
2450 where_is_internal (Lisp_Object definition
, Lisp_Object keymaps
,
2451 int noindirect
, int nomenus
)
2453 Lisp_Object maps
= Qnil
;
2455 struct where_is_internal_data data
;
2457 /* Only important use of caching is for the menubar
2458 (i.e. where-is-internal called with (def nil t nil nil)). */
2459 if (nomenus
&& !noindirect
)
2461 /* Check heuristic-consistency of the cache. */
2462 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2463 where_is_cache
= Qnil
;
2465 if (NILP (where_is_cache
))
2467 /* We need to create the cache. */
2468 Lisp_Object args
[2];
2469 where_is_cache
= Fmake_hash_table (0, args
);
2470 where_is_cache_keymaps
= Qt
;
2473 /* We can reuse the cache. */
2474 return Fgethash (definition
, where_is_cache
, Qnil
);
2477 /* Kill the cache so that where_is_internal_1 doesn't think
2478 we're filling it up. */
2479 where_is_cache
= Qnil
;
2482 while (CONSP (found
))
2486 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2487 found
= XCDR (found
);
2490 data
.sequences
= Qnil
;
2491 for (; CONSP (maps
); maps
= XCDR (maps
))
2493 /* Key sequence to reach map, and the map that it reaches */
2494 register Lisp_Object
this, map
, tem
;
2496 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2497 [M-CHAR] sequences, check if last character of the sequence
2498 is the meta-prefix char. */
2502 this = Fcar (XCAR (maps
));
2503 map
= Fcdr (XCAR (maps
));
2504 last
= make_number (XINT (Flength (this)) - 1);
2505 last_is_meta
= (XINT (last
) >= 0
2506 && EQ (Faref (this, last
), meta_prefix_char
));
2508 /* if (nomenus && !preferred_sequence_p (this)) */
2509 if (nomenus
&& XINT (last
) >= 0
2510 && SYMBOLP (tem
= Faref (this, make_number (0)))
2511 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2512 /* If no menu entries should be returned, skip over the
2513 keymaps bound to `menu-bar' and `tool-bar' and other
2514 non-ascii prefixes like `C-down-mouse-2'. */
2519 data
.definition
= definition
;
2520 data
.noindirect
= noindirect
;
2523 data
.last_is_meta
= last_is_meta
;
2526 map_keymap (map
, where_is_internal_1
, Qnil
, &data
, 0);
2529 if (nomenus
&& !noindirect
)
2530 { /* Remember for which keymaps this cache was built.
2531 We do it here (late) because we want to keep where_is_cache_keymaps
2532 set to t while the cache isn't fully filled. */
2533 where_is_cache_keymaps
= keymaps
;
2534 /* During cache-filling, data.sequences is not filled by
2535 where_is_internal_1. */
2536 return Fgethash (definition
, where_is_cache
, Qnil
);
2539 return data
.sequences
;
2542 /* This function can GC if Flookup_key autoloads any keymaps. */
2544 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2545 doc
: /* Return list of keys that invoke DEFINITION.
2546 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2547 If KEYMAP is nil, search all the currently active keymaps.
2548 If KEYMAP is a list of keymaps, search only those keymaps.
2550 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2551 rather than a list of all possible key sequences.
2552 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2553 no matter what it is.
2554 If FIRSTONLY has another non-nil value, prefer bindings
2555 that use the modifier key specified in `where-is-preferred-modifier'
2556 \(or their meta variants) and entirely reject menu bindings.
2558 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2559 to other keymaps or slots. This makes it possible to search for an
2560 indirect definition itself.
2562 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2563 that invoke a command which is remapped to DEFINITION, but include the
2564 remapped command in the returned list. */)
2565 (Lisp_Object definition
, Lisp_Object keymap
, Lisp_Object firstonly
, Lisp_Object noindirect
, Lisp_Object no_remap
)
2567 /* The keymaps in which to search. */
2568 Lisp_Object keymaps
;
2569 /* Potentially relevant bindings in "shortest to longest" order. */
2570 Lisp_Object sequences
= Qnil
;
2571 /* Actually relevant bindings. */
2572 Lisp_Object found
= Qnil
;
2573 /* 1 means ignore all menu bindings entirely. */
2574 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2575 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
, gcpro6
;
2576 /* List of sequences found via remapping. Keep them in a separate
2577 variable, so as to push them later, since we prefer
2578 non-remapped binding. */
2579 Lisp_Object remapped_sequences
= Qnil
;
2580 /* Whether or not we're handling remapped sequences. This is needed
2581 because remapping is not done recursively by Fcommand_remapping: you
2582 can't remap a remapped command. */
2584 Lisp_Object tem
= Qnil
;
2586 /* Refresh the C version of the modifier preference. */
2587 where_is_preferred_modifier
2588 = parse_solitary_modifier (Vwhere_is_preferred_modifier
);
2590 /* Find the relevant keymaps. */
2591 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2593 else if (!NILP (keymap
))
2594 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2596 keymaps
= Fcurrent_active_maps (Qnil
, Qnil
);
2598 GCPRO6 (definition
, keymaps
, found
, sequences
, remapped_sequences
, tem
);
2600 tem
= Fcommand_remapping (definition
, Qnil
, keymaps
);
2601 /* If `definition' is remapped to tem', then OT1H no key will run
2602 that command (since they will run `tem' instead), so we should
2603 return nil; but OTOH all keys bound to `definition' (or to `tem')
2604 will run the same command.
2605 So for menu-shortcut purposes, we want to find all the keys bound (maybe
2606 via remapping) to `tem'. But for the purpose of finding the keys that
2607 run `definition', then we'd want to just return nil.
2608 We choose to make it work right for menu-shortcuts, since it's the most
2610 Known bugs: if you remap switch-to-buffer to toto, C-h f switch-to-buffer
2611 will tell you that switch-to-buffer is bound to C-x b even though C-x b
2612 will run toto instead. And if `toto' is itself remapped to forward-char,
2613 then C-h f toto will tell you that it's bound to C-f even though C-f does
2614 not run toto and it won't tell you that C-x b does run toto. */
2615 if (NILP (no_remap
) && !NILP (tem
))
2618 if (SYMBOLP (definition
)
2619 && !NILP (firstonly
)
2620 && !NILP (tem
= Fget (definition
, QCadvertised_binding
)))
2622 /* We have a list of advertised bindings. */
2624 if (EQ (shadow_lookup (keymaps
, XCAR (tem
), Qnil
, 0), definition
))
2628 if (EQ (shadow_lookup (keymaps
, tem
, Qnil
, 0), definition
))
2632 sequences
= Freverse (where_is_internal (definition
, keymaps
,
2633 !NILP (noindirect
), nomenus
));
2635 while (CONSP (sequences
)
2636 /* If we're at the end of the `sequences' list and we haven't
2637 considered remapped sequences yet, copy them over and
2639 || (!remapped
&& (sequences
= remapped_sequences
,
2641 CONSP (sequences
))))
2643 Lisp_Object sequence
, function
;
2645 sequence
= XCAR (sequences
);
2646 sequences
= XCDR (sequences
);
2648 /* Verify that this key binding is not shadowed by another
2649 binding for the same key, before we say it exists.
2651 Mechanism: look for local definition of this key and if
2652 it is defined and does not match what we found then
2655 Either nil or number as value from Flookup_key
2657 if (NILP (Fequal (shadow_lookup (keymaps
, sequence
, Qnil
, remapped
),
2661 /* If the current sequence is a command remapping with
2662 format [remap COMMAND], find the key sequences
2663 which run COMMAND, and use those sequences instead. */
2664 if (NILP (no_remap
) && !remapped
2665 && VECTORP (sequence
) && ASIZE (sequence
) == 2
2666 && EQ (AREF (sequence
, 0), Qremap
)
2667 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2669 Lisp_Object seqs
= where_is_internal (function
, keymaps
,
2670 !NILP (noindirect
), nomenus
);
2671 remapped_sequences
= nconc2 (Freverse (seqs
), remapped_sequences
);
2675 /* Don't annoy user with strings from a menu such as the
2676 entries from the "Edit => Paste from Kill Menu".
2677 Change them all to "(any string)", so that there
2678 seems to be only one menu item to report. */
2679 if (! NILP (sequence
))
2682 tem1
= Faref (sequence
, make_number (ASIZE (sequence
) - 1));
2684 Faset (sequence
, make_number (ASIZE (sequence
) - 1),
2685 build_string ("(any string)"));
2688 /* It is a true unshadowed match. Record it, unless it's already
2689 been seen (as could happen when inheriting keymaps). */
2690 if (NILP (Fmember (sequence
, found
)))
2691 found
= Fcons (sequence
, found
);
2693 /* If firstonly is Qnon_ascii, then we can return the first
2694 binding we find. If firstonly is not Qnon_ascii but not
2695 nil, then we should return the first ascii-only binding
2697 if (EQ (firstonly
, Qnon_ascii
))
2698 RETURN_UNGCPRO (sequence
);
2699 else if (!NILP (firstonly
)
2700 && 2 == preferred_sequence_p (sequence
))
2701 RETURN_UNGCPRO (sequence
);
2706 found
= Fnreverse (found
);
2708 /* firstonly may have been t, but we may have gone all the way through
2709 the keymaps without finding an all-ASCII key sequence. So just
2710 return the best we could find. */
2711 if (NILP (firstonly
))
2713 else if (where_is_preferred_modifier
== 0)
2714 return Fcar (found
);
2716 { /* Maybe we did not find a preferred_modifier binding, but we did find
2717 some ASCII binding. */
2718 Lisp_Object bindings
= found
;
2719 while (CONSP (bindings
))
2720 if (preferred_sequence_p (XCAR (bindings
)))
2721 return XCAR (bindings
);
2723 bindings
= XCDR (bindings
);
2724 return Fcar (found
);
2728 /* This function can GC because get_keyelt can. */
2731 where_is_internal_1 (Lisp_Object key
, Lisp_Object binding
, Lisp_Object args
, void *data
)
2733 struct where_is_internal_data
*d
= data
; /* Cast! */
2734 Lisp_Object definition
= d
->definition
;
2735 int noindirect
= d
->noindirect
;
2736 Lisp_Object
this = d
->this;
2737 Lisp_Object last
= d
->last
;
2738 int last_is_meta
= d
->last_is_meta
;
2739 Lisp_Object sequence
;
2741 /* Search through indirections unless that's not wanted. */
2743 binding
= get_keyelt (binding
, 0);
2745 /* End this iteration if this element does not match
2748 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2749 || EQ (binding
, definition
)
2750 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2751 /* Doesn't match. */
2754 /* We have found a match. Construct the key sequence where we found it. */
2755 if (INTEGERP (key
) && last_is_meta
)
2757 sequence
= Fcopy_sequence (this);
2758 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2763 key
= Fcons (XCAR (key
), XCDR (key
));
2764 sequence
= append_key (this, key
);
2767 if (!NILP (where_is_cache
))
2769 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2770 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2773 d
->sequences
= Fcons (sequence
, d
->sequences
);
2776 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2778 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2779 doc
: /* Insert the list of all defined keys and their definitions.
2780 The list is inserted in the current buffer, while the bindings are
2781 looked up in BUFFER.
2782 The optional argument PREFIX, if non-nil, should be a key sequence;
2783 then we display only bindings that start with that prefix.
2784 The optional argument MENUS, if non-nil, says to mention menu bindings.
2785 \(Ordinarily these are omitted from the output.) */)
2786 (Lisp_Object buffer
, Lisp_Object prefix
, Lisp_Object menus
)
2788 Lisp_Object outbuf
, shadow
;
2789 int nomenu
= NILP (menus
);
2790 register Lisp_Object start1
;
2791 struct gcpro gcpro1
;
2793 const char *alternate_heading
2795 Keyboard translations:\n\n\
2796 You type Translation\n\
2797 -------- -----------\n";
2799 CHECK_BUFFER (buffer
);
2804 outbuf
= Fcurrent_buffer ();
2806 /* Report on alternates for keys. */
2807 if (STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
)) && !NILP (prefix
))
2810 const unsigned char *translate
= SDATA (KVAR (current_kboard
, Vkeyboard_translate_table
));
2811 int translate_len
= SCHARS (KVAR (current_kboard
, Vkeyboard_translate_table
));
2813 for (c
= 0; c
< translate_len
; c
++)
2814 if (translate
[c
] != c
)
2816 char buf
[KEY_DESCRIPTION_SIZE
];
2819 if (alternate_heading
)
2821 insert_string (alternate_heading
);
2822 alternate_heading
= 0;
2825 bufend
= push_key_description (translate
[c
], buf
, 1);
2826 insert (buf
, bufend
- buf
);
2827 Findent_to (make_number (16), make_number (1));
2828 bufend
= push_key_description (c
, buf
, 1);
2829 insert (buf
, bufend
- buf
);
2833 /* Insert calls signal_after_change which may GC. */
2834 translate
= SDATA (KVAR (current_kboard
, Vkeyboard_translate_table
));
2840 if (!NILP (Vkey_translation_map
))
2841 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2842 "Key translations", nomenu
, 1, 0, 0);
2845 /* Print the (major mode) local map. */
2847 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
2848 start1
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
2849 else if (!NILP (Voverriding_local_map
))
2850 start1
= Voverriding_local_map
;
2854 describe_map_tree (start1
, 1, shadow
, prefix
,
2855 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2856 shadow
= Fcons (start1
, shadow
);
2860 /* Print the minor mode and major mode keymaps. */
2862 Lisp_Object
*modes
, *maps
;
2864 /* Temporarily switch to `buffer', so that we can get that buffer's
2865 minor modes correctly. */
2866 Fset_buffer (buffer
);
2868 nmaps
= current_minor_maps (&modes
, &maps
);
2869 Fset_buffer (outbuf
);
2871 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2872 XBUFFER (buffer
), Qkeymap
);
2875 describe_map_tree (start1
, 1, shadow
, prefix
,
2876 "\f\n`keymap' Property Bindings", nomenu
,
2878 shadow
= Fcons (start1
, shadow
);
2881 /* Print the minor mode maps. */
2882 for (i
= 0; i
< nmaps
; i
++)
2884 /* The title for a minor mode keymap
2885 is constructed at run time.
2886 We let describe_map_tree do the actual insertion
2887 because it takes care of other features when doing so. */
2890 if (!SYMBOLP (modes
[i
]))
2893 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2897 memcpy (p
, SDATA (SYMBOL_NAME (modes
[i
])),
2898 SCHARS (SYMBOL_NAME (modes
[i
])));
2899 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2901 memcpy (p
, " Minor Mode Bindings", strlen (" Minor Mode Bindings"));
2902 p
+= strlen (" Minor Mode Bindings");
2905 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2906 title
, nomenu
, 0, 0, 0);
2907 shadow
= Fcons (maps
[i
], shadow
);
2910 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2911 XBUFFER (buffer
), Qlocal_map
);
2914 if (EQ (start1
, BVAR (XBUFFER (buffer
), keymap
)))
2915 describe_map_tree (start1
, 1, shadow
, prefix
,
2916 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2918 describe_map_tree (start1
, 1, shadow
, prefix
,
2919 "\f\n`local-map' Property Bindings",
2922 shadow
= Fcons (start1
, shadow
);
2926 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2927 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2929 /* Print the function-key-map translations under this prefix. */
2930 if (!NILP (KVAR (current_kboard
, Vlocal_function_key_map
)))
2931 describe_map_tree (KVAR (current_kboard
, Vlocal_function_key_map
), 0, Qnil
, prefix
,
2932 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2934 /* Print the input-decode-map translations under this prefix. */
2935 if (!NILP (KVAR (current_kboard
, Vinput_decode_map
)))
2936 describe_map_tree (KVAR (current_kboard
, Vinput_decode_map
), 0, Qnil
, prefix
,
2937 "\f\nInput decoding map translations", nomenu
, 1, 0, 0);
2943 /* Insert a description of the key bindings in STARTMAP,
2944 followed by those of all maps reachable through STARTMAP.
2945 If PARTIAL is nonzero, omit certain "uninteresting" commands
2946 (such as `undefined').
2947 If SHADOW is non-nil, it is a list of maps;
2948 don't mention keys which would be shadowed by any of them.
2949 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2950 TITLE, if not 0, is a string to insert at the beginning.
2951 TITLE should not end with a colon or a newline; we supply that.
2952 If NOMENU is not 0, then omit menu-bar commands.
2954 If TRANSL is nonzero, the definitions are actually key translations
2955 so print strings and vectors differently.
2957 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2960 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
2961 don't omit it; instead, mention it but say it is shadowed.
2963 Return whether something was inserted or not. */
2966 describe_map_tree (Lisp_Object startmap
, int partial
, Lisp_Object shadow
,
2967 Lisp_Object prefix
, const char *title
, int nomenu
, int transl
,
2968 int always_title
, int mention_shadow
)
2970 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2971 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2973 const char *key_heading
2978 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
2981 GCPRO3 (maps
, seen
, sub_shadows
);
2987 /* Delete from MAPS each element that is for the menu bar. */
2988 for (list
= maps
; CONSP (list
); list
= XCDR (list
))
2990 Lisp_Object elt
, elt_prefix
, tem
;
2993 elt_prefix
= Fcar (elt
);
2994 if (ASIZE (elt_prefix
) >= 1)
2996 tem
= Faref (elt_prefix
, make_number (0));
2997 if (EQ (tem
, Qmenu_bar
))
2998 maps
= Fdelq (elt
, maps
);
3003 if (!NILP (maps
) || always_title
)
3007 insert_string (title
);
3010 insert_string (" Starting With ");
3011 insert1 (Fkey_description (prefix
, Qnil
));
3013 insert_string (":\n");
3015 insert_string (key_heading
);
3019 for (; CONSP (maps
); maps
= XCDR (maps
))
3021 register Lisp_Object elt
, elt_prefix
, tail
;
3024 elt_prefix
= Fcar (elt
);
3028 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3032 shmap
= XCAR (tail
);
3034 /* If the sequence by which we reach this keymap is zero-length,
3035 then the shadow map for this keymap is just SHADOW. */
3036 if ((STRINGP (elt_prefix
) && SCHARS (elt_prefix
) == 0)
3037 || (VECTORP (elt_prefix
) && ASIZE (elt_prefix
) == 0))
3039 /* If the sequence by which we reach this keymap actually has
3040 some elements, then the sequence's definition in SHADOW is
3041 what we should use. */
3044 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3045 if (INTEGERP (shmap
))
3049 /* If shmap is not nil and not a keymap,
3050 it completely shadows this map, so don't
3051 describe this map at all. */
3052 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3056 sub_shadows
= Fcons (shmap
, sub_shadows
);
3059 /* Maps we have already listed in this loop shadow this map. */
3060 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3063 tem
= Fequal (Fcar (XCAR (tail
)), elt_prefix
);
3065 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3068 describe_map (Fcdr (elt
), elt_prefix
,
3069 transl
? describe_translation
: describe_command
,
3070 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3079 static int previous_description_column
;
3082 describe_command (Lisp_Object definition
, Lisp_Object args
)
3084 register Lisp_Object tem1
;
3085 EMACS_INT column
= current_column ();
3086 int description_column
;
3088 /* If column 16 is no good, go to col 32;
3089 but don't push beyond that--go to next line instead. */
3093 description_column
= 32;
3095 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3096 description_column
= 32;
3098 description_column
= 16;
3100 Findent_to (make_number (description_column
), make_number (1));
3101 previous_description_column
= description_column
;
3103 if (SYMBOLP (definition
))
3105 tem1
= SYMBOL_NAME (definition
);
3107 insert_string ("\n");
3109 else if (STRINGP (definition
) || VECTORP (definition
))
3110 insert_string ("Keyboard Macro\n");
3111 else if (KEYMAPP (definition
))
3112 insert_string ("Prefix Command\n");
3114 insert_string ("??\n");
3118 describe_translation (Lisp_Object definition
, Lisp_Object args
)
3120 register Lisp_Object tem1
;
3122 Findent_to (make_number (16), make_number (1));
3124 if (SYMBOLP (definition
))
3126 tem1
= SYMBOL_NAME (definition
);
3128 insert_string ("\n");
3130 else if (STRINGP (definition
) || VECTORP (definition
))
3132 insert1 (Fkey_description (definition
, Qnil
));
3133 insert_string ("\n");
3135 else if (KEYMAPP (definition
))
3136 insert_string ("Prefix Command\n");
3138 insert_string ("??\n");
3141 /* describe_map puts all the usable elements of a sparse keymap
3142 into an array of `struct describe_map_elt',
3143 then sorts them by the events. */
3145 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3147 /* qsort comparison function for sorting `struct describe_map_elt' by
3151 describe_map_compare (const void *aa
, const void *bb
)
3153 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3154 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3155 return ((XINT (a
->event
) > XINT (b
->event
))
3156 - (XINT (a
->event
) < XINT (b
->event
)));
3157 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3159 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3161 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3162 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3163 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3168 /* Describe the contents of map MAP, assuming that this map itself is
3169 reached by the sequence of prefix keys PREFIX (a string or vector).
3170 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3173 describe_map (Lisp_Object map
, Lisp_Object prefix
,
3174 void (*elt_describer
) (Lisp_Object
, Lisp_Object
),
3175 int partial
, Lisp_Object shadow
,
3176 Lisp_Object
*seen
, int nomenu
, int mention_shadow
)
3178 Lisp_Object tail
, definition
, event
;
3180 Lisp_Object suppress
;
3183 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3185 /* These accumulate the values from sparse keymap bindings,
3186 so we can sort them and handle them in order. */
3187 int length_needed
= 0;
3188 struct describe_map_elt
*vect
;
3195 suppress
= intern ("suppress-keymap");
3197 /* This vector gets used to present single keys to Flookup_key. Since
3198 that is done once per keymap element, we don't want to cons up a
3199 fresh vector every time. */
3200 kludge
= Fmake_vector (make_number (1), Qnil
);
3203 GCPRO3 (prefix
, definition
, kludge
);
3205 map
= call1 (Qkeymap_canonicalize
, map
);
3207 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3210 vect
= ((struct describe_map_elt
*)
3211 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3213 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3217 if (VECTORP (XCAR (tail
))
3218 || CHAR_TABLE_P (XCAR (tail
)))
3219 describe_vector (XCAR (tail
),
3220 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3222 else if (CONSP (XCAR (tail
)))
3224 int this_shadowed
= 0;
3226 event
= XCAR (XCAR (tail
));
3228 /* Ignore bindings whose "prefix" are not really valid events.
3229 (We get these in the frames and buffers menu.) */
3230 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3233 if (nomenu
&& EQ (event
, Qmenu_bar
))
3236 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3238 /* Don't show undefined commands or suppressed commands. */
3239 if (NILP (definition
)) continue;
3240 if (SYMBOLP (definition
) && partial
)
3242 tem
= Fget (definition
, suppress
);
3247 /* Don't show a command that isn't really visible
3248 because a local definition of the same key shadows it. */
3250 ASET (kludge
, 0, event
);
3253 tem
= shadow_lookup (shadow
, kludge
, Qt
, 0);
3256 /* If both bindings are keymaps, this key is a prefix key,
3257 so don't say it is shadowed. */
3258 if (KEYMAPP (definition
) && KEYMAPP (tem
))
3260 /* Avoid generating duplicate entries if the
3261 shadowed binding has the same definition. */
3262 else if (mention_shadow
&& !EQ (tem
, definition
))
3269 tem
= Flookup_key (map
, kludge
, Qt
);
3270 if (!EQ (tem
, definition
)) continue;
3272 vect
[slots_used
].event
= event
;
3273 vect
[slots_used
].definition
= definition
;
3274 vect
[slots_used
].shadowed
= this_shadowed
;
3277 else if (EQ (XCAR (tail
), Qkeymap
))
3279 /* The same keymap might be in the structure twice, if we're
3280 using an inherited keymap. So skip anything we've already
3282 tem
= Fassq (tail
, *seen
);
3283 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3285 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3289 /* If we found some sparse map events, sort them. */
3291 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3292 describe_map_compare
);
3294 /* Now output them in sorted order. */
3296 for (i
= 0; i
< slots_used
; i
++)
3298 Lisp_Object start
, end
;
3302 previous_description_column
= 0;
3307 ASET (kludge
, 0, vect
[i
].event
);
3308 start
= vect
[i
].event
;
3311 definition
= vect
[i
].definition
;
3313 /* Find consecutive chars that are identically defined. */
3314 if (INTEGERP (vect
[i
].event
))
3316 while (i
+ 1 < slots_used
3317 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3318 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3319 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3321 end
= vect
[i
].event
;
3324 /* Now START .. END is the range to describe next. */
3326 /* Insert the string to describe the event START. */
3327 insert1 (Fkey_description (kludge
, prefix
));
3329 if (!EQ (start
, end
))
3333 ASET (kludge
, 0, end
);
3334 /* Insert the string to describe the character END. */
3335 insert1 (Fkey_description (kludge
, prefix
));
3338 /* Print a description of the definition of this character.
3339 elt_describer will take care of spacing out far enough
3340 for alignment purposes. */
3341 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3343 if (vect
[i
].shadowed
)
3346 insert_string ("\n (that binding is currently shadowed by another mode)");
3355 describe_vector_princ (Lisp_Object elt
, Lisp_Object fun
)
3357 Findent_to (make_number (16), make_number (1));
3362 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3363 doc
: /* Insert a description of contents of VECTOR.
3364 This is text showing the elements of vector matched against indices.
3365 DESCRIBER is the output function used; nil means use `princ'. */)
3366 (Lisp_Object vector
, Lisp_Object describer
)
3368 int count
= SPECPDL_INDEX ();
3369 if (NILP (describer
))
3370 describer
= intern ("princ");
3371 specbind (Qstandard_output
, Fcurrent_buffer ());
3372 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3373 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3376 return unbind_to (count
, Qnil
);
3379 /* Insert in the current buffer a description of the contents of VECTOR.
3380 We call ELT_DESCRIBER to insert the description of one value found
3383 ELT_PREFIX describes what "comes before" the keys or indices defined
3384 by this vector. This is a human-readable string whose size
3385 is not necessarily related to the situation.
3387 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3388 leads to this keymap.
3390 If the vector is a chartable, ELT_PREFIX is the vector
3391 of bytes that lead to the character set or portion of a character
3392 set described by this chartable.
3394 If PARTIAL is nonzero, it means do not mention suppressed commands
3395 (that assumes the vector is in a keymap).
3397 SHADOW is a list of keymaps that shadow this map.
3398 If it is non-nil, then we look up the key in those maps
3399 and we don't mention it now if it is defined by any of them.
3401 ENTIRE_MAP is the keymap in which this vector appears.
3402 If the definition in effect in the whole map does not match
3403 the one in this vector, we ignore this one.
3405 ARGS is simply passed as the second argument to ELT_DESCRIBER.
3407 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3409 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3412 describe_vector (Lisp_Object vector
, Lisp_Object prefix
, Lisp_Object args
,
3413 void (*elt_describer
) (Lisp_Object
, Lisp_Object
),
3414 int partial
, Lisp_Object shadow
, Lisp_Object entire_map
,
3415 int keymap_p
, int mention_shadow
)
3417 Lisp_Object definition
;
3419 Lisp_Object elt_prefix
= Qnil
;
3421 Lisp_Object suppress
;
3424 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3425 /* Range of elements to be handled. */
3427 Lisp_Object character
;
3436 /* Call Fkey_description first, to avoid GC bug for the other string. */
3437 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3440 tem
= Fkey_description (prefix
, Qnil
);
3441 elt_prefix
= concat2 (tem
, build_string (" "));
3446 /* This vector gets used to present single keys to Flookup_key. Since
3447 that is done once per vector element, we don't want to cons up a
3448 fresh vector every time. */
3449 kludge
= Fmake_vector (make_number (1), Qnil
);
3450 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3453 suppress
= intern ("suppress-keymap");
3456 if (CHAR_TABLE_P (vector
))
3457 stop
= MAX_5_BYTE_CHAR
+ 1, to
= MAX_CHAR
+ 1;
3459 stop
= to
= ASIZE (vector
);
3461 for (i
= from
; ; i
++)
3463 int this_shadowed
= 0;
3464 int range_beg
, range_end
;
3478 if (CHAR_TABLE_P (vector
))
3482 val
= char_table_ref_and_range (vector
, range_beg
, &range_beg
, &i
);
3485 val
= AREF (vector
, i
);
3486 definition
= get_keyelt (val
, 0);
3488 if (NILP (definition
)) continue;
3490 /* Don't mention suppressed commands. */
3491 if (SYMBOLP (definition
) && partial
)
3495 tem
= Fget (definition
, suppress
);
3497 if (!NILP (tem
)) continue;
3500 character
= make_number (starting_i
);
3501 ASET (kludge
, 0, character
);
3503 /* If this binding is shadowed by some other map, ignore it. */
3508 tem
= shadow_lookup (shadow
, kludge
, Qt
, 0);
3519 /* Ignore this definition if it is shadowed by an earlier
3520 one in the same keymap. */
3521 if (!NILP (entire_map
))
3525 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3527 if (!EQ (tem
, definition
))
3537 /* Output the prefix that applies to every entry in this map. */
3538 if (!NILP (elt_prefix
))
3539 insert1 (elt_prefix
);
3541 insert1 (Fkey_description (kludge
, prefix
));
3543 /* Find all consecutive characters or rows that have the same
3544 definition. But, VECTOR is a char-table, we had better put a
3545 boundary between normal characters (-#x3FFF7F) and 8-bit
3546 characters (#x3FFF80-). */
3547 if (CHAR_TABLE_P (vector
))
3550 && (range_beg
= i
+ 1, range_end
= stop
- 1,
3551 val
= char_table_ref_and_range (vector
, range_beg
,
3552 &range_beg
, &range_end
),
3553 tem2
= get_keyelt (val
, 0),
3555 && !NILP (Fequal (tem2
, definition
)))
3560 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3562 && !NILP (Fequal (tem2
, definition
)))
3565 /* If we have a range of more than one character,
3566 print where the range reaches to. */
3568 if (i
!= starting_i
)
3572 ASET (kludge
, 0, make_number (i
));
3574 if (!NILP (elt_prefix
))
3575 insert1 (elt_prefix
);
3577 insert1 (Fkey_description (kludge
, prefix
));
3580 /* Print a description of the definition of this character.
3581 elt_describer will take care of spacing out far enough
3582 for alignment purposes. */
3583 (*elt_describer
) (definition
, args
);
3588 insert_string (" (binding currently shadowed)");
3593 if (CHAR_TABLE_P (vector
) && ! NILP (XCHAR_TABLE (vector
)->defalt
))
3595 if (!NILP (elt_prefix
))
3596 insert1 (elt_prefix
);
3597 insert ("default", 7);
3598 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3604 /* Apropos - finding all symbols whose names match a regexp. */
3605 static Lisp_Object apropos_predicate
;
3606 static Lisp_Object apropos_accumulate
;
3609 apropos_accum (Lisp_Object symbol
, Lisp_Object string
)
3611 register Lisp_Object tem
;
3613 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3614 if (!NILP (tem
) && !NILP (apropos_predicate
))
3615 tem
= call1 (apropos_predicate
, symbol
);
3617 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3620 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3621 doc
: /* Show all symbols whose names contain match for REGEXP.
3622 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3623 for each symbol and a symbol is mentioned only if that returns non-nil.
3624 Return list of symbols found. */)
3625 (Lisp_Object regexp
, Lisp_Object predicate
)
3628 CHECK_STRING (regexp
);
3629 apropos_predicate
= predicate
;
3630 apropos_accumulate
= Qnil
;
3631 map_obarray (Vobarray
, apropos_accum
, regexp
);
3632 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3633 apropos_accumulate
= Qnil
;
3634 apropos_predicate
= Qnil
;
3639 syms_of_keymap (void)
3641 DEFSYM (Qkeymap
, "keymap");
3642 staticpro (&apropos_predicate
);
3643 staticpro (&apropos_accumulate
);
3644 apropos_predicate
= Qnil
;
3645 apropos_accumulate
= Qnil
;
3647 DEFSYM (Qkeymap_canonicalize
, "keymap-canonicalize");
3649 /* Now we are ready to set up this property, so we can
3650 create char tables. */
3651 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3653 /* Initialize the keymaps standardly used.
3654 Each one is the value of a Lisp variable, and is also
3655 pointed to by a C variable */
3657 global_map
= Fmake_keymap (Qnil
);
3658 Fset (intern_c_string ("global-map"), global_map
);
3660 current_global_map
= global_map
;
3661 staticpro (&global_map
);
3662 staticpro (¤t_global_map
);
3664 meta_map
= Fmake_keymap (Qnil
);
3665 Fset (intern_c_string ("esc-map"), meta_map
);
3666 Ffset (intern_c_string ("ESC-prefix"), meta_map
);
3668 control_x_map
= Fmake_keymap (Qnil
);
3669 Fset (intern_c_string ("ctl-x-map"), control_x_map
);
3670 Ffset (intern_c_string ("Control-X-prefix"), control_x_map
);
3673 = pure_cons (pure_cons (make_pure_c_string ("DEL"), make_pure_c_string ("\\d")),
3674 pure_cons (pure_cons (make_pure_c_string ("TAB"), make_pure_c_string ("\\t")),
3675 pure_cons (pure_cons (make_pure_c_string ("RET"), make_pure_c_string ("\\r")),
3676 pure_cons (pure_cons (make_pure_c_string ("ESC"), make_pure_c_string ("\\e")),
3677 pure_cons (pure_cons (make_pure_c_string ("SPC"), make_pure_c_string (" ")),
3679 staticpro (&exclude_keys
);
3681 DEFVAR_LISP ("define-key-rebound-commands", Vdefine_key_rebound_commands
,
3682 doc
: /* List of commands given new key bindings recently.
3683 This is used for internal purposes during Emacs startup;
3684 don't alter it yourself. */);
3685 Vdefine_key_rebound_commands
= Qt
;
3687 DEFVAR_LISP ("minibuffer-local-map", Vminibuffer_local_map
,
3688 doc
: /* Default keymap to use when reading from the minibuffer. */);
3689 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3691 DEFVAR_LISP ("minibuffer-local-ns-map", Vminibuffer_local_ns_map
,
3692 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3693 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3694 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3697 DEFVAR_LISP ("minor-mode-map-alist", Vminor_mode_map_alist
,
3698 doc
: /* Alist of keymaps to use for minor modes.
3699 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3700 key sequences and look up bindings if VARIABLE's value is non-nil.
3701 If two active keymaps bind the same key, the keymap appearing earlier
3702 in the list takes precedence. */);
3703 Vminor_mode_map_alist
= Qnil
;
3705 DEFVAR_LISP ("minor-mode-overriding-map-alist", Vminor_mode_overriding_map_alist
,
3706 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3707 This variable is an alist just like `minor-mode-map-alist', and it is
3708 used the same way (and before `minor-mode-map-alist'); however,
3709 it is provided for major modes to bind locally. */);
3710 Vminor_mode_overriding_map_alist
= Qnil
;
3712 DEFVAR_LISP ("emulation-mode-map-alists", Vemulation_mode_map_alists
,
3713 doc
: /* List of keymap alists to use for emulations modes.
3714 It is intended for modes or packages using multiple minor-mode keymaps.
3715 Each element is a keymap alist just like `minor-mode-map-alist', or a
3716 symbol with a variable binding which is a keymap alist, and it is used
3717 the same way. The "active" keymaps in each alist are used before
3718 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3719 Vemulation_mode_map_alists
= Qnil
;
3721 DEFVAR_LISP ("where-is-preferred-modifier", Vwhere_is_preferred_modifier
,
3722 doc
: /* Preferred modifier key to use for `where-is'.
3723 When a single binding is requested, `where-is' will return one that
3724 uses this modifier key if possible. If nil, or if no such binding
3725 exists, bindings using keys without modifiers (or only with meta) will
3727 Vwhere_is_preferred_modifier
= Qnil
;
3728 where_is_preferred_modifier
= 0;
3730 staticpro (&Vmouse_events
);
3731 Vmouse_events
= pure_cons (intern_c_string ("menu-bar"),
3732 pure_cons (intern_c_string ("tool-bar"),
3733 pure_cons (intern_c_string ("header-line"),
3734 pure_cons (intern_c_string ("mode-line"),
3735 pure_cons (intern_c_string ("mouse-1"),
3736 pure_cons (intern_c_string ("mouse-2"),
3737 pure_cons (intern_c_string ("mouse-3"),
3738 pure_cons (intern_c_string ("mouse-4"),
3739 pure_cons (intern_c_string ("mouse-5"),
3742 DEFSYM (Qsingle_key_description
, "single-key-description");
3743 DEFSYM (Qkey_description
, "key-description");
3744 DEFSYM (Qkeymapp
, "keymapp");
3745 DEFSYM (Qnon_ascii
, "non-ascii");
3746 DEFSYM (Qmenu_item
, "menu-item");
3747 DEFSYM (Qremap
, "remap");
3748 DEFSYM (QCadvertised_binding
, ":advertised-binding");
3750 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3751 staticpro (&command_remapping_vector
);
3753 where_is_cache_keymaps
= Qt
;
3754 where_is_cache
= Qnil
;
3755 staticpro (&where_is_cache
);
3756 staticpro (&where_is_cache_keymaps
);
3758 defsubr (&Skeymapp
);
3759 defsubr (&Skeymap_parent
);
3760 defsubr (&Skeymap_prompt
);
3761 defsubr (&Sset_keymap_parent
);
3762 defsubr (&Smake_keymap
);
3763 defsubr (&Smake_sparse_keymap
);
3764 defsubr (&Smake_composed_keymap
);
3765 defsubr (&Smap_keymap_internal
);
3766 defsubr (&Smap_keymap
);
3767 defsubr (&Scopy_keymap
);
3768 defsubr (&Scommand_remapping
);
3769 defsubr (&Skey_binding
);
3770 defsubr (&Slocal_key_binding
);
3771 defsubr (&Sglobal_key_binding
);
3772 defsubr (&Sminor_mode_key_binding
);
3773 defsubr (&Sdefine_key
);
3774 defsubr (&Slookup_key
);
3775 defsubr (&Sdefine_prefix_command
);
3776 defsubr (&Suse_global_map
);
3777 defsubr (&Suse_local_map
);
3778 defsubr (&Scurrent_local_map
);
3779 defsubr (&Scurrent_global_map
);
3780 defsubr (&Scurrent_minor_mode_maps
);
3781 defsubr (&Scurrent_active_maps
);
3782 defsubr (&Saccessible_keymaps
);
3783 defsubr (&Skey_description
);
3784 defsubr (&Sdescribe_vector
);
3785 defsubr (&Ssingle_key_description
);
3786 defsubr (&Stext_char_description
);
3787 defsubr (&Swhere_is_internal
);
3788 defsubr (&Sdescribe_buffer_bindings
);
3789 defsubr (&Sapropos_internal
);
3793 keys_of_keymap (void)
3795 initial_define_key (global_map
, 033, "ESC-prefix");
3796 initial_define_key (global_map
, Ctl ('X'), "Control-X-prefix");