1 /* Manipulation of keymaps
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005 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
;
679 GCPRO3 (map
, args
, tail
);
680 map
= get_keymap (map
, 1, autoload
);
681 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
682 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
685 Lisp_Object binding
= XCAR (tail
);
688 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
689 else if (VECTORP (binding
))
691 /* Loop over the char values represented in the vector. */
692 int len
= ASIZE (binding
);
694 for (c
= 0; c
< len
; c
++)
696 Lisp_Object character
;
697 XSETFASTINT (character
, c
);
698 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
701 else if (CHAR_TABLE_P (binding
))
703 map_char_table (map_keymap_char_table_item
, Qnil
, binding
,
704 Fcons (make_save_value (fun
, 0),
705 Fcons (make_save_value (data
, 0),
713 map_keymap_call (key
, val
, fun
, dummy
)
714 Lisp_Object key
, val
, fun
;
717 call2 (fun
, key
, val
);
720 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
721 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
722 FUNCTION is called with two arguments: the event that is bound, and
723 the definition it is bound to.
725 If KEYMAP has a parent, the parent's bindings are included as well.
726 This works recursively: if the parent has itself a parent, then the
727 grandparent's bindings are also included and so on.
728 usage: (map-keymap FUNCTION KEYMAP) */)
729 (function
, keymap
, sort_first
)
730 Lisp_Object function
, keymap
, sort_first
;
732 if (INTEGERP (function
))
733 /* We have to stop integers early since map_keymap gives them special
735 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
736 if (! NILP (sort_first
))
737 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
739 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
743 /* Given OBJECT which was found in a slot in a keymap,
744 trace indirect definitions to get the actual definition of that slot.
745 An indirect definition is a list of the form
746 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
747 and INDEX is the object to look up in KEYMAP to yield the definition.
749 Also if OBJECT has a menu string as the first element,
750 remove that. Also remove a menu help string as second element.
752 If AUTOLOAD is nonzero, load autoloadable keymaps
753 that are referred to with indirection.
755 This can GC because menu_item_eval_property calls Feval. */
758 get_keyelt (object
, autoload
)
764 if (!(CONSP (object
)))
765 /* This is really the value. */
768 /* If the keymap contents looks like (keymap ...) or (lambda ...)
770 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
773 /* If the keymap contents looks like (menu-item name . DEFN)
774 or (menu-item name DEFN ...) then use DEFN.
775 This is a new format menu item. */
776 else if (EQ (XCAR (object
), Qmenu_item
))
778 if (CONSP (XCDR (object
)))
782 object
= XCDR (XCDR (object
));
785 object
= XCAR (object
);
787 /* If there's a `:filter FILTER', apply FILTER to the
788 menu-item's definition to get the real definition to
790 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
791 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
794 filter
= XCAR (XCDR (tem
));
795 filter
= list2 (filter
, list2 (Qquote
, object
));
796 object
= menu_item_eval_property (filter
);
801 /* Invalid keymap. */
805 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
806 Keymap alist elements like (CHAR MENUSTRING . DEFN)
807 will be used by HierarKey menus. */
808 else if (STRINGP (XCAR (object
)))
810 object
= XCDR (object
);
811 /* Also remove a menu help string, if any,
812 following the menu item name. */
813 if (CONSP (object
) && STRINGP (XCAR (object
)))
814 object
= XCDR (object
);
815 /* Also remove the sublist that caches key equivalences, if any. */
816 if (CONSP (object
) && CONSP (XCAR (object
)))
819 carcar
= XCAR (XCAR (object
));
820 if (NILP (carcar
) || VECTORP (carcar
))
821 object
= XCDR (object
);
825 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
831 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
833 return (!CONSP (map
) ? object
/* Invalid keymap */
834 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
840 store_in_keymap (keymap
, idx
, def
)
842 register Lisp_Object idx
;
843 register Lisp_Object def
;
845 /* Flush any reverse-map cache. */
846 where_is_cache
= Qnil
;
847 where_is_cache_keymaps
= Qt
;
849 /* If we are preparing to dump, and DEF is a menu element
850 with a menu item indicator, copy it to ensure it is not pure. */
851 if (CONSP (def
) && PURE_P (def
)
852 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
853 def
= Fcons (XCAR (def
), XCDR (def
));
855 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
856 error ("attempt to define a key in a non-keymap");
858 /* If idx is a cons, and the car part is a character, idx must be of
859 the form (FROM-CHAR . TO-CHAR). */
860 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
861 CHECK_CHARACTER_CDR (idx
);
863 /* If idx is a list (some sort of mouse click, perhaps?),
864 the index we want to use is the car of the list, which
865 ought to be a symbol. */
866 idx
= EVENT_HEAD (idx
);
868 /* If idx is a symbol, it might have modifiers, which need to
869 be put in the canonical order. */
871 idx
= reorder_modifiers (idx
);
872 else if (INTEGERP (idx
))
873 /* Clobber the high bits that can be present on a machine
874 with more than 24 bits of integer. */
875 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
877 /* Scan the keymap for a binding of idx. */
881 /* The cons after which we should insert new bindings. If the
882 keymap has a table element, we record its position here, so new
883 bindings will go after it; this way, the table will stay
884 towards the front of the alist and character lookups in dense
885 keymaps will remain fast. Otherwise, this just points at the
886 front of the keymap. */
887 Lisp_Object insertion_point
;
889 insertion_point
= keymap
;
890 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
897 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
900 ASET (elt
, XFASTINT (idx
), def
);
903 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
905 int from
= XFASTINT (XCAR (idx
));
906 int to
= XFASTINT (XCDR (idx
));
908 if (to
>= ASIZE (elt
))
909 to
= ASIZE (elt
) - 1;
910 for (; from
<= to
; from
++)
911 ASET (elt
, from
, def
);
912 if (to
== XFASTINT (XCDR (idx
)))
913 /* We have defined all keys in IDX. */
916 insertion_point
= tail
;
918 else if (CHAR_TABLE_P (elt
))
920 /* Character codes with modifiers
921 are not included in a char-table.
922 All character codes without modifiers are included. */
923 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
926 /* `nil' has a special meaning for char-tables, so
927 we use something else to record an explicitly
929 NILP (def
) ? Qt
: def
);
932 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
934 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
937 insertion_point
= tail
;
939 else if (CONSP (elt
))
941 if (EQ (idx
, XCAR (elt
)))
947 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
949 int from
= XFASTINT (XCAR (idx
));
950 int to
= XFASTINT (XCDR (idx
));
952 if (from
<= XFASTINT (XCAR (elt
))
953 && to
>= XFASTINT (XCAR (elt
)))
961 else if (EQ (elt
, Qkeymap
))
962 /* If we find a 'keymap' symbol in the spine of KEYMAP,
963 then we must have found the start of a second keymap
964 being used as the tail of KEYMAP, and a binding for IDX
965 should be inserted before it. */
972 /* We have scanned the entire keymap, and not found a binding for
973 IDX. Let's add one. */
977 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
979 /* IDX specifies a range of characters, and not all of them
980 were handled yet, which means this keymap doesn't have a
981 char-table. So, we insert a char-table now. */
982 elt
= Fmake_char_table (Qkeymap
, Qnil
);
983 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
986 elt
= Fcons (idx
, def
);
987 CHECK_IMPURE (insertion_point
);
988 XSETCDR (insertion_point
, Fcons (elt
, XCDR (insertion_point
)));
995 EXFUN (Fcopy_keymap
, 1);
998 copy_keymap_item (elt
)
1001 Lisp_Object res
, tem
;
1008 /* Is this a new format menu item. */
1009 if (EQ (XCAR (tem
), Qmenu_item
))
1011 /* Copy cell with menu-item marker. */
1012 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1016 /* Copy cell with menu-item name. */
1017 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1023 /* Copy cell with binding and if the binding is a keymap,
1025 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1028 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1029 XSETCAR (elt
, Fcopy_keymap (tem
));
1031 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1032 /* Delete cache for key equivalences. */
1033 XSETCDR (elt
, XCDR (tem
));
1038 /* It may be an old fomat menu item.
1039 Skip the optional menu string. */
1040 if (STRINGP (XCAR (tem
)))
1042 /* Copy the cell, since copy-alist didn't go this deep. */
1043 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1045 /* Also skip the optional menu help string. */
1046 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1048 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1052 /* There may also be a list that caches key equivalences.
1053 Just delete it for the new keymap. */
1055 && CONSP (XCAR (tem
))
1056 && (NILP (XCAR (XCAR (tem
)))
1057 || VECTORP (XCAR (XCAR (tem
)))))
1059 XSETCDR (elt
, XCDR (tem
));
1062 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1063 XSETCDR (elt
, Fcopy_keymap (tem
));
1065 else if (EQ (XCAR (tem
), Qkeymap
))
1066 res
= Fcopy_keymap (elt
);
1072 copy_keymap_1 (chartable
, idx
, elt
)
1073 Lisp_Object chartable
, idx
, elt
;
1075 Fset_char_table_range (chartable
, idx
, copy_keymap_item (elt
));
1078 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1079 doc
: /* Return a copy of the keymap KEYMAP.
1080 The copy starts out with the same definitions of KEYMAP,
1081 but changing either the copy or KEYMAP does not affect the other.
1082 Any key definitions that are subkeymaps are recursively copied.
1083 However, a key definition which is a symbol whose definition is a keymap
1088 register Lisp_Object copy
, tail
;
1089 keymap
= get_keymap (keymap
, 1, 0);
1090 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1091 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1093 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1095 Lisp_Object elt
= XCAR (keymap
);
1096 if (CHAR_TABLE_P (elt
))
1098 elt
= Fcopy_sequence (elt
);
1099 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
);
1101 else if (VECTORP (elt
))
1104 elt
= Fcopy_sequence (elt
);
1105 for (i
= 0; i
< ASIZE (elt
); i
++)
1106 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1108 else if (CONSP (elt
))
1109 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1110 XSETCDR (tail
, Fcons (elt
, Qnil
));
1112 keymap
= XCDR (keymap
);
1114 XSETCDR (tail
, keymap
);
1118 /* Simple Keymap mutators and accessors. */
1120 /* GC is possible in this function if it autoloads a keymap. */
1122 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1123 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1126 KEY is a string or a vector of symbols and characters meaning a
1127 sequence of keystrokes and events. Non-ASCII characters with codes
1128 above 127 (such as ISO Latin-1) can be included if you use a vector.
1129 Using [t] for KEY creates a default definition, which applies to any
1130 event type that has no other definition in this keymap.
1132 DEF is anything that can be a key's definition:
1133 nil (means key is undefined in this keymap),
1134 a command (a Lisp function suitable for interactive calling),
1135 a string (treated as a keyboard macro),
1136 a keymap (to define a prefix key),
1137 a symbol (when the key is looked up, the symbol will stand for its
1138 function definition, which should at that time be one of the above,
1139 or another symbol whose function definition is used, etc.),
1140 a cons (STRING . DEFN), meaning that DEFN is the definition
1141 (DEFN should be a valid definition in its own right),
1142 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1144 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1145 binding is altered. If there is no binding for KEY, the new pair
1146 binding KEY to DEF is added at the front of KEYMAP. */)
1153 register Lisp_Object c
;
1154 register Lisp_Object cmd
;
1158 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1160 GCPRO3 (keymap
, key
, def
);
1161 keymap
= get_keymap (keymap
, 1, 1);
1163 if (!VECTORP (key
) && !STRINGP (key
))
1164 key
= wrong_type_argument (Qarrayp
, key
);
1166 length
= XFASTINT (Flength (key
));
1168 RETURN_UNGCPRO (Qnil
);
1170 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1171 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1173 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1178 c
= Faref (key
, make_number (idx
));
1182 /* C may be a Lucid style event type list or a cons (FROM .
1183 TO) specifying a range of characters. */
1184 if (lucid_event_type_list_p (c
))
1185 c
= Fevent_convert_list (c
);
1186 else if (CHARACTERP (XCAR (c
)))
1187 CHECK_CHARACTER_CDR (c
);
1191 silly_event_symbol_error (c
);
1194 && (XINT (c
) & meta_bit
)
1197 c
= meta_prefix_char
;
1203 XSETINT (c
, XINT (c
) & ~meta_bit
);
1209 if (!INTEGERP (c
) && !SYMBOLP (c
)
1211 /* If C is a range, it must be a leaf. */
1212 || (INTEGERP (XCAR (c
)) && idx
!= length
)))
1213 error ("Key sequence contains invalid event");
1216 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1218 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1220 /* If this key is undefined, make it a prefix. */
1222 cmd
= define_as_prefix (keymap
, c
);
1224 keymap
= get_keymap (cmd
, 0, 1);
1225 if (!CONSP (keymap
))
1226 /* We must use Fkey_description rather than just passing key to
1227 error; key might be a vector, not a string. */
1228 error ("Key sequence %s uses invalid prefix characters",
1229 SDATA (Fkey_description (key
, Qnil
)));
1233 /* This function may GC (it calls Fkey_binding). */
1235 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1236 doc
: /* Return the remapping for command COMMAND in current keymaps.
1237 Returns nil if COMMAND is not remapped (or not a symbol). */)
1239 Lisp_Object command
;
1241 if (!SYMBOLP (command
))
1244 ASET (command_remapping_vector
, 1, command
);
1245 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1248 /* Value is number if KEY is too long; nil if valid but has no definition. */
1249 /* GC is possible in this function if it autoloads a keymap. */
1251 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1252 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1253 nil means undefined. See doc of `define-key' for kinds of definitions.
1255 A number as value means KEY is "too long";
1256 that is, characters or symbols in it except for the last one
1257 fail to be a valid sequence of prefix characters in KEYMAP.
1258 The number is how many characters at the front of KEY
1259 it takes to reach a non-prefix key.
1261 Normally, `lookup-key' ignores bindings for t, which act as default
1262 bindings, used when nothing else in the keymap applies; this makes it
1263 usable as a general function for probing keymaps. However, if the
1264 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1265 recognize the default bindings, just as `read-key-sequence' does. */)
1266 (keymap
, key
, accept_default
)
1269 Lisp_Object accept_default
;
1272 register Lisp_Object cmd
;
1273 register Lisp_Object c
;
1275 int t_ok
= !NILP (accept_default
);
1276 struct gcpro gcpro1
, gcpro2
;
1278 GCPRO2 (keymap
, key
);
1279 keymap
= get_keymap (keymap
, 1, 1);
1281 if (!VECTORP (key
) && !STRINGP (key
))
1282 key
= wrong_type_argument (Qarrayp
, key
);
1284 length
= XFASTINT (Flength (key
));
1286 RETURN_UNGCPRO (keymap
);
1291 c
= Faref (key
, make_number (idx
++));
1293 if (CONSP (c
) && lucid_event_type_list_p (c
))
1294 c
= Fevent_convert_list (c
);
1296 /* Turn the 8th bit of string chars into a meta modifier. */
1297 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1298 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1300 /* Allow string since binding for `menu-bar-select-buffer'
1301 includes the buffer name in the key sequence. */
1302 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1303 error ("Key sequence contains invalid event");
1305 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1307 RETURN_UNGCPRO (cmd
);
1309 keymap
= get_keymap (cmd
, 0, 1);
1310 if (!CONSP (keymap
))
1311 RETURN_UNGCPRO (make_number (idx
));
1317 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1318 Assume that currently it does not define C at all.
1319 Return the keymap. */
1322 define_as_prefix (keymap
, c
)
1323 Lisp_Object keymap
, c
;
1327 cmd
= Fmake_sparse_keymap (Qnil
);
1328 /* If this key is defined as a prefix in an inherited keymap,
1329 make it a prefix in this map, and make its definition
1330 inherit the other prefix definition. */
1331 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1332 store_in_keymap (keymap
, c
, cmd
);
1337 /* Append a key to the end of a key sequence. We always make a vector. */
1340 append_key (key_sequence
, key
)
1341 Lisp_Object key_sequence
, key
;
1343 Lisp_Object args
[2];
1345 args
[0] = key_sequence
;
1347 args
[1] = Fcons (key
, Qnil
);
1348 return Fvconcat (2, args
);
1351 /* Given a event type C which is a symbol,
1352 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1355 silly_event_symbol_error (c
)
1358 Lisp_Object parsed
, base
, name
, assoc
;
1361 parsed
= parse_modifiers (c
);
1362 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1363 base
= XCAR (parsed
);
1364 name
= Fsymbol_name (base
);
1365 /* This alist includes elements such as ("RET" . "\\r"). */
1366 assoc
= Fassoc (name
, exclude_keys
);
1370 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1372 Lisp_Object keystring
;
1373 if (modifiers
& alt_modifier
)
1374 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1375 if (modifiers
& ctrl_modifier
)
1376 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1377 if (modifiers
& hyper_modifier
)
1378 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1379 if (modifiers
& meta_modifier
)
1380 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1381 if (modifiers
& shift_modifier
)
1382 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1383 if (modifiers
& super_modifier
)
1384 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1387 c
= reorder_modifiers (c
);
1388 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1390 error ((modifiers
& ~meta_modifier
1391 ? "To bind the key %s, use [?%s], not [%s]"
1392 : "To bind the key %s, use \"%s\", not [%s]"),
1393 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1394 SDATA (SYMBOL_NAME (c
)));
1398 /* Global, local, and minor mode keymap stuff. */
1400 /* We can't put these variables inside current_minor_maps, since under
1401 some systems, static gets macro-defined to be the empty string.
1403 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1404 static int cmm_size
= 0;
1406 /* Error handler used in current_minor_maps. */
1408 current_minor_maps_error ()
1413 /* Store a pointer to an array of the keymaps of the currently active
1414 minor modes in *buf, and return the number of maps it contains.
1416 This function always returns a pointer to the same buffer, and may
1417 free or reallocate it, so if you want to keep it for a long time or
1418 hand it out to lisp code, copy it. This procedure will be called
1419 for every key sequence read, so the nice lispy approach (return a
1420 new assoclist, list, what have you) for each invocation would
1421 result in a lot of consing over time.
1423 If we used xrealloc/xmalloc and ran out of memory, they would throw
1424 back to the command loop, which would try to read a key sequence,
1425 which would call this function again, resulting in an infinite
1426 loop. Instead, we'll use realloc/malloc and silently truncate the
1427 list, let the key sequence be read, and hope some other piece of
1428 code signals the error. */
1430 current_minor_maps (modeptr
, mapptr
)
1431 Lisp_Object
**modeptr
, **mapptr
;
1434 int list_number
= 0;
1435 Lisp_Object alist
, assoc
, var
, val
;
1436 Lisp_Object emulation_alists
;
1437 Lisp_Object lists
[2];
1439 emulation_alists
= Vemulation_mode_map_alists
;
1440 lists
[0] = Vminor_mode_overriding_map_alist
;
1441 lists
[1] = Vminor_mode_map_alist
;
1443 for (list_number
= 0; list_number
< 2; list_number
++)
1445 if (CONSP (emulation_alists
))
1447 alist
= XCAR (emulation_alists
);
1448 emulation_alists
= XCDR (emulation_alists
);
1449 if (SYMBOLP (alist
))
1450 alist
= find_symbol_value (alist
);
1454 alist
= lists
[list_number
];
1456 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1457 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1458 && (var
= XCAR (assoc
), SYMBOLP (var
))
1459 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1464 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1465 and also an entry in Vminor_mode_map_alist,
1466 ignore the latter. */
1467 if (list_number
== 1)
1469 val
= assq_no_quit (var
, lists
[0]);
1476 int newsize
, allocsize
;
1477 Lisp_Object
*newmodes
, *newmaps
;
1479 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1480 allocsize
= newsize
* sizeof *newmodes
;
1482 /* Use malloc here. See the comment above this function.
1483 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1485 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1490 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1493 cmm_modes
= newmodes
;
1496 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1501 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1508 if (newmodes
== NULL
|| newmaps
== NULL
)
1513 /* Get the keymap definition--or nil if it is not defined. */
1514 temp
= internal_condition_case_1 (Findirect_function
,
1516 Qerror
, current_minor_maps_error
);
1520 cmm_maps
[i
] = temp
;
1526 if (modeptr
) *modeptr
= cmm_modes
;
1527 if (mapptr
) *mapptr
= cmm_maps
;
1531 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1533 doc
: /* Return a list of the currently active keymaps.
1534 OLP if non-nil indicates that we should obey `overriding-local-map' and
1535 `overriding-terminal-local-map'. */)
1539 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1543 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1544 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1545 /* The doc said that overriding-terminal-local-map should
1546 override overriding-local-map. The code used them both,
1547 but it seems clearer to use just one. rms, jan 2005. */
1548 else if (!NILP (Voverriding_local_map
))
1549 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1551 if (NILP (XCDR (keymaps
)))
1557 /* This usually returns the buffer's local map,
1558 but that can be overridden by a `local-map' property. */
1559 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1561 keymaps
= Fcons (local
, keymaps
);
1563 /* Now put all the minor mode keymaps on the list. */
1564 nmaps
= current_minor_maps (0, &maps
);
1566 for (i
= --nmaps
; i
>= 0; i
--)
1567 if (!NILP (maps
[i
]))
1568 keymaps
= Fcons (maps
[i
], keymaps
);
1570 /* This returns nil unless there is a `keymap' property. */
1571 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1573 keymaps
= Fcons (local
, keymaps
);
1579 /* GC is possible in this function if it autoloads a keymap. */
1581 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1582 doc
: /* Return the binding for command KEY in current keymaps.
1583 KEY is a string or vector, a sequence of keystrokes.
1584 The binding is probably a symbol with a function definition.
1586 Normally, `key-binding' ignores bindings for t, which act as default
1587 bindings, used when nothing else in the keymap applies; this makes it
1588 usable as a general function for probing keymaps. However, if the
1589 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1590 recognize the default bindings, just as `read-key-sequence' does.
1592 Like the normal command loop, `key-binding' will remap the command
1593 resulting from looking up KEY by looking up the command in the
1594 current keymaps. However, if the optional third argument NO-REMAP
1595 is non-nil, `key-binding' returns the unmapped command. */)
1596 (key
, accept_default
, no_remap
)
1597 Lisp_Object key
, accept_default
, no_remap
;
1599 Lisp_Object
*maps
, value
;
1601 struct gcpro gcpro1
;
1605 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1607 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1608 key
, accept_default
);
1609 if (! NILP (value
) && !INTEGERP (value
))
1612 else if (!NILP (Voverriding_local_map
))
1614 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1615 if (! NILP (value
) && !INTEGERP (value
))
1622 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1625 value
= Flookup_key (local
, key
, accept_default
);
1626 if (! NILP (value
) && !INTEGERP (value
))
1630 nmaps
= current_minor_maps (0, &maps
);
1631 /* Note that all these maps are GCPRO'd
1632 in the places where we found them. */
1634 for (i
= 0; i
< nmaps
; i
++)
1635 if (! NILP (maps
[i
]))
1637 value
= Flookup_key (maps
[i
], key
, accept_default
);
1638 if (! NILP (value
) && !INTEGERP (value
))
1642 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1645 value
= Flookup_key (local
, key
, accept_default
);
1646 if (! NILP (value
) && !INTEGERP (value
))
1651 value
= Flookup_key (current_global_map
, key
, accept_default
);
1655 if (NILP (value
) || INTEGERP (value
))
1658 /* If the result of the ordinary keymap lookup is an interactive
1659 command, look for a key binding (ie. remapping) for that command. */
1661 if (NILP (no_remap
) && SYMBOLP (value
))
1664 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1671 /* GC is possible in this function if it autoloads a keymap. */
1673 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1674 doc
: /* Return the binding for command KEYS in current local keymap only.
1675 KEYS is a string or vector, a sequence of keystrokes.
1676 The binding is probably a symbol with a function definition.
1678 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1679 bindings; see the description of `lookup-key' for more details about this. */)
1680 (keys
, accept_default
)
1681 Lisp_Object keys
, accept_default
;
1683 register Lisp_Object map
;
1684 map
= current_buffer
->keymap
;
1687 return Flookup_key (map
, keys
, accept_default
);
1690 /* GC is possible in this function if it autoloads a keymap. */
1692 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1693 doc
: /* Return the binding for command KEYS in current global keymap only.
1694 KEYS is a string or vector, a sequence of keystrokes.
1695 The binding is probably a symbol with a function definition.
1696 This function's return values are the same as those of `lookup-key'
1699 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1700 bindings; see the description of `lookup-key' for more details about this. */)
1701 (keys
, accept_default
)
1702 Lisp_Object keys
, accept_default
;
1704 return Flookup_key (current_global_map
, keys
, accept_default
);
1707 /* GC is possible in this function if it autoloads a keymap. */
1709 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1710 doc
: /* Find the visible minor mode bindings of KEY.
1711 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1712 the symbol which names the minor mode binding KEY, and BINDING is
1713 KEY's definition in that mode. In particular, if KEY has no
1714 minor-mode bindings, return nil. If the first binding is a
1715 non-prefix, all subsequent bindings will be omitted, since they would
1716 be ignored. Similarly, the list doesn't include non-prefix bindings
1717 that come after prefix bindings.
1719 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1720 bindings; see the description of `lookup-key' for more details about this. */)
1721 (key
, accept_default
)
1722 Lisp_Object key
, accept_default
;
1724 Lisp_Object
*modes
, *maps
;
1726 Lisp_Object binding
;
1728 struct gcpro gcpro1
, gcpro2
;
1730 nmaps
= current_minor_maps (&modes
, &maps
);
1731 /* Note that all these maps are GCPRO'd
1732 in the places where we found them. */
1735 GCPRO2 (key
, binding
);
1737 for (i
= j
= 0; i
< nmaps
; i
++)
1739 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1740 && !INTEGERP (binding
))
1742 if (KEYMAPP (binding
))
1743 maps
[j
++] = Fcons (modes
[i
], binding
);
1745 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1749 return Flist (j
, maps
);
1752 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1753 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1754 A new sparse keymap is stored as COMMAND's function definition and its value.
1755 If a second optional argument MAPVAR is given, the map is stored as
1756 its value instead of as COMMAND's value; but COMMAND is still defined
1758 The third optional argument NAME, if given, supplies a menu name
1759 string for the map. This is required to use the keymap as a menu.
1760 This function returns COMMAND. */)
1761 (command
, mapvar
, name
)
1762 Lisp_Object command
, mapvar
, name
;
1765 map
= Fmake_sparse_keymap (name
);
1766 Ffset (command
, map
);
1770 Fset (command
, map
);
1774 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1775 doc
: /* Select KEYMAP as the global keymap. */)
1779 keymap
= get_keymap (keymap
, 1, 1);
1780 current_global_map
= keymap
;
1785 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1786 doc
: /* Select KEYMAP as the local keymap.
1787 If KEYMAP is nil, that means no local keymap. */)
1792 keymap
= get_keymap (keymap
, 1, 1);
1794 current_buffer
->keymap
= keymap
;
1799 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1800 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1803 return current_buffer
->keymap
;
1806 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1807 doc
: /* Return the current global keymap. */)
1810 return current_global_map
;
1813 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1814 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1818 int nmaps
= current_minor_maps (0, &maps
);
1820 return Flist (nmaps
, maps
);
1823 /* Help functions for describing and documenting keymaps. */
1827 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1828 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1829 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1833 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1837 /* Look for and break cycles. */
1838 while (!NILP (tem
= Frassq (cmd
, maps
)))
1840 Lisp_Object prefix
= XCAR (tem
);
1841 int lim
= XINT (Flength (XCAR (tem
)));
1842 if (lim
<= XINT (Flength (thisseq
)))
1843 { /* This keymap was already seen with a smaller prefix. */
1845 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1846 Faref (thisseq
, make_number (i
))))
1849 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1852 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1853 but maybe `cmd' occurs again further down in `maps', so keep
1855 maps
= XCDR (Fmemq (tem
, maps
));
1858 /* If the last key in thisseq is meta-prefix-char,
1859 turn it into a meta-ized keystroke. We know
1860 that the event we're about to append is an
1861 ascii keystroke since we're processing a
1865 int meta_bit
= meta_modifier
;
1866 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1867 tem
= Fcopy_sequence (thisseq
);
1869 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1871 /* This new sequence is the same length as
1872 thisseq, so stick it in the list right
1875 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1879 tem
= append_key (thisseq
, key
);
1880 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1885 accessible_keymaps_char_table (args
, index
, cmd
)
1886 Lisp_Object args
, index
, cmd
;
1888 accessible_keymaps_1 (index
, cmd
,
1892 XINT (XCDR (XCAR (args
))));
1895 /* This function cannot GC. */
1897 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1899 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1900 Returns a list of elements of the form (KEYS . MAP), where the sequence
1901 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1902 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1903 An optional argument PREFIX, if non-nil, should be a key sequence;
1904 then the value includes only maps for prefixes that start with PREFIX. */)
1906 Lisp_Object keymap
, prefix
;
1908 Lisp_Object maps
, tail
;
1911 /* no need for gcpro because we don't autoload any keymaps. */
1914 prefixlen
= XINT (Flength (prefix
));
1918 /* If a prefix was specified, start with the keymap (if any) for
1919 that prefix, so we don't waste time considering other prefixes. */
1921 tem
= Flookup_key (keymap
, prefix
, Qt
);
1922 /* Flookup_key may give us nil, or a number,
1923 if the prefix is not defined in this particular map.
1924 It might even give us a list that isn't a keymap. */
1925 tem
= get_keymap (tem
, 0, 0);
1928 /* Convert PREFIX to a vector now, so that later on
1929 we don't have to deal with the possibility of a string. */
1930 if (STRINGP (prefix
))
1935 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1936 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1940 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1941 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1942 c
^= 0200 | meta_modifier
;
1943 ASET (copy
, i_before
, make_number (c
));
1947 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1953 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1954 get_keymap (keymap
, 1, 0)),
1957 /* For each map in the list maps,
1958 look at any other maps it points to,
1959 and stick them at the end if they are not already in the list.
1961 This is a breadth-first traversal, where tail is the queue of
1962 nodes, and maps accumulates a list of all nodes visited. */
1964 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1966 register Lisp_Object thisseq
, thismap
;
1968 /* Does the current sequence end in the meta-prefix-char? */
1971 thisseq
= Fcar (Fcar (tail
));
1972 thismap
= Fcdr (Fcar (tail
));
1973 last
= make_number (XINT (Flength (thisseq
)) - 1);
1974 is_metized
= (XINT (last
) >= 0
1975 /* Don't metize the last char of PREFIX. */
1976 && XINT (last
) >= prefixlen
1977 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1979 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1983 elt
= XCAR (thismap
);
1987 if (CHAR_TABLE_P (elt
))
1989 map_char_table (accessible_keymaps_char_table
, Qnil
,
1990 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1991 Fcons (tail
, thisseq
)));
1993 else if (VECTORP (elt
))
1997 /* Vector keymap. Scan all the elements. */
1998 for (i
= 0; i
< ASIZE (elt
); i
++)
1999 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
2000 maps
, tail
, thisseq
, is_metized
);
2003 else if (CONSP (elt
))
2004 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
2005 maps
, tail
, thisseq
,
2006 is_metized
&& INTEGERP (XCAR (elt
)));
2014 Lisp_Object Qsingle_key_description
, Qkey_description
;
2016 /* This function cannot GC. */
2018 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
2019 doc
: /* Return a pretty description of key-sequence KEYS.
2020 Optional arg PREFIX is the sequence of keys leading up to KEYS.
2021 Control characters turn into "C-foo" sequences, meta into "M-foo",
2022 spaces are put between sequence elements, etc. */)
2024 Lisp_Object keys
, prefix
;
2029 int size
= XINT (Flength (keys
));
2031 Lisp_Object sep
= build_string (" ");
2036 size
+= XINT (Flength (prefix
));
2038 /* This has one extra element at the end that we don't pass to Fconcat. */
2039 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2041 /* In effect, this computes
2042 (mapconcat 'single-key-description keys " ")
2043 but we shouldn't use mapconcat because it can do GC. */
2047 list
= prefix
, prefix
= Qnil
;
2048 else if (!NILP (keys
))
2049 list
= keys
, keys
= Qnil
;
2054 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2058 return empty_string
;
2059 return Fconcat (len
- 1, args
);
2063 size
= SCHARS (list
);
2064 else if (VECTORP (list
))
2065 size
= XVECTOR (list
)->size
;
2066 else if (CONSP (list
))
2067 size
= XINT (Flength (list
));
2069 wrong_type_argument (Qarrayp
, list
);
2078 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2079 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2080 c
^= 0200 | meta_modifier
;
2081 XSETFASTINT (key
, c
);
2083 else if (VECTORP (list
))
2085 key
= AREF (list
, i
++);
2097 || EQ (key
, meta_prefix_char
)
2098 || (XINT (key
) & meta_modifier
))
2100 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2102 if (EQ (key
, meta_prefix_char
))
2106 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2109 else if (EQ (key
, meta_prefix_char
))
2114 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2122 push_key_description (c
, p
, force_multibyte
)
2123 register unsigned int c
;
2125 int force_multibyte
;
2129 /* Clear all the meaningless bits above the meta bit. */
2130 c
&= meta_modifier
| ~ - meta_modifier
;
2131 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2132 | meta_modifier
| shift_modifier
| super_modifier
);
2134 if (c
& alt_modifier
)
2140 if ((c
& ctrl_modifier
) != 0
2141 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2145 c
&= ~ctrl_modifier
;
2147 if (c
& hyper_modifier
)
2151 c
-= hyper_modifier
;
2153 if (c
& meta_modifier
)
2159 if (c
& shift_modifier
)
2163 c
-= shift_modifier
;
2165 if (c
& super_modifier
)
2169 c
-= super_modifier
;
2185 else if (c
== Ctl ('M'))
2193 /* `C-' already added above. */
2194 if (c
> 0 && c
<= Ctl ('Z'))
2213 || (NILP (current_buffer
->enable_multibyte_characters
)
2214 && SINGLE_BYTE_CHAR_P (c
)
2215 && !force_multibyte
))
2219 else if (CHARACTERP (make_number (c
)))
2221 if (NILP (current_buffer
->enable_multibyte_characters
)
2222 && ! force_multibyte
)
2223 *p
++ = multibyte_char_to_unibyte (c
, Qnil
);
2225 p
+= CHAR_STRING (c
, (unsigned char *) p
);
2231 /* The biggest character code uses 22 bits. */
2232 for (bit_offset
= 21; bit_offset
>= 0; bit_offset
-= 3)
2234 if (c
>= (1 << bit_offset
))
2235 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2242 /* This function cannot GC. */
2244 DEFUN ("single-key-description", Fsingle_key_description
,
2245 Ssingle_key_description
, 1, 2, 0,
2246 doc
: /* Return a pretty description of command character KEY.
2247 Control characters turn into C-whatever, etc.
2248 Optional argument NO-ANGLES non-nil means don't put angle brackets
2249 around function keys and event symbols. */)
2251 Lisp_Object key
, no_angles
;
2253 if (CONSP (key
) && lucid_event_type_list_p (key
))
2254 key
= Fevent_convert_list (key
);
2256 key
= EVENT_HEAD (key
);
2258 if (INTEGERP (key
)) /* Normal character */
2260 char tem
[KEY_DESCRIPTION_SIZE
];
2262 *push_key_description (XUINT (key
), tem
, 1) = 0;
2263 return build_string (tem
);
2265 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2267 if (NILP (no_angles
))
2270 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2271 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2272 return build_string (buffer
);
2275 return Fsymbol_name (key
);
2277 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2278 return Fcopy_sequence (key
);
2280 error ("KEY must be an integer, cons, symbol, or string");
2285 push_text_char_description (c
, p
)
2286 register unsigned int c
;
2298 *p
++ = c
+ 64; /* 'A' - 1 */
2310 /* This function cannot GC. */
2312 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2313 doc
: /* Return a pretty description of file-character CHARACTER.
2314 Control characters turn into "^char", etc. This differs from
2315 `single-key-description' which turns them into "C-char".
2316 Also, this function recognizes the 2**7 bit as the Meta character,
2317 whereas `single-key-description' uses the 2**27 bit for Meta.
2318 See Info node `(elisp)Describing Characters' for examples. */)
2320 Lisp_Object character
;
2322 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2323 unsigned char str
[6];
2326 CHECK_NUMBER (character
);
2328 c
= XINT (character
);
2329 if (!ASCII_CHAR_P (c
))
2331 int len
= CHAR_STRING (c
, str
);
2333 return make_multibyte_string (str
, 1, len
);
2336 *push_text_char_description (c
& 0377, str
) = 0;
2338 return build_string (str
);
2341 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2344 ascii_sequence_p (seq
)
2348 int len
= XINT (Flength (seq
));
2350 for (i
= 0; i
< len
; i
++)
2352 Lisp_Object ii
, elt
;
2354 XSETFASTINT (ii
, i
);
2355 elt
= Faref (seq
, ii
);
2358 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2366 /* where-is - finding a command in a set of keymaps. */
2368 static Lisp_Object
where_is_internal ();
2369 static Lisp_Object
where_is_internal_1 ();
2370 static void where_is_internal_2 ();
2372 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2373 Returns the first non-nil binding found in any of those maps. */
2376 shadow_lookup (shadow
, key
, flag
)
2377 Lisp_Object shadow
, key
, flag
;
2379 Lisp_Object tail
, value
;
2381 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2383 value
= Flookup_key (XCAR (tail
), key
, flag
);
2384 if (NATNUMP (value
))
2386 value
= Flookup_key (XCAR (tail
),
2387 Fsubstring (key
, make_number (0), value
), flag
);
2391 else if (!NILP (value
))
2397 static Lisp_Object Vmouse_events
;
2399 /* This function can GC if Flookup_key autoloads any keymaps. */
2402 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2403 Lisp_Object definition
, keymaps
;
2404 Lisp_Object firstonly
, noindirect
, no_remap
;
2406 Lisp_Object maps
= Qnil
;
2407 Lisp_Object found
, sequences
;
2408 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2409 /* 1 means ignore all menu bindings entirely. */
2410 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2412 /* If this command is remapped, then it has no key bindings
2414 if (NILP (no_remap
) && SYMBOLP (definition
))
2417 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2422 while (CONSP (found
))
2426 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2427 found
= XCDR (found
);
2430 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2434 for (; !NILP (maps
); maps
= Fcdr (maps
))
2436 /* Key sequence to reach map, and the map that it reaches */
2437 register Lisp_Object
this, map
, tem
;
2439 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2440 [M-CHAR] sequences, check if last character of the sequence
2441 is the meta-prefix char. */
2445 this = Fcar (Fcar (maps
));
2446 map
= Fcdr (Fcar (maps
));
2447 last
= make_number (XINT (Flength (this)) - 1);
2448 last_is_meta
= (XINT (last
) >= 0
2449 && EQ (Faref (this, last
), meta_prefix_char
));
2451 /* if (nomenus && !ascii_sequence_p (this)) */
2452 if (nomenus
&& XINT (last
) >= 0
2453 && SYMBOLP (tem
= Faref (this, make_number (0)))
2454 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2455 /* If no menu entries should be returned, skip over the
2456 keymaps bound to `menu-bar' and `tool-bar' and other
2457 non-ascii prefixes like `C-down-mouse-2'. */
2464 /* Because the code we want to run on each binding is rather
2465 large, we don't want to have two separate loop bodies for
2466 sparse keymap bindings and tables; we want to iterate one
2467 loop body over both keymap and vector bindings.
2469 For this reason, if Fcar (map) is a vector, we don't
2470 advance map to the next element until i indicates that we
2471 have finished off the vector. */
2472 Lisp_Object elt
, key
, binding
;
2480 /* Set key and binding to the current key and binding, and
2481 advance map and i to the next binding. */
2484 Lisp_Object sequence
;
2486 /* In a vector, look at each element. */
2487 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2489 binding
= AREF (elt
, i
);
2490 XSETFASTINT (key
, i
);
2491 sequence
= where_is_internal_1 (binding
, key
, definition
,
2493 last
, nomenus
, last_is_meta
);
2494 if (!NILP (sequence
))
2495 sequences
= Fcons (sequence
, sequences
);
2498 else if (CHAR_TABLE_P (elt
))
2502 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2503 Qnil
), /* Result accumulator. */
2504 Fcons (Fcons (this, last
),
2505 Fcons (make_number (nomenus
),
2506 make_number (last_is_meta
))));
2507 map_char_table (where_is_internal_2
, Qnil
, elt
, args
);
2508 sequences
= XCDR (XCAR (args
));
2510 else if (CONSP (elt
))
2512 Lisp_Object sequence
;
2515 binding
= XCDR (elt
);
2517 sequence
= where_is_internal_1 (binding
, key
, definition
,
2519 last
, nomenus
, last_is_meta
);
2520 if (!NILP (sequence
))
2521 sequences
= Fcons (sequence
, sequences
);
2525 while (!NILP (sequences
))
2527 Lisp_Object sequence
, remapped
, function
;
2529 sequence
= XCAR (sequences
);
2530 sequences
= XCDR (sequences
);
2532 /* If the current sequence is a command remapping with
2533 format [remap COMMAND], find the key sequences
2534 which run COMMAND, and use those sequences instead. */
2537 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2538 && EQ (AREF (sequence
, 0), Qremap
)
2539 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2541 Lisp_Object remapped1
;
2543 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2544 if (CONSP (remapped1
))
2546 /* Verify that this key binding actually maps to the
2547 remapped command (see below). */
2548 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2550 sequence
= XCAR (remapped1
);
2551 remapped
= XCDR (remapped1
);
2552 goto record_sequence
;
2556 /* Verify that this key binding is not shadowed by another
2557 binding for the same key, before we say it exists.
2559 Mechanism: look for local definition of this key and if
2560 it is defined and does not match what we found then
2563 Either nil or number as value from Flookup_key
2565 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2569 /* Don't annoy user with strings from a menu such as
2570 Select Paste. Change them all to "(any string)",
2571 so that there seems to be only one menu item
2573 if (! NILP (sequence
))
2576 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2578 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2579 build_string ("(any string)"));
2582 /* It is a true unshadowed match. Record it, unless it's already
2583 been seen (as could happen when inheriting keymaps). */
2584 if (NILP (Fmember (sequence
, found
)))
2585 found
= Fcons (sequence
, found
);
2587 /* If firstonly is Qnon_ascii, then we can return the first
2588 binding we find. If firstonly is not Qnon_ascii but not
2589 nil, then we should return the first ascii-only binding
2591 if (EQ (firstonly
, Qnon_ascii
))
2592 RETURN_UNGCPRO (sequence
);
2593 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2594 RETURN_UNGCPRO (sequence
);
2596 if (CONSP (remapped
))
2598 sequence
= XCAR (remapped
);
2599 remapped
= XCDR (remapped
);
2600 goto record_sequence
;
2608 found
= Fnreverse (found
);
2610 /* firstonly may have been t, but we may have gone all the way through
2611 the keymaps without finding an all-ASCII key sequence. So just
2612 return the best we could find. */
2613 if (!NILP (firstonly
))
2614 return Fcar (found
);
2619 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2620 doc
: /* Return list of keys that invoke DEFINITION.
2621 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2622 If KEYMAP is nil, search all the currently active keymaps.
2623 If KEYMAP is a list of keymaps, search only those keymaps.
2625 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2626 rather than a list of all possible key sequences.
2627 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2628 no matter what it is.
2629 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2630 \(or their meta variants) and entirely reject menu bindings.
2632 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2633 to other keymaps or slots. This makes it possible to search for an
2634 indirect definition itself.
2636 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2637 that invoke a command which is remapped to DEFINITION, but include the
2638 remapped command in the returned list. */)
2639 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2640 Lisp_Object definition
, keymap
;
2641 Lisp_Object firstonly
, noindirect
, no_remap
;
2643 Lisp_Object sequences
, keymaps
;
2644 /* 1 means ignore all menu bindings entirely. */
2645 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2648 /* Find the relevant keymaps. */
2649 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2651 else if (!NILP (keymap
))
2652 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2654 keymaps
= Fcurrent_active_maps (Qnil
);
2656 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2657 We don't really need to check `keymap'. */
2658 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2662 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2664 /* Check heuristic-consistency of the cache. */
2665 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2666 where_is_cache
= Qnil
;
2668 if (NILP (where_is_cache
))
2670 /* We need to create the cache. */
2671 Lisp_Object args
[2];
2672 where_is_cache
= Fmake_hash_table (0, args
);
2673 where_is_cache_keymaps
= Qt
;
2675 /* Fill in the cache. */
2676 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2677 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2680 where_is_cache_keymaps
= keymaps
;
2683 /* We want to process definitions from the last to the first.
2684 Instead of consing, copy definitions to a vector and step
2685 over that vector. */
2686 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2687 n
= XINT (Flength (sequences
));
2688 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2689 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2690 defns
[i
++] = XCAR (sequences
);
2692 /* Verify that the key bindings are not shadowed. Note that
2693 the following can GC. */
2694 GCPRO2 (definition
, keymaps
);
2697 for (i
= n
- 1; i
>= 0; --i
)
2698 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2700 if (ascii_sequence_p (defns
[i
]))
2706 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2711 /* Kill the cache so that where_is_internal_1 doesn't think
2712 we're filling it up. */
2713 where_is_cache
= Qnil
;
2714 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2720 /* This is the function that Fwhere_is_internal calls using map_char_table.
2722 (((DEFINITION . NOINDIRECT) . RESULT)
2724 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2725 Since map_char_table doesn't really use the return value from this function,
2726 we the result append to RESULT, the slot in ARGS.
2728 KEY may be a cons (FROM . TO) where both FROM and TO are integers
2729 (i.e. character events).
2731 This function can GC because it calls where_is_internal_1 which can
2735 where_is_internal_2 (args
, key
, binding
)
2736 Lisp_Object args
, key
, binding
;
2738 Lisp_Object definition
, noindirect
, this, last
;
2739 Lisp_Object result
, sequence
;
2740 int nomenus
, last_is_meta
;
2741 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2743 GCPRO3 (args
, key
, binding
);
2744 definition
= XCAR (XCAR (XCAR (args
)));
2745 noindirect
= XCDR (XCAR (XCAR (args
)));
2746 this = XCAR (XCAR (XCDR (args
)));
2747 last
= XCDR (XCAR (XCDR (args
)));
2748 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2749 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2752 if (CONSP (key
) && INTEGERP (XCAR (key
)) && INTEGERP (XCDR (key
)))
2754 /* Try all ASCII characters. Try also non-ASCII characters but
2755 only the first and last one because trying all of them is
2756 extremely memory and time consuming.
2758 Fixme: Perhaps it should be allowed to store a cons directly
2759 in RESULT. -- handa@m17n.org */
2760 int from
= XINT (XCAR (key
)), to
= XINT (XCDR (key
));
2763 for (; from
<= to
; to
--)
2765 k
= make_number (to
);
2766 sequence
= where_is_internal_1 (binding
, k
, definition
, noindirect
,
2767 this, last
, nomenus
, last_is_meta
);
2768 if (!NILP (sequence
))
2769 result
= Fcons (sequence
, result
);
2776 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2777 this, last
, nomenus
, last_is_meta
);
2778 if (!NILP (sequence
))
2779 result
= Fcons (sequence
, Qnil
);
2782 if (! NILP (result
))
2783 nconc2 (XCAR (args
), result
);
2789 /* This function can GC because get_keyelt can. */
2792 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2793 nomenus
, last_is_meta
)
2794 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2795 int nomenus
, last_is_meta
;
2797 Lisp_Object sequence
;
2799 /* Search through indirections unless that's not wanted. */
2800 if (NILP (noindirect
))
2801 binding
= get_keyelt (binding
, 0);
2803 /* End this iteration if this element does not match
2806 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2807 || EQ (binding
, definition
)
2808 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2809 /* Doesn't match. */
2812 /* We have found a match. Construct the key sequence where we found it. */
2813 if (INTEGERP (key
) && last_is_meta
)
2815 sequence
= Fcopy_sequence (this);
2816 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2819 sequence
= append_key (this, key
);
2821 if (!NILP (where_is_cache
))
2823 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2824 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2831 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2833 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2834 doc
: /* Insert the list of all defined keys and their definitions.
2835 The list is inserted in the current buffer, while the bindings are
2836 looked up in BUFFER.
2837 The optional argument PREFIX, if non-nil, should be a key sequence;
2838 then we display only bindings that start with that prefix.
2839 The optional argument MENUS, if non-nil, says to mention menu bindings.
2840 \(Ordinarily these are omitted from the output.) */)
2841 (buffer
, prefix
, menus
)
2842 Lisp_Object buffer
, prefix
, menus
;
2844 Lisp_Object outbuf
, shadow
;
2845 int nomenu
= NILP (menus
);
2846 register Lisp_Object start1
;
2847 struct gcpro gcpro1
;
2849 char *alternate_heading
2851 Keyboard translations:\n\n\
2852 You type Translation\n\
2853 -------- -----------\n";
2858 outbuf
= Fcurrent_buffer ();
2860 /* Report on alternates for keys. */
2861 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2864 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2865 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2867 for (c
= 0; c
< translate_len
; c
++)
2868 if (translate
[c
] != c
)
2870 char buf
[KEY_DESCRIPTION_SIZE
];
2873 if (alternate_heading
)
2875 insert_string (alternate_heading
);
2876 alternate_heading
= 0;
2879 bufend
= push_key_description (translate
[c
], buf
, 1);
2880 insert (buf
, bufend
- buf
);
2881 Findent_to (make_number (16), make_number (1));
2882 bufend
= push_key_description (c
, buf
, 1);
2883 insert (buf
, bufend
- buf
);
2887 /* Insert calls signal_after_change which may GC. */
2888 translate
= SDATA (Vkeyboard_translate_table
);
2894 if (!NILP (Vkey_translation_map
))
2895 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2896 "Key translations", nomenu
, 1, 0, 0);
2899 /* Print the (major mode) local map. */
2901 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2902 start1
= current_kboard
->Voverriding_terminal_local_map
;
2903 else if (!NILP (Voverriding_local_map
))
2904 start1
= Voverriding_local_map
;
2908 describe_map_tree (start1
, 1, shadow
, prefix
,
2909 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2910 shadow
= Fcons (start1
, shadow
);
2914 /* Print the minor mode and major mode keymaps. */
2916 Lisp_Object
*modes
, *maps
;
2918 /* Temporarily switch to `buffer', so that we can get that buffer's
2919 minor modes correctly. */
2920 Fset_buffer (buffer
);
2922 nmaps
= current_minor_maps (&modes
, &maps
);
2923 Fset_buffer (outbuf
);
2925 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2926 XBUFFER (buffer
), Qkeymap
);
2929 describe_map_tree (start1
, 1, shadow
, prefix
,
2930 "\f\n`keymap' Property Bindings", nomenu
,
2932 shadow
= Fcons (start1
, shadow
);
2935 /* Print the minor mode maps. */
2936 for (i
= 0; i
< nmaps
; i
++)
2938 /* The title for a minor mode keymap
2939 is constructed at run time.
2940 We let describe_map_tree do the actual insertion
2941 because it takes care of other features when doing so. */
2944 if (!SYMBOLP (modes
[i
]))
2947 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2951 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2952 SCHARS (SYMBOL_NAME (modes
[i
])));
2953 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2955 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2956 p
+= sizeof (" Minor Mode Bindings") - 1;
2959 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2960 title
, nomenu
, 0, 0, 0);
2961 shadow
= Fcons (maps
[i
], shadow
);
2964 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2965 XBUFFER (buffer
), Qlocal_map
);
2968 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2969 describe_map_tree (start1
, 1, shadow
, prefix
,
2970 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2972 describe_map_tree (start1
, 1, shadow
, prefix
,
2973 "\f\n`local-map' Property Bindings",
2976 shadow
= Fcons (start1
, shadow
);
2980 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2981 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2983 /* Print the function-key-map translations under this prefix. */
2984 if (!NILP (Vfunction_key_map
))
2985 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2986 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2992 /* Insert a description of the key bindings in STARTMAP,
2993 followed by those of all maps reachable through STARTMAP.
2994 If PARTIAL is nonzero, omit certain "uninteresting" commands
2995 (such as `undefined').
2996 If SHADOW is non-nil, it is a list of maps;
2997 don't mention keys which would be shadowed by any of them.
2998 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2999 TITLE, if not 0, is a string to insert at the beginning.
3000 TITLE should not end with a colon or a newline; we supply that.
3001 If NOMENU is not 0, then omit menu-bar commands.
3003 If TRANSL is nonzero, the definitions are actually key translations
3004 so print strings and vectors differently.
3006 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
3009 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
3010 don't omit it; instead, mention it but say it is shadowed. */
3013 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
3014 always_title
, mention_shadow
)
3015 Lisp_Object startmap
, shadow
, prefix
;
3023 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
3024 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3031 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3034 GCPRO3 (maps
, seen
, sub_shadows
);
3040 /* Delete from MAPS each element that is for the menu bar. */
3041 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3043 Lisp_Object elt
, prefix
, tem
;
3046 prefix
= Fcar (elt
);
3047 if (XVECTOR (prefix
)->size
>= 1)
3049 tem
= Faref (prefix
, make_number (0));
3050 if (EQ (tem
, Qmenu_bar
))
3051 maps
= Fdelq (elt
, maps
);
3056 if (!NILP (maps
) || always_title
)
3060 insert_string (title
);
3063 insert_string (" Starting With ");
3064 insert1 (Fkey_description (prefix
, Qnil
));
3066 insert_string (":\n");
3068 insert_string (key_heading
);
3072 for (; !NILP (maps
); maps
= Fcdr (maps
))
3074 register Lisp_Object elt
, prefix
, tail
;
3077 prefix
= Fcar (elt
);
3081 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3085 shmap
= XCAR (tail
);
3087 /* If the sequence by which we reach this keymap is zero-length,
3088 then the shadow map for this keymap is just SHADOW. */
3089 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3090 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3092 /* If the sequence by which we reach this keymap actually has
3093 some elements, then the sequence's definition in SHADOW is
3094 what we should use. */
3097 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3098 if (INTEGERP (shmap
))
3102 /* If shmap is not nil and not a keymap,
3103 it completely shadows this map, so don't
3104 describe this map at all. */
3105 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3109 sub_shadows
= Fcons (shmap
, sub_shadows
);
3112 /* Maps we have already listed in this loop shadow this map. */
3113 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3116 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3118 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3121 describe_map (Fcdr (elt
), prefix
,
3122 transl
? describe_translation
: describe_command
,
3123 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3129 insert_string ("\n");
3134 static int previous_description_column
;
3137 describe_command (definition
, args
)
3138 Lisp_Object definition
, args
;
3140 register Lisp_Object tem1
;
3141 int column
= (int) current_column (); /* iftc */
3142 int description_column
;
3144 /* If column 16 is no good, go to col 32;
3145 but don't push beyond that--go to next line instead. */
3149 description_column
= 32;
3151 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3152 description_column
= 32;
3154 description_column
= 16;
3156 Findent_to (make_number (description_column
), make_number (1));
3157 previous_description_column
= description_column
;
3159 if (SYMBOLP (definition
))
3161 tem1
= SYMBOL_NAME (definition
);
3163 insert_string ("\n");
3165 else if (STRINGP (definition
) || VECTORP (definition
))
3166 insert_string ("Keyboard Macro\n");
3167 else if (KEYMAPP (definition
))
3168 insert_string ("Prefix Command\n");
3170 insert_string ("??\n");
3174 describe_translation (definition
, args
)
3175 Lisp_Object definition
, args
;
3177 register Lisp_Object tem1
;
3179 Findent_to (make_number (16), make_number (1));
3181 if (SYMBOLP (definition
))
3183 tem1
= SYMBOL_NAME (definition
);
3185 insert_string ("\n");
3187 else if (STRINGP (definition
) || VECTORP (definition
))
3189 insert1 (Fkey_description (definition
, Qnil
));
3190 insert_string ("\n");
3192 else if (KEYMAPP (definition
))
3193 insert_string ("Prefix Command\n");
3195 insert_string ("??\n");
3198 /* describe_map puts all the usable elements of a sparse keymap
3199 into an array of `struct describe_map_elt',
3200 then sorts them by the events. */
3202 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3204 /* qsort comparison function for sorting `struct describe_map_elt' by
3208 describe_map_compare (aa
, bb
)
3209 const void *aa
, *bb
;
3211 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3212 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3213 return ((XINT (a
->event
) > XINT (b
->event
))
3214 - (XINT (a
->event
) < XINT (b
->event
)));
3215 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3217 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3219 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3220 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3221 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3226 /* Describe the contents of map MAP, assuming that this map itself is
3227 reached by the sequence of prefix keys PREFIX (a string or vector).
3228 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3231 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3232 seen
, nomenu
, mention_shadow
)
3233 register Lisp_Object map
;
3235 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3242 Lisp_Object tail
, definition
, event
;
3244 Lisp_Object suppress
;
3247 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3249 /* These accumulate the values from sparse keymap bindings,
3250 so we can sort them and handle them in order. */
3251 int length_needed
= 0;
3252 struct describe_map_elt
*vect
;
3259 suppress
= intern ("suppress-keymap");
3261 /* This vector gets used to present single keys to Flookup_key. Since
3262 that is done once per keymap element, we don't want to cons up a
3263 fresh vector every time. */
3264 kludge
= Fmake_vector (make_number (1), Qnil
);
3267 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3270 vect
= ((struct describe_map_elt
*)
3271 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3273 GCPRO3 (prefix
, definition
, kludge
);
3275 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3279 if (VECTORP (XCAR (tail
))
3280 || CHAR_TABLE_P (XCAR (tail
)))
3281 describe_vector (XCAR (tail
),
3282 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3283 (int *)0, 0, 1, mention_shadow
);
3284 else if (CONSP (XCAR (tail
)))
3286 int this_shadowed
= 0;
3288 event
= XCAR (XCAR (tail
));
3290 /* Ignore bindings whose "prefix" are not really valid events.
3291 (We get these in the frames and buffers menu.) */
3292 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3295 if (nomenu
&& EQ (event
, Qmenu_bar
))
3298 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3300 /* Don't show undefined commands or suppressed commands. */
3301 if (NILP (definition
)) continue;
3302 if (SYMBOLP (definition
) && partial
)
3304 tem
= Fget (definition
, suppress
);
3309 /* Don't show a command that isn't really visible
3310 because a local definition of the same key shadows it. */
3312 ASET (kludge
, 0, event
);
3315 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3325 tem
= Flookup_key (map
, kludge
, Qt
);
3326 if (!EQ (tem
, definition
)) continue;
3328 vect
[slots_used
].event
= event
;
3329 vect
[slots_used
].definition
= definition
;
3330 vect
[slots_used
].shadowed
= this_shadowed
;
3333 else if (EQ (XCAR (tail
), Qkeymap
))
3335 /* The same keymap might be in the structure twice, if we're
3336 using an inherited keymap. So skip anything we've already
3338 tem
= Fassq (tail
, *seen
);
3339 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3341 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3345 /* If we found some sparse map events, sort them. */
3347 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3348 describe_map_compare
);
3350 /* Now output them in sorted order. */
3352 for (i
= 0; i
< slots_used
; i
++)
3354 Lisp_Object start
, end
;
3358 previous_description_column
= 0;
3363 ASET (kludge
, 0, vect
[i
].event
);
3364 start
= vect
[i
].event
;
3367 definition
= vect
[i
].definition
;
3369 /* Find consecutive chars that are identically defined. */
3370 if (INTEGERP (vect
[i
].event
))
3372 while (i
+ 1 < slots_used
3373 && XINT (vect
[i
+ 1].event
) == XINT (vect
[i
].event
) + 1
3374 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3375 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3377 end
= vect
[i
].event
;
3380 /* Now START .. END is the range to describe next. */
3382 /* Insert the string to describe the event START. */
3383 insert1 (Fkey_description (kludge
, prefix
));
3385 if (!EQ (start
, end
))
3389 ASET (kludge
, 0, end
);
3390 /* Insert the string to describe the character END. */
3391 insert1 (Fkey_description (kludge
, prefix
));
3394 /* Print a description of the definition of this character.
3395 elt_describer will take care of spacing out far enough
3396 for alignment purposes. */
3397 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3399 if (vect
[i
].shadowed
)
3402 insert_string (" (binding currently shadowed)");
3411 describe_vector_princ (elt
, fun
)
3412 Lisp_Object elt
, fun
;
3414 Findent_to (make_number (16), make_number (1));
3419 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3420 doc
: /* Insert a description of contents of VECTOR.
3421 This is text showing the elements of vector matched against indices.
3422 DESCRIBER is the output function used; nil means use `princ'. */)
3424 Lisp_Object vector
, describer
;
3426 int count
= SPECPDL_INDEX ();
3427 if (NILP (describer
))
3428 describer
= intern ("princ");
3429 specbind (Qstandard_output
, Fcurrent_buffer ());
3430 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3431 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3432 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3434 return unbind_to (count
, Qnil
);
3437 /* Insert in the current buffer a description of the contents of VECTOR.
3438 We call ELT_DESCRIBER to insert the description of one value found
3441 ELT_PREFIX describes what "comes before" the keys or indices defined
3442 by this vector. This is a human-readable string whose size
3443 is not necessarily related to the situation.
3445 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3446 leads to this keymap.
3448 If the vector is a chartable, ELT_PREFIX is the vector
3449 of bytes that lead to the character set or portion of a character
3450 set described by this chartable.
3452 If PARTIAL is nonzero, it means do not mention suppressed commands
3453 (that assumes the vector is in a keymap).
3455 SHADOW is a list of keymaps that shadow this map.
3456 If it is non-nil, then we look up the key in those maps
3457 and we don't mention it now if it is defined by any of them.
3459 ENTIRE_MAP is the keymap in which this vector appears.
3460 If the definition in effect in the whole map does not match
3461 the one in this vector, we ignore this one.
3463 ARGS is simply passed as the second argument to ELT_DESCRIBER.
3465 INDICES and CHAR_TABLE_DEPTH are ignored. They will be removed in
3468 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3470 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3473 describe_vector (vector
, prefix
, args
, elt_describer
,
3474 partial
, shadow
, entire_map
,
3475 indices
, char_table_depth
, keymap_p
,
3477 register Lisp_Object vector
;
3478 Lisp_Object prefix
, args
;
3479 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3482 Lisp_Object entire_map
;
3484 int char_table_depth
;
3488 Lisp_Object definition
;
3490 Lisp_Object elt_prefix
= Qnil
;
3492 Lisp_Object suppress
;
3495 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3496 /* Range of elements to be handled. */
3498 Lisp_Object character
;
3507 /* Call Fkey_description first, to avoid GC bug for the other string. */
3508 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3511 tem
= Fkey_description (prefix
, Qnil
);
3512 elt_prefix
= concat2 (tem
, build_string (" "));
3517 /* This vector gets used to present single keys to Flookup_key. Since
3518 that is done once per vector element, we don't want to cons up a
3519 fresh vector every time. */
3520 kludge
= Fmake_vector (make_number (1), Qnil
);
3521 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3524 suppress
= intern ("suppress-keymap");
3527 to
= CHAR_TABLE_P (vector
) ? MAX_CHAR
+ 1 : XVECTOR (vector
)->size
;
3529 for (i
= from
; i
< to
; i
++)
3531 int this_shadowed
= 0;
3532 int range_beg
, range_end
;
3539 if (CHAR_TABLE_P (vector
))
3540 val
= char_table_ref_and_range (vector
, i
, &range_beg
, &i
);
3542 val
= AREF (vector
, i
);
3543 definition
= get_keyelt (val
, 0);
3545 if (NILP (definition
)) continue;
3547 /* Don't mention suppressed commands. */
3548 if (SYMBOLP (definition
) && partial
)
3552 tem
= Fget (definition
, suppress
);
3554 if (!NILP (tem
)) continue;
3557 character
= make_number (starting_i
);
3558 ASET (kludge
, 0, character
);
3560 /* If this binding is shadowed by some other map, ignore it. */
3565 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3576 /* Ignore this definition if it is shadowed by an earlier
3577 one in the same keymap. */
3578 if (!NILP (entire_map
))
3582 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3584 if (!EQ (tem
, definition
))
3594 /* Output the prefix that applies to every entry in this map. */
3595 if (!NILP (elt_prefix
))
3596 insert1 (elt_prefix
);
3598 insert1 (Fkey_description (kludge
, prefix
));
3600 /* Find all consecutive characters or rows that have the same
3601 definition. But, for elements of a top level char table, if
3602 they are for charsets, we had better describe one by one even
3603 if they have the same definition. */
3604 if (CHAR_TABLE_P (vector
))
3606 && (val
= char_table_ref_and_range (vector
, i
+ 1,
3607 &range_beg
, &range_end
),
3608 tem2
= get_keyelt (val
, 0),
3610 && !NILP (Fequal (tem2
, definition
)))
3614 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3616 && !NILP (Fequal (tem2
, definition
)))
3619 /* If we have a range of more than one character,
3620 print where the range reaches to. */
3622 if (i
!= starting_i
)
3626 ASET (kludge
, 0, make_number (i
));
3628 if (!NILP (elt_prefix
))
3629 insert1 (elt_prefix
);
3631 insert1 (Fkey_description (kludge
, prefix
));
3634 /* Print a description of the definition of this character.
3635 elt_describer will take care of spacing out far enough
3636 for alignment purposes. */
3637 (*elt_describer
) (definition
, args
);
3642 insert_string (" (binding currently shadowed)");
3647 if (CHAR_TABLE_P (vector
) && ! NILP (XCHAR_TABLE (vector
)->defalt
))
3649 if (!NILP (elt_prefix
))
3650 insert1 (elt_prefix
);
3651 insert ("default", 7);
3652 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3658 /* Apropos - finding all symbols whose names match a regexp. */
3659 static Lisp_Object apropos_predicate
;
3660 static Lisp_Object apropos_accumulate
;
3663 apropos_accum (symbol
, string
)
3664 Lisp_Object symbol
, string
;
3666 register Lisp_Object tem
;
3668 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3669 if (!NILP (tem
) && !NILP (apropos_predicate
))
3670 tem
= call1 (apropos_predicate
, symbol
);
3672 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3675 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3676 doc
: /* Show all symbols whose names contain match for REGEXP.
3677 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3678 for each symbol and a symbol is mentioned only if that returns non-nil.
3679 Return list of symbols found. */)
3681 Lisp_Object regexp
, predicate
;
3684 CHECK_STRING (regexp
);
3685 apropos_predicate
= predicate
;
3686 apropos_accumulate
= Qnil
;
3687 map_obarray (Vobarray
, apropos_accum
, regexp
);
3688 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3689 apropos_accumulate
= Qnil
;
3690 apropos_predicate
= Qnil
;
3697 Qkeymap
= intern ("keymap");
3698 staticpro (&Qkeymap
);
3699 staticpro (&apropos_predicate
);
3700 staticpro (&apropos_accumulate
);
3701 apropos_predicate
= Qnil
;
3702 apropos_accumulate
= Qnil
;
3704 /* Now we are ready to set up this property, so we can
3705 create char tables. */
3706 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3708 /* Initialize the keymaps standardly used.
3709 Each one is the value of a Lisp variable, and is also
3710 pointed to by a C variable */
3712 global_map
= Fmake_keymap (Qnil
);
3713 Fset (intern ("global-map"), global_map
);
3715 current_global_map
= global_map
;
3716 staticpro (&global_map
);
3717 staticpro (¤t_global_map
);
3719 meta_map
= Fmake_keymap (Qnil
);
3720 Fset (intern ("esc-map"), meta_map
);
3721 Ffset (intern ("ESC-prefix"), meta_map
);
3723 control_x_map
= Fmake_keymap (Qnil
);
3724 Fset (intern ("ctl-x-map"), control_x_map
);
3725 Ffset (intern ("Control-X-prefix"), control_x_map
);
3728 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3729 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3730 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3731 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3732 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3734 staticpro (&exclude_keys
);
3736 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3737 doc
: /* List of commands given new key bindings recently.
3738 This is used for internal purposes during Emacs startup;
3739 don't alter it yourself. */);
3740 Vdefine_key_rebound_commands
= Qt
;
3742 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3743 doc
: /* Default keymap to use when reading from the minibuffer. */);
3744 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3746 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3747 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3748 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3749 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3751 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3752 doc
: /* Local keymap for minibuffer input with completion. */);
3753 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3754 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3756 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3757 &Vminibuffer_local_filename_completion_map
,
3758 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3759 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3760 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3761 Vminibuffer_local_completion_map
);
3764 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3765 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3766 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3767 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3768 Vminibuffer_local_completion_map
);
3770 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3771 &Vminibuffer_local_must_match_filename_map
,
3772 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3773 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3774 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3775 Vminibuffer_local_must_match_map
);
3777 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3778 doc
: /* Alist of keymaps to use for minor modes.
3779 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3780 key sequences and look up bindings iff VARIABLE's value is non-nil.
3781 If two active keymaps bind the same key, the keymap appearing earlier
3782 in the list takes precedence. */);
3783 Vminor_mode_map_alist
= Qnil
;
3785 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3786 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3787 This variable is an alist just like `minor-mode-map-alist', and it is
3788 used the same way (and before `minor-mode-map-alist'); however,
3789 it is provided for major modes to bind locally. */);
3790 Vminor_mode_overriding_map_alist
= Qnil
;
3792 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3793 doc
: /* List of keymap alists to use for emulations modes.
3794 It is intended for modes or packages using multiple minor-mode keymaps.
3795 Each element is a keymap alist just like `minor-mode-map-alist', or a
3796 symbol with a variable binding which is a keymap alist, and it is used
3797 the same way. The "active" keymaps in each alist are used before
3798 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3799 Vemulation_mode_map_alists
= Qnil
;
3802 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3803 doc
: /* Keymap that translates key sequences to key sequences during input.
3804 This is used mainly for mapping ASCII function key sequences into
3805 real Emacs function key events (symbols).
3807 The `read-key-sequence' function replaces any subsequence bound by
3808 `function-key-map' with its binding. More precisely, when the active
3809 keymaps have no binding for the current key sequence but
3810 `function-key-map' binds a suffix of the sequence to a vector or string,
3811 `read-key-sequence' replaces the matching suffix with its binding, and
3812 continues with the new sequence.
3814 If the binding is a function, it is called with one argument (the prompt)
3815 and its return value (a key sequence) is used.
3817 The events that come from bindings in `function-key-map' are not
3818 themselves looked up in `function-key-map'.
3820 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3821 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3822 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3823 key, typing `ESC O P x' would return [f1 x]. */);
3824 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3826 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3827 doc
: /* Keymap of key translations that can override keymaps.
3828 This keymap works like `function-key-map', but comes after that,
3829 and its non-prefix bindings override ordinary bindings. */);
3830 Vkey_translation_map
= Qnil
;
3832 staticpro (&Vmouse_events
);
3833 Vmouse_events
= Fcons (intern ("menu-bar"),
3834 Fcons (intern ("tool-bar"),
3835 Fcons (intern ("header-line"),
3836 Fcons (intern ("mode-line"),
3837 Fcons (intern ("mouse-1"),
3838 Fcons (intern ("mouse-2"),
3839 Fcons (intern ("mouse-3"),
3840 Fcons (intern ("mouse-4"),
3841 Fcons (intern ("mouse-5"),
3845 Qsingle_key_description
= intern ("single-key-description");
3846 staticpro (&Qsingle_key_description
);
3848 Qkey_description
= intern ("key-description");
3849 staticpro (&Qkey_description
);
3851 Qkeymapp
= intern ("keymapp");
3852 staticpro (&Qkeymapp
);
3854 Qnon_ascii
= intern ("non-ascii");
3855 staticpro (&Qnon_ascii
);
3857 Qmenu_item
= intern ("menu-item");
3858 staticpro (&Qmenu_item
);
3860 Qremap
= intern ("remap");
3861 staticpro (&Qremap
);
3863 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3864 staticpro (&command_remapping_vector
);
3866 where_is_cache_keymaps
= Qt
;
3867 where_is_cache
= Qnil
;
3868 staticpro (&where_is_cache
);
3869 staticpro (&where_is_cache_keymaps
);
3871 defsubr (&Skeymapp
);
3872 defsubr (&Skeymap_parent
);
3873 defsubr (&Skeymap_prompt
);
3874 defsubr (&Sset_keymap_parent
);
3875 defsubr (&Smake_keymap
);
3876 defsubr (&Smake_sparse_keymap
);
3877 defsubr (&Smap_keymap
);
3878 defsubr (&Scopy_keymap
);
3879 defsubr (&Scommand_remapping
);
3880 defsubr (&Skey_binding
);
3881 defsubr (&Slocal_key_binding
);
3882 defsubr (&Sglobal_key_binding
);
3883 defsubr (&Sminor_mode_key_binding
);
3884 defsubr (&Sdefine_key
);
3885 defsubr (&Slookup_key
);
3886 defsubr (&Sdefine_prefix_command
);
3887 defsubr (&Suse_global_map
);
3888 defsubr (&Suse_local_map
);
3889 defsubr (&Scurrent_local_map
);
3890 defsubr (&Scurrent_global_map
);
3891 defsubr (&Scurrent_minor_mode_maps
);
3892 defsubr (&Scurrent_active_maps
);
3893 defsubr (&Saccessible_keymaps
);
3894 defsubr (&Skey_description
);
3895 defsubr (&Sdescribe_vector
);
3896 defsubr (&Ssingle_key_description
);
3897 defsubr (&Stext_char_description
);
3898 defsubr (&Swhere_is_internal
);
3899 defsubr (&Sdescribe_buffer_bindings
);
3900 defsubr (&Sapropos_internal
);
3906 initial_define_key (global_map
, 033, "ESC-prefix");
3907 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
3910 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
3911 (do not change this comment) */