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, 2007 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. */
32 #include "character.h"
35 #include "termhooks.h"
36 #include "blockinput.h"
38 #include "intervals.h"
42 /* The number of elements in keymap vectors. */
43 #define DENSE_TABLE_SIZE (0200)
45 /* Actually allocate storage for these variables */
47 Lisp_Object current_global_map
; /* Current global keymap */
49 Lisp_Object global_map
; /* default global key bindings */
51 Lisp_Object meta_map
; /* The keymap used for globally bound
52 ESC-prefixed default commands */
54 Lisp_Object control_x_map
; /* The keymap used for globally bound
55 C-x-prefixed default commands */
57 /* was MinibufLocalMap */
58 Lisp_Object Vminibuffer_local_map
;
59 /* The keymap used by the minibuf for local
60 bindings when spaces are allowed in the
63 /* was MinibufLocalNSMap */
64 Lisp_Object Vminibuffer_local_ns_map
;
65 /* The keymap used by the minibuf for local
66 bindings when spaces are not encouraged
69 /* keymap used for minibuffers when doing completion */
70 /* was MinibufLocalCompletionMap */
71 Lisp_Object Vminibuffer_local_completion_map
;
73 /* keymap used for minibuffers when doing completion in filenames */
74 Lisp_Object Vminibuffer_local_filename_completion_map
;
76 /* keymap used for minibuffers when doing completion in filenames
78 Lisp_Object Vminibuffer_local_must_match_filename_map
;
80 /* keymap used for minibuffers when doing completion and require a match */
81 /* was MinibufLocalMustMatchMap */
82 Lisp_Object Vminibuffer_local_must_match_map
;
84 /* Alist of minor mode variables and keymaps. */
85 Lisp_Object Vminor_mode_map_alist
;
87 /* Alist of major-mode-specific overrides for
88 minor mode variables and keymaps. */
89 Lisp_Object Vminor_mode_overriding_map_alist
;
91 /* List of emulation mode keymap alists. */
92 Lisp_Object Vemulation_mode_map_alists
;
94 /* Keymap mapping ASCII function key sequences onto their preferred forms.
95 Initialized by the terminal-specific lisp files. See DEFVAR for more
97 Lisp_Object Vfunction_key_map
;
99 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
100 Lisp_Object Vkey_translation_map
;
102 /* A list of all commands given new bindings since a certain time
103 when nil was stored here.
104 This is used to speed up recomputation of menu key equivalents
105 when Emacs starts up. t means don't record anything here. */
106 Lisp_Object Vdefine_key_rebound_commands
;
108 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
110 /* Alist of elements like (DEL . "\d"). */
111 static Lisp_Object exclude_keys
;
113 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
114 static Lisp_Object command_remapping_vector
;
116 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
117 in a string key sequence is equivalent to prefixing with this
119 extern Lisp_Object meta_prefix_char
;
121 extern Lisp_Object Voverriding_local_map
;
123 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
124 static Lisp_Object where_is_cache
;
125 /* Which keymaps are reverse-stored in the cache. */
126 static Lisp_Object where_is_cache_keymaps
;
128 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
129 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
131 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
132 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
133 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
134 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
135 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
136 int, Lisp_Object
, Lisp_Object
*, int, int));
137 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
138 void (*) (Lisp_Object
, Lisp_Object
), int,
139 Lisp_Object
, Lisp_Object
, int *,
141 static void silly_event_symbol_error
P_ ((Lisp_Object
));
143 /* Keymap object support - constructors and predicates. */
145 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
146 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
147 CHARTABLE is a char-table that holds the bindings for all characters
148 without modifiers. All entries in it are initially nil, meaning
149 "command undefined". ALIST is an assoc-list which holds bindings for
150 function keys, mouse events, and any other things that appear in the
151 input stream. Initially, ALIST is nil.
153 The optional arg STRING supplies a menu name for the keymap
154 in case you use it as a menu with `x-popup-menu'. */)
160 tail
= Fcons (string
, Qnil
);
163 return Fcons (Qkeymap
,
164 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
167 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
168 doc
: /* Construct and return a new sparse keymap.
169 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
170 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
171 which binds the function key or mouse event SYMBOL to DEFINITION.
172 Initially the alist is nil.
174 The optional arg STRING supplies a menu name for the keymap
175 in case you use it as a menu with `x-popup-menu'. */)
180 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
181 return Fcons (Qkeymap
, Qnil
);
184 /* This function is used for installing the standard key bindings
185 at initialization time.
189 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
192 initial_define_key (keymap
, key
, defname
)
197 store_in_keymap (keymap
, make_number (key
), intern (defname
));
201 initial_define_lispy_key (keymap
, keyname
, defname
)
206 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
209 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
210 doc
: /* Return t if OBJECT is a keymap.
212 A keymap is a list (keymap . ALIST),
213 or a symbol whose function definition is itself a keymap.
214 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
215 a vector of densely packed bindings for small character codes
216 is also allowed as an element. */)
220 return (KEYMAPP (object
) ? Qt
: Qnil
);
223 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
224 doc
: /* Return the prompt-string of a keymap MAP.
225 If non-nil, the prompt is shown in the echo-area
226 when reading a key-sequence to be looked-up in this keymap. */)
230 map
= get_keymap (map
, 0, 0);
233 Lisp_Object tem
= XCAR (map
);
241 /* Check that OBJECT is a keymap (after dereferencing through any
242 symbols). If it is, return it.
244 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
245 is an autoload form, do the autoload and try again.
246 If AUTOLOAD is nonzero, callers must assume GC is possible.
248 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
249 is zero as well), return Qt.
251 ERROR controls how we respond if OBJECT isn't a keymap.
252 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
254 Note that most of the time, we don't want to pursue autoloads.
255 Functions like Faccessible_keymaps which scan entire keymap trees
256 shouldn't load every autoloaded keymap. I'm not sure about this,
257 but it seems to me that only read_key_sequence, Flookup_key, and
258 Fdefine_key should cause keymaps to be autoloaded.
260 This function can GC when AUTOLOAD is non-zero, because it calls
261 do_autoload which can GC. */
264 get_keymap (object
, error
, autoload
)
273 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
276 tem
= indirect_function (object
);
279 if (EQ (XCAR (tem
), Qkeymap
))
282 /* Should we do an autoload? Autoload forms for keymaps have
283 Qkeymap as their fifth element. */
284 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
)
289 tail
= Fnth (make_number (4), tem
);
290 if (EQ (tail
, Qkeymap
))
294 struct gcpro gcpro1
, gcpro2
;
296 GCPRO2 (tem
, object
);
297 do_autoload (tem
, object
);
310 wrong_type_argument (Qkeymapp
, object
);
314 /* Return the parent map of KEYMAP, or nil if it has none.
315 We assume that KEYMAP is a valid keymap. */
318 keymap_parent (keymap
, autoload
)
324 keymap
= get_keymap (keymap
, 1, autoload
);
326 /* Skip past the initial element `keymap'. */
327 list
= XCDR (keymap
);
328 for (; CONSP (list
); list
= XCDR (list
))
330 /* See if there is another `keymap'. */
335 return get_keymap (list
, 0, autoload
);
338 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
339 doc
: /* Return the parent keymap of KEYMAP. */)
343 return keymap_parent (keymap
, 1);
346 /* Check whether MAP is one of MAPS parents. */
348 keymap_memberp (map
, maps
)
349 Lisp_Object map
, maps
;
351 if (NILP (map
)) return 0;
352 while (KEYMAPP (maps
) && !EQ (map
, maps
))
353 maps
= keymap_parent (maps
, 0);
354 return (EQ (map
, maps
));
357 /* Set the parent keymap of MAP to PARENT. */
359 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
360 doc
: /* Modify KEYMAP to set its parent map to PARENT.
361 Return PARENT. PARENT should be nil or another keymap. */)
363 Lisp_Object keymap
, parent
;
365 Lisp_Object list
, prev
;
366 struct gcpro gcpro1
, gcpro2
;
369 /* Force a keymap flush for the next call to where-is.
370 Since this can be called from within where-is, we don't set where_is_cache
371 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
372 be changed during where-is, while where_is_cache_keymaps is only used at
373 the very beginning of where-is and can thus be changed here without any
375 This is a very minor correctness (rather than safety) issue. */
376 where_is_cache_keymaps
= Qt
;
378 GCPRO2 (keymap
, parent
);
379 keymap
= get_keymap (keymap
, 1, 1);
383 parent
= get_keymap (parent
, 1, 1);
385 /* Check for cycles. */
386 if (keymap_memberp (keymap
, parent
))
387 error ("Cyclic keymap inheritance");
390 /* Skip past the initial element `keymap'. */
395 /* If there is a parent keymap here, replace it.
396 If we came to the end, add the parent in PREV. */
397 if (!CONSP (list
) || KEYMAPP (list
))
399 /* If we already have the right parent, return now
400 so that we avoid the loops below. */
401 if (EQ (XCDR (prev
), parent
))
402 RETURN_UNGCPRO (parent
);
405 XSETCDR (prev
, parent
);
411 /* Scan through for submaps, and set their parents too. */
413 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
415 /* Stop the scan when we come to the parent. */
416 if (EQ (XCAR (list
), Qkeymap
))
419 /* If this element holds a prefix map, deal with it. */
420 if (CONSP (XCAR (list
))
421 && CONSP (XCDR (XCAR (list
))))
422 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
425 if (VECTORP (XCAR (list
)))
426 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
427 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
428 fix_submap_inheritance (keymap
, make_number (i
),
429 XVECTOR (XCAR (list
))->contents
[i
]);
431 if (CHAR_TABLE_P (XCAR (list
)))
433 map_char_table (fix_submap_inheritance
, Qnil
, XCAR (list
), keymap
);
437 RETURN_UNGCPRO (parent
);
440 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
441 if EVENT is also a prefix in MAP's parent,
442 make sure that SUBMAP inherits that definition as its own parent. */
445 fix_submap_inheritance (map
, event
, submap
)
446 Lisp_Object map
, event
, submap
;
448 Lisp_Object map_parent
, parent_entry
;
450 /* SUBMAP is a cons that we found as a key binding.
451 Discard the other things found in a menu key binding. */
453 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
455 /* If it isn't a keymap now, there's no work to do. */
459 map_parent
= keymap_parent (map
, 0);
460 if (!NILP (map_parent
))
462 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
466 /* If MAP's parent has something other than a keymap,
467 our own submap shadows it completely. */
468 if (!CONSP (parent_entry
))
471 if (! EQ (parent_entry
, submap
))
473 Lisp_Object submap_parent
;
474 submap_parent
= submap
;
479 tem
= keymap_parent (submap_parent
, 0);
483 if (keymap_memberp (tem
, parent_entry
))
484 /* Fset_keymap_parent could create a cycle. */
491 Fset_keymap_parent (submap_parent
, parent_entry
);
495 /* Look up IDX in MAP. IDX may be any sort of event.
496 Note that this does only one level of lookup; IDX must be a single
497 event, not a sequence.
499 If T_OK is non-zero, bindings for Qt are treated as default
500 bindings; any key left unmentioned by other tables and bindings is
501 given the binding of Qt.
503 If T_OK is zero, bindings for Qt are not treated specially.
505 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
508 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
517 /* Qunbound in VAL means we have found no binding yet. */
520 /* If idx is a list (some sort of mouse click, perhaps?),
521 the index we want to use is the car of the list, which
522 ought to be a symbol. */
523 idx
= EVENT_HEAD (idx
);
525 /* If idx is a symbol, it might have modifiers, which need to
526 be put in the canonical order. */
528 idx
= reorder_modifiers (idx
);
529 else if (INTEGERP (idx
))
530 /* Clobber the high bits that can be present on a machine
531 with more than 24 bits of integer. */
532 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
534 /* Handle the special meta -> esc mapping. */
535 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
537 /* See if there is a meta-map. If there's none, there is
538 no binding for IDX, unless a default binding exists in MAP. */
540 Lisp_Object meta_map
;
542 /* A strange value in which Meta is set would cause
543 infinite recursion. Protect against that. */
544 if (XINT (meta_prefix_char
) & CHAR_META
)
545 meta_prefix_char
= make_number (27);
546 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
547 t_ok
, noinherit
, autoload
),
550 if (CONSP (meta_map
))
553 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
556 /* Set IDX to t, so that we only find a default binding. */
559 /* We know there is no binding. */
563 /* t_binding is where we put a default binding that applies,
564 to use in case we do not find a binding specifically
565 for this key sequence. */
568 Lisp_Object t_binding
= Qnil
;
569 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
571 GCPRO4 (map
, tail
, idx
, t_binding
);
573 /* If `t_ok' is 2, both `t' is accepted. */
576 for (tail
= XCDR (map
);
578 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
583 binding
= XCAR (tail
);
584 if (SYMBOLP (binding
))
586 /* If NOINHERIT, stop finding prefix definitions
587 after we pass a second occurrence of the `keymap' symbol. */
588 if (noinherit
&& EQ (binding
, Qkeymap
))
589 RETURN_UNGCPRO (Qnil
);
591 else if (CONSP (binding
))
593 Lisp_Object key
= XCAR (binding
);
596 val
= XCDR (binding
);
597 else if (t_ok
> 1 && EQ (key
, Qt
))
599 t_binding
= XCDR (binding
);
603 else if (VECTORP (binding
))
605 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
606 val
= AREF (binding
, XFASTINT (idx
));
608 else if (CHAR_TABLE_P (binding
))
610 /* Character codes with modifiers
611 are not included in a char-table.
612 All character codes without modifiers are included. */
613 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
615 val
= Faref (binding
, idx
);
616 /* `nil' has a special meaning for char-tables, so
617 we use something else to record an explicitly
624 /* If we found a binding, clean it up and return it. */
625 if (!EQ (val
, Qunbound
))
628 /* A Qt binding is just like an explicit nil binding
629 (i.e. it shadows any parent binding but not bindings in
630 keymaps of lower precedence). */
632 val
= get_keyelt (val
, autoload
);
634 fix_submap_inheritance (map
, idx
, val
);
635 RETURN_UNGCPRO (val
);
640 return get_keyelt (t_binding
, autoload
);
645 map_keymap_item (fun
, args
, key
, val
, data
)
646 map_keymap_function_t fun
;
647 Lisp_Object args
, key
, val
;
650 /* We should maybe try to detect bindings shadowed by previous
651 ones and things like that. */
654 (*fun
) (key
, val
, args
, data
);
658 map_keymap_char_table_item (args
, key
, val
)
659 Lisp_Object args
, key
, val
;
663 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
665 map_keymap_item (fun
, XCDR (args
), key
, val
,
666 XSAVE_VALUE (XCAR (args
))->pointer
);
670 /* Call FUN for every binding in MAP.
671 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
672 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
674 map_keymap (map
, fun
, args
, data
, autoload
)
675 map_keymap_function_t fun
;
676 Lisp_Object map
, args
;
680 struct gcpro gcpro1
, gcpro2
, gcpro3
;
684 GCPRO3 (map
, args
, tail
);
685 map
= get_keymap (map
, 1, autoload
);
686 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
687 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
690 Lisp_Object binding
= XCAR (tail
);
693 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
694 else if (VECTORP (binding
))
696 /* Loop over the char values represented in the vector. */
697 int len
= ASIZE (binding
);
699 for (c
= 0; c
< len
; c
++)
701 Lisp_Object character
;
702 XSETFASTINT (character
, c
);
703 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
706 else if (CHAR_TABLE_P (binding
))
708 map_char_table (map_keymap_char_table_item
, Qnil
, binding
,
709 Fcons (make_save_value (fun
, 0),
710 Fcons (make_save_value (data
, 0),
718 map_keymap_call (key
, val
, fun
, dummy
)
719 Lisp_Object key
, val
, fun
;
722 call2 (fun
, key
, val
);
725 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
726 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
727 FUNCTION is called with two arguments: the event that is bound, and
728 the definition it is bound to. If the event is an integer, it may be
729 a generic character (see Info node `(elisp)Splitting Characters'), and
730 that means that all actual character events belonging to that generic
731 character are bound to the definition.
733 If KEYMAP has a parent, the parent's bindings are included as well.
734 This works recursively: if the parent has itself a parent, then the
735 grandparent's bindings are also included and so on.
736 usage: (map-keymap FUNCTION KEYMAP) */)
737 (function
, keymap
, sort_first
)
738 Lisp_Object function
, keymap
, sort_first
;
740 if (INTEGERP (function
))
741 /* We have to stop integers early since map_keymap gives them special
743 xsignal1 (Qinvalid_function
, function
);
744 if (! NILP (sort_first
))
745 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
747 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
751 /* Given OBJECT which was found in a slot in a keymap,
752 trace indirect definitions to get the actual definition of that slot.
753 An indirect definition is a list of the form
754 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
755 and INDEX is the object to look up in KEYMAP to yield the definition.
757 Also if OBJECT has a menu string as the first element,
758 remove that. Also remove a menu help string as second element.
760 If AUTOLOAD is nonzero, load autoloadable keymaps
761 that are referred to with indirection.
763 This can GC because menu_item_eval_property calls Feval. */
766 get_keyelt (object
, autoload
)
772 if (!(CONSP (object
)))
773 /* This is really the value. */
776 /* If the keymap contents looks like (keymap ...) or (lambda ...)
778 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
781 /* If the keymap contents looks like (menu-item name . DEFN)
782 or (menu-item name DEFN ...) then use DEFN.
783 This is a new format menu item. */
784 else if (EQ (XCAR (object
), Qmenu_item
))
786 if (CONSP (XCDR (object
)))
790 object
= XCDR (XCDR (object
));
793 object
= XCAR (object
);
795 /* If there's a `:filter FILTER', apply FILTER to the
796 menu-item's definition to get the real definition to
798 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
799 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
802 filter
= XCAR (XCDR (tem
));
803 filter
= list2 (filter
, list2 (Qquote
, object
));
804 object
= menu_item_eval_property (filter
);
809 /* Invalid keymap. */
813 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
814 Keymap alist elements like (CHAR MENUSTRING . DEFN)
815 will be used by HierarKey menus. */
816 else if (STRINGP (XCAR (object
)))
818 object
= XCDR (object
);
819 /* Also remove a menu help string, if any,
820 following the menu item name. */
821 if (CONSP (object
) && STRINGP (XCAR (object
)))
822 object
= XCDR (object
);
823 /* Also remove the sublist that caches key equivalences, if any. */
824 if (CONSP (object
) && CONSP (XCAR (object
)))
827 carcar
= XCAR (XCAR (object
));
828 if (NILP (carcar
) || VECTORP (carcar
))
829 object
= XCDR (object
);
833 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
839 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
841 return (!CONSP (map
) ? object
/* Invalid keymap */
842 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
848 store_in_keymap (keymap
, idx
, def
)
850 register Lisp_Object idx
;
853 /* Flush any reverse-map cache. */
854 where_is_cache
= Qnil
;
855 where_is_cache_keymaps
= Qt
;
857 /* If we are preparing to dump, and DEF is a menu element
858 with a menu item indicator, copy it to ensure it is not pure. */
859 if (CONSP (def
) && PURE_P (def
)
860 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
861 def
= Fcons (XCAR (def
), XCDR (def
));
863 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
864 error ("attempt to define a key in a non-keymap");
866 /* If idx is a cons, and the car part is a character, idx must be of
867 the form (FROM-CHAR . TO-CHAR). */
868 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
869 CHECK_CHARACTER_CDR (idx
);
871 /* If idx is a list (some sort of mouse click, perhaps?),
872 the index we want to use is the car of the list, which
873 ought to be a symbol. */
874 idx
= EVENT_HEAD (idx
);
876 /* If idx is a symbol, it might have modifiers, which need to
877 be put in the canonical order. */
879 idx
= reorder_modifiers (idx
);
880 else if (INTEGERP (idx
))
881 /* Clobber the high bits that can be present on a machine
882 with more than 24 bits of integer. */
883 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
885 /* Scan the keymap for a binding of idx. */
889 /* The cons after which we should insert new bindings. If the
890 keymap has a table element, we record its position here, so new
891 bindings will go after it; this way, the table will stay
892 towards the front of the alist and character lookups in dense
893 keymaps will remain fast. Otherwise, this just points at the
894 front of the keymap. */
895 Lisp_Object insertion_point
;
897 insertion_point
= keymap
;
898 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
905 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
908 ASET (elt
, XFASTINT (idx
), def
);
911 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
913 int from
= XFASTINT (XCAR (idx
));
914 int to
= XFASTINT (XCDR (idx
));
916 if (to
>= ASIZE (elt
))
917 to
= ASIZE (elt
) - 1;
918 for (; from
<= to
; from
++)
919 ASET (elt
, from
, def
);
920 if (to
== XFASTINT (XCDR (idx
)))
921 /* We have defined all keys in IDX. */
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 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
942 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
945 insertion_point
= tail
;
947 else if (CONSP (elt
))
949 if (EQ (idx
, XCAR (elt
)))
955 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
957 int from
= XFASTINT (XCAR (idx
));
958 int to
= XFASTINT (XCDR (idx
));
960 if (from
<= XFASTINT (XCAR (elt
))
961 && to
>= XFASTINT (XCAR (elt
)))
969 else if (EQ (elt
, Qkeymap
))
970 /* If we find a 'keymap' symbol in the spine of KEYMAP,
971 then we must have found the start of a second keymap
972 being used as the tail of KEYMAP, and a binding for IDX
973 should be inserted before it. */
980 /* We have scanned the entire keymap, and not found a binding for
981 IDX. Let's add one. */
985 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
987 /* IDX specifies a range of characters, and not all of them
988 were handled yet, which means this keymap doesn't have a
989 char-table. So, we insert a char-table now. */
990 elt
= Fmake_char_table (Qkeymap
, Qnil
);
991 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
994 elt
= Fcons (idx
, def
);
995 CHECK_IMPURE (insertion_point
);
996 XSETCDR (insertion_point
, Fcons (elt
, XCDR (insertion_point
)));
1003 EXFUN (Fcopy_keymap
, 1);
1006 copy_keymap_item (elt
)
1009 Lisp_Object res
, tem
;
1016 /* Is this a new format menu item. */
1017 if (EQ (XCAR (tem
), Qmenu_item
))
1019 /* Copy cell with menu-item marker. */
1020 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1024 /* Copy cell with menu-item name. */
1025 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1031 /* Copy cell with binding and if the binding is a keymap,
1033 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1036 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1037 XSETCAR (elt
, Fcopy_keymap (tem
));
1039 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1040 /* Delete cache for key equivalences. */
1041 XSETCDR (elt
, XCDR (tem
));
1046 /* It may be an old fomat menu item.
1047 Skip the optional menu string. */
1048 if (STRINGP (XCAR (tem
)))
1050 /* Copy the cell, since copy-alist didn't go this deep. */
1051 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1053 /* Also skip the optional menu help string. */
1054 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1056 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1060 /* There may also be a list that caches key equivalences.
1061 Just delete it for the new keymap. */
1063 && CONSP (XCAR (tem
))
1064 && (NILP (XCAR (XCAR (tem
)))
1065 || VECTORP (XCAR (XCAR (tem
)))))
1067 XSETCDR (elt
, XCDR (tem
));
1070 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1071 XSETCDR (elt
, Fcopy_keymap (tem
));
1073 else if (EQ (XCAR (tem
), Qkeymap
))
1074 res
= Fcopy_keymap (elt
);
1080 copy_keymap_1 (chartable
, idx
, elt
)
1081 Lisp_Object chartable
, idx
, elt
;
1083 Fset_char_table_range (chartable
, idx
, copy_keymap_item (elt
));
1086 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1087 doc
: /* Return a copy of the keymap KEYMAP.
1088 The copy starts out with the same definitions of KEYMAP,
1089 but changing either the copy or KEYMAP does not affect the other.
1090 Any key definitions that are subkeymaps are recursively copied.
1091 However, a key definition which is a symbol whose definition is a keymap
1096 register Lisp_Object copy
, tail
;
1097 keymap
= get_keymap (keymap
, 1, 0);
1098 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1099 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1101 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1103 Lisp_Object elt
= XCAR (keymap
);
1104 if (CHAR_TABLE_P (elt
))
1106 elt
= Fcopy_sequence (elt
);
1107 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
);
1109 else if (VECTORP (elt
))
1112 elt
= Fcopy_sequence (elt
);
1113 for (i
= 0; i
< ASIZE (elt
); i
++)
1114 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1116 else if (CONSP (elt
))
1117 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1118 XSETCDR (tail
, Fcons (elt
, Qnil
));
1120 keymap
= XCDR (keymap
);
1122 XSETCDR (tail
, keymap
);
1126 /* Simple Keymap mutators and accessors. */
1128 /* GC is possible in this function if it autoloads a keymap. */
1130 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1131 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1134 KEY is a string or a vector of symbols and characters meaning a
1135 sequence of keystrokes and events. Non-ASCII characters with codes
1136 above 127 (such as ISO Latin-1) can be included if you use a vector.
1137 Using [t] for KEY creates a default definition, which applies to any
1138 event type that has no other definition in this keymap.
1140 DEF is anything that can be a key's definition:
1141 nil (means key is undefined in this keymap),
1142 a command (a Lisp function suitable for interactive calling),
1143 a string (treated as a keyboard macro),
1144 a keymap (to define a prefix key),
1145 a symbol (when the key is looked up, the symbol will stand for its
1146 function definition, which should at that time be one of the above,
1147 or another symbol whose function definition is used, etc.),
1148 a cons (STRING . DEFN), meaning that DEFN is the definition
1149 (DEFN should be a valid definition in its own right),
1150 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP,
1151 or an extended menu item definition. (See info node `Extended Menu Items'.)
1153 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1154 binding is altered. If there is no binding for KEY, the new pair
1155 binding KEY to DEF is added at the front of KEYMAP. */)
1162 register Lisp_Object c
;
1163 register Lisp_Object cmd
;
1167 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1169 GCPRO3 (keymap
, key
, def
);
1170 keymap
= get_keymap (keymap
, 1, 1);
1172 CHECK_VECTOR_OR_STRING (key
);
1174 length
= XFASTINT (Flength (key
));
1176 RETURN_UNGCPRO (Qnil
);
1178 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1179 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1181 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1183 if (VECTORP (def
) && ASIZE (def
) > 0 && CONSP (AREF (def
, 0)))
1184 { /* DEF is apparently an XEmacs-style keyboard macro. */
1185 Lisp_Object tmp
= Fmake_vector (make_number (ASIZE (def
)), Qnil
);
1186 int i
= ASIZE (def
);
1189 Lisp_Object c
= AREF (def
, i
);
1190 if (CONSP (c
) && lucid_event_type_list_p (c
))
1191 c
= Fevent_convert_list (c
);
1200 c
= Faref (key
, make_number (idx
));
1204 /* C may be a Lucid style event type list or a cons (FROM .
1205 TO) specifying a range of characters. */
1206 if (lucid_event_type_list_p (c
))
1207 c
= Fevent_convert_list (c
);
1208 else if (CHARACTERP (XCAR (c
)))
1209 CHECK_CHARACTER_CDR (c
);
1213 silly_event_symbol_error (c
);
1216 && (XINT (c
) & meta_bit
)
1219 c
= meta_prefix_char
;
1225 XSETINT (c
, XINT (c
) & ~meta_bit
);
1231 if (!INTEGERP (c
) && !SYMBOLP (c
)
1233 /* If C is a range, it must be a leaf. */
1234 || (INTEGERP (XCAR (c
)) && idx
!= length
)))
1235 error ("Key sequence contains invalid event");
1238 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1240 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1242 /* If this key is undefined, make it a prefix. */
1244 cmd
= define_as_prefix (keymap
, c
);
1246 keymap
= get_keymap (cmd
, 0, 1);
1247 if (!CONSP (keymap
))
1248 /* We must use Fkey_description rather than just passing key to
1249 error; key might be a vector, not a string. */
1250 error ("Key sequence %s starts with non-prefix key %s",
1251 SDATA (Fkey_description (key
, Qnil
)),
1252 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1258 /* This function may GC (it calls Fkey_binding). */
1260 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 2, 0,
1261 doc
: /* Return the remapping for command COMMAND in current keymaps.
1262 Returns nil if COMMAND is not remapped (or not a symbol).
1264 If the optional argument POSITION is non-nil, it specifies a mouse
1265 position as returned by `event-start' and `event-end', and the
1266 remapping occurs in the keymaps associated with it. It can also be a
1267 number or marker, in which case the keymap properties at the specified
1268 buffer position instead of point are used. */)
1270 Lisp_Object command
, position
;
1272 if (!SYMBOLP (command
))
1275 ASET (command_remapping_vector
, 1, command
);
1276 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
, position
);
1279 /* Value is number if KEY is too long; nil if valid but has no definition. */
1280 /* GC is possible in this function if it autoloads a keymap. */
1282 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1283 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1284 A value of nil means undefined. See doc of `define-key'
1285 for kinds of definitions.
1287 A number as value means KEY is "too long";
1288 that is, characters or symbols in it except for the last one
1289 fail to be a valid sequence of prefix characters in KEYMAP.
1290 The number is how many characters at the front of KEY
1291 it takes to reach a non-prefix key.
1293 Normally, `lookup-key' ignores bindings for t, which act as default
1294 bindings, used when nothing else in the keymap applies; this makes it
1295 usable as a general function for probing keymaps. However, if the
1296 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1297 recognize the default bindings, just as `read-key-sequence' does. */)
1298 (keymap
, key
, accept_default
)
1301 Lisp_Object accept_default
;
1304 register Lisp_Object cmd
;
1305 register Lisp_Object c
;
1307 int t_ok
= !NILP (accept_default
);
1308 struct gcpro gcpro1
, gcpro2
;
1310 GCPRO2 (keymap
, key
);
1311 keymap
= get_keymap (keymap
, 1, 1);
1313 CHECK_VECTOR_OR_STRING (key
);
1315 length
= XFASTINT (Flength (key
));
1317 RETURN_UNGCPRO (keymap
);
1322 c
= Faref (key
, make_number (idx
++));
1324 if (CONSP (c
) && lucid_event_type_list_p (c
))
1325 c
= Fevent_convert_list (c
);
1327 /* Turn the 8th bit of string chars into a meta modifier. */
1328 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1329 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1331 /* Allow string since binding for `menu-bar-select-buffer'
1332 includes the buffer name in the key sequence. */
1333 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1334 error ("Key sequence contains invalid event");
1336 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1338 RETURN_UNGCPRO (cmd
);
1340 keymap
= get_keymap (cmd
, 0, 1);
1341 if (!CONSP (keymap
))
1342 RETURN_UNGCPRO (make_number (idx
));
1348 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1349 Assume that currently it does not define C at all.
1350 Return the keymap. */
1353 define_as_prefix (keymap
, c
)
1354 Lisp_Object keymap
, c
;
1358 cmd
= Fmake_sparse_keymap (Qnil
);
1359 /* If this key is defined as a prefix in an inherited keymap,
1360 make it a prefix in this map, and make its definition
1361 inherit the other prefix definition. */
1362 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1363 store_in_keymap (keymap
, c
, cmd
);
1368 /* Append a key to the end of a key sequence. We always make a vector. */
1371 append_key (key_sequence
, key
)
1372 Lisp_Object key_sequence
, key
;
1374 Lisp_Object args
[2];
1376 args
[0] = key_sequence
;
1378 args
[1] = Fcons (key
, Qnil
);
1379 return Fvconcat (2, args
);
1382 /* Given a event type C which is a symbol,
1383 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1386 silly_event_symbol_error (c
)
1389 Lisp_Object parsed
, base
, name
, assoc
;
1392 parsed
= parse_modifiers (c
);
1393 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1394 base
= XCAR (parsed
);
1395 name
= Fsymbol_name (base
);
1396 /* This alist includes elements such as ("RET" . "\\r"). */
1397 assoc
= Fassoc (name
, exclude_keys
);
1401 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1403 Lisp_Object keystring
;
1404 if (modifiers
& alt_modifier
)
1405 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1406 if (modifiers
& ctrl_modifier
)
1407 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1408 if (modifiers
& hyper_modifier
)
1409 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1410 if (modifiers
& meta_modifier
)
1411 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1412 if (modifiers
& shift_modifier
)
1413 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1414 if (modifiers
& super_modifier
)
1415 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1418 c
= reorder_modifiers (c
);
1419 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1421 error ((modifiers
& ~meta_modifier
1422 ? "To bind the key %s, use [?%s], not [%s]"
1423 : "To bind the key %s, use \"%s\", not [%s]"),
1424 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1425 SDATA (SYMBOL_NAME (c
)));
1429 /* Global, local, and minor mode keymap stuff. */
1431 /* We can't put these variables inside current_minor_maps, since under
1432 some systems, static gets macro-defined to be the empty string.
1434 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1435 static int cmm_size
= 0;
1437 /* Store a pointer to an array of the keymaps of the currently active
1438 minor modes in *buf, and return the number of maps it contains.
1440 This function always returns a pointer to the same buffer, and may
1441 free or reallocate it, so if you want to keep it for a long time or
1442 hand it out to lisp code, copy it. This procedure will be called
1443 for every key sequence read, so the nice lispy approach (return a
1444 new assoclist, list, what have you) for each invocation would
1445 result in a lot of consing over time.
1447 If we used xrealloc/xmalloc and ran out of memory, they would throw
1448 back to the command loop, which would try to read a key sequence,
1449 which would call this function again, resulting in an infinite
1450 loop. Instead, we'll use realloc/malloc and silently truncate the
1451 list, let the key sequence be read, and hope some other piece of
1452 code signals the error. */
1454 current_minor_maps (modeptr
, mapptr
)
1455 Lisp_Object
**modeptr
, **mapptr
;
1458 int list_number
= 0;
1459 Lisp_Object alist
, assoc
, var
, val
;
1460 Lisp_Object emulation_alists
;
1461 Lisp_Object lists
[2];
1463 emulation_alists
= Vemulation_mode_map_alists
;
1464 lists
[0] = Vminor_mode_overriding_map_alist
;
1465 lists
[1] = Vminor_mode_map_alist
;
1467 for (list_number
= 0; list_number
< 2; list_number
++)
1469 if (CONSP (emulation_alists
))
1471 alist
= XCAR (emulation_alists
);
1472 emulation_alists
= XCDR (emulation_alists
);
1473 if (SYMBOLP (alist
))
1474 alist
= find_symbol_value (alist
);
1478 alist
= lists
[list_number
];
1480 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1481 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1482 && (var
= XCAR (assoc
), SYMBOLP (var
))
1483 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1488 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1489 and also an entry in Vminor_mode_map_alist,
1490 ignore the latter. */
1491 if (list_number
== 1)
1493 val
= assq_no_quit (var
, lists
[0]);
1500 int newsize
, allocsize
;
1501 Lisp_Object
*newmodes
, *newmaps
;
1503 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1504 allocsize
= newsize
* sizeof *newmodes
;
1506 /* Use malloc here. See the comment above this function.
1507 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1509 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1514 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1517 cmm_modes
= newmodes
;
1520 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1525 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1532 if (newmodes
== NULL
|| newmaps
== NULL
)
1537 /* Get the keymap definition--or nil if it is not defined. */
1538 temp
= Findirect_function (XCDR (assoc
), Qt
);
1542 cmm_maps
[i
] = temp
;
1548 if (modeptr
) *modeptr
= cmm_modes
;
1549 if (mapptr
) *mapptr
= cmm_maps
;
1553 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1555 doc
: /* Return a list of the currently active keymaps.
1556 OLP if non-nil indicates that we should obey `overriding-local-map' and
1557 `overriding-terminal-local-map'. */)
1561 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1565 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1566 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1567 /* The doc said that overriding-terminal-local-map should
1568 override overriding-local-map. The code used them both,
1569 but it seems clearer to use just one. rms, jan 2005. */
1570 else if (!NILP (Voverriding_local_map
))
1571 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1573 if (NILP (XCDR (keymaps
)))
1579 /* This usually returns the buffer's local map,
1580 but that can be overridden by a `local-map' property. */
1581 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1583 keymaps
= Fcons (local
, keymaps
);
1585 /* Now put all the minor mode keymaps on the list. */
1586 nmaps
= current_minor_maps (0, &maps
);
1588 for (i
= --nmaps
; i
>= 0; i
--)
1589 if (!NILP (maps
[i
]))
1590 keymaps
= Fcons (maps
[i
], keymaps
);
1592 /* This returns nil unless there is a `keymap' property. */
1593 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1595 keymaps
= Fcons (local
, keymaps
);
1601 /* GC is possible in this function if it autoloads a keymap. */
1603 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 4, 0,
1604 doc
: /* Return the binding for command KEY in current keymaps.
1605 KEY is a string or vector, a sequence of keystrokes.
1606 The binding is probably a symbol with a function definition.
1608 Normally, `key-binding' ignores bindings for t, which act as default
1609 bindings, used when nothing else in the keymap applies; this makes it
1610 usable as a general function for probing keymaps. However, if the
1611 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1612 recognize the default bindings, just as `read-key-sequence' does.
1614 Like the normal command loop, `key-binding' will remap the command
1615 resulting from looking up KEY by looking up the command in the
1616 current keymaps. However, if the optional third argument NO-REMAP
1617 is non-nil, `key-binding' returns the unmapped command.
1619 If KEY is a key sequence initiated with the mouse, the used keymaps
1620 will depend on the clicked mouse position with regard to the buffer
1621 and possible local keymaps on strings.
1623 If the optional argument POSITION is non-nil, it specifies a mouse
1624 position as returned by `event-start' and `event-end', and the lookup
1625 occurs in the keymaps associated with it instead of KEY. It can also
1626 be a number or marker, in which case the keymap properties at the
1627 specified buffer position instead of point are used.
1629 (key
, accept_default
, no_remap
, position
)
1630 Lisp_Object key
, accept_default
, no_remap
, position
;
1632 Lisp_Object
*maps
, value
;
1634 struct gcpro gcpro1
, gcpro2
;
1635 int count
= SPECPDL_INDEX ();
1637 GCPRO2 (key
, position
);
1639 if (NILP (position
) && VECTORP (key
))
1642 /* mouse events may have a symbolic prefix indicating the
1643 scrollbar or mode line */
1644 = AREF (key
, SYMBOLP (AREF (key
, 0)) && ASIZE (key
) > 1 ? 1 : 0);
1646 /* We are not interested in locations without event data */
1648 if (EVENT_HAS_PARAMETERS (event
))
1650 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (event
));
1651 if (CONSP (XCDR (event
)) && EQ (kind
, Qmouse_click
))
1652 position
= EVENT_START (event
);
1656 /* Key sequences beginning with mouse clicks
1657 are read using the keymaps of the buffer clicked on, not
1658 the current buffer. So we may have to switch the buffer
1661 if (CONSP (position
))
1665 window
= POSN_WINDOW (position
);
1667 if (WINDOWP (window
)
1668 && BUFFERP (XWINDOW (window
)->buffer
)
1669 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
1671 /* Arrange to go back to the original buffer once we're done
1672 processing the key sequence. We don't use
1673 save_excursion_{save,restore} here, in analogy to
1674 `read-key-sequence' to avoid saving point. Maybe this
1675 would not be a problem here, but it is easier to keep
1679 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
1681 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
1685 if (! NILP (current_kboard
->Voverriding_terminal_local_map
))
1687 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1688 key
, accept_default
);
1689 if (! NILP (value
) && !INTEGERP (value
))
1692 else if (! NILP (Voverriding_local_map
))
1694 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1695 if (! NILP (value
) && !INTEGERP (value
))
1700 Lisp_Object keymap
, local_map
;
1703 pt
= INTEGERP (position
) ? XINT (position
)
1704 : MARKERP (position
) ? marker_position (position
)
1707 local_map
= get_local_map (pt
, current_buffer
, Qlocal_map
);
1708 keymap
= get_local_map (pt
, current_buffer
, Qkeymap
);
1710 if (CONSP (position
))
1714 /* For a mouse click, get the local text-property keymap
1715 of the place clicked on, rather than point. */
1717 if (POSN_INBUFFER_P (position
))
1721 pos
= POSN_BUFFER_POSN (position
);
1723 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
1725 local_map
= get_local_map (XINT (pos
),
1726 current_buffer
, Qlocal_map
);
1728 keymap
= get_local_map (XINT (pos
),
1729 current_buffer
, Qkeymap
);
1733 /* If on a mode line string with a local keymap,
1734 or for a click on a string, i.e. overlay string or a
1735 string displayed via the `display' property,
1736 consider `local-map' and `keymap' properties of
1739 if (string
= POSN_STRING (position
),
1740 (CONSP (string
) && STRINGP (XCAR (string
))))
1742 Lisp_Object pos
, map
;
1744 pos
= XCDR (string
);
1745 string
= XCAR (string
);
1748 && XINT (pos
) < SCHARS (string
))
1750 map
= Fget_text_property (pos
, Qlocal_map
, string
);
1754 map
= Fget_text_property (pos
, Qkeymap
, string
);
1762 if (! NILP (keymap
))
1764 value
= Flookup_key (keymap
, key
, accept_default
);
1765 if (! NILP (value
) && !INTEGERP (value
))
1769 nmaps
= current_minor_maps (0, &maps
);
1770 /* Note that all these maps are GCPRO'd
1771 in the places where we found them. */
1773 for (i
= 0; i
< nmaps
; i
++)
1774 if (! NILP (maps
[i
]))
1776 value
= Flookup_key (maps
[i
], key
, accept_default
);
1777 if (! NILP (value
) && !INTEGERP (value
))
1781 if (! NILP (local_map
))
1783 value
= Flookup_key (local_map
, key
, accept_default
);
1784 if (! NILP (value
) && !INTEGERP (value
))
1789 value
= Flookup_key (current_global_map
, key
, accept_default
);
1792 unbind_to (count
, Qnil
);
1795 if (NILP (value
) || INTEGERP (value
))
1798 /* If the result of the ordinary keymap lookup is an interactive
1799 command, look for a key binding (ie. remapping) for that command. */
1801 if (NILP (no_remap
) && SYMBOLP (value
))
1804 if (value1
= Fcommand_remapping (value
, position
), !NILP (value1
))
1811 /* GC is possible in this function if it autoloads a keymap. */
1813 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1814 doc
: /* Return the binding for command KEYS in current local keymap only.
1815 KEYS is a string or vector, a sequence of keystrokes.
1816 The binding is probably a symbol with a function definition.
1818 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1819 bindings; see the description of `lookup-key' for more details about this. */)
1820 (keys
, accept_default
)
1821 Lisp_Object keys
, accept_default
;
1823 register Lisp_Object map
;
1824 map
= current_buffer
->keymap
;
1827 return Flookup_key (map
, keys
, accept_default
);
1830 /* GC is possible in this function if it autoloads a keymap. */
1832 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1833 doc
: /* Return the binding for command KEYS in current global keymap only.
1834 KEYS is a string or vector, a sequence of keystrokes.
1835 The binding is probably a symbol with a function definition.
1836 This function's return values are the same as those of `lookup-key'
1839 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1840 bindings; see the description of `lookup-key' for more details about this. */)
1841 (keys
, accept_default
)
1842 Lisp_Object keys
, accept_default
;
1844 return Flookup_key (current_global_map
, keys
, accept_default
);
1847 /* GC is possible in this function if it autoloads a keymap. */
1849 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1850 doc
: /* Find the visible minor mode bindings of KEY.
1851 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1852 the symbol which names the minor mode binding KEY, and BINDING is
1853 KEY's definition in that mode. In particular, if KEY has no
1854 minor-mode bindings, return nil. If the first binding is a
1855 non-prefix, all subsequent bindings will be omitted, since they would
1856 be ignored. Similarly, the list doesn't include non-prefix bindings
1857 that come after prefix bindings.
1859 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1860 bindings; see the description of `lookup-key' for more details about this. */)
1861 (key
, accept_default
)
1862 Lisp_Object key
, accept_default
;
1864 Lisp_Object
*modes
, *maps
;
1866 Lisp_Object binding
;
1868 struct gcpro gcpro1
, gcpro2
;
1870 nmaps
= current_minor_maps (&modes
, &maps
);
1871 /* Note that all these maps are GCPRO'd
1872 in the places where we found them. */
1875 GCPRO2 (key
, binding
);
1877 for (i
= j
= 0; i
< nmaps
; i
++)
1879 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1880 && !INTEGERP (binding
))
1882 if (KEYMAPP (binding
))
1883 maps
[j
++] = Fcons (modes
[i
], binding
);
1885 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1889 return Flist (j
, maps
);
1892 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1893 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1894 A new sparse keymap is stored as COMMAND's function definition and its value.
1895 If a second optional argument MAPVAR is given, the map is stored as
1896 its value instead of as COMMAND's value; but COMMAND is still defined
1898 The third optional argument NAME, if given, supplies a menu name
1899 string for the map. This is required to use the keymap as a menu.
1900 This function returns COMMAND. */)
1901 (command
, mapvar
, name
)
1902 Lisp_Object command
, mapvar
, name
;
1905 map
= Fmake_sparse_keymap (name
);
1906 Ffset (command
, map
);
1910 Fset (command
, map
);
1914 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1915 doc
: /* Select KEYMAP as the global keymap. */)
1919 keymap
= get_keymap (keymap
, 1, 1);
1920 current_global_map
= keymap
;
1925 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1926 doc
: /* Select KEYMAP as the local keymap.
1927 If KEYMAP is nil, that means no local keymap. */)
1932 keymap
= get_keymap (keymap
, 1, 1);
1934 current_buffer
->keymap
= keymap
;
1939 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1940 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1943 return current_buffer
->keymap
;
1946 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1947 doc
: /* Return the current global keymap. */)
1950 return current_global_map
;
1953 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1954 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1958 int nmaps
= current_minor_maps (0, &maps
);
1960 return Flist (nmaps
, maps
);
1963 /* Help functions for describing and documenting keymaps. */
1967 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1968 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1969 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1973 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1977 /* Look for and break cycles. */
1978 while (!NILP (tem
= Frassq (cmd
, maps
)))
1980 Lisp_Object prefix
= XCAR (tem
);
1981 int lim
= XINT (Flength (XCAR (tem
)));
1982 if (lim
<= XINT (Flength (thisseq
)))
1983 { /* This keymap was already seen with a smaller prefix. */
1985 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1986 Faref (thisseq
, make_number (i
))))
1989 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1992 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1993 but maybe `cmd' occurs again further down in `maps', so keep
1995 maps
= XCDR (Fmemq (tem
, maps
));
1998 /* If the last key in thisseq is meta-prefix-char,
1999 turn it into a meta-ized keystroke. We know
2000 that the event we're about to append is an
2001 ascii keystroke since we're processing a
2005 int meta_bit
= meta_modifier
;
2006 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
2007 tem
= Fcopy_sequence (thisseq
);
2009 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
2011 /* This new sequence is the same length as
2012 thisseq, so stick it in the list right
2015 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
2019 tem
= append_key (thisseq
, key
);
2020 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
2025 accessible_keymaps_char_table (args
, index
, cmd
)
2026 Lisp_Object args
, index
, cmd
;
2028 accessible_keymaps_1 (index
, cmd
,
2032 XINT (XCDR (XCAR (args
))));
2035 /* This function cannot GC. */
2037 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
2039 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
2040 Returns a list of elements of the form (KEYS . MAP), where the sequence
2041 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
2042 so that the KEYS increase in length. The first element is ([] . KEYMAP).
2043 An optional argument PREFIX, if non-nil, should be a key sequence;
2044 then the value includes only maps for prefixes that start with PREFIX. */)
2046 Lisp_Object keymap
, prefix
;
2048 Lisp_Object maps
, tail
;
2051 /* no need for gcpro because we don't autoload any keymaps. */
2054 prefixlen
= XINT (Flength (prefix
));
2058 /* If a prefix was specified, start with the keymap (if any) for
2059 that prefix, so we don't waste time considering other prefixes. */
2061 tem
= Flookup_key (keymap
, prefix
, Qt
);
2062 /* Flookup_key may give us nil, or a number,
2063 if the prefix is not defined in this particular map.
2064 It might even give us a list that isn't a keymap. */
2065 tem
= get_keymap (tem
, 0, 0);
2068 /* Convert PREFIX to a vector now, so that later on
2069 we don't have to deal with the possibility of a string. */
2070 if (STRINGP (prefix
))
2075 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
2076 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
2080 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
2081 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2082 c
^= 0200 | meta_modifier
;
2083 ASET (copy
, i_before
, make_number (c
));
2087 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
2093 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
2094 get_keymap (keymap
, 1, 0)),
2097 /* For each map in the list maps,
2098 look at any other maps it points to,
2099 and stick them at the end if they are not already in the list.
2101 This is a breadth-first traversal, where tail is the queue of
2102 nodes, and maps accumulates a list of all nodes visited. */
2104 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
2106 register Lisp_Object thisseq
, thismap
;
2108 /* Does the current sequence end in the meta-prefix-char? */
2111 thisseq
= Fcar (Fcar (tail
));
2112 thismap
= Fcdr (Fcar (tail
));
2113 last
= make_number (XINT (Flength (thisseq
)) - 1);
2114 is_metized
= (XINT (last
) >= 0
2115 /* Don't metize the last char of PREFIX. */
2116 && XINT (last
) >= prefixlen
2117 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
2119 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
2123 elt
= XCAR (thismap
);
2127 if (CHAR_TABLE_P (elt
))
2129 map_char_table (accessible_keymaps_char_table
, Qnil
,
2130 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
2131 Fcons (tail
, thisseq
)));
2133 else if (VECTORP (elt
))
2137 /* Vector keymap. Scan all the elements. */
2138 for (i
= 0; i
< ASIZE (elt
); i
++)
2139 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
2140 maps
, tail
, thisseq
, is_metized
);
2143 else if (CONSP (elt
))
2144 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
2145 maps
, tail
, thisseq
,
2146 is_metized
&& INTEGERP (XCAR (elt
)));
2154 Lisp_Object Qsingle_key_description
, Qkey_description
;
2156 /* This function cannot GC. */
2158 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2159 doc
: /* Return a pretty description of key-sequence KEYS.
2160 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2161 Control characters turn into "C-foo" sequences, meta into "M-foo",
2162 spaces are put between sequence elements, etc. */)
2164 Lisp_Object keys
, prefix
;
2169 int size
= XINT (Flength (keys
));
2171 Lisp_Object sep
= build_string (" ");
2176 size
+= XINT (Flength (prefix
));
2178 /* This has one extra element at the end that we don't pass to Fconcat. */
2179 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2181 /* In effect, this computes
2182 (mapconcat 'single-key-description keys " ")
2183 but we shouldn't use mapconcat because it can do GC. */
2187 list
= prefix
, prefix
= Qnil
;
2188 else if (!NILP (keys
))
2189 list
= keys
, keys
= Qnil
;
2194 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2198 return empty_string
;
2199 return Fconcat (len
- 1, args
);
2203 size
= SCHARS (list
);
2204 else if (VECTORP (list
))
2205 size
= XVECTOR (list
)->size
;
2206 else if (CONSP (list
))
2207 size
= XINT (Flength (list
));
2209 wrong_type_argument (Qarrayp
, list
);
2218 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2219 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2220 c
^= 0200 | meta_modifier
;
2221 XSETFASTINT (key
, c
);
2223 else if (VECTORP (list
))
2225 key
= AREF (list
, i
++);
2237 || EQ (key
, meta_prefix_char
)
2238 || (XINT (key
) & meta_modifier
))
2240 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2242 if (EQ (key
, meta_prefix_char
))
2246 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2249 else if (EQ (key
, meta_prefix_char
))
2254 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2262 push_key_description (c
, p
, force_multibyte
)
2263 register unsigned int c
;
2265 int force_multibyte
;
2269 /* Clear all the meaningless bits above the meta bit. */
2270 c
&= meta_modifier
| ~ - meta_modifier
;
2271 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2272 | meta_modifier
| shift_modifier
| super_modifier
);
2274 if (! CHARACTERP (make_number (c2
)))
2276 /* KEY_DESCRIPTION_SIZE is large enough for this. */
2277 p
+= sprintf (p
, "[%d]", c
);
2281 if (c
& alt_modifier
)
2287 if ((c
& ctrl_modifier
) != 0
2288 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2292 c
&= ~ctrl_modifier
;
2294 if (c
& hyper_modifier
)
2298 c
-= hyper_modifier
;
2300 if (c
& meta_modifier
)
2306 if (c
& shift_modifier
)
2310 c
-= shift_modifier
;
2312 if (c
& super_modifier
)
2316 c
-= super_modifier
;
2332 else if (c
== Ctl ('M'))
2340 /* `C-' already added above. */
2341 if (c
> 0 && c
<= Ctl ('Z'))
2360 || (NILP (current_buffer
->enable_multibyte_characters
)
2361 && SINGLE_BYTE_CHAR_P (c
)
2362 && !force_multibyte
))
2368 /* Now we are sure that C is a valid character code. */
2369 if (NILP (current_buffer
->enable_multibyte_characters
)
2370 && ! force_multibyte
)
2371 *p
++ = multibyte_char_to_unibyte (c
, Qnil
);
2373 p
+= CHAR_STRING (c
, (unsigned char *) p
);
2379 /* This function cannot GC. */
2381 DEFUN ("single-key-description", Fsingle_key_description
,
2382 Ssingle_key_description
, 1, 2, 0,
2383 doc
: /* Return a pretty description of command character KEY.
2384 Control characters turn into C-whatever, etc.
2385 Optional argument NO-ANGLES non-nil means don't put angle brackets
2386 around function keys and event symbols. */)
2388 Lisp_Object key
, no_angles
;
2390 if (CONSP (key
) && lucid_event_type_list_p (key
))
2391 key
= Fevent_convert_list (key
);
2393 key
= EVENT_HEAD (key
);
2395 if (INTEGERP (key
)) /* Normal character */
2397 char tem
[KEY_DESCRIPTION_SIZE
];
2399 *push_key_description (XUINT (key
), tem
, 1) = 0;
2400 return build_string (tem
);
2402 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2404 if (NILP (no_angles
))
2407 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2408 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2409 return build_string (buffer
);
2412 return Fsymbol_name (key
);
2414 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2415 return Fcopy_sequence (key
);
2417 error ("KEY must be an integer, cons, symbol, or string");
2422 push_text_char_description (c
, p
)
2423 register unsigned int c
;
2435 *p
++ = c
+ 64; /* 'A' - 1 */
2447 /* This function cannot GC. */
2449 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2450 doc
: /* Return a pretty description of file-character CHARACTER.
2451 Control characters turn into "^char", etc. This differs from
2452 `single-key-description' which turns them into "C-char".
2453 Also, this function recognizes the 2**7 bit as the Meta character,
2454 whereas `single-key-description' uses the 2**27 bit for Meta.
2455 See Info node `(elisp)Describing Characters' for examples. */)
2457 Lisp_Object character
;
2459 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2460 unsigned char str
[6];
2463 CHECK_NUMBER (character
);
2465 c
= XINT (character
);
2466 if (!ASCII_CHAR_P (c
))
2468 int len
= CHAR_STRING (c
, str
);
2470 return make_multibyte_string (str
, 1, len
);
2473 *push_text_char_description (c
& 0377, str
) = 0;
2475 return build_string (str
);
2478 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2481 ascii_sequence_p (seq
)
2485 int len
= XINT (Flength (seq
));
2487 for (i
= 0; i
< len
; i
++)
2489 Lisp_Object ii
, elt
;
2491 XSETFASTINT (ii
, i
);
2492 elt
= Faref (seq
, ii
);
2495 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2503 /* where-is - finding a command in a set of keymaps. */
2505 static Lisp_Object
where_is_internal ();
2506 static Lisp_Object
where_is_internal_1 ();
2507 static void where_is_internal_2 ();
2509 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2510 Returns the first non-nil binding found in any of those maps. */
2513 shadow_lookup (shadow
, key
, flag
)
2514 Lisp_Object shadow
, key
, flag
;
2516 Lisp_Object tail
, value
;
2518 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2520 value
= Flookup_key (XCAR (tail
), key
, flag
);
2521 if (NATNUMP (value
))
2523 value
= Flookup_key (XCAR (tail
),
2524 Fsubstring (key
, make_number (0), value
), flag
);
2528 else if (!NILP (value
))
2534 static Lisp_Object Vmouse_events
;
2536 /* This function can GC if Flookup_key autoloads any keymaps. */
2539 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2540 Lisp_Object definition
, keymaps
;
2541 Lisp_Object firstonly
, noindirect
, no_remap
;
2543 Lisp_Object maps
= Qnil
;
2544 Lisp_Object found
, sequences
;
2545 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2546 /* 1 means ignore all menu bindings entirely. */
2547 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2549 /* If this command is remapped, then it has no key bindings
2551 if (NILP (no_remap
) && SYMBOLP (definition
))
2554 if (tem
= Fcommand_remapping (definition
, Qnil
), !NILP (tem
))
2559 while (CONSP (found
))
2563 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2564 found
= XCDR (found
);
2567 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2571 for (; !NILP (maps
); maps
= Fcdr (maps
))
2573 /* Key sequence to reach map, and the map that it reaches */
2574 register Lisp_Object
this, map
, tem
;
2576 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2577 [M-CHAR] sequences, check if last character of the sequence
2578 is the meta-prefix char. */
2582 this = Fcar (Fcar (maps
));
2583 map
= Fcdr (Fcar (maps
));
2584 last
= make_number (XINT (Flength (this)) - 1);
2585 last_is_meta
= (XINT (last
) >= 0
2586 && EQ (Faref (this, last
), meta_prefix_char
));
2588 /* if (nomenus && !ascii_sequence_p (this)) */
2589 if (nomenus
&& XINT (last
) >= 0
2590 && SYMBOLP (tem
= Faref (this, make_number (0)))
2591 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2592 /* If no menu entries should be returned, skip over the
2593 keymaps bound to `menu-bar' and `tool-bar' and other
2594 non-ascii prefixes like `C-down-mouse-2'. */
2601 /* Because the code we want to run on each binding is rather
2602 large, we don't want to have two separate loop bodies for
2603 sparse keymap bindings and tables; we want to iterate one
2604 loop body over both keymap and vector bindings.
2606 For this reason, if Fcar (map) is a vector, we don't
2607 advance map to the next element until i indicates that we
2608 have finished off the vector. */
2609 Lisp_Object elt
, key
, binding
;
2617 /* Set key and binding to the current key and binding, and
2618 advance map and i to the next binding. */
2621 Lisp_Object sequence
;
2623 /* In a vector, look at each element. */
2624 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2626 binding
= AREF (elt
, i
);
2627 XSETFASTINT (key
, i
);
2628 sequence
= where_is_internal_1 (binding
, key
, definition
,
2630 last
, nomenus
, last_is_meta
);
2631 if (!NILP (sequence
))
2632 sequences
= Fcons (sequence
, sequences
);
2635 else if (CHAR_TABLE_P (elt
))
2639 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2640 Qnil
), /* Result accumulator. */
2641 Fcons (Fcons (this, last
),
2642 Fcons (make_number (nomenus
),
2643 make_number (last_is_meta
))));
2644 map_char_table (where_is_internal_2
, Qnil
, elt
, args
);
2645 sequences
= XCDR (XCAR (args
));
2647 else if (CONSP (elt
))
2649 Lisp_Object sequence
;
2652 binding
= XCDR (elt
);
2654 sequence
= where_is_internal_1 (binding
, key
, definition
,
2656 last
, nomenus
, last_is_meta
);
2657 if (!NILP (sequence
))
2658 sequences
= Fcons (sequence
, sequences
);
2662 while (!NILP (sequences
))
2664 Lisp_Object sequence
, remapped
, function
;
2666 sequence
= XCAR (sequences
);
2667 sequences
= XCDR (sequences
);
2669 /* If the current sequence is a command remapping with
2670 format [remap COMMAND], find the key sequences
2671 which run COMMAND, and use those sequences instead. */
2674 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2675 && EQ (AREF (sequence
, 0), Qremap
)
2676 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2678 Lisp_Object remapped1
;
2680 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2681 if (CONSP (remapped1
))
2683 /* Verify that this key binding actually maps to the
2684 remapped command (see below). */
2685 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2687 sequence
= XCAR (remapped1
);
2688 remapped
= XCDR (remapped1
);
2689 goto record_sequence
;
2693 /* Verify that this key binding is not shadowed by another
2694 binding for the same key, before we say it exists.
2696 Mechanism: look for local definition of this key and if
2697 it is defined and does not match what we found then
2700 Either nil or number as value from Flookup_key
2702 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2706 /* Don't annoy user with strings from a menu such as
2707 Select Paste. Change them all to "(any string)",
2708 so that there seems to be only one menu item
2710 if (! NILP (sequence
))
2713 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2715 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2716 build_string ("(any string)"));
2719 /* It is a true unshadowed match. Record it, unless it's already
2720 been seen (as could happen when inheriting keymaps). */
2721 if (NILP (Fmember (sequence
, found
)))
2722 found
= Fcons (sequence
, found
);
2724 /* If firstonly is Qnon_ascii, then we can return the first
2725 binding we find. If firstonly is not Qnon_ascii but not
2726 nil, then we should return the first ascii-only binding
2728 if (EQ (firstonly
, Qnon_ascii
))
2729 RETURN_UNGCPRO (sequence
);
2730 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2731 RETURN_UNGCPRO (sequence
);
2733 if (CONSP (remapped
))
2735 sequence
= XCAR (remapped
);
2736 remapped
= XCDR (remapped
);
2737 goto record_sequence
;
2745 found
= Fnreverse (found
);
2747 /* firstonly may have been t, but we may have gone all the way through
2748 the keymaps without finding an all-ASCII key sequence. So just
2749 return the best we could find. */
2750 if (!NILP (firstonly
))
2751 return Fcar (found
);
2756 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2757 doc
: /* Return list of keys that invoke DEFINITION.
2758 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2759 If KEYMAP is nil, search all the currently active keymaps.
2760 If KEYMAP is a list of keymaps, search only those keymaps.
2762 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2763 rather than a list of all possible key sequences.
2764 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2765 no matter what it is.
2766 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2767 \(or their meta variants) and entirely reject menu bindings.
2769 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2770 to other keymaps or slots. This makes it possible to search for an
2771 indirect definition itself.
2773 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2774 that invoke a command which is remapped to DEFINITION, but include the
2775 remapped command in the returned list. */)
2776 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2777 Lisp_Object definition
, keymap
;
2778 Lisp_Object firstonly
, noindirect
, no_remap
;
2780 Lisp_Object sequences
, keymaps
;
2781 /* 1 means ignore all menu bindings entirely. */
2782 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2785 /* Find the relevant keymaps. */
2786 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2788 else if (!NILP (keymap
))
2789 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2791 keymaps
= Fcurrent_active_maps (Qnil
);
2793 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2794 We don't really need to check `keymap'. */
2795 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2799 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2801 /* Check heuristic-consistency of the cache. */
2802 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2803 where_is_cache
= Qnil
;
2805 if (NILP (where_is_cache
))
2807 /* We need to create the cache. */
2808 Lisp_Object args
[2];
2809 where_is_cache
= Fmake_hash_table (0, args
);
2810 where_is_cache_keymaps
= Qt
;
2812 /* Fill in the cache. */
2813 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2814 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2817 where_is_cache_keymaps
= keymaps
;
2820 /* We want to process definitions from the last to the first.
2821 Instead of consing, copy definitions to a vector and step
2822 over that vector. */
2823 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2824 n
= XINT (Flength (sequences
));
2825 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2826 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2827 defns
[i
++] = XCAR (sequences
);
2829 /* Verify that the key bindings are not shadowed. Note that
2830 the following can GC. */
2831 GCPRO2 (definition
, keymaps
);
2834 for (i
= n
- 1; i
>= 0; --i
)
2835 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2837 if (ascii_sequence_p (defns
[i
]))
2843 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2848 /* Kill the cache so that where_is_internal_1 doesn't think
2849 we're filling it up. */
2850 where_is_cache
= Qnil
;
2851 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2857 /* This is the function that Fwhere_is_internal calls using map_char_table.
2859 (((DEFINITION . NOINDIRECT) . RESULT)
2861 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2862 Since map_char_table doesn't really use the return value from this function,
2863 we the result append to RESULT, the slot in ARGS.
2865 KEY may be a cons (FROM . TO) where both FROM and TO are integers
2866 (i.e. character events).
2868 This function can GC because it calls where_is_internal_1 which can
2872 where_is_internal_2 (args
, key
, binding
)
2873 Lisp_Object args
, key
, binding
;
2875 Lisp_Object definition
, noindirect
, this, last
;
2876 Lisp_Object result
, sequence
;
2877 int nomenus
, last_is_meta
;
2878 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2880 GCPRO3 (args
, key
, binding
);
2881 definition
= XCAR (XCAR (XCAR (args
)));
2882 noindirect
= XCDR (XCAR (XCAR (args
)));
2883 this = XCAR (XCAR (XCDR (args
)));
2884 last
= XCDR (XCAR (XCDR (args
)));
2885 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2886 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2889 if (CONSP (key
) && INTEGERP (XCAR (key
)) && INTEGERP (XCDR (key
)))
2891 /* Try all ASCII characters. Try also non-ASCII characters but
2892 only the first and last one because trying all of them is
2893 extremely memory and time consuming.
2895 Fixme: Perhaps it should be allowed to store a cons directly
2896 in RESULT. -- handa@m17n.org */
2897 int from
= XINT (XCAR (key
)), to
= XINT (XCDR (key
));
2900 for (; from
<= to
; to
--)
2902 k
= make_number (to
);
2903 sequence
= where_is_internal_1 (binding
, k
, definition
, noindirect
,
2904 this, last
, nomenus
, last_is_meta
);
2905 if (!NILP (sequence
))
2906 result
= Fcons (sequence
, result
);
2913 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2914 this, last
, nomenus
, last_is_meta
);
2915 if (!NILP (sequence
))
2916 result
= Fcons (sequence
, Qnil
);
2919 if (! NILP (result
))
2920 nconc2 (XCAR (args
), result
);
2926 /* This function can GC because get_keyelt can. */
2929 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2930 nomenus
, last_is_meta
)
2931 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2932 int nomenus
, last_is_meta
;
2934 Lisp_Object sequence
;
2936 /* Search through indirections unless that's not wanted. */
2937 if (NILP (noindirect
))
2938 binding
= get_keyelt (binding
, 0);
2940 /* End this iteration if this element does not match
2943 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2944 || EQ (binding
, definition
)
2945 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2946 /* Doesn't match. */
2949 /* We have found a match. Construct the key sequence where we found it. */
2950 if (INTEGERP (key
) && last_is_meta
)
2952 sequence
= Fcopy_sequence (this);
2953 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2956 sequence
= append_key (this, key
);
2958 if (!NILP (where_is_cache
))
2960 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2961 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2968 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2970 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2971 doc
: /* Insert the list of all defined keys and their definitions.
2972 The list is inserted in the current buffer, while the bindings are
2973 looked up in BUFFER.
2974 The optional argument PREFIX, if non-nil, should be a key sequence;
2975 then we display only bindings that start with that prefix.
2976 The optional argument MENUS, if non-nil, says to mention menu bindings.
2977 \(Ordinarily these are omitted from the output.) */)
2978 (buffer
, prefix
, menus
)
2979 Lisp_Object buffer
, prefix
, menus
;
2981 Lisp_Object outbuf
, shadow
;
2982 int nomenu
= NILP (menus
);
2983 register Lisp_Object start1
;
2984 struct gcpro gcpro1
;
2986 char *alternate_heading
2988 Keyboard translations:\n\n\
2989 You type Translation\n\
2990 -------- -----------\n";
2995 outbuf
= Fcurrent_buffer ();
2997 /* Report on alternates for keys. */
2998 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
3001 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
3002 int translate_len
= SCHARS (Vkeyboard_translate_table
);
3004 for (c
= 0; c
< translate_len
; c
++)
3005 if (translate
[c
] != c
)
3007 char buf
[KEY_DESCRIPTION_SIZE
];
3010 if (alternate_heading
)
3012 insert_string (alternate_heading
);
3013 alternate_heading
= 0;
3016 bufend
= push_key_description (translate
[c
], buf
, 1);
3017 insert (buf
, bufend
- buf
);
3018 Findent_to (make_number (16), make_number (1));
3019 bufend
= push_key_description (c
, buf
, 1);
3020 insert (buf
, bufend
- buf
);
3024 /* Insert calls signal_after_change which may GC. */
3025 translate
= SDATA (Vkeyboard_translate_table
);
3031 if (!NILP (Vkey_translation_map
))
3032 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
3033 "Key translations", nomenu
, 1, 0, 0);
3036 /* Print the (major mode) local map. */
3038 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
3039 start1
= current_kboard
->Voverriding_terminal_local_map
;
3040 else if (!NILP (Voverriding_local_map
))
3041 start1
= Voverriding_local_map
;
3045 describe_map_tree (start1
, 1, shadow
, prefix
,
3046 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
3047 shadow
= Fcons (start1
, shadow
);
3051 /* Print the minor mode and major mode keymaps. */
3053 Lisp_Object
*modes
, *maps
;
3055 /* Temporarily switch to `buffer', so that we can get that buffer's
3056 minor modes correctly. */
3057 Fset_buffer (buffer
);
3059 nmaps
= current_minor_maps (&modes
, &maps
);
3060 Fset_buffer (outbuf
);
3062 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3063 XBUFFER (buffer
), Qkeymap
);
3066 describe_map_tree (start1
, 1, shadow
, prefix
,
3067 "\f\n`keymap' Property Bindings", nomenu
,
3069 shadow
= Fcons (start1
, shadow
);
3072 /* Print the minor mode maps. */
3073 for (i
= 0; i
< nmaps
; i
++)
3075 /* The title for a minor mode keymap
3076 is constructed at run time.
3077 We let describe_map_tree do the actual insertion
3078 because it takes care of other features when doing so. */
3081 if (!SYMBOLP (modes
[i
]))
3084 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
3088 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
3089 SCHARS (SYMBOL_NAME (modes
[i
])));
3090 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
3092 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
3093 p
+= sizeof (" Minor Mode Bindings") - 1;
3096 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
3097 title
, nomenu
, 0, 0, 0);
3098 shadow
= Fcons (maps
[i
], shadow
);
3101 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3102 XBUFFER (buffer
), Qlocal_map
);
3105 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
3106 describe_map_tree (start1
, 1, shadow
, prefix
,
3107 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
3109 describe_map_tree (start1
, 1, shadow
, prefix
,
3110 "\f\n`local-map' Property Bindings",
3113 shadow
= Fcons (start1
, shadow
);
3117 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
3118 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
3120 /* Print the function-key-map translations under this prefix. */
3121 if (!NILP (Vfunction_key_map
))
3122 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
3123 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
3129 /* Insert a description of the key bindings in STARTMAP,
3130 followed by those of all maps reachable through STARTMAP.
3131 If PARTIAL is nonzero, omit certain "uninteresting" commands
3132 (such as `undefined').
3133 If SHADOW is non-nil, it is a list of maps;
3134 don't mention keys which would be shadowed by any of them.
3135 PREFIX, if non-nil, says mention only keys that start with PREFIX.
3136 TITLE, if not 0, is a string to insert at the beginning.
3137 TITLE should not end with a colon or a newline; we supply that.
3138 If NOMENU is not 0, then omit menu-bar commands.
3140 If TRANSL is nonzero, the definitions are actually key translations
3141 so print strings and vectors differently.
3143 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
3146 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
3147 don't omit it; instead, mention it but say it is shadowed. */
3150 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
3151 always_title
, mention_shadow
)
3152 Lisp_Object startmap
, shadow
, prefix
;
3160 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
3161 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3168 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3171 GCPRO3 (maps
, seen
, sub_shadows
);
3177 /* Delete from MAPS each element that is for the menu bar. */
3178 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3180 Lisp_Object elt
, prefix
, tem
;
3183 prefix
= Fcar (elt
);
3184 if (XVECTOR (prefix
)->size
>= 1)
3186 tem
= Faref (prefix
, make_number (0));
3187 if (EQ (tem
, Qmenu_bar
))
3188 maps
= Fdelq (elt
, maps
);
3193 if (!NILP (maps
) || always_title
)
3197 insert_string (title
);
3200 insert_string (" Starting With ");
3201 insert1 (Fkey_description (prefix
, Qnil
));
3203 insert_string (":\n");
3205 insert_string (key_heading
);
3209 for (; !NILP (maps
); maps
= Fcdr (maps
))
3211 register Lisp_Object elt
, prefix
, tail
;
3214 prefix
= Fcar (elt
);
3218 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3222 shmap
= XCAR (tail
);
3224 /* If the sequence by which we reach this keymap is zero-length,
3225 then the shadow map for this keymap is just SHADOW. */
3226 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3227 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3229 /* If the sequence by which we reach this keymap actually has
3230 some elements, then the sequence's definition in SHADOW is
3231 what we should use. */
3234 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3235 if (INTEGERP (shmap
))
3239 /* If shmap is not nil and not a keymap,
3240 it completely shadows this map, so don't
3241 describe this map at all. */
3242 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3246 sub_shadows
= Fcons (shmap
, sub_shadows
);
3249 /* Maps we have already listed in this loop shadow this map. */
3250 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3253 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3255 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3258 describe_map (Fcdr (elt
), prefix
,
3259 transl
? describe_translation
: describe_command
,
3260 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3266 insert_string ("\n");
3271 static int previous_description_column
;
3274 describe_command (definition
, args
)
3275 Lisp_Object definition
, args
;
3277 register Lisp_Object tem1
;
3278 int column
= (int) current_column (); /* iftc */
3279 int description_column
;
3281 /* If column 16 is no good, go to col 32;
3282 but don't push beyond that--go to next line instead. */
3286 description_column
= 32;
3288 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3289 description_column
= 32;
3291 description_column
= 16;
3293 Findent_to (make_number (description_column
), make_number (1));
3294 previous_description_column
= description_column
;
3296 if (SYMBOLP (definition
))
3298 tem1
= SYMBOL_NAME (definition
);
3300 insert_string ("\n");
3302 else if (STRINGP (definition
) || VECTORP (definition
))
3303 insert_string ("Keyboard Macro\n");
3304 else if (KEYMAPP (definition
))
3305 insert_string ("Prefix Command\n");
3307 insert_string ("??\n");
3311 describe_translation (definition
, args
)
3312 Lisp_Object definition
, args
;
3314 register Lisp_Object tem1
;
3316 Findent_to (make_number (16), make_number (1));
3318 if (SYMBOLP (definition
))
3320 tem1
= SYMBOL_NAME (definition
);
3322 insert_string ("\n");
3324 else if (STRINGP (definition
) || VECTORP (definition
))
3326 insert1 (Fkey_description (definition
, Qnil
));
3327 insert_string ("\n");
3329 else if (KEYMAPP (definition
))
3330 insert_string ("Prefix Command\n");
3332 insert_string ("??\n");
3335 /* describe_map puts all the usable elements of a sparse keymap
3336 into an array of `struct describe_map_elt',
3337 then sorts them by the events. */
3339 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3341 /* qsort comparison function for sorting `struct describe_map_elt' by
3345 describe_map_compare (aa
, bb
)
3346 const void *aa
, *bb
;
3348 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3349 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3350 return ((XINT (a
->event
) > XINT (b
->event
))
3351 - (XINT (a
->event
) < XINT (b
->event
)));
3352 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3354 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3356 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3357 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3358 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3363 /* Describe the contents of map MAP, assuming that this map itself is
3364 reached by the sequence of prefix keys PREFIX (a string or vector).
3365 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3368 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3369 seen
, nomenu
, mention_shadow
)
3370 register Lisp_Object map
;
3372 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3379 Lisp_Object tail
, definition
, event
;
3381 Lisp_Object suppress
;
3384 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3386 /* These accumulate the values from sparse keymap bindings,
3387 so we can sort them and handle them in order. */
3388 int length_needed
= 0;
3389 struct describe_map_elt
*vect
;
3396 suppress
= intern ("suppress-keymap");
3398 /* This vector gets used to present single keys to Flookup_key. Since
3399 that is done once per keymap element, we don't want to cons up a
3400 fresh vector every time. */
3401 kludge
= Fmake_vector (make_number (1), Qnil
);
3404 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3407 vect
= ((struct describe_map_elt
*)
3408 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3410 GCPRO3 (prefix
, definition
, kludge
);
3412 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3416 if (VECTORP (XCAR (tail
))
3417 || CHAR_TABLE_P (XCAR (tail
)))
3418 describe_vector (XCAR (tail
),
3419 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3420 (int *)0, 0, 1, mention_shadow
);
3421 else if (CONSP (XCAR (tail
)))
3423 int this_shadowed
= 0;
3425 event
= XCAR (XCAR (tail
));
3427 /* Ignore bindings whose "prefix" are not really valid events.
3428 (We get these in the frames and buffers menu.) */
3429 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3432 if (nomenu
&& EQ (event
, Qmenu_bar
))
3435 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3437 /* Don't show undefined commands or suppressed commands. */
3438 if (NILP (definition
)) continue;
3439 if (SYMBOLP (definition
) && partial
)
3441 tem
= Fget (definition
, suppress
);
3446 /* Don't show a command that isn't really visible
3447 because a local definition of the same key shadows it. */
3449 ASET (kludge
, 0, event
);
3452 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3455 /* If both bindings are keymaps, this key is a prefix key,
3456 so don't say it is shadowed. */
3457 if (KEYMAPP (definition
) && KEYMAPP (tem
))
3459 /* Avoid generating duplicate entries if the
3460 shadowed binding has the same definition. */
3461 else if (mention_shadow
&& !EQ (tem
, definition
))
3468 tem
= Flookup_key (map
, kludge
, Qt
);
3469 if (!EQ (tem
, definition
)) continue;
3471 vect
[slots_used
].event
= event
;
3472 vect
[slots_used
].definition
= definition
;
3473 vect
[slots_used
].shadowed
= this_shadowed
;
3476 else if (EQ (XCAR (tail
), Qkeymap
))
3478 /* The same keymap might be in the structure twice, if we're
3479 using an inherited keymap. So skip anything we've already
3481 tem
= Fassq (tail
, *seen
);
3482 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3484 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3488 /* If we found some sparse map events, sort them. */
3490 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3491 describe_map_compare
);
3493 /* Now output them in sorted order. */
3495 for (i
= 0; i
< slots_used
; i
++)
3497 Lisp_Object start
, end
;
3501 previous_description_column
= 0;
3506 ASET (kludge
, 0, vect
[i
].event
);
3507 start
= vect
[i
].event
;
3510 definition
= vect
[i
].definition
;
3512 /* Find consecutive chars that are identically defined. */
3513 if (INTEGERP (vect
[i
].event
))
3515 while (i
+ 1 < slots_used
3516 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3517 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3518 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3520 end
= vect
[i
].event
;
3523 /* Now START .. END is the range to describe next. */
3525 /* Insert the string to describe the event START. */
3526 insert1 (Fkey_description (kludge
, prefix
));
3528 if (!EQ (start
, end
))
3532 ASET (kludge
, 0, end
);
3533 /* Insert the string to describe the character END. */
3534 insert1 (Fkey_description (kludge
, prefix
));
3537 /* Print a description of the definition of this character.
3538 elt_describer will take care of spacing out far enough
3539 for alignment purposes. */
3540 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3542 if (vect
[i
].shadowed
)
3545 insert_string ("\n (that binding is currently shadowed by another mode)");
3554 describe_vector_princ (elt
, fun
)
3555 Lisp_Object elt
, fun
;
3557 Findent_to (make_number (16), make_number (1));
3562 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3563 doc
: /* Insert a description of contents of VECTOR.
3564 This is text showing the elements of vector matched against indices.
3565 DESCRIBER is the output function used; nil means use `princ'. */)
3567 Lisp_Object vector
, describer
;
3569 int count
= SPECPDL_INDEX ();
3570 if (NILP (describer
))
3571 describer
= intern ("princ");
3572 specbind (Qstandard_output
, Fcurrent_buffer ());
3573 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3574 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3575 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3577 return unbind_to (count
, Qnil
);
3580 /* Insert in the current buffer a description of the contents of VECTOR.
3581 We call ELT_DESCRIBER to insert the description of one value found
3584 ELT_PREFIX describes what "comes before" the keys or indices defined
3585 by this vector. This is a human-readable string whose size
3586 is not necessarily related to the situation.
3588 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3589 leads to this keymap.
3591 If the vector is a chartable, ELT_PREFIX is the vector
3592 of bytes that lead to the character set or portion of a character
3593 set described by this chartable.
3595 If PARTIAL is nonzero, it means do not mention suppressed commands
3596 (that assumes the vector is in a keymap).
3598 SHADOW is a list of keymaps that shadow this map.
3599 If it is non-nil, then we look up the key in those maps
3600 and we don't mention it now if it is defined by any of them.
3602 ENTIRE_MAP is the keymap in which this vector appears.
3603 If the definition in effect in the whole map does not match
3604 the one in this vector, we ignore this one.
3606 ARGS is simply passed as the second argument to ELT_DESCRIBER.
3608 INDICES and CHAR_TABLE_DEPTH are ignored. They will be removed in
3611 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3613 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3616 describe_vector (vector
, prefix
, args
, elt_describer
,
3617 partial
, shadow
, entire_map
,
3618 indices
, char_table_depth
, keymap_p
,
3620 register Lisp_Object vector
;
3621 Lisp_Object prefix
, args
;
3622 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3625 Lisp_Object entire_map
;
3627 int char_table_depth
;
3631 Lisp_Object definition
;
3633 Lisp_Object elt_prefix
= Qnil
;
3635 Lisp_Object suppress
;
3638 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3639 /* Range of elements to be handled. */
3641 Lisp_Object character
;
3650 /* Call Fkey_description first, to avoid GC bug for the other string. */
3651 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3654 tem
= Fkey_description (prefix
, Qnil
);
3655 elt_prefix
= concat2 (tem
, build_string (" "));
3660 /* This vector gets used to present single keys to Flookup_key. Since
3661 that is done once per vector element, we don't want to cons up a
3662 fresh vector every time. */
3663 kludge
= Fmake_vector (make_number (1), Qnil
);
3664 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3667 suppress
= intern ("suppress-keymap");
3670 to
= CHAR_TABLE_P (vector
) ? MAX_CHAR
+ 1 : XVECTOR (vector
)->size
;
3672 for (i
= from
; i
< to
; i
++)
3674 int this_shadowed
= 0;
3675 int range_beg
, range_end
;
3682 if (CHAR_TABLE_P (vector
))
3683 val
= char_table_ref_and_range (vector
, i
, &range_beg
, &i
);
3685 val
= AREF (vector
, i
);
3686 definition
= get_keyelt (val
, 0);
3688 if (NILP (definition
)) continue;
3690 /* Don't mention suppressed commands. */
3691 if (SYMBOLP (definition
) && partial
)
3695 tem
= Fget (definition
, suppress
);
3697 if (!NILP (tem
)) continue;
3700 character
= make_number (starting_i
);
3701 ASET (kludge
, 0, character
);
3703 /* If this binding is shadowed by some other map, ignore it. */
3708 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3719 /* Ignore this definition if it is shadowed by an earlier
3720 one in the same keymap. */
3721 if (!NILP (entire_map
))
3725 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3727 if (!EQ (tem
, definition
))
3737 /* Output the prefix that applies to every entry in this map. */
3738 if (!NILP (elt_prefix
))
3739 insert1 (elt_prefix
);
3741 insert1 (Fkey_description (kludge
, prefix
));
3743 /* Find all consecutive characters or rows that have the same
3744 definition. But, for elements of a top level char table, if
3745 they are for charsets, we had better describe one by one even
3746 if they have the same definition. */
3747 if (CHAR_TABLE_P (vector
))
3749 && (val
= char_table_ref_and_range (vector
, i
+ 1,
3750 &range_beg
, &range_end
),
3751 tem2
= get_keyelt (val
, 0),
3753 && !NILP (Fequal (tem2
, definition
)))
3757 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3759 && !NILP (Fequal (tem2
, definition
)))
3762 /* If we have a range of more than one character,
3763 print where the range reaches to. */
3765 if (i
!= starting_i
)
3769 ASET (kludge
, 0, make_number (i
));
3771 if (!NILP (elt_prefix
))
3772 insert1 (elt_prefix
);
3774 insert1 (Fkey_description (kludge
, prefix
));
3777 /* Print a description of the definition of this character.
3778 elt_describer will take care of spacing out far enough
3779 for alignment purposes. */
3780 (*elt_describer
) (definition
, args
);
3785 insert_string (" (binding currently shadowed)");
3790 if (CHAR_TABLE_P (vector
) && ! NILP (XCHAR_TABLE (vector
)->defalt
))
3792 if (!NILP (elt_prefix
))
3793 insert1 (elt_prefix
);
3794 insert ("default", 7);
3795 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3801 /* Apropos - finding all symbols whose names match a regexp. */
3802 static Lisp_Object apropos_predicate
;
3803 static Lisp_Object apropos_accumulate
;
3806 apropos_accum (symbol
, string
)
3807 Lisp_Object symbol
, string
;
3809 register Lisp_Object tem
;
3811 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3812 if (!NILP (tem
) && !NILP (apropos_predicate
))
3813 tem
= call1 (apropos_predicate
, symbol
);
3815 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3818 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3819 doc
: /* Show all symbols whose names contain match for REGEXP.
3820 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3821 for each symbol and a symbol is mentioned only if that returns non-nil.
3822 Return list of symbols found. */)
3824 Lisp_Object regexp
, predicate
;
3827 CHECK_STRING (regexp
);
3828 apropos_predicate
= predicate
;
3829 apropos_accumulate
= Qnil
;
3830 map_obarray (Vobarray
, apropos_accum
, regexp
);
3831 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3832 apropos_accumulate
= Qnil
;
3833 apropos_predicate
= Qnil
;
3840 Qkeymap
= intern ("keymap");
3841 staticpro (&Qkeymap
);
3842 staticpro (&apropos_predicate
);
3843 staticpro (&apropos_accumulate
);
3844 apropos_predicate
= Qnil
;
3845 apropos_accumulate
= Qnil
;
3847 /* Now we are ready to set up this property, so we can
3848 create char tables. */
3849 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3851 /* Initialize the keymaps standardly used.
3852 Each one is the value of a Lisp variable, and is also
3853 pointed to by a C variable */
3855 global_map
= Fmake_keymap (Qnil
);
3856 Fset (intern ("global-map"), global_map
);
3858 current_global_map
= global_map
;
3859 staticpro (&global_map
);
3860 staticpro (¤t_global_map
);
3862 meta_map
= Fmake_keymap (Qnil
);
3863 Fset (intern ("esc-map"), meta_map
);
3864 Ffset (intern ("ESC-prefix"), meta_map
);
3866 control_x_map
= Fmake_keymap (Qnil
);
3867 Fset (intern ("ctl-x-map"), control_x_map
);
3868 Ffset (intern ("Control-X-prefix"), control_x_map
);
3871 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3872 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3873 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3874 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3875 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3877 staticpro (&exclude_keys
);
3879 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3880 doc
: /* List of commands given new key bindings recently.
3881 This is used for internal purposes during Emacs startup;
3882 don't alter it yourself. */);
3883 Vdefine_key_rebound_commands
= Qt
;
3885 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3886 doc
: /* Default keymap to use when reading from the minibuffer. */);
3887 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3889 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3890 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3891 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3892 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3894 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3895 doc
: /* Local keymap for minibuffer input with completion. */);
3896 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3897 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3899 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3900 &Vminibuffer_local_filename_completion_map
,
3901 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3902 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3903 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3904 Vminibuffer_local_completion_map
);
3907 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3908 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3909 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3910 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3911 Vminibuffer_local_completion_map
);
3913 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3914 &Vminibuffer_local_must_match_filename_map
,
3915 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3916 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3917 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3918 Vminibuffer_local_must_match_map
);
3920 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3921 doc
: /* Alist of keymaps to use for minor modes.
3922 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3923 key sequences and look up bindings iff VARIABLE's value is non-nil.
3924 If two active keymaps bind the same key, the keymap appearing earlier
3925 in the list takes precedence. */);
3926 Vminor_mode_map_alist
= Qnil
;
3928 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3929 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3930 This variable is an alist just like `minor-mode-map-alist', and it is
3931 used the same way (and before `minor-mode-map-alist'); however,
3932 it is provided for major modes to bind locally. */);
3933 Vminor_mode_overriding_map_alist
= Qnil
;
3935 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3936 doc
: /* List of keymap alists to use for emulations modes.
3937 It is intended for modes or packages using multiple minor-mode keymaps.
3938 Each element is a keymap alist just like `minor-mode-map-alist', or a
3939 symbol with a variable binding which is a keymap alist, and it is used
3940 the same way. The "active" keymaps in each alist are used before
3941 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3942 Vemulation_mode_map_alists
= Qnil
;
3945 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3946 doc
: /* Keymap that translates key sequences to key sequences during input.
3947 This is used mainly for mapping ASCII function key sequences into
3948 real Emacs function key events (symbols).
3950 The `read-key-sequence' function replaces any subsequence bound by
3951 `function-key-map' with its binding. More precisely, when the active
3952 keymaps have no binding for the current key sequence but
3953 `function-key-map' binds a suffix of the sequence to a vector or string,
3954 `read-key-sequence' replaces the matching suffix with its binding, and
3955 continues with the new sequence.
3957 If the binding is a function, it is called with one argument (the prompt)
3958 and its return value (a key sequence) is used.
3960 The events that come from bindings in `function-key-map' are not
3961 themselves looked up in `function-key-map'.
3963 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3964 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3965 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3966 key, typing `ESC O P x' would return [f1 x]. */);
3967 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3969 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3970 doc
: /* Keymap of key translations that can override keymaps.
3971 This keymap works like `function-key-map', but comes after that,
3972 and its non-prefix bindings override ordinary bindings. */);
3973 Vkey_translation_map
= Qnil
;
3975 staticpro (&Vmouse_events
);
3976 Vmouse_events
= Fcons (intern ("menu-bar"),
3977 Fcons (intern ("tool-bar"),
3978 Fcons (intern ("header-line"),
3979 Fcons (intern ("mode-line"),
3980 Fcons (intern ("mouse-1"),
3981 Fcons (intern ("mouse-2"),
3982 Fcons (intern ("mouse-3"),
3983 Fcons (intern ("mouse-4"),
3984 Fcons (intern ("mouse-5"),
3988 Qsingle_key_description
= intern ("single-key-description");
3989 staticpro (&Qsingle_key_description
);
3991 Qkey_description
= intern ("key-description");
3992 staticpro (&Qkey_description
);
3994 Qkeymapp
= intern ("keymapp");
3995 staticpro (&Qkeymapp
);
3997 Qnon_ascii
= intern ("non-ascii");
3998 staticpro (&Qnon_ascii
);
4000 Qmenu_item
= intern ("menu-item");
4001 staticpro (&Qmenu_item
);
4003 Qremap
= intern ("remap");
4004 staticpro (&Qremap
);
4006 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
4007 staticpro (&command_remapping_vector
);
4009 where_is_cache_keymaps
= Qt
;
4010 where_is_cache
= Qnil
;
4011 staticpro (&where_is_cache
);
4012 staticpro (&where_is_cache_keymaps
);
4014 defsubr (&Skeymapp
);
4015 defsubr (&Skeymap_parent
);
4016 defsubr (&Skeymap_prompt
);
4017 defsubr (&Sset_keymap_parent
);
4018 defsubr (&Smake_keymap
);
4019 defsubr (&Smake_sparse_keymap
);
4020 defsubr (&Smap_keymap
);
4021 defsubr (&Scopy_keymap
);
4022 defsubr (&Scommand_remapping
);
4023 defsubr (&Skey_binding
);
4024 defsubr (&Slocal_key_binding
);
4025 defsubr (&Sglobal_key_binding
);
4026 defsubr (&Sminor_mode_key_binding
);
4027 defsubr (&Sdefine_key
);
4028 defsubr (&Slookup_key
);
4029 defsubr (&Sdefine_prefix_command
);
4030 defsubr (&Suse_global_map
);
4031 defsubr (&Suse_local_map
);
4032 defsubr (&Scurrent_local_map
);
4033 defsubr (&Scurrent_global_map
);
4034 defsubr (&Scurrent_minor_mode_maps
);
4035 defsubr (&Scurrent_active_maps
);
4036 defsubr (&Saccessible_keymaps
);
4037 defsubr (&Skey_description
);
4038 defsubr (&Sdescribe_vector
);
4039 defsubr (&Ssingle_key_description
);
4040 defsubr (&Stext_char_description
);
4041 defsubr (&Swhere_is_internal
);
4042 defsubr (&Sdescribe_buffer_bindings
);
4043 defsubr (&Sapropos_internal
);
4049 initial_define_key (global_map
, 033, "ESC-prefix");
4050 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
4053 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
4054 (do not change this comment) */