1 /* Manipulation of keymaps
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
31 #include "termhooks.h"
32 #include "blockinput.h"
34 #include "intervals.h"
37 /* The number of elements in keymap vectors. */
38 #define DENSE_TABLE_SIZE (0200)
40 /* Actually allocate storage for these variables */
42 Lisp_Object current_global_map
; /* Current global keymap */
44 Lisp_Object global_map
; /* default global key bindings */
46 Lisp_Object meta_map
; /* The keymap used for globally bound
47 ESC-prefixed default commands */
49 Lisp_Object control_x_map
; /* The keymap used for globally bound
50 C-x-prefixed default commands */
52 /* was MinibufLocalMap */
53 Lisp_Object Vminibuffer_local_map
;
54 /* The keymap used by the minibuf for local
55 bindings when spaces are allowed in the
58 /* was MinibufLocalNSMap */
59 Lisp_Object Vminibuffer_local_ns_map
;
60 /* The keymap used by the minibuf for local
61 bindings when spaces are not encouraged
64 /* keymap used for minibuffers when doing completion */
65 /* was MinibufLocalCompletionMap */
66 Lisp_Object Vminibuffer_local_completion_map
;
68 /* keymap used for minibuffers when doing completion in filenames */
69 Lisp_Object Vminibuffer_local_filename_completion_map
;
71 /* keymap used for minibuffers when doing completion in filenames
73 Lisp_Object Vminibuffer_local_must_match_filename_map
;
75 /* keymap used for minibuffers when doing completion and require a match */
76 /* was MinibufLocalMustMatchMap */
77 Lisp_Object Vminibuffer_local_must_match_map
;
79 /* Alist of minor mode variables and keymaps. */
80 Lisp_Object Vminor_mode_map_alist
;
82 /* Alist of major-mode-specific overrides for
83 minor mode variables and keymaps. */
84 Lisp_Object Vminor_mode_overriding_map_alist
;
86 /* List of emulation mode keymap alists. */
87 Lisp_Object Vemulation_mode_map_alists
;
89 /* Keymap mapping ASCII function key sequences onto their preferred forms.
90 Initialized by the terminal-specific lisp files. See DEFVAR for more
92 Lisp_Object Vfunction_key_map
;
94 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
95 Lisp_Object Vkey_translation_map
;
97 /* A list of all commands given new bindings since a certain time
98 when nil was stored here.
99 This is used to speed up recomputation of menu key equivalents
100 when Emacs starts up. t means don't record anything here. */
101 Lisp_Object Vdefine_key_rebound_commands
;
103 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
105 /* Alist of elements like (DEL . "\d"). */
106 static Lisp_Object exclude_keys
;
108 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
109 static Lisp_Object command_remapping_vector
;
111 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
112 in a string key sequence is equivalent to prefixing with this
114 extern Lisp_Object meta_prefix_char
;
116 extern Lisp_Object Voverriding_local_map
;
118 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
119 static Lisp_Object where_is_cache
;
120 /* Which keymaps are reverse-stored in the cache. */
121 static Lisp_Object where_is_cache_keymaps
;
123 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
124 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
126 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
127 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
128 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
129 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
130 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
131 int, Lisp_Object
, Lisp_Object
*, int, int));
132 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
133 void (*) (Lisp_Object
, Lisp_Object
), int,
134 Lisp_Object
, Lisp_Object
, int *,
136 static void silly_event_symbol_error
P_ ((Lisp_Object
));
138 /* Keymap object support - constructors and predicates. */
140 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
141 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
142 CHARTABLE is a char-table that holds the bindings for all characters
143 without modifiers. All entries in it are initially nil, meaning
144 "command undefined". ALIST is an assoc-list which holds bindings for
145 function keys, mouse events, and any other things that appear in the
146 input stream. Initially, ALIST is nil.
148 The optional arg STRING supplies a menu name for the keymap
149 in case you use it as a menu with `x-popup-menu'. */)
155 tail
= Fcons (string
, Qnil
);
158 return Fcons (Qkeymap
,
159 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
162 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
163 doc
: /* Construct and return a new sparse keymap.
164 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
165 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
166 which binds the function key or mouse event SYMBOL to DEFINITION.
167 Initially the alist is nil.
169 The optional arg STRING supplies a menu name for the keymap
170 in case you use it as a menu with `x-popup-menu'. */)
175 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
176 return Fcons (Qkeymap
, Qnil
);
179 /* This function is used for installing the standard key bindings
180 at initialization time.
184 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
187 initial_define_key (keymap
, key
, defname
)
192 store_in_keymap (keymap
, make_number (key
), intern (defname
));
196 initial_define_lispy_key (keymap
, keyname
, defname
)
201 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
204 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
205 doc
: /* Return t if OBJECT is a keymap.
207 A keymap is a list (keymap . ALIST),
208 or a symbol whose function definition is itself a keymap.
209 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
210 a vector of densely packed bindings for small character codes
211 is also allowed as an element. */)
215 return (KEYMAPP (object
) ? Qt
: Qnil
);
218 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
219 doc
: /* Return the prompt-string of a keymap MAP.
220 If non-nil, the prompt is shown in the echo-area
221 when reading a key-sequence to be looked-up in this keymap. */)
225 map
= get_keymap (map
, 0, 0);
228 Lisp_Object tem
= XCAR (map
);
236 /* Check that OBJECT is a keymap (after dereferencing through any
237 symbols). If it is, return it.
239 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
240 is an autoload form, do the autoload and try again.
241 If AUTOLOAD is nonzero, callers must assume GC is possible.
243 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
244 is zero as well), return Qt.
246 ERROR controls how we respond if OBJECT isn't a keymap.
247 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
249 Note that most of the time, we don't want to pursue autoloads.
250 Functions like Faccessible_keymaps which scan entire keymap trees
251 shouldn't load every autoloaded keymap. I'm not sure about this,
252 but it seems to me that only read_key_sequence, Flookup_key, and
253 Fdefine_key should cause keymaps to be autoloaded.
255 This function can GC when AUTOLOAD is non-zero, because it calls
256 do_autoload which can GC. */
259 get_keymap (object
, error
, autoload
)
268 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
271 tem
= indirect_function (object
);
274 if (EQ (XCAR (tem
), Qkeymap
))
277 /* Should we do an autoload? Autoload forms for keymaps have
278 Qkeymap as their fifth element. */
279 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
)
284 tail
= Fnth (make_number (4), tem
);
285 if (EQ (tail
, Qkeymap
))
289 struct gcpro gcpro1
, gcpro2
;
291 GCPRO2 (tem
, object
);
292 do_autoload (tem
, object
);
305 wrong_type_argument (Qkeymapp
, object
);
309 /* Return the parent map of KEYMAP, or nil if it has none.
310 We assume that KEYMAP is a valid keymap. */
313 keymap_parent (keymap
, autoload
)
319 keymap
= get_keymap (keymap
, 1, autoload
);
321 /* Skip past the initial element `keymap'. */
322 list
= XCDR (keymap
);
323 for (; CONSP (list
); list
= XCDR (list
))
325 /* See if there is another `keymap'. */
330 return get_keymap (list
, 0, autoload
);
333 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
334 doc
: /* Return the parent keymap of KEYMAP. */)
338 return keymap_parent (keymap
, 1);
341 /* Check whether MAP is one of MAPS parents. */
343 keymap_memberp (map
, maps
)
344 Lisp_Object map
, maps
;
346 if (NILP (map
)) return 0;
347 while (KEYMAPP (maps
) && !EQ (map
, maps
))
348 maps
= keymap_parent (maps
, 0);
349 return (EQ (map
, maps
));
352 /* Set the parent keymap of MAP to PARENT. */
354 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
355 doc
: /* Modify KEYMAP to set its parent map to PARENT.
356 Return PARENT. PARENT should be nil or another keymap. */)
358 Lisp_Object keymap
, parent
;
360 Lisp_Object list
, prev
;
361 struct gcpro gcpro1
, gcpro2
;
364 /* Force a keymap flush for the next call to where-is.
365 Since this can be called from within where-is, we don't set where_is_cache
366 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
367 be changed during where-is, while where_is_cache_keymaps is only used at
368 the very beginning of where-is and can thus be changed here without any
370 This is a very minor correctness (rather than safety) issue. */
371 where_is_cache_keymaps
= Qt
;
373 GCPRO2 (keymap
, parent
);
374 keymap
= get_keymap (keymap
, 1, 1);
378 parent
= get_keymap (parent
, 1, 1);
380 /* Check for cycles. */
381 if (keymap_memberp (keymap
, parent
))
382 error ("Cyclic keymap inheritance");
385 /* Skip past the initial element `keymap'. */
390 /* If there is a parent keymap here, replace it.
391 If we came to the end, add the parent in PREV. */
392 if (!CONSP (list
) || KEYMAPP (list
))
394 /* If we already have the right parent, return now
395 so that we avoid the loops below. */
396 if (EQ (XCDR (prev
), parent
))
397 RETURN_UNGCPRO (parent
);
400 XSETCDR (prev
, parent
);
406 /* Scan through for submaps, and set their parents too. */
408 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
410 /* Stop the scan when we come to the parent. */
411 if (EQ (XCAR (list
), Qkeymap
))
414 /* If this element holds a prefix map, deal with it. */
415 if (CONSP (XCAR (list
))
416 && CONSP (XCDR (XCAR (list
))))
417 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
420 if (VECTORP (XCAR (list
)))
421 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
422 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
423 fix_submap_inheritance (keymap
, make_number (i
),
424 XVECTOR (XCAR (list
))->contents
[i
]);
426 if (CHAR_TABLE_P (XCAR (list
)))
428 Lisp_Object indices
[3];
430 map_char_table (fix_submap_inheritance
, Qnil
,
431 XCAR (list
), XCAR (list
),
436 RETURN_UNGCPRO (parent
);
439 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
440 if EVENT is also a prefix in MAP's parent,
441 make sure that SUBMAP inherits that definition as its own parent. */
444 fix_submap_inheritance (map
, event
, submap
)
445 Lisp_Object map
, event
, submap
;
447 Lisp_Object map_parent
, parent_entry
;
449 /* SUBMAP is a cons that we found as a key binding.
450 Discard the other things found in a menu key binding. */
452 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
454 /* If it isn't a keymap now, there's no work to do. */
458 map_parent
= keymap_parent (map
, 0);
459 if (!NILP (map_parent
))
461 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
465 /* If MAP's parent has something other than a keymap,
466 our own submap shadows it completely. */
467 if (!CONSP (parent_entry
))
470 if (! EQ (parent_entry
, submap
))
472 Lisp_Object submap_parent
;
473 submap_parent
= submap
;
478 tem
= keymap_parent (submap_parent
, 0);
482 if (keymap_memberp (tem
, parent_entry
))
483 /* Fset_keymap_parent could create a cycle. */
490 Fset_keymap_parent (submap_parent
, parent_entry
);
494 /* Look up IDX in MAP. IDX may be any sort of event.
495 Note that this does only one level of lookup; IDX must be a single
496 event, not a sequence.
498 If T_OK is non-zero, bindings for Qt are treated as default
499 bindings; any key left unmentioned by other tables and bindings is
500 given the binding of Qt.
502 If T_OK is zero, bindings for Qt are not treated specially.
504 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
507 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
516 /* Qunbound in VAL means we have found no binding yet. */
519 /* If idx is a list (some sort of mouse click, perhaps?),
520 the index we want to use is the car of the list, which
521 ought to be a symbol. */
522 idx
= EVENT_HEAD (idx
);
524 /* If idx is a symbol, it might have modifiers, which need to
525 be put in the canonical order. */
527 idx
= reorder_modifiers (idx
);
528 else if (INTEGERP (idx
))
529 /* Clobber the high bits that can be present on a machine
530 with more than 24 bits of integer. */
531 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
533 /* Handle the special meta -> esc mapping. */
534 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
536 /* See if there is a meta-map. If there's none, there is
537 no binding for IDX, unless a default binding exists in MAP. */
539 Lisp_Object meta_map
;
541 /* A strange value in which Meta is set would cause
542 infinite recursion. Protect against that. */
543 if (XINT (meta_prefix_char
) & CHAR_META
)
544 meta_prefix_char
= make_number (27);
545 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
546 t_ok
, noinherit
, autoload
),
549 if (CONSP (meta_map
))
552 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
555 /* Set IDX to t, so that we only find a default binding. */
558 /* We know there is no binding. */
562 /* t_binding is where we put a default binding that applies,
563 to use in case we do not find a binding specifically
564 for this key sequence. */
567 Lisp_Object t_binding
= Qnil
;
568 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
570 GCPRO4 (map
, tail
, idx
, t_binding
);
572 /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
573 If it is 1, only generic-char bindings are accepted.
574 Otherwise, neither are. */
577 for (tail
= XCDR (map
);
579 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
584 binding
= XCAR (tail
);
585 if (SYMBOLP (binding
))
587 /* If NOINHERIT, stop finding prefix definitions
588 after we pass a second occurrence of the `keymap' symbol. */
589 if (noinherit
&& EQ (binding
, Qkeymap
))
590 RETURN_UNGCPRO (Qnil
);
592 else if (CONSP (binding
))
594 Lisp_Object key
= XCAR (binding
);
597 val
= XCDR (binding
);
600 && (XINT (idx
) & CHAR_MODIFIER_MASK
) == 0
602 && (XINT (key
) & CHAR_MODIFIER_MASK
) == 0
603 && !SINGLE_BYTE_CHAR_P (XINT (idx
))
604 && !SINGLE_BYTE_CHAR_P (XINT (key
))
605 && CHAR_VALID_P (XINT (key
), 1)
606 && !CHAR_VALID_P (XINT (key
), 0)
607 && (CHAR_CHARSET (XINT (key
))
608 == CHAR_CHARSET (XINT (idx
))))
610 /* KEY is the generic character of the charset of IDX.
611 Use KEY's binding if there isn't a binding for IDX
613 t_binding
= XCDR (binding
);
616 else if (t_ok
> 1 && EQ (key
, Qt
))
618 t_binding
= XCDR (binding
);
622 else if (VECTORP (binding
))
624 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
625 val
= AREF (binding
, XFASTINT (idx
));
627 else if (CHAR_TABLE_P (binding
))
629 /* Character codes with modifiers
630 are not included in a char-table.
631 All character codes without modifiers are included. */
632 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
634 val
= Faref (binding
, idx
);
635 /* `nil' has a special meaning for char-tables, so
636 we use something else to record an explicitly
643 /* If we found a binding, clean it up and return it. */
644 if (!EQ (val
, Qunbound
))
647 /* A Qt binding is just like an explicit nil binding
648 (i.e. it shadows any parent binding but not bindings in
649 keymaps of lower precedence). */
651 val
= get_keyelt (val
, autoload
);
653 fix_submap_inheritance (map
, idx
, val
);
654 RETURN_UNGCPRO (val
);
659 return get_keyelt (t_binding
, autoload
);
664 map_keymap_item (fun
, args
, key
, val
, data
)
665 map_keymap_function_t fun
;
666 Lisp_Object args
, key
, val
;
669 /* We should maybe try to detect bindings shadowed by previous
670 ones and things like that. */
673 (*fun
) (key
, val
, args
, data
);
677 map_keymap_char_table_item (args
, key
, val
)
678 Lisp_Object args
, key
, val
;
682 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
684 map_keymap_item (fun
, XCDR (args
), key
, val
,
685 XSAVE_VALUE (XCAR (args
))->pointer
);
689 /* Call FUN for every binding in MAP.
690 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
691 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
693 map_keymap (map
, fun
, args
, data
, autoload
)
694 map_keymap_function_t fun
;
695 Lisp_Object map
, args
;
699 struct gcpro gcpro1
, gcpro2
, gcpro3
;
702 GCPRO3 (map
, args
, tail
);
703 map
= get_keymap (map
, 1, autoload
);
704 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
705 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
708 Lisp_Object binding
= XCAR (tail
);
711 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
712 else if (VECTORP (binding
))
714 /* Loop over the char values represented in the vector. */
715 int len
= ASIZE (binding
);
717 for (c
= 0; c
< len
; c
++)
719 Lisp_Object character
;
720 XSETFASTINT (character
, c
);
721 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
724 else if (CHAR_TABLE_P (binding
))
726 Lisp_Object indices
[3];
727 map_char_table (map_keymap_char_table_item
, Qnil
, binding
, binding
,
728 Fcons (make_save_value (fun
, 0),
729 Fcons (make_save_value (data
, 0),
738 map_keymap_call (key
, val
, fun
, dummy
)
739 Lisp_Object key
, val
, fun
;
742 call2 (fun
, key
, val
);
745 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
746 doc
: /* Call FUNCTION for every binding in KEYMAP.
747 FUNCTION is called with two arguments: the event and its binding.
748 If KEYMAP has a parent, the parent's bindings are included as well.
749 This works recursively: if the parent has itself a parent, then the
750 grandparent's bindings are also included and so on.
751 usage: (map-keymap FUNCTION KEYMAP) */)
752 (function
, keymap
, sort_first
)
753 Lisp_Object function
, keymap
, sort_first
;
755 if (INTEGERP (function
))
756 /* We have to stop integers early since map_keymap gives them special
758 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
759 if (! NILP (sort_first
))
760 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
762 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
766 /* Given OBJECT which was found in a slot in a keymap,
767 trace indirect definitions to get the actual definition of that slot.
768 An indirect definition is a list of the form
769 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
770 and INDEX is the object to look up in KEYMAP to yield the definition.
772 Also if OBJECT has a menu string as the first element,
773 remove that. Also remove a menu help string as second element.
775 If AUTOLOAD is nonzero, load autoloadable keymaps
776 that are referred to with indirection.
778 This can GC because menu_item_eval_property calls Feval. */
781 get_keyelt (object
, autoload
)
787 if (!(CONSP (object
)))
788 /* This is really the value. */
791 /* If the keymap contents looks like (keymap ...) or (lambda ...)
793 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
796 /* If the keymap contents looks like (menu-item name . DEFN)
797 or (menu-item name DEFN ...) then use DEFN.
798 This is a new format menu item. */
799 else if (EQ (XCAR (object
), Qmenu_item
))
801 if (CONSP (XCDR (object
)))
805 object
= XCDR (XCDR (object
));
808 object
= XCAR (object
);
810 /* If there's a `:filter FILTER', apply FILTER to the
811 menu-item's definition to get the real definition to
813 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
814 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
817 filter
= XCAR (XCDR (tem
));
818 filter
= list2 (filter
, list2 (Qquote
, object
));
819 object
= menu_item_eval_property (filter
);
824 /* Invalid keymap. */
828 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
829 Keymap alist elements like (CHAR MENUSTRING . DEFN)
830 will be used by HierarKey menus. */
831 else if (STRINGP (XCAR (object
)))
833 object
= XCDR (object
);
834 /* Also remove a menu help string, if any,
835 following the menu item name. */
836 if (CONSP (object
) && STRINGP (XCAR (object
)))
837 object
= XCDR (object
);
838 /* Also remove the sublist that caches key equivalences, if any. */
839 if (CONSP (object
) && CONSP (XCAR (object
)))
842 carcar
= XCAR (XCAR (object
));
843 if (NILP (carcar
) || VECTORP (carcar
))
844 object
= XCDR (object
);
848 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
854 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
856 return (!CONSP (map
) ? object
/* Invalid keymap */
857 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
863 store_in_keymap (keymap
, idx
, def
)
865 register Lisp_Object idx
;
866 register Lisp_Object def
;
868 /* Flush any reverse-map cache. */
869 where_is_cache
= Qnil
;
870 where_is_cache_keymaps
= Qt
;
872 /* If we are preparing to dump, and DEF is a menu element
873 with a menu item indicator, copy it to ensure it is not pure. */
874 if (CONSP (def
) && PURE_P (def
)
875 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
876 def
= Fcons (XCAR (def
), XCDR (def
));
878 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
879 error ("attempt to define a key in a non-keymap");
881 /* If idx is a list (some sort of mouse click, perhaps?),
882 the index we want to use is the car of the list, which
883 ought to be a symbol. */
884 idx
= EVENT_HEAD (idx
);
886 /* If idx is a symbol, it might have modifiers, which need to
887 be put in the canonical order. */
889 idx
= reorder_modifiers (idx
);
890 else if (INTEGERP (idx
))
891 /* Clobber the high bits that can be present on a machine
892 with more than 24 bits of integer. */
893 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
895 /* Scan the keymap for a binding of idx. */
899 /* The cons after which we should insert new bindings. If the
900 keymap has a table element, we record its position here, so new
901 bindings will go after it; this way, the table will stay
902 towards the front of the alist and character lookups in dense
903 keymaps will remain fast. Otherwise, this just points at the
904 front of the keymap. */
905 Lisp_Object insertion_point
;
907 insertion_point
= keymap
;
908 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
915 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
918 ASET (elt
, XFASTINT (idx
), def
);
921 insertion_point
= tail
;
923 else if (CHAR_TABLE_P (elt
))
925 /* Character codes with modifiers
926 are not included in a char-table.
927 All character codes without modifiers are included. */
928 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
931 /* `nil' has a special meaning for char-tables, so
932 we use something else to record an explicitly
934 NILP (def
) ? Qt
: def
);
937 insertion_point
= tail
;
939 else if (CONSP (elt
))
941 if (EQ (idx
, XCAR (elt
)))
948 else if (EQ (elt
, Qkeymap
))
949 /* If we find a 'keymap' symbol in the spine of KEYMAP,
950 then we must have found the start of a second keymap
951 being used as the tail of KEYMAP, and a binding for IDX
952 should be inserted before it. */
959 /* We have scanned the entire keymap, and not found a binding for
960 IDX. Let's add one. */
961 CHECK_IMPURE (insertion_point
);
962 XSETCDR (insertion_point
,
963 Fcons (Fcons (idx
, def
), XCDR (insertion_point
)));
969 EXFUN (Fcopy_keymap
, 1);
972 copy_keymap_item (elt
)
975 Lisp_Object res
, tem
;
982 /* Is this a new format menu item. */
983 if (EQ (XCAR (tem
), Qmenu_item
))
985 /* Copy cell with menu-item marker. */
986 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
990 /* Copy cell with menu-item name. */
991 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
997 /* Copy cell with binding and if the binding is a keymap,
999 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1002 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1003 XSETCAR (elt
, Fcopy_keymap (tem
));
1005 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1006 /* Delete cache for key equivalences. */
1007 XSETCDR (elt
, XCDR (tem
));
1012 /* It may be an old fomat menu item.
1013 Skip the optional menu string. */
1014 if (STRINGP (XCAR (tem
)))
1016 /* Copy the cell, since copy-alist didn't go this deep. */
1017 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1019 /* Also skip the optional menu help string. */
1020 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1022 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1026 /* There may also be a list that caches key equivalences.
1027 Just delete it for the new keymap. */
1029 && CONSP (XCAR (tem
))
1030 && (NILP (XCAR (XCAR (tem
)))
1031 || VECTORP (XCAR (XCAR (tem
)))))
1033 XSETCDR (elt
, XCDR (tem
));
1036 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1037 XSETCDR (elt
, Fcopy_keymap (tem
));
1039 else if (EQ (XCAR (tem
), Qkeymap
))
1040 res
= Fcopy_keymap (elt
);
1046 copy_keymap_1 (chartable
, idx
, elt
)
1047 Lisp_Object chartable
, idx
, elt
;
1049 Faset (chartable
, idx
, copy_keymap_item (elt
));
1052 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1053 doc
: /* Return a copy of the keymap KEYMAP.
1054 The copy starts out with the same definitions of KEYMAP,
1055 but changing either the copy or KEYMAP does not affect the other.
1056 Any key definitions that are subkeymaps are recursively copied.
1057 However, a key definition which is a symbol whose definition is a keymap
1062 register Lisp_Object copy
, tail
;
1063 keymap
= get_keymap (keymap
, 1, 0);
1064 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1065 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1067 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1069 Lisp_Object elt
= XCAR (keymap
);
1070 if (CHAR_TABLE_P (elt
))
1072 Lisp_Object indices
[3];
1073 elt
= Fcopy_sequence (elt
);
1074 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, elt
, 0, indices
);
1076 else if (VECTORP (elt
))
1079 elt
= Fcopy_sequence (elt
);
1080 for (i
= 0; i
< ASIZE (elt
); i
++)
1081 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1083 else if (CONSP (elt
))
1084 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1085 XSETCDR (tail
, Fcons (elt
, Qnil
));
1087 keymap
= XCDR (keymap
);
1089 XSETCDR (tail
, keymap
);
1093 /* Simple Keymap mutators and accessors. */
1095 /* GC is possible in this function if it autoloads a keymap. */
1097 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1098 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1101 KEY is a string or a vector of symbols and characters meaning a
1102 sequence of keystrokes and events. Non-ASCII characters with codes
1103 above 127 (such as ISO Latin-1) can be included if you use a vector.
1104 Using [t] for KEY creates a default definition, which applies to any
1105 event type that has no other definition in this keymap.
1107 DEF is anything that can be a key's definition:
1108 nil (means key is undefined in this keymap),
1109 a command (a Lisp function suitable for interactive calling),
1110 a string (treated as a keyboard macro),
1111 a keymap (to define a prefix key),
1112 a symbol (when the key is looked up, the symbol will stand for its
1113 function definition, which should at that time be one of the above,
1114 or another symbol whose function definition is used, etc.),
1115 a cons (STRING . DEFN), meaning that DEFN is the definition
1116 (DEFN should be a valid definition in its own right),
1117 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1119 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1120 binding is altered. If there is no binding for KEY, the new pair
1121 binding KEY to DEF is added at the front of KEYMAP. */)
1128 register Lisp_Object c
;
1129 register Lisp_Object cmd
;
1133 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1135 GCPRO3 (keymap
, key
, def
);
1136 keymap
= get_keymap (keymap
, 1, 1);
1138 if (!VECTORP (key
) && !STRINGP (key
))
1139 key
= wrong_type_argument (Qarrayp
, key
);
1141 length
= XFASTINT (Flength (key
));
1143 RETURN_UNGCPRO (Qnil
);
1145 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1146 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1148 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1153 c
= Faref (key
, make_number (idx
));
1155 if (CONSP (c
) && lucid_event_type_list_p (c
))
1156 c
= Fevent_convert_list (c
);
1159 silly_event_symbol_error (c
);
1162 && (XINT (c
) & meta_bit
)
1165 c
= meta_prefix_char
;
1171 XSETINT (c
, XINT (c
) & ~meta_bit
);
1177 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1178 error ("Key sequence contains invalid event");
1181 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1183 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1185 /* If this key is undefined, make it a prefix. */
1187 cmd
= define_as_prefix (keymap
, c
);
1189 keymap
= get_keymap (cmd
, 0, 1);
1190 if (!CONSP (keymap
))
1191 /* We must use Fkey_description rather than just passing key to
1192 error; key might be a vector, not a string. */
1193 error ("Key sequence %s uses invalid prefix characters",
1194 SDATA (Fkey_description (key
, Qnil
)));
1198 /* This function may GC (it calls Fkey_binding). */
1200 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1201 doc
: /* Return the remapping for command COMMAND in current keymaps.
1202 Returns nil if COMMAND is not remapped (or not a symbol). */)
1204 Lisp_Object command
;
1206 if (!SYMBOLP (command
))
1209 ASET (command_remapping_vector
, 1, command
);
1210 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1213 /* Value is number if KEY is too long; nil if valid but has no definition. */
1214 /* GC is possible in this function if it autoloads a keymap. */
1216 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1217 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1218 nil means undefined. See doc of `define-key' for kinds of definitions.
1220 A number as value means KEY is "too long";
1221 that is, characters or symbols in it except for the last one
1222 fail to be a valid sequence of prefix characters in KEYMAP.
1223 The number is how many characters at the front of KEY
1224 it takes to reach a non-prefix key.
1226 Normally, `lookup-key' ignores bindings for t, which act as default
1227 bindings, used when nothing else in the keymap applies; this makes it
1228 usable as a general function for probing keymaps. However, if the
1229 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1230 recognize the default bindings, just as `read-key-sequence' does. */)
1231 (keymap
, key
, accept_default
)
1234 Lisp_Object accept_default
;
1237 register Lisp_Object cmd
;
1238 register Lisp_Object c
;
1240 int t_ok
= !NILP (accept_default
);
1241 struct gcpro gcpro1
, gcpro2
;
1243 GCPRO2 (keymap
, key
);
1244 keymap
= get_keymap (keymap
, 1, 1);
1246 if (!VECTORP (key
) && !STRINGP (key
))
1247 key
= wrong_type_argument (Qarrayp
, key
);
1249 length
= XFASTINT (Flength (key
));
1251 RETURN_UNGCPRO (keymap
);
1256 c
= Faref (key
, make_number (idx
++));
1258 if (CONSP (c
) && lucid_event_type_list_p (c
))
1259 c
= Fevent_convert_list (c
);
1261 /* Turn the 8th bit of string chars into a meta modifier. */
1262 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1263 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1265 /* Allow string since binding for `menu-bar-select-buffer'
1266 includes the buffer name in the key sequence. */
1267 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1268 error ("Key sequence contains invalid event");
1270 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1272 RETURN_UNGCPRO (cmd
);
1274 keymap
= get_keymap (cmd
, 0, 1);
1275 if (!CONSP (keymap
))
1276 RETURN_UNGCPRO (make_number (idx
));
1282 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1283 Assume that currently it does not define C at all.
1284 Return the keymap. */
1287 define_as_prefix (keymap
, c
)
1288 Lisp_Object keymap
, c
;
1292 cmd
= Fmake_sparse_keymap (Qnil
);
1293 /* If this key is defined as a prefix in an inherited keymap,
1294 make it a prefix in this map, and make its definition
1295 inherit the other prefix definition. */
1296 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1297 store_in_keymap (keymap
, c
, cmd
);
1302 /* Append a key to the end of a key sequence. We always make a vector. */
1305 append_key (key_sequence
, key
)
1306 Lisp_Object key_sequence
, key
;
1308 Lisp_Object args
[2];
1310 args
[0] = key_sequence
;
1312 args
[1] = Fcons (key
, Qnil
);
1313 return Fvconcat (2, args
);
1316 /* Given a event type C which is a symbol,
1317 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1320 silly_event_symbol_error (c
)
1323 Lisp_Object parsed
, base
, name
, assoc
;
1326 parsed
= parse_modifiers (c
);
1327 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1328 base
= XCAR (parsed
);
1329 name
= Fsymbol_name (base
);
1330 /* This alist includes elements such as ("RET" . "\\r"). */
1331 assoc
= Fassoc (name
, exclude_keys
);
1335 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1337 Lisp_Object keystring
;
1338 if (modifiers
& alt_modifier
)
1339 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1340 if (modifiers
& ctrl_modifier
)
1341 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1342 if (modifiers
& hyper_modifier
)
1343 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1344 if (modifiers
& meta_modifier
)
1345 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1346 if (modifiers
& shift_modifier
)
1347 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1348 if (modifiers
& super_modifier
)
1349 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1352 c
= reorder_modifiers (c
);
1353 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1355 error ((modifiers
& ~meta_modifier
1356 ? "To bind the key %s, use [?%s], not [%s]"
1357 : "To bind the key %s, use \"%s\", not [%s]"),
1358 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1359 SDATA (SYMBOL_NAME (c
)));
1363 /* Global, local, and minor mode keymap stuff. */
1365 /* We can't put these variables inside current_minor_maps, since under
1366 some systems, static gets macro-defined to be the empty string.
1368 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1369 static int cmm_size
= 0;
1371 /* Error handler used in current_minor_maps. */
1373 current_minor_maps_error ()
1378 /* Store a pointer to an array of the keymaps of the currently active
1379 minor modes in *buf, and return the number of maps it contains.
1381 This function always returns a pointer to the same buffer, and may
1382 free or reallocate it, so if you want to keep it for a long time or
1383 hand it out to lisp code, copy it. This procedure will be called
1384 for every key sequence read, so the nice lispy approach (return a
1385 new assoclist, list, what have you) for each invocation would
1386 result in a lot of consing over time.
1388 If we used xrealloc/xmalloc and ran out of memory, they would throw
1389 back to the command loop, which would try to read a key sequence,
1390 which would call this function again, resulting in an infinite
1391 loop. Instead, we'll use realloc/malloc and silently truncate the
1392 list, let the key sequence be read, and hope some other piece of
1393 code signals the error. */
1395 current_minor_maps (modeptr
, mapptr
)
1396 Lisp_Object
**modeptr
, **mapptr
;
1399 int list_number
= 0;
1400 Lisp_Object alist
, assoc
, var
, val
;
1401 Lisp_Object emulation_alists
;
1402 Lisp_Object lists
[2];
1404 emulation_alists
= Vemulation_mode_map_alists
;
1405 lists
[0] = Vminor_mode_overriding_map_alist
;
1406 lists
[1] = Vminor_mode_map_alist
;
1408 for (list_number
= 0; list_number
< 2; list_number
++)
1410 if (CONSP (emulation_alists
))
1412 alist
= XCAR (emulation_alists
);
1413 emulation_alists
= XCDR (emulation_alists
);
1414 if (SYMBOLP (alist
))
1415 alist
= find_symbol_value (alist
);
1419 alist
= lists
[list_number
];
1421 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1422 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1423 && (var
= XCAR (assoc
), SYMBOLP (var
))
1424 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1429 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1430 and also an entry in Vminor_mode_map_alist,
1431 ignore the latter. */
1432 if (list_number
== 1)
1434 val
= assq_no_quit (var
, lists
[0]);
1441 int newsize
, allocsize
;
1442 Lisp_Object
*newmodes
, *newmaps
;
1444 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1445 allocsize
= newsize
* sizeof *newmodes
;
1447 /* Use malloc here. See the comment above this function.
1448 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1450 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1455 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1458 cmm_modes
= newmodes
;
1461 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1466 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1473 if (newmodes
== NULL
|| newmaps
== NULL
)
1478 /* Get the keymap definition--or nil if it is not defined. */
1479 temp
= internal_condition_case_1 (Findirect_function
,
1481 Qerror
, current_minor_maps_error
);
1485 cmm_maps
[i
] = temp
;
1491 if (modeptr
) *modeptr
= cmm_modes
;
1492 if (mapptr
) *mapptr
= cmm_maps
;
1496 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1498 doc
: /* Return a list of the currently active keymaps.
1499 OLP if non-nil indicates that we should obey `overriding-local-map' and
1500 `overriding-terminal-local-map'. */)
1504 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1508 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1509 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1510 /* The doc said that overriding-terminal-local-map should
1511 override overriding-local-map. The code used them both,
1512 but it seems clearer to use just one. rms, jan 2005. */
1513 else if (!NILP (Voverriding_local_map
))
1514 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1516 if (NILP (XCDR (keymaps
)))
1522 /* This usually returns the buffer's local map,
1523 but that can be overridden by a `local-map' property. */
1524 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1526 keymaps
= Fcons (local
, keymaps
);
1528 /* Now put all the minor mode keymaps on the list. */
1529 nmaps
= current_minor_maps (0, &maps
);
1531 for (i
= --nmaps
; i
>= 0; i
--)
1532 if (!NILP (maps
[i
]))
1533 keymaps
= Fcons (maps
[i
], keymaps
);
1535 /* This returns nil unless there is a `keymap' property. */
1536 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1538 keymaps
= Fcons (local
, keymaps
);
1544 /* GC is possible in this function if it autoloads a keymap. */
1546 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1547 doc
: /* Return the binding for command KEY in current keymaps.
1548 KEY is a string or vector, a sequence of keystrokes.
1549 The binding is probably a symbol with a function definition.
1551 Normally, `key-binding' ignores bindings for t, which act as default
1552 bindings, used when nothing else in the keymap applies; this makes it
1553 usable as a general function for probing keymaps. However, if the
1554 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1555 recognize the default bindings, just as `read-key-sequence' does.
1557 Like the normal command loop, `key-binding' will remap the command
1558 resulting from looking up KEY by looking up the command in the
1559 current keymaps. However, if the optional third argument NO-REMAP
1560 is non-nil, `key-binding' returns the unmapped command. */)
1561 (key
, accept_default
, no_remap
)
1562 Lisp_Object key
, accept_default
, no_remap
;
1564 Lisp_Object
*maps
, value
;
1566 struct gcpro gcpro1
;
1570 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1572 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1573 key
, accept_default
);
1574 if (! NILP (value
) && !INTEGERP (value
))
1577 else if (!NILP (Voverriding_local_map
))
1579 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1580 if (! NILP (value
) && !INTEGERP (value
))
1587 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1590 value
= Flookup_key (local
, key
, accept_default
);
1591 if (! NILP (value
) && !INTEGERP (value
))
1595 nmaps
= current_minor_maps (0, &maps
);
1596 /* Note that all these maps are GCPRO'd
1597 in the places where we found them. */
1599 for (i
= 0; i
< nmaps
; i
++)
1600 if (! NILP (maps
[i
]))
1602 value
= Flookup_key (maps
[i
], key
, accept_default
);
1603 if (! NILP (value
) && !INTEGERP (value
))
1607 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1610 value
= Flookup_key (local
, key
, accept_default
);
1611 if (! NILP (value
) && !INTEGERP (value
))
1616 value
= Flookup_key (current_global_map
, key
, accept_default
);
1620 if (NILP (value
) || INTEGERP (value
))
1623 /* If the result of the ordinary keymap lookup is an interactive
1624 command, look for a key binding (ie. remapping) for that command. */
1626 if (NILP (no_remap
) && SYMBOLP (value
))
1629 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1636 /* GC is possible in this function if it autoloads a keymap. */
1638 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1639 doc
: /* Return the binding for command KEYS in current local keymap only.
1640 KEYS is a string or vector, a sequence of keystrokes.
1641 The binding is probably a symbol with a function definition.
1643 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1644 bindings; see the description of `lookup-key' for more details about this. */)
1645 (keys
, accept_default
)
1646 Lisp_Object keys
, accept_default
;
1648 register Lisp_Object map
;
1649 map
= current_buffer
->keymap
;
1652 return Flookup_key (map
, keys
, accept_default
);
1655 /* GC is possible in this function if it autoloads a keymap. */
1657 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1658 doc
: /* Return the binding for command KEYS in current global keymap only.
1659 KEYS is a string or vector, a sequence of keystrokes.
1660 The binding is probably a symbol with a function definition.
1661 This function's return values are the same as those of `lookup-key'
1664 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1665 bindings; see the description of `lookup-key' for more details about this. */)
1666 (keys
, accept_default
)
1667 Lisp_Object keys
, accept_default
;
1669 return Flookup_key (current_global_map
, keys
, accept_default
);
1672 /* GC is possible in this function if it autoloads a keymap. */
1674 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1675 doc
: /* Find the visible minor mode bindings of KEY.
1676 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1677 the symbol which names the minor mode binding KEY, and BINDING is
1678 KEY's definition in that mode. In particular, if KEY has no
1679 minor-mode bindings, return nil. If the first binding is a
1680 non-prefix, all subsequent bindings will be omitted, since they would
1681 be ignored. Similarly, the list doesn't include non-prefix bindings
1682 that come after prefix bindings.
1684 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1685 bindings; see the description of `lookup-key' for more details about this. */)
1686 (key
, accept_default
)
1687 Lisp_Object key
, accept_default
;
1689 Lisp_Object
*modes
, *maps
;
1691 Lisp_Object binding
;
1693 struct gcpro gcpro1
, gcpro2
;
1695 nmaps
= current_minor_maps (&modes
, &maps
);
1696 /* Note that all these maps are GCPRO'd
1697 in the places where we found them. */
1700 GCPRO2 (key
, binding
);
1702 for (i
= j
= 0; i
< nmaps
; i
++)
1704 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1705 && !INTEGERP (binding
))
1707 if (KEYMAPP (binding
))
1708 maps
[j
++] = Fcons (modes
[i
], binding
);
1710 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1714 return Flist (j
, maps
);
1717 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1718 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1719 A new sparse keymap is stored as COMMAND's function definition and its value.
1720 If a second optional argument MAPVAR is given, the map is stored as
1721 its value instead of as COMMAND's value; but COMMAND is still defined
1723 The third optional argument NAME, if given, supplies a menu name
1724 string for the map. This is required to use the keymap as a menu.
1725 This function returns COMMAND. */)
1726 (command
, mapvar
, name
)
1727 Lisp_Object command
, mapvar
, name
;
1730 map
= Fmake_sparse_keymap (name
);
1731 Ffset (command
, map
);
1735 Fset (command
, map
);
1739 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1740 doc
: /* Select KEYMAP as the global keymap. */)
1744 keymap
= get_keymap (keymap
, 1, 1);
1745 current_global_map
= keymap
;
1750 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1751 doc
: /* Select KEYMAP as the local keymap.
1752 If KEYMAP is nil, that means no local keymap. */)
1757 keymap
= get_keymap (keymap
, 1, 1);
1759 current_buffer
->keymap
= keymap
;
1764 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1765 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1768 return current_buffer
->keymap
;
1771 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1772 doc
: /* Return the current global keymap. */)
1775 return current_global_map
;
1778 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1779 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1783 int nmaps
= current_minor_maps (0, &maps
);
1785 return Flist (nmaps
, maps
);
1788 /* Help functions for describing and documenting keymaps. */
1792 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1793 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1794 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1798 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1802 /* Look for and break cycles. */
1803 while (!NILP (tem
= Frassq (cmd
, maps
)))
1805 Lisp_Object prefix
= XCAR (tem
);
1806 int lim
= XINT (Flength (XCAR (tem
)));
1807 if (lim
<= XINT (Flength (thisseq
)))
1808 { /* This keymap was already seen with a smaller prefix. */
1810 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1811 Faref (thisseq
, make_number (i
))))
1814 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1817 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1818 but maybe `cmd' occurs again further down in `maps', so keep
1820 maps
= XCDR (Fmemq (tem
, maps
));
1823 /* If the last key in thisseq is meta-prefix-char,
1824 turn it into a meta-ized keystroke. We know
1825 that the event we're about to append is an
1826 ascii keystroke since we're processing a
1830 int meta_bit
= meta_modifier
;
1831 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1832 tem
= Fcopy_sequence (thisseq
);
1834 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1836 /* This new sequence is the same length as
1837 thisseq, so stick it in the list right
1840 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1844 tem
= append_key (thisseq
, key
);
1845 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1850 accessible_keymaps_char_table (args
, index
, cmd
)
1851 Lisp_Object args
, index
, cmd
;
1853 accessible_keymaps_1 (index
, cmd
,
1857 XINT (XCDR (XCAR (args
))));
1860 /* This function cannot GC. */
1862 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1864 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1865 Returns a list of elements of the form (KEYS . MAP), where the sequence
1866 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1867 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1868 An optional argument PREFIX, if non-nil, should be a key sequence;
1869 then the value includes only maps for prefixes that start with PREFIX. */)
1871 Lisp_Object keymap
, prefix
;
1873 Lisp_Object maps
, tail
;
1876 /* no need for gcpro because we don't autoload any keymaps. */
1879 prefixlen
= XINT (Flength (prefix
));
1883 /* If a prefix was specified, start with the keymap (if any) for
1884 that prefix, so we don't waste time considering other prefixes. */
1886 tem
= Flookup_key (keymap
, prefix
, Qt
);
1887 /* Flookup_key may give us nil, or a number,
1888 if the prefix is not defined in this particular map.
1889 It might even give us a list that isn't a keymap. */
1890 tem
= get_keymap (tem
, 0, 0);
1893 /* Convert PREFIX to a vector now, so that later on
1894 we don't have to deal with the possibility of a string. */
1895 if (STRINGP (prefix
))
1900 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1901 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1905 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1906 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1907 c
^= 0200 | meta_modifier
;
1908 ASET (copy
, i_before
, make_number (c
));
1912 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1918 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1919 get_keymap (keymap
, 1, 0)),
1922 /* For each map in the list maps,
1923 look at any other maps it points to,
1924 and stick them at the end if they are not already in the list.
1926 This is a breadth-first traversal, where tail is the queue of
1927 nodes, and maps accumulates a list of all nodes visited. */
1929 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1931 register Lisp_Object thisseq
, thismap
;
1933 /* Does the current sequence end in the meta-prefix-char? */
1936 thisseq
= Fcar (Fcar (tail
));
1937 thismap
= Fcdr (Fcar (tail
));
1938 last
= make_number (XINT (Flength (thisseq
)) - 1);
1939 is_metized
= (XINT (last
) >= 0
1940 /* Don't metize the last char of PREFIX. */
1941 && XINT (last
) >= prefixlen
1942 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1944 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1948 elt
= XCAR (thismap
);
1952 if (CHAR_TABLE_P (elt
))
1954 Lisp_Object indices
[3];
1956 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
1957 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1958 Fcons (tail
, thisseq
)),
1961 else if (VECTORP (elt
))
1965 /* Vector keymap. Scan all the elements. */
1966 for (i
= 0; i
< ASIZE (elt
); i
++)
1967 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1968 maps
, tail
, thisseq
, is_metized
);
1971 else if (CONSP (elt
))
1972 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1973 maps
, tail
, thisseq
,
1974 is_metized
&& INTEGERP (XCAR (elt
)));
1982 Lisp_Object Qsingle_key_description
, Qkey_description
;
1984 /* This function cannot GC. */
1986 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
1987 doc
: /* Return a pretty description of key-sequence KEYS.
1988 Optional arg PREFIX is the sequence of keys leading up to KEYS.
1989 Control characters turn into "C-foo" sequences, meta into "M-foo",
1990 spaces are put between sequence elements, etc. */)
1992 Lisp_Object keys
, prefix
;
1997 int size
= XINT (Flength (keys
));
1999 Lisp_Object sep
= build_string (" ");
2004 size
+= XINT (Flength (prefix
));
2006 /* This has one extra element at the end that we don't pass to Fconcat. */
2007 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2009 /* In effect, this computes
2010 (mapconcat 'single-key-description keys " ")
2011 but we shouldn't use mapconcat because it can do GC. */
2015 list
= prefix
, prefix
= Qnil
;
2016 else if (!NILP (keys
))
2017 list
= keys
, keys
= Qnil
;
2022 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2026 return empty_string
;
2027 return Fconcat (len
- 1, args
);
2031 size
= SCHARS (list
);
2032 else if (VECTORP (list
))
2033 size
= XVECTOR (list
)->size
;
2034 else if (CONSP (list
))
2035 size
= XINT (Flength (list
));
2037 wrong_type_argument (Qarrayp
, list
);
2046 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2047 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2048 c
^= 0200 | meta_modifier
;
2049 XSETFASTINT (key
, c
);
2051 else if (VECTORP (list
))
2053 key
= AREF (list
, i
++);
2065 || EQ (key
, meta_prefix_char
)
2066 || (XINT (key
) & meta_modifier
))
2068 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2070 if (EQ (key
, meta_prefix_char
))
2074 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2077 else if (EQ (key
, meta_prefix_char
))
2082 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2090 push_key_description (c
, p
, force_multibyte
)
2091 register unsigned int c
;
2093 int force_multibyte
;
2097 /* Clear all the meaningless bits above the meta bit. */
2098 c
&= meta_modifier
| ~ - meta_modifier
;
2099 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2100 | meta_modifier
| shift_modifier
| super_modifier
);
2102 if (c
& alt_modifier
)
2108 if ((c
& ctrl_modifier
) != 0
2109 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2113 c
&= ~ctrl_modifier
;
2115 if (c
& hyper_modifier
)
2119 c
-= hyper_modifier
;
2121 if (c
& meta_modifier
)
2127 if (c
& shift_modifier
)
2131 c
-= shift_modifier
;
2133 if (c
& super_modifier
)
2137 c
-= super_modifier
;
2153 else if (c
== Ctl ('M'))
2161 /* `C-' already added above. */
2162 if (c
> 0 && c
<= Ctl ('Z'))
2181 || (NILP (current_buffer
->enable_multibyte_characters
)
2182 && SINGLE_BYTE_CHAR_P (c
)
2183 && !force_multibyte
))
2189 int valid_p
= SINGLE_BYTE_CHAR_P (c
) || char_valid_p (c
, 0);
2191 if (force_multibyte
&& valid_p
)
2193 if (SINGLE_BYTE_CHAR_P (c
))
2194 c
= unibyte_char_to_multibyte (c
);
2195 p
+= CHAR_STRING (c
, p
);
2197 else if (NILP (current_buffer
->enable_multibyte_characters
)
2202 /* The biggest character code uses 19 bits. */
2203 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2205 if (c
>= (1 << bit_offset
))
2206 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2210 p
+= CHAR_STRING (c
, p
);
2216 /* This function cannot GC. */
2218 DEFUN ("single-key-description", Fsingle_key_description
,
2219 Ssingle_key_description
, 1, 2, 0,
2220 doc
: /* Return a pretty description of command character KEY.
2221 Control characters turn into C-whatever, etc.
2222 Optional argument NO-ANGLES non-nil means don't put angle brackets
2223 around function keys and event symbols. */)
2225 Lisp_Object key
, no_angles
;
2227 if (CONSP (key
) && lucid_event_type_list_p (key
))
2228 key
= Fevent_convert_list (key
);
2230 key
= EVENT_HEAD (key
);
2232 if (INTEGERP (key
)) /* Normal character */
2234 unsigned int charset
, c1
, c2
;
2235 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2237 if (SINGLE_BYTE_CHAR_P (without_bits
))
2240 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2243 && CHARSET_DEFINED_P (charset
)
2244 && ((c1
>= 0 && c1
< 32)
2245 || (c2
>= 0 && c2
< 32)))
2247 /* Handle a generic character. */
2249 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
2250 CHECK_STRING (name
);
2251 return concat2 (build_string ("Character set "), name
);
2255 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2259 end
= push_key_description (XUINT (key
), tem
, 1);
2261 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2262 if (nchars
== nbytes
)
2265 string
= build_string (tem
);
2268 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2272 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2274 if (NILP (no_angles
))
2277 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2278 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2279 return build_string (buffer
);
2282 return Fsymbol_name (key
);
2284 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2285 return Fcopy_sequence (key
);
2287 error ("KEY must be an integer, cons, symbol, or string");
2292 push_text_char_description (c
, p
)
2293 register unsigned int c
;
2305 *p
++ = c
+ 64; /* 'A' - 1 */
2317 /* This function cannot GC. */
2319 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2320 doc
: /* Return a pretty description of file-character CHARACTER.
2321 Control characters turn into "^char", etc. This differs from
2322 `single-key-description' which turns them into "C-char".
2323 Also, this function recognizes the 2**7 bit as the Meta character,
2324 whereas `single-key-description' uses the 2**27 bit for Meta.
2325 See Info node `(elisp)Describing Characters' for examples. */)
2327 Lisp_Object character
;
2329 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2330 unsigned char str
[6];
2333 CHECK_NUMBER (character
);
2335 c
= XINT (character
);
2336 if (!SINGLE_BYTE_CHAR_P (c
))
2338 int len
= CHAR_STRING (c
, str
);
2340 return make_multibyte_string (str
, 1, len
);
2343 *push_text_char_description (c
& 0377, str
) = 0;
2345 return build_string (str
);
2348 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2351 ascii_sequence_p (seq
)
2355 int len
= XINT (Flength (seq
));
2357 for (i
= 0; i
< len
; i
++)
2359 Lisp_Object ii
, elt
;
2361 XSETFASTINT (ii
, i
);
2362 elt
= Faref (seq
, ii
);
2365 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2373 /* where-is - finding a command in a set of keymaps. */
2375 static Lisp_Object
where_is_internal ();
2376 static Lisp_Object
where_is_internal_1 ();
2377 static void where_is_internal_2 ();
2379 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2380 Returns the first non-nil binding found in any of those maps. */
2383 shadow_lookup (shadow
, key
, flag
)
2384 Lisp_Object shadow
, key
, flag
;
2386 Lisp_Object tail
, value
;
2388 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2390 value
= Flookup_key (XCAR (tail
), key
, flag
);
2391 if (NATNUMP (value
))
2393 value
= Flookup_key (XCAR (tail
),
2394 Fsubstring (key
, make_number (0), value
), flag
);
2398 else if (!NILP (value
))
2404 static Lisp_Object Vmouse_events
;
2406 /* This function can GC if Flookup_key autoloads any keymaps. */
2409 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2410 Lisp_Object definition
, keymaps
;
2411 Lisp_Object firstonly
, noindirect
, no_remap
;
2413 Lisp_Object maps
= Qnil
;
2414 Lisp_Object found
, sequences
;
2415 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2416 /* 1 means ignore all menu bindings entirely. */
2417 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2419 /* If this command is remapped, then it has no key bindings
2421 if (NILP (no_remap
) && SYMBOLP (definition
))
2424 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2429 while (CONSP (found
))
2433 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2434 found
= XCDR (found
);
2437 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2441 for (; !NILP (maps
); maps
= Fcdr (maps
))
2443 /* Key sequence to reach map, and the map that it reaches */
2444 register Lisp_Object
this, map
, tem
;
2446 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2447 [M-CHAR] sequences, check if last character of the sequence
2448 is the meta-prefix char. */
2452 this = Fcar (Fcar (maps
));
2453 map
= Fcdr (Fcar (maps
));
2454 last
= make_number (XINT (Flength (this)) - 1);
2455 last_is_meta
= (XINT (last
) >= 0
2456 && EQ (Faref (this, last
), meta_prefix_char
));
2458 /* if (nomenus && !ascii_sequence_p (this)) */
2459 if (nomenus
&& XINT (last
) >= 0
2460 && SYMBOLP (tem
= Faref (this, make_number (0)))
2461 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2462 /* If no menu entries should be returned, skip over the
2463 keymaps bound to `menu-bar' and `tool-bar' and other
2464 non-ascii prefixes like `C-down-mouse-2'. */
2471 /* Because the code we want to run on each binding is rather
2472 large, we don't want to have two separate loop bodies for
2473 sparse keymap bindings and tables; we want to iterate one
2474 loop body over both keymap and vector bindings.
2476 For this reason, if Fcar (map) is a vector, we don't
2477 advance map to the next element until i indicates that we
2478 have finished off the vector. */
2479 Lisp_Object elt
, key
, binding
;
2487 /* Set key and binding to the current key and binding, and
2488 advance map and i to the next binding. */
2491 Lisp_Object sequence
;
2493 /* In a vector, look at each element. */
2494 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2496 binding
= AREF (elt
, i
);
2497 XSETFASTINT (key
, i
);
2498 sequence
= where_is_internal_1 (binding
, key
, definition
,
2500 last
, nomenus
, last_is_meta
);
2501 if (!NILP (sequence
))
2502 sequences
= Fcons (sequence
, sequences
);
2505 else if (CHAR_TABLE_P (elt
))
2507 Lisp_Object indices
[3];
2510 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2511 Qnil
), /* Result accumulator. */
2512 Fcons (Fcons (this, last
),
2513 Fcons (make_number (nomenus
),
2514 make_number (last_is_meta
))));
2515 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2517 sequences
= XCDR (XCAR (args
));
2519 else if (CONSP (elt
))
2521 Lisp_Object sequence
;
2524 binding
= XCDR (elt
);
2526 sequence
= where_is_internal_1 (binding
, key
, definition
,
2528 last
, nomenus
, last_is_meta
);
2529 if (!NILP (sequence
))
2530 sequences
= Fcons (sequence
, sequences
);
2534 while (!NILP (sequences
))
2536 Lisp_Object sequence
, remapped
, function
;
2538 sequence
= XCAR (sequences
);
2539 sequences
= XCDR (sequences
);
2541 /* If the current sequence is a command remapping with
2542 format [remap COMMAND], find the key sequences
2543 which run COMMAND, and use those sequences instead. */
2546 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2547 && EQ (AREF (sequence
, 0), Qremap
)
2548 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2550 Lisp_Object remapped1
;
2552 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2553 if (CONSP (remapped1
))
2555 /* Verify that this key binding actually maps to the
2556 remapped command (see below). */
2557 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2559 sequence
= XCAR (remapped1
);
2560 remapped
= XCDR (remapped1
);
2561 goto record_sequence
;
2565 /* Verify that this key binding is not shadowed by another
2566 binding for the same key, before we say it exists.
2568 Mechanism: look for local definition of this key and if
2569 it is defined and does not match what we found then
2572 Either nil or number as value from Flookup_key
2574 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2578 /* Don't annoy user with strings from a menu such as
2579 Select Paste. Change them all to "(any string)",
2580 so that there seems to be only one menu item
2582 if (! NILP (sequence
))
2585 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2587 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2588 build_string ("(any string)"));
2591 /* It is a true unshadowed match. Record it, unless it's already
2592 been seen (as could happen when inheriting keymaps). */
2593 if (NILP (Fmember (sequence
, found
)))
2594 found
= Fcons (sequence
, found
);
2596 /* If firstonly is Qnon_ascii, then we can return the first
2597 binding we find. If firstonly is not Qnon_ascii but not
2598 nil, then we should return the first ascii-only binding
2600 if (EQ (firstonly
, Qnon_ascii
))
2601 RETURN_UNGCPRO (sequence
);
2602 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2603 RETURN_UNGCPRO (sequence
);
2605 if (CONSP (remapped
))
2607 sequence
= XCAR (remapped
);
2608 remapped
= XCDR (remapped
);
2609 goto record_sequence
;
2617 found
= Fnreverse (found
);
2619 /* firstonly may have been t, but we may have gone all the way through
2620 the keymaps without finding an all-ASCII key sequence. So just
2621 return the best we could find. */
2622 if (!NILP (firstonly
))
2623 return Fcar (found
);
2628 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2629 doc
: /* Return list of keys that invoke DEFINITION.
2630 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2631 If KEYMAP is nil, search all the currently active keymaps.
2632 If KEYMAP is a list of keymaps, search only those keymaps.
2634 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2635 rather than a list of all possible key sequences.
2636 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2637 no matter what it is.
2638 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2639 \(or their meta variants) and entirely reject menu bindings.
2641 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2642 to other keymaps or slots. This makes it possible to search for an
2643 indirect definition itself.
2645 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2646 that invoke a command which is remapped to DEFINITION, but include the
2647 remapped command in the returned list. */)
2648 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2649 Lisp_Object definition
, keymap
;
2650 Lisp_Object firstonly
, noindirect
, no_remap
;
2652 Lisp_Object sequences
, keymaps
;
2653 /* 1 means ignore all menu bindings entirely. */
2654 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2657 /* Find the relevant keymaps. */
2658 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2660 else if (!NILP (keymap
))
2661 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2663 keymaps
= Fcurrent_active_maps (Qnil
);
2665 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2666 We don't really need to check `keymap'. */
2667 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2671 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2673 /* Check heuristic-consistency of the cache. */
2674 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2675 where_is_cache
= Qnil
;
2677 if (NILP (where_is_cache
))
2679 /* We need to create the cache. */
2680 Lisp_Object args
[2];
2681 where_is_cache
= Fmake_hash_table (0, args
);
2682 where_is_cache_keymaps
= Qt
;
2684 /* Fill in the cache. */
2685 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2686 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2689 where_is_cache_keymaps
= keymaps
;
2692 /* We want to process definitions from the last to the first.
2693 Instead of consing, copy definitions to a vector and step
2694 over that vector. */
2695 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2696 n
= XINT (Flength (sequences
));
2697 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2698 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2699 defns
[i
++] = XCAR (sequences
);
2701 /* Verify that the key bindings are not shadowed. Note that
2702 the following can GC. */
2703 GCPRO2 (definition
, keymaps
);
2706 for (i
= n
- 1; i
>= 0; --i
)
2707 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2709 if (ascii_sequence_p (defns
[i
]))
2715 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2720 /* Kill the cache so that where_is_internal_1 doesn't think
2721 we're filling it up. */
2722 where_is_cache
= Qnil
;
2723 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2729 /* This is the function that Fwhere_is_internal calls using map_char_table.
2731 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2733 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2734 Since map_char_table doesn't really use the return value from this function,
2735 we the result append to RESULT, the slot in ARGS.
2737 This function can GC because it calls where_is_internal_1 which can
2741 where_is_internal_2 (args
, key
, binding
)
2742 Lisp_Object args
, key
, binding
;
2744 Lisp_Object definition
, noindirect
, this, last
;
2745 Lisp_Object result
, sequence
;
2746 int nomenus
, last_is_meta
;
2747 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2749 GCPRO3 (args
, key
, binding
);
2750 result
= XCDR (XCAR (args
));
2751 definition
= XCAR (XCAR (XCAR (args
)));
2752 noindirect
= XCDR (XCAR (XCAR (args
)));
2753 this = XCAR (XCAR (XCDR (args
)));
2754 last
= XCDR (XCAR (XCDR (args
)));
2755 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2756 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2758 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2759 this, last
, nomenus
, last_is_meta
);
2761 if (!NILP (sequence
))
2762 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2768 /* This function can GC because get_keyelt can. */
2771 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2772 nomenus
, last_is_meta
)
2773 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2774 int nomenus
, last_is_meta
;
2776 Lisp_Object sequence
;
2778 /* Search through indirections unless that's not wanted. */
2779 if (NILP (noindirect
))
2780 binding
= get_keyelt (binding
, 0);
2782 /* End this iteration if this element does not match
2785 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2786 || EQ (binding
, definition
)
2787 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2788 /* Doesn't match. */
2791 /* We have found a match. Construct the key sequence where we found it. */
2792 if (INTEGERP (key
) && last_is_meta
)
2794 sequence
= Fcopy_sequence (this);
2795 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2798 sequence
= append_key (this, key
);
2800 if (!NILP (where_is_cache
))
2802 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2803 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2810 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2812 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2813 doc
: /* Insert the list of all defined keys and their definitions.
2814 The list is inserted in the current buffer, while the bindings are
2815 looked up in BUFFER.
2816 The optional argument PREFIX, if non-nil, should be a key sequence;
2817 then we display only bindings that start with that prefix.
2818 The optional argument MENUS, if non-nil, says to mention menu bindings.
2819 \(Ordinarily these are omitted from the output.) */)
2820 (buffer
, prefix
, menus
)
2821 Lisp_Object buffer
, prefix
, menus
;
2823 Lisp_Object outbuf
, shadow
;
2824 int nomenu
= NILP (menus
);
2825 register Lisp_Object start1
;
2826 struct gcpro gcpro1
;
2828 char *alternate_heading
2830 Keyboard translations:\n\n\
2831 You type Translation\n\
2832 -------- -----------\n";
2837 outbuf
= Fcurrent_buffer ();
2839 /* Report on alternates for keys. */
2840 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2843 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2844 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2846 for (c
= 0; c
< translate_len
; c
++)
2847 if (translate
[c
] != c
)
2849 char buf
[KEY_DESCRIPTION_SIZE
];
2852 if (alternate_heading
)
2854 insert_string (alternate_heading
);
2855 alternate_heading
= 0;
2858 bufend
= push_key_description (translate
[c
], buf
, 1);
2859 insert (buf
, bufend
- buf
);
2860 Findent_to (make_number (16), make_number (1));
2861 bufend
= push_key_description (c
, buf
, 1);
2862 insert (buf
, bufend
- buf
);
2866 /* Insert calls signal_after_change which may GC. */
2867 translate
= SDATA (Vkeyboard_translate_table
);
2873 if (!NILP (Vkey_translation_map
))
2874 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2875 "Key translations", nomenu
, 1, 0, 0);
2878 /* Print the (major mode) local map. */
2880 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2881 start1
= current_kboard
->Voverriding_terminal_local_map
;
2882 else if (!NILP (Voverriding_local_map
))
2883 start1
= Voverriding_local_map
;
2887 describe_map_tree (start1
, 1, shadow
, prefix
,
2888 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2889 shadow
= Fcons (start1
, shadow
);
2893 /* Print the minor mode and major mode keymaps. */
2895 Lisp_Object
*modes
, *maps
;
2897 /* Temporarily switch to `buffer', so that we can get that buffer's
2898 minor modes correctly. */
2899 Fset_buffer (buffer
);
2901 nmaps
= current_minor_maps (&modes
, &maps
);
2902 Fset_buffer (outbuf
);
2904 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2905 XBUFFER (buffer
), Qkeymap
);
2908 describe_map_tree (start1
, 1, shadow
, prefix
,
2909 "\f\n`keymap' Property Bindings", nomenu
,
2911 shadow
= Fcons (start1
, shadow
);
2914 /* Print the minor mode maps. */
2915 for (i
= 0; i
< nmaps
; i
++)
2917 /* The title for a minor mode keymap
2918 is constructed at run time.
2919 We let describe_map_tree do the actual insertion
2920 because it takes care of other features when doing so. */
2923 if (!SYMBOLP (modes
[i
]))
2926 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2930 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2931 SCHARS (SYMBOL_NAME (modes
[i
])));
2932 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2934 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2935 p
+= sizeof (" Minor Mode Bindings") - 1;
2938 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2939 title
, nomenu
, 0, 0, 0);
2940 shadow
= Fcons (maps
[i
], shadow
);
2943 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2944 XBUFFER (buffer
), Qlocal_map
);
2947 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2948 describe_map_tree (start1
, 1, shadow
, prefix
,
2949 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2951 describe_map_tree (start1
, 1, shadow
, prefix
,
2952 "\f\n`local-map' Property Bindings",
2955 shadow
= Fcons (start1
, shadow
);
2959 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2960 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2962 /* Print the function-key-map translations under this prefix. */
2963 if (!NILP (Vfunction_key_map
))
2964 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2965 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2971 /* Insert a description of the key bindings in STARTMAP,
2972 followed by those of all maps reachable through STARTMAP.
2973 If PARTIAL is nonzero, omit certain "uninteresting" commands
2974 (such as `undefined').
2975 If SHADOW is non-nil, it is a list of maps;
2976 don't mention keys which would be shadowed by any of them.
2977 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2978 TITLE, if not 0, is a string to insert at the beginning.
2979 TITLE should not end with a colon or a newline; we supply that.
2980 If NOMENU is not 0, then omit menu-bar commands.
2982 If TRANSL is nonzero, the definitions are actually key translations
2983 so print strings and vectors differently.
2985 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2988 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
2989 don't omit it; instead, mention it but say it is shadowed. */
2992 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2993 always_title
, mention_shadow
)
2994 Lisp_Object startmap
, shadow
, prefix
;
3002 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
3003 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3010 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3013 GCPRO3 (maps
, seen
, sub_shadows
);
3019 /* Delete from MAPS each element that is for the menu bar. */
3020 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3022 Lisp_Object elt
, prefix
, tem
;
3025 prefix
= Fcar (elt
);
3026 if (XVECTOR (prefix
)->size
>= 1)
3028 tem
= Faref (prefix
, make_number (0));
3029 if (EQ (tem
, Qmenu_bar
))
3030 maps
= Fdelq (elt
, maps
);
3035 if (!NILP (maps
) || always_title
)
3039 insert_string (title
);
3042 insert_string (" Starting With ");
3043 insert1 (Fkey_description (prefix
, Qnil
));
3045 insert_string (":\n");
3047 insert_string (key_heading
);
3051 for (; !NILP (maps
); maps
= Fcdr (maps
))
3053 register Lisp_Object elt
, prefix
, tail
;
3056 prefix
= Fcar (elt
);
3060 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3064 shmap
= XCAR (tail
);
3066 /* If the sequence by which we reach this keymap is zero-length,
3067 then the shadow map for this keymap is just SHADOW. */
3068 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3069 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3071 /* If the sequence by which we reach this keymap actually has
3072 some elements, then the sequence's definition in SHADOW is
3073 what we should use. */
3076 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3077 if (INTEGERP (shmap
))
3081 /* If shmap is not nil and not a keymap,
3082 it completely shadows this map, so don't
3083 describe this map at all. */
3084 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3088 sub_shadows
= Fcons (shmap
, sub_shadows
);
3091 /* Maps we have already listed in this loop shadow this map. */
3092 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3095 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3097 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3100 describe_map (Fcdr (elt
), prefix
,
3101 transl
? describe_translation
: describe_command
,
3102 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3108 insert_string ("\n");
3113 static int previous_description_column
;
3116 describe_command (definition
, args
)
3117 Lisp_Object definition
, args
;
3119 register Lisp_Object tem1
;
3120 int column
= (int) current_column (); /* iftc */
3121 int description_column
;
3123 /* If column 16 is no good, go to col 32;
3124 but don't push beyond that--go to next line instead. */
3128 description_column
= 32;
3130 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3131 description_column
= 32;
3133 description_column
= 16;
3135 Findent_to (make_number (description_column
), make_number (1));
3136 previous_description_column
= description_column
;
3138 if (SYMBOLP (definition
))
3140 tem1
= SYMBOL_NAME (definition
);
3142 insert_string ("\n");
3144 else if (STRINGP (definition
) || VECTORP (definition
))
3145 insert_string ("Keyboard Macro\n");
3146 else if (KEYMAPP (definition
))
3147 insert_string ("Prefix Command\n");
3149 insert_string ("??\n");
3153 describe_translation (definition
, args
)
3154 Lisp_Object definition
, args
;
3156 register Lisp_Object tem1
;
3158 Findent_to (make_number (16), make_number (1));
3160 if (SYMBOLP (definition
))
3162 tem1
= SYMBOL_NAME (definition
);
3164 insert_string ("\n");
3166 else if (STRINGP (definition
) || VECTORP (definition
))
3168 insert1 (Fkey_description (definition
, Qnil
));
3169 insert_string ("\n");
3171 else if (KEYMAPP (definition
))
3172 insert_string ("Prefix Command\n");
3174 insert_string ("??\n");
3177 /* describe_map puts all the usable elements of a sparse keymap
3178 into an array of `struct describe_map_elt',
3179 then sorts them by the events. */
3181 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3183 /* qsort comparison function for sorting `struct describe_map_elt' by
3187 describe_map_compare (aa
, bb
)
3188 const void *aa
, *bb
;
3190 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3191 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3192 return ((XINT (a
->event
) > XINT (b
->event
))
3193 - (XINT (a
->event
) < XINT (b
->event
)));
3194 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3196 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3198 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3199 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3200 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3205 /* Describe the contents of map MAP, assuming that this map itself is
3206 reached by the sequence of prefix keys PREFIX (a string or vector).
3207 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3210 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3211 seen
, nomenu
, mention_shadow
)
3212 register Lisp_Object map
;
3214 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3221 Lisp_Object tail
, definition
, event
;
3223 Lisp_Object suppress
;
3226 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3228 /* These accumulate the values from sparse keymap bindings,
3229 so we can sort them and handle them in order. */
3230 int length_needed
= 0;
3231 struct describe_map_elt
*vect
;
3238 suppress
= intern ("suppress-keymap");
3240 /* This vector gets used to present single keys to Flookup_key. Since
3241 that is done once per keymap element, we don't want to cons up a
3242 fresh vector every time. */
3243 kludge
= Fmake_vector (make_number (1), Qnil
);
3246 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3249 vect
= ((struct describe_map_elt
*)
3250 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3252 GCPRO3 (prefix
, definition
, kludge
);
3254 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3258 if (VECTORP (XCAR (tail
))
3259 || CHAR_TABLE_P (XCAR (tail
)))
3260 describe_vector (XCAR (tail
),
3261 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3262 (int *)0, 0, 1, mention_shadow
);
3263 else if (CONSP (XCAR (tail
)))
3265 int this_shadowed
= 0;
3267 event
= XCAR (XCAR (tail
));
3269 /* Ignore bindings whose "prefix" are not really valid events.
3270 (We get these in the frames and buffers menu.) */
3271 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3274 if (nomenu
&& EQ (event
, Qmenu_bar
))
3277 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3279 /* Don't show undefined commands or suppressed commands. */
3280 if (NILP (definition
)) continue;
3281 if (SYMBOLP (definition
) && partial
)
3283 tem
= Fget (definition
, suppress
);
3288 /* Don't show a command that isn't really visible
3289 because a local definition of the same key shadows it. */
3291 ASET (kludge
, 0, event
);
3294 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3304 tem
= Flookup_key (map
, kludge
, Qt
);
3305 if (!EQ (tem
, definition
)) continue;
3307 vect
[slots_used
].event
= event
;
3308 vect
[slots_used
].definition
= definition
;
3309 vect
[slots_used
].shadowed
= this_shadowed
;
3312 else if (EQ (XCAR (tail
), Qkeymap
))
3314 /* The same keymap might be in the structure twice, if we're
3315 using an inherited keymap. So skip anything we've already
3317 tem
= Fassq (tail
, *seen
);
3318 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3320 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3324 /* If we found some sparse map events, sort them. */
3326 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3327 describe_map_compare
);
3329 /* Now output them in sorted order. */
3331 for (i
= 0; i
< slots_used
; i
++)
3333 Lisp_Object start
, end
;
3337 previous_description_column
= 0;
3342 ASET (kludge
, 0, vect
[i
].event
);
3343 start
= vect
[i
].event
;
3346 definition
= vect
[i
].definition
;
3348 /* Find consecutive chars that are identically defined. */
3349 if (INTEGERP (vect
[i
].event
))
3351 while (i
+ 1 < slots_used
3352 && XINT (vect
[i
+ 1].event
) == XINT (vect
[i
].event
) + 1
3353 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3354 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3356 end
= vect
[i
].event
;
3359 /* Now START .. END is the range to describe next. */
3361 /* Insert the string to describe the event START. */
3362 insert1 (Fkey_description (kludge
, prefix
));
3364 if (!EQ (start
, end
))
3368 ASET (kludge
, 0, end
);
3369 /* Insert the string to describe the character END. */
3370 insert1 (Fkey_description (kludge
, prefix
));
3373 /* Print a description of the definition of this character.
3374 elt_describer will take care of spacing out far enough
3375 for alignment purposes. */
3376 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3378 if (vect
[i
].shadowed
)
3381 insert_string (" (binding currently shadowed)");
3390 describe_vector_princ (elt
, fun
)
3391 Lisp_Object elt
, fun
;
3393 Findent_to (make_number (16), make_number (1));
3398 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3399 doc
: /* Insert a description of contents of VECTOR.
3400 This is text showing the elements of vector matched against indices.
3401 DESCRIBER is the output function used; nil means use `princ'. */)
3403 Lisp_Object vector
, describer
;
3405 int count
= SPECPDL_INDEX ();
3406 if (NILP (describer
))
3407 describer
= intern ("princ");
3408 specbind (Qstandard_output
, Fcurrent_buffer ());
3409 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3410 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3411 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3413 return unbind_to (count
, Qnil
);
3416 /* Insert in the current buffer a description of the contents of VECTOR.
3417 We call ELT_DESCRIBER to insert the description of one value found
3420 ELT_PREFIX describes what "comes before" the keys or indices defined
3421 by this vector. This is a human-readable string whose size
3422 is not necessarily related to the situation.
3424 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3425 leads to this keymap.
3427 If the vector is a chartable, ELT_PREFIX is the vector
3428 of bytes that lead to the character set or portion of a character
3429 set described by this chartable.
3431 If PARTIAL is nonzero, it means do not mention suppressed commands
3432 (that assumes the vector is in a keymap).
3434 SHADOW is a list of keymaps that shadow this map.
3435 If it is non-nil, then we look up the key in those maps
3436 and we don't mention it now if it is defined by any of them.
3438 ENTIRE_MAP is the keymap in which this vector appears.
3439 If the definition in effect in the whole map does not match
3440 the one in this vector, we ignore this one.
3442 When describing a sub-char-table, INDICES is a list of
3443 indices at higher levels in this char-table,
3444 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3446 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3448 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3451 describe_vector (vector
, prefix
, args
, elt_describer
,
3452 partial
, shadow
, entire_map
,
3453 indices
, char_table_depth
, keymap_p
,
3455 register Lisp_Object vector
;
3456 Lisp_Object prefix
, args
;
3457 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3460 Lisp_Object entire_map
;
3462 int char_table_depth
;
3466 Lisp_Object definition
;
3468 Lisp_Object elt_prefix
= Qnil
;
3470 Lisp_Object suppress
;
3473 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3474 /* Range of elements to be handled. */
3476 /* A flag to tell if a leaf in this level of char-table is not a
3477 generic character (i.e. a complete multibyte character). */
3485 indices
= (int *) alloca (3 * sizeof (int));
3491 /* Call Fkey_description first, to avoid GC bug for the other string. */
3492 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3495 tem
= Fkey_description (prefix
, Qnil
);
3496 elt_prefix
= concat2 (tem
, build_string (" "));
3501 /* This vector gets used to present single keys to Flookup_key. Since
3502 that is done once per vector element, we don't want to cons up a
3503 fresh vector every time. */
3504 kludge
= Fmake_vector (make_number (1), Qnil
);
3505 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3508 suppress
= intern ("suppress-keymap");
3510 if (CHAR_TABLE_P (vector
))
3512 if (char_table_depth
== 0)
3514 /* VECTOR is a top level char-table. */
3517 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3521 /* VECTOR is a sub char-table. */
3522 if (char_table_depth
>= 3)
3523 /* A char-table is never that deep. */
3524 error ("Too deep char table");
3527 = (CHARSET_VALID_P (indices
[0])
3528 && ((CHARSET_DIMENSION (indices
[0]) == 1
3529 && char_table_depth
== 1)
3530 || char_table_depth
== 2));
3532 /* Meaningful elements are from 32th to 127th. */
3534 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3539 /* This does the right thing for ordinary vectors. */
3543 to
= XVECTOR (vector
)->size
;
3546 for (i
= from
; i
< to
; i
++)
3548 int this_shadowed
= 0;
3551 if (CHAR_TABLE_P (vector
))
3553 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3556 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3557 && !CHARSET_DEFINED_P (i
- 128))
3561 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3564 definition
= get_keyelt (AREF (vector
, i
), 0);
3566 if (NILP (definition
)) continue;
3568 /* Don't mention suppressed commands. */
3569 if (SYMBOLP (definition
) && partial
)
3573 tem
= Fget (definition
, suppress
);
3575 if (!NILP (tem
)) continue;
3578 /* Set CHARACTER to the character this entry describes, if any.
3579 Also update *INDICES. */
3580 if (CHAR_TABLE_P (vector
))
3582 indices
[char_table_depth
] = i
;
3584 if (char_table_depth
== 0)
3587 indices
[0] = i
- 128;
3589 else if (complete_char
)
3591 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3599 ASET (kludge
, 0, make_number (character
));
3601 /* If this binding is shadowed by some other map, ignore it. */
3602 if (!NILP (shadow
) && complete_char
)
3606 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3617 /* Ignore this definition if it is shadowed by an earlier
3618 one in the same keymap. */
3619 if (!NILP (entire_map
) && complete_char
)
3623 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3625 if (!EQ (tem
, definition
))
3631 if (char_table_depth
== 0)
3636 /* For a sub char-table, show the depth by indentation.
3637 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3638 if (char_table_depth
> 0)
3639 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3641 /* Output the prefix that applies to every entry in this map. */
3642 if (!NILP (elt_prefix
))
3643 insert1 (elt_prefix
);
3645 /* Insert or describe the character this slot is for,
3646 or a description of what it is for. */
3647 if (SUB_CHAR_TABLE_P (vector
))
3650 insert_char (character
);
3653 /* We need an octal representation for this block of
3656 sprintf (work
, "(row %d)", i
);
3657 insert (work
, strlen (work
));
3660 else if (CHAR_TABLE_P (vector
))
3663 insert1 (Fkey_description (kludge
, prefix
));
3666 /* Print the information for this character set. */
3667 insert_string ("<");
3668 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3670 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3679 insert1 (Fkey_description (kludge
, prefix
));
3682 /* If we find a sub char-table within a char-table,
3683 scan it recursively; it defines the details for
3684 a character set or a portion of a character set. */
3685 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3688 describe_vector (definition
, prefix
, args
, elt_describer
,
3689 partial
, shadow
, entire_map
,
3690 indices
, char_table_depth
+ 1, keymap_p
,
3697 /* Find all consecutive characters or rows that have the same
3698 definition. But, for elements of a top level char table, if
3699 they are for charsets, we had better describe one by one even
3700 if they have the same definition. */
3701 if (CHAR_TABLE_P (vector
))
3705 if (char_table_depth
== 0)
3706 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3708 while (i
+ 1 < limit
3709 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3711 && !NILP (Fequal (tem2
, definition
)))
3716 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3718 && !NILP (Fequal (tem2
, definition
)))
3722 /* If we have a range of more than one character,
3723 print where the range reaches to. */
3725 if (i
!= starting_i
)
3729 ASET (kludge
, 0, make_number (i
));
3731 if (!NILP (elt_prefix
))
3732 insert1 (elt_prefix
);
3734 if (CHAR_TABLE_P (vector
))
3736 if (char_table_depth
== 0)
3738 insert1 (Fkey_description (kludge
, prefix
));
3740 else if (complete_char
)
3742 indices
[char_table_depth
] = i
;
3743 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3744 insert_char (character
);
3748 /* We need an octal representation for this block of
3751 sprintf (work
, "(row %d)", i
);
3752 insert (work
, strlen (work
));
3757 insert1 (Fkey_description (kludge
, prefix
));
3761 /* Print a description of the definition of this character.
3762 elt_describer will take care of spacing out far enough
3763 for alignment purposes. */
3764 (*elt_describer
) (definition
, args
);
3769 insert_string (" (binding currently shadowed)");
3774 /* For (sub) char-table, print `defalt' slot at last. */
3775 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3777 insert (" ", char_table_depth
* 2);
3778 insert_string ("<<default>>");
3779 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3785 /* Apropos - finding all symbols whose names match a regexp. */
3786 static Lisp_Object apropos_predicate
;
3787 static Lisp_Object apropos_accumulate
;
3790 apropos_accum (symbol
, string
)
3791 Lisp_Object symbol
, string
;
3793 register Lisp_Object tem
;
3795 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3796 if (!NILP (tem
) && !NILP (apropos_predicate
))
3797 tem
= call1 (apropos_predicate
, symbol
);
3799 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3802 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3803 doc
: /* Show all symbols whose names contain match for REGEXP.
3804 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3805 for each symbol and a symbol is mentioned only if that returns non-nil.
3806 Return list of symbols found. */)
3808 Lisp_Object regexp
, predicate
;
3811 CHECK_STRING (regexp
);
3812 apropos_predicate
= predicate
;
3813 apropos_accumulate
= Qnil
;
3814 map_obarray (Vobarray
, apropos_accum
, regexp
);
3815 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3816 apropos_accumulate
= Qnil
;
3817 apropos_predicate
= Qnil
;
3824 Qkeymap
= intern ("keymap");
3825 staticpro (&Qkeymap
);
3826 staticpro (&apropos_predicate
);
3827 staticpro (&apropos_accumulate
);
3828 apropos_predicate
= Qnil
;
3829 apropos_accumulate
= Qnil
;
3831 /* Now we are ready to set up this property, so we can
3832 create char tables. */
3833 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3835 /* Initialize the keymaps standardly used.
3836 Each one is the value of a Lisp variable, and is also
3837 pointed to by a C variable */
3839 global_map
= Fmake_keymap (Qnil
);
3840 Fset (intern ("global-map"), global_map
);
3842 current_global_map
= global_map
;
3843 staticpro (&global_map
);
3844 staticpro (¤t_global_map
);
3846 meta_map
= Fmake_keymap (Qnil
);
3847 Fset (intern ("esc-map"), meta_map
);
3848 Ffset (intern ("ESC-prefix"), meta_map
);
3850 control_x_map
= Fmake_keymap (Qnil
);
3851 Fset (intern ("ctl-x-map"), control_x_map
);
3852 Ffset (intern ("Control-X-prefix"), control_x_map
);
3855 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3856 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3857 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3858 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3859 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3861 staticpro (&exclude_keys
);
3863 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3864 doc
: /* List of commands given new key bindings recently.
3865 This is used for internal purposes during Emacs startup;
3866 don't alter it yourself. */);
3867 Vdefine_key_rebound_commands
= Qt
;
3869 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3870 doc
: /* Default keymap to use when reading from the minibuffer. */);
3871 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3873 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3874 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3875 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3876 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3878 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3879 doc
: /* Local keymap for minibuffer input with completion. */);
3880 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3881 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3883 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3884 &Vminibuffer_local_filename_completion_map
,
3885 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3886 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3887 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3888 Vminibuffer_local_completion_map
);
3891 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3892 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3893 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3894 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3895 Vminibuffer_local_completion_map
);
3897 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3898 &Vminibuffer_local_must_match_filename_map
,
3899 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3900 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3901 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3902 Vminibuffer_local_must_match_map
);
3904 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3905 doc
: /* Alist of keymaps to use for minor modes.
3906 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3907 key sequences and look up bindings iff VARIABLE's value is non-nil.
3908 If two active keymaps bind the same key, the keymap appearing earlier
3909 in the list takes precedence. */);
3910 Vminor_mode_map_alist
= Qnil
;
3912 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3913 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3914 This variable is an alist just like `minor-mode-map-alist', and it is
3915 used the same way (and before `minor-mode-map-alist'); however,
3916 it is provided for major modes to bind locally. */);
3917 Vminor_mode_overriding_map_alist
= Qnil
;
3919 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3920 doc
: /* List of keymap alists to use for emulations modes.
3921 It is intended for modes or packages using multiple minor-mode keymaps.
3922 Each element is a keymap alist just like `minor-mode-map-alist', or a
3923 symbol with a variable binding which is a keymap alist, and it is used
3924 the same way. The "active" keymaps in each alist are used before
3925 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3926 Vemulation_mode_map_alists
= Qnil
;
3929 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3930 doc
: /* Keymap that translates key sequences to key sequences during input.
3931 This is used mainly for mapping ASCII function key sequences into
3932 real Emacs function key events (symbols).
3934 The `read-key-sequence' function replaces any subsequence bound by
3935 `function-key-map' with its binding. More precisely, when the active
3936 keymaps have no binding for the current key sequence but
3937 `function-key-map' binds a suffix of the sequence to a vector or string,
3938 `read-key-sequence' replaces the matching suffix with its binding, and
3939 continues with the new sequence.
3941 If the binding is a function, it is called with one argument (the prompt)
3942 and its return value (a key sequence) is used.
3944 The events that come from bindings in `function-key-map' are not
3945 themselves looked up in `function-key-map'.
3947 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3948 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3949 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3950 key, typing `ESC O P x' would return [f1 x]. */);
3951 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3953 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3954 doc
: /* Keymap of key translations that can override keymaps.
3955 This keymap works like `function-key-map', but comes after that,
3956 and its non-prefix bindings override ordinary bindings. */);
3957 Vkey_translation_map
= Qnil
;
3959 staticpro (&Vmouse_events
);
3960 Vmouse_events
= Fcons (intern ("menu-bar"),
3961 Fcons (intern ("tool-bar"),
3962 Fcons (intern ("header-line"),
3963 Fcons (intern ("mode-line"),
3964 Fcons (intern ("mouse-1"),
3965 Fcons (intern ("mouse-2"),
3966 Fcons (intern ("mouse-3"),
3967 Fcons (intern ("mouse-4"),
3968 Fcons (intern ("mouse-5"),
3972 Qsingle_key_description
= intern ("single-key-description");
3973 staticpro (&Qsingle_key_description
);
3975 Qkey_description
= intern ("key-description");
3976 staticpro (&Qkey_description
);
3978 Qkeymapp
= intern ("keymapp");
3979 staticpro (&Qkeymapp
);
3981 Qnon_ascii
= intern ("non-ascii");
3982 staticpro (&Qnon_ascii
);
3984 Qmenu_item
= intern ("menu-item");
3985 staticpro (&Qmenu_item
);
3987 Qremap
= intern ("remap");
3988 staticpro (&Qremap
);
3990 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3991 staticpro (&command_remapping_vector
);
3993 where_is_cache_keymaps
= Qt
;
3994 where_is_cache
= Qnil
;
3995 staticpro (&where_is_cache
);
3996 staticpro (&where_is_cache_keymaps
);
3998 defsubr (&Skeymapp
);
3999 defsubr (&Skeymap_parent
);
4000 defsubr (&Skeymap_prompt
);
4001 defsubr (&Sset_keymap_parent
);
4002 defsubr (&Smake_keymap
);
4003 defsubr (&Smake_sparse_keymap
);
4004 defsubr (&Smap_keymap
);
4005 defsubr (&Scopy_keymap
);
4006 defsubr (&Scommand_remapping
);
4007 defsubr (&Skey_binding
);
4008 defsubr (&Slocal_key_binding
);
4009 defsubr (&Sglobal_key_binding
);
4010 defsubr (&Sminor_mode_key_binding
);
4011 defsubr (&Sdefine_key
);
4012 defsubr (&Slookup_key
);
4013 defsubr (&Sdefine_prefix_command
);
4014 defsubr (&Suse_global_map
);
4015 defsubr (&Suse_local_map
);
4016 defsubr (&Scurrent_local_map
);
4017 defsubr (&Scurrent_global_map
);
4018 defsubr (&Scurrent_minor_mode_maps
);
4019 defsubr (&Scurrent_active_maps
);
4020 defsubr (&Saccessible_keymaps
);
4021 defsubr (&Skey_description
);
4022 defsubr (&Sdescribe_vector
);
4023 defsubr (&Ssingle_key_description
);
4024 defsubr (&Stext_char_description
);
4025 defsubr (&Swhere_is_internal
);
4026 defsubr (&Sdescribe_buffer_bindings
);
4027 defsubr (&Sapropos_internal
);
4033 initial_define_key (global_map
, 033, "ESC-prefix");
4034 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
4037 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
4038 (do not change this comment) */