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. */
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 /* A list of all commands given new bindings since a certain time
95 when nil was stored here.
96 This is used to speed up recomputation of menu key equivalents
97 when Emacs starts up. t means don't record anything here. */
98 Lisp_Object Vdefine_key_rebound_commands
;
100 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
102 /* Alist of elements like (DEL . "\d"). */
103 static Lisp_Object exclude_keys
;
105 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
106 static Lisp_Object command_remapping_vector
;
108 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
109 in a string key sequence is equivalent to prefixing with this
111 extern Lisp_Object meta_prefix_char
;
113 extern Lisp_Object Voverriding_local_map
;
115 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
116 static Lisp_Object where_is_cache
;
117 /* Which keymaps are reverse-stored in the cache. */
118 static Lisp_Object where_is_cache_keymaps
;
120 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
121 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
123 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
124 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
125 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
126 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
127 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
128 int, Lisp_Object
, Lisp_Object
*, int, int));
129 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
130 void (*) (Lisp_Object
, Lisp_Object
), int,
131 Lisp_Object
, Lisp_Object
, int *,
133 static void silly_event_symbol_error
P_ ((Lisp_Object
));
135 /* Keymap object support - constructors and predicates. */
137 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
138 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
139 CHARTABLE is a char-table that holds the bindings for all characters
140 without modifiers. All entries in it are initially nil, meaning
141 "command undefined". ALIST is an assoc-list which holds bindings for
142 function keys, mouse events, and any other things that appear in the
143 input stream. Initially, ALIST is nil.
145 The optional arg STRING supplies a menu name for the keymap
146 in case you use it as a menu with `x-popup-menu'. */)
152 tail
= Fcons (string
, Qnil
);
155 return Fcons (Qkeymap
,
156 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
159 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
160 doc
: /* Construct and return a new sparse keymap.
161 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
162 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
163 which binds the function key or mouse event SYMBOL to DEFINITION.
164 Initially the alist is nil.
166 The optional arg STRING supplies a menu name for the keymap
167 in case you use it as a menu with `x-popup-menu'. */)
172 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
173 return Fcons (Qkeymap
, Qnil
);
176 /* This function is used for installing the standard key bindings
177 at initialization time.
181 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
184 initial_define_key (keymap
, key
, defname
)
189 store_in_keymap (keymap
, make_number (key
), intern (defname
));
193 initial_define_lispy_key (keymap
, keyname
, defname
)
198 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
201 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
202 doc
: /* Return t if OBJECT is a keymap.
204 A keymap is a list (keymap . ALIST),
205 or a symbol whose function definition is itself a keymap.
206 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
207 a vector of densely packed bindings for small character codes
208 is also allowed as an element. */)
212 return (KEYMAPP (object
) ? Qt
: Qnil
);
215 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
216 doc
: /* Return the prompt-string of a keymap MAP.
217 If non-nil, the prompt is shown in the echo-area
218 when reading a key-sequence to be looked-up in this keymap. */)
222 map
= get_keymap (map
, 0, 0);
225 Lisp_Object tem
= XCAR (map
);
233 /* Check that OBJECT is a keymap (after dereferencing through any
234 symbols). If it is, return it.
236 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
237 is an autoload form, do the autoload and try again.
238 If AUTOLOAD is nonzero, callers must assume GC is possible.
240 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
241 is zero as well), return Qt.
243 ERROR controls how we respond if OBJECT isn't a keymap.
244 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
246 Note that most of the time, we don't want to pursue autoloads.
247 Functions like Faccessible_keymaps which scan entire keymap trees
248 shouldn't load every autoloaded keymap. I'm not sure about this,
249 but it seems to me that only read_key_sequence, Flookup_key, and
250 Fdefine_key should cause keymaps to be autoloaded.
252 This function can GC when AUTOLOAD is non-zero, because it calls
253 do_autoload which can GC. */
256 get_keymap (object
, error
, autoload
)
265 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
268 tem
= indirect_function (object
);
271 if (EQ (XCAR (tem
), Qkeymap
))
274 /* Should we do an autoload? Autoload forms for keymaps have
275 Qkeymap as their fifth element. */
276 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
)
281 tail
= Fnth (make_number (4), tem
);
282 if (EQ (tail
, Qkeymap
))
286 struct gcpro gcpro1
, gcpro2
;
288 GCPRO2 (tem
, object
);
289 do_autoload (tem
, object
);
302 wrong_type_argument (Qkeymapp
, object
);
306 /* Return the parent map of KEYMAP, or nil if it has none.
307 We assume that KEYMAP is a valid keymap. */
310 keymap_parent (keymap
, autoload
)
316 keymap
= get_keymap (keymap
, 1, autoload
);
318 /* Skip past the initial element `keymap'. */
319 list
= XCDR (keymap
);
320 for (; CONSP (list
); list
= XCDR (list
))
322 /* See if there is another `keymap'. */
327 return get_keymap (list
, 0, autoload
);
330 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
331 doc
: /* Return the parent keymap of KEYMAP. */)
335 return keymap_parent (keymap
, 1);
338 /* Check whether MAP is one of MAPS parents. */
340 keymap_memberp (map
, maps
)
341 Lisp_Object map
, maps
;
343 if (NILP (map
)) return 0;
344 while (KEYMAPP (maps
) && !EQ (map
, maps
))
345 maps
= keymap_parent (maps
, 0);
346 return (EQ (map
, maps
));
349 /* Set the parent keymap of MAP to PARENT. */
351 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
352 doc
: /* Modify KEYMAP to set its parent map to PARENT.
353 Return PARENT. PARENT should be nil or another keymap. */)
355 Lisp_Object keymap
, parent
;
357 Lisp_Object list
, prev
;
358 struct gcpro gcpro1
, gcpro2
;
361 /* Force a keymap flush for the next call to where-is.
362 Since this can be called from within where-is, we don't set where_is_cache
363 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
364 be changed during where-is, while where_is_cache_keymaps is only used at
365 the very beginning of where-is and can thus be changed here without any
367 This is a very minor correctness (rather than safety) issue. */
368 where_is_cache_keymaps
= Qt
;
370 GCPRO2 (keymap
, parent
);
371 keymap
= get_keymap (keymap
, 1, 1);
375 parent
= get_keymap (parent
, 1, 1);
377 /* Check for cycles. */
378 if (keymap_memberp (keymap
, parent
))
379 error ("Cyclic keymap inheritance");
382 /* Skip past the initial element `keymap'. */
387 /* If there is a parent keymap here, replace it.
388 If we came to the end, add the parent in PREV. */
389 if (!CONSP (list
) || KEYMAPP (list
))
391 /* If we already have the right parent, return now
392 so that we avoid the loops below. */
393 if (EQ (XCDR (prev
), parent
))
394 RETURN_UNGCPRO (parent
);
397 XSETCDR (prev
, parent
);
403 /* Scan through for submaps, and set their parents too. */
405 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
407 /* Stop the scan when we come to the parent. */
408 if (EQ (XCAR (list
), Qkeymap
))
411 /* If this element holds a prefix map, deal with it. */
412 if (CONSP (XCAR (list
))
413 && CONSP (XCDR (XCAR (list
))))
414 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
417 if (VECTORP (XCAR (list
)))
418 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
419 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
420 fix_submap_inheritance (keymap
, make_number (i
),
421 XVECTOR (XCAR (list
))->contents
[i
]);
423 if (CHAR_TABLE_P (XCAR (list
)))
425 Lisp_Object indices
[3];
427 map_char_table (fix_submap_inheritance
, Qnil
,
428 XCAR (list
), XCAR (list
),
433 RETURN_UNGCPRO (parent
);
436 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
437 if EVENT is also a prefix in MAP's parent,
438 make sure that SUBMAP inherits that definition as its own parent. */
441 fix_submap_inheritance (map
, event
, submap
)
442 Lisp_Object map
, event
, submap
;
444 Lisp_Object map_parent
, parent_entry
;
446 /* SUBMAP is a cons that we found as a key binding.
447 Discard the other things found in a menu key binding. */
449 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
451 /* If it isn't a keymap now, there's no work to do. */
455 map_parent
= keymap_parent (map
, 0);
456 if (!NILP (map_parent
))
458 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
462 /* If MAP's parent has something other than a keymap,
463 our own submap shadows it completely. */
464 if (!CONSP (parent_entry
))
467 if (! EQ (parent_entry
, submap
))
469 Lisp_Object submap_parent
;
470 submap_parent
= submap
;
475 tem
= keymap_parent (submap_parent
, 0);
479 if (keymap_memberp (tem
, parent_entry
))
480 /* Fset_keymap_parent could create a cycle. */
487 Fset_keymap_parent (submap_parent
, parent_entry
);
491 /* Look up IDX in MAP. IDX may be any sort of event.
492 Note that this does only one level of lookup; IDX must be a single
493 event, not a sequence.
495 If T_OK is non-zero, bindings for Qt are treated as default
496 bindings; any key left unmentioned by other tables and bindings is
497 given the binding of Qt.
499 If T_OK is zero, bindings for Qt are not treated specially.
501 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
504 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
513 /* Qunbound in VAL means we have found no binding yet. */
516 /* If idx is a list (some sort of mouse click, perhaps?),
517 the index we want to use is the car of the list, which
518 ought to be a symbol. */
519 idx
= EVENT_HEAD (idx
);
521 /* If idx is a symbol, it might have modifiers, which need to
522 be put in the canonical order. */
524 idx
= reorder_modifiers (idx
);
525 else if (INTEGERP (idx
))
526 /* Clobber the high bits that can be present on a machine
527 with more than 24 bits of integer. */
528 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
530 /* Handle the special meta -> esc mapping. */
531 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
533 /* See if there is a meta-map. If there's none, there is
534 no binding for IDX, unless a default binding exists in MAP. */
536 Lisp_Object meta_map
;
538 /* A strange value in which Meta is set would cause
539 infinite recursion. Protect against that. */
540 if (XINT (meta_prefix_char
) & CHAR_META
)
541 meta_prefix_char
= make_number (27);
542 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
543 t_ok
, noinherit
, autoload
),
546 if (CONSP (meta_map
))
549 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
552 /* Set IDX to t, so that we only find a default binding. */
555 /* We know there is no binding. */
559 /* t_binding is where we put a default binding that applies,
560 to use in case we do not find a binding specifically
561 for this key sequence. */
564 Lisp_Object t_binding
= Qnil
;
565 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
567 GCPRO4 (map
, tail
, idx
, t_binding
);
569 /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
570 If it is 1, only generic-char bindings are accepted.
571 Otherwise, neither are. */
574 for (tail
= XCDR (map
);
576 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
581 binding
= XCAR (tail
);
582 if (SYMBOLP (binding
))
584 /* If NOINHERIT, stop finding prefix definitions
585 after we pass a second occurrence of the `keymap' symbol. */
586 if (noinherit
&& EQ (binding
, Qkeymap
))
587 RETURN_UNGCPRO (Qnil
);
589 else if (CONSP (binding
))
591 Lisp_Object key
= XCAR (binding
);
594 val
= XCDR (binding
);
597 && (XINT (idx
) & CHAR_MODIFIER_MASK
) == 0
599 && (XINT (key
) & CHAR_MODIFIER_MASK
) == 0
600 && !SINGLE_BYTE_CHAR_P (XINT (idx
))
601 && !SINGLE_BYTE_CHAR_P (XINT (key
))
602 && CHAR_VALID_P (XINT (key
), 1)
603 && !CHAR_VALID_P (XINT (key
), 0)
604 && (CHAR_CHARSET (XINT (key
))
605 == CHAR_CHARSET (XINT (idx
))))
607 /* KEY is the generic character of the charset of IDX.
608 Use KEY's binding if there isn't a binding for IDX
610 t_binding
= XCDR (binding
);
613 else if (t_ok
> 1 && EQ (key
, Qt
))
615 t_binding
= XCDR (binding
);
619 else if (VECTORP (binding
))
621 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
622 val
= AREF (binding
, XFASTINT (idx
));
624 else if (CHAR_TABLE_P (binding
))
626 /* Character codes with modifiers
627 are not included in a char-table.
628 All character codes without modifiers are included. */
629 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
631 val
= Faref (binding
, idx
);
632 /* `nil' has a special meaning for char-tables, so
633 we use something else to record an explicitly
640 /* If we found a binding, clean it up and return it. */
641 if (!EQ (val
, Qunbound
))
644 /* A Qt binding is just like an explicit nil binding
645 (i.e. it shadows any parent binding but not bindings in
646 keymaps of lower precedence). */
648 val
= get_keyelt (val
, autoload
);
650 fix_submap_inheritance (map
, idx
, val
);
651 RETURN_UNGCPRO (val
);
656 return get_keyelt (t_binding
, autoload
);
661 map_keymap_item (fun
, args
, key
, val
, data
)
662 map_keymap_function_t fun
;
663 Lisp_Object args
, key
, val
;
666 /* We should maybe try to detect bindings shadowed by previous
667 ones and things like that. */
670 (*fun
) (key
, val
, args
, data
);
674 map_keymap_char_table_item (args
, key
, val
)
675 Lisp_Object args
, key
, val
;
679 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
681 map_keymap_item (fun
, XCDR (args
), key
, val
,
682 XSAVE_VALUE (XCAR (args
))->pointer
);
686 /* Call FUN for every binding in MAP.
687 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
688 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
690 map_keymap (map
, fun
, args
, data
, autoload
)
691 map_keymap_function_t fun
;
692 Lisp_Object map
, args
;
696 struct gcpro gcpro1
, gcpro2
, gcpro3
;
700 GCPRO3 (map
, args
, tail
);
701 map
= get_keymap (map
, 1, autoload
);
702 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
703 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
706 Lisp_Object binding
= XCAR (tail
);
709 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
710 else if (VECTORP (binding
))
712 /* Loop over the char values represented in the vector. */
713 int len
= ASIZE (binding
);
715 for (c
= 0; c
< len
; c
++)
717 Lisp_Object character
;
718 XSETFASTINT (character
, c
);
719 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
722 else if (CHAR_TABLE_P (binding
))
724 Lisp_Object indices
[3];
725 map_char_table (map_keymap_char_table_item
, Qnil
, binding
, binding
,
726 Fcons (make_save_value (fun
, 0),
727 Fcons (make_save_value (data
, 0),
736 map_keymap_call (key
, val
, fun
, dummy
)
737 Lisp_Object key
, val
, fun
;
740 call2 (fun
, key
, val
);
743 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
744 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
745 FUNCTION is called with two arguments: the event that is bound, and
746 the definition it is bound to. If the event is an integer, it may be
747 a generic character (see Info node `(elisp)Splitting Characters'), and
748 that means that all actual character events belonging to that generic
749 character are bound to the definition.
751 If KEYMAP has a parent, the parent's bindings are included as well.
752 This works recursively: if the parent has itself a parent, then the
753 grandparent's bindings are also included and so on.
754 usage: (map-keymap FUNCTION KEYMAP) */)
755 (function
, keymap
, sort_first
)
756 Lisp_Object function
, keymap
, sort_first
;
758 if (INTEGERP (function
))
759 /* We have to stop integers early since map_keymap gives them special
761 xsignal1 (Qinvalid_function
, function
);
762 if (! NILP (sort_first
))
763 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
765 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
769 /* Given OBJECT which was found in a slot in a keymap,
770 trace indirect definitions to get the actual definition of that slot.
771 An indirect definition is a list of the form
772 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
773 and INDEX is the object to look up in KEYMAP to yield the definition.
775 Also if OBJECT has a menu string as the first element,
776 remove that. Also remove a menu help string as second element.
778 If AUTOLOAD is nonzero, load autoloadable keymaps
779 that are referred to with indirection.
781 This can GC because menu_item_eval_property calls Feval. */
784 get_keyelt (object
, autoload
)
790 if (!(CONSP (object
)))
791 /* This is really the value. */
794 /* If the keymap contents looks like (keymap ...) or (lambda ...)
796 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
799 /* If the keymap contents looks like (menu-item name . DEFN)
800 or (menu-item name DEFN ...) then use DEFN.
801 This is a new format menu item. */
802 else if (EQ (XCAR (object
), Qmenu_item
))
804 if (CONSP (XCDR (object
)))
808 object
= XCDR (XCDR (object
));
811 object
= XCAR (object
);
813 /* If there's a `:filter FILTER', apply FILTER to the
814 menu-item's definition to get the real definition to
816 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
817 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
820 filter
= XCAR (XCDR (tem
));
821 filter
= list2 (filter
, list2 (Qquote
, object
));
822 object
= menu_item_eval_property (filter
);
827 /* Invalid keymap. */
831 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
832 Keymap alist elements like (CHAR MENUSTRING . DEFN)
833 will be used by HierarKey menus. */
834 else if (STRINGP (XCAR (object
)))
836 object
= XCDR (object
);
837 /* Also remove a menu help string, if any,
838 following the menu item name. */
839 if (CONSP (object
) && STRINGP (XCAR (object
)))
840 object
= XCDR (object
);
841 /* Also remove the sublist that caches key equivalences, if any. */
842 if (CONSP (object
) && CONSP (XCAR (object
)))
845 carcar
= XCAR (XCAR (object
));
846 if (NILP (carcar
) || VECTORP (carcar
))
847 object
= XCDR (object
);
851 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
857 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
859 return (!CONSP (map
) ? object
/* Invalid keymap */
860 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
866 store_in_keymap (keymap
, idx
, def
)
868 register Lisp_Object idx
;
871 /* Flush any reverse-map cache. */
872 where_is_cache
= Qnil
;
873 where_is_cache_keymaps
= Qt
;
875 /* If we are preparing to dump, and DEF is a menu element
876 with a menu item indicator, copy it to ensure it is not pure. */
877 if (CONSP (def
) && PURE_P (def
)
878 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
879 def
= Fcons (XCAR (def
), XCDR (def
));
881 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
882 error ("attempt to define a key in a non-keymap");
884 /* If idx is a list (some sort of mouse click, perhaps?),
885 the index we want to use is the car of the list, which
886 ought to be a symbol. */
887 idx
= EVENT_HEAD (idx
);
889 /* If idx is a symbol, it might have modifiers, which need to
890 be put in the canonical order. */
892 idx
= reorder_modifiers (idx
);
893 else if (INTEGERP (idx
))
894 /* Clobber the high bits that can be present on a machine
895 with more than 24 bits of integer. */
896 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
898 /* Scan the keymap for a binding of idx. */
902 /* The cons after which we should insert new bindings. If the
903 keymap has a table element, we record its position here, so new
904 bindings will go after it; this way, the table will stay
905 towards the front of the alist and character lookups in dense
906 keymaps will remain fast. Otherwise, this just points at the
907 front of the keymap. */
908 Lisp_Object insertion_point
;
910 insertion_point
= keymap
;
911 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
918 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
921 ASET (elt
, XFASTINT (idx
), def
);
924 insertion_point
= tail
;
926 else if (CHAR_TABLE_P (elt
))
928 /* Character codes with modifiers
929 are not included in a char-table.
930 All character codes without modifiers are included. */
931 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
934 /* `nil' has a special meaning for char-tables, so
935 we use something else to record an explicitly
937 NILP (def
) ? Qt
: def
);
940 insertion_point
= tail
;
942 else if (CONSP (elt
))
944 if (EQ (idx
, XCAR (elt
)))
951 else if (EQ (elt
, Qkeymap
))
952 /* If we find a 'keymap' symbol in the spine of KEYMAP,
953 then we must have found the start of a second keymap
954 being used as the tail of KEYMAP, and a binding for IDX
955 should be inserted before it. */
962 /* We have scanned the entire keymap, and not found a binding for
963 IDX. Let's add one. */
964 CHECK_IMPURE (insertion_point
);
965 XSETCDR (insertion_point
,
966 Fcons (Fcons (idx
, def
), XCDR (insertion_point
)));
972 EXFUN (Fcopy_keymap
, 1);
975 copy_keymap_item (elt
)
978 Lisp_Object res
, tem
;
985 /* Is this a new format menu item. */
986 if (EQ (XCAR (tem
), Qmenu_item
))
988 /* Copy cell with menu-item marker. */
989 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
993 /* Copy cell with menu-item name. */
994 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1000 /* Copy cell with binding and if the binding is a keymap,
1002 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1005 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1006 XSETCAR (elt
, Fcopy_keymap (tem
));
1008 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1009 /* Delete cache for key equivalences. */
1010 XSETCDR (elt
, XCDR (tem
));
1015 /* It may be an old fomat menu item.
1016 Skip the optional menu string. */
1017 if (STRINGP (XCAR (tem
)))
1019 /* Copy the cell, since copy-alist didn't go this deep. */
1020 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1022 /* Also skip the optional menu help string. */
1023 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1025 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1029 /* There may also be a list that caches key equivalences.
1030 Just delete it for the new keymap. */
1032 && CONSP (XCAR (tem
))
1033 && (NILP (XCAR (XCAR (tem
)))
1034 || VECTORP (XCAR (XCAR (tem
)))))
1036 XSETCDR (elt
, XCDR (tem
));
1039 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1040 XSETCDR (elt
, Fcopy_keymap (tem
));
1042 else if (EQ (XCAR (tem
), Qkeymap
))
1043 res
= Fcopy_keymap (elt
);
1049 copy_keymap_1 (chartable
, idx
, elt
)
1050 Lisp_Object chartable
, idx
, elt
;
1052 Faset (chartable
, idx
, copy_keymap_item (elt
));
1055 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1056 doc
: /* Return a copy of the keymap KEYMAP.
1057 The copy starts out with the same definitions of KEYMAP,
1058 but changing either the copy or KEYMAP does not affect the other.
1059 Any key definitions that are subkeymaps are recursively copied.
1060 However, a key definition which is a symbol whose definition is a keymap
1065 register Lisp_Object copy
, tail
;
1066 keymap
= get_keymap (keymap
, 1, 0);
1067 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1068 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1070 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1072 Lisp_Object elt
= XCAR (keymap
);
1073 if (CHAR_TABLE_P (elt
))
1075 Lisp_Object indices
[3];
1076 elt
= Fcopy_sequence (elt
);
1077 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, elt
, 0, indices
);
1079 else if (VECTORP (elt
))
1082 elt
= Fcopy_sequence (elt
);
1083 for (i
= 0; i
< ASIZE (elt
); i
++)
1084 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1086 else if (CONSP (elt
))
1087 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1088 XSETCDR (tail
, Fcons (elt
, Qnil
));
1090 keymap
= XCDR (keymap
);
1092 XSETCDR (tail
, keymap
);
1096 /* Simple Keymap mutators and accessors. */
1098 /* GC is possible in this function if it autoloads a keymap. */
1100 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1101 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1104 KEY is a string or a vector of symbols and characters meaning a
1105 sequence of keystrokes and events. Non-ASCII characters with codes
1106 above 127 (such as ISO Latin-1) can be included if you use a vector.
1107 Using [t] for KEY creates a default definition, which applies to any
1108 event type that has no other definition in this keymap.
1110 DEF is anything that can be a key's definition:
1111 nil (means key is undefined in this keymap),
1112 a command (a Lisp function suitable for interactive calling),
1113 a string (treated as a keyboard macro),
1114 a keymap (to define a prefix key),
1115 a symbol (when the key is looked up, the symbol will stand for its
1116 function definition, which should at that time be one of the above,
1117 or another symbol whose function definition is used, etc.),
1118 a cons (STRING . DEFN), meaning that DEFN is the definition
1119 (DEFN should be a valid definition in its own right),
1120 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP,
1121 or an extended menu item definition. (See info node `Extended Menu Items'.)
1123 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1124 binding is altered. If there is no binding for KEY, the new pair
1125 binding KEY to DEF is added at the front of KEYMAP. */)
1132 register Lisp_Object c
;
1133 register Lisp_Object cmd
;
1137 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1139 GCPRO3 (keymap
, key
, def
);
1140 keymap
= get_keymap (keymap
, 1, 1);
1142 CHECK_VECTOR_OR_STRING (key
);
1144 length
= XFASTINT (Flength (key
));
1146 RETURN_UNGCPRO (Qnil
);
1148 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1149 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1151 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1153 if (VECTORP (def
) && ASIZE (def
) > 0 && CONSP (AREF (def
, 0)))
1154 { /* DEF is apparently an XEmacs-style keyboard macro. */
1155 Lisp_Object tmp
= Fmake_vector (make_number (ASIZE (def
)), Qnil
);
1156 int i
= ASIZE (def
);
1159 Lisp_Object c
= AREF (def
, i
);
1160 if (CONSP (c
) && lucid_event_type_list_p (c
))
1161 c
= Fevent_convert_list (c
);
1170 c
= Faref (key
, make_number (idx
));
1172 if (CONSP (c
) && lucid_event_type_list_p (c
))
1173 c
= Fevent_convert_list (c
);
1176 silly_event_symbol_error (c
);
1179 && (XINT (c
) & meta_bit
)
1182 c
= meta_prefix_char
;
1188 XSETINT (c
, XINT (c
) & ~meta_bit
);
1194 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1195 error ("Key sequence contains invalid event");
1198 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1200 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1202 /* If this key is undefined, make it a prefix. */
1204 cmd
= define_as_prefix (keymap
, c
);
1206 keymap
= get_keymap (cmd
, 0, 1);
1207 if (!CONSP (keymap
))
1208 /* We must use Fkey_description rather than just passing key to
1209 error; key might be a vector, not a string. */
1210 error ("Key sequence %s starts with non-prefix key %s",
1211 SDATA (Fkey_description (key
, Qnil
)),
1212 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1218 /* This function may GC (it calls Fkey_binding). */
1220 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 3, 0,
1221 doc
: /* Return the remapping for command COMMAND.
1222 Returns nil if COMMAND is not remapped (or not a symbol).
1224 If the optional argument POSITION is non-nil, it specifies a mouse
1225 position as returned by `event-start' and `event-end', and the
1226 remapping occurs in the keymaps associated with it. It can also be a
1227 number or marker, in which case the keymap properties at the specified
1228 buffer position instead of point are used. The KEYMAPS argument is
1229 ignored if POSITION is non-nil.
1231 If the optional argument KEYMAPS is non-nil, it should be a list of
1232 keymaps to search for command remapping. Otherwise, search for the
1233 remapping in all currently active keymaps. */)
1234 (command
, position
, keymaps
)
1235 Lisp_Object command
, position
, keymaps
;
1237 if (!SYMBOLP (command
))
1240 ASET (command_remapping_vector
, 1, command
);
1243 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
, position
);
1246 Lisp_Object maps
, binding
;
1248 for (maps
= keymaps
; !NILP (maps
); maps
= Fcdr (maps
))
1250 binding
= Flookup_key (Fcar (maps
), command_remapping_vector
, Qnil
);
1251 if (!NILP (binding
) && !INTEGERP (binding
))
1258 /* Value is number if KEY is too long; nil if valid but has no definition. */
1259 /* GC is possible in this function if it autoloads a keymap. */
1261 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1262 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1263 A value of nil means undefined. See doc of `define-key'
1264 for kinds of definitions.
1266 A number as value means KEY is "too long";
1267 that is, characters or symbols in it except for the last one
1268 fail to be a valid sequence of prefix characters in KEYMAP.
1269 The number is how many characters at the front of KEY
1270 it takes to reach a non-prefix key.
1272 Normally, `lookup-key' ignores bindings for t, which act as default
1273 bindings, used when nothing else in the keymap applies; this makes it
1274 usable as a general function for probing keymaps. However, if the
1275 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1276 recognize the default bindings, just as `read-key-sequence' does. */)
1277 (keymap
, key
, accept_default
)
1280 Lisp_Object accept_default
;
1283 register Lisp_Object cmd
;
1284 register Lisp_Object c
;
1286 int t_ok
= !NILP (accept_default
);
1287 struct gcpro gcpro1
, gcpro2
;
1289 GCPRO2 (keymap
, key
);
1290 keymap
= get_keymap (keymap
, 1, 1);
1292 CHECK_VECTOR_OR_STRING (key
);
1294 length
= XFASTINT (Flength (key
));
1296 RETURN_UNGCPRO (keymap
);
1301 c
= Faref (key
, make_number (idx
++));
1303 if (CONSP (c
) && lucid_event_type_list_p (c
))
1304 c
= Fevent_convert_list (c
);
1306 /* Turn the 8th bit of string chars into a meta modifier. */
1307 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1308 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1310 /* Allow string since binding for `menu-bar-select-buffer'
1311 includes the buffer name in the key sequence. */
1312 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1313 error ("Key sequence contains invalid event");
1315 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1317 RETURN_UNGCPRO (cmd
);
1319 keymap
= get_keymap (cmd
, 0, 1);
1320 if (!CONSP (keymap
))
1321 RETURN_UNGCPRO (make_number (idx
));
1327 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1328 Assume that currently it does not define C at all.
1329 Return the keymap. */
1332 define_as_prefix (keymap
, c
)
1333 Lisp_Object keymap
, c
;
1337 cmd
= Fmake_sparse_keymap (Qnil
);
1338 /* If this key is defined as a prefix in an inherited keymap,
1339 make it a prefix in this map, and make its definition
1340 inherit the other prefix definition. */
1341 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1342 store_in_keymap (keymap
, c
, cmd
);
1347 /* Append a key to the end of a key sequence. We always make a vector. */
1350 append_key (key_sequence
, key
)
1351 Lisp_Object key_sequence
, key
;
1353 Lisp_Object args
[2];
1355 args
[0] = key_sequence
;
1357 args
[1] = Fcons (key
, Qnil
);
1358 return Fvconcat (2, args
);
1361 /* Given a event type C which is a symbol,
1362 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1365 silly_event_symbol_error (c
)
1368 Lisp_Object parsed
, base
, name
, assoc
;
1371 parsed
= parse_modifiers (c
);
1372 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1373 base
= XCAR (parsed
);
1374 name
= Fsymbol_name (base
);
1375 /* This alist includes elements such as ("RET" . "\\r"). */
1376 assoc
= Fassoc (name
, exclude_keys
);
1380 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1382 Lisp_Object keystring
;
1383 if (modifiers
& alt_modifier
)
1384 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1385 if (modifiers
& ctrl_modifier
)
1386 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1387 if (modifiers
& hyper_modifier
)
1388 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1389 if (modifiers
& meta_modifier
)
1390 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1391 if (modifiers
& shift_modifier
)
1392 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1393 if (modifiers
& super_modifier
)
1394 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1397 c
= reorder_modifiers (c
);
1398 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1400 error ((modifiers
& ~meta_modifier
1401 ? "To bind the key %s, use [?%s], not [%s]"
1402 : "To bind the key %s, use \"%s\", not [%s]"),
1403 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1404 SDATA (SYMBOL_NAME (c
)));
1408 /* Global, local, and minor mode keymap stuff. */
1410 /* We can't put these variables inside current_minor_maps, since under
1411 some systems, static gets macro-defined to be the empty string.
1413 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1414 static int cmm_size
= 0;
1416 /* Store a pointer to an array of the currently active minor modes in
1417 *modeptr, a pointer to an array of the keymaps of the currently
1418 active minor modes in *mapptr, and return the number of maps
1421 This function always returns a pointer to the same buffer, and may
1422 free or reallocate it, so if you want to keep it for a long time or
1423 hand it out to lisp code, copy it. This procedure will be called
1424 for every key sequence read, so the nice lispy approach (return a
1425 new assoclist, list, what have you) for each invocation would
1426 result in a lot of consing over time.
1428 If we used xrealloc/xmalloc and ran out of memory, they would throw
1429 back to the command loop, which would try to read a key sequence,
1430 which would call this function again, resulting in an infinite
1431 loop. Instead, we'll use realloc/malloc and silently truncate the
1432 list, let the key sequence be read, and hope some other piece of
1433 code signals the error. */
1435 current_minor_maps (modeptr
, mapptr
)
1436 Lisp_Object
**modeptr
, **mapptr
;
1439 int list_number
= 0;
1440 Lisp_Object alist
, assoc
, var
, val
;
1441 Lisp_Object emulation_alists
;
1442 Lisp_Object lists
[2];
1444 emulation_alists
= Vemulation_mode_map_alists
;
1445 lists
[0] = Vminor_mode_overriding_map_alist
;
1446 lists
[1] = Vminor_mode_map_alist
;
1448 for (list_number
= 0; list_number
< 2; list_number
++)
1450 if (CONSP (emulation_alists
))
1452 alist
= XCAR (emulation_alists
);
1453 emulation_alists
= XCDR (emulation_alists
);
1454 if (SYMBOLP (alist
))
1455 alist
= find_symbol_value (alist
);
1459 alist
= lists
[list_number
];
1461 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1462 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1463 && (var
= XCAR (assoc
), SYMBOLP (var
))
1464 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1469 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1470 and also an entry in Vminor_mode_map_alist,
1471 ignore the latter. */
1472 if (list_number
== 1)
1474 val
= assq_no_quit (var
, lists
[0]);
1481 int newsize
, allocsize
;
1482 Lisp_Object
*newmodes
, *newmaps
;
1484 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1485 allocsize
= newsize
* sizeof *newmodes
;
1487 /* Use malloc here. See the comment above this function.
1488 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1490 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1495 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1498 cmm_modes
= newmodes
;
1501 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1506 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1513 if (newmodes
== NULL
|| newmaps
== NULL
)
1518 /* Get the keymap definition--or nil if it is not defined. */
1519 temp
= Findirect_function (XCDR (assoc
), Qt
);
1523 cmm_maps
[i
] = temp
;
1529 if (modeptr
) *modeptr
= cmm_modes
;
1530 if (mapptr
) *mapptr
= cmm_maps
;
1534 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1536 doc
: /* Return a list of the currently active keymaps.
1537 OLP if non-nil indicates that we should obey `overriding-local-map' and
1538 `overriding-terminal-local-map'. */)
1542 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1546 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1547 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1548 /* The doc said that overriding-terminal-local-map should
1549 override overriding-local-map. The code used them both,
1550 but it seems clearer to use just one. rms, jan 2005. */
1551 else if (!NILP (Voverriding_local_map
))
1552 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1554 if (NILP (XCDR (keymaps
)))
1560 /* This usually returns the buffer's local map,
1561 but that can be overridden by a `local-map' property. */
1562 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1564 keymaps
= Fcons (local
, keymaps
);
1566 /* Now put all the minor mode keymaps on the list. */
1567 nmaps
= current_minor_maps (0, &maps
);
1569 for (i
= --nmaps
; i
>= 0; i
--)
1570 if (!NILP (maps
[i
]))
1571 keymaps
= Fcons (maps
[i
], keymaps
);
1573 /* This returns nil unless there is a `keymap' property. */
1574 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1576 keymaps
= Fcons (local
, keymaps
);
1582 /* GC is possible in this function if it autoloads a keymap. */
1584 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 4, 0,
1585 doc
: /* Return the binding for command KEY in current keymaps.
1586 KEY is a string or vector, a sequence of keystrokes.
1587 The binding is probably a symbol with a function definition.
1589 Normally, `key-binding' ignores bindings for t, which act as default
1590 bindings, used when nothing else in the keymap applies; this makes it
1591 usable as a general function for probing keymaps. However, if the
1592 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1593 recognize the default bindings, just as `read-key-sequence' does.
1595 Like the normal command loop, `key-binding' will remap the command
1596 resulting from looking up KEY by looking up the command in the
1597 current keymaps. However, if the optional third argument NO-REMAP
1598 is non-nil, `key-binding' returns the unmapped command.
1600 If KEY is a key sequence initiated with the mouse, the used keymaps
1601 will depend on the clicked mouse position with regard to the buffer
1602 and possible local keymaps on strings.
1604 If the optional argument POSITION is non-nil, it specifies a mouse
1605 position as returned by `event-start' and `event-end', and the lookup
1606 occurs in the keymaps associated with it instead of KEY. It can also
1607 be a number or marker, in which case the keymap properties at the
1608 specified buffer position instead of point are used.
1610 (key
, accept_default
, no_remap
, position
)
1611 Lisp_Object key
, accept_default
, no_remap
, position
;
1613 Lisp_Object
*maps
, value
;
1615 struct gcpro gcpro1
, gcpro2
;
1616 int count
= SPECPDL_INDEX ();
1618 GCPRO2 (key
, position
);
1620 if (NILP (position
) && VECTORP (key
))
1623 /* mouse events may have a symbolic prefix indicating the
1624 scrollbar or mode line */
1625 = AREF (key
, SYMBOLP (AREF (key
, 0)) && ASIZE (key
) > 1 ? 1 : 0);
1627 /* We are not interested in locations without event data */
1629 if (EVENT_HAS_PARAMETERS (event
) && CONSP (XCDR (event
)))
1631 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (event
));
1632 if (EQ (kind
, Qmouse_click
))
1633 position
= EVENT_START (event
);
1637 /* Key sequences beginning with mouse clicks
1638 are read using the keymaps of the buffer clicked on, not
1639 the current buffer. So we may have to switch the buffer
1642 if (CONSP (position
))
1646 window
= POSN_WINDOW (position
);
1648 if (WINDOWP (window
)
1649 && BUFFERP (XWINDOW (window
)->buffer
)
1650 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
1652 /* Arrange to go back to the original buffer once we're done
1653 processing the key sequence. We don't use
1654 save_excursion_{save,restore} here, in analogy to
1655 `read-key-sequence' to avoid saving point. Maybe this
1656 would not be a problem here, but it is easier to keep
1660 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
1662 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
1666 if (! NILP (current_kboard
->Voverriding_terminal_local_map
))
1668 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1669 key
, accept_default
);
1670 if (! NILP (value
) && !INTEGERP (value
))
1673 else if (! NILP (Voverriding_local_map
))
1675 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1676 if (! NILP (value
) && !INTEGERP (value
))
1681 Lisp_Object keymap
, local_map
;
1684 pt
= INTEGERP (position
) ? XINT (position
)
1685 : MARKERP (position
) ? marker_position (position
)
1688 local_map
= get_local_map (pt
, current_buffer
, Qlocal_map
);
1689 keymap
= get_local_map (pt
, current_buffer
, Qkeymap
);
1691 if (CONSP (position
))
1695 /* For a mouse click, get the local text-property keymap
1696 of the place clicked on, rather than point. */
1698 if (POSN_INBUFFER_P (position
))
1702 pos
= POSN_BUFFER_POSN (position
);
1704 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
1706 local_map
= get_local_map (XINT (pos
),
1707 current_buffer
, Qlocal_map
);
1709 keymap
= get_local_map (XINT (pos
),
1710 current_buffer
, Qkeymap
);
1714 /* If on a mode line string with a local keymap,
1715 or for a click on a string, i.e. overlay string or a
1716 string displayed via the `display' property,
1717 consider `local-map' and `keymap' properties of
1720 if (string
= POSN_STRING (position
),
1721 (CONSP (string
) && STRINGP (XCAR (string
))))
1723 Lisp_Object pos
, map
;
1725 pos
= XCDR (string
);
1726 string
= XCAR (string
);
1729 && XINT (pos
) < SCHARS (string
))
1731 map
= Fget_text_property (pos
, Qlocal_map
, string
);
1735 map
= Fget_text_property (pos
, Qkeymap
, string
);
1743 if (! NILP (keymap
))
1745 value
= Flookup_key (keymap
, key
, accept_default
);
1746 if (! NILP (value
) && !INTEGERP (value
))
1750 nmaps
= current_minor_maps (0, &maps
);
1751 /* Note that all these maps are GCPRO'd
1752 in the places where we found them. */
1754 for (i
= 0; i
< nmaps
; i
++)
1755 if (! NILP (maps
[i
]))
1757 value
= Flookup_key (maps
[i
], key
, accept_default
);
1758 if (! NILP (value
) && !INTEGERP (value
))
1762 if (! NILP (local_map
))
1764 value
= Flookup_key (local_map
, key
, accept_default
);
1765 if (! NILP (value
) && !INTEGERP (value
))
1770 value
= Flookup_key (current_global_map
, key
, accept_default
);
1773 unbind_to (count
, Qnil
);
1776 if (NILP (value
) || INTEGERP (value
))
1779 /* If the result of the ordinary keymap lookup is an interactive
1780 command, look for a key binding (ie. remapping) for that command. */
1782 if (NILP (no_remap
) && SYMBOLP (value
))
1785 if (value1
= Fcommand_remapping (value
, position
, Qnil
), !NILP (value1
))
1792 /* GC is possible in this function if it autoloads a keymap. */
1794 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1795 doc
: /* Return the binding for command KEYS in current local keymap only.
1796 KEYS is a string or vector, a sequence of keystrokes.
1797 The binding is probably a symbol with a function definition.
1799 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1800 bindings; see the description of `lookup-key' for more details about this. */)
1801 (keys
, accept_default
)
1802 Lisp_Object keys
, accept_default
;
1804 register Lisp_Object map
;
1805 map
= current_buffer
->keymap
;
1808 return Flookup_key (map
, keys
, accept_default
);
1811 /* GC is possible in this function if it autoloads a keymap. */
1813 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1814 doc
: /* Return the binding for command KEYS in current global keymap only.
1815 KEYS is a string or vector, a sequence of keystrokes.
1816 The binding is probably a symbol with a function definition.
1817 This function's return values are the same as those of `lookup-key'
1820 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1821 bindings; see the description of `lookup-key' for more details about this. */)
1822 (keys
, accept_default
)
1823 Lisp_Object keys
, accept_default
;
1825 return Flookup_key (current_global_map
, keys
, accept_default
);
1828 /* GC is possible in this function if it autoloads a keymap. */
1830 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1831 doc
: /* Find the visible minor mode bindings of KEY.
1832 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1833 the symbol which names the minor mode binding KEY, and BINDING is
1834 KEY's definition in that mode. In particular, if KEY has no
1835 minor-mode bindings, return nil. If the first binding is a
1836 non-prefix, all subsequent bindings will be omitted, since they would
1837 be ignored. Similarly, the list doesn't include non-prefix bindings
1838 that come after prefix bindings.
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 (key
, accept_default
)
1843 Lisp_Object key
, accept_default
;
1845 Lisp_Object
*modes
, *maps
;
1847 Lisp_Object binding
;
1849 struct gcpro gcpro1
, gcpro2
;
1851 nmaps
= current_minor_maps (&modes
, &maps
);
1852 /* Note that all these maps are GCPRO'd
1853 in the places where we found them. */
1856 GCPRO2 (key
, binding
);
1858 for (i
= j
= 0; i
< nmaps
; i
++)
1860 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1861 && !INTEGERP (binding
))
1863 if (KEYMAPP (binding
))
1864 maps
[j
++] = Fcons (modes
[i
], binding
);
1866 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1870 return Flist (j
, maps
);
1873 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1874 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1875 A new sparse keymap is stored as COMMAND's function definition and its value.
1876 If a second optional argument MAPVAR is given, the map is stored as
1877 its value instead of as COMMAND's value; but COMMAND is still defined
1879 The third optional argument NAME, if given, supplies a menu name
1880 string for the map. This is required to use the keymap as a menu.
1881 This function returns COMMAND. */)
1882 (command
, mapvar
, name
)
1883 Lisp_Object command
, mapvar
, name
;
1886 map
= Fmake_sparse_keymap (name
);
1887 Ffset (command
, map
);
1891 Fset (command
, map
);
1895 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1896 doc
: /* Select KEYMAP as the global keymap. */)
1900 keymap
= get_keymap (keymap
, 1, 1);
1901 current_global_map
= keymap
;
1906 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1907 doc
: /* Select KEYMAP as the local keymap.
1908 If KEYMAP is nil, that means no local keymap. */)
1913 keymap
= get_keymap (keymap
, 1, 1);
1915 current_buffer
->keymap
= keymap
;
1920 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1921 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1924 return current_buffer
->keymap
;
1927 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1928 doc
: /* Return the current global keymap. */)
1931 return current_global_map
;
1934 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1935 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1939 int nmaps
= current_minor_maps (0, &maps
);
1941 return Flist (nmaps
, maps
);
1944 /* Help functions for describing and documenting keymaps. */
1948 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1949 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1950 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1954 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1958 /* Look for and break cycles. */
1959 while (!NILP (tem
= Frassq (cmd
, maps
)))
1961 Lisp_Object prefix
= XCAR (tem
);
1962 int lim
= XINT (Flength (XCAR (tem
)));
1963 if (lim
<= XINT (Flength (thisseq
)))
1964 { /* This keymap was already seen with a smaller prefix. */
1966 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1967 Faref (thisseq
, make_number (i
))))
1970 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1973 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1974 but maybe `cmd' occurs again further down in `maps', so keep
1976 maps
= XCDR (Fmemq (tem
, maps
));
1979 /* If the last key in thisseq is meta-prefix-char,
1980 turn it into a meta-ized keystroke. We know
1981 that the event we're about to append is an
1982 ascii keystroke since we're processing a
1986 int meta_bit
= meta_modifier
;
1987 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1988 tem
= Fcopy_sequence (thisseq
);
1990 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1992 /* This new sequence is the same length as
1993 thisseq, so stick it in the list right
1996 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
2000 tem
= append_key (thisseq
, key
);
2001 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
2006 accessible_keymaps_char_table (args
, index
, cmd
)
2007 Lisp_Object args
, index
, cmd
;
2009 accessible_keymaps_1 (index
, cmd
,
2013 XINT (XCDR (XCAR (args
))));
2016 /* This function cannot GC. */
2018 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
2020 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
2021 Returns a list of elements of the form (KEYS . MAP), where the sequence
2022 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
2023 so that the KEYS increase in length. The first element is ([] . KEYMAP).
2024 An optional argument PREFIX, if non-nil, should be a key sequence;
2025 then the value includes only maps for prefixes that start with PREFIX. */)
2027 Lisp_Object keymap
, prefix
;
2029 Lisp_Object maps
, tail
;
2032 /* no need for gcpro because we don't autoload any keymaps. */
2035 prefixlen
= XINT (Flength (prefix
));
2039 /* If a prefix was specified, start with the keymap (if any) for
2040 that prefix, so we don't waste time considering other prefixes. */
2042 tem
= Flookup_key (keymap
, prefix
, Qt
);
2043 /* Flookup_key may give us nil, or a number,
2044 if the prefix is not defined in this particular map.
2045 It might even give us a list that isn't a keymap. */
2046 tem
= get_keymap (tem
, 0, 0);
2049 /* Convert PREFIX to a vector now, so that later on
2050 we don't have to deal with the possibility of a string. */
2051 if (STRINGP (prefix
))
2056 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
2057 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
2061 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
2062 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2063 c
^= 0200 | meta_modifier
;
2064 ASET (copy
, i_before
, make_number (c
));
2068 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
2074 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
2075 get_keymap (keymap
, 1, 0)),
2078 /* For each map in the list maps,
2079 look at any other maps it points to,
2080 and stick them at the end if they are not already in the list.
2082 This is a breadth-first traversal, where tail is the queue of
2083 nodes, and maps accumulates a list of all nodes visited. */
2085 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
2087 register Lisp_Object thisseq
, thismap
;
2089 /* Does the current sequence end in the meta-prefix-char? */
2092 thisseq
= Fcar (Fcar (tail
));
2093 thismap
= Fcdr (Fcar (tail
));
2094 last
= make_number (XINT (Flength (thisseq
)) - 1);
2095 is_metized
= (XINT (last
) >= 0
2096 /* Don't metize the last char of PREFIX. */
2097 && XINT (last
) >= prefixlen
2098 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
2100 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
2104 elt
= XCAR (thismap
);
2108 if (CHAR_TABLE_P (elt
))
2110 Lisp_Object indices
[3];
2112 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
2113 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
2114 Fcons (tail
, thisseq
)),
2117 else if (VECTORP (elt
))
2121 /* Vector keymap. Scan all the elements. */
2122 for (i
= 0; i
< ASIZE (elt
); i
++)
2123 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
2124 maps
, tail
, thisseq
, is_metized
);
2127 else if (CONSP (elt
))
2128 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
2129 maps
, tail
, thisseq
,
2130 is_metized
&& INTEGERP (XCAR (elt
)));
2138 Lisp_Object Qsingle_key_description
, Qkey_description
;
2140 /* This function cannot GC. */
2142 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2143 doc
: /* Return a pretty description of key-sequence KEYS.
2144 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2145 Control characters turn into "C-foo" sequences, meta into "M-foo",
2146 spaces are put between sequence elements, etc. */)
2148 Lisp_Object keys
, prefix
;
2153 int size
= XINT (Flength (keys
));
2155 Lisp_Object sep
= build_string (" ");
2160 size
+= XINT (Flength (prefix
));
2162 /* This has one extra element at the end that we don't pass to Fconcat. */
2163 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2165 /* In effect, this computes
2166 (mapconcat 'single-key-description keys " ")
2167 but we shouldn't use mapconcat because it can do GC. */
2171 list
= prefix
, prefix
= Qnil
;
2172 else if (!NILP (keys
))
2173 list
= keys
, keys
= Qnil
;
2178 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2182 return empty_string
;
2183 return Fconcat (len
- 1, args
);
2187 size
= SCHARS (list
);
2188 else if (VECTORP (list
))
2189 size
= XVECTOR (list
)->size
;
2190 else if (CONSP (list
))
2191 size
= XINT (Flength (list
));
2193 wrong_type_argument (Qarrayp
, list
);
2202 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2203 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2204 c
^= 0200 | meta_modifier
;
2205 XSETFASTINT (key
, c
);
2207 else if (VECTORP (list
))
2209 key
= AREF (list
, i
++);
2221 || EQ (key
, meta_prefix_char
)
2222 || (XINT (key
) & meta_modifier
))
2224 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2226 if (EQ (key
, meta_prefix_char
))
2230 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2233 else if (EQ (key
, meta_prefix_char
))
2238 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2246 push_key_description (c
, p
, force_multibyte
)
2247 register unsigned int c
;
2249 int force_multibyte
;
2254 /* Clear all the meaningless bits above the meta bit. */
2255 c
&= meta_modifier
| ~ - meta_modifier
;
2256 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2257 | meta_modifier
| shift_modifier
| super_modifier
);
2259 valid_p
= SINGLE_BYTE_CHAR_P (c2
) || char_valid_p (c2
, 0);
2262 /* KEY_DESCRIPTION_SIZE is large enough for this. */
2263 p
+= sprintf (p
, "[%d]", c
);
2267 if (c
& alt_modifier
)
2273 if ((c
& ctrl_modifier
) != 0
2274 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2278 c
&= ~ctrl_modifier
;
2280 if (c
& hyper_modifier
)
2284 c
-= hyper_modifier
;
2286 if (c
& meta_modifier
)
2292 if (c
& shift_modifier
)
2296 c
-= shift_modifier
;
2298 if (c
& super_modifier
)
2302 c
-= super_modifier
;
2318 else if (c
== Ctl ('M'))
2326 /* `C-' already added above. */
2327 if (c
> 0 && c
<= Ctl ('Z'))
2346 || (NILP (current_buffer
->enable_multibyte_characters
)
2347 && SINGLE_BYTE_CHAR_P (c
)
2348 && !force_multibyte
))
2354 if (force_multibyte
)
2356 if (SINGLE_BYTE_CHAR_P (c
))
2357 c
= unibyte_char_to_multibyte (c
);
2358 p
+= CHAR_STRING (c
, p
);
2360 else if (NILP (current_buffer
->enable_multibyte_characters
))
2364 /* The biggest character code uses 19 bits. */
2365 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2367 if (c
>= (1 << bit_offset
))
2368 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2372 p
+= CHAR_STRING (c
, p
);
2378 /* This function cannot GC. */
2380 DEFUN ("single-key-description", Fsingle_key_description
,
2381 Ssingle_key_description
, 1, 2, 0,
2382 doc
: /* Return a pretty description of command character KEY.
2383 Control characters turn into C-whatever, etc.
2384 Optional argument NO-ANGLES non-nil means don't put angle brackets
2385 around function keys and event symbols. */)
2387 Lisp_Object key
, no_angles
;
2389 if (CONSP (key
) && lucid_event_type_list_p (key
))
2390 key
= Fevent_convert_list (key
);
2392 key
= EVENT_HEAD (key
);
2394 if (INTEGERP (key
)) /* Normal character */
2396 unsigned int charset
, c1
, c2
;
2397 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2399 if (SINGLE_BYTE_CHAR_P (without_bits
))
2402 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2404 if (! CHAR_VALID_P (without_bits
, 1))
2408 sprintf (buf
, "Invalid char code %d", XINT (key
));
2409 return build_string (buf
);
2412 && ((c1
== 0 && c2
== -1) || c2
== 0))
2414 /* Handle a generic character. */
2418 name
= CHARSET_TABLE_INFO (charset
, CHARSET_SHORT_NAME_IDX
);
2419 CHECK_STRING (name
);
2421 /* Only a charset is specified. */
2422 sprintf (buf
, "Generic char %d: all of ", without_bits
);
2424 /* 1st code-point of 2-dimensional charset is specified. */
2425 sprintf (buf
, "Generic char %d: row %d of ", without_bits
, c1
);
2426 return concat2 (build_string (buf
), name
);
2430 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2434 end
= push_key_description (XUINT (key
), tem
, 1);
2436 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2437 if (nchars
== nbytes
)
2440 string
= build_string (tem
);
2443 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2447 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2449 if (NILP (no_angles
))
2452 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2453 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2454 return build_string (buffer
);
2457 return Fsymbol_name (key
);
2459 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2460 return Fcopy_sequence (key
);
2462 error ("KEY must be an integer, cons, symbol, or string");
2467 push_text_char_description (c
, p
)
2468 register unsigned int c
;
2480 *p
++ = c
+ 64; /* 'A' - 1 */
2492 /* This function cannot GC. */
2494 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2495 doc
: /* Return a pretty description of file-character CHARACTER.
2496 Control characters turn into "^char", etc. This differs from
2497 `single-key-description' which turns them into "C-char".
2498 Also, this function recognizes the 2**7 bit as the Meta character,
2499 whereas `single-key-description' uses the 2**27 bit for Meta.
2500 See Info node `(elisp)Describing Characters' for examples. */)
2502 Lisp_Object character
;
2504 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2505 unsigned char str
[6];
2508 CHECK_NUMBER (character
);
2510 c
= XINT (character
);
2511 if (!SINGLE_BYTE_CHAR_P (c
))
2513 int len
= CHAR_STRING (c
, str
);
2515 return make_multibyte_string (str
, 1, len
);
2518 *push_text_char_description (c
& 0377, str
) = 0;
2520 return build_string (str
);
2523 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2526 ascii_sequence_p (seq
)
2530 int len
= XINT (Flength (seq
));
2532 for (i
= 0; i
< len
; i
++)
2534 Lisp_Object ii
, elt
;
2536 XSETFASTINT (ii
, i
);
2537 elt
= Faref (seq
, ii
);
2540 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2548 /* where-is - finding a command in a set of keymaps. */
2550 static Lisp_Object
where_is_internal ();
2551 static Lisp_Object
where_is_internal_1 ();
2552 static void where_is_internal_2 ();
2554 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2555 Returns the first non-nil binding found in any of those maps. */
2558 shadow_lookup (shadow
, key
, flag
)
2559 Lisp_Object shadow
, key
, flag
;
2561 Lisp_Object tail
, value
;
2563 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2565 value
= Flookup_key (XCAR (tail
), key
, flag
);
2566 if (NATNUMP (value
))
2568 value
= Flookup_key (XCAR (tail
),
2569 Fsubstring (key
, make_number (0), value
), flag
);
2573 else if (!NILP (value
))
2579 static Lisp_Object Vmouse_events
;
2581 /* This function can GC if Flookup_key autoloads any keymaps. */
2584 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2585 Lisp_Object definition
, keymaps
;
2586 Lisp_Object firstonly
, noindirect
, no_remap
;
2588 Lisp_Object maps
= Qnil
;
2589 Lisp_Object found
, sequences
;
2590 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2591 /* 1 means ignore all menu bindings entirely. */
2592 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2595 while (CONSP (found
))
2599 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2600 found
= XCDR (found
);
2603 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2607 /* If this command is remapped, then it has no key bindings
2610 && SYMBOLP (definition
)
2611 && !NILP (Fcommand_remapping (definition
, Qnil
, keymaps
)))
2612 RETURN_UNGCPRO (Qnil
);
2614 for (; !NILP (maps
); maps
= Fcdr (maps
))
2616 /* Key sequence to reach map, and the map that it reaches */
2617 register Lisp_Object
this, map
, tem
;
2619 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2620 [M-CHAR] sequences, check if last character of the sequence
2621 is the meta-prefix char. */
2625 this = Fcar (Fcar (maps
));
2626 map
= Fcdr (Fcar (maps
));
2627 last
= make_number (XINT (Flength (this)) - 1);
2628 last_is_meta
= (XINT (last
) >= 0
2629 && EQ (Faref (this, last
), meta_prefix_char
));
2631 /* if (nomenus && !ascii_sequence_p (this)) */
2632 if (nomenus
&& XINT (last
) >= 0
2633 && SYMBOLP (tem
= Faref (this, make_number (0)))
2634 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2635 /* If no menu entries should be returned, skip over the
2636 keymaps bound to `menu-bar' and `tool-bar' and other
2637 non-ascii prefixes like `C-down-mouse-2'. */
2644 /* Because the code we want to run on each binding is rather
2645 large, we don't want to have two separate loop bodies for
2646 sparse keymap bindings and tables; we want to iterate one
2647 loop body over both keymap and vector bindings.
2649 For this reason, if Fcar (map) is a vector, we don't
2650 advance map to the next element until i indicates that we
2651 have finished off the vector. */
2652 Lisp_Object elt
, key
, binding
;
2660 /* Set key and binding to the current key and binding, and
2661 advance map and i to the next binding. */
2664 Lisp_Object sequence
;
2666 /* In a vector, look at each element. */
2667 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2669 binding
= AREF (elt
, i
);
2670 XSETFASTINT (key
, i
);
2671 sequence
= where_is_internal_1 (binding
, key
, definition
,
2673 last
, nomenus
, last_is_meta
);
2674 if (!NILP (sequence
))
2675 sequences
= Fcons (sequence
, sequences
);
2678 else if (CHAR_TABLE_P (elt
))
2680 Lisp_Object indices
[3];
2683 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2684 Qnil
), /* Result accumulator. */
2685 Fcons (Fcons (this, last
),
2686 Fcons (make_number (nomenus
),
2687 make_number (last_is_meta
))));
2688 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2690 sequences
= XCDR (XCAR (args
));
2692 else if (CONSP (elt
))
2694 Lisp_Object sequence
;
2697 binding
= XCDR (elt
);
2699 sequence
= where_is_internal_1 (binding
, key
, definition
,
2701 last
, nomenus
, last_is_meta
);
2702 if (!NILP (sequence
))
2703 sequences
= Fcons (sequence
, sequences
);
2707 while (!NILP (sequences
))
2709 Lisp_Object sequence
, remapped
, function
;
2711 sequence
= XCAR (sequences
);
2712 sequences
= XCDR (sequences
);
2714 /* If the current sequence is a command remapping with
2715 format [remap COMMAND], find the key sequences
2716 which run COMMAND, and use those sequences instead. */
2719 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2720 && EQ (AREF (sequence
, 0), Qremap
)
2721 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2723 Lisp_Object remapped1
;
2725 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2726 if (CONSP (remapped1
))
2728 /* Verify that this key binding actually maps to the
2729 remapped command (see below). */
2730 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2732 sequence
= XCAR (remapped1
);
2733 remapped
= XCDR (remapped1
);
2734 goto record_sequence
;
2738 /* Verify that this key binding is not shadowed by another
2739 binding for the same key, before we say it exists.
2741 Mechanism: look for local definition of this key and if
2742 it is defined and does not match what we found then
2745 Either nil or number as value from Flookup_key
2747 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2751 /* Don't annoy user with strings from a menu such as
2752 Select Paste. Change them all to "(any string)",
2753 so that there seems to be only one menu item
2755 if (! NILP (sequence
))
2758 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2760 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2761 build_string ("(any string)"));
2764 /* It is a true unshadowed match. Record it, unless it's already
2765 been seen (as could happen when inheriting keymaps). */
2766 if (NILP (Fmember (sequence
, found
)))
2767 found
= Fcons (sequence
, found
);
2769 /* If firstonly is Qnon_ascii, then we can return the first
2770 binding we find. If firstonly is not Qnon_ascii but not
2771 nil, then we should return the first ascii-only binding
2773 if (EQ (firstonly
, Qnon_ascii
))
2774 RETURN_UNGCPRO (sequence
);
2775 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2776 RETURN_UNGCPRO (sequence
);
2778 if (CONSP (remapped
))
2780 sequence
= XCAR (remapped
);
2781 remapped
= XCDR (remapped
);
2782 goto record_sequence
;
2790 found
= Fnreverse (found
);
2792 /* firstonly may have been t, but we may have gone all the way through
2793 the keymaps without finding an all-ASCII key sequence. So just
2794 return the best we could find. */
2795 if (!NILP (firstonly
))
2796 return Fcar (found
);
2801 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2802 doc
: /* Return list of keys that invoke DEFINITION.
2803 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2804 If KEYMAP is nil, search all the currently active keymaps.
2805 If KEYMAP is a list of keymaps, search only those keymaps.
2807 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2808 rather than a list of all possible key sequences.
2809 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2810 no matter what it is.
2811 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2812 \(or their meta variants) and entirely reject menu bindings.
2814 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2815 to other keymaps or slots. This makes it possible to search for an
2816 indirect definition itself.
2818 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2819 that invoke a command which is remapped to DEFINITION, but include the
2820 remapped command in the returned list. */)
2821 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2822 Lisp_Object definition
, keymap
;
2823 Lisp_Object firstonly
, noindirect
, no_remap
;
2825 Lisp_Object sequences
, keymaps
;
2826 /* 1 means ignore all menu bindings entirely. */
2827 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2830 /* Find the relevant keymaps. */
2831 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2833 else if (!NILP (keymap
))
2834 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2836 keymaps
= Fcurrent_active_maps (Qnil
);
2838 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2839 We don't really need to check `keymap'. */
2840 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2844 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2846 /* Check heuristic-consistency of the cache. */
2847 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2848 where_is_cache
= Qnil
;
2850 if (NILP (where_is_cache
))
2852 /* We need to create the cache. */
2853 Lisp_Object args
[2];
2854 where_is_cache
= Fmake_hash_table (0, args
);
2855 where_is_cache_keymaps
= Qt
;
2857 /* Fill in the cache. */
2858 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2859 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2862 where_is_cache_keymaps
= keymaps
;
2865 /* We want to process definitions from the last to the first.
2866 Instead of consing, copy definitions to a vector and step
2867 over that vector. */
2868 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2869 n
= XINT (Flength (sequences
));
2870 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2871 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2872 defns
[i
++] = XCAR (sequences
);
2874 /* Verify that the key bindings are not shadowed. Note that
2875 the following can GC. */
2876 GCPRO2 (definition
, keymaps
);
2879 for (i
= n
- 1; i
>= 0; --i
)
2880 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2882 if (ascii_sequence_p (defns
[i
]))
2888 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2893 /* Kill the cache so that where_is_internal_1 doesn't think
2894 we're filling it up. */
2895 where_is_cache
= Qnil
;
2896 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2902 /* This is the function that Fwhere_is_internal calls using map_char_table.
2904 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2906 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2907 Since map_char_table doesn't really use the return value from this function,
2908 we the result append to RESULT, the slot in ARGS.
2910 This function can GC because it calls where_is_internal_1 which can
2914 where_is_internal_2 (args
, key
, binding
)
2915 Lisp_Object args
, key
, binding
;
2917 Lisp_Object definition
, noindirect
, this, last
;
2918 Lisp_Object result
, sequence
;
2919 int nomenus
, last_is_meta
;
2920 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2922 GCPRO3 (args
, key
, binding
);
2923 result
= XCDR (XCAR (args
));
2924 definition
= XCAR (XCAR (XCAR (args
)));
2925 noindirect
= XCDR (XCAR (XCAR (args
)));
2926 this = XCAR (XCAR (XCDR (args
)));
2927 last
= XCDR (XCAR (XCDR (args
)));
2928 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2929 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2931 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2932 this, last
, nomenus
, last_is_meta
);
2934 if (!NILP (sequence
))
2935 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2941 /* This function can GC because get_keyelt can. */
2944 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2945 nomenus
, last_is_meta
)
2946 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2947 int nomenus
, last_is_meta
;
2949 Lisp_Object sequence
;
2951 /* Search through indirections unless that's not wanted. */
2952 if (NILP (noindirect
))
2953 binding
= get_keyelt (binding
, 0);
2955 /* End this iteration if this element does not match
2958 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2959 || EQ (binding
, definition
)
2960 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2961 /* Doesn't match. */
2964 /* We have found a match. Construct the key sequence where we found it. */
2965 if (INTEGERP (key
) && last_is_meta
)
2967 sequence
= Fcopy_sequence (this);
2968 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2971 sequence
= append_key (this, key
);
2973 if (!NILP (where_is_cache
))
2975 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2976 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2983 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2985 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2986 doc
: /* Insert the list of all defined keys and their definitions.
2987 The list is inserted in the current buffer, while the bindings are
2988 looked up in BUFFER.
2989 The optional argument PREFIX, if non-nil, should be a key sequence;
2990 then we display only bindings that start with that prefix.
2991 The optional argument MENUS, if non-nil, says to mention menu bindings.
2992 \(Ordinarily these are omitted from the output.) */)
2993 (buffer
, prefix
, menus
)
2994 Lisp_Object buffer
, prefix
, menus
;
2996 Lisp_Object outbuf
, shadow
;
2997 int nomenu
= NILP (menus
);
2998 register Lisp_Object start1
;
2999 struct gcpro gcpro1
;
3001 char *alternate_heading
3003 Keyboard translations:\n\n\
3004 You type Translation\n\
3005 -------- -----------\n";
3007 CHECK_BUFFER (buffer
);
3012 outbuf
= Fcurrent_buffer ();
3014 /* Report on alternates for keys. */
3015 if (STRINGP (current_kboard
->Vkeyboard_translate_table
) && !NILP (prefix
))
3018 const unsigned char *translate
= SDATA (current_kboard
->Vkeyboard_translate_table
);
3019 int translate_len
= SCHARS (current_kboard
->Vkeyboard_translate_table
);
3021 for (c
= 0; c
< translate_len
; c
++)
3022 if (translate
[c
] != c
)
3024 char buf
[KEY_DESCRIPTION_SIZE
];
3027 if (alternate_heading
)
3029 insert_string (alternate_heading
);
3030 alternate_heading
= 0;
3033 bufend
= push_key_description (translate
[c
], buf
, 1);
3034 insert (buf
, bufend
- buf
);
3035 Findent_to (make_number (16), make_number (1));
3036 bufend
= push_key_description (c
, buf
, 1);
3037 insert (buf
, bufend
- buf
);
3041 /* Insert calls signal_after_change which may GC. */
3042 translate
= SDATA (current_kboard
->Vkeyboard_translate_table
);
3048 if (!NILP (current_kboard
->Vlocal_key_translation_map
))
3049 describe_map_tree (current_kboard
->Vlocal_key_translation_map
, 0, Qnil
, prefix
,
3050 "Key translations", nomenu
, 1, 0, 0);
3053 /* Print the (major mode) local map. */
3055 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
3056 start1
= current_kboard
->Voverriding_terminal_local_map
;
3057 else if (!NILP (Voverriding_local_map
))
3058 start1
= Voverriding_local_map
;
3062 describe_map_tree (start1
, 1, shadow
, prefix
,
3063 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
3064 shadow
= Fcons (start1
, shadow
);
3068 /* Print the minor mode and major mode keymaps. */
3070 Lisp_Object
*modes
, *maps
;
3072 /* Temporarily switch to `buffer', so that we can get that buffer's
3073 minor modes correctly. */
3074 Fset_buffer (buffer
);
3076 nmaps
= current_minor_maps (&modes
, &maps
);
3077 Fset_buffer (outbuf
);
3079 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3080 XBUFFER (buffer
), Qkeymap
);
3083 describe_map_tree (start1
, 1, shadow
, prefix
,
3084 "\f\n`keymap' Property Bindings", nomenu
,
3086 shadow
= Fcons (start1
, shadow
);
3089 /* Print the minor mode maps. */
3090 for (i
= 0; i
< nmaps
; i
++)
3092 /* The title for a minor mode keymap
3093 is constructed at run time.
3094 We let describe_map_tree do the actual insertion
3095 because it takes care of other features when doing so. */
3098 if (!SYMBOLP (modes
[i
]))
3101 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
3105 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
3106 SCHARS (SYMBOL_NAME (modes
[i
])));
3107 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
3109 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
3110 p
+= sizeof (" Minor Mode Bindings") - 1;
3113 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
3114 title
, nomenu
, 0, 0, 0);
3115 shadow
= Fcons (maps
[i
], shadow
);
3118 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3119 XBUFFER (buffer
), Qlocal_map
);
3122 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
3123 describe_map_tree (start1
, 1, shadow
, prefix
,
3124 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
3126 describe_map_tree (start1
, 1, shadow
, prefix
,
3127 "\f\n`local-map' Property Bindings",
3130 shadow
= Fcons (start1
, shadow
);
3134 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
3135 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
3137 /* Print the function-key-map translations under this prefix. */
3138 if (!NILP (current_kboard
->Vlocal_function_key_map
))
3139 describe_map_tree (current_kboard
->Vlocal_function_key_map
, 0, Qnil
, prefix
,
3140 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
3146 /* Insert a description of the key bindings in STARTMAP,
3147 followed by those of all maps reachable through STARTMAP.
3148 If PARTIAL is nonzero, omit certain "uninteresting" commands
3149 (such as `undefined').
3150 If SHADOW is non-nil, it is a list of maps;
3151 don't mention keys which would be shadowed by any of them.
3152 PREFIX, if non-nil, says mention only keys that start with PREFIX.
3153 TITLE, if not 0, is a string to insert at the beginning.
3154 TITLE should not end with a colon or a newline; we supply that.
3155 If NOMENU is not 0, then omit menu-bar commands.
3157 If TRANSL is nonzero, the definitions are actually key translations
3158 so print strings and vectors differently.
3160 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
3163 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
3164 don't omit it; instead, mention it but say it is shadowed. */
3167 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
3168 always_title
, mention_shadow
)
3169 Lisp_Object startmap
, shadow
, prefix
;
3177 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
3178 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3185 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3188 GCPRO3 (maps
, seen
, sub_shadows
);
3194 /* Delete from MAPS each element that is for the menu bar. */
3195 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3197 Lisp_Object elt
, prefix
, tem
;
3200 prefix
= Fcar (elt
);
3201 if (XVECTOR (prefix
)->size
>= 1)
3203 tem
= Faref (prefix
, make_number (0));
3204 if (EQ (tem
, Qmenu_bar
))
3205 maps
= Fdelq (elt
, maps
);
3210 if (!NILP (maps
) || always_title
)
3214 insert_string (title
);
3217 insert_string (" Starting With ");
3218 insert1 (Fkey_description (prefix
, Qnil
));
3220 insert_string (":\n");
3222 insert_string (key_heading
);
3226 for (; !NILP (maps
); maps
= Fcdr (maps
))
3228 register Lisp_Object elt
, prefix
, tail
;
3231 prefix
= Fcar (elt
);
3235 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3239 shmap
= XCAR (tail
);
3241 /* If the sequence by which we reach this keymap is zero-length,
3242 then the shadow map for this keymap is just SHADOW. */
3243 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3244 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3246 /* If the sequence by which we reach this keymap actually has
3247 some elements, then the sequence's definition in SHADOW is
3248 what we should use. */
3251 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3252 if (INTEGERP (shmap
))
3256 /* If shmap is not nil and not a keymap,
3257 it completely shadows this map, so don't
3258 describe this map at all. */
3259 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3263 sub_shadows
= Fcons (shmap
, sub_shadows
);
3266 /* Maps we have already listed in this loop shadow this map. */
3267 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3270 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3272 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3275 describe_map (Fcdr (elt
), prefix
,
3276 transl
? describe_translation
: describe_command
,
3277 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3283 insert_string ("\n");
3288 static int previous_description_column
;
3291 describe_command (definition
, args
)
3292 Lisp_Object definition
, args
;
3294 register Lisp_Object tem1
;
3295 int column
= (int) current_column (); /* iftc */
3296 int description_column
;
3298 /* If column 16 is no good, go to col 32;
3299 but don't push beyond that--go to next line instead. */
3303 description_column
= 32;
3305 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3306 description_column
= 32;
3308 description_column
= 16;
3310 Findent_to (make_number (description_column
), make_number (1));
3311 previous_description_column
= description_column
;
3313 if (SYMBOLP (definition
))
3315 tem1
= SYMBOL_NAME (definition
);
3317 insert_string ("\n");
3319 else if (STRINGP (definition
) || VECTORP (definition
))
3320 insert_string ("Keyboard Macro\n");
3321 else if (KEYMAPP (definition
))
3322 insert_string ("Prefix Command\n");
3324 insert_string ("??\n");
3328 describe_translation (definition
, args
)
3329 Lisp_Object definition
, args
;
3331 register Lisp_Object tem1
;
3333 Findent_to (make_number (16), make_number (1));
3335 if (SYMBOLP (definition
))
3337 tem1
= SYMBOL_NAME (definition
);
3339 insert_string ("\n");
3341 else if (STRINGP (definition
) || VECTORP (definition
))
3343 insert1 (Fkey_description (definition
, Qnil
));
3344 insert_string ("\n");
3346 else if (KEYMAPP (definition
))
3347 insert_string ("Prefix Command\n");
3349 insert_string ("??\n");
3352 /* describe_map puts all the usable elements of a sparse keymap
3353 into an array of `struct describe_map_elt',
3354 then sorts them by the events. */
3356 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3358 /* qsort comparison function for sorting `struct describe_map_elt' by
3362 describe_map_compare (aa
, bb
)
3363 const void *aa
, *bb
;
3365 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3366 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3367 return ((XINT (a
->event
) > XINT (b
->event
))
3368 - (XINT (a
->event
) < XINT (b
->event
)));
3369 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3371 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3373 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3374 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3375 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3380 /* Describe the contents of map MAP, assuming that this map itself is
3381 reached by the sequence of prefix keys PREFIX (a string or vector).
3382 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3385 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3386 seen
, nomenu
, mention_shadow
)
3387 register Lisp_Object map
;
3389 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3396 Lisp_Object tail
, definition
, event
;
3398 Lisp_Object suppress
;
3401 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3403 /* These accumulate the values from sparse keymap bindings,
3404 so we can sort them and handle them in order. */
3405 int length_needed
= 0;
3406 struct describe_map_elt
*vect
;
3413 suppress
= intern ("suppress-keymap");
3415 /* This vector gets used to present single keys to Flookup_key. Since
3416 that is done once per keymap element, we don't want to cons up a
3417 fresh vector every time. */
3418 kludge
= Fmake_vector (make_number (1), Qnil
);
3421 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3424 vect
= ((struct describe_map_elt
*)
3425 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3427 GCPRO3 (prefix
, definition
, kludge
);
3429 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3433 if (VECTORP (XCAR (tail
))
3434 || CHAR_TABLE_P (XCAR (tail
)))
3435 describe_vector (XCAR (tail
),
3436 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3437 (int *)0, 0, 1, mention_shadow
);
3438 else if (CONSP (XCAR (tail
)))
3440 int this_shadowed
= 0;
3442 event
= XCAR (XCAR (tail
));
3444 /* Ignore bindings whose "prefix" are not really valid events.
3445 (We get these in the frames and buffers menu.) */
3446 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3449 if (nomenu
&& EQ (event
, Qmenu_bar
))
3452 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3454 /* Don't show undefined commands or suppressed commands. */
3455 if (NILP (definition
)) continue;
3456 if (SYMBOLP (definition
) && partial
)
3458 tem
= Fget (definition
, suppress
);
3463 /* Don't show a command that isn't really visible
3464 because a local definition of the same key shadows it. */
3466 ASET (kludge
, 0, event
);
3469 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3472 /* If both bindings are keymaps, this key is a prefix key,
3473 so don't say it is shadowed. */
3474 if (KEYMAPP (definition
) && KEYMAPP (tem
))
3476 /* Avoid generating duplicate entries if the
3477 shadowed binding has the same definition. */
3478 else if (mention_shadow
&& !EQ (tem
, definition
))
3485 tem
= Flookup_key (map
, kludge
, Qt
);
3486 if (!EQ (tem
, definition
)) continue;
3488 vect
[slots_used
].event
= event
;
3489 vect
[slots_used
].definition
= definition
;
3490 vect
[slots_used
].shadowed
= this_shadowed
;
3493 else if (EQ (XCAR (tail
), Qkeymap
))
3495 /* The same keymap might be in the structure twice, if we're
3496 using an inherited keymap. So skip anything we've already
3498 tem
= Fassq (tail
, *seen
);
3499 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3501 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3505 /* If we found some sparse map events, sort them. */
3507 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3508 describe_map_compare
);
3510 /* Now output them in sorted order. */
3512 for (i
= 0; i
< slots_used
; i
++)
3514 Lisp_Object start
, end
;
3518 previous_description_column
= 0;
3523 ASET (kludge
, 0, vect
[i
].event
);
3524 start
= vect
[i
].event
;
3527 definition
= vect
[i
].definition
;
3529 /* Find consecutive chars that are identically defined. */
3530 if (INTEGERP (vect
[i
].event
))
3532 while (i
+ 1 < slots_used
3533 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3534 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3535 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3537 end
= vect
[i
].event
;
3540 /* Now START .. END is the range to describe next. */
3542 /* Insert the string to describe the event START. */
3543 insert1 (Fkey_description (kludge
, prefix
));
3545 if (!EQ (start
, end
))
3549 ASET (kludge
, 0, end
);
3550 /* Insert the string to describe the character END. */
3551 insert1 (Fkey_description (kludge
, prefix
));
3554 /* Print a description of the definition of this character.
3555 elt_describer will take care of spacing out far enough
3556 for alignment purposes. */
3557 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3559 if (vect
[i
].shadowed
)
3562 insert_string ("\n (that binding is currently shadowed by another mode)");
3571 describe_vector_princ (elt
, fun
)
3572 Lisp_Object elt
, fun
;
3574 Findent_to (make_number (16), make_number (1));
3579 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3580 doc
: /* Insert a description of contents of VECTOR.
3581 This is text showing the elements of vector matched against indices.
3582 DESCRIBER is the output function used; nil means use `princ'. */)
3584 Lisp_Object vector
, describer
;
3586 int count
= SPECPDL_INDEX ();
3587 if (NILP (describer
))
3588 describer
= intern ("princ");
3589 specbind (Qstandard_output
, Fcurrent_buffer ());
3590 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3591 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3592 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3594 return unbind_to (count
, Qnil
);
3597 /* Insert in the current buffer a description of the contents of VECTOR.
3598 We call ELT_DESCRIBER to insert the description of one value found
3601 ELT_PREFIX describes what "comes before" the keys or indices defined
3602 by this vector. This is a human-readable string whose size
3603 is not necessarily related to the situation.
3605 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3606 leads to this keymap.
3608 If the vector is a chartable, ELT_PREFIX is the vector
3609 of bytes that lead to the character set or portion of a character
3610 set described by this chartable.
3612 If PARTIAL is nonzero, it means do not mention suppressed commands
3613 (that assumes the vector is in a keymap).
3615 SHADOW is a list of keymaps that shadow this map.
3616 If it is non-nil, then we look up the key in those maps
3617 and we don't mention it now if it is defined by any of them.
3619 ENTIRE_MAP is the keymap in which this vector appears.
3620 If the definition in effect in the whole map does not match
3621 the one in this vector, we ignore this one.
3623 When describing a sub-char-table, INDICES is a list of
3624 indices at higher levels in this char-table,
3625 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3627 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3629 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3632 describe_vector (vector
, prefix
, args
, elt_describer
,
3633 partial
, shadow
, entire_map
,
3634 indices
, char_table_depth
, keymap_p
,
3636 register Lisp_Object vector
;
3637 Lisp_Object prefix
, args
;
3638 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3641 Lisp_Object entire_map
;
3643 int char_table_depth
;
3647 Lisp_Object definition
;
3649 Lisp_Object elt_prefix
= Qnil
;
3651 Lisp_Object suppress
;
3654 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3655 /* Range of elements to be handled. */
3657 /* A flag to tell if a leaf in this level of char-table is not a
3658 generic character (i.e. a complete multibyte character). */
3666 indices
= (int *) alloca (3 * sizeof (int));
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");
3691 if (CHAR_TABLE_P (vector
))
3693 if (char_table_depth
== 0)
3695 /* VECTOR is a top level char-table. */
3698 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3702 /* VECTOR is a sub char-table. */
3703 if (char_table_depth
>= 3)
3704 /* A char-table is never that deep. */
3705 error ("Too deep char table");
3708 = (CHARSET_VALID_P (indices
[0])
3709 && ((CHARSET_DIMENSION (indices
[0]) == 1
3710 && char_table_depth
== 1)
3711 || char_table_depth
== 2));
3713 /* Meaningful elements are from 32th to 127th. */
3715 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3720 /* This does the right thing for ordinary vectors. */
3724 to
= XVECTOR (vector
)->size
;
3727 for (i
= from
; i
< to
; i
++)
3729 int this_shadowed
= 0;
3732 if (CHAR_TABLE_P (vector
))
3734 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3737 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3738 && !CHARSET_DEFINED_P (i
- 128))
3742 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3745 definition
= get_keyelt (AREF (vector
, i
), 0);
3747 if (NILP (definition
)) continue;
3749 /* Don't mention suppressed commands. */
3750 if (SYMBOLP (definition
) && partial
)
3754 tem
= Fget (definition
, suppress
);
3756 if (!NILP (tem
)) continue;
3759 /* Set CHARACTER to the character this entry describes, if any.
3760 Also update *INDICES. */
3761 if (CHAR_TABLE_P (vector
))
3763 indices
[char_table_depth
] = i
;
3765 if (char_table_depth
== 0)
3768 indices
[0] = i
- 128;
3770 else if (complete_char
)
3772 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3780 ASET (kludge
, 0, make_number (character
));
3782 /* If this binding is shadowed by some other map, ignore it. */
3783 if (!NILP (shadow
) && complete_char
)
3787 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3798 /* Ignore this definition if it is shadowed by an earlier
3799 one in the same keymap. */
3800 if (!NILP (entire_map
) && complete_char
)
3804 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3806 if (!EQ (tem
, definition
))
3812 if (char_table_depth
== 0)
3817 /* For a sub char-table, show the depth by indentation.
3818 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3819 if (char_table_depth
> 0)
3820 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3822 /* Output the prefix that applies to every entry in this map. */
3823 if (!NILP (elt_prefix
))
3824 insert1 (elt_prefix
);
3826 /* Insert or describe the character this slot is for,
3827 or a description of what it is for. */
3828 if (SUB_CHAR_TABLE_P (vector
))
3831 insert_char (character
);
3834 /* We need an octal representation for this block of
3837 sprintf (work
, "(row %d)", i
);
3838 insert (work
, strlen (work
));
3841 else if (CHAR_TABLE_P (vector
))
3844 insert1 (Fkey_description (kludge
, prefix
));
3847 /* Print the information for this character set. */
3848 insert_string ("<");
3849 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3851 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3860 insert1 (Fkey_description (kludge
, prefix
));
3863 /* If we find a sub char-table within a char-table,
3864 scan it recursively; it defines the details for
3865 a character set or a portion of a character set. */
3866 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3869 describe_vector (definition
, prefix
, args
, elt_describer
,
3870 partial
, shadow
, entire_map
,
3871 indices
, char_table_depth
+ 1, keymap_p
,
3878 /* Find all consecutive characters or rows that have the same
3879 definition. But, for elements of a top level char table, if
3880 they are for charsets, we had better describe one by one even
3881 if they have the same definition. */
3882 if (CHAR_TABLE_P (vector
))
3886 if (char_table_depth
== 0)
3887 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3889 while (i
+ 1 < limit
3890 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3892 && !NILP (Fequal (tem2
, definition
)))
3897 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3899 && !NILP (Fequal (tem2
, definition
)))
3903 /* If we have a range of more than one character,
3904 print where the range reaches to. */
3906 if (i
!= starting_i
)
3910 ASET (kludge
, 0, make_number (i
));
3912 if (!NILP (elt_prefix
))
3913 insert1 (elt_prefix
);
3915 if (CHAR_TABLE_P (vector
))
3917 if (char_table_depth
== 0)
3919 insert1 (Fkey_description (kludge
, prefix
));
3921 else if (complete_char
)
3923 indices
[char_table_depth
] = i
;
3924 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3925 insert_char (character
);
3929 /* We need an octal representation for this block of
3932 sprintf (work
, "(row %d)", i
);
3933 insert (work
, strlen (work
));
3938 insert1 (Fkey_description (kludge
, prefix
));
3942 /* Print a description of the definition of this character.
3943 elt_describer will take care of spacing out far enough
3944 for alignment purposes. */
3945 (*elt_describer
) (definition
, args
);
3950 insert_string (" (binding currently shadowed)");
3955 /* For (sub) char-table, print `defalt' slot at last. */
3956 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3958 insert (" ", char_table_depth
* 2);
3959 insert_string ("<<default>>");
3960 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3966 /* Apropos - finding all symbols whose names match a regexp. */
3967 static Lisp_Object apropos_predicate
;
3968 static Lisp_Object apropos_accumulate
;
3971 apropos_accum (symbol
, string
)
3972 Lisp_Object symbol
, string
;
3974 register Lisp_Object tem
;
3976 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3977 if (!NILP (tem
) && !NILP (apropos_predicate
))
3978 tem
= call1 (apropos_predicate
, symbol
);
3980 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3983 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3984 doc
: /* Show all symbols whose names contain match for REGEXP.
3985 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3986 for each symbol and a symbol is mentioned only if that returns non-nil.
3987 Return list of symbols found. */)
3989 Lisp_Object regexp
, predicate
;
3992 CHECK_STRING (regexp
);
3993 apropos_predicate
= predicate
;
3994 apropos_accumulate
= Qnil
;
3995 map_obarray (Vobarray
, apropos_accum
, regexp
);
3996 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3997 apropos_accumulate
= Qnil
;
3998 apropos_predicate
= Qnil
;
4005 Qkeymap
= intern ("keymap");
4006 staticpro (&Qkeymap
);
4007 staticpro (&apropos_predicate
);
4008 staticpro (&apropos_accumulate
);
4009 apropos_predicate
= Qnil
;
4010 apropos_accumulate
= Qnil
;
4012 /* Now we are ready to set up this property, so we can
4013 create char tables. */
4014 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
4016 /* Initialize the keymaps standardly used.
4017 Each one is the value of a Lisp variable, and is also
4018 pointed to by a C variable */
4020 global_map
= Fmake_keymap (Qnil
);
4021 Fset (intern ("global-map"), global_map
);
4023 current_global_map
= global_map
;
4024 staticpro (&global_map
);
4025 staticpro (¤t_global_map
);
4027 meta_map
= Fmake_keymap (Qnil
);
4028 Fset (intern ("esc-map"), meta_map
);
4029 Ffset (intern ("ESC-prefix"), meta_map
);
4031 control_x_map
= Fmake_keymap (Qnil
);
4032 Fset (intern ("ctl-x-map"), control_x_map
);
4033 Ffset (intern ("Control-X-prefix"), control_x_map
);
4036 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
4037 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
4038 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
4039 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
4040 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
4042 staticpro (&exclude_keys
);
4044 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
4045 doc
: /* List of commands given new key bindings recently.
4046 This is used for internal purposes during Emacs startup;
4047 don't alter it yourself. */);
4048 Vdefine_key_rebound_commands
= Qt
;
4050 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
4051 doc
: /* Default keymap to use when reading from the minibuffer. */);
4052 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
4054 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
4055 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
4056 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
4057 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
4059 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
4060 doc
: /* Local keymap for minibuffer input with completion. */);
4061 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
4062 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
4064 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
4065 &Vminibuffer_local_filename_completion_map
,
4066 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
4067 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
4068 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
4069 Vminibuffer_local_completion_map
);
4072 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
4073 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
4074 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
4075 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
4076 Vminibuffer_local_completion_map
);
4078 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
4079 &Vminibuffer_local_must_match_filename_map
,
4080 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
4081 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
4082 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
4083 Vminibuffer_local_must_match_map
);
4085 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
4086 doc
: /* Alist of keymaps to use for minor modes.
4087 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
4088 key sequences and look up bindings iff VARIABLE's value is non-nil.
4089 If two active keymaps bind the same key, the keymap appearing earlier
4090 in the list takes precedence. */);
4091 Vminor_mode_map_alist
= Qnil
;
4093 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
4094 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
4095 This variable is an alist just like `minor-mode-map-alist', and it is
4096 used the same way (and before `minor-mode-map-alist'); however,
4097 it is provided for major modes to bind locally. */);
4098 Vminor_mode_overriding_map_alist
= Qnil
;
4100 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
4101 doc
: /* List of keymap alists to use for emulations modes.
4102 It is intended for modes or packages using multiple minor-mode keymaps.
4103 Each element is a keymap alist just like `minor-mode-map-alist', or a
4104 symbol with a variable binding which is a keymap alist, and it is used
4105 the same way. The "active" keymaps in each alist are used before
4106 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
4107 Vemulation_mode_map_alists
= Qnil
;
4109 staticpro (&Vmouse_events
);
4110 Vmouse_events
= Fcons (intern ("menu-bar"),
4111 Fcons (intern ("tool-bar"),
4112 Fcons (intern ("header-line"),
4113 Fcons (intern ("mode-line"),
4114 Fcons (intern ("mouse-1"),
4115 Fcons (intern ("mouse-2"),
4116 Fcons (intern ("mouse-3"),
4117 Fcons (intern ("mouse-4"),
4118 Fcons (intern ("mouse-5"),
4122 Qsingle_key_description
= intern ("single-key-description");
4123 staticpro (&Qsingle_key_description
);
4125 Qkey_description
= intern ("key-description");
4126 staticpro (&Qkey_description
);
4128 Qkeymapp
= intern ("keymapp");
4129 staticpro (&Qkeymapp
);
4131 Qnon_ascii
= intern ("non-ascii");
4132 staticpro (&Qnon_ascii
);
4134 Qmenu_item
= intern ("menu-item");
4135 staticpro (&Qmenu_item
);
4137 Qremap
= intern ("remap");
4138 staticpro (&Qremap
);
4140 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
4141 staticpro (&command_remapping_vector
);
4143 where_is_cache_keymaps
= Qt
;
4144 where_is_cache
= Qnil
;
4145 staticpro (&where_is_cache
);
4146 staticpro (&where_is_cache_keymaps
);
4148 defsubr (&Skeymapp
);
4149 defsubr (&Skeymap_parent
);
4150 defsubr (&Skeymap_prompt
);
4151 defsubr (&Sset_keymap_parent
);
4152 defsubr (&Smake_keymap
);
4153 defsubr (&Smake_sparse_keymap
);
4154 defsubr (&Smap_keymap
);
4155 defsubr (&Scopy_keymap
);
4156 defsubr (&Scommand_remapping
);
4157 defsubr (&Skey_binding
);
4158 defsubr (&Slocal_key_binding
);
4159 defsubr (&Sglobal_key_binding
);
4160 defsubr (&Sminor_mode_key_binding
);
4161 defsubr (&Sdefine_key
);
4162 defsubr (&Slookup_key
);
4163 defsubr (&Sdefine_prefix_command
);
4164 defsubr (&Suse_global_map
);
4165 defsubr (&Suse_local_map
);
4166 defsubr (&Scurrent_local_map
);
4167 defsubr (&Scurrent_global_map
);
4168 defsubr (&Scurrent_minor_mode_maps
);
4169 defsubr (&Scurrent_active_maps
);
4170 defsubr (&Saccessible_keymaps
);
4171 defsubr (&Skey_description
);
4172 defsubr (&Sdescribe_vector
);
4173 defsubr (&Ssingle_key_description
);
4174 defsubr (&Stext_char_description
);
4175 defsubr (&Swhere_is_internal
);
4176 defsubr (&Sdescribe_buffer_bindings
);
4177 defsubr (&Sapropos_internal
);
4183 initial_define_key (global_map
, 033, "ESC-prefix");
4184 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
4187 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
4188 (do not change this comment) */