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
))
1219 /* We must use Fkey_description rather than just passing key to
1220 error; key might be a vector, not a string. */
1221 error ("Key sequence %s starts with non-prefix key %s",
1222 SDATA (Fkey_description (key
, Qnil
)),
1223 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1229 /* This function may GC (it calls Fkey_binding). */
1231 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 3, 0,
1232 doc
: /* Return the remapping for command COMMAND.
1233 Returns nil if COMMAND is not remapped (or not a symbol).
1235 If the optional argument POSITION is non-nil, it specifies a mouse
1236 position as returned by `event-start' and `event-end', and the
1237 remapping occurs in the keymaps associated with it. It can also be a
1238 number or marker, in which case the keymap properties at the specified
1239 buffer position instead of point are used. The KEYMAPS argument is
1240 ignored if POSITION is non-nil.
1242 If the optional argument KEYMAPS is non-nil, it should be a list of
1243 keymaps to search for command remapping. Otherwise, search for the
1244 remapping in all currently active keymaps. */)
1245 (Lisp_Object command
, Lisp_Object position
, Lisp_Object keymaps
)
1247 if (!SYMBOLP (command
))
1250 ASET (command_remapping_vector
, 1, command
);
1253 command
= Fkey_binding (command_remapping_vector
, Qnil
, Qt
, position
);
1255 command
= Flookup_key (Fcons (Qkeymap
, keymaps
),
1256 command_remapping_vector
, Qnil
);
1257 return INTEGERP (command
) ? Qnil
: command
;
1260 /* Value is number if KEY is too long; nil if valid but has no definition. */
1261 /* GC is possible in this function. */
1263 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1264 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1265 A value of nil means undefined. See doc of `define-key'
1266 for kinds of definitions.
1268 A number as value means KEY is "too long";
1269 that is, characters or symbols in it except for the last one
1270 fail to be a valid sequence of prefix characters in KEYMAP.
1271 The number is how many characters at the front of KEY
1272 it takes to reach a non-prefix key.
1274 Normally, `lookup-key' ignores bindings for t, which act as default
1275 bindings, used when nothing else in the keymap applies; this makes it
1276 usable as a general function for probing keymaps. However, if the
1277 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1278 recognize the default bindings, just as `read-key-sequence' does. */)
1279 (Lisp_Object keymap
, Lisp_Object key
, Lisp_Object accept_default
)
1282 register Lisp_Object cmd
;
1283 register Lisp_Object c
;
1285 int t_ok
= !NILP (accept_default
);
1286 struct gcpro gcpro1
, gcpro2
;
1288 GCPRO2 (keymap
, key
);
1289 keymap
= get_keymap (keymap
, 1, 1);
1291 CHECK_VECTOR_OR_STRING (key
);
1293 length
= XFASTINT (Flength (key
));
1295 RETURN_UNGCPRO (keymap
);
1300 c
= Faref (key
, make_number (idx
++));
1302 if (CONSP (c
) && lucid_event_type_list_p (c
))
1303 c
= Fevent_convert_list (c
);
1305 /* Turn the 8th bit of string chars into a meta modifier. */
1306 if (STRINGP (key
) && XINT (c
) & 0x80 && !STRING_MULTIBYTE (key
))
1307 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1309 /* Allow string since binding for `menu-bar-select-buffer'
1310 includes the buffer name in the key sequence. */
1311 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1312 message_with_string ("Key sequence contains invalid event %s", c
, 1);
1314 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1316 RETURN_UNGCPRO (cmd
);
1318 keymap
= get_keymap (cmd
, 0, 1);
1319 if (!CONSP (keymap
))
1320 RETURN_UNGCPRO (make_number (idx
));
1326 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1327 Assume that currently it does not define C at all.
1328 Return the keymap. */
1331 define_as_prefix (Lisp_Object keymap
, Lisp_Object c
)
1335 cmd
= Fmake_sparse_keymap (Qnil
);
1336 store_in_keymap (keymap
, c
, cmd
);
1341 /* Append a key to the end of a key sequence. We always make a vector. */
1344 append_key (Lisp_Object key_sequence
, Lisp_Object key
)
1346 Lisp_Object args
[2];
1348 args
[0] = key_sequence
;
1350 args
[1] = Fcons (key
, Qnil
);
1351 return Fvconcat (2, args
);
1354 /* Given a event type C which is a symbol,
1355 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1358 silly_event_symbol_error (Lisp_Object c
)
1360 Lisp_Object parsed
, base
, name
, assoc
;
1363 parsed
= parse_modifiers (c
);
1364 modifiers
= XFASTINT (XCAR (XCDR (parsed
)));
1365 base
= XCAR (parsed
);
1366 name
= Fsymbol_name (base
);
1367 /* This alist includes elements such as ("RET" . "\\r"). */
1368 assoc
= Fassoc (name
, exclude_keys
);
1372 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1374 Lisp_Object keystring
;
1375 if (modifiers
& alt_modifier
)
1376 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1377 if (modifiers
& ctrl_modifier
)
1378 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1379 if (modifiers
& hyper_modifier
)
1380 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1381 if (modifiers
& meta_modifier
)
1382 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1383 if (modifiers
& shift_modifier
)
1384 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1385 if (modifiers
& super_modifier
)
1386 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1389 c
= reorder_modifiers (c
);
1390 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1392 error ((modifiers
& ~meta_modifier
1393 ? "To bind the key %s, use [?%s], not [%s]"
1394 : "To bind the key %s, use \"%s\", not [%s]"),
1395 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1396 SDATA (SYMBOL_NAME (c
)));
1400 /* Global, local, and minor mode keymap stuff. */
1402 /* We can't put these variables inside current_minor_maps, since under
1403 some systems, static gets macro-defined to be the empty string.
1405 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1406 static int cmm_size
= 0;
1408 /* Store a pointer to an array of the currently active minor modes in
1409 *modeptr, a pointer to an array of the keymaps of the currently
1410 active minor modes in *mapptr, and return the number of maps
1413 This function always returns a pointer to the same buffer, and may
1414 free or reallocate it, so if you want to keep it for a long time or
1415 hand it out to lisp code, copy it. This procedure will be called
1416 for every key sequence read, so the nice lispy approach (return a
1417 new assoclist, list, what have you) for each invocation would
1418 result in a lot of consing over time.
1420 If we used xrealloc/xmalloc and ran out of memory, they would throw
1421 back to the command loop, which would try to read a key sequence,
1422 which would call this function again, resulting in an infinite
1423 loop. Instead, we'll use realloc/malloc and silently truncate the
1424 list, let the key sequence be read, and hope some other piece of
1425 code signals the error. */
1427 current_minor_maps (Lisp_Object
**modeptr
, Lisp_Object
**mapptr
)
1430 int list_number
= 0;
1431 Lisp_Object alist
, assoc
, var
, val
;
1432 Lisp_Object emulation_alists
;
1433 Lisp_Object lists
[2];
1435 emulation_alists
= Vemulation_mode_map_alists
;
1436 lists
[0] = Vminor_mode_overriding_map_alist
;
1437 lists
[1] = Vminor_mode_map_alist
;
1439 for (list_number
= 0; list_number
< 2; list_number
++)
1441 if (CONSP (emulation_alists
))
1443 alist
= XCAR (emulation_alists
);
1444 emulation_alists
= XCDR (emulation_alists
);
1445 if (SYMBOLP (alist
))
1446 alist
= find_symbol_value (alist
);
1450 alist
= lists
[list_number
];
1452 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1453 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1454 && (var
= XCAR (assoc
), SYMBOLP (var
))
1455 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1460 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1461 and also an entry in Vminor_mode_map_alist,
1462 ignore the latter. */
1463 if (list_number
== 1)
1465 val
= assq_no_quit (var
, lists
[0]);
1472 int newsize
, allocsize
;
1473 Lisp_Object
*newmodes
, *newmaps
;
1475 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1476 allocsize
= newsize
* sizeof *newmodes
;
1478 /* Use malloc here. See the comment above this function.
1479 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1481 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1486 memcpy (newmodes
, cmm_modes
,
1487 cmm_size
* sizeof cmm_modes
[0]);
1490 cmm_modes
= newmodes
;
1493 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1498 memcpy (newmaps
, cmm_maps
,
1499 cmm_size
* sizeof cmm_maps
[0]);
1506 if (newmodes
== NULL
|| newmaps
== NULL
)
1511 /* Get the keymap definition--or nil if it is not defined. */
1512 temp
= Findirect_function (XCDR (assoc
), Qt
);
1516 cmm_maps
[i
] = temp
;
1522 if (modeptr
) *modeptr
= cmm_modes
;
1523 if (mapptr
) *mapptr
= cmm_maps
;
1527 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1529 doc
: /* Return a list of the currently active keymaps.
1530 OLP if non-nil indicates that we should obey `overriding-local-map' and
1531 `overriding-terminal-local-map'. POSITION can specify a click position
1532 like in the respective argument of `key-binding'. */)
1533 (Lisp_Object olp
, Lisp_Object position
)
1535 int count
= SPECPDL_INDEX ();
1537 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1539 /* If a mouse click position is given, our variables are based on
1540 the buffer clicked on, not the current buffer. So we may have to
1541 switch the buffer here. */
1543 if (CONSP (position
))
1547 window
= POSN_WINDOW (position
);
1549 if (WINDOWP (window
)
1550 && BUFFERP (XWINDOW (window
)->buffer
)
1551 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
1553 /* Arrange to go back to the original buffer once we're done
1554 processing the key sequence. We don't use
1555 save_excursion_{save,restore} here, in analogy to
1556 `read-key-sequence' to avoid saving point. Maybe this
1557 would not be a problem here, but it is easier to keep
1561 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
1563 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
1569 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
1570 keymaps
= Fcons (KVAR (current_kboard
, Voverriding_terminal_local_map
),
1572 /* The doc said that overriding-terminal-local-map should
1573 override overriding-local-map. The code used them both,
1574 but it seems clearer to use just one. rms, jan 2005. */
1575 else if (!NILP (Voverriding_local_map
))
1576 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1578 if (NILP (XCDR (keymaps
)))
1583 = INTEGERP (position
) ? XINT (position
)
1584 : MARKERP (position
) ? marker_position (position
)
1586 /* This usually returns the buffer's local map,
1587 but that can be overridden by a `local-map' property. */
1588 Lisp_Object local_map
= get_local_map (pt
, current_buffer
, Qlocal_map
);
1589 /* This returns nil unless there is a `keymap' property. */
1590 Lisp_Object keymap
= get_local_map (pt
, current_buffer
, Qkeymap
);
1592 if (CONSP (position
))
1594 Lisp_Object string
= POSN_STRING (position
);
1596 /* For a mouse click, get the local text-property keymap
1597 of the place clicked on, rather than point. */
1599 if (POSN_INBUFFER_P (position
))
1603 pos
= POSN_BUFFER_POSN (position
);
1605 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
1607 local_map
= get_local_map (XINT (pos
),
1608 current_buffer
, Qlocal_map
);
1610 keymap
= get_local_map (XINT (pos
),
1611 current_buffer
, Qkeymap
);
1615 /* If on a mode line string with a local keymap,
1616 or for a click on a string, i.e. overlay string or a
1617 string displayed via the `display' property,
1618 consider `local-map' and `keymap' properties of
1621 if (CONSP (string
) && STRINGP (XCAR (string
)))
1623 Lisp_Object pos
, map
;
1625 pos
= XCDR (string
);
1626 string
= XCAR (string
);
1629 && XINT (pos
) < SCHARS (string
))
1631 map
= Fget_text_property (pos
, Qlocal_map
, string
);
1635 map
= Fget_text_property (pos
, Qkeymap
, string
);
1643 if (!NILP (local_map
))
1644 keymaps
= Fcons (local_map
, keymaps
);
1646 /* Now put all the minor mode keymaps on the list. */
1647 nmaps
= current_minor_maps (0, &maps
);
1649 for (i
= --nmaps
; i
>= 0; i
--)
1650 if (!NILP (maps
[i
]))
1651 keymaps
= Fcons (maps
[i
], keymaps
);
1654 keymaps
= Fcons (keymap
, keymaps
);
1657 unbind_to (count
, Qnil
);
1662 /* GC is possible in this function if it autoloads a keymap. */
1664 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 4, 0,
1665 doc
: /* Return the binding for command KEY in current keymaps.
1666 KEY is a string or vector, a sequence of keystrokes.
1667 The binding is probably a symbol with a function definition.
1669 Normally, `key-binding' ignores bindings for t, which act as default
1670 bindings, used when nothing else in the keymap applies; this makes it
1671 usable as a general function for probing keymaps. However, if the
1672 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1673 recognize the default bindings, just as `read-key-sequence' does.
1675 Like the normal command loop, `key-binding' will remap the command
1676 resulting from looking up KEY by looking up the command in the
1677 current keymaps. However, if the optional third argument NO-REMAP
1678 is non-nil, `key-binding' returns the unmapped command.
1680 If KEY is a key sequence initiated with the mouse, the used keymaps
1681 will depend on the clicked mouse position with regard to the buffer
1682 and possible local keymaps on strings.
1684 If the optional argument POSITION is non-nil, it specifies a mouse
1685 position as returned by `event-start' and `event-end', and the lookup
1686 occurs in the keymaps associated with it instead of KEY. It can also
1687 be a number or marker, in which case the keymap properties at the
1688 specified buffer position instead of point are used.
1690 (Lisp_Object key
, Lisp_Object accept_default
, Lisp_Object no_remap
, Lisp_Object position
)
1694 if (NILP (position
) && VECTORP (key
))
1697 /* mouse events may have a symbolic prefix indicating the
1698 scrollbar or mode line */
1699 = AREF (key
, SYMBOLP (AREF (key
, 0)) && ASIZE (key
) > 1 ? 1 : 0);
1701 /* We are not interested in locations without event data */
1703 if (EVENT_HAS_PARAMETERS (event
) && CONSP (XCDR (event
)))
1705 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (event
));
1706 if (EQ (kind
, Qmouse_click
))
1707 position
= EVENT_START (event
);
1711 value
= Flookup_key (Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
)),
1712 key
, accept_default
);
1714 if (NILP (value
) || INTEGERP (value
))
1717 /* If the result of the ordinary keymap lookup is an interactive
1718 command, look for a key binding (ie. remapping) for that command. */
1720 if (NILP (no_remap
) && SYMBOLP (value
))
1723 if (value1
= Fcommand_remapping (value
, position
, Qnil
), !NILP (value1
))
1730 /* GC is possible in this function if it autoloads a keymap. */
1732 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1733 doc
: /* Return the binding for command KEYS in current local keymap only.
1734 KEYS is a string or vector, a sequence of keystrokes.
1735 The binding is probably a symbol with a function definition.
1737 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1738 bindings; see the description of `lookup-key' for more details about this. */)
1739 (Lisp_Object keys
, Lisp_Object accept_default
)
1741 register Lisp_Object map
;
1742 map
= BVAR (current_buffer
, keymap
);
1745 return Flookup_key (map
, keys
, accept_default
);
1748 /* GC is possible in this function if it autoloads a keymap. */
1750 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1751 doc
: /* Return the binding for command KEYS in current global keymap only.
1752 KEYS is a string or vector, a sequence of keystrokes.
1753 The binding is probably a symbol with a function definition.
1754 This function's return values are the same as those of `lookup-key'
1757 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1758 bindings; see the description of `lookup-key' for more details about this. */)
1759 (Lisp_Object keys
, Lisp_Object accept_default
)
1761 return Flookup_key (current_global_map
, keys
, accept_default
);
1764 /* GC is possible in this function if it autoloads a keymap. */
1766 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1767 doc
: /* Find the visible minor mode bindings of KEY.
1768 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1769 the symbol which names the minor mode binding KEY, and BINDING is
1770 KEY's definition in that mode. In particular, if KEY has no
1771 minor-mode bindings, return nil. If the first binding is a
1772 non-prefix, all subsequent bindings will be omitted, since they would
1773 be ignored. Similarly, the list doesn't include non-prefix bindings
1774 that come after prefix bindings.
1776 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1777 bindings; see the description of `lookup-key' for more details about this. */)
1778 (Lisp_Object key
, Lisp_Object accept_default
)
1780 Lisp_Object
*modes
, *maps
;
1782 Lisp_Object binding
;
1784 struct gcpro gcpro1
, gcpro2
;
1786 nmaps
= current_minor_maps (&modes
, &maps
);
1787 /* Note that all these maps are GCPRO'd
1788 in the places where we found them. */
1791 GCPRO2 (key
, binding
);
1793 for (i
= j
= 0; i
< nmaps
; i
++)
1795 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1796 && !INTEGERP (binding
))
1798 if (KEYMAPP (binding
))
1799 maps
[j
++] = Fcons (modes
[i
], binding
);
1801 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1805 return Flist (j
, maps
);
1808 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1809 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1810 A new sparse keymap is stored as COMMAND's function definition and its value.
1811 If a second optional argument MAPVAR is given, the map is stored as
1812 its value instead of as COMMAND's value; but COMMAND is still defined
1814 The third optional argument NAME, if given, supplies a menu name
1815 string for the map. This is required to use the keymap as a menu.
1816 This function returns COMMAND. */)
1817 (Lisp_Object command
, Lisp_Object mapvar
, Lisp_Object name
)
1820 map
= Fmake_sparse_keymap (name
);
1821 Ffset (command
, map
);
1825 Fset (command
, map
);
1829 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1830 doc
: /* Select KEYMAP as the global keymap. */)
1831 (Lisp_Object keymap
)
1833 keymap
= get_keymap (keymap
, 1, 1);
1834 current_global_map
= keymap
;
1839 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1840 doc
: /* Select KEYMAP as the local keymap.
1841 If KEYMAP is nil, that means no local keymap. */)
1842 (Lisp_Object keymap
)
1845 keymap
= get_keymap (keymap
, 1, 1);
1847 BVAR (current_buffer
, keymap
) = keymap
;
1852 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1853 doc
: /* Return current buffer's local keymap, or nil if it has none.
1854 Normally the local keymap is set by the major mode with `use-local-map'. */)
1857 return BVAR (current_buffer
, keymap
);
1860 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1861 doc
: /* Return the current global keymap. */)
1864 return current_global_map
;
1867 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1868 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1872 int nmaps
= current_minor_maps (0, &maps
);
1874 return Flist (nmaps
, maps
);
1877 /* Help functions for describing and documenting keymaps. */
1879 struct accessible_keymaps_data
{
1880 Lisp_Object maps
, tail
, thisseq
;
1881 /* Does the current sequence end in the meta-prefix-char? */
1886 accessible_keymaps_1 (Lisp_Object key
, Lisp_Object cmd
, Lisp_Object args
, void *data
)
1887 /* Use void* data to be compatible with map_keymap_function_t. */
1889 struct accessible_keymaps_data
*d
= data
; /* Cast! */
1890 Lisp_Object maps
= d
->maps
;
1891 Lisp_Object tail
= d
->tail
;
1892 Lisp_Object thisseq
= d
->thisseq
;
1893 int is_metized
= d
->is_metized
&& INTEGERP (key
);
1896 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1900 /* Look for and break cycles. */
1901 while (!NILP (tem
= Frassq (cmd
, maps
)))
1903 Lisp_Object prefix
= XCAR (tem
);
1904 int lim
= XINT (Flength (XCAR (tem
)));
1905 if (lim
<= XINT (Flength (thisseq
)))
1906 { /* This keymap was already seen with a smaller prefix. */
1908 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1909 Faref (thisseq
, make_number (i
))))
1912 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1915 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1916 but maybe `cmd' occurs again further down in `maps', so keep
1918 maps
= XCDR (Fmemq (tem
, maps
));
1921 /* If the last key in thisseq is meta-prefix-char,
1922 turn it into a meta-ized keystroke. We know
1923 that the event we're about to append is an
1924 ascii keystroke since we're processing a
1928 int meta_bit
= meta_modifier
;
1929 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1930 tem
= Fcopy_sequence (thisseq
);
1932 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1934 /* This new sequence is the same length as
1935 thisseq, so stick it in the list right
1938 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1942 tem
= append_key (thisseq
, key
);
1943 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1947 /* This function cannot GC. */
1949 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1951 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1952 Returns a list of elements of the form (KEYS . MAP), where the sequence
1953 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1954 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1955 An optional argument PREFIX, if non-nil, should be a key sequence;
1956 then the value includes only maps for prefixes that start with PREFIX. */)
1957 (Lisp_Object keymap
, Lisp_Object prefix
)
1959 Lisp_Object maps
, tail
;
1960 int prefixlen
= XINT (Flength (prefix
));
1962 /* no need for gcpro because we don't autoload any keymaps. */
1966 /* If a prefix was specified, start with the keymap (if any) for
1967 that prefix, so we don't waste time considering other prefixes. */
1969 tem
= Flookup_key (keymap
, prefix
, Qt
);
1970 /* Flookup_key may give us nil, or a number,
1971 if the prefix is not defined in this particular map.
1972 It might even give us a list that isn't a keymap. */
1973 tem
= get_keymap (tem
, 0, 0);
1974 /* If the keymap is autoloaded `tem' is not a cons-cell, but we still
1975 want to return it. */
1978 /* Convert PREFIX to a vector now, so that later on
1979 we don't have to deal with the possibility of a string. */
1980 if (STRINGP (prefix
))
1985 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1986 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1990 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1991 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1992 c
^= 0200 | meta_modifier
;
1993 ASET (copy
, i_before
, make_number (c
));
1997 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
2003 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
2004 get_keymap (keymap
, 1, 0)),
2007 /* For each map in the list maps,
2008 look at any other maps it points to,
2009 and stick them at the end if they are not already in the list.
2011 This is a breadth-first traversal, where tail is the queue of
2012 nodes, and maps accumulates a list of all nodes visited. */
2014 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
2016 struct accessible_keymaps_data data
;
2017 register Lisp_Object thismap
= Fcdr (XCAR (tail
));
2020 data
.thisseq
= Fcar (XCAR (tail
));
2023 last
= make_number (XINT (Flength (data
.thisseq
)) - 1);
2024 /* Does the current sequence end in the meta-prefix-char? */
2025 data
.is_metized
= (XINT (last
) >= 0
2026 /* Don't metize the last char of PREFIX. */
2027 && XINT (last
) >= prefixlen
2028 && EQ (Faref (data
.thisseq
, last
), meta_prefix_char
));
2030 /* Since we can't run lisp code, we can't scan autoloaded maps. */
2031 if (CONSP (thismap
))
2032 map_keymap (thismap
, accessible_keymaps_1
, Qnil
, &data
, 0);
2036 static Lisp_Object Qsingle_key_description
, Qkey_description
;
2038 /* This function cannot GC. */
2040 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2041 doc
: /* Return a pretty description of key-sequence KEYS.
2042 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2043 Control characters turn into "C-foo" sequences, meta into "M-foo",
2044 spaces are put between sequence elements, etc. */)
2045 (Lisp_Object keys
, Lisp_Object prefix
)
2050 int size
= XINT (Flength (keys
));
2052 Lisp_Object sep
= build_string (" ");
2057 size
+= XINT (Flength (prefix
));
2059 /* This has one extra element at the end that we don't pass to Fconcat. */
2060 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2062 /* In effect, this computes
2063 (mapconcat 'single-key-description keys " ")
2064 but we shouldn't use mapconcat because it can do GC. */
2068 list
= prefix
, prefix
= Qnil
;
2069 else if (!NILP (keys
))
2070 list
= keys
, keys
= Qnil
;
2075 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2079 return empty_unibyte_string
;
2080 return Fconcat (len
- 1, args
);
2084 size
= SCHARS (list
);
2085 else if (VECTORP (list
))
2086 size
= ASIZE (list
);
2087 else if (CONSP (list
))
2088 size
= XINT (Flength (list
));
2090 wrong_type_argument (Qarrayp
, list
);
2099 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2100 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2101 c
^= 0200 | meta_modifier
;
2102 XSETFASTINT (key
, c
);
2104 else if (VECTORP (list
))
2106 key
= AREF (list
, i
); i
++;
2118 || EQ (key
, meta_prefix_char
)
2119 || (XINT (key
) & meta_modifier
))
2121 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2123 if (EQ (key
, meta_prefix_char
))
2127 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2130 else if (EQ (key
, meta_prefix_char
))
2135 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2143 push_key_description (register unsigned int c
, register char *p
, int force_multibyte
)
2147 /* Clear all the meaningless bits above the meta bit. */
2148 c
&= meta_modifier
| ~ - meta_modifier
;
2149 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2150 | meta_modifier
| shift_modifier
| super_modifier
);
2152 if (! CHARACTERP (make_number (c2
)))
2154 /* KEY_DESCRIPTION_SIZE is large enough for this. */
2155 p
+= sprintf (p
, "[%d]", c
);
2159 if (c
& alt_modifier
)
2165 if ((c
& ctrl_modifier
) != 0
2166 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2170 c
&= ~ctrl_modifier
;
2172 if (c
& hyper_modifier
)
2176 c
-= hyper_modifier
;
2178 if (c
& meta_modifier
)
2184 if (c
& shift_modifier
)
2188 c
-= shift_modifier
;
2190 if (c
& super_modifier
)
2194 c
-= super_modifier
;
2210 else if (c
== Ctl ('M'))
2218 /* `C-' already added above. */
2219 if (c
> 0 && c
<= Ctl ('Z'))
2238 || (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
2239 && SINGLE_BYTE_CHAR_P (c
)
2240 && !force_multibyte
))
2246 /* Now we are sure that C is a valid character code. */
2247 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
2248 && ! force_multibyte
)
2249 *p
++ = multibyte_char_to_unibyte (c
);
2251 p
+= CHAR_STRING (c
, (unsigned char *) p
);
2257 /* This function cannot GC. */
2259 DEFUN ("single-key-description", Fsingle_key_description
,
2260 Ssingle_key_description
, 1, 2, 0,
2261 doc
: /* Return a pretty description of command character KEY.
2262 Control characters turn into C-whatever, etc.
2263 Optional argument NO-ANGLES non-nil means don't put angle brackets
2264 around function keys and event symbols. */)
2265 (Lisp_Object key
, Lisp_Object no_angles
)
2267 if (CONSP (key
) && lucid_event_type_list_p (key
))
2268 key
= Fevent_convert_list (key
);
2270 key
= EVENT_HEAD (key
);
2272 if (INTEGERP (key
)) /* Normal character */
2274 char tem
[KEY_DESCRIPTION_SIZE
];
2276 *push_key_description (XINT (key
), tem
, 1) = 0;
2277 return build_string (tem
);
2279 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2281 if (NILP (no_angles
))
2284 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2285 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2286 return build_string (buffer
);
2289 return Fsymbol_name (key
);
2291 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2292 return Fcopy_sequence (key
);
2294 error ("KEY must be an integer, cons, symbol, or string");
2299 push_text_char_description (register unsigned int c
, register char *p
)
2310 *p
++ = c
+ 64; /* 'A' - 1 */
2322 /* This function cannot GC. */
2324 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2325 doc
: /* Return a pretty description of file-character CHARACTER.
2326 Control characters turn into "^char", etc. This differs from
2327 `single-key-description' which turns them into "C-char".
2328 Also, this function recognizes the 2**7 bit as the Meta character,
2329 whereas `single-key-description' uses the 2**27 bit for Meta.
2330 See Info node `(elisp)Describing Characters' for examples. */)
2331 (Lisp_Object character
)
2333 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2337 CHECK_NUMBER (character
);
2339 c
= XINT (character
);
2340 if (!ASCII_CHAR_P (c
))
2342 int len
= CHAR_STRING (c
, (unsigned char *) str
);
2344 return make_multibyte_string (str
, 1, len
);
2347 *push_text_char_description (c
& 0377, str
) = 0;
2349 return build_string (str
);
2352 static int where_is_preferred_modifier
;
2354 /* Return 0 if SEQ uses non-preferred modifiers or non-char events.
2355 Else, return 2 if SEQ uses the where_is_preferred_modifier,
2358 preferred_sequence_p (Lisp_Object seq
)
2361 int len
= XINT (Flength (seq
));
2364 for (i
= 0; i
< len
; i
++)
2366 Lisp_Object ii
, elt
;
2368 XSETFASTINT (ii
, i
);
2369 elt
= Faref (seq
, ii
);
2371 if (!INTEGERP (elt
))
2375 int modifiers
= XINT (elt
) & (CHAR_MODIFIER_MASK
& ~CHAR_META
);
2376 if (modifiers
== where_is_preferred_modifier
)
2387 /* where-is - finding a command in a set of keymaps. */
2389 static void where_is_internal_1 (Lisp_Object key
, Lisp_Object binding
,
2390 Lisp_Object args
, void *data
);
2392 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2393 Returns the first non-nil binding found in any of those maps.
2394 If REMAP is true, pass the result of the lookup through command
2395 remapping before returning it. */
2398 shadow_lookup (Lisp_Object shadow
, Lisp_Object key
, Lisp_Object flag
,
2401 Lisp_Object tail
, value
;
2403 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2405 value
= Flookup_key (XCAR (tail
), key
, flag
);
2406 if (NATNUMP (value
))
2408 value
= Flookup_key (XCAR (tail
),
2409 Fsubstring (key
, make_number (0), value
), flag
);
2413 else if (!NILP (value
))
2415 Lisp_Object remapping
;
2416 if (remap
&& SYMBOLP (value
)
2417 && (remapping
= Fcommand_remapping (value
, Qnil
, shadow
),
2427 static Lisp_Object Vmouse_events
;
2429 struct where_is_internal_data
{
2430 Lisp_Object definition
, this, last
;
2431 int last_is_meta
, noindirect
;
2432 Lisp_Object sequences
;
2435 /* This function can't GC, AFAIK. */
2436 /* Return the list of bindings found. This list is ordered "longest
2437 to shortest". It may include bindings that are actually shadowed
2438 by others, as well as duplicate bindings and remapping bindings.
2439 The list returned is potentially shared with where_is_cache, so
2440 be careful not to modify it via side-effects. */
2443 where_is_internal (Lisp_Object definition
, Lisp_Object keymaps
,
2444 int noindirect
, int nomenus
)
2446 Lisp_Object maps
= Qnil
;
2448 struct where_is_internal_data data
;
2450 /* Only important use of caching is for the menubar
2451 (i.e. where-is-internal called with (def nil t nil nil)). */
2452 if (nomenus
&& !noindirect
)
2454 /* Check heuristic-consistency of the cache. */
2455 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2456 where_is_cache
= Qnil
;
2458 if (NILP (where_is_cache
))
2460 /* We need to create the cache. */
2461 Lisp_Object args
[2];
2462 where_is_cache
= Fmake_hash_table (0, args
);
2463 where_is_cache_keymaps
= Qt
;
2466 /* We can reuse the cache. */
2467 return Fgethash (definition
, where_is_cache
, Qnil
);
2470 /* Kill the cache so that where_is_internal_1 doesn't think
2471 we're filling it up. */
2472 where_is_cache
= Qnil
;
2475 while (CONSP (found
))
2479 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2480 found
= XCDR (found
);
2483 data
.sequences
= Qnil
;
2484 for (; CONSP (maps
); maps
= XCDR (maps
))
2486 /* Key sequence to reach map, and the map that it reaches */
2487 register Lisp_Object
this, map
, tem
;
2489 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2490 [M-CHAR] sequences, check if last character of the sequence
2491 is the meta-prefix char. */
2495 this = Fcar (XCAR (maps
));
2496 map
= Fcdr (XCAR (maps
));
2497 last
= make_number (XINT (Flength (this)) - 1);
2498 last_is_meta
= (XINT (last
) >= 0
2499 && EQ (Faref (this, last
), meta_prefix_char
));
2501 /* if (nomenus && !preferred_sequence_p (this)) */
2502 if (nomenus
&& XINT (last
) >= 0
2503 && SYMBOLP (tem
= Faref (this, make_number (0)))
2504 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2505 /* If no menu entries should be returned, skip over the
2506 keymaps bound to `menu-bar' and `tool-bar' and other
2507 non-ascii prefixes like `C-down-mouse-2'. */
2512 data
.definition
= definition
;
2513 data
.noindirect
= noindirect
;
2516 data
.last_is_meta
= last_is_meta
;
2519 map_keymap (map
, where_is_internal_1
, Qnil
, &data
, 0);
2522 if (nomenus
&& !noindirect
)
2523 { /* Remember for which keymaps this cache was built.
2524 We do it here (late) because we want to keep where_is_cache_keymaps
2525 set to t while the cache isn't fully filled. */
2526 where_is_cache_keymaps
= keymaps
;
2527 /* During cache-filling, data.sequences is not filled by
2528 where_is_internal_1. */
2529 return Fgethash (definition
, where_is_cache
, Qnil
);
2532 return data
.sequences
;
2535 /* This function can GC if Flookup_key autoloads any keymaps. */
2537 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2538 doc
: /* Return list of keys that invoke DEFINITION.
2539 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2540 If KEYMAP is nil, search all the currently active keymaps.
2541 If KEYMAP is a list of keymaps, search only those keymaps.
2543 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2544 rather than a list of all possible key sequences.
2545 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2546 no matter what it is.
2547 If FIRSTONLY has another non-nil value, prefer bindings
2548 that use the modifier key specified in `where-is-preferred-modifier'
2549 \(or their meta variants) and entirely reject menu bindings.
2551 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2552 to other keymaps or slots. This makes it possible to search for an
2553 indirect definition itself.
2555 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2556 that invoke a command which is remapped to DEFINITION, but include the
2557 remapped command in the returned list. */)
2558 (Lisp_Object definition
, Lisp_Object keymap
, Lisp_Object firstonly
, Lisp_Object noindirect
, Lisp_Object no_remap
)
2560 /* The keymaps in which to search. */
2561 Lisp_Object keymaps
;
2562 /* Potentially relevant bindings in "shortest to longest" order. */
2563 Lisp_Object sequences
= Qnil
;
2564 /* Actually relevant bindings. */
2565 Lisp_Object found
= Qnil
;
2566 /* 1 means ignore all menu bindings entirely. */
2567 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2568 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
, gcpro6
;
2569 /* List of sequences found via remapping. Keep them in a separate
2570 variable, so as to push them later, since we prefer
2571 non-remapped binding. */
2572 Lisp_Object remapped_sequences
= Qnil
;
2573 /* Whether or not we're handling remapped sequences. This is needed
2574 because remapping is not done recursively by Fcommand_remapping: you
2575 can't remap a remapped command. */
2577 Lisp_Object tem
= Qnil
;
2579 /* Refresh the C version of the modifier preference. */
2580 where_is_preferred_modifier
2581 = parse_solitary_modifier (Vwhere_is_preferred_modifier
);
2583 /* Find the relevant keymaps. */
2584 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2586 else if (!NILP (keymap
))
2587 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2589 keymaps
= Fcurrent_active_maps (Qnil
, Qnil
);
2591 GCPRO6 (definition
, keymaps
, found
, sequences
, remapped_sequences
, tem
);
2593 tem
= Fcommand_remapping (definition
, Qnil
, keymaps
);
2594 /* If `definition' is remapped to tem', then OT1H no key will run
2595 that command (since they will run `tem' instead), so we should
2596 return nil; but OTOH all keys bound to `definition' (or to `tem')
2597 will run the same command.
2598 So for menu-shortcut purposes, we want to find all the keys bound (maybe
2599 via remapping) to `tem'. But for the purpose of finding the keys that
2600 run `definition', then we'd want to just return nil.
2601 We choose to make it work right for menu-shortcuts, since it's the most
2603 Known bugs: if you remap switch-to-buffer to toto, C-h f switch-to-buffer
2604 will tell you that switch-to-buffer is bound to C-x b even though C-x b
2605 will run toto instead. And if `toto' is itself remapped to forward-char,
2606 then C-h f toto will tell you that it's bound to C-f even though C-f does
2607 not run toto and it won't tell you that C-x b does run toto. */
2608 if (NILP (no_remap
) && !NILP (tem
))
2611 if (SYMBOLP (definition
)
2612 && !NILP (firstonly
)
2613 && !NILP (tem
= Fget (definition
, QCadvertised_binding
)))
2615 /* We have a list of advertised bindings. */
2617 if (EQ (shadow_lookup (keymaps
, XCAR (tem
), Qnil
, 0), definition
))
2621 if (EQ (shadow_lookup (keymaps
, tem
, Qnil
, 0), definition
))
2625 sequences
= Freverse (where_is_internal (definition
, keymaps
,
2626 !NILP (noindirect
), nomenus
));
2628 while (CONSP (sequences
)
2629 /* If we're at the end of the `sequences' list and we haven't
2630 considered remapped sequences yet, copy them over and
2632 || (!remapped
&& (sequences
= remapped_sequences
,
2634 CONSP (sequences
))))
2636 Lisp_Object sequence
, function
;
2638 sequence
= XCAR (sequences
);
2639 sequences
= XCDR (sequences
);
2641 /* Verify that this key binding is not shadowed by another
2642 binding for the same key, before we say it exists.
2644 Mechanism: look for local definition of this key and if
2645 it is defined and does not match what we found then
2648 Either nil or number as value from Flookup_key
2650 if (NILP (Fequal (shadow_lookup (keymaps
, sequence
, Qnil
, remapped
),
2654 /* If the current sequence is a command remapping with
2655 format [remap COMMAND], find the key sequences
2656 which run COMMAND, and use those sequences instead. */
2657 if (NILP (no_remap
) && !remapped
2658 && VECTORP (sequence
) && ASIZE (sequence
) == 2
2659 && EQ (AREF (sequence
, 0), Qremap
)
2660 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2662 Lisp_Object seqs
= where_is_internal (function
, keymaps
,
2663 !NILP (noindirect
), nomenus
);
2664 remapped_sequences
= nconc2 (Freverse (seqs
), remapped_sequences
);
2668 /* Don't annoy user with strings from a menu such as the
2669 entries from the "Edit => Paste from Kill Menu".
2670 Change them all to "(any string)", so that there
2671 seems to be only one menu item to report. */
2672 if (! NILP (sequence
))
2675 tem1
= Faref (sequence
, make_number (ASIZE (sequence
) - 1));
2677 Faset (sequence
, make_number (ASIZE (sequence
) - 1),
2678 build_string ("(any string)"));
2681 /* It is a true unshadowed match. Record it, unless it's already
2682 been seen (as could happen when inheriting keymaps). */
2683 if (NILP (Fmember (sequence
, found
)))
2684 found
= Fcons (sequence
, found
);
2686 /* If firstonly is Qnon_ascii, then we can return the first
2687 binding we find. If firstonly is not Qnon_ascii but not
2688 nil, then we should return the first ascii-only binding
2690 if (EQ (firstonly
, Qnon_ascii
))
2691 RETURN_UNGCPRO (sequence
);
2692 else if (!NILP (firstonly
)
2693 && 2 == preferred_sequence_p (sequence
))
2694 RETURN_UNGCPRO (sequence
);
2699 found
= Fnreverse (found
);
2701 /* firstonly may have been t, but we may have gone all the way through
2702 the keymaps without finding an all-ASCII key sequence. So just
2703 return the best we could find. */
2704 if (NILP (firstonly
))
2706 else if (where_is_preferred_modifier
== 0)
2707 return Fcar (found
);
2709 { /* Maybe we did not find a preferred_modifier binding, but we did find
2710 some ASCII binding. */
2711 Lisp_Object bindings
= found
;
2712 while (CONSP (bindings
))
2713 if (preferred_sequence_p (XCAR (bindings
)))
2714 return XCAR (bindings
);
2716 bindings
= XCDR (bindings
);
2717 return Fcar (found
);
2721 /* This function can GC because get_keyelt can. */
2724 where_is_internal_1 (Lisp_Object key
, Lisp_Object binding
, Lisp_Object args
, void *data
)
2726 struct where_is_internal_data
*d
= data
; /* Cast! */
2727 Lisp_Object definition
= d
->definition
;
2728 int noindirect
= d
->noindirect
;
2729 Lisp_Object
this = d
->this;
2730 Lisp_Object last
= d
->last
;
2731 int last_is_meta
= d
->last_is_meta
;
2732 Lisp_Object sequence
;
2734 /* Search through indirections unless that's not wanted. */
2736 binding
= get_keyelt (binding
, 0);
2738 /* End this iteration if this element does not match
2741 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2742 || EQ (binding
, definition
)
2743 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2744 /* Doesn't match. */
2747 /* We have found a match. Construct the key sequence where we found it. */
2748 if (INTEGERP (key
) && last_is_meta
)
2750 sequence
= Fcopy_sequence (this);
2751 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2756 key
= Fcons (XCAR (key
), XCDR (key
));
2757 sequence
= append_key (this, key
);
2760 if (!NILP (where_is_cache
))
2762 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2763 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2766 d
->sequences
= Fcons (sequence
, d
->sequences
);
2769 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2771 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2772 doc
: /* Insert the list of all defined keys and their definitions.
2773 The list is inserted in the current buffer, while the bindings are
2774 looked up in BUFFER.
2775 The optional argument PREFIX, if non-nil, should be a key sequence;
2776 then we display only bindings that start with that prefix.
2777 The optional argument MENUS, if non-nil, says to mention menu bindings.
2778 \(Ordinarily these are omitted from the output.) */)
2779 (Lisp_Object buffer
, Lisp_Object prefix
, Lisp_Object menus
)
2781 Lisp_Object outbuf
, shadow
;
2782 int nomenu
= NILP (menus
);
2783 register Lisp_Object start1
;
2784 struct gcpro gcpro1
;
2786 const char *alternate_heading
2788 Keyboard translations:\n\n\
2789 You type Translation\n\
2790 -------- -----------\n";
2792 CHECK_BUFFER (buffer
);
2797 outbuf
= Fcurrent_buffer ();
2799 /* Report on alternates for keys. */
2800 if (STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
)) && !NILP (prefix
))
2803 const unsigned char *translate
= SDATA (KVAR (current_kboard
, Vkeyboard_translate_table
));
2804 int translate_len
= SCHARS (KVAR (current_kboard
, Vkeyboard_translate_table
));
2806 for (c
= 0; c
< translate_len
; c
++)
2807 if (translate
[c
] != c
)
2809 char buf
[KEY_DESCRIPTION_SIZE
];
2812 if (alternate_heading
)
2814 insert_string (alternate_heading
);
2815 alternate_heading
= 0;
2818 bufend
= push_key_description (translate
[c
], buf
, 1);
2819 insert (buf
, bufend
- buf
);
2820 Findent_to (make_number (16), make_number (1));
2821 bufend
= push_key_description (c
, buf
, 1);
2822 insert (buf
, bufend
- buf
);
2826 /* Insert calls signal_after_change which may GC. */
2827 translate
= SDATA (KVAR (current_kboard
, Vkeyboard_translate_table
));
2833 if (!NILP (Vkey_translation_map
))
2834 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2835 "Key translations", nomenu
, 1, 0, 0);
2838 /* Print the (major mode) local map. */
2840 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
2841 start1
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
2842 else if (!NILP (Voverriding_local_map
))
2843 start1
= Voverriding_local_map
;
2847 describe_map_tree (start1
, 1, shadow
, prefix
,
2848 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2849 shadow
= Fcons (start1
, shadow
);
2853 /* Print the minor mode and major mode keymaps. */
2855 Lisp_Object
*modes
, *maps
;
2857 /* Temporarily switch to `buffer', so that we can get that buffer's
2858 minor modes correctly. */
2859 Fset_buffer (buffer
);
2861 nmaps
= current_minor_maps (&modes
, &maps
);
2862 Fset_buffer (outbuf
);
2864 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2865 XBUFFER (buffer
), Qkeymap
);
2868 describe_map_tree (start1
, 1, shadow
, prefix
,
2869 "\f\n`keymap' Property Bindings", nomenu
,
2871 shadow
= Fcons (start1
, shadow
);
2874 /* Print the minor mode maps. */
2875 for (i
= 0; i
< nmaps
; i
++)
2877 /* The title for a minor mode keymap
2878 is constructed at run time.
2879 We let describe_map_tree do the actual insertion
2880 because it takes care of other features when doing so. */
2883 if (!SYMBOLP (modes
[i
]))
2886 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2890 memcpy (p
, SDATA (SYMBOL_NAME (modes
[i
])),
2891 SCHARS (SYMBOL_NAME (modes
[i
])));
2892 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2894 memcpy (p
, " Minor Mode Bindings", strlen (" Minor Mode Bindings"));
2895 p
+= strlen (" Minor Mode Bindings");
2898 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2899 title
, nomenu
, 0, 0, 0);
2900 shadow
= Fcons (maps
[i
], shadow
);
2903 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2904 XBUFFER (buffer
), Qlocal_map
);
2907 if (EQ (start1
, BVAR (XBUFFER (buffer
), keymap
)))
2908 describe_map_tree (start1
, 1, shadow
, prefix
,
2909 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2911 describe_map_tree (start1
, 1, shadow
, prefix
,
2912 "\f\n`local-map' Property Bindings",
2915 shadow
= Fcons (start1
, shadow
);
2919 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2920 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2922 /* Print the function-key-map translations under this prefix. */
2923 if (!NILP (KVAR (current_kboard
, Vlocal_function_key_map
)))
2924 describe_map_tree (KVAR (current_kboard
, Vlocal_function_key_map
), 0, Qnil
, prefix
,
2925 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2927 /* Print the input-decode-map translations under this prefix. */
2928 if (!NILP (KVAR (current_kboard
, Vinput_decode_map
)))
2929 describe_map_tree (KVAR (current_kboard
, Vinput_decode_map
), 0, Qnil
, prefix
,
2930 "\f\nInput decoding map translations", nomenu
, 1, 0, 0);
2936 /* Insert a description of the key bindings in STARTMAP,
2937 followed by those of all maps reachable through STARTMAP.
2938 If PARTIAL is nonzero, omit certain "uninteresting" commands
2939 (such as `undefined').
2940 If SHADOW is non-nil, it is a list of maps;
2941 don't mention keys which would be shadowed by any of them.
2942 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2943 TITLE, if not 0, is a string to insert at the beginning.
2944 TITLE should not end with a colon or a newline; we supply that.
2945 If NOMENU is not 0, then omit menu-bar commands.
2947 If TRANSL is nonzero, the definitions are actually key translations
2948 so print strings and vectors differently.
2950 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2953 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
2954 don't omit it; instead, mention it but say it is shadowed. */
2957 describe_map_tree (Lisp_Object startmap
, int partial
, Lisp_Object shadow
,
2958 Lisp_Object prefix
, const char *title
, int nomenu
, int transl
,
2959 int always_title
, int mention_shadow
)
2961 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2962 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2964 const char *key_heading
2969 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
2972 GCPRO3 (maps
, seen
, sub_shadows
);
2978 /* Delete from MAPS each element that is for the menu bar. */
2979 for (list
= maps
; CONSP (list
); list
= XCDR (list
))
2981 Lisp_Object elt
, elt_prefix
, tem
;
2984 elt_prefix
= Fcar (elt
);
2985 if (ASIZE (elt_prefix
) >= 1)
2987 tem
= Faref (elt_prefix
, make_number (0));
2988 if (EQ (tem
, Qmenu_bar
))
2989 maps
= Fdelq (elt
, maps
);
2994 if (!NILP (maps
) || always_title
)
2998 insert_string (title
);
3001 insert_string (" Starting With ");
3002 insert1 (Fkey_description (prefix
, Qnil
));
3004 insert_string (":\n");
3006 insert_string (key_heading
);
3010 for (; CONSP (maps
); maps
= XCDR (maps
))
3012 register Lisp_Object elt
, elt_prefix
, tail
;
3015 elt_prefix
= Fcar (elt
);
3019 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3023 shmap
= XCAR (tail
);
3025 /* If the sequence by which we reach this keymap is zero-length,
3026 then the shadow map for this keymap is just SHADOW. */
3027 if ((STRINGP (elt_prefix
) && SCHARS (elt_prefix
) == 0)
3028 || (VECTORP (elt_prefix
) && ASIZE (elt_prefix
) == 0))
3030 /* If the sequence by which we reach this keymap actually has
3031 some elements, then the sequence's definition in SHADOW is
3032 what we should use. */
3035 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3036 if (INTEGERP (shmap
))
3040 /* If shmap is not nil and not a keymap,
3041 it completely shadows this map, so don't
3042 describe this map at all. */
3043 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3047 sub_shadows
= Fcons (shmap
, sub_shadows
);
3050 /* Maps we have already listed in this loop shadow this map. */
3051 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3054 tem
= Fequal (Fcar (XCAR (tail
)), elt_prefix
);
3056 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3059 describe_map (Fcdr (elt
), elt_prefix
,
3060 transl
? describe_translation
: describe_command
,
3061 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3067 insert_string ("\n");
3072 static int previous_description_column
;
3075 describe_command (Lisp_Object definition
, Lisp_Object args
)
3077 register Lisp_Object tem1
;
3078 EMACS_INT column
= current_column ();
3079 int description_column
;
3081 /* If column 16 is no good, go to col 32;
3082 but don't push beyond that--go to next line instead. */
3086 description_column
= 32;
3088 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3089 description_column
= 32;
3091 description_column
= 16;
3093 Findent_to (make_number (description_column
), make_number (1));
3094 previous_description_column
= description_column
;
3096 if (SYMBOLP (definition
))
3098 tem1
= SYMBOL_NAME (definition
);
3100 insert_string ("\n");
3102 else if (STRINGP (definition
) || VECTORP (definition
))
3103 insert_string ("Keyboard Macro\n");
3104 else if (KEYMAPP (definition
))
3105 insert_string ("Prefix Command\n");
3107 insert_string ("??\n");
3111 describe_translation (Lisp_Object definition
, Lisp_Object args
)
3113 register Lisp_Object tem1
;
3115 Findent_to (make_number (16), make_number (1));
3117 if (SYMBOLP (definition
))
3119 tem1
= SYMBOL_NAME (definition
);
3121 insert_string ("\n");
3123 else if (STRINGP (definition
) || VECTORP (definition
))
3125 insert1 (Fkey_description (definition
, Qnil
));
3126 insert_string ("\n");
3128 else if (KEYMAPP (definition
))
3129 insert_string ("Prefix Command\n");
3131 insert_string ("??\n");
3134 /* describe_map puts all the usable elements of a sparse keymap
3135 into an array of `struct describe_map_elt',
3136 then sorts them by the events. */
3138 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3140 /* qsort comparison function for sorting `struct describe_map_elt' by
3144 describe_map_compare (const void *aa
, const void *bb
)
3146 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3147 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3148 return ((XINT (a
->event
) > XINT (b
->event
))
3149 - (XINT (a
->event
) < XINT (b
->event
)));
3150 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3152 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3154 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3155 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3156 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3161 /* Describe the contents of map MAP, assuming that this map itself is
3162 reached by the sequence of prefix keys PREFIX (a string or vector).
3163 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3166 describe_map (Lisp_Object map
, Lisp_Object prefix
,
3167 void (*elt_describer
) (Lisp_Object
, Lisp_Object
),
3168 int partial
, Lisp_Object shadow
,
3169 Lisp_Object
*seen
, int nomenu
, int mention_shadow
)
3171 Lisp_Object tail
, definition
, event
;
3173 Lisp_Object suppress
;
3176 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3178 /* These accumulate the values from sparse keymap bindings,
3179 so we can sort them and handle them in order. */
3180 int length_needed
= 0;
3181 struct describe_map_elt
*vect
;
3188 suppress
= intern ("suppress-keymap");
3190 /* This vector gets used to present single keys to Flookup_key. Since
3191 that is done once per keymap element, we don't want to cons up a
3192 fresh vector every time. */
3193 kludge
= Fmake_vector (make_number (1), Qnil
);
3196 GCPRO3 (prefix
, definition
, kludge
);
3198 map
= call1 (Qkeymap_canonicalize
, map
);
3200 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3203 vect
= ((struct describe_map_elt
*)
3204 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3206 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3210 if (VECTORP (XCAR (tail
))
3211 || CHAR_TABLE_P (XCAR (tail
)))
3212 describe_vector (XCAR (tail
),
3213 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3215 else if (CONSP (XCAR (tail
)))
3217 int this_shadowed
= 0;
3219 event
= XCAR (XCAR (tail
));
3221 /* Ignore bindings whose "prefix" are not really valid events.
3222 (We get these in the frames and buffers menu.) */
3223 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3226 if (nomenu
&& EQ (event
, Qmenu_bar
))
3229 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3231 /* Don't show undefined commands or suppressed commands. */
3232 if (NILP (definition
)) continue;
3233 if (SYMBOLP (definition
) && partial
)
3235 tem
= Fget (definition
, suppress
);
3240 /* Don't show a command that isn't really visible
3241 because a local definition of the same key shadows it. */
3243 ASET (kludge
, 0, event
);
3246 tem
= shadow_lookup (shadow
, kludge
, Qt
, 0);
3249 /* If both bindings are keymaps, this key is a prefix key,
3250 so don't say it is shadowed. */
3251 if (KEYMAPP (definition
) && KEYMAPP (tem
))
3253 /* Avoid generating duplicate entries if the
3254 shadowed binding has the same definition. */
3255 else if (mention_shadow
&& !EQ (tem
, definition
))
3262 tem
= Flookup_key (map
, kludge
, Qt
);
3263 if (!EQ (tem
, definition
)) continue;
3265 vect
[slots_used
].event
= event
;
3266 vect
[slots_used
].definition
= definition
;
3267 vect
[slots_used
].shadowed
= this_shadowed
;
3270 else if (EQ (XCAR (tail
), Qkeymap
))
3272 /* The same keymap might be in the structure twice, if we're
3273 using an inherited keymap. So skip anything we've already
3275 tem
= Fassq (tail
, *seen
);
3276 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3278 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3282 /* If we found some sparse map events, sort them. */
3284 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3285 describe_map_compare
);
3287 /* Now output them in sorted order. */
3289 for (i
= 0; i
< slots_used
; i
++)
3291 Lisp_Object start
, end
;
3295 previous_description_column
= 0;
3300 ASET (kludge
, 0, vect
[i
].event
);
3301 start
= vect
[i
].event
;
3304 definition
= vect
[i
].definition
;
3306 /* Find consecutive chars that are identically defined. */
3307 if (INTEGERP (vect
[i
].event
))
3309 while (i
+ 1 < slots_used
3310 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3311 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3312 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3314 end
= vect
[i
].event
;
3317 /* Now START .. END is the range to describe next. */
3319 /* Insert the string to describe the event START. */
3320 insert1 (Fkey_description (kludge
, prefix
));
3322 if (!EQ (start
, end
))
3326 ASET (kludge
, 0, end
);
3327 /* Insert the string to describe the character END. */
3328 insert1 (Fkey_description (kludge
, prefix
));
3331 /* Print a description of the definition of this character.
3332 elt_describer will take care of spacing out far enough
3333 for alignment purposes. */
3334 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3336 if (vect
[i
].shadowed
)
3339 insert_string ("\n (that binding is currently shadowed by another mode)");
3348 describe_vector_princ (Lisp_Object elt
, Lisp_Object fun
)
3350 Findent_to (make_number (16), make_number (1));
3355 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3356 doc
: /* Insert a description of contents of VECTOR.
3357 This is text showing the elements of vector matched against indices.
3358 DESCRIBER is the output function used; nil means use `princ'. */)
3359 (Lisp_Object vector
, Lisp_Object describer
)
3361 int count
= SPECPDL_INDEX ();
3362 if (NILP (describer
))
3363 describer
= intern ("princ");
3364 specbind (Qstandard_output
, Fcurrent_buffer ());
3365 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3366 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3369 return unbind_to (count
, Qnil
);
3372 /* Insert in the current buffer a description of the contents of VECTOR.
3373 We call ELT_DESCRIBER to insert the description of one value found
3376 ELT_PREFIX describes what "comes before" the keys or indices defined
3377 by this vector. This is a human-readable string whose size
3378 is not necessarily related to the situation.
3380 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3381 leads to this keymap.
3383 If the vector is a chartable, ELT_PREFIX is the vector
3384 of bytes that lead to the character set or portion of a character
3385 set described by this chartable.
3387 If PARTIAL is nonzero, it means do not mention suppressed commands
3388 (that assumes the vector is in a keymap).
3390 SHADOW is a list of keymaps that shadow this map.
3391 If it is non-nil, then we look up the key in those maps
3392 and we don't mention it now if it is defined by any of them.
3394 ENTIRE_MAP is the keymap in which this vector appears.
3395 If the definition in effect in the whole map does not match
3396 the one in this vector, we ignore this one.
3398 ARGS is simply passed as the second argument to ELT_DESCRIBER.
3400 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3402 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3405 describe_vector (Lisp_Object vector
, Lisp_Object prefix
, Lisp_Object args
,
3406 void (*elt_describer
) (Lisp_Object
, Lisp_Object
),
3407 int partial
, Lisp_Object shadow
, Lisp_Object entire_map
,
3408 int keymap_p
, int mention_shadow
)
3410 Lisp_Object definition
;
3412 Lisp_Object elt_prefix
= Qnil
;
3414 Lisp_Object suppress
;
3417 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3418 /* Range of elements to be handled. */
3420 Lisp_Object character
;
3429 /* Call Fkey_description first, to avoid GC bug for the other string. */
3430 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3433 tem
= Fkey_description (prefix
, Qnil
);
3434 elt_prefix
= concat2 (tem
, build_string (" "));
3439 /* This vector gets used to present single keys to Flookup_key. Since
3440 that is done once per vector element, we don't want to cons up a
3441 fresh vector every time. */
3442 kludge
= Fmake_vector (make_number (1), Qnil
);
3443 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3446 suppress
= intern ("suppress-keymap");
3449 if (CHAR_TABLE_P (vector
))
3450 stop
= MAX_5_BYTE_CHAR
+ 1, to
= MAX_CHAR
+ 1;
3452 stop
= to
= ASIZE (vector
);
3454 for (i
= from
; ; i
++)
3456 int this_shadowed
= 0;
3457 int range_beg
, range_end
;
3471 if (CHAR_TABLE_P (vector
))
3475 val
= char_table_ref_and_range (vector
, range_beg
, &range_beg
, &i
);
3478 val
= AREF (vector
, i
);
3479 definition
= get_keyelt (val
, 0);
3481 if (NILP (definition
)) continue;
3483 /* Don't mention suppressed commands. */
3484 if (SYMBOLP (definition
) && partial
)
3488 tem
= Fget (definition
, suppress
);
3490 if (!NILP (tem
)) continue;
3493 character
= make_number (starting_i
);
3494 ASET (kludge
, 0, character
);
3496 /* If this binding is shadowed by some other map, ignore it. */
3501 tem
= shadow_lookup (shadow
, kludge
, Qt
, 0);
3512 /* Ignore this definition if it is shadowed by an earlier
3513 one in the same keymap. */
3514 if (!NILP (entire_map
))
3518 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3520 if (!EQ (tem
, definition
))
3530 /* Output the prefix that applies to every entry in this map. */
3531 if (!NILP (elt_prefix
))
3532 insert1 (elt_prefix
);
3534 insert1 (Fkey_description (kludge
, prefix
));
3536 /* Find all consecutive characters or rows that have the same
3537 definition. But, VECTOR is a char-table, we had better put a
3538 boundary between normal characters (-#x3FFF7F) and 8-bit
3539 characters (#x3FFF80-). */
3540 if (CHAR_TABLE_P (vector
))
3543 && (range_beg
= i
+ 1, range_end
= stop
- 1,
3544 val
= char_table_ref_and_range (vector
, range_beg
,
3545 &range_beg
, &range_end
),
3546 tem2
= get_keyelt (val
, 0),
3548 && !NILP (Fequal (tem2
, definition
)))
3553 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3555 && !NILP (Fequal (tem2
, definition
)))
3558 /* If we have a range of more than one character,
3559 print where the range reaches to. */
3561 if (i
!= starting_i
)
3565 ASET (kludge
, 0, make_number (i
));
3567 if (!NILP (elt_prefix
))
3568 insert1 (elt_prefix
);
3570 insert1 (Fkey_description (kludge
, prefix
));
3573 /* Print a description of the definition of this character.
3574 elt_describer will take care of spacing out far enough
3575 for alignment purposes. */
3576 (*elt_describer
) (definition
, args
);
3581 insert_string (" (binding currently shadowed)");
3586 if (CHAR_TABLE_P (vector
) && ! NILP (XCHAR_TABLE (vector
)->defalt
))
3588 if (!NILP (elt_prefix
))
3589 insert1 (elt_prefix
);
3590 insert ("default", 7);
3591 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3597 /* Apropos - finding all symbols whose names match a regexp. */
3598 static Lisp_Object apropos_predicate
;
3599 static Lisp_Object apropos_accumulate
;
3602 apropos_accum (Lisp_Object symbol
, Lisp_Object string
)
3604 register Lisp_Object tem
;
3606 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3607 if (!NILP (tem
) && !NILP (apropos_predicate
))
3608 tem
= call1 (apropos_predicate
, symbol
);
3610 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3613 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3614 doc
: /* Show all symbols whose names contain match for REGEXP.
3615 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3616 for each symbol and a symbol is mentioned only if that returns non-nil.
3617 Return list of symbols found. */)
3618 (Lisp_Object regexp
, Lisp_Object predicate
)
3621 CHECK_STRING (regexp
);
3622 apropos_predicate
= predicate
;
3623 apropos_accumulate
= Qnil
;
3624 map_obarray (Vobarray
, apropos_accum
, regexp
);
3625 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3626 apropos_accumulate
= Qnil
;
3627 apropos_predicate
= Qnil
;
3632 syms_of_keymap (void)
3634 DEFSYM (Qkeymap
, "keymap");
3635 staticpro (&apropos_predicate
);
3636 staticpro (&apropos_accumulate
);
3637 apropos_predicate
= Qnil
;
3638 apropos_accumulate
= Qnil
;
3640 DEFSYM (Qkeymap_canonicalize
, "keymap-canonicalize");
3642 /* Now we are ready to set up this property, so we can
3643 create char tables. */
3644 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3646 /* Initialize the keymaps standardly used.
3647 Each one is the value of a Lisp variable, and is also
3648 pointed to by a C variable */
3650 global_map
= Fmake_keymap (Qnil
);
3651 Fset (intern_c_string ("global-map"), global_map
);
3653 current_global_map
= global_map
;
3654 staticpro (&global_map
);
3655 staticpro (¤t_global_map
);
3657 meta_map
= Fmake_keymap (Qnil
);
3658 Fset (intern_c_string ("esc-map"), meta_map
);
3659 Ffset (intern_c_string ("ESC-prefix"), meta_map
);
3661 control_x_map
= Fmake_keymap (Qnil
);
3662 Fset (intern_c_string ("ctl-x-map"), control_x_map
);
3663 Ffset (intern_c_string ("Control-X-prefix"), control_x_map
);
3666 = pure_cons (pure_cons (make_pure_c_string ("DEL"), make_pure_c_string ("\\d")),
3667 pure_cons (pure_cons (make_pure_c_string ("TAB"), make_pure_c_string ("\\t")),
3668 pure_cons (pure_cons (make_pure_c_string ("RET"), make_pure_c_string ("\\r")),
3669 pure_cons (pure_cons (make_pure_c_string ("ESC"), make_pure_c_string ("\\e")),
3670 pure_cons (pure_cons (make_pure_c_string ("SPC"), make_pure_c_string (" ")),
3672 staticpro (&exclude_keys
);
3674 DEFVAR_LISP ("define-key-rebound-commands", Vdefine_key_rebound_commands
,
3675 doc
: /* List of commands given new key bindings recently.
3676 This is used for internal purposes during Emacs startup;
3677 don't alter it yourself. */);
3678 Vdefine_key_rebound_commands
= Qt
;
3680 DEFVAR_LISP ("minibuffer-local-map", Vminibuffer_local_map
,
3681 doc
: /* Default keymap to use when reading from the minibuffer. */);
3682 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3684 DEFVAR_LISP ("minibuffer-local-ns-map", Vminibuffer_local_ns_map
,
3685 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3686 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3687 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3690 DEFVAR_LISP ("minor-mode-map-alist", Vminor_mode_map_alist
,
3691 doc
: /* Alist of keymaps to use for minor modes.
3692 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3693 key sequences and look up bindings if VARIABLE's value is non-nil.
3694 If two active keymaps bind the same key, the keymap appearing earlier
3695 in the list takes precedence. */);
3696 Vminor_mode_map_alist
= Qnil
;
3698 DEFVAR_LISP ("minor-mode-overriding-map-alist", Vminor_mode_overriding_map_alist
,
3699 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3700 This variable is an alist just like `minor-mode-map-alist', and it is
3701 used the same way (and before `minor-mode-map-alist'); however,
3702 it is provided for major modes to bind locally. */);
3703 Vminor_mode_overriding_map_alist
= Qnil
;
3705 DEFVAR_LISP ("emulation-mode-map-alists", Vemulation_mode_map_alists
,
3706 doc
: /* List of keymap alists to use for emulations modes.
3707 It is intended for modes or packages using multiple minor-mode keymaps.
3708 Each element is a keymap alist just like `minor-mode-map-alist', or a
3709 symbol with a variable binding which is a keymap alist, and it is used
3710 the same way. The "active" keymaps in each alist are used before
3711 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3712 Vemulation_mode_map_alists
= Qnil
;
3714 DEFVAR_LISP ("where-is-preferred-modifier", Vwhere_is_preferred_modifier
,
3715 doc
: /* Preferred modifier to use for `where-is'.
3716 When a single binding is requested, `where-is' will return one that
3717 uses this modifier if possible. If nil, or if no such binding exists,
3718 bindings using keys without modifiers (or only with meta) will be
3720 Vwhere_is_preferred_modifier
= Qnil
;
3721 where_is_preferred_modifier
= 0;
3723 staticpro (&Vmouse_events
);
3724 Vmouse_events
= pure_cons (intern_c_string ("menu-bar"),
3725 pure_cons (intern_c_string ("tool-bar"),
3726 pure_cons (intern_c_string ("header-line"),
3727 pure_cons (intern_c_string ("mode-line"),
3728 pure_cons (intern_c_string ("mouse-1"),
3729 pure_cons (intern_c_string ("mouse-2"),
3730 pure_cons (intern_c_string ("mouse-3"),
3731 pure_cons (intern_c_string ("mouse-4"),
3732 pure_cons (intern_c_string ("mouse-5"),
3735 DEFSYM (Qsingle_key_description
, "single-key-description");
3736 DEFSYM (Qkey_description
, "key-description");
3737 DEFSYM (Qkeymapp
, "keymapp");
3738 DEFSYM (Qnon_ascii
, "non-ascii");
3739 DEFSYM (Qmenu_item
, "menu-item");
3740 DEFSYM (Qremap
, "remap");
3741 DEFSYM (QCadvertised_binding
, ":advertised-binding");
3743 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3744 staticpro (&command_remapping_vector
);
3746 where_is_cache_keymaps
= Qt
;
3747 where_is_cache
= Qnil
;
3748 staticpro (&where_is_cache
);
3749 staticpro (&where_is_cache_keymaps
);
3751 defsubr (&Skeymapp
);
3752 defsubr (&Skeymap_parent
);
3753 defsubr (&Skeymap_prompt
);
3754 defsubr (&Sset_keymap_parent
);
3755 defsubr (&Smake_keymap
);
3756 defsubr (&Smake_sparse_keymap
);
3757 defsubr (&Smake_composed_keymap
);
3758 defsubr (&Smap_keymap_internal
);
3759 defsubr (&Smap_keymap
);
3760 defsubr (&Scopy_keymap
);
3761 defsubr (&Scommand_remapping
);
3762 defsubr (&Skey_binding
);
3763 defsubr (&Slocal_key_binding
);
3764 defsubr (&Sglobal_key_binding
);
3765 defsubr (&Sminor_mode_key_binding
);
3766 defsubr (&Sdefine_key
);
3767 defsubr (&Slookup_key
);
3768 defsubr (&Sdefine_prefix_command
);
3769 defsubr (&Suse_global_map
);
3770 defsubr (&Suse_local_map
);
3771 defsubr (&Scurrent_local_map
);
3772 defsubr (&Scurrent_global_map
);
3773 defsubr (&Scurrent_minor_mode_maps
);
3774 defsubr (&Scurrent_active_maps
);
3775 defsubr (&Saccessible_keymaps
);
3776 defsubr (&Skey_description
);
3777 defsubr (&Sdescribe_vector
);
3778 defsubr (&Ssingle_key_description
);
3779 defsubr (&Stext_char_description
);
3780 defsubr (&Swhere_is_internal
);
3781 defsubr (&Sdescribe_buffer_bindings
);
3782 defsubr (&Sapropos_internal
);
3786 keys_of_keymap (void)
3788 initial_define_key (global_map
, 033, "ESC-prefix");
3789 initial_define_key (global_map
, Ctl ('X'), "Control-X-prefix");