1 /* Manipulation of keymaps
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
30 #include "character.h"
34 #include "termhooks.h"
35 #include "blockinput.h"
37 #include "intervals.h"
41 /* The number of elements in keymap vectors. */
42 #define DENSE_TABLE_SIZE (0200)
44 /* Actually allocate storage for these variables */
46 Lisp_Object current_global_map
; /* Current global keymap */
48 Lisp_Object global_map
; /* default global key bindings */
50 Lisp_Object meta_map
; /* The keymap used for globally bound
51 ESC-prefixed default commands */
53 Lisp_Object control_x_map
; /* The keymap used for globally bound
54 C-x-prefixed default commands */
56 /* was MinibufLocalMap */
57 Lisp_Object Vminibuffer_local_map
;
58 /* The keymap used by the minibuf for local
59 bindings when spaces are allowed in the
62 /* was MinibufLocalNSMap */
63 Lisp_Object Vminibuffer_local_ns_map
;
64 /* The keymap used by the minibuf for local
65 bindings when spaces are not encouraged
68 /* keymap used for minibuffers when doing completion */
69 /* was MinibufLocalCompletionMap */
70 Lisp_Object Vminibuffer_local_completion_map
;
72 /* keymap used for minibuffers when doing completion in filenames */
73 Lisp_Object Vminibuffer_local_filename_completion_map
;
75 /* keymap used for minibuffers when doing completion in filenames
77 Lisp_Object Vminibuffer_local_filename_must_match_map
;
79 /* keymap used for minibuffers when doing completion and require a match */
80 /* was MinibufLocalMustMatchMap */
81 Lisp_Object Vminibuffer_local_must_match_map
;
83 /* Alist of minor mode variables and keymaps. */
84 Lisp_Object Vminor_mode_map_alist
;
86 /* Alist of major-mode-specific overrides for
87 minor mode variables and keymaps. */
88 Lisp_Object Vminor_mode_overriding_map_alist
;
90 /* List of emulation mode keymap alists. */
91 Lisp_Object Vemulation_mode_map_alists
;
93 /* A list of all commands given new bindings since a certain time
94 when nil was stored here.
95 This is used to speed up recomputation of menu key equivalents
96 when Emacs starts up. t means don't record anything here. */
97 Lisp_Object Vdefine_key_rebound_commands
;
99 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
101 /* Alist of elements like (DEL . "\d"). */
102 static Lisp_Object exclude_keys
;
104 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
105 static Lisp_Object command_remapping_vector
;
107 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
108 in a string key sequence is equivalent to prefixing with this
110 extern Lisp_Object meta_prefix_char
;
112 extern Lisp_Object Voverriding_local_map
;
114 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
115 static Lisp_Object where_is_cache
;
116 /* Which keymaps are reverse-stored in the cache. */
117 static Lisp_Object where_is_cache_keymaps
;
119 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
120 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
122 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
123 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
124 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
125 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
126 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
127 int, Lisp_Object
, Lisp_Object
*, int, int));
128 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
129 void (*) (Lisp_Object
, Lisp_Object
), int,
130 Lisp_Object
, Lisp_Object
, int *,
132 static void silly_event_symbol_error
P_ ((Lisp_Object
));
134 /* Keymap object support - constructors and predicates. */
136 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
137 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
138 CHARTABLE is a char-table that holds the bindings for all characters
139 without modifiers. All entries in it are initially nil, meaning
140 "command undefined". ALIST is an assoc-list which holds bindings for
141 function keys, mouse events, and any other things that appear in the
142 input stream. Initially, ALIST is nil.
144 The optional arg STRING supplies a menu name for the keymap
145 in case you use it as a menu with `x-popup-menu'. */)
151 tail
= Fcons (string
, Qnil
);
154 return Fcons (Qkeymap
,
155 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
158 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
159 doc
: /* Construct and return a new sparse keymap.
160 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
161 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
162 which binds the function key or mouse event SYMBOL to DEFINITION.
163 Initially the alist is nil.
165 The optional arg STRING supplies a menu name for the keymap
166 in case you use it as a menu with `x-popup-menu'. */)
171 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
172 return Fcons (Qkeymap
, Qnil
);
175 /* This function is used for installing the standard key bindings
176 at initialization time.
180 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
183 initial_define_key (keymap
, key
, defname
)
188 store_in_keymap (keymap
, make_number (key
), intern (defname
));
192 initial_define_lispy_key (keymap
, keyname
, defname
)
197 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
200 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
201 doc
: /* Return t if OBJECT is a keymap.
203 A keymap is a list (keymap . ALIST),
204 or a symbol whose function definition is itself a keymap.
205 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
206 a vector of densely packed bindings for small character codes
207 is also allowed as an element. */)
211 return (KEYMAPP (object
) ? Qt
: Qnil
);
214 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
215 doc
: /* Return the prompt-string of a keymap MAP.
216 If non-nil, the prompt is shown in the echo-area
217 when reading a key-sequence to be looked-up in this keymap. */)
221 map
= get_keymap (map
, 0, 0);
224 Lisp_Object tem
= XCAR (map
);
232 /* Check that OBJECT is a keymap (after dereferencing through any
233 symbols). If it is, return it.
235 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
236 is an autoload form, do the autoload and try again.
237 If AUTOLOAD is nonzero, callers must assume GC is possible.
239 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
240 is zero as well), return Qt.
242 ERROR controls how we respond if OBJECT isn't a keymap.
243 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
245 Note that most of the time, we don't want to pursue autoloads.
246 Functions like Faccessible_keymaps which scan entire keymap trees
247 shouldn't load every autoloaded keymap. I'm not sure about this,
248 but it seems to me that only read_key_sequence, Flookup_key, and
249 Fdefine_key should cause keymaps to be autoloaded.
251 This function can GC when AUTOLOAD is non-zero, because it calls
252 do_autoload which can GC. */
255 get_keymap (object
, error
, autoload
)
264 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
267 tem
= indirect_function (object
);
270 if (EQ (XCAR (tem
), Qkeymap
))
273 /* Should we do an autoload? Autoload forms for keymaps have
274 Qkeymap as their fifth element. */
275 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
)
280 tail
= Fnth (make_number (4), tem
);
281 if (EQ (tail
, Qkeymap
))
285 struct gcpro gcpro1
, gcpro2
;
287 GCPRO2 (tem
, object
);
288 do_autoload (tem
, object
);
301 wrong_type_argument (Qkeymapp
, object
);
305 /* Return the parent map of KEYMAP, or nil if it has none.
306 We assume that KEYMAP is a valid keymap. */
309 keymap_parent (keymap
, autoload
)
315 keymap
= get_keymap (keymap
, 1, autoload
);
317 /* Skip past the initial element `keymap'. */
318 list
= XCDR (keymap
);
319 for (; CONSP (list
); list
= XCDR (list
))
321 /* See if there is another `keymap'. */
326 return get_keymap (list
, 0, autoload
);
329 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
330 doc
: /* Return the parent keymap of KEYMAP. */)
334 return keymap_parent (keymap
, 1);
337 /* Check whether MAP is one of MAPS parents. */
339 keymap_memberp (map
, maps
)
340 Lisp_Object map
, maps
;
342 if (NILP (map
)) return 0;
343 while (KEYMAPP (maps
) && !EQ (map
, maps
))
344 maps
= keymap_parent (maps
, 0);
345 return (EQ (map
, maps
));
348 /* Set the parent keymap of MAP to PARENT. */
350 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
351 doc
: /* Modify KEYMAP to set its parent map to PARENT.
352 Return PARENT. PARENT should be nil or another keymap. */)
354 Lisp_Object keymap
, parent
;
356 Lisp_Object list
, prev
;
357 struct gcpro gcpro1
, gcpro2
;
360 /* Force a keymap flush for the next call to where-is.
361 Since this can be called from within where-is, we don't set where_is_cache
362 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
363 be changed during where-is, while where_is_cache_keymaps is only used at
364 the very beginning of where-is and can thus be changed here without any
366 This is a very minor correctness (rather than safety) issue. */
367 where_is_cache_keymaps
= Qt
;
369 GCPRO2 (keymap
, parent
);
370 keymap
= get_keymap (keymap
, 1, 1);
374 parent
= get_keymap (parent
, 1, 1);
376 /* Check for cycles. */
377 if (keymap_memberp (keymap
, parent
))
378 error ("Cyclic keymap inheritance");
381 /* Skip past the initial element `keymap'. */
386 /* If there is a parent keymap here, replace it.
387 If we came to the end, add the parent in PREV. */
388 if (!CONSP (list
) || KEYMAPP (list
))
390 /* If we already have the right parent, return now
391 so that we avoid the loops below. */
392 if (EQ (XCDR (prev
), parent
))
393 RETURN_UNGCPRO (parent
);
396 XSETCDR (prev
, parent
);
402 /* Scan through for submaps, and set their parents too. */
404 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
406 /* Stop the scan when we come to the parent. */
407 if (EQ (XCAR (list
), Qkeymap
))
410 /* If this element holds a prefix map, deal with it. */
411 if (CONSP (XCAR (list
))
412 && CONSP (XCDR (XCAR (list
))))
413 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
416 if (VECTORP (XCAR (list
)))
417 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
418 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
419 fix_submap_inheritance (keymap
, make_number (i
),
420 XVECTOR (XCAR (list
))->contents
[i
]);
422 if (CHAR_TABLE_P (XCAR (list
)))
424 map_char_table (fix_submap_inheritance
, Qnil
, XCAR (list
), keymap
);
428 RETURN_UNGCPRO (parent
);
431 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
432 if EVENT is also a prefix in MAP's parent,
433 make sure that SUBMAP inherits that definition as its own parent. */
436 fix_submap_inheritance (map
, event
, submap
)
437 Lisp_Object map
, event
, submap
;
439 Lisp_Object map_parent
, parent_entry
;
441 /* SUBMAP is a cons that we found as a key binding.
442 Discard the other things found in a menu key binding. */
444 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
446 /* If it isn't a keymap now, there's no work to do. */
450 map_parent
= keymap_parent (map
, 0);
451 if (!NILP (map_parent
))
453 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
457 /* If MAP's parent has something other than a keymap,
458 our own submap shadows it completely. */
459 if (!CONSP (parent_entry
))
462 if (! EQ (parent_entry
, submap
))
464 Lisp_Object submap_parent
;
465 submap_parent
= submap
;
470 tem
= keymap_parent (submap_parent
, 0);
474 if (keymap_memberp (tem
, parent_entry
))
475 /* Fset_keymap_parent could create a cycle. */
482 Fset_keymap_parent (submap_parent
, parent_entry
);
486 /* Look up IDX in MAP. IDX may be any sort of event.
487 Note that this does only one level of lookup; IDX must be a single
488 event, not a sequence.
490 If T_OK is non-zero, bindings for Qt are treated as default
491 bindings; any key left unmentioned by other tables and bindings is
492 given the binding of Qt.
494 If T_OK is zero, bindings for Qt are not treated specially.
496 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
499 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
508 /* Qunbound in VAL means we have found no binding yet. */
511 /* If idx is a list (some sort of mouse click, perhaps?),
512 the index we want to use is the car of the list, which
513 ought to be a symbol. */
514 idx
= EVENT_HEAD (idx
);
516 /* If idx is a symbol, it might have modifiers, which need to
517 be put in the canonical order. */
519 idx
= reorder_modifiers (idx
);
520 else if (INTEGERP (idx
))
521 /* Clobber the high bits that can be present on a machine
522 with more than 24 bits of integer. */
523 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
525 /* Handle the special meta -> esc mapping. */
526 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
528 /* See if there is a meta-map. If there's none, there is
529 no binding for IDX, unless a default binding exists in MAP. */
531 Lisp_Object meta_map
;
533 /* A strange value in which Meta is set would cause
534 infinite recursion. Protect against that. */
535 if (XINT (meta_prefix_char
) & CHAR_META
)
536 meta_prefix_char
= make_number (27);
537 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
538 t_ok
, noinherit
, autoload
),
541 if (CONSP (meta_map
))
544 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
547 /* Set IDX to t, so that we only find a default binding. */
550 /* We know there is no binding. */
554 /* t_binding is where we put a default binding that applies,
555 to use in case we do not find a binding specifically
556 for this key sequence. */
559 Lisp_Object t_binding
= Qnil
;
560 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
562 GCPRO4 (map
, tail
, idx
, t_binding
);
564 for (tail
= XCDR (map
);
566 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
571 binding
= XCAR (tail
);
572 if (SYMBOLP (binding
))
574 /* If NOINHERIT, stop finding prefix definitions
575 after we pass a second occurrence of the `keymap' symbol. */
576 if (noinherit
&& EQ (binding
, Qkeymap
))
577 RETURN_UNGCPRO (Qnil
);
579 else if (CONSP (binding
))
581 Lisp_Object key
= XCAR (binding
);
584 val
= XCDR (binding
);
585 else if (t_ok
&& EQ (key
, Qt
))
587 t_binding
= XCDR (binding
);
591 else if (VECTORP (binding
))
593 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
594 val
= AREF (binding
, XFASTINT (idx
));
596 else if (CHAR_TABLE_P (binding
))
598 /* Character codes with modifiers
599 are not included in a char-table.
600 All character codes without modifiers are included. */
601 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
603 val
= Faref (binding
, idx
);
604 /* `nil' has a special meaning for char-tables, so
605 we use something else to record an explicitly
612 /* If we found a binding, clean it up and return it. */
613 if (!EQ (val
, Qunbound
))
616 /* A Qt binding is just like an explicit nil binding
617 (i.e. it shadows any parent binding but not bindings in
618 keymaps of lower precedence). */
620 val
= get_keyelt (val
, autoload
);
622 fix_submap_inheritance (map
, idx
, val
);
623 RETURN_UNGCPRO (val
);
628 return get_keyelt (t_binding
, autoload
);
633 map_keymap_item (fun
, args
, key
, val
, data
)
634 map_keymap_function_t fun
;
635 Lisp_Object args
, key
, val
;
638 /* We should maybe try to detect bindings shadowed by previous
639 ones and things like that. */
642 (*fun
) (key
, val
, args
, data
);
646 map_keymap_char_table_item (args
, key
, val
)
647 Lisp_Object args
, key
, val
;
651 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
653 map_keymap_item (fun
, XCDR (args
), key
, val
,
654 XSAVE_VALUE (XCAR (args
))->pointer
);
658 /* Call FUN for every binding in MAP and stop at (and return) the parent.
659 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA). */
661 map_keymap_internal (Lisp_Object map
,
662 map_keymap_function_t fun
,
666 struct gcpro gcpro1
, gcpro2
, gcpro3
;
668 = (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
670 GCPRO3 (map
, args
, tail
);
671 for (; CONSP (tail
) && !EQ (Qkeymap
, XCAR (tail
)); tail
= XCDR (tail
))
673 Lisp_Object binding
= XCAR (tail
);
676 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
677 else if (VECTORP (binding
))
679 /* Loop over the char values represented in the vector. */
680 int len
= ASIZE (binding
);
682 for (c
= 0; c
< len
; c
++)
684 Lisp_Object character
;
685 XSETFASTINT (character
, c
);
686 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
689 else if (CHAR_TABLE_P (binding
))
691 map_char_table (map_keymap_char_table_item
, Qnil
, binding
,
692 Fcons (make_save_value (fun
, 0),
693 Fcons (make_save_value (data
, 0),
702 map_keymap_call (key
, val
, fun
, dummy
)
703 Lisp_Object key
, val
, fun
;
706 call2 (fun
, key
, val
);
709 /* Same as map_keymap_internal, but doesn't traverses parent keymaps as well.
710 A non-zero AUTOLOAD indicates that autoloaded keymaps should be loaded. */
712 map_keymap (map
, fun
, args
, data
, autoload
)
713 map_keymap_function_t fun
;
714 Lisp_Object map
, args
;
720 map
= get_keymap (map
, 1, autoload
);
723 map
= map_keymap_internal (map
, fun
, args
, data
);
724 map
= get_keymap (map
, 0, autoload
);
729 Lisp_Object Qkeymap_canonicalize
;
731 /* Same as map_keymap, but does it right, properly eliminating duplicate
732 bindings due to inheritance. */
734 map_keymap_canonical (map
, fun
, args
, data
)
735 map_keymap_function_t fun
;
736 Lisp_Object map
, args
;
741 /* map_keymap_canonical may be used from redisplay (e.g. when building menus)
742 so be careful to ignore errors and to inhibit redisplay. */
743 map
= safe_call1 (Qkeymap_canonicalize
, map
);
744 /* No need to use `map_keymap' here because canonical map has no parent. */
745 map_keymap_internal (map
, fun
, args
, data
);
749 DEFUN ("map-keymap-internal", Fmap_keymap_internal
, Smap_keymap_internal
, 2, 2, 0,
750 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
751 FUNCTION is called with two arguments: the event that is bound, and
752 the definition it is bound to. The event may be a character range.
753 If KEYMAP has a parent, this function returns it without processing it. */)
755 Lisp_Object function
, keymap
;
759 keymap
= get_keymap (keymap
, 1, 1);
760 keymap
= map_keymap_internal (keymap
, map_keymap_call
, function
, NULL
);
765 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
766 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
767 FUNCTION is called with two arguments: the event that is bound, and
768 the definition it is bound to. The event may be a character range.
770 If KEYMAP has a parent, the parent's bindings are included as well.
771 This works recursively: if the parent has itself a parent, then the
772 grandparent's bindings are also included and so on.
773 usage: (map-keymap FUNCTION KEYMAP) */)
774 (function
, keymap
, sort_first
)
775 Lisp_Object function
, keymap
, sort_first
;
777 if (! NILP (sort_first
))
778 return call2 (intern ("map-keymap-sorted"), function
, keymap
);
780 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
784 /* Given OBJECT which was found in a slot in a keymap,
785 trace indirect definitions to get the actual definition of that slot.
786 An indirect definition is a list of the form
787 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
788 and INDEX is the object to look up in KEYMAP to yield the definition.
790 Also if OBJECT has a menu string as the first element,
791 remove that. Also remove a menu help string as second element.
793 If AUTOLOAD is nonzero, load autoloadable keymaps
794 that are referred to with indirection.
796 This can GC because menu_item_eval_property calls Feval. */
799 get_keyelt (object
, autoload
)
805 if (!(CONSP (object
)))
806 /* This is really the value. */
809 /* If the keymap contents looks like (keymap ...) or (lambda ...)
811 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
814 /* If the keymap contents looks like (menu-item name . DEFN)
815 or (menu-item name DEFN ...) then use DEFN.
816 This is a new format menu item. */
817 else if (EQ (XCAR (object
), Qmenu_item
))
819 if (CONSP (XCDR (object
)))
823 object
= XCDR (XCDR (object
));
826 object
= XCAR (object
);
828 /* If there's a `:filter FILTER', apply FILTER to the
829 menu-item's definition to get the real definition to
831 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
832 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
835 filter
= XCAR (XCDR (tem
));
836 filter
= list2 (filter
, list2 (Qquote
, object
));
837 object
= menu_item_eval_property (filter
);
842 /* Invalid keymap. */
846 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
847 Keymap alist elements like (CHAR MENUSTRING . DEFN)
848 will be used by HierarKey menus. */
849 else if (STRINGP (XCAR (object
)))
851 object
= XCDR (object
);
852 /* Also remove a menu help string, if any,
853 following the menu item name. */
854 if (CONSP (object
) && STRINGP (XCAR (object
)))
855 object
= XCDR (object
);
856 /* Also remove the sublist that caches key equivalences, if any. */
857 if (CONSP (object
) && CONSP (XCAR (object
)))
860 carcar
= XCAR (XCAR (object
));
861 if (NILP (carcar
) || VECTORP (carcar
))
862 object
= XCDR (object
);
866 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
872 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
874 return (!CONSP (map
) ? object
/* Invalid keymap */
875 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
881 store_in_keymap (keymap
, idx
, def
)
883 register Lisp_Object idx
;
886 /* Flush any reverse-map cache. */
887 where_is_cache
= Qnil
;
888 where_is_cache_keymaps
= Qt
;
890 /* If we are preparing to dump, and DEF is a menu element
891 with a menu item indicator, copy it to ensure it is not pure. */
892 if (CONSP (def
) && PURE_P (def
)
893 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
894 def
= Fcons (XCAR (def
), XCDR (def
));
896 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
897 error ("attempt to define a key in a non-keymap");
899 /* If idx is a cons, and the car part is a character, idx must be of
900 the form (FROM-CHAR . TO-CHAR). */
901 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
902 CHECK_CHARACTER_CDR (idx
);
904 /* If idx is a list (some sort of mouse click, perhaps?),
905 the index we want to use is the car of the list, which
906 ought to be a symbol. */
907 idx
= EVENT_HEAD (idx
);
909 /* If idx is a symbol, it might have modifiers, which need to
910 be put in the canonical order. */
912 idx
= reorder_modifiers (idx
);
913 else if (INTEGERP (idx
))
914 /* Clobber the high bits that can be present on a machine
915 with more than 24 bits of integer. */
916 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
918 /* Scan the keymap for a binding of idx. */
922 /* The cons after which we should insert new bindings. If the
923 keymap has a table element, we record its position here, so new
924 bindings will go after it; this way, the table will stay
925 towards the front of the alist and character lookups in dense
926 keymaps will remain fast. Otherwise, this just points at the
927 front of the keymap. */
928 Lisp_Object insertion_point
;
930 insertion_point
= keymap
;
931 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
938 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
941 ASET (elt
, XFASTINT (idx
), def
);
944 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
946 int from
= XFASTINT (XCAR (idx
));
947 int to
= XFASTINT (XCDR (idx
));
949 if (to
>= ASIZE (elt
))
950 to
= ASIZE (elt
) - 1;
951 for (; from
<= to
; from
++)
952 ASET (elt
, from
, def
);
953 if (to
== XFASTINT (XCDR (idx
)))
954 /* We have defined all keys in IDX. */
957 insertion_point
= tail
;
959 else if (CHAR_TABLE_P (elt
))
961 /* Character codes with modifiers
962 are not included in a char-table.
963 All character codes without modifiers are included. */
964 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
967 /* `nil' has a special meaning for char-tables, so
968 we use something else to record an explicitly
970 NILP (def
) ? Qt
: def
);
973 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
975 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
978 insertion_point
= tail
;
980 else if (CONSP (elt
))
982 if (EQ (idx
, XCAR (elt
)))
988 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
990 int from
= XFASTINT (XCAR (idx
));
991 int to
= XFASTINT (XCDR (idx
));
993 if (from
<= XFASTINT (XCAR (elt
))
994 && to
>= XFASTINT (XCAR (elt
)))
1002 else if (EQ (elt
, Qkeymap
))
1003 /* If we find a 'keymap' symbol in the spine of KEYMAP,
1004 then we must have found the start of a second keymap
1005 being used as the tail of KEYMAP, and a binding for IDX
1006 should be inserted before it. */
1013 /* We have scanned the entire keymap, and not found a binding for
1014 IDX. Let's add one. */
1018 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
1020 /* IDX specifies a range of characters, and not all of them
1021 were handled yet, which means this keymap doesn't have a
1022 char-table. So, we insert a char-table now. */
1023 elt
= Fmake_char_table (Qkeymap
, Qnil
);
1024 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
1027 elt
= Fcons (idx
, def
);
1028 CHECK_IMPURE (insertion_point
);
1029 XSETCDR (insertion_point
, Fcons (elt
, XCDR (insertion_point
)));
1036 EXFUN (Fcopy_keymap
, 1);
1039 copy_keymap_item (elt
)
1042 Lisp_Object res
, tem
;
1049 /* Is this a new format menu item. */
1050 if (EQ (XCAR (tem
), Qmenu_item
))
1052 /* Copy cell with menu-item marker. */
1053 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1057 /* Copy cell with menu-item name. */
1058 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1064 /* Copy cell with binding and if the binding is a keymap,
1066 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1069 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1070 XSETCAR (elt
, Fcopy_keymap (tem
));
1072 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1073 /* Delete cache for key equivalences. */
1074 XSETCDR (elt
, XCDR (tem
));
1079 /* It may be an old fomat menu item.
1080 Skip the optional menu string. */
1081 if (STRINGP (XCAR (tem
)))
1083 /* Copy the cell, since copy-alist didn't go this deep. */
1084 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1086 /* Also skip the optional menu help string. */
1087 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1089 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1093 /* There may also be a list that caches key equivalences.
1094 Just delete it for the new keymap. */
1096 && CONSP (XCAR (tem
))
1097 && (NILP (XCAR (XCAR (tem
)))
1098 || VECTORP (XCAR (XCAR (tem
)))))
1100 XSETCDR (elt
, XCDR (tem
));
1103 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1104 XSETCDR (elt
, Fcopy_keymap (tem
));
1106 else if (EQ (XCAR (tem
), Qkeymap
))
1107 res
= Fcopy_keymap (elt
);
1113 copy_keymap_1 (chartable
, idx
, elt
)
1114 Lisp_Object chartable
, idx
, elt
;
1116 Fset_char_table_range (chartable
, idx
, copy_keymap_item (elt
));
1119 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1120 doc
: /* Return a copy of the keymap KEYMAP.
1121 The copy starts out with the same definitions of KEYMAP,
1122 but changing either the copy or KEYMAP does not affect the other.
1123 Any key definitions that are subkeymaps are recursively copied.
1124 However, a key definition which is a symbol whose definition is a keymap
1129 register Lisp_Object copy
, tail
;
1130 keymap
= get_keymap (keymap
, 1, 0);
1131 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1132 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1134 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1136 Lisp_Object elt
= XCAR (keymap
);
1137 if (CHAR_TABLE_P (elt
))
1139 elt
= Fcopy_sequence (elt
);
1140 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
);
1142 else if (VECTORP (elt
))
1145 elt
= Fcopy_sequence (elt
);
1146 for (i
= 0; i
< ASIZE (elt
); i
++)
1147 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1149 else if (CONSP (elt
))
1150 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1151 XSETCDR (tail
, Fcons (elt
, Qnil
));
1153 keymap
= XCDR (keymap
);
1155 XSETCDR (tail
, keymap
);
1159 /* Simple Keymap mutators and accessors. */
1161 /* GC is possible in this function if it autoloads a keymap. */
1163 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1164 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1167 KEY is a string or a vector of symbols and characters meaning a
1168 sequence of keystrokes and events. Non-ASCII characters with codes
1169 above 127 (such as ISO Latin-1) can be included if you use a vector.
1170 Using [t] for KEY creates a default definition, which applies to any
1171 event type that has no other definition in this keymap.
1173 DEF is anything that can be a key's definition:
1174 nil (means key is undefined in this keymap),
1175 a command (a Lisp function suitable for interactive calling),
1176 a string (treated as a keyboard macro),
1177 a keymap (to define a prefix key),
1178 a symbol (when the key is looked up, the symbol will stand for its
1179 function definition, which should at that time be one of the above,
1180 or another symbol whose function definition is used, etc.),
1181 a cons (STRING . DEFN), meaning that DEFN is the definition
1182 (DEFN should be a valid definition in its own right),
1183 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP,
1184 or an extended menu item definition.
1185 (See info node `(elisp)Extended Menu Items'.)
1187 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1188 binding is altered. If there is no binding for KEY, the new pair
1189 binding KEY to DEF is added at the front of KEYMAP. */)
1196 register Lisp_Object c
;
1197 register Lisp_Object cmd
;
1201 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1203 GCPRO3 (keymap
, key
, def
);
1204 keymap
= get_keymap (keymap
, 1, 1);
1206 CHECK_VECTOR_OR_STRING (key
);
1208 length
= XFASTINT (Flength (key
));
1210 RETURN_UNGCPRO (Qnil
);
1212 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1213 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1215 meta_bit
= (VECTORP (key
) || (STRINGP (key
) && STRING_MULTIBYTE (key
))
1216 ? meta_modifier
: 0x80);
1218 if (VECTORP (def
) && ASIZE (def
) > 0 && CONSP (AREF (def
, 0)))
1219 { /* DEF is apparently an XEmacs-style keyboard macro. */
1220 Lisp_Object tmp
= Fmake_vector (make_number (ASIZE (def
)), Qnil
);
1221 int i
= ASIZE (def
);
1224 Lisp_Object c
= AREF (def
, i
);
1225 if (CONSP (c
) && lucid_event_type_list_p (c
))
1226 c
= Fevent_convert_list (c
);
1235 c
= Faref (key
, make_number (idx
));
1239 /* C may be a Lucid style event type list or a cons (FROM .
1240 TO) specifying a range of characters. */
1241 if (lucid_event_type_list_p (c
))
1242 c
= Fevent_convert_list (c
);
1243 else if (CHARACTERP (XCAR (c
)))
1244 CHECK_CHARACTER_CDR (c
);
1248 silly_event_symbol_error (c
);
1251 && (XINT (c
) & meta_bit
)
1254 c
= meta_prefix_char
;
1260 XSETINT (c
, XINT (c
) & ~meta_bit
);
1266 if (!INTEGERP (c
) && !SYMBOLP (c
)
1268 /* If C is a range, it must be a leaf. */
1269 || (INTEGERP (XCAR (c
)) && idx
!= length
)))
1270 error ("Key sequence contains invalid event");
1273 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1275 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1277 /* If this key is undefined, make it a prefix. */
1279 cmd
= define_as_prefix (keymap
, c
);
1281 keymap
= get_keymap (cmd
, 0, 1);
1282 if (!CONSP (keymap
))
1283 /* We must use Fkey_description rather than just passing key to
1284 error; key might be a vector, not a string. */
1285 error ("Key sequence %s starts with non-prefix key %s",
1286 SDATA (Fkey_description (key
, Qnil
)),
1287 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1293 /* This function may GC (it calls Fkey_binding). */
1295 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 3, 0,
1296 doc
: /* Return the remapping for command COMMAND.
1297 Returns nil if COMMAND is not remapped (or not a symbol).
1299 If the optional argument POSITION is non-nil, it specifies a mouse
1300 position as returned by `event-start' and `event-end', and the
1301 remapping occurs in the keymaps associated with it. It can also be a
1302 number or marker, in which case the keymap properties at the specified
1303 buffer position instead of point are used. The KEYMAPS argument is
1304 ignored if POSITION is non-nil.
1306 If the optional argument KEYMAPS is non-nil, it should be a list of
1307 keymaps to search for command remapping. Otherwise, search for the
1308 remapping in all currently active keymaps. */)
1309 (command
, position
, keymaps
)
1310 Lisp_Object command
, position
, keymaps
;
1312 if (!SYMBOLP (command
))
1315 ASET (command_remapping_vector
, 1, command
);
1318 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
, position
);
1321 Lisp_Object maps
, binding
;
1323 for (maps
= keymaps
; CONSP (maps
); maps
= XCDR (maps
))
1325 binding
= Flookup_key (XCAR (maps
), command_remapping_vector
, Qnil
);
1326 if (!NILP (binding
) && !INTEGERP (binding
))
1333 /* Value is number if KEY is too long; nil if valid but has no definition. */
1334 /* GC is possible in this function if it autoloads a keymap. */
1336 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1337 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1338 A value of nil means undefined. See doc of `define-key'
1339 for kinds of definitions.
1341 A number as value means KEY is "too long";
1342 that is, characters or symbols in it except for the last one
1343 fail to be a valid sequence of prefix characters in KEYMAP.
1344 The number is how many characters at the front of KEY
1345 it takes to reach a non-prefix key.
1347 Normally, `lookup-key' ignores bindings for t, which act as default
1348 bindings, used when nothing else in the keymap applies; this makes it
1349 usable as a general function for probing keymaps. However, if the
1350 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1351 recognize the default bindings, just as `read-key-sequence' does. */)
1352 (keymap
, key
, accept_default
)
1355 Lisp_Object accept_default
;
1358 register Lisp_Object cmd
;
1359 register Lisp_Object c
;
1361 int t_ok
= !NILP (accept_default
);
1362 struct gcpro gcpro1
, gcpro2
;
1364 GCPRO2 (keymap
, key
);
1365 keymap
= get_keymap (keymap
, 1, 1);
1367 CHECK_VECTOR_OR_STRING (key
);
1369 length
= XFASTINT (Flength (key
));
1371 RETURN_UNGCPRO (keymap
);
1376 c
= Faref (key
, make_number (idx
++));
1378 if (CONSP (c
) && lucid_event_type_list_p (c
))
1379 c
= Fevent_convert_list (c
);
1381 /* Turn the 8th bit of string chars into a meta modifier. */
1382 if (STRINGP (key
) && XINT (c
) & 0x80 && !STRING_MULTIBYTE (key
))
1383 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1385 /* Allow string since binding for `menu-bar-select-buffer'
1386 includes the buffer name in the key sequence. */
1387 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1388 error ("Key sequence contains invalid event");
1390 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1392 RETURN_UNGCPRO (cmd
);
1394 keymap
= get_keymap (cmd
, 0, 1);
1395 if (!CONSP (keymap
))
1396 RETURN_UNGCPRO (make_number (idx
));
1402 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1403 Assume that currently it does not define C at all.
1404 Return the keymap. */
1407 define_as_prefix (keymap
, c
)
1408 Lisp_Object keymap
, c
;
1412 cmd
= Fmake_sparse_keymap (Qnil
);
1413 /* If this key is defined as a prefix in an inherited keymap,
1414 make it a prefix in this map, and make its definition
1415 inherit the other prefix definition. */
1416 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1417 store_in_keymap (keymap
, c
, cmd
);
1422 /* Append a key to the end of a key sequence. We always make a vector. */
1425 append_key (key_sequence
, key
)
1426 Lisp_Object key_sequence
, key
;
1428 Lisp_Object args
[2];
1430 args
[0] = key_sequence
;
1432 args
[1] = Fcons (key
, Qnil
);
1433 return Fvconcat (2, args
);
1436 /* Given a event type C which is a symbol,
1437 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1440 silly_event_symbol_error (c
)
1443 Lisp_Object parsed
, base
, name
, assoc
;
1446 parsed
= parse_modifiers (c
);
1447 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1448 base
= XCAR (parsed
);
1449 name
= Fsymbol_name (base
);
1450 /* This alist includes elements such as ("RET" . "\\r"). */
1451 assoc
= Fassoc (name
, exclude_keys
);
1455 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1457 Lisp_Object keystring
;
1458 if (modifiers
& alt_modifier
)
1459 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1460 if (modifiers
& ctrl_modifier
)
1461 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1462 if (modifiers
& hyper_modifier
)
1463 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1464 if (modifiers
& meta_modifier
)
1465 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1466 if (modifiers
& shift_modifier
)
1467 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1468 if (modifiers
& super_modifier
)
1469 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1472 c
= reorder_modifiers (c
);
1473 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1475 error ((modifiers
& ~meta_modifier
1476 ? "To bind the key %s, use [?%s], not [%s]"
1477 : "To bind the key %s, use \"%s\", not [%s]"),
1478 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1479 SDATA (SYMBOL_NAME (c
)));
1483 /* Global, local, and minor mode keymap stuff. */
1485 /* We can't put these variables inside current_minor_maps, since under
1486 some systems, static gets macro-defined to be the empty string.
1488 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1489 static int cmm_size
= 0;
1491 /* Store a pointer to an array of the currently active minor modes in
1492 *modeptr, a pointer to an array of the keymaps of the currently
1493 active minor modes in *mapptr, and return the number of maps
1496 This function always returns a pointer to the same buffer, and may
1497 free or reallocate it, so if you want to keep it for a long time or
1498 hand it out to lisp code, copy it. This procedure will be called
1499 for every key sequence read, so the nice lispy approach (return a
1500 new assoclist, list, what have you) for each invocation would
1501 result in a lot of consing over time.
1503 If we used xrealloc/xmalloc and ran out of memory, they would throw
1504 back to the command loop, which would try to read a key sequence,
1505 which would call this function again, resulting in an infinite
1506 loop. Instead, we'll use realloc/malloc and silently truncate the
1507 list, let the key sequence be read, and hope some other piece of
1508 code signals the error. */
1510 current_minor_maps (modeptr
, mapptr
)
1511 Lisp_Object
**modeptr
, **mapptr
;
1514 int list_number
= 0;
1515 Lisp_Object alist
, assoc
, var
, val
;
1516 Lisp_Object emulation_alists
;
1517 Lisp_Object lists
[2];
1519 emulation_alists
= Vemulation_mode_map_alists
;
1520 lists
[0] = Vminor_mode_overriding_map_alist
;
1521 lists
[1] = Vminor_mode_map_alist
;
1523 for (list_number
= 0; list_number
< 2; list_number
++)
1525 if (CONSP (emulation_alists
))
1527 alist
= XCAR (emulation_alists
);
1528 emulation_alists
= XCDR (emulation_alists
);
1529 if (SYMBOLP (alist
))
1530 alist
= find_symbol_value (alist
);
1534 alist
= lists
[list_number
];
1536 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1537 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1538 && (var
= XCAR (assoc
), SYMBOLP (var
))
1539 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1544 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1545 and also an entry in Vminor_mode_map_alist,
1546 ignore the latter. */
1547 if (list_number
== 1)
1549 val
= assq_no_quit (var
, lists
[0]);
1556 int newsize
, allocsize
;
1557 Lisp_Object
*newmodes
, *newmaps
;
1559 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1560 allocsize
= newsize
* sizeof *newmodes
;
1562 /* Use malloc here. See the comment above this function.
1563 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1565 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1570 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1573 cmm_modes
= newmodes
;
1576 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1581 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1588 if (newmodes
== NULL
|| newmaps
== NULL
)
1593 /* Get the keymap definition--or nil if it is not defined. */
1594 temp
= Findirect_function (XCDR (assoc
), Qt
);
1598 cmm_maps
[i
] = temp
;
1604 if (modeptr
) *modeptr
= cmm_modes
;
1605 if (mapptr
) *mapptr
= cmm_maps
;
1609 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1611 doc
: /* Return a list of the currently active keymaps.
1612 OLP if non-nil indicates that we should obey `overriding-local-map' and
1613 `overriding-terminal-local-map'. POSITION can specify a click position
1614 like in the respective argument of `key-binding'. */)
1616 Lisp_Object olp
, position
;
1618 int count
= SPECPDL_INDEX ();
1620 Lisp_Object keymaps
;
1622 /* If a mouse click position is given, our variables are based on
1623 the buffer clicked on, not the current buffer. So we may have to
1624 switch the buffer here. */
1626 if (CONSP (position
))
1630 window
= POSN_WINDOW (position
);
1632 if (WINDOWP (window
)
1633 && BUFFERP (XWINDOW (window
)->buffer
)
1634 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
1636 /* Arrange to go back to the original buffer once we're done
1637 processing the key sequence. We don't use
1638 save_excursion_{save,restore} here, in analogy to
1639 `read-key-sequence' to avoid saving point. Maybe this
1640 would not be a problem here, but it is easier to keep
1644 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
1646 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
1650 keymaps
= Fcons (current_global_map
, Qnil
);
1654 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1655 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1656 /* The doc said that overriding-terminal-local-map should
1657 override overriding-local-map. The code used them both,
1658 but it seems clearer to use just one. rms, jan 2005. */
1659 else if (!NILP (Voverriding_local_map
))
1660 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1662 if (NILP (XCDR (keymaps
)))
1667 Lisp_Object keymap
, local_map
;
1670 pt
= INTEGERP (position
) ? XINT (position
)
1671 : MARKERP (position
) ? marker_position (position
)
1674 /* Get the buffer local maps, possibly overriden by text or
1675 overlay properties */
1677 local_map
= get_local_map (pt
, current_buffer
, Qlocal_map
);
1678 keymap
= get_local_map (pt
, current_buffer
, Qkeymap
);
1680 if (CONSP (position
))
1684 /* For a mouse click, get the local text-property keymap
1685 of the place clicked on, rather than point. */
1687 if (POSN_INBUFFER_P (position
))
1691 pos
= POSN_BUFFER_POSN (position
);
1693 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
1695 local_map
= get_local_map (XINT (pos
),
1696 current_buffer
, Qlocal_map
);
1698 keymap
= get_local_map (XINT (pos
),
1699 current_buffer
, Qkeymap
);
1703 /* If on a mode line string with a local keymap,
1704 or for a click on a string, i.e. overlay string or a
1705 string displayed via the `display' property,
1706 consider `local-map' and `keymap' properties of
1709 if (string
= POSN_STRING (position
),
1710 (CONSP (string
) && STRINGP (XCAR (string
))))
1712 Lisp_Object pos
, map
;
1714 pos
= XCDR (string
);
1715 string
= XCAR (string
);
1718 && XINT (pos
) < SCHARS (string
))
1720 map
= Fget_text_property (pos
, Qlocal_map
, string
);
1724 map
= Fget_text_property (pos
, Qkeymap
, string
);
1732 if (!NILP (local_map
))
1733 keymaps
= Fcons (local_map
, keymaps
);
1735 /* Now put all the minor mode keymaps on the list. */
1736 nmaps
= current_minor_maps (0, &maps
);
1738 for (i
= --nmaps
; i
>= 0; i
--)
1739 if (!NILP (maps
[i
]))
1740 keymaps
= Fcons (maps
[i
], keymaps
);
1743 keymaps
= Fcons (keymap
, keymaps
);
1746 unbind_to (count
, Qnil
);
1751 /* GC is possible in this function if it autoloads a keymap. */
1753 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 4, 0,
1754 doc
: /* Return the binding for command KEY in current keymaps.
1755 KEY is a string or vector, a sequence of keystrokes.
1756 The binding is probably a symbol with a function definition.
1758 Normally, `key-binding' ignores bindings for t, which act as default
1759 bindings, used when nothing else in the keymap applies; this makes it
1760 usable as a general function for probing keymaps. However, if the
1761 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1762 recognize the default bindings, just as `read-key-sequence' does.
1764 Like the normal command loop, `key-binding' will remap the command
1765 resulting from looking up KEY by looking up the command in the
1766 current keymaps. However, if the optional third argument NO-REMAP
1767 is non-nil, `key-binding' returns the unmapped command.
1769 If KEY is a key sequence initiated with the mouse, the used keymaps
1770 will depend on the clicked mouse position with regard to the buffer
1771 and possible local keymaps on strings.
1773 If the optional argument POSITION is non-nil, it specifies a mouse
1774 position as returned by `event-start' and `event-end', and the lookup
1775 occurs in the keymaps associated with it instead of KEY. It can also
1776 be a number or marker, in which case the keymap properties at the
1777 specified buffer position instead of point are used.
1779 (key
, accept_default
, no_remap
, position
)
1780 Lisp_Object key
, accept_default
, no_remap
, position
;
1782 Lisp_Object
*maps
, value
;
1784 struct gcpro gcpro1
, gcpro2
;
1785 int count
= SPECPDL_INDEX ();
1787 GCPRO2 (key
, position
);
1789 if (NILP (position
) && VECTORP (key
))
1792 /* mouse events may have a symbolic prefix indicating the
1793 scrollbar or mode line */
1794 = AREF (key
, SYMBOLP (AREF (key
, 0)) && ASIZE (key
) > 1 ? 1 : 0);
1796 /* We are not interested in locations without event data */
1798 if (EVENT_HAS_PARAMETERS (event
) && CONSP (XCDR (event
)))
1800 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (event
));
1801 if (EQ (kind
, Qmouse_click
))
1802 position
= EVENT_START (event
);
1806 /* Key sequences beginning with mouse clicks
1807 are read using the keymaps of the buffer clicked on, not
1808 the current buffer. So we may have to switch the buffer
1811 if (CONSP (position
))
1815 window
= POSN_WINDOW (position
);
1817 if (WINDOWP (window
)
1818 && BUFFERP (XWINDOW (window
)->buffer
)
1819 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
1821 /* Arrange to go back to the original buffer once we're done
1822 processing the key sequence. We don't use
1823 save_excursion_{save,restore} here, in analogy to
1824 `read-key-sequence' to avoid saving point. Maybe this
1825 would not be a problem here, but it is easier to keep
1829 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
1831 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
1835 if (! NILP (current_kboard
->Voverriding_terminal_local_map
))
1837 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1838 key
, accept_default
);
1839 if (! NILP (value
) && !INTEGERP (value
))
1842 else if (! NILP (Voverriding_local_map
))
1844 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1845 if (! NILP (value
) && !INTEGERP (value
))
1850 Lisp_Object keymap
, local_map
;
1853 pt
= INTEGERP (position
) ? XINT (position
)
1854 : MARKERP (position
) ? marker_position (position
)
1857 local_map
= get_local_map (pt
, current_buffer
, Qlocal_map
);
1858 keymap
= get_local_map (pt
, current_buffer
, Qkeymap
);
1860 if (CONSP (position
))
1864 /* For a mouse click, get the local text-property keymap
1865 of the place clicked on, rather than point. */
1867 if (POSN_INBUFFER_P (position
))
1871 pos
= POSN_BUFFER_POSN (position
);
1873 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
1875 local_map
= get_local_map (XINT (pos
),
1876 current_buffer
, Qlocal_map
);
1878 keymap
= get_local_map (XINT (pos
),
1879 current_buffer
, Qkeymap
);
1883 /* If on a mode line string with a local keymap,
1884 or for a click on a string, i.e. overlay string or a
1885 string displayed via the `display' property,
1886 consider `local-map' and `keymap' properties of
1889 if (string
= POSN_STRING (position
),
1890 (CONSP (string
) && STRINGP (XCAR (string
))))
1892 Lisp_Object pos
, map
;
1894 pos
= XCDR (string
);
1895 string
= XCAR (string
);
1898 && XINT (pos
) < SCHARS (string
))
1900 map
= Fget_text_property (pos
, Qlocal_map
, string
);
1904 map
= Fget_text_property (pos
, Qkeymap
, string
);
1912 if (! NILP (keymap
))
1914 value
= Flookup_key (keymap
, key
, accept_default
);
1915 if (! NILP (value
) && !INTEGERP (value
))
1919 nmaps
= current_minor_maps (0, &maps
);
1920 /* Note that all these maps are GCPRO'd
1921 in the places where we found them. */
1923 for (i
= 0; i
< nmaps
; i
++)
1924 if (! NILP (maps
[i
]))
1926 value
= Flookup_key (maps
[i
], key
, accept_default
);
1927 if (! NILP (value
) && !INTEGERP (value
))
1931 if (! NILP (local_map
))
1933 value
= Flookup_key (local_map
, key
, accept_default
);
1934 if (! NILP (value
) && !INTEGERP (value
))
1939 value
= Flookup_key (current_global_map
, key
, accept_default
);
1942 unbind_to (count
, Qnil
);
1945 if (NILP (value
) || INTEGERP (value
))
1948 /* If the result of the ordinary keymap lookup is an interactive
1949 command, look for a key binding (ie. remapping) for that command. */
1951 if (NILP (no_remap
) && SYMBOLP (value
))
1954 if (value1
= Fcommand_remapping (value
, position
, Qnil
), !NILP (value1
))
1961 /* GC is possible in this function if it autoloads a keymap. */
1963 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1964 doc
: /* Return the binding for command KEYS in current local keymap only.
1965 KEYS is a string or vector, a sequence of keystrokes.
1966 The binding is probably a symbol with a function definition.
1968 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1969 bindings; see the description of `lookup-key' for more details about this. */)
1970 (keys
, accept_default
)
1971 Lisp_Object keys
, accept_default
;
1973 register Lisp_Object map
;
1974 map
= current_buffer
->keymap
;
1977 return Flookup_key (map
, keys
, accept_default
);
1980 /* GC is possible in this function if it autoloads a keymap. */
1982 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1983 doc
: /* Return the binding for command KEYS in current global keymap only.
1984 KEYS is a string or vector, a sequence of keystrokes.
1985 The binding is probably a symbol with a function definition.
1986 This function's return values are the same as those of `lookup-key'
1989 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1990 bindings; see the description of `lookup-key' for more details about this. */)
1991 (keys
, accept_default
)
1992 Lisp_Object keys
, accept_default
;
1994 return Flookup_key (current_global_map
, keys
, accept_default
);
1997 /* GC is possible in this function if it autoloads a keymap. */
1999 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
2000 doc
: /* Find the visible minor mode bindings of KEY.
2001 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
2002 the symbol which names the minor mode binding KEY, and BINDING is
2003 KEY's definition in that mode. In particular, if KEY has no
2004 minor-mode bindings, return nil. If the first binding is a
2005 non-prefix, all subsequent bindings will be omitted, since they would
2006 be ignored. Similarly, the list doesn't include non-prefix bindings
2007 that come after prefix bindings.
2009 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
2010 bindings; see the description of `lookup-key' for more details about this. */)
2011 (key
, accept_default
)
2012 Lisp_Object key
, accept_default
;
2014 Lisp_Object
*modes
, *maps
;
2016 Lisp_Object binding
;
2018 struct gcpro gcpro1
, gcpro2
;
2020 nmaps
= current_minor_maps (&modes
, &maps
);
2021 /* Note that all these maps are GCPRO'd
2022 in the places where we found them. */
2025 GCPRO2 (key
, binding
);
2027 for (i
= j
= 0; i
< nmaps
; i
++)
2029 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
2030 && !INTEGERP (binding
))
2032 if (KEYMAPP (binding
))
2033 maps
[j
++] = Fcons (modes
[i
], binding
);
2035 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
2039 return Flist (j
, maps
);
2042 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
2043 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
2044 A new sparse keymap is stored as COMMAND's function definition and its value.
2045 If a second optional argument MAPVAR is given, the map is stored as
2046 its value instead of as COMMAND's value; but COMMAND is still defined
2048 The third optional argument NAME, if given, supplies a menu name
2049 string for the map. This is required to use the keymap as a menu.
2050 This function returns COMMAND. */)
2051 (command
, mapvar
, name
)
2052 Lisp_Object command
, mapvar
, name
;
2055 map
= Fmake_sparse_keymap (name
);
2056 Ffset (command
, map
);
2060 Fset (command
, map
);
2064 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
2065 doc
: /* Select KEYMAP as the global keymap. */)
2069 keymap
= get_keymap (keymap
, 1, 1);
2070 current_global_map
= keymap
;
2075 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
2076 doc
: /* Select KEYMAP as the local keymap.
2077 If KEYMAP is nil, that means no local keymap. */)
2082 keymap
= get_keymap (keymap
, 1, 1);
2084 current_buffer
->keymap
= keymap
;
2089 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
2090 doc
: /* Return current buffer's local keymap, or nil if it has none.
2091 Normally the local keymap is set by the major mode with `use-local-map'. */)
2094 return current_buffer
->keymap
;
2097 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
2098 doc
: /* Return the current global keymap. */)
2101 return current_global_map
;
2104 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
2105 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
2109 int nmaps
= current_minor_maps (0, &maps
);
2111 return Flist (nmaps
, maps
);
2114 /* Help functions for describing and documenting keymaps. */
2116 struct accessible_keymaps_data
{
2117 Lisp_Object maps
, tail
, thisseq
;
2118 /* Does the current sequence end in the meta-prefix-char? */
2123 accessible_keymaps_1 (key
, cmd
, args
, data
)
2124 Lisp_Object key
, cmd
, args
;
2125 /* Use void* to be compatible with map_keymap_function_t. */
2128 struct accessible_keymaps_data
*d
= data
; /* Cast! */
2129 Lisp_Object maps
= d
->maps
;
2130 Lisp_Object tail
= d
->tail
;
2131 Lisp_Object thisseq
= d
->thisseq
;
2132 int is_metized
= d
->is_metized
&& INTEGERP (key
);
2135 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
2139 /* Look for and break cycles. */
2140 while (!NILP (tem
= Frassq (cmd
, maps
)))
2142 Lisp_Object prefix
= XCAR (tem
);
2143 int lim
= XINT (Flength (XCAR (tem
)));
2144 if (lim
<= XINT (Flength (thisseq
)))
2145 { /* This keymap was already seen with a smaller prefix. */
2147 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
2148 Faref (thisseq
, make_number (i
))))
2151 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
2154 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
2155 but maybe `cmd' occurs again further down in `maps', so keep
2157 maps
= XCDR (Fmemq (tem
, maps
));
2160 /* If the last key in thisseq is meta-prefix-char,
2161 turn it into a meta-ized keystroke. We know
2162 that the event we're about to append is an
2163 ascii keystroke since we're processing a
2167 int meta_bit
= meta_modifier
;
2168 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
2169 tem
= Fcopy_sequence (thisseq
);
2171 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
2173 /* This new sequence is the same length as
2174 thisseq, so stick it in the list right
2177 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
2181 tem
= append_key (thisseq
, key
);
2182 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
2186 /* This function cannot GC. */
2188 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
2190 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
2191 Returns a list of elements of the form (KEYS . MAP), where the sequence
2192 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
2193 so that the KEYS increase in length. The first element is ([] . KEYMAP).
2194 An optional argument PREFIX, if non-nil, should be a key sequence;
2195 then the value includes only maps for prefixes that start with PREFIX. */)
2197 Lisp_Object keymap
, prefix
;
2199 Lisp_Object maps
, tail
;
2200 int prefixlen
= XINT (Flength (prefix
));
2202 /* no need for gcpro because we don't autoload any keymaps. */
2206 /* If a prefix was specified, start with the keymap (if any) for
2207 that prefix, so we don't waste time considering other prefixes. */
2209 tem
= Flookup_key (keymap
, prefix
, Qt
);
2210 /* Flookup_key may give us nil, or a number,
2211 if the prefix is not defined in this particular map.
2212 It might even give us a list that isn't a keymap. */
2213 tem
= get_keymap (tem
, 0, 0);
2214 /* If the keymap is autoloaded `tem' is not a cons-cell, but we still
2215 want to return it. */
2218 /* Convert PREFIX to a vector now, so that later on
2219 we don't have to deal with the possibility of a string. */
2220 if (STRINGP (prefix
))
2225 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
2226 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
2230 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
2231 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2232 c
^= 0200 | meta_modifier
;
2233 ASET (copy
, i_before
, make_number (c
));
2237 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
2243 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
2244 get_keymap (keymap
, 1, 0)),
2247 /* For each map in the list maps,
2248 look at any other maps it points to,
2249 and stick them at the end if they are not already in the list.
2251 This is a breadth-first traversal, where tail is the queue of
2252 nodes, and maps accumulates a list of all nodes visited. */
2254 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
2256 struct accessible_keymaps_data data
;
2257 register Lisp_Object thismap
= Fcdr (XCAR (tail
));
2260 data
.thisseq
= Fcar (XCAR (tail
));
2263 last
= make_number (XINT (Flength (data
.thisseq
)) - 1);
2264 /* Does the current sequence end in the meta-prefix-char? */
2265 data
.is_metized
= (XINT (last
) >= 0
2266 /* Don't metize the last char of PREFIX. */
2267 && XINT (last
) >= prefixlen
2268 && EQ (Faref (data
.thisseq
, last
), meta_prefix_char
));
2270 /* Since we can't run lisp code, we can't scan autoloaded maps. */
2271 if (CONSP (thismap
))
2272 map_keymap (thismap
, accessible_keymaps_1
, Qnil
, &data
, 0);
2276 Lisp_Object Qsingle_key_description
, Qkey_description
;
2278 /* This function cannot GC. */
2280 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2281 doc
: /* Return a pretty description of key-sequence KEYS.
2282 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2283 Control characters turn into "C-foo" sequences, meta into "M-foo",
2284 spaces are put between sequence elements, etc. */)
2286 Lisp_Object keys
, prefix
;
2291 int size
= XINT (Flength (keys
));
2293 Lisp_Object sep
= build_string (" ");
2298 size
+= XINT (Flength (prefix
));
2300 /* This has one extra element at the end that we don't pass to Fconcat. */
2301 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2303 /* In effect, this computes
2304 (mapconcat 'single-key-description keys " ")
2305 but we shouldn't use mapconcat because it can do GC. */
2309 list
= prefix
, prefix
= Qnil
;
2310 else if (!NILP (keys
))
2311 list
= keys
, keys
= Qnil
;
2316 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2320 return empty_unibyte_string
;
2321 return Fconcat (len
- 1, args
);
2325 size
= SCHARS (list
);
2326 else if (VECTORP (list
))
2327 size
= XVECTOR (list
)->size
;
2328 else if (CONSP (list
))
2329 size
= XINT (Flength (list
));
2331 wrong_type_argument (Qarrayp
, list
);
2340 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2341 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2342 c
^= 0200 | meta_modifier
;
2343 XSETFASTINT (key
, c
);
2345 else if (VECTORP (list
))
2347 key
= AREF (list
, i
); i
++;
2359 || EQ (key
, meta_prefix_char
)
2360 || (XINT (key
) & meta_modifier
))
2362 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2364 if (EQ (key
, meta_prefix_char
))
2368 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2371 else if (EQ (key
, meta_prefix_char
))
2376 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2384 push_key_description (c
, p
, force_multibyte
)
2385 register unsigned int c
;
2387 int force_multibyte
;
2391 /* Clear all the meaningless bits above the meta bit. */
2392 c
&= meta_modifier
| ~ - meta_modifier
;
2393 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2394 | meta_modifier
| shift_modifier
| super_modifier
);
2396 if (! CHARACTERP (make_number (c2
)))
2398 /* KEY_DESCRIPTION_SIZE is large enough for this. */
2399 p
+= sprintf (p
, "[%d]", c
);
2403 if (c
& alt_modifier
)
2409 if ((c
& ctrl_modifier
) != 0
2410 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2414 c
&= ~ctrl_modifier
;
2416 if (c
& hyper_modifier
)
2420 c
-= hyper_modifier
;
2422 if (c
& meta_modifier
)
2428 if (c
& shift_modifier
)
2432 c
-= shift_modifier
;
2434 if (c
& super_modifier
)
2438 c
-= super_modifier
;
2454 else if (c
== Ctl ('M'))
2462 /* `C-' already added above. */
2463 if (c
> 0 && c
<= Ctl ('Z'))
2482 || (NILP (current_buffer
->enable_multibyte_characters
)
2483 && SINGLE_BYTE_CHAR_P (c
)
2484 && !force_multibyte
))
2490 /* Now we are sure that C is a valid character code. */
2491 if (NILP (current_buffer
->enable_multibyte_characters
)
2492 && ! force_multibyte
)
2493 *p
++ = multibyte_char_to_unibyte (c
, Qnil
);
2495 p
+= CHAR_STRING (c
, (unsigned char *) p
);
2501 /* This function cannot GC. */
2503 DEFUN ("single-key-description", Fsingle_key_description
,
2504 Ssingle_key_description
, 1, 2, 0,
2505 doc
: /* Return a pretty description of command character KEY.
2506 Control characters turn into C-whatever, etc.
2507 Optional argument NO-ANGLES non-nil means don't put angle brackets
2508 around function keys and event symbols. */)
2510 Lisp_Object key
, no_angles
;
2512 if (CONSP (key
) && lucid_event_type_list_p (key
))
2513 key
= Fevent_convert_list (key
);
2515 key
= EVENT_HEAD (key
);
2517 if (INTEGERP (key
)) /* Normal character */
2519 char tem
[KEY_DESCRIPTION_SIZE
];
2521 *push_key_description (XUINT (key
), tem
, 1) = 0;
2522 return build_string (tem
);
2524 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2526 if (NILP (no_angles
))
2529 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2530 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2531 return build_string (buffer
);
2534 return Fsymbol_name (key
);
2536 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2537 return Fcopy_sequence (key
);
2539 error ("KEY must be an integer, cons, symbol, or string");
2544 push_text_char_description (c
, p
)
2545 register unsigned int c
;
2557 *p
++ = c
+ 64; /* 'A' - 1 */
2569 /* This function cannot GC. */
2571 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2572 doc
: /* Return a pretty description of file-character CHARACTER.
2573 Control characters turn into "^char", etc. This differs from
2574 `single-key-description' which turns them into "C-char".
2575 Also, this function recognizes the 2**7 bit as the Meta character,
2576 whereas `single-key-description' uses the 2**27 bit for Meta.
2577 See Info node `(elisp)Describing Characters' for examples. */)
2579 Lisp_Object character
;
2581 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2582 unsigned char str
[6];
2585 CHECK_NUMBER (character
);
2587 c
= XINT (character
);
2588 if (!ASCII_CHAR_P (c
))
2590 int len
= CHAR_STRING (c
, str
);
2592 return make_multibyte_string (str
, 1, len
);
2595 *push_text_char_description (c
& 0377, str
) = 0;
2597 return build_string (str
);
2600 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2603 ascii_sequence_p (seq
)
2607 int len
= XINT (Flength (seq
));
2609 for (i
= 0; i
< len
; i
++)
2611 Lisp_Object ii
, elt
;
2613 XSETFASTINT (ii
, i
);
2614 elt
= Faref (seq
, ii
);
2617 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2625 /* where-is - finding a command in a set of keymaps. */
2627 static Lisp_Object
where_is_internal ();
2628 static void where_is_internal_1
P_ ((Lisp_Object key
, Lisp_Object binding
,
2629 Lisp_Object args
, void *data
));
2631 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2632 Returns the first non-nil binding found in any of those maps. */
2635 shadow_lookup (shadow
, key
, flag
)
2636 Lisp_Object shadow
, key
, flag
;
2638 Lisp_Object tail
, value
;
2640 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2642 value
= Flookup_key (XCAR (tail
), key
, flag
);
2643 if (NATNUMP (value
))
2645 value
= Flookup_key (XCAR (tail
),
2646 Fsubstring (key
, make_number (0), value
), flag
);
2650 else if (!NILP (value
))
2656 static Lisp_Object Vmouse_events
;
2658 struct where_is_internal_data
{
2659 Lisp_Object definition
, noindirect
, this, last
;
2661 Lisp_Object sequences
;
2664 /* This function can GC if Flookup_key autoloads any keymaps. */
2667 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2668 Lisp_Object definition
, keymaps
;
2669 Lisp_Object firstonly
, noindirect
, no_remap
;
2671 Lisp_Object maps
= Qnil
;
2672 Lisp_Object found
, sequences
;
2673 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2674 /* 1 means ignore all menu bindings entirely. */
2675 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2678 while (CONSP (found
))
2682 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2683 found
= XCDR (found
);
2686 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2690 /* If this command is remapped, then it has no key bindings
2693 && SYMBOLP (definition
)
2694 && !NILP (Fcommand_remapping (definition
, Qnil
, keymaps
)))
2695 RETURN_UNGCPRO (Qnil
);
2697 for (; CONSP (maps
); maps
= XCDR (maps
))
2699 /* Key sequence to reach map, and the map that it reaches */
2700 register Lisp_Object
this, map
, tem
;
2701 struct where_is_internal_data data
;
2703 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2704 [M-CHAR] sequences, check if last character of the sequence
2705 is the meta-prefix char. */
2709 this = Fcar (XCAR (maps
));
2710 map
= Fcdr (XCAR (maps
));
2711 last
= make_number (XINT (Flength (this)) - 1);
2712 last_is_meta
= (XINT (last
) >= 0
2713 && EQ (Faref (this, last
), meta_prefix_char
));
2715 /* if (nomenus && !ascii_sequence_p (this)) */
2716 if (nomenus
&& XINT (last
) >= 0
2717 && SYMBOLP (tem
= Faref (this, make_number (0)))
2718 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2719 /* If no menu entries should be returned, skip over the
2720 keymaps bound to `menu-bar' and `tool-bar' and other
2721 non-ascii prefixes like `C-down-mouse-2'. */
2726 data
.definition
= definition
;
2727 data
.noindirect
= noindirect
;
2730 data
.last_is_meta
= last_is_meta
;
2731 data
.sequences
= Qnil
;
2734 map_keymap (map
, where_is_internal_1
, Qnil
, &data
, 0);
2736 sequences
= data
.sequences
;
2738 while (CONSP (sequences
))
2740 Lisp_Object sequence
, remapped
, function
;
2742 sequence
= XCAR (sequences
);
2743 sequences
= XCDR (sequences
);
2745 /* If the current sequence is a command remapping with
2746 format [remap COMMAND], find the key sequences
2747 which run COMMAND, and use those sequences instead. */
2750 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2751 && EQ (AREF (sequence
, 0), Qremap
)
2752 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2754 Lisp_Object remapped1
;
2756 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2757 if (CONSP (remapped1
))
2759 /* Verify that this key binding actually maps to the
2760 remapped command (see below). */
2761 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2763 sequence
= XCAR (remapped1
);
2764 remapped
= XCDR (remapped1
);
2765 goto record_sequence
;
2769 /* Verify that this key binding is not shadowed by another
2770 binding for the same key, before we say it exists.
2772 Mechanism: look for local definition of this key and if
2773 it is defined and does not match what we found then
2776 Either nil or number as value from Flookup_key
2778 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2782 /* Don't annoy user with strings from a menu such as
2783 Select Paste. Change them all to "(any string)",
2784 so that there seems to be only one menu item
2786 if (! NILP (sequence
))
2789 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2791 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2792 build_string ("(any string)"));
2795 /* It is a true unshadowed match. Record it, unless it's already
2796 been seen (as could happen when inheriting keymaps). */
2797 if (NILP (Fmember (sequence
, found
)))
2798 found
= Fcons (sequence
, found
);
2800 /* If firstonly is Qnon_ascii, then we can return the first
2801 binding we find. If firstonly is not Qnon_ascii but not
2802 nil, then we should return the first ascii-only binding
2804 if (EQ (firstonly
, Qnon_ascii
))
2805 RETURN_UNGCPRO (sequence
);
2806 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2807 RETURN_UNGCPRO (sequence
);
2809 if (CONSP (remapped
))
2811 sequence
= XCAR (remapped
);
2812 remapped
= XCDR (remapped
);
2813 goto record_sequence
;
2820 found
= Fnreverse (found
);
2822 /* firstonly may have been t, but we may have gone all the way through
2823 the keymaps without finding an all-ASCII key sequence. So just
2824 return the best we could find. */
2825 if (!NILP (firstonly
))
2826 return Fcar (found
);
2831 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2832 doc
: /* Return list of keys that invoke DEFINITION.
2833 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2834 If KEYMAP is nil, search all the currently active keymaps.
2835 If KEYMAP is a list of keymaps, search only those keymaps.
2837 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2838 rather than a list of all possible key sequences.
2839 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2840 no matter what it is.
2841 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2842 \(or their meta variants) and entirely reject menu bindings.
2844 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2845 to other keymaps or slots. This makes it possible to search for an
2846 indirect definition itself.
2848 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2849 that invoke a command which is remapped to DEFINITION, but include the
2850 remapped command in the returned list. */)
2851 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2852 Lisp_Object definition
, keymap
;
2853 Lisp_Object firstonly
, noindirect
, no_remap
;
2855 Lisp_Object sequences
, keymaps
;
2856 /* 1 means ignore all menu bindings entirely. */
2857 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2860 /* Find the relevant keymaps. */
2861 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2863 else if (!NILP (keymap
))
2864 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2866 keymaps
= Fcurrent_active_maps (Qnil
, Qnil
);
2868 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2869 We don't really need to check `keymap'. */
2870 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2874 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2876 /* Check heuristic-consistency of the cache. */
2877 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2878 where_is_cache
= Qnil
;
2880 if (NILP (where_is_cache
))
2882 /* We need to create the cache. */
2883 Lisp_Object args
[2];
2884 where_is_cache
= Fmake_hash_table (0, args
);
2885 where_is_cache_keymaps
= Qt
;
2887 /* Fill in the cache. */
2888 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2889 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2892 where_is_cache_keymaps
= keymaps
;
2895 /* We want to process definitions from the last to the first.
2896 Instead of consing, copy definitions to a vector and step
2897 over that vector. */
2898 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2899 n
= XINT (Flength (sequences
));
2900 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2901 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2902 defns
[i
++] = XCAR (sequences
);
2904 /* Verify that the key bindings are not shadowed. Note that
2905 the following can GC. */
2906 GCPRO2 (definition
, keymaps
);
2909 for (i
= n
- 1; i
>= 0; --i
)
2910 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2912 if (ascii_sequence_p (defns
[i
]))
2918 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2923 /* Kill the cache so that where_is_internal_1 doesn't think
2924 we're filling it up. */
2925 where_is_cache
= Qnil
;
2926 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2932 /* This function can GC because get_keyelt can. */
2935 where_is_internal_1 (key
, binding
, args
, data
)
2936 Lisp_Object key
, binding
, args
;
2939 struct where_is_internal_data
*d
= data
; /* Cast! */
2940 Lisp_Object definition
= d
->definition
;
2941 Lisp_Object noindirect
= d
->noindirect
;
2942 Lisp_Object
this = d
->this;
2943 Lisp_Object last
= d
->last
;
2944 int last_is_meta
= d
->last_is_meta
;
2945 Lisp_Object sequence
;
2947 /* Search through indirections unless that's not wanted. */
2948 if (NILP (noindirect
))
2949 binding
= get_keyelt (binding
, 0);
2951 /* End this iteration if this element does not match
2954 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2955 || EQ (binding
, definition
)
2956 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2957 /* Doesn't match. */
2960 /* We have found a match. Construct the key sequence where we found it. */
2961 if (INTEGERP (key
) && last_is_meta
)
2963 sequence
= Fcopy_sequence (this);
2964 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2969 key
= Fcons (XCAR (key
), XCDR (key
));
2970 sequence
= append_key (this, key
);
2973 if (!NILP (where_is_cache
))
2975 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2976 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2979 d
->sequences
= Fcons (sequence
, d
->sequences
);
2982 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2984 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2985 doc
: /* Insert the list of all defined keys and their definitions.
2986 The list is inserted in the current buffer, while the bindings are
2987 looked up in BUFFER.
2988 The optional argument PREFIX, if non-nil, should be a key sequence;
2989 then we display only bindings that start with that prefix.
2990 The optional argument MENUS, if non-nil, says to mention menu bindings.
2991 \(Ordinarily these are omitted from the output.) */)
2992 (buffer
, prefix
, menus
)
2993 Lisp_Object buffer
, prefix
, menus
;
2995 Lisp_Object outbuf
, shadow
;
2996 int nomenu
= NILP (menus
);
2997 register Lisp_Object start1
;
2998 struct gcpro gcpro1
;
3000 char *alternate_heading
3002 Keyboard translations:\n\n\
3003 You type Translation\n\
3004 -------- -----------\n";
3006 CHECK_BUFFER (buffer
);
3011 outbuf
= Fcurrent_buffer ();
3013 /* Report on alternates for keys. */
3014 if (STRINGP (current_kboard
->Vkeyboard_translate_table
) && !NILP (prefix
))
3017 const unsigned char *translate
= SDATA (current_kboard
->Vkeyboard_translate_table
);
3018 int translate_len
= SCHARS (current_kboard
->Vkeyboard_translate_table
);
3020 for (c
= 0; c
< translate_len
; c
++)
3021 if (translate
[c
] != c
)
3023 char buf
[KEY_DESCRIPTION_SIZE
];
3026 if (alternate_heading
)
3028 insert_string (alternate_heading
);
3029 alternate_heading
= 0;
3032 bufend
= push_key_description (translate
[c
], buf
, 1);
3033 insert (buf
, bufend
- buf
);
3034 Findent_to (make_number (16), make_number (1));
3035 bufend
= push_key_description (c
, buf
, 1);
3036 insert (buf
, bufend
- buf
);
3040 /* Insert calls signal_after_change which may GC. */
3041 translate
= SDATA (current_kboard
->Vkeyboard_translate_table
);
3047 if (!NILP (Vkey_translation_map
))
3048 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
3049 "Key translations", nomenu
, 1, 0, 0);
3052 /* Print the (major mode) local map. */
3054 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
3055 start1
= current_kboard
->Voverriding_terminal_local_map
;
3056 else if (!NILP (Voverriding_local_map
))
3057 start1
= Voverriding_local_map
;
3061 describe_map_tree (start1
, 1, shadow
, prefix
,
3062 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
3063 shadow
= Fcons (start1
, shadow
);
3067 /* Print the minor mode and major mode keymaps. */
3069 Lisp_Object
*modes
, *maps
;
3071 /* Temporarily switch to `buffer', so that we can get that buffer's
3072 minor modes correctly. */
3073 Fset_buffer (buffer
);
3075 nmaps
= current_minor_maps (&modes
, &maps
);
3076 Fset_buffer (outbuf
);
3078 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3079 XBUFFER (buffer
), Qkeymap
);
3082 describe_map_tree (start1
, 1, shadow
, prefix
,
3083 "\f\n`keymap' Property Bindings", nomenu
,
3085 shadow
= Fcons (start1
, shadow
);
3088 /* Print the minor mode maps. */
3089 for (i
= 0; i
< nmaps
; i
++)
3091 /* The title for a minor mode keymap
3092 is constructed at run time.
3093 We let describe_map_tree do the actual insertion
3094 because it takes care of other features when doing so. */
3097 if (!SYMBOLP (modes
[i
]))
3100 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
3104 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
3105 SCHARS (SYMBOL_NAME (modes
[i
])));
3106 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
3108 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
3109 p
+= sizeof (" Minor Mode Bindings") - 1;
3112 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
3113 title
, nomenu
, 0, 0, 0);
3114 shadow
= Fcons (maps
[i
], shadow
);
3117 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3118 XBUFFER (buffer
), Qlocal_map
);
3121 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
3122 describe_map_tree (start1
, 1, shadow
, prefix
,
3123 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
3125 describe_map_tree (start1
, 1, shadow
, prefix
,
3126 "\f\n`local-map' Property Bindings",
3129 shadow
= Fcons (start1
, shadow
);
3133 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
3134 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
3136 /* Print the function-key-map translations under this prefix. */
3137 if (!NILP (current_kboard
->Vlocal_function_key_map
))
3138 describe_map_tree (current_kboard
->Vlocal_function_key_map
, 0, Qnil
, prefix
,
3139 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
3141 /* Print the input-decode-map translations under this prefix. */
3142 if (!NILP (current_kboard
->Vinput_decode_map
))
3143 describe_map_tree (current_kboard
->Vinput_decode_map
, 0, Qnil
, prefix
,
3144 "\f\nInput decoding map translations", nomenu
, 1, 0, 0);
3150 /* Insert a description of the key bindings in STARTMAP,
3151 followed by those of all maps reachable through STARTMAP.
3152 If PARTIAL is nonzero, omit certain "uninteresting" commands
3153 (such as `undefined').
3154 If SHADOW is non-nil, it is a list of maps;
3155 don't mention keys which would be shadowed by any of them.
3156 PREFIX, if non-nil, says mention only keys that start with PREFIX.
3157 TITLE, if not 0, is a string to insert at the beginning.
3158 TITLE should not end with a colon or a newline; we supply that.
3159 If NOMENU is not 0, then omit menu-bar commands.
3161 If TRANSL is nonzero, the definitions are actually key translations
3162 so print strings and vectors differently.
3164 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
3167 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
3168 don't omit it; instead, mention it but say it is shadowed. */
3171 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
3172 always_title
, mention_shadow
)
3173 Lisp_Object startmap
, shadow
, prefix
;
3181 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
3182 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3189 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3192 GCPRO3 (maps
, seen
, sub_shadows
);
3198 /* Delete from MAPS each element that is for the menu bar. */
3199 for (list
= maps
; CONSP (list
); list
= XCDR (list
))
3201 Lisp_Object elt
, prefix
, tem
;
3204 prefix
= Fcar (elt
);
3205 if (XVECTOR (prefix
)->size
>= 1)
3207 tem
= Faref (prefix
, make_number (0));
3208 if (EQ (tem
, Qmenu_bar
))
3209 maps
= Fdelq (elt
, maps
);
3214 if (!NILP (maps
) || always_title
)
3218 insert_string (title
);
3221 insert_string (" Starting With ");
3222 insert1 (Fkey_description (prefix
, Qnil
));
3224 insert_string (":\n");
3226 insert_string (key_heading
);
3230 for (; CONSP (maps
); maps
= XCDR (maps
))
3232 register Lisp_Object elt
, prefix
, tail
;
3235 prefix
= Fcar (elt
);
3239 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3243 shmap
= XCAR (tail
);
3245 /* If the sequence by which we reach this keymap is zero-length,
3246 then the shadow map for this keymap is just SHADOW. */
3247 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3248 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3250 /* If the sequence by which we reach this keymap actually has
3251 some elements, then the sequence's definition in SHADOW is
3252 what we should use. */
3255 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3256 if (INTEGERP (shmap
))
3260 /* If shmap is not nil and not a keymap,
3261 it completely shadows this map, so don't
3262 describe this map at all. */
3263 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3267 sub_shadows
= Fcons (shmap
, sub_shadows
);
3270 /* Maps we have already listed in this loop shadow this map. */
3271 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3274 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3276 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3279 describe_map (Fcdr (elt
), prefix
,
3280 transl
? describe_translation
: describe_command
,
3281 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3287 insert_string ("\n");
3292 static int previous_description_column
;
3295 describe_command (definition
, args
)
3296 Lisp_Object definition
, args
;
3298 register Lisp_Object tem1
;
3299 int column
= (int) current_column (); /* iftc */
3300 int description_column
;
3302 /* If column 16 is no good, go to col 32;
3303 but don't push beyond that--go to next line instead. */
3307 description_column
= 32;
3309 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3310 description_column
= 32;
3312 description_column
= 16;
3314 Findent_to (make_number (description_column
), make_number (1));
3315 previous_description_column
= description_column
;
3317 if (SYMBOLP (definition
))
3319 tem1
= SYMBOL_NAME (definition
);
3321 insert_string ("\n");
3323 else if (STRINGP (definition
) || VECTORP (definition
))
3324 insert_string ("Keyboard Macro\n");
3325 else if (KEYMAPP (definition
))
3326 insert_string ("Prefix Command\n");
3328 insert_string ("??\n");
3332 describe_translation (definition
, args
)
3333 Lisp_Object definition
, args
;
3335 register Lisp_Object tem1
;
3337 Findent_to (make_number (16), make_number (1));
3339 if (SYMBOLP (definition
))
3341 tem1
= SYMBOL_NAME (definition
);
3343 insert_string ("\n");
3345 else if (STRINGP (definition
) || VECTORP (definition
))
3347 insert1 (Fkey_description (definition
, Qnil
));
3348 insert_string ("\n");
3350 else if (KEYMAPP (definition
))
3351 insert_string ("Prefix Command\n");
3353 insert_string ("??\n");
3356 /* describe_map puts all the usable elements of a sparse keymap
3357 into an array of `struct describe_map_elt',
3358 then sorts them by the events. */
3360 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3362 /* qsort comparison function for sorting `struct describe_map_elt' by
3366 describe_map_compare (aa
, bb
)
3367 const void *aa
, *bb
;
3369 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3370 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3371 return ((XINT (a
->event
) > XINT (b
->event
))
3372 - (XINT (a
->event
) < XINT (b
->event
)));
3373 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3375 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3377 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3378 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3379 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3384 /* Describe the contents of map MAP, assuming that this map itself is
3385 reached by the sequence of prefix keys PREFIX (a string or vector).
3386 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3389 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3390 seen
, nomenu
, mention_shadow
)
3391 register Lisp_Object map
;
3393 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3400 Lisp_Object tail
, definition
, event
;
3402 Lisp_Object suppress
;
3405 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3407 /* These accumulate the values from sparse keymap bindings,
3408 so we can sort them and handle them in order. */
3409 int length_needed
= 0;
3410 struct describe_map_elt
*vect
;
3417 suppress
= intern ("suppress-keymap");
3419 /* This vector gets used to present single keys to Flookup_key. Since
3420 that is done once per keymap element, we don't want to cons up a
3421 fresh vector every time. */
3422 kludge
= Fmake_vector (make_number (1), Qnil
);
3425 GCPRO3 (prefix
, definition
, kludge
);
3427 map
= call1 (Qkeymap_canonicalize
, map
);
3429 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3432 vect
= ((struct describe_map_elt
*)
3433 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3435 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3439 if (VECTORP (XCAR (tail
))
3440 || CHAR_TABLE_P (XCAR (tail
)))
3441 describe_vector (XCAR (tail
),
3442 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3443 (int *)0, 0, 1, mention_shadow
);
3444 else if (CONSP (XCAR (tail
)))
3446 int this_shadowed
= 0;
3448 event
= XCAR (XCAR (tail
));
3450 /* Ignore bindings whose "prefix" are not really valid events.
3451 (We get these in the frames and buffers menu.) */
3452 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3455 if (nomenu
&& EQ (event
, Qmenu_bar
))
3458 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3460 /* Don't show undefined commands or suppressed commands. */
3461 if (NILP (definition
)) continue;
3462 if (SYMBOLP (definition
) && partial
)
3464 tem
= Fget (definition
, suppress
);
3469 /* Don't show a command that isn't really visible
3470 because a local definition of the same key shadows it. */
3472 ASET (kludge
, 0, event
);
3475 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3478 /* If both bindings are keymaps, this key is a prefix key,
3479 so don't say it is shadowed. */
3480 if (KEYMAPP (definition
) && KEYMAPP (tem
))
3482 /* Avoid generating duplicate entries if the
3483 shadowed binding has the same definition. */
3484 else if (mention_shadow
&& !EQ (tem
, definition
))
3491 tem
= Flookup_key (map
, kludge
, Qt
);
3492 if (!EQ (tem
, definition
)) continue;
3494 vect
[slots_used
].event
= event
;
3495 vect
[slots_used
].definition
= definition
;
3496 vect
[slots_used
].shadowed
= this_shadowed
;
3499 else if (EQ (XCAR (tail
), Qkeymap
))
3501 /* The same keymap might be in the structure twice, if we're
3502 using an inherited keymap. So skip anything we've already
3504 tem
= Fassq (tail
, *seen
);
3505 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3507 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3511 /* If we found some sparse map events, sort them. */
3513 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3514 describe_map_compare
);
3516 /* Now output them in sorted order. */
3518 for (i
= 0; i
< slots_used
; i
++)
3520 Lisp_Object start
, end
;
3524 previous_description_column
= 0;
3529 ASET (kludge
, 0, vect
[i
].event
);
3530 start
= vect
[i
].event
;
3533 definition
= vect
[i
].definition
;
3535 /* Find consecutive chars that are identically defined. */
3536 if (INTEGERP (vect
[i
].event
))
3538 while (i
+ 1 < slots_used
3539 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3540 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3541 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3543 end
= vect
[i
].event
;
3546 /* Now START .. END is the range to describe next. */
3548 /* Insert the string to describe the event START. */
3549 insert1 (Fkey_description (kludge
, prefix
));
3551 if (!EQ (start
, end
))
3555 ASET (kludge
, 0, end
);
3556 /* Insert the string to describe the character END. */
3557 insert1 (Fkey_description (kludge
, prefix
));
3560 /* Print a description of the definition of this character.
3561 elt_describer will take care of spacing out far enough
3562 for alignment purposes. */
3563 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3565 if (vect
[i
].shadowed
)
3568 insert_string ("\n (that binding is currently shadowed by another mode)");
3577 describe_vector_princ (elt
, fun
)
3578 Lisp_Object elt
, fun
;
3580 Findent_to (make_number (16), make_number (1));
3585 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3586 doc
: /* Insert a description of contents of VECTOR.
3587 This is text showing the elements of vector matched against indices.
3588 DESCRIBER is the output function used; nil means use `princ'. */)
3590 Lisp_Object vector
, describer
;
3592 int count
= SPECPDL_INDEX ();
3593 if (NILP (describer
))
3594 describer
= intern ("princ");
3595 specbind (Qstandard_output
, Fcurrent_buffer ());
3596 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3597 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3598 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3600 return unbind_to (count
, Qnil
);
3603 /* Insert in the current buffer a description of the contents of VECTOR.
3604 We call ELT_DESCRIBER to insert the description of one value found
3607 ELT_PREFIX describes what "comes before" the keys or indices defined
3608 by this vector. This is a human-readable string whose size
3609 is not necessarily related to the situation.
3611 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3612 leads to this keymap.
3614 If the vector is a chartable, ELT_PREFIX is the vector
3615 of bytes that lead to the character set or portion of a character
3616 set described by this chartable.
3618 If PARTIAL is nonzero, it means do not mention suppressed commands
3619 (that assumes the vector is in a keymap).
3621 SHADOW is a list of keymaps that shadow this map.
3622 If it is non-nil, then we look up the key in those maps
3623 and we don't mention it now if it is defined by any of them.
3625 ENTIRE_MAP is the keymap in which this vector appears.
3626 If the definition in effect in the whole map does not match
3627 the one in this vector, we ignore this one.
3629 ARGS is simply passed as the second argument to ELT_DESCRIBER.
3631 INDICES and CHAR_TABLE_DEPTH are ignored. They will be removed in
3634 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3636 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3639 describe_vector (vector
, prefix
, args
, elt_describer
,
3640 partial
, shadow
, entire_map
,
3641 indices
, char_table_depth
, keymap_p
,
3643 register Lisp_Object vector
;
3644 Lisp_Object prefix
, args
;
3645 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3648 Lisp_Object entire_map
;
3650 int char_table_depth
;
3654 Lisp_Object definition
;
3656 Lisp_Object elt_prefix
= Qnil
;
3658 Lisp_Object suppress
;
3661 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3662 /* Range of elements to be handled. */
3664 Lisp_Object character
;
3673 /* Call Fkey_description first, to avoid GC bug for the other string. */
3674 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3677 tem
= Fkey_description (prefix
, Qnil
);
3678 elt_prefix
= concat2 (tem
, build_string (" "));
3683 /* This vector gets used to present single keys to Flookup_key. Since
3684 that is done once per vector element, we don't want to cons up a
3685 fresh vector every time. */
3686 kludge
= Fmake_vector (make_number (1), Qnil
);
3687 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3690 suppress
= intern ("suppress-keymap");
3693 to
= CHAR_TABLE_P (vector
) ? MAX_CHAR
+ 1 : XVECTOR (vector
)->size
;
3695 for (i
= from
; i
< to
; i
++)
3697 int this_shadowed
= 0;
3698 int range_beg
, range_end
;
3705 if (CHAR_TABLE_P (vector
))
3706 val
= char_table_ref_and_range (vector
, i
, &range_beg
, &i
);
3708 val
= AREF (vector
, i
);
3709 definition
= get_keyelt (val
, 0);
3711 if (NILP (definition
)) continue;
3713 /* Don't mention suppressed commands. */
3714 if (SYMBOLP (definition
) && partial
)
3718 tem
= Fget (definition
, suppress
);
3720 if (!NILP (tem
)) continue;
3723 character
= make_number (starting_i
);
3724 ASET (kludge
, 0, character
);
3726 /* If this binding is shadowed by some other map, ignore it. */
3731 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3742 /* Ignore this definition if it is shadowed by an earlier
3743 one in the same keymap. */
3744 if (!NILP (entire_map
))
3748 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3750 if (!EQ (tem
, definition
))
3760 /* Output the prefix that applies to every entry in this map. */
3761 if (!NILP (elt_prefix
))
3762 insert1 (elt_prefix
);
3764 insert1 (Fkey_description (kludge
, prefix
));
3766 /* Find all consecutive characters or rows that have the same
3767 definition. But, for elements of a top level char table, if
3768 they are for charsets, we had better describe one by one even
3769 if they have the same definition. */
3770 if (CHAR_TABLE_P (vector
))
3772 && (val
= char_table_ref_and_range (vector
, i
+ 1,
3773 &range_beg
, &range_end
),
3774 tem2
= get_keyelt (val
, 0),
3776 && !NILP (Fequal (tem2
, definition
)))
3780 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3782 && !NILP (Fequal (tem2
, definition
)))
3785 /* If we have a range of more than one character,
3786 print where the range reaches to. */
3788 if (i
!= starting_i
)
3792 ASET (kludge
, 0, make_number (i
));
3794 if (!NILP (elt_prefix
))
3795 insert1 (elt_prefix
);
3797 insert1 (Fkey_description (kludge
, prefix
));
3800 /* Print a description of the definition of this character.
3801 elt_describer will take care of spacing out far enough
3802 for alignment purposes. */
3803 (*elt_describer
) (definition
, args
);
3808 insert_string (" (binding currently shadowed)");
3813 if (CHAR_TABLE_P (vector
) && ! NILP (XCHAR_TABLE (vector
)->defalt
))
3815 if (!NILP (elt_prefix
))
3816 insert1 (elt_prefix
);
3817 insert ("default", 7);
3818 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3824 /* Apropos - finding all symbols whose names match a regexp. */
3825 static Lisp_Object apropos_predicate
;
3826 static Lisp_Object apropos_accumulate
;
3829 apropos_accum (symbol
, string
)
3830 Lisp_Object symbol
, string
;
3832 register Lisp_Object tem
;
3834 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3835 if (!NILP (tem
) && !NILP (apropos_predicate
))
3836 tem
= call1 (apropos_predicate
, symbol
);
3838 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3841 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3842 doc
: /* Show all symbols whose names contain match for REGEXP.
3843 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3844 for each symbol and a symbol is mentioned only if that returns non-nil.
3845 Return list of symbols found. */)
3847 Lisp_Object regexp
, predicate
;
3850 CHECK_STRING (regexp
);
3851 apropos_predicate
= predicate
;
3852 apropos_accumulate
= Qnil
;
3853 map_obarray (Vobarray
, apropos_accum
, regexp
);
3854 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3855 apropos_accumulate
= Qnil
;
3856 apropos_predicate
= Qnil
;
3863 Qkeymap
= intern ("keymap");
3864 staticpro (&Qkeymap
);
3865 staticpro (&apropos_predicate
);
3866 staticpro (&apropos_accumulate
);
3867 apropos_predicate
= Qnil
;
3868 apropos_accumulate
= Qnil
;
3870 Qkeymap_canonicalize
= intern ("keymap-canonicalize");
3871 staticpro (&Qkeymap_canonicalize
);
3873 /* Now we are ready to set up this property, so we can
3874 create char tables. */
3875 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3877 /* Initialize the keymaps standardly used.
3878 Each one is the value of a Lisp variable, and is also
3879 pointed to by a C variable */
3881 global_map
= Fmake_keymap (Qnil
);
3882 Fset (intern ("global-map"), global_map
);
3884 current_global_map
= global_map
;
3885 staticpro (&global_map
);
3886 staticpro (¤t_global_map
);
3888 meta_map
= Fmake_keymap (Qnil
);
3889 Fset (intern ("esc-map"), meta_map
);
3890 Ffset (intern ("ESC-prefix"), meta_map
);
3892 control_x_map
= Fmake_keymap (Qnil
);
3893 Fset (intern ("ctl-x-map"), control_x_map
);
3894 Ffset (intern ("Control-X-prefix"), control_x_map
);
3897 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3898 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3899 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3900 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3901 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3903 staticpro (&exclude_keys
);
3905 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3906 doc
: /* List of commands given new key bindings recently.
3907 This is used for internal purposes during Emacs startup;
3908 don't alter it yourself. */);
3909 Vdefine_key_rebound_commands
= Qt
;
3911 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3912 doc
: /* Default keymap to use when reading from the minibuffer. */);
3913 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3915 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3916 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3917 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3918 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3920 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3921 doc
: /* Local keymap for minibuffer input with completion. */);
3922 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3923 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3925 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3926 &Vminibuffer_local_filename_completion_map
,
3927 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3928 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3929 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3930 Vminibuffer_local_completion_map
);
3933 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3934 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3935 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3936 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3937 Vminibuffer_local_completion_map
);
3939 DEFVAR_LISP ("minibuffer-local-filename-must-match-map",
3940 &Vminibuffer_local_filename_must_match_map
,
3941 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3942 Vminibuffer_local_filename_must_match_map
= Fmake_sparse_keymap (Qnil
);
3943 Fset_keymap_parent (Vminibuffer_local_filename_must_match_map
,
3944 Vminibuffer_local_must_match_map
);
3946 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3947 doc
: /* Alist of keymaps to use for minor modes.
3948 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3949 key sequences and look up bindings if VARIABLE's value is non-nil.
3950 If two active keymaps bind the same key, the keymap appearing earlier
3951 in the list takes precedence. */);
3952 Vminor_mode_map_alist
= Qnil
;
3954 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3955 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3956 This variable is an alist just like `minor-mode-map-alist', and it is
3957 used the same way (and before `minor-mode-map-alist'); however,
3958 it is provided for major modes to bind locally. */);
3959 Vminor_mode_overriding_map_alist
= Qnil
;
3961 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3962 doc
: /* List of keymap alists to use for emulations modes.
3963 It is intended for modes or packages using multiple minor-mode keymaps.
3964 Each element is a keymap alist just like `minor-mode-map-alist', or a
3965 symbol with a variable binding which is a keymap alist, and it is used
3966 the same way. The "active" keymaps in each alist are used before
3967 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3968 Vemulation_mode_map_alists
= Qnil
;
3970 staticpro (&Vmouse_events
);
3971 Vmouse_events
= Fcons (intern ("menu-bar"),
3972 Fcons (intern ("tool-bar"),
3973 Fcons (intern ("header-line"),
3974 Fcons (intern ("mode-line"),
3975 Fcons (intern ("mouse-1"),
3976 Fcons (intern ("mouse-2"),
3977 Fcons (intern ("mouse-3"),
3978 Fcons (intern ("mouse-4"),
3979 Fcons (intern ("mouse-5"),
3983 Qsingle_key_description
= intern ("single-key-description");
3984 staticpro (&Qsingle_key_description
);
3986 Qkey_description
= intern ("key-description");
3987 staticpro (&Qkey_description
);
3989 Qkeymapp
= intern ("keymapp");
3990 staticpro (&Qkeymapp
);
3992 Qnon_ascii
= intern ("non-ascii");
3993 staticpro (&Qnon_ascii
);
3995 Qmenu_item
= intern ("menu-item");
3996 staticpro (&Qmenu_item
);
3998 Qremap
= intern ("remap");
3999 staticpro (&Qremap
);
4001 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
4002 staticpro (&command_remapping_vector
);
4004 where_is_cache_keymaps
= Qt
;
4005 where_is_cache
= Qnil
;
4006 staticpro (&where_is_cache
);
4007 staticpro (&where_is_cache_keymaps
);
4009 defsubr (&Skeymapp
);
4010 defsubr (&Skeymap_parent
);
4011 defsubr (&Skeymap_prompt
);
4012 defsubr (&Sset_keymap_parent
);
4013 defsubr (&Smake_keymap
);
4014 defsubr (&Smake_sparse_keymap
);
4015 defsubr (&Smap_keymap_internal
);
4016 defsubr (&Smap_keymap
);
4017 defsubr (&Scopy_keymap
);
4018 defsubr (&Scommand_remapping
);
4019 defsubr (&Skey_binding
);
4020 defsubr (&Slocal_key_binding
);
4021 defsubr (&Sglobal_key_binding
);
4022 defsubr (&Sminor_mode_key_binding
);
4023 defsubr (&Sdefine_key
);
4024 defsubr (&Slookup_key
);
4025 defsubr (&Sdefine_prefix_command
);
4026 defsubr (&Suse_global_map
);
4027 defsubr (&Suse_local_map
);
4028 defsubr (&Scurrent_local_map
);
4029 defsubr (&Scurrent_global_map
);
4030 defsubr (&Scurrent_minor_mode_maps
);
4031 defsubr (&Scurrent_active_maps
);
4032 defsubr (&Saccessible_keymaps
);
4033 defsubr (&Skey_description
);
4034 defsubr (&Sdescribe_vector
);
4035 defsubr (&Ssingle_key_description
);
4036 defsubr (&Stext_char_description
);
4037 defsubr (&Swhere_is_internal
);
4038 defsubr (&Sdescribe_buffer_bindings
);
4039 defsubr (&Sapropos_internal
);
4045 initial_define_key (global_map
, 033, "ESC-prefix");
4046 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
4049 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
4050 (do not change this comment) */