1 /* Manipulation of keymaps
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
31 #include "termhooks.h"
32 #include "blockinput.h"
34 #include "intervals.h"
37 /* The number of elements in keymap vectors. */
38 #define DENSE_TABLE_SIZE (0200)
40 /* Actually allocate storage for these variables */
42 Lisp_Object current_global_map
; /* Current global keymap */
44 Lisp_Object global_map
; /* default global key bindings */
46 Lisp_Object meta_map
; /* The keymap used for globally bound
47 ESC-prefixed default commands */
49 Lisp_Object control_x_map
; /* The keymap used for globally bound
50 C-x-prefixed default commands */
52 /* was MinibufLocalMap */
53 Lisp_Object Vminibuffer_local_map
;
54 /* The keymap used by the minibuf for local
55 bindings when spaces are allowed in the
58 /* was MinibufLocalNSMap */
59 Lisp_Object Vminibuffer_local_ns_map
;
60 /* The keymap used by the minibuf for local
61 bindings when spaces are not encouraged
64 /* keymap used for minibuffers when doing completion */
65 /* was MinibufLocalCompletionMap */
66 Lisp_Object Vminibuffer_local_completion_map
;
68 /* keymap used for minibuffers when doing completion in filenames */
69 Lisp_Object Vminibuffer_local_filename_completion_map
;
71 /* keymap used for minibuffers when doing completion in filenames
73 Lisp_Object Vminibuffer_local_must_match_filename_map
;
75 /* keymap used for minibuffers when doing completion and require a match */
76 /* was MinibufLocalMustMatchMap */
77 Lisp_Object Vminibuffer_local_must_match_map
;
79 /* Alist of minor mode variables and keymaps. */
80 Lisp_Object Vminor_mode_map_alist
;
82 /* Alist of major-mode-specific overrides for
83 minor mode variables and keymaps. */
84 Lisp_Object Vminor_mode_overriding_map_alist
;
86 /* List of emulation mode keymap alists. */
87 Lisp_Object Vemulation_mode_map_alists
;
89 /* Keymap mapping ASCII function key sequences onto their preferred forms.
90 Initialized by the terminal-specific lisp files. See DEFVAR for more
92 Lisp_Object Vfunction_key_map
;
94 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
95 Lisp_Object Vkey_translation_map
;
97 /* A list of all commands given new bindings since a certain time
98 when nil was stored here.
99 This is used to speed up recomputation of menu key equivalents
100 when Emacs starts up. t means don't record anything here. */
101 Lisp_Object Vdefine_key_rebound_commands
;
103 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
105 /* Alist of elements like (DEL . "\d"). */
106 static Lisp_Object exclude_keys
;
108 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
109 static Lisp_Object command_remapping_vector
;
111 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
112 in a string key sequence is equivalent to prefixing with this
114 extern Lisp_Object meta_prefix_char
;
116 extern Lisp_Object Voverriding_local_map
;
118 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
119 static Lisp_Object where_is_cache
;
120 /* Which keymaps are reverse-stored in the cache. */
121 static Lisp_Object where_is_cache_keymaps
;
123 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
124 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
126 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
127 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
128 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
129 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
130 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
131 int, Lisp_Object
, Lisp_Object
*, int, int));
132 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
133 void (*) (Lisp_Object
, Lisp_Object
), int,
134 Lisp_Object
, Lisp_Object
, int *,
136 static void silly_event_symbol_error
P_ ((Lisp_Object
));
138 /* Keymap object support - constructors and predicates. */
140 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
141 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
142 CHARTABLE is a char-table that holds the bindings for all characters
143 without modifiers. All entries in it are initially nil, meaning
144 "command undefined". ALIST is an assoc-list which holds bindings for
145 function keys, mouse events, and any other things that appear in the
146 input stream. Initially, ALIST is nil.
148 The optional arg STRING supplies a menu name for the keymap
149 in case you use it as a menu with `x-popup-menu'. */)
155 tail
= Fcons (string
, Qnil
);
158 return Fcons (Qkeymap
,
159 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
162 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
163 doc
: /* Construct and return a new sparse keymap.
164 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
165 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
166 which binds the function key or mouse event SYMBOL to DEFINITION.
167 Initially the alist is nil.
169 The optional arg STRING supplies a menu name for the keymap
170 in case you use it as a menu with `x-popup-menu'. */)
175 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
176 return Fcons (Qkeymap
, Qnil
);
179 /* This function is used for installing the standard key bindings
180 at initialization time.
184 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
187 initial_define_key (keymap
, key
, defname
)
192 store_in_keymap (keymap
, make_number (key
), intern (defname
));
196 initial_define_lispy_key (keymap
, keyname
, defname
)
201 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
204 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
205 doc
: /* Return t if OBJECT is a keymap.
207 A keymap is a list (keymap . ALIST),
208 or a symbol whose function definition is itself a keymap.
209 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
210 a vector of densely packed bindings for small character codes
211 is also allowed as an element. */)
215 return (KEYMAPP (object
) ? Qt
: Qnil
);
218 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
219 doc
: /* Return the prompt-string of a keymap MAP.
220 If non-nil, the prompt is shown in the echo-area
221 when reading a key-sequence to be looked-up in this keymap. */)
225 map
= get_keymap (map
, 0, 0);
228 Lisp_Object tem
= XCAR (map
);
236 /* Check that OBJECT is a keymap (after dereferencing through any
237 symbols). If it is, return it.
239 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
240 is an autoload form, do the autoload and try again.
241 If AUTOLOAD is nonzero, callers must assume GC is possible.
243 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
244 is zero as well), return Qt.
246 ERROR controls how we respond if OBJECT isn't a keymap.
247 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
249 Note that most of the time, we don't want to pursue autoloads.
250 Functions like Faccessible_keymaps which scan entire keymap trees
251 shouldn't load every autoloaded keymap. I'm not sure about this,
252 but it seems to me that only read_key_sequence, Flookup_key, and
253 Fdefine_key should cause keymaps to be autoloaded.
255 This function can GC when AUTOLOAD is non-zero, because it calls
256 do_autoload which can GC. */
259 get_keymap (object
, error
, autoload
)
268 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
271 tem
= indirect_function (object
);
274 if (EQ (XCAR (tem
), Qkeymap
))
277 /* Should we do an autoload? Autoload forms for keymaps have
278 Qkeymap as their fifth element. */
279 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
)
284 tail
= Fnth (make_number (4), tem
);
285 if (EQ (tail
, Qkeymap
))
289 struct gcpro gcpro1
, gcpro2
;
291 GCPRO2 (tem
, object
);
292 do_autoload (tem
, object
);
305 wrong_type_argument (Qkeymapp
, object
);
309 /* Return the parent map of KEYMAP, or nil if it has none.
310 We assume that KEYMAP is a valid keymap. */
313 keymap_parent (keymap
, autoload
)
319 keymap
= get_keymap (keymap
, 1, autoload
);
321 /* Skip past the initial element `keymap'. */
322 list
= XCDR (keymap
);
323 for (; CONSP (list
); list
= XCDR (list
))
325 /* See if there is another `keymap'. */
330 return get_keymap (list
, 0, autoload
);
333 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
334 doc
: /* Return the parent keymap of KEYMAP. */)
338 return keymap_parent (keymap
, 1);
341 /* Check whether MAP is one of MAPS parents. */
343 keymap_memberp (map
, maps
)
344 Lisp_Object map
, maps
;
346 if (NILP (map
)) return 0;
347 while (KEYMAPP (maps
) && !EQ (map
, maps
))
348 maps
= keymap_parent (maps
, 0);
349 return (EQ (map
, maps
));
352 /* Set the parent keymap of MAP to PARENT. */
354 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
355 doc
: /* Modify KEYMAP to set its parent map to PARENT.
356 Return PARENT. PARENT should be nil or another keymap. */)
358 Lisp_Object keymap
, parent
;
360 Lisp_Object list
, prev
;
361 struct gcpro gcpro1
, gcpro2
;
364 /* Force a keymap flush for the next call to where-is.
365 Since this can be called from within where-is, we don't set where_is_cache
366 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
367 be changed during where-is, while where_is_cache_keymaps is only used at
368 the very beginning of where-is and can thus be changed here without any
370 This is a very minor correctness (rather than safety) issue. */
371 where_is_cache_keymaps
= Qt
;
373 GCPRO2 (keymap
, parent
);
374 keymap
= get_keymap (keymap
, 1, 1);
378 parent
= get_keymap (parent
, 1, 1);
380 /* Check for cycles. */
381 if (keymap_memberp (keymap
, parent
))
382 error ("Cyclic keymap inheritance");
385 /* Skip past the initial element `keymap'. */
390 /* If there is a parent keymap here, replace it.
391 If we came to the end, add the parent in PREV. */
392 if (!CONSP (list
) || KEYMAPP (list
))
394 /* If we already have the right parent, return now
395 so that we avoid the loops below. */
396 if (EQ (XCDR (prev
), parent
))
397 RETURN_UNGCPRO (parent
);
400 XSETCDR (prev
, parent
);
406 /* Scan through for submaps, and set their parents too. */
408 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
410 /* Stop the scan when we come to the parent. */
411 if (EQ (XCAR (list
), Qkeymap
))
414 /* If this element holds a prefix map, deal with it. */
415 if (CONSP (XCAR (list
))
416 && CONSP (XCDR (XCAR (list
))))
417 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
420 if (VECTORP (XCAR (list
)))
421 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
422 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
423 fix_submap_inheritance (keymap
, make_number (i
),
424 XVECTOR (XCAR (list
))->contents
[i
]);
426 if (CHAR_TABLE_P (XCAR (list
)))
428 Lisp_Object indices
[3];
430 map_char_table (fix_submap_inheritance
, Qnil
,
431 XCAR (list
), XCAR (list
),
436 RETURN_UNGCPRO (parent
);
439 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
440 if EVENT is also a prefix in MAP's parent,
441 make sure that SUBMAP inherits that definition as its own parent. */
444 fix_submap_inheritance (map
, event
, submap
)
445 Lisp_Object map
, event
, submap
;
447 Lisp_Object map_parent
, parent_entry
;
449 /* SUBMAP is a cons that we found as a key binding.
450 Discard the other things found in a menu key binding. */
452 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
454 /* If it isn't a keymap now, there's no work to do. */
458 map_parent
= keymap_parent (map
, 0);
459 if (!NILP (map_parent
))
461 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
465 /* If MAP's parent has something other than a keymap,
466 our own submap shadows it completely. */
467 if (!CONSP (parent_entry
))
470 if (! EQ (parent_entry
, submap
))
472 Lisp_Object submap_parent
;
473 submap_parent
= submap
;
478 tem
= keymap_parent (submap_parent
, 0);
482 if (keymap_memberp (tem
, parent_entry
))
483 /* Fset_keymap_parent could create a cycle. */
490 Fset_keymap_parent (submap_parent
, parent_entry
);
494 /* Look up IDX in MAP. IDX may be any sort of event.
495 Note that this does only one level of lookup; IDX must be a single
496 event, not a sequence.
498 If T_OK is non-zero, bindings for Qt are treated as default
499 bindings; any key left unmentioned by other tables and bindings is
500 given the binding of Qt.
502 If T_OK is zero, bindings for Qt are not treated specially.
504 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
507 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
516 /* Qunbound in VAL means we have found no binding yet. */
519 /* If idx is a list (some sort of mouse click, perhaps?),
520 the index we want to use is the car of the list, which
521 ought to be a symbol. */
522 idx
= EVENT_HEAD (idx
);
524 /* If idx is a symbol, it might have modifiers, which need to
525 be put in the canonical order. */
527 idx
= reorder_modifiers (idx
);
528 else if (INTEGERP (idx
))
529 /* Clobber the high bits that can be present on a machine
530 with more than 24 bits of integer. */
531 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
533 /* Handle the special meta -> esc mapping. */
534 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
536 /* See if there is a meta-map. If there's none, there is
537 no binding for IDX, unless a default binding exists in MAP. */
539 Lisp_Object meta_map
;
541 /* A strange value in which Meta is set would cause
542 infinite recursion. Protect against that. */
543 if (XINT (meta_prefix_char
) & CHAR_META
)
544 meta_prefix_char
= make_number (27);
545 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
546 t_ok
, noinherit
, autoload
),
549 if (CONSP (meta_map
))
552 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
555 /* Set IDX to t, so that we only find a default binding. */
558 /* We know there is no binding. */
562 /* t_binding is where we put a default binding that applies,
563 to use in case we do not find a binding specifically
564 for this key sequence. */
567 Lisp_Object t_binding
= Qnil
;
568 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
570 GCPRO4 (map
, tail
, idx
, t_binding
);
572 /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
573 If it is 1, only generic-char bindings are accepted.
574 Otherwise, neither are. */
577 for (tail
= XCDR (map
);
579 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
584 binding
= XCAR (tail
);
585 if (SYMBOLP (binding
))
587 /* If NOINHERIT, stop finding prefix definitions
588 after we pass a second occurrence of the `keymap' symbol. */
589 if (noinherit
&& EQ (binding
, Qkeymap
))
590 RETURN_UNGCPRO (Qnil
);
592 else if (CONSP (binding
))
594 Lisp_Object key
= XCAR (binding
);
597 val
= XCDR (binding
);
600 && (XINT (idx
) & CHAR_MODIFIER_MASK
) == 0
602 && (XINT (key
) & CHAR_MODIFIER_MASK
) == 0
603 && !SINGLE_BYTE_CHAR_P (XINT (idx
))
604 && !SINGLE_BYTE_CHAR_P (XINT (key
))
605 && CHAR_VALID_P (XINT (key
), 1)
606 && !CHAR_VALID_P (XINT (key
), 0)
607 && (CHAR_CHARSET (XINT (key
))
608 == CHAR_CHARSET (XINT (idx
))))
610 /* KEY is the generic character of the charset of IDX.
611 Use KEY's binding if there isn't a binding for IDX
613 t_binding
= XCDR (binding
);
616 else if (t_ok
> 1 && EQ (key
, Qt
))
618 t_binding
= XCDR (binding
);
622 else if (VECTORP (binding
))
624 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
625 val
= AREF (binding
, XFASTINT (idx
));
627 else if (CHAR_TABLE_P (binding
))
629 /* Character codes with modifiers
630 are not included in a char-table.
631 All character codes without modifiers are included. */
632 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
634 val
= Faref (binding
, idx
);
635 /* `nil' has a special meaning for char-tables, so
636 we use something else to record an explicitly
643 /* If we found a binding, clean it up and return it. */
644 if (!EQ (val
, Qunbound
))
647 /* A Qt binding is just like an explicit nil binding
648 (i.e. it shadows any parent binding but not bindings in
649 keymaps of lower precedence). */
651 val
= get_keyelt (val
, autoload
);
653 fix_submap_inheritance (map
, idx
, val
);
654 RETURN_UNGCPRO (val
);
659 return get_keyelt (t_binding
, autoload
);
664 map_keymap_item (fun
, args
, key
, val
, data
)
665 map_keymap_function_t fun
;
666 Lisp_Object args
, key
, val
;
669 /* We should maybe try to detect bindings shadowed by previous
670 ones and things like that. */
673 (*fun
) (key
, val
, args
, data
);
677 map_keymap_char_table_item (args
, key
, val
)
678 Lisp_Object args
, key
, val
;
682 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
684 map_keymap_item (fun
, XCDR (args
), key
, val
,
685 XSAVE_VALUE (XCAR (args
))->pointer
);
689 /* Call FUN for every binding in MAP.
690 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
691 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
693 map_keymap (map
, fun
, args
, data
, autoload
)
694 map_keymap_function_t fun
;
695 Lisp_Object map
, args
;
699 struct gcpro gcpro1
, gcpro2
, gcpro3
;
703 GCPRO3 (map
, args
, tail
);
704 map
= get_keymap (map
, 1, autoload
);
705 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
706 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
709 Lisp_Object binding
= XCAR (tail
);
712 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
713 else if (VECTORP (binding
))
715 /* Loop over the char values represented in the vector. */
716 int len
= ASIZE (binding
);
718 for (c
= 0; c
< len
; c
++)
720 Lisp_Object character
;
721 XSETFASTINT (character
, c
);
722 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
725 else if (CHAR_TABLE_P (binding
))
727 Lisp_Object indices
[3];
728 map_char_table (map_keymap_char_table_item
, Qnil
, binding
, binding
,
729 Fcons (make_save_value (fun
, 0),
730 Fcons (make_save_value (data
, 0),
739 map_keymap_call (key
, val
, fun
, dummy
)
740 Lisp_Object key
, val
, fun
;
743 call2 (fun
, key
, val
);
746 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
747 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
748 FUNCTION is called with two arguments: the event that is bound, and
749 the definition it is bound to.
751 If KEYMAP has a parent, the parent's bindings are included as well.
752 This works recursively: if the parent has itself a parent, then the
753 grandparent's bindings are also included and so on.
754 usage: (map-keymap FUNCTION KEYMAP) */)
755 (function
, keymap
, sort_first
)
756 Lisp_Object function
, keymap
, sort_first
;
758 if (INTEGERP (function
))
759 /* We have to stop integers early since map_keymap gives them special
761 xsignal1 (Qinvalid_function
, function
);
762 if (! NILP (sort_first
))
763 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
765 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
769 /* Given OBJECT which was found in a slot in a keymap,
770 trace indirect definitions to get the actual definition of that slot.
771 An indirect definition is a list of the form
772 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
773 and INDEX is the object to look up in KEYMAP to yield the definition.
775 Also if OBJECT has a menu string as the first element,
776 remove that. Also remove a menu help string as second element.
778 If AUTOLOAD is nonzero, load autoloadable keymaps
779 that are referred to with indirection.
781 This can GC because menu_item_eval_property calls Feval. */
784 get_keyelt (object
, autoload
)
790 if (!(CONSP (object
)))
791 /* This is really the value. */
794 /* If the keymap contents looks like (keymap ...) or (lambda ...)
796 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
799 /* If the keymap contents looks like (menu-item name . DEFN)
800 or (menu-item name DEFN ...) then use DEFN.
801 This is a new format menu item. */
802 else if (EQ (XCAR (object
), Qmenu_item
))
804 if (CONSP (XCDR (object
)))
808 object
= XCDR (XCDR (object
));
811 object
= XCAR (object
);
813 /* If there's a `:filter FILTER', apply FILTER to the
814 menu-item's definition to get the real definition to
816 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
817 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
820 filter
= XCAR (XCDR (tem
));
821 filter
= list2 (filter
, list2 (Qquote
, object
));
822 object
= menu_item_eval_property (filter
);
827 /* Invalid keymap. */
831 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
832 Keymap alist elements like (CHAR MENUSTRING . DEFN)
833 will be used by HierarKey menus. */
834 else if (STRINGP (XCAR (object
)))
836 object
= XCDR (object
);
837 /* Also remove a menu help string, if any,
838 following the menu item name. */
839 if (CONSP (object
) && STRINGP (XCAR (object
)))
840 object
= XCDR (object
);
841 /* Also remove the sublist that caches key equivalences, if any. */
842 if (CONSP (object
) && CONSP (XCAR (object
)))
845 carcar
= XCAR (XCAR (object
));
846 if (NILP (carcar
) || VECTORP (carcar
))
847 object
= XCDR (object
);
851 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
857 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
859 return (!CONSP (map
) ? object
/* Invalid keymap */
860 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
866 store_in_keymap (keymap
, idx
, def
)
868 register Lisp_Object idx
;
871 /* Flush any reverse-map cache. */
872 where_is_cache
= Qnil
;
873 where_is_cache_keymaps
= Qt
;
875 /* If we are preparing to dump, and DEF is a menu element
876 with a menu item indicator, copy it to ensure it is not pure. */
877 if (CONSP (def
) && PURE_P (def
)
878 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
879 def
= Fcons (XCAR (def
), XCDR (def
));
881 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
882 error ("attempt to define a key in a non-keymap");
884 /* If idx is a list (some sort of mouse click, perhaps?),
885 the index we want to use is the car of the list, which
886 ought to be a symbol. */
887 idx
= EVENT_HEAD (idx
);
889 /* If idx is a symbol, it might have modifiers, which need to
890 be put in the canonical order. */
892 idx
= reorder_modifiers (idx
);
893 else if (INTEGERP (idx
))
894 /* Clobber the high bits that can be present on a machine
895 with more than 24 bits of integer. */
896 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
898 /* Scan the keymap for a binding of idx. */
902 /* The cons after which we should insert new bindings. If the
903 keymap has a table element, we record its position here, so new
904 bindings will go after it; this way, the table will stay
905 towards the front of the alist and character lookups in dense
906 keymaps will remain fast. Otherwise, this just points at the
907 front of the keymap. */
908 Lisp_Object insertion_point
;
910 insertion_point
= keymap
;
911 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
918 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
921 ASET (elt
, XFASTINT (idx
), def
);
924 insertion_point
= tail
;
926 else if (CHAR_TABLE_P (elt
))
928 /* Character codes with modifiers
929 are not included in a char-table.
930 All character codes without modifiers are included. */
931 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
934 /* `nil' has a special meaning for char-tables, so
935 we use something else to record an explicitly
937 NILP (def
) ? Qt
: def
);
940 insertion_point
= tail
;
942 else if (CONSP (elt
))
944 if (EQ (idx
, XCAR (elt
)))
951 else if (EQ (elt
, Qkeymap
))
952 /* If we find a 'keymap' symbol in the spine of KEYMAP,
953 then we must have found the start of a second keymap
954 being used as the tail of KEYMAP, and a binding for IDX
955 should be inserted before it. */
962 /* We have scanned the entire keymap, and not found a binding for
963 IDX. Let's add one. */
964 CHECK_IMPURE (insertion_point
);
965 XSETCDR (insertion_point
,
966 Fcons (Fcons (idx
, def
), XCDR (insertion_point
)));
972 EXFUN (Fcopy_keymap
, 1);
975 copy_keymap_item (elt
)
978 Lisp_Object res
, tem
;
985 /* Is this a new format menu item. */
986 if (EQ (XCAR (tem
), Qmenu_item
))
988 /* Copy cell with menu-item marker. */
989 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
993 /* Copy cell with menu-item name. */
994 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1000 /* Copy cell with binding and if the binding is a keymap,
1002 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1005 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1006 XSETCAR (elt
, Fcopy_keymap (tem
));
1008 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1009 /* Delete cache for key equivalences. */
1010 XSETCDR (elt
, XCDR (tem
));
1015 /* It may be an old fomat menu item.
1016 Skip the optional menu string. */
1017 if (STRINGP (XCAR (tem
)))
1019 /* Copy the cell, since copy-alist didn't go this deep. */
1020 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1022 /* Also skip the optional menu help string. */
1023 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1025 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1029 /* There may also be a list that caches key equivalences.
1030 Just delete it for the new keymap. */
1032 && CONSP (XCAR (tem
))
1033 && (NILP (XCAR (XCAR (tem
)))
1034 || VECTORP (XCAR (XCAR (tem
)))))
1036 XSETCDR (elt
, XCDR (tem
));
1039 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1040 XSETCDR (elt
, Fcopy_keymap (tem
));
1042 else if (EQ (XCAR (tem
), Qkeymap
))
1043 res
= Fcopy_keymap (elt
);
1049 copy_keymap_1 (chartable
, idx
, elt
)
1050 Lisp_Object chartable
, idx
, elt
;
1052 Faset (chartable
, idx
, copy_keymap_item (elt
));
1055 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1056 doc
: /* Return a copy of the keymap KEYMAP.
1057 The copy starts out with the same definitions of KEYMAP,
1058 but changing either the copy or KEYMAP does not affect the other.
1059 Any key definitions that are subkeymaps are recursively copied.
1060 However, a key definition which is a symbol whose definition is a keymap
1065 register Lisp_Object copy
, tail
;
1066 keymap
= get_keymap (keymap
, 1, 0);
1067 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1068 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1070 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1072 Lisp_Object elt
= XCAR (keymap
);
1073 if (CHAR_TABLE_P (elt
))
1075 Lisp_Object indices
[3];
1076 elt
= Fcopy_sequence (elt
);
1077 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, elt
, 0, indices
);
1079 else if (VECTORP (elt
))
1082 elt
= Fcopy_sequence (elt
);
1083 for (i
= 0; i
< ASIZE (elt
); i
++)
1084 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1086 else if (CONSP (elt
))
1087 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1088 XSETCDR (tail
, Fcons (elt
, Qnil
));
1090 keymap
= XCDR (keymap
);
1092 XSETCDR (tail
, keymap
);
1096 /* Simple Keymap mutators and accessors. */
1098 /* GC is possible in this function if it autoloads a keymap. */
1100 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1101 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1104 KEY is a string or a vector of symbols and characters meaning a
1105 sequence of keystrokes and events. Non-ASCII characters with codes
1106 above 127 (such as ISO Latin-1) can be included if you use a vector.
1107 Using [t] for KEY creates a default definition, which applies to any
1108 event type that has no other definition in this keymap.
1110 DEF is anything that can be a key's definition:
1111 nil (means key is undefined in this keymap),
1112 a command (a Lisp function suitable for interactive calling),
1113 a string (treated as a keyboard macro),
1114 a keymap (to define a prefix key),
1115 a symbol (when the key is looked up, the symbol will stand for its
1116 function definition, which should at that time be one of the above,
1117 or another symbol whose function definition is used, etc.),
1118 a cons (STRING . DEFN), meaning that DEFN is the definition
1119 (DEFN should be a valid definition in its own right),
1120 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1122 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1123 binding is altered. If there is no binding for KEY, the new pair
1124 binding KEY to DEF is added at the front of KEYMAP. */)
1131 register Lisp_Object c
;
1132 register Lisp_Object cmd
;
1136 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1138 GCPRO3 (keymap
, key
, def
);
1139 keymap
= get_keymap (keymap
, 1, 1);
1141 CHECK_VECTOR_OR_STRING (key
);
1143 length
= XFASTINT (Flength (key
));
1145 RETURN_UNGCPRO (Qnil
);
1147 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1148 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1150 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1152 if (VECTORP (def
) && ASIZE (def
) > 0 && CONSP (AREF (def
, make_number (0))))
1153 { /* DEF is apparently an XEmacs-style keyboard macro. */
1154 Lisp_Object tmp
= Fmake_vector (make_number (ASIZE (def
)), Qnil
);
1155 int i
= ASIZE (def
);
1158 Lisp_Object c
= AREF (def
, i
);
1159 if (CONSP (c
) && lucid_event_type_list_p (c
))
1160 c
= Fevent_convert_list (c
);
1169 c
= Faref (key
, make_number (idx
));
1171 if (CONSP (c
) && lucid_event_type_list_p (c
))
1172 c
= Fevent_convert_list (c
);
1175 silly_event_symbol_error (c
);
1178 && (XINT (c
) & meta_bit
)
1181 c
= meta_prefix_char
;
1187 XSETINT (c
, XINT (c
) & ~meta_bit
);
1193 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1194 error ("Key sequence contains invalid event");
1197 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1199 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1201 /* If this key is undefined, make it a prefix. */
1203 cmd
= define_as_prefix (keymap
, c
);
1205 keymap
= get_keymap (cmd
, 0, 1);
1206 if (!CONSP (keymap
))
1207 /* We must use Fkey_description rather than just passing key to
1208 error; key might be a vector, not a string. */
1209 error ("Key sequence %s starts with non-prefix key %s",
1210 SDATA (Fkey_description (key
, Qnil
)),
1211 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1217 /* This function may GC (it calls Fkey_binding). */
1219 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1220 doc
: /* Return the remapping for command COMMAND in current keymaps.
1221 Returns nil if COMMAND is not remapped (or not a symbol). */)
1223 Lisp_Object command
;
1225 if (!SYMBOLP (command
))
1228 ASET (command_remapping_vector
, 1, command
);
1229 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1232 /* Value is number if KEY is too long; nil if valid but has no definition. */
1233 /* GC is possible in this function if it autoloads a keymap. */
1235 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1236 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1237 nil means undefined. See doc of `define-key' for kinds of definitions.
1239 A number as value means KEY is "too long";
1240 that is, characters or symbols in it except for the last one
1241 fail to be a valid sequence of prefix characters in KEYMAP.
1242 The number is how many characters at the front of KEY
1243 it takes to reach a non-prefix key.
1245 Normally, `lookup-key' ignores bindings for t, which act as default
1246 bindings, used when nothing else in the keymap applies; this makes it
1247 usable as a general function for probing keymaps. However, if the
1248 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1249 recognize the default bindings, just as `read-key-sequence' does. */)
1250 (keymap
, key
, accept_default
)
1253 Lisp_Object accept_default
;
1256 register Lisp_Object cmd
;
1257 register Lisp_Object c
;
1259 int t_ok
= !NILP (accept_default
);
1260 struct gcpro gcpro1
, gcpro2
;
1262 GCPRO2 (keymap
, key
);
1263 keymap
= get_keymap (keymap
, 1, 1);
1265 CHECK_VECTOR_OR_STRING (key
);
1267 length
= XFASTINT (Flength (key
));
1269 RETURN_UNGCPRO (keymap
);
1274 c
= Faref (key
, make_number (idx
++));
1276 if (CONSP (c
) && lucid_event_type_list_p (c
))
1277 c
= Fevent_convert_list (c
);
1279 /* Turn the 8th bit of string chars into a meta modifier. */
1280 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1281 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1283 /* Allow string since binding for `menu-bar-select-buffer'
1284 includes the buffer name in the key sequence. */
1285 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1286 error ("Key sequence contains invalid event");
1288 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1290 RETURN_UNGCPRO (cmd
);
1292 keymap
= get_keymap (cmd
, 0, 1);
1293 if (!CONSP (keymap
))
1294 RETURN_UNGCPRO (make_number (idx
));
1300 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1301 Assume that currently it does not define C at all.
1302 Return the keymap. */
1305 define_as_prefix (keymap
, c
)
1306 Lisp_Object keymap
, c
;
1310 cmd
= Fmake_sparse_keymap (Qnil
);
1311 /* If this key is defined as a prefix in an inherited keymap,
1312 make it a prefix in this map, and make its definition
1313 inherit the other prefix definition. */
1314 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1315 store_in_keymap (keymap
, c
, cmd
);
1320 /* Append a key to the end of a key sequence. We always make a vector. */
1323 append_key (key_sequence
, key
)
1324 Lisp_Object key_sequence
, key
;
1326 Lisp_Object args
[2];
1328 args
[0] = key_sequence
;
1330 args
[1] = Fcons (key
, Qnil
);
1331 return Fvconcat (2, args
);
1334 /* Given a event type C which is a symbol,
1335 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1338 silly_event_symbol_error (c
)
1341 Lisp_Object parsed
, base
, name
, assoc
;
1344 parsed
= parse_modifiers (c
);
1345 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1346 base
= XCAR (parsed
);
1347 name
= Fsymbol_name (base
);
1348 /* This alist includes elements such as ("RET" . "\\r"). */
1349 assoc
= Fassoc (name
, exclude_keys
);
1353 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1355 Lisp_Object keystring
;
1356 if (modifiers
& alt_modifier
)
1357 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1358 if (modifiers
& ctrl_modifier
)
1359 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1360 if (modifiers
& hyper_modifier
)
1361 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1362 if (modifiers
& meta_modifier
)
1363 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1364 if (modifiers
& shift_modifier
)
1365 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1366 if (modifiers
& super_modifier
)
1367 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1370 c
= reorder_modifiers (c
);
1371 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1373 error ((modifiers
& ~meta_modifier
1374 ? "To bind the key %s, use [?%s], not [%s]"
1375 : "To bind the key %s, use \"%s\", not [%s]"),
1376 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1377 SDATA (SYMBOL_NAME (c
)));
1381 /* Global, local, and minor mode keymap stuff. */
1383 /* We can't put these variables inside current_minor_maps, since under
1384 some systems, static gets macro-defined to be the empty string.
1386 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1387 static int cmm_size
= 0;
1389 /* Store a pointer to an array of the keymaps of the currently active
1390 minor modes in *buf, and return the number of maps it contains.
1392 This function always returns a pointer to the same buffer, and may
1393 free or reallocate it, so if you want to keep it for a long time or
1394 hand it out to lisp code, copy it. This procedure will be called
1395 for every key sequence read, so the nice lispy approach (return a
1396 new assoclist, list, what have you) for each invocation would
1397 result in a lot of consing over time.
1399 If we used xrealloc/xmalloc and ran out of memory, they would throw
1400 back to the command loop, which would try to read a key sequence,
1401 which would call this function again, resulting in an infinite
1402 loop. Instead, we'll use realloc/malloc and silently truncate the
1403 list, let the key sequence be read, and hope some other piece of
1404 code signals the error. */
1406 current_minor_maps (modeptr
, mapptr
)
1407 Lisp_Object
**modeptr
, **mapptr
;
1410 int list_number
= 0;
1411 Lisp_Object alist
, assoc
, var
, val
;
1412 Lisp_Object emulation_alists
;
1413 Lisp_Object lists
[2];
1415 emulation_alists
= Vemulation_mode_map_alists
;
1416 lists
[0] = Vminor_mode_overriding_map_alist
;
1417 lists
[1] = Vminor_mode_map_alist
;
1419 for (list_number
= 0; list_number
< 2; list_number
++)
1421 if (CONSP (emulation_alists
))
1423 alist
= XCAR (emulation_alists
);
1424 emulation_alists
= XCDR (emulation_alists
);
1425 if (SYMBOLP (alist
))
1426 alist
= find_symbol_value (alist
);
1430 alist
= lists
[list_number
];
1432 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1433 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1434 && (var
= XCAR (assoc
), SYMBOLP (var
))
1435 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1440 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1441 and also an entry in Vminor_mode_map_alist,
1442 ignore the latter. */
1443 if (list_number
== 1)
1445 val
= assq_no_quit (var
, lists
[0]);
1452 int newsize
, allocsize
;
1453 Lisp_Object
*newmodes
, *newmaps
;
1455 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1456 allocsize
= newsize
* sizeof *newmodes
;
1458 /* Use malloc here. See the comment above this function.
1459 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1461 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1466 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1469 cmm_modes
= newmodes
;
1472 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1477 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1484 if (newmodes
== NULL
|| newmaps
== NULL
)
1489 /* Get the keymap definition--or nil if it is not defined. */
1490 temp
= Findirect_function (XCDR (assoc
), Qt
);
1494 cmm_maps
[i
] = temp
;
1500 if (modeptr
) *modeptr
= cmm_modes
;
1501 if (mapptr
) *mapptr
= cmm_maps
;
1505 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1507 doc
: /* Return a list of the currently active keymaps.
1508 OLP if non-nil indicates that we should obey `overriding-local-map' and
1509 `overriding-terminal-local-map'. */)
1513 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1517 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1518 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1519 /* The doc said that overriding-terminal-local-map should
1520 override overriding-local-map. The code used them both,
1521 but it seems clearer to use just one. rms, jan 2005. */
1522 else if (!NILP (Voverriding_local_map
))
1523 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1525 if (NILP (XCDR (keymaps
)))
1531 /* This usually returns the buffer's local map,
1532 but that can be overridden by a `local-map' property. */
1533 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1535 keymaps
= Fcons (local
, keymaps
);
1537 /* Now put all the minor mode keymaps on the list. */
1538 nmaps
= current_minor_maps (0, &maps
);
1540 for (i
= --nmaps
; i
>= 0; i
--)
1541 if (!NILP (maps
[i
]))
1542 keymaps
= Fcons (maps
[i
], keymaps
);
1544 /* This returns nil unless there is a `keymap' property. */
1545 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1547 keymaps
= Fcons (local
, keymaps
);
1553 /* GC is possible in this function if it autoloads a keymap. */
1555 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1556 doc
: /* Return the binding for command KEY in current keymaps.
1557 KEY is a string or vector, a sequence of keystrokes.
1558 The binding is probably a symbol with a function definition.
1560 Normally, `key-binding' ignores bindings for t, which act as default
1561 bindings, used when nothing else in the keymap applies; this makes it
1562 usable as a general function for probing keymaps. However, if the
1563 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1564 recognize the default bindings, just as `read-key-sequence' does.
1566 Like the normal command loop, `key-binding' will remap the command
1567 resulting from looking up KEY by looking up the command in the
1568 current keymaps. However, if the optional third argument NO-REMAP
1569 is non-nil, `key-binding' returns the unmapped command. */)
1570 (key
, accept_default
, no_remap
)
1571 Lisp_Object key
, accept_default
, no_remap
;
1573 Lisp_Object
*maps
, value
;
1575 struct gcpro gcpro1
;
1580 if (VECTORP (key
) && ASIZE (key
) > 0)
1582 Lisp_Object ev
, pos
;
1583 if ((ev
= AREF (key
, 0), CONSP (ev
))
1584 && SYMBOLP (XCAR (ev
))
1585 && CONSP (XCDR (ev
))
1586 && (pos
= XCAR (XCDR (ev
)), CONSP (pos
))
1587 && XINT (Flength (pos
)) == 10
1588 && INTEGERP (XCAR (XCDR (pos
))))
1590 Lisp_Object map
, obj
;
1591 obj
= Fnth (make_number(4), pos
);
1592 map
= Fget_char_property (XCAR (XCDR (pos
)),
1595 Fwindow_buffer (XCAR (pos
))
1597 if (!NILP (Fkeymapp (map
)))
1599 value
= Flookup_key (map
, key
, accept_default
);
1600 if (! NILP (value
) && !INTEGERP (value
))
1605 #endif /* HAVE_MOUSE */
1607 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1609 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1610 key
, accept_default
);
1611 if (! NILP (value
) && !INTEGERP (value
))
1614 else if (!NILP (Voverriding_local_map
))
1616 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1617 if (! NILP (value
) && !INTEGERP (value
))
1624 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1627 value
= Flookup_key (local
, key
, accept_default
);
1628 if (! NILP (value
) && !INTEGERP (value
))
1632 nmaps
= current_minor_maps (0, &maps
);
1633 /* Note that all these maps are GCPRO'd
1634 in the places where we found them. */
1636 for (i
= 0; i
< nmaps
; i
++)
1637 if (! NILP (maps
[i
]))
1639 value
= Flookup_key (maps
[i
], key
, accept_default
);
1640 if (! NILP (value
) && !INTEGERP (value
))
1644 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1647 value
= Flookup_key (local
, key
, accept_default
);
1648 if (! NILP (value
) && !INTEGERP (value
))
1653 value
= Flookup_key (current_global_map
, key
, accept_default
);
1657 if (NILP (value
) || INTEGERP (value
))
1660 /* If the result of the ordinary keymap lookup is an interactive
1661 command, look for a key binding (ie. remapping) for that command. */
1663 if (NILP (no_remap
) && SYMBOLP (value
))
1666 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1673 /* GC is possible in this function if it autoloads a keymap. */
1675 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1676 doc
: /* Return the binding for command KEYS in current local keymap only.
1677 KEYS is a string or vector, a sequence of keystrokes.
1678 The binding is probably a symbol with a function definition.
1680 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1681 bindings; see the description of `lookup-key' for more details about this. */)
1682 (keys
, accept_default
)
1683 Lisp_Object keys
, accept_default
;
1685 register Lisp_Object map
;
1686 map
= current_buffer
->keymap
;
1689 return Flookup_key (map
, keys
, accept_default
);
1692 /* GC is possible in this function if it autoloads a keymap. */
1694 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1695 doc
: /* Return the binding for command KEYS in current global keymap only.
1696 KEYS is a string or vector, a sequence of keystrokes.
1697 The binding is probably a symbol with a function definition.
1698 This function's return values are the same as those of `lookup-key'
1701 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1702 bindings; see the description of `lookup-key' for more details about this. */)
1703 (keys
, accept_default
)
1704 Lisp_Object keys
, accept_default
;
1706 return Flookup_key (current_global_map
, keys
, accept_default
);
1709 /* GC is possible in this function if it autoloads a keymap. */
1711 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1712 doc
: /* Find the visible minor mode bindings of KEY.
1713 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1714 the symbol which names the minor mode binding KEY, and BINDING is
1715 KEY's definition in that mode. In particular, if KEY has no
1716 minor-mode bindings, return nil. If the first binding is a
1717 non-prefix, all subsequent bindings will be omitted, since they would
1718 be ignored. Similarly, the list doesn't include non-prefix bindings
1719 that come after prefix bindings.
1721 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1722 bindings; see the description of `lookup-key' for more details about this. */)
1723 (key
, accept_default
)
1724 Lisp_Object key
, accept_default
;
1726 Lisp_Object
*modes
, *maps
;
1728 Lisp_Object binding
;
1730 struct gcpro gcpro1
, gcpro2
;
1732 nmaps
= current_minor_maps (&modes
, &maps
);
1733 /* Note that all these maps are GCPRO'd
1734 in the places where we found them. */
1737 GCPRO2 (key
, binding
);
1739 for (i
= j
= 0; i
< nmaps
; i
++)
1741 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1742 && !INTEGERP (binding
))
1744 if (KEYMAPP (binding
))
1745 maps
[j
++] = Fcons (modes
[i
], binding
);
1747 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1751 return Flist (j
, maps
);
1754 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1755 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1756 A new sparse keymap is stored as COMMAND's function definition and its value.
1757 If a second optional argument MAPVAR is given, the map is stored as
1758 its value instead of as COMMAND's value; but COMMAND is still defined
1760 The third optional argument NAME, if given, supplies a menu name
1761 string for the map. This is required to use the keymap as a menu.
1762 This function returns COMMAND. */)
1763 (command
, mapvar
, name
)
1764 Lisp_Object command
, mapvar
, name
;
1767 map
= Fmake_sparse_keymap (name
);
1768 Ffset (command
, map
);
1772 Fset (command
, map
);
1776 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1777 doc
: /* Select KEYMAP as the global keymap. */)
1781 keymap
= get_keymap (keymap
, 1, 1);
1782 current_global_map
= keymap
;
1787 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1788 doc
: /* Select KEYMAP as the local keymap.
1789 If KEYMAP is nil, that means no local keymap. */)
1794 keymap
= get_keymap (keymap
, 1, 1);
1796 current_buffer
->keymap
= keymap
;
1801 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1802 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1805 return current_buffer
->keymap
;
1808 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1809 doc
: /* Return the current global keymap. */)
1812 return current_global_map
;
1815 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1816 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1820 int nmaps
= current_minor_maps (0, &maps
);
1822 return Flist (nmaps
, maps
);
1825 /* Help functions for describing and documenting keymaps. */
1829 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1830 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1831 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1835 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1839 /* Look for and break cycles. */
1840 while (!NILP (tem
= Frassq (cmd
, maps
)))
1842 Lisp_Object prefix
= XCAR (tem
);
1843 int lim
= XINT (Flength (XCAR (tem
)));
1844 if (lim
<= XINT (Flength (thisseq
)))
1845 { /* This keymap was already seen with a smaller prefix. */
1847 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1848 Faref (thisseq
, make_number (i
))))
1851 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1854 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1855 but maybe `cmd' occurs again further down in `maps', so keep
1857 maps
= XCDR (Fmemq (tem
, maps
));
1860 /* If the last key in thisseq is meta-prefix-char,
1861 turn it into a meta-ized keystroke. We know
1862 that the event we're about to append is an
1863 ascii keystroke since we're processing a
1867 int meta_bit
= meta_modifier
;
1868 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1869 tem
= Fcopy_sequence (thisseq
);
1871 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1873 /* This new sequence is the same length as
1874 thisseq, so stick it in the list right
1877 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1881 tem
= append_key (thisseq
, key
);
1882 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1887 accessible_keymaps_char_table (args
, index
, cmd
)
1888 Lisp_Object args
, index
, cmd
;
1890 accessible_keymaps_1 (index
, cmd
,
1894 XINT (XCDR (XCAR (args
))));
1897 /* This function cannot GC. */
1899 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1901 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1902 Returns a list of elements of the form (KEYS . MAP), where the sequence
1903 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1904 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1905 An optional argument PREFIX, if non-nil, should be a key sequence;
1906 then the value includes only maps for prefixes that start with PREFIX. */)
1908 Lisp_Object keymap
, prefix
;
1910 Lisp_Object maps
, tail
;
1913 /* no need for gcpro because we don't autoload any keymaps. */
1916 prefixlen
= XINT (Flength (prefix
));
1920 /* If a prefix was specified, start with the keymap (if any) for
1921 that prefix, so we don't waste time considering other prefixes. */
1923 tem
= Flookup_key (keymap
, prefix
, Qt
);
1924 /* Flookup_key may give us nil, or a number,
1925 if the prefix is not defined in this particular map.
1926 It might even give us a list that isn't a keymap. */
1927 tem
= get_keymap (tem
, 0, 0);
1930 /* Convert PREFIX to a vector now, so that later on
1931 we don't have to deal with the possibility of a string. */
1932 if (STRINGP (prefix
))
1937 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1938 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1942 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1943 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1944 c
^= 0200 | meta_modifier
;
1945 ASET (copy
, i_before
, make_number (c
));
1949 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1955 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1956 get_keymap (keymap
, 1, 0)),
1959 /* For each map in the list maps,
1960 look at any other maps it points to,
1961 and stick them at the end if they are not already in the list.
1963 This is a breadth-first traversal, where tail is the queue of
1964 nodes, and maps accumulates a list of all nodes visited. */
1966 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1968 register Lisp_Object thisseq
, thismap
;
1970 /* Does the current sequence end in the meta-prefix-char? */
1973 thisseq
= Fcar (Fcar (tail
));
1974 thismap
= Fcdr (Fcar (tail
));
1975 last
= make_number (XINT (Flength (thisseq
)) - 1);
1976 is_metized
= (XINT (last
) >= 0
1977 /* Don't metize the last char of PREFIX. */
1978 && XINT (last
) >= prefixlen
1979 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1981 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1985 elt
= XCAR (thismap
);
1989 if (CHAR_TABLE_P (elt
))
1991 Lisp_Object indices
[3];
1993 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
1994 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1995 Fcons (tail
, thisseq
)),
1998 else if (VECTORP (elt
))
2002 /* Vector keymap. Scan all the elements. */
2003 for (i
= 0; i
< ASIZE (elt
); i
++)
2004 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
2005 maps
, tail
, thisseq
, is_metized
);
2008 else if (CONSP (elt
))
2009 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
2010 maps
, tail
, thisseq
,
2011 is_metized
&& INTEGERP (XCAR (elt
)));
2019 Lisp_Object Qsingle_key_description
, Qkey_description
;
2021 /* This function cannot GC. */
2023 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2024 doc
: /* Return a pretty description of key-sequence KEYS.
2025 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2026 Control characters turn into "C-foo" sequences, meta into "M-foo",
2027 spaces are put between sequence elements, etc. */)
2029 Lisp_Object keys
, prefix
;
2034 int size
= XINT (Flength (keys
));
2036 Lisp_Object sep
= build_string (" ");
2041 size
+= XINT (Flength (prefix
));
2043 /* This has one extra element at the end that we don't pass to Fconcat. */
2044 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2046 /* In effect, this computes
2047 (mapconcat 'single-key-description keys " ")
2048 but we shouldn't use mapconcat because it can do GC. */
2052 list
= prefix
, prefix
= Qnil
;
2053 else if (!NILP (keys
))
2054 list
= keys
, keys
= Qnil
;
2059 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2063 return empty_string
;
2064 return Fconcat (len
- 1, args
);
2068 size
= SCHARS (list
);
2069 else if (VECTORP (list
))
2070 size
= XVECTOR (list
)->size
;
2071 else if (CONSP (list
))
2072 size
= XINT (Flength (list
));
2074 wrong_type_argument (Qarrayp
, list
);
2083 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2084 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2085 c
^= 0200 | meta_modifier
;
2086 XSETFASTINT (key
, c
);
2088 else if (VECTORP (list
))
2090 key
= AREF (list
, i
++);
2102 || EQ (key
, meta_prefix_char
)
2103 || (XINT (key
) & meta_modifier
))
2105 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2107 if (EQ (key
, meta_prefix_char
))
2111 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2114 else if (EQ (key
, meta_prefix_char
))
2119 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2127 push_key_description (c
, p
, force_multibyte
)
2128 register unsigned int c
;
2130 int force_multibyte
;
2135 /* Clear all the meaningless bits above the meta bit. */
2136 c
&= meta_modifier
| ~ - meta_modifier
;
2137 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2138 | meta_modifier
| shift_modifier
| super_modifier
);
2140 valid_p
= SINGLE_BYTE_CHAR_P (c2
) || char_valid_p (c2
, 0);
2143 /* KEY_DESCRIPTION_SIZE is large enough for this. */
2144 p
+= sprintf (p
, "[%d]", c
);
2148 if (c
& alt_modifier
)
2154 if ((c
& ctrl_modifier
) != 0
2155 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2159 c
&= ~ctrl_modifier
;
2161 if (c
& hyper_modifier
)
2165 c
-= hyper_modifier
;
2167 if (c
& meta_modifier
)
2173 if (c
& shift_modifier
)
2177 c
-= shift_modifier
;
2179 if (c
& super_modifier
)
2183 c
-= super_modifier
;
2199 else if (c
== Ctl ('M'))
2207 /* `C-' already added above. */
2208 if (c
> 0 && c
<= Ctl ('Z'))
2227 || (NILP (current_buffer
->enable_multibyte_characters
)
2228 && SINGLE_BYTE_CHAR_P (c
)
2229 && !force_multibyte
))
2235 if (force_multibyte
)
2237 if (SINGLE_BYTE_CHAR_P (c
))
2238 c
= unibyte_char_to_multibyte (c
);
2239 p
+= CHAR_STRING (c
, p
);
2241 else if (NILP (current_buffer
->enable_multibyte_characters
))
2245 /* The biggest character code uses 19 bits. */
2246 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2248 if (c
>= (1 << bit_offset
))
2249 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2253 p
+= CHAR_STRING (c
, p
);
2259 /* This function cannot GC. */
2261 DEFUN ("single-key-description", Fsingle_key_description
,
2262 Ssingle_key_description
, 1, 2, 0,
2263 doc
: /* Return a pretty description of command character KEY.
2264 Control characters turn into C-whatever, etc.
2265 Optional argument NO-ANGLES non-nil means don't put angle brackets
2266 around function keys and event symbols. */)
2268 Lisp_Object key
, no_angles
;
2270 if (CONSP (key
) && lucid_event_type_list_p (key
))
2271 key
= Fevent_convert_list (key
);
2273 key
= EVENT_HEAD (key
);
2275 if (INTEGERP (key
)) /* Normal character */
2277 unsigned int charset
, c1
, c2
;
2278 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2280 if (SINGLE_BYTE_CHAR_P (without_bits
))
2283 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2286 && CHARSET_DEFINED_P (charset
)
2287 && ((c1
>= 0 && c1
< 32)
2288 || (c2
>= 0 && c2
< 32)))
2290 /* Handle a generic character. */
2292 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
2293 CHECK_STRING (name
);
2294 return concat2 (build_string ("Character set "), name
);
2298 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2302 end
= push_key_description (XUINT (key
), tem
, 1);
2304 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2305 if (nchars
== nbytes
)
2308 string
= build_string (tem
);
2311 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2315 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2317 if (NILP (no_angles
))
2320 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2321 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2322 return build_string (buffer
);
2325 return Fsymbol_name (key
);
2327 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2328 return Fcopy_sequence (key
);
2330 error ("KEY must be an integer, cons, symbol, or string");
2335 push_text_char_description (c
, p
)
2336 register unsigned int c
;
2348 *p
++ = c
+ 64; /* 'A' - 1 */
2360 /* This function cannot GC. */
2362 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2363 doc
: /* Return a pretty description of file-character CHARACTER.
2364 Control characters turn into "^char", etc. This differs from
2365 `single-key-description' which turns them into "C-char".
2366 Also, this function recognizes the 2**7 bit as the Meta character,
2367 whereas `single-key-description' uses the 2**27 bit for Meta.
2368 See Info node `(elisp)Describing Characters' for examples. */)
2370 Lisp_Object character
;
2372 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2373 unsigned char str
[6];
2376 CHECK_NUMBER (character
);
2378 c
= XINT (character
);
2379 if (!SINGLE_BYTE_CHAR_P (c
))
2381 int len
= CHAR_STRING (c
, str
);
2383 return make_multibyte_string (str
, 1, len
);
2386 *push_text_char_description (c
& 0377, str
) = 0;
2388 return build_string (str
);
2391 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2394 ascii_sequence_p (seq
)
2398 int len
= XINT (Flength (seq
));
2400 for (i
= 0; i
< len
; i
++)
2402 Lisp_Object ii
, elt
;
2404 XSETFASTINT (ii
, i
);
2405 elt
= Faref (seq
, ii
);
2408 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2416 /* where-is - finding a command in a set of keymaps. */
2418 static Lisp_Object
where_is_internal ();
2419 static Lisp_Object
where_is_internal_1 ();
2420 static void where_is_internal_2 ();
2422 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2423 Returns the first non-nil binding found in any of those maps. */
2426 shadow_lookup (shadow
, key
, flag
)
2427 Lisp_Object shadow
, key
, flag
;
2429 Lisp_Object tail
, value
;
2431 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2433 value
= Flookup_key (XCAR (tail
), key
, flag
);
2434 if (NATNUMP (value
))
2436 value
= Flookup_key (XCAR (tail
),
2437 Fsubstring (key
, make_number (0), value
), flag
);
2441 else if (!NILP (value
))
2447 static Lisp_Object Vmouse_events
;
2449 /* This function can GC if Flookup_key autoloads any keymaps. */
2452 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2453 Lisp_Object definition
, keymaps
;
2454 Lisp_Object firstonly
, noindirect
, no_remap
;
2456 Lisp_Object maps
= Qnil
;
2457 Lisp_Object found
, sequences
;
2458 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2459 /* 1 means ignore all menu bindings entirely. */
2460 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2462 /* If this command is remapped, then it has no key bindings
2464 if (NILP (no_remap
) && SYMBOLP (definition
))
2467 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2472 while (CONSP (found
))
2476 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2477 found
= XCDR (found
);
2480 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2484 for (; !NILP (maps
); maps
= Fcdr (maps
))
2486 /* Key sequence to reach map, and the map that it reaches */
2487 register Lisp_Object
this, map
, tem
;
2489 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2490 [M-CHAR] sequences, check if last character of the sequence
2491 is the meta-prefix char. */
2495 this = Fcar (Fcar (maps
));
2496 map
= Fcdr (Fcar (maps
));
2497 last
= make_number (XINT (Flength (this)) - 1);
2498 last_is_meta
= (XINT (last
) >= 0
2499 && EQ (Faref (this, last
), meta_prefix_char
));
2501 /* if (nomenus && !ascii_sequence_p (this)) */
2502 if (nomenus
&& XINT (last
) >= 0
2503 && SYMBOLP (tem
= Faref (this, make_number (0)))
2504 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2505 /* If no menu entries should be returned, skip over the
2506 keymaps bound to `menu-bar' and `tool-bar' and other
2507 non-ascii prefixes like `C-down-mouse-2'. */
2514 /* Because the code we want to run on each binding is rather
2515 large, we don't want to have two separate loop bodies for
2516 sparse keymap bindings and tables; we want to iterate one
2517 loop body over both keymap and vector bindings.
2519 For this reason, if Fcar (map) is a vector, we don't
2520 advance map to the next element until i indicates that we
2521 have finished off the vector. */
2522 Lisp_Object elt
, key
, binding
;
2530 /* Set key and binding to the current key and binding, and
2531 advance map and i to the next binding. */
2534 Lisp_Object sequence
;
2536 /* In a vector, look at each element. */
2537 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2539 binding
= AREF (elt
, i
);
2540 XSETFASTINT (key
, i
);
2541 sequence
= where_is_internal_1 (binding
, key
, definition
,
2543 last
, nomenus
, last_is_meta
);
2544 if (!NILP (sequence
))
2545 sequences
= Fcons (sequence
, sequences
);
2548 else if (CHAR_TABLE_P (elt
))
2550 Lisp_Object indices
[3];
2553 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2554 Qnil
), /* Result accumulator. */
2555 Fcons (Fcons (this, last
),
2556 Fcons (make_number (nomenus
),
2557 make_number (last_is_meta
))));
2558 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2560 sequences
= XCDR (XCAR (args
));
2562 else if (CONSP (elt
))
2564 Lisp_Object sequence
;
2567 binding
= XCDR (elt
);
2569 sequence
= where_is_internal_1 (binding
, key
, definition
,
2571 last
, nomenus
, last_is_meta
);
2572 if (!NILP (sequence
))
2573 sequences
= Fcons (sequence
, sequences
);
2577 while (!NILP (sequences
))
2579 Lisp_Object sequence
, remapped
, function
;
2581 sequence
= XCAR (sequences
);
2582 sequences
= XCDR (sequences
);
2584 /* If the current sequence is a command remapping with
2585 format [remap COMMAND], find the key sequences
2586 which run COMMAND, and use those sequences instead. */
2589 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2590 && EQ (AREF (sequence
, 0), Qremap
)
2591 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2593 Lisp_Object remapped1
;
2595 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2596 if (CONSP (remapped1
))
2598 /* Verify that this key binding actually maps to the
2599 remapped command (see below). */
2600 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2602 sequence
= XCAR (remapped1
);
2603 remapped
= XCDR (remapped1
);
2604 goto record_sequence
;
2608 /* Verify that this key binding is not shadowed by another
2609 binding for the same key, before we say it exists.
2611 Mechanism: look for local definition of this key and if
2612 it is defined and does not match what we found then
2615 Either nil or number as value from Flookup_key
2617 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2621 /* Don't annoy user with strings from a menu such as
2622 Select Paste. Change them all to "(any string)",
2623 so that there seems to be only one menu item
2625 if (! NILP (sequence
))
2628 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2630 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2631 build_string ("(any string)"));
2634 /* It is a true unshadowed match. Record it, unless it's already
2635 been seen (as could happen when inheriting keymaps). */
2636 if (NILP (Fmember (sequence
, found
)))
2637 found
= Fcons (sequence
, found
);
2639 /* If firstonly is Qnon_ascii, then we can return the first
2640 binding we find. If firstonly is not Qnon_ascii but not
2641 nil, then we should return the first ascii-only binding
2643 if (EQ (firstonly
, Qnon_ascii
))
2644 RETURN_UNGCPRO (sequence
);
2645 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2646 RETURN_UNGCPRO (sequence
);
2648 if (CONSP (remapped
))
2650 sequence
= XCAR (remapped
);
2651 remapped
= XCDR (remapped
);
2652 goto record_sequence
;
2660 found
= Fnreverse (found
);
2662 /* firstonly may have been t, but we may have gone all the way through
2663 the keymaps without finding an all-ASCII key sequence. So just
2664 return the best we could find. */
2665 if (!NILP (firstonly
))
2666 return Fcar (found
);
2671 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2672 doc
: /* Return list of keys that invoke DEFINITION.
2673 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2674 If KEYMAP is nil, search all the currently active keymaps.
2675 If KEYMAP is a list of keymaps, search only those keymaps.
2677 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2678 rather than a list of all possible key sequences.
2679 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2680 no matter what it is.
2681 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2682 \(or their meta variants) and entirely reject menu bindings.
2684 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2685 to other keymaps or slots. This makes it possible to search for an
2686 indirect definition itself.
2688 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2689 that invoke a command which is remapped to DEFINITION, but include the
2690 remapped command in the returned list. */)
2691 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2692 Lisp_Object definition
, keymap
;
2693 Lisp_Object firstonly
, noindirect
, no_remap
;
2695 Lisp_Object sequences
, keymaps
;
2696 /* 1 means ignore all menu bindings entirely. */
2697 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2700 /* Find the relevant keymaps. */
2701 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2703 else if (!NILP (keymap
))
2704 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2706 keymaps
= Fcurrent_active_maps (Qnil
);
2708 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2709 We don't really need to check `keymap'. */
2710 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2714 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2716 /* Check heuristic-consistency of the cache. */
2717 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2718 where_is_cache
= Qnil
;
2720 if (NILP (where_is_cache
))
2722 /* We need to create the cache. */
2723 Lisp_Object args
[2];
2724 where_is_cache
= Fmake_hash_table (0, args
);
2725 where_is_cache_keymaps
= Qt
;
2727 /* Fill in the cache. */
2728 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2729 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2732 where_is_cache_keymaps
= keymaps
;
2735 /* We want to process definitions from the last to the first.
2736 Instead of consing, copy definitions to a vector and step
2737 over that vector. */
2738 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2739 n
= XINT (Flength (sequences
));
2740 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2741 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2742 defns
[i
++] = XCAR (sequences
);
2744 /* Verify that the key bindings are not shadowed. Note that
2745 the following can GC. */
2746 GCPRO2 (definition
, keymaps
);
2749 for (i
= n
- 1; i
>= 0; --i
)
2750 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2752 if (ascii_sequence_p (defns
[i
]))
2758 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2763 /* Kill the cache so that where_is_internal_1 doesn't think
2764 we're filling it up. */
2765 where_is_cache
= Qnil
;
2766 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2772 /* This is the function that Fwhere_is_internal calls using map_char_table.
2774 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2776 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2777 Since map_char_table doesn't really use the return value from this function,
2778 we the result append to RESULT, the slot in ARGS.
2780 This function can GC because it calls where_is_internal_1 which can
2784 where_is_internal_2 (args
, key
, binding
)
2785 Lisp_Object args
, key
, binding
;
2787 Lisp_Object definition
, noindirect
, this, last
;
2788 Lisp_Object result
, sequence
;
2789 int nomenus
, last_is_meta
;
2790 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2792 GCPRO3 (args
, key
, binding
);
2793 result
= XCDR (XCAR (args
));
2794 definition
= XCAR (XCAR (XCAR (args
)));
2795 noindirect
= XCDR (XCAR (XCAR (args
)));
2796 this = XCAR (XCAR (XCDR (args
)));
2797 last
= XCDR (XCAR (XCDR (args
)));
2798 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2799 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2801 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2802 this, last
, nomenus
, last_is_meta
);
2804 if (!NILP (sequence
))
2805 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2811 /* This function can GC because get_keyelt can. */
2814 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2815 nomenus
, last_is_meta
)
2816 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2817 int nomenus
, last_is_meta
;
2819 Lisp_Object sequence
;
2821 /* Search through indirections unless that's not wanted. */
2822 if (NILP (noindirect
))
2823 binding
= get_keyelt (binding
, 0);
2825 /* End this iteration if this element does not match
2828 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2829 || EQ (binding
, definition
)
2830 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2831 /* Doesn't match. */
2834 /* We have found a match. Construct the key sequence where we found it. */
2835 if (INTEGERP (key
) && last_is_meta
)
2837 sequence
= Fcopy_sequence (this);
2838 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2841 sequence
= append_key (this, key
);
2843 if (!NILP (where_is_cache
))
2845 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2846 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2853 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2855 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2856 doc
: /* Insert the list of all defined keys and their definitions.
2857 The list is inserted in the current buffer, while the bindings are
2858 looked up in BUFFER.
2859 The optional argument PREFIX, if non-nil, should be a key sequence;
2860 then we display only bindings that start with that prefix.
2861 The optional argument MENUS, if non-nil, says to mention menu bindings.
2862 \(Ordinarily these are omitted from the output.) */)
2863 (buffer
, prefix
, menus
)
2864 Lisp_Object buffer
, prefix
, menus
;
2866 Lisp_Object outbuf
, shadow
;
2867 int nomenu
= NILP (menus
);
2868 register Lisp_Object start1
;
2869 struct gcpro gcpro1
;
2871 char *alternate_heading
2873 Keyboard translations:\n\n\
2874 You type Translation\n\
2875 -------- -----------\n";
2880 outbuf
= Fcurrent_buffer ();
2882 /* Report on alternates for keys. */
2883 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2886 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2887 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2889 for (c
= 0; c
< translate_len
; c
++)
2890 if (translate
[c
] != c
)
2892 char buf
[KEY_DESCRIPTION_SIZE
];
2895 if (alternate_heading
)
2897 insert_string (alternate_heading
);
2898 alternate_heading
= 0;
2901 bufend
= push_key_description (translate
[c
], buf
, 1);
2902 insert (buf
, bufend
- buf
);
2903 Findent_to (make_number (16), make_number (1));
2904 bufend
= push_key_description (c
, buf
, 1);
2905 insert (buf
, bufend
- buf
);
2909 /* Insert calls signal_after_change which may GC. */
2910 translate
= SDATA (Vkeyboard_translate_table
);
2916 if (!NILP (Vkey_translation_map
))
2917 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2918 "Key translations", nomenu
, 1, 0, 0);
2921 /* Print the (major mode) local map. */
2923 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2924 start1
= current_kboard
->Voverriding_terminal_local_map
;
2925 else if (!NILP (Voverriding_local_map
))
2926 start1
= Voverriding_local_map
;
2930 describe_map_tree (start1
, 1, shadow
, prefix
,
2931 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2932 shadow
= Fcons (start1
, shadow
);
2936 /* Print the minor mode and major mode keymaps. */
2938 Lisp_Object
*modes
, *maps
;
2940 /* Temporarily switch to `buffer', so that we can get that buffer's
2941 minor modes correctly. */
2942 Fset_buffer (buffer
);
2944 nmaps
= current_minor_maps (&modes
, &maps
);
2945 Fset_buffer (outbuf
);
2947 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2948 XBUFFER (buffer
), Qkeymap
);
2951 describe_map_tree (start1
, 1, shadow
, prefix
,
2952 "\f\n`keymap' Property Bindings", nomenu
,
2954 shadow
= Fcons (start1
, shadow
);
2957 /* Print the minor mode maps. */
2958 for (i
= 0; i
< nmaps
; i
++)
2960 /* The title for a minor mode keymap
2961 is constructed at run time.
2962 We let describe_map_tree do the actual insertion
2963 because it takes care of other features when doing so. */
2966 if (!SYMBOLP (modes
[i
]))
2969 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2973 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2974 SCHARS (SYMBOL_NAME (modes
[i
])));
2975 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2977 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2978 p
+= sizeof (" Minor Mode Bindings") - 1;
2981 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2982 title
, nomenu
, 0, 0, 0);
2983 shadow
= Fcons (maps
[i
], shadow
);
2986 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2987 XBUFFER (buffer
), Qlocal_map
);
2990 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2991 describe_map_tree (start1
, 1, shadow
, prefix
,
2992 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2994 describe_map_tree (start1
, 1, shadow
, prefix
,
2995 "\f\n`local-map' Property Bindings",
2998 shadow
= Fcons (start1
, shadow
);
3002 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
3003 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
3005 /* Print the function-key-map translations under this prefix. */
3006 if (!NILP (Vfunction_key_map
))
3007 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
3008 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
3014 /* Insert a description of the key bindings in STARTMAP,
3015 followed by those of all maps reachable through STARTMAP.
3016 If PARTIAL is nonzero, omit certain "uninteresting" commands
3017 (such as `undefined').
3018 If SHADOW is non-nil, it is a list of maps;
3019 don't mention keys which would be shadowed by any of them.
3020 PREFIX, if non-nil, says mention only keys that start with PREFIX.
3021 TITLE, if not 0, is a string to insert at the beginning.
3022 TITLE should not end with a colon or a newline; we supply that.
3023 If NOMENU is not 0, then omit menu-bar commands.
3025 If TRANSL is nonzero, the definitions are actually key translations
3026 so print strings and vectors differently.
3028 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
3031 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
3032 don't omit it; instead, mention it but say it is shadowed. */
3035 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
3036 always_title
, mention_shadow
)
3037 Lisp_Object startmap
, shadow
, prefix
;
3045 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
3046 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3053 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3056 GCPRO3 (maps
, seen
, sub_shadows
);
3062 /* Delete from MAPS each element that is for the menu bar. */
3063 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3065 Lisp_Object elt
, prefix
, tem
;
3068 prefix
= Fcar (elt
);
3069 if (XVECTOR (prefix
)->size
>= 1)
3071 tem
= Faref (prefix
, make_number (0));
3072 if (EQ (tem
, Qmenu_bar
))
3073 maps
= Fdelq (elt
, maps
);
3078 if (!NILP (maps
) || always_title
)
3082 insert_string (title
);
3085 insert_string (" Starting With ");
3086 insert1 (Fkey_description (prefix
, Qnil
));
3088 insert_string (":\n");
3090 insert_string (key_heading
);
3094 for (; !NILP (maps
); maps
= Fcdr (maps
))
3096 register Lisp_Object elt
, prefix
, tail
;
3099 prefix
= Fcar (elt
);
3103 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3107 shmap
= XCAR (tail
);
3109 /* If the sequence by which we reach this keymap is zero-length,
3110 then the shadow map for this keymap is just SHADOW. */
3111 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3112 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3114 /* If the sequence by which we reach this keymap actually has
3115 some elements, then the sequence's definition in SHADOW is
3116 what we should use. */
3119 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3120 if (INTEGERP (shmap
))
3124 /* If shmap is not nil and not a keymap,
3125 it completely shadows this map, so don't
3126 describe this map at all. */
3127 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3131 sub_shadows
= Fcons (shmap
, sub_shadows
);
3134 /* Maps we have already listed in this loop shadow this map. */
3135 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3138 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3140 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3143 describe_map (Fcdr (elt
), prefix
,
3144 transl
? describe_translation
: describe_command
,
3145 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3151 insert_string ("\n");
3156 static int previous_description_column
;
3159 describe_command (definition
, args
)
3160 Lisp_Object definition
, args
;
3162 register Lisp_Object tem1
;
3163 int column
= (int) current_column (); /* iftc */
3164 int description_column
;
3166 /* If column 16 is no good, go to col 32;
3167 but don't push beyond that--go to next line instead. */
3171 description_column
= 32;
3173 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3174 description_column
= 32;
3176 description_column
= 16;
3178 Findent_to (make_number (description_column
), make_number (1));
3179 previous_description_column
= description_column
;
3181 if (SYMBOLP (definition
))
3183 tem1
= SYMBOL_NAME (definition
);
3185 insert_string ("\n");
3187 else if (STRINGP (definition
) || VECTORP (definition
))
3188 insert_string ("Keyboard Macro\n");
3189 else if (KEYMAPP (definition
))
3190 insert_string ("Prefix Command\n");
3192 insert_string ("??\n");
3196 describe_translation (definition
, args
)
3197 Lisp_Object definition
, args
;
3199 register Lisp_Object tem1
;
3201 Findent_to (make_number (16), make_number (1));
3203 if (SYMBOLP (definition
))
3205 tem1
= SYMBOL_NAME (definition
);
3207 insert_string ("\n");
3209 else if (STRINGP (definition
) || VECTORP (definition
))
3211 insert1 (Fkey_description (definition
, Qnil
));
3212 insert_string ("\n");
3214 else if (KEYMAPP (definition
))
3215 insert_string ("Prefix Command\n");
3217 insert_string ("??\n");
3220 /* describe_map puts all the usable elements of a sparse keymap
3221 into an array of `struct describe_map_elt',
3222 then sorts them by the events. */
3224 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3226 /* qsort comparison function for sorting `struct describe_map_elt' by
3230 describe_map_compare (aa
, bb
)
3231 const void *aa
, *bb
;
3233 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3234 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3235 return ((XINT (a
->event
) > XINT (b
->event
))
3236 - (XINT (a
->event
) < XINT (b
->event
)));
3237 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3239 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3241 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3242 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3243 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3248 /* Describe the contents of map MAP, assuming that this map itself is
3249 reached by the sequence of prefix keys PREFIX (a string or vector).
3250 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3253 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3254 seen
, nomenu
, mention_shadow
)
3255 register Lisp_Object map
;
3257 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3264 Lisp_Object tail
, definition
, event
;
3266 Lisp_Object suppress
;
3269 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3271 /* These accumulate the values from sparse keymap bindings,
3272 so we can sort them and handle them in order. */
3273 int length_needed
= 0;
3274 struct describe_map_elt
*vect
;
3281 suppress
= intern ("suppress-keymap");
3283 /* This vector gets used to present single keys to Flookup_key. Since
3284 that is done once per keymap element, we don't want to cons up a
3285 fresh vector every time. */
3286 kludge
= Fmake_vector (make_number (1), Qnil
);
3289 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3292 vect
= ((struct describe_map_elt
*)
3293 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3295 GCPRO3 (prefix
, definition
, kludge
);
3297 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3301 if (VECTORP (XCAR (tail
))
3302 || CHAR_TABLE_P (XCAR (tail
)))
3303 describe_vector (XCAR (tail
),
3304 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3305 (int *)0, 0, 1, mention_shadow
);
3306 else if (CONSP (XCAR (tail
)))
3308 int this_shadowed
= 0;
3310 event
= XCAR (XCAR (tail
));
3312 /* Ignore bindings whose "prefix" are not really valid events.
3313 (We get these in the frames and buffers menu.) */
3314 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3317 if (nomenu
&& EQ (event
, Qmenu_bar
))
3320 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3322 /* Don't show undefined commands or suppressed commands. */
3323 if (NILP (definition
)) continue;
3324 if (SYMBOLP (definition
) && partial
)
3326 tem
= Fget (definition
, suppress
);
3331 /* Don't show a command that isn't really visible
3332 because a local definition of the same key shadows it. */
3334 ASET (kludge
, 0, event
);
3337 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3340 /* Avoid generating duplicate entries if the
3341 shadowed binding has the same definition. */
3342 if (mention_shadow
&& !EQ (tem
, definition
))
3349 tem
= Flookup_key (map
, kludge
, Qt
);
3350 if (!EQ (tem
, definition
)) continue;
3352 vect
[slots_used
].event
= event
;
3353 vect
[slots_used
].definition
= definition
;
3354 vect
[slots_used
].shadowed
= this_shadowed
;
3357 else if (EQ (XCAR (tail
), Qkeymap
))
3359 /* The same keymap might be in the structure twice, if we're
3360 using an inherited keymap. So skip anything we've already
3362 tem
= Fassq (tail
, *seen
);
3363 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3365 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3369 /* If we found some sparse map events, sort them. */
3371 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3372 describe_map_compare
);
3374 /* Now output them in sorted order. */
3376 for (i
= 0; i
< slots_used
; i
++)
3378 Lisp_Object start
, end
;
3382 previous_description_column
= 0;
3387 ASET (kludge
, 0, vect
[i
].event
);
3388 start
= vect
[i
].event
;
3391 definition
= vect
[i
].definition
;
3393 /* Find consecutive chars that are identically defined. */
3394 if (INTEGERP (vect
[i
].event
))
3396 while (i
+ 1 < slots_used
3397 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3398 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3399 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3401 end
= vect
[i
].event
;
3404 /* Now START .. END is the range to describe next. */
3406 /* Insert the string to describe the event START. */
3407 insert1 (Fkey_description (kludge
, prefix
));
3409 if (!EQ (start
, end
))
3413 ASET (kludge
, 0, end
);
3414 /* Insert the string to describe the character END. */
3415 insert1 (Fkey_description (kludge
, prefix
));
3418 /* Print a description of the definition of this character.
3419 elt_describer will take care of spacing out far enough
3420 for alignment purposes. */
3421 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3423 if (vect
[i
].shadowed
)
3426 insert_string ("\n (that binding is currently shadowed by another mode)");
3435 describe_vector_princ (elt
, fun
)
3436 Lisp_Object elt
, fun
;
3438 Findent_to (make_number (16), make_number (1));
3443 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3444 doc
: /* Insert a description of contents of VECTOR.
3445 This is text showing the elements of vector matched against indices.
3446 DESCRIBER is the output function used; nil means use `princ'. */)
3448 Lisp_Object vector
, describer
;
3450 int count
= SPECPDL_INDEX ();
3451 if (NILP (describer
))
3452 describer
= intern ("princ");
3453 specbind (Qstandard_output
, Fcurrent_buffer ());
3454 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3455 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3456 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3458 return unbind_to (count
, Qnil
);
3461 /* Insert in the current buffer a description of the contents of VECTOR.
3462 We call ELT_DESCRIBER to insert the description of one value found
3465 ELT_PREFIX describes what "comes before" the keys or indices defined
3466 by this vector. This is a human-readable string whose size
3467 is not necessarily related to the situation.
3469 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3470 leads to this keymap.
3472 If the vector is a chartable, ELT_PREFIX is the vector
3473 of bytes that lead to the character set or portion of a character
3474 set described by this chartable.
3476 If PARTIAL is nonzero, it means do not mention suppressed commands
3477 (that assumes the vector is in a keymap).
3479 SHADOW is a list of keymaps that shadow this map.
3480 If it is non-nil, then we look up the key in those maps
3481 and we don't mention it now if it is defined by any of them.
3483 ENTIRE_MAP is the keymap in which this vector appears.
3484 If the definition in effect in the whole map does not match
3485 the one in this vector, we ignore this one.
3487 When describing a sub-char-table, INDICES is a list of
3488 indices at higher levels in this char-table,
3489 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3491 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3493 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3496 describe_vector (vector
, prefix
, args
, elt_describer
,
3497 partial
, shadow
, entire_map
,
3498 indices
, char_table_depth
, keymap_p
,
3500 register Lisp_Object vector
;
3501 Lisp_Object prefix
, args
;
3502 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3505 Lisp_Object entire_map
;
3507 int char_table_depth
;
3511 Lisp_Object definition
;
3513 Lisp_Object elt_prefix
= Qnil
;
3515 Lisp_Object suppress
;
3518 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3519 /* Range of elements to be handled. */
3521 /* A flag to tell if a leaf in this level of char-table is not a
3522 generic character (i.e. a complete multibyte character). */
3530 indices
= (int *) alloca (3 * sizeof (int));
3536 /* Call Fkey_description first, to avoid GC bug for the other string. */
3537 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3540 tem
= Fkey_description (prefix
, Qnil
);
3541 elt_prefix
= concat2 (tem
, build_string (" "));
3546 /* This vector gets used to present single keys to Flookup_key. Since
3547 that is done once per vector element, we don't want to cons up a
3548 fresh vector every time. */
3549 kludge
= Fmake_vector (make_number (1), Qnil
);
3550 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3553 suppress
= intern ("suppress-keymap");
3555 if (CHAR_TABLE_P (vector
))
3557 if (char_table_depth
== 0)
3559 /* VECTOR is a top level char-table. */
3562 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3566 /* VECTOR is a sub char-table. */
3567 if (char_table_depth
>= 3)
3568 /* A char-table is never that deep. */
3569 error ("Too deep char table");
3572 = (CHARSET_VALID_P (indices
[0])
3573 && ((CHARSET_DIMENSION (indices
[0]) == 1
3574 && char_table_depth
== 1)
3575 || char_table_depth
== 2));
3577 /* Meaningful elements are from 32th to 127th. */
3579 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3584 /* This does the right thing for ordinary vectors. */
3588 to
= XVECTOR (vector
)->size
;
3591 for (i
= from
; i
< to
; i
++)
3593 int this_shadowed
= 0;
3596 if (CHAR_TABLE_P (vector
))
3598 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3601 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3602 && !CHARSET_DEFINED_P (i
- 128))
3606 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3609 definition
= get_keyelt (AREF (vector
, i
), 0);
3611 if (NILP (definition
)) continue;
3613 /* Don't mention suppressed commands. */
3614 if (SYMBOLP (definition
) && partial
)
3618 tem
= Fget (definition
, suppress
);
3620 if (!NILP (tem
)) continue;
3623 /* Set CHARACTER to the character this entry describes, if any.
3624 Also update *INDICES. */
3625 if (CHAR_TABLE_P (vector
))
3627 indices
[char_table_depth
] = i
;
3629 if (char_table_depth
== 0)
3632 indices
[0] = i
- 128;
3634 else if (complete_char
)
3636 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3644 ASET (kludge
, 0, make_number (character
));
3646 /* If this binding is shadowed by some other map, ignore it. */
3647 if (!NILP (shadow
) && complete_char
)
3651 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3662 /* Ignore this definition if it is shadowed by an earlier
3663 one in the same keymap. */
3664 if (!NILP (entire_map
) && complete_char
)
3668 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3670 if (!EQ (tem
, definition
))
3676 if (char_table_depth
== 0)
3681 /* For a sub char-table, show the depth by indentation.
3682 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3683 if (char_table_depth
> 0)
3684 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3686 /* Output the prefix that applies to every entry in this map. */
3687 if (!NILP (elt_prefix
))
3688 insert1 (elt_prefix
);
3690 /* Insert or describe the character this slot is for,
3691 or a description of what it is for. */
3692 if (SUB_CHAR_TABLE_P (vector
))
3695 insert_char (character
);
3698 /* We need an octal representation for this block of
3701 sprintf (work
, "(row %d)", i
);
3702 insert (work
, strlen (work
));
3705 else if (CHAR_TABLE_P (vector
))
3708 insert1 (Fkey_description (kludge
, prefix
));
3711 /* Print the information for this character set. */
3712 insert_string ("<");
3713 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3715 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3724 insert1 (Fkey_description (kludge
, prefix
));
3727 /* If we find a sub char-table within a char-table,
3728 scan it recursively; it defines the details for
3729 a character set or a portion of a character set. */
3730 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3733 describe_vector (definition
, prefix
, args
, elt_describer
,
3734 partial
, shadow
, entire_map
,
3735 indices
, char_table_depth
+ 1, keymap_p
,
3742 /* Find all consecutive characters or rows that have the same
3743 definition. But, for elements of a top level char table, if
3744 they are for charsets, we had better describe one by one even
3745 if they have the same definition. */
3746 if (CHAR_TABLE_P (vector
))
3750 if (char_table_depth
== 0)
3751 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3753 while (i
+ 1 < limit
3754 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3756 && !NILP (Fequal (tem2
, definition
)))
3761 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3763 && !NILP (Fequal (tem2
, definition
)))
3767 /* If we have a range of more than one character,
3768 print where the range reaches to. */
3770 if (i
!= starting_i
)
3774 ASET (kludge
, 0, make_number (i
));
3776 if (!NILP (elt_prefix
))
3777 insert1 (elt_prefix
);
3779 if (CHAR_TABLE_P (vector
))
3781 if (char_table_depth
== 0)
3783 insert1 (Fkey_description (kludge
, prefix
));
3785 else if (complete_char
)
3787 indices
[char_table_depth
] = i
;
3788 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3789 insert_char (character
);
3793 /* We need an octal representation for this block of
3796 sprintf (work
, "(row %d)", i
);
3797 insert (work
, strlen (work
));
3802 insert1 (Fkey_description (kludge
, prefix
));
3806 /* Print a description of the definition of this character.
3807 elt_describer will take care of spacing out far enough
3808 for alignment purposes. */
3809 (*elt_describer
) (definition
, args
);
3814 insert_string (" (binding currently shadowed)");
3819 /* For (sub) char-table, print `defalt' slot at last. */
3820 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3822 insert (" ", char_table_depth
* 2);
3823 insert_string ("<<default>>");
3824 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3830 /* Apropos - finding all symbols whose names match a regexp. */
3831 static Lisp_Object apropos_predicate
;
3832 static Lisp_Object apropos_accumulate
;
3835 apropos_accum (symbol
, string
)
3836 Lisp_Object symbol
, string
;
3838 register Lisp_Object tem
;
3840 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3841 if (!NILP (tem
) && !NILP (apropos_predicate
))
3842 tem
= call1 (apropos_predicate
, symbol
);
3844 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3847 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3848 doc
: /* Show all symbols whose names contain match for REGEXP.
3849 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3850 for each symbol and a symbol is mentioned only if that returns non-nil.
3851 Return list of symbols found. */)
3853 Lisp_Object regexp
, predicate
;
3856 CHECK_STRING (regexp
);
3857 apropos_predicate
= predicate
;
3858 apropos_accumulate
= Qnil
;
3859 map_obarray (Vobarray
, apropos_accum
, regexp
);
3860 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3861 apropos_accumulate
= Qnil
;
3862 apropos_predicate
= Qnil
;
3869 Qkeymap
= intern ("keymap");
3870 staticpro (&Qkeymap
);
3871 staticpro (&apropos_predicate
);
3872 staticpro (&apropos_accumulate
);
3873 apropos_predicate
= Qnil
;
3874 apropos_accumulate
= Qnil
;
3876 /* Now we are ready to set up this property, so we can
3877 create char tables. */
3878 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3880 /* Initialize the keymaps standardly used.
3881 Each one is the value of a Lisp variable, and is also
3882 pointed to by a C variable */
3884 global_map
= Fmake_keymap (Qnil
);
3885 Fset (intern ("global-map"), global_map
);
3887 current_global_map
= global_map
;
3888 staticpro (&global_map
);
3889 staticpro (¤t_global_map
);
3891 meta_map
= Fmake_keymap (Qnil
);
3892 Fset (intern ("esc-map"), meta_map
);
3893 Ffset (intern ("ESC-prefix"), meta_map
);
3895 control_x_map
= Fmake_keymap (Qnil
);
3896 Fset (intern ("ctl-x-map"), control_x_map
);
3897 Ffset (intern ("Control-X-prefix"), control_x_map
);
3900 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3901 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3902 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3903 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3904 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3906 staticpro (&exclude_keys
);
3908 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3909 doc
: /* List of commands given new key bindings recently.
3910 This is used for internal purposes during Emacs startup;
3911 don't alter it yourself. */);
3912 Vdefine_key_rebound_commands
= Qt
;
3914 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3915 doc
: /* Default keymap to use when reading from the minibuffer. */);
3916 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3918 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3919 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3920 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3921 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3923 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3924 doc
: /* Local keymap for minibuffer input with completion. */);
3925 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3926 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3928 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3929 &Vminibuffer_local_filename_completion_map
,
3930 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3931 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3932 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3933 Vminibuffer_local_completion_map
);
3936 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3937 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3938 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3939 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3940 Vminibuffer_local_completion_map
);
3942 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3943 &Vminibuffer_local_must_match_filename_map
,
3944 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3945 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3946 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3947 Vminibuffer_local_must_match_map
);
3949 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3950 doc
: /* Alist of keymaps to use for minor modes.
3951 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3952 key sequences and look up bindings iff VARIABLE's value is non-nil.
3953 If two active keymaps bind the same key, the keymap appearing earlier
3954 in the list takes precedence. */);
3955 Vminor_mode_map_alist
= Qnil
;
3957 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3958 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3959 This variable is an alist just like `minor-mode-map-alist', and it is
3960 used the same way (and before `minor-mode-map-alist'); however,
3961 it is provided for major modes to bind locally. */);
3962 Vminor_mode_overriding_map_alist
= Qnil
;
3964 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3965 doc
: /* List of keymap alists to use for emulations modes.
3966 It is intended for modes or packages using multiple minor-mode keymaps.
3967 Each element is a keymap alist just like `minor-mode-map-alist', or a
3968 symbol with a variable binding which is a keymap alist, and it is used
3969 the same way. The "active" keymaps in each alist are used before
3970 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3971 Vemulation_mode_map_alists
= Qnil
;
3974 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3975 doc
: /* Keymap that translates key sequences to key sequences during input.
3976 This is used mainly for mapping ASCII function key sequences into
3977 real Emacs function key events (symbols).
3979 The `read-key-sequence' function replaces any subsequence bound by
3980 `function-key-map' with its binding. More precisely, when the active
3981 keymaps have no binding for the current key sequence but
3982 `function-key-map' binds a suffix of the sequence to a vector or string,
3983 `read-key-sequence' replaces the matching suffix with its binding, and
3984 continues with the new sequence.
3986 If the binding is a function, it is called with one argument (the prompt)
3987 and its return value (a key sequence) is used.
3989 The events that come from bindings in `function-key-map' are not
3990 themselves looked up in `function-key-map'.
3992 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3993 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3994 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3995 key, typing `ESC O P x' would return [f1 x]. */);
3996 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3998 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3999 doc
: /* Keymap of key translations that can override keymaps.
4000 This keymap works like `function-key-map', but comes after that,
4001 and its non-prefix bindings override ordinary bindings. */);
4002 Vkey_translation_map
= Qnil
;
4004 staticpro (&Vmouse_events
);
4005 Vmouse_events
= Fcons (intern ("menu-bar"),
4006 Fcons (intern ("tool-bar"),
4007 Fcons (intern ("header-line"),
4008 Fcons (intern ("mode-line"),
4009 Fcons (intern ("mouse-1"),
4010 Fcons (intern ("mouse-2"),
4011 Fcons (intern ("mouse-3"),
4012 Fcons (intern ("mouse-4"),
4013 Fcons (intern ("mouse-5"),
4017 Qsingle_key_description
= intern ("single-key-description");
4018 staticpro (&Qsingle_key_description
);
4020 Qkey_description
= intern ("key-description");
4021 staticpro (&Qkey_description
);
4023 Qkeymapp
= intern ("keymapp");
4024 staticpro (&Qkeymapp
);
4026 Qnon_ascii
= intern ("non-ascii");
4027 staticpro (&Qnon_ascii
);
4029 Qmenu_item
= intern ("menu-item");
4030 staticpro (&Qmenu_item
);
4032 Qremap
= intern ("remap");
4033 staticpro (&Qremap
);
4035 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
4036 staticpro (&command_remapping_vector
);
4038 where_is_cache_keymaps
= Qt
;
4039 where_is_cache
= Qnil
;
4040 staticpro (&where_is_cache
);
4041 staticpro (&where_is_cache_keymaps
);
4043 defsubr (&Skeymapp
);
4044 defsubr (&Skeymap_parent
);
4045 defsubr (&Skeymap_prompt
);
4046 defsubr (&Sset_keymap_parent
);
4047 defsubr (&Smake_keymap
);
4048 defsubr (&Smake_sparse_keymap
);
4049 defsubr (&Smap_keymap
);
4050 defsubr (&Scopy_keymap
);
4051 defsubr (&Scommand_remapping
);
4052 defsubr (&Skey_binding
);
4053 defsubr (&Slocal_key_binding
);
4054 defsubr (&Sglobal_key_binding
);
4055 defsubr (&Sminor_mode_key_binding
);
4056 defsubr (&Sdefine_key
);
4057 defsubr (&Slookup_key
);
4058 defsubr (&Sdefine_prefix_command
);
4059 defsubr (&Suse_global_map
);
4060 defsubr (&Suse_local_map
);
4061 defsubr (&Scurrent_local_map
);
4062 defsubr (&Scurrent_global_map
);
4063 defsubr (&Scurrent_minor_mode_maps
);
4064 defsubr (&Scurrent_active_maps
);
4065 defsubr (&Saccessible_keymaps
);
4066 defsubr (&Skey_description
);
4067 defsubr (&Sdescribe_vector
);
4068 defsubr (&Ssingle_key_description
);
4069 defsubr (&Stext_char_description
);
4070 defsubr (&Swhere_is_internal
);
4071 defsubr (&Sdescribe_buffer_bindings
);
4072 defsubr (&Sapropos_internal
);
4078 initial_define_key (global_map
, 033, "ESC-prefix");
4079 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
4082 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
4083 (do not change this comment) */