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. */
29 #include "character.h"
32 #include "termhooks.h"
33 #include "blockinput.h"
35 #include "intervals.h"
38 /* The number of elements in keymap vectors. */
39 #define DENSE_TABLE_SIZE (0200)
41 /* Actually allocate storage for these variables */
43 Lisp_Object current_global_map
; /* Current global keymap */
45 Lisp_Object global_map
; /* default global key bindings */
47 Lisp_Object meta_map
; /* The keymap used for globally bound
48 ESC-prefixed default commands */
50 Lisp_Object control_x_map
; /* The keymap used for globally bound
51 C-x-prefixed default commands */
53 /* was MinibufLocalMap */
54 Lisp_Object Vminibuffer_local_map
;
55 /* The keymap used by the minibuf for local
56 bindings when spaces are allowed in the
59 /* was MinibufLocalNSMap */
60 Lisp_Object Vminibuffer_local_ns_map
;
61 /* The keymap used by the minibuf for local
62 bindings when spaces are not encouraged
65 /* keymap used for minibuffers when doing completion */
66 /* was MinibufLocalCompletionMap */
67 Lisp_Object Vminibuffer_local_completion_map
;
69 /* keymap used for minibuffers when doing completion in filenames */
70 Lisp_Object Vminibuffer_local_filename_completion_map
;
72 /* keymap used for minibuffers when doing completion in filenames
74 Lisp_Object Vminibuffer_local_must_match_filename_map
;
76 /* keymap used for minibuffers when doing completion and require a match */
77 /* was MinibufLocalMustMatchMap */
78 Lisp_Object Vminibuffer_local_must_match_map
;
80 /* Alist of minor mode variables and keymaps. */
81 Lisp_Object Vminor_mode_map_alist
;
83 /* Alist of major-mode-specific overrides for
84 minor mode variables and keymaps. */
85 Lisp_Object Vminor_mode_overriding_map_alist
;
87 /* List of emulation mode keymap alists. */
88 Lisp_Object Vemulation_mode_map_alists
;
90 /* Keymap mapping ASCII function key sequences onto their preferred forms.
91 Initialized by the terminal-specific lisp files. See DEFVAR for more
93 Lisp_Object Vfunction_key_map
;
95 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
96 Lisp_Object Vkey_translation_map
;
98 /* A list of all commands given new bindings since a certain time
99 when nil was stored here.
100 This is used to speed up recomputation of menu key equivalents
101 when Emacs starts up. t means don't record anything here. */
102 Lisp_Object Vdefine_key_rebound_commands
;
104 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
106 /* Alist of elements like (DEL . "\d"). */
107 static Lisp_Object exclude_keys
;
109 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
110 static Lisp_Object command_remapping_vector
;
112 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
113 in a string key sequence is equivalent to prefixing with this
115 extern Lisp_Object meta_prefix_char
;
117 extern Lisp_Object Voverriding_local_map
;
119 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
120 static Lisp_Object where_is_cache
;
121 /* Which keymaps are reverse-stored in the cache. */
122 static Lisp_Object where_is_cache_keymaps
;
124 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
125 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
127 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
128 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
129 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
130 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
131 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
132 int, Lisp_Object
, Lisp_Object
*, int, int));
133 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
134 void (*) (Lisp_Object
, Lisp_Object
), int,
135 Lisp_Object
, Lisp_Object
, int *,
137 static void silly_event_symbol_error
P_ ((Lisp_Object
));
139 /* Keymap object support - constructors and predicates. */
141 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
142 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
143 CHARTABLE is a char-table that holds the bindings for all characters
144 without modifiers. All entries in it are initially nil, meaning
145 "command undefined". ALIST is an assoc-list which holds bindings for
146 function keys, mouse events, and any other things that appear in the
147 input stream. Initially, ALIST is nil.
149 The optional arg STRING supplies a menu name for the keymap
150 in case you use it as a menu with `x-popup-menu'. */)
156 tail
= Fcons (string
, Qnil
);
159 return Fcons (Qkeymap
,
160 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
163 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
164 doc
: /* Construct and return a new sparse keymap.
165 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
166 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
167 which binds the function key or mouse event SYMBOL to DEFINITION.
168 Initially the alist is nil.
170 The optional arg STRING supplies a menu name for the keymap
171 in case you use it as a menu with `x-popup-menu'. */)
176 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
177 return Fcons (Qkeymap
, Qnil
);
180 /* This function is used for installing the standard key bindings
181 at initialization time.
185 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
188 initial_define_key (keymap
, key
, defname
)
193 store_in_keymap (keymap
, make_number (key
), intern (defname
));
197 initial_define_lispy_key (keymap
, keyname
, defname
)
202 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
205 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
206 doc
: /* Return t if OBJECT is a keymap.
208 A keymap is a list (keymap . ALIST),
209 or a symbol whose function definition is itself a keymap.
210 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
211 a vector of densely packed bindings for small character codes
212 is also allowed as an element. */)
216 return (KEYMAPP (object
) ? Qt
: Qnil
);
219 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
220 doc
: /* Return the prompt-string of a keymap MAP.
221 If non-nil, the prompt is shown in the echo-area
222 when reading a key-sequence to be looked-up in this keymap. */)
226 map
= get_keymap (map
, 0, 0);
229 Lisp_Object tem
= XCAR (map
);
237 /* Check that OBJECT is a keymap (after dereferencing through any
238 symbols). If it is, return it.
240 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
241 is an autoload form, do the autoload and try again.
242 If AUTOLOAD is nonzero, callers must assume GC is possible.
244 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
245 is zero as well), return Qt.
247 ERROR controls how we respond if OBJECT isn't a keymap.
248 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
250 Note that most of the time, we don't want to pursue autoloads.
251 Functions like Faccessible_keymaps which scan entire keymap trees
252 shouldn't load every autoloaded keymap. I'm not sure about this,
253 but it seems to me that only read_key_sequence, Flookup_key, and
254 Fdefine_key should cause keymaps to be autoloaded.
256 This function can GC when AUTOLOAD is non-zero, because it calls
257 do_autoload which can GC. */
260 get_keymap (object
, error
, autoload
)
269 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
272 tem
= indirect_function (object
);
275 if (EQ (XCAR (tem
), Qkeymap
))
278 /* Should we do an autoload? Autoload forms for keymaps have
279 Qkeymap as their fifth element. */
280 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
)
285 tail
= Fnth (make_number (4), tem
);
286 if (EQ (tail
, Qkeymap
))
290 struct gcpro gcpro1
, gcpro2
;
292 GCPRO2 (tem
, object
);
293 do_autoload (tem
, object
);
306 wrong_type_argument (Qkeymapp
, object
);
310 /* Return the parent map of KEYMAP, or nil if it has none.
311 We assume that KEYMAP is a valid keymap. */
314 keymap_parent (keymap
, autoload
)
320 keymap
= get_keymap (keymap
, 1, autoload
);
322 /* Skip past the initial element `keymap'. */
323 list
= XCDR (keymap
);
324 for (; CONSP (list
); list
= XCDR (list
))
326 /* See if there is another `keymap'. */
331 return get_keymap (list
, 0, autoload
);
334 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
335 doc
: /* Return the parent keymap of KEYMAP. */)
339 return keymap_parent (keymap
, 1);
342 /* Check whether MAP is one of MAPS parents. */
344 keymap_memberp (map
, maps
)
345 Lisp_Object map
, maps
;
347 if (NILP (map
)) return 0;
348 while (KEYMAPP (maps
) && !EQ (map
, maps
))
349 maps
= keymap_parent (maps
, 0);
350 return (EQ (map
, maps
));
353 /* Set the parent keymap of MAP to PARENT. */
355 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
356 doc
: /* Modify KEYMAP to set its parent map to PARENT.
357 Return PARENT. PARENT should be nil or another keymap. */)
359 Lisp_Object keymap
, parent
;
361 Lisp_Object list
, prev
;
362 struct gcpro gcpro1
, gcpro2
;
365 /* Force a keymap flush for the next call to where-is.
366 Since this can be called from within where-is, we don't set where_is_cache
367 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
368 be changed during where-is, while where_is_cache_keymaps is only used at
369 the very beginning of where-is and can thus be changed here without any
371 This is a very minor correctness (rather than safety) issue. */
372 where_is_cache_keymaps
= Qt
;
374 GCPRO2 (keymap
, parent
);
375 keymap
= get_keymap (keymap
, 1, 1);
379 parent
= get_keymap (parent
, 1, 1);
381 /* Check for cycles. */
382 if (keymap_memberp (keymap
, parent
))
383 error ("Cyclic keymap inheritance");
386 /* Skip past the initial element `keymap'. */
391 /* If there is a parent keymap here, replace it.
392 If we came to the end, add the parent in PREV. */
393 if (!CONSP (list
) || KEYMAPP (list
))
395 /* If we already have the right parent, return now
396 so that we avoid the loops below. */
397 if (EQ (XCDR (prev
), parent
))
398 RETURN_UNGCPRO (parent
);
401 XSETCDR (prev
, parent
);
407 /* Scan through for submaps, and set their parents too. */
409 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
411 /* Stop the scan when we come to the parent. */
412 if (EQ (XCAR (list
), Qkeymap
))
415 /* If this element holds a prefix map, deal with it. */
416 if (CONSP (XCAR (list
))
417 && CONSP (XCDR (XCAR (list
))))
418 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
421 if (VECTORP (XCAR (list
)))
422 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
423 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
424 fix_submap_inheritance (keymap
, make_number (i
),
425 XVECTOR (XCAR (list
))->contents
[i
]);
427 if (CHAR_TABLE_P (XCAR (list
)))
429 map_char_table (fix_submap_inheritance
, Qnil
, XCAR (list
), keymap
);
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' is accepted. */
572 for (tail
= XCDR (map
);
574 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
579 binding
= XCAR (tail
);
580 if (SYMBOLP (binding
))
582 /* If NOINHERIT, stop finding prefix definitions
583 after we pass a second occurrence of the `keymap' symbol. */
584 if (noinherit
&& EQ (binding
, Qkeymap
))
585 RETURN_UNGCPRO (Qnil
);
587 else if (CONSP (binding
))
589 Lisp_Object key
= XCAR (binding
);
592 val
= XCDR (binding
);
593 else if (t_ok
> 1 && EQ (key
, Qt
))
595 t_binding
= XCDR (binding
);
599 else if (VECTORP (binding
))
601 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
602 val
= AREF (binding
, XFASTINT (idx
));
604 else if (CHAR_TABLE_P (binding
))
606 /* Character codes with modifiers
607 are not included in a char-table.
608 All character codes without modifiers are included. */
609 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
611 val
= Faref (binding
, idx
);
612 /* `nil' has a special meaning for char-tables, so
613 we use something else to record an explicitly
620 /* If we found a binding, clean it up and return it. */
621 if (!EQ (val
, Qunbound
))
624 /* A Qt binding is just like an explicit nil binding
625 (i.e. it shadows any parent binding but not bindings in
626 keymaps of lower precedence). */
628 val
= get_keyelt (val
, autoload
);
630 fix_submap_inheritance (map
, idx
, val
);
631 RETURN_UNGCPRO (val
);
636 return get_keyelt (t_binding
, autoload
);
641 map_keymap_item (fun
, args
, key
, val
, data
)
642 map_keymap_function_t fun
;
643 Lisp_Object args
, key
, val
;
646 /* We should maybe try to detect bindings shadowed by previous
647 ones and things like that. */
650 (*fun
) (key
, val
, args
, data
);
654 map_keymap_char_table_item (args
, key
, val
)
655 Lisp_Object args
, key
, val
;
659 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
661 map_keymap_item (fun
, XCDR (args
), key
, val
,
662 XSAVE_VALUE (XCAR (args
))->pointer
);
666 /* Call FUN for every binding in MAP.
667 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
668 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
670 map_keymap (map
, fun
, args
, data
, autoload
)
671 map_keymap_function_t fun
;
672 Lisp_Object map
, args
;
676 struct gcpro gcpro1
, gcpro2
, gcpro3
;
680 GCPRO3 (map
, args
, tail
);
681 map
= get_keymap (map
, 1, autoload
);
682 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
683 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
686 Lisp_Object binding
= XCAR (tail
);
689 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
690 else if (VECTORP (binding
))
692 /* Loop over the char values represented in the vector. */
693 int len
= ASIZE (binding
);
695 for (c
= 0; c
< len
; c
++)
697 Lisp_Object character
;
698 XSETFASTINT (character
, c
);
699 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
702 else if (CHAR_TABLE_P (binding
))
704 map_char_table (map_keymap_char_table_item
, Qnil
, binding
,
705 Fcons (make_save_value (fun
, 0),
706 Fcons (make_save_value (data
, 0),
714 map_keymap_call (key
, val
, fun
, dummy
)
715 Lisp_Object key
, val
, fun
;
718 call2 (fun
, key
, val
);
721 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
722 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
723 FUNCTION is called with two arguments: the event that is bound, and
724 the definition it is bound to.
726 If KEYMAP has a parent, the parent's bindings are included as well.
727 This works recursively: if the parent has itself a parent, then the
728 grandparent's bindings are also included and so on.
729 usage: (map-keymap FUNCTION KEYMAP) */)
730 (function
, keymap
, sort_first
)
731 Lisp_Object function
, keymap
, sort_first
;
733 if (INTEGERP (function
))
734 /* We have to stop integers early since map_keymap gives them special
736 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
737 if (! NILP (sort_first
))
738 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
740 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
744 /* Given OBJECT which was found in a slot in a keymap,
745 trace indirect definitions to get the actual definition of that slot.
746 An indirect definition is a list of the form
747 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
748 and INDEX is the object to look up in KEYMAP to yield the definition.
750 Also if OBJECT has a menu string as the first element,
751 remove that. Also remove a menu help string as second element.
753 If AUTOLOAD is nonzero, load autoloadable keymaps
754 that are referred to with indirection.
756 This can GC because menu_item_eval_property calls Feval. */
759 get_keyelt (object
, autoload
)
765 if (!(CONSP (object
)))
766 /* This is really the value. */
769 /* If the keymap contents looks like (keymap ...) or (lambda ...)
771 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
774 /* If the keymap contents looks like (menu-item name . DEFN)
775 or (menu-item name DEFN ...) then use DEFN.
776 This is a new format menu item. */
777 else if (EQ (XCAR (object
), Qmenu_item
))
779 if (CONSP (XCDR (object
)))
783 object
= XCDR (XCDR (object
));
786 object
= XCAR (object
);
788 /* If there's a `:filter FILTER', apply FILTER to the
789 menu-item's definition to get the real definition to
791 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
792 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
795 filter
= XCAR (XCDR (tem
));
796 filter
= list2 (filter
, list2 (Qquote
, object
));
797 object
= menu_item_eval_property (filter
);
802 /* Invalid keymap. */
806 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
807 Keymap alist elements like (CHAR MENUSTRING . DEFN)
808 will be used by HierarKey menus. */
809 else if (STRINGP (XCAR (object
)))
811 object
= XCDR (object
);
812 /* Also remove a menu help string, if any,
813 following the menu item name. */
814 if (CONSP (object
) && STRINGP (XCAR (object
)))
815 object
= XCDR (object
);
816 /* Also remove the sublist that caches key equivalences, if any. */
817 if (CONSP (object
) && CONSP (XCAR (object
)))
820 carcar
= XCAR (XCAR (object
));
821 if (NILP (carcar
) || VECTORP (carcar
))
822 object
= XCDR (object
);
826 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
832 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
834 return (!CONSP (map
) ? object
/* Invalid keymap */
835 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
841 store_in_keymap (keymap
, idx
, def
)
843 register Lisp_Object idx
;
844 register Lisp_Object def
;
846 /* Flush any reverse-map cache. */
847 where_is_cache
= Qnil
;
848 where_is_cache_keymaps
= Qt
;
850 /* If we are preparing to dump, and DEF is a menu element
851 with a menu item indicator, copy it to ensure it is not pure. */
852 if (CONSP (def
) && PURE_P (def
)
853 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
854 def
= Fcons (XCAR (def
), XCDR (def
));
856 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
857 error ("attempt to define a key in a non-keymap");
859 /* If idx is a cons, and the car part is a character, idx must be of
860 the form (FROM-CHAR . TO-CHAR). */
861 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
862 CHECK_CHARACTER_CDR (idx
);
864 /* If idx is a list (some sort of mouse click, perhaps?),
865 the index we want to use is the car of the list, which
866 ought to be a symbol. */
867 idx
= EVENT_HEAD (idx
);
869 /* If idx is a symbol, it might have modifiers, which need to
870 be put in the canonical order. */
872 idx
= reorder_modifiers (idx
);
873 else if (INTEGERP (idx
))
874 /* Clobber the high bits that can be present on a machine
875 with more than 24 bits of integer. */
876 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
878 /* Scan the keymap for a binding of idx. */
882 /* The cons after which we should insert new bindings. If the
883 keymap has a table element, we record its position here, so new
884 bindings will go after it; this way, the table will stay
885 towards the front of the alist and character lookups in dense
886 keymaps will remain fast. Otherwise, this just points at the
887 front of the keymap. */
888 Lisp_Object insertion_point
;
890 insertion_point
= keymap
;
891 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
898 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
901 ASET (elt
, XFASTINT (idx
), def
);
904 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
906 int from
= XFASTINT (XCAR (idx
));
907 int to
= XFASTINT (XCDR (idx
));
909 if (to
>= ASIZE (elt
))
910 to
= ASIZE (elt
) - 1;
911 for (; from
<= to
; from
++)
912 ASET (elt
, from
, def
);
913 if (to
== XFASTINT (XCDR (idx
)))
914 /* We have defined all keys in IDX. */
917 insertion_point
= tail
;
919 else if (CHAR_TABLE_P (elt
))
921 /* Character codes with modifiers
922 are not included in a char-table.
923 All character codes without modifiers are included. */
924 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
927 /* `nil' has a special meaning for char-tables, so
928 we use something else to record an explicitly
930 NILP (def
) ? Qt
: def
);
933 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
935 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
938 insertion_point
= tail
;
940 else if (CONSP (elt
))
942 if (EQ (idx
, XCAR (elt
)))
948 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
950 int from
= XFASTINT (XCAR (idx
));
951 int to
= XFASTINT (XCDR (idx
));
953 if (from
<= XFASTINT (XCAR (elt
))
954 && to
>= XFASTINT (XCAR (elt
)))
962 else if (EQ (elt
, Qkeymap
))
963 /* If we find a 'keymap' symbol in the spine of KEYMAP,
964 then we must have found the start of a second keymap
965 being used as the tail of KEYMAP, and a binding for IDX
966 should be inserted before it. */
973 /* We have scanned the entire keymap, and not found a binding for
974 IDX. Let's add one. */
978 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
980 /* IDX specifies a range of characters, and not all of them
981 were handled yet, which means this keymap doesn't have a
982 char-table. So, we insert a char-table now. */
983 elt
= Fmake_char_table (Qkeymap
, Qnil
);
984 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
987 elt
= Fcons (idx
, def
);
988 CHECK_IMPURE (insertion_point
);
989 XSETCDR (insertion_point
, Fcons (elt
, XCDR (insertion_point
)));
996 EXFUN (Fcopy_keymap
, 1);
999 copy_keymap_item (elt
)
1002 Lisp_Object res
, tem
;
1009 /* Is this a new format menu item. */
1010 if (EQ (XCAR (tem
), Qmenu_item
))
1012 /* Copy cell with menu-item marker. */
1013 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1017 /* Copy cell with menu-item name. */
1018 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1024 /* Copy cell with binding and if the binding is a keymap,
1026 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1029 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1030 XSETCAR (elt
, Fcopy_keymap (tem
));
1032 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1033 /* Delete cache for key equivalences. */
1034 XSETCDR (elt
, XCDR (tem
));
1039 /* It may be an old fomat menu item.
1040 Skip the optional menu string. */
1041 if (STRINGP (XCAR (tem
)))
1043 /* Copy the cell, since copy-alist didn't go this deep. */
1044 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1046 /* Also skip the optional menu help string. */
1047 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1049 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1053 /* There may also be a list that caches key equivalences.
1054 Just delete it for the new keymap. */
1056 && CONSP (XCAR (tem
))
1057 && (NILP (XCAR (XCAR (tem
)))
1058 || VECTORP (XCAR (XCAR (tem
)))))
1060 XSETCDR (elt
, XCDR (tem
));
1063 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1064 XSETCDR (elt
, Fcopy_keymap (tem
));
1066 else if (EQ (XCAR (tem
), Qkeymap
))
1067 res
= Fcopy_keymap (elt
);
1073 copy_keymap_1 (chartable
, idx
, elt
)
1074 Lisp_Object chartable
, idx
, elt
;
1076 Fset_char_table_range (chartable
, idx
, copy_keymap_item (elt
));
1079 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1080 doc
: /* Return a copy of the keymap KEYMAP.
1081 The copy starts out with the same definitions of KEYMAP,
1082 but changing either the copy or KEYMAP does not affect the other.
1083 Any key definitions that are subkeymaps are recursively copied.
1084 However, a key definition which is a symbol whose definition is a keymap
1089 register Lisp_Object copy
, tail
;
1090 keymap
= get_keymap (keymap
, 1, 0);
1091 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1092 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1094 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1096 Lisp_Object elt
= XCAR (keymap
);
1097 if (CHAR_TABLE_P (elt
))
1099 elt
= Fcopy_sequence (elt
);
1100 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
);
1102 else if (VECTORP (elt
))
1105 elt
= Fcopy_sequence (elt
);
1106 for (i
= 0; i
< ASIZE (elt
); i
++)
1107 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1109 else if (CONSP (elt
))
1110 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1111 XSETCDR (tail
, Fcons (elt
, Qnil
));
1113 keymap
= XCDR (keymap
);
1115 XSETCDR (tail
, keymap
);
1119 /* Simple Keymap mutators and accessors. */
1121 /* GC is possible in this function if it autoloads a keymap. */
1123 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1124 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1127 KEY is a string or a vector of symbols and characters meaning a
1128 sequence of keystrokes and events. Non-ASCII characters with codes
1129 above 127 (such as ISO Latin-1) can be included if you use a vector.
1130 Using [t] for KEY creates a default definition, which applies to any
1131 event type that has no other definition in this keymap.
1133 DEF is anything that can be a key's definition:
1134 nil (means key is undefined in this keymap),
1135 a command (a Lisp function suitable for interactive calling),
1136 a string (treated as a keyboard macro),
1137 a keymap (to define a prefix key),
1138 a symbol (when the key is looked up, the symbol will stand for its
1139 function definition, which should at that time be one of the above,
1140 or another symbol whose function definition is used, etc.),
1141 a cons (STRING . DEFN), meaning that DEFN is the definition
1142 (DEFN should be a valid definition in its own right),
1143 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1145 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1146 binding is altered. If there is no binding for KEY, the new pair
1147 binding KEY to DEF is added at the front of KEYMAP. */)
1154 register Lisp_Object c
;
1155 register Lisp_Object cmd
;
1159 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1161 GCPRO3 (keymap
, key
, def
);
1162 keymap
= get_keymap (keymap
, 1, 1);
1164 if (!VECTORP (key
) && !STRINGP (key
))
1165 key
= wrong_type_argument (Qarrayp
, key
);
1167 length
= XFASTINT (Flength (key
));
1169 RETURN_UNGCPRO (Qnil
);
1171 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1172 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1174 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1179 c
= Faref (key
, make_number (idx
));
1183 /* C may be a Lucid style event type list or a cons (FROM .
1184 TO) specifying a range of characters. */
1185 if (lucid_event_type_list_p (c
))
1186 c
= Fevent_convert_list (c
);
1187 else if (CHARACTERP (XCAR (c
)))
1188 CHECK_CHARACTER_CDR (c
);
1192 silly_event_symbol_error (c
);
1195 && (XINT (c
) & meta_bit
)
1198 c
= meta_prefix_char
;
1204 XSETINT (c
, XINT (c
) & ~meta_bit
);
1210 if (!INTEGERP (c
) && !SYMBOLP (c
)
1212 /* If C is a range, it must be a leaf. */
1213 || (INTEGERP (XCAR (c
)) && idx
!= length
)))
1214 error ("Key sequence contains invalid event");
1217 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1219 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1221 /* If this key is undefined, make it a prefix. */
1223 cmd
= define_as_prefix (keymap
, c
);
1225 keymap
= get_keymap (cmd
, 0, 1);
1226 if (!CONSP (keymap
))
1227 /* We must use Fkey_description rather than just passing key to
1228 error; key might be a vector, not a string. */
1229 error ("Key sequence %s uses invalid prefix characters",
1230 SDATA (Fkey_description (key
, Qnil
)));
1234 /* This function may GC (it calls Fkey_binding). */
1236 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1237 doc
: /* Return the remapping for command COMMAND in current keymaps.
1238 Returns nil if COMMAND is not remapped (or not a symbol). */)
1240 Lisp_Object command
;
1242 if (!SYMBOLP (command
))
1245 ASET (command_remapping_vector
, 1, command
);
1246 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1249 /* Value is number if KEY is too long; nil if valid but has no definition. */
1250 /* GC is possible in this function if it autoloads a keymap. */
1252 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1253 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1254 nil means undefined. See doc of `define-key' for kinds of definitions.
1256 A number as value means KEY is "too long";
1257 that is, characters or symbols in it except for the last one
1258 fail to be a valid sequence of prefix characters in KEYMAP.
1259 The number is how many characters at the front of KEY
1260 it takes to reach a non-prefix key.
1262 Normally, `lookup-key' ignores bindings for t, which act as default
1263 bindings, used when nothing else in the keymap applies; this makes it
1264 usable as a general function for probing keymaps. However, if the
1265 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1266 recognize the default bindings, just as `read-key-sequence' does. */)
1267 (keymap
, key
, accept_default
)
1270 Lisp_Object accept_default
;
1273 register Lisp_Object cmd
;
1274 register Lisp_Object c
;
1276 int t_ok
= !NILP (accept_default
);
1277 struct gcpro gcpro1
, gcpro2
;
1279 GCPRO2 (keymap
, key
);
1280 keymap
= get_keymap (keymap
, 1, 1);
1282 if (!VECTORP (key
) && !STRINGP (key
))
1283 key
= wrong_type_argument (Qarrayp
, key
);
1285 length
= XFASTINT (Flength (key
));
1287 RETURN_UNGCPRO (keymap
);
1292 c
= Faref (key
, make_number (idx
++));
1294 if (CONSP (c
) && lucid_event_type_list_p (c
))
1295 c
= Fevent_convert_list (c
);
1297 /* Turn the 8th bit of string chars into a meta modifier. */
1298 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1299 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1301 /* Allow string since binding for `menu-bar-select-buffer'
1302 includes the buffer name in the key sequence. */
1303 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1304 error ("Key sequence contains invalid event");
1306 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1308 RETURN_UNGCPRO (cmd
);
1310 keymap
= get_keymap (cmd
, 0, 1);
1311 if (!CONSP (keymap
))
1312 RETURN_UNGCPRO (make_number (idx
));
1318 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1319 Assume that currently it does not define C at all.
1320 Return the keymap. */
1323 define_as_prefix (keymap
, c
)
1324 Lisp_Object keymap
, c
;
1328 cmd
= Fmake_sparse_keymap (Qnil
);
1329 /* If this key is defined as a prefix in an inherited keymap,
1330 make it a prefix in this map, and make its definition
1331 inherit the other prefix definition. */
1332 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1333 store_in_keymap (keymap
, c
, cmd
);
1338 /* Append a key to the end of a key sequence. We always make a vector. */
1341 append_key (key_sequence
, key
)
1342 Lisp_Object key_sequence
, key
;
1344 Lisp_Object args
[2];
1346 args
[0] = key_sequence
;
1348 args
[1] = Fcons (key
, Qnil
);
1349 return Fvconcat (2, args
);
1352 /* Given a event type C which is a symbol,
1353 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1356 silly_event_symbol_error (c
)
1359 Lisp_Object parsed
, base
, name
, assoc
;
1362 parsed
= parse_modifiers (c
);
1363 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1364 base
= XCAR (parsed
);
1365 name
= Fsymbol_name (base
);
1366 /* This alist includes elements such as ("RET" . "\\r"). */
1367 assoc
= Fassoc (name
, exclude_keys
);
1371 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1373 Lisp_Object keystring
;
1374 if (modifiers
& alt_modifier
)
1375 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1376 if (modifiers
& ctrl_modifier
)
1377 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1378 if (modifiers
& hyper_modifier
)
1379 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1380 if (modifiers
& meta_modifier
)
1381 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1382 if (modifiers
& shift_modifier
)
1383 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1384 if (modifiers
& super_modifier
)
1385 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1388 c
= reorder_modifiers (c
);
1389 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1391 error ((modifiers
& ~meta_modifier
1392 ? "To bind the key %s, use [?%s], not [%s]"
1393 : "To bind the key %s, use \"%s\", not [%s]"),
1394 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1395 SDATA (SYMBOL_NAME (c
)));
1399 /* Global, local, and minor mode keymap stuff. */
1401 /* We can't put these variables inside current_minor_maps, since under
1402 some systems, static gets macro-defined to be the empty string.
1404 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1405 static int cmm_size
= 0;
1407 /* Store a pointer to an array of the keymaps of the currently active
1408 minor modes in *buf, and return the number of maps it contains.
1410 This function always returns a pointer to the same buffer, and may
1411 free or reallocate it, so if you want to keep it for a long time or
1412 hand it out to lisp code, copy it. This procedure will be called
1413 for every key sequence read, so the nice lispy approach (return a
1414 new assoclist, list, what have you) for each invocation would
1415 result in a lot of consing over time.
1417 If we used xrealloc/xmalloc and ran out of memory, they would throw
1418 back to the command loop, which would try to read a key sequence,
1419 which would call this function again, resulting in an infinite
1420 loop. Instead, we'll use realloc/malloc and silently truncate the
1421 list, let the key sequence be read, and hope some other piece of
1422 code signals the error. */
1424 current_minor_maps (modeptr
, mapptr
)
1425 Lisp_Object
**modeptr
, **mapptr
;
1428 int list_number
= 0;
1429 Lisp_Object alist
, assoc
, var
, val
;
1430 Lisp_Object emulation_alists
;
1431 Lisp_Object lists
[2];
1433 emulation_alists
= Vemulation_mode_map_alists
;
1434 lists
[0] = Vminor_mode_overriding_map_alist
;
1435 lists
[1] = Vminor_mode_map_alist
;
1437 for (list_number
= 0; list_number
< 2; list_number
++)
1439 if (CONSP (emulation_alists
))
1441 alist
= XCAR (emulation_alists
);
1442 emulation_alists
= XCDR (emulation_alists
);
1443 if (SYMBOLP (alist
))
1444 alist
= find_symbol_value (alist
);
1448 alist
= lists
[list_number
];
1450 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1451 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1452 && (var
= XCAR (assoc
), SYMBOLP (var
))
1453 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1458 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1459 and also an entry in Vminor_mode_map_alist,
1460 ignore the latter. */
1461 if (list_number
== 1)
1463 val
= assq_no_quit (var
, lists
[0]);
1470 int newsize
, allocsize
;
1471 Lisp_Object
*newmodes
, *newmaps
;
1473 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1474 allocsize
= newsize
* sizeof *newmodes
;
1476 /* Use malloc here. See the comment above this function.
1477 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1479 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1484 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1487 cmm_modes
= newmodes
;
1490 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1495 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1502 if (newmodes
== NULL
|| newmaps
== NULL
)
1507 /* Get the keymap definition--or nil if it is not defined. */
1508 temp
= Findirect_function (XCDR (assoc
), Qt
);
1512 cmm_maps
[i
] = temp
;
1518 if (modeptr
) *modeptr
= cmm_modes
;
1519 if (mapptr
) *mapptr
= cmm_maps
;
1523 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1525 doc
: /* Return a list of the currently active keymaps.
1526 OLP if non-nil indicates that we should obey `overriding-local-map' and
1527 `overriding-terminal-local-map'. */)
1531 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1535 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1536 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1537 /* The doc said that overriding-terminal-local-map should
1538 override overriding-local-map. The code used them both,
1539 but it seems clearer to use just one. rms, jan 2005. */
1540 else if (!NILP (Voverriding_local_map
))
1541 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1543 if (NILP (XCDR (keymaps
)))
1549 /* This usually returns the buffer's local map,
1550 but that can be overridden by a `local-map' property. */
1551 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1553 keymaps
= Fcons (local
, keymaps
);
1555 /* Now put all the minor mode keymaps on the list. */
1556 nmaps
= current_minor_maps (0, &maps
);
1558 for (i
= --nmaps
; i
>= 0; i
--)
1559 if (!NILP (maps
[i
]))
1560 keymaps
= Fcons (maps
[i
], keymaps
);
1562 /* This returns nil unless there is a `keymap' property. */
1563 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1565 keymaps
= Fcons (local
, keymaps
);
1571 /* GC is possible in this function if it autoloads a keymap. */
1573 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1574 doc
: /* Return the binding for command KEY in current keymaps.
1575 KEY is a string or vector, a sequence of keystrokes.
1576 The binding is probably a symbol with a function definition.
1578 Normally, `key-binding' ignores bindings for t, which act as default
1579 bindings, used when nothing else in the keymap applies; this makes it
1580 usable as a general function for probing keymaps. However, if the
1581 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1582 recognize the default bindings, just as `read-key-sequence' does.
1584 Like the normal command loop, `key-binding' will remap the command
1585 resulting from looking up KEY by looking up the command in the
1586 current keymaps. However, if the optional third argument NO-REMAP
1587 is non-nil, `key-binding' returns the unmapped command. */)
1588 (key
, accept_default
, no_remap
)
1589 Lisp_Object key
, accept_default
, no_remap
;
1591 Lisp_Object
*maps
, value
;
1593 struct gcpro gcpro1
;
1597 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1599 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1600 key
, accept_default
);
1601 if (! NILP (value
) && !INTEGERP (value
))
1604 else if (!NILP (Voverriding_local_map
))
1606 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1607 if (! NILP (value
) && !INTEGERP (value
))
1614 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1617 value
= Flookup_key (local
, key
, accept_default
);
1618 if (! NILP (value
) && !INTEGERP (value
))
1622 nmaps
= current_minor_maps (0, &maps
);
1623 /* Note that all these maps are GCPRO'd
1624 in the places where we found them. */
1626 for (i
= 0; i
< nmaps
; i
++)
1627 if (! NILP (maps
[i
]))
1629 value
= Flookup_key (maps
[i
], key
, accept_default
);
1630 if (! NILP (value
) && !INTEGERP (value
))
1634 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1637 value
= Flookup_key (local
, key
, accept_default
);
1638 if (! NILP (value
) && !INTEGERP (value
))
1643 value
= Flookup_key (current_global_map
, key
, accept_default
);
1647 if (NILP (value
) || INTEGERP (value
))
1650 /* If the result of the ordinary keymap lookup is an interactive
1651 command, look for a key binding (ie. remapping) for that command. */
1653 if (NILP (no_remap
) && SYMBOLP (value
))
1656 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1663 /* GC is possible in this function if it autoloads a keymap. */
1665 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1666 doc
: /* Return the binding for command KEYS in current local keymap only.
1667 KEYS is a string or vector, a sequence of keystrokes.
1668 The binding is probably a symbol with a function definition.
1670 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1671 bindings; see the description of `lookup-key' for more details about this. */)
1672 (keys
, accept_default
)
1673 Lisp_Object keys
, accept_default
;
1675 register Lisp_Object map
;
1676 map
= current_buffer
->keymap
;
1679 return Flookup_key (map
, keys
, accept_default
);
1682 /* GC is possible in this function if it autoloads a keymap. */
1684 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1685 doc
: /* Return the binding for command KEYS in current global keymap only.
1686 KEYS is a string or vector, a sequence of keystrokes.
1687 The binding is probably a symbol with a function definition.
1688 This function's return values are the same as those of `lookup-key'
1691 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1692 bindings; see the description of `lookup-key' for more details about this. */)
1693 (keys
, accept_default
)
1694 Lisp_Object keys
, accept_default
;
1696 return Flookup_key (current_global_map
, keys
, accept_default
);
1699 /* GC is possible in this function if it autoloads a keymap. */
1701 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1702 doc
: /* Find the visible minor mode bindings of KEY.
1703 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1704 the symbol which names the minor mode binding KEY, and BINDING is
1705 KEY's definition in that mode. In particular, if KEY has no
1706 minor-mode bindings, return nil. If the first binding is a
1707 non-prefix, all subsequent bindings will be omitted, since they would
1708 be ignored. Similarly, the list doesn't include non-prefix bindings
1709 that come after prefix bindings.
1711 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1712 bindings; see the description of `lookup-key' for more details about this. */)
1713 (key
, accept_default
)
1714 Lisp_Object key
, accept_default
;
1716 Lisp_Object
*modes
, *maps
;
1718 Lisp_Object binding
;
1720 struct gcpro gcpro1
, gcpro2
;
1722 nmaps
= current_minor_maps (&modes
, &maps
);
1723 /* Note that all these maps are GCPRO'd
1724 in the places where we found them. */
1727 GCPRO2 (key
, binding
);
1729 for (i
= j
= 0; i
< nmaps
; i
++)
1731 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1732 && !INTEGERP (binding
))
1734 if (KEYMAPP (binding
))
1735 maps
[j
++] = Fcons (modes
[i
], binding
);
1737 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1741 return Flist (j
, maps
);
1744 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1745 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1746 A new sparse keymap is stored as COMMAND's function definition and its value.
1747 If a second optional argument MAPVAR is given, the map is stored as
1748 its value instead of as COMMAND's value; but COMMAND is still defined
1750 The third optional argument NAME, if given, supplies a menu name
1751 string for the map. This is required to use the keymap as a menu.
1752 This function returns COMMAND. */)
1753 (command
, mapvar
, name
)
1754 Lisp_Object command
, mapvar
, name
;
1757 map
= Fmake_sparse_keymap (name
);
1758 Ffset (command
, map
);
1762 Fset (command
, map
);
1766 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1767 doc
: /* Select KEYMAP as the global keymap. */)
1771 keymap
= get_keymap (keymap
, 1, 1);
1772 current_global_map
= keymap
;
1777 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1778 doc
: /* Select KEYMAP as the local keymap.
1779 If KEYMAP is nil, that means no local keymap. */)
1784 keymap
= get_keymap (keymap
, 1, 1);
1786 current_buffer
->keymap
= keymap
;
1791 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1792 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1795 return current_buffer
->keymap
;
1798 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1799 doc
: /* Return the current global keymap. */)
1802 return current_global_map
;
1805 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1806 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1810 int nmaps
= current_minor_maps (0, &maps
);
1812 return Flist (nmaps
, maps
);
1815 /* Help functions for describing and documenting keymaps. */
1819 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1820 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1821 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1825 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1829 /* Look for and break cycles. */
1830 while (!NILP (tem
= Frassq (cmd
, maps
)))
1832 Lisp_Object prefix
= XCAR (tem
);
1833 int lim
= XINT (Flength (XCAR (tem
)));
1834 if (lim
<= XINT (Flength (thisseq
)))
1835 { /* This keymap was already seen with a smaller prefix. */
1837 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1838 Faref (thisseq
, make_number (i
))))
1841 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1844 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1845 but maybe `cmd' occurs again further down in `maps', so keep
1847 maps
= XCDR (Fmemq (tem
, maps
));
1850 /* If the last key in thisseq is meta-prefix-char,
1851 turn it into a meta-ized keystroke. We know
1852 that the event we're about to append is an
1853 ascii keystroke since we're processing a
1857 int meta_bit
= meta_modifier
;
1858 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1859 tem
= Fcopy_sequence (thisseq
);
1861 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1863 /* This new sequence is the same length as
1864 thisseq, so stick it in the list right
1867 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1871 tem
= append_key (thisseq
, key
);
1872 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1877 accessible_keymaps_char_table (args
, index
, cmd
)
1878 Lisp_Object args
, index
, cmd
;
1880 accessible_keymaps_1 (index
, cmd
,
1884 XINT (XCDR (XCAR (args
))));
1887 /* This function cannot GC. */
1889 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1891 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1892 Returns a list of elements of the form (KEYS . MAP), where the sequence
1893 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1894 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1895 An optional argument PREFIX, if non-nil, should be a key sequence;
1896 then the value includes only maps for prefixes that start with PREFIX. */)
1898 Lisp_Object keymap
, prefix
;
1900 Lisp_Object maps
, tail
;
1903 /* no need for gcpro because we don't autoload any keymaps. */
1906 prefixlen
= XINT (Flength (prefix
));
1910 /* If a prefix was specified, start with the keymap (if any) for
1911 that prefix, so we don't waste time considering other prefixes. */
1913 tem
= Flookup_key (keymap
, prefix
, Qt
);
1914 /* Flookup_key may give us nil, or a number,
1915 if the prefix is not defined in this particular map.
1916 It might even give us a list that isn't a keymap. */
1917 tem
= get_keymap (tem
, 0, 0);
1920 /* Convert PREFIX to a vector now, so that later on
1921 we don't have to deal with the possibility of a string. */
1922 if (STRINGP (prefix
))
1927 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1928 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1932 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1933 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1934 c
^= 0200 | meta_modifier
;
1935 ASET (copy
, i_before
, make_number (c
));
1939 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1945 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1946 get_keymap (keymap
, 1, 0)),
1949 /* For each map in the list maps,
1950 look at any other maps it points to,
1951 and stick them at the end if they are not already in the list.
1953 This is a breadth-first traversal, where tail is the queue of
1954 nodes, and maps accumulates a list of all nodes visited. */
1956 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1958 register Lisp_Object thisseq
, thismap
;
1960 /* Does the current sequence end in the meta-prefix-char? */
1963 thisseq
= Fcar (Fcar (tail
));
1964 thismap
= Fcdr (Fcar (tail
));
1965 last
= make_number (XINT (Flength (thisseq
)) - 1);
1966 is_metized
= (XINT (last
) >= 0
1967 /* Don't metize the last char of PREFIX. */
1968 && XINT (last
) >= prefixlen
1969 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1971 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1975 elt
= XCAR (thismap
);
1979 if (CHAR_TABLE_P (elt
))
1981 map_char_table (accessible_keymaps_char_table
, Qnil
,
1982 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1983 Fcons (tail
, thisseq
)));
1985 else if (VECTORP (elt
))
1989 /* Vector keymap. Scan all the elements. */
1990 for (i
= 0; i
< ASIZE (elt
); i
++)
1991 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1992 maps
, tail
, thisseq
, is_metized
);
1995 else if (CONSP (elt
))
1996 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1997 maps
, tail
, thisseq
,
1998 is_metized
&& INTEGERP (XCAR (elt
)));
2006 Lisp_Object Qsingle_key_description
, Qkey_description
;
2008 /* This function cannot GC. */
2010 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2011 doc
: /* Return a pretty description of key-sequence KEYS.
2012 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2013 Control characters turn into "C-foo" sequences, meta into "M-foo",
2014 spaces are put between sequence elements, etc. */)
2016 Lisp_Object keys
, prefix
;
2021 int size
= XINT (Flength (keys
));
2023 Lisp_Object sep
= build_string (" ");
2028 size
+= XINT (Flength (prefix
));
2030 /* This has one extra element at the end that we don't pass to Fconcat. */
2031 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2033 /* In effect, this computes
2034 (mapconcat 'single-key-description keys " ")
2035 but we shouldn't use mapconcat because it can do GC. */
2039 list
= prefix
, prefix
= Qnil
;
2040 else if (!NILP (keys
))
2041 list
= keys
, keys
= Qnil
;
2046 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2050 return empty_string
;
2051 return Fconcat (len
- 1, args
);
2055 size
= SCHARS (list
);
2056 else if (VECTORP (list
))
2057 size
= XVECTOR (list
)->size
;
2058 else if (CONSP (list
))
2059 size
= XINT (Flength (list
));
2061 wrong_type_argument (Qarrayp
, list
);
2070 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2071 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2072 c
^= 0200 | meta_modifier
;
2073 XSETFASTINT (key
, c
);
2075 else if (VECTORP (list
))
2077 key
= AREF (list
, i
++);
2089 || EQ (key
, meta_prefix_char
)
2090 || (XINT (key
) & meta_modifier
))
2092 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2094 if (EQ (key
, meta_prefix_char
))
2098 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2101 else if (EQ (key
, meta_prefix_char
))
2106 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2114 push_key_description (c
, p
, force_multibyte
)
2115 register unsigned int c
;
2117 int force_multibyte
;
2121 /* Clear all the meaningless bits above the meta bit. */
2122 c
&= meta_modifier
| ~ - meta_modifier
;
2123 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2124 | meta_modifier
| shift_modifier
| super_modifier
);
2126 if (c
& alt_modifier
)
2132 if ((c
& ctrl_modifier
) != 0
2133 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2137 c
&= ~ctrl_modifier
;
2139 if (c
& hyper_modifier
)
2143 c
-= hyper_modifier
;
2145 if (c
& meta_modifier
)
2151 if (c
& shift_modifier
)
2155 c
-= shift_modifier
;
2157 if (c
& super_modifier
)
2161 c
-= super_modifier
;
2177 else if (c
== Ctl ('M'))
2185 /* `C-' already added above. */
2186 if (c
> 0 && c
<= Ctl ('Z'))
2205 || (NILP (current_buffer
->enable_multibyte_characters
)
2206 && SINGLE_BYTE_CHAR_P (c
)
2207 && !force_multibyte
))
2211 else if (CHARACTERP (make_number (c
)))
2213 if (NILP (current_buffer
->enable_multibyte_characters
)
2214 && ! force_multibyte
)
2215 *p
++ = multibyte_char_to_unibyte (c
, Qnil
);
2217 p
+= CHAR_STRING (c
, (unsigned char *) p
);
2223 /* The biggest character code uses 22 bits. */
2224 for (bit_offset
= 21; bit_offset
>= 0; bit_offset
-= 3)
2226 if (c
>= (1 << bit_offset
))
2227 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2234 /* This function cannot GC. */
2236 DEFUN ("single-key-description", Fsingle_key_description
,
2237 Ssingle_key_description
, 1, 2, 0,
2238 doc
: /* Return a pretty description of command character KEY.
2239 Control characters turn into C-whatever, etc.
2240 Optional argument NO-ANGLES non-nil means don't put angle brackets
2241 around function keys and event symbols. */)
2243 Lisp_Object key
, no_angles
;
2245 if (CONSP (key
) && lucid_event_type_list_p (key
))
2246 key
= Fevent_convert_list (key
);
2248 key
= EVENT_HEAD (key
);
2250 if (INTEGERP (key
)) /* Normal character */
2252 char tem
[KEY_DESCRIPTION_SIZE
];
2254 *push_key_description (XUINT (key
), tem
, 1) = 0;
2255 return build_string (tem
);
2257 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2259 if (NILP (no_angles
))
2262 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2263 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2264 return build_string (buffer
);
2267 return Fsymbol_name (key
);
2269 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2270 return Fcopy_sequence (key
);
2272 error ("KEY must be an integer, cons, symbol, or string");
2277 push_text_char_description (c
, p
)
2278 register unsigned int c
;
2290 *p
++ = c
+ 64; /* 'A' - 1 */
2302 /* This function cannot GC. */
2304 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2305 doc
: /* Return a pretty description of file-character CHARACTER.
2306 Control characters turn into "^char", etc. This differs from
2307 `single-key-description' which turns them into "C-char".
2308 Also, this function recognizes the 2**7 bit as the Meta character,
2309 whereas `single-key-description' uses the 2**27 bit for Meta.
2310 See Info node `(elisp)Describing Characters' for examples. */)
2312 Lisp_Object character
;
2314 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2315 unsigned char str
[6];
2318 CHECK_NUMBER (character
);
2320 c
= XINT (character
);
2321 if (!ASCII_CHAR_P (c
))
2323 int len
= CHAR_STRING (c
, str
);
2325 return make_multibyte_string (str
, 1, len
);
2328 *push_text_char_description (c
& 0377, str
) = 0;
2330 return build_string (str
);
2333 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2336 ascii_sequence_p (seq
)
2340 int len
= XINT (Flength (seq
));
2342 for (i
= 0; i
< len
; i
++)
2344 Lisp_Object ii
, elt
;
2346 XSETFASTINT (ii
, i
);
2347 elt
= Faref (seq
, ii
);
2350 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2358 /* where-is - finding a command in a set of keymaps. */
2360 static Lisp_Object
where_is_internal ();
2361 static Lisp_Object
where_is_internal_1 ();
2362 static void where_is_internal_2 ();
2364 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2365 Returns the first non-nil binding found in any of those maps. */
2368 shadow_lookup (shadow
, key
, flag
)
2369 Lisp_Object shadow
, key
, flag
;
2371 Lisp_Object tail
, value
;
2373 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2375 value
= Flookup_key (XCAR (tail
), key
, flag
);
2376 if (NATNUMP (value
))
2378 value
= Flookup_key (XCAR (tail
),
2379 Fsubstring (key
, make_number (0), value
), flag
);
2383 else if (!NILP (value
))
2389 static Lisp_Object Vmouse_events
;
2391 /* This function can GC if Flookup_key autoloads any keymaps. */
2394 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2395 Lisp_Object definition
, keymaps
;
2396 Lisp_Object firstonly
, noindirect
, no_remap
;
2398 Lisp_Object maps
= Qnil
;
2399 Lisp_Object found
, sequences
;
2400 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2401 /* 1 means ignore all menu bindings entirely. */
2402 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2404 /* If this command is remapped, then it has no key bindings
2406 if (NILP (no_remap
) && SYMBOLP (definition
))
2409 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2414 while (CONSP (found
))
2418 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2419 found
= XCDR (found
);
2422 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2426 for (; !NILP (maps
); maps
= Fcdr (maps
))
2428 /* Key sequence to reach map, and the map that it reaches */
2429 register Lisp_Object
this, map
, tem
;
2431 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2432 [M-CHAR] sequences, check if last character of the sequence
2433 is the meta-prefix char. */
2437 this = Fcar (Fcar (maps
));
2438 map
= Fcdr (Fcar (maps
));
2439 last
= make_number (XINT (Flength (this)) - 1);
2440 last_is_meta
= (XINT (last
) >= 0
2441 && EQ (Faref (this, last
), meta_prefix_char
));
2443 /* if (nomenus && !ascii_sequence_p (this)) */
2444 if (nomenus
&& XINT (last
) >= 0
2445 && SYMBOLP (tem
= Faref (this, make_number (0)))
2446 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2447 /* If no menu entries should be returned, skip over the
2448 keymaps bound to `menu-bar' and `tool-bar' and other
2449 non-ascii prefixes like `C-down-mouse-2'. */
2456 /* Because the code we want to run on each binding is rather
2457 large, we don't want to have two separate loop bodies for
2458 sparse keymap bindings and tables; we want to iterate one
2459 loop body over both keymap and vector bindings.
2461 For this reason, if Fcar (map) is a vector, we don't
2462 advance map to the next element until i indicates that we
2463 have finished off the vector. */
2464 Lisp_Object elt
, key
, binding
;
2472 /* Set key and binding to the current key and binding, and
2473 advance map and i to the next binding. */
2476 Lisp_Object sequence
;
2478 /* In a vector, look at each element. */
2479 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2481 binding
= AREF (elt
, i
);
2482 XSETFASTINT (key
, i
);
2483 sequence
= where_is_internal_1 (binding
, key
, definition
,
2485 last
, nomenus
, last_is_meta
);
2486 if (!NILP (sequence
))
2487 sequences
= Fcons (sequence
, sequences
);
2490 else if (CHAR_TABLE_P (elt
))
2494 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2495 Qnil
), /* Result accumulator. */
2496 Fcons (Fcons (this, last
),
2497 Fcons (make_number (nomenus
),
2498 make_number (last_is_meta
))));
2499 map_char_table (where_is_internal_2
, Qnil
, elt
, args
);
2500 sequences
= XCDR (XCAR (args
));
2502 else if (CONSP (elt
))
2504 Lisp_Object sequence
;
2507 binding
= XCDR (elt
);
2509 sequence
= where_is_internal_1 (binding
, key
, definition
,
2511 last
, nomenus
, last_is_meta
);
2512 if (!NILP (sequence
))
2513 sequences
= Fcons (sequence
, sequences
);
2517 while (!NILP (sequences
))
2519 Lisp_Object sequence
, remapped
, function
;
2521 sequence
= XCAR (sequences
);
2522 sequences
= XCDR (sequences
);
2524 /* If the current sequence is a command remapping with
2525 format [remap COMMAND], find the key sequences
2526 which run COMMAND, and use those sequences instead. */
2529 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2530 && EQ (AREF (sequence
, 0), Qremap
)
2531 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2533 Lisp_Object remapped1
;
2535 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2536 if (CONSP (remapped1
))
2538 /* Verify that this key binding actually maps to the
2539 remapped command (see below). */
2540 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2542 sequence
= XCAR (remapped1
);
2543 remapped
= XCDR (remapped1
);
2544 goto record_sequence
;
2548 /* Verify that this key binding is not shadowed by another
2549 binding for the same key, before we say it exists.
2551 Mechanism: look for local definition of this key and if
2552 it is defined and does not match what we found then
2555 Either nil or number as value from Flookup_key
2557 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2561 /* Don't annoy user with strings from a menu such as
2562 Select Paste. Change them all to "(any string)",
2563 so that there seems to be only one menu item
2565 if (! NILP (sequence
))
2568 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2570 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2571 build_string ("(any string)"));
2574 /* It is a true unshadowed match. Record it, unless it's already
2575 been seen (as could happen when inheriting keymaps). */
2576 if (NILP (Fmember (sequence
, found
)))
2577 found
= Fcons (sequence
, found
);
2579 /* If firstonly is Qnon_ascii, then we can return the first
2580 binding we find. If firstonly is not Qnon_ascii but not
2581 nil, then we should return the first ascii-only binding
2583 if (EQ (firstonly
, Qnon_ascii
))
2584 RETURN_UNGCPRO (sequence
);
2585 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2586 RETURN_UNGCPRO (sequence
);
2588 if (CONSP (remapped
))
2590 sequence
= XCAR (remapped
);
2591 remapped
= XCDR (remapped
);
2592 goto record_sequence
;
2600 found
= Fnreverse (found
);
2602 /* firstonly may have been t, but we may have gone all the way through
2603 the keymaps without finding an all-ASCII key sequence. So just
2604 return the best we could find. */
2605 if (!NILP (firstonly
))
2606 return Fcar (found
);
2611 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2612 doc
: /* Return list of keys that invoke DEFINITION.
2613 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2614 If KEYMAP is nil, search all the currently active keymaps.
2615 If KEYMAP is a list of keymaps, search only those keymaps.
2617 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2618 rather than a list of all possible key sequences.
2619 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2620 no matter what it is.
2621 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2622 \(or their meta variants) and entirely reject menu bindings.
2624 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2625 to other keymaps or slots. This makes it possible to search for an
2626 indirect definition itself.
2628 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2629 that invoke a command which is remapped to DEFINITION, but include the
2630 remapped command in the returned list. */)
2631 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2632 Lisp_Object definition
, keymap
;
2633 Lisp_Object firstonly
, noindirect
, no_remap
;
2635 Lisp_Object sequences
, keymaps
;
2636 /* 1 means ignore all menu bindings entirely. */
2637 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2640 /* Find the relevant keymaps. */
2641 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2643 else if (!NILP (keymap
))
2644 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2646 keymaps
= Fcurrent_active_maps (Qnil
);
2648 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2649 We don't really need to check `keymap'. */
2650 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2654 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2656 /* Check heuristic-consistency of the cache. */
2657 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2658 where_is_cache
= Qnil
;
2660 if (NILP (where_is_cache
))
2662 /* We need to create the cache. */
2663 Lisp_Object args
[2];
2664 where_is_cache
= Fmake_hash_table (0, args
);
2665 where_is_cache_keymaps
= Qt
;
2667 /* Fill in the cache. */
2668 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2669 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2672 where_is_cache_keymaps
= keymaps
;
2675 /* We want to process definitions from the last to the first.
2676 Instead of consing, copy definitions to a vector and step
2677 over that vector. */
2678 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2679 n
= XINT (Flength (sequences
));
2680 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2681 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2682 defns
[i
++] = XCAR (sequences
);
2684 /* Verify that the key bindings are not shadowed. Note that
2685 the following can GC. */
2686 GCPRO2 (definition
, keymaps
);
2689 for (i
= n
- 1; i
>= 0; --i
)
2690 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2692 if (ascii_sequence_p (defns
[i
]))
2698 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2703 /* Kill the cache so that where_is_internal_1 doesn't think
2704 we're filling it up. */
2705 where_is_cache
= Qnil
;
2706 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2712 /* This is the function that Fwhere_is_internal calls using map_char_table.
2714 (((DEFINITION . NOINDIRECT) . RESULT)
2716 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2717 Since map_char_table doesn't really use the return value from this function,
2718 we the result append to RESULT, the slot in ARGS.
2720 KEY may be a cons (FROM . TO) where both FROM and TO are integers
2721 (i.e. character events).
2723 This function can GC because it calls where_is_internal_1 which can
2727 where_is_internal_2 (args
, key
, binding
)
2728 Lisp_Object args
, key
, binding
;
2730 Lisp_Object definition
, noindirect
, this, last
;
2731 Lisp_Object result
, sequence
;
2732 int nomenus
, last_is_meta
;
2733 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2735 GCPRO3 (args
, key
, binding
);
2736 definition
= XCAR (XCAR (XCAR (args
)));
2737 noindirect
= XCDR (XCAR (XCAR (args
)));
2738 this = XCAR (XCAR (XCDR (args
)));
2739 last
= XCDR (XCAR (XCDR (args
)));
2740 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2741 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2744 if (CONSP (key
) && INTEGERP (XCAR (key
)) && INTEGERP (XCDR (key
)))
2746 /* Try all ASCII characters. Try also non-ASCII characters but
2747 only the first and last one because trying all of them is
2748 extremely memory and time consuming.
2750 Fixme: Perhaps it should be allowed to store a cons directly
2751 in RESULT. -- handa@m17n.org */
2752 int from
= XINT (XCAR (key
)), to
= XINT (XCDR (key
));
2755 for (; from
<= to
; to
--)
2757 k
= make_number (to
);
2758 sequence
= where_is_internal_1 (binding
, k
, definition
, noindirect
,
2759 this, last
, nomenus
, last_is_meta
);
2760 if (!NILP (sequence
))
2761 result
= Fcons (sequence
, result
);
2768 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2769 this, last
, nomenus
, last_is_meta
);
2770 if (!NILP (sequence
))
2771 result
= Fcons (sequence
, Qnil
);
2774 if (! NILP (result
))
2775 nconc2 (XCAR (args
), result
);
2781 /* This function can GC because get_keyelt can. */
2784 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2785 nomenus
, last_is_meta
)
2786 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2787 int nomenus
, last_is_meta
;
2789 Lisp_Object sequence
;
2791 /* Search through indirections unless that's not wanted. */
2792 if (NILP (noindirect
))
2793 binding
= get_keyelt (binding
, 0);
2795 /* End this iteration if this element does not match
2798 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2799 || EQ (binding
, definition
)
2800 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2801 /* Doesn't match. */
2804 /* We have found a match. Construct the key sequence where we found it. */
2805 if (INTEGERP (key
) && last_is_meta
)
2807 sequence
= Fcopy_sequence (this);
2808 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2811 sequence
= append_key (this, key
);
2813 if (!NILP (where_is_cache
))
2815 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2816 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2823 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2825 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2826 doc
: /* Insert the list of all defined keys and their definitions.
2827 The list is inserted in the current buffer, while the bindings are
2828 looked up in BUFFER.
2829 The optional argument PREFIX, if non-nil, should be a key sequence;
2830 then we display only bindings that start with that prefix.
2831 The optional argument MENUS, if non-nil, says to mention menu bindings.
2832 \(Ordinarily these are omitted from the output.) */)
2833 (buffer
, prefix
, menus
)
2834 Lisp_Object buffer
, prefix
, menus
;
2836 Lisp_Object outbuf
, shadow
;
2837 int nomenu
= NILP (menus
);
2838 register Lisp_Object start1
;
2839 struct gcpro gcpro1
;
2841 char *alternate_heading
2843 Keyboard translations:\n\n\
2844 You type Translation\n\
2845 -------- -----------\n";
2850 outbuf
= Fcurrent_buffer ();
2852 /* Report on alternates for keys. */
2853 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2856 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2857 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2859 for (c
= 0; c
< translate_len
; c
++)
2860 if (translate
[c
] != c
)
2862 char buf
[KEY_DESCRIPTION_SIZE
];
2865 if (alternate_heading
)
2867 insert_string (alternate_heading
);
2868 alternate_heading
= 0;
2871 bufend
= push_key_description (translate
[c
], buf
, 1);
2872 insert (buf
, bufend
- buf
);
2873 Findent_to (make_number (16), make_number (1));
2874 bufend
= push_key_description (c
, buf
, 1);
2875 insert (buf
, bufend
- buf
);
2879 /* Insert calls signal_after_change which may GC. */
2880 translate
= SDATA (Vkeyboard_translate_table
);
2886 if (!NILP (Vkey_translation_map
))
2887 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2888 "Key translations", nomenu
, 1, 0, 0);
2891 /* Print the (major mode) local map. */
2893 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2894 start1
= current_kboard
->Voverriding_terminal_local_map
;
2895 else if (!NILP (Voverriding_local_map
))
2896 start1
= Voverriding_local_map
;
2900 describe_map_tree (start1
, 1, shadow
, prefix
,
2901 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2902 shadow
= Fcons (start1
, shadow
);
2906 /* Print the minor mode and major mode keymaps. */
2908 Lisp_Object
*modes
, *maps
;
2910 /* Temporarily switch to `buffer', so that we can get that buffer's
2911 minor modes correctly. */
2912 Fset_buffer (buffer
);
2914 nmaps
= current_minor_maps (&modes
, &maps
);
2915 Fset_buffer (outbuf
);
2917 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2918 XBUFFER (buffer
), Qkeymap
);
2921 describe_map_tree (start1
, 1, shadow
, prefix
,
2922 "\f\n`keymap' Property Bindings", nomenu
,
2924 shadow
= Fcons (start1
, shadow
);
2927 /* Print the minor mode maps. */
2928 for (i
= 0; i
< nmaps
; i
++)
2930 /* The title for a minor mode keymap
2931 is constructed at run time.
2932 We let describe_map_tree do the actual insertion
2933 because it takes care of other features when doing so. */
2936 if (!SYMBOLP (modes
[i
]))
2939 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2943 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2944 SCHARS (SYMBOL_NAME (modes
[i
])));
2945 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2947 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2948 p
+= sizeof (" Minor Mode Bindings") - 1;
2951 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2952 title
, nomenu
, 0, 0, 0);
2953 shadow
= Fcons (maps
[i
], shadow
);
2956 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2957 XBUFFER (buffer
), Qlocal_map
);
2960 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2961 describe_map_tree (start1
, 1, shadow
, prefix
,
2962 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2964 describe_map_tree (start1
, 1, shadow
, prefix
,
2965 "\f\n`local-map' Property Bindings",
2968 shadow
= Fcons (start1
, shadow
);
2972 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2973 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2975 /* Print the function-key-map translations under this prefix. */
2976 if (!NILP (Vfunction_key_map
))
2977 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2978 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2984 /* Insert a description of the key bindings in STARTMAP,
2985 followed by those of all maps reachable through STARTMAP.
2986 If PARTIAL is nonzero, omit certain "uninteresting" commands
2987 (such as `undefined').
2988 If SHADOW is non-nil, it is a list of maps;
2989 don't mention keys which would be shadowed by any of them.
2990 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2991 TITLE, if not 0, is a string to insert at the beginning.
2992 TITLE should not end with a colon or a newline; we supply that.
2993 If NOMENU is not 0, then omit menu-bar commands.
2995 If TRANSL is nonzero, the definitions are actually key translations
2996 so print strings and vectors differently.
2998 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
3001 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
3002 don't omit it; instead, mention it but say it is shadowed. */
3005 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
3006 always_title
, mention_shadow
)
3007 Lisp_Object startmap
, shadow
, prefix
;
3015 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
3016 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3023 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3026 GCPRO3 (maps
, seen
, sub_shadows
);
3032 /* Delete from MAPS each element that is for the menu bar. */
3033 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3035 Lisp_Object elt
, prefix
, tem
;
3038 prefix
= Fcar (elt
);
3039 if (XVECTOR (prefix
)->size
>= 1)
3041 tem
= Faref (prefix
, make_number (0));
3042 if (EQ (tem
, Qmenu_bar
))
3043 maps
= Fdelq (elt
, maps
);
3048 if (!NILP (maps
) || always_title
)
3052 insert_string (title
);
3055 insert_string (" Starting With ");
3056 insert1 (Fkey_description (prefix
, Qnil
));
3058 insert_string (":\n");
3060 insert_string (key_heading
);
3064 for (; !NILP (maps
); maps
= Fcdr (maps
))
3066 register Lisp_Object elt
, prefix
, tail
;
3069 prefix
= Fcar (elt
);
3073 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3077 shmap
= XCAR (tail
);
3079 /* If the sequence by which we reach this keymap is zero-length,
3080 then the shadow map for this keymap is just SHADOW. */
3081 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3082 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3084 /* If the sequence by which we reach this keymap actually has
3085 some elements, then the sequence's definition in SHADOW is
3086 what we should use. */
3089 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3090 if (INTEGERP (shmap
))
3094 /* If shmap is not nil and not a keymap,
3095 it completely shadows this map, so don't
3096 describe this map at all. */
3097 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3101 sub_shadows
= Fcons (shmap
, sub_shadows
);
3104 /* Maps we have already listed in this loop shadow this map. */
3105 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3108 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3110 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3113 describe_map (Fcdr (elt
), prefix
,
3114 transl
? describe_translation
: describe_command
,
3115 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3121 insert_string ("\n");
3126 static int previous_description_column
;
3129 describe_command (definition
, args
)
3130 Lisp_Object definition
, args
;
3132 register Lisp_Object tem1
;
3133 int column
= (int) current_column (); /* iftc */
3134 int description_column
;
3136 /* If column 16 is no good, go to col 32;
3137 but don't push beyond that--go to next line instead. */
3141 description_column
= 32;
3143 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3144 description_column
= 32;
3146 description_column
= 16;
3148 Findent_to (make_number (description_column
), make_number (1));
3149 previous_description_column
= description_column
;
3151 if (SYMBOLP (definition
))
3153 tem1
= SYMBOL_NAME (definition
);
3155 insert_string ("\n");
3157 else if (STRINGP (definition
) || VECTORP (definition
))
3158 insert_string ("Keyboard Macro\n");
3159 else if (KEYMAPP (definition
))
3160 insert_string ("Prefix Command\n");
3162 insert_string ("??\n");
3166 describe_translation (definition
, args
)
3167 Lisp_Object definition
, args
;
3169 register Lisp_Object tem1
;
3171 Findent_to (make_number (16), make_number (1));
3173 if (SYMBOLP (definition
))
3175 tem1
= SYMBOL_NAME (definition
);
3177 insert_string ("\n");
3179 else if (STRINGP (definition
) || VECTORP (definition
))
3181 insert1 (Fkey_description (definition
, Qnil
));
3182 insert_string ("\n");
3184 else if (KEYMAPP (definition
))
3185 insert_string ("Prefix Command\n");
3187 insert_string ("??\n");
3190 /* describe_map puts all the usable elements of a sparse keymap
3191 into an array of `struct describe_map_elt',
3192 then sorts them by the events. */
3194 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3196 /* qsort comparison function for sorting `struct describe_map_elt' by
3200 describe_map_compare (aa
, bb
)
3201 const void *aa
, *bb
;
3203 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3204 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3205 return ((XINT (a
->event
) > XINT (b
->event
))
3206 - (XINT (a
->event
) < XINT (b
->event
)));
3207 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3209 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3211 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3212 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3213 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3218 /* Describe the contents of map MAP, assuming that this map itself is
3219 reached by the sequence of prefix keys PREFIX (a string or vector).
3220 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3223 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3224 seen
, nomenu
, mention_shadow
)
3225 register Lisp_Object map
;
3227 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3234 Lisp_Object tail
, definition
, event
;
3236 Lisp_Object suppress
;
3239 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3241 /* These accumulate the values from sparse keymap bindings,
3242 so we can sort them and handle them in order. */
3243 int length_needed
= 0;
3244 struct describe_map_elt
*vect
;
3251 suppress
= intern ("suppress-keymap");
3253 /* This vector gets used to present single keys to Flookup_key. Since
3254 that is done once per keymap element, we don't want to cons up a
3255 fresh vector every time. */
3256 kludge
= Fmake_vector (make_number (1), Qnil
);
3259 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3262 vect
= ((struct describe_map_elt
*)
3263 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3265 GCPRO3 (prefix
, definition
, kludge
);
3267 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3271 if (VECTORP (XCAR (tail
))
3272 || CHAR_TABLE_P (XCAR (tail
)))
3273 describe_vector (XCAR (tail
),
3274 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3275 (int *)0, 0, 1, mention_shadow
);
3276 else if (CONSP (XCAR (tail
)))
3278 int this_shadowed
= 0;
3280 event
= XCAR (XCAR (tail
));
3282 /* Ignore bindings whose "prefix" are not really valid events.
3283 (We get these in the frames and buffers menu.) */
3284 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3287 if (nomenu
&& EQ (event
, Qmenu_bar
))
3290 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3292 /* Don't show undefined commands or suppressed commands. */
3293 if (NILP (definition
)) continue;
3294 if (SYMBOLP (definition
) && partial
)
3296 tem
= Fget (definition
, suppress
);
3301 /* Don't show a command that isn't really visible
3302 because a local definition of the same key shadows it. */
3304 ASET (kludge
, 0, event
);
3307 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3317 tem
= Flookup_key (map
, kludge
, Qt
);
3318 if (!EQ (tem
, definition
)) continue;
3320 vect
[slots_used
].event
= event
;
3321 vect
[slots_used
].definition
= definition
;
3322 vect
[slots_used
].shadowed
= this_shadowed
;
3325 else if (EQ (XCAR (tail
), Qkeymap
))
3327 /* The same keymap might be in the structure twice, if we're
3328 using an inherited keymap. So skip anything we've already
3330 tem
= Fassq (tail
, *seen
);
3331 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3333 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3337 /* If we found some sparse map events, sort them. */
3339 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3340 describe_map_compare
);
3342 /* Now output them in sorted order. */
3344 for (i
= 0; i
< slots_used
; i
++)
3346 Lisp_Object start
, end
;
3350 previous_description_column
= 0;
3355 ASET (kludge
, 0, vect
[i
].event
);
3356 start
= vect
[i
].event
;
3359 definition
= vect
[i
].definition
;
3361 /* Find consecutive chars that are identically defined. */
3362 if (INTEGERP (vect
[i
].event
))
3364 while (i
+ 1 < slots_used
3365 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3366 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3367 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3369 end
= vect
[i
].event
;
3372 /* Now START .. END is the range to describe next. */
3374 /* Insert the string to describe the event START. */
3375 insert1 (Fkey_description (kludge
, prefix
));
3377 if (!EQ (start
, end
))
3381 ASET (kludge
, 0, end
);
3382 /* Insert the string to describe the character END. */
3383 insert1 (Fkey_description (kludge
, prefix
));
3386 /* Print a description of the definition of this character.
3387 elt_describer will take care of spacing out far enough
3388 for alignment purposes. */
3389 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3391 if (vect
[i
].shadowed
)
3394 insert_string ("\n (that binding is currently shadowed by another mode)");
3403 describe_vector_princ (elt
, fun
)
3404 Lisp_Object elt
, fun
;
3406 Findent_to (make_number (16), make_number (1));
3411 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3412 doc
: /* Insert a description of contents of VECTOR.
3413 This is text showing the elements of vector matched against indices.
3414 DESCRIBER is the output function used; nil means use `princ'. */)
3416 Lisp_Object vector
, describer
;
3418 int count
= SPECPDL_INDEX ();
3419 if (NILP (describer
))
3420 describer
= intern ("princ");
3421 specbind (Qstandard_output
, Fcurrent_buffer ());
3422 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3423 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3424 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3426 return unbind_to (count
, Qnil
);
3429 /* Insert in the current buffer a description of the contents of VECTOR.
3430 We call ELT_DESCRIBER to insert the description of one value found
3433 ELT_PREFIX describes what "comes before" the keys or indices defined
3434 by this vector. This is a human-readable string whose size
3435 is not necessarily related to the situation.
3437 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3438 leads to this keymap.
3440 If the vector is a chartable, ELT_PREFIX is the vector
3441 of bytes that lead to the character set or portion of a character
3442 set described by this chartable.
3444 If PARTIAL is nonzero, it means do not mention suppressed commands
3445 (that assumes the vector is in a keymap).
3447 SHADOW is a list of keymaps that shadow this map.
3448 If it is non-nil, then we look up the key in those maps
3449 and we don't mention it now if it is defined by any of them.
3451 ENTIRE_MAP is the keymap in which this vector appears.
3452 If the definition in effect in the whole map does not match
3453 the one in this vector, we ignore this one.
3455 ARGS is simply passed as the second argument to ELT_DESCRIBER.
3457 INDICES and CHAR_TABLE_DEPTH are ignored. They will be removed in
3460 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3462 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3465 describe_vector (vector
, prefix
, args
, elt_describer
,
3466 partial
, shadow
, entire_map
,
3467 indices
, char_table_depth
, keymap_p
,
3469 register Lisp_Object vector
;
3470 Lisp_Object prefix
, args
;
3471 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3474 Lisp_Object entire_map
;
3476 int char_table_depth
;
3480 Lisp_Object definition
;
3482 Lisp_Object elt_prefix
= Qnil
;
3484 Lisp_Object suppress
;
3487 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3488 /* Range of elements to be handled. */
3490 Lisp_Object character
;
3499 /* Call Fkey_description first, to avoid GC bug for the other string. */
3500 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3503 tem
= Fkey_description (prefix
, Qnil
);
3504 elt_prefix
= concat2 (tem
, build_string (" "));
3509 /* This vector gets used to present single keys to Flookup_key. Since
3510 that is done once per vector element, we don't want to cons up a
3511 fresh vector every time. */
3512 kludge
= Fmake_vector (make_number (1), Qnil
);
3513 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3516 suppress
= intern ("suppress-keymap");
3519 to
= CHAR_TABLE_P (vector
) ? MAX_CHAR
+ 1 : XVECTOR (vector
)->size
;
3521 for (i
= from
; i
< to
; i
++)
3523 int this_shadowed
= 0;
3524 int range_beg
, range_end
;
3531 if (CHAR_TABLE_P (vector
))
3532 val
= char_table_ref_and_range (vector
, i
, &range_beg
, &i
);
3534 val
= AREF (vector
, i
);
3535 definition
= get_keyelt (val
, 0);
3537 if (NILP (definition
)) continue;
3539 /* Don't mention suppressed commands. */
3540 if (SYMBOLP (definition
) && partial
)
3544 tem
= Fget (definition
, suppress
);
3546 if (!NILP (tem
)) continue;
3549 character
= make_number (starting_i
);
3550 ASET (kludge
, 0, character
);
3552 /* If this binding is shadowed by some other map, ignore it. */
3557 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3568 /* Ignore this definition if it is shadowed by an earlier
3569 one in the same keymap. */
3570 if (!NILP (entire_map
))
3574 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3576 if (!EQ (tem
, definition
))
3586 /* Output the prefix that applies to every entry in this map. */
3587 if (!NILP (elt_prefix
))
3588 insert1 (elt_prefix
);
3590 insert1 (Fkey_description (kludge
, prefix
));
3592 /* Find all consecutive characters or rows that have the same
3593 definition. But, for elements of a top level char table, if
3594 they are for charsets, we had better describe one by one even
3595 if they have the same definition. */
3596 if (CHAR_TABLE_P (vector
))
3598 && (val
= char_table_ref_and_range (vector
, i
+ 1,
3599 &range_beg
, &range_end
),
3600 tem2
= get_keyelt (val
, 0),
3602 && !NILP (Fequal (tem2
, definition
)))
3606 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3608 && !NILP (Fequal (tem2
, definition
)))
3611 /* If we have a range of more than one character,
3612 print where the range reaches to. */
3614 if (i
!= starting_i
)
3618 ASET (kludge
, 0, make_number (i
));
3620 if (!NILP (elt_prefix
))
3621 insert1 (elt_prefix
);
3623 insert1 (Fkey_description (kludge
, prefix
));
3626 /* Print a description of the definition of this character.
3627 elt_describer will take care of spacing out far enough
3628 for alignment purposes. */
3629 (*elt_describer
) (definition
, args
);
3634 insert_string (" (binding currently shadowed)");
3639 if (CHAR_TABLE_P (vector
) && ! NILP (XCHAR_TABLE (vector
)->defalt
))
3641 if (!NILP (elt_prefix
))
3642 insert1 (elt_prefix
);
3643 insert ("default", 7);
3644 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3650 /* Apropos - finding all symbols whose names match a regexp. */
3651 static Lisp_Object apropos_predicate
;
3652 static Lisp_Object apropos_accumulate
;
3655 apropos_accum (symbol
, string
)
3656 Lisp_Object symbol
, string
;
3658 register Lisp_Object tem
;
3660 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3661 if (!NILP (tem
) && !NILP (apropos_predicate
))
3662 tem
= call1 (apropos_predicate
, symbol
);
3664 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3667 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3668 doc
: /* Show all symbols whose names contain match for REGEXP.
3669 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3670 for each symbol and a symbol is mentioned only if that returns non-nil.
3671 Return list of symbols found. */)
3673 Lisp_Object regexp
, predicate
;
3676 CHECK_STRING (regexp
);
3677 apropos_predicate
= predicate
;
3678 apropos_accumulate
= Qnil
;
3679 map_obarray (Vobarray
, apropos_accum
, regexp
);
3680 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3681 apropos_accumulate
= Qnil
;
3682 apropos_predicate
= Qnil
;
3689 Qkeymap
= intern ("keymap");
3690 staticpro (&Qkeymap
);
3691 staticpro (&apropos_predicate
);
3692 staticpro (&apropos_accumulate
);
3693 apropos_predicate
= Qnil
;
3694 apropos_accumulate
= Qnil
;
3696 /* Now we are ready to set up this property, so we can
3697 create char tables. */
3698 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3700 /* Initialize the keymaps standardly used.
3701 Each one is the value of a Lisp variable, and is also
3702 pointed to by a C variable */
3704 global_map
= Fmake_keymap (Qnil
);
3705 Fset (intern ("global-map"), global_map
);
3707 current_global_map
= global_map
;
3708 staticpro (&global_map
);
3709 staticpro (¤t_global_map
);
3711 meta_map
= Fmake_keymap (Qnil
);
3712 Fset (intern ("esc-map"), meta_map
);
3713 Ffset (intern ("ESC-prefix"), meta_map
);
3715 control_x_map
= Fmake_keymap (Qnil
);
3716 Fset (intern ("ctl-x-map"), control_x_map
);
3717 Ffset (intern ("Control-X-prefix"), control_x_map
);
3720 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3721 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3722 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3723 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3724 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3726 staticpro (&exclude_keys
);
3728 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3729 doc
: /* List of commands given new key bindings recently.
3730 This is used for internal purposes during Emacs startup;
3731 don't alter it yourself. */);
3732 Vdefine_key_rebound_commands
= Qt
;
3734 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3735 doc
: /* Default keymap to use when reading from the minibuffer. */);
3736 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3738 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3739 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3740 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3741 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3743 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3744 doc
: /* Local keymap for minibuffer input with completion. */);
3745 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3746 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3748 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3749 &Vminibuffer_local_filename_completion_map
,
3750 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3751 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3752 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3753 Vminibuffer_local_completion_map
);
3756 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3757 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3758 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3759 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3760 Vminibuffer_local_completion_map
);
3762 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3763 &Vminibuffer_local_must_match_filename_map
,
3764 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3765 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3766 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3767 Vminibuffer_local_must_match_map
);
3769 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3770 doc
: /* Alist of keymaps to use for minor modes.
3771 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3772 key sequences and look up bindings iff VARIABLE's value is non-nil.
3773 If two active keymaps bind the same key, the keymap appearing earlier
3774 in the list takes precedence. */);
3775 Vminor_mode_map_alist
= Qnil
;
3777 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3778 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3779 This variable is an alist just like `minor-mode-map-alist', and it is
3780 used the same way (and before `minor-mode-map-alist'); however,
3781 it is provided for major modes to bind locally. */);
3782 Vminor_mode_overriding_map_alist
= Qnil
;
3784 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3785 doc
: /* List of keymap alists to use for emulations modes.
3786 It is intended for modes or packages using multiple minor-mode keymaps.
3787 Each element is a keymap alist just like `minor-mode-map-alist', or a
3788 symbol with a variable binding which is a keymap alist, and it is used
3789 the same way. The "active" keymaps in each alist are used before
3790 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3791 Vemulation_mode_map_alists
= Qnil
;
3794 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3795 doc
: /* Keymap that translates key sequences to key sequences during input.
3796 This is used mainly for mapping ASCII function key sequences into
3797 real Emacs function key events (symbols).
3799 The `read-key-sequence' function replaces any subsequence bound by
3800 `function-key-map' with its binding. More precisely, when the active
3801 keymaps have no binding for the current key sequence but
3802 `function-key-map' binds a suffix of the sequence to a vector or string,
3803 `read-key-sequence' replaces the matching suffix with its binding, and
3804 continues with the new sequence.
3806 If the binding is a function, it is called with one argument (the prompt)
3807 and its return value (a key sequence) is used.
3809 The events that come from bindings in `function-key-map' are not
3810 themselves looked up in `function-key-map'.
3812 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3813 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3814 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3815 key, typing `ESC O P x' would return [f1 x]. */);
3816 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3818 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3819 doc
: /* Keymap of key translations that can override keymaps.
3820 This keymap works like `function-key-map', but comes after that,
3821 and its non-prefix bindings override ordinary bindings. */);
3822 Vkey_translation_map
= Qnil
;
3824 staticpro (&Vmouse_events
);
3825 Vmouse_events
= Fcons (intern ("menu-bar"),
3826 Fcons (intern ("tool-bar"),
3827 Fcons (intern ("header-line"),
3828 Fcons (intern ("mode-line"),
3829 Fcons (intern ("mouse-1"),
3830 Fcons (intern ("mouse-2"),
3831 Fcons (intern ("mouse-3"),
3832 Fcons (intern ("mouse-4"),
3833 Fcons (intern ("mouse-5"),
3837 Qsingle_key_description
= intern ("single-key-description");
3838 staticpro (&Qsingle_key_description
);
3840 Qkey_description
= intern ("key-description");
3841 staticpro (&Qkey_description
);
3843 Qkeymapp
= intern ("keymapp");
3844 staticpro (&Qkeymapp
);
3846 Qnon_ascii
= intern ("non-ascii");
3847 staticpro (&Qnon_ascii
);
3849 Qmenu_item
= intern ("menu-item");
3850 staticpro (&Qmenu_item
);
3852 Qremap
= intern ("remap");
3853 staticpro (&Qremap
);
3855 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3856 staticpro (&command_remapping_vector
);
3858 where_is_cache_keymaps
= Qt
;
3859 where_is_cache
= Qnil
;
3860 staticpro (&where_is_cache
);
3861 staticpro (&where_is_cache_keymaps
);
3863 defsubr (&Skeymapp
);
3864 defsubr (&Skeymap_parent
);
3865 defsubr (&Skeymap_prompt
);
3866 defsubr (&Sset_keymap_parent
);
3867 defsubr (&Smake_keymap
);
3868 defsubr (&Smake_sparse_keymap
);
3869 defsubr (&Smap_keymap
);
3870 defsubr (&Scopy_keymap
);
3871 defsubr (&Scommand_remapping
);
3872 defsubr (&Skey_binding
);
3873 defsubr (&Slocal_key_binding
);
3874 defsubr (&Sglobal_key_binding
);
3875 defsubr (&Sminor_mode_key_binding
);
3876 defsubr (&Sdefine_key
);
3877 defsubr (&Slookup_key
);
3878 defsubr (&Sdefine_prefix_command
);
3879 defsubr (&Suse_global_map
);
3880 defsubr (&Suse_local_map
);
3881 defsubr (&Scurrent_local_map
);
3882 defsubr (&Scurrent_global_map
);
3883 defsubr (&Scurrent_minor_mode_maps
);
3884 defsubr (&Scurrent_active_maps
);
3885 defsubr (&Saccessible_keymaps
);
3886 defsubr (&Skey_description
);
3887 defsubr (&Sdescribe_vector
);
3888 defsubr (&Ssingle_key_description
);
3889 defsubr (&Stext_char_description
);
3890 defsubr (&Swhere_is_internal
);
3891 defsubr (&Sdescribe_buffer_bindings
);
3892 defsubr (&Sapropos_internal
);
3898 initial_define_key (global_map
, 033, "ESC-prefix");
3899 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
3902 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
3903 (do not change this comment) */