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
;
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 starts with non-prefix key %s",
1197 SDATA (Fkey_description (key
, Qnil
)),
1198 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1204 /* This function may GC (it calls Fkey_binding). */
1206 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1207 doc
: /* Return the remapping for command COMMAND in current keymaps.
1208 Returns nil if COMMAND is not remapped (or not a symbol). */)
1210 Lisp_Object command
;
1212 if (!SYMBOLP (command
))
1215 ASET (command_remapping_vector
, 1, command
);
1216 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1219 /* Value is number if KEY is too long; nil if valid but has no definition. */
1220 /* GC is possible in this function if it autoloads a keymap. */
1222 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1223 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1224 nil means undefined. See doc of `define-key' for kinds of definitions.
1226 A number as value means KEY is "too long";
1227 that is, characters or symbols in it except for the last one
1228 fail to be a valid sequence of prefix characters in KEYMAP.
1229 The number is how many characters at the front of KEY
1230 it takes to reach a non-prefix key.
1232 Normally, `lookup-key' ignores bindings for t, which act as default
1233 bindings, used when nothing else in the keymap applies; this makes it
1234 usable as a general function for probing keymaps. However, if the
1235 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1236 recognize the default bindings, just as `read-key-sequence' does. */)
1237 (keymap
, key
, accept_default
)
1240 Lisp_Object accept_default
;
1243 register Lisp_Object cmd
;
1244 register Lisp_Object c
;
1246 int t_ok
= !NILP (accept_default
);
1247 struct gcpro gcpro1
, gcpro2
;
1249 GCPRO2 (keymap
, key
);
1250 keymap
= get_keymap (keymap
, 1, 1);
1252 if (!VECTORP (key
) && !STRINGP (key
))
1253 key
= wrong_type_argument (Qarrayp
, key
);
1255 length
= XFASTINT (Flength (key
));
1257 RETURN_UNGCPRO (keymap
);
1262 c
= Faref (key
, make_number (idx
++));
1264 if (CONSP (c
) && lucid_event_type_list_p (c
))
1265 c
= Fevent_convert_list (c
);
1267 /* Turn the 8th bit of string chars into a meta modifier. */
1268 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1269 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1271 /* Allow string since binding for `menu-bar-select-buffer'
1272 includes the buffer name in the key sequence. */
1273 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1274 error ("Key sequence contains invalid event");
1276 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1278 RETURN_UNGCPRO (cmd
);
1280 keymap
= get_keymap (cmd
, 0, 1);
1281 if (!CONSP (keymap
))
1282 RETURN_UNGCPRO (make_number (idx
));
1288 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1289 Assume that currently it does not define C at all.
1290 Return the keymap. */
1293 define_as_prefix (keymap
, c
)
1294 Lisp_Object keymap
, c
;
1298 cmd
= Fmake_sparse_keymap (Qnil
);
1299 /* If this key is defined as a prefix in an inherited keymap,
1300 make it a prefix in this map, and make its definition
1301 inherit the other prefix definition. */
1302 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1303 store_in_keymap (keymap
, c
, cmd
);
1308 /* Append a key to the end of a key sequence. We always make a vector. */
1311 append_key (key_sequence
, key
)
1312 Lisp_Object key_sequence
, key
;
1314 Lisp_Object args
[2];
1316 args
[0] = key_sequence
;
1318 args
[1] = Fcons (key
, Qnil
);
1319 return Fvconcat (2, args
);
1322 /* Given a event type C which is a symbol,
1323 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1326 silly_event_symbol_error (c
)
1329 Lisp_Object parsed
, base
, name
, assoc
;
1332 parsed
= parse_modifiers (c
);
1333 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1334 base
= XCAR (parsed
);
1335 name
= Fsymbol_name (base
);
1336 /* This alist includes elements such as ("RET" . "\\r"). */
1337 assoc
= Fassoc (name
, exclude_keys
);
1341 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1343 Lisp_Object keystring
;
1344 if (modifiers
& alt_modifier
)
1345 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1346 if (modifiers
& ctrl_modifier
)
1347 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1348 if (modifiers
& hyper_modifier
)
1349 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1350 if (modifiers
& meta_modifier
)
1351 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1352 if (modifiers
& shift_modifier
)
1353 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1354 if (modifiers
& super_modifier
)
1355 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1358 c
= reorder_modifiers (c
);
1359 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1361 error ((modifiers
& ~meta_modifier
1362 ? "To bind the key %s, use [?%s], not [%s]"
1363 : "To bind the key %s, use \"%s\", not [%s]"),
1364 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1365 SDATA (SYMBOL_NAME (c
)));
1369 /* Global, local, and minor mode keymap stuff. */
1371 /* We can't put these variables inside current_minor_maps, since under
1372 some systems, static gets macro-defined to be the empty string.
1374 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1375 static int cmm_size
= 0;
1377 /* Store a pointer to an array of the keymaps of the currently active
1378 minor modes in *buf, and return the number of maps it contains.
1380 This function always returns a pointer to the same buffer, and may
1381 free or reallocate it, so if you want to keep it for a long time or
1382 hand it out to lisp code, copy it. This procedure will be called
1383 for every key sequence read, so the nice lispy approach (return a
1384 new assoclist, list, what have you) for each invocation would
1385 result in a lot of consing over time.
1387 If we used xrealloc/xmalloc and ran out of memory, they would throw
1388 back to the command loop, which would try to read a key sequence,
1389 which would call this function again, resulting in an infinite
1390 loop. Instead, we'll use realloc/malloc and silently truncate the
1391 list, let the key sequence be read, and hope some other piece of
1392 code signals the error. */
1394 current_minor_maps (modeptr
, mapptr
)
1395 Lisp_Object
**modeptr
, **mapptr
;
1398 int list_number
= 0;
1399 Lisp_Object alist
, assoc
, var
, val
;
1400 Lisp_Object emulation_alists
;
1401 Lisp_Object lists
[2];
1403 emulation_alists
= Vemulation_mode_map_alists
;
1404 lists
[0] = Vminor_mode_overriding_map_alist
;
1405 lists
[1] = Vminor_mode_map_alist
;
1407 for (list_number
= 0; list_number
< 2; list_number
++)
1409 if (CONSP (emulation_alists
))
1411 alist
= XCAR (emulation_alists
);
1412 emulation_alists
= XCDR (emulation_alists
);
1413 if (SYMBOLP (alist
))
1414 alist
= find_symbol_value (alist
);
1418 alist
= lists
[list_number
];
1420 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1421 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1422 && (var
= XCAR (assoc
), SYMBOLP (var
))
1423 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1428 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1429 and also an entry in Vminor_mode_map_alist,
1430 ignore the latter. */
1431 if (list_number
== 1)
1433 val
= assq_no_quit (var
, lists
[0]);
1440 int newsize
, allocsize
;
1441 Lisp_Object
*newmodes
, *newmaps
;
1443 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1444 allocsize
= newsize
* sizeof *newmodes
;
1446 /* Use malloc here. See the comment above this function.
1447 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1449 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1454 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1457 cmm_modes
= newmodes
;
1460 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1465 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1472 if (newmodes
== NULL
|| newmaps
== NULL
)
1477 /* Get the keymap definition--or nil if it is not defined. */
1478 temp
= Findirect_function (XCDR (assoc
), Qt
);
1482 cmm_maps
[i
] = temp
;
1488 if (modeptr
) *modeptr
= cmm_modes
;
1489 if (mapptr
) *mapptr
= cmm_maps
;
1493 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1495 doc
: /* Return a list of the currently active keymaps.
1496 OLP if non-nil indicates that we should obey `overriding-local-map' and
1497 `overriding-terminal-local-map'. */)
1501 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1505 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1506 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1507 /* The doc said that overriding-terminal-local-map should
1508 override overriding-local-map. The code used them both,
1509 but it seems clearer to use just one. rms, jan 2005. */
1510 else if (!NILP (Voverriding_local_map
))
1511 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1513 if (NILP (XCDR (keymaps
)))
1519 /* This usually returns the buffer's local map,
1520 but that can be overridden by a `local-map' property. */
1521 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1523 keymaps
= Fcons (local
, keymaps
);
1525 /* Now put all the minor mode keymaps on the list. */
1526 nmaps
= current_minor_maps (0, &maps
);
1528 for (i
= --nmaps
; i
>= 0; i
--)
1529 if (!NILP (maps
[i
]))
1530 keymaps
= Fcons (maps
[i
], keymaps
);
1532 /* This returns nil unless there is a `keymap' property. */
1533 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1535 keymaps
= Fcons (local
, keymaps
);
1541 /* GC is possible in this function if it autoloads a keymap. */
1543 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1544 doc
: /* Return the binding for command KEY in current keymaps.
1545 KEY is a string or vector, a sequence of keystrokes.
1546 The binding is probably a symbol with a function definition.
1548 Normally, `key-binding' ignores bindings for t, which act as default
1549 bindings, used when nothing else in the keymap applies; this makes it
1550 usable as a general function for probing keymaps. However, if the
1551 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1552 recognize the default bindings, just as `read-key-sequence' does.
1554 Like the normal command loop, `key-binding' will remap the command
1555 resulting from looking up KEY by looking up the command in the
1556 current keymaps. However, if the optional third argument NO-REMAP
1557 is non-nil, `key-binding' returns the unmapped command. */)
1558 (key
, accept_default
, no_remap
)
1559 Lisp_Object key
, accept_default
, no_remap
;
1561 Lisp_Object
*maps
, value
;
1563 struct gcpro gcpro1
;
1567 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1569 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1570 key
, accept_default
);
1571 if (! NILP (value
) && !INTEGERP (value
))
1574 else if (!NILP (Voverriding_local_map
))
1576 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1577 if (! NILP (value
) && !INTEGERP (value
))
1584 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1587 value
= Flookup_key (local
, key
, accept_default
);
1588 if (! NILP (value
) && !INTEGERP (value
))
1592 nmaps
= current_minor_maps (0, &maps
);
1593 /* Note that all these maps are GCPRO'd
1594 in the places where we found them. */
1596 for (i
= 0; i
< nmaps
; i
++)
1597 if (! NILP (maps
[i
]))
1599 value
= Flookup_key (maps
[i
], key
, accept_default
);
1600 if (! NILP (value
) && !INTEGERP (value
))
1604 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1607 value
= Flookup_key (local
, key
, accept_default
);
1608 if (! NILP (value
) && !INTEGERP (value
))
1613 value
= Flookup_key (current_global_map
, key
, accept_default
);
1617 if (NILP (value
) || INTEGERP (value
))
1620 /* If the result of the ordinary keymap lookup is an interactive
1621 command, look for a key binding (ie. remapping) for that command. */
1623 if (NILP (no_remap
) && SYMBOLP (value
))
1626 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1633 /* GC is possible in this function if it autoloads a keymap. */
1635 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1636 doc
: /* Return the binding for command KEYS in current local keymap only.
1637 KEYS is a string or vector, a sequence of keystrokes.
1638 The binding is probably a symbol with a function definition.
1640 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1641 bindings; see the description of `lookup-key' for more details about this. */)
1642 (keys
, accept_default
)
1643 Lisp_Object keys
, accept_default
;
1645 register Lisp_Object map
;
1646 map
= current_buffer
->keymap
;
1649 return Flookup_key (map
, keys
, accept_default
);
1652 /* GC is possible in this function if it autoloads a keymap. */
1654 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1655 doc
: /* Return the binding for command KEYS in current global keymap only.
1656 KEYS is a string or vector, a sequence of keystrokes.
1657 The binding is probably a symbol with a function definition.
1658 This function's return values are the same as those of `lookup-key'
1661 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1662 bindings; see the description of `lookup-key' for more details about this. */)
1663 (keys
, accept_default
)
1664 Lisp_Object keys
, accept_default
;
1666 return Flookup_key (current_global_map
, keys
, accept_default
);
1669 /* GC is possible in this function if it autoloads a keymap. */
1671 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1672 doc
: /* Find the visible minor mode bindings of KEY.
1673 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1674 the symbol which names the minor mode binding KEY, and BINDING is
1675 KEY's definition in that mode. In particular, if KEY has no
1676 minor-mode bindings, return nil. If the first binding is a
1677 non-prefix, all subsequent bindings will be omitted, since they would
1678 be ignored. Similarly, the list doesn't include non-prefix bindings
1679 that come after prefix bindings.
1681 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1682 bindings; see the description of `lookup-key' for more details about this. */)
1683 (key
, accept_default
)
1684 Lisp_Object key
, accept_default
;
1686 Lisp_Object
*modes
, *maps
;
1688 Lisp_Object binding
;
1690 struct gcpro gcpro1
, gcpro2
;
1692 nmaps
= current_minor_maps (&modes
, &maps
);
1693 /* Note that all these maps are GCPRO'd
1694 in the places where we found them. */
1697 GCPRO2 (key
, binding
);
1699 for (i
= j
= 0; i
< nmaps
; i
++)
1701 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1702 && !INTEGERP (binding
))
1704 if (KEYMAPP (binding
))
1705 maps
[j
++] = Fcons (modes
[i
], binding
);
1707 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1711 return Flist (j
, maps
);
1714 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1715 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1716 A new sparse keymap is stored as COMMAND's function definition and its value.
1717 If a second optional argument MAPVAR is given, the map is stored as
1718 its value instead of as COMMAND's value; but COMMAND is still defined
1720 The third optional argument NAME, if given, supplies a menu name
1721 string for the map. This is required to use the keymap as a menu.
1722 This function returns COMMAND. */)
1723 (command
, mapvar
, name
)
1724 Lisp_Object command
, mapvar
, name
;
1727 map
= Fmake_sparse_keymap (name
);
1728 Ffset (command
, map
);
1732 Fset (command
, map
);
1736 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1737 doc
: /* Select KEYMAP as the global keymap. */)
1741 keymap
= get_keymap (keymap
, 1, 1);
1742 current_global_map
= keymap
;
1747 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1748 doc
: /* Select KEYMAP as the local keymap.
1749 If KEYMAP is nil, that means no local keymap. */)
1754 keymap
= get_keymap (keymap
, 1, 1);
1756 current_buffer
->keymap
= keymap
;
1761 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1762 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1765 return current_buffer
->keymap
;
1768 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1769 doc
: /* Return the current global keymap. */)
1772 return current_global_map
;
1775 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1776 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1780 int nmaps
= current_minor_maps (0, &maps
);
1782 return Flist (nmaps
, maps
);
1785 /* Help functions for describing and documenting keymaps. */
1789 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1790 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1791 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1795 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1799 /* Look for and break cycles. */
1800 while (!NILP (tem
= Frassq (cmd
, maps
)))
1802 Lisp_Object prefix
= XCAR (tem
);
1803 int lim
= XINT (Flength (XCAR (tem
)));
1804 if (lim
<= XINT (Flength (thisseq
)))
1805 { /* This keymap was already seen with a smaller prefix. */
1807 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1808 Faref (thisseq
, make_number (i
))))
1811 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1814 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1815 but maybe `cmd' occurs again further down in `maps', so keep
1817 maps
= XCDR (Fmemq (tem
, maps
));
1820 /* If the last key in thisseq is meta-prefix-char,
1821 turn it into a meta-ized keystroke. We know
1822 that the event we're about to append is an
1823 ascii keystroke since we're processing a
1827 int meta_bit
= meta_modifier
;
1828 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1829 tem
= Fcopy_sequence (thisseq
);
1831 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1833 /* This new sequence is the same length as
1834 thisseq, so stick it in the list right
1837 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1841 tem
= append_key (thisseq
, key
);
1842 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1847 accessible_keymaps_char_table (args
, index
, cmd
)
1848 Lisp_Object args
, index
, cmd
;
1850 accessible_keymaps_1 (index
, cmd
,
1854 XINT (XCDR (XCAR (args
))));
1857 /* This function cannot GC. */
1859 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1861 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1862 Returns a list of elements of the form (KEYS . MAP), where the sequence
1863 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1864 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1865 An optional argument PREFIX, if non-nil, should be a key sequence;
1866 then the value includes only maps for prefixes that start with PREFIX. */)
1868 Lisp_Object keymap
, prefix
;
1870 Lisp_Object maps
, tail
;
1873 /* no need for gcpro because we don't autoload any keymaps. */
1876 prefixlen
= XINT (Flength (prefix
));
1880 /* If a prefix was specified, start with the keymap (if any) for
1881 that prefix, so we don't waste time considering other prefixes. */
1883 tem
= Flookup_key (keymap
, prefix
, Qt
);
1884 /* Flookup_key may give us nil, or a number,
1885 if the prefix is not defined in this particular map.
1886 It might even give us a list that isn't a keymap. */
1887 tem
= get_keymap (tem
, 0, 0);
1890 /* Convert PREFIX to a vector now, so that later on
1891 we don't have to deal with the possibility of a string. */
1892 if (STRINGP (prefix
))
1897 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1898 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1902 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1903 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1904 c
^= 0200 | meta_modifier
;
1905 ASET (copy
, i_before
, make_number (c
));
1909 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1915 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1916 get_keymap (keymap
, 1, 0)),
1919 /* For each map in the list maps,
1920 look at any other maps it points to,
1921 and stick them at the end if they are not already in the list.
1923 This is a breadth-first traversal, where tail is the queue of
1924 nodes, and maps accumulates a list of all nodes visited. */
1926 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1928 register Lisp_Object thisseq
, thismap
;
1930 /* Does the current sequence end in the meta-prefix-char? */
1933 thisseq
= Fcar (Fcar (tail
));
1934 thismap
= Fcdr (Fcar (tail
));
1935 last
= make_number (XINT (Flength (thisseq
)) - 1);
1936 is_metized
= (XINT (last
) >= 0
1937 /* Don't metize the last char of PREFIX. */
1938 && XINT (last
) >= prefixlen
1939 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1941 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1945 elt
= XCAR (thismap
);
1949 if (CHAR_TABLE_P (elt
))
1951 Lisp_Object indices
[3];
1953 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
1954 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1955 Fcons (tail
, thisseq
)),
1958 else if (VECTORP (elt
))
1962 /* Vector keymap. Scan all the elements. */
1963 for (i
= 0; i
< ASIZE (elt
); i
++)
1964 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1965 maps
, tail
, thisseq
, is_metized
);
1968 else if (CONSP (elt
))
1969 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1970 maps
, tail
, thisseq
,
1971 is_metized
&& INTEGERP (XCAR (elt
)));
1979 Lisp_Object Qsingle_key_description
, Qkey_description
;
1981 /* This function cannot GC. */
1983 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
1984 doc
: /* Return a pretty description of key-sequence KEYS.
1985 Optional arg PREFIX is the sequence of keys leading up to KEYS.
1986 Control characters turn into "C-foo" sequences, meta into "M-foo",
1987 spaces are put between sequence elements, etc. */)
1989 Lisp_Object keys
, prefix
;
1994 int size
= XINT (Flength (keys
));
1996 Lisp_Object sep
= build_string (" ");
2001 size
+= XINT (Flength (prefix
));
2003 /* This has one extra element at the end that we don't pass to Fconcat. */
2004 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2006 /* In effect, this computes
2007 (mapconcat 'single-key-description keys " ")
2008 but we shouldn't use mapconcat because it can do GC. */
2012 list
= prefix
, prefix
= Qnil
;
2013 else if (!NILP (keys
))
2014 list
= keys
, keys
= Qnil
;
2019 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2023 return empty_string
;
2024 return Fconcat (len
- 1, args
);
2028 size
= SCHARS (list
);
2029 else if (VECTORP (list
))
2030 size
= XVECTOR (list
)->size
;
2031 else if (CONSP (list
))
2032 size
= XINT (Flength (list
));
2034 wrong_type_argument (Qarrayp
, list
);
2043 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2044 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2045 c
^= 0200 | meta_modifier
;
2046 XSETFASTINT (key
, c
);
2048 else if (VECTORP (list
))
2050 key
= AREF (list
, i
++);
2062 || EQ (key
, meta_prefix_char
)
2063 || (XINT (key
) & meta_modifier
))
2065 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2067 if (EQ (key
, meta_prefix_char
))
2071 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2074 else if (EQ (key
, meta_prefix_char
))
2079 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2087 push_key_description (c
, p
, force_multibyte
)
2088 register unsigned int c
;
2090 int force_multibyte
;
2094 /* Clear all the meaningless bits above the meta bit. */
2095 c
&= meta_modifier
| ~ - meta_modifier
;
2096 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2097 | meta_modifier
| shift_modifier
| super_modifier
);
2099 if (c
& alt_modifier
)
2105 if ((c
& ctrl_modifier
) != 0
2106 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2110 c
&= ~ctrl_modifier
;
2112 if (c
& hyper_modifier
)
2116 c
-= hyper_modifier
;
2118 if (c
& meta_modifier
)
2124 if (c
& shift_modifier
)
2128 c
-= shift_modifier
;
2130 if (c
& super_modifier
)
2134 c
-= super_modifier
;
2150 else if (c
== Ctl ('M'))
2158 /* `C-' already added above. */
2159 if (c
> 0 && c
<= Ctl ('Z'))
2178 || (NILP (current_buffer
->enable_multibyte_characters
)
2179 && SINGLE_BYTE_CHAR_P (c
)
2180 && !force_multibyte
))
2186 int valid_p
= SINGLE_BYTE_CHAR_P (c
) || char_valid_p (c
, 0);
2188 if (force_multibyte
&& valid_p
)
2190 if (SINGLE_BYTE_CHAR_P (c
))
2191 c
= unibyte_char_to_multibyte (c
);
2192 p
+= CHAR_STRING (c
, p
);
2194 else if (NILP (current_buffer
->enable_multibyte_characters
)
2199 /* The biggest character code uses 19 bits. */
2200 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2202 if (c
>= (1 << bit_offset
))
2203 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2207 p
+= CHAR_STRING (c
, p
);
2213 /* This function cannot GC. */
2215 DEFUN ("single-key-description", Fsingle_key_description
,
2216 Ssingle_key_description
, 1, 2, 0,
2217 doc
: /* Return a pretty description of command character KEY.
2218 Control characters turn into C-whatever, etc.
2219 Optional argument NO-ANGLES non-nil means don't put angle brackets
2220 around function keys and event symbols. */)
2222 Lisp_Object key
, no_angles
;
2224 if (CONSP (key
) && lucid_event_type_list_p (key
))
2225 key
= Fevent_convert_list (key
);
2227 key
= EVENT_HEAD (key
);
2229 if (INTEGERP (key
)) /* Normal character */
2231 unsigned int charset
, c1
, c2
;
2232 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2234 if (SINGLE_BYTE_CHAR_P (without_bits
))
2237 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2240 && CHARSET_DEFINED_P (charset
)
2241 && ((c1
>= 0 && c1
< 32)
2242 || (c2
>= 0 && c2
< 32)))
2244 /* Handle a generic character. */
2246 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
2247 CHECK_STRING (name
);
2248 return concat2 (build_string ("Character set "), name
);
2252 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2256 end
= push_key_description (XUINT (key
), tem
, 1);
2258 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2259 if (nchars
== nbytes
)
2262 string
= build_string (tem
);
2265 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2269 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2271 if (NILP (no_angles
))
2274 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2275 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2276 return build_string (buffer
);
2279 return Fsymbol_name (key
);
2281 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2282 return Fcopy_sequence (key
);
2284 error ("KEY must be an integer, cons, symbol, or string");
2289 push_text_char_description (c
, p
)
2290 register unsigned int c
;
2302 *p
++ = c
+ 64; /* 'A' - 1 */
2314 /* This function cannot GC. */
2316 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2317 doc
: /* Return a pretty description of file-character CHARACTER.
2318 Control characters turn into "^char", etc. This differs from
2319 `single-key-description' which turns them into "C-char".
2320 Also, this function recognizes the 2**7 bit as the Meta character,
2321 whereas `single-key-description' uses the 2**27 bit for Meta.
2322 See Info node `(elisp)Describing Characters' for examples. */)
2324 Lisp_Object character
;
2326 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2327 unsigned char str
[6];
2330 CHECK_NUMBER (character
);
2332 c
= XINT (character
);
2333 if (!SINGLE_BYTE_CHAR_P (c
))
2335 int len
= CHAR_STRING (c
, str
);
2337 return make_multibyte_string (str
, 1, len
);
2340 *push_text_char_description (c
& 0377, str
) = 0;
2342 return build_string (str
);
2345 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2348 ascii_sequence_p (seq
)
2352 int len
= XINT (Flength (seq
));
2354 for (i
= 0; i
< len
; i
++)
2356 Lisp_Object ii
, elt
;
2358 XSETFASTINT (ii
, i
);
2359 elt
= Faref (seq
, ii
);
2362 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2370 /* where-is - finding a command in a set of keymaps. */
2372 static Lisp_Object
where_is_internal ();
2373 static Lisp_Object
where_is_internal_1 ();
2374 static void where_is_internal_2 ();
2376 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2377 Returns the first non-nil binding found in any of those maps. */
2380 shadow_lookup (shadow
, key
, flag
)
2381 Lisp_Object shadow
, key
, flag
;
2383 Lisp_Object tail
, value
;
2385 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2387 value
= Flookup_key (XCAR (tail
), key
, flag
);
2388 if (NATNUMP (value
))
2390 value
= Flookup_key (XCAR (tail
),
2391 Fsubstring (key
, make_number (0), value
), flag
);
2395 else if (!NILP (value
))
2401 static Lisp_Object Vmouse_events
;
2403 /* This function can GC if Flookup_key autoloads any keymaps. */
2406 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2407 Lisp_Object definition
, keymaps
;
2408 Lisp_Object firstonly
, noindirect
, no_remap
;
2410 Lisp_Object maps
= Qnil
;
2411 Lisp_Object found
, sequences
;
2412 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2413 /* 1 means ignore all menu bindings entirely. */
2414 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2416 /* If this command is remapped, then it has no key bindings
2418 if (NILP (no_remap
) && SYMBOLP (definition
))
2421 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2426 while (CONSP (found
))
2430 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2431 found
= XCDR (found
);
2434 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2438 for (; !NILP (maps
); maps
= Fcdr (maps
))
2440 /* Key sequence to reach map, and the map that it reaches */
2441 register Lisp_Object
this, map
, tem
;
2443 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2444 [M-CHAR] sequences, check if last character of the sequence
2445 is the meta-prefix char. */
2449 this = Fcar (Fcar (maps
));
2450 map
= Fcdr (Fcar (maps
));
2451 last
= make_number (XINT (Flength (this)) - 1);
2452 last_is_meta
= (XINT (last
) >= 0
2453 && EQ (Faref (this, last
), meta_prefix_char
));
2455 /* if (nomenus && !ascii_sequence_p (this)) */
2456 if (nomenus
&& XINT (last
) >= 0
2457 && SYMBOLP (tem
= Faref (this, make_number (0)))
2458 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2459 /* If no menu entries should be returned, skip over the
2460 keymaps bound to `menu-bar' and `tool-bar' and other
2461 non-ascii prefixes like `C-down-mouse-2'. */
2468 /* Because the code we want to run on each binding is rather
2469 large, we don't want to have two separate loop bodies for
2470 sparse keymap bindings and tables; we want to iterate one
2471 loop body over both keymap and vector bindings.
2473 For this reason, if Fcar (map) is a vector, we don't
2474 advance map to the next element until i indicates that we
2475 have finished off the vector. */
2476 Lisp_Object elt
, key
, binding
;
2484 /* Set key and binding to the current key and binding, and
2485 advance map and i to the next binding. */
2488 Lisp_Object sequence
;
2490 /* In a vector, look at each element. */
2491 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2493 binding
= AREF (elt
, i
);
2494 XSETFASTINT (key
, i
);
2495 sequence
= where_is_internal_1 (binding
, key
, definition
,
2497 last
, nomenus
, last_is_meta
);
2498 if (!NILP (sequence
))
2499 sequences
= Fcons (sequence
, sequences
);
2502 else if (CHAR_TABLE_P (elt
))
2504 Lisp_Object indices
[3];
2507 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2508 Qnil
), /* Result accumulator. */
2509 Fcons (Fcons (this, last
),
2510 Fcons (make_number (nomenus
),
2511 make_number (last_is_meta
))));
2512 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2514 sequences
= XCDR (XCAR (args
));
2516 else if (CONSP (elt
))
2518 Lisp_Object sequence
;
2521 binding
= XCDR (elt
);
2523 sequence
= where_is_internal_1 (binding
, key
, definition
,
2525 last
, nomenus
, last_is_meta
);
2526 if (!NILP (sequence
))
2527 sequences
= Fcons (sequence
, sequences
);
2531 while (!NILP (sequences
))
2533 Lisp_Object sequence
, remapped
, function
;
2535 sequence
= XCAR (sequences
);
2536 sequences
= XCDR (sequences
);
2538 /* If the current sequence is a command remapping with
2539 format [remap COMMAND], find the key sequences
2540 which run COMMAND, and use those sequences instead. */
2543 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2544 && EQ (AREF (sequence
, 0), Qremap
)
2545 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2547 Lisp_Object remapped1
;
2549 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2550 if (CONSP (remapped1
))
2552 /* Verify that this key binding actually maps to the
2553 remapped command (see below). */
2554 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2556 sequence
= XCAR (remapped1
);
2557 remapped
= XCDR (remapped1
);
2558 goto record_sequence
;
2562 /* Verify that this key binding is not shadowed by another
2563 binding for the same key, before we say it exists.
2565 Mechanism: look for local definition of this key and if
2566 it is defined and does not match what we found then
2569 Either nil or number as value from Flookup_key
2571 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2575 /* Don't annoy user with strings from a menu such as
2576 Select Paste. Change them all to "(any string)",
2577 so that there seems to be only one menu item
2579 if (! NILP (sequence
))
2582 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2584 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2585 build_string ("(any string)"));
2588 /* It is a true unshadowed match. Record it, unless it's already
2589 been seen (as could happen when inheriting keymaps). */
2590 if (NILP (Fmember (sequence
, found
)))
2591 found
= Fcons (sequence
, found
);
2593 /* If firstonly is Qnon_ascii, then we can return the first
2594 binding we find. If firstonly is not Qnon_ascii but not
2595 nil, then we should return the first ascii-only binding
2597 if (EQ (firstonly
, Qnon_ascii
))
2598 RETURN_UNGCPRO (sequence
);
2599 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2600 RETURN_UNGCPRO (sequence
);
2602 if (CONSP (remapped
))
2604 sequence
= XCAR (remapped
);
2605 remapped
= XCDR (remapped
);
2606 goto record_sequence
;
2614 found
= Fnreverse (found
);
2616 /* firstonly may have been t, but we may have gone all the way through
2617 the keymaps without finding an all-ASCII key sequence. So just
2618 return the best we could find. */
2619 if (!NILP (firstonly
))
2620 return Fcar (found
);
2625 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2626 doc
: /* Return list of keys that invoke DEFINITION.
2627 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2628 If KEYMAP is nil, search all the currently active keymaps.
2629 If KEYMAP is a list of keymaps, search only those keymaps.
2631 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2632 rather than a list of all possible key sequences.
2633 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2634 no matter what it is.
2635 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2636 \(or their meta variants) and entirely reject menu bindings.
2638 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2639 to other keymaps or slots. This makes it possible to search for an
2640 indirect definition itself.
2642 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2643 that invoke a command which is remapped to DEFINITION, but include the
2644 remapped command in the returned list. */)
2645 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2646 Lisp_Object definition
, keymap
;
2647 Lisp_Object firstonly
, noindirect
, no_remap
;
2649 Lisp_Object sequences
, keymaps
;
2650 /* 1 means ignore all menu bindings entirely. */
2651 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2654 /* Find the relevant keymaps. */
2655 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2657 else if (!NILP (keymap
))
2658 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2660 keymaps
= Fcurrent_active_maps (Qnil
);
2662 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2663 We don't really need to check `keymap'. */
2664 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2668 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2670 /* Check heuristic-consistency of the cache. */
2671 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2672 where_is_cache
= Qnil
;
2674 if (NILP (where_is_cache
))
2676 /* We need to create the cache. */
2677 Lisp_Object args
[2];
2678 where_is_cache
= Fmake_hash_table (0, args
);
2679 where_is_cache_keymaps
= Qt
;
2681 /* Fill in the cache. */
2682 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2683 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2686 where_is_cache_keymaps
= keymaps
;
2689 /* We want to process definitions from the last to the first.
2690 Instead of consing, copy definitions to a vector and step
2691 over that vector. */
2692 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2693 n
= XINT (Flength (sequences
));
2694 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2695 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2696 defns
[i
++] = XCAR (sequences
);
2698 /* Verify that the key bindings are not shadowed. Note that
2699 the following can GC. */
2700 GCPRO2 (definition
, keymaps
);
2703 for (i
= n
- 1; i
>= 0; --i
)
2704 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2706 if (ascii_sequence_p (defns
[i
]))
2712 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2717 /* Kill the cache so that where_is_internal_1 doesn't think
2718 we're filling it up. */
2719 where_is_cache
= Qnil
;
2720 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2726 /* This is the function that Fwhere_is_internal calls using map_char_table.
2728 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2730 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2731 Since map_char_table doesn't really use the return value from this function,
2732 we the result append to RESULT, the slot in ARGS.
2734 This function can GC because it calls where_is_internal_1 which can
2738 where_is_internal_2 (args
, key
, binding
)
2739 Lisp_Object args
, key
, binding
;
2741 Lisp_Object definition
, noindirect
, this, last
;
2742 Lisp_Object result
, sequence
;
2743 int nomenus
, last_is_meta
;
2744 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2746 GCPRO3 (args
, key
, binding
);
2747 result
= XCDR (XCAR (args
));
2748 definition
= XCAR (XCAR (XCAR (args
)));
2749 noindirect
= XCDR (XCAR (XCAR (args
)));
2750 this = XCAR (XCAR (XCDR (args
)));
2751 last
= XCDR (XCAR (XCDR (args
)));
2752 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2753 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2755 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2756 this, last
, nomenus
, last_is_meta
);
2758 if (!NILP (sequence
))
2759 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2765 /* This function can GC because get_keyelt can. */
2768 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2769 nomenus
, last_is_meta
)
2770 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2771 int nomenus
, last_is_meta
;
2773 Lisp_Object sequence
;
2775 /* Search through indirections unless that's not wanted. */
2776 if (NILP (noindirect
))
2777 binding
= get_keyelt (binding
, 0);
2779 /* End this iteration if this element does not match
2782 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2783 || EQ (binding
, definition
)
2784 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2785 /* Doesn't match. */
2788 /* We have found a match. Construct the key sequence where we found it. */
2789 if (INTEGERP (key
) && last_is_meta
)
2791 sequence
= Fcopy_sequence (this);
2792 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2795 sequence
= append_key (this, key
);
2797 if (!NILP (where_is_cache
))
2799 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2800 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2807 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2809 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2810 doc
: /* Insert the list of all defined keys and their definitions.
2811 The list is inserted in the current buffer, while the bindings are
2812 looked up in BUFFER.
2813 The optional argument PREFIX, if non-nil, should be a key sequence;
2814 then we display only bindings that start with that prefix.
2815 The optional argument MENUS, if non-nil, says to mention menu bindings.
2816 \(Ordinarily these are omitted from the output.) */)
2817 (buffer
, prefix
, menus
)
2818 Lisp_Object buffer
, prefix
, menus
;
2820 Lisp_Object outbuf
, shadow
;
2821 int nomenu
= NILP (menus
);
2822 register Lisp_Object start1
;
2823 struct gcpro gcpro1
;
2825 char *alternate_heading
2827 Keyboard translations:\n\n\
2828 You type Translation\n\
2829 -------- -----------\n";
2834 outbuf
= Fcurrent_buffer ();
2836 /* Report on alternates for keys. */
2837 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2840 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2841 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2843 for (c
= 0; c
< translate_len
; c
++)
2844 if (translate
[c
] != c
)
2846 char buf
[KEY_DESCRIPTION_SIZE
];
2849 if (alternate_heading
)
2851 insert_string (alternate_heading
);
2852 alternate_heading
= 0;
2855 bufend
= push_key_description (translate
[c
], buf
, 1);
2856 insert (buf
, bufend
- buf
);
2857 Findent_to (make_number (16), make_number (1));
2858 bufend
= push_key_description (c
, buf
, 1);
2859 insert (buf
, bufend
- buf
);
2863 /* Insert calls signal_after_change which may GC. */
2864 translate
= SDATA (Vkeyboard_translate_table
);
2870 if (!NILP (Vkey_translation_map
))
2871 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2872 "Key translations", nomenu
, 1, 0, 0);
2875 /* Print the (major mode) local map. */
2877 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2878 start1
= current_kboard
->Voverriding_terminal_local_map
;
2879 else if (!NILP (Voverriding_local_map
))
2880 start1
= Voverriding_local_map
;
2884 describe_map_tree (start1
, 1, shadow
, prefix
,
2885 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2886 shadow
= Fcons (start1
, shadow
);
2890 /* Print the minor mode and major mode keymaps. */
2892 Lisp_Object
*modes
, *maps
;
2894 /* Temporarily switch to `buffer', so that we can get that buffer's
2895 minor modes correctly. */
2896 Fset_buffer (buffer
);
2898 nmaps
= current_minor_maps (&modes
, &maps
);
2899 Fset_buffer (outbuf
);
2901 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2902 XBUFFER (buffer
), Qkeymap
);
2905 describe_map_tree (start1
, 1, shadow
, prefix
,
2906 "\f\n`keymap' Property Bindings", nomenu
,
2908 shadow
= Fcons (start1
, shadow
);
2911 /* Print the minor mode maps. */
2912 for (i
= 0; i
< nmaps
; i
++)
2914 /* The title for a minor mode keymap
2915 is constructed at run time.
2916 We let describe_map_tree do the actual insertion
2917 because it takes care of other features when doing so. */
2920 if (!SYMBOLP (modes
[i
]))
2923 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2927 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2928 SCHARS (SYMBOL_NAME (modes
[i
])));
2929 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2931 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2932 p
+= sizeof (" Minor Mode Bindings") - 1;
2935 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2936 title
, nomenu
, 0, 0, 0);
2937 shadow
= Fcons (maps
[i
], shadow
);
2940 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2941 XBUFFER (buffer
), Qlocal_map
);
2944 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2945 describe_map_tree (start1
, 1, shadow
, prefix
,
2946 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2948 describe_map_tree (start1
, 1, shadow
, prefix
,
2949 "\f\n`local-map' Property Bindings",
2952 shadow
= Fcons (start1
, shadow
);
2956 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2957 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2959 /* Print the function-key-map translations under this prefix. */
2960 if (!NILP (Vfunction_key_map
))
2961 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2962 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2968 /* Insert a description of the key bindings in STARTMAP,
2969 followed by those of all maps reachable through STARTMAP.
2970 If PARTIAL is nonzero, omit certain "uninteresting" commands
2971 (such as `undefined').
2972 If SHADOW is non-nil, it is a list of maps;
2973 don't mention keys which would be shadowed by any of them.
2974 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2975 TITLE, if not 0, is a string to insert at the beginning.
2976 TITLE should not end with a colon or a newline; we supply that.
2977 If NOMENU is not 0, then omit menu-bar commands.
2979 If TRANSL is nonzero, the definitions are actually key translations
2980 so print strings and vectors differently.
2982 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2985 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
2986 don't omit it; instead, mention it but say it is shadowed. */
2989 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2990 always_title
, mention_shadow
)
2991 Lisp_Object startmap
, shadow
, prefix
;
2999 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
3000 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3007 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3010 GCPRO3 (maps
, seen
, sub_shadows
);
3016 /* Delete from MAPS each element that is for the menu bar. */
3017 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3019 Lisp_Object elt
, prefix
, tem
;
3022 prefix
= Fcar (elt
);
3023 if (XVECTOR (prefix
)->size
>= 1)
3025 tem
= Faref (prefix
, make_number (0));
3026 if (EQ (tem
, Qmenu_bar
))
3027 maps
= Fdelq (elt
, maps
);
3032 if (!NILP (maps
) || always_title
)
3036 insert_string (title
);
3039 insert_string (" Starting With ");
3040 insert1 (Fkey_description (prefix
, Qnil
));
3042 insert_string (":\n");
3044 insert_string (key_heading
);
3048 for (; !NILP (maps
); maps
= Fcdr (maps
))
3050 register Lisp_Object elt
, prefix
, tail
;
3053 prefix
= Fcar (elt
);
3057 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3061 shmap
= XCAR (tail
);
3063 /* If the sequence by which we reach this keymap is zero-length,
3064 then the shadow map for this keymap is just SHADOW. */
3065 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3066 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3068 /* If the sequence by which we reach this keymap actually has
3069 some elements, then the sequence's definition in SHADOW is
3070 what we should use. */
3073 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3074 if (INTEGERP (shmap
))
3078 /* If shmap is not nil and not a keymap,
3079 it completely shadows this map, so don't
3080 describe this map at all. */
3081 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3085 sub_shadows
= Fcons (shmap
, sub_shadows
);
3088 /* Maps we have already listed in this loop shadow this map. */
3089 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3092 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3094 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3097 describe_map (Fcdr (elt
), prefix
,
3098 transl
? describe_translation
: describe_command
,
3099 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3105 insert_string ("\n");
3110 static int previous_description_column
;
3113 describe_command (definition
, args
)
3114 Lisp_Object definition
, args
;
3116 register Lisp_Object tem1
;
3117 int column
= (int) current_column (); /* iftc */
3118 int description_column
;
3120 /* If column 16 is no good, go to col 32;
3121 but don't push beyond that--go to next line instead. */
3125 description_column
= 32;
3127 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3128 description_column
= 32;
3130 description_column
= 16;
3132 Findent_to (make_number (description_column
), make_number (1));
3133 previous_description_column
= description_column
;
3135 if (SYMBOLP (definition
))
3137 tem1
= SYMBOL_NAME (definition
);
3139 insert_string ("\n");
3141 else if (STRINGP (definition
) || VECTORP (definition
))
3142 insert_string ("Keyboard Macro\n");
3143 else if (KEYMAPP (definition
))
3144 insert_string ("Prefix Command\n");
3146 insert_string ("??\n");
3150 describe_translation (definition
, args
)
3151 Lisp_Object definition
, args
;
3153 register Lisp_Object tem1
;
3155 Findent_to (make_number (16), make_number (1));
3157 if (SYMBOLP (definition
))
3159 tem1
= SYMBOL_NAME (definition
);
3161 insert_string ("\n");
3163 else if (STRINGP (definition
) || VECTORP (definition
))
3165 insert1 (Fkey_description (definition
, Qnil
));
3166 insert_string ("\n");
3168 else if (KEYMAPP (definition
))
3169 insert_string ("Prefix Command\n");
3171 insert_string ("??\n");
3174 /* describe_map puts all the usable elements of a sparse keymap
3175 into an array of `struct describe_map_elt',
3176 then sorts them by the events. */
3178 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3180 /* qsort comparison function for sorting `struct describe_map_elt' by
3184 describe_map_compare (aa
, bb
)
3185 const void *aa
, *bb
;
3187 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3188 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3189 return ((XINT (a
->event
) > XINT (b
->event
))
3190 - (XINT (a
->event
) < XINT (b
->event
)));
3191 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3193 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3195 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3196 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3197 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3202 /* Describe the contents of map MAP, assuming that this map itself is
3203 reached by the sequence of prefix keys PREFIX (a string or vector).
3204 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3207 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3208 seen
, nomenu
, mention_shadow
)
3209 register Lisp_Object map
;
3211 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3218 Lisp_Object tail
, definition
, event
;
3220 Lisp_Object suppress
;
3223 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3225 /* These accumulate the values from sparse keymap bindings,
3226 so we can sort them and handle them in order. */
3227 int length_needed
= 0;
3228 struct describe_map_elt
*vect
;
3235 suppress
= intern ("suppress-keymap");
3237 /* This vector gets used to present single keys to Flookup_key. Since
3238 that is done once per keymap element, we don't want to cons up a
3239 fresh vector every time. */
3240 kludge
= Fmake_vector (make_number (1), Qnil
);
3243 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3246 vect
= ((struct describe_map_elt
*)
3247 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3249 GCPRO3 (prefix
, definition
, kludge
);
3251 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3255 if (VECTORP (XCAR (tail
))
3256 || CHAR_TABLE_P (XCAR (tail
)))
3257 describe_vector (XCAR (tail
),
3258 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3259 (int *)0, 0, 1, mention_shadow
);
3260 else if (CONSP (XCAR (tail
)))
3262 int this_shadowed
= 0;
3264 event
= XCAR (XCAR (tail
));
3266 /* Ignore bindings whose "prefix" are not really valid events.
3267 (We get these in the frames and buffers menu.) */
3268 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3271 if (nomenu
&& EQ (event
, Qmenu_bar
))
3274 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3276 /* Don't show undefined commands or suppressed commands. */
3277 if (NILP (definition
)) continue;
3278 if (SYMBOLP (definition
) && partial
)
3280 tem
= Fget (definition
, suppress
);
3285 /* Don't show a command that isn't really visible
3286 because a local definition of the same key shadows it. */
3288 ASET (kludge
, 0, event
);
3291 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3301 tem
= Flookup_key (map
, kludge
, Qt
);
3302 if (!EQ (tem
, definition
)) continue;
3304 vect
[slots_used
].event
= event
;
3305 vect
[slots_used
].definition
= definition
;
3306 vect
[slots_used
].shadowed
= this_shadowed
;
3309 else if (EQ (XCAR (tail
), Qkeymap
))
3311 /* The same keymap might be in the structure twice, if we're
3312 using an inherited keymap. So skip anything we've already
3314 tem
= Fassq (tail
, *seen
);
3315 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3317 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3321 /* If we found some sparse map events, sort them. */
3323 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3324 describe_map_compare
);
3326 /* Now output them in sorted order. */
3328 for (i
= 0; i
< slots_used
; i
++)
3330 Lisp_Object start
, end
;
3334 previous_description_column
= 0;
3339 ASET (kludge
, 0, vect
[i
].event
);
3340 start
= vect
[i
].event
;
3343 definition
= vect
[i
].definition
;
3345 /* Find consecutive chars that are identically defined. */
3346 if (INTEGERP (vect
[i
].event
))
3348 while (i
+ 1 < slots_used
3349 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3350 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3351 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3353 end
= vect
[i
].event
;
3356 /* Now START .. END is the range to describe next. */
3358 /* Insert the string to describe the event START. */
3359 insert1 (Fkey_description (kludge
, prefix
));
3361 if (!EQ (start
, end
))
3365 ASET (kludge
, 0, end
);
3366 /* Insert the string to describe the character END. */
3367 insert1 (Fkey_description (kludge
, prefix
));
3370 /* Print a description of the definition of this character.
3371 elt_describer will take care of spacing out far enough
3372 for alignment purposes. */
3373 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3375 if (vect
[i
].shadowed
)
3378 insert_string ("\n (that binding is currently shadowed by another mode)");
3387 describe_vector_princ (elt
, fun
)
3388 Lisp_Object elt
, fun
;
3390 Findent_to (make_number (16), make_number (1));
3395 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3396 doc
: /* Insert a description of contents of VECTOR.
3397 This is text showing the elements of vector matched against indices.
3398 DESCRIBER is the output function used; nil means use `princ'. */)
3400 Lisp_Object vector
, describer
;
3402 int count
= SPECPDL_INDEX ();
3403 if (NILP (describer
))
3404 describer
= intern ("princ");
3405 specbind (Qstandard_output
, Fcurrent_buffer ());
3406 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3407 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3408 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3410 return unbind_to (count
, Qnil
);
3413 /* Insert in the current buffer a description of the contents of VECTOR.
3414 We call ELT_DESCRIBER to insert the description of one value found
3417 ELT_PREFIX describes what "comes before" the keys or indices defined
3418 by this vector. This is a human-readable string whose size
3419 is not necessarily related to the situation.
3421 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3422 leads to this keymap.
3424 If the vector is a chartable, ELT_PREFIX is the vector
3425 of bytes that lead to the character set or portion of a character
3426 set described by this chartable.
3428 If PARTIAL is nonzero, it means do not mention suppressed commands
3429 (that assumes the vector is in a keymap).
3431 SHADOW is a list of keymaps that shadow this map.
3432 If it is non-nil, then we look up the key in those maps
3433 and we don't mention it now if it is defined by any of them.
3435 ENTIRE_MAP is the keymap in which this vector appears.
3436 If the definition in effect in the whole map does not match
3437 the one in this vector, we ignore this one.
3439 When describing a sub-char-table, INDICES is a list of
3440 indices at higher levels in this char-table,
3441 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3443 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3445 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3448 describe_vector (vector
, prefix
, args
, elt_describer
,
3449 partial
, shadow
, entire_map
,
3450 indices
, char_table_depth
, keymap_p
,
3452 register Lisp_Object vector
;
3453 Lisp_Object prefix
, args
;
3454 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3457 Lisp_Object entire_map
;
3459 int char_table_depth
;
3463 Lisp_Object definition
;
3465 Lisp_Object elt_prefix
= Qnil
;
3467 Lisp_Object suppress
;
3470 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3471 /* Range of elements to be handled. */
3473 /* A flag to tell if a leaf in this level of char-table is not a
3474 generic character (i.e. a complete multibyte character). */
3482 indices
= (int *) alloca (3 * sizeof (int));
3488 /* Call Fkey_description first, to avoid GC bug for the other string. */
3489 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3492 tem
= Fkey_description (prefix
, Qnil
);
3493 elt_prefix
= concat2 (tem
, build_string (" "));
3498 /* This vector gets used to present single keys to Flookup_key. Since
3499 that is done once per vector element, we don't want to cons up a
3500 fresh vector every time. */
3501 kludge
= Fmake_vector (make_number (1), Qnil
);
3502 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3505 suppress
= intern ("suppress-keymap");
3507 if (CHAR_TABLE_P (vector
))
3509 if (char_table_depth
== 0)
3511 /* VECTOR is a top level char-table. */
3514 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3518 /* VECTOR is a sub char-table. */
3519 if (char_table_depth
>= 3)
3520 /* A char-table is never that deep. */
3521 error ("Too deep char table");
3524 = (CHARSET_VALID_P (indices
[0])
3525 && ((CHARSET_DIMENSION (indices
[0]) == 1
3526 && char_table_depth
== 1)
3527 || char_table_depth
== 2));
3529 /* Meaningful elements are from 32th to 127th. */
3531 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3536 /* This does the right thing for ordinary vectors. */
3540 to
= XVECTOR (vector
)->size
;
3543 for (i
= from
; i
< to
; i
++)
3545 int this_shadowed
= 0;
3548 if (CHAR_TABLE_P (vector
))
3550 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3553 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3554 && !CHARSET_DEFINED_P (i
- 128))
3558 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3561 definition
= get_keyelt (AREF (vector
, i
), 0);
3563 if (NILP (definition
)) continue;
3565 /* Don't mention suppressed commands. */
3566 if (SYMBOLP (definition
) && partial
)
3570 tem
= Fget (definition
, suppress
);
3572 if (!NILP (tem
)) continue;
3575 /* Set CHARACTER to the character this entry describes, if any.
3576 Also update *INDICES. */
3577 if (CHAR_TABLE_P (vector
))
3579 indices
[char_table_depth
] = i
;
3581 if (char_table_depth
== 0)
3584 indices
[0] = i
- 128;
3586 else if (complete_char
)
3588 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3596 ASET (kludge
, 0, make_number (character
));
3598 /* If this binding is shadowed by some other map, ignore it. */
3599 if (!NILP (shadow
) && complete_char
)
3603 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3614 /* Ignore this definition if it is shadowed by an earlier
3615 one in the same keymap. */
3616 if (!NILP (entire_map
) && complete_char
)
3620 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3622 if (!EQ (tem
, definition
))
3628 if (char_table_depth
== 0)
3633 /* For a sub char-table, show the depth by indentation.
3634 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3635 if (char_table_depth
> 0)
3636 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3638 /* Output the prefix that applies to every entry in this map. */
3639 if (!NILP (elt_prefix
))
3640 insert1 (elt_prefix
);
3642 /* Insert or describe the character this slot is for,
3643 or a description of what it is for. */
3644 if (SUB_CHAR_TABLE_P (vector
))
3647 insert_char (character
);
3650 /* We need an octal representation for this block of
3653 sprintf (work
, "(row %d)", i
);
3654 insert (work
, strlen (work
));
3657 else if (CHAR_TABLE_P (vector
))
3660 insert1 (Fkey_description (kludge
, prefix
));
3663 /* Print the information for this character set. */
3664 insert_string ("<");
3665 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3667 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3676 insert1 (Fkey_description (kludge
, prefix
));
3679 /* If we find a sub char-table within a char-table,
3680 scan it recursively; it defines the details for
3681 a character set or a portion of a character set. */
3682 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3685 describe_vector (definition
, prefix
, args
, elt_describer
,
3686 partial
, shadow
, entire_map
,
3687 indices
, char_table_depth
+ 1, keymap_p
,
3694 /* Find all consecutive characters or rows that have the same
3695 definition. But, for elements of a top level char table, if
3696 they are for charsets, we had better describe one by one even
3697 if they have the same definition. */
3698 if (CHAR_TABLE_P (vector
))
3702 if (char_table_depth
== 0)
3703 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3705 while (i
+ 1 < limit
3706 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3708 && !NILP (Fequal (tem2
, definition
)))
3713 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3715 && !NILP (Fequal (tem2
, definition
)))
3719 /* If we have a range of more than one character,
3720 print where the range reaches to. */
3722 if (i
!= starting_i
)
3726 ASET (kludge
, 0, make_number (i
));
3728 if (!NILP (elt_prefix
))
3729 insert1 (elt_prefix
);
3731 if (CHAR_TABLE_P (vector
))
3733 if (char_table_depth
== 0)
3735 insert1 (Fkey_description (kludge
, prefix
));
3737 else if (complete_char
)
3739 indices
[char_table_depth
] = i
;
3740 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3741 insert_char (character
);
3745 /* We need an octal representation for this block of
3748 sprintf (work
, "(row %d)", i
);
3749 insert (work
, strlen (work
));
3754 insert1 (Fkey_description (kludge
, prefix
));
3758 /* Print a description of the definition of this character.
3759 elt_describer will take care of spacing out far enough
3760 for alignment purposes. */
3761 (*elt_describer
) (definition
, args
);
3766 insert_string (" (binding currently shadowed)");
3771 /* For (sub) char-table, print `defalt' slot at last. */
3772 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3774 insert (" ", char_table_depth
* 2);
3775 insert_string ("<<default>>");
3776 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3782 /* Apropos - finding all symbols whose names match a regexp. */
3783 static Lisp_Object apropos_predicate
;
3784 static Lisp_Object apropos_accumulate
;
3787 apropos_accum (symbol
, string
)
3788 Lisp_Object symbol
, string
;
3790 register Lisp_Object tem
;
3792 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3793 if (!NILP (tem
) && !NILP (apropos_predicate
))
3794 tem
= call1 (apropos_predicate
, symbol
);
3796 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3799 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3800 doc
: /* Show all symbols whose names contain match for REGEXP.
3801 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3802 for each symbol and a symbol is mentioned only if that returns non-nil.
3803 Return list of symbols found. */)
3805 Lisp_Object regexp
, predicate
;
3808 CHECK_STRING (regexp
);
3809 apropos_predicate
= predicate
;
3810 apropos_accumulate
= Qnil
;
3811 map_obarray (Vobarray
, apropos_accum
, regexp
);
3812 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3813 apropos_accumulate
= Qnil
;
3814 apropos_predicate
= Qnil
;
3821 Qkeymap
= intern ("keymap");
3822 staticpro (&Qkeymap
);
3823 staticpro (&apropos_predicate
);
3824 staticpro (&apropos_accumulate
);
3825 apropos_predicate
= Qnil
;
3826 apropos_accumulate
= Qnil
;
3828 /* Now we are ready to set up this property, so we can
3829 create char tables. */
3830 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3832 /* Initialize the keymaps standardly used.
3833 Each one is the value of a Lisp variable, and is also
3834 pointed to by a C variable */
3836 global_map
= Fmake_keymap (Qnil
);
3837 Fset (intern ("global-map"), global_map
);
3839 current_global_map
= global_map
;
3840 staticpro (&global_map
);
3841 staticpro (¤t_global_map
);
3843 meta_map
= Fmake_keymap (Qnil
);
3844 Fset (intern ("esc-map"), meta_map
);
3845 Ffset (intern ("ESC-prefix"), meta_map
);
3847 control_x_map
= Fmake_keymap (Qnil
);
3848 Fset (intern ("ctl-x-map"), control_x_map
);
3849 Ffset (intern ("Control-X-prefix"), control_x_map
);
3852 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3853 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3854 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3855 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3856 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3858 staticpro (&exclude_keys
);
3860 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3861 doc
: /* List of commands given new key bindings recently.
3862 This is used for internal purposes during Emacs startup;
3863 don't alter it yourself. */);
3864 Vdefine_key_rebound_commands
= Qt
;
3866 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3867 doc
: /* Default keymap to use when reading from the minibuffer. */);
3868 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3870 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3871 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3872 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3873 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3875 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3876 doc
: /* Local keymap for minibuffer input with completion. */);
3877 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3878 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3880 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3881 &Vminibuffer_local_filename_completion_map
,
3882 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3883 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3884 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3885 Vminibuffer_local_completion_map
);
3888 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3889 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3890 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3891 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3892 Vminibuffer_local_completion_map
);
3894 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3895 &Vminibuffer_local_must_match_filename_map
,
3896 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3897 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3898 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3899 Vminibuffer_local_must_match_map
);
3901 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3902 doc
: /* Alist of keymaps to use for minor modes.
3903 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3904 key sequences and look up bindings iff VARIABLE's value is non-nil.
3905 If two active keymaps bind the same key, the keymap appearing earlier
3906 in the list takes precedence. */);
3907 Vminor_mode_map_alist
= Qnil
;
3909 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3910 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3911 This variable is an alist just like `minor-mode-map-alist', and it is
3912 used the same way (and before `minor-mode-map-alist'); however,
3913 it is provided for major modes to bind locally. */);
3914 Vminor_mode_overriding_map_alist
= Qnil
;
3916 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3917 doc
: /* List of keymap alists to use for emulations modes.
3918 It is intended for modes or packages using multiple minor-mode keymaps.
3919 Each element is a keymap alist just like `minor-mode-map-alist', or a
3920 symbol with a variable binding which is a keymap alist, and it is used
3921 the same way. The "active" keymaps in each alist are used before
3922 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3923 Vemulation_mode_map_alists
= Qnil
;
3926 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3927 doc
: /* Keymap that translates key sequences to key sequences during input.
3928 This is used mainly for mapping ASCII function key sequences into
3929 real Emacs function key events (symbols).
3931 The `read-key-sequence' function replaces any subsequence bound by
3932 `function-key-map' with its binding. More precisely, when the active
3933 keymaps have no binding for the current key sequence but
3934 `function-key-map' binds a suffix of the sequence to a vector or string,
3935 `read-key-sequence' replaces the matching suffix with its binding, and
3936 continues with the new sequence.
3938 If the binding is a function, it is called with one argument (the prompt)
3939 and its return value (a key sequence) is used.
3941 The events that come from bindings in `function-key-map' are not
3942 themselves looked up in `function-key-map'.
3944 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3945 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3946 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3947 key, typing `ESC O P x' would return [f1 x]. */);
3948 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3950 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3951 doc
: /* Keymap of key translations that can override keymaps.
3952 This keymap works like `function-key-map', but comes after that,
3953 and its non-prefix bindings override ordinary bindings. */);
3954 Vkey_translation_map
= Qnil
;
3956 staticpro (&Vmouse_events
);
3957 Vmouse_events
= Fcons (intern ("menu-bar"),
3958 Fcons (intern ("tool-bar"),
3959 Fcons (intern ("header-line"),
3960 Fcons (intern ("mode-line"),
3961 Fcons (intern ("mouse-1"),
3962 Fcons (intern ("mouse-2"),
3963 Fcons (intern ("mouse-3"),
3964 Fcons (intern ("mouse-4"),
3965 Fcons (intern ("mouse-5"),
3969 Qsingle_key_description
= intern ("single-key-description");
3970 staticpro (&Qsingle_key_description
);
3972 Qkey_description
= intern ("key-description");
3973 staticpro (&Qkey_description
);
3975 Qkeymapp
= intern ("keymapp");
3976 staticpro (&Qkeymapp
);
3978 Qnon_ascii
= intern ("non-ascii");
3979 staticpro (&Qnon_ascii
);
3981 Qmenu_item
= intern ("menu-item");
3982 staticpro (&Qmenu_item
);
3984 Qremap
= intern ("remap");
3985 staticpro (&Qremap
);
3987 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3988 staticpro (&command_remapping_vector
);
3990 where_is_cache_keymaps
= Qt
;
3991 where_is_cache
= Qnil
;
3992 staticpro (&where_is_cache
);
3993 staticpro (&where_is_cache_keymaps
);
3995 defsubr (&Skeymapp
);
3996 defsubr (&Skeymap_parent
);
3997 defsubr (&Skeymap_prompt
);
3998 defsubr (&Sset_keymap_parent
);
3999 defsubr (&Smake_keymap
);
4000 defsubr (&Smake_sparse_keymap
);
4001 defsubr (&Smap_keymap
);
4002 defsubr (&Scopy_keymap
);
4003 defsubr (&Scommand_remapping
);
4004 defsubr (&Skey_binding
);
4005 defsubr (&Slocal_key_binding
);
4006 defsubr (&Sglobal_key_binding
);
4007 defsubr (&Sminor_mode_key_binding
);
4008 defsubr (&Sdefine_key
);
4009 defsubr (&Slookup_key
);
4010 defsubr (&Sdefine_prefix_command
);
4011 defsubr (&Suse_global_map
);
4012 defsubr (&Suse_local_map
);
4013 defsubr (&Scurrent_local_map
);
4014 defsubr (&Scurrent_global_map
);
4015 defsubr (&Scurrent_minor_mode_maps
);
4016 defsubr (&Scurrent_active_maps
);
4017 defsubr (&Saccessible_keymaps
);
4018 defsubr (&Skey_description
);
4019 defsubr (&Sdescribe_vector
);
4020 defsubr (&Ssingle_key_description
);
4021 defsubr (&Stext_char_description
);
4022 defsubr (&Swhere_is_internal
);
4023 defsubr (&Sdescribe_buffer_bindings
);
4024 defsubr (&Sapropos_internal
);
4030 initial_define_key (global_map
, 033, "ESC-prefix");
4031 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
4034 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
4035 (do not change this comment) */