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.
1152 (See info node `(elisp)Extended Menu Items'.)
1154 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1155 binding is altered. If there is no binding for KEY, the new pair
1156 binding KEY to DEF is added at the front of KEYMAP. */)
1163 register Lisp_Object c
;
1164 register Lisp_Object cmd
;
1168 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1170 GCPRO3 (keymap
, key
, def
);
1171 keymap
= get_keymap (keymap
, 1, 1);
1173 CHECK_VECTOR_OR_STRING (key
);
1175 length
= XFASTINT (Flength (key
));
1177 RETURN_UNGCPRO (Qnil
);
1179 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1180 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1182 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1184 if (VECTORP (def
) && ASIZE (def
) > 0 && CONSP (AREF (def
, 0)))
1185 { /* DEF is apparently an XEmacs-style keyboard macro. */
1186 Lisp_Object tmp
= Fmake_vector (make_number (ASIZE (def
)), Qnil
);
1187 int i
= ASIZE (def
);
1190 Lisp_Object c
= AREF (def
, i
);
1191 if (CONSP (c
) && lucid_event_type_list_p (c
))
1192 c
= Fevent_convert_list (c
);
1201 c
= Faref (key
, make_number (idx
));
1205 /* C may be a Lucid style event type list or a cons (FROM .
1206 TO) specifying a range of characters. */
1207 if (lucid_event_type_list_p (c
))
1208 c
= Fevent_convert_list (c
);
1209 else if (CHARACTERP (XCAR (c
)))
1210 CHECK_CHARACTER_CDR (c
);
1214 silly_event_symbol_error (c
);
1217 && (XINT (c
) & meta_bit
)
1220 c
= meta_prefix_char
;
1226 XSETINT (c
, XINT (c
) & ~meta_bit
);
1232 if (!INTEGERP (c
) && !SYMBOLP (c
)
1234 /* If C is a range, it must be a leaf. */
1235 || (INTEGERP (XCAR (c
)) && idx
!= length
)))
1236 error ("Key sequence contains invalid event");
1239 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1241 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1243 /* If this key is undefined, make it a prefix. */
1245 cmd
= define_as_prefix (keymap
, c
);
1247 keymap
= get_keymap (cmd
, 0, 1);
1248 if (!CONSP (keymap
))
1249 /* We must use Fkey_description rather than just passing key to
1250 error; key might be a vector, not a string. */
1251 error ("Key sequence %s starts with non-prefix key %s",
1252 SDATA (Fkey_description (key
, Qnil
)),
1253 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1259 /* This function may GC (it calls Fkey_binding). */
1261 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 3, 0,
1262 doc
: /* Return the remapping for command COMMAND.
1263 Returns nil if COMMAND is not remapped (or not a symbol).
1265 If the optional argument POSITION is non-nil, it specifies a mouse
1266 position as returned by `event-start' and `event-end', and the
1267 remapping occurs in the keymaps associated with it. It can also be a
1268 number or marker, in which case the keymap properties at the specified
1269 buffer position instead of point are used. The KEYMAPS argument is
1270 ignored if POSITION is non-nil.
1272 If the optional argument KEYMAPS is non-nil, it should be a list of
1273 keymaps to search for command remapping. Otherwise, search for the
1274 remapping in all currently active keymaps. */)
1275 (command
, position
, keymaps
)
1276 Lisp_Object command
, position
, keymaps
;
1278 if (!SYMBOLP (command
))
1281 ASET (command_remapping_vector
, 1, command
);
1284 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
, position
);
1287 Lisp_Object maps
, binding
;
1289 for (maps
= keymaps
; !NILP (maps
); maps
= Fcdr (maps
))
1291 binding
= Flookup_key (Fcar (maps
), command_remapping_vector
, Qnil
);
1292 if (!NILP (binding
) && !INTEGERP (binding
))
1299 /* Value is number if KEY is too long; nil if valid but has no definition. */
1300 /* GC is possible in this function if it autoloads a keymap. */
1302 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1303 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1304 A value of nil means undefined. See doc of `define-key'
1305 for kinds of definitions.
1307 A number as value means KEY is "too long";
1308 that is, characters or symbols in it except for the last one
1309 fail to be a valid sequence of prefix characters in KEYMAP.
1310 The number is how many characters at the front of KEY
1311 it takes to reach a non-prefix key.
1313 Normally, `lookup-key' ignores bindings for t, which act as default
1314 bindings, used when nothing else in the keymap applies; this makes it
1315 usable as a general function for probing keymaps. However, if the
1316 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1317 recognize the default bindings, just as `read-key-sequence' does. */)
1318 (keymap
, key
, accept_default
)
1321 Lisp_Object accept_default
;
1324 register Lisp_Object cmd
;
1325 register Lisp_Object c
;
1327 int t_ok
= !NILP (accept_default
);
1328 struct gcpro gcpro1
, gcpro2
;
1330 GCPRO2 (keymap
, key
);
1331 keymap
= get_keymap (keymap
, 1, 1);
1333 CHECK_VECTOR_OR_STRING (key
);
1335 length
= XFASTINT (Flength (key
));
1337 RETURN_UNGCPRO (keymap
);
1342 c
= Faref (key
, make_number (idx
++));
1344 if (CONSP (c
) && lucid_event_type_list_p (c
))
1345 c
= Fevent_convert_list (c
);
1347 /* Turn the 8th bit of string chars into a meta modifier. */
1348 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1349 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1351 /* Allow string since binding for `menu-bar-select-buffer'
1352 includes the buffer name in the key sequence. */
1353 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1354 error ("Key sequence contains invalid event");
1356 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1358 RETURN_UNGCPRO (cmd
);
1360 keymap
= get_keymap (cmd
, 0, 1);
1361 if (!CONSP (keymap
))
1362 RETURN_UNGCPRO (make_number (idx
));
1368 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1369 Assume that currently it does not define C at all.
1370 Return the keymap. */
1373 define_as_prefix (keymap
, c
)
1374 Lisp_Object keymap
, c
;
1378 cmd
= Fmake_sparse_keymap (Qnil
);
1379 /* If this key is defined as a prefix in an inherited keymap,
1380 make it a prefix in this map, and make its definition
1381 inherit the other prefix definition. */
1382 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1383 store_in_keymap (keymap
, c
, cmd
);
1388 /* Append a key to the end of a key sequence. We always make a vector. */
1391 append_key (key_sequence
, key
)
1392 Lisp_Object key_sequence
, key
;
1394 Lisp_Object args
[2];
1396 args
[0] = key_sequence
;
1398 args
[1] = Fcons (key
, Qnil
);
1399 return Fvconcat (2, args
);
1402 /* Given a event type C which is a symbol,
1403 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1406 silly_event_symbol_error (c
)
1409 Lisp_Object parsed
, base
, name
, assoc
;
1412 parsed
= parse_modifiers (c
);
1413 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1414 base
= XCAR (parsed
);
1415 name
= Fsymbol_name (base
);
1416 /* This alist includes elements such as ("RET" . "\\r"). */
1417 assoc
= Fassoc (name
, exclude_keys
);
1421 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1423 Lisp_Object keystring
;
1424 if (modifiers
& alt_modifier
)
1425 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1426 if (modifiers
& ctrl_modifier
)
1427 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1428 if (modifiers
& hyper_modifier
)
1429 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1430 if (modifiers
& meta_modifier
)
1431 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1432 if (modifiers
& shift_modifier
)
1433 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1434 if (modifiers
& super_modifier
)
1435 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1438 c
= reorder_modifiers (c
);
1439 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1441 error ((modifiers
& ~meta_modifier
1442 ? "To bind the key %s, use [?%s], not [%s]"
1443 : "To bind the key %s, use \"%s\", not [%s]"),
1444 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1445 SDATA (SYMBOL_NAME (c
)));
1449 /* Global, local, and minor mode keymap stuff. */
1451 /* We can't put these variables inside current_minor_maps, since under
1452 some systems, static gets macro-defined to be the empty string.
1454 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1455 static int cmm_size
= 0;
1457 /* Store a pointer to an array of the currently active minor modes in
1458 *modeptr, a pointer to an array of the keymaps of the currently
1459 active minor modes in *mapptr, and return the number of maps
1462 This function always returns a pointer to the same buffer, and may
1463 free or reallocate it, so if you want to keep it for a long time or
1464 hand it out to lisp code, copy it. This procedure will be called
1465 for every key sequence read, so the nice lispy approach (return a
1466 new assoclist, list, what have you) for each invocation would
1467 result in a lot of consing over time.
1469 If we used xrealloc/xmalloc and ran out of memory, they would throw
1470 back to the command loop, which would try to read a key sequence,
1471 which would call this function again, resulting in an infinite
1472 loop. Instead, we'll use realloc/malloc and silently truncate the
1473 list, let the key sequence be read, and hope some other piece of
1474 code signals the error. */
1476 current_minor_maps (modeptr
, mapptr
)
1477 Lisp_Object
**modeptr
, **mapptr
;
1480 int list_number
= 0;
1481 Lisp_Object alist
, assoc
, var
, val
;
1482 Lisp_Object emulation_alists
;
1483 Lisp_Object lists
[2];
1485 emulation_alists
= Vemulation_mode_map_alists
;
1486 lists
[0] = Vminor_mode_overriding_map_alist
;
1487 lists
[1] = Vminor_mode_map_alist
;
1489 for (list_number
= 0; list_number
< 2; list_number
++)
1491 if (CONSP (emulation_alists
))
1493 alist
= XCAR (emulation_alists
);
1494 emulation_alists
= XCDR (emulation_alists
);
1495 if (SYMBOLP (alist
))
1496 alist
= find_symbol_value (alist
);
1500 alist
= lists
[list_number
];
1502 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1503 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1504 && (var
= XCAR (assoc
), SYMBOLP (var
))
1505 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1510 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1511 and also an entry in Vminor_mode_map_alist,
1512 ignore the latter. */
1513 if (list_number
== 1)
1515 val
= assq_no_quit (var
, lists
[0]);
1522 int newsize
, allocsize
;
1523 Lisp_Object
*newmodes
, *newmaps
;
1525 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1526 allocsize
= newsize
* sizeof *newmodes
;
1528 /* Use malloc here. See the comment above this function.
1529 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1531 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1536 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1539 cmm_modes
= newmodes
;
1542 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1547 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1554 if (newmodes
== NULL
|| newmaps
== NULL
)
1559 /* Get the keymap definition--or nil if it is not defined. */
1560 temp
= Findirect_function (XCDR (assoc
), Qt
);
1564 cmm_maps
[i
] = temp
;
1570 if (modeptr
) *modeptr
= cmm_modes
;
1571 if (mapptr
) *mapptr
= cmm_maps
;
1575 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1577 doc
: /* Return a list of the currently active keymaps.
1578 OLP if non-nil indicates that we should obey `overriding-local-map' and
1579 `overriding-terminal-local-map'. */)
1583 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1587 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1588 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1589 /* The doc said that overriding-terminal-local-map should
1590 override overriding-local-map. The code used them both,
1591 but it seems clearer to use just one. rms, jan 2005. */
1592 else if (!NILP (Voverriding_local_map
))
1593 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1595 if (NILP (XCDR (keymaps
)))
1601 /* This usually returns the buffer's local map,
1602 but that can be overridden by a `local-map' property. */
1603 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1605 keymaps
= Fcons (local
, keymaps
);
1607 /* Now put all the minor mode keymaps on the list. */
1608 nmaps
= current_minor_maps (0, &maps
);
1610 for (i
= --nmaps
; i
>= 0; i
--)
1611 if (!NILP (maps
[i
]))
1612 keymaps
= Fcons (maps
[i
], keymaps
);
1614 /* This returns nil unless there is a `keymap' property. */
1615 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1617 keymaps
= Fcons (local
, keymaps
);
1623 /* GC is possible in this function if it autoloads a keymap. */
1625 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 4, 0,
1626 doc
: /* Return the binding for command KEY in current keymaps.
1627 KEY is a string or vector, a sequence of keystrokes.
1628 The binding is probably a symbol with a function definition.
1630 Normally, `key-binding' ignores bindings for t, which act as default
1631 bindings, used when nothing else in the keymap applies; this makes it
1632 usable as a general function for probing keymaps. However, if the
1633 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1634 recognize the default bindings, just as `read-key-sequence' does.
1636 Like the normal command loop, `key-binding' will remap the command
1637 resulting from looking up KEY by looking up the command in the
1638 current keymaps. However, if the optional third argument NO-REMAP
1639 is non-nil, `key-binding' returns the unmapped command.
1641 If KEY is a key sequence initiated with the mouse, the used keymaps
1642 will depend on the clicked mouse position with regard to the buffer
1643 and possible local keymaps on strings.
1645 If the optional argument POSITION is non-nil, it specifies a mouse
1646 position as returned by `event-start' and `event-end', and the lookup
1647 occurs in the keymaps associated with it instead of KEY. It can also
1648 be a number or marker, in which case the keymap properties at the
1649 specified buffer position instead of point are used.
1651 (key
, accept_default
, no_remap
, position
)
1652 Lisp_Object key
, accept_default
, no_remap
, position
;
1654 Lisp_Object
*maps
, value
;
1656 struct gcpro gcpro1
, gcpro2
;
1657 int count
= SPECPDL_INDEX ();
1659 GCPRO2 (key
, position
);
1661 if (NILP (position
) && VECTORP (key
))
1664 /* mouse events may have a symbolic prefix indicating the
1665 scrollbar or mode line */
1666 = AREF (key
, SYMBOLP (AREF (key
, 0)) && ASIZE (key
) > 1 ? 1 : 0);
1668 /* We are not interested in locations without event data */
1670 if (EVENT_HAS_PARAMETERS (event
) && CONSP (XCDR (event
)))
1672 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (event
));
1673 if (EQ (kind
, Qmouse_click
))
1674 position
= EVENT_START (event
);
1678 /* Key sequences beginning with mouse clicks
1679 are read using the keymaps of the buffer clicked on, not
1680 the current buffer. So we may have to switch the buffer
1683 if (CONSP (position
))
1687 window
= POSN_WINDOW (position
);
1689 if (WINDOWP (window
)
1690 && BUFFERP (XWINDOW (window
)->buffer
)
1691 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
1693 /* Arrange to go back to the original buffer once we're done
1694 processing the key sequence. We don't use
1695 save_excursion_{save,restore} here, in analogy to
1696 `read-key-sequence' to avoid saving point. Maybe this
1697 would not be a problem here, but it is easier to keep
1701 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
1703 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
1707 if (! NILP (current_kboard
->Voverriding_terminal_local_map
))
1709 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1710 key
, accept_default
);
1711 if (! NILP (value
) && !INTEGERP (value
))
1714 else if (! NILP (Voverriding_local_map
))
1716 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1717 if (! NILP (value
) && !INTEGERP (value
))
1722 Lisp_Object keymap
, local_map
;
1725 pt
= INTEGERP (position
) ? XINT (position
)
1726 : MARKERP (position
) ? marker_position (position
)
1729 local_map
= get_local_map (pt
, current_buffer
, Qlocal_map
);
1730 keymap
= get_local_map (pt
, current_buffer
, Qkeymap
);
1732 if (CONSP (position
))
1736 /* For a mouse click, get the local text-property keymap
1737 of the place clicked on, rather than point. */
1739 if (POSN_INBUFFER_P (position
))
1743 pos
= POSN_BUFFER_POSN (position
);
1745 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
1747 local_map
= get_local_map (XINT (pos
),
1748 current_buffer
, Qlocal_map
);
1750 keymap
= get_local_map (XINT (pos
),
1751 current_buffer
, Qkeymap
);
1755 /* If on a mode line string with a local keymap,
1756 or for a click on a string, i.e. overlay string or a
1757 string displayed via the `display' property,
1758 consider `local-map' and `keymap' properties of
1761 if (string
= POSN_STRING (position
),
1762 (CONSP (string
) && STRINGP (XCAR (string
))))
1764 Lisp_Object pos
, map
;
1766 pos
= XCDR (string
);
1767 string
= XCAR (string
);
1770 && XINT (pos
) < SCHARS (string
))
1772 map
= Fget_text_property (pos
, Qlocal_map
, string
);
1776 map
= Fget_text_property (pos
, Qkeymap
, string
);
1784 if (! NILP (keymap
))
1786 value
= Flookup_key (keymap
, key
, accept_default
);
1787 if (! NILP (value
) && !INTEGERP (value
))
1791 nmaps
= current_minor_maps (0, &maps
);
1792 /* Note that all these maps are GCPRO'd
1793 in the places where we found them. */
1795 for (i
= 0; i
< nmaps
; i
++)
1796 if (! NILP (maps
[i
]))
1798 value
= Flookup_key (maps
[i
], key
, accept_default
);
1799 if (! NILP (value
) && !INTEGERP (value
))
1803 if (! NILP (local_map
))
1805 value
= Flookup_key (local_map
, key
, accept_default
);
1806 if (! NILP (value
) && !INTEGERP (value
))
1811 value
= Flookup_key (current_global_map
, key
, accept_default
);
1814 unbind_to (count
, Qnil
);
1817 if (NILP (value
) || INTEGERP (value
))
1820 /* If the result of the ordinary keymap lookup is an interactive
1821 command, look for a key binding (ie. remapping) for that command. */
1823 if (NILP (no_remap
) && SYMBOLP (value
))
1826 if (value1
= Fcommand_remapping (value
, position
, Qnil
), !NILP (value1
))
1833 /* GC is possible in this function if it autoloads a keymap. */
1835 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1836 doc
: /* Return the binding for command KEYS in current local keymap only.
1837 KEYS is a string or vector, a sequence of keystrokes.
1838 The binding is probably a symbol with a function definition.
1840 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1841 bindings; see the description of `lookup-key' for more details about this. */)
1842 (keys
, accept_default
)
1843 Lisp_Object keys
, accept_default
;
1845 register Lisp_Object map
;
1846 map
= current_buffer
->keymap
;
1849 return Flookup_key (map
, keys
, accept_default
);
1852 /* GC is possible in this function if it autoloads a keymap. */
1854 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1855 doc
: /* Return the binding for command KEYS in current global keymap only.
1856 KEYS is a string or vector, a sequence of keystrokes.
1857 The binding is probably a symbol with a function definition.
1858 This function's return values are the same as those of `lookup-key'
1861 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1862 bindings; see the description of `lookup-key' for more details about this. */)
1863 (keys
, accept_default
)
1864 Lisp_Object keys
, accept_default
;
1866 return Flookup_key (current_global_map
, keys
, accept_default
);
1869 /* GC is possible in this function if it autoloads a keymap. */
1871 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1872 doc
: /* Find the visible minor mode bindings of KEY.
1873 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1874 the symbol which names the minor mode binding KEY, and BINDING is
1875 KEY's definition in that mode. In particular, if KEY has no
1876 minor-mode bindings, return nil. If the first binding is a
1877 non-prefix, all subsequent bindings will be omitted, since they would
1878 be ignored. Similarly, the list doesn't include non-prefix bindings
1879 that come after prefix bindings.
1881 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1882 bindings; see the description of `lookup-key' for more details about this. */)
1883 (key
, accept_default
)
1884 Lisp_Object key
, accept_default
;
1886 Lisp_Object
*modes
, *maps
;
1888 Lisp_Object binding
;
1890 struct gcpro gcpro1
, gcpro2
;
1892 nmaps
= current_minor_maps (&modes
, &maps
);
1893 /* Note that all these maps are GCPRO'd
1894 in the places where we found them. */
1897 GCPRO2 (key
, binding
);
1899 for (i
= j
= 0; i
< nmaps
; i
++)
1901 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1902 && !INTEGERP (binding
))
1904 if (KEYMAPP (binding
))
1905 maps
[j
++] = Fcons (modes
[i
], binding
);
1907 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1911 return Flist (j
, maps
);
1914 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1915 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1916 A new sparse keymap is stored as COMMAND's function definition and its value.
1917 If a second optional argument MAPVAR is given, the map is stored as
1918 its value instead of as COMMAND's value; but COMMAND is still defined
1920 The third optional argument NAME, if given, supplies a menu name
1921 string for the map. This is required to use the keymap as a menu.
1922 This function returns COMMAND. */)
1923 (command
, mapvar
, name
)
1924 Lisp_Object command
, mapvar
, name
;
1927 map
= Fmake_sparse_keymap (name
);
1928 Ffset (command
, map
);
1932 Fset (command
, map
);
1936 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1937 doc
: /* Select KEYMAP as the global keymap. */)
1941 keymap
= get_keymap (keymap
, 1, 1);
1942 current_global_map
= keymap
;
1947 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1948 doc
: /* Select KEYMAP as the local keymap.
1949 If KEYMAP is nil, that means no local keymap. */)
1954 keymap
= get_keymap (keymap
, 1, 1);
1956 current_buffer
->keymap
= keymap
;
1961 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1962 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1965 return current_buffer
->keymap
;
1968 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1969 doc
: /* Return the current global keymap. */)
1972 return current_global_map
;
1975 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1976 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1980 int nmaps
= current_minor_maps (0, &maps
);
1982 return Flist (nmaps
, maps
);
1985 /* Help functions for describing and documenting keymaps. */
1989 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1990 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1991 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1995 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1999 /* Look for and break cycles. */
2000 while (!NILP (tem
= Frassq (cmd
, maps
)))
2002 Lisp_Object prefix
= XCAR (tem
);
2003 int lim
= XINT (Flength (XCAR (tem
)));
2004 if (lim
<= XINT (Flength (thisseq
)))
2005 { /* This keymap was already seen with a smaller prefix. */
2007 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
2008 Faref (thisseq
, make_number (i
))))
2011 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
2014 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
2015 but maybe `cmd' occurs again further down in `maps', so keep
2017 maps
= XCDR (Fmemq (tem
, maps
));
2020 /* If the last key in thisseq is meta-prefix-char,
2021 turn it into a meta-ized keystroke. We know
2022 that the event we're about to append is an
2023 ascii keystroke since we're processing a
2027 int meta_bit
= meta_modifier
;
2028 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
2029 tem
= Fcopy_sequence (thisseq
);
2031 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
2033 /* This new sequence is the same length as
2034 thisseq, so stick it in the list right
2037 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
2041 tem
= append_key (thisseq
, key
);
2042 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
2047 accessible_keymaps_char_table (args
, index
, cmd
)
2048 Lisp_Object args
, index
, cmd
;
2050 accessible_keymaps_1 (index
, cmd
,
2054 XINT (XCDR (XCAR (args
))));
2057 /* This function cannot GC. */
2059 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
2061 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
2062 Returns a list of elements of the form (KEYS . MAP), where the sequence
2063 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
2064 so that the KEYS increase in length. The first element is ([] . KEYMAP).
2065 An optional argument PREFIX, if non-nil, should be a key sequence;
2066 then the value includes only maps for prefixes that start with PREFIX. */)
2068 Lisp_Object keymap
, prefix
;
2070 Lisp_Object maps
, tail
;
2073 /* no need for gcpro because we don't autoload any keymaps. */
2076 prefixlen
= XINT (Flength (prefix
));
2080 /* If a prefix was specified, start with the keymap (if any) for
2081 that prefix, so we don't waste time considering other prefixes. */
2083 tem
= Flookup_key (keymap
, prefix
, Qt
);
2084 /* Flookup_key may give us nil, or a number,
2085 if the prefix is not defined in this particular map.
2086 It might even give us a list that isn't a keymap. */
2087 tem
= get_keymap (tem
, 0, 0);
2090 /* Convert PREFIX to a vector now, so that later on
2091 we don't have to deal with the possibility of a string. */
2092 if (STRINGP (prefix
))
2097 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
2098 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
2102 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
2103 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2104 c
^= 0200 | meta_modifier
;
2105 ASET (copy
, i_before
, make_number (c
));
2109 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
2115 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
2116 get_keymap (keymap
, 1, 0)),
2119 /* For each map in the list maps,
2120 look at any other maps it points to,
2121 and stick them at the end if they are not already in the list.
2123 This is a breadth-first traversal, where tail is the queue of
2124 nodes, and maps accumulates a list of all nodes visited. */
2126 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
2128 register Lisp_Object thisseq
, thismap
;
2130 /* Does the current sequence end in the meta-prefix-char? */
2133 thisseq
= Fcar (Fcar (tail
));
2134 thismap
= Fcdr (Fcar (tail
));
2135 last
= make_number (XINT (Flength (thisseq
)) - 1);
2136 is_metized
= (XINT (last
) >= 0
2137 /* Don't metize the last char of PREFIX. */
2138 && XINT (last
) >= prefixlen
2139 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
2141 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
2145 elt
= XCAR (thismap
);
2149 if (CHAR_TABLE_P (elt
))
2151 map_char_table (accessible_keymaps_char_table
, Qnil
,
2152 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
2153 Fcons (tail
, thisseq
)));
2155 else if (VECTORP (elt
))
2159 /* Vector keymap. Scan all the elements. */
2160 for (i
= 0; i
< ASIZE (elt
); i
++)
2161 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
2162 maps
, tail
, thisseq
, is_metized
);
2165 else if (CONSP (elt
))
2166 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
2167 maps
, tail
, thisseq
,
2168 is_metized
&& INTEGERP (XCAR (elt
)));
2176 Lisp_Object Qsingle_key_description
, Qkey_description
;
2178 /* This function cannot GC. */
2180 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2181 doc
: /* Return a pretty description of key-sequence KEYS.
2182 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2183 Control characters turn into "C-foo" sequences, meta into "M-foo",
2184 spaces are put between sequence elements, etc. */)
2186 Lisp_Object keys
, prefix
;
2191 int size
= XINT (Flength (keys
));
2193 Lisp_Object sep
= build_string (" ");
2198 size
+= XINT (Flength (prefix
));
2200 /* This has one extra element at the end that we don't pass to Fconcat. */
2201 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2203 /* In effect, this computes
2204 (mapconcat 'single-key-description keys " ")
2205 but we shouldn't use mapconcat because it can do GC. */
2209 list
= prefix
, prefix
= Qnil
;
2210 else if (!NILP (keys
))
2211 list
= keys
, keys
= Qnil
;
2216 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2220 return empty_string
;
2221 return Fconcat (len
- 1, args
);
2225 size
= SCHARS (list
);
2226 else if (VECTORP (list
))
2227 size
= XVECTOR (list
)->size
;
2228 else if (CONSP (list
))
2229 size
= XINT (Flength (list
));
2231 wrong_type_argument (Qarrayp
, list
);
2240 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2241 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2242 c
^= 0200 | meta_modifier
;
2243 XSETFASTINT (key
, c
);
2245 else if (VECTORP (list
))
2247 key
= AREF (list
, i
++);
2259 || EQ (key
, meta_prefix_char
)
2260 || (XINT (key
) & meta_modifier
))
2262 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2264 if (EQ (key
, meta_prefix_char
))
2268 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2271 else if (EQ (key
, meta_prefix_char
))
2276 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2284 push_key_description (c
, p
, force_multibyte
)
2285 register unsigned int c
;
2287 int force_multibyte
;
2291 /* Clear all the meaningless bits above the meta bit. */
2292 c
&= meta_modifier
| ~ - meta_modifier
;
2293 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2294 | meta_modifier
| shift_modifier
| super_modifier
);
2296 if (! CHARACTERP (make_number (c2
)))
2298 /* KEY_DESCRIPTION_SIZE is large enough for this. */
2299 p
+= sprintf (p
, "[%d]", c
);
2303 if (c
& alt_modifier
)
2309 if ((c
& ctrl_modifier
) != 0
2310 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2314 c
&= ~ctrl_modifier
;
2316 if (c
& hyper_modifier
)
2320 c
-= hyper_modifier
;
2322 if (c
& meta_modifier
)
2328 if (c
& shift_modifier
)
2332 c
-= shift_modifier
;
2334 if (c
& super_modifier
)
2338 c
-= super_modifier
;
2354 else if (c
== Ctl ('M'))
2362 /* `C-' already added above. */
2363 if (c
> 0 && c
<= Ctl ('Z'))
2382 || (NILP (current_buffer
->enable_multibyte_characters
)
2383 && SINGLE_BYTE_CHAR_P (c
)
2384 && !force_multibyte
))
2390 /* Now we are sure that C is a valid character code. */
2391 if (NILP (current_buffer
->enable_multibyte_characters
)
2392 && ! force_multibyte
)
2393 *p
++ = multibyte_char_to_unibyte (c
, Qnil
);
2395 p
+= CHAR_STRING (c
, (unsigned char *) p
);
2401 /* This function cannot GC. */
2403 DEFUN ("single-key-description", Fsingle_key_description
,
2404 Ssingle_key_description
, 1, 2, 0,
2405 doc
: /* Return a pretty description of command character KEY.
2406 Control characters turn into C-whatever, etc.
2407 Optional argument NO-ANGLES non-nil means don't put angle brackets
2408 around function keys and event symbols. */)
2410 Lisp_Object key
, no_angles
;
2412 if (CONSP (key
) && lucid_event_type_list_p (key
))
2413 key
= Fevent_convert_list (key
);
2415 key
= EVENT_HEAD (key
);
2417 if (INTEGERP (key
)) /* Normal character */
2419 char tem
[KEY_DESCRIPTION_SIZE
];
2421 *push_key_description (XUINT (key
), tem
, 1) = 0;
2422 return build_string (tem
);
2424 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2426 if (NILP (no_angles
))
2429 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2430 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2431 return build_string (buffer
);
2434 return Fsymbol_name (key
);
2436 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2437 return Fcopy_sequence (key
);
2439 error ("KEY must be an integer, cons, symbol, or string");
2444 push_text_char_description (c
, p
)
2445 register unsigned int c
;
2457 *p
++ = c
+ 64; /* 'A' - 1 */
2469 /* This function cannot GC. */
2471 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2472 doc
: /* Return a pretty description of file-character CHARACTER.
2473 Control characters turn into "^char", etc. This differs from
2474 `single-key-description' which turns them into "C-char".
2475 Also, this function recognizes the 2**7 bit as the Meta character,
2476 whereas `single-key-description' uses the 2**27 bit for Meta.
2477 See Info node `(elisp)Describing Characters' for examples. */)
2479 Lisp_Object character
;
2481 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2482 unsigned char str
[6];
2485 CHECK_NUMBER (character
);
2487 c
= XINT (character
);
2488 if (!ASCII_CHAR_P (c
))
2490 int len
= CHAR_STRING (c
, str
);
2492 return make_multibyte_string (str
, 1, len
);
2495 *push_text_char_description (c
& 0377, str
) = 0;
2497 return build_string (str
);
2500 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2503 ascii_sequence_p (seq
)
2507 int len
= XINT (Flength (seq
));
2509 for (i
= 0; i
< len
; i
++)
2511 Lisp_Object ii
, elt
;
2513 XSETFASTINT (ii
, i
);
2514 elt
= Faref (seq
, ii
);
2517 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2525 /* where-is - finding a command in a set of keymaps. */
2527 static Lisp_Object
where_is_internal ();
2528 static Lisp_Object
where_is_internal_1 ();
2529 static void where_is_internal_2 ();
2531 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2532 Returns the first non-nil binding found in any of those maps. */
2535 shadow_lookup (shadow
, key
, flag
)
2536 Lisp_Object shadow
, key
, flag
;
2538 Lisp_Object tail
, value
;
2540 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2542 value
= Flookup_key (XCAR (tail
), key
, flag
);
2543 if (NATNUMP (value
))
2545 value
= Flookup_key (XCAR (tail
),
2546 Fsubstring (key
, make_number (0), value
), flag
);
2550 else if (!NILP (value
))
2556 static Lisp_Object Vmouse_events
;
2558 /* This function can GC if Flookup_key autoloads any keymaps. */
2561 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2562 Lisp_Object definition
, keymaps
;
2563 Lisp_Object firstonly
, noindirect
, no_remap
;
2565 Lisp_Object maps
= Qnil
;
2566 Lisp_Object found
, sequences
;
2567 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2568 /* 1 means ignore all menu bindings entirely. */
2569 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2572 while (CONSP (found
))
2576 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2577 found
= XCDR (found
);
2580 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2584 /* If this command is remapped, then it has no key bindings
2587 && SYMBOLP (definition
)
2588 && !NILP (Fcommand_remapping (definition
, Qnil
, keymaps
)))
2589 RETURN_UNGCPRO (Qnil
);
2591 for (; !NILP (maps
); maps
= Fcdr (maps
))
2593 /* Key sequence to reach map, and the map that it reaches */
2594 register Lisp_Object
this, map
, tem
;
2596 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2597 [M-CHAR] sequences, check if last character of the sequence
2598 is the meta-prefix char. */
2602 this = Fcar (Fcar (maps
));
2603 map
= Fcdr (Fcar (maps
));
2604 last
= make_number (XINT (Flength (this)) - 1);
2605 last_is_meta
= (XINT (last
) >= 0
2606 && EQ (Faref (this, last
), meta_prefix_char
));
2608 /* if (nomenus && !ascii_sequence_p (this)) */
2609 if (nomenus
&& XINT (last
) >= 0
2610 && SYMBOLP (tem
= Faref (this, make_number (0)))
2611 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2612 /* If no menu entries should be returned, skip over the
2613 keymaps bound to `menu-bar' and `tool-bar' and other
2614 non-ascii prefixes like `C-down-mouse-2'. */
2621 /* Because the code we want to run on each binding is rather
2622 large, we don't want to have two separate loop bodies for
2623 sparse keymap bindings and tables; we want to iterate one
2624 loop body over both keymap and vector bindings.
2626 For this reason, if Fcar (map) is a vector, we don't
2627 advance map to the next element until i indicates that we
2628 have finished off the vector. */
2629 Lisp_Object elt
, key
, binding
;
2637 /* Set key and binding to the current key and binding, and
2638 advance map and i to the next binding. */
2641 Lisp_Object sequence
;
2643 /* In a vector, look at each element. */
2644 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2646 binding
= AREF (elt
, i
);
2647 XSETFASTINT (key
, i
);
2648 sequence
= where_is_internal_1 (binding
, key
, definition
,
2650 last
, nomenus
, last_is_meta
);
2651 if (!NILP (sequence
))
2652 sequences
= Fcons (sequence
, sequences
);
2655 else if (CHAR_TABLE_P (elt
))
2659 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2660 Qnil
), /* Result accumulator. */
2661 Fcons (Fcons (this, last
),
2662 Fcons (make_number (nomenus
),
2663 make_number (last_is_meta
))));
2664 map_char_table (where_is_internal_2
, Qnil
, elt
, args
);
2665 sequences
= XCDR (XCAR (args
));
2667 else if (CONSP (elt
))
2669 Lisp_Object sequence
;
2672 binding
= XCDR (elt
);
2674 sequence
= where_is_internal_1 (binding
, key
, definition
,
2676 last
, nomenus
, last_is_meta
);
2677 if (!NILP (sequence
))
2678 sequences
= Fcons (sequence
, sequences
);
2682 while (!NILP (sequences
))
2684 Lisp_Object sequence
, remapped
, function
;
2686 sequence
= XCAR (sequences
);
2687 sequences
= XCDR (sequences
);
2689 /* If the current sequence is a command remapping with
2690 format [remap COMMAND], find the key sequences
2691 which run COMMAND, and use those sequences instead. */
2694 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2695 && EQ (AREF (sequence
, 0), Qremap
)
2696 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2698 Lisp_Object remapped1
;
2700 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2701 if (CONSP (remapped1
))
2703 /* Verify that this key binding actually maps to the
2704 remapped command (see below). */
2705 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2707 sequence
= XCAR (remapped1
);
2708 remapped
= XCDR (remapped1
);
2709 goto record_sequence
;
2713 /* Verify that this key binding is not shadowed by another
2714 binding for the same key, before we say it exists.
2716 Mechanism: look for local definition of this key and if
2717 it is defined and does not match what we found then
2720 Either nil or number as value from Flookup_key
2722 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2726 /* Don't annoy user with strings from a menu such as
2727 Select Paste. Change them all to "(any string)",
2728 so that there seems to be only one menu item
2730 if (! NILP (sequence
))
2733 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2735 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2736 build_string ("(any string)"));
2739 /* It is a true unshadowed match. Record it, unless it's already
2740 been seen (as could happen when inheriting keymaps). */
2741 if (NILP (Fmember (sequence
, found
)))
2742 found
= Fcons (sequence
, found
);
2744 /* If firstonly is Qnon_ascii, then we can return the first
2745 binding we find. If firstonly is not Qnon_ascii but not
2746 nil, then we should return the first ascii-only binding
2748 if (EQ (firstonly
, Qnon_ascii
))
2749 RETURN_UNGCPRO (sequence
);
2750 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2751 RETURN_UNGCPRO (sequence
);
2753 if (CONSP (remapped
))
2755 sequence
= XCAR (remapped
);
2756 remapped
= XCDR (remapped
);
2757 goto record_sequence
;
2765 found
= Fnreverse (found
);
2767 /* firstonly may have been t, but we may have gone all the way through
2768 the keymaps without finding an all-ASCII key sequence. So just
2769 return the best we could find. */
2770 if (!NILP (firstonly
))
2771 return Fcar (found
);
2776 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2777 doc
: /* Return list of keys that invoke DEFINITION.
2778 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2779 If KEYMAP is nil, search all the currently active keymaps.
2780 If KEYMAP is a list of keymaps, search only those keymaps.
2782 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2783 rather than a list of all possible key sequences.
2784 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2785 no matter what it is.
2786 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2787 \(or their meta variants) and entirely reject menu bindings.
2789 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2790 to other keymaps or slots. This makes it possible to search for an
2791 indirect definition itself.
2793 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2794 that invoke a command which is remapped to DEFINITION, but include the
2795 remapped command in the returned list. */)
2796 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2797 Lisp_Object definition
, keymap
;
2798 Lisp_Object firstonly
, noindirect
, no_remap
;
2800 Lisp_Object sequences
, keymaps
;
2801 /* 1 means ignore all menu bindings entirely. */
2802 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2805 /* Find the relevant keymaps. */
2806 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2808 else if (!NILP (keymap
))
2809 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2811 keymaps
= Fcurrent_active_maps (Qnil
);
2813 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2814 We don't really need to check `keymap'. */
2815 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2819 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2821 /* Check heuristic-consistency of the cache. */
2822 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2823 where_is_cache
= Qnil
;
2825 if (NILP (where_is_cache
))
2827 /* We need to create the cache. */
2828 Lisp_Object args
[2];
2829 where_is_cache
= Fmake_hash_table (0, args
);
2830 where_is_cache_keymaps
= Qt
;
2832 /* Fill in the cache. */
2833 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2834 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2837 where_is_cache_keymaps
= keymaps
;
2840 /* We want to process definitions from the last to the first.
2841 Instead of consing, copy definitions to a vector and step
2842 over that vector. */
2843 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2844 n
= XINT (Flength (sequences
));
2845 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2846 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2847 defns
[i
++] = XCAR (sequences
);
2849 /* Verify that the key bindings are not shadowed. Note that
2850 the following can GC. */
2851 GCPRO2 (definition
, keymaps
);
2854 for (i
= n
- 1; i
>= 0; --i
)
2855 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2857 if (ascii_sequence_p (defns
[i
]))
2863 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2868 /* Kill the cache so that where_is_internal_1 doesn't think
2869 we're filling it up. */
2870 where_is_cache
= Qnil
;
2871 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2877 /* This is the function that Fwhere_is_internal calls using map_char_table.
2879 (((DEFINITION . NOINDIRECT) . RESULT)
2881 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2882 Since map_char_table doesn't really use the return value from this function,
2883 we the result append to RESULT, the slot in ARGS.
2885 KEY may be a cons (FROM . TO) where both FROM and TO are integers
2886 (i.e. character events).
2888 This function can GC because it calls where_is_internal_1 which can
2892 where_is_internal_2 (args
, key
, binding
)
2893 Lisp_Object args
, key
, binding
;
2895 Lisp_Object definition
, noindirect
, this, last
;
2896 Lisp_Object result
, sequence
;
2897 int nomenus
, last_is_meta
;
2898 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2900 GCPRO3 (args
, key
, binding
);
2901 definition
= XCAR (XCAR (XCAR (args
)));
2902 noindirect
= XCDR (XCAR (XCAR (args
)));
2903 this = XCAR (XCAR (XCDR (args
)));
2904 last
= XCDR (XCAR (XCDR (args
)));
2905 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2906 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2909 if (CONSP (key
) && INTEGERP (XCAR (key
)) && INTEGERP (XCDR (key
)))
2911 /* Try all ASCII characters. Try also non-ASCII characters but
2912 only the first and last one because trying all of them is
2913 extremely memory and time consuming.
2915 Fixme: Perhaps it should be allowed to store a cons directly
2916 in RESULT. -- handa@m17n.org */
2917 int from
= XINT (XCAR (key
)), to
= XINT (XCDR (key
));
2920 for (; from
<= to
; to
--)
2922 k
= make_number (to
);
2923 sequence
= where_is_internal_1 (binding
, k
, definition
, noindirect
,
2924 this, last
, nomenus
, last_is_meta
);
2925 if (!NILP (sequence
))
2926 result
= Fcons (sequence
, result
);
2933 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2934 this, last
, nomenus
, last_is_meta
);
2935 if (!NILP (sequence
))
2936 result
= Fcons (sequence
, Qnil
);
2939 if (! NILP (result
))
2940 nconc2 (XCAR (args
), result
);
2946 /* This function can GC because get_keyelt can. */
2949 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2950 nomenus
, last_is_meta
)
2951 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2952 int nomenus
, last_is_meta
;
2954 Lisp_Object sequence
;
2956 /* Search through indirections unless that's not wanted. */
2957 if (NILP (noindirect
))
2958 binding
= get_keyelt (binding
, 0);
2960 /* End this iteration if this element does not match
2963 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2964 || EQ (binding
, definition
)
2965 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2966 /* Doesn't match. */
2969 /* We have found a match. Construct the key sequence where we found it. */
2970 if (INTEGERP (key
) && last_is_meta
)
2972 sequence
= Fcopy_sequence (this);
2973 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2976 sequence
= append_key (this, key
);
2978 if (!NILP (where_is_cache
))
2980 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2981 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2988 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2990 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2991 doc
: /* Insert the list of all defined keys and their definitions.
2992 The list is inserted in the current buffer, while the bindings are
2993 looked up in BUFFER.
2994 The optional argument PREFIX, if non-nil, should be a key sequence;
2995 then we display only bindings that start with that prefix.
2996 The optional argument MENUS, if non-nil, says to mention menu bindings.
2997 \(Ordinarily these are omitted from the output.) */)
2998 (buffer
, prefix
, menus
)
2999 Lisp_Object buffer
, prefix
, menus
;
3001 Lisp_Object outbuf
, shadow
;
3002 int nomenu
= NILP (menus
);
3003 register Lisp_Object start1
;
3004 struct gcpro gcpro1
;
3006 char *alternate_heading
3008 Keyboard translations:\n\n\
3009 You type Translation\n\
3010 -------- -----------\n";
3012 CHECK_BUFFER (buffer
);
3017 outbuf
= Fcurrent_buffer ();
3019 /* Report on alternates for keys. */
3020 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
3023 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
3024 int translate_len
= SCHARS (Vkeyboard_translate_table
);
3026 for (c
= 0; c
< translate_len
; c
++)
3027 if (translate
[c
] != c
)
3029 char buf
[KEY_DESCRIPTION_SIZE
];
3032 if (alternate_heading
)
3034 insert_string (alternate_heading
);
3035 alternate_heading
= 0;
3038 bufend
= push_key_description (translate
[c
], buf
, 1);
3039 insert (buf
, bufend
- buf
);
3040 Findent_to (make_number (16), make_number (1));
3041 bufend
= push_key_description (c
, buf
, 1);
3042 insert (buf
, bufend
- buf
);
3046 /* Insert calls signal_after_change which may GC. */
3047 translate
= SDATA (Vkeyboard_translate_table
);
3053 if (!NILP (Vkey_translation_map
))
3054 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
3055 "Key translations", nomenu
, 1, 0, 0);
3058 /* Print the (major mode) local map. */
3060 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
3061 start1
= current_kboard
->Voverriding_terminal_local_map
;
3062 else if (!NILP (Voverriding_local_map
))
3063 start1
= Voverriding_local_map
;
3067 describe_map_tree (start1
, 1, shadow
, prefix
,
3068 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
3069 shadow
= Fcons (start1
, shadow
);
3073 /* Print the minor mode and major mode keymaps. */
3075 Lisp_Object
*modes
, *maps
;
3077 /* Temporarily switch to `buffer', so that we can get that buffer's
3078 minor modes correctly. */
3079 Fset_buffer (buffer
);
3081 nmaps
= current_minor_maps (&modes
, &maps
);
3082 Fset_buffer (outbuf
);
3084 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3085 XBUFFER (buffer
), Qkeymap
);
3088 describe_map_tree (start1
, 1, shadow
, prefix
,
3089 "\f\n`keymap' Property Bindings", nomenu
,
3091 shadow
= Fcons (start1
, shadow
);
3094 /* Print the minor mode maps. */
3095 for (i
= 0; i
< nmaps
; i
++)
3097 /* The title for a minor mode keymap
3098 is constructed at run time.
3099 We let describe_map_tree do the actual insertion
3100 because it takes care of other features when doing so. */
3103 if (!SYMBOLP (modes
[i
]))
3106 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
3110 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
3111 SCHARS (SYMBOL_NAME (modes
[i
])));
3112 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
3114 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
3115 p
+= sizeof (" Minor Mode Bindings") - 1;
3118 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
3119 title
, nomenu
, 0, 0, 0);
3120 shadow
= Fcons (maps
[i
], shadow
);
3123 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3124 XBUFFER (buffer
), Qlocal_map
);
3127 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
3128 describe_map_tree (start1
, 1, shadow
, prefix
,
3129 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
3131 describe_map_tree (start1
, 1, shadow
, prefix
,
3132 "\f\n`local-map' Property Bindings",
3135 shadow
= Fcons (start1
, shadow
);
3139 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
3140 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
3142 /* Print the function-key-map translations under this prefix. */
3143 if (!NILP (Vfunction_key_map
))
3144 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
3145 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
3151 /* Insert a description of the key bindings in STARTMAP,
3152 followed by those of all maps reachable through STARTMAP.
3153 If PARTIAL is nonzero, omit certain "uninteresting" commands
3154 (such as `undefined').
3155 If SHADOW is non-nil, it is a list of maps;
3156 don't mention keys which would be shadowed by any of them.
3157 PREFIX, if non-nil, says mention only keys that start with PREFIX.
3158 TITLE, if not 0, is a string to insert at the beginning.
3159 TITLE should not end with a colon or a newline; we supply that.
3160 If NOMENU is not 0, then omit menu-bar commands.
3162 If TRANSL is nonzero, the definitions are actually key translations
3163 so print strings and vectors differently.
3165 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
3168 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
3169 don't omit it; instead, mention it but say it is shadowed. */
3172 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
3173 always_title
, mention_shadow
)
3174 Lisp_Object startmap
, shadow
, prefix
;
3182 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
3183 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3190 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3193 GCPRO3 (maps
, seen
, sub_shadows
);
3199 /* Delete from MAPS each element that is for the menu bar. */
3200 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3202 Lisp_Object elt
, prefix
, tem
;
3205 prefix
= Fcar (elt
);
3206 if (XVECTOR (prefix
)->size
>= 1)
3208 tem
= Faref (prefix
, make_number (0));
3209 if (EQ (tem
, Qmenu_bar
))
3210 maps
= Fdelq (elt
, maps
);
3215 if (!NILP (maps
) || always_title
)
3219 insert_string (title
);
3222 insert_string (" Starting With ");
3223 insert1 (Fkey_description (prefix
, Qnil
));
3225 insert_string (":\n");
3227 insert_string (key_heading
);
3231 for (; !NILP (maps
); maps
= Fcdr (maps
))
3233 register Lisp_Object elt
, prefix
, tail
;
3236 prefix
= Fcar (elt
);
3240 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3244 shmap
= XCAR (tail
);
3246 /* If the sequence by which we reach this keymap is zero-length,
3247 then the shadow map for this keymap is just SHADOW. */
3248 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3249 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3251 /* If the sequence by which we reach this keymap actually has
3252 some elements, then the sequence's definition in SHADOW is
3253 what we should use. */
3256 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3257 if (INTEGERP (shmap
))
3261 /* If shmap is not nil and not a keymap,
3262 it completely shadows this map, so don't
3263 describe this map at all. */
3264 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3268 sub_shadows
= Fcons (shmap
, sub_shadows
);
3271 /* Maps we have already listed in this loop shadow this map. */
3272 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3275 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3277 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3280 describe_map (Fcdr (elt
), prefix
,
3281 transl
? describe_translation
: describe_command
,
3282 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3288 insert_string ("\n");
3293 static int previous_description_column
;
3296 describe_command (definition
, args
)
3297 Lisp_Object definition
, args
;
3299 register Lisp_Object tem1
;
3300 int column
= (int) current_column (); /* iftc */
3301 int description_column
;
3303 /* If column 16 is no good, go to col 32;
3304 but don't push beyond that--go to next line instead. */
3308 description_column
= 32;
3310 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3311 description_column
= 32;
3313 description_column
= 16;
3315 Findent_to (make_number (description_column
), make_number (1));
3316 previous_description_column
= description_column
;
3318 if (SYMBOLP (definition
))
3320 tem1
= SYMBOL_NAME (definition
);
3322 insert_string ("\n");
3324 else if (STRINGP (definition
) || VECTORP (definition
))
3325 insert_string ("Keyboard Macro\n");
3326 else if (KEYMAPP (definition
))
3327 insert_string ("Prefix Command\n");
3329 insert_string ("??\n");
3333 describe_translation (definition
, args
)
3334 Lisp_Object definition
, args
;
3336 register Lisp_Object tem1
;
3338 Findent_to (make_number (16), make_number (1));
3340 if (SYMBOLP (definition
))
3342 tem1
= SYMBOL_NAME (definition
);
3344 insert_string ("\n");
3346 else if (STRINGP (definition
) || VECTORP (definition
))
3348 insert1 (Fkey_description (definition
, Qnil
));
3349 insert_string ("\n");
3351 else if (KEYMAPP (definition
))
3352 insert_string ("Prefix Command\n");
3354 insert_string ("??\n");
3357 /* describe_map puts all the usable elements of a sparse keymap
3358 into an array of `struct describe_map_elt',
3359 then sorts them by the events. */
3361 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3363 /* qsort comparison function for sorting `struct describe_map_elt' by
3367 describe_map_compare (aa
, bb
)
3368 const void *aa
, *bb
;
3370 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3371 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3372 return ((XINT (a
->event
) > XINT (b
->event
))
3373 - (XINT (a
->event
) < XINT (b
->event
)));
3374 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3376 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3378 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3379 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3380 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3385 /* Describe the contents of map MAP, assuming that this map itself is
3386 reached by the sequence of prefix keys PREFIX (a string or vector).
3387 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3390 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3391 seen
, nomenu
, mention_shadow
)
3392 register Lisp_Object map
;
3394 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3401 Lisp_Object tail
, definition
, event
;
3403 Lisp_Object suppress
;
3406 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3408 /* These accumulate the values from sparse keymap bindings,
3409 so we can sort them and handle them in order. */
3410 int length_needed
= 0;
3411 struct describe_map_elt
*vect
;
3418 suppress
= intern ("suppress-keymap");
3420 /* This vector gets used to present single keys to Flookup_key. Since
3421 that is done once per keymap element, we don't want to cons up a
3422 fresh vector every time. */
3423 kludge
= Fmake_vector (make_number (1), Qnil
);
3426 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3429 vect
= ((struct describe_map_elt
*)
3430 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3432 GCPRO3 (prefix
, definition
, kludge
);
3434 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3438 if (VECTORP (XCAR (tail
))
3439 || CHAR_TABLE_P (XCAR (tail
)))
3440 describe_vector (XCAR (tail
),
3441 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3442 (int *)0, 0, 1, mention_shadow
);
3443 else if (CONSP (XCAR (tail
)))
3445 int this_shadowed
= 0;
3447 event
= XCAR (XCAR (tail
));
3449 /* Ignore bindings whose "prefix" are not really valid events.
3450 (We get these in the frames and buffers menu.) */
3451 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3454 if (nomenu
&& EQ (event
, Qmenu_bar
))
3457 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3459 /* Don't show undefined commands or suppressed commands. */
3460 if (NILP (definition
)) continue;
3461 if (SYMBOLP (definition
) && partial
)
3463 tem
= Fget (definition
, suppress
);
3468 /* Don't show a command that isn't really visible
3469 because a local definition of the same key shadows it. */
3471 ASET (kludge
, 0, event
);
3474 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3477 /* If both bindings are keymaps, this key is a prefix key,
3478 so don't say it is shadowed. */
3479 if (KEYMAPP (definition
) && KEYMAPP (tem
))
3481 /* Avoid generating duplicate entries if the
3482 shadowed binding has the same definition. */
3483 else if (mention_shadow
&& !EQ (tem
, definition
))
3490 tem
= Flookup_key (map
, kludge
, Qt
);
3491 if (!EQ (tem
, definition
)) continue;
3493 vect
[slots_used
].event
= event
;
3494 vect
[slots_used
].definition
= definition
;
3495 vect
[slots_used
].shadowed
= this_shadowed
;
3498 else if (EQ (XCAR (tail
), Qkeymap
))
3500 /* The same keymap might be in the structure twice, if we're
3501 using an inherited keymap. So skip anything we've already
3503 tem
= Fassq (tail
, *seen
);
3504 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3506 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3510 /* If we found some sparse map events, sort them. */
3512 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3513 describe_map_compare
);
3515 /* Now output them in sorted order. */
3517 for (i
= 0; i
< slots_used
; i
++)
3519 Lisp_Object start
, end
;
3523 previous_description_column
= 0;
3528 ASET (kludge
, 0, vect
[i
].event
);
3529 start
= vect
[i
].event
;
3532 definition
= vect
[i
].definition
;
3534 /* Find consecutive chars that are identically defined. */
3535 if (INTEGERP (vect
[i
].event
))
3537 while (i
+ 1 < slots_used
3538 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3539 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3540 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3542 end
= vect
[i
].event
;
3545 /* Now START .. END is the range to describe next. */
3547 /* Insert the string to describe the event START. */
3548 insert1 (Fkey_description (kludge
, prefix
));
3550 if (!EQ (start
, end
))
3554 ASET (kludge
, 0, end
);
3555 /* Insert the string to describe the character END. */
3556 insert1 (Fkey_description (kludge
, prefix
));
3559 /* Print a description of the definition of this character.
3560 elt_describer will take care of spacing out far enough
3561 for alignment purposes. */
3562 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3564 if (vect
[i
].shadowed
)
3567 insert_string ("\n (that binding is currently shadowed by another mode)");
3576 describe_vector_princ (elt
, fun
)
3577 Lisp_Object elt
, fun
;
3579 Findent_to (make_number (16), make_number (1));
3584 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3585 doc
: /* Insert a description of contents of VECTOR.
3586 This is text showing the elements of vector matched against indices.
3587 DESCRIBER is the output function used; nil means use `princ'. */)
3589 Lisp_Object vector
, describer
;
3591 int count
= SPECPDL_INDEX ();
3592 if (NILP (describer
))
3593 describer
= intern ("princ");
3594 specbind (Qstandard_output
, Fcurrent_buffer ());
3595 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3596 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3597 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3599 return unbind_to (count
, Qnil
);
3602 /* Insert in the current buffer a description of the contents of VECTOR.
3603 We call ELT_DESCRIBER to insert the description of one value found
3606 ELT_PREFIX describes what "comes before" the keys or indices defined
3607 by this vector. This is a human-readable string whose size
3608 is not necessarily related to the situation.
3610 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3611 leads to this keymap.
3613 If the vector is a chartable, ELT_PREFIX is the vector
3614 of bytes that lead to the character set or portion of a character
3615 set described by this chartable.
3617 If PARTIAL is nonzero, it means do not mention suppressed commands
3618 (that assumes the vector is in a keymap).
3620 SHADOW is a list of keymaps that shadow this map.
3621 If it is non-nil, then we look up the key in those maps
3622 and we don't mention it now if it is defined by any of them.
3624 ENTIRE_MAP is the keymap in which this vector appears.
3625 If the definition in effect in the whole map does not match
3626 the one in this vector, we ignore this one.
3628 ARGS is simply passed as the second argument to ELT_DESCRIBER.
3630 INDICES and CHAR_TABLE_DEPTH are ignored. They will be removed in
3633 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3635 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3638 describe_vector (vector
, prefix
, args
, elt_describer
,
3639 partial
, shadow
, entire_map
,
3640 indices
, char_table_depth
, keymap_p
,
3642 register Lisp_Object vector
;
3643 Lisp_Object prefix
, args
;
3644 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3647 Lisp_Object entire_map
;
3649 int char_table_depth
;
3653 Lisp_Object definition
;
3655 Lisp_Object elt_prefix
= Qnil
;
3657 Lisp_Object suppress
;
3660 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3661 /* Range of elements to be handled. */
3663 Lisp_Object character
;
3672 /* Call Fkey_description first, to avoid GC bug for the other string. */
3673 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3676 tem
= Fkey_description (prefix
, Qnil
);
3677 elt_prefix
= concat2 (tem
, build_string (" "));
3682 /* This vector gets used to present single keys to Flookup_key. Since
3683 that is done once per vector element, we don't want to cons up a
3684 fresh vector every time. */
3685 kludge
= Fmake_vector (make_number (1), Qnil
);
3686 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3689 suppress
= intern ("suppress-keymap");
3692 to
= CHAR_TABLE_P (vector
) ? MAX_CHAR
+ 1 : XVECTOR (vector
)->size
;
3694 for (i
= from
; i
< to
; i
++)
3696 int this_shadowed
= 0;
3697 int range_beg
, range_end
;
3704 if (CHAR_TABLE_P (vector
))
3705 val
= char_table_ref_and_range (vector
, i
, &range_beg
, &i
);
3707 val
= AREF (vector
, i
);
3708 definition
= get_keyelt (val
, 0);
3710 if (NILP (definition
)) continue;
3712 /* Don't mention suppressed commands. */
3713 if (SYMBOLP (definition
) && partial
)
3717 tem
= Fget (definition
, suppress
);
3719 if (!NILP (tem
)) continue;
3722 character
= make_number (starting_i
);
3723 ASET (kludge
, 0, character
);
3725 /* If this binding is shadowed by some other map, ignore it. */
3730 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3741 /* Ignore this definition if it is shadowed by an earlier
3742 one in the same keymap. */
3743 if (!NILP (entire_map
))
3747 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3749 if (!EQ (tem
, definition
))
3759 /* Output the prefix that applies to every entry in this map. */
3760 if (!NILP (elt_prefix
))
3761 insert1 (elt_prefix
);
3763 insert1 (Fkey_description (kludge
, prefix
));
3765 /* Find all consecutive characters or rows that have the same
3766 definition. But, for elements of a top level char table, if
3767 they are for charsets, we had better describe one by one even
3768 if they have the same definition. */
3769 if (CHAR_TABLE_P (vector
))
3771 && (val
= char_table_ref_and_range (vector
, i
+ 1,
3772 &range_beg
, &range_end
),
3773 tem2
= get_keyelt (val
, 0),
3775 && !NILP (Fequal (tem2
, definition
)))
3779 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3781 && !NILP (Fequal (tem2
, definition
)))
3784 /* If we have a range of more than one character,
3785 print where the range reaches to. */
3787 if (i
!= starting_i
)
3791 ASET (kludge
, 0, make_number (i
));
3793 if (!NILP (elt_prefix
))
3794 insert1 (elt_prefix
);
3796 insert1 (Fkey_description (kludge
, prefix
));
3799 /* Print a description of the definition of this character.
3800 elt_describer will take care of spacing out far enough
3801 for alignment purposes. */
3802 (*elt_describer
) (definition
, args
);
3807 insert_string (" (binding currently shadowed)");
3812 if (CHAR_TABLE_P (vector
) && ! NILP (XCHAR_TABLE (vector
)->defalt
))
3814 if (!NILP (elt_prefix
))
3815 insert1 (elt_prefix
);
3816 insert ("default", 7);
3817 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3823 /* Apropos - finding all symbols whose names match a regexp. */
3824 static Lisp_Object apropos_predicate
;
3825 static Lisp_Object apropos_accumulate
;
3828 apropos_accum (symbol
, string
)
3829 Lisp_Object symbol
, string
;
3831 register Lisp_Object tem
;
3833 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3834 if (!NILP (tem
) && !NILP (apropos_predicate
))
3835 tem
= call1 (apropos_predicate
, symbol
);
3837 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3840 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3841 doc
: /* Show all symbols whose names contain match for REGEXP.
3842 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3843 for each symbol and a symbol is mentioned only if that returns non-nil.
3844 Return list of symbols found. */)
3846 Lisp_Object regexp
, predicate
;
3849 CHECK_STRING (regexp
);
3850 apropos_predicate
= predicate
;
3851 apropos_accumulate
= Qnil
;
3852 map_obarray (Vobarray
, apropos_accum
, regexp
);
3853 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3854 apropos_accumulate
= Qnil
;
3855 apropos_predicate
= Qnil
;
3862 Qkeymap
= intern ("keymap");
3863 staticpro (&Qkeymap
);
3864 staticpro (&apropos_predicate
);
3865 staticpro (&apropos_accumulate
);
3866 apropos_predicate
= Qnil
;
3867 apropos_accumulate
= Qnil
;
3869 /* Now we are ready to set up this property, so we can
3870 create char tables. */
3871 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3873 /* Initialize the keymaps standardly used.
3874 Each one is the value of a Lisp variable, and is also
3875 pointed to by a C variable */
3877 global_map
= Fmake_keymap (Qnil
);
3878 Fset (intern ("global-map"), global_map
);
3880 current_global_map
= global_map
;
3881 staticpro (&global_map
);
3882 staticpro (¤t_global_map
);
3884 meta_map
= Fmake_keymap (Qnil
);
3885 Fset (intern ("esc-map"), meta_map
);
3886 Ffset (intern ("ESC-prefix"), meta_map
);
3888 control_x_map
= Fmake_keymap (Qnil
);
3889 Fset (intern ("ctl-x-map"), control_x_map
);
3890 Ffset (intern ("Control-X-prefix"), control_x_map
);
3893 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3894 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3895 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3896 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3897 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3899 staticpro (&exclude_keys
);
3901 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3902 doc
: /* List of commands given new key bindings recently.
3903 This is used for internal purposes during Emacs startup;
3904 don't alter it yourself. */);
3905 Vdefine_key_rebound_commands
= Qt
;
3907 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3908 doc
: /* Default keymap to use when reading from the minibuffer. */);
3909 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3911 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3912 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3913 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3914 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3916 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3917 doc
: /* Local keymap for minibuffer input with completion. */);
3918 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3919 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3921 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3922 &Vminibuffer_local_filename_completion_map
,
3923 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3924 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3925 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3926 Vminibuffer_local_completion_map
);
3929 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3930 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3931 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3932 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3933 Vminibuffer_local_completion_map
);
3935 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3936 &Vminibuffer_local_must_match_filename_map
,
3937 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3938 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3939 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3940 Vminibuffer_local_must_match_map
);
3942 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3943 doc
: /* Alist of keymaps to use for minor modes.
3944 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3945 key sequences and look up bindings iff VARIABLE's value is non-nil.
3946 If two active keymaps bind the same key, the keymap appearing earlier
3947 in the list takes precedence. */);
3948 Vminor_mode_map_alist
= Qnil
;
3950 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3951 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3952 This variable is an alist just like `minor-mode-map-alist', and it is
3953 used the same way (and before `minor-mode-map-alist'); however,
3954 it is provided for major modes to bind locally. */);
3955 Vminor_mode_overriding_map_alist
= Qnil
;
3957 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3958 doc
: /* List of keymap alists to use for emulations modes.
3959 It is intended for modes or packages using multiple minor-mode keymaps.
3960 Each element is a keymap alist just like `minor-mode-map-alist', or a
3961 symbol with a variable binding which is a keymap alist, and it is used
3962 the same way. The "active" keymaps in each alist are used before
3963 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3964 Vemulation_mode_map_alists
= Qnil
;
3967 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3968 doc
: /* Keymap that translates key sequences to key sequences during input.
3969 This is used mainly for mapping ASCII function key sequences into
3970 real Emacs function key events (symbols).
3972 The `read-key-sequence' function replaces any subsequence bound by
3973 `function-key-map' with its binding. More precisely, when the active
3974 keymaps have no binding for the current key sequence but
3975 `function-key-map' binds a suffix of the sequence to a vector or string,
3976 `read-key-sequence' replaces the matching suffix with its binding, and
3977 continues with the new sequence.
3979 If the binding is a function, it is called with one argument (the prompt)
3980 and its return value (a key sequence) is used.
3982 The events that come from bindings in `function-key-map' are not
3983 themselves looked up in `function-key-map'.
3985 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3986 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3987 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3988 key, typing `ESC O P x' would return [f1 x]. */);
3989 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3991 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3992 doc
: /* Keymap of key translations that can override keymaps.
3993 This keymap works like `function-key-map', but comes after that,
3994 and its non-prefix bindings override ordinary bindings. */);
3995 Vkey_translation_map
= Qnil
;
3997 staticpro (&Vmouse_events
);
3998 Vmouse_events
= Fcons (intern ("menu-bar"),
3999 Fcons (intern ("tool-bar"),
4000 Fcons (intern ("header-line"),
4001 Fcons (intern ("mode-line"),
4002 Fcons (intern ("mouse-1"),
4003 Fcons (intern ("mouse-2"),
4004 Fcons (intern ("mouse-3"),
4005 Fcons (intern ("mouse-4"),
4006 Fcons (intern ("mouse-5"),
4010 Qsingle_key_description
= intern ("single-key-description");
4011 staticpro (&Qsingle_key_description
);
4013 Qkey_description
= intern ("key-description");
4014 staticpro (&Qkey_description
);
4016 Qkeymapp
= intern ("keymapp");
4017 staticpro (&Qkeymapp
);
4019 Qnon_ascii
= intern ("non-ascii");
4020 staticpro (&Qnon_ascii
);
4022 Qmenu_item
= intern ("menu-item");
4023 staticpro (&Qmenu_item
);
4025 Qremap
= intern ("remap");
4026 staticpro (&Qremap
);
4028 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
4029 staticpro (&command_remapping_vector
);
4031 where_is_cache_keymaps
= Qt
;
4032 where_is_cache
= Qnil
;
4033 staticpro (&where_is_cache
);
4034 staticpro (&where_is_cache_keymaps
);
4036 defsubr (&Skeymapp
);
4037 defsubr (&Skeymap_parent
);
4038 defsubr (&Skeymap_prompt
);
4039 defsubr (&Sset_keymap_parent
);
4040 defsubr (&Smake_keymap
);
4041 defsubr (&Smake_sparse_keymap
);
4042 defsubr (&Smap_keymap
);
4043 defsubr (&Scopy_keymap
);
4044 defsubr (&Scommand_remapping
);
4045 defsubr (&Skey_binding
);
4046 defsubr (&Slocal_key_binding
);
4047 defsubr (&Sglobal_key_binding
);
4048 defsubr (&Sminor_mode_key_binding
);
4049 defsubr (&Sdefine_key
);
4050 defsubr (&Slookup_key
);
4051 defsubr (&Sdefine_prefix_command
);
4052 defsubr (&Suse_global_map
);
4053 defsubr (&Suse_local_map
);
4054 defsubr (&Scurrent_local_map
);
4055 defsubr (&Scurrent_global_map
);
4056 defsubr (&Scurrent_minor_mode_maps
);
4057 defsubr (&Scurrent_active_maps
);
4058 defsubr (&Saccessible_keymaps
);
4059 defsubr (&Skey_description
);
4060 defsubr (&Sdescribe_vector
);
4061 defsubr (&Ssingle_key_description
);
4062 defsubr (&Stext_char_description
);
4063 defsubr (&Swhere_is_internal
);
4064 defsubr (&Sdescribe_buffer_bindings
);
4065 defsubr (&Sapropos_internal
);
4071 initial_define_key (global_map
, 033, "ESC-prefix");
4072 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
4075 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
4076 (do not change this comment) */