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
;
695 GCPRO3 (map
, args
, tail
);
696 map
= get_keymap (map
, 1, autoload
);
697 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
698 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
701 Lisp_Object binding
= XCAR (tail
);
704 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
705 else if (VECTORP (binding
))
707 /* Loop over the char values represented in the vector. */
708 int len
= ASIZE (binding
);
710 for (c
= 0; c
< len
; c
++)
712 Lisp_Object character
;
713 XSETFASTINT (character
, c
);
714 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
717 else if (CHAR_TABLE_P (binding
))
719 Lisp_Object indices
[3];
720 map_char_table (map_keymap_char_table_item
, Qnil
, binding
, binding
,
721 Fcons (make_save_value (fun
, 0),
722 Fcons (make_save_value (data
, 0),
731 map_keymap_call (key
, val
, fun
, dummy
)
732 Lisp_Object key
, val
, fun
;
735 call2 (fun
, key
, val
);
738 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
739 doc
: /* Call FUNCTION once for each event binding in KEYMAP.
740 FUNCTION is called with two arguments: the event that is bound, and
741 the definition it is bound to.
743 If KEYMAP has a parent, the parent's bindings are included as well.
744 This works recursively: if the parent has itself a parent, then the
745 grandparent's bindings are also included and so on.
746 usage: (map-keymap FUNCTION KEYMAP) */)
747 (function
, keymap
, sort_first
)
748 Lisp_Object function
, keymap
, sort_first
;
750 if (INTEGERP (function
))
751 /* We have to stop integers early since map_keymap gives them special
753 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
754 if (! NILP (sort_first
))
755 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
757 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
761 /* Given OBJECT which was found in a slot in a keymap,
762 trace indirect definitions to get the actual definition of that slot.
763 An indirect definition is a list of the form
764 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
765 and INDEX is the object to look up in KEYMAP to yield the definition.
767 Also if OBJECT has a menu string as the first element,
768 remove that. Also remove a menu help string as second element.
770 If AUTOLOAD is nonzero, load autoloadable keymaps
771 that are referred to with indirection.
773 This can GC because menu_item_eval_property calls Feval. */
776 get_keyelt (object
, autoload
)
782 if (!(CONSP (object
)))
783 /* This is really the value. */
786 /* If the keymap contents looks like (keymap ...) or (lambda ...)
788 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
791 /* If the keymap contents looks like (menu-item name . DEFN)
792 or (menu-item name DEFN ...) then use DEFN.
793 This is a new format menu item. */
794 else if (EQ (XCAR (object
), Qmenu_item
))
796 if (CONSP (XCDR (object
)))
800 object
= XCDR (XCDR (object
));
803 object
= XCAR (object
);
805 /* If there's a `:filter FILTER', apply FILTER to the
806 menu-item's definition to get the real definition to
808 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
809 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
812 filter
= XCAR (XCDR (tem
));
813 filter
= list2 (filter
, list2 (Qquote
, object
));
814 object
= menu_item_eval_property (filter
);
819 /* Invalid keymap. */
823 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
824 Keymap alist elements like (CHAR MENUSTRING . DEFN)
825 will be used by HierarKey menus. */
826 else if (STRINGP (XCAR (object
)))
828 object
= XCDR (object
);
829 /* Also remove a menu help string, if any,
830 following the menu item name. */
831 if (CONSP (object
) && STRINGP (XCAR (object
)))
832 object
= XCDR (object
);
833 /* Also remove the sublist that caches key equivalences, if any. */
834 if (CONSP (object
) && CONSP (XCAR (object
)))
837 carcar
= XCAR (XCAR (object
));
838 if (NILP (carcar
) || VECTORP (carcar
))
839 object
= XCDR (object
);
843 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
849 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
851 return (!CONSP (map
) ? object
/* Invalid keymap */
852 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
858 store_in_keymap (keymap
, idx
, def
)
860 register Lisp_Object idx
;
861 register Lisp_Object def
;
863 /* Flush any reverse-map cache. */
864 where_is_cache
= Qnil
;
865 where_is_cache_keymaps
= Qt
;
867 /* If we are preparing to dump, and DEF is a menu element
868 with a menu item indicator, copy it to ensure it is not pure. */
869 if (CONSP (def
) && PURE_P (def
)
870 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
871 def
= Fcons (XCAR (def
), XCDR (def
));
873 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
874 error ("attempt to define a key in a non-keymap");
876 /* If idx is a list (some sort of mouse click, perhaps?),
877 the index we want to use is the car of the list, which
878 ought to be a symbol. */
879 idx
= EVENT_HEAD (idx
);
881 /* If idx is a symbol, it might have modifiers, which need to
882 be put in the canonical order. */
884 idx
= reorder_modifiers (idx
);
885 else if (INTEGERP (idx
))
886 /* Clobber the high bits that can be present on a machine
887 with more than 24 bits of integer. */
888 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
890 /* Scan the keymap for a binding of idx. */
894 /* The cons after which we should insert new bindings. If the
895 keymap has a table element, we record its position here, so new
896 bindings will go after it; this way, the table will stay
897 towards the front of the alist and character lookups in dense
898 keymaps will remain fast. Otherwise, this just points at the
899 front of the keymap. */
900 Lisp_Object insertion_point
;
902 insertion_point
= keymap
;
903 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
910 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
913 ASET (elt
, XFASTINT (idx
), def
);
916 insertion_point
= tail
;
918 else if (CHAR_TABLE_P (elt
))
920 /* Character codes with modifiers
921 are not included in a char-table.
922 All character codes without modifiers are included. */
923 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
926 /* `nil' has a special meaning for char-tables, so
927 we use something else to record an explicitly
929 NILP (def
) ? Qt
: def
);
932 insertion_point
= tail
;
934 else if (CONSP (elt
))
936 if (EQ (idx
, XCAR (elt
)))
943 else if (EQ (elt
, Qkeymap
))
944 /* If we find a 'keymap' symbol in the spine of KEYMAP,
945 then we must have found the start of a second keymap
946 being used as the tail of KEYMAP, and a binding for IDX
947 should be inserted before it. */
954 /* We have scanned the entire keymap, and not found a binding for
955 IDX. Let's add one. */
956 CHECK_IMPURE (insertion_point
);
957 XSETCDR (insertion_point
,
958 Fcons (Fcons (idx
, def
), XCDR (insertion_point
)));
964 EXFUN (Fcopy_keymap
, 1);
967 copy_keymap_item (elt
)
970 Lisp_Object res
, tem
;
977 /* Is this a new format menu item. */
978 if (EQ (XCAR (tem
), Qmenu_item
))
980 /* Copy cell with menu-item marker. */
981 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
985 /* Copy cell with menu-item name. */
986 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
992 /* Copy cell with binding and if the binding is a keymap,
994 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
997 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
998 XSETCAR (elt
, Fcopy_keymap (tem
));
1000 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1001 /* Delete cache for key equivalences. */
1002 XSETCDR (elt
, XCDR (tem
));
1007 /* It may be an old fomat menu item.
1008 Skip the optional menu string. */
1009 if (STRINGP (XCAR (tem
)))
1011 /* Copy the cell, since copy-alist didn't go this deep. */
1012 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1014 /* Also skip the optional menu help string. */
1015 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1017 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1021 /* There may also be a list that caches key equivalences.
1022 Just delete it for the new keymap. */
1024 && CONSP (XCAR (tem
))
1025 && (NILP (XCAR (XCAR (tem
)))
1026 || VECTORP (XCAR (XCAR (tem
)))))
1028 XSETCDR (elt
, XCDR (tem
));
1031 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1032 XSETCDR (elt
, Fcopy_keymap (tem
));
1034 else if (EQ (XCAR (tem
), Qkeymap
))
1035 res
= Fcopy_keymap (elt
);
1041 copy_keymap_1 (chartable
, idx
, elt
)
1042 Lisp_Object chartable
, idx
, elt
;
1044 Faset (chartable
, idx
, copy_keymap_item (elt
));
1047 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1048 doc
: /* Return a copy of the keymap KEYMAP.
1049 The copy starts out with the same definitions of KEYMAP,
1050 but changing either the copy or KEYMAP does not affect the other.
1051 Any key definitions that are subkeymaps are recursively copied.
1052 However, a key definition which is a symbol whose definition is a keymap
1057 register Lisp_Object copy
, tail
;
1058 keymap
= get_keymap (keymap
, 1, 0);
1059 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1060 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1062 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1064 Lisp_Object elt
= XCAR (keymap
);
1065 if (CHAR_TABLE_P (elt
))
1067 Lisp_Object indices
[3];
1068 elt
= Fcopy_sequence (elt
);
1069 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, elt
, 0, indices
);
1071 else if (VECTORP (elt
))
1074 elt
= Fcopy_sequence (elt
);
1075 for (i
= 0; i
< ASIZE (elt
); i
++)
1076 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1078 else if (CONSP (elt
))
1079 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1080 XSETCDR (tail
, Fcons (elt
, Qnil
));
1082 keymap
= XCDR (keymap
);
1084 XSETCDR (tail
, keymap
);
1088 /* Simple Keymap mutators and accessors. */
1090 /* GC is possible in this function if it autoloads a keymap. */
1092 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1093 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1096 KEY is a string or a vector of symbols and characters meaning a
1097 sequence of keystrokes and events. Non-ASCII characters with codes
1098 above 127 (such as ISO Latin-1) can be included if you use a vector.
1099 Using [t] for KEY creates a default definition, which applies to any
1100 event type that has no other definition in this keymap.
1102 DEF is anything that can be a key's definition:
1103 nil (means key is undefined in this keymap),
1104 a command (a Lisp function suitable for interactive calling),
1105 a string (treated as a keyboard macro),
1106 a keymap (to define a prefix key),
1107 a symbol (when the key is looked up, the symbol will stand for its
1108 function definition, which should at that time be one of the above,
1109 or another symbol whose function definition is used, etc.),
1110 a cons (STRING . DEFN), meaning that DEFN is the definition
1111 (DEFN should be a valid definition in its own right),
1112 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1114 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1115 binding is altered. If there is no binding for KEY, the new pair
1116 binding KEY to DEF is added at the front of KEYMAP. */)
1123 register Lisp_Object c
;
1124 register Lisp_Object cmd
;
1128 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1130 GCPRO3 (keymap
, key
, def
);
1131 keymap
= get_keymap (keymap
, 1, 1);
1133 if (!VECTORP (key
) && !STRINGP (key
))
1134 key
= wrong_type_argument (Qarrayp
, key
);
1136 length
= XFASTINT (Flength (key
));
1138 RETURN_UNGCPRO (Qnil
);
1140 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1141 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1143 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1148 c
= Faref (key
, make_number (idx
));
1150 if (CONSP (c
) && lucid_event_type_list_p (c
))
1151 c
= Fevent_convert_list (c
);
1154 silly_event_symbol_error (c
);
1157 && (XINT (c
) & meta_bit
)
1160 c
= meta_prefix_char
;
1166 XSETINT (c
, XINT (c
) & ~meta_bit
);
1172 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1173 error ("Key sequence contains invalid event");
1176 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1178 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1180 /* If this key is undefined, make it a prefix. */
1182 cmd
= define_as_prefix (keymap
, c
);
1184 keymap
= get_keymap (cmd
, 0, 1);
1185 if (!CONSP (keymap
))
1186 /* We must use Fkey_description rather than just passing key to
1187 error; key might be a vector, not a string. */
1188 error ("Key sequence %s uses invalid prefix characters",
1189 SDATA (Fkey_description (key
, Qnil
)));
1193 /* This function may GC (it calls Fkey_binding). */
1195 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1196 doc
: /* Return the remapping for command COMMAND in current keymaps.
1197 Returns nil if COMMAND is not remapped (or not a symbol). */)
1199 Lisp_Object command
;
1201 if (!SYMBOLP (command
))
1204 ASET (command_remapping_vector
, 1, command
);
1205 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1208 /* Value is number if KEY is too long; nil if valid but has no definition. */
1209 /* GC is possible in this function if it autoloads a keymap. */
1211 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1212 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1213 nil means undefined. See doc of `define-key' for kinds of definitions.
1215 A number as value means KEY is "too long";
1216 that is, characters or symbols in it except for the last one
1217 fail to be a valid sequence of prefix characters in KEYMAP.
1218 The number is how many characters at the front of KEY
1219 it takes to reach a non-prefix key.
1221 Normally, `lookup-key' ignores bindings for t, which act as default
1222 bindings, used when nothing else in the keymap applies; this makes it
1223 usable as a general function for probing keymaps. However, if the
1224 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1225 recognize the default bindings, just as `read-key-sequence' does. */)
1226 (keymap
, key
, accept_default
)
1229 Lisp_Object accept_default
;
1232 register Lisp_Object cmd
;
1233 register Lisp_Object c
;
1235 int t_ok
= !NILP (accept_default
);
1236 struct gcpro gcpro1
, gcpro2
;
1238 GCPRO2 (keymap
, key
);
1239 keymap
= get_keymap (keymap
, 1, 1);
1241 if (!VECTORP (key
) && !STRINGP (key
))
1242 key
= wrong_type_argument (Qarrayp
, key
);
1244 length
= XFASTINT (Flength (key
));
1246 RETURN_UNGCPRO (keymap
);
1251 c
= Faref (key
, make_number (idx
++));
1253 if (CONSP (c
) && lucid_event_type_list_p (c
))
1254 c
= Fevent_convert_list (c
);
1256 /* Turn the 8th bit of string chars into a meta modifier. */
1257 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1258 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1260 /* Allow string since binding for `menu-bar-select-buffer'
1261 includes the buffer name in the key sequence. */
1262 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1263 error ("Key sequence contains invalid event");
1265 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1267 RETURN_UNGCPRO (cmd
);
1269 keymap
= get_keymap (cmd
, 0, 1);
1270 if (!CONSP (keymap
))
1271 RETURN_UNGCPRO (make_number (idx
));
1277 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1278 Assume that currently it does not define C at all.
1279 Return the keymap. */
1282 define_as_prefix (keymap
, c
)
1283 Lisp_Object keymap
, c
;
1287 cmd
= Fmake_sparse_keymap (Qnil
);
1288 /* If this key is defined as a prefix in an inherited keymap,
1289 make it a prefix in this map, and make its definition
1290 inherit the other prefix definition. */
1291 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1292 store_in_keymap (keymap
, c
, cmd
);
1297 /* Append a key to the end of a key sequence. We always make a vector. */
1300 append_key (key_sequence
, key
)
1301 Lisp_Object key_sequence
, key
;
1303 Lisp_Object args
[2];
1305 args
[0] = key_sequence
;
1307 args
[1] = Fcons (key
, Qnil
);
1308 return Fvconcat (2, args
);
1311 /* Given a event type C which is a symbol,
1312 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1315 silly_event_symbol_error (c
)
1318 Lisp_Object parsed
, base
, name
, assoc
;
1321 parsed
= parse_modifiers (c
);
1322 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1323 base
= XCAR (parsed
);
1324 name
= Fsymbol_name (base
);
1325 /* This alist includes elements such as ("RET" . "\\r"). */
1326 assoc
= Fassoc (name
, exclude_keys
);
1330 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1332 Lisp_Object keystring
;
1333 if (modifiers
& alt_modifier
)
1334 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1335 if (modifiers
& ctrl_modifier
)
1336 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1337 if (modifiers
& hyper_modifier
)
1338 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1339 if (modifiers
& meta_modifier
)
1340 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1341 if (modifiers
& shift_modifier
)
1342 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1343 if (modifiers
& super_modifier
)
1344 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1347 c
= reorder_modifiers (c
);
1348 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1350 error ((modifiers
& ~meta_modifier
1351 ? "To bind the key %s, use [?%s], not [%s]"
1352 : "To bind the key %s, use \"%s\", not [%s]"),
1353 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1354 SDATA (SYMBOL_NAME (c
)));
1358 /* Global, local, and minor mode keymap stuff. */
1360 /* We can't put these variables inside current_minor_maps, since under
1361 some systems, static gets macro-defined to be the empty string.
1363 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1364 static int cmm_size
= 0;
1366 /* Store a pointer to an array of the keymaps of the currently active
1367 minor modes in *buf, and return the number of maps it contains.
1369 This function always returns a pointer to the same buffer, and may
1370 free or reallocate it, so if you want to keep it for a long time or
1371 hand it out to lisp code, copy it. This procedure will be called
1372 for every key sequence read, so the nice lispy approach (return a
1373 new assoclist, list, what have you) for each invocation would
1374 result in a lot of consing over time.
1376 If we used xrealloc/xmalloc and ran out of memory, they would throw
1377 back to the command loop, which would try to read a key sequence,
1378 which would call this function again, resulting in an infinite
1379 loop. Instead, we'll use realloc/malloc and silently truncate the
1380 list, let the key sequence be read, and hope some other piece of
1381 code signals the error. */
1383 current_minor_maps (modeptr
, mapptr
)
1384 Lisp_Object
**modeptr
, **mapptr
;
1387 int list_number
= 0;
1388 Lisp_Object alist
, assoc
, var
, val
;
1389 Lisp_Object emulation_alists
;
1390 Lisp_Object lists
[2];
1392 emulation_alists
= Vemulation_mode_map_alists
;
1393 lists
[0] = Vminor_mode_overriding_map_alist
;
1394 lists
[1] = Vminor_mode_map_alist
;
1396 for (list_number
= 0; list_number
< 2; list_number
++)
1398 if (CONSP (emulation_alists
))
1400 alist
= XCAR (emulation_alists
);
1401 emulation_alists
= XCDR (emulation_alists
);
1402 if (SYMBOLP (alist
))
1403 alist
= find_symbol_value (alist
);
1407 alist
= lists
[list_number
];
1409 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1410 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1411 && (var
= XCAR (assoc
), SYMBOLP (var
))
1412 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1417 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1418 and also an entry in Vminor_mode_map_alist,
1419 ignore the latter. */
1420 if (list_number
== 1)
1422 val
= assq_no_quit (var
, lists
[0]);
1429 int newsize
, allocsize
;
1430 Lisp_Object
*newmodes
, *newmaps
;
1432 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1433 allocsize
= newsize
* sizeof *newmodes
;
1435 /* Use malloc here. See the comment above this function.
1436 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1438 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1443 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1446 cmm_modes
= newmodes
;
1449 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1454 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1461 if (newmodes
== NULL
|| newmaps
== NULL
)
1466 /* Get the keymap definition--or nil if it is not defined. */
1467 temp
= Findirect_function (XCDR (assoc
), Qt
);
1471 cmm_maps
[i
] = temp
;
1477 if (modeptr
) *modeptr
= cmm_modes
;
1478 if (mapptr
) *mapptr
= cmm_maps
;
1482 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1484 doc
: /* Return a list of the currently active keymaps.
1485 OLP if non-nil indicates that we should obey `overriding-local-map' and
1486 `overriding-terminal-local-map'. */)
1490 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1494 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1495 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1496 /* The doc said that overriding-terminal-local-map should
1497 override overriding-local-map. The code used them both,
1498 but it seems clearer to use just one. rms, jan 2005. */
1499 else if (!NILP (Voverriding_local_map
))
1500 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1502 if (NILP (XCDR (keymaps
)))
1508 /* This usually returns the buffer's local map,
1509 but that can be overridden by a `local-map' property. */
1510 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1512 keymaps
= Fcons (local
, keymaps
);
1514 /* Now put all the minor mode keymaps on the list. */
1515 nmaps
= current_minor_maps (0, &maps
);
1517 for (i
= --nmaps
; i
>= 0; i
--)
1518 if (!NILP (maps
[i
]))
1519 keymaps
= Fcons (maps
[i
], keymaps
);
1521 /* This returns nil unless there is a `keymap' property. */
1522 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1524 keymaps
= Fcons (local
, keymaps
);
1530 /* GC is possible in this function if it autoloads a keymap. */
1532 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1533 doc
: /* Return the binding for command KEY in current keymaps.
1534 KEY is a string or vector, a sequence of keystrokes.
1535 The binding is probably a symbol with a function definition.
1537 Normally, `key-binding' ignores bindings for t, which act as default
1538 bindings, used when nothing else in the keymap applies; this makes it
1539 usable as a general function for probing keymaps. However, if the
1540 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1541 recognize the default bindings, just as `read-key-sequence' does.
1543 Like the normal command loop, `key-binding' will remap the command
1544 resulting from looking up KEY by looking up the command in the
1545 current keymaps. However, if the optional third argument NO-REMAP
1546 is non-nil, `key-binding' returns the unmapped command. */)
1547 (key
, accept_default
, no_remap
)
1548 Lisp_Object key
, accept_default
, no_remap
;
1550 Lisp_Object
*maps
, value
;
1552 struct gcpro gcpro1
;
1556 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1558 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1559 key
, accept_default
);
1560 if (! NILP (value
) && !INTEGERP (value
))
1563 else if (!NILP (Voverriding_local_map
))
1565 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1566 if (! NILP (value
) && !INTEGERP (value
))
1573 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1576 value
= Flookup_key (local
, key
, accept_default
);
1577 if (! NILP (value
) && !INTEGERP (value
))
1581 nmaps
= current_minor_maps (0, &maps
);
1582 /* Note that all these maps are GCPRO'd
1583 in the places where we found them. */
1585 for (i
= 0; i
< nmaps
; i
++)
1586 if (! NILP (maps
[i
]))
1588 value
= Flookup_key (maps
[i
], key
, accept_default
);
1589 if (! NILP (value
) && !INTEGERP (value
))
1593 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1596 value
= Flookup_key (local
, key
, accept_default
);
1597 if (! NILP (value
) && !INTEGERP (value
))
1602 value
= Flookup_key (current_global_map
, key
, accept_default
);
1606 if (NILP (value
) || INTEGERP (value
))
1609 /* If the result of the ordinary keymap lookup is an interactive
1610 command, look for a key binding (ie. remapping) for that command. */
1612 if (NILP (no_remap
) && SYMBOLP (value
))
1615 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1622 /* GC is possible in this function if it autoloads a keymap. */
1624 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1625 doc
: /* Return the binding for command KEYS in current local keymap only.
1626 KEYS is a string or vector, a sequence of keystrokes.
1627 The binding is probably a symbol with a function definition.
1629 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1630 bindings; see the description of `lookup-key' for more details about this. */)
1631 (keys
, accept_default
)
1632 Lisp_Object keys
, accept_default
;
1634 register Lisp_Object map
;
1635 map
= current_buffer
->keymap
;
1638 return Flookup_key (map
, keys
, accept_default
);
1641 /* GC is possible in this function if it autoloads a keymap. */
1643 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1644 doc
: /* Return the binding for command KEYS in current global keymap only.
1645 KEYS is a string or vector, a sequence of keystrokes.
1646 The binding is probably a symbol with a function definition.
1647 This function's return values are the same as those of `lookup-key'
1650 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1651 bindings; see the description of `lookup-key' for more details about this. */)
1652 (keys
, accept_default
)
1653 Lisp_Object keys
, accept_default
;
1655 return Flookup_key (current_global_map
, keys
, accept_default
);
1658 /* GC is possible in this function if it autoloads a keymap. */
1660 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1661 doc
: /* Find the visible minor mode bindings of KEY.
1662 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1663 the symbol which names the minor mode binding KEY, and BINDING is
1664 KEY's definition in that mode. In particular, if KEY has no
1665 minor-mode bindings, return nil. If the first binding is a
1666 non-prefix, all subsequent bindings will be omitted, since they would
1667 be ignored. Similarly, the list doesn't include non-prefix bindings
1668 that come after prefix bindings.
1670 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1671 bindings; see the description of `lookup-key' for more details about this. */)
1672 (key
, accept_default
)
1673 Lisp_Object key
, accept_default
;
1675 Lisp_Object
*modes
, *maps
;
1677 Lisp_Object binding
;
1679 struct gcpro gcpro1
, gcpro2
;
1681 nmaps
= current_minor_maps (&modes
, &maps
);
1682 /* Note that all these maps are GCPRO'd
1683 in the places where we found them. */
1686 GCPRO2 (key
, binding
);
1688 for (i
= j
= 0; i
< nmaps
; i
++)
1690 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1691 && !INTEGERP (binding
))
1693 if (KEYMAPP (binding
))
1694 maps
[j
++] = Fcons (modes
[i
], binding
);
1696 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1700 return Flist (j
, maps
);
1703 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1704 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1705 A new sparse keymap is stored as COMMAND's function definition and its value.
1706 If a second optional argument MAPVAR is given, the map is stored as
1707 its value instead of as COMMAND's value; but COMMAND is still defined
1709 The third optional argument NAME, if given, supplies a menu name
1710 string for the map. This is required to use the keymap as a menu.
1711 This function returns COMMAND. */)
1712 (command
, mapvar
, name
)
1713 Lisp_Object command
, mapvar
, name
;
1716 map
= Fmake_sparse_keymap (name
);
1717 Ffset (command
, map
);
1721 Fset (command
, map
);
1725 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1726 doc
: /* Select KEYMAP as the global keymap. */)
1730 keymap
= get_keymap (keymap
, 1, 1);
1731 current_global_map
= keymap
;
1736 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1737 doc
: /* Select KEYMAP as the local keymap.
1738 If KEYMAP is nil, that means no local keymap. */)
1743 keymap
= get_keymap (keymap
, 1, 1);
1745 current_buffer
->keymap
= keymap
;
1750 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1751 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1754 return current_buffer
->keymap
;
1757 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1758 doc
: /* Return the current global keymap. */)
1761 return current_global_map
;
1764 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1765 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1769 int nmaps
= current_minor_maps (0, &maps
);
1771 return Flist (nmaps
, maps
);
1774 /* Help functions for describing and documenting keymaps. */
1778 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1779 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1780 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1784 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1788 /* Look for and break cycles. */
1789 while (!NILP (tem
= Frassq (cmd
, maps
)))
1791 Lisp_Object prefix
= XCAR (tem
);
1792 int lim
= XINT (Flength (XCAR (tem
)));
1793 if (lim
<= XINT (Flength (thisseq
)))
1794 { /* This keymap was already seen with a smaller prefix. */
1796 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1797 Faref (thisseq
, make_number (i
))))
1800 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1803 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1804 but maybe `cmd' occurs again further down in `maps', so keep
1806 maps
= XCDR (Fmemq (tem
, maps
));
1809 /* If the last key in thisseq is meta-prefix-char,
1810 turn it into a meta-ized keystroke. We know
1811 that the event we're about to append is an
1812 ascii keystroke since we're processing a
1816 int meta_bit
= meta_modifier
;
1817 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1818 tem
= Fcopy_sequence (thisseq
);
1820 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1822 /* This new sequence is the same length as
1823 thisseq, so stick it in the list right
1826 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1830 tem
= append_key (thisseq
, key
);
1831 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1836 accessible_keymaps_char_table (args
, index
, cmd
)
1837 Lisp_Object args
, index
, cmd
;
1839 accessible_keymaps_1 (index
, cmd
,
1843 XINT (XCDR (XCAR (args
))));
1846 /* This function cannot GC. */
1848 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1850 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1851 Returns a list of elements of the form (KEYS . MAP), where the sequence
1852 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1853 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1854 An optional argument PREFIX, if non-nil, should be a key sequence;
1855 then the value includes only maps for prefixes that start with PREFIX. */)
1857 Lisp_Object keymap
, prefix
;
1859 Lisp_Object maps
, tail
;
1862 /* no need for gcpro because we don't autoload any keymaps. */
1865 prefixlen
= XINT (Flength (prefix
));
1869 /* If a prefix was specified, start with the keymap (if any) for
1870 that prefix, so we don't waste time considering other prefixes. */
1872 tem
= Flookup_key (keymap
, prefix
, Qt
);
1873 /* Flookup_key may give us nil, or a number,
1874 if the prefix is not defined in this particular map.
1875 It might even give us a list that isn't a keymap. */
1876 tem
= get_keymap (tem
, 0, 0);
1879 /* Convert PREFIX to a vector now, so that later on
1880 we don't have to deal with the possibility of a string. */
1881 if (STRINGP (prefix
))
1886 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1887 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1891 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1892 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1893 c
^= 0200 | meta_modifier
;
1894 ASET (copy
, i_before
, make_number (c
));
1898 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1904 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1905 get_keymap (keymap
, 1, 0)),
1908 /* For each map in the list maps,
1909 look at any other maps it points to,
1910 and stick them at the end if they are not already in the list.
1912 This is a breadth-first traversal, where tail is the queue of
1913 nodes, and maps accumulates a list of all nodes visited. */
1915 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1917 register Lisp_Object thisseq
, thismap
;
1919 /* Does the current sequence end in the meta-prefix-char? */
1922 thisseq
= Fcar (Fcar (tail
));
1923 thismap
= Fcdr (Fcar (tail
));
1924 last
= make_number (XINT (Flength (thisseq
)) - 1);
1925 is_metized
= (XINT (last
) >= 0
1926 /* Don't metize the last char of PREFIX. */
1927 && XINT (last
) >= prefixlen
1928 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1930 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1934 elt
= XCAR (thismap
);
1938 if (CHAR_TABLE_P (elt
))
1940 Lisp_Object indices
[3];
1942 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
1943 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1944 Fcons (tail
, thisseq
)),
1947 else if (VECTORP (elt
))
1951 /* Vector keymap. Scan all the elements. */
1952 for (i
= 0; i
< ASIZE (elt
); i
++)
1953 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1954 maps
, tail
, thisseq
, is_metized
);
1957 else if (CONSP (elt
))
1958 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1959 maps
, tail
, thisseq
,
1960 is_metized
&& INTEGERP (XCAR (elt
)));
1968 Lisp_Object Qsingle_key_description
, Qkey_description
;
1970 /* This function cannot GC. */
1972 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
1973 doc
: /* Return a pretty description of key-sequence KEYS.
1974 Optional arg PREFIX is the sequence of keys leading up to KEYS.
1975 Control characters turn into "C-foo" sequences, meta into "M-foo",
1976 spaces are put between sequence elements, etc. */)
1978 Lisp_Object keys
, prefix
;
1983 int size
= XINT (Flength (keys
));
1985 Lisp_Object sep
= build_string (" ");
1990 size
+= XINT (Flength (prefix
));
1992 /* This has one extra element at the end that we don't pass to Fconcat. */
1993 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
1995 /* In effect, this computes
1996 (mapconcat 'single-key-description keys " ")
1997 but we shouldn't use mapconcat because it can do GC. */
2001 list
= prefix
, prefix
= Qnil
;
2002 else if (!NILP (keys
))
2003 list
= keys
, keys
= Qnil
;
2008 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2012 return empty_string
;
2013 return Fconcat (len
- 1, args
);
2017 size
= SCHARS (list
);
2018 else if (VECTORP (list
))
2019 size
= XVECTOR (list
)->size
;
2020 else if (CONSP (list
))
2021 size
= XINT (Flength (list
));
2023 wrong_type_argument (Qarrayp
, list
);
2032 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2033 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2034 c
^= 0200 | meta_modifier
;
2035 XSETFASTINT (key
, c
);
2037 else if (VECTORP (list
))
2039 key
= AREF (list
, i
++);
2051 || EQ (key
, meta_prefix_char
)
2052 || (XINT (key
) & meta_modifier
))
2054 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2056 if (EQ (key
, meta_prefix_char
))
2060 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2063 else if (EQ (key
, meta_prefix_char
))
2068 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2076 push_key_description (c
, p
, force_multibyte
)
2077 register unsigned int c
;
2079 int force_multibyte
;
2083 /* Clear all the meaningless bits above the meta bit. */
2084 c
&= meta_modifier
| ~ - meta_modifier
;
2085 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2086 | meta_modifier
| shift_modifier
| super_modifier
);
2088 if (c
& alt_modifier
)
2094 if ((c
& ctrl_modifier
) != 0
2095 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2099 c
&= ~ctrl_modifier
;
2101 if (c
& hyper_modifier
)
2105 c
-= hyper_modifier
;
2107 if (c
& meta_modifier
)
2113 if (c
& shift_modifier
)
2117 c
-= shift_modifier
;
2119 if (c
& super_modifier
)
2123 c
-= super_modifier
;
2139 else if (c
== Ctl ('M'))
2147 /* `C-' already added above. */
2148 if (c
> 0 && c
<= Ctl ('Z'))
2167 || (NILP (current_buffer
->enable_multibyte_characters
)
2168 && SINGLE_BYTE_CHAR_P (c
)
2169 && !force_multibyte
))
2175 int valid_p
= SINGLE_BYTE_CHAR_P (c
) || char_valid_p (c
, 0);
2177 if (force_multibyte
&& valid_p
)
2179 if (SINGLE_BYTE_CHAR_P (c
))
2180 c
= unibyte_char_to_multibyte (c
);
2181 p
+= CHAR_STRING (c
, p
);
2183 else if (NILP (current_buffer
->enable_multibyte_characters
)
2188 /* The biggest character code uses 19 bits. */
2189 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2191 if (c
>= (1 << bit_offset
))
2192 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2196 p
+= CHAR_STRING (c
, p
);
2202 /* This function cannot GC. */
2204 DEFUN ("single-key-description", Fsingle_key_description
,
2205 Ssingle_key_description
, 1, 2, 0,
2206 doc
: /* Return a pretty description of command character KEY.
2207 Control characters turn into C-whatever, etc.
2208 Optional argument NO-ANGLES non-nil means don't put angle brackets
2209 around function keys and event symbols. */)
2211 Lisp_Object key
, no_angles
;
2213 if (CONSP (key
) && lucid_event_type_list_p (key
))
2214 key
= Fevent_convert_list (key
);
2216 key
= EVENT_HEAD (key
);
2218 if (INTEGERP (key
)) /* Normal character */
2220 unsigned int charset
, c1
, c2
;
2221 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2223 if (SINGLE_BYTE_CHAR_P (without_bits
))
2226 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2229 && CHARSET_DEFINED_P (charset
)
2230 && ((c1
>= 0 && c1
< 32)
2231 || (c2
>= 0 && c2
< 32)))
2233 /* Handle a generic character. */
2235 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
2236 CHECK_STRING (name
);
2237 return concat2 (build_string ("Character set "), name
);
2241 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2245 end
= push_key_description (XUINT (key
), tem
, 1);
2247 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2248 if (nchars
== nbytes
)
2251 string
= build_string (tem
);
2254 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2258 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2260 if (NILP (no_angles
))
2263 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2264 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2265 return build_string (buffer
);
2268 return Fsymbol_name (key
);
2270 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2271 return Fcopy_sequence (key
);
2273 error ("KEY must be an integer, cons, symbol, or string");
2278 push_text_char_description (c
, p
)
2279 register unsigned int c
;
2291 *p
++ = c
+ 64; /* 'A' - 1 */
2303 /* This function cannot GC. */
2305 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2306 doc
: /* Return a pretty description of file-character CHARACTER.
2307 Control characters turn into "^char", etc. This differs from
2308 `single-key-description' which turns them into "C-char".
2309 Also, this function recognizes the 2**7 bit as the Meta character,
2310 whereas `single-key-description' uses the 2**27 bit for Meta.
2311 See Info node `(elisp)Describing Characters' for examples. */)
2313 Lisp_Object character
;
2315 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2316 unsigned char str
[6];
2319 CHECK_NUMBER (character
);
2321 c
= XINT (character
);
2322 if (!SINGLE_BYTE_CHAR_P (c
))
2324 int len
= CHAR_STRING (c
, str
);
2326 return make_multibyte_string (str
, 1, len
);
2329 *push_text_char_description (c
& 0377, str
) = 0;
2331 return build_string (str
);
2334 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2337 ascii_sequence_p (seq
)
2341 int len
= XINT (Flength (seq
));
2343 for (i
= 0; i
< len
; i
++)
2345 Lisp_Object ii
, elt
;
2347 XSETFASTINT (ii
, i
);
2348 elt
= Faref (seq
, ii
);
2351 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2359 /* where-is - finding a command in a set of keymaps. */
2361 static Lisp_Object
where_is_internal ();
2362 static Lisp_Object
where_is_internal_1 ();
2363 static void where_is_internal_2 ();
2365 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2366 Returns the first non-nil binding found in any of those maps. */
2369 shadow_lookup (shadow
, key
, flag
)
2370 Lisp_Object shadow
, key
, flag
;
2372 Lisp_Object tail
, value
;
2374 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2376 value
= Flookup_key (XCAR (tail
), key
, flag
);
2377 if (NATNUMP (value
))
2379 value
= Flookup_key (XCAR (tail
),
2380 Fsubstring (key
, make_number (0), value
), flag
);
2384 else if (!NILP (value
))
2390 static Lisp_Object Vmouse_events
;
2392 /* This function can GC if Flookup_key autoloads any keymaps. */
2395 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2396 Lisp_Object definition
, keymaps
;
2397 Lisp_Object firstonly
, noindirect
, no_remap
;
2399 Lisp_Object maps
= Qnil
;
2400 Lisp_Object found
, sequences
;
2401 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2402 /* 1 means ignore all menu bindings entirely. */
2403 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2405 /* If this command is remapped, then it has no key bindings
2407 if (NILP (no_remap
) && SYMBOLP (definition
))
2410 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2415 while (CONSP (found
))
2419 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2420 found
= XCDR (found
);
2423 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2427 for (; !NILP (maps
); maps
= Fcdr (maps
))
2429 /* Key sequence to reach map, and the map that it reaches */
2430 register Lisp_Object
this, map
, tem
;
2432 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2433 [M-CHAR] sequences, check if last character of the sequence
2434 is the meta-prefix char. */
2438 this = Fcar (Fcar (maps
));
2439 map
= Fcdr (Fcar (maps
));
2440 last
= make_number (XINT (Flength (this)) - 1);
2441 last_is_meta
= (XINT (last
) >= 0
2442 && EQ (Faref (this, last
), meta_prefix_char
));
2444 /* if (nomenus && !ascii_sequence_p (this)) */
2445 if (nomenus
&& XINT (last
) >= 0
2446 && SYMBOLP (tem
= Faref (this, make_number (0)))
2447 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2448 /* If no menu entries should be returned, skip over the
2449 keymaps bound to `menu-bar' and `tool-bar' and other
2450 non-ascii prefixes like `C-down-mouse-2'. */
2457 /* Because the code we want to run on each binding is rather
2458 large, we don't want to have two separate loop bodies for
2459 sparse keymap bindings and tables; we want to iterate one
2460 loop body over both keymap and vector bindings.
2462 For this reason, if Fcar (map) is a vector, we don't
2463 advance map to the next element until i indicates that we
2464 have finished off the vector. */
2465 Lisp_Object elt
, key
, binding
;
2473 /* Set key and binding to the current key and binding, and
2474 advance map and i to the next binding. */
2477 Lisp_Object sequence
;
2479 /* In a vector, look at each element. */
2480 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2482 binding
= AREF (elt
, i
);
2483 XSETFASTINT (key
, i
);
2484 sequence
= where_is_internal_1 (binding
, key
, definition
,
2486 last
, nomenus
, last_is_meta
);
2487 if (!NILP (sequence
))
2488 sequences
= Fcons (sequence
, sequences
);
2491 else if (CHAR_TABLE_P (elt
))
2493 Lisp_Object indices
[3];
2496 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2497 Qnil
), /* Result accumulator. */
2498 Fcons (Fcons (this, last
),
2499 Fcons (make_number (nomenus
),
2500 make_number (last_is_meta
))));
2501 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2503 sequences
= XCDR (XCAR (args
));
2505 else if (CONSP (elt
))
2507 Lisp_Object sequence
;
2510 binding
= XCDR (elt
);
2512 sequence
= where_is_internal_1 (binding
, key
, definition
,
2514 last
, nomenus
, last_is_meta
);
2515 if (!NILP (sequence
))
2516 sequences
= Fcons (sequence
, sequences
);
2520 while (!NILP (sequences
))
2522 Lisp_Object sequence
, remapped
, function
;
2524 sequence
= XCAR (sequences
);
2525 sequences
= XCDR (sequences
);
2527 /* If the current sequence is a command remapping with
2528 format [remap COMMAND], find the key sequences
2529 which run COMMAND, and use those sequences instead. */
2532 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2533 && EQ (AREF (sequence
, 0), Qremap
)
2534 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2536 Lisp_Object remapped1
;
2538 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2539 if (CONSP (remapped1
))
2541 /* Verify that this key binding actually maps to the
2542 remapped command (see below). */
2543 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2545 sequence
= XCAR (remapped1
);
2546 remapped
= XCDR (remapped1
);
2547 goto record_sequence
;
2551 /* Verify that this key binding is not shadowed by another
2552 binding for the same key, before we say it exists.
2554 Mechanism: look for local definition of this key and if
2555 it is defined and does not match what we found then
2558 Either nil or number as value from Flookup_key
2560 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2564 /* Don't annoy user with strings from a menu such as
2565 Select Paste. Change them all to "(any string)",
2566 so that there seems to be only one menu item
2568 if (! NILP (sequence
))
2571 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2573 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2574 build_string ("(any string)"));
2577 /* It is a true unshadowed match. Record it, unless it's already
2578 been seen (as could happen when inheriting keymaps). */
2579 if (NILP (Fmember (sequence
, found
)))
2580 found
= Fcons (sequence
, found
);
2582 /* If firstonly is Qnon_ascii, then we can return the first
2583 binding we find. If firstonly is not Qnon_ascii but not
2584 nil, then we should return the first ascii-only binding
2586 if (EQ (firstonly
, Qnon_ascii
))
2587 RETURN_UNGCPRO (sequence
);
2588 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2589 RETURN_UNGCPRO (sequence
);
2591 if (CONSP (remapped
))
2593 sequence
= XCAR (remapped
);
2594 remapped
= XCDR (remapped
);
2595 goto record_sequence
;
2603 found
= Fnreverse (found
);
2605 /* firstonly may have been t, but we may have gone all the way through
2606 the keymaps without finding an all-ASCII key sequence. So just
2607 return the best we could find. */
2608 if (!NILP (firstonly
))
2609 return Fcar (found
);
2614 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2615 doc
: /* Return list of keys that invoke DEFINITION.
2616 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2617 If KEYMAP is nil, search all the currently active keymaps.
2618 If KEYMAP is a list of keymaps, search only those keymaps.
2620 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2621 rather than a list of all possible key sequences.
2622 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2623 no matter what it is.
2624 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2625 \(or their meta variants) and entirely reject menu bindings.
2627 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2628 to other keymaps or slots. This makes it possible to search for an
2629 indirect definition itself.
2631 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2632 that invoke a command which is remapped to DEFINITION, but include the
2633 remapped command in the returned list. */)
2634 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2635 Lisp_Object definition
, keymap
;
2636 Lisp_Object firstonly
, noindirect
, no_remap
;
2638 Lisp_Object sequences
, keymaps
;
2639 /* 1 means ignore all menu bindings entirely. */
2640 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2643 /* Find the relevant keymaps. */
2644 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2646 else if (!NILP (keymap
))
2647 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2649 keymaps
= Fcurrent_active_maps (Qnil
);
2651 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2652 We don't really need to check `keymap'. */
2653 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2657 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2659 /* Check heuristic-consistency of the cache. */
2660 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2661 where_is_cache
= Qnil
;
2663 if (NILP (where_is_cache
))
2665 /* We need to create the cache. */
2666 Lisp_Object args
[2];
2667 where_is_cache
= Fmake_hash_table (0, args
);
2668 where_is_cache_keymaps
= Qt
;
2670 /* Fill in the cache. */
2671 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2672 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2675 where_is_cache_keymaps
= keymaps
;
2678 /* We want to process definitions from the last to the first.
2679 Instead of consing, copy definitions to a vector and step
2680 over that vector. */
2681 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2682 n
= XINT (Flength (sequences
));
2683 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2684 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2685 defns
[i
++] = XCAR (sequences
);
2687 /* Verify that the key bindings are not shadowed. Note that
2688 the following can GC. */
2689 GCPRO2 (definition
, keymaps
);
2692 for (i
= n
- 1; i
>= 0; --i
)
2693 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2695 if (ascii_sequence_p (defns
[i
]))
2701 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2706 /* Kill the cache so that where_is_internal_1 doesn't think
2707 we're filling it up. */
2708 where_is_cache
= Qnil
;
2709 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2715 /* This is the function that Fwhere_is_internal calls using map_char_table.
2717 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2719 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2720 Since map_char_table doesn't really use the return value from this function,
2721 we the result append to RESULT, the slot in ARGS.
2723 This function can GC because it calls where_is_internal_1 which can
2727 where_is_internal_2 (args
, key
, binding
)
2728 Lisp_Object args
, key
, binding
;
2730 Lisp_Object definition
, noindirect
, this, last
;
2731 Lisp_Object result
, sequence
;
2732 int nomenus
, last_is_meta
;
2733 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2735 GCPRO3 (args
, key
, binding
);
2736 result
= XCDR (XCAR (args
));
2737 definition
= XCAR (XCAR (XCAR (args
)));
2738 noindirect
= XCDR (XCAR (XCAR (args
)));
2739 this = XCAR (XCAR (XCDR (args
)));
2740 last
= XCDR (XCAR (XCDR (args
)));
2741 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2742 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2744 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2745 this, last
, nomenus
, last_is_meta
);
2747 if (!NILP (sequence
))
2748 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2754 /* This function can GC because get_keyelt can. */
2757 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2758 nomenus
, last_is_meta
)
2759 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2760 int nomenus
, last_is_meta
;
2762 Lisp_Object sequence
;
2764 /* Search through indirections unless that's not wanted. */
2765 if (NILP (noindirect
))
2766 binding
= get_keyelt (binding
, 0);
2768 /* End this iteration if this element does not match
2771 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2772 || EQ (binding
, definition
)
2773 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2774 /* Doesn't match. */
2777 /* We have found a match. Construct the key sequence where we found it. */
2778 if (INTEGERP (key
) && last_is_meta
)
2780 sequence
= Fcopy_sequence (this);
2781 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2784 sequence
= append_key (this, key
);
2786 if (!NILP (where_is_cache
))
2788 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2789 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2796 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2798 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2799 doc
: /* Insert the list of all defined keys and their definitions.
2800 The list is inserted in the current buffer, while the bindings are
2801 looked up in BUFFER.
2802 The optional argument PREFIX, if non-nil, should be a key sequence;
2803 then we display only bindings that start with that prefix.
2804 The optional argument MENUS, if non-nil, says to mention menu bindings.
2805 \(Ordinarily these are omitted from the output.) */)
2806 (buffer
, prefix
, menus
)
2807 Lisp_Object buffer
, prefix
, menus
;
2809 Lisp_Object outbuf
, shadow
;
2810 int nomenu
= NILP (menus
);
2811 register Lisp_Object start1
;
2812 struct gcpro gcpro1
;
2814 char *alternate_heading
2816 Keyboard translations:\n\n\
2817 You type Translation\n\
2818 -------- -----------\n";
2823 outbuf
= Fcurrent_buffer ();
2825 /* Report on alternates for keys. */
2826 if (STRINGP (current_kboard
->Vkeyboard_translate_table
) && !NILP (prefix
))
2829 const unsigned char *translate
= SDATA (current_kboard
->Vkeyboard_translate_table
);
2830 int translate_len
= SCHARS (current_kboard
->Vkeyboard_translate_table
);
2832 for (c
= 0; c
< translate_len
; c
++)
2833 if (translate
[c
] != c
)
2835 char buf
[KEY_DESCRIPTION_SIZE
];
2838 if (alternate_heading
)
2840 insert_string (alternate_heading
);
2841 alternate_heading
= 0;
2844 bufend
= push_key_description (translate
[c
], buf
, 1);
2845 insert (buf
, bufend
- buf
);
2846 Findent_to (make_number (16), make_number (1));
2847 bufend
= push_key_description (c
, buf
, 1);
2848 insert (buf
, bufend
- buf
);
2852 /* Insert calls signal_after_change which may GC. */
2853 translate
= SDATA (current_kboard
->Vkeyboard_translate_table
);
2859 if (!NILP (current_kboard
->Vlocal_key_translation_map
))
2860 describe_map_tree (current_kboard
->Vlocal_key_translation_map
, 0, Qnil
, prefix
,
2861 "Key translations", nomenu
, 1, 0, 0);
2864 /* Print the (major mode) local map. */
2866 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2867 start1
= current_kboard
->Voverriding_terminal_local_map
;
2868 else if (!NILP (Voverriding_local_map
))
2869 start1
= Voverriding_local_map
;
2873 describe_map_tree (start1
, 1, shadow
, prefix
,
2874 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2875 shadow
= Fcons (start1
, shadow
);
2879 /* Print the minor mode and major mode keymaps. */
2881 Lisp_Object
*modes
, *maps
;
2883 /* Temporarily switch to `buffer', so that we can get that buffer's
2884 minor modes correctly. */
2885 Fset_buffer (buffer
);
2887 nmaps
= current_minor_maps (&modes
, &maps
);
2888 Fset_buffer (outbuf
);
2890 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2891 XBUFFER (buffer
), Qkeymap
);
2894 describe_map_tree (start1
, 1, shadow
, prefix
,
2895 "\f\n`keymap' Property Bindings", nomenu
,
2897 shadow
= Fcons (start1
, shadow
);
2900 /* Print the minor mode maps. */
2901 for (i
= 0; i
< nmaps
; i
++)
2903 /* The title for a minor mode keymap
2904 is constructed at run time.
2905 We let describe_map_tree do the actual insertion
2906 because it takes care of other features when doing so. */
2909 if (!SYMBOLP (modes
[i
]))
2912 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2916 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2917 SCHARS (SYMBOL_NAME (modes
[i
])));
2918 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2920 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2921 p
+= sizeof (" Minor Mode Bindings") - 1;
2924 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2925 title
, nomenu
, 0, 0, 0);
2926 shadow
= Fcons (maps
[i
], shadow
);
2929 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2930 XBUFFER (buffer
), Qlocal_map
);
2933 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2934 describe_map_tree (start1
, 1, shadow
, prefix
,
2935 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2937 describe_map_tree (start1
, 1, shadow
, prefix
,
2938 "\f\n`local-map' Property Bindings",
2941 shadow
= Fcons (start1
, shadow
);
2945 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2946 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2948 /* Print the function-key-map translations under this prefix. */
2949 if (!NILP (current_kboard
->Vlocal_function_key_map
))
2950 describe_map_tree (current_kboard
->Vlocal_function_key_map
, 0, Qnil
, prefix
,
2951 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2957 /* Insert a description of the key bindings in STARTMAP,
2958 followed by those of all maps reachable through STARTMAP.
2959 If PARTIAL is nonzero, omit certain "uninteresting" commands
2960 (such as `undefined').
2961 If SHADOW is non-nil, it is a list of maps;
2962 don't mention keys which would be shadowed by any of them.
2963 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2964 TITLE, if not 0, is a string to insert at the beginning.
2965 TITLE should not end with a colon or a newline; we supply that.
2966 If NOMENU is not 0, then omit menu-bar commands.
2968 If TRANSL is nonzero, the definitions are actually key translations
2969 so print strings and vectors differently.
2971 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2974 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
2975 don't omit it; instead, mention it but say it is shadowed. */
2978 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2979 always_title
, mention_shadow
)
2980 Lisp_Object startmap
, shadow
, prefix
;
2988 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2989 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2996 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
2999 GCPRO3 (maps
, seen
, sub_shadows
);
3005 /* Delete from MAPS each element that is for the menu bar. */
3006 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3008 Lisp_Object elt
, prefix
, tem
;
3011 prefix
= Fcar (elt
);
3012 if (XVECTOR (prefix
)->size
>= 1)
3014 tem
= Faref (prefix
, make_number (0));
3015 if (EQ (tem
, Qmenu_bar
))
3016 maps
= Fdelq (elt
, maps
);
3021 if (!NILP (maps
) || always_title
)
3025 insert_string (title
);
3028 insert_string (" Starting With ");
3029 insert1 (Fkey_description (prefix
, Qnil
));
3031 insert_string (":\n");
3033 insert_string (key_heading
);
3037 for (; !NILP (maps
); maps
= Fcdr (maps
))
3039 register Lisp_Object elt
, prefix
, tail
;
3042 prefix
= Fcar (elt
);
3046 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3050 shmap
= XCAR (tail
);
3052 /* If the sequence by which we reach this keymap is zero-length,
3053 then the shadow map for this keymap is just SHADOW. */
3054 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3055 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3057 /* If the sequence by which we reach this keymap actually has
3058 some elements, then the sequence's definition in SHADOW is
3059 what we should use. */
3062 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3063 if (INTEGERP (shmap
))
3067 /* If shmap is not nil and not a keymap,
3068 it completely shadows this map, so don't
3069 describe this map at all. */
3070 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3074 sub_shadows
= Fcons (shmap
, sub_shadows
);
3077 /* Maps we have already listed in this loop shadow this map. */
3078 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3081 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3083 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3086 describe_map (Fcdr (elt
), prefix
,
3087 transl
? describe_translation
: describe_command
,
3088 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3094 insert_string ("\n");
3099 static int previous_description_column
;
3102 describe_command (definition
, args
)
3103 Lisp_Object definition
, args
;
3105 register Lisp_Object tem1
;
3106 int column
= (int) current_column (); /* iftc */
3107 int description_column
;
3109 /* If column 16 is no good, go to col 32;
3110 but don't push beyond that--go to next line instead. */
3114 description_column
= 32;
3116 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3117 description_column
= 32;
3119 description_column
= 16;
3121 Findent_to (make_number (description_column
), make_number (1));
3122 previous_description_column
= description_column
;
3124 if (SYMBOLP (definition
))
3126 tem1
= SYMBOL_NAME (definition
);
3128 insert_string ("\n");
3130 else if (STRINGP (definition
) || VECTORP (definition
))
3131 insert_string ("Keyboard Macro\n");
3132 else if (KEYMAPP (definition
))
3133 insert_string ("Prefix Command\n");
3135 insert_string ("??\n");
3139 describe_translation (definition
, args
)
3140 Lisp_Object definition
, args
;
3142 register Lisp_Object tem1
;
3144 Findent_to (make_number (16), make_number (1));
3146 if (SYMBOLP (definition
))
3148 tem1
= SYMBOL_NAME (definition
);
3150 insert_string ("\n");
3152 else if (STRINGP (definition
) || VECTORP (definition
))
3154 insert1 (Fkey_description (definition
, Qnil
));
3155 insert_string ("\n");
3157 else if (KEYMAPP (definition
))
3158 insert_string ("Prefix Command\n");
3160 insert_string ("??\n");
3163 /* describe_map puts all the usable elements of a sparse keymap
3164 into an array of `struct describe_map_elt',
3165 then sorts them by the events. */
3167 struct describe_map_elt
{ Lisp_Object event
; Lisp_Object definition
; int shadowed
; };
3169 /* qsort comparison function for sorting `struct describe_map_elt' by
3173 describe_map_compare (aa
, bb
)
3174 const void *aa
, *bb
;
3176 const struct describe_map_elt
*a
= aa
, *b
= bb
;
3177 if (INTEGERP (a
->event
) && INTEGERP (b
->event
))
3178 return ((XINT (a
->event
) > XINT (b
->event
))
3179 - (XINT (a
->event
) < XINT (b
->event
)));
3180 if (!INTEGERP (a
->event
) && INTEGERP (b
->event
))
3182 if (INTEGERP (a
->event
) && !INTEGERP (b
->event
))
3184 if (SYMBOLP (a
->event
) && SYMBOLP (b
->event
))
3185 return (!NILP (Fstring_lessp (a
->event
, b
->event
)) ? -1
3186 : !NILP (Fstring_lessp (b
->event
, a
->event
)) ? 1
3191 /* Describe the contents of map MAP, assuming that this map itself is
3192 reached by the sequence of prefix keys PREFIX (a string or vector).
3193 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3196 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3197 seen
, nomenu
, mention_shadow
)
3198 register Lisp_Object map
;
3200 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3207 Lisp_Object tail
, definition
, event
;
3209 Lisp_Object suppress
;
3212 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3214 /* These accumulate the values from sparse keymap bindings,
3215 so we can sort them and handle them in order. */
3216 int length_needed
= 0;
3217 struct describe_map_elt
*vect
;
3224 suppress
= intern ("suppress-keymap");
3226 /* This vector gets used to present single keys to Flookup_key. Since
3227 that is done once per keymap element, we don't want to cons up a
3228 fresh vector every time. */
3229 kludge
= Fmake_vector (make_number (1), Qnil
);
3232 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3235 vect
= ((struct describe_map_elt
*)
3236 alloca (sizeof (struct describe_map_elt
) * length_needed
));
3238 GCPRO3 (prefix
, definition
, kludge
);
3240 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3244 if (VECTORP (XCAR (tail
))
3245 || CHAR_TABLE_P (XCAR (tail
)))
3246 describe_vector (XCAR (tail
),
3247 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3248 (int *)0, 0, 1, mention_shadow
);
3249 else if (CONSP (XCAR (tail
)))
3251 int this_shadowed
= 0;
3253 event
= XCAR (XCAR (tail
));
3255 /* Ignore bindings whose "prefix" are not really valid events.
3256 (We get these in the frames and buffers menu.) */
3257 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3260 if (nomenu
&& EQ (event
, Qmenu_bar
))
3263 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3265 /* Don't show undefined commands or suppressed commands. */
3266 if (NILP (definition
)) continue;
3267 if (SYMBOLP (definition
) && partial
)
3269 tem
= Fget (definition
, suppress
);
3274 /* Don't show a command that isn't really visible
3275 because a local definition of the same key shadows it. */
3277 ASET (kludge
, 0, event
);
3280 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3290 tem
= Flookup_key (map
, kludge
, Qt
);
3291 if (!EQ (tem
, definition
)) continue;
3293 vect
[slots_used
].event
= event
;
3294 vect
[slots_used
].definition
= definition
;
3295 vect
[slots_used
].shadowed
= this_shadowed
;
3298 else if (EQ (XCAR (tail
), Qkeymap
))
3300 /* The same keymap might be in the structure twice, if we're
3301 using an inherited keymap. So skip anything we've already
3303 tem
= Fassq (tail
, *seen
);
3304 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3306 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3310 /* If we found some sparse map events, sort them. */
3312 qsort (vect
, slots_used
, sizeof (struct describe_map_elt
),
3313 describe_map_compare
);
3315 /* Now output them in sorted order. */
3317 for (i
= 0; i
< slots_used
; i
++)
3319 Lisp_Object start
, end
;
3323 previous_description_column
= 0;
3328 ASET (kludge
, 0, vect
[i
].event
);
3329 start
= vect
[i
].event
;
3332 definition
= vect
[i
].definition
;
3334 /* Find consecutive chars that are identically defined. */
3335 if (INTEGERP (vect
[i
].event
))
3337 while (i
+ 1 < slots_used
3338 && XINT (vect
[i
+ 1].event
) == XINT (vect
[i
].event
) + 1
3339 && !NILP (Fequal (vect
[i
+ 1].definition
, definition
))
3340 && vect
[i
].shadowed
== vect
[i
+ 1].shadowed
)
3342 end
= vect
[i
].event
;
3345 /* Now START .. END is the range to describe next. */
3347 /* Insert the string to describe the event START. */
3348 insert1 (Fkey_description (kludge
, prefix
));
3350 if (!EQ (start
, end
))
3354 ASET (kludge
, 0, end
);
3355 /* Insert the string to describe the character END. */
3356 insert1 (Fkey_description (kludge
, prefix
));
3359 /* Print a description of the definition of this character.
3360 elt_describer will take care of spacing out far enough
3361 for alignment purposes. */
3362 (*elt_describer
) (vect
[i
].definition
, Qnil
);
3364 if (vect
[i
].shadowed
)
3367 insert_string (" (binding currently shadowed)");
3376 describe_vector_princ (elt
, fun
)
3377 Lisp_Object elt
, fun
;
3379 Findent_to (make_number (16), make_number (1));
3384 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3385 doc
: /* Insert a description of contents of VECTOR.
3386 This is text showing the elements of vector matched against indices.
3387 DESCRIBER is the output function used; nil means use `princ'. */)
3389 Lisp_Object vector
, describer
;
3391 int count
= SPECPDL_INDEX ();
3392 if (NILP (describer
))
3393 describer
= intern ("princ");
3394 specbind (Qstandard_output
, Fcurrent_buffer ());
3395 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3396 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3397 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3399 return unbind_to (count
, Qnil
);
3402 /* Insert in the current buffer a description of the contents of VECTOR.
3403 We call ELT_DESCRIBER to insert the description of one value found
3406 ELT_PREFIX describes what "comes before" the keys or indices defined
3407 by this vector. This is a human-readable string whose size
3408 is not necessarily related to the situation.
3410 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3411 leads to this keymap.
3413 If the vector is a chartable, ELT_PREFIX is the vector
3414 of bytes that lead to the character set or portion of a character
3415 set described by this chartable.
3417 If PARTIAL is nonzero, it means do not mention suppressed commands
3418 (that assumes the vector is in a keymap).
3420 SHADOW is a list of keymaps that shadow this map.
3421 If it is non-nil, then we look up the key in those maps
3422 and we don't mention it now if it is defined by any of them.
3424 ENTIRE_MAP is the keymap in which this vector appears.
3425 If the definition in effect in the whole map does not match
3426 the one in this vector, we ignore this one.
3428 When describing a sub-char-table, INDICES is a list of
3429 indices at higher levels in this char-table,
3430 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3432 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3434 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3437 describe_vector (vector
, prefix
, args
, elt_describer
,
3438 partial
, shadow
, entire_map
,
3439 indices
, char_table_depth
, keymap_p
,
3441 register Lisp_Object vector
;
3442 Lisp_Object prefix
, args
;
3443 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3446 Lisp_Object entire_map
;
3448 int char_table_depth
;
3452 Lisp_Object definition
;
3454 Lisp_Object elt_prefix
= Qnil
;
3456 Lisp_Object suppress
;
3459 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3460 /* Range of elements to be handled. */
3462 /* A flag to tell if a leaf in this level of char-table is not a
3463 generic character (i.e. a complete multibyte character). */
3471 indices
= (int *) alloca (3 * sizeof (int));
3477 /* Call Fkey_description first, to avoid GC bug for the other string. */
3478 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3481 tem
= Fkey_description (prefix
, Qnil
);
3482 elt_prefix
= concat2 (tem
, build_string (" "));
3487 /* This vector gets used to present single keys to Flookup_key. Since
3488 that is done once per vector element, we don't want to cons up a
3489 fresh vector every time. */
3490 kludge
= Fmake_vector (make_number (1), Qnil
);
3491 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3494 suppress
= intern ("suppress-keymap");
3496 if (CHAR_TABLE_P (vector
))
3498 if (char_table_depth
== 0)
3500 /* VECTOR is a top level char-table. */
3503 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3507 /* VECTOR is a sub char-table. */
3508 if (char_table_depth
>= 3)
3509 /* A char-table is never that deep. */
3510 error ("Too deep char table");
3513 = (CHARSET_VALID_P (indices
[0])
3514 && ((CHARSET_DIMENSION (indices
[0]) == 1
3515 && char_table_depth
== 1)
3516 || char_table_depth
== 2));
3518 /* Meaningful elements are from 32th to 127th. */
3520 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3525 /* This does the right thing for ordinary vectors. */
3529 to
= XVECTOR (vector
)->size
;
3532 for (i
= from
; i
< to
; i
++)
3534 int this_shadowed
= 0;
3537 if (CHAR_TABLE_P (vector
))
3539 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3542 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3543 && !CHARSET_DEFINED_P (i
- 128))
3547 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3550 definition
= get_keyelt (AREF (vector
, i
), 0);
3552 if (NILP (definition
)) continue;
3554 /* Don't mention suppressed commands. */
3555 if (SYMBOLP (definition
) && partial
)
3559 tem
= Fget (definition
, suppress
);
3561 if (!NILP (tem
)) continue;
3564 /* Set CHARACTER to the character this entry describes, if any.
3565 Also update *INDICES. */
3566 if (CHAR_TABLE_P (vector
))
3568 indices
[char_table_depth
] = i
;
3570 if (char_table_depth
== 0)
3573 indices
[0] = i
- 128;
3575 else if (complete_char
)
3577 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3585 ASET (kludge
, 0, make_number (character
));
3587 /* If this binding is shadowed by some other map, ignore it. */
3588 if (!NILP (shadow
) && complete_char
)
3592 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3603 /* Ignore this definition if it is shadowed by an earlier
3604 one in the same keymap. */
3605 if (!NILP (entire_map
) && complete_char
)
3609 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3611 if (!EQ (tem
, definition
))
3617 if (char_table_depth
== 0)
3622 /* For a sub char-table, show the depth by indentation.
3623 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3624 if (char_table_depth
> 0)
3625 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3627 /* Output the prefix that applies to every entry in this map. */
3628 if (!NILP (elt_prefix
))
3629 insert1 (elt_prefix
);
3631 /* Insert or describe the character this slot is for,
3632 or a description of what it is for. */
3633 if (SUB_CHAR_TABLE_P (vector
))
3636 insert_char (character
);
3639 /* We need an octal representation for this block of
3642 sprintf (work
, "(row %d)", i
);
3643 insert (work
, strlen (work
));
3646 else if (CHAR_TABLE_P (vector
))
3649 insert1 (Fkey_description (kludge
, prefix
));
3652 /* Print the information for this character set. */
3653 insert_string ("<");
3654 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3656 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3665 insert1 (Fkey_description (kludge
, prefix
));
3668 /* If we find a sub char-table within a char-table,
3669 scan it recursively; it defines the details for
3670 a character set or a portion of a character set. */
3671 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3674 describe_vector (definition
, prefix
, args
, elt_describer
,
3675 partial
, shadow
, entire_map
,
3676 indices
, char_table_depth
+ 1, keymap_p
,
3683 /* Find all consecutive characters or rows that have the same
3684 definition. But, for elements of a top level char table, if
3685 they are for charsets, we had better describe one by one even
3686 if they have the same definition. */
3687 if (CHAR_TABLE_P (vector
))
3691 if (char_table_depth
== 0)
3692 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3694 while (i
+ 1 < limit
3695 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3697 && !NILP (Fequal (tem2
, definition
)))
3702 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3704 && !NILP (Fequal (tem2
, definition
)))
3708 /* If we have a range of more than one character,
3709 print where the range reaches to. */
3711 if (i
!= starting_i
)
3715 ASET (kludge
, 0, make_number (i
));
3717 if (!NILP (elt_prefix
))
3718 insert1 (elt_prefix
);
3720 if (CHAR_TABLE_P (vector
))
3722 if (char_table_depth
== 0)
3724 insert1 (Fkey_description (kludge
, prefix
));
3726 else if (complete_char
)
3728 indices
[char_table_depth
] = i
;
3729 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3730 insert_char (character
);
3734 /* We need an octal representation for this block of
3737 sprintf (work
, "(row %d)", i
);
3738 insert (work
, strlen (work
));
3743 insert1 (Fkey_description (kludge
, prefix
));
3747 /* Print a description of the definition of this character.
3748 elt_describer will take care of spacing out far enough
3749 for alignment purposes. */
3750 (*elt_describer
) (definition
, args
);
3755 insert_string (" (binding currently shadowed)");
3760 /* For (sub) char-table, print `defalt' slot at last. */
3761 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3763 insert (" ", char_table_depth
* 2);
3764 insert_string ("<<default>>");
3765 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3771 /* Apropos - finding all symbols whose names match a regexp. */
3772 static Lisp_Object apropos_predicate
;
3773 static Lisp_Object apropos_accumulate
;
3776 apropos_accum (symbol
, string
)
3777 Lisp_Object symbol
, string
;
3779 register Lisp_Object tem
;
3781 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3782 if (!NILP (tem
) && !NILP (apropos_predicate
))
3783 tem
= call1 (apropos_predicate
, symbol
);
3785 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3788 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3789 doc
: /* Show all symbols whose names contain match for REGEXP.
3790 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3791 for each symbol and a symbol is mentioned only if that returns non-nil.
3792 Return list of symbols found. */)
3794 Lisp_Object regexp
, predicate
;
3797 CHECK_STRING (regexp
);
3798 apropos_predicate
= predicate
;
3799 apropos_accumulate
= Qnil
;
3800 map_obarray (Vobarray
, apropos_accum
, regexp
);
3801 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3802 apropos_accumulate
= Qnil
;
3803 apropos_predicate
= Qnil
;
3810 Qkeymap
= intern ("keymap");
3811 staticpro (&Qkeymap
);
3812 staticpro (&apropos_predicate
);
3813 staticpro (&apropos_accumulate
);
3814 apropos_predicate
= Qnil
;
3815 apropos_accumulate
= Qnil
;
3817 /* Now we are ready to set up this property, so we can
3818 create char tables. */
3819 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3821 /* Initialize the keymaps standardly used.
3822 Each one is the value of a Lisp variable, and is also
3823 pointed to by a C variable */
3825 global_map
= Fmake_keymap (Qnil
);
3826 Fset (intern ("global-map"), global_map
);
3828 current_global_map
= global_map
;
3829 staticpro (&global_map
);
3830 staticpro (¤t_global_map
);
3832 meta_map
= Fmake_keymap (Qnil
);
3833 Fset (intern ("esc-map"), meta_map
);
3834 Ffset (intern ("ESC-prefix"), meta_map
);
3836 control_x_map
= Fmake_keymap (Qnil
);
3837 Fset (intern ("ctl-x-map"), control_x_map
);
3838 Ffset (intern ("Control-X-prefix"), control_x_map
);
3841 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3842 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3843 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3844 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3845 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3847 staticpro (&exclude_keys
);
3849 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3850 doc
: /* List of commands given new key bindings recently.
3851 This is used for internal purposes during Emacs startup;
3852 don't alter it yourself. */);
3853 Vdefine_key_rebound_commands
= Qt
;
3855 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3856 doc
: /* Default keymap to use when reading from the minibuffer. */);
3857 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3859 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3860 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3861 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3862 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3864 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3865 doc
: /* Local keymap for minibuffer input with completion. */);
3866 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3867 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3869 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3870 &Vminibuffer_local_filename_completion_map
,
3871 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3872 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3873 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3874 Vminibuffer_local_completion_map
);
3877 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3878 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3879 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3880 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3881 Vminibuffer_local_completion_map
);
3883 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3884 &Vminibuffer_local_must_match_filename_map
,
3885 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3886 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3887 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3888 Vminibuffer_local_must_match_map
);
3890 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3891 doc
: /* Alist of keymaps to use for minor modes.
3892 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3893 key sequences and look up bindings iff VARIABLE's value is non-nil.
3894 If two active keymaps bind the same key, the keymap appearing earlier
3895 in the list takes precedence. */);
3896 Vminor_mode_map_alist
= Qnil
;
3898 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3899 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3900 This variable is an alist just like `minor-mode-map-alist', and it is
3901 used the same way (and before `minor-mode-map-alist'); however,
3902 it is provided for major modes to bind locally. */);
3903 Vminor_mode_overriding_map_alist
= Qnil
;
3905 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3906 doc
: /* List of keymap alists to use for emulations modes.
3907 It is intended for modes or packages using multiple minor-mode keymaps.
3908 Each element is a keymap alist just like `minor-mode-map-alist', or a
3909 symbol with a variable binding which is a keymap alist, and it is used
3910 the same way. The "active" keymaps in each alist are used before
3911 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3912 Vemulation_mode_map_alists
= Qnil
;
3914 staticpro (&Vmouse_events
);
3915 Vmouse_events
= Fcons (intern ("menu-bar"),
3916 Fcons (intern ("tool-bar"),
3917 Fcons (intern ("header-line"),
3918 Fcons (intern ("mode-line"),
3919 Fcons (intern ("mouse-1"),
3920 Fcons (intern ("mouse-2"),
3921 Fcons (intern ("mouse-3"),
3922 Fcons (intern ("mouse-4"),
3923 Fcons (intern ("mouse-5"),
3927 Qsingle_key_description
= intern ("single-key-description");
3928 staticpro (&Qsingle_key_description
);
3930 Qkey_description
= intern ("key-description");
3931 staticpro (&Qkey_description
);
3933 Qkeymapp
= intern ("keymapp");
3934 staticpro (&Qkeymapp
);
3936 Qnon_ascii
= intern ("non-ascii");
3937 staticpro (&Qnon_ascii
);
3939 Qmenu_item
= intern ("menu-item");
3940 staticpro (&Qmenu_item
);
3942 Qremap
= intern ("remap");
3943 staticpro (&Qremap
);
3945 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3946 staticpro (&command_remapping_vector
);
3948 where_is_cache_keymaps
= Qt
;
3949 where_is_cache
= Qnil
;
3950 staticpro (&where_is_cache
);
3951 staticpro (&where_is_cache_keymaps
);
3953 defsubr (&Skeymapp
);
3954 defsubr (&Skeymap_parent
);
3955 defsubr (&Skeymap_prompt
);
3956 defsubr (&Sset_keymap_parent
);
3957 defsubr (&Smake_keymap
);
3958 defsubr (&Smake_sparse_keymap
);
3959 defsubr (&Smap_keymap
);
3960 defsubr (&Scopy_keymap
);
3961 defsubr (&Scommand_remapping
);
3962 defsubr (&Skey_binding
);
3963 defsubr (&Slocal_key_binding
);
3964 defsubr (&Sglobal_key_binding
);
3965 defsubr (&Sminor_mode_key_binding
);
3966 defsubr (&Sdefine_key
);
3967 defsubr (&Slookup_key
);
3968 defsubr (&Sdefine_prefix_command
);
3969 defsubr (&Suse_global_map
);
3970 defsubr (&Suse_local_map
);
3971 defsubr (&Scurrent_local_map
);
3972 defsubr (&Scurrent_global_map
);
3973 defsubr (&Scurrent_minor_mode_maps
);
3974 defsubr (&Scurrent_active_maps
);
3975 defsubr (&Saccessible_keymaps
);
3976 defsubr (&Skey_description
);
3977 defsubr (&Sdescribe_vector
);
3978 defsubr (&Ssingle_key_description
);
3979 defsubr (&Stext_char_description
);
3980 defsubr (&Swhere_is_internal
);
3981 defsubr (&Sdescribe_buffer_bindings
);
3982 defsubr (&Sapropos_internal
);
3988 initial_define_key (global_map
, 033, "ESC-prefix");
3989 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
3992 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
3993 (do not change this comment) */