1 /* Manipulation of keymaps
2 Copyright (C) 1985, 86,87,88,93,94,95,98,99, 2000, 01, 2004
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
30 #include "termhooks.h"
31 #include "blockinput.h"
33 #include "intervals.h"
36 /* The number of elements in keymap vectors. */
37 #define DENSE_TABLE_SIZE (0200)
39 /* Actually allocate storage for these variables */
41 Lisp_Object current_global_map
; /* Current global keymap */
43 Lisp_Object global_map
; /* default global key bindings */
45 Lisp_Object meta_map
; /* The keymap used for globally bound
46 ESC-prefixed default commands */
48 Lisp_Object control_x_map
; /* The keymap used for globally bound
49 C-x-prefixed default commands */
51 /* was MinibufLocalMap */
52 Lisp_Object Vminibuffer_local_map
;
53 /* The keymap used by the minibuf for local
54 bindings when spaces are allowed in the
57 /* was MinibufLocalNSMap */
58 Lisp_Object Vminibuffer_local_ns_map
;
59 /* The keymap used by the minibuf for local
60 bindings when spaces are not encouraged
63 /* keymap used for minibuffers when doing completion */
64 /* was MinibufLocalCompletionMap */
65 Lisp_Object Vminibuffer_local_completion_map
;
67 /* keymap used for minibuffers when doing completion and require a match */
68 /* was MinibufLocalMustMatchMap */
69 Lisp_Object Vminibuffer_local_must_match_map
;
71 /* Alist of minor mode variables and keymaps. */
72 Lisp_Object Vminor_mode_map_alist
;
74 /* Alist of major-mode-specific overrides for
75 minor mode variables and keymaps. */
76 Lisp_Object Vminor_mode_overriding_map_alist
;
78 /* List of emulation mode keymap alists. */
79 Lisp_Object Vemulation_mode_map_alists
;
81 /* Keymap mapping ASCII function key sequences onto their preferred forms.
82 Initialized by the terminal-specific lisp files. See DEFVAR for more
84 Lisp_Object Vfunction_key_map
;
86 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
87 Lisp_Object Vkey_translation_map
;
89 /* A list of all commands given new bindings since a certain time
90 when nil was stored here.
91 This is used to speed up recomputation of menu key equivalents
92 when Emacs starts up. t means don't record anything here. */
93 Lisp_Object Vdefine_key_rebound_commands
;
95 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
97 /* Alist of elements like (DEL . "\d"). */
98 static Lisp_Object exclude_keys
;
100 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
101 static Lisp_Object command_remapping_vector
;
103 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
104 in a string key sequence is equivalent to prefixing with this
106 extern Lisp_Object meta_prefix_char
;
108 extern Lisp_Object Voverriding_local_map
;
110 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
111 static Lisp_Object where_is_cache
;
112 /* Which keymaps are reverse-stored in the cache. */
113 static Lisp_Object where_is_cache_keymaps
;
115 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
116 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
118 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
119 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
120 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
121 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
122 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
123 int, Lisp_Object
, Lisp_Object
*, int));
124 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
125 void (*) (Lisp_Object
, Lisp_Object
), int,
126 Lisp_Object
, Lisp_Object
, int *, int, int));
127 static void silly_event_symbol_error
P_ ((Lisp_Object
));
129 /* Keymap object support - constructors and predicates. */
131 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
132 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
133 CHARTABLE is a char-table that holds the bindings for all characters
134 without modifiers. All entries in it are initially nil, meaning
135 "command undefined". ALIST is an assoc-list which holds bindings for
136 function keys, mouse events, and any other things that appear in the
137 input stream. Initially, ALIST is nil.
139 The optional arg STRING supplies a menu name for the keymap
140 in case you use it as a menu with `x-popup-menu'. */)
146 tail
= Fcons (string
, Qnil
);
149 return Fcons (Qkeymap
,
150 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
153 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
154 doc
: /* Construct and return a new sparse keymap.
155 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
156 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
157 which binds the function key or mouse event SYMBOL to DEFINITION.
158 Initially the alist is nil.
160 The optional arg STRING supplies a menu name for the keymap
161 in case you use it as a menu with `x-popup-menu'. */)
166 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
167 return Fcons (Qkeymap
, Qnil
);
170 /* This function is used for installing the standard key bindings
171 at initialization time.
175 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
178 initial_define_key (keymap
, key
, defname
)
183 store_in_keymap (keymap
, make_number (key
), intern (defname
));
187 initial_define_lispy_key (keymap
, keyname
, defname
)
192 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
195 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
196 doc
: /* Return t if OBJECT is a keymap.
198 A keymap is a list (keymap . ALIST),
199 or a symbol whose function definition is itself a keymap.
200 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
201 a vector of densely packed bindings for small character codes
202 is also allowed as an element. */)
206 return (KEYMAPP (object
) ? Qt
: Qnil
);
209 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
210 doc
: /* Return the prompt-string of a keymap MAP.
211 If non-nil, the prompt is shown in the echo-area
212 when reading a key-sequence to be looked-up in this keymap. */)
216 map
= get_keymap (map
, 0, 0);
219 Lisp_Object tem
= XCAR (map
);
227 /* Check that OBJECT is a keymap (after dereferencing through any
228 symbols). If it is, return it.
230 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
231 is an autoload form, do the autoload and try again.
232 If AUTOLOAD is nonzero, callers must assume GC is possible.
234 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
235 is zero as well), return Qt.
237 ERROR controls how we respond if OBJECT isn't a keymap.
238 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
240 Note that most of the time, we don't want to pursue autoloads.
241 Functions like Faccessible_keymaps which scan entire keymap trees
242 shouldn't load every autoloaded keymap. I'm not sure about this,
243 but it seems to me that only read_key_sequence, Flookup_key, and
244 Fdefine_key should cause keymaps to be autoloaded.
246 This function can GC when AUTOLOAD is non-zero, because it calls
247 do_autoload which can GC. */
250 get_keymap (object
, error
, autoload
)
259 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
262 tem
= indirect_function (object
);
265 if (EQ (XCAR (tem
), Qkeymap
))
268 /* Should we do an autoload? Autoload forms for keymaps have
269 Qkeymap as their fifth element. */
270 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
)
275 tail
= Fnth (make_number (4), tem
);
276 if (EQ (tail
, Qkeymap
))
280 struct gcpro gcpro1
, gcpro2
;
282 GCPRO2 (tem
, object
);
283 do_autoload (tem
, object
);
296 wrong_type_argument (Qkeymapp
, object
);
300 /* Return the parent map of KEYMAP, or nil if it has none.
301 We assume that KEYMAP is a valid keymap. */
304 keymap_parent (keymap
, autoload
)
310 keymap
= get_keymap (keymap
, 1, autoload
);
312 /* Skip past the initial element `keymap'. */
313 list
= XCDR (keymap
);
314 for (; CONSP (list
); list
= XCDR (list
))
316 /* See if there is another `keymap'. */
321 return get_keymap (list
, 0, autoload
);
324 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
325 doc
: /* Return the parent keymap of KEYMAP. */)
329 return keymap_parent (keymap
, 1);
332 /* Check whether MAP is one of MAPS parents. */
334 keymap_memberp (map
, maps
)
335 Lisp_Object map
, maps
;
337 if (NILP (map
)) return 0;
338 while (KEYMAPP (maps
) && !EQ (map
, maps
))
339 maps
= keymap_parent (maps
, 0);
340 return (EQ (map
, maps
));
343 /* Set the parent keymap of MAP to PARENT. */
345 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
346 doc
: /* Modify KEYMAP to set its parent map to PARENT.
347 Return PARENT. PARENT should be nil or another keymap. */)
349 Lisp_Object keymap
, parent
;
351 Lisp_Object list
, prev
;
352 struct gcpro gcpro1
, gcpro2
;
355 /* Force a keymap flush for the next call to where-is.
356 Since this can be called from within where-is, we don't set where_is_cache
357 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
358 be changed during where-is, while where_is_cache_keymaps is only used at
359 the very beginning of where-is and can thus be changed here without any
361 This is a very minor correctness (rather than safety) issue. */
362 where_is_cache_keymaps
= Qt
;
364 GCPRO2 (keymap
, parent
);
365 keymap
= get_keymap (keymap
, 1, 1);
369 parent
= get_keymap (parent
, 1, 1);
371 /* Check for cycles. */
372 if (keymap_memberp (keymap
, parent
))
373 error ("Cyclic keymap inheritance");
376 /* Skip past the initial element `keymap'. */
381 /* If there is a parent keymap here, replace it.
382 If we came to the end, add the parent in PREV. */
383 if (!CONSP (list
) || KEYMAPP (list
))
385 /* If we already have the right parent, return now
386 so that we avoid the loops below. */
387 if (EQ (XCDR (prev
), parent
))
388 RETURN_UNGCPRO (parent
);
390 XSETCDR (prev
, parent
);
396 /* Scan through for submaps, and set their parents too. */
398 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
400 /* Stop the scan when we come to the parent. */
401 if (EQ (XCAR (list
), Qkeymap
))
404 /* If this element holds a prefix map, deal with it. */
405 if (CONSP (XCAR (list
))
406 && CONSP (XCDR (XCAR (list
))))
407 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
410 if (VECTORP (XCAR (list
)))
411 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
412 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
413 fix_submap_inheritance (keymap
, make_number (i
),
414 XVECTOR (XCAR (list
))->contents
[i
]);
416 if (CHAR_TABLE_P (XCAR (list
)))
418 Lisp_Object indices
[3];
420 map_char_table (fix_submap_inheritance
, Qnil
,
421 XCAR (list
), XCAR (list
),
426 RETURN_UNGCPRO (parent
);
429 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
430 if EVENT is also a prefix in MAP's parent,
431 make sure that SUBMAP inherits that definition as its own parent. */
434 fix_submap_inheritance (map
, event
, submap
)
435 Lisp_Object map
, event
, submap
;
437 Lisp_Object map_parent
, parent_entry
;
439 /* SUBMAP is a cons that we found as a key binding.
440 Discard the other things found in a menu key binding. */
442 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
444 /* If it isn't a keymap now, there's no work to do. */
448 map_parent
= keymap_parent (map
, 0);
449 if (!NILP (map_parent
))
451 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
455 /* If MAP's parent has something other than a keymap,
456 our own submap shadows it completely. */
457 if (!CONSP (parent_entry
))
460 if (! EQ (parent_entry
, submap
))
462 Lisp_Object submap_parent
;
463 submap_parent
= submap
;
468 tem
= keymap_parent (submap_parent
, 0);
472 if (keymap_memberp (tem
, parent_entry
))
473 /* Fset_keymap_parent could create a cycle. */
480 Fset_keymap_parent (submap_parent
, parent_entry
);
484 /* Look up IDX in MAP. IDX may be any sort of event.
485 Note that this does only one level of lookup; IDX must be a single
486 event, not a sequence.
488 If T_OK is non-zero, bindings for Qt are treated as default
489 bindings; any key left unmentioned by other tables and bindings is
490 given the binding of Qt.
492 If T_OK is zero, bindings for Qt are not treated specially.
494 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
497 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
506 /* Qunbound in VAL means we have found no binding yet. */
509 /* If idx is a list (some sort of mouse click, perhaps?),
510 the index we want to use is the car of the list, which
511 ought to be a symbol. */
512 idx
= EVENT_HEAD (idx
);
514 /* If idx is a symbol, it might have modifiers, which need to
515 be put in the canonical order. */
517 idx
= reorder_modifiers (idx
);
518 else if (INTEGERP (idx
))
519 /* Clobber the high bits that can be present on a machine
520 with more than 24 bits of integer. */
521 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
523 /* Handle the special meta -> esc mapping. */
524 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
526 /* See if there is a meta-map. If there's none, there is
527 no binding for IDX, unless a default binding exists in MAP. */
529 Lisp_Object meta_map
;
531 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
532 t_ok
, noinherit
, autoload
),
535 if (CONSP (meta_map
))
538 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
541 /* Set IDX to t, so that we only find a default binding. */
544 /* We know there is no binding. */
548 /* t_binding is where we put a default binding that applies,
549 to use in case we do not find a binding specifically
550 for this key sequence. */
553 Lisp_Object t_binding
= Qnil
;
554 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
556 GCPRO4 (map
, tail
, idx
, t_binding
);
558 /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
559 If it is 1, only generic-char bindings are accepted.
560 Otherwise, neither are. */
563 for (tail
= XCDR (map
);
565 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
570 binding
= XCAR (tail
);
571 if (SYMBOLP (binding
))
573 /* If NOINHERIT, stop finding prefix definitions
574 after we pass a second occurrence of the `keymap' symbol. */
575 if (noinherit
&& EQ (binding
, Qkeymap
))
576 RETURN_UNGCPRO (Qnil
);
578 else if (CONSP (binding
))
580 Lisp_Object key
= XCAR (binding
);
583 val
= XCDR (binding
);
586 && (XINT (idx
) & CHAR_MODIFIER_MASK
) == 0
588 && (XINT (key
) & CHAR_MODIFIER_MASK
) == 0
589 && !SINGLE_BYTE_CHAR_P (XINT (idx
))
590 && !SINGLE_BYTE_CHAR_P (XINT (key
))
591 && CHAR_VALID_P (XINT (key
), 1)
592 && !CHAR_VALID_P (XINT (key
), 0)
593 && (CHAR_CHARSET (XINT (key
))
594 == CHAR_CHARSET (XINT (idx
))))
596 /* KEY is the generic character of the charset of IDX.
597 Use KEY's binding if there isn't a binding for IDX
599 t_binding
= XCDR (binding
);
602 else if (t_ok
> 1 && EQ (key
, Qt
))
604 t_binding
= XCDR (binding
);
608 else if (VECTORP (binding
))
610 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
611 val
= AREF (binding
, XFASTINT (idx
));
613 else if (CHAR_TABLE_P (binding
))
615 /* Character codes with modifiers
616 are not included in a char-table.
617 All character codes without modifiers are included. */
618 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
620 val
= Faref (binding
, idx
);
621 /* `nil' has a special meaning for char-tables, so
622 we use something else to record an explicitly
629 /* If we found a binding, clean it up and return it. */
630 if (!EQ (val
, Qunbound
))
633 /* A Qt binding is just like an explicit nil binding
634 (i.e. it shadows any parent binding but not bindings in
635 keymaps of lower precedence). */
637 val
= get_keyelt (val
, autoload
);
639 fix_submap_inheritance (map
, idx
, val
);
640 RETURN_UNGCPRO (val
);
645 return get_keyelt (t_binding
, autoload
);
650 map_keymap_item (fun
, args
, key
, val
, data
)
651 map_keymap_function_t fun
;
652 Lisp_Object args
, key
, val
;
655 /* We should maybe try to detect bindings shadowed by previous
656 ones and things like that. */
659 (*fun
) (key
, val
, args
, data
);
663 map_keymap_char_table_item (args
, key
, val
)
664 Lisp_Object args
, key
, val
;
668 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
670 map_keymap_item (fun
, XCDR (args
), key
, val
,
671 XSAVE_VALUE (XCAR (args
))->pointer
);
675 /* Call FUN for every binding in MAP.
676 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
677 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
679 map_keymap (map
, fun
, args
, data
, autoload
)
680 map_keymap_function_t fun
;
681 Lisp_Object map
, args
;
685 struct gcpro gcpro1
, gcpro2
, gcpro3
;
688 GCPRO3 (map
, args
, tail
);
689 map
= get_keymap (map
, 1, autoload
);
690 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
691 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
694 Lisp_Object binding
= XCAR (tail
);
697 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
698 else if (VECTORP (binding
))
700 /* Loop over the char values represented in the vector. */
701 int len
= ASIZE (binding
);
703 for (c
= 0; c
< len
; c
++)
705 Lisp_Object character
;
706 XSETFASTINT (character
, c
);
707 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
710 else if (CHAR_TABLE_P (binding
))
712 Lisp_Object indices
[3];
713 map_char_table (map_keymap_char_table_item
, Qnil
, binding
, binding
,
714 Fcons (make_save_value (fun
, 0),
715 Fcons (make_save_value (data
, 0),
724 map_keymap_call (key
, val
, fun
, dummy
)
725 Lisp_Object key
, val
, fun
;
728 call2 (fun
, key
, val
);
731 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
732 doc
: /* Call FUNCTION for every binding in KEYMAP.
733 FUNCTION is called with two arguments: the event and its binding.
734 If KEYMAP has a parent, the parent's bindings are included as well.
735 This works recursively: if the parent has itself a parent, then the
736 grandparent's bindings are also included and so on.
737 usage: (map-keymap FUNCTION KEYMAP) */)
738 (function
, keymap
, sort_first
)
739 Lisp_Object function
, keymap
, sort_first
;
741 if (INTEGERP (function
))
742 /* We have to stop integers early since map_keymap gives them special
744 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
745 if (! NILP (sort_first
))
746 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
748 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
752 /* Given OBJECT which was found in a slot in a keymap,
753 trace indirect definitions to get the actual definition of that slot.
754 An indirect definition is a list of the form
755 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
756 and INDEX is the object to look up in KEYMAP to yield the definition.
758 Also if OBJECT has a menu string as the first element,
759 remove that. Also remove a menu help string as second element.
761 If AUTOLOAD is nonzero, load autoloadable keymaps
762 that are referred to with indirection. */
765 get_keyelt (object
, autoload
)
771 if (!(CONSP (object
)))
772 /* This is really the value. */
775 /* If the keymap contents looks like (keymap ...) or (lambda ...)
777 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
780 /* If the keymap contents looks like (menu-item name . DEFN)
781 or (menu-item name DEFN ...) then use DEFN.
782 This is a new format menu item. */
783 else if (EQ (XCAR (object
), Qmenu_item
))
785 if (CONSP (XCDR (object
)))
789 object
= XCDR (XCDR (object
));
792 object
= XCAR (object
);
794 /* If there's a `:filter FILTER', apply FILTER to the
795 menu-item's definition to get the real definition to
797 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
798 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
801 filter
= XCAR (XCDR (tem
));
802 filter
= list2 (filter
, list2 (Qquote
, object
));
803 object
= menu_item_eval_property (filter
);
808 /* Invalid keymap. */
812 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
813 Keymap alist elements like (CHAR MENUSTRING . DEFN)
814 will be used by HierarKey menus. */
815 else if (STRINGP (XCAR (object
)))
817 object
= XCDR (object
);
818 /* Also remove a menu help string, if any,
819 following the menu item name. */
820 if (CONSP (object
) && STRINGP (XCAR (object
)))
821 object
= XCDR (object
);
822 /* Also remove the sublist that caches key equivalences, if any. */
823 if (CONSP (object
) && CONSP (XCAR (object
)))
826 carcar
= XCAR (XCAR (object
));
827 if (NILP (carcar
) || VECTORP (carcar
))
828 object
= XCDR (object
);
832 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
838 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
840 return (!CONSP (map
) ? object
/* Invalid keymap */
841 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
847 store_in_keymap (keymap
, idx
, def
)
849 register Lisp_Object idx
;
850 register Lisp_Object def
;
852 /* Flush any reverse-map cache. */
853 where_is_cache
= Qnil
;
854 where_is_cache_keymaps
= Qt
;
856 /* If we are preparing to dump, and DEF is a menu element
857 with a menu item indicator, copy it to ensure it is not pure. */
858 if (CONSP (def
) && PURE_P (def
)
859 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
860 def
= Fcons (XCAR (def
), XCDR (def
));
862 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
863 error ("attempt to define a key in a non-keymap");
865 /* If idx is a list (some sort of mouse click, perhaps?),
866 the index we want to use is the car of the list, which
867 ought to be a symbol. */
868 idx
= EVENT_HEAD (idx
);
870 /* If idx is a symbol, it might have modifiers, which need to
871 be put in the canonical order. */
873 idx
= reorder_modifiers (idx
);
874 else if (INTEGERP (idx
))
875 /* Clobber the high bits that can be present on a machine
876 with more than 24 bits of integer. */
877 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
879 /* Scan the keymap for a binding of idx. */
883 /* The cons after which we should insert new bindings. If the
884 keymap has a table element, we record its position here, so new
885 bindings will go after it; this way, the table will stay
886 towards the front of the alist and character lookups in dense
887 keymaps will remain fast. Otherwise, this just points at the
888 front of the keymap. */
889 Lisp_Object insertion_point
;
891 insertion_point
= keymap
;
892 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
899 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
901 ASET (elt
, XFASTINT (idx
), def
);
904 insertion_point
= tail
;
906 else if (CHAR_TABLE_P (elt
))
908 /* Character codes with modifiers
909 are not included in a char-table.
910 All character codes without modifiers are included. */
911 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
914 /* `nil' has a special meaning for char-tables, so
915 we use something else to record an explicitly
917 NILP (def
) ? Qt
: def
);
920 insertion_point
= tail
;
922 else if (CONSP (elt
))
924 if (EQ (idx
, XCAR (elt
)))
930 else if (EQ (elt
, Qkeymap
))
931 /* If we find a 'keymap' symbol in the spine of KEYMAP,
932 then we must have found the start of a second keymap
933 being used as the tail of KEYMAP, and a binding for IDX
934 should be inserted before it. */
941 /* We have scanned the entire keymap, and not found a binding for
942 IDX. Let's add one. */
943 XSETCDR (insertion_point
,
944 Fcons (Fcons (idx
, def
), XCDR (insertion_point
)));
950 EXFUN (Fcopy_keymap
, 1);
953 copy_keymap_item (elt
)
956 Lisp_Object res
, tem
;
963 /* Is this a new format menu item. */
964 if (EQ (XCAR (tem
), Qmenu_item
))
966 /* Copy cell with menu-item marker. */
967 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
971 /* Copy cell with menu-item name. */
972 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
978 /* Copy cell with binding and if the binding is a keymap,
980 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
983 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
984 XSETCAR (elt
, Fcopy_keymap (tem
));
986 if (CONSP (tem
) && CONSP (XCAR (tem
)))
987 /* Delete cache for key equivalences. */
988 XSETCDR (elt
, XCDR (tem
));
993 /* It may be an old fomat menu item.
994 Skip the optional menu string. */
995 if (STRINGP (XCAR (tem
)))
997 /* Copy the cell, since copy-alist didn't go this deep. */
998 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1000 /* Also skip the optional menu help string. */
1001 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1003 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1007 /* There may also be a list that caches key equivalences.
1008 Just delete it for the new keymap. */
1010 && CONSP (XCAR (tem
))
1011 && (NILP (XCAR (XCAR (tem
)))
1012 || VECTORP (XCAR (XCAR (tem
)))))
1014 XSETCDR (elt
, XCDR (tem
));
1017 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1018 XSETCDR (elt
, Fcopy_keymap (tem
));
1020 else if (EQ (XCAR (tem
), Qkeymap
))
1021 res
= Fcopy_keymap (elt
);
1027 copy_keymap_1 (chartable
, idx
, elt
)
1028 Lisp_Object chartable
, idx
, elt
;
1030 Faset (chartable
, idx
, copy_keymap_item (elt
));
1033 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1034 doc
: /* Return a copy of the keymap KEYMAP.
1035 The copy starts out with the same definitions of KEYMAP,
1036 but changing either the copy or KEYMAP does not affect the other.
1037 Any key definitions that are subkeymaps are recursively copied.
1038 However, a key definition which is a symbol whose definition is a keymap
1043 register Lisp_Object copy
, tail
;
1044 keymap
= get_keymap (keymap
, 1, 0);
1045 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1046 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1048 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1050 Lisp_Object elt
= XCAR (keymap
);
1051 if (CHAR_TABLE_P (elt
))
1053 Lisp_Object indices
[3];
1054 elt
= Fcopy_sequence (elt
);
1055 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, elt
, 0, indices
);
1057 else if (VECTORP (elt
))
1060 elt
= Fcopy_sequence (elt
);
1061 for (i
= 0; i
< ASIZE (elt
); i
++)
1062 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1064 else if (CONSP (elt
))
1065 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1066 XSETCDR (tail
, Fcons (elt
, Qnil
));
1068 keymap
= XCDR (keymap
);
1070 XSETCDR (tail
, keymap
);
1074 /* Simple Keymap mutators and accessors. */
1076 /* GC is possible in this function if it autoloads a keymap. */
1078 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1079 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1082 KEY is a string or a vector of symbols and characters meaning a
1083 sequence of keystrokes and events. Non-ASCII characters with codes
1084 above 127 (such as ISO Latin-1) can be included if you use a vector.
1085 Using [t] for KEY creates a default definition, which applies to any
1086 event type that has no other definition in this keymap.
1088 DEF is anything that can be a key's definition:
1089 nil (means key is undefined in this keymap),
1090 a command (a Lisp function suitable for interactive calling),
1091 a string (treated as a keyboard macro),
1092 a keymap (to define a prefix key),
1093 a symbol (when the key is looked up, the symbol will stand for its
1094 function definition, which should at that time be one of the above,
1095 or another symbol whose function definition is used, etc.),
1096 a cons (STRING . DEFN), meaning that DEFN is the definition
1097 (DEFN should be a valid definition in its own right),
1098 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1100 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1101 binding is altered. If there is no binding for KEY, the new pair
1102 binding KEY to DEF is added at the front of KEYMAP. */)
1109 register Lisp_Object c
;
1110 register Lisp_Object cmd
;
1114 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1116 GCPRO3 (keymap
, key
, def
);
1117 keymap
= get_keymap (keymap
, 1, 1);
1119 if (!VECTORP (key
) && !STRINGP (key
))
1120 key
= wrong_type_argument (Qarrayp
, key
);
1122 length
= XFASTINT (Flength (key
));
1124 RETURN_UNGCPRO (Qnil
);
1126 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1127 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1129 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1134 c
= Faref (key
, make_number (idx
));
1136 if (CONSP (c
) && lucid_event_type_list_p (c
))
1137 c
= Fevent_convert_list (c
);
1140 silly_event_symbol_error (c
);
1143 && (XINT (c
) & meta_bit
)
1146 c
= meta_prefix_char
;
1152 XSETINT (c
, XINT (c
) & ~meta_bit
);
1158 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1159 error ("Key sequence contains invalid event");
1162 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1164 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1166 /* If this key is undefined, make it a prefix. */
1168 cmd
= define_as_prefix (keymap
, c
);
1170 keymap
= get_keymap (cmd
, 0, 1);
1171 if (!CONSP (keymap
))
1172 /* We must use Fkey_description rather than just passing key to
1173 error; key might be a vector, not a string. */
1174 error ("Key sequence %s uses invalid prefix characters",
1175 SDATA (Fkey_description (key
, Qnil
)));
1179 /* This function may GC (it calls Fkey_binding). */
1181 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1182 doc
: /* Return the remapping for command COMMAND in current keymaps.
1183 Returns nil if COMMAND is not remapped (or not a symbol). */)
1185 Lisp_Object command
;
1187 if (!SYMBOLP (command
))
1190 ASET (command_remapping_vector
, 1, command
);
1191 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1194 /* Value is number if KEY is too long; nil if valid but has no definition. */
1195 /* GC is possible in this function if it autoloads a keymap. */
1197 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1198 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1199 nil means undefined. See doc of `define-key' for kinds of definitions.
1201 A number as value means KEY is "too long";
1202 that is, characters or symbols in it except for the last one
1203 fail to be a valid sequence of prefix characters in KEYMAP.
1204 The number is how many characters at the front of KEY
1205 it takes to reach a non-prefix command.
1207 Normally, `lookup-key' ignores bindings for t, which act as default
1208 bindings, used when nothing else in the keymap applies; this makes it
1209 usable as a general function for probing keymaps. However, if the
1210 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1211 recognize the default bindings, just as `read-key-sequence' does. */)
1212 (keymap
, key
, accept_default
)
1215 Lisp_Object accept_default
;
1218 register Lisp_Object cmd
;
1219 register Lisp_Object c
;
1221 int t_ok
= !NILP (accept_default
);
1222 struct gcpro gcpro1
, gcpro2
;
1224 GCPRO2 (keymap
, key
);
1225 keymap
= get_keymap (keymap
, 1, 1);
1227 if (!VECTORP (key
) && !STRINGP (key
))
1228 key
= wrong_type_argument (Qarrayp
, key
);
1230 length
= XFASTINT (Flength (key
));
1232 RETURN_UNGCPRO (keymap
);
1237 c
= Faref (key
, make_number (idx
++));
1239 if (CONSP (c
) && lucid_event_type_list_p (c
))
1240 c
= Fevent_convert_list (c
);
1242 /* Turn the 8th bit of string chars into a meta modifier. */
1243 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1244 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1246 /* Allow string since binding for `menu-bar-select-buffer'
1247 includes the buffer name in the key sequence. */
1248 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1249 error ("Key sequence contains invalid event");
1251 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1253 RETURN_UNGCPRO (cmd
);
1255 keymap
= get_keymap (cmd
, 0, 1);
1256 if (!CONSP (keymap
))
1257 RETURN_UNGCPRO (make_number (idx
));
1263 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1264 Assume that currently it does not define C at all.
1265 Return the keymap. */
1268 define_as_prefix (keymap
, c
)
1269 Lisp_Object keymap
, c
;
1273 cmd
= Fmake_sparse_keymap (Qnil
);
1274 /* If this key is defined as a prefix in an inherited keymap,
1275 make it a prefix in this map, and make its definition
1276 inherit the other prefix definition. */
1277 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1278 store_in_keymap (keymap
, c
, cmd
);
1283 /* Append a key to the end of a key sequence. We always make a vector. */
1286 append_key (key_sequence
, key
)
1287 Lisp_Object key_sequence
, key
;
1289 Lisp_Object args
[2];
1291 args
[0] = key_sequence
;
1293 args
[1] = Fcons (key
, Qnil
);
1294 return Fvconcat (2, args
);
1297 /* Given a event type C which is a symbol,
1298 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1301 silly_event_symbol_error (c
)
1304 Lisp_Object parsed
, base
, name
, assoc
;
1307 parsed
= parse_modifiers (c
);
1308 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1309 base
= XCAR (parsed
);
1310 name
= Fsymbol_name (base
);
1311 /* This alist includes elements such as ("RET" . "\\r"). */
1312 assoc
= Fassoc (name
, exclude_keys
);
1316 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1318 Lisp_Object keystring
;
1319 if (modifiers
& alt_modifier
)
1320 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1321 if (modifiers
& ctrl_modifier
)
1322 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1323 if (modifiers
& hyper_modifier
)
1324 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1325 if (modifiers
& meta_modifier
)
1326 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1327 if (modifiers
& shift_modifier
)
1328 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1329 if (modifiers
& super_modifier
)
1330 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1333 c
= reorder_modifiers (c
);
1334 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1336 error ((modifiers
& ~meta_modifier
1337 ? "To bind the key %s, use [?%s], not [%s]"
1338 : "To bind the key %s, use \"%s\", not [%s]"),
1339 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1340 SDATA (SYMBOL_NAME (c
)));
1344 /* Global, local, and minor mode keymap stuff. */
1346 /* We can't put these variables inside current_minor_maps, since under
1347 some systems, static gets macro-defined to be the empty string.
1349 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1350 static int cmm_size
= 0;
1352 /* Error handler used in current_minor_maps. */
1354 current_minor_maps_error ()
1359 /* Store a pointer to an array of the keymaps of the currently active
1360 minor modes in *buf, and return the number of maps it contains.
1362 This function always returns a pointer to the same buffer, and may
1363 free or reallocate it, so if you want to keep it for a long time or
1364 hand it out to lisp code, copy it. This procedure will be called
1365 for every key sequence read, so the nice lispy approach (return a
1366 new assoclist, list, what have you) for each invocation would
1367 result in a lot of consing over time.
1369 If we used xrealloc/xmalloc and ran out of memory, they would throw
1370 back to the command loop, which would try to read a key sequence,
1371 which would call this function again, resulting in an infinite
1372 loop. Instead, we'll use realloc/malloc and silently truncate the
1373 list, let the key sequence be read, and hope some other piece of
1374 code signals the error. */
1376 current_minor_maps (modeptr
, mapptr
)
1377 Lisp_Object
**modeptr
, **mapptr
;
1380 int list_number
= 0;
1381 Lisp_Object alist
, assoc
, var
, val
;
1382 Lisp_Object emulation_alists
;
1383 Lisp_Object lists
[2];
1385 emulation_alists
= Vemulation_mode_map_alists
;
1386 lists
[0] = Vminor_mode_overriding_map_alist
;
1387 lists
[1] = Vminor_mode_map_alist
;
1389 for (list_number
= 0; list_number
< 2; list_number
++)
1391 if (CONSP (emulation_alists
))
1393 alist
= XCAR (emulation_alists
);
1394 emulation_alists
= XCDR (emulation_alists
);
1395 if (SYMBOLP (alist
))
1396 alist
= find_symbol_value (alist
);
1400 alist
= lists
[list_number
];
1402 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1403 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1404 && (var
= XCAR (assoc
), SYMBOLP (var
))
1405 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1410 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1411 and also an entry in Vminor_mode_map_alist,
1412 ignore the latter. */
1413 if (list_number
== 1)
1415 val
= assq_no_quit (var
, lists
[0]);
1422 int newsize
, allocsize
;
1423 Lisp_Object
*newmodes
, *newmaps
;
1425 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1426 allocsize
= newsize
* sizeof *newmodes
;
1428 /* Use malloc here. See the comment above this function.
1429 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1431 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1436 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1439 cmm_modes
= newmodes
;
1442 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1447 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1454 if (newmodes
== NULL
|| newmaps
== NULL
)
1459 /* Get the keymap definition--or nil if it is not defined. */
1460 temp
= internal_condition_case_1 (Findirect_function
,
1462 Qerror
, current_minor_maps_error
);
1466 cmm_maps
[i
] = temp
;
1472 if (modeptr
) *modeptr
= cmm_modes
;
1473 if (mapptr
) *mapptr
= cmm_maps
;
1477 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1479 doc
: /* Return a list of the currently active keymaps.
1480 OLP if non-nil indicates that we should obey `overriding-local-map' and
1481 `overriding-terminal-local-map'. */)
1485 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1489 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1490 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1491 /* The doc said that overriding-terminal-local-map should
1492 override overriding-local-map. The code used them both,
1493 but it seems clearer to use just one. rms, jan 2005. */
1494 else if (!NILP (Voverriding_local_map
))
1495 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1497 if (NILP (XCDR (keymaps
)))
1503 /* This usually returns the buffer's local map,
1504 but that can be overridden by a `local-map' property. */
1505 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1507 keymaps
= Fcons (local
, keymaps
);
1509 /* Now put all the minor mode keymaps on the list. */
1510 nmaps
= current_minor_maps (0, &maps
);
1512 for (i
= --nmaps
; i
>= 0; i
--)
1513 if (!NILP (maps
[i
]))
1514 keymaps
= Fcons (maps
[i
], keymaps
);
1516 /* This returns nil unless there is a `keymap' property. */
1517 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1519 keymaps
= Fcons (local
, keymaps
);
1525 /* GC is possible in this function if it autoloads a keymap. */
1527 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1528 doc
: /* Return the binding for command KEY in current keymaps.
1529 KEY is a string or vector, a sequence of keystrokes.
1530 The binding is probably a symbol with a function definition.
1532 Normally, `key-binding' ignores bindings for t, which act as default
1533 bindings, used when nothing else in the keymap applies; this makes it
1534 usable as a general function for probing keymaps. However, if the
1535 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1536 recognize the default bindings, just as `read-key-sequence' does.
1538 Like the normal command loop, `key-binding' will remap the command
1539 resulting from looking up KEY by looking up the command in the
1540 current keymaps. However, if the optional third argument NO-REMAP
1541 is non-nil, `key-binding' returns the unmapped command. */)
1542 (key
, accept_default
, no_remap
)
1543 Lisp_Object key
, accept_default
, no_remap
;
1545 Lisp_Object
*maps
, value
;
1547 struct gcpro gcpro1
;
1551 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1553 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1554 key
, accept_default
);
1555 if (! NILP (value
) && !INTEGERP (value
))
1558 else if (!NILP (Voverriding_local_map
))
1560 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1561 if (! NILP (value
) && !INTEGERP (value
))
1568 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1571 value
= Flookup_key (local
, key
, accept_default
);
1572 if (! NILP (value
) && !INTEGERP (value
))
1576 nmaps
= current_minor_maps (0, &maps
);
1577 /* Note that all these maps are GCPRO'd
1578 in the places where we found them. */
1580 for (i
= 0; i
< nmaps
; i
++)
1581 if (! NILP (maps
[i
]))
1583 value
= Flookup_key (maps
[i
], key
, accept_default
);
1584 if (! NILP (value
) && !INTEGERP (value
))
1588 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1591 value
= Flookup_key (local
, key
, accept_default
);
1592 if (! NILP (value
) && !INTEGERP (value
))
1597 value
= Flookup_key (current_global_map
, key
, accept_default
);
1601 if (NILP (value
) || INTEGERP (value
))
1604 /* If the result of the ordinary keymap lookup is an interactive
1605 command, look for a key binding (ie. remapping) for that command. */
1607 if (NILP (no_remap
) && SYMBOLP (value
))
1610 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1617 /* GC is possible in this function if it autoloads a keymap. */
1619 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1620 doc
: /* Return the binding for command KEYS in current local keymap only.
1621 KEYS is a string or vector, a sequence of keystrokes.
1622 The binding is probably a symbol with a function definition.
1624 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1625 bindings; see the description of `lookup-key' for more details about this. */)
1626 (keys
, accept_default
)
1627 Lisp_Object keys
, accept_default
;
1629 register Lisp_Object map
;
1630 map
= current_buffer
->keymap
;
1633 return Flookup_key (map
, keys
, accept_default
);
1636 /* GC is possible in this function if it autoloads a keymap. */
1638 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1639 doc
: /* Return the binding for command KEYS in current global keymap only.
1640 KEYS is a string or vector, a sequence of keystrokes.
1641 The binding is probably a symbol with a function definition.
1642 This function's return values are the same as those of `lookup-key'
1645 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1646 bindings; see the description of `lookup-key' for more details about this. */)
1647 (keys
, accept_default
)
1648 Lisp_Object keys
, accept_default
;
1650 return Flookup_key (current_global_map
, keys
, accept_default
);
1653 /* GC is possible in this function if it autoloads a keymap. */
1655 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1656 doc
: /* Find the visible minor mode bindings of KEY.
1657 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the
1658 the symbol which names the minor mode binding KEY, and BINDING is
1659 KEY's definition in that mode. In particular, if KEY has no
1660 minor-mode bindings, return nil. If the first binding is a
1661 non-prefix, all subsequent bindings will be omitted, since they would
1662 be ignored. Similarly, the list doesn't include non-prefix bindings
1663 that come after prefix bindings.
1665 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1666 bindings; see the description of `lookup-key' for more details about this. */)
1667 (key
, accept_default
)
1668 Lisp_Object key
, accept_default
;
1670 Lisp_Object
*modes
, *maps
;
1672 Lisp_Object binding
;
1674 struct gcpro gcpro1
, gcpro2
;
1676 nmaps
= current_minor_maps (&modes
, &maps
);
1677 /* Note that all these maps are GCPRO'd
1678 in the places where we found them. */
1681 GCPRO2 (key
, binding
);
1683 for (i
= j
= 0; i
< nmaps
; i
++)
1685 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1686 && !INTEGERP (binding
))
1688 if (KEYMAPP (binding
))
1689 maps
[j
++] = Fcons (modes
[i
], binding
);
1691 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1695 return Flist (j
, maps
);
1698 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1699 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1700 A new sparse keymap is stored as COMMAND's function definition and its value.
1701 If a second optional argument MAPVAR is given, the map is stored as
1702 its value instead of as COMMAND's value; but COMMAND is still defined
1704 The third optional argument NAME, if given, supplies a menu name
1705 string for the map. This is required to use the keymap as a menu.
1706 This function returns COMMAND. */)
1707 (command
, mapvar
, name
)
1708 Lisp_Object command
, mapvar
, name
;
1711 map
= Fmake_sparse_keymap (name
);
1712 Ffset (command
, map
);
1716 Fset (command
, map
);
1720 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1721 doc
: /* Select KEYMAP as the global keymap. */)
1725 keymap
= get_keymap (keymap
, 1, 1);
1726 current_global_map
= keymap
;
1731 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1732 doc
: /* Select KEYMAP as the local keymap.
1733 If KEYMAP is nil, that means no local keymap. */)
1738 keymap
= get_keymap (keymap
, 1, 1);
1740 current_buffer
->keymap
= keymap
;
1745 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1746 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1749 return current_buffer
->keymap
;
1752 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1753 doc
: /* Return the current global keymap. */)
1756 return current_global_map
;
1759 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1760 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1764 int nmaps
= current_minor_maps (0, &maps
);
1766 return Flist (nmaps
, maps
);
1769 /* Help functions for describing and documenting keymaps. */
1773 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1774 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1775 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1779 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1783 /* Look for and break cycles. */
1784 while (!NILP (tem
= Frassq (cmd
, maps
)))
1786 Lisp_Object prefix
= XCAR (tem
);
1787 int lim
= XINT (Flength (XCAR (tem
)));
1788 if (lim
<= XINT (Flength (thisseq
)))
1789 { /* This keymap was already seen with a smaller prefix. */
1791 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1792 Faref (thisseq
, make_number (i
))))
1795 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1798 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1799 but maybe `cmd' occurs again further down in `maps', so keep
1801 maps
= XCDR (Fmemq (tem
, maps
));
1804 /* If the last key in thisseq is meta-prefix-char,
1805 turn it into a meta-ized keystroke. We know
1806 that the event we're about to append is an
1807 ascii keystroke since we're processing a
1811 int meta_bit
= meta_modifier
;
1812 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1813 tem
= Fcopy_sequence (thisseq
);
1815 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1817 /* This new sequence is the same length as
1818 thisseq, so stick it in the list right
1821 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1825 tem
= append_key (thisseq
, key
);
1826 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1831 accessible_keymaps_char_table (args
, index
, cmd
)
1832 Lisp_Object args
, index
, cmd
;
1834 accessible_keymaps_1 (index
, cmd
,
1838 XINT (XCDR (XCAR (args
))));
1841 /* This function cannot GC. */
1843 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1845 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1846 Returns a list of elements of the form (KEYS . MAP), where the sequence
1847 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1848 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1849 An optional argument PREFIX, if non-nil, should be a key sequence;
1850 then the value includes only maps for prefixes that start with PREFIX. */)
1852 Lisp_Object keymap
, prefix
;
1854 Lisp_Object maps
, tail
;
1857 /* no need for gcpro because we don't autoload any keymaps. */
1860 prefixlen
= XINT (Flength (prefix
));
1864 /* If a prefix was specified, start with the keymap (if any) for
1865 that prefix, so we don't waste time considering other prefixes. */
1867 tem
= Flookup_key (keymap
, prefix
, Qt
);
1868 /* Flookup_key may give us nil, or a number,
1869 if the prefix is not defined in this particular map.
1870 It might even give us a list that isn't a keymap. */
1871 tem
= get_keymap (tem
, 0, 0);
1874 /* Convert PREFIX to a vector now, so that later on
1875 we don't have to deal with the possibility of a string. */
1876 if (STRINGP (prefix
))
1881 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1882 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1886 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1887 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1888 c
^= 0200 | meta_modifier
;
1889 ASET (copy
, i_before
, make_number (c
));
1893 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1899 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1900 get_keymap (keymap
, 1, 0)),
1903 /* For each map in the list maps,
1904 look at any other maps it points to,
1905 and stick them at the end if they are not already in the list.
1907 This is a breadth-first traversal, where tail is the queue of
1908 nodes, and maps accumulates a list of all nodes visited. */
1910 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1912 register Lisp_Object thisseq
, thismap
;
1914 /* Does the current sequence end in the meta-prefix-char? */
1917 thisseq
= Fcar (Fcar (tail
));
1918 thismap
= Fcdr (Fcar (tail
));
1919 last
= make_number (XINT (Flength (thisseq
)) - 1);
1920 is_metized
= (XINT (last
) >= 0
1921 /* Don't metize the last char of PREFIX. */
1922 && XINT (last
) >= prefixlen
1923 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1925 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1929 elt
= XCAR (thismap
);
1933 if (CHAR_TABLE_P (elt
))
1935 Lisp_Object indices
[3];
1937 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
1938 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1939 Fcons (tail
, thisseq
)),
1942 else if (VECTORP (elt
))
1946 /* Vector keymap. Scan all the elements. */
1947 for (i
= 0; i
< ASIZE (elt
); i
++)
1948 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1949 maps
, tail
, thisseq
, is_metized
);
1952 else if (CONSP (elt
))
1953 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1954 maps
, tail
, thisseq
,
1955 is_metized
&& INTEGERP (XCAR (elt
)));
1963 Lisp_Object Qsingle_key_description
, Qkey_description
;
1965 /* This function cannot GC. */
1967 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
1968 doc
: /* Return a pretty description of key-sequence KEYS.
1969 Optional arg PREFIX is the sequence of keys leading up to KEYS.
1970 Control characters turn into "C-foo" sequences, meta into "M-foo",
1971 spaces are put between sequence elements, etc. */)
1973 Lisp_Object keys
, prefix
;
1978 int size
= XINT (Flength (keys
));
1980 Lisp_Object sep
= build_string (" ");
1985 size
+= XINT (Flength (prefix
));
1987 /* This has one extra element at the end that we don't pass to Fconcat. */
1988 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
1990 /* In effect, this computes
1991 (mapconcat 'single-key-description keys " ")
1992 but we shouldn't use mapconcat because it can do GC. */
1996 list
= prefix
, prefix
= Qnil
;
1997 else if (!NILP (keys
))
1998 list
= keys
, keys
= Qnil
;
2003 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2007 return empty_string
;
2008 return Fconcat (len
- 1, args
);
2012 size
= SCHARS (list
);
2013 else if (VECTORP (list
))
2014 size
= XVECTOR (list
)->size
;
2015 else if (CONSP (list
))
2016 size
= XINT (Flength (list
));
2018 wrong_type_argument (Qarrayp
, list
);
2027 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2028 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2029 c
^= 0200 | meta_modifier
;
2030 XSETFASTINT (key
, c
);
2032 else if (VECTORP (list
))
2034 key
= AREF (list
, i
++);
2046 || EQ (key
, meta_prefix_char
)
2047 || (XINT (key
) & meta_modifier
))
2049 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2051 if (EQ (key
, meta_prefix_char
))
2055 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2058 else if (EQ (key
, meta_prefix_char
))
2063 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2071 push_key_description (c
, p
, force_multibyte
)
2072 register unsigned int c
;
2074 int force_multibyte
;
2078 /* Clear all the meaningless bits above the meta bit. */
2079 c
&= meta_modifier
| ~ - meta_modifier
;
2080 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2081 | meta_modifier
| shift_modifier
| super_modifier
);
2083 if (c
& alt_modifier
)
2089 if ((c
& ctrl_modifier
) != 0
2090 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2094 c
&= ~ctrl_modifier
;
2096 if (c
& hyper_modifier
)
2100 c
-= hyper_modifier
;
2102 if (c
& meta_modifier
)
2108 if (c
& shift_modifier
)
2112 c
-= shift_modifier
;
2114 if (c
& super_modifier
)
2118 c
-= super_modifier
;
2134 else if (c
== Ctl ('M'))
2142 /* `C-' already added above. */
2143 if (c
> 0 && c
<= Ctl ('Z'))
2162 || (NILP (current_buffer
->enable_multibyte_characters
)
2163 && SINGLE_BYTE_CHAR_P (c
)
2164 && !force_multibyte
))
2170 int valid_p
= SINGLE_BYTE_CHAR_P (c
) || char_valid_p (c
, 0);
2172 if (force_multibyte
&& valid_p
)
2174 if (SINGLE_BYTE_CHAR_P (c
))
2175 c
= unibyte_char_to_multibyte (c
);
2176 p
+= CHAR_STRING (c
, p
);
2178 else if (NILP (current_buffer
->enable_multibyte_characters
)
2183 /* The biggest character code uses 19 bits. */
2184 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2186 if (c
>= (1 << bit_offset
))
2187 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2191 p
+= CHAR_STRING (c
, p
);
2197 /* This function cannot GC. */
2199 DEFUN ("single-key-description", Fsingle_key_description
,
2200 Ssingle_key_description
, 1, 2, 0,
2201 doc
: /* Return a pretty description of command character KEY.
2202 Control characters turn into C-whatever, etc.
2203 Optional argument NO-ANGLES non-nil means don't put angle brackets
2204 around function keys and event symbols. */)
2206 Lisp_Object key
, no_angles
;
2208 if (CONSP (key
) && lucid_event_type_list_p (key
))
2209 key
= Fevent_convert_list (key
);
2211 key
= EVENT_HEAD (key
);
2213 if (INTEGERP (key
)) /* Normal character */
2215 unsigned int charset
, c1
, c2
;
2216 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2218 if (SINGLE_BYTE_CHAR_P (without_bits
))
2221 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2224 && CHARSET_DEFINED_P (charset
)
2225 && ((c1
>= 0 && c1
< 32)
2226 || (c2
>= 0 && c2
< 32)))
2228 /* Handle a generic character. */
2230 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
2231 CHECK_STRING (name
);
2232 return concat2 (build_string ("Character set "), name
);
2236 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2240 end
= push_key_description (XUINT (key
), tem
, 1);
2242 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2243 if (nchars
== nbytes
)
2246 string
= build_string (tem
);
2249 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2253 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2255 if (NILP (no_angles
))
2258 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2259 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2260 return build_string (buffer
);
2263 return Fsymbol_name (key
);
2265 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2266 return Fcopy_sequence (key
);
2268 error ("KEY must be an integer, cons, symbol, or string");
2273 push_text_char_description (c
, p
)
2274 register unsigned int c
;
2286 *p
++ = c
+ 64; /* 'A' - 1 */
2298 /* This function cannot GC. */
2300 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2301 doc
: /* Return a pretty description of file-character CHARACTER.
2302 Control characters turn into "^char", etc. This differs from
2303 `single-key-description' which turns them into "C-char".
2304 Also, this function recognizes the 2**7 bit as the Meta character,
2305 whereas `single-key-description' uses the 2**27 bit for Meta.
2306 See Info node `(elisp)Describing Characters' for examples. */)
2308 Lisp_Object character
;
2310 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2311 unsigned char str
[6];
2314 CHECK_NUMBER (character
);
2316 c
= XINT (character
);
2317 if (!SINGLE_BYTE_CHAR_P (c
))
2319 int len
= CHAR_STRING (c
, str
);
2321 return make_multibyte_string (str
, 1, len
);
2324 *push_text_char_description (c
& 0377, str
) = 0;
2326 return build_string (str
);
2329 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2332 ascii_sequence_p (seq
)
2336 int len
= XINT (Flength (seq
));
2338 for (i
= 0; i
< len
; i
++)
2340 Lisp_Object ii
, elt
;
2342 XSETFASTINT (ii
, i
);
2343 elt
= Faref (seq
, ii
);
2346 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2354 /* where-is - finding a command in a set of keymaps. */
2356 static Lisp_Object
where_is_internal ();
2357 static Lisp_Object
where_is_internal_1 ();
2358 static void where_is_internal_2 ();
2360 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2361 Returns the first non-nil binding found in any of those maps. */
2364 shadow_lookup (shadow
, key
, flag
)
2365 Lisp_Object shadow
, key
, flag
;
2367 Lisp_Object tail
, value
;
2369 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2371 value
= Flookup_key (XCAR (tail
), key
, flag
);
2372 if (!NILP (value
) && !NATNUMP (value
))
2378 static Lisp_Object Vmouse_events
;
2380 /* This function can GC if Flookup_key autoloads any keymaps. */
2383 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2384 Lisp_Object definition
, keymaps
;
2385 Lisp_Object firstonly
, noindirect
, no_remap
;
2387 Lisp_Object maps
= Qnil
;
2388 Lisp_Object found
, sequences
;
2389 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2390 /* 1 means ignore all menu bindings entirely. */
2391 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2393 /* If this command is remapped, then it has no key bindings
2395 if (NILP (no_remap
) && SYMBOLP (definition
))
2398 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2403 while (CONSP (found
))
2407 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2408 found
= XCDR (found
);
2411 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2415 for (; !NILP (maps
); maps
= Fcdr (maps
))
2417 /* Key sequence to reach map, and the map that it reaches */
2418 register Lisp_Object
this, map
, tem
;
2420 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2421 [M-CHAR] sequences, check if last character of the sequence
2422 is the meta-prefix char. */
2426 this = Fcar (Fcar (maps
));
2427 map
= Fcdr (Fcar (maps
));
2428 last
= make_number (XINT (Flength (this)) - 1);
2429 last_is_meta
= (XINT (last
) >= 0
2430 && EQ (Faref (this, last
), meta_prefix_char
));
2432 /* if (nomenus && !ascii_sequence_p (this)) */
2433 if (nomenus
&& XINT (last
) >= 0
2434 && SYMBOLP (tem
= Faref (this, make_number (0)))
2435 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2436 /* If no menu entries should be returned, skip over the
2437 keymaps bound to `menu-bar' and `tool-bar' and other
2438 non-ascii prefixes like `C-down-mouse-2'. */
2445 /* Because the code we want to run on each binding is rather
2446 large, we don't want to have two separate loop bodies for
2447 sparse keymap bindings and tables; we want to iterate one
2448 loop body over both keymap and vector bindings.
2450 For this reason, if Fcar (map) is a vector, we don't
2451 advance map to the next element until i indicates that we
2452 have finished off the vector. */
2453 Lisp_Object elt
, key
, binding
;
2461 /* Set key and binding to the current key and binding, and
2462 advance map and i to the next binding. */
2465 Lisp_Object sequence
;
2467 /* In a vector, look at each element. */
2468 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2470 binding
= AREF (elt
, i
);
2471 XSETFASTINT (key
, i
);
2472 sequence
= where_is_internal_1 (binding
, key
, definition
,
2474 last
, nomenus
, last_is_meta
);
2475 if (!NILP (sequence
))
2476 sequences
= Fcons (sequence
, sequences
);
2479 else if (CHAR_TABLE_P (elt
))
2481 Lisp_Object indices
[3];
2484 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2485 Qnil
), /* Result accumulator. */
2486 Fcons (Fcons (this, last
),
2487 Fcons (make_number (nomenus
),
2488 make_number (last_is_meta
))));
2489 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2491 sequences
= XCDR (XCAR (args
));
2493 else if (CONSP (elt
))
2495 Lisp_Object sequence
;
2498 binding
= XCDR (elt
);
2500 sequence
= where_is_internal_1 (binding
, key
, definition
,
2502 last
, nomenus
, last_is_meta
);
2503 if (!NILP (sequence
))
2504 sequences
= Fcons (sequence
, sequences
);
2508 while (!NILP (sequences
))
2510 Lisp_Object sequence
, remapped
, function
;
2512 sequence
= XCAR (sequences
);
2513 sequences
= XCDR (sequences
);
2515 /* If the current sequence is a command remapping with
2516 format [remap COMMAND], find the key sequences
2517 which run COMMAND, and use those sequences instead. */
2520 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2521 && EQ (AREF (sequence
, 0), Qremap
)
2522 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2524 Lisp_Object remapped1
;
2526 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2527 if (CONSP (remapped1
))
2529 /* Verify that this key binding actually maps to the
2530 remapped command (see below). */
2531 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2533 sequence
= XCAR (remapped1
);
2534 remapped
= XCDR (remapped1
);
2535 goto record_sequence
;
2539 /* Verify that this key binding is not shadowed by another
2540 binding for the same key, before we say it exists.
2542 Mechanism: look for local definition of this key and if
2543 it is defined and does not match what we found then
2546 Either nil or number as value from Flookup_key
2548 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2552 /* It is a true unshadowed match. Record it, unless it's already
2553 been seen (as could happen when inheriting keymaps). */
2554 if (NILP (Fmember (sequence
, found
)))
2555 found
= Fcons (sequence
, found
);
2557 /* If firstonly is Qnon_ascii, then we can return the first
2558 binding we find. If firstonly is not Qnon_ascii but not
2559 nil, then we should return the first ascii-only binding
2561 if (EQ (firstonly
, Qnon_ascii
))
2562 RETURN_UNGCPRO (sequence
);
2563 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2564 RETURN_UNGCPRO (sequence
);
2566 if (CONSP (remapped
))
2568 sequence
= XCAR (remapped
);
2569 remapped
= XCDR (remapped
);
2570 goto record_sequence
;
2578 found
= Fnreverse (found
);
2580 /* firstonly may have been t, but we may have gone all the way through
2581 the keymaps without finding an all-ASCII key sequence. So just
2582 return the best we could find. */
2583 if (!NILP (firstonly
))
2584 return Fcar (found
);
2589 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2590 doc
: /* Return list of keys that invoke DEFINITION.
2591 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2592 If KEYMAP is nil, search all the currently active keymaps.
2593 If KEYMAP is a list of keymaps, search only those keymaps.
2595 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2596 rather than a list of all possible key sequences.
2597 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2598 no matter what it is.
2599 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2600 \(or their meta variants) and entirely reject menu bindings.
2602 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2603 to other keymaps or slots. This makes it possible to search for an
2604 indirect definition itself.
2606 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2607 that invoke a command which is remapped to DEFINITION, but include the
2608 remapped command in the returned list. */)
2609 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2610 Lisp_Object definition
, keymap
;
2611 Lisp_Object firstonly
, noindirect
, no_remap
;
2613 Lisp_Object sequences
, keymaps
;
2614 /* 1 means ignore all menu bindings entirely. */
2615 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2618 /* Find the relevant keymaps. */
2619 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2621 else if (!NILP (keymap
))
2622 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2624 keymaps
= Fcurrent_active_maps (Qnil
);
2626 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2627 We don't really need to check `keymap'. */
2628 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2632 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2634 /* Check heuristic-consistency of the cache. */
2635 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2636 where_is_cache
= Qnil
;
2638 if (NILP (where_is_cache
))
2640 /* We need to create the cache. */
2641 Lisp_Object args
[2];
2642 where_is_cache
= Fmake_hash_table (0, args
);
2643 where_is_cache_keymaps
= Qt
;
2645 /* Fill in the cache. */
2646 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2647 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2650 where_is_cache_keymaps
= keymaps
;
2653 /* We want to process definitions from the last to the first.
2654 Instead of consing, copy definitions to a vector and step
2655 over that vector. */
2656 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2657 n
= XINT (Flength (sequences
));
2658 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2659 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2660 defns
[i
++] = XCAR (sequences
);
2662 /* Verify that the key bindings are not shadowed. Note that
2663 the following can GC. */
2664 GCPRO2 (definition
, keymaps
);
2667 for (i
= n
- 1; i
>= 0; --i
)
2668 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2670 if (ascii_sequence_p (defns
[i
]))
2676 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2681 /* Kill the cache so that where_is_internal_1 doesn't think
2682 we're filling it up. */
2683 where_is_cache
= Qnil
;
2684 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2690 /* This is the function that Fwhere_is_internal calls using map_char_table.
2692 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2694 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2695 Since map_char_table doesn't really use the return value from this function,
2696 we the result append to RESULT, the slot in ARGS.
2698 This function can GC because it calls where_is_internal_1 which can
2702 where_is_internal_2 (args
, key
, binding
)
2703 Lisp_Object args
, key
, binding
;
2705 Lisp_Object definition
, noindirect
, this, last
;
2706 Lisp_Object result
, sequence
;
2707 int nomenus
, last_is_meta
;
2708 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2710 GCPRO3 (args
, key
, binding
);
2711 result
= XCDR (XCAR (args
));
2712 definition
= XCAR (XCAR (XCAR (args
)));
2713 noindirect
= XCDR (XCAR (XCAR (args
)));
2714 this = XCAR (XCAR (XCDR (args
)));
2715 last
= XCDR (XCAR (XCDR (args
)));
2716 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2717 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2719 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2720 this, last
, nomenus
, last_is_meta
);
2722 if (!NILP (sequence
))
2723 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2729 /* This function cannot GC. */
2732 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2733 nomenus
, last_is_meta
)
2734 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2735 int nomenus
, last_is_meta
;
2737 Lisp_Object sequence
;
2739 /* Search through indirections unless that's not wanted. */
2740 if (NILP (noindirect
))
2741 binding
= get_keyelt (binding
, 0);
2743 /* End this iteration if this element does not match
2746 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2747 || EQ (binding
, definition
)
2748 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2749 /* Doesn't match. */
2752 /* We have found a match. Construct the key sequence where we found it. */
2753 if (INTEGERP (key
) && last_is_meta
)
2755 sequence
= Fcopy_sequence (this);
2756 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2759 sequence
= append_key (this, key
);
2761 if (!NILP (where_is_cache
))
2763 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2764 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2771 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2773 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2774 doc
: /* Insert the list of all defined keys and their definitions.
2775 The list is inserted in the current buffer, while the bindings are
2776 looked up in BUFFER.
2777 The optional argument PREFIX, if non-nil, should be a key sequence;
2778 then we display only bindings that start with that prefix.
2779 The optional argument MENUS, if non-nil, says to mention menu bindings.
2780 \(Ordinarily these are omitted from the output.) */)
2781 (buffer
, prefix
, menus
)
2782 Lisp_Object buffer
, prefix
, menus
;
2784 Lisp_Object outbuf
, shadow
;
2785 int nomenu
= NILP (menus
);
2786 register Lisp_Object start1
;
2787 struct gcpro gcpro1
;
2789 char *alternate_heading
2791 Keyboard translations:\n\n\
2792 You type Translation\n\
2793 -------- -----------\n";
2798 outbuf
= Fcurrent_buffer ();
2800 /* Report on alternates for keys. */
2801 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2804 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2805 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2807 for (c
= 0; c
< translate_len
; c
++)
2808 if (translate
[c
] != c
)
2810 char buf
[KEY_DESCRIPTION_SIZE
];
2813 if (alternate_heading
)
2815 insert_string (alternate_heading
);
2816 alternate_heading
= 0;
2819 bufend
= push_key_description (translate
[c
], buf
, 1);
2820 insert (buf
, bufend
- buf
);
2821 Findent_to (make_number (16), make_number (1));
2822 bufend
= push_key_description (c
, buf
, 1);
2823 insert (buf
, bufend
- buf
);
2831 if (!NILP (Vkey_translation_map
))
2832 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2833 "Key translations", nomenu
, 1, 0);
2836 /* Print the (major mode) local map. */
2838 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2839 start1
= current_kboard
->Voverriding_terminal_local_map
;
2840 else if (!NILP (Voverriding_local_map
))
2841 start1
= Voverriding_local_map
;
2845 describe_map_tree (start1
, 1, shadow
, prefix
,
2846 "\f\nOverriding Bindings", nomenu
, 0, 0);
2847 shadow
= Fcons (start1
, shadow
);
2851 /* Print the minor mode and major mode keymaps. */
2853 Lisp_Object
*modes
, *maps
;
2855 /* Temporarily switch to `buffer', so that we can get that buffer's
2856 minor modes correctly. */
2857 Fset_buffer (buffer
);
2859 nmaps
= current_minor_maps (&modes
, &maps
);
2860 Fset_buffer (outbuf
);
2862 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2863 XBUFFER (buffer
), Qkeymap
);
2866 describe_map_tree (start1
, 1, shadow
, prefix
,
2867 "\f\n`keymap' Property Bindings", nomenu
, 0, 0);
2868 shadow
= Fcons (start1
, shadow
);
2871 /* Print the minor mode maps. */
2872 for (i
= 0; i
< nmaps
; i
++)
2874 /* The title for a minor mode keymap
2875 is constructed at run time.
2876 We let describe_map_tree do the actual insertion
2877 because it takes care of other features when doing so. */
2880 if (!SYMBOLP (modes
[i
]))
2883 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2887 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2888 SCHARS (SYMBOL_NAME (modes
[i
])));
2889 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2891 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2892 p
+= sizeof (" Minor Mode Bindings") - 1;
2895 describe_map_tree (maps
[i
], 1, shadow
, prefix
, title
, nomenu
, 0, 0);
2896 shadow
= Fcons (maps
[i
], shadow
);
2899 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2900 XBUFFER (buffer
), Qlocal_map
);
2903 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2904 describe_map_tree (start1
, 1, shadow
, prefix
,
2905 "\f\nMajor Mode Bindings", nomenu
, 0, 0);
2907 describe_map_tree (start1
, 1, shadow
, prefix
,
2908 "\f\n`local-map' Property Bindings",
2911 shadow
= Fcons (start1
, shadow
);
2915 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2916 "\f\nGlobal Bindings", nomenu
, 0, 1);
2918 /* Print the function-key-map translations under this prefix. */
2919 if (!NILP (Vfunction_key_map
))
2920 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2921 "\f\nFunction key map translations", nomenu
, 1, 0);
2927 /* Insert a description of the key bindings in STARTMAP,
2928 followed by those of all maps reachable through STARTMAP.
2929 If PARTIAL is nonzero, omit certain "uninteresting" commands
2930 (such as `undefined').
2931 If SHADOW is non-nil, it is a list of maps;
2932 don't mention keys which would be shadowed by any of them.
2933 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2934 TITLE, if not 0, is a string to insert at the beginning.
2935 TITLE should not end with a colon or a newline; we supply that.
2936 If NOMENU is not 0, then omit menu-bar commands.
2938 If TRANSL is nonzero, the definitions are actually key translations
2939 so print strings and vectors differently.
2941 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2945 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2947 Lisp_Object startmap
, shadow
, prefix
;
2954 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2955 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2962 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
2965 GCPRO3 (maps
, seen
, sub_shadows
);
2971 /* Delete from MAPS each element that is for the menu bar. */
2972 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
2974 Lisp_Object elt
, prefix
, tem
;
2977 prefix
= Fcar (elt
);
2978 if (XVECTOR (prefix
)->size
>= 1)
2980 tem
= Faref (prefix
, make_number (0));
2981 if (EQ (tem
, Qmenu_bar
))
2982 maps
= Fdelq (elt
, maps
);
2987 if (!NILP (maps
) || always_title
)
2991 insert_string (title
);
2994 insert_string (" Starting With ");
2995 insert1 (Fkey_description (prefix
, Qnil
));
2997 insert_string (":\n");
2999 insert_string (key_heading
);
3003 for (; !NILP (maps
); maps
= Fcdr (maps
))
3005 register Lisp_Object elt
, prefix
, tail
;
3008 prefix
= Fcar (elt
);
3012 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3016 shmap
= XCAR (tail
);
3018 /* If the sequence by which we reach this keymap is zero-length,
3019 then the shadow map for this keymap is just SHADOW. */
3020 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3021 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3023 /* If the sequence by which we reach this keymap actually has
3024 some elements, then the sequence's definition in SHADOW is
3025 what we should use. */
3028 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3029 if (INTEGERP (shmap
))
3033 /* If shmap is not nil and not a keymap,
3034 it completely shadows this map, so don't
3035 describe this map at all. */
3036 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3040 sub_shadows
= Fcons (shmap
, sub_shadows
);
3043 /* Maps we have already listed in this loop shadow this map. */
3044 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3047 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3049 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3052 describe_map (Fcdr (elt
), prefix
,
3053 transl
? describe_translation
: describe_command
,
3054 partial
, sub_shadows
, &seen
, nomenu
);
3060 insert_string ("\n");
3065 static int previous_description_column
;
3068 describe_command (definition
, args
)
3069 Lisp_Object definition
, args
;
3071 register Lisp_Object tem1
;
3072 int column
= (int) current_column (); /* iftc */
3073 int description_column
;
3075 /* If column 16 is no good, go to col 32;
3076 but don't push beyond that--go to next line instead. */
3080 description_column
= 32;
3082 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3083 description_column
= 32;
3085 description_column
= 16;
3087 Findent_to (make_number (description_column
), make_number (1));
3088 previous_description_column
= description_column
;
3090 if (SYMBOLP (definition
))
3092 tem1
= SYMBOL_NAME (definition
);
3094 insert_string ("\n");
3096 else if (STRINGP (definition
) || VECTORP (definition
))
3097 insert_string ("Keyboard Macro\n");
3098 else if (KEYMAPP (definition
))
3099 insert_string ("Prefix Command\n");
3101 insert_string ("??\n");
3105 describe_translation (definition
, args
)
3106 Lisp_Object definition
, args
;
3108 register Lisp_Object tem1
;
3110 Findent_to (make_number (16), make_number (1));
3112 if (SYMBOLP (definition
))
3114 tem1
= SYMBOL_NAME (definition
);
3116 insert_string ("\n");
3118 else if (STRINGP (definition
) || VECTORP (definition
))
3120 insert1 (Fkey_description (definition
, Qnil
));
3121 insert_string ("\n");
3123 else if (KEYMAPP (definition
))
3124 insert_string ("Prefix Command\n");
3126 insert_string ("??\n");
3129 /* Describe the contents of map MAP, assuming that this map itself is
3130 reached by the sequence of prefix keys PREFIX (a string or vector).
3131 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3134 describe_map (map
, prefix
, elt_describer
, partial
, shadow
, seen
, nomenu
)
3135 register Lisp_Object map
;
3137 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3143 Lisp_Object tail
, definition
, event
;
3145 Lisp_Object suppress
;
3148 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3153 suppress
= intern ("suppress-keymap");
3155 /* This vector gets used to present single keys to Flookup_key. Since
3156 that is done once per keymap element, we don't want to cons up a
3157 fresh vector every time. */
3158 kludge
= Fmake_vector (make_number (1), Qnil
);
3161 GCPRO3 (prefix
, definition
, kludge
);
3163 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3167 if (VECTORP (XCAR (tail
))
3168 || CHAR_TABLE_P (XCAR (tail
)))
3169 describe_vector (XCAR (tail
),
3170 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3172 else if (CONSP (XCAR (tail
)))
3174 event
= XCAR (XCAR (tail
));
3176 /* Ignore bindings whose "prefix" are not really valid events.
3177 (We get these in the frames and buffers menu.) */
3178 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3181 if (nomenu
&& EQ (event
, Qmenu_bar
))
3184 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3186 /* Don't show undefined commands or suppressed commands. */
3187 if (NILP (definition
)) continue;
3188 if (SYMBOLP (definition
) && partial
)
3190 tem
= Fget (definition
, suppress
);
3195 /* Don't show a command that isn't really visible
3196 because a local definition of the same key shadows it. */
3198 ASET (kludge
, 0, event
);
3201 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3202 if (!NILP (tem
)) continue;
3205 tem
= Flookup_key (map
, kludge
, Qt
);
3206 if (!EQ (tem
, definition
)) continue;
3210 previous_description_column
= 0;
3215 /* THIS gets the string to describe the character EVENT. */
3216 insert1 (Fkey_description (kludge
, prefix
));
3218 /* Print a description of the definition of this character.
3219 elt_describer will take care of spacing out far enough
3220 for alignment purposes. */
3221 (*elt_describer
) (definition
, Qnil
);
3223 else if (EQ (XCAR (tail
), Qkeymap
))
3225 /* The same keymap might be in the structure twice, if we're
3226 using an inherited keymap. So skip anything we've already
3228 tem
= Fassq (tail
, *seen
);
3229 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3231 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3239 describe_vector_princ (elt
, fun
)
3240 Lisp_Object elt
, fun
;
3242 Findent_to (make_number (16), make_number (1));
3247 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3248 doc
: /* Insert a description of contents of VECTOR.
3249 This is text showing the elements of vector matched against indices.
3250 DESCRIBER is the output function used; nil means use `princ'. */)
3252 Lisp_Object vector
, describer
;
3254 int count
= SPECPDL_INDEX ();
3255 if (NILP (describer
))
3256 describer
= intern ("princ");
3257 specbind (Qstandard_output
, Fcurrent_buffer ());
3258 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3259 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3260 Qnil
, Qnil
, (int *)0, 0, 0);
3262 return unbind_to (count
, Qnil
);
3265 /* Insert in the current buffer a description of the contents of VECTOR.
3266 We call ELT_DESCRIBER to insert the description of one value found
3269 ELT_PREFIX describes what "comes before" the keys or indices defined
3270 by this vector. This is a human-readable string whose size
3271 is not necessarily related to the situation.
3273 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3274 leads to this keymap.
3276 If the vector is a chartable, ELT_PREFIX is the vector
3277 of bytes that lead to the character set or portion of a character
3278 set described by this chartable.
3280 If PARTIAL is nonzero, it means do not mention suppressed commands
3281 (that assumes the vector is in a keymap).
3283 SHADOW is a list of keymaps that shadow this map.
3284 If it is non-nil, then we look up the key in those maps
3285 and we don't mention it now if it is defined by any of them.
3287 ENTIRE_MAP is the keymap in which this vector appears.
3288 If the definition in effect in the whole map does not match
3289 the one in this vector, we ignore this one.
3291 When describing a sub-char-table, INDICES is a list of
3292 indices at higher levels in this char-table,
3293 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3295 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3297 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3300 describe_vector (vector
, prefix
, args
, elt_describer
,
3301 partial
, shadow
, entire_map
,
3302 indices
, char_table_depth
, keymap_p
)
3303 register Lisp_Object vector
;
3304 Lisp_Object prefix
, args
;
3305 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3308 Lisp_Object entire_map
;
3310 int char_table_depth
;
3313 Lisp_Object definition
;
3315 Lisp_Object elt_prefix
= Qnil
;
3317 Lisp_Object suppress
;
3320 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3321 /* Range of elements to be handled. */
3323 /* A flag to tell if a leaf in this level of char-table is not a
3324 generic character (i.e. a complete multibyte character). */
3332 indices
= (int *) alloca (3 * sizeof (int));
3338 /* Call Fkey_description first, to avoid GC bug for the other string. */
3339 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3342 tem
= Fkey_description (prefix
, Qnil
);
3343 elt_prefix
= concat2 (tem
, build_string (" "));
3348 /* This vector gets used to present single keys to Flookup_key. Since
3349 that is done once per vector element, we don't want to cons up a
3350 fresh vector every time. */
3351 kludge
= Fmake_vector (make_number (1), Qnil
);
3352 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3355 suppress
= intern ("suppress-keymap");
3357 if (CHAR_TABLE_P (vector
))
3359 if (char_table_depth
== 0)
3361 /* VECTOR is a top level char-table. */
3364 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3368 /* VECTOR is a sub char-table. */
3369 if (char_table_depth
>= 3)
3370 /* A char-table is never that deep. */
3371 error ("Too deep char table");
3374 = (CHARSET_VALID_P (indices
[0])
3375 && ((CHARSET_DIMENSION (indices
[0]) == 1
3376 && char_table_depth
== 1)
3377 || char_table_depth
== 2));
3379 /* Meaningful elements are from 32th to 127th. */
3381 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3386 /* This does the right thing for ordinary vectors. */
3390 to
= XVECTOR (vector
)->size
;
3393 for (i
= from
; i
< to
; i
++)
3397 if (CHAR_TABLE_P (vector
))
3399 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3402 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3403 && !CHARSET_DEFINED_P (i
- 128))
3407 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3410 definition
= get_keyelt (AREF (vector
, i
), 0);
3412 if (NILP (definition
)) continue;
3414 /* Don't mention suppressed commands. */
3415 if (SYMBOLP (definition
) && partial
)
3419 tem
= Fget (definition
, suppress
);
3421 if (!NILP (tem
)) continue;
3424 /* Set CHARACTER to the character this entry describes, if any.
3425 Also update *INDICES. */
3426 if (CHAR_TABLE_P (vector
))
3428 indices
[char_table_depth
] = i
;
3430 if (char_table_depth
== 0)
3433 indices
[0] = i
- 128;
3435 else if (complete_char
)
3437 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3445 ASET (kludge
, 0, make_number (character
));
3447 /* If this binding is shadowed by some other map, ignore it. */
3448 if (!NILP (shadow
) && complete_char
)
3452 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3454 if (!NILP (tem
)) continue;
3457 /* Ignore this definition if it is shadowed by an earlier
3458 one in the same keymap. */
3459 if (!NILP (entire_map
) && complete_char
)
3463 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3465 if (!EQ (tem
, definition
))
3471 if (char_table_depth
== 0)
3476 /* For a sub char-table, show the depth by indentation.
3477 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3478 if (char_table_depth
> 0)
3479 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3481 /* Output the prefix that applies to every entry in this map. */
3482 if (!NILP (elt_prefix
))
3483 insert1 (elt_prefix
);
3485 /* Insert or describe the character this slot is for,
3486 or a description of what it is for. */
3487 if (SUB_CHAR_TABLE_P (vector
))
3490 insert_char (character
);
3493 /* We need an octal representation for this block of
3496 sprintf (work
, "(row %d)", i
);
3497 insert (work
, strlen (work
));
3500 else if (CHAR_TABLE_P (vector
))
3503 insert1 (Fkey_description (kludge
, prefix
));
3506 /* Print the information for this character set. */
3507 insert_string ("<");
3508 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3510 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3519 insert1 (Fkey_description (kludge
, prefix
));
3522 /* If we find a sub char-table within a char-table,
3523 scan it recursively; it defines the details for
3524 a character set or a portion of a character set. */
3525 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3528 describe_vector (definition
, prefix
, args
, elt_describer
,
3529 partial
, shadow
, entire_map
,
3530 indices
, char_table_depth
+ 1, keymap_p
);
3536 /* Find all consecutive characters or rows that have the same
3537 definition. But, for elements of a top level char table, if
3538 they are for charsets, we had better describe one by one even
3539 if they have the same definition. */
3540 if (CHAR_TABLE_P (vector
))
3544 if (char_table_depth
== 0)
3545 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3547 while (i
+ 1 < limit
3548 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3550 && !NILP (Fequal (tem2
, definition
)))
3555 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3557 && !NILP (Fequal (tem2
, definition
)))
3561 /* If we have a range of more than one character,
3562 print where the range reaches to. */
3564 if (i
!= starting_i
)
3568 ASET (kludge
, 0, make_number (i
));
3570 if (!NILP (elt_prefix
))
3571 insert1 (elt_prefix
);
3573 if (CHAR_TABLE_P (vector
))
3575 if (char_table_depth
== 0)
3577 insert1 (Fkey_description (kludge
, prefix
));
3579 else if (complete_char
)
3581 indices
[char_table_depth
] = i
;
3582 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3583 insert_char (character
);
3587 /* We need an octal representation for this block of
3590 sprintf (work
, "(row %d)", i
);
3591 insert (work
, strlen (work
));
3596 insert1 (Fkey_description (kludge
, prefix
));
3600 /* Print a description of the definition of this character.
3601 elt_describer will take care of spacing out far enough
3602 for alignment purposes. */
3603 (*elt_describer
) (definition
, args
);
3606 /* For (sub) char-table, print `defalt' slot at last. */
3607 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3609 insert (" ", char_table_depth
* 2);
3610 insert_string ("<<default>>");
3611 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3617 /* Apropos - finding all symbols whose names match a regexp. */
3618 static Lisp_Object apropos_predicate
;
3619 static Lisp_Object apropos_accumulate
;
3622 apropos_accum (symbol
, string
)
3623 Lisp_Object symbol
, string
;
3625 register Lisp_Object tem
;
3627 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3628 if (!NILP (tem
) && !NILP (apropos_predicate
))
3629 tem
= call1 (apropos_predicate
, symbol
);
3631 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3634 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3635 doc
: /* Show all symbols whose names contain match for REGEXP.
3636 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3637 for each symbol and a symbol is mentioned only if that returns non-nil.
3638 Return list of symbols found. */)
3640 Lisp_Object regexp
, predicate
;
3643 CHECK_STRING (regexp
);
3644 apropos_predicate
= predicate
;
3645 apropos_accumulate
= Qnil
;
3646 map_obarray (Vobarray
, apropos_accum
, regexp
);
3647 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3648 apropos_accumulate
= Qnil
;
3649 apropos_predicate
= Qnil
;
3656 Qkeymap
= intern ("keymap");
3657 staticpro (&Qkeymap
);
3658 staticpro (&apropos_predicate
);
3659 staticpro (&apropos_accumulate
);
3660 apropos_predicate
= Qnil
;
3661 apropos_accumulate
= Qnil
;
3663 /* Now we are ready to set up this property, so we can
3664 create char tables. */
3665 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3667 /* Initialize the keymaps standardly used.
3668 Each one is the value of a Lisp variable, and is also
3669 pointed to by a C variable */
3671 global_map
= Fmake_keymap (Qnil
);
3672 Fset (intern ("global-map"), global_map
);
3674 current_global_map
= global_map
;
3675 staticpro (&global_map
);
3676 staticpro (¤t_global_map
);
3678 meta_map
= Fmake_keymap (Qnil
);
3679 Fset (intern ("esc-map"), meta_map
);
3680 Ffset (intern ("ESC-prefix"), meta_map
);
3682 control_x_map
= Fmake_keymap (Qnil
);
3683 Fset (intern ("ctl-x-map"), control_x_map
);
3684 Ffset (intern ("Control-X-prefix"), control_x_map
);
3687 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3688 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3689 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3690 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3691 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3693 staticpro (&exclude_keys
);
3695 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3696 doc
: /* List of commands given new key bindings recently.
3697 This is used for internal purposes during Emacs startup;
3698 don't alter it yourself. */);
3699 Vdefine_key_rebound_commands
= Qt
;
3701 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3702 doc
: /* Default keymap to use when reading from the minibuffer. */);
3703 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3705 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3706 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3707 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3708 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3710 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3711 doc
: /* Local keymap for minibuffer input with completion. */);
3712 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3713 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3715 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3716 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3717 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3718 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3719 Vminibuffer_local_completion_map
);
3721 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3722 doc
: /* Alist of keymaps to use for minor modes.
3723 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3724 key sequences and look up bindings iff VARIABLE's value is non-nil.
3725 If two active keymaps bind the same key, the keymap appearing earlier
3726 in the list takes precedence. */);
3727 Vminor_mode_map_alist
= Qnil
;
3729 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3730 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3731 This variable is an alist just like `minor-mode-map-alist', and it is
3732 used the same way (and before `minor-mode-map-alist'); however,
3733 it is provided for major modes to bind locally. */);
3734 Vminor_mode_overriding_map_alist
= Qnil
;
3736 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3737 doc
: /* List of keymap alists to use for emulations modes.
3738 It is intended for modes or packages using multiple minor-mode keymaps.
3739 Each element is a keymap alist just like `minor-mode-map-alist', or a
3740 symbol with a variable binding which is a keymap alist, and it is used
3741 the same way. The "active" keymaps in each alist are used before
3742 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3743 Vemulation_mode_map_alists
= Qnil
;
3746 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3747 doc
: /* Keymap mapping ASCII function key sequences onto their preferred forms.
3748 This allows Emacs to recognize function keys sent from ASCII
3749 terminals at any point in a key sequence.
3751 The `read-key-sequence' function replaces any subsequence bound by
3752 `function-key-map' with its binding. More precisely, when the active
3753 keymaps have no binding for the current key sequence but
3754 `function-key-map' binds a suffix of the sequence to a vector or string,
3755 `read-key-sequence' replaces the matching suffix with its binding, and
3756 continues with the new sequence.
3758 The events that come from bindings in `function-key-map' are not
3759 themselves looked up in `function-key-map'.
3761 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3762 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3763 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3764 key, typing `ESC O P x' would return [f1 x]. */);
3765 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3767 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3768 doc
: /* Keymap of key translations that can override keymaps.
3769 This keymap works like `function-key-map', but comes after that,
3770 and its non-prefix bindings override ordinary bindings. */);
3771 Vkey_translation_map
= Qnil
;
3773 staticpro (&Vmouse_events
);
3774 Vmouse_events
= Fcons (intern ("menu-bar"),
3775 Fcons (intern ("tool-bar"),
3776 Fcons (intern ("header-line"),
3777 Fcons (intern ("mode-line"),
3778 Fcons (intern ("mouse-1"),
3779 Fcons (intern ("mouse-2"),
3780 Fcons (intern ("mouse-3"),
3781 Fcons (intern ("mouse-4"),
3782 Fcons (intern ("mouse-5"),
3786 Qsingle_key_description
= intern ("single-key-description");
3787 staticpro (&Qsingle_key_description
);
3789 Qkey_description
= intern ("key-description");
3790 staticpro (&Qkey_description
);
3792 Qkeymapp
= intern ("keymapp");
3793 staticpro (&Qkeymapp
);
3795 Qnon_ascii
= intern ("non-ascii");
3796 staticpro (&Qnon_ascii
);
3798 Qmenu_item
= intern ("menu-item");
3799 staticpro (&Qmenu_item
);
3801 Qremap
= intern ("remap");
3802 staticpro (&Qremap
);
3804 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3805 staticpro (&command_remapping_vector
);
3807 where_is_cache_keymaps
= Qt
;
3808 where_is_cache
= Qnil
;
3809 staticpro (&where_is_cache
);
3810 staticpro (&where_is_cache_keymaps
);
3812 defsubr (&Skeymapp
);
3813 defsubr (&Skeymap_parent
);
3814 defsubr (&Skeymap_prompt
);
3815 defsubr (&Sset_keymap_parent
);
3816 defsubr (&Smake_keymap
);
3817 defsubr (&Smake_sparse_keymap
);
3818 defsubr (&Smap_keymap
);
3819 defsubr (&Scopy_keymap
);
3820 defsubr (&Scommand_remapping
);
3821 defsubr (&Skey_binding
);
3822 defsubr (&Slocal_key_binding
);
3823 defsubr (&Sglobal_key_binding
);
3824 defsubr (&Sminor_mode_key_binding
);
3825 defsubr (&Sdefine_key
);
3826 defsubr (&Slookup_key
);
3827 defsubr (&Sdefine_prefix_command
);
3828 defsubr (&Suse_global_map
);
3829 defsubr (&Suse_local_map
);
3830 defsubr (&Scurrent_local_map
);
3831 defsubr (&Scurrent_global_map
);
3832 defsubr (&Scurrent_minor_mode_maps
);
3833 defsubr (&Scurrent_active_maps
);
3834 defsubr (&Saccessible_keymaps
);
3835 defsubr (&Skey_description
);
3836 defsubr (&Sdescribe_vector
);
3837 defsubr (&Ssingle_key_description
);
3838 defsubr (&Stext_char_description
);
3839 defsubr (&Swhere_is_internal
);
3840 defsubr (&Sdescribe_buffer_bindings
);
3841 defsubr (&Sapropos_internal
);
3847 initial_define_key (global_map
, 033, "ESC-prefix");
3848 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
3851 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
3852 (do not change this comment) */