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 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 2, or (at your option)
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; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
32 #include "character.h"
35 #include "termhooks.h"
36 #include "blockinput.h"
38 #include "intervals.h"
42 /* The number of elements in keymap vectors. */
43 #define DENSE_TABLE_SIZE (0200)
45 /* Actually allocate storage for these variables */
47 Lisp_Object current_global_map
; /* Current global keymap */
49 Lisp_Object global_map
; /* default global key bindings */
51 Lisp_Object meta_map
; /* The keymap used for globally bound
52 ESC-prefixed default commands */
54 Lisp_Object control_x_map
; /* The keymap used for globally bound
55 C-x-prefixed default commands */
57 /* was MinibufLocalMap */
58 Lisp_Object Vminibuffer_local_map
;
59 /* The keymap used by the minibuf for local
60 bindings when spaces are allowed in the
63 /* was MinibufLocalNSMap */
64 Lisp_Object Vminibuffer_local_ns_map
;
65 /* The keymap used by the minibuf for local
66 bindings when spaces are not encouraged
69 /* keymap used for minibuffers when doing completion */
70 /* was MinibufLocalCompletionMap */
71 Lisp_Object Vminibuffer_local_completion_map
;
73 /* keymap used for minibuffers when doing completion in filenames */
74 Lisp_Object Vminibuffer_local_filename_completion_map
;
76 /* keymap used for minibuffers when doing completion in filenames
78 Lisp_Object Vminibuffer_local_must_match_filename_map
;
80 /* keymap used for minibuffers when doing completion and require a match */
81 /* was MinibufLocalMustMatchMap */
82 Lisp_Object Vminibuffer_local_must_match_map
;
84 /* Alist of minor mode variables and keymaps. */
85 Lisp_Object Vminor_mode_map_alist
;
87 /* Alist of major-mode-specific overrides for
88 minor mode variables and keymaps. */
89 Lisp_Object Vminor_mode_overriding_map_alist
;
91 /* List of emulation mode keymap alists. */
92 Lisp_Object Vemulation_mode_map_alists
;
94 /* Keymap mapping ASCII function key sequences onto their preferred forms.
95 Initialized by the terminal-specific lisp files. See DEFVAR for more
97 Lisp_Object Vfunction_key_map
;
99 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
100 Lisp_Object Vkey_translation_map
;
102 /* A list of all commands given new bindings since a certain time
103 when nil was stored here.
104 This is used to speed up recomputation of menu key equivalents
105 when Emacs starts up. t means don't record anything here. */
106 Lisp_Object Vdefine_key_rebound_commands
;
108 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
110 /* Alist of elements like (DEL . "\d"). */
111 static Lisp_Object exclude_keys
;
113 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
114 static Lisp_Object command_remapping_vector
;
116 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
117 in a string key sequence is equivalent to prefixing with this
119 extern Lisp_Object meta_prefix_char
;
121 extern Lisp_Object Voverriding_local_map
;
123 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
124 static Lisp_Object where_is_cache
;
125 /* Which keymaps are reverse-stored in the cache. */
126 static Lisp_Object where_is_cache_keymaps
;
128 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
129 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
131 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
132 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
133 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
134 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
135 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
136 int, Lisp_Object
, Lisp_Object
*, int, int));
137 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
138 void (*) (Lisp_Object
, Lisp_Object
), int,
139 Lisp_Object
, Lisp_Object
, int *,
141 static void silly_event_symbol_error
P_ ((Lisp_Object
));
143 /* Keymap object support - constructors and predicates. */
145 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
146 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
147 CHARTABLE is a char-table that holds the bindings for all characters
148 without modifiers. All entries in it are initially nil, meaning
149 "command undefined". ALIST is an assoc-list which holds bindings for
150 function keys, mouse events, and any other things that appear in the
151 input stream. Initially, ALIST is nil.
153 The optional arg STRING supplies a menu name for the keymap
154 in case you use it as a menu with `x-popup-menu'. */)
160 tail
= Fcons (string
, Qnil
);
163 return Fcons (Qkeymap
,
164 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
167 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
168 doc
: /* Construct and return a new sparse keymap.
169 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
170 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
171 which binds the function key or mouse event SYMBOL to DEFINITION.
172 Initially the alist is nil.
174 The optional arg STRING supplies a menu name for the keymap
175 in case you use it as a menu with `x-popup-menu'. */)
180 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
181 return Fcons (Qkeymap
, Qnil
);
184 /* This function is used for installing the standard key bindings
185 at initialization time.
189 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
192 initial_define_key (keymap
, key
, defname
)
197 store_in_keymap (keymap
, make_number (key
), intern (defname
));
201 initial_define_lispy_key (keymap
, keyname
, defname
)
206 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
209 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
210 doc
: /* Return t if OBJECT is a keymap.
212 A keymap is a list (keymap . ALIST),
213 or a symbol whose function definition is itself a keymap.
214 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
215 a vector of densely packed bindings for small character codes
216 is also allowed as an element. */)
220 return (KEYMAPP (object
) ? Qt
: Qnil
);
223 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
224 doc
: /* Return the prompt-string of a keymap MAP.
225 If non-nil, the prompt is shown in the echo-area
226 when reading a key-sequence to be looked-up in this keymap. */)
230 map
= get_keymap (map
, 0, 0);
233 Lisp_Object tem
= XCAR (map
);
241 /* Check that OBJECT is a keymap (after dereferencing through any
242 symbols). If it is, return it.
244 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
245 is an autoload form, do the autoload and try again.
246 If AUTOLOAD is nonzero, callers must assume GC is possible.
248 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
249 is zero as well), return Qt.
251 ERROR controls how we respond if OBJECT isn't a keymap.
252 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
254 Note that most of the time, we don't want to pursue autoloads.
255 Functions like Faccessible_keymaps which scan entire keymap trees
256 shouldn't load every autoloaded keymap. I'm not sure about this,
257 but it seems to me that only read_key_sequence, Flookup_key, and
258 Fdefine_key should cause keymaps to be autoloaded.
260 This function can GC when AUTOLOAD is non-zero, because it calls
261 do_autoload which can GC. */
264 get_keymap (object
, error
, autoload
)
273 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
276 tem
= indirect_function (object
);
279 if (EQ (XCAR (tem
), Qkeymap
))
282 /* Should we do an autoload? Autoload forms for keymaps have
283 Qkeymap as their fifth element. */
284 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
)
289 tail
= Fnth (make_number (4), tem
);
290 if (EQ (tail
, Qkeymap
))
294 struct gcpro gcpro1
, gcpro2
;
296 GCPRO2 (tem
, object
);
297 do_autoload (tem
, object
);
310 wrong_type_argument (Qkeymapp
, object
);
314 /* Return the parent map of KEYMAP, or nil if it has none.
315 We assume that KEYMAP is a valid keymap. */
318 keymap_parent (keymap
, autoload
)
324 keymap
= get_keymap (keymap
, 1, autoload
);
326 /* Skip past the initial element `keymap'. */
327 list
= XCDR (keymap
);
328 for (; CONSP (list
); list
= XCDR (list
))
330 /* See if there is another `keymap'. */
335 return get_keymap (list
, 0, autoload
);
338 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
339 doc
: /* Return the parent keymap of KEYMAP. */)
343 return keymap_parent (keymap
, 1);
346 /* Check whether MAP is one of MAPS parents. */
348 keymap_memberp (map
, maps
)
349 Lisp_Object map
, maps
;
351 if (NILP (map
)) return 0;
352 while (KEYMAPP (maps
) && !EQ (map
, maps
))
353 maps
= keymap_parent (maps
, 0);
354 return (EQ (map
, maps
));
357 /* Set the parent keymap of MAP to PARENT. */
359 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
360 doc
: /* Modify KEYMAP to set its parent map to PARENT.
361 Return PARENT. PARENT should be nil or another keymap. */)
363 Lisp_Object keymap
, parent
;
365 Lisp_Object list
, prev
;
366 struct gcpro gcpro1
, gcpro2
;
369 /* Force a keymap flush for the next call to where-is.
370 Since this can be called from within where-is, we don't set where_is_cache
371 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
372 be changed during where-is, while where_is_cache_keymaps is only used at
373 the very beginning of where-is and can thus be changed here without any
375 This is a very minor correctness (rather than safety) issue. */
376 where_is_cache_keymaps
= Qt
;
378 GCPRO2 (keymap
, parent
);
379 keymap
= get_keymap (keymap
, 1, 1);
383 parent
= get_keymap (parent
, 1, 1);
385 /* Check for cycles. */
386 if (keymap_memberp (keymap
, parent
))
387 error ("Cyclic keymap inheritance");
390 /* Skip past the initial element `keymap'. */
395 /* If there is a parent keymap here, replace it.
396 If we came to the end, add the parent in PREV. */
397 if (!CONSP (list
) || KEYMAPP (list
))
399 /* If we already have the right parent, return now
400 so that we avoid the loops below. */
401 if (EQ (XCDR (prev
), parent
))
402 RETURN_UNGCPRO (parent
);
405 XSETCDR (prev
, parent
);
411 /* Scan through for submaps, and set their parents too. */
413 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
415 /* Stop the scan when we come to the parent. */
416 if (EQ (XCAR (list
), Qkeymap
))
419 /* If this element holds a prefix map, deal with it. */
420 if (CONSP (XCAR (list
))
421 && CONSP (XCDR (XCAR (list
))))
422 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
425 if (VECTORP (XCAR (list
)))
426 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
427 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
428 fix_submap_inheritance (keymap
, make_number (i
),
429 XVECTOR (XCAR (list
))->contents
[i
]);
431 if (CHAR_TABLE_P (XCAR (list
)))
433 map_char_table (fix_submap_inheritance
, Qnil
, XCAR (list
), keymap
);
437 RETURN_UNGCPRO (parent
);
440 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
441 if EVENT is also a prefix in MAP's parent,
442 make sure that SUBMAP inherits that definition as its own parent. */
445 fix_submap_inheritance (map
, event
, submap
)
446 Lisp_Object map
, event
, submap
;
448 Lisp_Object map_parent
, parent_entry
;
450 /* SUBMAP is a cons that we found as a key binding.
451 Discard the other things found in a menu key binding. */
453 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
455 /* If it isn't a keymap now, there's no work to do. */
459 map_parent
= keymap_parent (map
, 0);
460 if (!NILP (map_parent
))
462 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
466 /* If MAP's parent has something other than a keymap,
467 our own submap shadows it completely. */
468 if (!CONSP (parent_entry
))
471 if (! EQ (parent_entry
, submap
))
473 Lisp_Object submap_parent
;
474 submap_parent
= submap
;
479 tem
= keymap_parent (submap_parent
, 0);
483 if (keymap_memberp (tem
, parent_entry
))
484 /* Fset_keymap_parent could create a cycle. */
491 Fset_keymap_parent (submap_parent
, parent_entry
);
495 /* Look up IDX in MAP. IDX may be any sort of event.
496 Note that this does only one level of lookup; IDX must be a single
497 event, not a sequence.
499 If T_OK is non-zero, bindings for Qt are treated as default
500 bindings; any key left unmentioned by other tables and bindings is
501 given the binding of Qt.
503 If T_OK is zero, bindings for Qt are not treated specially.
505 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
508 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
517 /* Qunbound in VAL means we have found no binding yet. */
520 /* If idx is a list (some sort of mouse click, perhaps?),
521 the index we want to use is the car of the list, which
522 ought to be a symbol. */
523 idx
= EVENT_HEAD (idx
);
525 /* If idx is a symbol, it might have modifiers, which need to
526 be put in the canonical order. */
528 idx
= reorder_modifiers (idx
);
529 else if (INTEGERP (idx
))
530 /* Clobber the high bits that can be present on a machine
531 with more than 24 bits of integer. */
532 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
534 /* Handle the special meta -> esc mapping. */
535 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
537 /* See if there is a meta-map. If there's none, there is
538 no binding for IDX, unless a default binding exists in MAP. */
540 Lisp_Object meta_map
;
542 /* A strange value in which Meta is set would cause
543 infinite recursion. Protect against that. */
544 if (XINT (meta_prefix_char
) & CHAR_META
)
545 meta_prefix_char
= make_number (27);
546 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
547 t_ok
, noinherit
, autoload
),
550 if (CONSP (meta_map
))
553 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
556 /* Set IDX to t, so that we only find a default binding. */
559 /* We know there is no binding. */
563 /* t_binding is where we put a default binding that applies,
564 to use in case we do not find a binding specifically
565 for this key sequence. */
568 Lisp_Object t_binding
= Qnil
;
569 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
571 GCPRO4 (map
, tail
, idx
, t_binding
);
573 /* If `t_ok' is 2, both `t' is accepted. */
576 for (tail
= XCDR (map
);
578 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
583 binding
= XCAR (tail
);
584 if (SYMBOLP (binding
))
586 /* If NOINHERIT, stop finding prefix definitions
587 after we pass a second occurrence of the `keymap' symbol. */
588 if (noinherit
&& EQ (binding
, Qkeymap
))
589 RETURN_UNGCPRO (Qnil
);
591 else if (CONSP (binding
))
593 Lisp_Object key
= XCAR (binding
);
596 val
= XCDR (binding
);
597 else if (t_ok
> 1 && EQ (key
, Qt
))
599 t_binding
= XCDR (binding
);
603 else if (VECTORP (binding
))
605 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
606 val
= AREF (binding
, XFASTINT (idx
));
608 else if (CHAR_TABLE_P (binding
))
610 /* Character codes with modifiers
611 are not included in a char-table.
612 All character codes without modifiers are included. */
613 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
615 val
= Faref (binding
, idx
);
616 /* `nil' has a special meaning for char-tables, so
617 we use something else to record an explicitly
624 /* If we found a binding, clean it up and return it. */
625 if (!EQ (val
, Qunbound
))
628 /* A Qt binding is just like an explicit nil binding
629 (i.e. it shadows any parent binding but not bindings in
630 keymaps of lower precedence). */
632 val
= get_keyelt (val
, autoload
);
634 fix_submap_inheritance (map
, idx
, val
);
635 RETURN_UNGCPRO (val
);
640 return get_keyelt (t_binding
, autoload
);
645 map_keymap_item (fun
, args
, key
, val
, data
)
646 map_keymap_function_t fun
;
647 Lisp_Object args
, key
, val
;
650 /* We should maybe try to detect bindings shadowed by previous
651 ones and things like that. */
654 (*fun
) (key
, val
, args
, data
);
658 map_keymap_char_table_item (args
, key
, val
)
659 Lisp_Object args
, key
, val
;
663 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
665 map_keymap_item (fun
, XCDR (args
), key
, val
,
666 XSAVE_VALUE (XCAR (args
))->pointer
);
670 /* Call FUN for every binding in MAP.
671 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
672 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
674 map_keymap (map
, fun
, args
, data
, autoload
)
675 map_keymap_function_t fun
;
676 Lisp_Object map
, args
;
680 struct gcpro gcpro1
, gcpro2
, gcpro3
;
684 GCPRO3 (map
, args
, tail
);
685 map
= get_keymap (map
, 1, autoload
);
686 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
687 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
690 Lisp_Object binding
= XCAR (tail
);
693 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
694 else if (VECTORP (binding
))
696 /* Loop over the char values represented in the vector. */
697 int len
= ASIZE (binding
);
699 for (c
= 0; c
< len
; c
++)
701 Lisp_Object character
;
702 XSETFASTINT (character
, c
);
703 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
706 else if (CHAR_TABLE_P (binding
))
708 map_char_table (map_keymap_char_table_item
, Qnil
, binding
,
709 Fcons (make_save_value (fun
, 0),
710 Fcons (make_save_value (data
, 0),
718 map_keymap_call (key
, val
, fun
, dummy
)
719 Lisp_Object key
, val
, fun
;
722 call2 (fun
, key
, val
);
725 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
726 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
727 FUNCTION is called with two arguments: the event that is bound, and
728 the definition it is bound to.
730 If KEYMAP has a parent, the parent's bindings are included as well.
731 This works recursively: if the parent has itself a parent, then the
732 grandparent's bindings are also included and so on.
733 usage: (map-keymap FUNCTION KEYMAP) */)
734 (function
, keymap
, sort_first
)
735 Lisp_Object function
, keymap
, sort_first
;
737 if (INTEGERP (function
))
738 /* We have to stop integers early since map_keymap gives them special
740 xsignal1 (Qinvalid_function
, function
);
741 if (! NILP (sort_first
))
742 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
744 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
748 /* Given OBJECT which was found in a slot in a keymap,
749 trace indirect definitions to get the actual definition of that slot.
750 An indirect definition is a list of the form
751 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
752 and INDEX is the object to look up in KEYMAP to yield the definition.
754 Also if OBJECT has a menu string as the first element,
755 remove that. Also remove a menu help string as second element.
757 If AUTOLOAD is nonzero, load autoloadable keymaps
758 that are referred to with indirection.
760 This can GC because menu_item_eval_property calls Feval. */
763 get_keyelt (object
, autoload
)
769 if (!(CONSP (object
)))
770 /* This is really the value. */
773 /* If the keymap contents looks like (keymap ...) or (lambda ...)
775 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
778 /* If the keymap contents looks like (menu-item name . DEFN)
779 or (menu-item name DEFN ...) then use DEFN.
780 This is a new format menu item. */
781 else if (EQ (XCAR (object
), Qmenu_item
))
783 if (CONSP (XCDR (object
)))
787 object
= XCDR (XCDR (object
));
790 object
= XCAR (object
);
792 /* If there's a `:filter FILTER', apply FILTER to the
793 menu-item's definition to get the real definition to
795 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
796 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
799 filter
= XCAR (XCDR (tem
));
800 filter
= list2 (filter
, list2 (Qquote
, object
));
801 object
= menu_item_eval_property (filter
);
806 /* Invalid keymap. */
810 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
811 Keymap alist elements like (CHAR MENUSTRING . DEFN)
812 will be used by HierarKey menus. */
813 else if (STRINGP (XCAR (object
)))
815 object
= XCDR (object
);
816 /* Also remove a menu help string, if any,
817 following the menu item name. */
818 if (CONSP (object
) && STRINGP (XCAR (object
)))
819 object
= XCDR (object
);
820 /* Also remove the sublist that caches key equivalences, if any. */
821 if (CONSP (object
) && CONSP (XCAR (object
)))
824 carcar
= XCAR (XCAR (object
));
825 if (NILP (carcar
) || VECTORP (carcar
))
826 object
= XCDR (object
);
830 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
836 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
838 return (!CONSP (map
) ? object
/* Invalid keymap */
839 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
845 store_in_keymap (keymap
, idx
, def
)
847 register Lisp_Object idx
;
850 /* Flush any reverse-map cache. */
851 where_is_cache
= Qnil
;
852 where_is_cache_keymaps
= Qt
;
854 /* If we are preparing to dump, and DEF is a menu element
855 with a menu item indicator, copy it to ensure it is not pure. */
856 if (CONSP (def
) && PURE_P (def
)
857 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
858 def
= Fcons (XCAR (def
), XCDR (def
));
860 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
861 error ("attempt to define a key in a non-keymap");
863 /* If idx is a cons, and the car part is a character, idx must be of
864 the form (FROM-CHAR . TO-CHAR). */
865 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
866 CHECK_CHARACTER_CDR (idx
);
868 /* If idx is a list (some sort of mouse click, perhaps?),
869 the index we want to use is the car of the list, which
870 ought to be a symbol. */
871 idx
= EVENT_HEAD (idx
);
873 /* If idx is a symbol, it might have modifiers, which need to
874 be put in the canonical order. */
876 idx
= reorder_modifiers (idx
);
877 else if (INTEGERP (idx
))
878 /* Clobber the high bits that can be present on a machine
879 with more than 24 bits of integer. */
880 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
882 /* Scan the keymap for a binding of idx. */
886 /* The cons after which we should insert new bindings. If the
887 keymap has a table element, we record its position here, so new
888 bindings will go after it; this way, the table will stay
889 towards the front of the alist and character lookups in dense
890 keymaps will remain fast. Otherwise, this just points at the
891 front of the keymap. */
892 Lisp_Object insertion_point
;
894 insertion_point
= keymap
;
895 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
902 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
905 ASET (elt
, XFASTINT (idx
), def
);
908 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
910 int from
= XFASTINT (XCAR (idx
));
911 int to
= XFASTINT (XCDR (idx
));
913 if (to
>= ASIZE (elt
))
914 to
= ASIZE (elt
) - 1;
915 for (; from
<= to
; from
++)
916 ASET (elt
, from
, def
);
917 if (to
== XFASTINT (XCDR (idx
)))
918 /* We have defined all keys in IDX. */
921 insertion_point
= tail
;
923 else if (CHAR_TABLE_P (elt
))
925 /* Character codes with modifiers
926 are not included in a char-table.
927 All character codes without modifiers are included. */
928 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
931 /* `nil' has a special meaning for char-tables, so
932 we use something else to record an explicitly
934 NILP (def
) ? Qt
: def
);
937 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
939 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
942 insertion_point
= tail
;
944 else if (CONSP (elt
))
946 if (EQ (idx
, XCAR (elt
)))
952 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
954 int from
= XFASTINT (XCAR (idx
));
955 int to
= XFASTINT (XCDR (idx
));
957 if (from
<= XFASTINT (XCAR (elt
))
958 && to
>= XFASTINT (XCAR (elt
)))
966 else if (EQ (elt
, Qkeymap
))
967 /* If we find a 'keymap' symbol in the spine of KEYMAP,
968 then we must have found the start of a second keymap
969 being used as the tail of KEYMAP, and a binding for IDX
970 should be inserted before it. */
977 /* We have scanned the entire keymap, and not found a binding for
978 IDX. Let's add one. */
982 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
984 /* IDX specifies a range of characters, and not all of them
985 were handled yet, which means this keymap doesn't have a
986 char-table. So, we insert a char-table now. */
987 elt
= Fmake_char_table (Qkeymap
, Qnil
);
988 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
991 elt
= Fcons (idx
, def
);
992 CHECK_IMPURE (insertion_point
);
993 XSETCDR (insertion_point
, Fcons (elt
, XCDR (insertion_point
)));
1000 EXFUN (Fcopy_keymap
, 1);
1003 copy_keymap_item (elt
)
1006 Lisp_Object res
, tem
;
1013 /* Is this a new format menu item. */
1014 if (EQ (XCAR (tem
), Qmenu_item
))
1016 /* Copy cell with menu-item marker. */
1017 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1021 /* Copy cell with menu-item name. */
1022 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1028 /* Copy cell with binding and if the binding is a keymap,
1030 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1033 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1034 XSETCAR (elt
, Fcopy_keymap (tem
));
1036 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1037 /* Delete cache for key equivalences. */
1038 XSETCDR (elt
, XCDR (tem
));
1043 /* It may be an old fomat menu item.
1044 Skip the optional menu string. */
1045 if (STRINGP (XCAR (tem
)))
1047 /* Copy the cell, since copy-alist didn't go this deep. */
1048 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1050 /* Also skip the optional menu help string. */
1051 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1053 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1057 /* There may also be a list that caches key equivalences.
1058 Just delete it for the new keymap. */
1060 && CONSP (XCAR (tem
))
1061 && (NILP (XCAR (XCAR (tem
)))
1062 || VECTORP (XCAR (XCAR (tem
)))))
1064 XSETCDR (elt
, XCDR (tem
));
1067 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1068 XSETCDR (elt
, Fcopy_keymap (tem
));
1070 else if (EQ (XCAR (tem
), Qkeymap
))
1071 res
= Fcopy_keymap (elt
);
1077 copy_keymap_1 (chartable
, idx
, elt
)
1078 Lisp_Object chartable
, idx
, elt
;
1080 Fset_char_table_range (chartable
, idx
, copy_keymap_item (elt
));
1083 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1084 doc
: /* Return a copy of the keymap KEYMAP.
1085 The copy starts out with the same definitions of KEYMAP,
1086 but changing either the copy or KEYMAP does not affect the other.
1087 Any key definitions that are subkeymaps are recursively copied.
1088 However, a key definition which is a symbol whose definition is a keymap
1093 register Lisp_Object copy
, tail
;
1094 keymap
= get_keymap (keymap
, 1, 0);
1095 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1096 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1098 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1100 Lisp_Object elt
= XCAR (keymap
);
1101 if (CHAR_TABLE_P (elt
))
1103 elt
= Fcopy_sequence (elt
);
1104 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
);
1106 else if (VECTORP (elt
))
1109 elt
= Fcopy_sequence (elt
);
1110 for (i
= 0; i
< ASIZE (elt
); i
++)
1111 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1113 else if (CONSP (elt
))
1114 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1115 XSETCDR (tail
, Fcons (elt
, Qnil
));
1117 keymap
= XCDR (keymap
);
1119 XSETCDR (tail
, keymap
);
1123 /* Simple Keymap mutators and accessors. */
1125 /* GC is possible in this function if it autoloads a keymap. */
1127 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1128 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1131 KEY is a string or a vector of symbols and characters meaning a
1132 sequence of keystrokes and events. Non-ASCII characters with codes
1133 above 127 (such as ISO Latin-1) can be included if you use a vector.
1134 Using [t] for KEY creates a default definition, which applies to any
1135 event type that has no other definition in this keymap.
1137 DEF is anything that can be a key's definition:
1138 nil (means key is undefined in this keymap),
1139 a command (a Lisp function suitable for interactive calling),
1140 a string (treated as a keyboard macro),
1141 a keymap (to define a prefix key),
1142 a symbol (when the key is looked up, the symbol will stand for its
1143 function definition, which should at that time be one of the above,
1144 or another symbol whose function definition is used, etc.),
1145 a cons (STRING . DEFN), meaning that DEFN is the definition
1146 (DEFN should be a valid definition in its own right),
1147 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1149 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1150 binding is altered. If there is no binding for KEY, the new pair
1151 binding KEY to DEF is added at the front of KEYMAP. */)
1158 register Lisp_Object c
;
1159 register Lisp_Object cmd
;
1163 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1165 GCPRO3 (keymap
, key
, def
);
1166 keymap
= get_keymap (keymap
, 1, 1);
1168 CHECK_VECTOR_OR_STRING (key
);
1170 length
= XFASTINT (Flength (key
));
1172 RETURN_UNGCPRO (Qnil
);
1174 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1175 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1177 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1179 if (VECTORP (def
) && ASIZE (def
) > 0 && CONSP (AREF (def
, make_number (0))))
1180 { /* DEF is apparently an XEmacs-style keyboard macro. */
1181 Lisp_Object tmp
= Fmake_vector (make_number (ASIZE (def
)), Qnil
);
1182 int i
= ASIZE (def
);
1185 Lisp_Object c
= AREF (def
, i
);
1186 if (CONSP (c
) && lucid_event_type_list_p (c
))
1187 c
= Fevent_convert_list (c
);
1196 c
= Faref (key
, make_number (idx
));
1200 /* C may be a Lucid style event type list or a cons (FROM .
1201 TO) specifying a range of characters. */
1202 if (lucid_event_type_list_p (c
))
1203 c
= Fevent_convert_list (c
);
1204 else if (CHARACTERP (XCAR (c
)))
1205 CHECK_CHARACTER_CDR (c
);
1209 silly_event_symbol_error (c
);
1212 && (XINT (c
) & meta_bit
)
1215 c
= meta_prefix_char
;
1221 XSETINT (c
, XINT (c
) & ~meta_bit
);
1227 if (!INTEGERP (c
) && !SYMBOLP (c
)
1229 /* If C is a range, it must be a leaf. */
1230 || (INTEGERP (XCAR (c
)) && idx
!= length
)))
1231 error ("Key sequence contains invalid event");
1234 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1236 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1238 /* If this key is undefined, make it a prefix. */
1240 cmd
= define_as_prefix (keymap
, c
);
1242 keymap
= get_keymap (cmd
, 0, 1);
1243 if (!CONSP (keymap
))
1244 /* We must use Fkey_description rather than just passing key to
1245 error; key might be a vector, not a string. */
1246 error ("Key sequence %s starts with non-prefix key %s",
1247 SDATA (Fkey_description (key
, Qnil
)),
1248 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1254 /* This function may GC (it calls Fkey_binding). */
1256 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 2, 0,
1257 doc
: /* Return the remapping for command COMMAND in current keymaps.
1258 Returns nil if COMMAND is not remapped (or not a symbol).
1260 If the optional argument POSITION is non-nil, it specifies a mouse
1261 position as returned by `event-start' and `event-end', and the
1262 remapping occurs in the keymaps associated with it. It can also be a
1263 number or marker, in which case the keymap properties at the specified
1264 buffer position instead of point are used. */)
1266 Lisp_Object command
, position
;
1268 if (!SYMBOLP (command
))
1271 ASET (command_remapping_vector
, 1, command
);
1272 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
, position
);
1275 /* Value is number if KEY is too long; nil if valid but has no definition. */
1276 /* GC is possible in this function if it autoloads a keymap. */
1278 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1279 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1280 nil means undefined. See doc of `define-key' for kinds of definitions.
1282 A number as value means KEY is "too long";
1283 that is, characters or symbols in it except for the last one
1284 fail to be a valid sequence of prefix characters in KEYMAP.
1285 The number is how many characters at the front of KEY
1286 it takes to reach a non-prefix key.
1288 Normally, `lookup-key' ignores bindings for t, which act as default
1289 bindings, used when nothing else in the keymap applies; this makes it
1290 usable as a general function for probing keymaps. However, if the
1291 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1292 recognize the default bindings, just as `read-key-sequence' does. */)
1293 (keymap
, key
, accept_default
)
1296 Lisp_Object accept_default
;
1299 register Lisp_Object cmd
;
1300 register Lisp_Object c
;
1302 int t_ok
= !NILP (accept_default
);
1303 struct gcpro gcpro1
, gcpro2
;
1305 GCPRO2 (keymap
, key
);
1306 keymap
= get_keymap (keymap
, 1, 1);
1308 CHECK_VECTOR_OR_STRING (key
);
1310 length
= XFASTINT (Flength (key
));
1312 RETURN_UNGCPRO (keymap
);
1317 c
= Faref (key
, make_number (idx
++));
1319 if (CONSP (c
) && lucid_event_type_list_p (c
))
1320 c
= Fevent_convert_list (c
);
1322 /* Turn the 8th bit of string chars into a meta modifier. */
1323 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1324 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1326 /* Allow string since binding for `menu-bar-select-buffer'
1327 includes the buffer name in the key sequence. */
1328 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1329 error ("Key sequence contains invalid event");
1331 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1333 RETURN_UNGCPRO (cmd
);
1335 keymap
= get_keymap (cmd
, 0, 1);
1336 if (!CONSP (keymap
))
1337 RETURN_UNGCPRO (make_number (idx
));
1343 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1344 Assume that currently it does not define C at all.
1345 Return the keymap. */
1348 define_as_prefix (keymap
, c
)
1349 Lisp_Object keymap
, c
;
1353 cmd
= Fmake_sparse_keymap (Qnil
);
1354 /* If this key is defined as a prefix in an inherited keymap,
1355 make it a prefix in this map, and make its definition
1356 inherit the other prefix definition. */
1357 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1358 store_in_keymap (keymap
, c
, cmd
);
1363 /* Append a key to the end of a key sequence. We always make a vector. */
1366 append_key (key_sequence
, key
)
1367 Lisp_Object key_sequence
, key
;
1369 Lisp_Object args
[2];
1371 args
[0] = key_sequence
;
1373 args
[1] = Fcons (key
, Qnil
);
1374 return Fvconcat (2, args
);
1377 /* Given a event type C which is a symbol,
1378 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1381 silly_event_symbol_error (c
)
1384 Lisp_Object parsed
, base
, name
, assoc
;
1387 parsed
= parse_modifiers (c
);
1388 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1389 base
= XCAR (parsed
);
1390 name
= Fsymbol_name (base
);
1391 /* This alist includes elements such as ("RET" . "\\r"). */
1392 assoc
= Fassoc (name
, exclude_keys
);
1396 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1398 Lisp_Object keystring
;
1399 if (modifiers
& alt_modifier
)
1400 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1401 if (modifiers
& ctrl_modifier
)
1402 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1403 if (modifiers
& hyper_modifier
)
1404 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1405 if (modifiers
& meta_modifier
)
1406 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1407 if (modifiers
& shift_modifier
)
1408 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1409 if (modifiers
& super_modifier
)
1410 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1413 c
= reorder_modifiers (c
);
1414 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1416 error ((modifiers
& ~meta_modifier
1417 ? "To bind the key %s, use [?%s], not [%s]"
1418 : "To bind the key %s, use \"%s\", not [%s]"),
1419 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1420 SDATA (SYMBOL_NAME (c
)));
1424 /* Global, local, and minor mode keymap stuff. */
1426 /* We can't put these variables inside current_minor_maps, since under
1427 some systems, static gets macro-defined to be the empty string.
1429 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1430 static int cmm_size
= 0;
1432 /* Store a pointer to an array of the keymaps of the currently active
1433 minor modes in *buf, and return the number of maps it contains.
1435 This function always returns a pointer to the same buffer, and may
1436 free or reallocate it, so if you want to keep it for a long time or
1437 hand it out to lisp code, copy it. This procedure will be called
1438 for every key sequence read, so the nice lispy approach (return a
1439 new assoclist, list, what have you) for each invocation would
1440 result in a lot of consing over time.
1442 If we used xrealloc/xmalloc and ran out of memory, they would throw
1443 back to the command loop, which would try to read a key sequence,
1444 which would call this function again, resulting in an infinite
1445 loop. Instead, we'll use realloc/malloc and silently truncate the
1446 list, let the key sequence be read, and hope some other piece of
1447 code signals the error. */
1449 current_minor_maps (modeptr
, mapptr
)
1450 Lisp_Object
**modeptr
, **mapptr
;
1453 int list_number
= 0;
1454 Lisp_Object alist
, assoc
, var
, val
;
1455 Lisp_Object emulation_alists
;
1456 Lisp_Object lists
[2];
1458 emulation_alists
= Vemulation_mode_map_alists
;
1459 lists
[0] = Vminor_mode_overriding_map_alist
;
1460 lists
[1] = Vminor_mode_map_alist
;
1462 for (list_number
= 0; list_number
< 2; list_number
++)
1464 if (CONSP (emulation_alists
))
1466 alist
= XCAR (emulation_alists
);
1467 emulation_alists
= XCDR (emulation_alists
);
1468 if (SYMBOLP (alist
))
1469 alist
= find_symbol_value (alist
);
1473 alist
= lists
[list_number
];
1475 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1476 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1477 && (var
= XCAR (assoc
), SYMBOLP (var
))
1478 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1483 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1484 and also an entry in Vminor_mode_map_alist,
1485 ignore the latter. */
1486 if (list_number
== 1)
1488 val
= assq_no_quit (var
, lists
[0]);
1495 int newsize
, allocsize
;
1496 Lisp_Object
*newmodes
, *newmaps
;
1498 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1499 allocsize
= newsize
* sizeof *newmodes
;
1501 /* Use malloc here. See the comment above this function.
1502 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1504 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1509 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1512 cmm_modes
= newmodes
;
1515 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1520 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1527 if (newmodes
== NULL
|| newmaps
== NULL
)
1532 /* Get the keymap definition--or nil if it is not defined. */
1533 temp
= Findirect_function (XCDR (assoc
), Qt
);
1537 cmm_maps
[i
] = temp
;
1543 if (modeptr
) *modeptr
= cmm_modes
;
1544 if (mapptr
) *mapptr
= cmm_maps
;
1548 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1550 doc
: /* Return a list of the currently active keymaps.
1551 OLP if non-nil indicates that we should obey `overriding-local-map' and
1552 `overriding-terminal-local-map'. */)
1556 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1560 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1561 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1562 /* The doc said that overriding-terminal-local-map should
1563 override overriding-local-map. The code used them both,
1564 but it seems clearer to use just one. rms, jan 2005. */
1565 else if (!NILP (Voverriding_local_map
))
1566 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1568 if (NILP (XCDR (keymaps
)))
1574 /* This usually returns the buffer's local map,
1575 but that can be overridden by a `local-map' property. */
1576 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1578 keymaps
= Fcons (local
, keymaps
);
1580 /* Now put all the minor mode keymaps on the list. */
1581 nmaps
= current_minor_maps (0, &maps
);
1583 for (i
= --nmaps
; i
>= 0; i
--)
1584 if (!NILP (maps
[i
]))
1585 keymaps
= Fcons (maps
[i
], keymaps
);
1587 /* This returns nil unless there is a `keymap' property. */
1588 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1590 keymaps
= Fcons (local
, keymaps
);
1596 /* GC is possible in this function if it autoloads a keymap. */
1598 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 4, 0,
1599 doc
: /* Return the binding for command KEY in current keymaps.
1600 KEY is a string or vector, a sequence of keystrokes.
1601 The binding is probably a symbol with a function definition.
1603 Normally, `key-binding' ignores bindings for t, which act as default
1604 bindings, used when nothing else in the keymap applies; this makes it
1605 usable as a general function for probing keymaps. However, if the
1606 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1607 recognize the default bindings, just as `read-key-sequence' does.
1609 Like the normal command loop, `key-binding' will remap the command
1610 resulting from looking up KEY by looking up the command in the
1611 current keymaps. However, if the optional third argument NO-REMAP
1612 is non-nil, `key-binding' returns the unmapped command.
1614 If KEY is a key sequence initiated with the mouse, the used keymaps
1615 will depend on the clicked mouse position with regard to the buffer
1616 and possible local keymaps on strings.
1618 If the optional argument POSITION is non-nil, it specifies a mouse
1619 position as returned by `event-start' and `event-end', and the lookup
1620 occurs in the keymaps associated with it instead of KEY. It can also
1621 be a number or marker, in which case the keymap properties at the
1622 specified buffer position instead of point are used.
1624 (key
, accept_default
, no_remap
, position
)
1625 Lisp_Object key
, accept_default
, no_remap
, position
;
1627 Lisp_Object
*maps
, value
;
1629 struct gcpro gcpro1
, gcpro2
;
1630 int count
= SPECPDL_INDEX ();
1632 GCPRO2 (key
, position
);
1634 if (NILP (position
) && VECTORP (key
))
1637 /* mouse events may have a symbolic prefix indicating the
1638 scrollbar or mode line */
1639 = AREF (key
, SYMBOLP (AREF (key
, 0)) && ASIZE (key
) > 1 ? 1 : 0);
1641 /* We are not interested in locations without event data */
1643 if (EVENT_HAS_PARAMETERS (event
)) {
1646 kind
= EVENT_HEAD_KIND (EVENT_HEAD (event
));
1647 if (EQ (kind
, Qmouse_click
))
1648 position
= EVENT_START (event
);
1652 /* Key sequences beginning with mouse clicks
1653 are read using the keymaps of the buffer clicked on, not
1654 the current buffer. So we may have to switch the buffer
1657 if (CONSP (position
))
1661 window
= POSN_WINDOW (position
);
1663 if (WINDOWP (window
)
1664 && BUFFERP (XWINDOW (window
)->buffer
)
1665 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
1667 /* Arrange to go back to the original buffer once we're done
1668 processing the key sequence. We don't use
1669 save_excursion_{save,restore} here, in analogy to
1670 `read-key-sequence' to avoid saving point. Maybe this
1671 would not be a problem here, but it is easier to keep
1675 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
1677 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
1681 if (! NILP (current_kboard
->Voverriding_terminal_local_map
))
1683 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1684 key
, accept_default
);
1685 if (! NILP (value
) && !INTEGERP (value
))
1688 else if (! NILP (Voverriding_local_map
))
1690 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1691 if (! NILP (value
) && !INTEGERP (value
))
1696 Lisp_Object keymap
, local_map
;
1699 pt
= INTEGERP (position
) ? XINT (position
)
1700 : MARKERP (position
) ? marker_position (position
)
1703 local_map
= get_local_map (pt
, current_buffer
, Qlocal_map
);
1704 keymap
= get_local_map (pt
, current_buffer
, Qkeymap
);
1706 if (CONSP (position
))
1710 /* For a mouse click, get the local text-property keymap
1711 of the place clicked on, rather than point. */
1713 if (POSN_INBUFFER_P (position
))
1717 pos
= POSN_BUFFER_POSN (position
);
1719 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
1721 local_map
= get_local_map (XINT (pos
),
1722 current_buffer
, Qlocal_map
);
1724 keymap
= get_local_map (XINT (pos
),
1725 current_buffer
, Qkeymap
);
1729 /* If on a mode line string with a local keymap,
1730 or for a click on a string, i.e. overlay string or a
1731 string displayed via the `display' property,
1732 consider `local-map' and `keymap' properties of
1735 if (string
= POSN_STRING (position
),
1736 (CONSP (string
) && STRINGP (XCAR (string
))))
1738 Lisp_Object pos
, map
;
1740 pos
= XCDR (string
);
1741 string
= XCAR (string
);
1743 && XINT (pos
) < SCHARS (string
))
1745 map
= Fget_text_property (pos
, Qlocal_map
, string
);
1749 map
= Fget_text_property (pos
, Qkeymap
, string
);
1757 if (! NILP (keymap
))
1759 value
= Flookup_key (keymap
, key
, accept_default
);
1760 if (! NILP (value
) && !INTEGERP (value
))
1764 nmaps
= current_minor_maps (0, &maps
);
1765 /* Note that all these maps are GCPRO'd
1766 in the places where we found them. */
1768 for (i
= 0; i
< nmaps
; i
++)
1769 if (! NILP (maps
[i
]))
1771 value
= Flookup_key (maps
[i
], key
, accept_default
);
1772 if (! NILP (value
) && !INTEGERP (value
))
1776 if (! NILP (local_map
))
1778 value
= Flookup_key (local_map
, key
, accept_default
);
1779 if (! NILP (value
) && !INTEGERP (value
))
1784 value
= Flookup_key (current_global_map
, key
, accept_default
);
1787 unbind_to (count
, Qnil
);
1790 if (NILP (value
) || INTEGERP (value
))
1793 /* If the result of the ordinary keymap lookup is an interactive
1794 command, look for a key binding (ie. remapping) for that command. */
1796 if (NILP (no_remap
) && SYMBOLP (value
))
1799 if (value1
= Fcommand_remapping (value
, position
), !NILP (value1
))
1806 /* GC is possible in this function if it autoloads a keymap. */
1808 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1809 doc
: /* Return the binding for command KEYS in current local keymap only.
1810 KEYS is a string or vector, a sequence of keystrokes.
1811 The binding is probably a symbol with a function definition.
1813 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1814 bindings; see the description of `lookup-key' for more details about this. */)
1815 (keys
, accept_default
)
1816 Lisp_Object keys
, accept_default
;
1818 register Lisp_Object map
;
1819 map
= current_buffer
->keymap
;
1822 return Flookup_key (map
, keys
, accept_default
);
1825 /* GC is possible in this function if it autoloads a keymap. */
1827 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1828 doc
: /* Return the binding for command KEYS in current global keymap only.
1829 KEYS is a string or vector, a sequence of keystrokes.
1830 The binding is probably a symbol with a function definition.
1831 This function's return values are the same as those of `lookup-key'
1834 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1835 bindings; see the description of `lookup-key' for more details about this. */)
1836 (keys
, accept_default
)
1837 Lisp_Object keys
, accept_default
;
1839 return Flookup_key (current_global_map
, keys
, accept_default
);
1842 /* GC is possible in this function if it autoloads a keymap. */
1844 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1845 doc
: /* Find the visible minor mode bindings of KEY.
1846 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1847 the symbol which names the minor mode binding KEY, and BINDING is
1848 KEY's definition in that mode. In particular, if KEY has no
1849 minor-mode bindings, return nil. If the first binding is a
1850 non-prefix, all subsequent bindings will be omitted, since they would
1851 be ignored. Similarly, the list doesn't include non-prefix bindings
1852 that come after prefix bindings.
1854 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1855 bindings; see the description of `lookup-key' for more details about this. */)
1856 (key
, accept_default
)
1857 Lisp_Object key
, accept_default
;
1859 Lisp_Object
*modes
, *maps
;
1861 Lisp_Object binding
;
1863 struct gcpro gcpro1
, gcpro2
;
1865 nmaps
= current_minor_maps (&modes
, &maps
);
1866 /* Note that all these maps are GCPRO'd
1867 in the places where we found them. */
1870 GCPRO2 (key
, binding
);
1872 for (i
= j
= 0; i
< nmaps
; i
++)
1874 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1875 && !INTEGERP (binding
))
1877 if (KEYMAPP (binding
))
1878 maps
[j
++] = Fcons (modes
[i
], binding
);
1880 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1884 return Flist (j
, maps
);
1887 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1888 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1889 A new sparse keymap is stored as COMMAND's function definition and its value.
1890 If a second optional argument MAPVAR is given, the map is stored as
1891 its value instead of as COMMAND's value; but COMMAND is still defined
1893 The third optional argument NAME, if given, supplies a menu name
1894 string for the map. This is required to use the keymap as a menu.
1895 This function returns COMMAND. */)
1896 (command
, mapvar
, name
)
1897 Lisp_Object command
, mapvar
, name
;
1900 map
= Fmake_sparse_keymap (name
);
1901 Ffset (command
, map
);
1905 Fset (command
, map
);
1909 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1910 doc
: /* Select KEYMAP as the global keymap. */)
1914 keymap
= get_keymap (keymap
, 1, 1);
1915 current_global_map
= keymap
;
1920 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1921 doc
: /* Select KEYMAP as the local keymap.
1922 If KEYMAP is nil, that means no local keymap. */)
1927 keymap
= get_keymap (keymap
, 1, 1);
1929 current_buffer
->keymap
= keymap
;
1934 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1935 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1938 return current_buffer
->keymap
;
1941 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1942 doc
: /* Return the current global keymap. */)
1945 return current_global_map
;
1948 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1949 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1953 int nmaps
= current_minor_maps (0, &maps
);
1955 return Flist (nmaps
, maps
);
1958 /* Help functions for describing and documenting keymaps. */
1962 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1963 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1964 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1968 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1972 /* Look for and break cycles. */
1973 while (!NILP (tem
= Frassq (cmd
, maps
)))
1975 Lisp_Object prefix
= XCAR (tem
);
1976 int lim
= XINT (Flength (XCAR (tem
)));
1977 if (lim
<= XINT (Flength (thisseq
)))
1978 { /* This keymap was already seen with a smaller prefix. */
1980 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1981 Faref (thisseq
, make_number (i
))))
1984 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1987 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1988 but maybe `cmd' occurs again further down in `maps', so keep
1990 maps
= XCDR (Fmemq (tem
, maps
));
1993 /* If the last key in thisseq is meta-prefix-char,
1994 turn it into a meta-ized keystroke. We know
1995 that the event we're about to append is an
1996 ascii keystroke since we're processing a
2000 int meta_bit
= meta_modifier
;
2001 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
2002 tem
= Fcopy_sequence (thisseq
);
2004 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
2006 /* This new sequence is the same length as
2007 thisseq, so stick it in the list right
2010 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
2014 tem
= append_key (thisseq
, key
);
2015 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
2020 accessible_keymaps_char_table (args
, index
, cmd
)
2021 Lisp_Object args
, index
, cmd
;
2023 accessible_keymaps_1 (index
, cmd
,
2027 XINT (XCDR (XCAR (args
))));
2030 /* This function cannot GC. */
2032 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
2034 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
2035 Returns a list of elements of the form (KEYS . MAP), where the sequence
2036 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
2037 so that the KEYS increase in length. The first element is ([] . KEYMAP).
2038 An optional argument PREFIX, if non-nil, should be a key sequence;
2039 then the value includes only maps for prefixes that start with PREFIX. */)
2041 Lisp_Object keymap
, prefix
;
2043 Lisp_Object maps
, tail
;
2046 /* no need for gcpro because we don't autoload any keymaps. */
2049 prefixlen
= XINT (Flength (prefix
));
2053 /* If a prefix was specified, start with the keymap (if any) for
2054 that prefix, so we don't waste time considering other prefixes. */
2056 tem
= Flookup_key (keymap
, prefix
, Qt
);
2057 /* Flookup_key may give us nil, or a number,
2058 if the prefix is not defined in this particular map.
2059 It might even give us a list that isn't a keymap. */
2060 tem
= get_keymap (tem
, 0, 0);
2063 /* Convert PREFIX to a vector now, so that later on
2064 we don't have to deal with the possibility of a string. */
2065 if (STRINGP (prefix
))
2070 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
2071 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
2075 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
2076 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2077 c
^= 0200 | meta_modifier
;
2078 ASET (copy
, i_before
, make_number (c
));
2082 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
2088 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
2089 get_keymap (keymap
, 1, 0)),
2092 /* For each map in the list maps,
2093 look at any other maps it points to,
2094 and stick them at the end if they are not already in the list.
2096 This is a breadth-first traversal, where tail is the queue of
2097 nodes, and maps accumulates a list of all nodes visited. */
2099 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
2101 register Lisp_Object thisseq
, thismap
;
2103 /* Does the current sequence end in the meta-prefix-char? */
2106 thisseq
= Fcar (Fcar (tail
));
2107 thismap
= Fcdr (Fcar (tail
));
2108 last
= make_number (XINT (Flength (thisseq
)) - 1);
2109 is_metized
= (XINT (last
) >= 0
2110 /* Don't metize the last char of PREFIX. */
2111 && XINT (last
) >= prefixlen
2112 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
2114 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
2118 elt
= XCAR (thismap
);
2122 if (CHAR_TABLE_P (elt
))
2124 map_char_table (accessible_keymaps_char_table
, Qnil
,
2125 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
2126 Fcons (tail
, thisseq
)));
2128 else if (VECTORP (elt
))
2132 /* Vector keymap. Scan all the elements. */
2133 for (i
= 0; i
< ASIZE (elt
); i
++)
2134 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
2135 maps
, tail
, thisseq
, is_metized
);
2138 else if (CONSP (elt
))
2139 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
2140 maps
, tail
, thisseq
,
2141 is_metized
&& INTEGERP (XCAR (elt
)));
2149 Lisp_Object Qsingle_key_description
, Qkey_description
;
2151 /* This function cannot GC. */
2153 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2154 doc
: /* Return a pretty description of key-sequence KEYS.
2155 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2156 Control characters turn into "C-foo" sequences, meta into "M-foo",
2157 spaces are put between sequence elements, etc. */)
2159 Lisp_Object keys
, prefix
;
2164 int size
= XINT (Flength (keys
));
2166 Lisp_Object sep
= build_string (" ");
2171 size
+= XINT (Flength (prefix
));
2173 /* This has one extra element at the end that we don't pass to Fconcat. */
2174 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2176 /* In effect, this computes
2177 (mapconcat 'single-key-description keys " ")
2178 but we shouldn't use mapconcat because it can do GC. */
2182 list
= prefix
, prefix
= Qnil
;
2183 else if (!NILP (keys
))
2184 list
= keys
, keys
= Qnil
;
2189 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2193 return empty_string
;
2194 return Fconcat (len
- 1, args
);
2198 size
= SCHARS (list
);
2199 else if (VECTORP (list
))
2200 size
= XVECTOR (list
)->size
;
2201 else if (CONSP (list
))
2202 size
= XINT (Flength (list
));
2204 wrong_type_argument (Qarrayp
, list
);
2213 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2214 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2215 c
^= 0200 | meta_modifier
;
2216 XSETFASTINT (key
, c
);
2218 else if (VECTORP (list
))
2220 key
= AREF (list
, i
++);
2232 || EQ (key
, meta_prefix_char
)
2233 || (XINT (key
) & meta_modifier
))
2235 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2237 if (EQ (key
, meta_prefix_char
))
2241 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2244 else if (EQ (key
, meta_prefix_char
))
2249 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2257 push_key_description (c
, p
, force_multibyte
)
2258 register unsigned int c
;
2260 int force_multibyte
;
2264 /* Clear all the meaningless bits above the meta bit. */
2265 c
&= meta_modifier
| ~ - meta_modifier
;
2266 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2267 | meta_modifier
| shift_modifier
| super_modifier
);
2269 if (! CHARACTERP (make_number (c2
)))
2271 /* KEY_DESCRIPTION_SIZE is large enough for this. */
2272 p
+= sprintf (p
, "[%d]", c
);
2276 if (c
& alt_modifier
)
2282 if ((c
& ctrl_modifier
) != 0
2283 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2287 c
&= ~ctrl_modifier
;
2289 if (c
& hyper_modifier
)
2293 c
-= hyper_modifier
;
2295 if (c
& meta_modifier
)
2301 if (c
& shift_modifier
)
2305 c
-= shift_modifier
;
2307 if (c
& super_modifier
)
2311 c
-= super_modifier
;
2327 else if (c
== Ctl ('M'))
2335 /* `C-' already added above. */
2336 if (c
> 0 && c
<= Ctl ('Z'))
2355 || (NILP (current_buffer
->enable_multibyte_characters
)
2356 && SINGLE_BYTE_CHAR_P (c
)
2357 && !force_multibyte
))
2363 /* Now we are sure that C is a valid character code. */
2364 if (NILP (current_buffer
->enable_multibyte_characters
)
2365 && ! force_multibyte
)
2366 *p
++ = multibyte_char_to_unibyte (c
, Qnil
);
2368 p
+= CHAR_STRING (c
, (unsigned char *) p
);
2374 /* This function cannot GC. */
2376 DEFUN ("single-key-description", Fsingle_key_description
,
2377 Ssingle_key_description
, 1, 2, 0,
2378 doc
: /* Return a pretty description of command character KEY.
2379 Control characters turn into C-whatever, etc.
2380 Optional argument NO-ANGLES non-nil means don't put angle brackets
2381 around function keys and event symbols. */)
2383 Lisp_Object key
, no_angles
;
2385 if (CONSP (key
) && lucid_event_type_list_p (key
))
2386 key
= Fevent_convert_list (key
);
2388 key
= EVENT_HEAD (key
);
2390 if (INTEGERP (key
)) /* Normal character */
2392 char tem
[KEY_DESCRIPTION_SIZE
];
2394 *push_key_description (XUINT (key
), tem
, 1) = 0;
2395 return build_string (tem
);
2397 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2399 if (NILP (no_angles
))
2402 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2403 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2404 return build_string (buffer
);
2407 return Fsymbol_name (key
);
2409 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2410 return Fcopy_sequence (key
);
2412 error ("KEY must be an integer, cons, symbol, or string");
2417 push_text_char_description (c
, p
)
2418 register unsigned int c
;
2430 *p
++ = c
+ 64; /* 'A' - 1 */
2442 /* This function cannot GC. */
2444 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2445 doc
: /* Return a pretty description of file-character CHARACTER.
2446 Control characters turn into "^char", etc. This differs from
2447 `single-key-description' which turns them into "C-char".
2448 Also, this function recognizes the 2**7 bit as the Meta character,
2449 whereas `single-key-description' uses the 2**27 bit for Meta.
2450 See Info node `(elisp)Describing Characters' for examples. */)
2452 Lisp_Object character
;
2454 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2455 unsigned char str
[6];
2458 CHECK_NUMBER (character
);
2460 c
= XINT (character
);
2461 if (!ASCII_CHAR_P (c
))
2463 int len
= CHAR_STRING (c
, str
);
2465 return make_multibyte_string (str
, 1, len
);
2468 *push_text_char_description (c
& 0377, str
) = 0;
2470 return build_string (str
);
2473 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2476 ascii_sequence_p (seq
)
2480 int len
= XINT (Flength (seq
));
2482 for (i
= 0; i
< len
; i
++)
2484 Lisp_Object ii
, elt
;
2486 XSETFASTINT (ii
, i
);
2487 elt
= Faref (seq
, ii
);
2490 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2498 /* where-is - finding a command in a set of keymaps. */
2500 static Lisp_Object
where_is_internal ();
2501 static Lisp_Object
where_is_internal_1 ();
2502 static void where_is_internal_2 ();
2504 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2505 Returns the first non-nil binding found in any of those maps. */
2508 shadow_lookup (shadow
, key
, flag
)
2509 Lisp_Object shadow
, key
, flag
;
2511 Lisp_Object tail
, value
;
2513 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2515 value
= Flookup_key (XCAR (tail
), key
, flag
);
2516 if (NATNUMP (value
))
2518 value
= Flookup_key (XCAR (tail
),
2519 Fsubstring (key
, make_number (0), value
), flag
);
2523 else if (!NILP (value
))
2529 static Lisp_Object Vmouse_events
;
2531 /* This function can GC if Flookup_key autoloads any keymaps. */
2534 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2535 Lisp_Object definition
, keymaps
;
2536 Lisp_Object firstonly
, noindirect
, no_remap
;
2538 Lisp_Object maps
= Qnil
;
2539 Lisp_Object found
, sequences
;
2540 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2541 /* 1 means ignore all menu bindings entirely. */
2542 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2544 /* If this command is remapped, then it has no key bindings
2546 if (NILP (no_remap
) && SYMBOLP (definition
))
2549 if (tem
= Fcommand_remapping (definition
, Qnil
), !NILP (tem
))
2554 while (CONSP (found
))
2558 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2559 found
= XCDR (found
);
2562 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2566 for (; !NILP (maps
); maps
= Fcdr (maps
))
2568 /* Key sequence to reach map, and the map that it reaches */
2569 register Lisp_Object
this, map
, tem
;
2571 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2572 [M-CHAR] sequences, check if last character of the sequence
2573 is the meta-prefix char. */
2577 this = Fcar (Fcar (maps
));
2578 map
= Fcdr (Fcar (maps
));
2579 last
= make_number (XINT (Flength (this)) - 1);
2580 last_is_meta
= (XINT (last
) >= 0
2581 && EQ (Faref (this, last
), meta_prefix_char
));
2583 /* if (nomenus && !ascii_sequence_p (this)) */
2584 if (nomenus
&& XINT (last
) >= 0
2585 && SYMBOLP (tem
= Faref (this, make_number (0)))
2586 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2587 /* If no menu entries should be returned, skip over the
2588 keymaps bound to `menu-bar' and `tool-bar' and other
2589 non-ascii prefixes like `C-down-mouse-2'. */
2596 /* Because the code we want to run on each binding is rather
2597 large, we don't want to have two separate loop bodies for
2598 sparse keymap bindings and tables; we want to iterate one
2599 loop body over both keymap and vector bindings.
2601 For this reason, if Fcar (map) is a vector, we don't
2602 advance map to the next element until i indicates that we
2603 have finished off the vector. */
2604 Lisp_Object elt
, key
, binding
;
2612 /* Set key and binding to the current key and binding, and
2613 advance map and i to the next binding. */
2616 Lisp_Object sequence
;
2618 /* In a vector, look at each element. */
2619 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2621 binding
= AREF (elt
, i
);
2622 XSETFASTINT (key
, i
);
2623 sequence
= where_is_internal_1 (binding
, key
, definition
,
2625 last
, nomenus
, last_is_meta
);
2626 if (!NILP (sequence
))
2627 sequences
= Fcons (sequence
, sequences
);
2630 else if (CHAR_TABLE_P (elt
))
2634 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2635 Qnil
), /* Result accumulator. */
2636 Fcons (Fcons (this, last
),
2637 Fcons (make_number (nomenus
),
2638 make_number (last_is_meta
))));
2639 map_char_table (where_is_internal_2
, Qnil
, elt
, args
);
2640 sequences
= XCDR (XCAR (args
));
2642 else if (CONSP (elt
))
2644 Lisp_Object sequence
;
2647 binding
= XCDR (elt
);
2649 sequence
= where_is_internal_1 (binding
, key
, definition
,
2651 last
, nomenus
, last_is_meta
);
2652 if (!NILP (sequence
))
2653 sequences
= Fcons (sequence
, sequences
);
2657 while (!NILP (sequences
))
2659 Lisp_Object sequence
, remapped
, function
;
2661 sequence
= XCAR (sequences
);
2662 sequences
= XCDR (sequences
);
2664 /* If the current sequence is a command remapping with
2665 format [remap COMMAND], find the key sequences
2666 which run COMMAND, and use those sequences instead. */
2669 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2670 && EQ (AREF (sequence
, 0), Qremap
)
2671 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2673 Lisp_Object remapped1
;
2675 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2676 if (CONSP (remapped1
))
2678 /* Verify that this key binding actually maps to the
2679 remapped command (see below). */
2680 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2682 sequence
= XCAR (remapped1
);
2683 remapped
= XCDR (remapped1
);
2684 goto record_sequence
;
2688 /* Verify that this key binding is not shadowed by another
2689 binding for the same key, before we say it exists.
2691 Mechanism: look for local definition of this key and if
2692 it is defined and does not match what we found then
2695 Either nil or number as value from Flookup_key
2697 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2701 /* Don't annoy user with strings from a menu such as
2702 Select Paste. Change them all to "(any string)",
2703 so that there seems to be only one menu item
2705 if (! NILP (sequence
))
2708 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2710 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2711 build_string ("(any string)"));
2714 /* It is a true unshadowed match. Record it, unless it's already
2715 been seen (as could happen when inheriting keymaps). */
2716 if (NILP (Fmember (sequence
, found
)))
2717 found
= Fcons (sequence
, found
);
2719 /* If firstonly is Qnon_ascii, then we can return the first
2720 binding we find. If firstonly is not Qnon_ascii but not
2721 nil, then we should return the first ascii-only binding
2723 if (EQ (firstonly
, Qnon_ascii
))
2724 RETURN_UNGCPRO (sequence
);
2725 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2726 RETURN_UNGCPRO (sequence
);
2728 if (CONSP (remapped
))
2730 sequence
= XCAR (remapped
);
2731 remapped
= XCDR (remapped
);
2732 goto record_sequence
;
2740 found
= Fnreverse (found
);
2742 /* firstonly may have been t, but we may have gone all the way through
2743 the keymaps without finding an all-ASCII key sequence. So just
2744 return the best we could find. */
2745 if (!NILP (firstonly
))
2746 return Fcar (found
);
2751 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2752 doc
: /* Return list of keys that invoke DEFINITION.
2753 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2754 If KEYMAP is nil, search all the currently active keymaps.
2755 If KEYMAP is a list of keymaps, search only those keymaps.
2757 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2758 rather than a list of all possible key sequences.
2759 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2760 no matter what it is.
2761 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2762 \(or their meta variants) and entirely reject menu bindings.
2764 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2765 to other keymaps or slots. This makes it possible to search for an
2766 indirect definition itself.
2768 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2769 that invoke a command which is remapped to DEFINITION, but include the
2770 remapped command in the returned list. */)
2771 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2772 Lisp_Object definition
, keymap
;
2773 Lisp_Object firstonly
, noindirect
, no_remap
;
2775 Lisp_Object sequences
, keymaps
;
2776 /* 1 means ignore all menu bindings entirely. */
2777 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2780 /* Find the relevant keymaps. */
2781 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2783 else if (!NILP (keymap
))
2784 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2786 keymaps
= Fcurrent_active_maps (Qnil
);
2788 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2789 We don't really need to check `keymap'. */
2790 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2794 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2796 /* Check heuristic-consistency of the cache. */
2797 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2798 where_is_cache
= Qnil
;
2800 if (NILP (where_is_cache
))
2802 /* We need to create the cache. */
2803 Lisp_Object args
[2];
2804 where_is_cache
= Fmake_hash_table (0, args
);
2805 where_is_cache_keymaps
= Qt
;
2807 /* Fill in the cache. */
2808 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2809 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2812 where_is_cache_keymaps
= keymaps
;
2815 /* We want to process definitions from the last to the first.
2816 Instead of consing, copy definitions to a vector and step
2817 over that vector. */
2818 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2819 n
= XINT (Flength (sequences
));
2820 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2821 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2822 defns
[i
++] = XCAR (sequences
);
2824 /* Verify that the key bindings are not shadowed. Note that
2825 the following can GC. */
2826 GCPRO2 (definition
, keymaps
);
2829 for (i
= n
- 1; i
>= 0; --i
)
2830 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2832 if (ascii_sequence_p (defns
[i
]))
2838 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2843 /* Kill the cache so that where_is_internal_1 doesn't think
2844 we're filling it up. */
2845 where_is_cache
= Qnil
;
2846 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2852 /* This is the function that Fwhere_is_internal calls using map_char_table.
2854 (((DEFINITION . NOINDIRECT) . RESULT)
2856 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2857 Since map_char_table doesn't really use the return value from this function,
2858 we the result append to RESULT, the slot in ARGS.
2860 KEY may be a cons (FROM . TO) where both FROM and TO are integers
2861 (i.e. character events).
2863 This function can GC because it calls where_is_internal_1 which can
2867 where_is_internal_2 (args
, key
, binding
)
2868 Lisp_Object args
, key
, binding
;
2870 Lisp_Object definition
, noindirect
, this, last
;
2871 Lisp_Object result
, sequence
;
2872 int nomenus
, last_is_meta
;
2873 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2875 GCPRO3 (args
, key
, binding
);
2876 definition
= XCAR (XCAR (XCAR (args
)));
2877 noindirect
= XCDR (XCAR (XCAR (args
)));
2878 this = XCAR (XCAR (XCDR (args
)));
2879 last
= XCDR (XCAR (XCDR (args
)));
2880 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2881 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2884 if (CONSP (key
) && INTEGERP (XCAR (key
)) && INTEGERP (XCDR (key
)))
2886 /* Try all ASCII characters. Try also non-ASCII characters but
2887 only the first and last one because trying all of them is
2888 extremely memory and time consuming.
2890 Fixme: Perhaps it should be allowed to store a cons directly
2891 in RESULT. -- handa@m17n.org */
2892 int from
= XINT (XCAR (key
)), to
= XINT (XCDR (key
));
2895 for (; from
<= to
; to
--)
2897 k
= make_number (to
);
2898 sequence
= where_is_internal_1 (binding
, k
, definition
, noindirect
,
2899 this, last
, nomenus
, last_is_meta
);
2900 if (!NILP (sequence
))
2901 result
= Fcons (sequence
, result
);
2908 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2909 this, last
, nomenus
, last_is_meta
);
2910 if (!NILP (sequence
))
2911 result
= Fcons (sequence
, Qnil
);
2914 if (! NILP (result
))
2915 nconc2 (XCAR (args
), result
);
2921 /* This function can GC because get_keyelt can. */
2924 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2925 nomenus
, last_is_meta
)
2926 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2927 int nomenus
, last_is_meta
;
2929 Lisp_Object sequence
;
2931 /* Search through indirections unless that's not wanted. */
2932 if (NILP (noindirect
))
2933 binding
= get_keyelt (binding
, 0);
2935 /* End this iteration if this element does not match
2938 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2939 || EQ (binding
, definition
)
2940 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2941 /* Doesn't match. */
2944 /* We have found a match. Construct the key sequence where we found it. */
2945 if (INTEGERP (key
) && last_is_meta
)
2947 sequence
= Fcopy_sequence (this);
2948 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2951 sequence
= append_key (this, key
);
2953 if (!NILP (where_is_cache
))
2955 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2956 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2963 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2965 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2966 doc
: /* Insert the list of all defined keys and their definitions.
2967 The list is inserted in the current buffer, while the bindings are
2968 looked up in BUFFER.
2969 The optional argument PREFIX, if non-nil, should be a key sequence;
2970 then we display only bindings that start with that prefix.
2971 The optional argument MENUS, if non-nil, says to mention menu bindings.
2972 \(Ordinarily these are omitted from the output.) */)
2973 (buffer
, prefix
, menus
)
2974 Lisp_Object buffer
, prefix
, menus
;
2976 Lisp_Object outbuf
, shadow
;
2977 int nomenu
= NILP (menus
);
2978 register Lisp_Object start1
;
2979 struct gcpro gcpro1
;
2981 char *alternate_heading
2983 Keyboard translations:\n\n\
2984 You type Translation\n\
2985 -------- -----------\n";
2990 outbuf
= Fcurrent_buffer ();
2992 /* Report on alternates for keys. */
2993 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2996 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2997 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2999 for (c
= 0; c
< translate_len
; c
++)
3000 if (translate
[c
] != c
)
3002 char buf
[KEY_DESCRIPTION_SIZE
];
3005 if (alternate_heading
)
3007 insert_string (alternate_heading
);
3008 alternate_heading
= 0;
3011 bufend
= push_key_description (translate
[c
], buf
, 1);
3012 insert (buf
, bufend
- buf
);
3013 Findent_to (make_number (16), make_number (1));
3014 bufend
= push_key_description (c
, buf
, 1);
3015 insert (buf
, bufend
- buf
);
3019 /* Insert calls signal_after_change which may GC. */
3020 translate
= SDATA (Vkeyboard_translate_table
);
3026 if (!NILP (Vkey_translation_map
))
3027 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
3028 "Key translations", nomenu
, 1, 0, 0);
3031 /* Print the (major mode) local map. */
3033 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
3034 start1
= current_kboard
->Voverriding_terminal_local_map
;
3035 else if (!NILP (Voverriding_local_map
))
3036 start1
= Voverriding_local_map
;
3040 describe_map_tree (start1
, 1, shadow
, prefix
,
3041 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
3042 shadow
= Fcons (start1
, shadow
);
3046 /* Print the minor mode and major mode keymaps. */
3048 Lisp_Object
*modes
, *maps
;
3050 /* Temporarily switch to `buffer', so that we can get that buffer's
3051 minor modes correctly. */
3052 Fset_buffer (buffer
);
3054 nmaps
= current_minor_maps (&modes
, &maps
);
3055 Fset_buffer (outbuf
);
3057 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3058 XBUFFER (buffer
), Qkeymap
);
3061 describe_map_tree (start1
, 1, shadow
, prefix
,
3062 "\f\n`keymap' Property Bindings", nomenu
,
3064 shadow
= Fcons (start1
, shadow
);
3067 /* Print the minor mode maps. */
3068 for (i
= 0; i
< nmaps
; i
++)
3070 /* The title for a minor mode keymap
3071 is constructed at run time.
3072 We let describe_map_tree do the actual insertion
3073 because it takes care of other features when doing so. */
3076 if (!SYMBOLP (modes
[i
]))
3079 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
3083 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
3084 SCHARS (SYMBOL_NAME (modes
[i
])));
3085 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
3087 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
3088 p
+= sizeof (" Minor Mode Bindings") - 1;
3091 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
3092 title
, nomenu
, 0, 0, 0);
3093 shadow
= Fcons (maps
[i
], shadow
);
3096 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3097 XBUFFER (buffer
), Qlocal_map
);
3100 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
3101 describe_map_tree (start1
, 1, shadow
, prefix
,
3102 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
3104 describe_map_tree (start1
, 1, shadow
, prefix
,
3105 "\f\n`local-map' Property Bindings",
3108 shadow
= Fcons (start1
, shadow
);
3112 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
3113 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
3115 /* Print the function-key-map translations under this prefix. */
3116 if (!NILP (Vfunction_key_map
))
3117 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
3118 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
3124 /* Insert a description of the key bindings in STARTMAP,
3125 followed by those of all maps reachable through STARTMAP.
3126 If PARTIAL is nonzero, omit certain "uninteresting" commands
3127 (such as `undefined').
3128 If SHADOW is non-nil, it is a list of maps;
3129 don't mention keys which would be shadowed by any of them.
3130 PREFIX, if non-nil, says mention only keys that start with PREFIX.
3131 TITLE, if not 0, is a string to insert at the beginning.
3132 TITLE should not end with a colon or a newline; we supply that.
3133 If NOMENU is not 0, then omit menu-bar commands.
3135 If TRANSL is nonzero, the definitions are actually key translations
3136 so print strings and vectors differently.
3138 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
3141 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
3142 don't omit it; instead, mention it but say it is shadowed. */
3145 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
3146 always_title
, mention_shadow
)
3147 Lisp_Object startmap
, shadow
, prefix
;
3155 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
3156 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3163 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3166 GCPRO3 (maps
, seen
, sub_shadows
);
3172 /* Delete from MAPS each element that is for the menu bar. */
3173 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3175 Lisp_Object elt
, prefix
, tem
;
3178 prefix
= Fcar (elt
);
3179 if (XVECTOR (prefix
)->size
>= 1)
3181 tem
= Faref (prefix
, make_number (0));
3182 if (EQ (tem
, Qmenu_bar
))
3183 maps
= Fdelq (elt
, maps
);
3188 if (!NILP (maps
) || always_title
)
3192 insert_string (title
);
3195 insert_string (" Starting With ");
3196 insert1 (Fkey_description (prefix
, Qnil
));
3198 insert_string (":\n");
3200 insert_string (key_heading
);
3204 for (; !NILP (maps
); maps
= Fcdr (maps
))
3206 register Lisp_Object elt
, prefix
, tail
;
3209 prefix
= Fcar (elt
);
3213 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3217 shmap
= XCAR (tail
);
3219 /* If the sequence by which we reach this keymap is zero-length,
3220 then the shadow map for this keymap is just SHADOW. */
3221 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3222 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3224 /* If the sequence by which we reach this keymap actually has
3225 some elements, then the sequence's definition in SHADOW is
3226 what we should use. */
3229 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3230 if (INTEGERP (shmap
))
3234 /* If shmap is not nil and not a keymap,
3235 it completely shadows this map, so don't
3236 describe this map at all. */
3237 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3241 sub_shadows
= Fcons (shmap
, sub_shadows
);
3244 /* Maps we have already listed in this loop shadow this map. */
3245 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3248 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3250 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3253 describe_map (Fcdr (elt
), prefix
,
3254 transl
? describe_translation
: describe_command
,
3255 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3261 insert_string ("\n");
3266 static int previous_description_column
;
3269 describe_command (definition
, args
)
3270 Lisp_Object definition
, args
;
3272 register Lisp_Object tem1
;
3273 int column
= (int) current_column (); /* iftc */
3274 int description_column
;
3276 /* If column 16 is no good, go to col 32;
3277 but don't push beyond that--go to next line instead. */
3281 description_column
= 32;
3283 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3284 description_column
= 32;
3286 description_column
= 16;
3288 Findent_to (make_number (description_column
), make_number (1));
3289 previous_description_column
= description_column
;
3291 if (SYMBOLP (definition
))
3293 tem1
= SYMBOL_NAME (definition
);
3295 insert_string ("\n");
3297 else if (STRINGP (definition
) || VECTORP (definition
))
3298 insert_string ("Keyboard Macro\n");
3299 else if (KEYMAPP (definition
))
3300 insert_string ("Prefix Command\n");
3302 insert_string ("??\n");
3306 describe_translation (definition
, args
)
3307 Lisp_Object definition
, args
;
3309 register Lisp_Object tem1
;
3311 Findent_to (make_number (16), make_number (1));
3313 if (SYMBOLP (definition
))
3315 tem1
= SYMBOL_NAME (definition
);
3317 insert_string ("\n");
3319 else if (STRINGP (definition
) || VECTORP (definition
))
3321 insert1 (Fkey_description (definition
, Qnil
));
3322 insert_string ("\n");
3324 else if (KEYMAPP (definition
))
3325 insert_string ("Prefix Command\n");
3327 insert_string ("??\n");
3330 /* describe_map puts all the usable elements of a sparse keymap
3331 into an array of `struct describe_map_elt',
3332 then sorts them by the events. */
3334 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3336 /* qsort comparison function for sorting `struct describe_map_elt' by
3340 describe_map_compare (aa
, bb
)
3341 const void *aa
, *bb
;
3343 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3344 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3345 return ((XINT (a
->event
) > XINT (b
->event
))
3346 - (XINT (a
->event
) < XINT (b
->event
)));
3347 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3349 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3351 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3352 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3353 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3358 /* Describe the contents of map MAP, assuming that this map itself is
3359 reached by the sequence of prefix keys PREFIX (a string or vector).
3360 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3363 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3364 seen
, nomenu
, mention_shadow
)
3365 register Lisp_Object map
;
3367 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3374 Lisp_Object tail
, definition
, event
;
3376 Lisp_Object suppress
;
3379 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3381 /* These accumulate the values from sparse keymap bindings,
3382 so we can sort them and handle them in order. */
3383 int length_needed
= 0;
3384 struct describe_map_elt
*vect
;
3391 suppress
= intern ("suppress-keymap");
3393 /* This vector gets used to present single keys to Flookup_key. Since
3394 that is done once per keymap element, we don't want to cons up a
3395 fresh vector every time. */
3396 kludge
= Fmake_vector (make_number (1), Qnil
);
3399 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3402 vect
= ((struct describe_map_elt
*)
3403 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3405 GCPRO3 (prefix
, definition
, kludge
);
3407 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3411 if (VECTORP (XCAR (tail
))
3412 || CHAR_TABLE_P (XCAR (tail
)))
3413 describe_vector (XCAR (tail
),
3414 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3415 (int *)0, 0, 1, mention_shadow
);
3416 else if (CONSP (XCAR (tail
)))
3418 int this_shadowed
= 0;
3420 event
= XCAR (XCAR (tail
));
3422 /* Ignore bindings whose "prefix" are not really valid events.
3423 (We get these in the frames and buffers menu.) */
3424 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3427 if (nomenu
&& EQ (event
, Qmenu_bar
))
3430 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3432 /* Don't show undefined commands or suppressed commands. */
3433 if (NILP (definition
)) continue;
3434 if (SYMBOLP (definition
) && partial
)
3436 tem
= Fget (definition
, suppress
);
3441 /* Don't show a command that isn't really visible
3442 because a local definition of the same key shadows it. */
3444 ASET (kludge
, 0, event
);
3447 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3450 /* Avoid generating duplicate entries if the
3451 shadowed binding has the same definition. */
3452 if (mention_shadow
&& !EQ (tem
, definition
))
3459 tem
= Flookup_key (map
, kludge
, Qt
);
3460 if (!EQ (tem
, definition
)) continue;
3462 vect
[slots_used
].event
= event
;
3463 vect
[slots_used
].definition
= definition
;
3464 vect
[slots_used
].shadowed
= this_shadowed
;
3467 else if (EQ (XCAR (tail
), Qkeymap
))
3469 /* The same keymap might be in the structure twice, if we're
3470 using an inherited keymap. So skip anything we've already
3472 tem
= Fassq (tail
, *seen
);
3473 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3475 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3479 /* If we found some sparse map events, sort them. */
3481 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3482 describe_map_compare
);
3484 /* Now output them in sorted order. */
3486 for (i
= 0; i
< slots_used
; i
++)
3488 Lisp_Object start
, end
;
3492 previous_description_column
= 0;
3497 ASET (kludge
, 0, vect
[i
].event
);
3498 start
= vect
[i
].event
;
3501 definition
= vect
[i
].definition
;
3503 /* Find consecutive chars that are identically defined. */
3504 if (INTEGERP (vect
[i
].event
))
3506 while (i
+ 1 < slots_used
3507 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3508 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3509 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3511 end
= vect
[i
].event
;
3514 /* Now START .. END is the range to describe next. */
3516 /* Insert the string to describe the event START. */
3517 insert1 (Fkey_description (kludge
, prefix
));
3519 if (!EQ (start
, end
))
3523 ASET (kludge
, 0, end
);
3524 /* Insert the string to describe the character END. */
3525 insert1 (Fkey_description (kludge
, prefix
));
3528 /* Print a description of the definition of this character.
3529 elt_describer will take care of spacing out far enough
3530 for alignment purposes. */
3531 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3533 if (vect
[i
].shadowed
)
3536 insert_string ("\n (that binding is currently shadowed by another mode)");
3545 describe_vector_princ (elt
, fun
)
3546 Lisp_Object elt
, fun
;
3548 Findent_to (make_number (16), make_number (1));
3553 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3554 doc
: /* Insert a description of contents of VECTOR.
3555 This is text showing the elements of vector matched against indices.
3556 DESCRIBER is the output function used; nil means use `princ'. */)
3558 Lisp_Object vector
, describer
;
3560 int count
= SPECPDL_INDEX ();
3561 if (NILP (describer
))
3562 describer
= intern ("princ");
3563 specbind (Qstandard_output
, Fcurrent_buffer ());
3564 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3565 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3566 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3568 return unbind_to (count
, Qnil
);
3571 /* Insert in the current buffer a description of the contents of VECTOR.
3572 We call ELT_DESCRIBER to insert the description of one value found
3575 ELT_PREFIX describes what "comes before" the keys or indices defined
3576 by this vector. This is a human-readable string whose size
3577 is not necessarily related to the situation.
3579 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3580 leads to this keymap.
3582 If the vector is a chartable, ELT_PREFIX is the vector
3583 of bytes that lead to the character set or portion of a character
3584 set described by this chartable.
3586 If PARTIAL is nonzero, it means do not mention suppressed commands
3587 (that assumes the vector is in a keymap).
3589 SHADOW is a list of keymaps that shadow this map.
3590 If it is non-nil, then we look up the key in those maps
3591 and we don't mention it now if it is defined by any of them.
3593 ENTIRE_MAP is the keymap in which this vector appears.
3594 If the definition in effect in the whole map does not match
3595 the one in this vector, we ignore this one.
3597 ARGS is simply passed as the second argument to ELT_DESCRIBER.
3599 INDICES and CHAR_TABLE_DEPTH are ignored. They will be removed in
3602 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3604 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3607 describe_vector (vector
, prefix
, args
, elt_describer
,
3608 partial
, shadow
, entire_map
,
3609 indices
, char_table_depth
, keymap_p
,
3611 register Lisp_Object vector
;
3612 Lisp_Object prefix
, args
;
3613 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3616 Lisp_Object entire_map
;
3618 int char_table_depth
;
3622 Lisp_Object definition
;
3624 Lisp_Object elt_prefix
= Qnil
;
3626 Lisp_Object suppress
;
3629 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3630 /* Range of elements to be handled. */
3632 Lisp_Object character
;
3641 /* Call Fkey_description first, to avoid GC bug for the other string. */
3642 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3645 tem
= Fkey_description (prefix
, Qnil
);
3646 elt_prefix
= concat2 (tem
, build_string (" "));
3651 /* This vector gets used to present single keys to Flookup_key. Since
3652 that is done once per vector element, we don't want to cons up a
3653 fresh vector every time. */
3654 kludge
= Fmake_vector (make_number (1), Qnil
);
3655 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3658 suppress
= intern ("suppress-keymap");
3661 to
= CHAR_TABLE_P (vector
) ? MAX_CHAR
+ 1 : XVECTOR (vector
)->size
;
3663 for (i
= from
; i
< to
; i
++)
3665 int this_shadowed
= 0;
3666 int range_beg
, range_end
;
3673 if (CHAR_TABLE_P (vector
))
3674 val
= char_table_ref_and_range (vector
, i
, &range_beg
, &i
);
3676 val
= AREF (vector
, i
);
3677 definition
= get_keyelt (val
, 0);
3679 if (NILP (definition
)) continue;
3681 /* Don't mention suppressed commands. */
3682 if (SYMBOLP (definition
) && partial
)
3686 tem
= Fget (definition
, suppress
);
3688 if (!NILP (tem
)) continue;
3691 character
= make_number (starting_i
);
3692 ASET (kludge
, 0, character
);
3694 /* If this binding is shadowed by some other map, ignore it. */
3699 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3710 /* Ignore this definition if it is shadowed by an earlier
3711 one in the same keymap. */
3712 if (!NILP (entire_map
))
3716 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3718 if (!EQ (tem
, definition
))
3728 /* Output the prefix that applies to every entry in this map. */
3729 if (!NILP (elt_prefix
))
3730 insert1 (elt_prefix
);
3732 insert1 (Fkey_description (kludge
, prefix
));
3734 /* Find all consecutive characters or rows that have the same
3735 definition. But, for elements of a top level char table, if
3736 they are for charsets, we had better describe one by one even
3737 if they have the same definition. */
3738 if (CHAR_TABLE_P (vector
))
3740 && (val
= char_table_ref_and_range (vector
, i
+ 1,
3741 &range_beg
, &range_end
),
3742 tem2
= get_keyelt (val
, 0),
3744 && !NILP (Fequal (tem2
, definition
)))
3748 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3750 && !NILP (Fequal (tem2
, definition
)))
3753 /* If we have a range of more than one character,
3754 print where the range reaches to. */
3756 if (i
!= starting_i
)
3760 ASET (kludge
, 0, make_number (i
));
3762 if (!NILP (elt_prefix
))
3763 insert1 (elt_prefix
);
3765 insert1 (Fkey_description (kludge
, prefix
));
3768 /* Print a description of the definition of this character.
3769 elt_describer will take care of spacing out far enough
3770 for alignment purposes. */
3771 (*elt_describer
) (definition
, args
);
3776 insert_string (" (binding currently shadowed)");
3781 if (CHAR_TABLE_P (vector
) && ! NILP (XCHAR_TABLE (vector
)->defalt
))
3783 if (!NILP (elt_prefix
))
3784 insert1 (elt_prefix
);
3785 insert ("default", 7);
3786 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3792 /* Apropos - finding all symbols whose names match a regexp. */
3793 static Lisp_Object apropos_predicate
;
3794 static Lisp_Object apropos_accumulate
;
3797 apropos_accum (symbol
, string
)
3798 Lisp_Object symbol
, string
;
3800 register Lisp_Object tem
;
3802 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3803 if (!NILP (tem
) && !NILP (apropos_predicate
))
3804 tem
= call1 (apropos_predicate
, symbol
);
3806 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3809 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3810 doc
: /* Show all symbols whose names contain match for REGEXP.
3811 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3812 for each symbol and a symbol is mentioned only if that returns non-nil.
3813 Return list of symbols found. */)
3815 Lisp_Object regexp
, predicate
;
3818 CHECK_STRING (regexp
);
3819 apropos_predicate
= predicate
;
3820 apropos_accumulate
= Qnil
;
3821 map_obarray (Vobarray
, apropos_accum
, regexp
);
3822 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3823 apropos_accumulate
= Qnil
;
3824 apropos_predicate
= Qnil
;
3831 Qkeymap
= intern ("keymap");
3832 staticpro (&Qkeymap
);
3833 staticpro (&apropos_predicate
);
3834 staticpro (&apropos_accumulate
);
3835 apropos_predicate
= Qnil
;
3836 apropos_accumulate
= Qnil
;
3838 /* Now we are ready to set up this property, so we can
3839 create char tables. */
3840 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3842 /* Initialize the keymaps standardly used.
3843 Each one is the value of a Lisp variable, and is also
3844 pointed to by a C variable */
3846 global_map
= Fmake_keymap (Qnil
);
3847 Fset (intern ("global-map"), global_map
);
3849 current_global_map
= global_map
;
3850 staticpro (&global_map
);
3851 staticpro (¤t_global_map
);
3853 meta_map
= Fmake_keymap (Qnil
);
3854 Fset (intern ("esc-map"), meta_map
);
3855 Ffset (intern ("ESC-prefix"), meta_map
);
3857 control_x_map
= Fmake_keymap (Qnil
);
3858 Fset (intern ("ctl-x-map"), control_x_map
);
3859 Ffset (intern ("Control-X-prefix"), control_x_map
);
3862 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3863 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3864 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3865 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3866 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3868 staticpro (&exclude_keys
);
3870 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3871 doc
: /* List of commands given new key bindings recently.
3872 This is used for internal purposes during Emacs startup;
3873 don't alter it yourself. */);
3874 Vdefine_key_rebound_commands
= Qt
;
3876 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3877 doc
: /* Default keymap to use when reading from the minibuffer. */);
3878 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3880 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3881 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3882 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3883 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3885 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3886 doc
: /* Local keymap for minibuffer input with completion. */);
3887 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3888 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3890 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3891 &Vminibuffer_local_filename_completion_map
,
3892 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3893 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3894 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3895 Vminibuffer_local_completion_map
);
3898 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3899 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3900 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3901 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3902 Vminibuffer_local_completion_map
);
3904 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3905 &Vminibuffer_local_must_match_filename_map
,
3906 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3907 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3908 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3909 Vminibuffer_local_must_match_map
);
3911 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3912 doc
: /* Alist of keymaps to use for minor modes.
3913 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3914 key sequences and look up bindings iff VARIABLE's value is non-nil.
3915 If two active keymaps bind the same key, the keymap appearing earlier
3916 in the list takes precedence. */);
3917 Vminor_mode_map_alist
= Qnil
;
3919 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3920 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3921 This variable is an alist just like `minor-mode-map-alist', and it is
3922 used the same way (and before `minor-mode-map-alist'); however,
3923 it is provided for major modes to bind locally. */);
3924 Vminor_mode_overriding_map_alist
= Qnil
;
3926 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3927 doc
: /* List of keymap alists to use for emulations modes.
3928 It is intended for modes or packages using multiple minor-mode keymaps.
3929 Each element is a keymap alist just like `minor-mode-map-alist', or a
3930 symbol with a variable binding which is a keymap alist, and it is used
3931 the same way. The "active" keymaps in each alist are used before
3932 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3933 Vemulation_mode_map_alists
= Qnil
;
3936 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3937 doc
: /* Keymap that translates key sequences to key sequences during input.
3938 This is used mainly for mapping ASCII function key sequences into
3939 real Emacs function key events (symbols).
3941 The `read-key-sequence' function replaces any subsequence bound by
3942 `function-key-map' with its binding. More precisely, when the active
3943 keymaps have no binding for the current key sequence but
3944 `function-key-map' binds a suffix of the sequence to a vector or string,
3945 `read-key-sequence' replaces the matching suffix with its binding, and
3946 continues with the new sequence.
3948 If the binding is a function, it is called with one argument (the prompt)
3949 and its return value (a key sequence) is used.
3951 The events that come from bindings in `function-key-map' are not
3952 themselves looked up in `function-key-map'.
3954 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3955 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3956 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3957 key, typing `ESC O P x' would return [f1 x]. */);
3958 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3960 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3961 doc
: /* Keymap of key translations that can override keymaps.
3962 This keymap works like `function-key-map', but comes after that,
3963 and its non-prefix bindings override ordinary bindings. */);
3964 Vkey_translation_map
= Qnil
;
3966 staticpro (&Vmouse_events
);
3967 Vmouse_events
= Fcons (intern ("menu-bar"),
3968 Fcons (intern ("tool-bar"),
3969 Fcons (intern ("header-line"),
3970 Fcons (intern ("mode-line"),
3971 Fcons (intern ("mouse-1"),
3972 Fcons (intern ("mouse-2"),
3973 Fcons (intern ("mouse-3"),
3974 Fcons (intern ("mouse-4"),
3975 Fcons (intern ("mouse-5"),
3979 Qsingle_key_description
= intern ("single-key-description");
3980 staticpro (&Qsingle_key_description
);
3982 Qkey_description
= intern ("key-description");
3983 staticpro (&Qkey_description
);
3985 Qkeymapp
= intern ("keymapp");
3986 staticpro (&Qkeymapp
);
3988 Qnon_ascii
= intern ("non-ascii");
3989 staticpro (&Qnon_ascii
);
3991 Qmenu_item
= intern ("menu-item");
3992 staticpro (&Qmenu_item
);
3994 Qremap
= intern ("remap");
3995 staticpro (&Qremap
);
3997 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3998 staticpro (&command_remapping_vector
);
4000 where_is_cache_keymaps
= Qt
;
4001 where_is_cache
= Qnil
;
4002 staticpro (&where_is_cache
);
4003 staticpro (&where_is_cache_keymaps
);
4005 defsubr (&Skeymapp
);
4006 defsubr (&Skeymap_parent
);
4007 defsubr (&Skeymap_prompt
);
4008 defsubr (&Sset_keymap_parent
);
4009 defsubr (&Smake_keymap
);
4010 defsubr (&Smake_sparse_keymap
);
4011 defsubr (&Smap_keymap
);
4012 defsubr (&Scopy_keymap
);
4013 defsubr (&Scommand_remapping
);
4014 defsubr (&Skey_binding
);
4015 defsubr (&Slocal_key_binding
);
4016 defsubr (&Sglobal_key_binding
);
4017 defsubr (&Sminor_mode_key_binding
);
4018 defsubr (&Sdefine_key
);
4019 defsubr (&Slookup_key
);
4020 defsubr (&Sdefine_prefix_command
);
4021 defsubr (&Suse_global_map
);
4022 defsubr (&Suse_local_map
);
4023 defsubr (&Scurrent_local_map
);
4024 defsubr (&Scurrent_global_map
);
4025 defsubr (&Scurrent_minor_mode_maps
);
4026 defsubr (&Scurrent_active_maps
);
4027 defsubr (&Saccessible_keymaps
);
4028 defsubr (&Skey_description
);
4029 defsubr (&Sdescribe_vector
);
4030 defsubr (&Ssingle_key_description
);
4031 defsubr (&Stext_char_description
);
4032 defsubr (&Swhere_is_internal
);
4033 defsubr (&Sdescribe_buffer_bindings
);
4034 defsubr (&Sapropos_internal
);
4040 initial_define_key (global_map
, 033, "ESC-prefix");
4041 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
4044 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
4045 (do not change this comment) */