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
;
703 GCPRO3 (map
, args
, tail
);
704 map
= get_keymap (map
, 1, autoload
);
705 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
706 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
709 Lisp_Object binding
= XCAR (tail
);
712 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
713 else if (VECTORP (binding
))
715 /* Loop over the char values represented in the vector. */
716 int len
= ASIZE (binding
);
718 for (c
= 0; c
< len
; c
++)
720 Lisp_Object character
;
721 XSETFASTINT (character
, c
);
722 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
725 else if (CHAR_TABLE_P (binding
))
727 Lisp_Object indices
[3];
728 map_char_table (map_keymap_char_table_item
, Qnil
, binding
, binding
,
729 Fcons (make_save_value (fun
, 0),
730 Fcons (make_save_value (data
, 0),
739 map_keymap_call (key
, val
, fun
, dummy
)
740 Lisp_Object key
, val
, fun
;
743 call2 (fun
, key
, val
);
746 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
747 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
748 FUNCTION is called with two arguments: the event that is bound, and
749 the definition it is bound to.
751 If KEYMAP has a parent, the parent's bindings are included as well.
752 This works recursively: if the parent has itself a parent, then the
753 grandparent's bindings are also included and so on.
754 usage: (map-keymap FUNCTION KEYMAP) */)
755 (function
, keymap
, sort_first
)
756 Lisp_Object function
, keymap
, sort_first
;
758 if (INTEGERP (function
))
759 /* We have to stop integers early since map_keymap gives them special
761 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
762 if (! NILP (sort_first
))
763 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
765 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
769 /* Given OBJECT which was found in a slot in a keymap,
770 trace indirect definitions to get the actual definition of that slot.
771 An indirect definition is a list of the form
772 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
773 and INDEX is the object to look up in KEYMAP to yield the definition.
775 Also if OBJECT has a menu string as the first element,
776 remove that. Also remove a menu help string as second element.
778 If AUTOLOAD is nonzero, load autoloadable keymaps
779 that are referred to with indirection.
781 This can GC because menu_item_eval_property calls Feval. */
784 get_keyelt (object
, autoload
)
790 if (!(CONSP (object
)))
791 /* This is really the value. */
794 /* If the keymap contents looks like (keymap ...) or (lambda ...)
796 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
799 /* If the keymap contents looks like (menu-item name . DEFN)
800 or (menu-item name DEFN ...) then use DEFN.
801 This is a new format menu item. */
802 else if (EQ (XCAR (object
), Qmenu_item
))
804 if (CONSP (XCDR (object
)))
808 object
= XCDR (XCDR (object
));
811 object
= XCAR (object
);
813 /* If there's a `:filter FILTER', apply FILTER to the
814 menu-item's definition to get the real definition to
816 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
817 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
820 filter
= XCAR (XCDR (tem
));
821 filter
= list2 (filter
, list2 (Qquote
, object
));
822 object
= menu_item_eval_property (filter
);
827 /* Invalid keymap. */
831 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
832 Keymap alist elements like (CHAR MENUSTRING . DEFN)
833 will be used by HierarKey menus. */
834 else if (STRINGP (XCAR (object
)))
836 object
= XCDR (object
);
837 /* Also remove a menu help string, if any,
838 following the menu item name. */
839 if (CONSP (object
) && STRINGP (XCAR (object
)))
840 object
= XCDR (object
);
841 /* Also remove the sublist that caches key equivalences, if any. */
842 if (CONSP (object
) && CONSP (XCAR (object
)))
845 carcar
= XCAR (XCAR (object
));
846 if (NILP (carcar
) || VECTORP (carcar
))
847 object
= XCDR (object
);
851 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
857 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
859 return (!CONSP (map
) ? object
/* Invalid keymap */
860 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
866 store_in_keymap (keymap
, idx
, def
)
868 register Lisp_Object idx
;
869 register Lisp_Object def
;
871 /* Flush any reverse-map cache. */
872 where_is_cache
= Qnil
;
873 where_is_cache_keymaps
= Qt
;
875 /* If we are preparing to dump, and DEF is a menu element
876 with a menu item indicator, copy it to ensure it is not pure. */
877 if (CONSP (def
) && PURE_P (def
)
878 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
879 def
= Fcons (XCAR (def
), XCDR (def
));
881 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
882 error ("attempt to define a key in a non-keymap");
884 /* If idx is a list (some sort of mouse click, perhaps?),
885 the index we want to use is the car of the list, which
886 ought to be a symbol. */
887 idx
= EVENT_HEAD (idx
);
889 /* If idx is a symbol, it might have modifiers, which need to
890 be put in the canonical order. */
892 idx
= reorder_modifiers (idx
);
893 else if (INTEGERP (idx
))
894 /* Clobber the high bits that can be present on a machine
895 with more than 24 bits of integer. */
896 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
898 /* Scan the keymap for a binding of idx. */
902 /* The cons after which we should insert new bindings. If the
903 keymap has a table element, we record its position here, so new
904 bindings will go after it; this way, the table will stay
905 towards the front of the alist and character lookups in dense
906 keymaps will remain fast. Otherwise, this just points at the
907 front of the keymap. */
908 Lisp_Object insertion_point
;
910 insertion_point
= keymap
;
911 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
918 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
921 ASET (elt
, XFASTINT (idx
), def
);
924 insertion_point
= tail
;
926 else if (CHAR_TABLE_P (elt
))
928 /* Character codes with modifiers
929 are not included in a char-table.
930 All character codes without modifiers are included. */
931 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
934 /* `nil' has a special meaning for char-tables, so
935 we use something else to record an explicitly
937 NILP (def
) ? Qt
: def
);
940 insertion_point
= tail
;
942 else if (CONSP (elt
))
944 if (EQ (idx
, XCAR (elt
)))
951 else if (EQ (elt
, Qkeymap
))
952 /* If we find a 'keymap' symbol in the spine of KEYMAP,
953 then we must have found the start of a second keymap
954 being used as the tail of KEYMAP, and a binding for IDX
955 should be inserted before it. */
962 /* We have scanned the entire keymap, and not found a binding for
963 IDX. Let's add one. */
964 CHECK_IMPURE (insertion_point
);
965 XSETCDR (insertion_point
,
966 Fcons (Fcons (idx
, def
), XCDR (insertion_point
)));
972 EXFUN (Fcopy_keymap
, 1);
975 copy_keymap_item (elt
)
978 Lisp_Object res
, tem
;
985 /* Is this a new format menu item. */
986 if (EQ (XCAR (tem
), Qmenu_item
))
988 /* Copy cell with menu-item marker. */
989 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
993 /* Copy cell with menu-item name. */
994 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1000 /* Copy cell with binding and if the binding is a keymap,
1002 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1005 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1006 XSETCAR (elt
, Fcopy_keymap (tem
));
1008 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1009 /* Delete cache for key equivalences. */
1010 XSETCDR (elt
, XCDR (tem
));
1015 /* It may be an old fomat menu item.
1016 Skip the optional menu string. */
1017 if (STRINGP (XCAR (tem
)))
1019 /* Copy the cell, since copy-alist didn't go this deep. */
1020 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1022 /* Also skip the optional menu help string. */
1023 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1025 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1029 /* There may also be a list that caches key equivalences.
1030 Just delete it for the new keymap. */
1032 && CONSP (XCAR (tem
))
1033 && (NILP (XCAR (XCAR (tem
)))
1034 || VECTORP (XCAR (XCAR (tem
)))))
1036 XSETCDR (elt
, XCDR (tem
));
1039 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1040 XSETCDR (elt
, Fcopy_keymap (tem
));
1042 else if (EQ (XCAR (tem
), Qkeymap
))
1043 res
= Fcopy_keymap (elt
);
1049 copy_keymap_1 (chartable
, idx
, elt
)
1050 Lisp_Object chartable
, idx
, elt
;
1052 Faset (chartable
, idx
, copy_keymap_item (elt
));
1055 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1056 doc
: /* Return a copy of the keymap KEYMAP.
1057 The copy starts out with the same definitions of KEYMAP,
1058 but changing either the copy or KEYMAP does not affect the other.
1059 Any key definitions that are subkeymaps are recursively copied.
1060 However, a key definition which is a symbol whose definition is a keymap
1065 register Lisp_Object copy
, tail
;
1066 keymap
= get_keymap (keymap
, 1, 0);
1067 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1068 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1070 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1072 Lisp_Object elt
= XCAR (keymap
);
1073 if (CHAR_TABLE_P (elt
))
1075 Lisp_Object indices
[3];
1076 elt
= Fcopy_sequence (elt
);
1077 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, elt
, 0, indices
);
1079 else if (VECTORP (elt
))
1082 elt
= Fcopy_sequence (elt
);
1083 for (i
= 0; i
< ASIZE (elt
); i
++)
1084 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1086 else if (CONSP (elt
))
1087 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1088 XSETCDR (tail
, Fcons (elt
, Qnil
));
1090 keymap
= XCDR (keymap
);
1092 XSETCDR (tail
, keymap
);
1096 /* Simple Keymap mutators and accessors. */
1098 /* GC is possible in this function if it autoloads a keymap. */
1100 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1101 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1104 KEY is a string or a vector of symbols and characters meaning a
1105 sequence of keystrokes and events. Non-ASCII characters with codes
1106 above 127 (such as ISO Latin-1) can be included if you use a vector.
1107 Using [t] for KEY creates a default definition, which applies to any
1108 event type that has no other definition in this keymap.
1110 DEF is anything that can be a key's definition:
1111 nil (means key is undefined in this keymap),
1112 a command (a Lisp function suitable for interactive calling),
1113 a string (treated as a keyboard macro),
1114 a keymap (to define a prefix key),
1115 a symbol (when the key is looked up, the symbol will stand for its
1116 function definition, which should at that time be one of the above,
1117 or another symbol whose function definition is used, etc.),
1118 a cons (STRING . DEFN), meaning that DEFN is the definition
1119 (DEFN should be a valid definition in its own right),
1120 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1122 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1123 binding is altered. If there is no binding for KEY, the new pair
1124 binding KEY to DEF is added at the front of KEYMAP. */)
1131 register Lisp_Object c
;
1132 register Lisp_Object cmd
;
1136 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1138 GCPRO3 (keymap
, key
, def
);
1139 keymap
= get_keymap (keymap
, 1, 1);
1141 if (!VECTORP (key
) && !STRINGP (key
))
1142 key
= wrong_type_argument (Qarrayp
, key
);
1144 length
= XFASTINT (Flength (key
));
1146 RETURN_UNGCPRO (Qnil
);
1148 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1149 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1151 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1156 c
= Faref (key
, make_number (idx
));
1158 if (CONSP (c
) && lucid_event_type_list_p (c
))
1159 c
= Fevent_convert_list (c
);
1162 silly_event_symbol_error (c
);
1165 && (XINT (c
) & meta_bit
)
1168 c
= meta_prefix_char
;
1174 XSETINT (c
, XINT (c
) & ~meta_bit
);
1180 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1181 error ("Key sequence contains invalid event");
1184 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1186 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1188 /* If this key is undefined, make it a prefix. */
1190 cmd
= define_as_prefix (keymap
, c
);
1192 keymap
= get_keymap (cmd
, 0, 1);
1193 if (!CONSP (keymap
))
1194 /* We must use Fkey_description rather than just passing key to
1195 error; key might be a vector, not a string. */
1196 error ("Key sequence %s uses invalid prefix characters",
1197 SDATA (Fkey_description (key
, Qnil
)));
1201 /* This function may GC (it calls Fkey_binding). */
1203 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1204 doc
: /* Return the remapping for command COMMAND in current keymaps.
1205 Returns nil if COMMAND is not remapped (or not a symbol). */)
1207 Lisp_Object command
;
1209 if (!SYMBOLP (command
))
1212 ASET (command_remapping_vector
, 1, command
);
1213 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1216 /* Value is number if KEY is too long; nil if valid but has no definition. */
1217 /* GC is possible in this function if it autoloads a keymap. */
1219 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1220 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1221 nil means undefined. See doc of `define-key' for kinds of definitions.
1223 A number as value means KEY is "too long";
1224 that is, characters or symbols in it except for the last one
1225 fail to be a valid sequence of prefix characters in KEYMAP.
1226 The number is how many characters at the front of KEY
1227 it takes to reach a non-prefix key.
1229 Normally, `lookup-key' ignores bindings for t, which act as default
1230 bindings, used when nothing else in the keymap applies; this makes it
1231 usable as a general function for probing keymaps. However, if the
1232 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1233 recognize the default bindings, just as `read-key-sequence' does. */)
1234 (keymap
, key
, accept_default
)
1237 Lisp_Object accept_default
;
1240 register Lisp_Object cmd
;
1241 register Lisp_Object c
;
1243 int t_ok
= !NILP (accept_default
);
1244 struct gcpro gcpro1
, gcpro2
;
1246 GCPRO2 (keymap
, key
);
1247 keymap
= get_keymap (keymap
, 1, 1);
1249 if (!VECTORP (key
) && !STRINGP (key
))
1250 key
= wrong_type_argument (Qarrayp
, key
);
1252 length
= XFASTINT (Flength (key
));
1254 RETURN_UNGCPRO (keymap
);
1259 c
= Faref (key
, make_number (idx
++));
1261 if (CONSP (c
) && lucid_event_type_list_p (c
))
1262 c
= Fevent_convert_list (c
);
1264 /* Turn the 8th bit of string chars into a meta modifier. */
1265 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1266 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1268 /* Allow string since binding for `menu-bar-select-buffer'
1269 includes the buffer name in the key sequence. */
1270 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1271 error ("Key sequence contains invalid event");
1273 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1275 RETURN_UNGCPRO (cmd
);
1277 keymap
= get_keymap (cmd
, 0, 1);
1278 if (!CONSP (keymap
))
1279 RETURN_UNGCPRO (make_number (idx
));
1285 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1286 Assume that currently it does not define C at all.
1287 Return the keymap. */
1290 define_as_prefix (keymap
, c
)
1291 Lisp_Object keymap
, c
;
1295 cmd
= Fmake_sparse_keymap (Qnil
);
1296 /* If this key is defined as a prefix in an inherited keymap,
1297 make it a prefix in this map, and make its definition
1298 inherit the other prefix definition. */
1299 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1300 store_in_keymap (keymap
, c
, cmd
);
1305 /* Append a key to the end of a key sequence. We always make a vector. */
1308 append_key (key_sequence
, key
)
1309 Lisp_Object key_sequence
, key
;
1311 Lisp_Object args
[2];
1313 args
[0] = key_sequence
;
1315 args
[1] = Fcons (key
, Qnil
);
1316 return Fvconcat (2, args
);
1319 /* Given a event type C which is a symbol,
1320 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1323 silly_event_symbol_error (c
)
1326 Lisp_Object parsed
, base
, name
, assoc
;
1329 parsed
= parse_modifiers (c
);
1330 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1331 base
= XCAR (parsed
);
1332 name
= Fsymbol_name (base
);
1333 /* This alist includes elements such as ("RET" . "\\r"). */
1334 assoc
= Fassoc (name
, exclude_keys
);
1338 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1340 Lisp_Object keystring
;
1341 if (modifiers
& alt_modifier
)
1342 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1343 if (modifiers
& ctrl_modifier
)
1344 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1345 if (modifiers
& hyper_modifier
)
1346 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1347 if (modifiers
& meta_modifier
)
1348 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1349 if (modifiers
& shift_modifier
)
1350 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1351 if (modifiers
& super_modifier
)
1352 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1355 c
= reorder_modifiers (c
);
1356 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1358 error ((modifiers
& ~meta_modifier
1359 ? "To bind the key %s, use [?%s], not [%s]"
1360 : "To bind the key %s, use \"%s\", not [%s]"),
1361 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1362 SDATA (SYMBOL_NAME (c
)));
1366 /* Global, local, and minor mode keymap stuff. */
1368 /* We can't put these variables inside current_minor_maps, since under
1369 some systems, static gets macro-defined to be the empty string.
1371 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1372 static int cmm_size
= 0;
1374 /* Store a pointer to an array of the keymaps of the currently active
1375 minor modes in *buf, and return the number of maps it contains.
1377 This function always returns a pointer to the same buffer, and may
1378 free or reallocate it, so if you want to keep it for a long time or
1379 hand it out to lisp code, copy it. This procedure will be called
1380 for every key sequence read, so the nice lispy approach (return a
1381 new assoclist, list, what have you) for each invocation would
1382 result in a lot of consing over time.
1384 If we used xrealloc/xmalloc and ran out of memory, they would throw
1385 back to the command loop, which would try to read a key sequence,
1386 which would call this function again, resulting in an infinite
1387 loop. Instead, we'll use realloc/malloc and silently truncate the
1388 list, let the key sequence be read, and hope some other piece of
1389 code signals the error. */
1391 current_minor_maps (modeptr
, mapptr
)
1392 Lisp_Object
**modeptr
, **mapptr
;
1395 int list_number
= 0;
1396 Lisp_Object alist
, assoc
, var
, val
;
1397 Lisp_Object emulation_alists
;
1398 Lisp_Object lists
[2];
1400 emulation_alists
= Vemulation_mode_map_alists
;
1401 lists
[0] = Vminor_mode_overriding_map_alist
;
1402 lists
[1] = Vminor_mode_map_alist
;
1404 for (list_number
= 0; list_number
< 2; list_number
++)
1406 if (CONSP (emulation_alists
))
1408 alist
= XCAR (emulation_alists
);
1409 emulation_alists
= XCDR (emulation_alists
);
1410 if (SYMBOLP (alist
))
1411 alist
= find_symbol_value (alist
);
1415 alist
= lists
[list_number
];
1417 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1418 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1419 && (var
= XCAR (assoc
), SYMBOLP (var
))
1420 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1425 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1426 and also an entry in Vminor_mode_map_alist,
1427 ignore the latter. */
1428 if (list_number
== 1)
1430 val
= assq_no_quit (var
, lists
[0]);
1437 int newsize
, allocsize
;
1438 Lisp_Object
*newmodes
, *newmaps
;
1440 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1441 allocsize
= newsize
* sizeof *newmodes
;
1443 /* Use malloc here. See the comment above this function.
1444 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1446 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1451 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1454 cmm_modes
= newmodes
;
1457 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1462 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1469 if (newmodes
== NULL
|| newmaps
== NULL
)
1474 /* Get the keymap definition--or nil if it is not defined. */
1475 temp
= Findirect_function (XCDR (assoc
), Qt
);
1479 cmm_maps
[i
] = temp
;
1485 if (modeptr
) *modeptr
= cmm_modes
;
1486 if (mapptr
) *mapptr
= cmm_maps
;
1490 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1492 doc
: /* Return a list of the currently active keymaps.
1493 OLP if non-nil indicates that we should obey `overriding-local-map' and
1494 `overriding-terminal-local-map'. */)
1498 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1502 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1503 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1504 /* The doc said that overriding-terminal-local-map should
1505 override overriding-local-map. The code used them both,
1506 but it seems clearer to use just one. rms, jan 2005. */
1507 else if (!NILP (Voverriding_local_map
))
1508 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1510 if (NILP (XCDR (keymaps
)))
1516 /* This usually returns the buffer's local map,
1517 but that can be overridden by a `local-map' property. */
1518 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1520 keymaps
= Fcons (local
, keymaps
);
1522 /* Now put all the minor mode keymaps on the list. */
1523 nmaps
= current_minor_maps (0, &maps
);
1525 for (i
= --nmaps
; i
>= 0; i
--)
1526 if (!NILP (maps
[i
]))
1527 keymaps
= Fcons (maps
[i
], keymaps
);
1529 /* This returns nil unless there is a `keymap' property. */
1530 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1532 keymaps
= Fcons (local
, keymaps
);
1538 /* GC is possible in this function if it autoloads a keymap. */
1540 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1541 doc
: /* Return the binding for command KEY in current keymaps.
1542 KEY is a string or vector, a sequence of keystrokes.
1543 The binding is probably a symbol with a function definition.
1545 Normally, `key-binding' ignores bindings for t, which act as default
1546 bindings, used when nothing else in the keymap applies; this makes it
1547 usable as a general function for probing keymaps. However, if the
1548 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1549 recognize the default bindings, just as `read-key-sequence' does.
1551 Like the normal command loop, `key-binding' will remap the command
1552 resulting from looking up KEY by looking up the command in the
1553 current keymaps. However, if the optional third argument NO-REMAP
1554 is non-nil, `key-binding' returns the unmapped command. */)
1555 (key
, accept_default
, no_remap
)
1556 Lisp_Object key
, accept_default
, no_remap
;
1558 Lisp_Object
*maps
, value
;
1560 struct gcpro gcpro1
;
1564 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1566 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1567 key
, accept_default
);
1568 if (! NILP (value
) && !INTEGERP (value
))
1571 else if (!NILP (Voverriding_local_map
))
1573 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1574 if (! NILP (value
) && !INTEGERP (value
))
1581 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1584 value
= Flookup_key (local
, key
, accept_default
);
1585 if (! NILP (value
) && !INTEGERP (value
))
1589 nmaps
= current_minor_maps (0, &maps
);
1590 /* Note that all these maps are GCPRO'd
1591 in the places where we found them. */
1593 for (i
= 0; i
< nmaps
; i
++)
1594 if (! NILP (maps
[i
]))
1596 value
= Flookup_key (maps
[i
], key
, accept_default
);
1597 if (! NILP (value
) && !INTEGERP (value
))
1601 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1604 value
= Flookup_key (local
, key
, accept_default
);
1605 if (! NILP (value
) && !INTEGERP (value
))
1610 value
= Flookup_key (current_global_map
, key
, accept_default
);
1614 if (NILP (value
) || INTEGERP (value
))
1617 /* If the result of the ordinary keymap lookup is an interactive
1618 command, look for a key binding (ie. remapping) for that command. */
1620 if (NILP (no_remap
) && SYMBOLP (value
))
1623 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1630 /* GC is possible in this function if it autoloads a keymap. */
1632 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1633 doc
: /* Return the binding for command KEYS in current local keymap only.
1634 KEYS is a string or vector, a sequence of keystrokes.
1635 The binding is probably a symbol with a function definition.
1637 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1638 bindings; see the description of `lookup-key' for more details about this. */)
1639 (keys
, accept_default
)
1640 Lisp_Object keys
, accept_default
;
1642 register Lisp_Object map
;
1643 map
= current_buffer
->keymap
;
1646 return Flookup_key (map
, keys
, accept_default
);
1649 /* GC is possible in this function if it autoloads a keymap. */
1651 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1652 doc
: /* Return the binding for command KEYS in current global keymap only.
1653 KEYS is a string or vector, a sequence of keystrokes.
1654 The binding is probably a symbol with a function definition.
1655 This function's return values are the same as those of `lookup-key'
1658 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1659 bindings; see the description of `lookup-key' for more details about this. */)
1660 (keys
, accept_default
)
1661 Lisp_Object keys
, accept_default
;
1663 return Flookup_key (current_global_map
, keys
, accept_default
);
1666 /* GC is possible in this function if it autoloads a keymap. */
1668 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1669 doc
: /* Find the visible minor mode bindings of KEY.
1670 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1671 the symbol which names the minor mode binding KEY, and BINDING is
1672 KEY's definition in that mode. In particular, if KEY has no
1673 minor-mode bindings, return nil. If the first binding is a
1674 non-prefix, all subsequent bindings will be omitted, since they would
1675 be ignored. Similarly, the list doesn't include non-prefix bindings
1676 that come after prefix bindings.
1678 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1679 bindings; see the description of `lookup-key' for more details about this. */)
1680 (key
, accept_default
)
1681 Lisp_Object key
, accept_default
;
1683 Lisp_Object
*modes
, *maps
;
1685 Lisp_Object binding
;
1687 struct gcpro gcpro1
, gcpro2
;
1689 nmaps
= current_minor_maps (&modes
, &maps
);
1690 /* Note that all these maps are GCPRO'd
1691 in the places where we found them. */
1694 GCPRO2 (key
, binding
);
1696 for (i
= j
= 0; i
< nmaps
; i
++)
1698 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1699 && !INTEGERP (binding
))
1701 if (KEYMAPP (binding
))
1702 maps
[j
++] = Fcons (modes
[i
], binding
);
1704 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1708 return Flist (j
, maps
);
1711 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1712 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1713 A new sparse keymap is stored as COMMAND's function definition and its value.
1714 If a second optional argument MAPVAR is given, the map is stored as
1715 its value instead of as COMMAND's value; but COMMAND is still defined
1717 The third optional argument NAME, if given, supplies a menu name
1718 string for the map. This is required to use the keymap as a menu.
1719 This function returns COMMAND. */)
1720 (command
, mapvar
, name
)
1721 Lisp_Object command
, mapvar
, name
;
1724 map
= Fmake_sparse_keymap (name
);
1725 Ffset (command
, map
);
1729 Fset (command
, map
);
1733 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1734 doc
: /* Select KEYMAP as the global keymap. */)
1738 keymap
= get_keymap (keymap
, 1, 1);
1739 current_global_map
= keymap
;
1744 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1745 doc
: /* Select KEYMAP as the local keymap.
1746 If KEYMAP is nil, that means no local keymap. */)
1751 keymap
= get_keymap (keymap
, 1, 1);
1753 current_buffer
->keymap
= keymap
;
1758 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1759 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1762 return current_buffer
->keymap
;
1765 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1766 doc
: /* Return the current global keymap. */)
1769 return current_global_map
;
1772 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1773 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1777 int nmaps
= current_minor_maps (0, &maps
);
1779 return Flist (nmaps
, maps
);
1782 /* Help functions for describing and documenting keymaps. */
1786 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1787 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1788 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1792 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1796 /* Look for and break cycles. */
1797 while (!NILP (tem
= Frassq (cmd
, maps
)))
1799 Lisp_Object prefix
= XCAR (tem
);
1800 int lim
= XINT (Flength (XCAR (tem
)));
1801 if (lim
<= XINT (Flength (thisseq
)))
1802 { /* This keymap was already seen with a smaller prefix. */
1804 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1805 Faref (thisseq
, make_number (i
))))
1808 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1811 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1812 but maybe `cmd' occurs again further down in `maps', so keep
1814 maps
= XCDR (Fmemq (tem
, maps
));
1817 /* If the last key in thisseq is meta-prefix-char,
1818 turn it into a meta-ized keystroke. We know
1819 that the event we're about to append is an
1820 ascii keystroke since we're processing a
1824 int meta_bit
= meta_modifier
;
1825 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1826 tem
= Fcopy_sequence (thisseq
);
1828 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1830 /* This new sequence is the same length as
1831 thisseq, so stick it in the list right
1834 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1838 tem
= append_key (thisseq
, key
);
1839 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1844 accessible_keymaps_char_table (args
, index
, cmd
)
1845 Lisp_Object args
, index
, cmd
;
1847 accessible_keymaps_1 (index
, cmd
,
1851 XINT (XCDR (XCAR (args
))));
1854 /* This function cannot GC. */
1856 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1858 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1859 Returns a list of elements of the form (KEYS . MAP), where the sequence
1860 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1861 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1862 An optional argument PREFIX, if non-nil, should be a key sequence;
1863 then the value includes only maps for prefixes that start with PREFIX. */)
1865 Lisp_Object keymap
, prefix
;
1867 Lisp_Object maps
, tail
;
1870 /* no need for gcpro because we don't autoload any keymaps. */
1873 prefixlen
= XINT (Flength (prefix
));
1877 /* If a prefix was specified, start with the keymap (if any) for
1878 that prefix, so we don't waste time considering other prefixes. */
1880 tem
= Flookup_key (keymap
, prefix
, Qt
);
1881 /* Flookup_key may give us nil, or a number,
1882 if the prefix is not defined in this particular map.
1883 It might even give us a list that isn't a keymap. */
1884 tem
= get_keymap (tem
, 0, 0);
1887 /* Convert PREFIX to a vector now, so that later on
1888 we don't have to deal with the possibility of a string. */
1889 if (STRINGP (prefix
))
1894 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1895 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1899 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1900 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1901 c
^= 0200 | meta_modifier
;
1902 ASET (copy
, i_before
, make_number (c
));
1906 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1912 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1913 get_keymap (keymap
, 1, 0)),
1916 /* For each map in the list maps,
1917 look at any other maps it points to,
1918 and stick them at the end if they are not already in the list.
1920 This is a breadth-first traversal, where tail is the queue of
1921 nodes, and maps accumulates a list of all nodes visited. */
1923 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1925 register Lisp_Object thisseq
, thismap
;
1927 /* Does the current sequence end in the meta-prefix-char? */
1930 thisseq
= Fcar (Fcar (tail
));
1931 thismap
= Fcdr (Fcar (tail
));
1932 last
= make_number (XINT (Flength (thisseq
)) - 1);
1933 is_metized
= (XINT (last
) >= 0
1934 /* Don't metize the last char of PREFIX. */
1935 && XINT (last
) >= prefixlen
1936 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1938 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1942 elt
= XCAR (thismap
);
1946 if (CHAR_TABLE_P (elt
))
1948 Lisp_Object indices
[3];
1950 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
1951 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1952 Fcons (tail
, thisseq
)),
1955 else if (VECTORP (elt
))
1959 /* Vector keymap. Scan all the elements. */
1960 for (i
= 0; i
< ASIZE (elt
); i
++)
1961 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1962 maps
, tail
, thisseq
, is_metized
);
1965 else if (CONSP (elt
))
1966 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1967 maps
, tail
, thisseq
,
1968 is_metized
&& INTEGERP (XCAR (elt
)));
1976 Lisp_Object Qsingle_key_description
, Qkey_description
;
1978 /* This function cannot GC. */
1980 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
1981 doc
: /* Return a pretty description of key-sequence KEYS.
1982 Optional arg PREFIX is the sequence of keys leading up to KEYS.
1983 Control characters turn into "C-foo" sequences, meta into "M-foo",
1984 spaces are put between sequence elements, etc. */)
1986 Lisp_Object keys
, prefix
;
1991 int size
= XINT (Flength (keys
));
1993 Lisp_Object sep
= build_string (" ");
1998 size
+= XINT (Flength (prefix
));
2000 /* This has one extra element at the end that we don't pass to Fconcat. */
2001 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2003 /* In effect, this computes
2004 (mapconcat 'single-key-description keys " ")
2005 but we shouldn't use mapconcat because it can do GC. */
2009 list
= prefix
, prefix
= Qnil
;
2010 else if (!NILP (keys
))
2011 list
= keys
, keys
= Qnil
;
2016 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2020 return empty_string
;
2021 return Fconcat (len
- 1, args
);
2025 size
= SCHARS (list
);
2026 else if (VECTORP (list
))
2027 size
= XVECTOR (list
)->size
;
2028 else if (CONSP (list
))
2029 size
= XINT (Flength (list
));
2031 wrong_type_argument (Qarrayp
, list
);
2040 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2041 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2042 c
^= 0200 | meta_modifier
;
2043 XSETFASTINT (key
, c
);
2045 else if (VECTORP (list
))
2047 key
= AREF (list
, i
++);
2059 || EQ (key
, meta_prefix_char
)
2060 || (XINT (key
) & meta_modifier
))
2062 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2064 if (EQ (key
, meta_prefix_char
))
2068 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2071 else if (EQ (key
, meta_prefix_char
))
2076 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2084 push_key_description (c
, p
, force_multibyte
)
2085 register unsigned int c
;
2087 int force_multibyte
;
2091 /* Clear all the meaningless bits above the meta bit. */
2092 c
&= meta_modifier
| ~ - meta_modifier
;
2093 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2094 | meta_modifier
| shift_modifier
| super_modifier
);
2096 if (c
& alt_modifier
)
2102 if ((c
& ctrl_modifier
) != 0
2103 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2107 c
&= ~ctrl_modifier
;
2109 if (c
& hyper_modifier
)
2113 c
-= hyper_modifier
;
2115 if (c
& meta_modifier
)
2121 if (c
& shift_modifier
)
2125 c
-= shift_modifier
;
2127 if (c
& super_modifier
)
2131 c
-= super_modifier
;
2147 else if (c
== Ctl ('M'))
2155 /* `C-' already added above. */
2156 if (c
> 0 && c
<= Ctl ('Z'))
2175 || (NILP (current_buffer
->enable_multibyte_characters
)
2176 && SINGLE_BYTE_CHAR_P (c
)
2177 && !force_multibyte
))
2183 int valid_p
= SINGLE_BYTE_CHAR_P (c
) || char_valid_p (c
, 0);
2185 if (force_multibyte
&& valid_p
)
2187 if (SINGLE_BYTE_CHAR_P (c
))
2188 c
= unibyte_char_to_multibyte (c
);
2189 p
+= CHAR_STRING (c
, p
);
2191 else if (NILP (current_buffer
->enable_multibyte_characters
)
2196 /* The biggest character code uses 19 bits. */
2197 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2199 if (c
>= (1 << bit_offset
))
2200 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2204 p
+= CHAR_STRING (c
, p
);
2210 /* This function cannot GC. */
2212 DEFUN ("single-key-description", Fsingle_key_description
,
2213 Ssingle_key_description
, 1, 2, 0,
2214 doc
: /* Return a pretty description of command character KEY.
2215 Control characters turn into C-whatever, etc.
2216 Optional argument NO-ANGLES non-nil means don't put angle brackets
2217 around function keys and event symbols. */)
2219 Lisp_Object key
, no_angles
;
2221 if (CONSP (key
) && lucid_event_type_list_p (key
))
2222 key
= Fevent_convert_list (key
);
2224 key
= EVENT_HEAD (key
);
2226 if (INTEGERP (key
)) /* Normal character */
2228 unsigned int charset
, c1
, c2
;
2229 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2231 if (SINGLE_BYTE_CHAR_P (without_bits
))
2234 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2237 && CHARSET_DEFINED_P (charset
)
2238 && ((c1
>= 0 && c1
< 32)
2239 || (c2
>= 0 && c2
< 32)))
2241 /* Handle a generic character. */
2243 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
2244 CHECK_STRING (name
);
2245 return concat2 (build_string ("Character set "), name
);
2249 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2253 end
= push_key_description (XUINT (key
), tem
, 1);
2255 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2256 if (nchars
== nbytes
)
2259 string
= build_string (tem
);
2262 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2266 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2268 if (NILP (no_angles
))
2271 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2272 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2273 return build_string (buffer
);
2276 return Fsymbol_name (key
);
2278 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2279 return Fcopy_sequence (key
);
2281 error ("KEY must be an integer, cons, symbol, or string");
2286 push_text_char_description (c
, p
)
2287 register unsigned int c
;
2299 *p
++ = c
+ 64; /* 'A' - 1 */
2311 /* This function cannot GC. */
2313 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2314 doc
: /* Return a pretty description of file-character CHARACTER.
2315 Control characters turn into "^char", etc. This differs from
2316 `single-key-description' which turns them into "C-char".
2317 Also, this function recognizes the 2**7 bit as the Meta character,
2318 whereas `single-key-description' uses the 2**27 bit for Meta.
2319 See Info node `(elisp)Describing Characters' for examples. */)
2321 Lisp_Object character
;
2323 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2324 unsigned char str
[6];
2327 CHECK_NUMBER (character
);
2329 c
= XINT (character
);
2330 if (!SINGLE_BYTE_CHAR_P (c
))
2332 int len
= CHAR_STRING (c
, str
);
2334 return make_multibyte_string (str
, 1, len
);
2337 *push_text_char_description (c
& 0377, str
) = 0;
2339 return build_string (str
);
2342 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2345 ascii_sequence_p (seq
)
2349 int len
= XINT (Flength (seq
));
2351 for (i
= 0; i
< len
; i
++)
2353 Lisp_Object ii
, elt
;
2355 XSETFASTINT (ii
, i
);
2356 elt
= Faref (seq
, ii
);
2359 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2367 /* where-is - finding a command in a set of keymaps. */
2369 static Lisp_Object
where_is_internal ();
2370 static Lisp_Object
where_is_internal_1 ();
2371 static void where_is_internal_2 ();
2373 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2374 Returns the first non-nil binding found in any of those maps. */
2377 shadow_lookup (shadow
, key
, flag
)
2378 Lisp_Object shadow
, key
, flag
;
2380 Lisp_Object tail
, value
;
2382 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2384 value
= Flookup_key (XCAR (tail
), key
, flag
);
2385 if (NATNUMP (value
))
2387 value
= Flookup_key (XCAR (tail
),
2388 Fsubstring (key
, make_number (0), value
), flag
);
2392 else if (!NILP (value
))
2398 static Lisp_Object Vmouse_events
;
2400 /* This function can GC if Flookup_key autoloads any keymaps. */
2403 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2404 Lisp_Object definition
, keymaps
;
2405 Lisp_Object firstonly
, noindirect
, no_remap
;
2407 Lisp_Object maps
= Qnil
;
2408 Lisp_Object found
, sequences
;
2409 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2410 /* 1 means ignore all menu bindings entirely. */
2411 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2413 /* If this command is remapped, then it has no key bindings
2415 if (NILP (no_remap
) && SYMBOLP (definition
))
2418 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2423 while (CONSP (found
))
2427 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2428 found
= XCDR (found
);
2431 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2435 for (; !NILP (maps
); maps
= Fcdr (maps
))
2437 /* Key sequence to reach map, and the map that it reaches */
2438 register Lisp_Object
this, map
, tem
;
2440 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2441 [M-CHAR] sequences, check if last character of the sequence
2442 is the meta-prefix char. */
2446 this = Fcar (Fcar (maps
));
2447 map
= Fcdr (Fcar (maps
));
2448 last
= make_number (XINT (Flength (this)) - 1);
2449 last_is_meta
= (XINT (last
) >= 0
2450 && EQ (Faref (this, last
), meta_prefix_char
));
2452 /* if (nomenus && !ascii_sequence_p (this)) */
2453 if (nomenus
&& XINT (last
) >= 0
2454 && SYMBOLP (tem
= Faref (this, make_number (0)))
2455 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2456 /* If no menu entries should be returned, skip over the
2457 keymaps bound to `menu-bar' and `tool-bar' and other
2458 non-ascii prefixes like `C-down-mouse-2'. */
2465 /* Because the code we want to run on each binding is rather
2466 large, we don't want to have two separate loop bodies for
2467 sparse keymap bindings and tables; we want to iterate one
2468 loop body over both keymap and vector bindings.
2470 For this reason, if Fcar (map) is a vector, we don't
2471 advance map to the next element until i indicates that we
2472 have finished off the vector. */
2473 Lisp_Object elt
, key
, binding
;
2481 /* Set key and binding to the current key and binding, and
2482 advance map and i to the next binding. */
2485 Lisp_Object sequence
;
2487 /* In a vector, look at each element. */
2488 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2490 binding
= AREF (elt
, i
);
2491 XSETFASTINT (key
, i
);
2492 sequence
= where_is_internal_1 (binding
, key
, definition
,
2494 last
, nomenus
, last_is_meta
);
2495 if (!NILP (sequence
))
2496 sequences
= Fcons (sequence
, sequences
);
2499 else if (CHAR_TABLE_P (elt
))
2501 Lisp_Object indices
[3];
2504 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2505 Qnil
), /* Result accumulator. */
2506 Fcons (Fcons (this, last
),
2507 Fcons (make_number (nomenus
),
2508 make_number (last_is_meta
))));
2509 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2511 sequences
= XCDR (XCAR (args
));
2513 else if (CONSP (elt
))
2515 Lisp_Object sequence
;
2518 binding
= XCDR (elt
);
2520 sequence
= where_is_internal_1 (binding
, key
, definition
,
2522 last
, nomenus
, last_is_meta
);
2523 if (!NILP (sequence
))
2524 sequences
= Fcons (sequence
, sequences
);
2528 while (!NILP (sequences
))
2530 Lisp_Object sequence
, remapped
, function
;
2532 sequence
= XCAR (sequences
);
2533 sequences
= XCDR (sequences
);
2535 /* If the current sequence is a command remapping with
2536 format [remap COMMAND], find the key sequences
2537 which run COMMAND, and use those sequences instead. */
2540 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2541 && EQ (AREF (sequence
, 0), Qremap
)
2542 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2544 Lisp_Object remapped1
;
2546 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2547 if (CONSP (remapped1
))
2549 /* Verify that this key binding actually maps to the
2550 remapped command (see below). */
2551 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2553 sequence
= XCAR (remapped1
);
2554 remapped
= XCDR (remapped1
);
2555 goto record_sequence
;
2559 /* Verify that this key binding is not shadowed by another
2560 binding for the same key, before we say it exists.
2562 Mechanism: look for local definition of this key and if
2563 it is defined and does not match what we found then
2566 Either nil or number as value from Flookup_key
2568 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2572 /* Don't annoy user with strings from a menu such as
2573 Select Paste. Change them all to "(any string)",
2574 so that there seems to be only one menu item
2576 if (! NILP (sequence
))
2579 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2581 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2582 build_string ("(any string)"));
2585 /* It is a true unshadowed match. Record it, unless it's already
2586 been seen (as could happen when inheriting keymaps). */
2587 if (NILP (Fmember (sequence
, found
)))
2588 found
= Fcons (sequence
, found
);
2590 /* If firstonly is Qnon_ascii, then we can return the first
2591 binding we find. If firstonly is not Qnon_ascii but not
2592 nil, then we should return the first ascii-only binding
2594 if (EQ (firstonly
, Qnon_ascii
))
2595 RETURN_UNGCPRO (sequence
);
2596 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2597 RETURN_UNGCPRO (sequence
);
2599 if (CONSP (remapped
))
2601 sequence
= XCAR (remapped
);
2602 remapped
= XCDR (remapped
);
2603 goto record_sequence
;
2611 found
= Fnreverse (found
);
2613 /* firstonly may have been t, but we may have gone all the way through
2614 the keymaps without finding an all-ASCII key sequence. So just
2615 return the best we could find. */
2616 if (!NILP (firstonly
))
2617 return Fcar (found
);
2622 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2623 doc
: /* Return list of keys that invoke DEFINITION.
2624 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2625 If KEYMAP is nil, search all the currently active keymaps.
2626 If KEYMAP is a list of keymaps, search only those keymaps.
2628 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2629 rather than a list of all possible key sequences.
2630 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2631 no matter what it is.
2632 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2633 \(or their meta variants) and entirely reject menu bindings.
2635 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2636 to other keymaps or slots. This makes it possible to search for an
2637 indirect definition itself.
2639 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2640 that invoke a command which is remapped to DEFINITION, but include the
2641 remapped command in the returned list. */)
2642 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2643 Lisp_Object definition
, keymap
;
2644 Lisp_Object firstonly
, noindirect
, no_remap
;
2646 Lisp_Object sequences
, keymaps
;
2647 /* 1 means ignore all menu bindings entirely. */
2648 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2651 /* Find the relevant keymaps. */
2652 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2654 else if (!NILP (keymap
))
2655 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2657 keymaps
= Fcurrent_active_maps (Qnil
);
2659 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2660 We don't really need to check `keymap'. */
2661 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2665 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2667 /* Check heuristic-consistency of the cache. */
2668 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2669 where_is_cache
= Qnil
;
2671 if (NILP (where_is_cache
))
2673 /* We need to create the cache. */
2674 Lisp_Object args
[2];
2675 where_is_cache
= Fmake_hash_table (0, args
);
2676 where_is_cache_keymaps
= Qt
;
2678 /* Fill in the cache. */
2679 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2680 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2683 where_is_cache_keymaps
= keymaps
;
2686 /* We want to process definitions from the last to the first.
2687 Instead of consing, copy definitions to a vector and step
2688 over that vector. */
2689 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2690 n
= XINT (Flength (sequences
));
2691 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2692 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2693 defns
[i
++] = XCAR (sequences
);
2695 /* Verify that the key bindings are not shadowed. Note that
2696 the following can GC. */
2697 GCPRO2 (definition
, keymaps
);
2700 for (i
= n
- 1; i
>= 0; --i
)
2701 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2703 if (ascii_sequence_p (defns
[i
]))
2709 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2714 /* Kill the cache so that where_is_internal_1 doesn't think
2715 we're filling it up. */
2716 where_is_cache
= Qnil
;
2717 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2723 /* This is the function that Fwhere_is_internal calls using map_char_table.
2725 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2727 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2728 Since map_char_table doesn't really use the return value from this function,
2729 we the result append to RESULT, the slot in ARGS.
2731 This function can GC because it calls where_is_internal_1 which can
2735 where_is_internal_2 (args
, key
, binding
)
2736 Lisp_Object args
, key
, binding
;
2738 Lisp_Object definition
, noindirect
, this, last
;
2739 Lisp_Object result
, sequence
;
2740 int nomenus
, last_is_meta
;
2741 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2743 GCPRO3 (args
, key
, binding
);
2744 result
= XCDR (XCAR (args
));
2745 definition
= XCAR (XCAR (XCAR (args
)));
2746 noindirect
= XCDR (XCAR (XCAR (args
)));
2747 this = XCAR (XCAR (XCDR (args
)));
2748 last
= XCDR (XCAR (XCDR (args
)));
2749 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2750 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2752 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2753 this, last
, nomenus
, last_is_meta
);
2755 if (!NILP (sequence
))
2756 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2762 /* This function can GC because get_keyelt can. */
2765 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2766 nomenus
, last_is_meta
)
2767 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2768 int nomenus
, last_is_meta
;
2770 Lisp_Object sequence
;
2772 /* Search through indirections unless that's not wanted. */
2773 if (NILP (noindirect
))
2774 binding
= get_keyelt (binding
, 0);
2776 /* End this iteration if this element does not match
2779 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2780 || EQ (binding
, definition
)
2781 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2782 /* Doesn't match. */
2785 /* We have found a match. Construct the key sequence where we found it. */
2786 if (INTEGERP (key
) && last_is_meta
)
2788 sequence
= Fcopy_sequence (this);
2789 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2792 sequence
= append_key (this, key
);
2794 if (!NILP (where_is_cache
))
2796 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2797 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2804 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2806 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2807 doc
: /* Insert the list of all defined keys and their definitions.
2808 The list is inserted in the current buffer, while the bindings are
2809 looked up in BUFFER.
2810 The optional argument PREFIX, if non-nil, should be a key sequence;
2811 then we display only bindings that start with that prefix.
2812 The optional argument MENUS, if non-nil, says to mention menu bindings.
2813 \(Ordinarily these are omitted from the output.) */)
2814 (buffer
, prefix
, menus
)
2815 Lisp_Object buffer
, prefix
, menus
;
2817 Lisp_Object outbuf
, shadow
;
2818 int nomenu
= NILP (menus
);
2819 register Lisp_Object start1
;
2820 struct gcpro gcpro1
;
2822 char *alternate_heading
2824 Keyboard translations:\n\n\
2825 You type Translation\n\
2826 -------- -----------\n";
2831 outbuf
= Fcurrent_buffer ();
2833 /* Report on alternates for keys. */
2834 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2837 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2838 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2840 for (c
= 0; c
< translate_len
; c
++)
2841 if (translate
[c
] != c
)
2843 char buf
[KEY_DESCRIPTION_SIZE
];
2846 if (alternate_heading
)
2848 insert_string (alternate_heading
);
2849 alternate_heading
= 0;
2852 bufend
= push_key_description (translate
[c
], buf
, 1);
2853 insert (buf
, bufend
- buf
);
2854 Findent_to (make_number (16), make_number (1));
2855 bufend
= push_key_description (c
, buf
, 1);
2856 insert (buf
, bufend
- buf
);
2860 /* Insert calls signal_after_change which may GC. */
2861 translate
= SDATA (Vkeyboard_translate_table
);
2867 if (!NILP (Vkey_translation_map
))
2868 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2869 "Key translations", nomenu
, 1, 0, 0);
2872 /* Print the (major mode) local map. */
2874 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2875 start1
= current_kboard
->Voverriding_terminal_local_map
;
2876 else if (!NILP (Voverriding_local_map
))
2877 start1
= Voverriding_local_map
;
2881 describe_map_tree (start1
, 1, shadow
, prefix
,
2882 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2883 shadow
= Fcons (start1
, shadow
);
2887 /* Print the minor mode and major mode keymaps. */
2889 Lisp_Object
*modes
, *maps
;
2891 /* Temporarily switch to `buffer', so that we can get that buffer's
2892 minor modes correctly. */
2893 Fset_buffer (buffer
);
2895 nmaps
= current_minor_maps (&modes
, &maps
);
2896 Fset_buffer (outbuf
);
2898 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2899 XBUFFER (buffer
), Qkeymap
);
2902 describe_map_tree (start1
, 1, shadow
, prefix
,
2903 "\f\n`keymap' Property Bindings", nomenu
,
2905 shadow
= Fcons (start1
, shadow
);
2908 /* Print the minor mode maps. */
2909 for (i
= 0; i
< nmaps
; i
++)
2911 /* The title for a minor mode keymap
2912 is constructed at run time.
2913 We let describe_map_tree do the actual insertion
2914 because it takes care of other features when doing so. */
2917 if (!SYMBOLP (modes
[i
]))
2920 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2924 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2925 SCHARS (SYMBOL_NAME (modes
[i
])));
2926 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2928 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2929 p
+= sizeof (" Minor Mode Bindings") - 1;
2932 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2933 title
, nomenu
, 0, 0, 0);
2934 shadow
= Fcons (maps
[i
], shadow
);
2937 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2938 XBUFFER (buffer
), Qlocal_map
);
2941 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2942 describe_map_tree (start1
, 1, shadow
, prefix
,
2943 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2945 describe_map_tree (start1
, 1, shadow
, prefix
,
2946 "\f\n`local-map' Property Bindings",
2949 shadow
= Fcons (start1
, shadow
);
2953 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2954 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2956 /* Print the function-key-map translations under this prefix. */
2957 if (!NILP (Vfunction_key_map
))
2958 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2959 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2965 /* Insert a description of the key bindings in STARTMAP,
2966 followed by those of all maps reachable through STARTMAP.
2967 If PARTIAL is nonzero, omit certain "uninteresting" commands
2968 (such as `undefined').
2969 If SHADOW is non-nil, it is a list of maps;
2970 don't mention keys which would be shadowed by any of them.
2971 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2972 TITLE, if not 0, is a string to insert at the beginning.
2973 TITLE should not end with a colon or a newline; we supply that.
2974 If NOMENU is not 0, then omit menu-bar commands.
2976 If TRANSL is nonzero, the definitions are actually key translations
2977 so print strings and vectors differently.
2979 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2982 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
2983 don't omit it; instead, mention it but say it is shadowed. */
2986 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2987 always_title
, mention_shadow
)
2988 Lisp_Object startmap
, shadow
, prefix
;
2996 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2997 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3004 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3007 GCPRO3 (maps
, seen
, sub_shadows
);
3013 /* Delete from MAPS each element that is for the menu bar. */
3014 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3016 Lisp_Object elt
, prefix
, tem
;
3019 prefix
= Fcar (elt
);
3020 if (XVECTOR (prefix
)->size
>= 1)
3022 tem
= Faref (prefix
, make_number (0));
3023 if (EQ (tem
, Qmenu_bar
))
3024 maps
= Fdelq (elt
, maps
);
3029 if (!NILP (maps
) || always_title
)
3033 insert_string (title
);
3036 insert_string (" Starting With ");
3037 insert1 (Fkey_description (prefix
, Qnil
));
3039 insert_string (":\n");
3041 insert_string (key_heading
);
3045 for (; !NILP (maps
); maps
= Fcdr (maps
))
3047 register Lisp_Object elt
, prefix
, tail
;
3050 prefix
= Fcar (elt
);
3054 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3058 shmap
= XCAR (tail
);
3060 /* If the sequence by which we reach this keymap is zero-length,
3061 then the shadow map for this keymap is just SHADOW. */
3062 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3063 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3065 /* If the sequence by which we reach this keymap actually has
3066 some elements, then the sequence's definition in SHADOW is
3067 what we should use. */
3070 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3071 if (INTEGERP (shmap
))
3075 /* If shmap is not nil and not a keymap,
3076 it completely shadows this map, so don't
3077 describe this map at all. */
3078 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3082 sub_shadows
= Fcons (shmap
, sub_shadows
);
3085 /* Maps we have already listed in this loop shadow this map. */
3086 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3089 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3091 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3094 describe_map (Fcdr (elt
), prefix
,
3095 transl
? describe_translation
: describe_command
,
3096 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3102 insert_string ("\n");
3107 static int previous_description_column
;
3110 describe_command (definition
, args
)
3111 Lisp_Object definition
, args
;
3113 register Lisp_Object tem1
;
3114 int column
= (int) current_column (); /* iftc */
3115 int description_column
;
3117 /* If column 16 is no good, go to col 32;
3118 but don't push beyond that--go to next line instead. */
3122 description_column
= 32;
3124 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3125 description_column
= 32;
3127 description_column
= 16;
3129 Findent_to (make_number (description_column
), make_number (1));
3130 previous_description_column
= description_column
;
3132 if (SYMBOLP (definition
))
3134 tem1
= SYMBOL_NAME (definition
);
3136 insert_string ("\n");
3138 else if (STRINGP (definition
) || VECTORP (definition
))
3139 insert_string ("Keyboard Macro\n");
3140 else if (KEYMAPP (definition
))
3141 insert_string ("Prefix Command\n");
3143 insert_string ("??\n");
3147 describe_translation (definition
, args
)
3148 Lisp_Object definition
, args
;
3150 register Lisp_Object tem1
;
3152 Findent_to (make_number (16), make_number (1));
3154 if (SYMBOLP (definition
))
3156 tem1
= SYMBOL_NAME (definition
);
3158 insert_string ("\n");
3160 else if (STRINGP (definition
) || VECTORP (definition
))
3162 insert1 (Fkey_description (definition
, Qnil
));
3163 insert_string ("\n");
3165 else if (KEYMAPP (definition
))
3166 insert_string ("Prefix Command\n");
3168 insert_string ("??\n");
3171 /* describe_map puts all the usable elements of a sparse keymap
3172 into an array of `struct describe_map_elt',
3173 then sorts them by the events. */
3175 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3177 /* qsort comparison function for sorting `struct describe_map_elt' by
3181 describe_map_compare (aa
, bb
)
3182 const void *aa
, *bb
;
3184 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3185 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3186 return ((XINT (a
->event
) > XINT (b
->event
))
3187 - (XINT (a
->event
) < XINT (b
->event
)));
3188 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3190 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3192 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3193 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3194 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3199 /* Describe the contents of map MAP, assuming that this map itself is
3200 reached by the sequence of prefix keys PREFIX (a string or vector).
3201 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3204 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3205 seen
, nomenu
, mention_shadow
)
3206 register Lisp_Object map
;
3208 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3215 Lisp_Object tail
, definition
, event
;
3217 Lisp_Object suppress
;
3220 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3222 /* These accumulate the values from sparse keymap bindings,
3223 so we can sort them and handle them in order. */
3224 int length_needed
= 0;
3225 struct describe_map_elt
*vect
;
3232 suppress
= intern ("suppress-keymap");
3234 /* This vector gets used to present single keys to Flookup_key. Since
3235 that is done once per keymap element, we don't want to cons up a
3236 fresh vector every time. */
3237 kludge
= Fmake_vector (make_number (1), Qnil
);
3240 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3243 vect
= ((struct describe_map_elt
*)
3244 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3246 GCPRO3 (prefix
, definition
, kludge
);
3248 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3252 if (VECTORP (XCAR (tail
))
3253 || CHAR_TABLE_P (XCAR (tail
)))
3254 describe_vector (XCAR (tail
),
3255 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3256 (int *)0, 0, 1, mention_shadow
);
3257 else if (CONSP (XCAR (tail
)))
3259 int this_shadowed
= 0;
3261 event
= XCAR (XCAR (tail
));
3263 /* Ignore bindings whose "prefix" are not really valid events.
3264 (We get these in the frames and buffers menu.) */
3265 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3268 if (nomenu
&& EQ (event
, Qmenu_bar
))
3271 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3273 /* Don't show undefined commands or suppressed commands. */
3274 if (NILP (definition
)) continue;
3275 if (SYMBOLP (definition
) && partial
)
3277 tem
= Fget (definition
, suppress
);
3282 /* Don't show a command that isn't really visible
3283 because a local definition of the same key shadows it. */
3285 ASET (kludge
, 0, event
);
3288 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3298 tem
= Flookup_key (map
, kludge
, Qt
);
3299 if (!EQ (tem
, definition
)) continue;
3301 vect
[slots_used
].event
= event
;
3302 vect
[slots_used
].definition
= definition
;
3303 vect
[slots_used
].shadowed
= this_shadowed
;
3306 else if (EQ (XCAR (tail
), Qkeymap
))
3308 /* The same keymap might be in the structure twice, if we're
3309 using an inherited keymap. So skip anything we've already
3311 tem
= Fassq (tail
, *seen
);
3312 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3314 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3318 /* If we found some sparse map events, sort them. */
3320 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3321 describe_map_compare
);
3323 /* Now output them in sorted order. */
3325 for (i
= 0; i
< slots_used
; i
++)
3327 Lisp_Object start
, end
;
3331 previous_description_column
= 0;
3336 ASET (kludge
, 0, vect
[i
].event
);
3337 start
= vect
[i
].event
;
3340 definition
= vect
[i
].definition
;
3342 /* Find consecutive chars that are identically defined. */
3343 if (INTEGERP (vect
[i
].event
))
3345 while (i
+ 1 < slots_used
3346 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3347 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3348 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3350 end
= vect
[i
].event
;
3353 /* Now START .. END is the range to describe next. */
3355 /* Insert the string to describe the event START. */
3356 insert1 (Fkey_description (kludge
, prefix
));
3358 if (!EQ (start
, end
))
3362 ASET (kludge
, 0, end
);
3363 /* Insert the string to describe the character END. */
3364 insert1 (Fkey_description (kludge
, prefix
));
3367 /* Print a description of the definition of this character.
3368 elt_describer will take care of spacing out far enough
3369 for alignment purposes. */
3370 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3372 if (vect
[i
].shadowed
)
3375 insert_string ("\n (that binding is currently shadowed by another mode)");
3384 describe_vector_princ (elt
, fun
)
3385 Lisp_Object elt
, fun
;
3387 Findent_to (make_number (16), make_number (1));
3392 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3393 doc
: /* Insert a description of contents of VECTOR.
3394 This is text showing the elements of vector matched against indices.
3395 DESCRIBER is the output function used; nil means use `princ'. */)
3397 Lisp_Object vector
, describer
;
3399 int count
= SPECPDL_INDEX ();
3400 if (NILP (describer
))
3401 describer
= intern ("princ");
3402 specbind (Qstandard_output
, Fcurrent_buffer ());
3403 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3404 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3405 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3407 return unbind_to (count
, Qnil
);
3410 /* Insert in the current buffer a description of the contents of VECTOR.
3411 We call ELT_DESCRIBER to insert the description of one value found
3414 ELT_PREFIX describes what "comes before" the keys or indices defined
3415 by this vector. This is a human-readable string whose size
3416 is not necessarily related to the situation.
3418 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3419 leads to this keymap.
3421 If the vector is a chartable, ELT_PREFIX is the vector
3422 of bytes that lead to the character set or portion of a character
3423 set described by this chartable.
3425 If PARTIAL is nonzero, it means do not mention suppressed commands
3426 (that assumes the vector is in a keymap).
3428 SHADOW is a list of keymaps that shadow this map.
3429 If it is non-nil, then we look up the key in those maps
3430 and we don't mention it now if it is defined by any of them.
3432 ENTIRE_MAP is the keymap in which this vector appears.
3433 If the definition in effect in the whole map does not match
3434 the one in this vector, we ignore this one.
3436 When describing a sub-char-table, INDICES is a list of
3437 indices at higher levels in this char-table,
3438 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3440 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3442 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3445 describe_vector (vector
, prefix
, args
, elt_describer
,
3446 partial
, shadow
, entire_map
,
3447 indices
, char_table_depth
, keymap_p
,
3449 register Lisp_Object vector
;
3450 Lisp_Object prefix
, args
;
3451 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3454 Lisp_Object entire_map
;
3456 int char_table_depth
;
3460 Lisp_Object definition
;
3462 Lisp_Object elt_prefix
= Qnil
;
3464 Lisp_Object suppress
;
3467 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3468 /* Range of elements to be handled. */
3470 /* A flag to tell if a leaf in this level of char-table is not a
3471 generic character (i.e. a complete multibyte character). */
3479 indices
= (int *) alloca (3 * sizeof (int));
3485 /* Call Fkey_description first, to avoid GC bug for the other string. */
3486 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3489 tem
= Fkey_description (prefix
, Qnil
);
3490 elt_prefix
= concat2 (tem
, build_string (" "));
3495 /* This vector gets used to present single keys to Flookup_key. Since
3496 that is done once per vector element, we don't want to cons up a
3497 fresh vector every time. */
3498 kludge
= Fmake_vector (make_number (1), Qnil
);
3499 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3502 suppress
= intern ("suppress-keymap");
3504 if (CHAR_TABLE_P (vector
))
3506 if (char_table_depth
== 0)
3508 /* VECTOR is a top level char-table. */
3511 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3515 /* VECTOR is a sub char-table. */
3516 if (char_table_depth
>= 3)
3517 /* A char-table is never that deep. */
3518 error ("Too deep char table");
3521 = (CHARSET_VALID_P (indices
[0])
3522 && ((CHARSET_DIMENSION (indices
[0]) == 1
3523 && char_table_depth
== 1)
3524 || char_table_depth
== 2));
3526 /* Meaningful elements are from 32th to 127th. */
3528 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3533 /* This does the right thing for ordinary vectors. */
3537 to
= XVECTOR (vector
)->size
;
3540 for (i
= from
; i
< to
; i
++)
3542 int this_shadowed
= 0;
3545 if (CHAR_TABLE_P (vector
))
3547 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3550 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3551 && !CHARSET_DEFINED_P (i
- 128))
3555 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3558 definition
= get_keyelt (AREF (vector
, i
), 0);
3560 if (NILP (definition
)) continue;
3562 /* Don't mention suppressed commands. */
3563 if (SYMBOLP (definition
) && partial
)
3567 tem
= Fget (definition
, suppress
);
3569 if (!NILP (tem
)) continue;
3572 /* Set CHARACTER to the character this entry describes, if any.
3573 Also update *INDICES. */
3574 if (CHAR_TABLE_P (vector
))
3576 indices
[char_table_depth
] = i
;
3578 if (char_table_depth
== 0)
3581 indices
[0] = i
- 128;
3583 else if (complete_char
)
3585 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3593 ASET (kludge
, 0, make_number (character
));
3595 /* If this binding is shadowed by some other map, ignore it. */
3596 if (!NILP (shadow
) && complete_char
)
3600 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3611 /* Ignore this definition if it is shadowed by an earlier
3612 one in the same keymap. */
3613 if (!NILP (entire_map
) && complete_char
)
3617 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3619 if (!EQ (tem
, definition
))
3625 if (char_table_depth
== 0)
3630 /* For a sub char-table, show the depth by indentation.
3631 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3632 if (char_table_depth
> 0)
3633 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3635 /* Output the prefix that applies to every entry in this map. */
3636 if (!NILP (elt_prefix
))
3637 insert1 (elt_prefix
);
3639 /* Insert or describe the character this slot is for,
3640 or a description of what it is for. */
3641 if (SUB_CHAR_TABLE_P (vector
))
3644 insert_char (character
);
3647 /* We need an octal representation for this block of
3650 sprintf (work
, "(row %d)", i
);
3651 insert (work
, strlen (work
));
3654 else if (CHAR_TABLE_P (vector
))
3657 insert1 (Fkey_description (kludge
, prefix
));
3660 /* Print the information for this character set. */
3661 insert_string ("<");
3662 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3664 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3673 insert1 (Fkey_description (kludge
, prefix
));
3676 /* If we find a sub char-table within a char-table,
3677 scan it recursively; it defines the details for
3678 a character set or a portion of a character set. */
3679 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3682 describe_vector (definition
, prefix
, args
, elt_describer
,
3683 partial
, shadow
, entire_map
,
3684 indices
, char_table_depth
+ 1, keymap_p
,
3691 /* Find all consecutive characters or rows that have the same
3692 definition. But, for elements of a top level char table, if
3693 they are for charsets, we had better describe one by one even
3694 if they have the same definition. */
3695 if (CHAR_TABLE_P (vector
))
3699 if (char_table_depth
== 0)
3700 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3702 while (i
+ 1 < limit
3703 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3705 && !NILP (Fequal (tem2
, definition
)))
3710 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3712 && !NILP (Fequal (tem2
, definition
)))
3716 /* If we have a range of more than one character,
3717 print where the range reaches to. */
3719 if (i
!= starting_i
)
3723 ASET (kludge
, 0, make_number (i
));
3725 if (!NILP (elt_prefix
))
3726 insert1 (elt_prefix
);
3728 if (CHAR_TABLE_P (vector
))
3730 if (char_table_depth
== 0)
3732 insert1 (Fkey_description (kludge
, prefix
));
3734 else if (complete_char
)
3736 indices
[char_table_depth
] = i
;
3737 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3738 insert_char (character
);
3742 /* We need an octal representation for this block of
3745 sprintf (work
, "(row %d)", i
);
3746 insert (work
, strlen (work
));
3751 insert1 (Fkey_description (kludge
, prefix
));
3755 /* Print a description of the definition of this character.
3756 elt_describer will take care of spacing out far enough
3757 for alignment purposes. */
3758 (*elt_describer
) (definition
, args
);
3763 insert_string (" (binding currently shadowed)");
3768 /* For (sub) char-table, print `defalt' slot at last. */
3769 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3771 insert (" ", char_table_depth
* 2);
3772 insert_string ("<<default>>");
3773 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3779 /* Apropos - finding all symbols whose names match a regexp. */
3780 static Lisp_Object apropos_predicate
;
3781 static Lisp_Object apropos_accumulate
;
3784 apropos_accum (symbol
, string
)
3785 Lisp_Object symbol
, string
;
3787 register Lisp_Object tem
;
3789 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3790 if (!NILP (tem
) && !NILP (apropos_predicate
))
3791 tem
= call1 (apropos_predicate
, symbol
);
3793 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3796 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3797 doc
: /* Show all symbols whose names contain match for REGEXP.
3798 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3799 for each symbol and a symbol is mentioned only if that returns non-nil.
3800 Return list of symbols found. */)
3802 Lisp_Object regexp
, predicate
;
3805 CHECK_STRING (regexp
);
3806 apropos_predicate
= predicate
;
3807 apropos_accumulate
= Qnil
;
3808 map_obarray (Vobarray
, apropos_accum
, regexp
);
3809 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3810 apropos_accumulate
= Qnil
;
3811 apropos_predicate
= Qnil
;
3818 Qkeymap
= intern ("keymap");
3819 staticpro (&Qkeymap
);
3820 staticpro (&apropos_predicate
);
3821 staticpro (&apropos_accumulate
);
3822 apropos_predicate
= Qnil
;
3823 apropos_accumulate
= Qnil
;
3825 /* Now we are ready to set up this property, so we can
3826 create char tables. */
3827 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3829 /* Initialize the keymaps standardly used.
3830 Each one is the value of a Lisp variable, and is also
3831 pointed to by a C variable */
3833 global_map
= Fmake_keymap (Qnil
);
3834 Fset (intern ("global-map"), global_map
);
3836 current_global_map
= global_map
;
3837 staticpro (&global_map
);
3838 staticpro (¤t_global_map
);
3840 meta_map
= Fmake_keymap (Qnil
);
3841 Fset (intern ("esc-map"), meta_map
);
3842 Ffset (intern ("ESC-prefix"), meta_map
);
3844 control_x_map
= Fmake_keymap (Qnil
);
3845 Fset (intern ("ctl-x-map"), control_x_map
);
3846 Ffset (intern ("Control-X-prefix"), control_x_map
);
3849 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3850 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3851 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3852 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3853 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3855 staticpro (&exclude_keys
);
3857 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3858 doc
: /* List of commands given new key bindings recently.
3859 This is used for internal purposes during Emacs startup;
3860 don't alter it yourself. */);
3861 Vdefine_key_rebound_commands
= Qt
;
3863 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3864 doc
: /* Default keymap to use when reading from the minibuffer. */);
3865 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3867 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3868 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3869 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3870 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3872 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3873 doc
: /* Local keymap for minibuffer input with completion. */);
3874 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3875 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3877 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3878 &Vminibuffer_local_filename_completion_map
,
3879 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3880 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3881 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3882 Vminibuffer_local_completion_map
);
3885 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3886 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3887 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3888 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3889 Vminibuffer_local_completion_map
);
3891 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3892 &Vminibuffer_local_must_match_filename_map
,
3893 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3894 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3895 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3896 Vminibuffer_local_must_match_map
);
3898 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3899 doc
: /* Alist of keymaps to use for minor modes.
3900 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3901 key sequences and look up bindings iff VARIABLE's value is non-nil.
3902 If two active keymaps bind the same key, the keymap appearing earlier
3903 in the list takes precedence. */);
3904 Vminor_mode_map_alist
= Qnil
;
3906 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3907 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3908 This variable is an alist just like `minor-mode-map-alist', and it is
3909 used the same way (and before `minor-mode-map-alist'); however,
3910 it is provided for major modes to bind locally. */);
3911 Vminor_mode_overriding_map_alist
= Qnil
;
3913 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3914 doc
: /* List of keymap alists to use for emulations modes.
3915 It is intended for modes or packages using multiple minor-mode keymaps.
3916 Each element is a keymap alist just like `minor-mode-map-alist', or a
3917 symbol with a variable binding which is a keymap alist, and it is used
3918 the same way. The "active" keymaps in each alist are used before
3919 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3920 Vemulation_mode_map_alists
= Qnil
;
3923 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3924 doc
: /* Keymap that translates key sequences to key sequences during input.
3925 This is used mainly for mapping ASCII function key sequences into
3926 real Emacs function key events (symbols).
3928 The `read-key-sequence' function replaces any subsequence bound by
3929 `function-key-map' with its binding. More precisely, when the active
3930 keymaps have no binding for the current key sequence but
3931 `function-key-map' binds a suffix of the sequence to a vector or string,
3932 `read-key-sequence' replaces the matching suffix with its binding, and
3933 continues with the new sequence.
3935 If the binding is a function, it is called with one argument (the prompt)
3936 and its return value (a key sequence) is used.
3938 The events that come from bindings in `function-key-map' are not
3939 themselves looked up in `function-key-map'.
3941 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3942 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3943 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3944 key, typing `ESC O P x' would return [f1 x]. */);
3945 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3947 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3948 doc
: /* Keymap of key translations that can override keymaps.
3949 This keymap works like `function-key-map', but comes after that,
3950 and its non-prefix bindings override ordinary bindings. */);
3951 Vkey_translation_map
= Qnil
;
3953 staticpro (&Vmouse_events
);
3954 Vmouse_events
= Fcons (intern ("menu-bar"),
3955 Fcons (intern ("tool-bar"),
3956 Fcons (intern ("header-line"),
3957 Fcons (intern ("mode-line"),
3958 Fcons (intern ("mouse-1"),
3959 Fcons (intern ("mouse-2"),
3960 Fcons (intern ("mouse-3"),
3961 Fcons (intern ("mouse-4"),
3962 Fcons (intern ("mouse-5"),
3966 Qsingle_key_description
= intern ("single-key-description");
3967 staticpro (&Qsingle_key_description
);
3969 Qkey_description
= intern ("key-description");
3970 staticpro (&Qkey_description
);
3972 Qkeymapp
= intern ("keymapp");
3973 staticpro (&Qkeymapp
);
3975 Qnon_ascii
= intern ("non-ascii");
3976 staticpro (&Qnon_ascii
);
3978 Qmenu_item
= intern ("menu-item");
3979 staticpro (&Qmenu_item
);
3981 Qremap
= intern ("remap");
3982 staticpro (&Qremap
);
3984 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3985 staticpro (&command_remapping_vector
);
3987 where_is_cache_keymaps
= Qt
;
3988 where_is_cache
= Qnil
;
3989 staticpro (&where_is_cache
);
3990 staticpro (&where_is_cache_keymaps
);
3992 defsubr (&Skeymapp
);
3993 defsubr (&Skeymap_parent
);
3994 defsubr (&Skeymap_prompt
);
3995 defsubr (&Sset_keymap_parent
);
3996 defsubr (&Smake_keymap
);
3997 defsubr (&Smake_sparse_keymap
);
3998 defsubr (&Smap_keymap
);
3999 defsubr (&Scopy_keymap
);
4000 defsubr (&Scommand_remapping
);
4001 defsubr (&Skey_binding
);
4002 defsubr (&Slocal_key_binding
);
4003 defsubr (&Sglobal_key_binding
);
4004 defsubr (&Sminor_mode_key_binding
);
4005 defsubr (&Sdefine_key
);
4006 defsubr (&Slookup_key
);
4007 defsubr (&Sdefine_prefix_command
);
4008 defsubr (&Suse_global_map
);
4009 defsubr (&Suse_local_map
);
4010 defsubr (&Scurrent_local_map
);
4011 defsubr (&Scurrent_global_map
);
4012 defsubr (&Scurrent_minor_mode_maps
);
4013 defsubr (&Scurrent_active_maps
);
4014 defsubr (&Saccessible_keymaps
);
4015 defsubr (&Skey_description
);
4016 defsubr (&Sdescribe_vector
);
4017 defsubr (&Ssingle_key_description
);
4018 defsubr (&Stext_char_description
);
4019 defsubr (&Swhere_is_internal
);
4020 defsubr (&Sdescribe_buffer_bindings
);
4021 defsubr (&Sapropos_internal
);
4027 initial_define_key (global_map
, 033, "ESC-prefix");
4028 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
4031 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
4032 (do not change this comment) */