1 /* Manipulation of keymaps
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
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.
1122 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1123 binding is altered. If there is no binding for KEY, the new pair
1124 binding KEY to DEF is added at the front of KEYMAP. */)
1131 register Lisp_Object c
;
1132 register Lisp_Object cmd
;
1136 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1138 GCPRO3 (keymap
, key
, def
);
1139 keymap
= get_keymap (keymap
, 1, 1);
1141 CHECK_VECTOR_OR_STRING (key
);
1143 length
= XFASTINT (Flength (key
));
1145 RETURN_UNGCPRO (Qnil
);
1147 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1148 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1150 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1152 if (VECTORP (def
) && ASIZE (def
) > 0 && CONSP (AREF (def
, 0)))
1153 { /* DEF is apparently an XEmacs-style keyboard macro. */
1154 Lisp_Object tmp
= Fmake_vector (make_number (ASIZE (def
)), Qnil
);
1155 int i
= ASIZE (def
);
1158 Lisp_Object c
= AREF (def
, i
);
1159 if (CONSP (c
) && lucid_event_type_list_p (c
))
1160 c
= Fevent_convert_list (c
);
1169 c
= Faref (key
, make_number (idx
));
1171 if (CONSP (c
) && lucid_event_type_list_p (c
))
1172 c
= Fevent_convert_list (c
);
1175 silly_event_symbol_error (c
);
1178 && (XINT (c
) & meta_bit
)
1181 c
= meta_prefix_char
;
1187 XSETINT (c
, XINT (c
) & ~meta_bit
);
1193 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1194 error ("Key sequence contains invalid event");
1197 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1199 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1201 /* If this key is undefined, make it a prefix. */
1203 cmd
= define_as_prefix (keymap
, c
);
1205 keymap
= get_keymap (cmd
, 0, 1);
1206 if (!CONSP (keymap
))
1207 /* We must use Fkey_description rather than just passing key to
1208 error; key might be a vector, not a string. */
1209 error ("Key sequence %s starts with non-prefix key %s",
1210 SDATA (Fkey_description (key
, Qnil
)),
1211 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1217 /* This function may GC (it calls Fkey_binding). */
1219 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 2, 0,
1220 doc
: /* Return the remapping for command COMMAND in current keymaps.
1221 Returns nil if COMMAND is not remapped (or not a symbol).
1223 If the optional argument POSITION is non-nil, it specifies a mouse
1224 position as returned by `event-start' and `event-end', and the
1225 remapping occurs in the keymaps associated with it. It can also be a
1226 number or marker, in which case the keymap properties at the specified
1227 buffer position instead of point are used. */)
1229 Lisp_Object command
, position
;
1231 if (!SYMBOLP (command
))
1234 ASET (command_remapping_vector
, 1, command
);
1235 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
, position
);
1238 /* Value is number if KEY is too long; nil if valid but has no definition. */
1239 /* GC is possible in this function if it autoloads a keymap. */
1241 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1242 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1243 nil means undefined. See doc of `define-key' for kinds of definitions.
1245 A number as value means KEY is "too long";
1246 that is, characters or symbols in it except for the last one
1247 fail to be a valid sequence of prefix characters in KEYMAP.
1248 The number is how many characters at the front of KEY
1249 it takes to reach a non-prefix key.
1251 Normally, `lookup-key' ignores bindings for t, which act as default
1252 bindings, used when nothing else in the keymap applies; this makes it
1253 usable as a general function for probing keymaps. However, if the
1254 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1255 recognize the default bindings, just as `read-key-sequence' does. */)
1256 (keymap
, key
, accept_default
)
1259 Lisp_Object accept_default
;
1262 register Lisp_Object cmd
;
1263 register Lisp_Object c
;
1265 int t_ok
= !NILP (accept_default
);
1266 struct gcpro gcpro1
, gcpro2
;
1268 GCPRO2 (keymap
, key
);
1269 keymap
= get_keymap (keymap
, 1, 1);
1271 CHECK_VECTOR_OR_STRING (key
);
1273 length
= XFASTINT (Flength (key
));
1275 RETURN_UNGCPRO (keymap
);
1280 c
= Faref (key
, make_number (idx
++));
1282 if (CONSP (c
) && lucid_event_type_list_p (c
))
1283 c
= Fevent_convert_list (c
);
1285 /* Turn the 8th bit of string chars into a meta modifier. */
1286 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1287 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1289 /* Allow string since binding for `menu-bar-select-buffer'
1290 includes the buffer name in the key sequence. */
1291 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1292 error ("Key sequence contains invalid event");
1294 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1296 RETURN_UNGCPRO (cmd
);
1298 keymap
= get_keymap (cmd
, 0, 1);
1299 if (!CONSP (keymap
))
1300 RETURN_UNGCPRO (make_number (idx
));
1306 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1307 Assume that currently it does not define C at all.
1308 Return the keymap. */
1311 define_as_prefix (keymap
, c
)
1312 Lisp_Object keymap
, c
;
1316 cmd
= Fmake_sparse_keymap (Qnil
);
1317 /* If this key is defined as a prefix in an inherited keymap,
1318 make it a prefix in this map, and make its definition
1319 inherit the other prefix definition. */
1320 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1321 store_in_keymap (keymap
, c
, cmd
);
1326 /* Append a key to the end of a key sequence. We always make a vector. */
1329 append_key (key_sequence
, key
)
1330 Lisp_Object key_sequence
, key
;
1332 Lisp_Object args
[2];
1334 args
[0] = key_sequence
;
1336 args
[1] = Fcons (key
, Qnil
);
1337 return Fvconcat (2, args
);
1340 /* Given a event type C which is a symbol,
1341 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1344 silly_event_symbol_error (c
)
1347 Lisp_Object parsed
, base
, name
, assoc
;
1350 parsed
= parse_modifiers (c
);
1351 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1352 base
= XCAR (parsed
);
1353 name
= Fsymbol_name (base
);
1354 /* This alist includes elements such as ("RET" . "\\r"). */
1355 assoc
= Fassoc (name
, exclude_keys
);
1359 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1361 Lisp_Object keystring
;
1362 if (modifiers
& alt_modifier
)
1363 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1364 if (modifiers
& ctrl_modifier
)
1365 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1366 if (modifiers
& hyper_modifier
)
1367 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1368 if (modifiers
& meta_modifier
)
1369 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1370 if (modifiers
& shift_modifier
)
1371 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1372 if (modifiers
& super_modifier
)
1373 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1376 c
= reorder_modifiers (c
);
1377 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1379 error ((modifiers
& ~meta_modifier
1380 ? "To bind the key %s, use [?%s], not [%s]"
1381 : "To bind the key %s, use \"%s\", not [%s]"),
1382 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1383 SDATA (SYMBOL_NAME (c
)));
1387 /* Global, local, and minor mode keymap stuff. */
1389 /* We can't put these variables inside current_minor_maps, since under
1390 some systems, static gets macro-defined to be the empty string.
1392 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1393 static int cmm_size
= 0;
1395 /* Store a pointer to an array of the keymaps of the currently active
1396 minor modes in *buf, and return the number of maps it contains.
1398 This function always returns a pointer to the same buffer, and may
1399 free or reallocate it, so if you want to keep it for a long time or
1400 hand it out to lisp code, copy it. This procedure will be called
1401 for every key sequence read, so the nice lispy approach (return a
1402 new assoclist, list, what have you) for each invocation would
1403 result in a lot of consing over time.
1405 If we used xrealloc/xmalloc and ran out of memory, they would throw
1406 back to the command loop, which would try to read a key sequence,
1407 which would call this function again, resulting in an infinite
1408 loop. Instead, we'll use realloc/malloc and silently truncate the
1409 list, let the key sequence be read, and hope some other piece of
1410 code signals the error. */
1412 current_minor_maps (modeptr
, mapptr
)
1413 Lisp_Object
**modeptr
, **mapptr
;
1416 int list_number
= 0;
1417 Lisp_Object alist
, assoc
, var
, val
;
1418 Lisp_Object emulation_alists
;
1419 Lisp_Object lists
[2];
1421 emulation_alists
= Vemulation_mode_map_alists
;
1422 lists
[0] = Vminor_mode_overriding_map_alist
;
1423 lists
[1] = Vminor_mode_map_alist
;
1425 for (list_number
= 0; list_number
< 2; list_number
++)
1427 if (CONSP (emulation_alists
))
1429 alist
= XCAR (emulation_alists
);
1430 emulation_alists
= XCDR (emulation_alists
);
1431 if (SYMBOLP (alist
))
1432 alist
= find_symbol_value (alist
);
1436 alist
= lists
[list_number
];
1438 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1439 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1440 && (var
= XCAR (assoc
), SYMBOLP (var
))
1441 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1446 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1447 and also an entry in Vminor_mode_map_alist,
1448 ignore the latter. */
1449 if (list_number
== 1)
1451 val
= assq_no_quit (var
, lists
[0]);
1458 int newsize
, allocsize
;
1459 Lisp_Object
*newmodes
, *newmaps
;
1461 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1462 allocsize
= newsize
* sizeof *newmodes
;
1464 /* Use malloc here. See the comment above this function.
1465 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1467 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1472 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1475 cmm_modes
= newmodes
;
1478 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1483 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1490 if (newmodes
== NULL
|| newmaps
== NULL
)
1495 /* Get the keymap definition--or nil if it is not defined. */
1496 temp
= Findirect_function (XCDR (assoc
), Qt
);
1500 cmm_maps
[i
] = temp
;
1506 if (modeptr
) *modeptr
= cmm_modes
;
1507 if (mapptr
) *mapptr
= cmm_maps
;
1511 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1513 doc
: /* Return a list of the currently active keymaps.
1514 OLP if non-nil indicates that we should obey `overriding-local-map' and
1515 `overriding-terminal-local-map'. */)
1519 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1523 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1524 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1525 /* The doc said that overriding-terminal-local-map should
1526 override overriding-local-map. The code used them both,
1527 but it seems clearer to use just one. rms, jan 2005. */
1528 else if (!NILP (Voverriding_local_map
))
1529 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1531 if (NILP (XCDR (keymaps
)))
1537 /* This usually returns the buffer's local map,
1538 but that can be overridden by a `local-map' property. */
1539 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1541 keymaps
= Fcons (local
, keymaps
);
1543 /* Now put all the minor mode keymaps on the list. */
1544 nmaps
= current_minor_maps (0, &maps
);
1546 for (i
= --nmaps
; i
>= 0; i
--)
1547 if (!NILP (maps
[i
]))
1548 keymaps
= Fcons (maps
[i
], keymaps
);
1550 /* This returns nil unless there is a `keymap' property. */
1551 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1553 keymaps
= Fcons (local
, keymaps
);
1559 /* GC is possible in this function if it autoloads a keymap. */
1561 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 4, 0,
1562 doc
: /* Return the binding for command KEY in current keymaps.
1563 KEY is a string or vector, a sequence of keystrokes.
1564 The binding is probably a symbol with a function definition.
1566 Normally, `key-binding' ignores bindings for t, which act as default
1567 bindings, used when nothing else in the keymap applies; this makes it
1568 usable as a general function for probing keymaps. However, if the
1569 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1570 recognize the default bindings, just as `read-key-sequence' does.
1572 Like the normal command loop, `key-binding' will remap the command
1573 resulting from looking up KEY by looking up the command in the
1574 current keymaps. However, if the optional third argument NO-REMAP
1575 is non-nil, `key-binding' returns the unmapped command.
1577 If KEY is a key sequence initiated with the mouse, the used keymaps
1578 will depend on the clicked mouse position with regard to the buffer
1579 and possible local keymaps on strings.
1581 If the optional argument POSITION is non-nil, it specifies a mouse
1582 position as returned by `event-start' and `event-end', and the lookup
1583 occurs in the keymaps associated with it instead of KEY. It can also
1584 be a number or marker, in which case the keymap properties at the
1585 specified buffer position instead of point are used.
1587 (key
, accept_default
, no_remap
, position
)
1588 Lisp_Object key
, accept_default
, no_remap
, position
;
1590 Lisp_Object
*maps
, value
;
1592 struct gcpro gcpro1
, gcpro2
;
1593 int count
= SPECPDL_INDEX ();
1595 GCPRO2 (key
, position
);
1597 if (NILP (position
) && VECTORP (key
))
1600 /* mouse events may have a symbolic prefix indicating the
1601 scrollbar or mode line */
1602 = AREF (key
, SYMBOLP (AREF (key
, 0)) && ASIZE (key
) > 1 ? 1 : 0);
1604 /* We are not interested in locations without event data */
1606 if (EVENT_HAS_PARAMETERS (event
))
1608 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (event
));
1609 if (CONSP (XCDR (event
)) && EQ (kind
, Qmouse_click
))
1610 position
= EVENT_START (event
);
1614 /* Key sequences beginning with mouse clicks
1615 are read using the keymaps of the buffer clicked on, not
1616 the current buffer. So we may have to switch the buffer
1619 if (CONSP (position
))
1623 window
= POSN_WINDOW (position
);
1625 if (WINDOWP (window
)
1626 && BUFFERP (XWINDOW (window
)->buffer
)
1627 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
1629 /* Arrange to go back to the original buffer once we're done
1630 processing the key sequence. We don't use
1631 save_excursion_{save,restore} here, in analogy to
1632 `read-key-sequence' to avoid saving point. Maybe this
1633 would not be a problem here, but it is easier to keep
1637 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
1639 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
1643 if (! NILP (current_kboard
->Voverriding_terminal_local_map
))
1645 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1646 key
, accept_default
);
1647 if (! NILP (value
) && !INTEGERP (value
))
1650 else if (! NILP (Voverriding_local_map
))
1652 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1653 if (! NILP (value
) && !INTEGERP (value
))
1658 Lisp_Object keymap
, local_map
;
1661 pt
= INTEGERP (position
) ? XINT (position
)
1662 : MARKERP (position
) ? marker_position (position
)
1665 local_map
= get_local_map (pt
, current_buffer
, Qlocal_map
);
1666 keymap
= get_local_map (pt
, current_buffer
, Qkeymap
);
1668 if (CONSP (position
))
1672 /* For a mouse click, get the local text-property keymap
1673 of the place clicked on, rather than point. */
1675 if (POSN_INBUFFER_P (position
))
1679 pos
= POSN_BUFFER_POSN (position
);
1681 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
1683 local_map
= get_local_map (XINT (pos
),
1684 current_buffer
, Qlocal_map
);
1686 keymap
= get_local_map (XINT (pos
),
1687 current_buffer
, Qkeymap
);
1691 /* If on a mode line string with a local keymap,
1692 or for a click on a string, i.e. overlay string or a
1693 string displayed via the `display' property,
1694 consider `local-map' and `keymap' properties of
1697 if (string
= POSN_STRING (position
),
1698 (CONSP (string
) && STRINGP (XCAR (string
))))
1700 Lisp_Object pos
, map
;
1702 pos
= XCDR (string
);
1703 string
= XCAR (string
);
1706 && XINT (pos
) < SCHARS (string
))
1708 map
= Fget_text_property (pos
, Qlocal_map
, string
);
1712 map
= Fget_text_property (pos
, Qkeymap
, string
);
1720 if (! NILP (keymap
))
1722 value
= Flookup_key (keymap
, key
, accept_default
);
1723 if (! NILP (value
) && !INTEGERP (value
))
1727 nmaps
= current_minor_maps (0, &maps
);
1728 /* Note that all these maps are GCPRO'd
1729 in the places where we found them. */
1731 for (i
= 0; i
< nmaps
; i
++)
1732 if (! NILP (maps
[i
]))
1734 value
= Flookup_key (maps
[i
], key
, accept_default
);
1735 if (! NILP (value
) && !INTEGERP (value
))
1739 if (! NILP (local_map
))
1741 value
= Flookup_key (local_map
, key
, accept_default
);
1742 if (! NILP (value
) && !INTEGERP (value
))
1747 value
= Flookup_key (current_global_map
, key
, accept_default
);
1750 unbind_to (count
, Qnil
);
1753 if (NILP (value
) || INTEGERP (value
))
1756 /* If the result of the ordinary keymap lookup is an interactive
1757 command, look for a key binding (ie. remapping) for that command. */
1759 if (NILP (no_remap
) && SYMBOLP (value
))
1762 if (value1
= Fcommand_remapping (value
, position
), !NILP (value1
))
1769 /* GC is possible in this function if it autoloads a keymap. */
1771 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1772 doc
: /* Return the binding for command KEYS in current local keymap only.
1773 KEYS is a string or vector, a sequence of keystrokes.
1774 The binding is probably a symbol with a function definition.
1776 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1777 bindings; see the description of `lookup-key' for more details about this. */)
1778 (keys
, accept_default
)
1779 Lisp_Object keys
, accept_default
;
1781 register Lisp_Object map
;
1782 map
= current_buffer
->keymap
;
1785 return Flookup_key (map
, keys
, accept_default
);
1788 /* GC is possible in this function if it autoloads a keymap. */
1790 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1791 doc
: /* Return the binding for command KEYS in current global keymap only.
1792 KEYS is a string or vector, a sequence of keystrokes.
1793 The binding is probably a symbol with a function definition.
1794 This function's return values are the same as those of `lookup-key'
1797 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1798 bindings; see the description of `lookup-key' for more details about this. */)
1799 (keys
, accept_default
)
1800 Lisp_Object keys
, accept_default
;
1802 return Flookup_key (current_global_map
, keys
, accept_default
);
1805 /* GC is possible in this function if it autoloads a keymap. */
1807 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1808 doc
: /* Find the visible minor mode bindings of KEY.
1809 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1810 the symbol which names the minor mode binding KEY, and BINDING is
1811 KEY's definition in that mode. In particular, if KEY has no
1812 minor-mode bindings, return nil. If the first binding is a
1813 non-prefix, all subsequent bindings will be omitted, since they would
1814 be ignored. Similarly, the list doesn't include non-prefix bindings
1815 that come after prefix bindings.
1817 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1818 bindings; see the description of `lookup-key' for more details about this. */)
1819 (key
, accept_default
)
1820 Lisp_Object key
, accept_default
;
1822 Lisp_Object
*modes
, *maps
;
1824 Lisp_Object binding
;
1826 struct gcpro gcpro1
, gcpro2
;
1828 nmaps
= current_minor_maps (&modes
, &maps
);
1829 /* Note that all these maps are GCPRO'd
1830 in the places where we found them. */
1833 GCPRO2 (key
, binding
);
1835 for (i
= j
= 0; i
< nmaps
; i
++)
1837 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1838 && !INTEGERP (binding
))
1840 if (KEYMAPP (binding
))
1841 maps
[j
++] = Fcons (modes
[i
], binding
);
1843 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1847 return Flist (j
, maps
);
1850 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1851 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1852 A new sparse keymap is stored as COMMAND's function definition and its value.
1853 If a second optional argument MAPVAR is given, the map is stored as
1854 its value instead of as COMMAND's value; but COMMAND is still defined
1856 The third optional argument NAME, if given, supplies a menu name
1857 string for the map. This is required to use the keymap as a menu.
1858 This function returns COMMAND. */)
1859 (command
, mapvar
, name
)
1860 Lisp_Object command
, mapvar
, name
;
1863 map
= Fmake_sparse_keymap (name
);
1864 Ffset (command
, map
);
1868 Fset (command
, map
);
1872 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1873 doc
: /* Select KEYMAP as the global keymap. */)
1877 keymap
= get_keymap (keymap
, 1, 1);
1878 current_global_map
= keymap
;
1883 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1884 doc
: /* Select KEYMAP as the local keymap.
1885 If KEYMAP is nil, that means no local keymap. */)
1890 keymap
= get_keymap (keymap
, 1, 1);
1892 current_buffer
->keymap
= keymap
;
1897 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1898 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1901 return current_buffer
->keymap
;
1904 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1905 doc
: /* Return the current global keymap. */)
1908 return current_global_map
;
1911 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1912 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1916 int nmaps
= current_minor_maps (0, &maps
);
1918 return Flist (nmaps
, maps
);
1921 /* Help functions for describing and documenting keymaps. */
1925 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1926 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1927 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1931 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1935 /* Look for and break cycles. */
1936 while (!NILP (tem
= Frassq (cmd
, maps
)))
1938 Lisp_Object prefix
= XCAR (tem
);
1939 int lim
= XINT (Flength (XCAR (tem
)));
1940 if (lim
<= XINT (Flength (thisseq
)))
1941 { /* This keymap was already seen with a smaller prefix. */
1943 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1944 Faref (thisseq
, make_number (i
))))
1947 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1950 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1951 but maybe `cmd' occurs again further down in `maps', so keep
1953 maps
= XCDR (Fmemq (tem
, maps
));
1956 /* If the last key in thisseq is meta-prefix-char,
1957 turn it into a meta-ized keystroke. We know
1958 that the event we're about to append is an
1959 ascii keystroke since we're processing a
1963 int meta_bit
= meta_modifier
;
1964 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1965 tem
= Fcopy_sequence (thisseq
);
1967 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1969 /* This new sequence is the same length as
1970 thisseq, so stick it in the list right
1973 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1977 tem
= append_key (thisseq
, key
);
1978 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1983 accessible_keymaps_char_table (args
, index
, cmd
)
1984 Lisp_Object args
, index
, cmd
;
1986 accessible_keymaps_1 (index
, cmd
,
1990 XINT (XCDR (XCAR (args
))));
1993 /* This function cannot GC. */
1995 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1997 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1998 Returns a list of elements of the form (KEYS . MAP), where the sequence
1999 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
2000 so that the KEYS increase in length. The first element is ([] . KEYMAP).
2001 An optional argument PREFIX, if non-nil, should be a key sequence;
2002 then the value includes only maps for prefixes that start with PREFIX. */)
2004 Lisp_Object keymap
, prefix
;
2006 Lisp_Object maps
, tail
;
2009 /* no need for gcpro because we don't autoload any keymaps. */
2012 prefixlen
= XINT (Flength (prefix
));
2016 /* If a prefix was specified, start with the keymap (if any) for
2017 that prefix, so we don't waste time considering other prefixes. */
2019 tem
= Flookup_key (keymap
, prefix
, Qt
);
2020 /* Flookup_key may give us nil, or a number,
2021 if the prefix is not defined in this particular map.
2022 It might even give us a list that isn't a keymap. */
2023 tem
= get_keymap (tem
, 0, 0);
2026 /* Convert PREFIX to a vector now, so that later on
2027 we don't have to deal with the possibility of a string. */
2028 if (STRINGP (prefix
))
2033 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
2034 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
2038 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
2039 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2040 c
^= 0200 | meta_modifier
;
2041 ASET (copy
, i_before
, make_number (c
));
2045 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
2051 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
2052 get_keymap (keymap
, 1, 0)),
2055 /* For each map in the list maps,
2056 look at any other maps it points to,
2057 and stick them at the end if they are not already in the list.
2059 This is a breadth-first traversal, where tail is the queue of
2060 nodes, and maps accumulates a list of all nodes visited. */
2062 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
2064 register Lisp_Object thisseq
, thismap
;
2066 /* Does the current sequence end in the meta-prefix-char? */
2069 thisseq
= Fcar (Fcar (tail
));
2070 thismap
= Fcdr (Fcar (tail
));
2071 last
= make_number (XINT (Flength (thisseq
)) - 1);
2072 is_metized
= (XINT (last
) >= 0
2073 /* Don't metize the last char of PREFIX. */
2074 && XINT (last
) >= prefixlen
2075 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
2077 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
2081 elt
= XCAR (thismap
);
2085 if (CHAR_TABLE_P (elt
))
2087 Lisp_Object indices
[3];
2089 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
2090 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
2091 Fcons (tail
, thisseq
)),
2094 else if (VECTORP (elt
))
2098 /* Vector keymap. Scan all the elements. */
2099 for (i
= 0; i
< ASIZE (elt
); i
++)
2100 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
2101 maps
, tail
, thisseq
, is_metized
);
2104 else if (CONSP (elt
))
2105 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
2106 maps
, tail
, thisseq
,
2107 is_metized
&& INTEGERP (XCAR (elt
)));
2115 Lisp_Object Qsingle_key_description
, Qkey_description
;
2117 /* This function cannot GC. */
2119 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2120 doc
: /* Return a pretty description of key-sequence KEYS.
2121 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2122 Control characters turn into "C-foo" sequences, meta into "M-foo",
2123 spaces are put between sequence elements, etc. */)
2125 Lisp_Object keys
, prefix
;
2130 int size
= XINT (Flength (keys
));
2132 Lisp_Object sep
= build_string (" ");
2137 size
+= XINT (Flength (prefix
));
2139 /* This has one extra element at the end that we don't pass to Fconcat. */
2140 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2142 /* In effect, this computes
2143 (mapconcat 'single-key-description keys " ")
2144 but we shouldn't use mapconcat because it can do GC. */
2148 list
= prefix
, prefix
= Qnil
;
2149 else if (!NILP (keys
))
2150 list
= keys
, keys
= Qnil
;
2155 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2159 return empty_string
;
2160 return Fconcat (len
- 1, args
);
2164 size
= SCHARS (list
);
2165 else if (VECTORP (list
))
2166 size
= XVECTOR (list
)->size
;
2167 else if (CONSP (list
))
2168 size
= XINT (Flength (list
));
2170 wrong_type_argument (Qarrayp
, list
);
2179 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2180 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2181 c
^= 0200 | meta_modifier
;
2182 XSETFASTINT (key
, c
);
2184 else if (VECTORP (list
))
2186 key
= AREF (list
, i
++);
2198 || EQ (key
, meta_prefix_char
)
2199 || (XINT (key
) & meta_modifier
))
2201 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2203 if (EQ (key
, meta_prefix_char
))
2207 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2210 else if (EQ (key
, meta_prefix_char
))
2215 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2223 push_key_description (c
, p
, force_multibyte
)
2224 register unsigned int c
;
2226 int force_multibyte
;
2231 /* Clear all the meaningless bits above the meta bit. */
2232 c
&= meta_modifier
| ~ - meta_modifier
;
2233 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2234 | meta_modifier
| shift_modifier
| super_modifier
);
2236 valid_p
= SINGLE_BYTE_CHAR_P (c2
) || char_valid_p (c2
, 0);
2239 /* KEY_DESCRIPTION_SIZE is large enough for this. */
2240 p
+= sprintf (p
, "[%d]", c
);
2244 if (c
& alt_modifier
)
2250 if ((c
& ctrl_modifier
) != 0
2251 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2255 c
&= ~ctrl_modifier
;
2257 if (c
& hyper_modifier
)
2261 c
-= hyper_modifier
;
2263 if (c
& meta_modifier
)
2269 if (c
& shift_modifier
)
2273 c
-= shift_modifier
;
2275 if (c
& super_modifier
)
2279 c
-= super_modifier
;
2295 else if (c
== Ctl ('M'))
2303 /* `C-' already added above. */
2304 if (c
> 0 && c
<= Ctl ('Z'))
2323 || (NILP (current_buffer
->enable_multibyte_characters
)
2324 && SINGLE_BYTE_CHAR_P (c
)
2325 && !force_multibyte
))
2331 if (force_multibyte
)
2333 if (SINGLE_BYTE_CHAR_P (c
))
2334 c
= unibyte_char_to_multibyte (c
);
2335 p
+= CHAR_STRING (c
, p
);
2337 else if (NILP (current_buffer
->enable_multibyte_characters
))
2341 /* The biggest character code uses 19 bits. */
2342 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2344 if (c
>= (1 << bit_offset
))
2345 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2349 p
+= CHAR_STRING (c
, p
);
2355 /* This function cannot GC. */
2357 DEFUN ("single-key-description", Fsingle_key_description
,
2358 Ssingle_key_description
, 1, 2, 0,
2359 doc
: /* Return a pretty description of command character KEY.
2360 Control characters turn into C-whatever, etc.
2361 Optional argument NO-ANGLES non-nil means don't put angle brackets
2362 around function keys and event symbols. */)
2364 Lisp_Object key
, no_angles
;
2366 if (CONSP (key
) && lucid_event_type_list_p (key
))
2367 key
= Fevent_convert_list (key
);
2369 key
= EVENT_HEAD (key
);
2371 if (INTEGERP (key
)) /* Normal character */
2373 unsigned int charset
, c1
, c2
;
2374 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2376 if (SINGLE_BYTE_CHAR_P (without_bits
))
2379 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2381 if (! CHAR_VALID_P (without_bits
, 1))
2385 sprintf (buf
, "Invalid char code %d", XINT (key
));
2386 return build_string (buf
);
2389 && ((c1
== 0 && c2
== -1) || c2
== 0))
2391 /* Handle a generic character. */
2395 name
= CHARSET_TABLE_INFO (charset
, CHARSET_SHORT_NAME_IDX
);
2396 CHECK_STRING (name
);
2398 /* Only a charset is specified. */
2399 sprintf (buf
, "Generic char %d: all of ", without_bits
);
2401 /* 1st code-point of 2-dimensional charset is specified. */
2402 sprintf (buf
, "Generic char %d: row %d of ", without_bits
, c1
);
2403 return concat2 (build_string (buf
), name
);
2407 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2411 end
= push_key_description (XUINT (key
), tem
, 1);
2413 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2414 if (nchars
== nbytes
)
2417 string
= build_string (tem
);
2420 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2424 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2426 if (NILP (no_angles
))
2429 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2430 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2431 return build_string (buffer
);
2434 return Fsymbol_name (key
);
2436 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2437 return Fcopy_sequence (key
);
2439 error ("KEY must be an integer, cons, symbol, or string");
2444 push_text_char_description (c
, p
)
2445 register unsigned int c
;
2457 *p
++ = c
+ 64; /* 'A' - 1 */
2469 /* This function cannot GC. */
2471 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2472 doc
: /* Return a pretty description of file-character CHARACTER.
2473 Control characters turn into "^char", etc. This differs from
2474 `single-key-description' which turns them into "C-char".
2475 Also, this function recognizes the 2**7 bit as the Meta character,
2476 whereas `single-key-description' uses the 2**27 bit for Meta.
2477 See Info node `(elisp)Describing Characters' for examples. */)
2479 Lisp_Object character
;
2481 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2482 unsigned char str
[6];
2485 CHECK_NUMBER (character
);
2487 c
= XINT (character
);
2488 if (!SINGLE_BYTE_CHAR_P (c
))
2490 int len
= CHAR_STRING (c
, str
);
2492 return make_multibyte_string (str
, 1, len
);
2495 *push_text_char_description (c
& 0377, str
) = 0;
2497 return build_string (str
);
2500 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2503 ascii_sequence_p (seq
)
2507 int len
= XINT (Flength (seq
));
2509 for (i
= 0; i
< len
; i
++)
2511 Lisp_Object ii
, elt
;
2513 XSETFASTINT (ii
, i
);
2514 elt
= Faref (seq
, ii
);
2517 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2525 /* where-is - finding a command in a set of keymaps. */
2527 static Lisp_Object
where_is_internal ();
2528 static Lisp_Object
where_is_internal_1 ();
2529 static void where_is_internal_2 ();
2531 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2532 Returns the first non-nil binding found in any of those maps. */
2535 shadow_lookup (shadow
, key
, flag
)
2536 Lisp_Object shadow
, key
, flag
;
2538 Lisp_Object tail
, value
;
2540 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2542 value
= Flookup_key (XCAR (tail
), key
, flag
);
2543 if (NATNUMP (value
))
2545 value
= Flookup_key (XCAR (tail
),
2546 Fsubstring (key
, make_number (0), value
), flag
);
2550 else if (!NILP (value
))
2556 static Lisp_Object Vmouse_events
;
2558 /* This function can GC if Flookup_key autoloads any keymaps. */
2561 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2562 Lisp_Object definition
, keymaps
;
2563 Lisp_Object firstonly
, noindirect
, no_remap
;
2565 Lisp_Object maps
= Qnil
;
2566 Lisp_Object found
, sequences
;
2567 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2568 /* 1 means ignore all menu bindings entirely. */
2569 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2571 /* If this command is remapped, then it has no key bindings
2573 if (NILP (no_remap
) && SYMBOLP (definition
))
2576 if (tem
= Fcommand_remapping (definition
, Qnil
), !NILP (tem
))
2581 while (CONSP (found
))
2585 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2586 found
= XCDR (found
);
2589 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2593 for (; !NILP (maps
); maps
= Fcdr (maps
))
2595 /* Key sequence to reach map, and the map that it reaches */
2596 register Lisp_Object
this, map
, tem
;
2598 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2599 [M-CHAR] sequences, check if last character of the sequence
2600 is the meta-prefix char. */
2604 this = Fcar (Fcar (maps
));
2605 map
= Fcdr (Fcar (maps
));
2606 last
= make_number (XINT (Flength (this)) - 1);
2607 last_is_meta
= (XINT (last
) >= 0
2608 && EQ (Faref (this, last
), meta_prefix_char
));
2610 /* if (nomenus && !ascii_sequence_p (this)) */
2611 if (nomenus
&& XINT (last
) >= 0
2612 && SYMBOLP (tem
= Faref (this, make_number (0)))
2613 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2614 /* If no menu entries should be returned, skip over the
2615 keymaps bound to `menu-bar' and `tool-bar' and other
2616 non-ascii prefixes like `C-down-mouse-2'. */
2623 /* Because the code we want to run on each binding is rather
2624 large, we don't want to have two separate loop bodies for
2625 sparse keymap bindings and tables; we want to iterate one
2626 loop body over both keymap and vector bindings.
2628 For this reason, if Fcar (map) is a vector, we don't
2629 advance map to the next element until i indicates that we
2630 have finished off the vector. */
2631 Lisp_Object elt
, key
, binding
;
2639 /* Set key and binding to the current key and binding, and
2640 advance map and i to the next binding. */
2643 Lisp_Object sequence
;
2645 /* In a vector, look at each element. */
2646 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2648 binding
= AREF (elt
, i
);
2649 XSETFASTINT (key
, i
);
2650 sequence
= where_is_internal_1 (binding
, key
, definition
,
2652 last
, nomenus
, last_is_meta
);
2653 if (!NILP (sequence
))
2654 sequences
= Fcons (sequence
, sequences
);
2657 else if (CHAR_TABLE_P (elt
))
2659 Lisp_Object indices
[3];
2662 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2663 Qnil
), /* Result accumulator. */
2664 Fcons (Fcons (this, last
),
2665 Fcons (make_number (nomenus
),
2666 make_number (last_is_meta
))));
2667 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2669 sequences
= XCDR (XCAR (args
));
2671 else if (CONSP (elt
))
2673 Lisp_Object sequence
;
2676 binding
= XCDR (elt
);
2678 sequence
= where_is_internal_1 (binding
, key
, definition
,
2680 last
, nomenus
, last_is_meta
);
2681 if (!NILP (sequence
))
2682 sequences
= Fcons (sequence
, sequences
);
2686 while (!NILP (sequences
))
2688 Lisp_Object sequence
, remapped
, function
;
2690 sequence
= XCAR (sequences
);
2691 sequences
= XCDR (sequences
);
2693 /* If the current sequence is a command remapping with
2694 format [remap COMMAND], find the key sequences
2695 which run COMMAND, and use those sequences instead. */
2698 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2699 && EQ (AREF (sequence
, 0), Qremap
)
2700 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2702 Lisp_Object remapped1
;
2704 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2705 if (CONSP (remapped1
))
2707 /* Verify that this key binding actually maps to the
2708 remapped command (see below). */
2709 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2711 sequence
= XCAR (remapped1
);
2712 remapped
= XCDR (remapped1
);
2713 goto record_sequence
;
2717 /* Verify that this key binding is not shadowed by another
2718 binding for the same key, before we say it exists.
2720 Mechanism: look for local definition of this key and if
2721 it is defined and does not match what we found then
2724 Either nil or number as value from Flookup_key
2726 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2730 /* Don't annoy user with strings from a menu such as
2731 Select Paste. Change them all to "(any string)",
2732 so that there seems to be only one menu item
2734 if (! NILP (sequence
))
2737 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2739 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2740 build_string ("(any string)"));
2743 /* It is a true unshadowed match. Record it, unless it's already
2744 been seen (as could happen when inheriting keymaps). */
2745 if (NILP (Fmember (sequence
, found
)))
2746 found
= Fcons (sequence
, found
);
2748 /* If firstonly is Qnon_ascii, then we can return the first
2749 binding we find. If firstonly is not Qnon_ascii but not
2750 nil, then we should return the first ascii-only binding
2752 if (EQ (firstonly
, Qnon_ascii
))
2753 RETURN_UNGCPRO (sequence
);
2754 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2755 RETURN_UNGCPRO (sequence
);
2757 if (CONSP (remapped
))
2759 sequence
= XCAR (remapped
);
2760 remapped
= XCDR (remapped
);
2761 goto record_sequence
;
2769 found
= Fnreverse (found
);
2771 /* firstonly may have been t, but we may have gone all the way through
2772 the keymaps without finding an all-ASCII key sequence. So just
2773 return the best we could find. */
2774 if (!NILP (firstonly
))
2775 return Fcar (found
);
2780 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2781 doc
: /* Return list of keys that invoke DEFINITION.
2782 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2783 If KEYMAP is nil, search all the currently active keymaps.
2784 If KEYMAP is a list of keymaps, search only those keymaps.
2786 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2787 rather than a list of all possible key sequences.
2788 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2789 no matter what it is.
2790 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2791 \(or their meta variants) and entirely reject menu bindings.
2793 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2794 to other keymaps or slots. This makes it possible to search for an
2795 indirect definition itself.
2797 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2798 that invoke a command which is remapped to DEFINITION, but include the
2799 remapped command in the returned list. */)
2800 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2801 Lisp_Object definition
, keymap
;
2802 Lisp_Object firstonly
, noindirect
, no_remap
;
2804 Lisp_Object sequences
, keymaps
;
2805 /* 1 means ignore all menu bindings entirely. */
2806 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2809 /* Find the relevant keymaps. */
2810 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2812 else if (!NILP (keymap
))
2813 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2815 keymaps
= Fcurrent_active_maps (Qnil
);
2817 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2818 We don't really need to check `keymap'. */
2819 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2823 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2825 /* Check heuristic-consistency of the cache. */
2826 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2827 where_is_cache
= Qnil
;
2829 if (NILP (where_is_cache
))
2831 /* We need to create the cache. */
2832 Lisp_Object args
[2];
2833 where_is_cache
= Fmake_hash_table (0, args
);
2834 where_is_cache_keymaps
= Qt
;
2836 /* Fill in the cache. */
2837 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2838 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2841 where_is_cache_keymaps
= keymaps
;
2844 /* We want to process definitions from the last to the first.
2845 Instead of consing, copy definitions to a vector and step
2846 over that vector. */
2847 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2848 n
= XINT (Flength (sequences
));
2849 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2850 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2851 defns
[i
++] = XCAR (sequences
);
2853 /* Verify that the key bindings are not shadowed. Note that
2854 the following can GC. */
2855 GCPRO2 (definition
, keymaps
);
2858 for (i
= n
- 1; i
>= 0; --i
)
2859 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2861 if (ascii_sequence_p (defns
[i
]))
2867 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2872 /* Kill the cache so that where_is_internal_1 doesn't think
2873 we're filling it up. */
2874 where_is_cache
= Qnil
;
2875 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2881 /* This is the function that Fwhere_is_internal calls using map_char_table.
2883 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2885 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2886 Since map_char_table doesn't really use the return value from this function,
2887 we the result append to RESULT, the slot in ARGS.
2889 This function can GC because it calls where_is_internal_1 which can
2893 where_is_internal_2 (args
, key
, binding
)
2894 Lisp_Object args
, key
, binding
;
2896 Lisp_Object definition
, noindirect
, this, last
;
2897 Lisp_Object result
, sequence
;
2898 int nomenus
, last_is_meta
;
2899 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2901 GCPRO3 (args
, key
, binding
);
2902 result
= XCDR (XCAR (args
));
2903 definition
= XCAR (XCAR (XCAR (args
)));
2904 noindirect
= XCDR (XCAR (XCAR (args
)));
2905 this = XCAR (XCAR (XCDR (args
)));
2906 last
= XCDR (XCAR (XCDR (args
)));
2907 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2908 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2910 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2911 this, last
, nomenus
, last_is_meta
);
2913 if (!NILP (sequence
))
2914 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2920 /* This function can GC because get_keyelt can. */
2923 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2924 nomenus
, last_is_meta
)
2925 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2926 int nomenus
, last_is_meta
;
2928 Lisp_Object sequence
;
2930 /* Search through indirections unless that's not wanted. */
2931 if (NILP (noindirect
))
2932 binding
= get_keyelt (binding
, 0);
2934 /* End this iteration if this element does not match
2937 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2938 || EQ (binding
, definition
)
2939 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2940 /* Doesn't match. */
2943 /* We have found a match. Construct the key sequence where we found it. */
2944 if (INTEGERP (key
) && last_is_meta
)
2946 sequence
= Fcopy_sequence (this);
2947 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2950 sequence
= append_key (this, key
);
2952 if (!NILP (where_is_cache
))
2954 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2955 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2962 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2964 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2965 doc
: /* Insert the list of all defined keys and their definitions.
2966 The list is inserted in the current buffer, while the bindings are
2967 looked up in BUFFER.
2968 The optional argument PREFIX, if non-nil, should be a key sequence;
2969 then we display only bindings that start with that prefix.
2970 The optional argument MENUS, if non-nil, says to mention menu bindings.
2971 \(Ordinarily these are omitted from the output.) */)
2972 (buffer
, prefix
, menus
)
2973 Lisp_Object buffer
, prefix
, menus
;
2975 Lisp_Object outbuf
, shadow
;
2976 int nomenu
= NILP (menus
);
2977 register Lisp_Object start1
;
2978 struct gcpro gcpro1
;
2980 char *alternate_heading
2982 Keyboard translations:\n\n\
2983 You type Translation\n\
2984 -------- -----------\n";
2989 outbuf
= Fcurrent_buffer ();
2991 /* Report on alternates for keys. */
2992 if (STRINGP (current_kboard
->Vkeyboard_translate_table
) && !NILP (prefix
))
2995 const unsigned char *translate
= SDATA (current_kboard
->Vkeyboard_translate_table
);
2996 int translate_len
= SCHARS (current_kboard
->Vkeyboard_translate_table
);
2998 for (c
= 0; c
< translate_len
; c
++)
2999 if (translate
[c
] != c
)
3001 char buf
[KEY_DESCRIPTION_SIZE
];
3004 if (alternate_heading
)
3006 insert_string (alternate_heading
);
3007 alternate_heading
= 0;
3010 bufend
= push_key_description (translate
[c
], buf
, 1);
3011 insert (buf
, bufend
- buf
);
3012 Findent_to (make_number (16), make_number (1));
3013 bufend
= push_key_description (c
, buf
, 1);
3014 insert (buf
, bufend
- buf
);
3018 /* Insert calls signal_after_change which may GC. */
3019 translate
= SDATA (current_kboard
->Vkeyboard_translate_table
);
3025 if (!NILP (current_kboard
->Vlocal_key_translation_map
))
3026 describe_map_tree (current_kboard
->Vlocal_key_translation_map
, 0, Qnil
, prefix
,
3027 "Key translations", nomenu
, 1, 0, 0);
3030 /* Print the (major mode) local map. */
3032 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
3033 start1
= current_kboard
->Voverriding_terminal_local_map
;
3034 else if (!NILP (Voverriding_local_map
))
3035 start1
= Voverriding_local_map
;
3039 describe_map_tree (start1
, 1, shadow
, prefix
,
3040 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
3041 shadow
= Fcons (start1
, shadow
);
3045 /* Print the minor mode and major mode keymaps. */
3047 Lisp_Object
*modes
, *maps
;
3049 /* Temporarily switch to `buffer', so that we can get that buffer's
3050 minor modes correctly. */
3051 Fset_buffer (buffer
);
3053 nmaps
= current_minor_maps (&modes
, &maps
);
3054 Fset_buffer (outbuf
);
3056 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3057 XBUFFER (buffer
), Qkeymap
);
3060 describe_map_tree (start1
, 1, shadow
, prefix
,
3061 "\f\n`keymap' Property Bindings", nomenu
,
3063 shadow
= Fcons (start1
, shadow
);
3066 /* Print the minor mode maps. */
3067 for (i
= 0; i
< nmaps
; i
++)
3069 /* The title for a minor mode keymap
3070 is constructed at run time.
3071 We let describe_map_tree do the actual insertion
3072 because it takes care of other features when doing so. */
3075 if (!SYMBOLP (modes
[i
]))
3078 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
3082 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
3083 SCHARS (SYMBOL_NAME (modes
[i
])));
3084 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
3086 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
3087 p
+= sizeof (" Minor Mode Bindings") - 1;
3090 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
3091 title
, nomenu
, 0, 0, 0);
3092 shadow
= Fcons (maps
[i
], shadow
);
3095 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3096 XBUFFER (buffer
), Qlocal_map
);
3099 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
3100 describe_map_tree (start1
, 1, shadow
, prefix
,
3101 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
3103 describe_map_tree (start1
, 1, shadow
, prefix
,
3104 "\f\n`local-map' Property Bindings",
3107 shadow
= Fcons (start1
, shadow
);
3111 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
3112 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
3114 /* Print the function-key-map translations under this prefix. */
3115 if (!NILP (current_kboard
->Vlocal_function_key_map
))
3116 describe_map_tree (current_kboard
->Vlocal_function_key_map
, 0, Qnil
, prefix
,
3117 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
3123 /* Insert a description of the key bindings in STARTMAP,
3124 followed by those of all maps reachable through STARTMAP.
3125 If PARTIAL is nonzero, omit certain "uninteresting" commands
3126 (such as `undefined').
3127 If SHADOW is non-nil, it is a list of maps;
3128 don't mention keys which would be shadowed by any of them.
3129 PREFIX, if non-nil, says mention only keys that start with PREFIX.
3130 TITLE, if not 0, is a string to insert at the beginning.
3131 TITLE should not end with a colon or a newline; we supply that.
3132 If NOMENU is not 0, then omit menu-bar commands.
3134 If TRANSL is nonzero, the definitions are actually key translations
3135 so print strings and vectors differently.
3137 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
3140 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
3141 don't omit it; instead, mention it but say it is shadowed. */
3144 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
3145 always_title
, mention_shadow
)
3146 Lisp_Object startmap
, shadow
, prefix
;
3154 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
3155 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3162 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3165 GCPRO3 (maps
, seen
, sub_shadows
);
3171 /* Delete from MAPS each element that is for the menu bar. */
3172 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3174 Lisp_Object elt
, prefix
, tem
;
3177 prefix
= Fcar (elt
);
3178 if (XVECTOR (prefix
)->size
>= 1)
3180 tem
= Faref (prefix
, make_number (0));
3181 if (EQ (tem
, Qmenu_bar
))
3182 maps
= Fdelq (elt
, maps
);
3187 if (!NILP (maps
) || always_title
)
3191 insert_string (title
);
3194 insert_string (" Starting With ");
3195 insert1 (Fkey_description (prefix
, Qnil
));
3197 insert_string (":\n");
3199 insert_string (key_heading
);
3203 for (; !NILP (maps
); maps
= Fcdr (maps
))
3205 register Lisp_Object elt
, prefix
, tail
;
3208 prefix
= Fcar (elt
);
3212 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3216 shmap
= XCAR (tail
);
3218 /* If the sequence by which we reach this keymap is zero-length,
3219 then the shadow map for this keymap is just SHADOW. */
3220 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3221 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3223 /* If the sequence by which we reach this keymap actually has
3224 some elements, then the sequence's definition in SHADOW is
3225 what we should use. */
3228 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3229 if (INTEGERP (shmap
))
3233 /* If shmap is not nil and not a keymap,
3234 it completely shadows this map, so don't
3235 describe this map at all. */
3236 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3240 sub_shadows
= Fcons (shmap
, sub_shadows
);
3243 /* Maps we have already listed in this loop shadow this map. */
3244 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3247 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3249 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3252 describe_map (Fcdr (elt
), prefix
,
3253 transl
? describe_translation
: describe_command
,
3254 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3260 insert_string ("\n");
3265 static int previous_description_column
;
3268 describe_command (definition
, args
)
3269 Lisp_Object definition
, args
;
3271 register Lisp_Object tem1
;
3272 int column
= (int) current_column (); /* iftc */
3273 int description_column
;
3275 /* If column 16 is no good, go to col 32;
3276 but don't push beyond that--go to next line instead. */
3280 description_column
= 32;
3282 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3283 description_column
= 32;
3285 description_column
= 16;
3287 Findent_to (make_number (description_column
), make_number (1));
3288 previous_description_column
= description_column
;
3290 if (SYMBOLP (definition
))
3292 tem1
= SYMBOL_NAME (definition
);
3294 insert_string ("\n");
3296 else if (STRINGP (definition
) || VECTORP (definition
))
3297 insert_string ("Keyboard Macro\n");
3298 else if (KEYMAPP (definition
))
3299 insert_string ("Prefix Command\n");
3301 insert_string ("??\n");
3305 describe_translation (definition
, args
)
3306 Lisp_Object definition
, args
;
3308 register Lisp_Object tem1
;
3310 Findent_to (make_number (16), make_number (1));
3312 if (SYMBOLP (definition
))
3314 tem1
= SYMBOL_NAME (definition
);
3316 insert_string ("\n");
3318 else if (STRINGP (definition
) || VECTORP (definition
))
3320 insert1 (Fkey_description (definition
, Qnil
));
3321 insert_string ("\n");
3323 else if (KEYMAPP (definition
))
3324 insert_string ("Prefix Command\n");
3326 insert_string ("??\n");
3329 /* describe_map puts all the usable elements of a sparse keymap
3330 into an array of `struct describe_map_elt',
3331 then sorts them by the events. */
3333 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3335 /* qsort comparison function for sorting `struct describe_map_elt' by
3339 describe_map_compare (aa
, bb
)
3340 const void *aa
, *bb
;
3342 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3343 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3344 return ((XINT (a
->event
) > XINT (b
->event
))
3345 - (XINT (a
->event
) < XINT (b
->event
)));
3346 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3348 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3350 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3351 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3352 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3357 /* Describe the contents of map MAP, assuming that this map itself is
3358 reached by the sequence of prefix keys PREFIX (a string or vector).
3359 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3362 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3363 seen
, nomenu
, mention_shadow
)
3364 register Lisp_Object map
;
3366 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3373 Lisp_Object tail
, definition
, event
;
3375 Lisp_Object suppress
;
3378 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3380 /* These accumulate the values from sparse keymap bindings,
3381 so we can sort them and handle them in order. */
3382 int length_needed
= 0;
3383 struct describe_map_elt
*vect
;
3390 suppress
= intern ("suppress-keymap");
3392 /* This vector gets used to present single keys to Flookup_key. Since
3393 that is done once per keymap element, we don't want to cons up a
3394 fresh vector every time. */
3395 kludge
= Fmake_vector (make_number (1), Qnil
);
3398 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3401 vect
= ((struct describe_map_elt
*)
3402 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3404 GCPRO3 (prefix
, definition
, kludge
);
3406 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3410 if (VECTORP (XCAR (tail
))
3411 || CHAR_TABLE_P (XCAR (tail
)))
3412 describe_vector (XCAR (tail
),
3413 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3414 (int *)0, 0, 1, mention_shadow
);
3415 else if (CONSP (XCAR (tail
)))
3417 int this_shadowed
= 0;
3419 event
= XCAR (XCAR (tail
));
3421 /* Ignore bindings whose "prefix" are not really valid events.
3422 (We get these in the frames and buffers menu.) */
3423 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3426 if (nomenu
&& EQ (event
, Qmenu_bar
))
3429 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3431 /* Don't show undefined commands or suppressed commands. */
3432 if (NILP (definition
)) continue;
3433 if (SYMBOLP (definition
) && partial
)
3435 tem
= Fget (definition
, suppress
);
3440 /* Don't show a command that isn't really visible
3441 because a local definition of the same key shadows it. */
3443 ASET (kludge
, 0, event
);
3446 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3449 /* Avoid generating duplicate entries if the
3450 shadowed binding has the same definition. */
3451 if (mention_shadow
&& !EQ (tem
, definition
))
3458 tem
= Flookup_key (map
, kludge
, Qt
);
3459 if (!EQ (tem
, definition
)) continue;
3461 vect
[slots_used
].event
= event
;
3462 vect
[slots_used
].definition
= definition
;
3463 vect
[slots_used
].shadowed
= this_shadowed
;
3466 else if (EQ (XCAR (tail
), Qkeymap
))
3468 /* The same keymap might be in the structure twice, if we're
3469 using an inherited keymap. So skip anything we've already
3471 tem
= Fassq (tail
, *seen
);
3472 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3474 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3478 /* If we found some sparse map events, sort them. */
3480 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3481 describe_map_compare
);
3483 /* Now output them in sorted order. */
3485 for (i
= 0; i
< slots_used
; i
++)
3487 Lisp_Object start
, end
;
3491 previous_description_column
= 0;
3496 ASET (kludge
, 0, vect
[i
].event
);
3497 start
= vect
[i
].event
;
3500 definition
= vect
[i
].definition
;
3502 /* Find consecutive chars that are identically defined. */
3503 if (INTEGERP (vect
[i
].event
))
3505 while (i
+ 1 < slots_used
3506 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3507 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3508 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3510 end
= vect
[i
].event
;
3513 /* Now START .. END is the range to describe next. */
3515 /* Insert the string to describe the event START. */
3516 insert1 (Fkey_description (kludge
, prefix
));
3518 if (!EQ (start
, end
))
3522 ASET (kludge
, 0, end
);
3523 /* Insert the string to describe the character END. */
3524 insert1 (Fkey_description (kludge
, prefix
));
3527 /* Print a description of the definition of this character.
3528 elt_describer will take care of spacing out far enough
3529 for alignment purposes. */
3530 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3532 if (vect
[i
].shadowed
)
3535 insert_string ("\n (that binding is currently shadowed by another mode)");
3544 describe_vector_princ (elt
, fun
)
3545 Lisp_Object elt
, fun
;
3547 Findent_to (make_number (16), make_number (1));
3552 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3553 doc
: /* Insert a description of contents of VECTOR.
3554 This is text showing the elements of vector matched against indices.
3555 DESCRIBER is the output function used; nil means use `princ'. */)
3557 Lisp_Object vector
, describer
;
3559 int count
= SPECPDL_INDEX ();
3560 if (NILP (describer
))
3561 describer
= intern ("princ");
3562 specbind (Qstandard_output
, Fcurrent_buffer ());
3563 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3564 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3565 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3567 return unbind_to (count
, Qnil
);
3570 /* Insert in the current buffer a description of the contents of VECTOR.
3571 We call ELT_DESCRIBER to insert the description of one value found
3574 ELT_PREFIX describes what "comes before" the keys or indices defined
3575 by this vector. This is a human-readable string whose size
3576 is not necessarily related to the situation.
3578 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3579 leads to this keymap.
3581 If the vector is a chartable, ELT_PREFIX is the vector
3582 of bytes that lead to the character set or portion of a character
3583 set described by this chartable.
3585 If PARTIAL is nonzero, it means do not mention suppressed commands
3586 (that assumes the vector is in a keymap).
3588 SHADOW is a list of keymaps that shadow this map.
3589 If it is non-nil, then we look up the key in those maps
3590 and we don't mention it now if it is defined by any of them.
3592 ENTIRE_MAP is the keymap in which this vector appears.
3593 If the definition in effect in the whole map does not match
3594 the one in this vector, we ignore this one.
3596 When describing a sub-char-table, INDICES is a list of
3597 indices at higher levels in this char-table,
3598 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3600 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3602 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3605 describe_vector (vector
, prefix
, args
, elt_describer
,
3606 partial
, shadow
, entire_map
,
3607 indices
, char_table_depth
, keymap_p
,
3609 register Lisp_Object vector
;
3610 Lisp_Object prefix
, args
;
3611 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3614 Lisp_Object entire_map
;
3616 int char_table_depth
;
3620 Lisp_Object definition
;
3622 Lisp_Object elt_prefix
= Qnil
;
3624 Lisp_Object suppress
;
3627 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3628 /* Range of elements to be handled. */
3630 /* A flag to tell if a leaf in this level of char-table is not a
3631 generic character (i.e. a complete multibyte character). */
3639 indices
= (int *) alloca (3 * sizeof (int));
3645 /* Call Fkey_description first, to avoid GC bug for the other string. */
3646 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3649 tem
= Fkey_description (prefix
, Qnil
);
3650 elt_prefix
= concat2 (tem
, build_string (" "));
3655 /* This vector gets used to present single keys to Flookup_key. Since
3656 that is done once per vector element, we don't want to cons up a
3657 fresh vector every time. */
3658 kludge
= Fmake_vector (make_number (1), Qnil
);
3659 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3662 suppress
= intern ("suppress-keymap");
3664 if (CHAR_TABLE_P (vector
))
3666 if (char_table_depth
== 0)
3668 /* VECTOR is a top level char-table. */
3671 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3675 /* VECTOR is a sub char-table. */
3676 if (char_table_depth
>= 3)
3677 /* A char-table is never that deep. */
3678 error ("Too deep char table");
3681 = (CHARSET_VALID_P (indices
[0])
3682 && ((CHARSET_DIMENSION (indices
[0]) == 1
3683 && char_table_depth
== 1)
3684 || char_table_depth
== 2));
3686 /* Meaningful elements are from 32th to 127th. */
3688 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3693 /* This does the right thing for ordinary vectors. */
3697 to
= XVECTOR (vector
)->size
;
3700 for (i
= from
; i
< to
; i
++)
3702 int this_shadowed
= 0;
3705 if (CHAR_TABLE_P (vector
))
3707 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3710 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3711 && !CHARSET_DEFINED_P (i
- 128))
3715 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3718 definition
= get_keyelt (AREF (vector
, i
), 0);
3720 if (NILP (definition
)) continue;
3722 /* Don't mention suppressed commands. */
3723 if (SYMBOLP (definition
) && partial
)
3727 tem
= Fget (definition
, suppress
);
3729 if (!NILP (tem
)) continue;
3732 /* Set CHARACTER to the character this entry describes, if any.
3733 Also update *INDICES. */
3734 if (CHAR_TABLE_P (vector
))
3736 indices
[char_table_depth
] = i
;
3738 if (char_table_depth
== 0)
3741 indices
[0] = i
- 128;
3743 else if (complete_char
)
3745 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3753 ASET (kludge
, 0, make_number (character
));
3755 /* If this binding is shadowed by some other map, ignore it. */
3756 if (!NILP (shadow
) && complete_char
)
3760 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3771 /* Ignore this definition if it is shadowed by an earlier
3772 one in the same keymap. */
3773 if (!NILP (entire_map
) && complete_char
)
3777 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3779 if (!EQ (tem
, definition
))
3785 if (char_table_depth
== 0)
3790 /* For a sub char-table, show the depth by indentation.
3791 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3792 if (char_table_depth
> 0)
3793 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3795 /* Output the prefix that applies to every entry in this map. */
3796 if (!NILP (elt_prefix
))
3797 insert1 (elt_prefix
);
3799 /* Insert or describe the character this slot is for,
3800 or a description of what it is for. */
3801 if (SUB_CHAR_TABLE_P (vector
))
3804 insert_char (character
);
3807 /* We need an octal representation for this block of
3810 sprintf (work
, "(row %d)", i
);
3811 insert (work
, strlen (work
));
3814 else if (CHAR_TABLE_P (vector
))
3817 insert1 (Fkey_description (kludge
, prefix
));
3820 /* Print the information for this character set. */
3821 insert_string ("<");
3822 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3824 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3833 insert1 (Fkey_description (kludge
, prefix
));
3836 /* If we find a sub char-table within a char-table,
3837 scan it recursively; it defines the details for
3838 a character set or a portion of a character set. */
3839 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3842 describe_vector (definition
, prefix
, args
, elt_describer
,
3843 partial
, shadow
, entire_map
,
3844 indices
, char_table_depth
+ 1, keymap_p
,
3851 /* Find all consecutive characters or rows that have the same
3852 definition. But, for elements of a top level char table, if
3853 they are for charsets, we had better describe one by one even
3854 if they have the same definition. */
3855 if (CHAR_TABLE_P (vector
))
3859 if (char_table_depth
== 0)
3860 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3862 while (i
+ 1 < limit
3863 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3865 && !NILP (Fequal (tem2
, definition
)))
3870 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3872 && !NILP (Fequal (tem2
, definition
)))
3876 /* If we have a range of more than one character,
3877 print where the range reaches to. */
3879 if (i
!= starting_i
)
3883 ASET (kludge
, 0, make_number (i
));
3885 if (!NILP (elt_prefix
))
3886 insert1 (elt_prefix
);
3888 if (CHAR_TABLE_P (vector
))
3890 if (char_table_depth
== 0)
3892 insert1 (Fkey_description (kludge
, prefix
));
3894 else if (complete_char
)
3896 indices
[char_table_depth
] = i
;
3897 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3898 insert_char (character
);
3902 /* We need an octal representation for this block of
3905 sprintf (work
, "(row %d)", i
);
3906 insert (work
, strlen (work
));
3911 insert1 (Fkey_description (kludge
, prefix
));
3915 /* Print a description of the definition of this character.
3916 elt_describer will take care of spacing out far enough
3917 for alignment purposes. */
3918 (*elt_describer
) (definition
, args
);
3923 insert_string (" (binding currently shadowed)");
3928 /* For (sub) char-table, print `defalt' slot at last. */
3929 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3931 insert (" ", char_table_depth
* 2);
3932 insert_string ("<<default>>");
3933 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3939 /* Apropos - finding all symbols whose names match a regexp. */
3940 static Lisp_Object apropos_predicate
;
3941 static Lisp_Object apropos_accumulate
;
3944 apropos_accum (symbol
, string
)
3945 Lisp_Object symbol
, string
;
3947 register Lisp_Object tem
;
3949 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3950 if (!NILP (tem
) && !NILP (apropos_predicate
))
3951 tem
= call1 (apropos_predicate
, symbol
);
3953 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3956 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3957 doc
: /* Show all symbols whose names contain match for REGEXP.
3958 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3959 for each symbol and a symbol is mentioned only if that returns non-nil.
3960 Return list of symbols found. */)
3962 Lisp_Object regexp
, predicate
;
3965 CHECK_STRING (regexp
);
3966 apropos_predicate
= predicate
;
3967 apropos_accumulate
= Qnil
;
3968 map_obarray (Vobarray
, apropos_accum
, regexp
);
3969 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3970 apropos_accumulate
= Qnil
;
3971 apropos_predicate
= Qnil
;
3978 Qkeymap
= intern ("keymap");
3979 staticpro (&Qkeymap
);
3980 staticpro (&apropos_predicate
);
3981 staticpro (&apropos_accumulate
);
3982 apropos_predicate
= Qnil
;
3983 apropos_accumulate
= Qnil
;
3985 /* Now we are ready to set up this property, so we can
3986 create char tables. */
3987 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3989 /* Initialize the keymaps standardly used.
3990 Each one is the value of a Lisp variable, and is also
3991 pointed to by a C variable */
3993 global_map
= Fmake_keymap (Qnil
);
3994 Fset (intern ("global-map"), global_map
);
3996 current_global_map
= global_map
;
3997 staticpro (&global_map
);
3998 staticpro (¤t_global_map
);
4000 meta_map
= Fmake_keymap (Qnil
);
4001 Fset (intern ("esc-map"), meta_map
);
4002 Ffset (intern ("ESC-prefix"), meta_map
);
4004 control_x_map
= Fmake_keymap (Qnil
);
4005 Fset (intern ("ctl-x-map"), control_x_map
);
4006 Ffset (intern ("Control-X-prefix"), control_x_map
);
4009 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
4010 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
4011 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
4012 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
4013 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
4015 staticpro (&exclude_keys
);
4017 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
4018 doc
: /* List of commands given new key bindings recently.
4019 This is used for internal purposes during Emacs startup;
4020 don't alter it yourself. */);
4021 Vdefine_key_rebound_commands
= Qt
;
4023 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
4024 doc
: /* Default keymap to use when reading from the minibuffer. */);
4025 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
4027 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
4028 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
4029 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
4030 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
4032 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
4033 doc
: /* Local keymap for minibuffer input with completion. */);
4034 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
4035 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
4037 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
4038 &Vminibuffer_local_filename_completion_map
,
4039 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
4040 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
4041 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
4042 Vminibuffer_local_completion_map
);
4045 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
4046 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
4047 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
4048 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
4049 Vminibuffer_local_completion_map
);
4051 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
4052 &Vminibuffer_local_must_match_filename_map
,
4053 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
4054 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
4055 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
4056 Vminibuffer_local_must_match_map
);
4058 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
4059 doc
: /* Alist of keymaps to use for minor modes.
4060 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
4061 key sequences and look up bindings iff VARIABLE's value is non-nil.
4062 If two active keymaps bind the same key, the keymap appearing earlier
4063 in the list takes precedence. */);
4064 Vminor_mode_map_alist
= Qnil
;
4066 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
4067 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
4068 This variable is an alist just like `minor-mode-map-alist', and it is
4069 used the same way (and before `minor-mode-map-alist'); however,
4070 it is provided for major modes to bind locally. */);
4071 Vminor_mode_overriding_map_alist
= Qnil
;
4073 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
4074 doc
: /* List of keymap alists to use for emulations modes.
4075 It is intended for modes or packages using multiple minor-mode keymaps.
4076 Each element is a keymap alist just like `minor-mode-map-alist', or a
4077 symbol with a variable binding which is a keymap alist, and it is used
4078 the same way. The "active" keymaps in each alist are used before
4079 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
4080 Vemulation_mode_map_alists
= Qnil
;
4082 staticpro (&Vmouse_events
);
4083 Vmouse_events
= Fcons (intern ("menu-bar"),
4084 Fcons (intern ("tool-bar"),
4085 Fcons (intern ("header-line"),
4086 Fcons (intern ("mode-line"),
4087 Fcons (intern ("mouse-1"),
4088 Fcons (intern ("mouse-2"),
4089 Fcons (intern ("mouse-3"),
4090 Fcons (intern ("mouse-4"),
4091 Fcons (intern ("mouse-5"),
4095 Qsingle_key_description
= intern ("single-key-description");
4096 staticpro (&Qsingle_key_description
);
4098 Qkey_description
= intern ("key-description");
4099 staticpro (&Qkey_description
);
4101 Qkeymapp
= intern ("keymapp");
4102 staticpro (&Qkeymapp
);
4104 Qnon_ascii
= intern ("non-ascii");
4105 staticpro (&Qnon_ascii
);
4107 Qmenu_item
= intern ("menu-item");
4108 staticpro (&Qmenu_item
);
4110 Qremap
= intern ("remap");
4111 staticpro (&Qremap
);
4113 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
4114 staticpro (&command_remapping_vector
);
4116 where_is_cache_keymaps
= Qt
;
4117 where_is_cache
= Qnil
;
4118 staticpro (&where_is_cache
);
4119 staticpro (&where_is_cache_keymaps
);
4121 defsubr (&Skeymapp
);
4122 defsubr (&Skeymap_parent
);
4123 defsubr (&Skeymap_prompt
);
4124 defsubr (&Sset_keymap_parent
);
4125 defsubr (&Smake_keymap
);
4126 defsubr (&Smake_sparse_keymap
);
4127 defsubr (&Smap_keymap
);
4128 defsubr (&Scopy_keymap
);
4129 defsubr (&Scommand_remapping
);
4130 defsubr (&Skey_binding
);
4131 defsubr (&Slocal_key_binding
);
4132 defsubr (&Sglobal_key_binding
);
4133 defsubr (&Sminor_mode_key_binding
);
4134 defsubr (&Sdefine_key
);
4135 defsubr (&Slookup_key
);
4136 defsubr (&Sdefine_prefix_command
);
4137 defsubr (&Suse_global_map
);
4138 defsubr (&Suse_local_map
);
4139 defsubr (&Scurrent_local_map
);
4140 defsubr (&Scurrent_global_map
);
4141 defsubr (&Scurrent_minor_mode_maps
);
4142 defsubr (&Scurrent_active_maps
);
4143 defsubr (&Saccessible_keymaps
);
4144 defsubr (&Skey_description
);
4145 defsubr (&Sdescribe_vector
);
4146 defsubr (&Ssingle_key_description
);
4147 defsubr (&Stext_char_description
);
4148 defsubr (&Swhere_is_internal
);
4149 defsubr (&Sdescribe_buffer_bindings
);
4150 defsubr (&Sapropos_internal
);
4156 initial_define_key (global_map
, 033, "ESC-prefix");
4157 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
4160 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
4161 (do not change this comment) */