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,
1121 or an extended menu item definition. (See info node `Extended Menu Items'.)
1123 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1124 binding is altered. If there is no binding for KEY, the new pair
1125 binding KEY to DEF is added at the front of KEYMAP. */)
1132 register Lisp_Object c
;
1133 register Lisp_Object cmd
;
1137 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1139 GCPRO3 (keymap
, key
, def
);
1140 keymap
= get_keymap (keymap
, 1, 1);
1142 CHECK_VECTOR_OR_STRING (key
);
1144 length
= XFASTINT (Flength (key
));
1146 RETURN_UNGCPRO (Qnil
);
1148 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1149 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1151 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1153 if (VECTORP (def
) && ASIZE (def
) > 0 && CONSP (AREF (def
, 0)))
1154 { /* DEF is apparently an XEmacs-style keyboard macro. */
1155 Lisp_Object tmp
= Fmake_vector (make_number (ASIZE (def
)), Qnil
);
1156 int i
= ASIZE (def
);
1159 Lisp_Object c
= AREF (def
, i
);
1160 if (CONSP (c
) && lucid_event_type_list_p (c
))
1161 c
= Fevent_convert_list (c
);
1170 c
= Faref (key
, make_number (idx
));
1172 if (CONSP (c
) && lucid_event_type_list_p (c
))
1173 c
= Fevent_convert_list (c
);
1176 silly_event_symbol_error (c
);
1179 && (XINT (c
) & meta_bit
)
1182 c
= meta_prefix_char
;
1188 XSETINT (c
, XINT (c
) & ~meta_bit
);
1194 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1195 error ("Key sequence contains invalid event");
1198 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1200 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1202 /* If this key is undefined, make it a prefix. */
1204 cmd
= define_as_prefix (keymap
, c
);
1206 keymap
= get_keymap (cmd
, 0, 1);
1207 if (!CONSP (keymap
))
1208 /* We must use Fkey_description rather than just passing key to
1209 error; key might be a vector, not a string. */
1210 error ("Key sequence %s starts with non-prefix key %s",
1211 SDATA (Fkey_description (key
, Qnil
)),
1212 SDATA (Fkey_description (Fsubstring (key
, make_number (0),
1218 /* This function may GC (it calls Fkey_binding). */
1220 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 2, 0,
1221 doc
: /* Return the remapping for command COMMAND in current keymaps.
1222 Returns nil if COMMAND is not remapped (or not a symbol).
1224 If the optional argument POSITION is non-nil, it specifies a mouse
1225 position as returned by `event-start' and `event-end', and the
1226 remapping occurs in the keymaps associated with it. It can also be a
1227 number or marker, in which case the keymap properties at the specified
1228 buffer position instead of point are used. */)
1230 Lisp_Object command
, position
;
1232 if (!SYMBOLP (command
))
1235 ASET (command_remapping_vector
, 1, command
);
1236 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
, position
);
1239 /* Value is number if KEY is too long; nil if valid but has no definition. */
1240 /* GC is possible in this function if it autoloads a keymap. */
1242 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1243 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1244 A value of nil means undefined. See doc of `define-key'
1245 for kinds of definitions.
1247 A number as value means KEY is "too long";
1248 that is, characters or symbols in it except for the last one
1249 fail to be a valid sequence of prefix characters in KEYMAP.
1250 The number is how many characters at the front of KEY
1251 it takes to reach a non-prefix key.
1253 Normally, `lookup-key' ignores bindings for t, which act as default
1254 bindings, used when nothing else in the keymap applies; this makes it
1255 usable as a general function for probing keymaps. However, if the
1256 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1257 recognize the default bindings, just as `read-key-sequence' does. */)
1258 (keymap
, key
, accept_default
)
1261 Lisp_Object accept_default
;
1264 register Lisp_Object cmd
;
1265 register Lisp_Object c
;
1267 int t_ok
= !NILP (accept_default
);
1268 struct gcpro gcpro1
, gcpro2
;
1270 GCPRO2 (keymap
, key
);
1271 keymap
= get_keymap (keymap
, 1, 1);
1273 CHECK_VECTOR_OR_STRING (key
);
1275 length
= XFASTINT (Flength (key
));
1277 RETURN_UNGCPRO (keymap
);
1282 c
= Faref (key
, make_number (idx
++));
1284 if (CONSP (c
) && lucid_event_type_list_p (c
))
1285 c
= Fevent_convert_list (c
);
1287 /* Turn the 8th bit of string chars into a meta modifier. */
1288 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1289 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1291 /* Allow string since binding for `menu-bar-select-buffer'
1292 includes the buffer name in the key sequence. */
1293 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1294 error ("Key sequence contains invalid event");
1296 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1298 RETURN_UNGCPRO (cmd
);
1300 keymap
= get_keymap (cmd
, 0, 1);
1301 if (!CONSP (keymap
))
1302 RETURN_UNGCPRO (make_number (idx
));
1308 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1309 Assume that currently it does not define C at all.
1310 Return the keymap. */
1313 define_as_prefix (keymap
, c
)
1314 Lisp_Object keymap
, c
;
1318 cmd
= Fmake_sparse_keymap (Qnil
);
1319 /* If this key is defined as a prefix in an inherited keymap,
1320 make it a prefix in this map, and make its definition
1321 inherit the other prefix definition. */
1322 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1323 store_in_keymap (keymap
, c
, cmd
);
1328 /* Append a key to the end of a key sequence. We always make a vector. */
1331 append_key (key_sequence
, key
)
1332 Lisp_Object key_sequence
, key
;
1334 Lisp_Object args
[2];
1336 args
[0] = key_sequence
;
1338 args
[1] = Fcons (key
, Qnil
);
1339 return Fvconcat (2, args
);
1342 /* Given a event type C which is a symbol,
1343 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1346 silly_event_symbol_error (c
)
1349 Lisp_Object parsed
, base
, name
, assoc
;
1352 parsed
= parse_modifiers (c
);
1353 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1354 base
= XCAR (parsed
);
1355 name
= Fsymbol_name (base
);
1356 /* This alist includes elements such as ("RET" . "\\r"). */
1357 assoc
= Fassoc (name
, exclude_keys
);
1361 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1363 Lisp_Object keystring
;
1364 if (modifiers
& alt_modifier
)
1365 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1366 if (modifiers
& ctrl_modifier
)
1367 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1368 if (modifiers
& hyper_modifier
)
1369 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1370 if (modifiers
& meta_modifier
)
1371 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1372 if (modifiers
& shift_modifier
)
1373 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1374 if (modifiers
& super_modifier
)
1375 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1378 c
= reorder_modifiers (c
);
1379 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1381 error ((modifiers
& ~meta_modifier
1382 ? "To bind the key %s, use [?%s], not [%s]"
1383 : "To bind the key %s, use \"%s\", not [%s]"),
1384 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1385 SDATA (SYMBOL_NAME (c
)));
1389 /* Global, local, and minor mode keymap stuff. */
1391 /* We can't put these variables inside current_minor_maps, since under
1392 some systems, static gets macro-defined to be the empty string.
1394 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1395 static int cmm_size
= 0;
1397 /* Store a pointer to an array of the keymaps of the currently active
1398 minor modes in *buf, and return the number of maps it contains.
1400 This function always returns a pointer to the same buffer, and may
1401 free or reallocate it, so if you want to keep it for a long time or
1402 hand it out to lisp code, copy it. This procedure will be called
1403 for every key sequence read, so the nice lispy approach (return a
1404 new assoclist, list, what have you) for each invocation would
1405 result in a lot of consing over time.
1407 If we used xrealloc/xmalloc and ran out of memory, they would throw
1408 back to the command loop, which would try to read a key sequence,
1409 which would call this function again, resulting in an infinite
1410 loop. Instead, we'll use realloc/malloc and silently truncate the
1411 list, let the key sequence be read, and hope some other piece of
1412 code signals the error. */
1414 current_minor_maps (modeptr
, mapptr
)
1415 Lisp_Object
**modeptr
, **mapptr
;
1418 int list_number
= 0;
1419 Lisp_Object alist
, assoc
, var
, val
;
1420 Lisp_Object emulation_alists
;
1421 Lisp_Object lists
[2];
1423 emulation_alists
= Vemulation_mode_map_alists
;
1424 lists
[0] = Vminor_mode_overriding_map_alist
;
1425 lists
[1] = Vminor_mode_map_alist
;
1427 for (list_number
= 0; list_number
< 2; list_number
++)
1429 if (CONSP (emulation_alists
))
1431 alist
= XCAR (emulation_alists
);
1432 emulation_alists
= XCDR (emulation_alists
);
1433 if (SYMBOLP (alist
))
1434 alist
= find_symbol_value (alist
);
1438 alist
= lists
[list_number
];
1440 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1441 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1442 && (var
= XCAR (assoc
), SYMBOLP (var
))
1443 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1448 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1449 and also an entry in Vminor_mode_map_alist,
1450 ignore the latter. */
1451 if (list_number
== 1)
1453 val
= assq_no_quit (var
, lists
[0]);
1460 int newsize
, allocsize
;
1461 Lisp_Object
*newmodes
, *newmaps
;
1463 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1464 allocsize
= newsize
* sizeof *newmodes
;
1466 /* Use malloc here. See the comment above this function.
1467 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1469 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1474 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1477 cmm_modes
= newmodes
;
1480 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1485 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1492 if (newmodes
== NULL
|| newmaps
== NULL
)
1497 /* Get the keymap definition--or nil if it is not defined. */
1498 temp
= Findirect_function (XCDR (assoc
), Qt
);
1502 cmm_maps
[i
] = temp
;
1508 if (modeptr
) *modeptr
= cmm_modes
;
1509 if (mapptr
) *mapptr
= cmm_maps
;
1513 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1515 doc
: /* Return a list of the currently active keymaps.
1516 OLP if non-nil indicates that we should obey `overriding-local-map' and
1517 `overriding-terminal-local-map'. */)
1521 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1525 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1526 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1527 /* The doc said that overriding-terminal-local-map should
1528 override overriding-local-map. The code used them both,
1529 but it seems clearer to use just one. rms, jan 2005. */
1530 else if (!NILP (Voverriding_local_map
))
1531 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1533 if (NILP (XCDR (keymaps
)))
1539 /* This usually returns the buffer's local map,
1540 but that can be overridden by a `local-map' property. */
1541 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1543 keymaps
= Fcons (local
, keymaps
);
1545 /* Now put all the minor mode keymaps on the list. */
1546 nmaps
= current_minor_maps (0, &maps
);
1548 for (i
= --nmaps
; i
>= 0; i
--)
1549 if (!NILP (maps
[i
]))
1550 keymaps
= Fcons (maps
[i
], keymaps
);
1552 /* This returns nil unless there is a `keymap' property. */
1553 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1555 keymaps
= Fcons (local
, keymaps
);
1561 /* GC is possible in this function if it autoloads a keymap. */
1563 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 4, 0,
1564 doc
: /* Return the binding for command KEY in current keymaps.
1565 KEY is a string or vector, a sequence of keystrokes.
1566 The binding is probably a symbol with a function definition.
1568 Normally, `key-binding' ignores bindings for t, which act as default
1569 bindings, used when nothing else in the keymap applies; this makes it
1570 usable as a general function for probing keymaps. However, if the
1571 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1572 recognize the default bindings, just as `read-key-sequence' does.
1574 Like the normal command loop, `key-binding' will remap the command
1575 resulting from looking up KEY by looking up the command in the
1576 current keymaps. However, if the optional third argument NO-REMAP
1577 is non-nil, `key-binding' returns the unmapped command.
1579 If KEY is a key sequence initiated with the mouse, the used keymaps
1580 will depend on the clicked mouse position with regard to the buffer
1581 and possible local keymaps on strings.
1583 If the optional argument POSITION is non-nil, it specifies a mouse
1584 position as returned by `event-start' and `event-end', and the lookup
1585 occurs in the keymaps associated with it instead of KEY. It can also
1586 be a number or marker, in which case the keymap properties at the
1587 specified buffer position instead of point are used.
1589 (key
, accept_default
, no_remap
, position
)
1590 Lisp_Object key
, accept_default
, no_remap
, position
;
1592 Lisp_Object
*maps
, value
;
1594 struct gcpro gcpro1
, gcpro2
;
1595 int count
= SPECPDL_INDEX ();
1597 GCPRO2 (key
, position
);
1599 if (NILP (position
) && VECTORP (key
))
1602 /* mouse events may have a symbolic prefix indicating the
1603 scrollbar or mode line */
1604 = AREF (key
, SYMBOLP (AREF (key
, 0)) && ASIZE (key
) > 1 ? 1 : 0);
1606 /* We are not interested in locations without event data */
1608 if (EVENT_HAS_PARAMETERS (event
))
1610 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (event
));
1611 if (CONSP (XCDR (event
)) && EQ (kind
, Qmouse_click
))
1612 position
= EVENT_START (event
);
1616 /* Key sequences beginning with mouse clicks
1617 are read using the keymaps of the buffer clicked on, not
1618 the current buffer. So we may have to switch the buffer
1621 if (CONSP (position
))
1625 window
= POSN_WINDOW (position
);
1627 if (WINDOWP (window
)
1628 && BUFFERP (XWINDOW (window
)->buffer
)
1629 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
1631 /* Arrange to go back to the original buffer once we're done
1632 processing the key sequence. We don't use
1633 save_excursion_{save,restore} here, in analogy to
1634 `read-key-sequence' to avoid saving point. Maybe this
1635 would not be a problem here, but it is easier to keep
1639 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
1641 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
1645 if (! NILP (current_kboard
->Voverriding_terminal_local_map
))
1647 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1648 key
, accept_default
);
1649 if (! NILP (value
) && !INTEGERP (value
))
1652 else if (! NILP (Voverriding_local_map
))
1654 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1655 if (! NILP (value
) && !INTEGERP (value
))
1660 Lisp_Object keymap
, local_map
;
1663 pt
= INTEGERP (position
) ? XINT (position
)
1664 : MARKERP (position
) ? marker_position (position
)
1667 local_map
= get_local_map (pt
, current_buffer
, Qlocal_map
);
1668 keymap
= get_local_map (pt
, current_buffer
, Qkeymap
);
1670 if (CONSP (position
))
1674 /* For a mouse click, get the local text-property keymap
1675 of the place clicked on, rather than point. */
1677 if (POSN_INBUFFER_P (position
))
1681 pos
= POSN_BUFFER_POSN (position
);
1683 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
1685 local_map
= get_local_map (XINT (pos
),
1686 current_buffer
, Qlocal_map
);
1688 keymap
= get_local_map (XINT (pos
),
1689 current_buffer
, Qkeymap
);
1693 /* If on a mode line string with a local keymap,
1694 or for a click on a string, i.e. overlay string or a
1695 string displayed via the `display' property,
1696 consider `local-map' and `keymap' properties of
1699 if (string
= POSN_STRING (position
),
1700 (CONSP (string
) && STRINGP (XCAR (string
))))
1702 Lisp_Object pos
, map
;
1704 pos
= XCDR (string
);
1705 string
= XCAR (string
);
1708 && XINT (pos
) < SCHARS (string
))
1710 map
= Fget_text_property (pos
, Qlocal_map
, string
);
1714 map
= Fget_text_property (pos
, Qkeymap
, string
);
1722 if (! NILP (keymap
))
1724 value
= Flookup_key (keymap
, key
, accept_default
);
1725 if (! NILP (value
) && !INTEGERP (value
))
1729 nmaps
= current_minor_maps (0, &maps
);
1730 /* Note that all these maps are GCPRO'd
1731 in the places where we found them. */
1733 for (i
= 0; i
< nmaps
; i
++)
1734 if (! NILP (maps
[i
]))
1736 value
= Flookup_key (maps
[i
], key
, accept_default
);
1737 if (! NILP (value
) && !INTEGERP (value
))
1741 if (! NILP (local_map
))
1743 value
= Flookup_key (local_map
, key
, accept_default
);
1744 if (! NILP (value
) && !INTEGERP (value
))
1749 value
= Flookup_key (current_global_map
, key
, accept_default
);
1752 unbind_to (count
, Qnil
);
1755 if (NILP (value
) || INTEGERP (value
))
1758 /* If the result of the ordinary keymap lookup is an interactive
1759 command, look for a key binding (ie. remapping) for that command. */
1761 if (NILP (no_remap
) && SYMBOLP (value
))
1764 if (value1
= Fcommand_remapping (value
, position
), !NILP (value1
))
1771 /* GC is possible in this function if it autoloads a keymap. */
1773 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1774 doc
: /* Return the binding for command KEYS in current local keymap only.
1775 KEYS is a string or vector, a sequence of keystrokes.
1776 The binding is probably a symbol with a function definition.
1778 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1779 bindings; see the description of `lookup-key' for more details about this. */)
1780 (keys
, accept_default
)
1781 Lisp_Object keys
, accept_default
;
1783 register Lisp_Object map
;
1784 map
= current_buffer
->keymap
;
1787 return Flookup_key (map
, keys
, accept_default
);
1790 /* GC is possible in this function if it autoloads a keymap. */
1792 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1793 doc
: /* Return the binding for command KEYS in current global keymap only.
1794 KEYS is a string or vector, a sequence of keystrokes.
1795 The binding is probably a symbol with a function definition.
1796 This function's return values are the same as those of `lookup-key'
1799 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1800 bindings; see the description of `lookup-key' for more details about this. */)
1801 (keys
, accept_default
)
1802 Lisp_Object keys
, accept_default
;
1804 return Flookup_key (current_global_map
, keys
, accept_default
);
1807 /* GC is possible in this function if it autoloads a keymap. */
1809 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1810 doc
: /* Find the visible minor mode bindings of KEY.
1811 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1812 the symbol which names the minor mode binding KEY, and BINDING is
1813 KEY's definition in that mode. In particular, if KEY has no
1814 minor-mode bindings, return nil. If the first binding is a
1815 non-prefix, all subsequent bindings will be omitted, since they would
1816 be ignored. Similarly, the list doesn't include non-prefix bindings
1817 that come after prefix bindings.
1819 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1820 bindings; see the description of `lookup-key' for more details about this. */)
1821 (key
, accept_default
)
1822 Lisp_Object key
, accept_default
;
1824 Lisp_Object
*modes
, *maps
;
1826 Lisp_Object binding
;
1828 struct gcpro gcpro1
, gcpro2
;
1830 nmaps
= current_minor_maps (&modes
, &maps
);
1831 /* Note that all these maps are GCPRO'd
1832 in the places where we found them. */
1835 GCPRO2 (key
, binding
);
1837 for (i
= j
= 0; i
< nmaps
; i
++)
1839 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1840 && !INTEGERP (binding
))
1842 if (KEYMAPP (binding
))
1843 maps
[j
++] = Fcons (modes
[i
], binding
);
1845 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1849 return Flist (j
, maps
);
1852 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1853 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1854 A new sparse keymap is stored as COMMAND's function definition and its value.
1855 If a second optional argument MAPVAR is given, the map is stored as
1856 its value instead of as COMMAND's value; but COMMAND is still defined
1858 The third optional argument NAME, if given, supplies a menu name
1859 string for the map. This is required to use the keymap as a menu.
1860 This function returns COMMAND. */)
1861 (command
, mapvar
, name
)
1862 Lisp_Object command
, mapvar
, name
;
1865 map
= Fmake_sparse_keymap (name
);
1866 Ffset (command
, map
);
1870 Fset (command
, map
);
1874 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1875 doc
: /* Select KEYMAP as the global keymap. */)
1879 keymap
= get_keymap (keymap
, 1, 1);
1880 current_global_map
= keymap
;
1885 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1886 doc
: /* Select KEYMAP as the local keymap.
1887 If KEYMAP is nil, that means no local keymap. */)
1892 keymap
= get_keymap (keymap
, 1, 1);
1894 current_buffer
->keymap
= keymap
;
1899 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1900 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1903 return current_buffer
->keymap
;
1906 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1907 doc
: /* Return the current global keymap. */)
1910 return current_global_map
;
1913 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1914 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1918 int nmaps
= current_minor_maps (0, &maps
);
1920 return Flist (nmaps
, maps
);
1923 /* Help functions for describing and documenting keymaps. */
1927 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1928 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1929 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1933 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1937 /* Look for and break cycles. */
1938 while (!NILP (tem
= Frassq (cmd
, maps
)))
1940 Lisp_Object prefix
= XCAR (tem
);
1941 int lim
= XINT (Flength (XCAR (tem
)));
1942 if (lim
<= XINT (Flength (thisseq
)))
1943 { /* This keymap was already seen with a smaller prefix. */
1945 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1946 Faref (thisseq
, make_number (i
))))
1949 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1952 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1953 but maybe `cmd' occurs again further down in `maps', so keep
1955 maps
= XCDR (Fmemq (tem
, maps
));
1958 /* If the last key in thisseq is meta-prefix-char,
1959 turn it into a meta-ized keystroke. We know
1960 that the event we're about to append is an
1961 ascii keystroke since we're processing a
1965 int meta_bit
= meta_modifier
;
1966 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1967 tem
= Fcopy_sequence (thisseq
);
1969 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1971 /* This new sequence is the same length as
1972 thisseq, so stick it in the list right
1975 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1979 tem
= append_key (thisseq
, key
);
1980 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1985 accessible_keymaps_char_table (args
, index
, cmd
)
1986 Lisp_Object args
, index
, cmd
;
1988 accessible_keymaps_1 (index
, cmd
,
1992 XINT (XCDR (XCAR (args
))));
1995 /* This function cannot GC. */
1997 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1999 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
2000 Returns a list of elements of the form (KEYS . MAP), where the sequence
2001 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
2002 so that the KEYS increase in length. The first element is ([] . KEYMAP).
2003 An optional argument PREFIX, if non-nil, should be a key sequence;
2004 then the value includes only maps for prefixes that start with PREFIX. */)
2006 Lisp_Object keymap
, prefix
;
2008 Lisp_Object maps
, tail
;
2011 /* no need for gcpro because we don't autoload any keymaps. */
2014 prefixlen
= XINT (Flength (prefix
));
2018 /* If a prefix was specified, start with the keymap (if any) for
2019 that prefix, so we don't waste time considering other prefixes. */
2021 tem
= Flookup_key (keymap
, prefix
, Qt
);
2022 /* Flookup_key may give us nil, or a number,
2023 if the prefix is not defined in this particular map.
2024 It might even give us a list that isn't a keymap. */
2025 tem
= get_keymap (tem
, 0, 0);
2028 /* Convert PREFIX to a vector now, so that later on
2029 we don't have to deal with the possibility of a string. */
2030 if (STRINGP (prefix
))
2035 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
2036 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
2040 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
2041 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2042 c
^= 0200 | meta_modifier
;
2043 ASET (copy
, i_before
, make_number (c
));
2047 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
2053 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
2054 get_keymap (keymap
, 1, 0)),
2057 /* For each map in the list maps,
2058 look at any other maps it points to,
2059 and stick them at the end if they are not already in the list.
2061 This is a breadth-first traversal, where tail is the queue of
2062 nodes, and maps accumulates a list of all nodes visited. */
2064 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
2066 register Lisp_Object thisseq
, thismap
;
2068 /* Does the current sequence end in the meta-prefix-char? */
2071 thisseq
= Fcar (Fcar (tail
));
2072 thismap
= Fcdr (Fcar (tail
));
2073 last
= make_number (XINT (Flength (thisseq
)) - 1);
2074 is_metized
= (XINT (last
) >= 0
2075 /* Don't metize the last char of PREFIX. */
2076 && XINT (last
) >= prefixlen
2077 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
2079 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
2083 elt
= XCAR (thismap
);
2087 if (CHAR_TABLE_P (elt
))
2089 Lisp_Object indices
[3];
2091 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
2092 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
2093 Fcons (tail
, thisseq
)),
2096 else if (VECTORP (elt
))
2100 /* Vector keymap. Scan all the elements. */
2101 for (i
= 0; i
< ASIZE (elt
); i
++)
2102 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
2103 maps
, tail
, thisseq
, is_metized
);
2106 else if (CONSP (elt
))
2107 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
2108 maps
, tail
, thisseq
,
2109 is_metized
&& INTEGERP (XCAR (elt
)));
2117 Lisp_Object Qsingle_key_description
, Qkey_description
;
2119 /* This function cannot GC. */
2121 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2122 doc
: /* Return a pretty description of key-sequence KEYS.
2123 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2124 Control characters turn into "C-foo" sequences, meta into "M-foo",
2125 spaces are put between sequence elements, etc. */)
2127 Lisp_Object keys
, prefix
;
2132 int size
= XINT (Flength (keys
));
2134 Lisp_Object sep
= build_string (" ");
2139 size
+= XINT (Flength (prefix
));
2141 /* This has one extra element at the end that we don't pass to Fconcat. */
2142 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2144 /* In effect, this computes
2145 (mapconcat 'single-key-description keys " ")
2146 but we shouldn't use mapconcat because it can do GC. */
2150 list
= prefix
, prefix
= Qnil
;
2151 else if (!NILP (keys
))
2152 list
= keys
, keys
= Qnil
;
2157 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2161 return empty_string
;
2162 return Fconcat (len
- 1, args
);
2166 size
= SCHARS (list
);
2167 else if (VECTORP (list
))
2168 size
= XVECTOR (list
)->size
;
2169 else if (CONSP (list
))
2170 size
= XINT (Flength (list
));
2172 wrong_type_argument (Qarrayp
, list
);
2181 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2182 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2183 c
^= 0200 | meta_modifier
;
2184 XSETFASTINT (key
, c
);
2186 else if (VECTORP (list
))
2188 key
= AREF (list
, i
++);
2200 || EQ (key
, meta_prefix_char
)
2201 || (XINT (key
) & meta_modifier
))
2203 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2205 if (EQ (key
, meta_prefix_char
))
2209 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2212 else if (EQ (key
, meta_prefix_char
))
2217 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2225 push_key_description (c
, p
, force_multibyte
)
2226 register unsigned int c
;
2228 int force_multibyte
;
2233 /* Clear all the meaningless bits above the meta bit. */
2234 c
&= meta_modifier
| ~ - meta_modifier
;
2235 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2236 | meta_modifier
| shift_modifier
| super_modifier
);
2238 valid_p
= SINGLE_BYTE_CHAR_P (c2
) || char_valid_p (c2
, 0);
2241 /* KEY_DESCRIPTION_SIZE is large enough for this. */
2242 p
+= sprintf (p
, "[%d]", c
);
2246 if (c
& alt_modifier
)
2252 if ((c
& ctrl_modifier
) != 0
2253 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2257 c
&= ~ctrl_modifier
;
2259 if (c
& hyper_modifier
)
2263 c
-= hyper_modifier
;
2265 if (c
& meta_modifier
)
2271 if (c
& shift_modifier
)
2275 c
-= shift_modifier
;
2277 if (c
& super_modifier
)
2281 c
-= super_modifier
;
2297 else if (c
== Ctl ('M'))
2305 /* `C-' already added above. */
2306 if (c
> 0 && c
<= Ctl ('Z'))
2325 || (NILP (current_buffer
->enable_multibyte_characters
)
2326 && SINGLE_BYTE_CHAR_P (c
)
2327 && !force_multibyte
))
2333 if (force_multibyte
)
2335 if (SINGLE_BYTE_CHAR_P (c
))
2336 c
= unibyte_char_to_multibyte (c
);
2337 p
+= CHAR_STRING (c
, p
);
2339 else if (NILP (current_buffer
->enable_multibyte_characters
))
2343 /* The biggest character code uses 19 bits. */
2344 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2346 if (c
>= (1 << bit_offset
))
2347 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2351 p
+= CHAR_STRING (c
, p
);
2357 /* This function cannot GC. */
2359 DEFUN ("single-key-description", Fsingle_key_description
,
2360 Ssingle_key_description
, 1, 2, 0,
2361 doc
: /* Return a pretty description of command character KEY.
2362 Control characters turn into C-whatever, etc.
2363 Optional argument NO-ANGLES non-nil means don't put angle brackets
2364 around function keys and event symbols. */)
2366 Lisp_Object key
, no_angles
;
2368 if (CONSP (key
) && lucid_event_type_list_p (key
))
2369 key
= Fevent_convert_list (key
);
2371 key
= EVENT_HEAD (key
);
2373 if (INTEGERP (key
)) /* Normal character */
2375 unsigned int charset
, c1
, c2
;
2376 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2378 if (SINGLE_BYTE_CHAR_P (without_bits
))
2381 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2383 if (! CHAR_VALID_P (without_bits
, 1))
2387 sprintf (buf
, "Invalid char code %d", XINT (key
));
2388 return build_string (buf
);
2391 && ((c1
== 0 && c2
== -1) || c2
== 0))
2393 /* Handle a generic character. */
2397 name
= CHARSET_TABLE_INFO (charset
, CHARSET_SHORT_NAME_IDX
);
2398 CHECK_STRING (name
);
2400 /* Only a charset is specified. */
2401 sprintf (buf
, "Generic char %d: all of ", without_bits
);
2403 /* 1st code-point of 2-dimensional charset is specified. */
2404 sprintf (buf
, "Generic char %d: row %d of ", without_bits
, c1
);
2405 return concat2 (build_string (buf
), name
);
2409 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2413 end
= push_key_description (XUINT (key
), tem
, 1);
2415 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2416 if (nchars
== nbytes
)
2419 string
= build_string (tem
);
2422 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2426 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2428 if (NILP (no_angles
))
2431 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2432 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2433 return build_string (buffer
);
2436 return Fsymbol_name (key
);
2438 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2439 return Fcopy_sequence (key
);
2441 error ("KEY must be an integer, cons, symbol, or string");
2446 push_text_char_description (c
, p
)
2447 register unsigned int c
;
2459 *p
++ = c
+ 64; /* 'A' - 1 */
2471 /* This function cannot GC. */
2473 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2474 doc
: /* Return a pretty description of file-character CHARACTER.
2475 Control characters turn into "^char", etc. This differs from
2476 `single-key-description' which turns them into "C-char".
2477 Also, this function recognizes the 2**7 bit as the Meta character,
2478 whereas `single-key-description' uses the 2**27 bit for Meta.
2479 See Info node `(elisp)Describing Characters' for examples. */)
2481 Lisp_Object character
;
2483 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2484 unsigned char str
[6];
2487 CHECK_NUMBER (character
);
2489 c
= XINT (character
);
2490 if (!SINGLE_BYTE_CHAR_P (c
))
2492 int len
= CHAR_STRING (c
, str
);
2494 return make_multibyte_string (str
, 1, len
);
2497 *push_text_char_description (c
& 0377, str
) = 0;
2499 return build_string (str
);
2502 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2505 ascii_sequence_p (seq
)
2509 int len
= XINT (Flength (seq
));
2511 for (i
= 0; i
< len
; i
++)
2513 Lisp_Object ii
, elt
;
2515 XSETFASTINT (ii
, i
);
2516 elt
= Faref (seq
, ii
);
2519 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2527 /* where-is - finding a command in a set of keymaps. */
2529 static Lisp_Object
where_is_internal ();
2530 static Lisp_Object
where_is_internal_1 ();
2531 static void where_is_internal_2 ();
2533 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2534 Returns the first non-nil binding found in any of those maps. */
2537 shadow_lookup (shadow
, key
, flag
)
2538 Lisp_Object shadow
, key
, flag
;
2540 Lisp_Object tail
, value
;
2542 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2544 value
= Flookup_key (XCAR (tail
), key
, flag
);
2545 if (NATNUMP (value
))
2547 value
= Flookup_key (XCAR (tail
),
2548 Fsubstring (key
, make_number (0), value
), flag
);
2552 else if (!NILP (value
))
2558 static Lisp_Object Vmouse_events
;
2560 /* This function can GC if Flookup_key autoloads any keymaps. */
2563 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2564 Lisp_Object definition
, keymaps
;
2565 Lisp_Object firstonly
, noindirect
, no_remap
;
2567 Lisp_Object maps
= Qnil
;
2568 Lisp_Object found
, sequences
;
2569 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2570 /* 1 means ignore all menu bindings entirely. */
2571 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2573 /* If this command is remapped, then it has no key bindings
2575 if (NILP (no_remap
) && SYMBOLP (definition
))
2578 if (tem
= Fcommand_remapping (definition
, Qnil
), !NILP (tem
))
2583 while (CONSP (found
))
2587 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2588 found
= XCDR (found
);
2591 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2595 for (; !NILP (maps
); maps
= Fcdr (maps
))
2597 /* Key sequence to reach map, and the map that it reaches */
2598 register Lisp_Object
this, map
, tem
;
2600 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2601 [M-CHAR] sequences, check if last character of the sequence
2602 is the meta-prefix char. */
2606 this = Fcar (Fcar (maps
));
2607 map
= Fcdr (Fcar (maps
));
2608 last
= make_number (XINT (Flength (this)) - 1);
2609 last_is_meta
= (XINT (last
) >= 0
2610 && EQ (Faref (this, last
), meta_prefix_char
));
2612 /* if (nomenus && !ascii_sequence_p (this)) */
2613 if (nomenus
&& XINT (last
) >= 0
2614 && SYMBOLP (tem
= Faref (this, make_number (0)))
2615 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2616 /* If no menu entries should be returned, skip over the
2617 keymaps bound to `menu-bar' and `tool-bar' and other
2618 non-ascii prefixes like `C-down-mouse-2'. */
2625 /* Because the code we want to run on each binding is rather
2626 large, we don't want to have two separate loop bodies for
2627 sparse keymap bindings and tables; we want to iterate one
2628 loop body over both keymap and vector bindings.
2630 For this reason, if Fcar (map) is a vector, we don't
2631 advance map to the next element until i indicates that we
2632 have finished off the vector. */
2633 Lisp_Object elt
, key
, binding
;
2641 /* Set key and binding to the current key and binding, and
2642 advance map and i to the next binding. */
2645 Lisp_Object sequence
;
2647 /* In a vector, look at each element. */
2648 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2650 binding
= AREF (elt
, i
);
2651 XSETFASTINT (key
, i
);
2652 sequence
= where_is_internal_1 (binding
, key
, definition
,
2654 last
, nomenus
, last_is_meta
);
2655 if (!NILP (sequence
))
2656 sequences
= Fcons (sequence
, sequences
);
2659 else if (CHAR_TABLE_P (elt
))
2661 Lisp_Object indices
[3];
2664 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2665 Qnil
), /* Result accumulator. */
2666 Fcons (Fcons (this, last
),
2667 Fcons (make_number (nomenus
),
2668 make_number (last_is_meta
))));
2669 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2671 sequences
= XCDR (XCAR (args
));
2673 else if (CONSP (elt
))
2675 Lisp_Object sequence
;
2678 binding
= XCDR (elt
);
2680 sequence
= where_is_internal_1 (binding
, key
, definition
,
2682 last
, nomenus
, last_is_meta
);
2683 if (!NILP (sequence
))
2684 sequences
= Fcons (sequence
, sequences
);
2688 while (!NILP (sequences
))
2690 Lisp_Object sequence
, remapped
, function
;
2692 sequence
= XCAR (sequences
);
2693 sequences
= XCDR (sequences
);
2695 /* If the current sequence is a command remapping with
2696 format [remap COMMAND], find the key sequences
2697 which run COMMAND, and use those sequences instead. */
2700 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2701 && EQ (AREF (sequence
, 0), Qremap
)
2702 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2704 Lisp_Object remapped1
;
2706 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2707 if (CONSP (remapped1
))
2709 /* Verify that this key binding actually maps to the
2710 remapped command (see below). */
2711 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2713 sequence
= XCAR (remapped1
);
2714 remapped
= XCDR (remapped1
);
2715 goto record_sequence
;
2719 /* Verify that this key binding is not shadowed by another
2720 binding for the same key, before we say it exists.
2722 Mechanism: look for local definition of this key and if
2723 it is defined and does not match what we found then
2726 Either nil or number as value from Flookup_key
2728 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2732 /* Don't annoy user with strings from a menu such as
2733 Select Paste. Change them all to "(any string)",
2734 so that there seems to be only one menu item
2736 if (! NILP (sequence
))
2739 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2741 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2742 build_string ("(any string)"));
2745 /* It is a true unshadowed match. Record it, unless it's already
2746 been seen (as could happen when inheriting keymaps). */
2747 if (NILP (Fmember (sequence
, found
)))
2748 found
= Fcons (sequence
, found
);
2750 /* If firstonly is Qnon_ascii, then we can return the first
2751 binding we find. If firstonly is not Qnon_ascii but not
2752 nil, then we should return the first ascii-only binding
2754 if (EQ (firstonly
, Qnon_ascii
))
2755 RETURN_UNGCPRO (sequence
);
2756 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2757 RETURN_UNGCPRO (sequence
);
2759 if (CONSP (remapped
))
2761 sequence
= XCAR (remapped
);
2762 remapped
= XCDR (remapped
);
2763 goto record_sequence
;
2771 found
= Fnreverse (found
);
2773 /* firstonly may have been t, but we may have gone all the way through
2774 the keymaps without finding an all-ASCII key sequence. So just
2775 return the best we could find. */
2776 if (!NILP (firstonly
))
2777 return Fcar (found
);
2782 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2783 doc
: /* Return list of keys that invoke DEFINITION.
2784 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2785 If KEYMAP is nil, search all the currently active keymaps.
2786 If KEYMAP is a list of keymaps, search only those keymaps.
2788 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2789 rather than a list of all possible key sequences.
2790 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2791 no matter what it is.
2792 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2793 \(or their meta variants) and entirely reject menu bindings.
2795 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2796 to other keymaps or slots. This makes it possible to search for an
2797 indirect definition itself.
2799 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2800 that invoke a command which is remapped to DEFINITION, but include the
2801 remapped command in the returned list. */)
2802 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2803 Lisp_Object definition
, keymap
;
2804 Lisp_Object firstonly
, noindirect
, no_remap
;
2806 Lisp_Object sequences
, keymaps
;
2807 /* 1 means ignore all menu bindings entirely. */
2808 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2811 /* Find the relevant keymaps. */
2812 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2814 else if (!NILP (keymap
))
2815 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2817 keymaps
= Fcurrent_active_maps (Qnil
);
2819 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2820 We don't really need to check `keymap'. */
2821 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2825 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2827 /* Check heuristic-consistency of the cache. */
2828 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2829 where_is_cache
= Qnil
;
2831 if (NILP (where_is_cache
))
2833 /* We need to create the cache. */
2834 Lisp_Object args
[2];
2835 where_is_cache
= Fmake_hash_table (0, args
);
2836 where_is_cache_keymaps
= Qt
;
2838 /* Fill in the cache. */
2839 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2840 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2843 where_is_cache_keymaps
= keymaps
;
2846 /* We want to process definitions from the last to the first.
2847 Instead of consing, copy definitions to a vector and step
2848 over that vector. */
2849 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2850 n
= XINT (Flength (sequences
));
2851 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2852 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2853 defns
[i
++] = XCAR (sequences
);
2855 /* Verify that the key bindings are not shadowed. Note that
2856 the following can GC. */
2857 GCPRO2 (definition
, keymaps
);
2860 for (i
= n
- 1; i
>= 0; --i
)
2861 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2863 if (ascii_sequence_p (defns
[i
]))
2869 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2874 /* Kill the cache so that where_is_internal_1 doesn't think
2875 we're filling it up. */
2876 where_is_cache
= Qnil
;
2877 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2883 /* This is the function that Fwhere_is_internal calls using map_char_table.
2885 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2887 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2888 Since map_char_table doesn't really use the return value from this function,
2889 we the result append to RESULT, the slot in ARGS.
2891 This function can GC because it calls where_is_internal_1 which can
2895 where_is_internal_2 (args
, key
, binding
)
2896 Lisp_Object args
, key
, binding
;
2898 Lisp_Object definition
, noindirect
, this, last
;
2899 Lisp_Object result
, sequence
;
2900 int nomenus
, last_is_meta
;
2901 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2903 GCPRO3 (args
, key
, binding
);
2904 result
= XCDR (XCAR (args
));
2905 definition
= XCAR (XCAR (XCAR (args
)));
2906 noindirect
= XCDR (XCAR (XCAR (args
)));
2907 this = XCAR (XCAR (XCDR (args
)));
2908 last
= XCDR (XCAR (XCDR (args
)));
2909 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2910 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2912 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2913 this, last
, nomenus
, last_is_meta
);
2915 if (!NILP (sequence
))
2916 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2922 /* This function can GC because get_keyelt can. */
2925 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2926 nomenus
, last_is_meta
)
2927 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2928 int nomenus
, last_is_meta
;
2930 Lisp_Object sequence
;
2932 /* Search through indirections unless that's not wanted. */
2933 if (NILP (noindirect
))
2934 binding
= get_keyelt (binding
, 0);
2936 /* End this iteration if this element does not match
2939 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2940 || EQ (binding
, definition
)
2941 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2942 /* Doesn't match. */
2945 /* We have found a match. Construct the key sequence where we found it. */
2946 if (INTEGERP (key
) && last_is_meta
)
2948 sequence
= Fcopy_sequence (this);
2949 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2952 sequence
= append_key (this, key
);
2954 if (!NILP (where_is_cache
))
2956 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2957 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2964 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2966 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2967 doc
: /* Insert the list of all defined keys and their definitions.
2968 The list is inserted in the current buffer, while the bindings are
2969 looked up in BUFFER.
2970 The optional argument PREFIX, if non-nil, should be a key sequence;
2971 then we display only bindings that start with that prefix.
2972 The optional argument MENUS, if non-nil, says to mention menu bindings.
2973 \(Ordinarily these are omitted from the output.) */)
2974 (buffer
, prefix
, menus
)
2975 Lisp_Object buffer
, prefix
, menus
;
2977 Lisp_Object outbuf
, shadow
;
2978 int nomenu
= NILP (menus
);
2979 register Lisp_Object start1
;
2980 struct gcpro gcpro1
;
2982 char *alternate_heading
2984 Keyboard translations:\n\n\
2985 You type Translation\n\
2986 -------- -----------\n";
2991 outbuf
= Fcurrent_buffer ();
2993 /* Report on alternates for keys. */
2994 if (STRINGP (current_kboard
->Vkeyboard_translate_table
) && !NILP (prefix
))
2997 const unsigned char *translate
= SDATA (current_kboard
->Vkeyboard_translate_table
);
2998 int translate_len
= SCHARS (current_kboard
->Vkeyboard_translate_table
);
3000 for (c
= 0; c
< translate_len
; c
++)
3001 if (translate
[c
] != c
)
3003 char buf
[KEY_DESCRIPTION_SIZE
];
3006 if (alternate_heading
)
3008 insert_string (alternate_heading
);
3009 alternate_heading
= 0;
3012 bufend
= push_key_description (translate
[c
], buf
, 1);
3013 insert (buf
, bufend
- buf
);
3014 Findent_to (make_number (16), make_number (1));
3015 bufend
= push_key_description (c
, buf
, 1);
3016 insert (buf
, bufend
- buf
);
3020 /* Insert calls signal_after_change which may GC. */
3021 translate
= SDATA (current_kboard
->Vkeyboard_translate_table
);
3027 if (!NILP (current_kboard
->Vlocal_key_translation_map
))
3028 describe_map_tree (current_kboard
->Vlocal_key_translation_map
, 0, Qnil
, prefix
,
3029 "Key translations", nomenu
, 1, 0, 0);
3032 /* Print the (major mode) local map. */
3034 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
3035 start1
= current_kboard
->Voverriding_terminal_local_map
;
3036 else if (!NILP (Voverriding_local_map
))
3037 start1
= Voverriding_local_map
;
3041 describe_map_tree (start1
, 1, shadow
, prefix
,
3042 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
3043 shadow
= Fcons (start1
, shadow
);
3047 /* Print the minor mode and major mode keymaps. */
3049 Lisp_Object
*modes
, *maps
;
3051 /* Temporarily switch to `buffer', so that we can get that buffer's
3052 minor modes correctly. */
3053 Fset_buffer (buffer
);
3055 nmaps
= current_minor_maps (&modes
, &maps
);
3056 Fset_buffer (outbuf
);
3058 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3059 XBUFFER (buffer
), Qkeymap
);
3062 describe_map_tree (start1
, 1, shadow
, prefix
,
3063 "\f\n`keymap' Property Bindings", nomenu
,
3065 shadow
= Fcons (start1
, shadow
);
3068 /* Print the minor mode maps. */
3069 for (i
= 0; i
< nmaps
; i
++)
3071 /* The title for a minor mode keymap
3072 is constructed at run time.
3073 We let describe_map_tree do the actual insertion
3074 because it takes care of other features when doing so. */
3077 if (!SYMBOLP (modes
[i
]))
3080 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
3084 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
3085 SCHARS (SYMBOL_NAME (modes
[i
])));
3086 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
3088 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
3089 p
+= sizeof (" Minor Mode Bindings") - 1;
3092 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
3093 title
, nomenu
, 0, 0, 0);
3094 shadow
= Fcons (maps
[i
], shadow
);
3097 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
3098 XBUFFER (buffer
), Qlocal_map
);
3101 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
3102 describe_map_tree (start1
, 1, shadow
, prefix
,
3103 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
3105 describe_map_tree (start1
, 1, shadow
, prefix
,
3106 "\f\n`local-map' Property Bindings",
3109 shadow
= Fcons (start1
, shadow
);
3113 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
3114 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
3116 /* Print the function-key-map translations under this prefix. */
3117 if (!NILP (current_kboard
->Vlocal_function_key_map
))
3118 describe_map_tree (current_kboard
->Vlocal_function_key_map
, 0, Qnil
, prefix
,
3119 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
3125 /* Insert a description of the key bindings in STARTMAP,
3126 followed by those of all maps reachable through STARTMAP.
3127 If PARTIAL is nonzero, omit certain "uninteresting" commands
3128 (such as `undefined').
3129 If SHADOW is non-nil, it is a list of maps;
3130 don't mention keys which would be shadowed by any of them.
3131 PREFIX, if non-nil, says mention only keys that start with PREFIX.
3132 TITLE, if not 0, is a string to insert at the beginning.
3133 TITLE should not end with a colon or a newline; we supply that.
3134 If NOMENU is not 0, then omit menu-bar commands.
3136 If TRANSL is nonzero, the definitions are actually key translations
3137 so print strings and vectors differently.
3139 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
3142 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
3143 don't omit it; instead, mention it but say it is shadowed. */
3146 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
3147 always_title
, mention_shadow
)
3148 Lisp_Object startmap
, shadow
, prefix
;
3156 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
3157 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3164 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3167 GCPRO3 (maps
, seen
, sub_shadows
);
3173 /* Delete from MAPS each element that is for the menu bar. */
3174 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3176 Lisp_Object elt
, prefix
, tem
;
3179 prefix
= Fcar (elt
);
3180 if (XVECTOR (prefix
)->size
>= 1)
3182 tem
= Faref (prefix
, make_number (0));
3183 if (EQ (tem
, Qmenu_bar
))
3184 maps
= Fdelq (elt
, maps
);
3189 if (!NILP (maps
) || always_title
)
3193 insert_string (title
);
3196 insert_string (" Starting With ");
3197 insert1 (Fkey_description (prefix
, Qnil
));
3199 insert_string (":\n");
3201 insert_string (key_heading
);
3205 for (; !NILP (maps
); maps
= Fcdr (maps
))
3207 register Lisp_Object elt
, prefix
, tail
;
3210 prefix
= Fcar (elt
);
3214 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3218 shmap
= XCAR (tail
);
3220 /* If the sequence by which we reach this keymap is zero-length,
3221 then the shadow map for this keymap is just SHADOW. */
3222 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3223 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3225 /* If the sequence by which we reach this keymap actually has
3226 some elements, then the sequence's definition in SHADOW is
3227 what we should use. */
3230 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3231 if (INTEGERP (shmap
))
3235 /* If shmap is not nil and not a keymap,
3236 it completely shadows this map, so don't
3237 describe this map at all. */
3238 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3242 sub_shadows
= Fcons (shmap
, sub_shadows
);
3245 /* Maps we have already listed in this loop shadow this map. */
3246 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3249 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3251 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3254 describe_map (Fcdr (elt
), prefix
,
3255 transl
? describe_translation
: describe_command
,
3256 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3262 insert_string ("\n");
3267 static int previous_description_column
;
3270 describe_command (definition
, args
)
3271 Lisp_Object definition
, args
;
3273 register Lisp_Object tem1
;
3274 int column
= (int) current_column (); /* iftc */
3275 int description_column
;
3277 /* If column 16 is no good, go to col 32;
3278 but don't push beyond that--go to next line instead. */
3282 description_column
= 32;
3284 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3285 description_column
= 32;
3287 description_column
= 16;
3289 Findent_to (make_number (description_column
), make_number (1));
3290 previous_description_column
= description_column
;
3292 if (SYMBOLP (definition
))
3294 tem1
= SYMBOL_NAME (definition
);
3296 insert_string ("\n");
3298 else if (STRINGP (definition
) || VECTORP (definition
))
3299 insert_string ("Keyboard Macro\n");
3300 else if (KEYMAPP (definition
))
3301 insert_string ("Prefix Command\n");
3303 insert_string ("??\n");
3307 describe_translation (definition
, args
)
3308 Lisp_Object definition
, args
;
3310 register Lisp_Object tem1
;
3312 Findent_to (make_number (16), make_number (1));
3314 if (SYMBOLP (definition
))
3316 tem1
= SYMBOL_NAME (definition
);
3318 insert_string ("\n");
3320 else if (STRINGP (definition
) || VECTORP (definition
))
3322 insert1 (Fkey_description (definition
, Qnil
));
3323 insert_string ("\n");
3325 else if (KEYMAPP (definition
))
3326 insert_string ("Prefix Command\n");
3328 insert_string ("??\n");
3331 /* describe_map puts all the usable elements of a sparse keymap
3332 into an array of `struct describe_map_elt',
3333 then sorts them by the events. */
3335 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3337 /* qsort comparison function for sorting `struct describe_map_elt' by
3341 describe_map_compare (aa
, bb
)
3342 const void *aa
, *bb
;
3344 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3345 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3346 return ((XINT (a
->event
) > XINT (b
->event
))
3347 - (XINT (a
->event
) < XINT (b
->event
)));
3348 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3350 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3352 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3353 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3354 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3359 /* Describe the contents of map MAP, assuming that this map itself is
3360 reached by the sequence of prefix keys PREFIX (a string or vector).
3361 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3364 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3365 seen
, nomenu
, mention_shadow
)
3366 register Lisp_Object map
;
3368 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3375 Lisp_Object tail
, definition
, event
;
3377 Lisp_Object suppress
;
3380 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3382 /* These accumulate the values from sparse keymap bindings,
3383 so we can sort them and handle them in order. */
3384 int length_needed
= 0;
3385 struct describe_map_elt
*vect
;
3392 suppress
= intern ("suppress-keymap");
3394 /* This vector gets used to present single keys to Flookup_key. Since
3395 that is done once per keymap element, we don't want to cons up a
3396 fresh vector every time. */
3397 kludge
= Fmake_vector (make_number (1), Qnil
);
3400 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3403 vect
= ((struct describe_map_elt
*)
3404 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3406 GCPRO3 (prefix
, definition
, kludge
);
3408 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3412 if (VECTORP (XCAR (tail
))
3413 || CHAR_TABLE_P (XCAR (tail
)))
3414 describe_vector (XCAR (tail
),
3415 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3416 (int *)0, 0, 1, mention_shadow
);
3417 else if (CONSP (XCAR (tail
)))
3419 int this_shadowed
= 0;
3421 event
= XCAR (XCAR (tail
));
3423 /* Ignore bindings whose "prefix" are not really valid events.
3424 (We get these in the frames and buffers menu.) */
3425 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3428 if (nomenu
&& EQ (event
, Qmenu_bar
))
3431 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3433 /* Don't show undefined commands or suppressed commands. */
3434 if (NILP (definition
)) continue;
3435 if (SYMBOLP (definition
) && partial
)
3437 tem
= Fget (definition
, suppress
);
3442 /* Don't show a command that isn't really visible
3443 because a local definition of the same key shadows it. */
3445 ASET (kludge
, 0, event
);
3448 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3451 /* Avoid generating duplicate entries if the
3452 shadowed binding has the same definition. */
3453 if (mention_shadow
&& !EQ (tem
, definition
))
3460 tem
= Flookup_key (map
, kludge
, Qt
);
3461 if (!EQ (tem
, definition
)) continue;
3463 vect
[slots_used
].event
= event
;
3464 vect
[slots_used
].definition
= definition
;
3465 vect
[slots_used
].shadowed
= this_shadowed
;
3468 else if (EQ (XCAR (tail
), Qkeymap
))
3470 /* The same keymap might be in the structure twice, if we're
3471 using an inherited keymap. So skip anything we've already
3473 tem
= Fassq (tail
, *seen
);
3474 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3476 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3480 /* If we found some sparse map events, sort them. */
3482 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3483 describe_map_compare
);
3485 /* Now output them in sorted order. */
3487 for (i
= 0; i
< slots_used
; i
++)
3489 Lisp_Object start
, end
;
3493 previous_description_column
= 0;
3498 ASET (kludge
, 0, vect
[i
].event
);
3499 start
= vect
[i
].event
;
3502 definition
= vect
[i
].definition
;
3504 /* Find consecutive chars that are identically defined. */
3505 if (INTEGERP (vect
[i
].event
))
3507 while (i
+ 1 < slots_used
3508 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3509 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3510 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3512 end
= vect
[i
].event
;
3515 /* Now START .. END is the range to describe next. */
3517 /* Insert the string to describe the event START. */
3518 insert1 (Fkey_description (kludge
, prefix
));
3520 if (!EQ (start
, end
))
3524 ASET (kludge
, 0, end
);
3525 /* Insert the string to describe the character END. */
3526 insert1 (Fkey_description (kludge
, prefix
));
3529 /* Print a description of the definition of this character.
3530 elt_describer will take care of spacing out far enough
3531 for alignment purposes. */
3532 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3534 if (vect
[i
].shadowed
)
3537 insert_string ("\n (that binding is currently shadowed by another mode)");
3546 describe_vector_princ (elt
, fun
)
3547 Lisp_Object elt
, fun
;
3549 Findent_to (make_number (16), make_number (1));
3554 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3555 doc
: /* Insert a description of contents of VECTOR.
3556 This is text showing the elements of vector matched against indices.
3557 DESCRIBER is the output function used; nil means use `princ'. */)
3559 Lisp_Object vector
, describer
;
3561 int count
= SPECPDL_INDEX ();
3562 if (NILP (describer
))
3563 describer
= intern ("princ");
3564 specbind (Qstandard_output
, Fcurrent_buffer ());
3565 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3566 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3567 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3569 return unbind_to (count
, Qnil
);
3572 /* Insert in the current buffer a description of the contents of VECTOR.
3573 We call ELT_DESCRIBER to insert the description of one value found
3576 ELT_PREFIX describes what "comes before" the keys or indices defined
3577 by this vector. This is a human-readable string whose size
3578 is not necessarily related to the situation.
3580 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3581 leads to this keymap.
3583 If the vector is a chartable, ELT_PREFIX is the vector
3584 of bytes that lead to the character set or portion of a character
3585 set described by this chartable.
3587 If PARTIAL is nonzero, it means do not mention suppressed commands
3588 (that assumes the vector is in a keymap).
3590 SHADOW is a list of keymaps that shadow this map.
3591 If it is non-nil, then we look up the key in those maps
3592 and we don't mention it now if it is defined by any of them.
3594 ENTIRE_MAP is the keymap in which this vector appears.
3595 If the definition in effect in the whole map does not match
3596 the one in this vector, we ignore this one.
3598 When describing a sub-char-table, INDICES is a list of
3599 indices at higher levels in this char-table,
3600 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3602 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3604 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3607 describe_vector (vector
, prefix
, args
, elt_describer
,
3608 partial
, shadow
, entire_map
,
3609 indices
, char_table_depth
, keymap_p
,
3611 register Lisp_Object vector
;
3612 Lisp_Object prefix
, args
;
3613 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3616 Lisp_Object entire_map
;
3618 int char_table_depth
;
3622 Lisp_Object definition
;
3624 Lisp_Object elt_prefix
= Qnil
;
3626 Lisp_Object suppress
;
3629 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3630 /* Range of elements to be handled. */
3632 /* A flag to tell if a leaf in this level of char-table is not a
3633 generic character (i.e. a complete multibyte character). */
3641 indices
= (int *) alloca (3 * sizeof (int));
3647 /* Call Fkey_description first, to avoid GC bug for the other string. */
3648 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3651 tem
= Fkey_description (prefix
, Qnil
);
3652 elt_prefix
= concat2 (tem
, build_string (" "));
3657 /* This vector gets used to present single keys to Flookup_key. Since
3658 that is done once per vector element, we don't want to cons up a
3659 fresh vector every time. */
3660 kludge
= Fmake_vector (make_number (1), Qnil
);
3661 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3664 suppress
= intern ("suppress-keymap");
3666 if (CHAR_TABLE_P (vector
))
3668 if (char_table_depth
== 0)
3670 /* VECTOR is a top level char-table. */
3673 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3677 /* VECTOR is a sub char-table. */
3678 if (char_table_depth
>= 3)
3679 /* A char-table is never that deep. */
3680 error ("Too deep char table");
3683 = (CHARSET_VALID_P (indices
[0])
3684 && ((CHARSET_DIMENSION (indices
[0]) == 1
3685 && char_table_depth
== 1)
3686 || char_table_depth
== 2));
3688 /* Meaningful elements are from 32th to 127th. */
3690 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3695 /* This does the right thing for ordinary vectors. */
3699 to
= XVECTOR (vector
)->size
;
3702 for (i
= from
; i
< to
; i
++)
3704 int this_shadowed
= 0;
3707 if (CHAR_TABLE_P (vector
))
3709 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3712 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3713 && !CHARSET_DEFINED_P (i
- 128))
3717 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3720 definition
= get_keyelt (AREF (vector
, i
), 0);
3722 if (NILP (definition
)) continue;
3724 /* Don't mention suppressed commands. */
3725 if (SYMBOLP (definition
) && partial
)
3729 tem
= Fget (definition
, suppress
);
3731 if (!NILP (tem
)) continue;
3734 /* Set CHARACTER to the character this entry describes, if any.
3735 Also update *INDICES. */
3736 if (CHAR_TABLE_P (vector
))
3738 indices
[char_table_depth
] = i
;
3740 if (char_table_depth
== 0)
3743 indices
[0] = i
- 128;
3745 else if (complete_char
)
3747 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3755 ASET (kludge
, 0, make_number (character
));
3757 /* If this binding is shadowed by some other map, ignore it. */
3758 if (!NILP (shadow
) && complete_char
)
3762 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3773 /* Ignore this definition if it is shadowed by an earlier
3774 one in the same keymap. */
3775 if (!NILP (entire_map
) && complete_char
)
3779 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3781 if (!EQ (tem
, definition
))
3787 if (char_table_depth
== 0)
3792 /* For a sub char-table, show the depth by indentation.
3793 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3794 if (char_table_depth
> 0)
3795 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3797 /* Output the prefix that applies to every entry in this map. */
3798 if (!NILP (elt_prefix
))
3799 insert1 (elt_prefix
);
3801 /* Insert or describe the character this slot is for,
3802 or a description of what it is for. */
3803 if (SUB_CHAR_TABLE_P (vector
))
3806 insert_char (character
);
3809 /* We need an octal representation for this block of
3812 sprintf (work
, "(row %d)", i
);
3813 insert (work
, strlen (work
));
3816 else if (CHAR_TABLE_P (vector
))
3819 insert1 (Fkey_description (kludge
, prefix
));
3822 /* Print the information for this character set. */
3823 insert_string ("<");
3824 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3826 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3835 insert1 (Fkey_description (kludge
, prefix
));
3838 /* If we find a sub char-table within a char-table,
3839 scan it recursively; it defines the details for
3840 a character set or a portion of a character set. */
3841 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3844 describe_vector (definition
, prefix
, args
, elt_describer
,
3845 partial
, shadow
, entire_map
,
3846 indices
, char_table_depth
+ 1, keymap_p
,
3853 /* Find all consecutive characters or rows that have the same
3854 definition. But, for elements of a top level char table, if
3855 they are for charsets, we had better describe one by one even
3856 if they have the same definition. */
3857 if (CHAR_TABLE_P (vector
))
3861 if (char_table_depth
== 0)
3862 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3864 while (i
+ 1 < limit
3865 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3867 && !NILP (Fequal (tem2
, definition
)))
3872 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3874 && !NILP (Fequal (tem2
, definition
)))
3878 /* If we have a range of more than one character,
3879 print where the range reaches to. */
3881 if (i
!= starting_i
)
3885 ASET (kludge
, 0, make_number (i
));
3887 if (!NILP (elt_prefix
))
3888 insert1 (elt_prefix
);
3890 if (CHAR_TABLE_P (vector
))
3892 if (char_table_depth
== 0)
3894 insert1 (Fkey_description (kludge
, prefix
));
3896 else if (complete_char
)
3898 indices
[char_table_depth
] = i
;
3899 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3900 insert_char (character
);
3904 /* We need an octal representation for this block of
3907 sprintf (work
, "(row %d)", i
);
3908 insert (work
, strlen (work
));
3913 insert1 (Fkey_description (kludge
, prefix
));
3917 /* Print a description of the definition of this character.
3918 elt_describer will take care of spacing out far enough
3919 for alignment purposes. */
3920 (*elt_describer
) (definition
, args
);
3925 insert_string (" (binding currently shadowed)");
3930 /* For (sub) char-table, print `defalt' slot at last. */
3931 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3933 insert (" ", char_table_depth
* 2);
3934 insert_string ("<<default>>");
3935 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3941 /* Apropos - finding all symbols whose names match a regexp. */
3942 static Lisp_Object apropos_predicate
;
3943 static Lisp_Object apropos_accumulate
;
3946 apropos_accum (symbol
, string
)
3947 Lisp_Object symbol
, string
;
3949 register Lisp_Object tem
;
3951 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3952 if (!NILP (tem
) && !NILP (apropos_predicate
))
3953 tem
= call1 (apropos_predicate
, symbol
);
3955 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3958 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3959 doc
: /* Show all symbols whose names contain match for REGEXP.
3960 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3961 for each symbol and a symbol is mentioned only if that returns non-nil.
3962 Return list of symbols found. */)
3964 Lisp_Object regexp
, predicate
;
3967 CHECK_STRING (regexp
);
3968 apropos_predicate
= predicate
;
3969 apropos_accumulate
= Qnil
;
3970 map_obarray (Vobarray
, apropos_accum
, regexp
);
3971 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3972 apropos_accumulate
= Qnil
;
3973 apropos_predicate
= Qnil
;
3980 Qkeymap
= intern ("keymap");
3981 staticpro (&Qkeymap
);
3982 staticpro (&apropos_predicate
);
3983 staticpro (&apropos_accumulate
);
3984 apropos_predicate
= Qnil
;
3985 apropos_accumulate
= Qnil
;
3987 /* Now we are ready to set up this property, so we can
3988 create char tables. */
3989 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3991 /* Initialize the keymaps standardly used.
3992 Each one is the value of a Lisp variable, and is also
3993 pointed to by a C variable */
3995 global_map
= Fmake_keymap (Qnil
);
3996 Fset (intern ("global-map"), global_map
);
3998 current_global_map
= global_map
;
3999 staticpro (&global_map
);
4000 staticpro (¤t_global_map
);
4002 meta_map
= Fmake_keymap (Qnil
);
4003 Fset (intern ("esc-map"), meta_map
);
4004 Ffset (intern ("ESC-prefix"), meta_map
);
4006 control_x_map
= Fmake_keymap (Qnil
);
4007 Fset (intern ("ctl-x-map"), control_x_map
);
4008 Ffset (intern ("Control-X-prefix"), control_x_map
);
4011 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
4012 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
4013 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
4014 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
4015 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
4017 staticpro (&exclude_keys
);
4019 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
4020 doc
: /* List of commands given new key bindings recently.
4021 This is used for internal purposes during Emacs startup;
4022 don't alter it yourself. */);
4023 Vdefine_key_rebound_commands
= Qt
;
4025 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
4026 doc
: /* Default keymap to use when reading from the minibuffer. */);
4027 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
4029 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
4030 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
4031 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
4032 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
4034 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
4035 doc
: /* Local keymap for minibuffer input with completion. */);
4036 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
4037 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
4039 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
4040 &Vminibuffer_local_filename_completion_map
,
4041 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
4042 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
4043 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
4044 Vminibuffer_local_completion_map
);
4047 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
4048 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
4049 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
4050 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
4051 Vminibuffer_local_completion_map
);
4053 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
4054 &Vminibuffer_local_must_match_filename_map
,
4055 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
4056 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
4057 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
4058 Vminibuffer_local_must_match_map
);
4060 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
4061 doc
: /* Alist of keymaps to use for minor modes.
4062 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
4063 key sequences and look up bindings iff VARIABLE's value is non-nil.
4064 If two active keymaps bind the same key, the keymap appearing earlier
4065 in the list takes precedence. */);
4066 Vminor_mode_map_alist
= Qnil
;
4068 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
4069 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
4070 This variable is an alist just like `minor-mode-map-alist', and it is
4071 used the same way (and before `minor-mode-map-alist'); however,
4072 it is provided for major modes to bind locally. */);
4073 Vminor_mode_overriding_map_alist
= Qnil
;
4075 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
4076 doc
: /* List of keymap alists to use for emulations modes.
4077 It is intended for modes or packages using multiple minor-mode keymaps.
4078 Each element is a keymap alist just like `minor-mode-map-alist', or a
4079 symbol with a variable binding which is a keymap alist, and it is used
4080 the same way. The "active" keymaps in each alist are used before
4081 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
4082 Vemulation_mode_map_alists
= Qnil
;
4084 staticpro (&Vmouse_events
);
4085 Vmouse_events
= Fcons (intern ("menu-bar"),
4086 Fcons (intern ("tool-bar"),
4087 Fcons (intern ("header-line"),
4088 Fcons (intern ("mode-line"),
4089 Fcons (intern ("mouse-1"),
4090 Fcons (intern ("mouse-2"),
4091 Fcons (intern ("mouse-3"),
4092 Fcons (intern ("mouse-4"),
4093 Fcons (intern ("mouse-5"),
4097 Qsingle_key_description
= intern ("single-key-description");
4098 staticpro (&Qsingle_key_description
);
4100 Qkey_description
= intern ("key-description");
4101 staticpro (&Qkey_description
);
4103 Qkeymapp
= intern ("keymapp");
4104 staticpro (&Qkeymapp
);
4106 Qnon_ascii
= intern ("non-ascii");
4107 staticpro (&Qnon_ascii
);
4109 Qmenu_item
= intern ("menu-item");
4110 staticpro (&Qmenu_item
);
4112 Qremap
= intern ("remap");
4113 staticpro (&Qremap
);
4115 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
4116 staticpro (&command_remapping_vector
);
4118 where_is_cache_keymaps
= Qt
;
4119 where_is_cache
= Qnil
;
4120 staticpro (&where_is_cache
);
4121 staticpro (&where_is_cache_keymaps
);
4123 defsubr (&Skeymapp
);
4124 defsubr (&Skeymap_parent
);
4125 defsubr (&Skeymap_prompt
);
4126 defsubr (&Sset_keymap_parent
);
4127 defsubr (&Smake_keymap
);
4128 defsubr (&Smake_sparse_keymap
);
4129 defsubr (&Smap_keymap
);
4130 defsubr (&Scopy_keymap
);
4131 defsubr (&Scommand_remapping
);
4132 defsubr (&Skey_binding
);
4133 defsubr (&Slocal_key_binding
);
4134 defsubr (&Sglobal_key_binding
);
4135 defsubr (&Sminor_mode_key_binding
);
4136 defsubr (&Sdefine_key
);
4137 defsubr (&Slookup_key
);
4138 defsubr (&Sdefine_prefix_command
);
4139 defsubr (&Suse_global_map
);
4140 defsubr (&Suse_local_map
);
4141 defsubr (&Scurrent_local_map
);
4142 defsubr (&Scurrent_global_map
);
4143 defsubr (&Scurrent_minor_mode_maps
);
4144 defsubr (&Scurrent_active_maps
);
4145 defsubr (&Saccessible_keymaps
);
4146 defsubr (&Skey_description
);
4147 defsubr (&Sdescribe_vector
);
4148 defsubr (&Ssingle_key_description
);
4149 defsubr (&Stext_char_description
);
4150 defsubr (&Swhere_is_internal
);
4151 defsubr (&Sdescribe_buffer_bindings
);
4152 defsubr (&Sapropos_internal
);
4158 initial_define_key (global_map
, 033, "ESC-prefix");
4159 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
4162 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
4163 (do not change this comment) */