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. */
31 #include "termhooks.h"
32 #include "blockinput.h"
34 #include "intervals.h"
37 /* The number of elements in keymap vectors. */
38 #define DENSE_TABLE_SIZE (0200)
40 /* Actually allocate storage for these variables */
42 Lisp_Object current_global_map
; /* Current global keymap */
44 Lisp_Object global_map
; /* default global key bindings */
46 Lisp_Object meta_map
; /* The keymap used for globally bound
47 ESC-prefixed default commands */
49 Lisp_Object control_x_map
; /* The keymap used for globally bound
50 C-x-prefixed default commands */
52 /* was MinibufLocalMap */
53 Lisp_Object Vminibuffer_local_map
;
54 /* The keymap used by the minibuf for local
55 bindings when spaces are allowed in the
58 /* was MinibufLocalNSMap */
59 Lisp_Object Vminibuffer_local_ns_map
;
60 /* The keymap used by the minibuf for local
61 bindings when spaces are not encouraged
64 /* keymap used for minibuffers when doing completion */
65 /* was MinibufLocalCompletionMap */
66 Lisp_Object Vminibuffer_local_completion_map
;
68 /* keymap used for minibuffers when doing completion in filenames */
69 Lisp_Object Vminibuffer_local_filename_completion_map
;
71 /* keymap used for minibuffers when doing completion in filenames
73 Lisp_Object Vminibuffer_local_must_match_filename_map
;
75 /* keymap used for minibuffers when doing completion and require a match */
76 /* was MinibufLocalMustMatchMap */
77 Lisp_Object Vminibuffer_local_must_match_map
;
79 /* Alist of minor mode variables and keymaps. */
80 Lisp_Object Vminor_mode_map_alist
;
82 /* Alist of major-mode-specific overrides for
83 minor mode variables and keymaps. */
84 Lisp_Object Vminor_mode_overriding_map_alist
;
86 /* List of emulation mode keymap alists. */
87 Lisp_Object Vemulation_mode_map_alists
;
89 /* Keymap mapping ASCII function key sequences onto their preferred forms.
90 Initialized by the terminal-specific lisp files. See DEFVAR for more
92 Lisp_Object Vfunction_key_map
;
94 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
95 Lisp_Object Vkey_translation_map
;
97 /* A list of all commands given new bindings since a certain time
98 when nil was stored here.
99 This is used to speed up recomputation of menu key equivalents
100 when Emacs starts up. t means don't record anything here. */
101 Lisp_Object Vdefine_key_rebound_commands
;
103 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
105 /* Alist of elements like (DEL . "\d"). */
106 static Lisp_Object exclude_keys
;
108 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
109 static Lisp_Object command_remapping_vector
;
111 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
112 in a string key sequence is equivalent to prefixing with this
114 extern Lisp_Object meta_prefix_char
;
116 extern Lisp_Object Voverriding_local_map
;
118 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
119 static Lisp_Object where_is_cache
;
120 /* Which keymaps are reverse-stored in the cache. */
121 static Lisp_Object where_is_cache_keymaps
;
123 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
124 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
126 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
127 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
128 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
129 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
130 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
131 int, Lisp_Object
, Lisp_Object
*, int, int));
132 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
133 void (*) (Lisp_Object
, Lisp_Object
), int,
134 Lisp_Object
, Lisp_Object
, int *,
136 static void silly_event_symbol_error
P_ ((Lisp_Object
));
138 /* Keymap object support - constructors and predicates. */
140 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
141 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
142 CHARTABLE is a char-table that holds the bindings for all characters
143 without modifiers. All entries in it are initially nil, meaning
144 "command undefined". ALIST is an assoc-list which holds bindings for
145 function keys, mouse events, and any other things that appear in the
146 input stream. Initially, ALIST is nil.
148 The optional arg STRING supplies a menu name for the keymap
149 in case you use it as a menu with `x-popup-menu'. */)
155 tail
= Fcons (string
, Qnil
);
158 return Fcons (Qkeymap
,
159 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
162 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
163 doc
: /* Construct and return a new sparse keymap.
164 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
165 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
166 which binds the function key or mouse event SYMBOL to DEFINITION.
167 Initially the alist is nil.
169 The optional arg STRING supplies a menu name for the keymap
170 in case you use it as a menu with `x-popup-menu'. */)
175 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
176 return Fcons (Qkeymap
, Qnil
);
179 /* This function is used for installing the standard key bindings
180 at initialization time.
184 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
187 initial_define_key (keymap
, key
, defname
)
192 store_in_keymap (keymap
, make_number (key
), intern (defname
));
196 initial_define_lispy_key (keymap
, keyname
, defname
)
201 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
204 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
205 doc
: /* Return t if OBJECT is a keymap.
207 A keymap is a list (keymap . ALIST),
208 or a symbol whose function definition is itself a keymap.
209 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
210 a vector of densely packed bindings for small character codes
211 is also allowed as an element. */)
215 return (KEYMAPP (object
) ? Qt
: Qnil
);
218 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
219 doc
: /* Return the prompt-string of a keymap MAP.
220 If non-nil, the prompt is shown in the echo-area
221 when reading a key-sequence to be looked-up in this keymap. */)
225 map
= get_keymap (map
, 0, 0);
228 Lisp_Object tem
= XCAR (map
);
236 /* Check that OBJECT is a keymap (after dereferencing through any
237 symbols). If it is, return it.
239 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
240 is an autoload form, do the autoload and try again.
241 If AUTOLOAD is nonzero, callers must assume GC is possible.
243 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
244 is zero as well), return Qt.
246 ERROR controls how we respond if OBJECT isn't a keymap.
247 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
249 Note that most of the time, we don't want to pursue autoloads.
250 Functions like Faccessible_keymaps which scan entire keymap trees
251 shouldn't load every autoloaded keymap. I'm not sure about this,
252 but it seems to me that only read_key_sequence, Flookup_key, and
253 Fdefine_key should cause keymaps to be autoloaded.
255 This function can GC when AUTOLOAD is non-zero, because it calls
256 do_autoload which can GC. */
259 get_keymap (object
, error
, autoload
)
268 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
271 tem
= indirect_function (object
);
274 if (EQ (XCAR (tem
), Qkeymap
))
277 /* Should we do an autoload? Autoload forms for keymaps have
278 Qkeymap as their fifth element. */
279 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
)
284 tail
= Fnth (make_number (4), tem
);
285 if (EQ (tail
, Qkeymap
))
289 struct gcpro gcpro1
, gcpro2
;
291 GCPRO2 (tem
, object
);
292 do_autoload (tem
, object
);
305 wrong_type_argument (Qkeymapp
, object
);
309 /* Return the parent map of KEYMAP, or nil if it has none.
310 We assume that KEYMAP is a valid keymap. */
313 keymap_parent (keymap
, autoload
)
319 keymap
= get_keymap (keymap
, 1, autoload
);
321 /* Skip past the initial element `keymap'. */
322 list
= XCDR (keymap
);
323 for (; CONSP (list
); list
= XCDR (list
))
325 /* See if there is another `keymap'. */
330 return get_keymap (list
, 0, autoload
);
333 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
334 doc
: /* Return the parent keymap of KEYMAP. */)
338 return keymap_parent (keymap
, 1);
341 /* Check whether MAP is one of MAPS parents. */
343 keymap_memberp (map
, maps
)
344 Lisp_Object map
, maps
;
346 if (NILP (map
)) return 0;
347 while (KEYMAPP (maps
) && !EQ (map
, maps
))
348 maps
= keymap_parent (maps
, 0);
349 return (EQ (map
, maps
));
352 /* Set the parent keymap of MAP to PARENT. */
354 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
355 doc
: /* Modify KEYMAP to set its parent map to PARENT.
356 Return PARENT. PARENT should be nil or another keymap. */)
358 Lisp_Object keymap
, parent
;
360 Lisp_Object list
, prev
;
361 struct gcpro gcpro1
, gcpro2
;
364 /* Force a keymap flush for the next call to where-is.
365 Since this can be called from within where-is, we don't set where_is_cache
366 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
367 be changed during where-is, while where_is_cache_keymaps is only used at
368 the very beginning of where-is and can thus be changed here without any
370 This is a very minor correctness (rather than safety) issue. */
371 where_is_cache_keymaps
= Qt
;
373 GCPRO2 (keymap
, parent
);
374 keymap
= get_keymap (keymap
, 1, 1);
378 parent
= get_keymap (parent
, 1, 1);
380 /* Check for cycles. */
381 if (keymap_memberp (keymap
, parent
))
382 error ("Cyclic keymap inheritance");
385 /* Skip past the initial element `keymap'. */
390 /* If there is a parent keymap here, replace it.
391 If we came to the end, add the parent in PREV. */
392 if (!CONSP (list
) || KEYMAPP (list
))
394 /* If we already have the right parent, return now
395 so that we avoid the loops below. */
396 if (EQ (XCDR (prev
), parent
))
397 RETURN_UNGCPRO (parent
);
400 XSETCDR (prev
, parent
);
406 /* Scan through for submaps, and set their parents too. */
408 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
410 /* Stop the scan when we come to the parent. */
411 if (EQ (XCAR (list
), Qkeymap
))
414 /* If this element holds a prefix map, deal with it. */
415 if (CONSP (XCAR (list
))
416 && CONSP (XCDR (XCAR (list
))))
417 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
420 if (VECTORP (XCAR (list
)))
421 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
422 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
423 fix_submap_inheritance (keymap
, make_number (i
),
424 XVECTOR (XCAR (list
))->contents
[i
]);
426 if (CHAR_TABLE_P (XCAR (list
)))
428 Lisp_Object indices
[3];
430 map_char_table (fix_submap_inheritance
, Qnil
,
431 XCAR (list
), XCAR (list
),
436 RETURN_UNGCPRO (parent
);
439 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
440 if EVENT is also a prefix in MAP's parent,
441 make sure that SUBMAP inherits that definition as its own parent. */
444 fix_submap_inheritance (map
, event
, submap
)
445 Lisp_Object map
, event
, submap
;
447 Lisp_Object map_parent
, parent_entry
;
449 /* SUBMAP is a cons that we found as a key binding.
450 Discard the other things found in a menu key binding. */
452 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
454 /* If it isn't a keymap now, there's no work to do. */
458 map_parent
= keymap_parent (map
, 0);
459 if (!NILP (map_parent
))
461 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
465 /* If MAP's parent has something other than a keymap,
466 our own submap shadows it completely. */
467 if (!CONSP (parent_entry
))
470 if (! EQ (parent_entry
, submap
))
472 Lisp_Object submap_parent
;
473 submap_parent
= submap
;
478 tem
= keymap_parent (submap_parent
, 0);
482 if (keymap_memberp (tem
, parent_entry
))
483 /* Fset_keymap_parent could create a cycle. */
490 Fset_keymap_parent (submap_parent
, parent_entry
);
494 /* Look up IDX in MAP. IDX may be any sort of event.
495 Note that this does only one level of lookup; IDX must be a single
496 event, not a sequence.
498 If T_OK is non-zero, bindings for Qt are treated as default
499 bindings; any key left unmentioned by other tables and bindings is
500 given the binding of Qt.
502 If T_OK is zero, bindings for Qt are not treated specially.
504 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
507 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
516 /* Qunbound in VAL means we have found no binding yet. */
519 /* If idx is a list (some sort of mouse click, perhaps?),
520 the index we want to use is the car of the list, which
521 ought to be a symbol. */
522 idx
= EVENT_HEAD (idx
);
524 /* If idx is a symbol, it might have modifiers, which need to
525 be put in the canonical order. */
527 idx
= reorder_modifiers (idx
);
528 else if (INTEGERP (idx
))
529 /* Clobber the high bits that can be present on a machine
530 with more than 24 bits of integer. */
531 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
533 /* Handle the special meta -> esc mapping. */
534 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
536 /* See if there is a meta-map. If there's none, there is
537 no binding for IDX, unless a default binding exists in MAP. */
539 Lisp_Object meta_map
;
541 /* A strange value in which Meta is set would cause
542 infinite recursion. Protect against that. */
543 if (XINT (meta_prefix_char
) & CHAR_META
)
544 meta_prefix_char
= make_number (27);
545 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
546 t_ok
, noinherit
, autoload
),
549 if (CONSP (meta_map
))
552 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
555 /* Set IDX to t, so that we only find a default binding. */
558 /* We know there is no binding. */
562 /* t_binding is where we put a default binding that applies,
563 to use in case we do not find a binding specifically
564 for this key sequence. */
567 Lisp_Object t_binding
= Qnil
;
568 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
570 GCPRO4 (map
, tail
, idx
, t_binding
);
572 /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
573 If it is 1, only generic-char bindings are accepted.
574 Otherwise, neither are. */
577 for (tail
= XCDR (map
);
579 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
584 binding
= XCAR (tail
);
585 if (SYMBOLP (binding
))
587 /* If NOINHERIT, stop finding prefix definitions
588 after we pass a second occurrence of the `keymap' symbol. */
589 if (noinherit
&& EQ (binding
, Qkeymap
))
590 RETURN_UNGCPRO (Qnil
);
592 else if (CONSP (binding
))
594 Lisp_Object key
= XCAR (binding
);
597 val
= XCDR (binding
);
600 && (XINT (idx
) & CHAR_MODIFIER_MASK
) == 0
602 && (XINT (key
) & CHAR_MODIFIER_MASK
) == 0
603 && !SINGLE_BYTE_CHAR_P (XINT (idx
))
604 && !SINGLE_BYTE_CHAR_P (XINT (key
))
605 && CHAR_VALID_P (XINT (key
), 1)
606 && !CHAR_VALID_P (XINT (key
), 0)
607 && (CHAR_CHARSET (XINT (key
))
608 == CHAR_CHARSET (XINT (idx
))))
610 /* KEY is the generic character of the charset of IDX.
611 Use KEY's binding if there isn't a binding for IDX
613 t_binding
= XCDR (binding
);
616 else if (t_ok
> 1 && EQ (key
, Qt
))
618 t_binding
= XCDR (binding
);
622 else if (VECTORP (binding
))
624 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
625 val
= AREF (binding
, XFASTINT (idx
));
627 else if (CHAR_TABLE_P (binding
))
629 /* Character codes with modifiers
630 are not included in a char-table.
631 All character codes without modifiers are included. */
632 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
634 val
= Faref (binding
, idx
);
635 /* `nil' has a special meaning for char-tables, so
636 we use something else to record an explicitly
643 /* If we found a binding, clean it up and return it. */
644 if (!EQ (val
, Qunbound
))
647 /* A Qt binding is just like an explicit nil binding
648 (i.e. it shadows any parent binding but not bindings in
649 keymaps of lower precedence). */
651 val
= get_keyelt (val
, autoload
);
653 fix_submap_inheritance (map
, idx
, val
);
654 RETURN_UNGCPRO (val
);
659 return get_keyelt (t_binding
, autoload
);
664 map_keymap_item (fun
, args
, key
, val
, data
)
665 map_keymap_function_t fun
;
666 Lisp_Object args
, key
, val
;
669 /* We should maybe try to detect bindings shadowed by previous
670 ones and things like that. */
673 (*fun
) (key
, val
, args
, data
);
677 map_keymap_char_table_item (args
, key
, val
)
678 Lisp_Object args
, key
, val
;
682 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
684 map_keymap_item (fun
, XCDR (args
), key
, val
,
685 XSAVE_VALUE (XCAR (args
))->pointer
);
689 /* Call FUN for every binding in MAP.
690 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
691 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
693 map_keymap (map
, fun
, args
, data
, autoload
)
694 map_keymap_function_t fun
;
695 Lisp_Object map
, args
;
699 struct gcpro gcpro1
, gcpro2
, gcpro3
;
702 GCPRO3 (map
, args
, tail
);
703 map
= get_keymap (map
, 1, autoload
);
704 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
705 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
708 Lisp_Object binding
= XCAR (tail
);
711 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
712 else if (VECTORP (binding
))
714 /* Loop over the char values represented in the vector. */
715 int len
= ASIZE (binding
);
717 for (c
= 0; c
< len
; c
++)
719 Lisp_Object character
;
720 XSETFASTINT (character
, c
);
721 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
724 else if (CHAR_TABLE_P (binding
))
726 Lisp_Object indices
[3];
727 map_char_table (map_keymap_char_table_item
, Qnil
, binding
, binding
,
728 Fcons (make_save_value (fun
, 0),
729 Fcons (make_save_value (data
, 0),
738 map_keymap_call (key
, val
, fun
, dummy
)
739 Lisp_Object key
, val
, fun
;
742 call2 (fun
, key
, val
);
745 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
746 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
747 FUNCTION is called with two arguments: the event that is bound, and
748 the definition it is bound to.
750 If KEYMAP has a parent, the parent's bindings are included as well.
751 This works recursively: if the parent has itself a parent, then the
752 grandparent's bindings are also included and so on.
753 usage: (map-keymap FUNCTION KEYMAP) */)
754 (function
, keymap
, sort_first
)
755 Lisp_Object function
, keymap
, sort_first
;
757 if (INTEGERP (function
))
758 /* We have to stop integers early since map_keymap gives them special
760 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
761 if (! NILP (sort_first
))
762 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
764 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
768 /* Given OBJECT which was found in a slot in a keymap,
769 trace indirect definitions to get the actual definition of that slot.
770 An indirect definition is a list of the form
771 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
772 and INDEX is the object to look up in KEYMAP to yield the definition.
774 Also if OBJECT has a menu string as the first element,
775 remove that. Also remove a menu help string as second element.
777 If AUTOLOAD is nonzero, load autoloadable keymaps
778 that are referred to with indirection.
780 This can GC because menu_item_eval_property calls Feval. */
783 get_keyelt (object
, autoload
)
789 if (!(CONSP (object
)))
790 /* This is really the value. */
793 /* If the keymap contents looks like (keymap ...) or (lambda ...)
795 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
798 /* If the keymap contents looks like (menu-item name . DEFN)
799 or (menu-item name DEFN ...) then use DEFN.
800 This is a new format menu item. */
801 else if (EQ (XCAR (object
), Qmenu_item
))
803 if (CONSP (XCDR (object
)))
807 object
= XCDR (XCDR (object
));
810 object
= XCAR (object
);
812 /* If there's a `:filter FILTER', apply FILTER to the
813 menu-item's definition to get the real definition to
815 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
816 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
819 filter
= XCAR (XCDR (tem
));
820 filter
= list2 (filter
, list2 (Qquote
, object
));
821 object
= menu_item_eval_property (filter
);
826 /* Invalid keymap. */
830 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
831 Keymap alist elements like (CHAR MENUSTRING . DEFN)
832 will be used by HierarKey menus. */
833 else if (STRINGP (XCAR (object
)))
835 object
= XCDR (object
);
836 /* Also remove a menu help string, if any,
837 following the menu item name. */
838 if (CONSP (object
) && STRINGP (XCAR (object
)))
839 object
= XCDR (object
);
840 /* Also remove the sublist that caches key equivalences, if any. */
841 if (CONSP (object
) && CONSP (XCAR (object
)))
844 carcar
= XCAR (XCAR (object
));
845 if (NILP (carcar
) || VECTORP (carcar
))
846 object
= XCDR (object
);
850 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
856 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
858 return (!CONSP (map
) ? object
/* Invalid keymap */
859 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
865 store_in_keymap (keymap
, idx
, def
)
867 register Lisp_Object idx
;
868 register Lisp_Object def
;
870 /* Flush any reverse-map cache. */
871 where_is_cache
= Qnil
;
872 where_is_cache_keymaps
= Qt
;
874 /* If we are preparing to dump, and DEF is a menu element
875 with a menu item indicator, copy it to ensure it is not pure. */
876 if (CONSP (def
) && PURE_P (def
)
877 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
878 def
= Fcons (XCAR (def
), XCDR (def
));
880 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
881 error ("attempt to define a key in a non-keymap");
883 /* If idx is a list (some sort of mouse click, perhaps?),
884 the index we want to use is the car of the list, which
885 ought to be a symbol. */
886 idx
= EVENT_HEAD (idx
);
888 /* If idx is a symbol, it might have modifiers, which need to
889 be put in the canonical order. */
891 idx
= reorder_modifiers (idx
);
892 else if (INTEGERP (idx
))
893 /* Clobber the high bits that can be present on a machine
894 with more than 24 bits of integer. */
895 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
897 /* Scan the keymap for a binding of idx. */
901 /* The cons after which we should insert new bindings. If the
902 keymap has a table element, we record its position here, so new
903 bindings will go after it; this way, the table will stay
904 towards the front of the alist and character lookups in dense
905 keymaps will remain fast. Otherwise, this just points at the
906 front of the keymap. */
907 Lisp_Object insertion_point
;
909 insertion_point
= keymap
;
910 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
917 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
920 ASET (elt
, XFASTINT (idx
), def
);
923 insertion_point
= tail
;
925 else if (CHAR_TABLE_P (elt
))
927 /* Character codes with modifiers
928 are not included in a char-table.
929 All character codes without modifiers are included. */
930 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
933 /* `nil' has a special meaning for char-tables, so
934 we use something else to record an explicitly
936 NILP (def
) ? Qt
: def
);
939 insertion_point
= tail
;
941 else if (CONSP (elt
))
943 if (EQ (idx
, XCAR (elt
)))
950 else if (EQ (elt
, Qkeymap
))
951 /* If we find a 'keymap' symbol in the spine of KEYMAP,
952 then we must have found the start of a second keymap
953 being used as the tail of KEYMAP, and a binding for IDX
954 should be inserted before it. */
961 /* We have scanned the entire keymap, and not found a binding for
962 IDX. Let's add one. */
963 CHECK_IMPURE (insertion_point
);
964 XSETCDR (insertion_point
,
965 Fcons (Fcons (idx
, def
), XCDR (insertion_point
)));
971 EXFUN (Fcopy_keymap
, 1);
974 copy_keymap_item (elt
)
977 Lisp_Object res
, tem
;
984 /* Is this a new format menu item. */
985 if (EQ (XCAR (tem
), Qmenu_item
))
987 /* Copy cell with menu-item marker. */
988 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
992 /* Copy cell with menu-item name. */
993 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
999 /* Copy cell with binding and if the binding is a keymap,
1001 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1004 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1005 XSETCAR (elt
, Fcopy_keymap (tem
));
1007 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1008 /* Delete cache for key equivalences. */
1009 XSETCDR (elt
, XCDR (tem
));
1014 /* It may be an old fomat menu item.
1015 Skip the optional menu string. */
1016 if (STRINGP (XCAR (tem
)))
1018 /* Copy the cell, since copy-alist didn't go this deep. */
1019 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1021 /* Also skip the optional menu help string. */
1022 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1024 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1028 /* There may also be a list that caches key equivalences.
1029 Just delete it for the new keymap. */
1031 && CONSP (XCAR (tem
))
1032 && (NILP (XCAR (XCAR (tem
)))
1033 || VECTORP (XCAR (XCAR (tem
)))))
1035 XSETCDR (elt
, XCDR (tem
));
1038 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1039 XSETCDR (elt
, Fcopy_keymap (tem
));
1041 else if (EQ (XCAR (tem
), Qkeymap
))
1042 res
= Fcopy_keymap (elt
);
1048 copy_keymap_1 (chartable
, idx
, elt
)
1049 Lisp_Object chartable
, idx
, elt
;
1051 Faset (chartable
, idx
, copy_keymap_item (elt
));
1054 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1055 doc
: /* Return a copy of the keymap KEYMAP.
1056 The copy starts out with the same definitions of KEYMAP,
1057 but changing either the copy or KEYMAP does not affect the other.
1058 Any key definitions that are subkeymaps are recursively copied.
1059 However, a key definition which is a symbol whose definition is a keymap
1064 register Lisp_Object copy
, tail
;
1065 keymap
= get_keymap (keymap
, 1, 0);
1066 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1067 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1069 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1071 Lisp_Object elt
= XCAR (keymap
);
1072 if (CHAR_TABLE_P (elt
))
1074 Lisp_Object indices
[3];
1075 elt
= Fcopy_sequence (elt
);
1076 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, elt
, 0, indices
);
1078 else if (VECTORP (elt
))
1081 elt
= Fcopy_sequence (elt
);
1082 for (i
= 0; i
< ASIZE (elt
); i
++)
1083 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1085 else if (CONSP (elt
))
1086 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1087 XSETCDR (tail
, Fcons (elt
, Qnil
));
1089 keymap
= XCDR (keymap
);
1091 XSETCDR (tail
, keymap
);
1095 /* Simple Keymap mutators and accessors. */
1097 /* GC is possible in this function if it autoloads a keymap. */
1099 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1100 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1103 KEY is a string or a vector of symbols and characters meaning a
1104 sequence of keystrokes and events. Non-ASCII characters with codes
1105 above 127 (such as ISO Latin-1) can be included if you use a vector.
1106 Using [t] for KEY creates a default definition, which applies to any
1107 event type that has no other definition in this keymap.
1109 DEF is anything that can be a key's definition:
1110 nil (means key is undefined in this keymap),
1111 a command (a Lisp function suitable for interactive calling),
1112 a string (treated as a keyboard macro),
1113 a keymap (to define a prefix key),
1114 a symbol (when the key is looked up, the symbol will stand for its
1115 function definition, which should at that time be one of the above,
1116 or another symbol whose function definition is used, etc.),
1117 a cons (STRING . DEFN), meaning that DEFN is the definition
1118 (DEFN should be a valid definition in its own right),
1119 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1121 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1122 binding is altered. If there is no binding for KEY, the new pair
1123 binding KEY to DEF is added at the front of KEYMAP. */)
1130 register Lisp_Object c
;
1131 register Lisp_Object cmd
;
1135 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1137 GCPRO3 (keymap
, key
, def
);
1138 keymap
= get_keymap (keymap
, 1, 1);
1140 if (!VECTORP (key
) && !STRINGP (key
))
1141 key
= wrong_type_argument (Qarrayp
, key
);
1143 length
= XFASTINT (Flength (key
));
1145 RETURN_UNGCPRO (Qnil
);
1147 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1148 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1150 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1155 c
= Faref (key
, make_number (idx
));
1157 if (CONSP (c
) && lucid_event_type_list_p (c
))
1158 c
= Fevent_convert_list (c
);
1161 silly_event_symbol_error (c
);
1164 && (XINT (c
) & meta_bit
)
1167 c
= meta_prefix_char
;
1173 XSETINT (c
, XINT (c
) & ~meta_bit
);
1179 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1180 error ("Key sequence contains invalid event");
1183 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1185 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1187 /* If this key is undefined, make it a prefix. */
1189 cmd
= define_as_prefix (keymap
, c
);
1191 keymap
= get_keymap (cmd
, 0, 1);
1192 if (!CONSP (keymap
))
1193 /* We must use Fkey_description rather than just passing key to
1194 error; key might be a vector, not a string. */
1195 error ("Key sequence %s uses invalid prefix characters",
1196 SDATA (Fkey_description (key
, Qnil
)));
1200 /* This function may GC (it calls Fkey_binding). */
1202 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1203 doc
: /* Return the remapping for command COMMAND in current keymaps.
1204 Returns nil if COMMAND is not remapped (or not a symbol). */)
1206 Lisp_Object command
;
1208 if (!SYMBOLP (command
))
1211 ASET (command_remapping_vector
, 1, command
);
1212 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1215 /* Value is number if KEY is too long; nil if valid but has no definition. */
1216 /* GC is possible in this function if it autoloads a keymap. */
1218 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1219 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1220 nil means undefined. See doc of `define-key' for kinds of definitions.
1222 A number as value means KEY is "too long";
1223 that is, characters or symbols in it except for the last one
1224 fail to be a valid sequence of prefix characters in KEYMAP.
1225 The number is how many characters at the front of KEY
1226 it takes to reach a non-prefix key.
1228 Normally, `lookup-key' ignores bindings for t, which act as default
1229 bindings, used when nothing else in the keymap applies; this makes it
1230 usable as a general function for probing keymaps. However, if the
1231 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1232 recognize the default bindings, just as `read-key-sequence' does. */)
1233 (keymap
, key
, accept_default
)
1236 Lisp_Object accept_default
;
1239 register Lisp_Object cmd
;
1240 register Lisp_Object c
;
1242 int t_ok
= !NILP (accept_default
);
1243 struct gcpro gcpro1
, gcpro2
;
1245 GCPRO2 (keymap
, key
);
1246 keymap
= get_keymap (keymap
, 1, 1);
1248 if (!VECTORP (key
) && !STRINGP (key
))
1249 key
= wrong_type_argument (Qarrayp
, key
);
1251 length
= XFASTINT (Flength (key
));
1253 RETURN_UNGCPRO (keymap
);
1258 c
= Faref (key
, make_number (idx
++));
1260 if (CONSP (c
) && lucid_event_type_list_p (c
))
1261 c
= Fevent_convert_list (c
);
1263 /* Turn the 8th bit of string chars into a meta modifier. */
1264 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1265 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1267 /* Allow string since binding for `menu-bar-select-buffer'
1268 includes the buffer name in the key sequence. */
1269 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1270 error ("Key sequence contains invalid event");
1272 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1274 RETURN_UNGCPRO (cmd
);
1276 keymap
= get_keymap (cmd
, 0, 1);
1277 if (!CONSP (keymap
))
1278 RETURN_UNGCPRO (make_number (idx
));
1284 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1285 Assume that currently it does not define C at all.
1286 Return the keymap. */
1289 define_as_prefix (keymap
, c
)
1290 Lisp_Object keymap
, c
;
1294 cmd
= Fmake_sparse_keymap (Qnil
);
1295 /* If this key is defined as a prefix in an inherited keymap,
1296 make it a prefix in this map, and make its definition
1297 inherit the other prefix definition. */
1298 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1299 store_in_keymap (keymap
, c
, cmd
);
1304 /* Append a key to the end of a key sequence. We always make a vector. */
1307 append_key (key_sequence
, key
)
1308 Lisp_Object key_sequence
, key
;
1310 Lisp_Object args
[2];
1312 args
[0] = key_sequence
;
1314 args
[1] = Fcons (key
, Qnil
);
1315 return Fvconcat (2, args
);
1318 /* Given a event type C which is a symbol,
1319 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1322 silly_event_symbol_error (c
)
1325 Lisp_Object parsed
, base
, name
, assoc
;
1328 parsed
= parse_modifiers (c
);
1329 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1330 base
= XCAR (parsed
);
1331 name
= Fsymbol_name (base
);
1332 /* This alist includes elements such as ("RET" . "\\r"). */
1333 assoc
= Fassoc (name
, exclude_keys
);
1337 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1339 Lisp_Object keystring
;
1340 if (modifiers
& alt_modifier
)
1341 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1342 if (modifiers
& ctrl_modifier
)
1343 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1344 if (modifiers
& hyper_modifier
)
1345 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1346 if (modifiers
& meta_modifier
)
1347 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1348 if (modifiers
& shift_modifier
)
1349 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1350 if (modifiers
& super_modifier
)
1351 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1354 c
= reorder_modifiers (c
);
1355 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1357 error ((modifiers
& ~meta_modifier
1358 ? "To bind the key %s, use [?%s], not [%s]"
1359 : "To bind the key %s, use \"%s\", not [%s]"),
1360 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1361 SDATA (SYMBOL_NAME (c
)));
1365 /* Global, local, and minor mode keymap stuff. */
1367 /* We can't put these variables inside current_minor_maps, since under
1368 some systems, static gets macro-defined to be the empty string.
1370 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1371 static int cmm_size
= 0;
1373 /* Store a pointer to an array of the keymaps of the currently active
1374 minor modes in *buf, and return the number of maps it contains.
1376 This function always returns a pointer to the same buffer, and may
1377 free or reallocate it, so if you want to keep it for a long time or
1378 hand it out to lisp code, copy it. This procedure will be called
1379 for every key sequence read, so the nice lispy approach (return a
1380 new assoclist, list, what have you) for each invocation would
1381 result in a lot of consing over time.
1383 If we used xrealloc/xmalloc and ran out of memory, they would throw
1384 back to the command loop, which would try to read a key sequence,
1385 which would call this function again, resulting in an infinite
1386 loop. Instead, we'll use realloc/malloc and silently truncate the
1387 list, let the key sequence be read, and hope some other piece of
1388 code signals the error. */
1390 current_minor_maps (modeptr
, mapptr
)
1391 Lisp_Object
**modeptr
, **mapptr
;
1394 int list_number
= 0;
1395 Lisp_Object alist
, assoc
, var
, val
;
1396 Lisp_Object emulation_alists
;
1397 Lisp_Object lists
[2];
1399 emulation_alists
= Vemulation_mode_map_alists
;
1400 lists
[0] = Vminor_mode_overriding_map_alist
;
1401 lists
[1] = Vminor_mode_map_alist
;
1403 for (list_number
= 0; list_number
< 2; list_number
++)
1405 if (CONSP (emulation_alists
))
1407 alist
= XCAR (emulation_alists
);
1408 emulation_alists
= XCDR (emulation_alists
);
1409 if (SYMBOLP (alist
))
1410 alist
= find_symbol_value (alist
);
1414 alist
= lists
[list_number
];
1416 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1417 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1418 && (var
= XCAR (assoc
), SYMBOLP (var
))
1419 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1424 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1425 and also an entry in Vminor_mode_map_alist,
1426 ignore the latter. */
1427 if (list_number
== 1)
1429 val
= assq_no_quit (var
, lists
[0]);
1436 int newsize
, allocsize
;
1437 Lisp_Object
*newmodes
, *newmaps
;
1439 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1440 allocsize
= newsize
* sizeof *newmodes
;
1442 /* Use malloc here. See the comment above this function.
1443 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1445 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1450 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1453 cmm_modes
= newmodes
;
1456 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1461 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1468 if (newmodes
== NULL
|| newmaps
== NULL
)
1473 /* Get the keymap definition--or nil if it is not defined. */
1474 temp
= Findirect_function (XCDR (assoc
), Qt
);
1478 cmm_maps
[i
] = temp
;
1484 if (modeptr
) *modeptr
= cmm_modes
;
1485 if (mapptr
) *mapptr
= cmm_maps
;
1489 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1491 doc
: /* Return a list of the currently active keymaps.
1492 OLP if non-nil indicates that we should obey `overriding-local-map' and
1493 `overriding-terminal-local-map'. */)
1497 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1501 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1502 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1503 /* The doc said that overriding-terminal-local-map should
1504 override overriding-local-map. The code used them both,
1505 but it seems clearer to use just one. rms, jan 2005. */
1506 else if (!NILP (Voverriding_local_map
))
1507 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1509 if (NILP (XCDR (keymaps
)))
1515 /* This usually returns the buffer's local map,
1516 but that can be overridden by a `local-map' property. */
1517 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1519 keymaps
= Fcons (local
, keymaps
);
1521 /* Now put all the minor mode keymaps on the list. */
1522 nmaps
= current_minor_maps (0, &maps
);
1524 for (i
= --nmaps
; i
>= 0; i
--)
1525 if (!NILP (maps
[i
]))
1526 keymaps
= Fcons (maps
[i
], keymaps
);
1528 /* This returns nil unless there is a `keymap' property. */
1529 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1531 keymaps
= Fcons (local
, keymaps
);
1537 /* GC is possible in this function if it autoloads a keymap. */
1539 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1540 doc
: /* Return the binding for command KEY in current keymaps.
1541 KEY is a string or vector, a sequence of keystrokes.
1542 The binding is probably a symbol with a function definition.
1544 Normally, `key-binding' ignores bindings for t, which act as default
1545 bindings, used when nothing else in the keymap applies; this makes it
1546 usable as a general function for probing keymaps. However, if the
1547 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1548 recognize the default bindings, just as `read-key-sequence' does.
1550 Like the normal command loop, `key-binding' will remap the command
1551 resulting from looking up KEY by looking up the command in the
1552 current keymaps. However, if the optional third argument NO-REMAP
1553 is non-nil, `key-binding' returns the unmapped command. */)
1554 (key
, accept_default
, no_remap
)
1555 Lisp_Object key
, accept_default
, no_remap
;
1557 Lisp_Object
*maps
, value
;
1559 struct gcpro gcpro1
;
1563 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1565 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1566 key
, accept_default
);
1567 if (! NILP (value
) && !INTEGERP (value
))
1570 else if (!NILP (Voverriding_local_map
))
1572 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1573 if (! NILP (value
) && !INTEGERP (value
))
1580 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1583 value
= Flookup_key (local
, key
, accept_default
);
1584 if (! NILP (value
) && !INTEGERP (value
))
1588 nmaps
= current_minor_maps (0, &maps
);
1589 /* Note that all these maps are GCPRO'd
1590 in the places where we found them. */
1592 for (i
= 0; i
< nmaps
; i
++)
1593 if (! NILP (maps
[i
]))
1595 value
= Flookup_key (maps
[i
], key
, accept_default
);
1596 if (! NILP (value
) && !INTEGERP (value
))
1600 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1603 value
= Flookup_key (local
, key
, accept_default
);
1604 if (! NILP (value
) && !INTEGERP (value
))
1609 value
= Flookup_key (current_global_map
, key
, accept_default
);
1613 if (NILP (value
) || INTEGERP (value
))
1616 /* If the result of the ordinary keymap lookup is an interactive
1617 command, look for a key binding (ie. remapping) for that command. */
1619 if (NILP (no_remap
) && SYMBOLP (value
))
1622 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1629 /* GC is possible in this function if it autoloads a keymap. */
1631 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1632 doc
: /* Return the binding for command KEYS in current local keymap only.
1633 KEYS is a string or vector, a sequence of keystrokes.
1634 The binding is probably a symbol with a function definition.
1636 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1637 bindings; see the description of `lookup-key' for more details about this. */)
1638 (keys
, accept_default
)
1639 Lisp_Object keys
, accept_default
;
1641 register Lisp_Object map
;
1642 map
= current_buffer
->keymap
;
1645 return Flookup_key (map
, keys
, accept_default
);
1648 /* GC is possible in this function if it autoloads a keymap. */
1650 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1651 doc
: /* Return the binding for command KEYS in current global keymap only.
1652 KEYS is a string or vector, a sequence of keystrokes.
1653 The binding is probably a symbol with a function definition.
1654 This function's return values are the same as those of `lookup-key'
1657 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1658 bindings; see the description of `lookup-key' for more details about this. */)
1659 (keys
, accept_default
)
1660 Lisp_Object keys
, accept_default
;
1662 return Flookup_key (current_global_map
, keys
, accept_default
);
1665 /* GC is possible in this function if it autoloads a keymap. */
1667 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1668 doc
: /* Find the visible minor mode bindings of KEY.
1669 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1670 the symbol which names the minor mode binding KEY, and BINDING is
1671 KEY's definition in that mode. In particular, if KEY has no
1672 minor-mode bindings, return nil. If the first binding is a
1673 non-prefix, all subsequent bindings will be omitted, since they would
1674 be ignored. Similarly, the list doesn't include non-prefix bindings
1675 that come after prefix bindings.
1677 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1678 bindings; see the description of `lookup-key' for more details about this. */)
1679 (key
, accept_default
)
1680 Lisp_Object key
, accept_default
;
1682 Lisp_Object
*modes
, *maps
;
1684 Lisp_Object binding
;
1686 struct gcpro gcpro1
, gcpro2
;
1688 nmaps
= current_minor_maps (&modes
, &maps
);
1689 /* Note that all these maps are GCPRO'd
1690 in the places where we found them. */
1693 GCPRO2 (key
, binding
);
1695 for (i
= j
= 0; i
< nmaps
; i
++)
1697 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1698 && !INTEGERP (binding
))
1700 if (KEYMAPP (binding
))
1701 maps
[j
++] = Fcons (modes
[i
], binding
);
1703 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1707 return Flist (j
, maps
);
1710 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1711 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1712 A new sparse keymap is stored as COMMAND's function definition and its value.
1713 If a second optional argument MAPVAR is given, the map is stored as
1714 its value instead of as COMMAND's value; but COMMAND is still defined
1716 The third optional argument NAME, if given, supplies a menu name
1717 string for the map. This is required to use the keymap as a menu.
1718 This function returns COMMAND. */)
1719 (command
, mapvar
, name
)
1720 Lisp_Object command
, mapvar
, name
;
1723 map
= Fmake_sparse_keymap (name
);
1724 Ffset (command
, map
);
1728 Fset (command
, map
);
1732 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1733 doc
: /* Select KEYMAP as the global keymap. */)
1737 keymap
= get_keymap (keymap
, 1, 1);
1738 current_global_map
= keymap
;
1743 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1744 doc
: /* Select KEYMAP as the local keymap.
1745 If KEYMAP is nil, that means no local keymap. */)
1750 keymap
= get_keymap (keymap
, 1, 1);
1752 current_buffer
->keymap
= keymap
;
1757 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1758 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1761 return current_buffer
->keymap
;
1764 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1765 doc
: /* Return the current global keymap. */)
1768 return current_global_map
;
1771 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1772 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1776 int nmaps
= current_minor_maps (0, &maps
);
1778 return Flist (nmaps
, maps
);
1781 /* Help functions for describing and documenting keymaps. */
1785 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1786 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1787 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1791 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1795 /* Look for and break cycles. */
1796 while (!NILP (tem
= Frassq (cmd
, maps
)))
1798 Lisp_Object prefix
= XCAR (tem
);
1799 int lim
= XINT (Flength (XCAR (tem
)));
1800 if (lim
<= XINT (Flength (thisseq
)))
1801 { /* This keymap was already seen with a smaller prefix. */
1803 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1804 Faref (thisseq
, make_number (i
))))
1807 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1810 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1811 but maybe `cmd' occurs again further down in `maps', so keep
1813 maps
= XCDR (Fmemq (tem
, maps
));
1816 /* If the last key in thisseq is meta-prefix-char,
1817 turn it into a meta-ized keystroke. We know
1818 that the event we're about to append is an
1819 ascii keystroke since we're processing a
1823 int meta_bit
= meta_modifier
;
1824 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1825 tem
= Fcopy_sequence (thisseq
);
1827 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1829 /* This new sequence is the same length as
1830 thisseq, so stick it in the list right
1833 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1837 tem
= append_key (thisseq
, key
);
1838 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1843 accessible_keymaps_char_table (args
, index
, cmd
)
1844 Lisp_Object args
, index
, cmd
;
1846 accessible_keymaps_1 (index
, cmd
,
1850 XINT (XCDR (XCAR (args
))));
1853 /* This function cannot GC. */
1855 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1857 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1858 Returns a list of elements of the form (KEYS . MAP), where the sequence
1859 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1860 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1861 An optional argument PREFIX, if non-nil, should be a key sequence;
1862 then the value includes only maps for prefixes that start with PREFIX. */)
1864 Lisp_Object keymap
, prefix
;
1866 Lisp_Object maps
, tail
;
1869 /* no need for gcpro because we don't autoload any keymaps. */
1872 prefixlen
= XINT (Flength (prefix
));
1876 /* If a prefix was specified, start with the keymap (if any) for
1877 that prefix, so we don't waste time considering other prefixes. */
1879 tem
= Flookup_key (keymap
, prefix
, Qt
);
1880 /* Flookup_key may give us nil, or a number,
1881 if the prefix is not defined in this particular map.
1882 It might even give us a list that isn't a keymap. */
1883 tem
= get_keymap (tem
, 0, 0);
1886 /* Convert PREFIX to a vector now, so that later on
1887 we don't have to deal with the possibility of a string. */
1888 if (STRINGP (prefix
))
1893 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1894 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1898 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1899 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1900 c
^= 0200 | meta_modifier
;
1901 ASET (copy
, i_before
, make_number (c
));
1905 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1911 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1912 get_keymap (keymap
, 1, 0)),
1915 /* For each map in the list maps,
1916 look at any other maps it points to,
1917 and stick them at the end if they are not already in the list.
1919 This is a breadth-first traversal, where tail is the queue of
1920 nodes, and maps accumulates a list of all nodes visited. */
1922 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1924 register Lisp_Object thisseq
, thismap
;
1926 /* Does the current sequence end in the meta-prefix-char? */
1929 thisseq
= Fcar (Fcar (tail
));
1930 thismap
= Fcdr (Fcar (tail
));
1931 last
= make_number (XINT (Flength (thisseq
)) - 1);
1932 is_metized
= (XINT (last
) >= 0
1933 /* Don't metize the last char of PREFIX. */
1934 && XINT (last
) >= prefixlen
1935 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1937 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1941 elt
= XCAR (thismap
);
1945 if (CHAR_TABLE_P (elt
))
1947 Lisp_Object indices
[3];
1949 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
1950 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1951 Fcons (tail
, thisseq
)),
1954 else if (VECTORP (elt
))
1958 /* Vector keymap. Scan all the elements. */
1959 for (i
= 0; i
< ASIZE (elt
); i
++)
1960 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1961 maps
, tail
, thisseq
, is_metized
);
1964 else if (CONSP (elt
))
1965 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1966 maps
, tail
, thisseq
,
1967 is_metized
&& INTEGERP (XCAR (elt
)));
1975 Lisp_Object Qsingle_key_description
, Qkey_description
;
1977 /* This function cannot GC. */
1979 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
1980 doc
: /* Return a pretty description of key-sequence KEYS.
1981 Optional arg PREFIX is the sequence of keys leading up to KEYS.
1982 Control characters turn into "C-foo" sequences, meta into "M-foo",
1983 spaces are put between sequence elements, etc. */)
1985 Lisp_Object keys
, prefix
;
1990 int size
= XINT (Flength (keys
));
1992 Lisp_Object sep
= build_string (" ");
1997 size
+= XINT (Flength (prefix
));
1999 /* This has one extra element at the end that we don't pass to Fconcat. */
2000 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2002 /* In effect, this computes
2003 (mapconcat 'single-key-description keys " ")
2004 but we shouldn't use mapconcat because it can do GC. */
2008 list
= prefix
, prefix
= Qnil
;
2009 else if (!NILP (keys
))
2010 list
= keys
, keys
= Qnil
;
2015 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2019 return empty_string
;
2020 return Fconcat (len
- 1, args
);
2024 size
= SCHARS (list
);
2025 else if (VECTORP (list
))
2026 size
= XVECTOR (list
)->size
;
2027 else if (CONSP (list
))
2028 size
= XINT (Flength (list
));
2030 wrong_type_argument (Qarrayp
, list
);
2039 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2040 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2041 c
^= 0200 | meta_modifier
;
2042 XSETFASTINT (key
, c
);
2044 else if (VECTORP (list
))
2046 key
= AREF (list
, i
++);
2058 || EQ (key
, meta_prefix_char
)
2059 || (XINT (key
) & meta_modifier
))
2061 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2063 if (EQ (key
, meta_prefix_char
))
2067 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2070 else if (EQ (key
, meta_prefix_char
))
2075 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2083 push_key_description (c
, p
, force_multibyte
)
2084 register unsigned int c
;
2086 int force_multibyte
;
2090 /* Clear all the meaningless bits above the meta bit. */
2091 c
&= meta_modifier
| ~ - meta_modifier
;
2092 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2093 | meta_modifier
| shift_modifier
| super_modifier
);
2095 if (c
& alt_modifier
)
2101 if ((c
& ctrl_modifier
) != 0
2102 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2106 c
&= ~ctrl_modifier
;
2108 if (c
& hyper_modifier
)
2112 c
-= hyper_modifier
;
2114 if (c
& meta_modifier
)
2120 if (c
& shift_modifier
)
2124 c
-= shift_modifier
;
2126 if (c
& super_modifier
)
2130 c
-= super_modifier
;
2146 else if (c
== Ctl ('M'))
2154 /* `C-' already added above. */
2155 if (c
> 0 && c
<= Ctl ('Z'))
2174 || (NILP (current_buffer
->enable_multibyte_characters
)
2175 && SINGLE_BYTE_CHAR_P (c
)
2176 && !force_multibyte
))
2182 int valid_p
= SINGLE_BYTE_CHAR_P (c
) || char_valid_p (c
, 0);
2184 if (force_multibyte
&& valid_p
)
2186 if (SINGLE_BYTE_CHAR_P (c
))
2187 c
= unibyte_char_to_multibyte (c
);
2188 p
+= CHAR_STRING (c
, p
);
2190 else if (NILP (current_buffer
->enable_multibyte_characters
)
2195 /* The biggest character code uses 19 bits. */
2196 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2198 if (c
>= (1 << bit_offset
))
2199 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2203 p
+= CHAR_STRING (c
, p
);
2209 /* This function cannot GC. */
2211 DEFUN ("single-key-description", Fsingle_key_description
,
2212 Ssingle_key_description
, 1, 2, 0,
2213 doc
: /* Return a pretty description of command character KEY.
2214 Control characters turn into C-whatever, etc.
2215 Optional argument NO-ANGLES non-nil means don't put angle brackets
2216 around function keys and event symbols. */)
2218 Lisp_Object key
, no_angles
;
2220 if (CONSP (key
) && lucid_event_type_list_p (key
))
2221 key
= Fevent_convert_list (key
);
2223 key
= EVENT_HEAD (key
);
2225 if (INTEGERP (key
)) /* Normal character */
2227 unsigned int charset
, c1
, c2
;
2228 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2230 if (SINGLE_BYTE_CHAR_P (without_bits
))
2233 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2236 && CHARSET_DEFINED_P (charset
)
2237 && ((c1
>= 0 && c1
< 32)
2238 || (c2
>= 0 && c2
< 32)))
2240 /* Handle a generic character. */
2242 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
2243 CHECK_STRING (name
);
2244 return concat2 (build_string ("Character set "), name
);
2248 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2252 end
= push_key_description (XUINT (key
), tem
, 1);
2254 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2255 if (nchars
== nbytes
)
2258 string
= build_string (tem
);
2261 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2265 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2267 if (NILP (no_angles
))
2270 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2271 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2272 return build_string (buffer
);
2275 return Fsymbol_name (key
);
2277 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2278 return Fcopy_sequence (key
);
2280 error ("KEY must be an integer, cons, symbol, or string");
2285 push_text_char_description (c
, p
)
2286 register unsigned int c
;
2298 *p
++ = c
+ 64; /* 'A' - 1 */
2310 /* This function cannot GC. */
2312 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2313 doc
: /* Return a pretty description of file-character CHARACTER.
2314 Control characters turn into "^char", etc. This differs from
2315 `single-key-description' which turns them into "C-char".
2316 Also, this function recognizes the 2**7 bit as the Meta character,
2317 whereas `single-key-description' uses the 2**27 bit for Meta.
2318 See Info node `(elisp)Describing Characters' for examples. */)
2320 Lisp_Object character
;
2322 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2323 unsigned char str
[6];
2326 CHECK_NUMBER (character
);
2328 c
= XINT (character
);
2329 if (!SINGLE_BYTE_CHAR_P (c
))
2331 int len
= CHAR_STRING (c
, str
);
2333 return make_multibyte_string (str
, 1, len
);
2336 *push_text_char_description (c
& 0377, str
) = 0;
2338 return build_string (str
);
2341 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2344 ascii_sequence_p (seq
)
2348 int len
= XINT (Flength (seq
));
2350 for (i
= 0; i
< len
; i
++)
2352 Lisp_Object ii
, elt
;
2354 XSETFASTINT (ii
, i
);
2355 elt
= Faref (seq
, ii
);
2358 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2366 /* where-is - finding a command in a set of keymaps. */
2368 static Lisp_Object
where_is_internal ();
2369 static Lisp_Object
where_is_internal_1 ();
2370 static void where_is_internal_2 ();
2372 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2373 Returns the first non-nil binding found in any of those maps. */
2376 shadow_lookup (shadow
, key
, flag
)
2377 Lisp_Object shadow
, key
, flag
;
2379 Lisp_Object tail
, value
;
2381 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2383 value
= Flookup_key (XCAR (tail
), key
, flag
);
2384 if (NATNUMP (value
))
2386 value
= Flookup_key (XCAR (tail
),
2387 Fsubstring (key
, make_number (0), value
), flag
);
2391 else if (!NILP (value
))
2397 static Lisp_Object Vmouse_events
;
2399 /* This function can GC if Flookup_key autoloads any keymaps. */
2402 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2403 Lisp_Object definition
, keymaps
;
2404 Lisp_Object firstonly
, noindirect
, no_remap
;
2406 Lisp_Object maps
= Qnil
;
2407 Lisp_Object found
, sequences
;
2408 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2409 /* 1 means ignore all menu bindings entirely. */
2410 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2412 /* If this command is remapped, then it has no key bindings
2414 if (NILP (no_remap
) && SYMBOLP (definition
))
2417 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2422 while (CONSP (found
))
2426 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2427 found
= XCDR (found
);
2430 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2434 for (; !NILP (maps
); maps
= Fcdr (maps
))
2436 /* Key sequence to reach map, and the map that it reaches */
2437 register Lisp_Object
this, map
, tem
;
2439 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2440 [M-CHAR] sequences, check if last character of the sequence
2441 is the meta-prefix char. */
2445 this = Fcar (Fcar (maps
));
2446 map
= Fcdr (Fcar (maps
));
2447 last
= make_number (XINT (Flength (this)) - 1);
2448 last_is_meta
= (XINT (last
) >= 0
2449 && EQ (Faref (this, last
), meta_prefix_char
));
2451 /* if (nomenus && !ascii_sequence_p (this)) */
2452 if (nomenus
&& XINT (last
) >= 0
2453 && SYMBOLP (tem
= Faref (this, make_number (0)))
2454 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2455 /* If no menu entries should be returned, skip over the
2456 keymaps bound to `menu-bar' and `tool-bar' and other
2457 non-ascii prefixes like `C-down-mouse-2'. */
2464 /* Because the code we want to run on each binding is rather
2465 large, we don't want to have two separate loop bodies for
2466 sparse keymap bindings and tables; we want to iterate one
2467 loop body over both keymap and vector bindings.
2469 For this reason, if Fcar (map) is a vector, we don't
2470 advance map to the next element until i indicates that we
2471 have finished off the vector. */
2472 Lisp_Object elt
, key
, binding
;
2480 /* Set key and binding to the current key and binding, and
2481 advance map and i to the next binding. */
2484 Lisp_Object sequence
;
2486 /* In a vector, look at each element. */
2487 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2489 binding
= AREF (elt
, i
);
2490 XSETFASTINT (key
, i
);
2491 sequence
= where_is_internal_1 (binding
, key
, definition
,
2493 last
, nomenus
, last_is_meta
);
2494 if (!NILP (sequence
))
2495 sequences
= Fcons (sequence
, sequences
);
2498 else if (CHAR_TABLE_P (elt
))
2500 Lisp_Object indices
[3];
2503 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2504 Qnil
), /* Result accumulator. */
2505 Fcons (Fcons (this, last
),
2506 Fcons (make_number (nomenus
),
2507 make_number (last_is_meta
))));
2508 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2510 sequences
= XCDR (XCAR (args
));
2512 else if (CONSP (elt
))
2514 Lisp_Object sequence
;
2517 binding
= XCDR (elt
);
2519 sequence
= where_is_internal_1 (binding
, key
, definition
,
2521 last
, nomenus
, last_is_meta
);
2522 if (!NILP (sequence
))
2523 sequences
= Fcons (sequence
, sequences
);
2527 while (!NILP (sequences
))
2529 Lisp_Object sequence
, remapped
, function
;
2531 sequence
= XCAR (sequences
);
2532 sequences
= XCDR (sequences
);
2534 /* If the current sequence is a command remapping with
2535 format [remap COMMAND], find the key sequences
2536 which run COMMAND, and use those sequences instead. */
2539 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2540 && EQ (AREF (sequence
, 0), Qremap
)
2541 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2543 Lisp_Object remapped1
;
2545 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2546 if (CONSP (remapped1
))
2548 /* Verify that this key binding actually maps to the
2549 remapped command (see below). */
2550 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2552 sequence
= XCAR (remapped1
);
2553 remapped
= XCDR (remapped1
);
2554 goto record_sequence
;
2558 /* Verify that this key binding is not shadowed by another
2559 binding for the same key, before we say it exists.
2561 Mechanism: look for local definition of this key and if
2562 it is defined and does not match what we found then
2565 Either nil or number as value from Flookup_key
2567 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2571 /* Don't annoy user with strings from a menu such as
2572 Select Paste. Change them all to "(any string)",
2573 so that there seems to be only one menu item
2575 if (! NILP (sequence
))
2578 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2580 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2581 build_string ("(any string)"));
2584 /* It is a true unshadowed match. Record it, unless it's already
2585 been seen (as could happen when inheriting keymaps). */
2586 if (NILP (Fmember (sequence
, found
)))
2587 found
= Fcons (sequence
, found
);
2589 /* If firstonly is Qnon_ascii, then we can return the first
2590 binding we find. If firstonly is not Qnon_ascii but not
2591 nil, then we should return the first ascii-only binding
2593 if (EQ (firstonly
, Qnon_ascii
))
2594 RETURN_UNGCPRO (sequence
);
2595 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2596 RETURN_UNGCPRO (sequence
);
2598 if (CONSP (remapped
))
2600 sequence
= XCAR (remapped
);
2601 remapped
= XCDR (remapped
);
2602 goto record_sequence
;
2610 found
= Fnreverse (found
);
2612 /* firstonly may have been t, but we may have gone all the way through
2613 the keymaps without finding an all-ASCII key sequence. So just
2614 return the best we could find. */
2615 if (!NILP (firstonly
))
2616 return Fcar (found
);
2621 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2622 doc
: /* Return list of keys that invoke DEFINITION.
2623 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2624 If KEYMAP is nil, search all the currently active keymaps.
2625 If KEYMAP is a list of keymaps, search only those keymaps.
2627 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2628 rather than a list of all possible key sequences.
2629 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2630 no matter what it is.
2631 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2632 \(or their meta variants) and entirely reject menu bindings.
2634 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2635 to other keymaps or slots. This makes it possible to search for an
2636 indirect definition itself.
2638 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2639 that invoke a command which is remapped to DEFINITION, but include the
2640 remapped command in the returned list. */)
2641 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2642 Lisp_Object definition
, keymap
;
2643 Lisp_Object firstonly
, noindirect
, no_remap
;
2645 Lisp_Object sequences
, keymaps
;
2646 /* 1 means ignore all menu bindings entirely. */
2647 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2650 /* Find the relevant keymaps. */
2651 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2653 else if (!NILP (keymap
))
2654 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2656 keymaps
= Fcurrent_active_maps (Qnil
);
2658 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2659 We don't really need to check `keymap'. */
2660 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2664 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2666 /* Check heuristic-consistency of the cache. */
2667 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2668 where_is_cache
= Qnil
;
2670 if (NILP (where_is_cache
))
2672 /* We need to create the cache. */
2673 Lisp_Object args
[2];
2674 where_is_cache
= Fmake_hash_table (0, args
);
2675 where_is_cache_keymaps
= Qt
;
2677 /* Fill in the cache. */
2678 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2679 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2682 where_is_cache_keymaps
= keymaps
;
2685 /* We want to process definitions from the last to the first.
2686 Instead of consing, copy definitions to a vector and step
2687 over that vector. */
2688 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2689 n
= XINT (Flength (sequences
));
2690 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2691 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2692 defns
[i
++] = XCAR (sequences
);
2694 /* Verify that the key bindings are not shadowed. Note that
2695 the following can GC. */
2696 GCPRO2 (definition
, keymaps
);
2699 for (i
= n
- 1; i
>= 0; --i
)
2700 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2702 if (ascii_sequence_p (defns
[i
]))
2708 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2713 /* Kill the cache so that where_is_internal_1 doesn't think
2714 we're filling it up. */
2715 where_is_cache
= Qnil
;
2716 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2722 /* This is the function that Fwhere_is_internal calls using map_char_table.
2724 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2726 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2727 Since map_char_table doesn't really use the return value from this function,
2728 we the result append to RESULT, the slot in ARGS.
2730 This function can GC because it calls where_is_internal_1 which can
2734 where_is_internal_2 (args
, key
, binding
)
2735 Lisp_Object args
, key
, binding
;
2737 Lisp_Object definition
, noindirect
, this, last
;
2738 Lisp_Object result
, sequence
;
2739 int nomenus
, last_is_meta
;
2740 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2742 GCPRO3 (args
, key
, binding
);
2743 result
= XCDR (XCAR (args
));
2744 definition
= XCAR (XCAR (XCAR (args
)));
2745 noindirect
= XCDR (XCAR (XCAR (args
)));
2746 this = XCAR (XCAR (XCDR (args
)));
2747 last
= XCDR (XCAR (XCDR (args
)));
2748 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2749 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2751 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2752 this, last
, nomenus
, last_is_meta
);
2754 if (!NILP (sequence
))
2755 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2761 /* This function can GC because get_keyelt can. */
2764 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2765 nomenus
, last_is_meta
)
2766 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2767 int nomenus
, last_is_meta
;
2769 Lisp_Object sequence
;
2771 /* Search through indirections unless that's not wanted. */
2772 if (NILP (noindirect
))
2773 binding
= get_keyelt (binding
, 0);
2775 /* End this iteration if this element does not match
2778 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2779 || EQ (binding
, definition
)
2780 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2781 /* Doesn't match. */
2784 /* We have found a match. Construct the key sequence where we found it. */
2785 if (INTEGERP (key
) && last_is_meta
)
2787 sequence
= Fcopy_sequence (this);
2788 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2791 sequence
= append_key (this, key
);
2793 if (!NILP (where_is_cache
))
2795 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2796 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2803 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2805 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2806 doc
: /* Insert the list of all defined keys and their definitions.
2807 The list is inserted in the current buffer, while the bindings are
2808 looked up in BUFFER.
2809 The optional argument PREFIX, if non-nil, should be a key sequence;
2810 then we display only bindings that start with that prefix.
2811 The optional argument MENUS, if non-nil, says to mention menu bindings.
2812 \(Ordinarily these are omitted from the output.) */)
2813 (buffer
, prefix
, menus
)
2814 Lisp_Object buffer
, prefix
, menus
;
2816 Lisp_Object outbuf
, shadow
;
2817 int nomenu
= NILP (menus
);
2818 register Lisp_Object start1
;
2819 struct gcpro gcpro1
;
2821 char *alternate_heading
2823 Keyboard translations:\n\n\
2824 You type Translation\n\
2825 -------- -----------\n";
2830 outbuf
= Fcurrent_buffer ();
2832 /* Report on alternates for keys. */
2833 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2836 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2837 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2839 for (c
= 0; c
< translate_len
; c
++)
2840 if (translate
[c
] != c
)
2842 char buf
[KEY_DESCRIPTION_SIZE
];
2845 if (alternate_heading
)
2847 insert_string (alternate_heading
);
2848 alternate_heading
= 0;
2851 bufend
= push_key_description (translate
[c
], buf
, 1);
2852 insert (buf
, bufend
- buf
);
2853 Findent_to (make_number (16), make_number (1));
2854 bufend
= push_key_description (c
, buf
, 1);
2855 insert (buf
, bufend
- buf
);
2859 /* Insert calls signal_after_change which may GC. */
2860 translate
= SDATA (Vkeyboard_translate_table
);
2866 if (!NILP (Vkey_translation_map
))
2867 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2868 "Key translations", nomenu
, 1, 0, 0);
2871 /* Print the (major mode) local map. */
2873 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2874 start1
= current_kboard
->Voverriding_terminal_local_map
;
2875 else if (!NILP (Voverriding_local_map
))
2876 start1
= Voverriding_local_map
;
2880 describe_map_tree (start1
, 1, shadow
, prefix
,
2881 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2882 shadow
= Fcons (start1
, shadow
);
2886 /* Print the minor mode and major mode keymaps. */
2888 Lisp_Object
*modes
, *maps
;
2890 /* Temporarily switch to `buffer', so that we can get that buffer's
2891 minor modes correctly. */
2892 Fset_buffer (buffer
);
2894 nmaps
= current_minor_maps (&modes
, &maps
);
2895 Fset_buffer (outbuf
);
2897 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2898 XBUFFER (buffer
), Qkeymap
);
2901 describe_map_tree (start1
, 1, shadow
, prefix
,
2902 "\f\n`keymap' Property Bindings", nomenu
,
2904 shadow
= Fcons (start1
, shadow
);
2907 /* Print the minor mode maps. */
2908 for (i
= 0; i
< nmaps
; i
++)
2910 /* The title for a minor mode keymap
2911 is constructed at run time.
2912 We let describe_map_tree do the actual insertion
2913 because it takes care of other features when doing so. */
2916 if (!SYMBOLP (modes
[i
]))
2919 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2923 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2924 SCHARS (SYMBOL_NAME (modes
[i
])));
2925 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2927 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2928 p
+= sizeof (" Minor Mode Bindings") - 1;
2931 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2932 title
, nomenu
, 0, 0, 0);
2933 shadow
= Fcons (maps
[i
], shadow
);
2936 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2937 XBUFFER (buffer
), Qlocal_map
);
2940 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2941 describe_map_tree (start1
, 1, shadow
, prefix
,
2942 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2944 describe_map_tree (start1
, 1, shadow
, prefix
,
2945 "\f\n`local-map' Property Bindings",
2948 shadow
= Fcons (start1
, shadow
);
2952 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2953 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2955 /* Print the function-key-map translations under this prefix. */
2956 if (!NILP (Vfunction_key_map
))
2957 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2958 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2964 /* Insert a description of the key bindings in STARTMAP,
2965 followed by those of all maps reachable through STARTMAP.
2966 If PARTIAL is nonzero, omit certain "uninteresting" commands
2967 (such as `undefined').
2968 If SHADOW is non-nil, it is a list of maps;
2969 don't mention keys which would be shadowed by any of them.
2970 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2971 TITLE, if not 0, is a string to insert at the beginning.
2972 TITLE should not end with a colon or a newline; we supply that.
2973 If NOMENU is not 0, then omit menu-bar commands.
2975 If TRANSL is nonzero, the definitions are actually key translations
2976 so print strings and vectors differently.
2978 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2981 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
2982 don't omit it; instead, mention it but say it is shadowed. */
2985 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2986 always_title
, mention_shadow
)
2987 Lisp_Object startmap
, shadow
, prefix
;
2995 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2996 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3003 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3006 GCPRO3 (maps
, seen
, sub_shadows
);
3012 /* Delete from MAPS each element that is for the menu bar. */
3013 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3015 Lisp_Object elt
, prefix
, tem
;
3018 prefix
= Fcar (elt
);
3019 if (XVECTOR (prefix
)->size
>= 1)
3021 tem
= Faref (prefix
, make_number (0));
3022 if (EQ (tem
, Qmenu_bar
))
3023 maps
= Fdelq (elt
, maps
);
3028 if (!NILP (maps
) || always_title
)
3032 insert_string (title
);
3035 insert_string (" Starting With ");
3036 insert1 (Fkey_description (prefix
, Qnil
));
3038 insert_string (":\n");
3040 insert_string (key_heading
);
3044 for (; !NILP (maps
); maps
= Fcdr (maps
))
3046 register Lisp_Object elt
, prefix
, tail
;
3049 prefix
= Fcar (elt
);
3053 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3057 shmap
= XCAR (tail
);
3059 /* If the sequence by which we reach this keymap is zero-length,
3060 then the shadow map for this keymap is just SHADOW. */
3061 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3062 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3064 /* If the sequence by which we reach this keymap actually has
3065 some elements, then the sequence's definition in SHADOW is
3066 what we should use. */
3069 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3070 if (INTEGERP (shmap
))
3074 /* If shmap is not nil and not a keymap,
3075 it completely shadows this map, so don't
3076 describe this map at all. */
3077 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3081 sub_shadows
= Fcons (shmap
, sub_shadows
);
3084 /* Maps we have already listed in this loop shadow this map. */
3085 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3088 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3090 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3093 describe_map (Fcdr (elt
), prefix
,
3094 transl
? describe_translation
: describe_command
,
3095 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3101 insert_string ("\n");
3106 static int previous_description_column
;
3109 describe_command (definition
, args
)
3110 Lisp_Object definition
, args
;
3112 register Lisp_Object tem1
;
3113 int column
= (int) current_column (); /* iftc */
3114 int description_column
;
3116 /* If column 16 is no good, go to col 32;
3117 but don't push beyond that--go to next line instead. */
3121 description_column
= 32;
3123 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3124 description_column
= 32;
3126 description_column
= 16;
3128 Findent_to (make_number (description_column
), make_number (1));
3129 previous_description_column
= description_column
;
3131 if (SYMBOLP (definition
))
3133 tem1
= SYMBOL_NAME (definition
);
3135 insert_string ("\n");
3137 else if (STRINGP (definition
) || VECTORP (definition
))
3138 insert_string ("Keyboard Macro\n");
3139 else if (KEYMAPP (definition
))
3140 insert_string ("Prefix Command\n");
3142 insert_string ("??\n");
3146 describe_translation (definition
, args
)
3147 Lisp_Object definition
, args
;
3149 register Lisp_Object tem1
;
3151 Findent_to (make_number (16), make_number (1));
3153 if (SYMBOLP (definition
))
3155 tem1
= SYMBOL_NAME (definition
);
3157 insert_string ("\n");
3159 else if (STRINGP (definition
) || VECTORP (definition
))
3161 insert1 (Fkey_description (definition
, Qnil
));
3162 insert_string ("\n");
3164 else if (KEYMAPP (definition
))
3165 insert_string ("Prefix Command\n");
3167 insert_string ("??\n");
3170 /* describe_map puts all the usable elements of a sparse keymap
3171 into an array of `struct describe_map_elt',
3172 then sorts them by the events. */
3174 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3176 /* qsort comparison function for sorting `struct describe_map_elt' by
3180 describe_map_compare (aa
, bb
)
3181 const void *aa
, *bb
;
3183 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3184 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3185 return ((XINT (a
->event
) > XINT (b
->event
))
3186 - (XINT (a
->event
) < XINT (b
->event
)));
3187 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3189 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3191 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3192 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3193 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3198 /* Describe the contents of map MAP, assuming that this map itself is
3199 reached by the sequence of prefix keys PREFIX (a string or vector).
3200 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3203 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3204 seen
, nomenu
, mention_shadow
)
3205 register Lisp_Object map
;
3207 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3214 Lisp_Object tail
, definition
, event
;
3216 Lisp_Object suppress
;
3219 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3221 /* These accumulate the values from sparse keymap bindings,
3222 so we can sort them and handle them in order. */
3223 int length_needed
= 0;
3224 struct describe_map_elt
*vect
;
3231 suppress
= intern ("suppress-keymap");
3233 /* This vector gets used to present single keys to Flookup_key. Since
3234 that is done once per keymap element, we don't want to cons up a
3235 fresh vector every time. */
3236 kludge
= Fmake_vector (make_number (1), Qnil
);
3239 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3242 vect
= ((struct describe_map_elt
*)
3243 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3245 GCPRO3 (prefix
, definition
, kludge
);
3247 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3251 if (VECTORP (XCAR (tail
))
3252 || CHAR_TABLE_P (XCAR (tail
)))
3253 describe_vector (XCAR (tail
),
3254 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3255 (int *)0, 0, 1, mention_shadow
);
3256 else if (CONSP (XCAR (tail
)))
3258 int this_shadowed
= 0;
3260 event
= XCAR (XCAR (tail
));
3262 /* Ignore bindings whose "prefix" are not really valid events.
3263 (We get these in the frames and buffers menu.) */
3264 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3267 if (nomenu
&& EQ (event
, Qmenu_bar
))
3270 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3272 /* Don't show undefined commands or suppressed commands. */
3273 if (NILP (definition
)) continue;
3274 if (SYMBOLP (definition
) && partial
)
3276 tem
= Fget (definition
, suppress
);
3281 /* Don't show a command that isn't really visible
3282 because a local definition of the same key shadows it. */
3284 ASET (kludge
, 0, event
);
3287 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3297 tem
= Flookup_key (map
, kludge
, Qt
);
3298 if (!EQ (tem
, definition
)) continue;
3300 vect
[slots_used
].event
= event
;
3301 vect
[slots_used
].definition
= definition
;
3302 vect
[slots_used
].shadowed
= this_shadowed
;
3305 else if (EQ (XCAR (tail
), Qkeymap
))
3307 /* The same keymap might be in the structure twice, if we're
3308 using an inherited keymap. So skip anything we've already
3310 tem
= Fassq (tail
, *seen
);
3311 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3313 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3317 /* If we found some sparse map events, sort them. */
3319 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3320 describe_map_compare
);
3322 /* Now output them in sorted order. */
3324 for (i
= 0; i
< slots_used
; i
++)
3326 Lisp_Object start
, end
;
3330 previous_description_column
= 0;
3335 ASET (kludge
, 0, vect
[i
].event
);
3336 start
= vect
[i
].event
;
3339 definition
= vect
[i
].definition
;
3341 /* Find consecutive chars that are identically defined. */
3342 if (INTEGERP (vect
[i
].event
))
3344 while (i
+ 1 < slots_used
3345 && XINT (vect
[i
+ 1].event
) == XINT (vect
[i
].event
) + 1
3346 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3347 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3349 end
= vect
[i
].event
;
3352 /* Now START .. END is the range to describe next. */
3354 /* Insert the string to describe the event START. */
3355 insert1 (Fkey_description (kludge
, prefix
));
3357 if (!EQ (start
, end
))
3361 ASET (kludge
, 0, end
);
3362 /* Insert the string to describe the character END. */
3363 insert1 (Fkey_description (kludge
, prefix
));
3366 /* Print a description of the definition of this character.
3367 elt_describer will take care of spacing out far enough
3368 for alignment purposes. */
3369 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3371 if (vect
[i
].shadowed
)
3374 insert_string (" (binding currently shadowed)");
3383 describe_vector_princ (elt
, fun
)
3384 Lisp_Object elt
, fun
;
3386 Findent_to (make_number (16), make_number (1));
3391 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3392 doc
: /* Insert a description of contents of VECTOR.
3393 This is text showing the elements of vector matched against indices.
3394 DESCRIBER is the output function used; nil means use `princ'. */)
3396 Lisp_Object vector
, describer
;
3398 int count
= SPECPDL_INDEX ();
3399 if (NILP (describer
))
3400 describer
= intern ("princ");
3401 specbind (Qstandard_output
, Fcurrent_buffer ());
3402 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3403 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3404 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3406 return unbind_to (count
, Qnil
);
3409 /* Insert in the current buffer a description of the contents of VECTOR.
3410 We call ELT_DESCRIBER to insert the description of one value found
3413 ELT_PREFIX describes what "comes before" the keys or indices defined
3414 by this vector. This is a human-readable string whose size
3415 is not necessarily related to the situation.
3417 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3418 leads to this keymap.
3420 If the vector is a chartable, ELT_PREFIX is the vector
3421 of bytes that lead to the character set or portion of a character
3422 set described by this chartable.
3424 If PARTIAL is nonzero, it means do not mention suppressed commands
3425 (that assumes the vector is in a keymap).
3427 SHADOW is a list of keymaps that shadow this map.
3428 If it is non-nil, then we look up the key in those maps
3429 and we don't mention it now if it is defined by any of them.
3431 ENTIRE_MAP is the keymap in which this vector appears.
3432 If the definition in effect in the whole map does not match
3433 the one in this vector, we ignore this one.
3435 When describing a sub-char-table, INDICES is a list of
3436 indices at higher levels in this char-table,
3437 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3439 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3441 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3444 describe_vector (vector
, prefix
, args
, elt_describer
,
3445 partial
, shadow
, entire_map
,
3446 indices
, char_table_depth
, keymap_p
,
3448 register Lisp_Object vector
;
3449 Lisp_Object prefix
, args
;
3450 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3453 Lisp_Object entire_map
;
3455 int char_table_depth
;
3459 Lisp_Object definition
;
3461 Lisp_Object elt_prefix
= Qnil
;
3463 Lisp_Object suppress
;
3466 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3467 /* Range of elements to be handled. */
3469 /* A flag to tell if a leaf in this level of char-table is not a
3470 generic character (i.e. a complete multibyte character). */
3478 indices
= (int *) alloca (3 * sizeof (int));
3484 /* Call Fkey_description first, to avoid GC bug for the other string. */
3485 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3488 tem
= Fkey_description (prefix
, Qnil
);
3489 elt_prefix
= concat2 (tem
, build_string (" "));
3494 /* This vector gets used to present single keys to Flookup_key. Since
3495 that is done once per vector element, we don't want to cons up a
3496 fresh vector every time. */
3497 kludge
= Fmake_vector (make_number (1), Qnil
);
3498 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3501 suppress
= intern ("suppress-keymap");
3503 if (CHAR_TABLE_P (vector
))
3505 if (char_table_depth
== 0)
3507 /* VECTOR is a top level char-table. */
3510 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3514 /* VECTOR is a sub char-table. */
3515 if (char_table_depth
>= 3)
3516 /* A char-table is never that deep. */
3517 error ("Too deep char table");
3520 = (CHARSET_VALID_P (indices
[0])
3521 && ((CHARSET_DIMENSION (indices
[0]) == 1
3522 && char_table_depth
== 1)
3523 || char_table_depth
== 2));
3525 /* Meaningful elements are from 32th to 127th. */
3527 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3532 /* This does the right thing for ordinary vectors. */
3536 to
= XVECTOR (vector
)->size
;
3539 for (i
= from
; i
< to
; i
++)
3541 int this_shadowed
= 0;
3544 if (CHAR_TABLE_P (vector
))
3546 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3549 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3550 && !CHARSET_DEFINED_P (i
- 128))
3554 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3557 definition
= get_keyelt (AREF (vector
, i
), 0);
3559 if (NILP (definition
)) continue;
3561 /* Don't mention suppressed commands. */
3562 if (SYMBOLP (definition
) && partial
)
3566 tem
= Fget (definition
, suppress
);
3568 if (!NILP (tem
)) continue;
3571 /* Set CHARACTER to the character this entry describes, if any.
3572 Also update *INDICES. */
3573 if (CHAR_TABLE_P (vector
))
3575 indices
[char_table_depth
] = i
;
3577 if (char_table_depth
== 0)
3580 indices
[0] = i
- 128;
3582 else if (complete_char
)
3584 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3592 ASET (kludge
, 0, make_number (character
));
3594 /* If this binding is shadowed by some other map, ignore it. */
3595 if (!NILP (shadow
) && complete_char
)
3599 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3610 /* Ignore this definition if it is shadowed by an earlier
3611 one in the same keymap. */
3612 if (!NILP (entire_map
) && complete_char
)
3616 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3618 if (!EQ (tem
, definition
))
3624 if (char_table_depth
== 0)
3629 /* For a sub char-table, show the depth by indentation.
3630 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3631 if (char_table_depth
> 0)
3632 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3634 /* Output the prefix that applies to every entry in this map. */
3635 if (!NILP (elt_prefix
))
3636 insert1 (elt_prefix
);
3638 /* Insert or describe the character this slot is for,
3639 or a description of what it is for. */
3640 if (SUB_CHAR_TABLE_P (vector
))
3643 insert_char (character
);
3646 /* We need an octal representation for this block of
3649 sprintf (work
, "(row %d)", i
);
3650 insert (work
, strlen (work
));
3653 else if (CHAR_TABLE_P (vector
))
3656 insert1 (Fkey_description (kludge
, prefix
));
3659 /* Print the information for this character set. */
3660 insert_string ("<");
3661 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3663 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3672 insert1 (Fkey_description (kludge
, prefix
));
3675 /* If we find a sub char-table within a char-table,
3676 scan it recursively; it defines the details for
3677 a character set or a portion of a character set. */
3678 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3681 describe_vector (definition
, prefix
, args
, elt_describer
,
3682 partial
, shadow
, entire_map
,
3683 indices
, char_table_depth
+ 1, keymap_p
,
3690 /* Find all consecutive characters or rows that have the same
3691 definition. But, for elements of a top level char table, if
3692 they are for charsets, we had better describe one by one even
3693 if they have the same definition. */
3694 if (CHAR_TABLE_P (vector
))
3698 if (char_table_depth
== 0)
3699 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3701 while (i
+ 1 < limit
3702 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3704 && !NILP (Fequal (tem2
, definition
)))
3709 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3711 && !NILP (Fequal (tem2
, definition
)))
3715 /* If we have a range of more than one character,
3716 print where the range reaches to. */
3718 if (i
!= starting_i
)
3722 ASET (kludge
, 0, make_number (i
));
3724 if (!NILP (elt_prefix
))
3725 insert1 (elt_prefix
);
3727 if (CHAR_TABLE_P (vector
))
3729 if (char_table_depth
== 0)
3731 insert1 (Fkey_description (kludge
, prefix
));
3733 else if (complete_char
)
3735 indices
[char_table_depth
] = i
;
3736 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3737 insert_char (character
);
3741 /* We need an octal representation for this block of
3744 sprintf (work
, "(row %d)", i
);
3745 insert (work
, strlen (work
));
3750 insert1 (Fkey_description (kludge
, prefix
));
3754 /* Print a description of the definition of this character.
3755 elt_describer will take care of spacing out far enough
3756 for alignment purposes. */
3757 (*elt_describer
) (definition
, args
);
3762 insert_string (" (binding currently shadowed)");
3767 /* For (sub) char-table, print `defalt' slot at last. */
3768 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3770 insert (" ", char_table_depth
* 2);
3771 insert_string ("<<default>>");
3772 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3778 /* Apropos - finding all symbols whose names match a regexp. */
3779 static Lisp_Object apropos_predicate
;
3780 static Lisp_Object apropos_accumulate
;
3783 apropos_accum (symbol
, string
)
3784 Lisp_Object symbol
, string
;
3786 register Lisp_Object tem
;
3788 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3789 if (!NILP (tem
) && !NILP (apropos_predicate
))
3790 tem
= call1 (apropos_predicate
, symbol
);
3792 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3795 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3796 doc
: /* Show all symbols whose names contain match for REGEXP.
3797 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3798 for each symbol and a symbol is mentioned only if that returns non-nil.
3799 Return list of symbols found. */)
3801 Lisp_Object regexp
, predicate
;
3804 CHECK_STRING (regexp
);
3805 apropos_predicate
= predicate
;
3806 apropos_accumulate
= Qnil
;
3807 map_obarray (Vobarray
, apropos_accum
, regexp
);
3808 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3809 apropos_accumulate
= Qnil
;
3810 apropos_predicate
= Qnil
;
3817 Qkeymap
= intern ("keymap");
3818 staticpro (&Qkeymap
);
3819 staticpro (&apropos_predicate
);
3820 staticpro (&apropos_accumulate
);
3821 apropos_predicate
= Qnil
;
3822 apropos_accumulate
= Qnil
;
3824 /* Now we are ready to set up this property, so we can
3825 create char tables. */
3826 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3828 /* Initialize the keymaps standardly used.
3829 Each one is the value of a Lisp variable, and is also
3830 pointed to by a C variable */
3832 global_map
= Fmake_keymap (Qnil
);
3833 Fset (intern ("global-map"), global_map
);
3835 current_global_map
= global_map
;
3836 staticpro (&global_map
);
3837 staticpro (¤t_global_map
);
3839 meta_map
= Fmake_keymap (Qnil
);
3840 Fset (intern ("esc-map"), meta_map
);
3841 Ffset (intern ("ESC-prefix"), meta_map
);
3843 control_x_map
= Fmake_keymap (Qnil
);
3844 Fset (intern ("ctl-x-map"), control_x_map
);
3845 Ffset (intern ("Control-X-prefix"), control_x_map
);
3848 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3849 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3850 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3851 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3852 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3854 staticpro (&exclude_keys
);
3856 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3857 doc
: /* List of commands given new key bindings recently.
3858 This is used for internal purposes during Emacs startup;
3859 don't alter it yourself. */);
3860 Vdefine_key_rebound_commands
= Qt
;
3862 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3863 doc
: /* Default keymap to use when reading from the minibuffer. */);
3864 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3866 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3867 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3868 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3869 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3871 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3872 doc
: /* Local keymap for minibuffer input with completion. */);
3873 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3874 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3876 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3877 &Vminibuffer_local_filename_completion_map
,
3878 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3879 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3880 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3881 Vminibuffer_local_completion_map
);
3884 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3885 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3886 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3887 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3888 Vminibuffer_local_completion_map
);
3890 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3891 &Vminibuffer_local_must_match_filename_map
,
3892 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3893 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3894 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3895 Vminibuffer_local_must_match_map
);
3897 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3898 doc
: /* Alist of keymaps to use for minor modes.
3899 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3900 key sequences and look up bindings iff VARIABLE's value is non-nil.
3901 If two active keymaps bind the same key, the keymap appearing earlier
3902 in the list takes precedence. */);
3903 Vminor_mode_map_alist
= Qnil
;
3905 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3906 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3907 This variable is an alist just like `minor-mode-map-alist', and it is
3908 used the same way (and before `minor-mode-map-alist'); however,
3909 it is provided for major modes to bind locally. */);
3910 Vminor_mode_overriding_map_alist
= Qnil
;
3912 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3913 doc
: /* List of keymap alists to use for emulations modes.
3914 It is intended for modes or packages using multiple minor-mode keymaps.
3915 Each element is a keymap alist just like `minor-mode-map-alist', or a
3916 symbol with a variable binding which is a keymap alist, and it is used
3917 the same way. The "active" keymaps in each alist are used before
3918 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3919 Vemulation_mode_map_alists
= Qnil
;
3922 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3923 doc
: /* Keymap that translates key sequences to key sequences during input.
3924 This is used mainly for mapping ASCII function key sequences into
3925 real Emacs function key events (symbols).
3927 The `read-key-sequence' function replaces any subsequence bound by
3928 `function-key-map' with its binding. More precisely, when the active
3929 keymaps have no binding for the current key sequence but
3930 `function-key-map' binds a suffix of the sequence to a vector or string,
3931 `read-key-sequence' replaces the matching suffix with its binding, and
3932 continues with the new sequence.
3934 If the binding is a function, it is called with one argument (the prompt)
3935 and its return value (a key sequence) is used.
3937 The events that come from bindings in `function-key-map' are not
3938 themselves looked up in `function-key-map'.
3940 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3941 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3942 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3943 key, typing `ESC O P x' would return [f1 x]. */);
3944 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3946 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3947 doc
: /* Keymap of key translations that can override keymaps.
3948 This keymap works like `function-key-map', but comes after that,
3949 and its non-prefix bindings override ordinary bindings. */);
3950 Vkey_translation_map
= Qnil
;
3952 staticpro (&Vmouse_events
);
3953 Vmouse_events
= Fcons (intern ("menu-bar"),
3954 Fcons (intern ("tool-bar"),
3955 Fcons (intern ("header-line"),
3956 Fcons (intern ("mode-line"),
3957 Fcons (intern ("mouse-1"),
3958 Fcons (intern ("mouse-2"),
3959 Fcons (intern ("mouse-3"),
3960 Fcons (intern ("mouse-4"),
3961 Fcons (intern ("mouse-5"),
3965 Qsingle_key_description
= intern ("single-key-description");
3966 staticpro (&Qsingle_key_description
);
3968 Qkey_description
= intern ("key-description");
3969 staticpro (&Qkey_description
);
3971 Qkeymapp
= intern ("keymapp");
3972 staticpro (&Qkeymapp
);
3974 Qnon_ascii
= intern ("non-ascii");
3975 staticpro (&Qnon_ascii
);
3977 Qmenu_item
= intern ("menu-item");
3978 staticpro (&Qmenu_item
);
3980 Qremap
= intern ("remap");
3981 staticpro (&Qremap
);
3983 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3984 staticpro (&command_remapping_vector
);
3986 where_is_cache_keymaps
= Qt
;
3987 where_is_cache
= Qnil
;
3988 staticpro (&where_is_cache
);
3989 staticpro (&where_is_cache_keymaps
);
3991 defsubr (&Skeymapp
);
3992 defsubr (&Skeymap_parent
);
3993 defsubr (&Skeymap_prompt
);
3994 defsubr (&Sset_keymap_parent
);
3995 defsubr (&Smake_keymap
);
3996 defsubr (&Smake_sparse_keymap
);
3997 defsubr (&Smap_keymap
);
3998 defsubr (&Scopy_keymap
);
3999 defsubr (&Scommand_remapping
);
4000 defsubr (&Skey_binding
);
4001 defsubr (&Slocal_key_binding
);
4002 defsubr (&Sglobal_key_binding
);
4003 defsubr (&Sminor_mode_key_binding
);
4004 defsubr (&Sdefine_key
);
4005 defsubr (&Slookup_key
);
4006 defsubr (&Sdefine_prefix_command
);
4007 defsubr (&Suse_global_map
);
4008 defsubr (&Suse_local_map
);
4009 defsubr (&Scurrent_local_map
);
4010 defsubr (&Scurrent_global_map
);
4011 defsubr (&Scurrent_minor_mode_maps
);
4012 defsubr (&Scurrent_active_maps
);
4013 defsubr (&Saccessible_keymaps
);
4014 defsubr (&Skey_description
);
4015 defsubr (&Sdescribe_vector
);
4016 defsubr (&Ssingle_key_description
);
4017 defsubr (&Stext_char_description
);
4018 defsubr (&Swhere_is_internal
);
4019 defsubr (&Sdescribe_buffer_bindings
);
4020 defsubr (&Sapropos_internal
);
4026 initial_define_key (global_map
, 033, "ESC-prefix");
4027 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
4030 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
4031 (do not change this comment) */