1 /* Manipulation of keymaps
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
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 /* A list of all commands given new bindings since a certain time
91 when nil was stored here.
92 This is used to speed up recomputation of menu key equivalents
93 when Emacs starts up. t means don't record anything here. */
94 Lisp_Object Vdefine_key_rebound_commands
;
96 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
98 /* Alist of elements like (DEL . "\d"). */
99 static Lisp_Object exclude_keys
;
101 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
102 static Lisp_Object command_remapping_vector
;
104 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
105 in a string key sequence is equivalent to prefixing with this
107 extern Lisp_Object meta_prefix_char
;
109 extern Lisp_Object Voverriding_local_map
;
111 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
112 static Lisp_Object where_is_cache
;
113 /* Which keymaps are reverse-stored in the cache. */
114 static Lisp_Object where_is_cache_keymaps
;
116 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
117 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
119 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
120 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
121 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
122 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
123 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
124 int, Lisp_Object
, Lisp_Object
*, int, int));
125 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
126 void (*) (Lisp_Object
, Lisp_Object
), int,
127 Lisp_Object
, Lisp_Object
, int *,
129 static void silly_event_symbol_error
P_ ((Lisp_Object
));
131 /* Keymap object support - constructors and predicates. */
133 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
134 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
135 CHARTABLE is a char-table that holds the bindings for all characters
136 without modifiers. All entries in it are initially nil, meaning
137 "command undefined". ALIST is an assoc-list which holds bindings for
138 function keys, mouse events, and any other things that appear in the
139 input stream. Initially, ALIST is nil.
141 The optional arg STRING supplies a menu name for the keymap
142 in case you use it as a menu with `x-popup-menu'. */)
148 tail
= Fcons (string
, Qnil
);
151 return Fcons (Qkeymap
,
152 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
155 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
156 doc
: /* Construct and return a new sparse keymap.
157 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
158 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
159 which binds the function key or mouse event SYMBOL to DEFINITION.
160 Initially the alist is nil.
162 The optional arg STRING supplies a menu name for the keymap
163 in case you use it as a menu with `x-popup-menu'. */)
168 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
169 return Fcons (Qkeymap
, Qnil
);
172 /* This function is used for installing the standard key bindings
173 at initialization time.
177 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
180 initial_define_key (keymap
, key
, defname
)
185 store_in_keymap (keymap
, make_number (key
), intern (defname
));
189 initial_define_lispy_key (keymap
, keyname
, defname
)
194 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
197 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
198 doc
: /* Return t if OBJECT is a keymap.
200 A keymap is a list (keymap . ALIST),
201 or a symbol whose function definition is itself a keymap.
202 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
203 a vector of densely packed bindings for small character codes
204 is also allowed as an element. */)
208 return (KEYMAPP (object
) ? Qt
: Qnil
);
211 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
212 doc
: /* Return the prompt-string of a keymap MAP.
213 If non-nil, the prompt is shown in the echo-area
214 when reading a key-sequence to be looked-up in this keymap. */)
218 map
= get_keymap (map
, 0, 0);
221 Lisp_Object tem
= XCAR (map
);
229 /* Check that OBJECT is a keymap (after dereferencing through any
230 symbols). If it is, return it.
232 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
233 is an autoload form, do the autoload and try again.
234 If AUTOLOAD is nonzero, callers must assume GC is possible.
236 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
237 is zero as well), return Qt.
239 ERROR controls how we respond if OBJECT isn't a keymap.
240 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
242 Note that most of the time, we don't want to pursue autoloads.
243 Functions like Faccessible_keymaps which scan entire keymap trees
244 shouldn't load every autoloaded keymap. I'm not sure about this,
245 but it seems to me that only read_key_sequence, Flookup_key, and
246 Fdefine_key should cause keymaps to be autoloaded.
248 This function can GC when AUTOLOAD is non-zero, because it calls
249 do_autoload which can GC. */
252 get_keymap (object
, error
, autoload
)
261 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
264 tem
= indirect_function (object
);
267 if (EQ (XCAR (tem
), Qkeymap
))
270 /* Should we do an autoload? Autoload forms for keymaps have
271 Qkeymap as their fifth element. */
272 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
)
277 tail
= Fnth (make_number (4), tem
);
278 if (EQ (tail
, Qkeymap
))
282 struct gcpro gcpro1
, gcpro2
;
284 GCPRO2 (tem
, object
);
285 do_autoload (tem
, object
);
298 wrong_type_argument (Qkeymapp
, object
);
302 /* Return the parent map of KEYMAP, or nil if it has none.
303 We assume that KEYMAP is a valid keymap. */
306 keymap_parent (keymap
, autoload
)
312 keymap
= get_keymap (keymap
, 1, autoload
);
314 /* Skip past the initial element `keymap'. */
315 list
= XCDR (keymap
);
316 for (; CONSP (list
); list
= XCDR (list
))
318 /* See if there is another `keymap'. */
323 return get_keymap (list
, 0, autoload
);
326 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
327 doc
: /* Return the parent keymap of KEYMAP. */)
331 return keymap_parent (keymap
, 1);
334 /* Check whether MAP is one of MAPS parents. */
336 keymap_memberp (map
, maps
)
337 Lisp_Object map
, maps
;
339 if (NILP (map
)) return 0;
340 while (KEYMAPP (maps
) && !EQ (map
, maps
))
341 maps
= keymap_parent (maps
, 0);
342 return (EQ (map
, maps
));
345 /* Set the parent keymap of MAP to PARENT. */
347 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
348 doc
: /* Modify KEYMAP to set its parent map to PARENT.
349 Return PARENT. PARENT should be nil or another keymap. */)
351 Lisp_Object keymap
, parent
;
353 Lisp_Object list
, prev
;
354 struct gcpro gcpro1
, gcpro2
;
357 /* Force a keymap flush for the next call to where-is.
358 Since this can be called from within where-is, we don't set where_is_cache
359 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
360 be changed during where-is, while where_is_cache_keymaps is only used at
361 the very beginning of where-is and can thus be changed here without any
363 This is a very minor correctness (rather than safety) issue. */
364 where_is_cache_keymaps
= Qt
;
366 GCPRO2 (keymap
, parent
);
367 keymap
= get_keymap (keymap
, 1, 1);
371 parent
= get_keymap (parent
, 1, 1);
373 /* Check for cycles. */
374 if (keymap_memberp (keymap
, parent
))
375 error ("Cyclic keymap inheritance");
378 /* Skip past the initial element `keymap'. */
383 /* If there is a parent keymap here, replace it.
384 If we came to the end, add the parent in PREV. */
385 if (!CONSP (list
) || KEYMAPP (list
))
387 /* If we already have the right parent, return now
388 so that we avoid the loops below. */
389 if (EQ (XCDR (prev
), parent
))
390 RETURN_UNGCPRO (parent
);
393 XSETCDR (prev
, parent
);
399 /* Scan through for submaps, and set their parents too. */
401 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
403 /* Stop the scan when we come to the parent. */
404 if (EQ (XCAR (list
), Qkeymap
))
407 /* If this element holds a prefix map, deal with it. */
408 if (CONSP (XCAR (list
))
409 && CONSP (XCDR (XCAR (list
))))
410 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
413 if (VECTORP (XCAR (list
)))
414 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
415 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
416 fix_submap_inheritance (keymap
, make_number (i
),
417 XVECTOR (XCAR (list
))->contents
[i
]);
419 if (CHAR_TABLE_P (XCAR (list
)))
421 Lisp_Object indices
[3];
423 map_char_table (fix_submap_inheritance
, Qnil
,
424 XCAR (list
), XCAR (list
),
429 RETURN_UNGCPRO (parent
);
432 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
433 if EVENT is also a prefix in MAP's parent,
434 make sure that SUBMAP inherits that definition as its own parent. */
437 fix_submap_inheritance (map
, event
, submap
)
438 Lisp_Object map
, event
, submap
;
440 Lisp_Object map_parent
, parent_entry
;
442 /* SUBMAP is a cons that we found as a key binding.
443 Discard the other things found in a menu key binding. */
445 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
447 /* If it isn't a keymap now, there's no work to do. */
451 map_parent
= keymap_parent (map
, 0);
452 if (!NILP (map_parent
))
454 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
458 /* If MAP's parent has something other than a keymap,
459 our own submap shadows it completely. */
460 if (!CONSP (parent_entry
))
463 if (! EQ (parent_entry
, submap
))
465 Lisp_Object submap_parent
;
466 submap_parent
= submap
;
471 tem
= keymap_parent (submap_parent
, 0);
475 if (keymap_memberp (tem
, parent_entry
))
476 /* Fset_keymap_parent could create a cycle. */
483 Fset_keymap_parent (submap_parent
, parent_entry
);
487 /* Look up IDX in MAP. IDX may be any sort of event.
488 Note that this does only one level of lookup; IDX must be a single
489 event, not a sequence.
491 If T_OK is non-zero, bindings for Qt are treated as default
492 bindings; any key left unmentioned by other tables and bindings is
493 given the binding of Qt.
495 If T_OK is zero, bindings for Qt are not treated specially.
497 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
500 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
509 /* Qunbound in VAL means we have found no binding yet. */
512 /* If idx is a list (some sort of mouse click, perhaps?),
513 the index we want to use is the car of the list, which
514 ought to be a symbol. */
515 idx
= EVENT_HEAD (idx
);
517 /* If idx is a symbol, it might have modifiers, which need to
518 be put in the canonical order. */
520 idx
= reorder_modifiers (idx
);
521 else if (INTEGERP (idx
))
522 /* Clobber the high bits that can be present on a machine
523 with more than 24 bits of integer. */
524 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
526 /* Handle the special meta -> esc mapping. */
527 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
529 /* See if there is a meta-map. If there's none, there is
530 no binding for IDX, unless a default binding exists in MAP. */
532 Lisp_Object meta_map
;
534 /* A strange value in which Meta is set would cause
535 infinite recursion. Protect against that. */
536 if (XINT (meta_prefix_char
) & CHAR_META
)
537 meta_prefix_char
= make_number (27);
538 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
539 t_ok
, noinherit
, autoload
),
542 if (CONSP (meta_map
))
545 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
548 /* Set IDX to t, so that we only find a default binding. */
551 /* We know there is no binding. */
555 /* t_binding is where we put a default binding that applies,
556 to use in case we do not find a binding specifically
557 for this key sequence. */
560 Lisp_Object t_binding
= Qnil
;
561 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
563 GCPRO4 (map
, tail
, idx
, t_binding
);
565 /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
566 If it is 1, only generic-char bindings are accepted.
567 Otherwise, neither are. */
570 for (tail
= XCDR (map
);
572 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
577 binding
= XCAR (tail
);
578 if (SYMBOLP (binding
))
580 /* If NOINHERIT, stop finding prefix definitions
581 after we pass a second occurrence of the `keymap' symbol. */
582 if (noinherit
&& EQ (binding
, Qkeymap
))
583 RETURN_UNGCPRO (Qnil
);
585 else if (CONSP (binding
))
587 Lisp_Object key
= XCAR (binding
);
590 val
= XCDR (binding
);
593 && (XINT (idx
) & CHAR_MODIFIER_MASK
) == 0
595 && (XINT (key
) & CHAR_MODIFIER_MASK
) == 0
596 && !SINGLE_BYTE_CHAR_P (XINT (idx
))
597 && !SINGLE_BYTE_CHAR_P (XINT (key
))
598 && CHAR_VALID_P (XINT (key
), 1)
599 && !CHAR_VALID_P (XINT (key
), 0)
600 && (CHAR_CHARSET (XINT (key
))
601 == CHAR_CHARSET (XINT (idx
))))
603 /* KEY is the generic character of the charset of IDX.
604 Use KEY's binding if there isn't a binding for IDX
606 t_binding
= XCDR (binding
);
609 else if (t_ok
> 1 && EQ (key
, Qt
))
611 t_binding
= XCDR (binding
);
615 else if (VECTORP (binding
))
617 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
618 val
= AREF (binding
, XFASTINT (idx
));
620 else if (CHAR_TABLE_P (binding
))
622 /* Character codes with modifiers
623 are not included in a char-table.
624 All character codes without modifiers are included. */
625 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
627 val
= Faref (binding
, idx
);
628 /* `nil' has a special meaning for char-tables, so
629 we use something else to record an explicitly
636 /* If we found a binding, clean it up and return it. */
637 if (!EQ (val
, Qunbound
))
640 /* A Qt binding is just like an explicit nil binding
641 (i.e. it shadows any parent binding but not bindings in
642 keymaps of lower precedence). */
644 val
= get_keyelt (val
, autoload
);
646 fix_submap_inheritance (map
, idx
, val
);
647 RETURN_UNGCPRO (val
);
652 return get_keyelt (t_binding
, autoload
);
657 map_keymap_item (fun
, args
, key
, val
, data
)
658 map_keymap_function_t fun
;
659 Lisp_Object args
, key
, val
;
662 /* We should maybe try to detect bindings shadowed by previous
663 ones and things like that. */
666 (*fun
) (key
, val
, args
, data
);
670 map_keymap_char_table_item (args
, key
, val
)
671 Lisp_Object args
, key
, val
;
675 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
677 map_keymap_item (fun
, XCDR (args
), key
, val
,
678 XSAVE_VALUE (XCAR (args
))->pointer
);
682 /* Call FUN for every binding in MAP.
683 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
684 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
686 map_keymap (map
, fun
, args
, data
, autoload
)
687 map_keymap_function_t fun
;
688 Lisp_Object map
, args
;
692 struct gcpro gcpro1
, gcpro2
, gcpro3
;
696 GCPRO3 (map
, args
, tail
);
697 map
= get_keymap (map
, 1, autoload
);
698 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
699 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
702 Lisp_Object binding
= XCAR (tail
);
705 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
706 else if (VECTORP (binding
))
708 /* Loop over the char values represented in the vector. */
709 int len
= ASIZE (binding
);
711 for (c
= 0; c
< len
; c
++)
713 Lisp_Object character
;
714 XSETFASTINT (character
, c
);
715 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
718 else if (CHAR_TABLE_P (binding
))
720 Lisp_Object indices
[3];
721 map_char_table (map_keymap_char_table_item
, Qnil
, binding
, binding
,
722 Fcons (make_save_value (fun
, 0),
723 Fcons (make_save_value (data
, 0),
732 map_keymap_call (key
, val
, fun
, dummy
)
733 Lisp_Object key
, val
, fun
;
736 call2 (fun
, key
, val
);
739 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
740 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
741 FUNCTION is called with two arguments: the event that is bound, and
742 the definition it is bound to.
744 If KEYMAP has a parent, the parent's bindings are included as well.
745 This works recursively: if the parent has itself a parent, then the
746 grandparent's bindings are also included and so on.
747 usage: (map-keymap FUNCTION KEYMAP) */)
748 (function
, keymap
, sort_first
)
749 Lisp_Object function
, keymap
, sort_first
;
751 if (INTEGERP (function
))
752 /* We have to stop integers early since map_keymap gives them special
754 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
755 if (! NILP (sort_first
))
756 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
758 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
762 /* Given OBJECT which was found in a slot in a keymap,
763 trace indirect definitions to get the actual definition of that slot.
764 An indirect definition is a list of the form
765 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
766 and INDEX is the object to look up in KEYMAP to yield the definition.
768 Also if OBJECT has a menu string as the first element,
769 remove that. Also remove a menu help string as second element.
771 If AUTOLOAD is nonzero, load autoloadable keymaps
772 that are referred to with indirection.
774 This can GC because menu_item_eval_property calls Feval. */
777 get_keyelt (object
, autoload
)
783 if (!(CONSP (object
)))
784 /* This is really the value. */
787 /* If the keymap contents looks like (keymap ...) or (lambda ...)
789 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
792 /* If the keymap contents looks like (menu-item name . DEFN)
793 or (menu-item name DEFN ...) then use DEFN.
794 This is a new format menu item. */
795 else if (EQ (XCAR (object
), Qmenu_item
))
797 if (CONSP (XCDR (object
)))
801 object
= XCDR (XCDR (object
));
804 object
= XCAR (object
);
806 /* If there's a `:filter FILTER', apply FILTER to the
807 menu-item's definition to get the real definition to
809 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
810 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
813 filter
= XCAR (XCDR (tem
));
814 filter
= list2 (filter
, list2 (Qquote
, object
));
815 object
= menu_item_eval_property (filter
);
820 /* Invalid keymap. */
824 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
825 Keymap alist elements like (CHAR MENUSTRING . DEFN)
826 will be used by HierarKey menus. */
827 else if (STRINGP (XCAR (object
)))
829 object
= XCDR (object
);
830 /* Also remove a menu help string, if any,
831 following the menu item name. */
832 if (CONSP (object
) && STRINGP (XCAR (object
)))
833 object
= XCDR (object
);
834 /* Also remove the sublist that caches key equivalences, if any. */
835 if (CONSP (object
) && CONSP (XCAR (object
)))
838 carcar
= XCAR (XCAR (object
));
839 if (NILP (carcar
) || VECTORP (carcar
))
840 object
= XCDR (object
);
844 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
850 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
852 return (!CONSP (map
) ? object
/* Invalid keymap */
853 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
859 store_in_keymap (keymap
, idx
, def
)
861 register Lisp_Object idx
;
862 register Lisp_Object def
;
864 /* Flush any reverse-map cache. */
865 where_is_cache
= Qnil
;
866 where_is_cache_keymaps
= Qt
;
868 /* If we are preparing to dump, and DEF is a menu element
869 with a menu item indicator, copy it to ensure it is not pure. */
870 if (CONSP (def
) && PURE_P (def
)
871 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
872 def
= Fcons (XCAR (def
), XCDR (def
));
874 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
875 error ("attempt to define a key in a non-keymap");
877 /* If idx is a list (some sort of mouse click, perhaps?),
878 the index we want to use is the car of the list, which
879 ought to be a symbol. */
880 idx
= EVENT_HEAD (idx
);
882 /* If idx is a symbol, it might have modifiers, which need to
883 be put in the canonical order. */
885 idx
= reorder_modifiers (idx
);
886 else if (INTEGERP (idx
))
887 /* Clobber the high bits that can be present on a machine
888 with more than 24 bits of integer. */
889 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
891 /* Scan the keymap for a binding of idx. */
895 /* The cons after which we should insert new bindings. If the
896 keymap has a table element, we record its position here, so new
897 bindings will go after it; this way, the table will stay
898 towards the front of the alist and character lookups in dense
899 keymaps will remain fast. Otherwise, this just points at the
900 front of the keymap. */
901 Lisp_Object insertion_point
;
903 insertion_point
= keymap
;
904 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
911 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
914 ASET (elt
, XFASTINT (idx
), def
);
917 insertion_point
= tail
;
919 else if (CHAR_TABLE_P (elt
))
921 /* Character codes with modifiers
922 are not included in a char-table.
923 All character codes without modifiers are included. */
924 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
927 /* `nil' has a special meaning for char-tables, so
928 we use something else to record an explicitly
930 NILP (def
) ? Qt
: def
);
933 insertion_point
= tail
;
935 else if (CONSP (elt
))
937 if (EQ (idx
, XCAR (elt
)))
944 else if (EQ (elt
, Qkeymap
))
945 /* If we find a 'keymap' symbol in the spine of KEYMAP,
946 then we must have found the start of a second keymap
947 being used as the tail of KEYMAP, and a binding for IDX
948 should be inserted before it. */
955 /* We have scanned the entire keymap, and not found a binding for
956 IDX. Let's add one. */
957 CHECK_IMPURE (insertion_point
);
958 XSETCDR (insertion_point
,
959 Fcons (Fcons (idx
, def
), XCDR (insertion_point
)));
965 EXFUN (Fcopy_keymap
, 1);
968 copy_keymap_item (elt
)
971 Lisp_Object res
, tem
;
978 /* Is this a new format menu item. */
979 if (EQ (XCAR (tem
), Qmenu_item
))
981 /* Copy cell with menu-item marker. */
982 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
986 /* Copy cell with menu-item name. */
987 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
993 /* Copy cell with binding and if the binding is a keymap,
995 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
998 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
999 XSETCAR (elt
, Fcopy_keymap (tem
));
1001 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1002 /* Delete cache for key equivalences. */
1003 XSETCDR (elt
, XCDR (tem
));
1008 /* It may be an old fomat menu item.
1009 Skip the optional menu string. */
1010 if (STRINGP (XCAR (tem
)))
1012 /* Copy the cell, since copy-alist didn't go this deep. */
1013 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1015 /* Also skip the optional menu help string. */
1016 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1018 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1022 /* There may also be a list that caches key equivalences.
1023 Just delete it for the new keymap. */
1025 && CONSP (XCAR (tem
))
1026 && (NILP (XCAR (XCAR (tem
)))
1027 || VECTORP (XCAR (XCAR (tem
)))))
1029 XSETCDR (elt
, XCDR (tem
));
1032 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1033 XSETCDR (elt
, Fcopy_keymap (tem
));
1035 else if (EQ (XCAR (tem
), Qkeymap
))
1036 res
= Fcopy_keymap (elt
);
1042 copy_keymap_1 (chartable
, idx
, elt
)
1043 Lisp_Object chartable
, idx
, elt
;
1045 Faset (chartable
, idx
, copy_keymap_item (elt
));
1048 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1049 doc
: /* Return a copy of the keymap KEYMAP.
1050 The copy starts out with the same definitions of KEYMAP,
1051 but changing either the copy or KEYMAP does not affect the other.
1052 Any key definitions that are subkeymaps are recursively copied.
1053 However, a key definition which is a symbol whose definition is a keymap
1058 register Lisp_Object copy
, tail
;
1059 keymap
= get_keymap (keymap
, 1, 0);
1060 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1061 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1063 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1065 Lisp_Object elt
= XCAR (keymap
);
1066 if (CHAR_TABLE_P (elt
))
1068 Lisp_Object indices
[3];
1069 elt
= Fcopy_sequence (elt
);
1070 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, elt
, 0, indices
);
1072 else if (VECTORP (elt
))
1075 elt
= Fcopy_sequence (elt
);
1076 for (i
= 0; i
< ASIZE (elt
); i
++)
1077 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1079 else if (CONSP (elt
))
1080 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1081 XSETCDR (tail
, Fcons (elt
, Qnil
));
1083 keymap
= XCDR (keymap
);
1085 XSETCDR (tail
, keymap
);
1089 /* Simple Keymap mutators and accessors. */
1091 /* GC is possible in this function if it autoloads a keymap. */
1093 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1094 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1097 KEY is a string or a vector of symbols and characters meaning a
1098 sequence of keystrokes and events. Non-ASCII characters with codes
1099 above 127 (such as ISO Latin-1) can be included if you use a vector.
1100 Using [t] for KEY creates a default definition, which applies to any
1101 event type that has no other definition in this keymap.
1103 DEF is anything that can be a key's definition:
1104 nil (means key is undefined in this keymap),
1105 a command (a Lisp function suitable for interactive calling),
1106 a string (treated as a keyboard macro),
1107 a keymap (to define a prefix key),
1108 a symbol (when the key is looked up, the symbol will stand for its
1109 function definition, which should at that time be one of the above,
1110 or another symbol whose function definition is used, etc.),
1111 a cons (STRING . DEFN), meaning that DEFN is the definition
1112 (DEFN should be a valid definition in its own right),
1113 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1115 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1116 binding is altered. If there is no binding for KEY, the new pair
1117 binding KEY to DEF is added at the front of KEYMAP. */)
1124 register Lisp_Object c
;
1125 register Lisp_Object cmd
;
1129 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1131 GCPRO3 (keymap
, key
, def
);
1132 keymap
= get_keymap (keymap
, 1, 1);
1134 if (!VECTORP (key
) && !STRINGP (key
))
1135 key
= wrong_type_argument (Qarrayp
, key
);
1137 length
= XFASTINT (Flength (key
));
1139 RETURN_UNGCPRO (Qnil
);
1141 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1142 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1144 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1149 c
= Faref (key
, make_number (idx
));
1151 if (CONSP (c
) && lucid_event_type_list_p (c
))
1152 c
= Fevent_convert_list (c
);
1155 silly_event_symbol_error (c
);
1158 && (XINT (c
) & meta_bit
)
1161 c
= meta_prefix_char
;
1167 XSETINT (c
, XINT (c
) & ~meta_bit
);
1173 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1174 error ("Key sequence contains invalid event");
1177 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1179 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1181 /* If this key is undefined, make it a prefix. */
1183 cmd
= define_as_prefix (keymap
, c
);
1185 keymap
= get_keymap (cmd
, 0, 1);
1186 if (!CONSP (keymap
))
1187 /* We must use Fkey_description rather than just passing key to
1188 error; key might be a vector, not a string. */
1189 error ("Key sequence %s uses invalid prefix characters",
1190 SDATA (Fkey_description (key
, Qnil
)));
1194 /* This function may GC (it calls Fkey_binding). */
1196 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1197 doc
: /* Return the remapping for command COMMAND in current keymaps.
1198 Returns nil if COMMAND is not remapped (or not a symbol). */)
1200 Lisp_Object command
;
1202 if (!SYMBOLP (command
))
1205 ASET (command_remapping_vector
, 1, command
);
1206 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1209 /* Value is number if KEY is too long; nil if valid but has no definition. */
1210 /* GC is possible in this function if it autoloads a keymap. */
1212 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1213 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1214 nil means undefined. See doc of `define-key' for kinds of definitions.
1216 A number as value means KEY is "too long";
1217 that is, characters or symbols in it except for the last one
1218 fail to be a valid sequence of prefix characters in KEYMAP.
1219 The number is how many characters at the front of KEY
1220 it takes to reach a non-prefix key.
1222 Normally, `lookup-key' ignores bindings for t, which act as default
1223 bindings, used when nothing else in the keymap applies; this makes it
1224 usable as a general function for probing keymaps. However, if the
1225 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1226 recognize the default bindings, just as `read-key-sequence' does. */)
1227 (keymap
, key
, accept_default
)
1230 Lisp_Object accept_default
;
1233 register Lisp_Object cmd
;
1234 register Lisp_Object c
;
1236 int t_ok
= !NILP (accept_default
);
1237 struct gcpro gcpro1
, gcpro2
;
1239 GCPRO2 (keymap
, key
);
1240 keymap
= get_keymap (keymap
, 1, 1);
1242 if (!VECTORP (key
) && !STRINGP (key
))
1243 key
= wrong_type_argument (Qarrayp
, key
);
1245 length
= XFASTINT (Flength (key
));
1247 RETURN_UNGCPRO (keymap
);
1252 c
= Faref (key
, make_number (idx
++));
1254 if (CONSP (c
) && lucid_event_type_list_p (c
))
1255 c
= Fevent_convert_list (c
);
1257 /* Turn the 8th bit of string chars into a meta modifier. */
1258 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1259 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1261 /* Allow string since binding for `menu-bar-select-buffer'
1262 includes the buffer name in the key sequence. */
1263 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1264 error ("Key sequence contains invalid event");
1266 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1268 RETURN_UNGCPRO (cmd
);
1270 keymap
= get_keymap (cmd
, 0, 1);
1271 if (!CONSP (keymap
))
1272 RETURN_UNGCPRO (make_number (idx
));
1278 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1279 Assume that currently it does not define C at all.
1280 Return the keymap. */
1283 define_as_prefix (keymap
, c
)
1284 Lisp_Object keymap
, c
;
1288 cmd
= Fmake_sparse_keymap (Qnil
);
1289 /* If this key is defined as a prefix in an inherited keymap,
1290 make it a prefix in this map, and make its definition
1291 inherit the other prefix definition. */
1292 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1293 store_in_keymap (keymap
, c
, cmd
);
1298 /* Append a key to the end of a key sequence. We always make a vector. */
1301 append_key (key_sequence
, key
)
1302 Lisp_Object key_sequence
, key
;
1304 Lisp_Object args
[2];
1306 args
[0] = key_sequence
;
1308 args
[1] = Fcons (key
, Qnil
);
1309 return Fvconcat (2, args
);
1312 /* Given a event type C which is a symbol,
1313 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1316 silly_event_symbol_error (c
)
1319 Lisp_Object parsed
, base
, name
, assoc
;
1322 parsed
= parse_modifiers (c
);
1323 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1324 base
= XCAR (parsed
);
1325 name
= Fsymbol_name (base
);
1326 /* This alist includes elements such as ("RET" . "\\r"). */
1327 assoc
= Fassoc (name
, exclude_keys
);
1331 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1333 Lisp_Object keystring
;
1334 if (modifiers
& alt_modifier
)
1335 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1336 if (modifiers
& ctrl_modifier
)
1337 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1338 if (modifiers
& hyper_modifier
)
1339 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1340 if (modifiers
& meta_modifier
)
1341 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1342 if (modifiers
& shift_modifier
)
1343 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1344 if (modifiers
& super_modifier
)
1345 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1348 c
= reorder_modifiers (c
);
1349 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1351 error ((modifiers
& ~meta_modifier
1352 ? "To bind the key %s, use [?%s], not [%s]"
1353 : "To bind the key %s, use \"%s\", not [%s]"),
1354 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1355 SDATA (SYMBOL_NAME (c
)));
1359 /* Global, local, and minor mode keymap stuff. */
1361 /* We can't put these variables inside current_minor_maps, since under
1362 some systems, static gets macro-defined to be the empty string.
1364 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1365 static int cmm_size
= 0;
1367 /* Store a pointer to an array of the keymaps of the currently active
1368 minor modes in *buf, and return the number of maps it contains.
1370 This function always returns a pointer to the same buffer, and may
1371 free or reallocate it, so if you want to keep it for a long time or
1372 hand it out to lisp code, copy it. This procedure will be called
1373 for every key sequence read, so the nice lispy approach (return a
1374 new assoclist, list, what have you) for each invocation would
1375 result in a lot of consing over time.
1377 If we used xrealloc/xmalloc and ran out of memory, they would throw
1378 back to the command loop, which would try to read a key sequence,
1379 which would call this function again, resulting in an infinite
1380 loop. Instead, we'll use realloc/malloc and silently truncate the
1381 list, let the key sequence be read, and hope some other piece of
1382 code signals the error. */
1384 current_minor_maps (modeptr
, mapptr
)
1385 Lisp_Object
**modeptr
, **mapptr
;
1388 int list_number
= 0;
1389 Lisp_Object alist
, assoc
, var
, val
;
1390 Lisp_Object emulation_alists
;
1391 Lisp_Object lists
[2];
1393 emulation_alists
= Vemulation_mode_map_alists
;
1394 lists
[0] = Vminor_mode_overriding_map_alist
;
1395 lists
[1] = Vminor_mode_map_alist
;
1397 for (list_number
= 0; list_number
< 2; list_number
++)
1399 if (CONSP (emulation_alists
))
1401 alist
= XCAR (emulation_alists
);
1402 emulation_alists
= XCDR (emulation_alists
);
1403 if (SYMBOLP (alist
))
1404 alist
= find_symbol_value (alist
);
1408 alist
= lists
[list_number
];
1410 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1411 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1412 && (var
= XCAR (assoc
), SYMBOLP (var
))
1413 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1418 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1419 and also an entry in Vminor_mode_map_alist,
1420 ignore the latter. */
1421 if (list_number
== 1)
1423 val
= assq_no_quit (var
, lists
[0]);
1430 int newsize
, allocsize
;
1431 Lisp_Object
*newmodes
, *newmaps
;
1433 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1434 allocsize
= newsize
* sizeof *newmodes
;
1436 /* Use malloc here. See the comment above this function.
1437 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1439 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1444 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1447 cmm_modes
= newmodes
;
1450 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1455 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1462 if (newmodes
== NULL
|| newmaps
== NULL
)
1467 /* Get the keymap definition--or nil if it is not defined. */
1468 temp
= Findirect_function (XCDR (assoc
), Qt
);
1472 cmm_maps
[i
] = temp
;
1478 if (modeptr
) *modeptr
= cmm_modes
;
1479 if (mapptr
) *mapptr
= cmm_maps
;
1483 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1485 doc
: /* Return a list of the currently active keymaps.
1486 OLP if non-nil indicates that we should obey `overriding-local-map' and
1487 `overriding-terminal-local-map'. */)
1491 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1495 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1496 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1497 /* The doc said that overriding-terminal-local-map should
1498 override overriding-local-map. The code used them both,
1499 but it seems clearer to use just one. rms, jan 2005. */
1500 else if (!NILP (Voverriding_local_map
))
1501 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1503 if (NILP (XCDR (keymaps
)))
1509 /* This usually returns the buffer's local map,
1510 but that can be overridden by a `local-map' property. */
1511 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1513 keymaps
= Fcons (local
, keymaps
);
1515 /* Now put all the minor mode keymaps on the list. */
1516 nmaps
= current_minor_maps (0, &maps
);
1518 for (i
= --nmaps
; i
>= 0; i
--)
1519 if (!NILP (maps
[i
]))
1520 keymaps
= Fcons (maps
[i
], keymaps
);
1522 /* This returns nil unless there is a `keymap' property. */
1523 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1525 keymaps
= Fcons (local
, keymaps
);
1531 /* GC is possible in this function if it autoloads a keymap. */
1533 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1534 doc
: /* Return the binding for command KEY in current keymaps.
1535 KEY is a string or vector, a sequence of keystrokes.
1536 The binding is probably a symbol with a function definition.
1538 Normally, `key-binding' ignores bindings for t, which act as default
1539 bindings, used when nothing else in the keymap applies; this makes it
1540 usable as a general function for probing keymaps. However, if the
1541 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1542 recognize the default bindings, just as `read-key-sequence' does.
1544 Like the normal command loop, `key-binding' will remap the command
1545 resulting from looking up KEY by looking up the command in the
1546 current keymaps. However, if the optional third argument NO-REMAP
1547 is non-nil, `key-binding' returns the unmapped command. */)
1548 (key
, accept_default
, no_remap
)
1549 Lisp_Object key
, accept_default
, no_remap
;
1551 Lisp_Object
*maps
, value
;
1553 struct gcpro gcpro1
;
1557 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1559 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1560 key
, accept_default
);
1561 if (! NILP (value
) && !INTEGERP (value
))
1564 else if (!NILP (Voverriding_local_map
))
1566 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1567 if (! NILP (value
) && !INTEGERP (value
))
1574 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1577 value
= Flookup_key (local
, key
, accept_default
);
1578 if (! NILP (value
) && !INTEGERP (value
))
1582 nmaps
= current_minor_maps (0, &maps
);
1583 /* Note that all these maps are GCPRO'd
1584 in the places where we found them. */
1586 for (i
= 0; i
< nmaps
; i
++)
1587 if (! NILP (maps
[i
]))
1589 value
= Flookup_key (maps
[i
], key
, accept_default
);
1590 if (! NILP (value
) && !INTEGERP (value
))
1594 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1597 value
= Flookup_key (local
, key
, accept_default
);
1598 if (! NILP (value
) && !INTEGERP (value
))
1603 value
= Flookup_key (current_global_map
, key
, accept_default
);
1607 if (NILP (value
) || INTEGERP (value
))
1610 /* If the result of the ordinary keymap lookup is an interactive
1611 command, look for a key binding (ie. remapping) for that command. */
1613 if (NILP (no_remap
) && SYMBOLP (value
))
1616 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1623 /* GC is possible in this function if it autoloads a keymap. */
1625 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1626 doc
: /* Return the binding for command KEYS in current local keymap only.
1627 KEYS is a string or vector, a sequence of keystrokes.
1628 The binding is probably a symbol with a function definition.
1630 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1631 bindings; see the description of `lookup-key' for more details about this. */)
1632 (keys
, accept_default
)
1633 Lisp_Object keys
, accept_default
;
1635 register Lisp_Object map
;
1636 map
= current_buffer
->keymap
;
1639 return Flookup_key (map
, keys
, accept_default
);
1642 /* GC is possible in this function if it autoloads a keymap. */
1644 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1645 doc
: /* Return the binding for command KEYS in current global keymap only.
1646 KEYS is a string or vector, a sequence of keystrokes.
1647 The binding is probably a symbol with a function definition.
1648 This function's return values are the same as those of `lookup-key'
1651 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1652 bindings; see the description of `lookup-key' for more details about this. */)
1653 (keys
, accept_default
)
1654 Lisp_Object keys
, accept_default
;
1656 return Flookup_key (current_global_map
, keys
, accept_default
);
1659 /* GC is possible in this function if it autoloads a keymap. */
1661 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1662 doc
: /* Find the visible minor mode bindings of KEY.
1663 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1664 the symbol which names the minor mode binding KEY, and BINDING is
1665 KEY's definition in that mode. In particular, if KEY has no
1666 minor-mode bindings, return nil. If the first binding is a
1667 non-prefix, all subsequent bindings will be omitted, since they would
1668 be ignored. Similarly, the list doesn't include non-prefix bindings
1669 that come after prefix bindings.
1671 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1672 bindings; see the description of `lookup-key' for more details about this. */)
1673 (key
, accept_default
)
1674 Lisp_Object key
, accept_default
;
1676 Lisp_Object
*modes
, *maps
;
1678 Lisp_Object binding
;
1680 struct gcpro gcpro1
, gcpro2
;
1682 nmaps
= current_minor_maps (&modes
, &maps
);
1683 /* Note that all these maps are GCPRO'd
1684 in the places where we found them. */
1687 GCPRO2 (key
, binding
);
1689 for (i
= j
= 0; i
< nmaps
; i
++)
1691 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1692 && !INTEGERP (binding
))
1694 if (KEYMAPP (binding
))
1695 maps
[j
++] = Fcons (modes
[i
], binding
);
1697 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1701 return Flist (j
, maps
);
1704 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1705 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1706 A new sparse keymap is stored as COMMAND's function definition and its value.
1707 If a second optional argument MAPVAR is given, the map is stored as
1708 its value instead of as COMMAND's value; but COMMAND is still defined
1710 The third optional argument NAME, if given, supplies a menu name
1711 string for the map. This is required to use the keymap as a menu.
1712 This function returns COMMAND. */)
1713 (command
, mapvar
, name
)
1714 Lisp_Object command
, mapvar
, name
;
1717 map
= Fmake_sparse_keymap (name
);
1718 Ffset (command
, map
);
1722 Fset (command
, map
);
1726 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1727 doc
: /* Select KEYMAP as the global keymap. */)
1731 keymap
= get_keymap (keymap
, 1, 1);
1732 current_global_map
= keymap
;
1737 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1738 doc
: /* Select KEYMAP as the local keymap.
1739 If KEYMAP is nil, that means no local keymap. */)
1744 keymap
= get_keymap (keymap
, 1, 1);
1746 current_buffer
->keymap
= keymap
;
1751 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1752 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1755 return current_buffer
->keymap
;
1758 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1759 doc
: /* Return the current global keymap. */)
1762 return current_global_map
;
1765 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1766 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1770 int nmaps
= current_minor_maps (0, &maps
);
1772 return Flist (nmaps
, maps
);
1775 /* Help functions for describing and documenting keymaps. */
1779 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1780 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1781 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1785 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1789 /* Look for and break cycles. */
1790 while (!NILP (tem
= Frassq (cmd
, maps
)))
1792 Lisp_Object prefix
= XCAR (tem
);
1793 int lim
= XINT (Flength (XCAR (tem
)));
1794 if (lim
<= XINT (Flength (thisseq
)))
1795 { /* This keymap was already seen with a smaller prefix. */
1797 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1798 Faref (thisseq
, make_number (i
))))
1801 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1804 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1805 but maybe `cmd' occurs again further down in `maps', so keep
1807 maps
= XCDR (Fmemq (tem
, maps
));
1810 /* If the last key in thisseq is meta-prefix-char,
1811 turn it into a meta-ized keystroke. We know
1812 that the event we're about to append is an
1813 ascii keystroke since we're processing a
1817 int meta_bit
= meta_modifier
;
1818 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1819 tem
= Fcopy_sequence (thisseq
);
1821 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1823 /* This new sequence is the same length as
1824 thisseq, so stick it in the list right
1827 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1831 tem
= append_key (thisseq
, key
);
1832 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1837 accessible_keymaps_char_table (args
, index
, cmd
)
1838 Lisp_Object args
, index
, cmd
;
1840 accessible_keymaps_1 (index
, cmd
,
1844 XINT (XCDR (XCAR (args
))));
1847 /* This function cannot GC. */
1849 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1851 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1852 Returns a list of elements of the form (KEYS . MAP), where the sequence
1853 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1854 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1855 An optional argument PREFIX, if non-nil, should be a key sequence;
1856 then the value includes only maps for prefixes that start with PREFIX. */)
1858 Lisp_Object keymap
, prefix
;
1860 Lisp_Object maps
, tail
;
1863 /* no need for gcpro because we don't autoload any keymaps. */
1866 prefixlen
= XINT (Flength (prefix
));
1870 /* If a prefix was specified, start with the keymap (if any) for
1871 that prefix, so we don't waste time considering other prefixes. */
1873 tem
= Flookup_key (keymap
, prefix
, Qt
);
1874 /* Flookup_key may give us nil, or a number,
1875 if the prefix is not defined in this particular map.
1876 It might even give us a list that isn't a keymap. */
1877 tem
= get_keymap (tem
, 0, 0);
1880 /* Convert PREFIX to a vector now, so that later on
1881 we don't have to deal with the possibility of a string. */
1882 if (STRINGP (prefix
))
1887 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1888 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1892 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1893 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1894 c
^= 0200 | meta_modifier
;
1895 ASET (copy
, i_before
, make_number (c
));
1899 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1905 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1906 get_keymap (keymap
, 1, 0)),
1909 /* For each map in the list maps,
1910 look at any other maps it points to,
1911 and stick them at the end if they are not already in the list.
1913 This is a breadth-first traversal, where tail is the queue of
1914 nodes, and maps accumulates a list of all nodes visited. */
1916 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1918 register Lisp_Object thisseq
, thismap
;
1920 /* Does the current sequence end in the meta-prefix-char? */
1923 thisseq
= Fcar (Fcar (tail
));
1924 thismap
= Fcdr (Fcar (tail
));
1925 last
= make_number (XINT (Flength (thisseq
)) - 1);
1926 is_metized
= (XINT (last
) >= 0
1927 /* Don't metize the last char of PREFIX. */
1928 && XINT (last
) >= prefixlen
1929 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1931 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1935 elt
= XCAR (thismap
);
1939 if (CHAR_TABLE_P (elt
))
1941 Lisp_Object indices
[3];
1943 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
1944 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1945 Fcons (tail
, thisseq
)),
1948 else if (VECTORP (elt
))
1952 /* Vector keymap. Scan all the elements. */
1953 for (i
= 0; i
< ASIZE (elt
); i
++)
1954 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1955 maps
, tail
, thisseq
, is_metized
);
1958 else if (CONSP (elt
))
1959 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1960 maps
, tail
, thisseq
,
1961 is_metized
&& INTEGERP (XCAR (elt
)));
1969 Lisp_Object Qsingle_key_description
, Qkey_description
;
1971 /* This function cannot GC. */
1973 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
1974 doc
: /* Return a pretty description of key-sequence KEYS.
1975 Optional arg PREFIX is the sequence of keys leading up to KEYS.
1976 Control characters turn into "C-foo" sequences, meta into "M-foo",
1977 spaces are put between sequence elements, etc. */)
1979 Lisp_Object keys
, prefix
;
1984 int size
= XINT (Flength (keys
));
1986 Lisp_Object sep
= build_string (" ");
1991 size
+= XINT (Flength (prefix
));
1993 /* This has one extra element at the end that we don't pass to Fconcat. */
1994 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
1996 /* In effect, this computes
1997 (mapconcat 'single-key-description keys " ")
1998 but we shouldn't use mapconcat because it can do GC. */
2002 list
= prefix
, prefix
= Qnil
;
2003 else if (!NILP (keys
))
2004 list
= keys
, keys
= Qnil
;
2009 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2013 return empty_string
;
2014 return Fconcat (len
- 1, args
);
2018 size
= SCHARS (list
);
2019 else if (VECTORP (list
))
2020 size
= XVECTOR (list
)->size
;
2021 else if (CONSP (list
))
2022 size
= XINT (Flength (list
));
2024 wrong_type_argument (Qarrayp
, list
);
2033 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2034 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2035 c
^= 0200 | meta_modifier
;
2036 XSETFASTINT (key
, c
);
2038 else if (VECTORP (list
))
2040 key
= AREF (list
, i
++);
2052 || EQ (key
, meta_prefix_char
)
2053 || (XINT (key
) & meta_modifier
))
2055 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2057 if (EQ (key
, meta_prefix_char
))
2061 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2064 else if (EQ (key
, meta_prefix_char
))
2069 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2077 push_key_description (c
, p
, force_multibyte
)
2078 register unsigned int c
;
2080 int force_multibyte
;
2084 /* Clear all the meaningless bits above the meta bit. */
2085 c
&= meta_modifier
| ~ - meta_modifier
;
2086 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2087 | meta_modifier
| shift_modifier
| super_modifier
);
2089 if (c
& alt_modifier
)
2095 if ((c
& ctrl_modifier
) != 0
2096 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2100 c
&= ~ctrl_modifier
;
2102 if (c
& hyper_modifier
)
2106 c
-= hyper_modifier
;
2108 if (c
& meta_modifier
)
2114 if (c
& shift_modifier
)
2118 c
-= shift_modifier
;
2120 if (c
& super_modifier
)
2124 c
-= super_modifier
;
2140 else if (c
== Ctl ('M'))
2148 /* `C-' already added above. */
2149 if (c
> 0 && c
<= Ctl ('Z'))
2168 || (NILP (current_buffer
->enable_multibyte_characters
)
2169 && SINGLE_BYTE_CHAR_P (c
)
2170 && !force_multibyte
))
2176 int valid_p
= SINGLE_BYTE_CHAR_P (c
) || char_valid_p (c
, 0);
2178 if (force_multibyte
&& valid_p
)
2180 if (SINGLE_BYTE_CHAR_P (c
))
2181 c
= unibyte_char_to_multibyte (c
);
2182 p
+= CHAR_STRING (c
, p
);
2184 else if (NILP (current_buffer
->enable_multibyte_characters
)
2189 /* The biggest character code uses 19 bits. */
2190 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2192 if (c
>= (1 << bit_offset
))
2193 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2197 p
+= CHAR_STRING (c
, p
);
2203 /* This function cannot GC. */
2205 DEFUN ("single-key-description", Fsingle_key_description
,
2206 Ssingle_key_description
, 1, 2, 0,
2207 doc
: /* Return a pretty description of command character KEY.
2208 Control characters turn into C-whatever, etc.
2209 Optional argument NO-ANGLES non-nil means don't put angle brackets
2210 around function keys and event symbols. */)
2212 Lisp_Object key
, no_angles
;
2214 if (CONSP (key
) && lucid_event_type_list_p (key
))
2215 key
= Fevent_convert_list (key
);
2217 key
= EVENT_HEAD (key
);
2219 if (INTEGERP (key
)) /* Normal character */
2221 unsigned int charset
, c1
, c2
;
2222 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2224 if (SINGLE_BYTE_CHAR_P (without_bits
))
2227 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2230 && CHARSET_DEFINED_P (charset
)
2231 && ((c1
>= 0 && c1
< 32)
2232 || (c2
>= 0 && c2
< 32)))
2234 /* Handle a generic character. */
2236 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
2237 CHECK_STRING (name
);
2238 return concat2 (build_string ("Character set "), name
);
2242 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2246 end
= push_key_description (XUINT (key
), tem
, 1);
2248 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2249 if (nchars
== nbytes
)
2252 string
= build_string (tem
);
2255 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2259 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2261 if (NILP (no_angles
))
2264 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2265 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2266 return build_string (buffer
);
2269 return Fsymbol_name (key
);
2271 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2272 return Fcopy_sequence (key
);
2274 error ("KEY must be an integer, cons, symbol, or string");
2279 push_text_char_description (c
, p
)
2280 register unsigned int c
;
2292 *p
++ = c
+ 64; /* 'A' - 1 */
2304 /* This function cannot GC. */
2306 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2307 doc
: /* Return a pretty description of file-character CHARACTER.
2308 Control characters turn into "^char", etc. This differs from
2309 `single-key-description' which turns them into "C-char".
2310 Also, this function recognizes the 2**7 bit as the Meta character,
2311 whereas `single-key-description' uses the 2**27 bit for Meta.
2312 See Info node `(elisp)Describing Characters' for examples. */)
2314 Lisp_Object character
;
2316 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2317 unsigned char str
[6];
2320 CHECK_NUMBER (character
);
2322 c
= XINT (character
);
2323 if (!SINGLE_BYTE_CHAR_P (c
))
2325 int len
= CHAR_STRING (c
, str
);
2327 return make_multibyte_string (str
, 1, len
);
2330 *push_text_char_description (c
& 0377, str
) = 0;
2332 return build_string (str
);
2335 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2338 ascii_sequence_p (seq
)
2342 int len
= XINT (Flength (seq
));
2344 for (i
= 0; i
< len
; i
++)
2346 Lisp_Object ii
, elt
;
2348 XSETFASTINT (ii
, i
);
2349 elt
= Faref (seq
, ii
);
2352 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2360 /* where-is - finding a command in a set of keymaps. */
2362 static Lisp_Object
where_is_internal ();
2363 static Lisp_Object
where_is_internal_1 ();
2364 static void where_is_internal_2 ();
2366 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2367 Returns the first non-nil binding found in any of those maps. */
2370 shadow_lookup (shadow
, key
, flag
)
2371 Lisp_Object shadow
, key
, flag
;
2373 Lisp_Object tail
, value
;
2375 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2377 value
= Flookup_key (XCAR (tail
), key
, flag
);
2378 if (NATNUMP (value
))
2380 value
= Flookup_key (XCAR (tail
),
2381 Fsubstring (key
, make_number (0), value
), flag
);
2385 else if (!NILP (value
))
2391 static Lisp_Object Vmouse_events
;
2393 /* This function can GC if Flookup_key autoloads any keymaps. */
2396 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2397 Lisp_Object definition
, keymaps
;
2398 Lisp_Object firstonly
, noindirect
, no_remap
;
2400 Lisp_Object maps
= Qnil
;
2401 Lisp_Object found
, sequences
;
2402 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2403 /* 1 means ignore all menu bindings entirely. */
2404 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2406 /* If this command is remapped, then it has no key bindings
2408 if (NILP (no_remap
) && SYMBOLP (definition
))
2411 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2416 while (CONSP (found
))
2420 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2421 found
= XCDR (found
);
2424 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2428 for (; !NILP (maps
); maps
= Fcdr (maps
))
2430 /* Key sequence to reach map, and the map that it reaches */
2431 register Lisp_Object
this, map
, tem
;
2433 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2434 [M-CHAR] sequences, check if last character of the sequence
2435 is the meta-prefix char. */
2439 this = Fcar (Fcar (maps
));
2440 map
= Fcdr (Fcar (maps
));
2441 last
= make_number (XINT (Flength (this)) - 1);
2442 last_is_meta
= (XINT (last
) >= 0
2443 && EQ (Faref (this, last
), meta_prefix_char
));
2445 /* if (nomenus && !ascii_sequence_p (this)) */
2446 if (nomenus
&& XINT (last
) >= 0
2447 && SYMBOLP (tem
= Faref (this, make_number (0)))
2448 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2449 /* If no menu entries should be returned, skip over the
2450 keymaps bound to `menu-bar' and `tool-bar' and other
2451 non-ascii prefixes like `C-down-mouse-2'. */
2458 /* Because the code we want to run on each binding is rather
2459 large, we don't want to have two separate loop bodies for
2460 sparse keymap bindings and tables; we want to iterate one
2461 loop body over both keymap and vector bindings.
2463 For this reason, if Fcar (map) is a vector, we don't
2464 advance map to the next element until i indicates that we
2465 have finished off the vector. */
2466 Lisp_Object elt
, key
, binding
;
2474 /* Set key and binding to the current key and binding, and
2475 advance map and i to the next binding. */
2478 Lisp_Object sequence
;
2480 /* In a vector, look at each element. */
2481 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2483 binding
= AREF (elt
, i
);
2484 XSETFASTINT (key
, i
);
2485 sequence
= where_is_internal_1 (binding
, key
, definition
,
2487 last
, nomenus
, last_is_meta
);
2488 if (!NILP (sequence
))
2489 sequences
= Fcons (sequence
, sequences
);
2492 else if (CHAR_TABLE_P (elt
))
2494 Lisp_Object indices
[3];
2497 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2498 Qnil
), /* Result accumulator. */
2499 Fcons (Fcons (this, last
),
2500 Fcons (make_number (nomenus
),
2501 make_number (last_is_meta
))));
2502 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2504 sequences
= XCDR (XCAR (args
));
2506 else if (CONSP (elt
))
2508 Lisp_Object sequence
;
2511 binding
= XCDR (elt
);
2513 sequence
= where_is_internal_1 (binding
, key
, definition
,
2515 last
, nomenus
, last_is_meta
);
2516 if (!NILP (sequence
))
2517 sequences
= Fcons (sequence
, sequences
);
2521 while (!NILP (sequences
))
2523 Lisp_Object sequence
, remapped
, function
;
2525 sequence
= XCAR (sequences
);
2526 sequences
= XCDR (sequences
);
2528 /* If the current sequence is a command remapping with
2529 format [remap COMMAND], find the key sequences
2530 which run COMMAND, and use those sequences instead. */
2533 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2534 && EQ (AREF (sequence
, 0), Qremap
)
2535 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2537 Lisp_Object remapped1
;
2539 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2540 if (CONSP (remapped1
))
2542 /* Verify that this key binding actually maps to the
2543 remapped command (see below). */
2544 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2546 sequence
= XCAR (remapped1
);
2547 remapped
= XCDR (remapped1
);
2548 goto record_sequence
;
2552 /* Verify that this key binding is not shadowed by another
2553 binding for the same key, before we say it exists.
2555 Mechanism: look for local definition of this key and if
2556 it is defined and does not match what we found then
2559 Either nil or number as value from Flookup_key
2561 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2565 /* Don't annoy user with strings from a menu such as
2566 Select Paste. Change them all to "(any string)",
2567 so that there seems to be only one menu item
2569 if (! NILP (sequence
))
2572 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2574 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2575 build_string ("(any string)"));
2578 /* It is a true unshadowed match. Record it, unless it's already
2579 been seen (as could happen when inheriting keymaps). */
2580 if (NILP (Fmember (sequence
, found
)))
2581 found
= Fcons (sequence
, found
);
2583 /* If firstonly is Qnon_ascii, then we can return the first
2584 binding we find. If firstonly is not Qnon_ascii but not
2585 nil, then we should return the first ascii-only binding
2587 if (EQ (firstonly
, Qnon_ascii
))
2588 RETURN_UNGCPRO (sequence
);
2589 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2590 RETURN_UNGCPRO (sequence
);
2592 if (CONSP (remapped
))
2594 sequence
= XCAR (remapped
);
2595 remapped
= XCDR (remapped
);
2596 goto record_sequence
;
2604 found
= Fnreverse (found
);
2606 /* firstonly may have been t, but we may have gone all the way through
2607 the keymaps without finding an all-ASCII key sequence. So just
2608 return the best we could find. */
2609 if (!NILP (firstonly
))
2610 return Fcar (found
);
2615 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2616 doc
: /* Return list of keys that invoke DEFINITION.
2617 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2618 If KEYMAP is nil, search all the currently active keymaps.
2619 If KEYMAP is a list of keymaps, search only those keymaps.
2621 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2622 rather than a list of all possible key sequences.
2623 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2624 no matter what it is.
2625 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2626 \(or their meta variants) and entirely reject menu bindings.
2628 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2629 to other keymaps or slots. This makes it possible to search for an
2630 indirect definition itself.
2632 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2633 that invoke a command which is remapped to DEFINITION, but include the
2634 remapped command in the returned list. */)
2635 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2636 Lisp_Object definition
, keymap
;
2637 Lisp_Object firstonly
, noindirect
, no_remap
;
2639 Lisp_Object sequences
, keymaps
;
2640 /* 1 means ignore all menu bindings entirely. */
2641 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2644 /* Find the relevant keymaps. */
2645 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2647 else if (!NILP (keymap
))
2648 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2650 keymaps
= Fcurrent_active_maps (Qnil
);
2652 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2653 We don't really need to check `keymap'. */
2654 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2658 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2660 /* Check heuristic-consistency of the cache. */
2661 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2662 where_is_cache
= Qnil
;
2664 if (NILP (where_is_cache
))
2666 /* We need to create the cache. */
2667 Lisp_Object args
[2];
2668 where_is_cache
= Fmake_hash_table (0, args
);
2669 where_is_cache_keymaps
= Qt
;
2671 /* Fill in the cache. */
2672 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2673 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2676 where_is_cache_keymaps
= keymaps
;
2679 /* We want to process definitions from the last to the first.
2680 Instead of consing, copy definitions to a vector and step
2681 over that vector. */
2682 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2683 n
= XINT (Flength (sequences
));
2684 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2685 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2686 defns
[i
++] = XCAR (sequences
);
2688 /* Verify that the key bindings are not shadowed. Note that
2689 the following can GC. */
2690 GCPRO2 (definition
, keymaps
);
2693 for (i
= n
- 1; i
>= 0; --i
)
2694 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2696 if (ascii_sequence_p (defns
[i
]))
2702 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2707 /* Kill the cache so that where_is_internal_1 doesn't think
2708 we're filling it up. */
2709 where_is_cache
= Qnil
;
2710 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2716 /* This is the function that Fwhere_is_internal calls using map_char_table.
2718 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2720 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2721 Since map_char_table doesn't really use the return value from this function,
2722 we the result append to RESULT, the slot in ARGS.
2724 This function can GC because it calls where_is_internal_1 which can
2728 where_is_internal_2 (args
, key
, binding
)
2729 Lisp_Object args
, key
, binding
;
2731 Lisp_Object definition
, noindirect
, this, last
;
2732 Lisp_Object result
, sequence
;
2733 int nomenus
, last_is_meta
;
2734 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2736 GCPRO3 (args
, key
, binding
);
2737 result
= XCDR (XCAR (args
));
2738 definition
= XCAR (XCAR (XCAR (args
)));
2739 noindirect
= XCDR (XCAR (XCAR (args
)));
2740 this = XCAR (XCAR (XCDR (args
)));
2741 last
= XCDR (XCAR (XCDR (args
)));
2742 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2743 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2745 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2746 this, last
, nomenus
, last_is_meta
);
2748 if (!NILP (sequence
))
2749 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2755 /* This function can GC because get_keyelt can. */
2758 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2759 nomenus
, last_is_meta
)
2760 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2761 int nomenus
, last_is_meta
;
2763 Lisp_Object sequence
;
2765 /* Search through indirections unless that's not wanted. */
2766 if (NILP (noindirect
))
2767 binding
= get_keyelt (binding
, 0);
2769 /* End this iteration if this element does not match
2772 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2773 || EQ (binding
, definition
)
2774 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2775 /* Doesn't match. */
2778 /* We have found a match. Construct the key sequence where we found it. */
2779 if (INTEGERP (key
) && last_is_meta
)
2781 sequence
= Fcopy_sequence (this);
2782 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2785 sequence
= append_key (this, key
);
2787 if (!NILP (where_is_cache
))
2789 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2790 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2797 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2799 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2800 doc
: /* Insert the list of all defined keys and their definitions.
2801 The list is inserted in the current buffer, while the bindings are
2802 looked up in BUFFER.
2803 The optional argument PREFIX, if non-nil, should be a key sequence;
2804 then we display only bindings that start with that prefix.
2805 The optional argument MENUS, if non-nil, says to mention menu bindings.
2806 \(Ordinarily these are omitted from the output.) */)
2807 (buffer
, prefix
, menus
)
2808 Lisp_Object buffer
, prefix
, menus
;
2810 Lisp_Object outbuf
, shadow
;
2811 int nomenu
= NILP (menus
);
2812 register Lisp_Object start1
;
2813 struct gcpro gcpro1
;
2815 char *alternate_heading
2817 Keyboard translations:\n\n\
2818 You type Translation\n\
2819 -------- -----------\n";
2824 outbuf
= Fcurrent_buffer ();
2826 /* Report on alternates for keys. */
2827 if (STRINGP (current_kboard
->Vkeyboard_translate_table
) && !NILP (prefix
))
2830 const unsigned char *translate
= SDATA (current_kboard
->Vkeyboard_translate_table
);
2831 int translate_len
= SCHARS (current_kboard
->Vkeyboard_translate_table
);
2833 for (c
= 0; c
< translate_len
; c
++)
2834 if (translate
[c
] != c
)
2836 char buf
[KEY_DESCRIPTION_SIZE
];
2839 if (alternate_heading
)
2841 insert_string (alternate_heading
);
2842 alternate_heading
= 0;
2845 bufend
= push_key_description (translate
[c
], buf
, 1);
2846 insert (buf
, bufend
- buf
);
2847 Findent_to (make_number (16), make_number (1));
2848 bufend
= push_key_description (c
, buf
, 1);
2849 insert (buf
, bufend
- buf
);
2853 /* Insert calls signal_after_change which may GC. */
2854 translate
= SDATA (current_kboard
->Vkeyboard_translate_table
);
2860 if (!NILP (current_kboard
->Vlocal_key_translation_map
))
2861 describe_map_tree (current_kboard
->Vlocal_key_translation_map
, 0, Qnil
, prefix
,
2862 "Key translations", nomenu
, 1, 0, 0);
2865 /* Print the (major mode) local map. */
2867 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2868 start1
= current_kboard
->Voverriding_terminal_local_map
;
2869 else if (!NILP (Voverriding_local_map
))
2870 start1
= Voverriding_local_map
;
2874 describe_map_tree (start1
, 1, shadow
, prefix
,
2875 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2876 shadow
= Fcons (start1
, shadow
);
2880 /* Print the minor mode and major mode keymaps. */
2882 Lisp_Object
*modes
, *maps
;
2884 /* Temporarily switch to `buffer', so that we can get that buffer's
2885 minor modes correctly. */
2886 Fset_buffer (buffer
);
2888 nmaps
= current_minor_maps (&modes
, &maps
);
2889 Fset_buffer (outbuf
);
2891 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2892 XBUFFER (buffer
), Qkeymap
);
2895 describe_map_tree (start1
, 1, shadow
, prefix
,
2896 "\f\n`keymap' Property Bindings", nomenu
,
2898 shadow
= Fcons (start1
, shadow
);
2901 /* Print the minor mode maps. */
2902 for (i
= 0; i
< nmaps
; i
++)
2904 /* The title for a minor mode keymap
2905 is constructed at run time.
2906 We let describe_map_tree do the actual insertion
2907 because it takes care of other features when doing so. */
2910 if (!SYMBOLP (modes
[i
]))
2913 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2917 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2918 SCHARS (SYMBOL_NAME (modes
[i
])));
2919 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2921 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2922 p
+= sizeof (" Minor Mode Bindings") - 1;
2925 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2926 title
, nomenu
, 0, 0, 0);
2927 shadow
= Fcons (maps
[i
], shadow
);
2930 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2931 XBUFFER (buffer
), Qlocal_map
);
2934 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2935 describe_map_tree (start1
, 1, shadow
, prefix
,
2936 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2938 describe_map_tree (start1
, 1, shadow
, prefix
,
2939 "\f\n`local-map' Property Bindings",
2942 shadow
= Fcons (start1
, shadow
);
2946 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2947 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2949 /* Print the function-key-map translations under this prefix. */
2950 if (!NILP (current_kboard
->Vlocal_function_key_map
))
2951 describe_map_tree (current_kboard
->Vlocal_function_key_map
, 0, Qnil
, prefix
,
2952 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2958 /* Insert a description of the key bindings in STARTMAP,
2959 followed by those of all maps reachable through STARTMAP.
2960 If PARTIAL is nonzero, omit certain "uninteresting" commands
2961 (such as `undefined').
2962 If SHADOW is non-nil, it is a list of maps;
2963 don't mention keys which would be shadowed by any of them.
2964 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2965 TITLE, if not 0, is a string to insert at the beginning.
2966 TITLE should not end with a colon or a newline; we supply that.
2967 If NOMENU is not 0, then omit menu-bar commands.
2969 If TRANSL is nonzero, the definitions are actually key translations
2970 so print strings and vectors differently.
2972 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2975 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
2976 don't omit it; instead, mention it but say it is shadowed. */
2979 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2980 always_title
, mention_shadow
)
2981 Lisp_Object startmap
, shadow
, prefix
;
2989 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2990 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2997 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3000 GCPRO3 (maps
, seen
, sub_shadows
);
3006 /* Delete from MAPS each element that is for the menu bar. */
3007 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3009 Lisp_Object elt
, prefix
, tem
;
3012 prefix
= Fcar (elt
);
3013 if (XVECTOR (prefix
)->size
>= 1)
3015 tem
= Faref (prefix
, make_number (0));
3016 if (EQ (tem
, Qmenu_bar
))
3017 maps
= Fdelq (elt
, maps
);
3022 if (!NILP (maps
) || always_title
)
3026 insert_string (title
);
3029 insert_string (" Starting With ");
3030 insert1 (Fkey_description (prefix
, Qnil
));
3032 insert_string (":\n");
3034 insert_string (key_heading
);
3038 for (; !NILP (maps
); maps
= Fcdr (maps
))
3040 register Lisp_Object elt
, prefix
, tail
;
3043 prefix
= Fcar (elt
);
3047 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3051 shmap
= XCAR (tail
);
3053 /* If the sequence by which we reach this keymap is zero-length,
3054 then the shadow map for this keymap is just SHADOW. */
3055 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3056 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3058 /* If the sequence by which we reach this keymap actually has
3059 some elements, then the sequence's definition in SHADOW is
3060 what we should use. */
3063 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3064 if (INTEGERP (shmap
))
3068 /* If shmap is not nil and not a keymap,
3069 it completely shadows this map, so don't
3070 describe this map at all. */
3071 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3075 sub_shadows
= Fcons (shmap
, sub_shadows
);
3078 /* Maps we have already listed in this loop shadow this map. */
3079 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3082 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3084 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3087 describe_map (Fcdr (elt
), prefix
,
3088 transl
? describe_translation
: describe_command
,
3089 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3095 insert_string ("\n");
3100 static int previous_description_column
;
3103 describe_command (definition
, args
)
3104 Lisp_Object definition
, args
;
3106 register Lisp_Object tem1
;
3107 int column
= (int) current_column (); /* iftc */
3108 int description_column
;
3110 /* If column 16 is no good, go to col 32;
3111 but don't push beyond that--go to next line instead. */
3115 description_column
= 32;
3117 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3118 description_column
= 32;
3120 description_column
= 16;
3122 Findent_to (make_number (description_column
), make_number (1));
3123 previous_description_column
= description_column
;
3125 if (SYMBOLP (definition
))
3127 tem1
= SYMBOL_NAME (definition
);
3129 insert_string ("\n");
3131 else if (STRINGP (definition
) || VECTORP (definition
))
3132 insert_string ("Keyboard Macro\n");
3133 else if (KEYMAPP (definition
))
3134 insert_string ("Prefix Command\n");
3136 insert_string ("??\n");
3140 describe_translation (definition
, args
)
3141 Lisp_Object definition
, args
;
3143 register Lisp_Object tem1
;
3145 Findent_to (make_number (16), make_number (1));
3147 if (SYMBOLP (definition
))
3149 tem1
= SYMBOL_NAME (definition
);
3151 insert_string ("\n");
3153 else if (STRINGP (definition
) || VECTORP (definition
))
3155 insert1 (Fkey_description (definition
, Qnil
));
3156 insert_string ("\n");
3158 else if (KEYMAPP (definition
))
3159 insert_string ("Prefix Command\n");
3161 insert_string ("??\n");
3164 /* describe_map puts all the usable elements of a sparse keymap
3165 into an array of `struct describe_map_elt',
3166 then sorts them by the events. */
3168 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3170 /* qsort comparison function for sorting `struct describe_map_elt' by
3174 describe_map_compare (aa
, bb
)
3175 const void *aa
, *bb
;
3177 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3178 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3179 return ((XINT (a
->event
) > XINT (b
->event
))
3180 - (XINT (a
->event
) < XINT (b
->event
)));
3181 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3183 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3185 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3186 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3187 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3192 /* Describe the contents of map MAP, assuming that this map itself is
3193 reached by the sequence of prefix keys PREFIX (a string or vector).
3194 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3197 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3198 seen
, nomenu
, mention_shadow
)
3199 register Lisp_Object map
;
3201 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3208 Lisp_Object tail
, definition
, event
;
3210 Lisp_Object suppress
;
3213 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3215 /* These accumulate the values from sparse keymap bindings,
3216 so we can sort them and handle them in order. */
3217 int length_needed
= 0;
3218 struct describe_map_elt
*vect
;
3225 suppress
= intern ("suppress-keymap");
3227 /* This vector gets used to present single keys to Flookup_key. Since
3228 that is done once per keymap element, we don't want to cons up a
3229 fresh vector every time. */
3230 kludge
= Fmake_vector (make_number (1), Qnil
);
3233 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3236 vect
= ((struct describe_map_elt
*)
3237 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3239 GCPRO3 (prefix
, definition
, kludge
);
3241 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3245 if (VECTORP (XCAR (tail
))
3246 || CHAR_TABLE_P (XCAR (tail
)))
3247 describe_vector (XCAR (tail
),
3248 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3249 (int *)0, 0, 1, mention_shadow
);
3250 else if (CONSP (XCAR (tail
)))
3252 int this_shadowed
= 0;
3254 event
= XCAR (XCAR (tail
));
3256 /* Ignore bindings whose "prefix" are not really valid events.
3257 (We get these in the frames and buffers menu.) */
3258 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3261 if (nomenu
&& EQ (event
, Qmenu_bar
))
3264 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3266 /* Don't show undefined commands or suppressed commands. */
3267 if (NILP (definition
)) continue;
3268 if (SYMBOLP (definition
) && partial
)
3270 tem
= Fget (definition
, suppress
);
3275 /* Don't show a command that isn't really visible
3276 because a local definition of the same key shadows it. */
3278 ASET (kludge
, 0, event
);
3281 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3291 tem
= Flookup_key (map
, kludge
, Qt
);
3292 if (!EQ (tem
, definition
)) continue;
3294 vect
[slots_used
].event
= event
;
3295 vect
[slots_used
].definition
= definition
;
3296 vect
[slots_used
].shadowed
= this_shadowed
;
3299 else if (EQ (XCAR (tail
), Qkeymap
))
3301 /* The same keymap might be in the structure twice, if we're
3302 using an inherited keymap. So skip anything we've already
3304 tem
= Fassq (tail
, *seen
);
3305 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3307 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3311 /* If we found some sparse map events, sort them. */
3313 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3314 describe_map_compare
);
3316 /* Now output them in sorted order. */
3318 for (i
= 0; i
< slots_used
; i
++)
3320 Lisp_Object start
, end
;
3324 previous_description_column
= 0;
3329 ASET (kludge
, 0, vect
[i
].event
);
3330 start
= vect
[i
].event
;
3333 definition
= vect
[i
].definition
;
3335 /* Find consecutive chars that are identically defined. */
3336 if (INTEGERP (vect
[i
].event
))
3338 while (i
+ 1 < slots_used
3339 && EQ (vect
[i
+1].event
, make_number (XINT (vect
[i
].event
) + 1))
3340 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3341 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3343 end
= vect
[i
].event
;
3346 /* Now START .. END is the range to describe next. */
3348 /* Insert the string to describe the event START. */
3349 insert1 (Fkey_description (kludge
, prefix
));
3351 if (!EQ (start
, end
))
3355 ASET (kludge
, 0, end
);
3356 /* Insert the string to describe the character END. */
3357 insert1 (Fkey_description (kludge
, prefix
));
3360 /* Print a description of the definition of this character.
3361 elt_describer will take care of spacing out far enough
3362 for alignment purposes. */
3363 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3365 if (vect
[i
].shadowed
)
3368 insert_string ("\n (that binding is currently shadowed by another mode)");
3377 describe_vector_princ (elt
, fun
)
3378 Lisp_Object elt
, fun
;
3380 Findent_to (make_number (16), make_number (1));
3385 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3386 doc
: /* Insert a description of contents of VECTOR.
3387 This is text showing the elements of vector matched against indices.
3388 DESCRIBER is the output function used; nil means use `princ'. */)
3390 Lisp_Object vector
, describer
;
3392 int count
= SPECPDL_INDEX ();
3393 if (NILP (describer
))
3394 describer
= intern ("princ");
3395 specbind (Qstandard_output
, Fcurrent_buffer ());
3396 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3397 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3398 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3400 return unbind_to (count
, Qnil
);
3403 /* Insert in the current buffer a description of the contents of VECTOR.
3404 We call ELT_DESCRIBER to insert the description of one value found
3407 ELT_PREFIX describes what "comes before" the keys or indices defined
3408 by this vector. This is a human-readable string whose size
3409 is not necessarily related to the situation.
3411 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3412 leads to this keymap.
3414 If the vector is a chartable, ELT_PREFIX is the vector
3415 of bytes that lead to the character set or portion of a character
3416 set described by this chartable.
3418 If PARTIAL is nonzero, it means do not mention suppressed commands
3419 (that assumes the vector is in a keymap).
3421 SHADOW is a list of keymaps that shadow this map.
3422 If it is non-nil, then we look up the key in those maps
3423 and we don't mention it now if it is defined by any of them.
3425 ENTIRE_MAP is the keymap in which this vector appears.
3426 If the definition in effect in the whole map does not match
3427 the one in this vector, we ignore this one.
3429 When describing a sub-char-table, INDICES is a list of
3430 indices at higher levels in this char-table,
3431 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3433 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3435 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3438 describe_vector (vector
, prefix
, args
, elt_describer
,
3439 partial
, shadow
, entire_map
,
3440 indices
, char_table_depth
, keymap_p
,
3442 register Lisp_Object vector
;
3443 Lisp_Object prefix
, args
;
3444 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3447 Lisp_Object entire_map
;
3449 int char_table_depth
;
3453 Lisp_Object definition
;
3455 Lisp_Object elt_prefix
= Qnil
;
3457 Lisp_Object suppress
;
3460 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3461 /* Range of elements to be handled. */
3463 /* A flag to tell if a leaf in this level of char-table is not a
3464 generic character (i.e. a complete multibyte character). */
3472 indices
= (int *) alloca (3 * sizeof (int));
3478 /* Call Fkey_description first, to avoid GC bug for the other string. */
3479 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3482 tem
= Fkey_description (prefix
, Qnil
);
3483 elt_prefix
= concat2 (tem
, build_string (" "));
3488 /* This vector gets used to present single keys to Flookup_key. Since
3489 that is done once per vector element, we don't want to cons up a
3490 fresh vector every time. */
3491 kludge
= Fmake_vector (make_number (1), Qnil
);
3492 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3495 suppress
= intern ("suppress-keymap");
3497 if (CHAR_TABLE_P (vector
))
3499 if (char_table_depth
== 0)
3501 /* VECTOR is a top level char-table. */
3504 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3508 /* VECTOR is a sub char-table. */
3509 if (char_table_depth
>= 3)
3510 /* A char-table is never that deep. */
3511 error ("Too deep char table");
3514 = (CHARSET_VALID_P (indices
[0])
3515 && ((CHARSET_DIMENSION (indices
[0]) == 1
3516 && char_table_depth
== 1)
3517 || char_table_depth
== 2));
3519 /* Meaningful elements are from 32th to 127th. */
3521 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3526 /* This does the right thing for ordinary vectors. */
3530 to
= XVECTOR (vector
)->size
;
3533 for (i
= from
; i
< to
; i
++)
3535 int this_shadowed
= 0;
3538 if (CHAR_TABLE_P (vector
))
3540 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3543 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3544 && !CHARSET_DEFINED_P (i
- 128))
3548 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3551 definition
= get_keyelt (AREF (vector
, i
), 0);
3553 if (NILP (definition
)) continue;
3555 /* Don't mention suppressed commands. */
3556 if (SYMBOLP (definition
) && partial
)
3560 tem
= Fget (definition
, suppress
);
3562 if (!NILP (tem
)) continue;
3565 /* Set CHARACTER to the character this entry describes, if any.
3566 Also update *INDICES. */
3567 if (CHAR_TABLE_P (vector
))
3569 indices
[char_table_depth
] = i
;
3571 if (char_table_depth
== 0)
3574 indices
[0] = i
- 128;
3576 else if (complete_char
)
3578 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3586 ASET (kludge
, 0, make_number (character
));
3588 /* If this binding is shadowed by some other map, ignore it. */
3589 if (!NILP (shadow
) && complete_char
)
3593 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3604 /* Ignore this definition if it is shadowed by an earlier
3605 one in the same keymap. */
3606 if (!NILP (entire_map
) && complete_char
)
3610 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3612 if (!EQ (tem
, definition
))
3618 if (char_table_depth
== 0)
3623 /* For a sub char-table, show the depth by indentation.
3624 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3625 if (char_table_depth
> 0)
3626 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3628 /* Output the prefix that applies to every entry in this map. */
3629 if (!NILP (elt_prefix
))
3630 insert1 (elt_prefix
);
3632 /* Insert or describe the character this slot is for,
3633 or a description of what it is for. */
3634 if (SUB_CHAR_TABLE_P (vector
))
3637 insert_char (character
);
3640 /* We need an octal representation for this block of
3643 sprintf (work
, "(row %d)", i
);
3644 insert (work
, strlen (work
));
3647 else if (CHAR_TABLE_P (vector
))
3650 insert1 (Fkey_description (kludge
, prefix
));
3653 /* Print the information for this character set. */
3654 insert_string ("<");
3655 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3657 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3666 insert1 (Fkey_description (kludge
, prefix
));
3669 /* If we find a sub char-table within a char-table,
3670 scan it recursively; it defines the details for
3671 a character set or a portion of a character set. */
3672 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3675 describe_vector (definition
, prefix
, args
, elt_describer
,
3676 partial
, shadow
, entire_map
,
3677 indices
, char_table_depth
+ 1, keymap_p
,
3684 /* Find all consecutive characters or rows that have the same
3685 definition. But, for elements of a top level char table, if
3686 they are for charsets, we had better describe one by one even
3687 if they have the same definition. */
3688 if (CHAR_TABLE_P (vector
))
3692 if (char_table_depth
== 0)
3693 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3695 while (i
+ 1 < limit
3696 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3698 && !NILP (Fequal (tem2
, definition
)))
3703 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3705 && !NILP (Fequal (tem2
, definition
)))
3709 /* If we have a range of more than one character,
3710 print where the range reaches to. */
3712 if (i
!= starting_i
)
3716 ASET (kludge
, 0, make_number (i
));
3718 if (!NILP (elt_prefix
))
3719 insert1 (elt_prefix
);
3721 if (CHAR_TABLE_P (vector
))
3723 if (char_table_depth
== 0)
3725 insert1 (Fkey_description (kludge
, prefix
));
3727 else if (complete_char
)
3729 indices
[char_table_depth
] = i
;
3730 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3731 insert_char (character
);
3735 /* We need an octal representation for this block of
3738 sprintf (work
, "(row %d)", i
);
3739 insert (work
, strlen (work
));
3744 insert1 (Fkey_description (kludge
, prefix
));
3748 /* Print a description of the definition of this character.
3749 elt_describer will take care of spacing out far enough
3750 for alignment purposes. */
3751 (*elt_describer
) (definition
, args
);
3756 insert_string (" (binding currently shadowed)");
3761 /* For (sub) char-table, print `defalt' slot at last. */
3762 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3764 insert (" ", char_table_depth
* 2);
3765 insert_string ("<<default>>");
3766 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3772 /* Apropos - finding all symbols whose names match a regexp. */
3773 static Lisp_Object apropos_predicate
;
3774 static Lisp_Object apropos_accumulate
;
3777 apropos_accum (symbol
, string
)
3778 Lisp_Object symbol
, string
;
3780 register Lisp_Object tem
;
3782 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3783 if (!NILP (tem
) && !NILP (apropos_predicate
))
3784 tem
= call1 (apropos_predicate
, symbol
);
3786 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3789 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3790 doc
: /* Show all symbols whose names contain match for REGEXP.
3791 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3792 for each symbol and a symbol is mentioned only if that returns non-nil.
3793 Return list of symbols found. */)
3795 Lisp_Object regexp
, predicate
;
3798 CHECK_STRING (regexp
);
3799 apropos_predicate
= predicate
;
3800 apropos_accumulate
= Qnil
;
3801 map_obarray (Vobarray
, apropos_accum
, regexp
);
3802 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3803 apropos_accumulate
= Qnil
;
3804 apropos_predicate
= Qnil
;
3811 Qkeymap
= intern ("keymap");
3812 staticpro (&Qkeymap
);
3813 staticpro (&apropos_predicate
);
3814 staticpro (&apropos_accumulate
);
3815 apropos_predicate
= Qnil
;
3816 apropos_accumulate
= Qnil
;
3818 /* Now we are ready to set up this property, so we can
3819 create char tables. */
3820 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3822 /* Initialize the keymaps standardly used.
3823 Each one is the value of a Lisp variable, and is also
3824 pointed to by a C variable */
3826 global_map
= Fmake_keymap (Qnil
);
3827 Fset (intern ("global-map"), global_map
);
3829 current_global_map
= global_map
;
3830 staticpro (&global_map
);
3831 staticpro (¤t_global_map
);
3833 meta_map
= Fmake_keymap (Qnil
);
3834 Fset (intern ("esc-map"), meta_map
);
3835 Ffset (intern ("ESC-prefix"), meta_map
);
3837 control_x_map
= Fmake_keymap (Qnil
);
3838 Fset (intern ("ctl-x-map"), control_x_map
);
3839 Ffset (intern ("Control-X-prefix"), control_x_map
);
3842 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3843 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3844 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3845 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3846 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3848 staticpro (&exclude_keys
);
3850 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3851 doc
: /* List of commands given new key bindings recently.
3852 This is used for internal purposes during Emacs startup;
3853 don't alter it yourself. */);
3854 Vdefine_key_rebound_commands
= Qt
;
3856 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3857 doc
: /* Default keymap to use when reading from the minibuffer. */);
3858 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3860 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3861 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3862 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3863 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3865 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3866 doc
: /* Local keymap for minibuffer input with completion. */);
3867 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3868 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3870 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3871 &Vminibuffer_local_filename_completion_map
,
3872 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3873 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3874 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3875 Vminibuffer_local_completion_map
);
3878 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3879 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3880 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3881 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3882 Vminibuffer_local_completion_map
);
3884 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3885 &Vminibuffer_local_must_match_filename_map
,
3886 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3887 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3888 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3889 Vminibuffer_local_must_match_map
);
3891 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3892 doc
: /* Alist of keymaps to use for minor modes.
3893 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3894 key sequences and look up bindings iff VARIABLE's value is non-nil.
3895 If two active keymaps bind the same key, the keymap appearing earlier
3896 in the list takes precedence. */);
3897 Vminor_mode_map_alist
= Qnil
;
3899 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3900 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3901 This variable is an alist just like `minor-mode-map-alist', and it is
3902 used the same way (and before `minor-mode-map-alist'); however,
3903 it is provided for major modes to bind locally. */);
3904 Vminor_mode_overriding_map_alist
= Qnil
;
3906 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3907 doc
: /* List of keymap alists to use for emulations modes.
3908 It is intended for modes or packages using multiple minor-mode keymaps.
3909 Each element is a keymap alist just like `minor-mode-map-alist', or a
3910 symbol with a variable binding which is a keymap alist, and it is used
3911 the same way. The "active" keymaps in each alist are used before
3912 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3913 Vemulation_mode_map_alists
= Qnil
;
3915 staticpro (&Vmouse_events
);
3916 Vmouse_events
= Fcons (intern ("menu-bar"),
3917 Fcons (intern ("tool-bar"),
3918 Fcons (intern ("header-line"),
3919 Fcons (intern ("mode-line"),
3920 Fcons (intern ("mouse-1"),
3921 Fcons (intern ("mouse-2"),
3922 Fcons (intern ("mouse-3"),
3923 Fcons (intern ("mouse-4"),
3924 Fcons (intern ("mouse-5"),
3928 Qsingle_key_description
= intern ("single-key-description");
3929 staticpro (&Qsingle_key_description
);
3931 Qkey_description
= intern ("key-description");
3932 staticpro (&Qkey_description
);
3934 Qkeymapp
= intern ("keymapp");
3935 staticpro (&Qkeymapp
);
3937 Qnon_ascii
= intern ("non-ascii");
3938 staticpro (&Qnon_ascii
);
3940 Qmenu_item
= intern ("menu-item");
3941 staticpro (&Qmenu_item
);
3943 Qremap
= intern ("remap");
3944 staticpro (&Qremap
);
3946 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3947 staticpro (&command_remapping_vector
);
3949 where_is_cache_keymaps
= Qt
;
3950 where_is_cache
= Qnil
;
3951 staticpro (&where_is_cache
);
3952 staticpro (&where_is_cache_keymaps
);
3954 defsubr (&Skeymapp
);
3955 defsubr (&Skeymap_parent
);
3956 defsubr (&Skeymap_prompt
);
3957 defsubr (&Sset_keymap_parent
);
3958 defsubr (&Smake_keymap
);
3959 defsubr (&Smake_sparse_keymap
);
3960 defsubr (&Smap_keymap
);
3961 defsubr (&Scopy_keymap
);
3962 defsubr (&Scommand_remapping
);
3963 defsubr (&Skey_binding
);
3964 defsubr (&Slocal_key_binding
);
3965 defsubr (&Sglobal_key_binding
);
3966 defsubr (&Sminor_mode_key_binding
);
3967 defsubr (&Sdefine_key
);
3968 defsubr (&Slookup_key
);
3969 defsubr (&Sdefine_prefix_command
);
3970 defsubr (&Suse_global_map
);
3971 defsubr (&Suse_local_map
);
3972 defsubr (&Scurrent_local_map
);
3973 defsubr (&Scurrent_global_map
);
3974 defsubr (&Scurrent_minor_mode_maps
);
3975 defsubr (&Scurrent_active_maps
);
3976 defsubr (&Saccessible_keymaps
);
3977 defsubr (&Skey_description
);
3978 defsubr (&Sdescribe_vector
);
3979 defsubr (&Ssingle_key_description
);
3980 defsubr (&Stext_char_description
);
3981 defsubr (&Swhere_is_internal
);
3982 defsubr (&Sdescribe_buffer_bindings
);
3983 defsubr (&Sapropos_internal
);
3989 initial_define_key (global_map
, 033, "ESC-prefix");
3990 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
3993 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
3994 (do not change this comment) */