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 /* A strange value in which Meta is set would cause
532 infinite recursion. Protect against that. */
533 if (meta_prefix_char
& CHAR_META
)
534 meta_prefix_char
= make_number (27);
535 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
536 t_ok
, noinherit
, autoload
),
539 if (CONSP (meta_map
))
542 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
545 /* Set IDX to t, so that we only find a default binding. */
548 /* We know there is no binding. */
552 /* t_binding is where we put a default binding that applies,
553 to use in case we do not find a binding specifically
554 for this key sequence. */
557 Lisp_Object t_binding
= Qnil
;
558 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
560 GCPRO4 (map
, tail
, idx
, t_binding
);
562 /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
563 If it is 1, only generic-char bindings are accepted.
564 Otherwise, neither are. */
567 for (tail
= XCDR (map
);
569 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
574 binding
= XCAR (tail
);
575 if (SYMBOLP (binding
))
577 /* If NOINHERIT, stop finding prefix definitions
578 after we pass a second occurrence of the `keymap' symbol. */
579 if (noinherit
&& EQ (binding
, Qkeymap
))
580 RETURN_UNGCPRO (Qnil
);
582 else if (CONSP (binding
))
584 Lisp_Object key
= XCAR (binding
);
587 val
= XCDR (binding
);
590 && (XINT (idx
) & CHAR_MODIFIER_MASK
) == 0
592 && (XINT (key
) & CHAR_MODIFIER_MASK
) == 0
593 && !SINGLE_BYTE_CHAR_P (XINT (idx
))
594 && !SINGLE_BYTE_CHAR_P (XINT (key
))
595 && CHAR_VALID_P (XINT (key
), 1)
596 && !CHAR_VALID_P (XINT (key
), 0)
597 && (CHAR_CHARSET (XINT (key
))
598 == CHAR_CHARSET (XINT (idx
))))
600 /* KEY is the generic character of the charset of IDX.
601 Use KEY's binding if there isn't a binding for IDX
603 t_binding
= XCDR (binding
);
606 else if (t_ok
> 1 && EQ (key
, Qt
))
608 t_binding
= XCDR (binding
);
612 else if (VECTORP (binding
))
614 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
615 val
= AREF (binding
, XFASTINT (idx
));
617 else if (CHAR_TABLE_P (binding
))
619 /* Character codes with modifiers
620 are not included in a char-table.
621 All character codes without modifiers are included. */
622 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
624 val
= Faref (binding
, idx
);
625 /* `nil' has a special meaning for char-tables, so
626 we use something else to record an explicitly
633 /* If we found a binding, clean it up and return it. */
634 if (!EQ (val
, Qunbound
))
637 /* A Qt binding is just like an explicit nil binding
638 (i.e. it shadows any parent binding but not bindings in
639 keymaps of lower precedence). */
641 val
= get_keyelt (val
, autoload
);
643 fix_submap_inheritance (map
, idx
, val
);
644 RETURN_UNGCPRO (val
);
649 return get_keyelt (t_binding
, autoload
);
654 map_keymap_item (fun
, args
, key
, val
, data
)
655 map_keymap_function_t fun
;
656 Lisp_Object args
, key
, val
;
659 /* We should maybe try to detect bindings shadowed by previous
660 ones and things like that. */
663 (*fun
) (key
, val
, args
, data
);
667 map_keymap_char_table_item (args
, key
, val
)
668 Lisp_Object args
, key
, val
;
672 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
674 map_keymap_item (fun
, XCDR (args
), key
, val
,
675 XSAVE_VALUE (XCAR (args
))->pointer
);
679 /* Call FUN for every binding in MAP.
680 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
681 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
683 map_keymap (map
, fun
, args
, data
, autoload
)
684 map_keymap_function_t fun
;
685 Lisp_Object map
, args
;
689 struct gcpro gcpro1
, gcpro2
, gcpro3
;
692 GCPRO3 (map
, args
, tail
);
693 map
= get_keymap (map
, 1, autoload
);
694 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
695 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
698 Lisp_Object binding
= XCAR (tail
);
701 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
702 else if (VECTORP (binding
))
704 /* Loop over the char values represented in the vector. */
705 int len
= ASIZE (binding
);
707 for (c
= 0; c
< len
; c
++)
709 Lisp_Object character
;
710 XSETFASTINT (character
, c
);
711 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
714 else if (CHAR_TABLE_P (binding
))
716 Lisp_Object indices
[3];
717 map_char_table (map_keymap_char_table_item
, Qnil
, binding
, binding
,
718 Fcons (make_save_value (fun
, 0),
719 Fcons (make_save_value (data
, 0),
728 map_keymap_call (key
, val
, fun
, dummy
)
729 Lisp_Object key
, val
, fun
;
732 call2 (fun
, key
, val
);
735 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
736 doc
: /* Call FUNCTION for every binding in KEYMAP.
737 FUNCTION is called with two arguments: the event and its binding.
738 If KEYMAP has a parent, the parent's bindings are included as well.
739 This works recursively: if the parent has itself a parent, then the
740 grandparent's bindings are also included and so on.
741 usage: (map-keymap FUNCTION KEYMAP) */)
742 (function
, keymap
, sort_first
)
743 Lisp_Object function
, keymap
, sort_first
;
745 if (INTEGERP (function
))
746 /* We have to stop integers early since map_keymap gives them special
748 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
749 if (! NILP (sort_first
))
750 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
752 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
756 /* Given OBJECT which was found in a slot in a keymap,
757 trace indirect definitions to get the actual definition of that slot.
758 An indirect definition is a list of the form
759 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
760 and INDEX is the object to look up in KEYMAP to yield the definition.
762 Also if OBJECT has a menu string as the first element,
763 remove that. Also remove a menu help string as second element.
765 If AUTOLOAD is nonzero, load autoloadable keymaps
766 that are referred to with indirection. */
769 get_keyelt (object
, autoload
)
775 if (!(CONSP (object
)))
776 /* This is really the value. */
779 /* If the keymap contents looks like (keymap ...) or (lambda ...)
781 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
784 /* If the keymap contents looks like (menu-item name . DEFN)
785 or (menu-item name DEFN ...) then use DEFN.
786 This is a new format menu item. */
787 else if (EQ (XCAR (object
), Qmenu_item
))
789 if (CONSP (XCDR (object
)))
793 object
= XCDR (XCDR (object
));
796 object
= XCAR (object
);
798 /* If there's a `:filter FILTER', apply FILTER to the
799 menu-item's definition to get the real definition to
801 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
802 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
805 filter
= XCAR (XCDR (tem
));
806 filter
= list2 (filter
, list2 (Qquote
, object
));
807 object
= menu_item_eval_property (filter
);
812 /* Invalid keymap. */
816 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
817 Keymap alist elements like (CHAR MENUSTRING . DEFN)
818 will be used by HierarKey menus. */
819 else if (STRINGP (XCAR (object
)))
821 object
= XCDR (object
);
822 /* Also remove a menu help string, if any,
823 following the menu item name. */
824 if (CONSP (object
) && STRINGP (XCAR (object
)))
825 object
= XCDR (object
);
826 /* Also remove the sublist that caches key equivalences, if any. */
827 if (CONSP (object
) && CONSP (XCAR (object
)))
830 carcar
= XCAR (XCAR (object
));
831 if (NILP (carcar
) || VECTORP (carcar
))
832 object
= XCDR (object
);
836 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
842 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
844 return (!CONSP (map
) ? object
/* Invalid keymap */
845 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
851 store_in_keymap (keymap
, idx
, def
)
853 register Lisp_Object idx
;
854 register Lisp_Object def
;
856 /* Flush any reverse-map cache. */
857 where_is_cache
= Qnil
;
858 where_is_cache_keymaps
= Qt
;
860 /* If we are preparing to dump, and DEF is a menu element
861 with a menu item indicator, copy it to ensure it is not pure. */
862 if (CONSP (def
) && PURE_P (def
)
863 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
864 def
= Fcons (XCAR (def
), XCDR (def
));
866 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
867 error ("attempt to define a key in a non-keymap");
869 /* If idx is a list (some sort of mouse click, perhaps?),
870 the index we want to use is the car of the list, which
871 ought to be a symbol. */
872 idx
= EVENT_HEAD (idx
);
874 /* If idx is a symbol, it might have modifiers, which need to
875 be put in the canonical order. */
877 idx
= reorder_modifiers (idx
);
878 else if (INTEGERP (idx
))
879 /* Clobber the high bits that can be present on a machine
880 with more than 24 bits of integer. */
881 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
883 /* Scan the keymap for a binding of idx. */
887 /* The cons after which we should insert new bindings. If the
888 keymap has a table element, we record its position here, so new
889 bindings will go after it; this way, the table will stay
890 towards the front of the alist and character lookups in dense
891 keymaps will remain fast. Otherwise, this just points at the
892 front of the keymap. */
893 Lisp_Object insertion_point
;
895 insertion_point
= keymap
;
896 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
903 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
905 ASET (elt
, XFASTINT (idx
), def
);
908 insertion_point
= tail
;
910 else if (CHAR_TABLE_P (elt
))
912 /* Character codes with modifiers
913 are not included in a char-table.
914 All character codes without modifiers are included. */
915 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
918 /* `nil' has a special meaning for char-tables, so
919 we use something else to record an explicitly
921 NILP (def
) ? Qt
: def
);
924 insertion_point
= tail
;
926 else if (CONSP (elt
))
928 if (EQ (idx
, XCAR (elt
)))
934 else if (EQ (elt
, Qkeymap
))
935 /* If we find a 'keymap' symbol in the spine of KEYMAP,
936 then we must have found the start of a second keymap
937 being used as the tail of KEYMAP, and a binding for IDX
938 should be inserted before it. */
945 /* We have scanned the entire keymap, and not found a binding for
946 IDX. Let's add one. */
947 XSETCDR (insertion_point
,
948 Fcons (Fcons (idx
, def
), XCDR (insertion_point
)));
954 EXFUN (Fcopy_keymap
, 1);
957 copy_keymap_item (elt
)
960 Lisp_Object res
, tem
;
967 /* Is this a new format menu item. */
968 if (EQ (XCAR (tem
), Qmenu_item
))
970 /* Copy cell with menu-item marker. */
971 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
975 /* Copy cell with menu-item name. */
976 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
982 /* Copy cell with binding and if the binding is a keymap,
984 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
987 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
988 XSETCAR (elt
, Fcopy_keymap (tem
));
990 if (CONSP (tem
) && CONSP (XCAR (tem
)))
991 /* Delete cache for key equivalences. */
992 XSETCDR (elt
, XCDR (tem
));
997 /* It may be an old fomat menu item.
998 Skip the optional menu string. */
999 if (STRINGP (XCAR (tem
)))
1001 /* Copy the cell, since copy-alist didn't go this deep. */
1002 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1004 /* Also skip the optional menu help string. */
1005 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1007 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1011 /* There may also be a list that caches key equivalences.
1012 Just delete it for the new keymap. */
1014 && CONSP (XCAR (tem
))
1015 && (NILP (XCAR (XCAR (tem
)))
1016 || VECTORP (XCAR (XCAR (tem
)))))
1018 XSETCDR (elt
, XCDR (tem
));
1021 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1022 XSETCDR (elt
, Fcopy_keymap (tem
));
1024 else if (EQ (XCAR (tem
), Qkeymap
))
1025 res
= Fcopy_keymap (elt
);
1031 copy_keymap_1 (chartable
, idx
, elt
)
1032 Lisp_Object chartable
, idx
, elt
;
1034 Faset (chartable
, idx
, copy_keymap_item (elt
));
1037 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1038 doc
: /* Return a copy of the keymap KEYMAP.
1039 The copy starts out with the same definitions of KEYMAP,
1040 but changing either the copy or KEYMAP does not affect the other.
1041 Any key definitions that are subkeymaps are recursively copied.
1042 However, a key definition which is a symbol whose definition is a keymap
1047 register Lisp_Object copy
, tail
;
1048 keymap
= get_keymap (keymap
, 1, 0);
1049 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1050 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1052 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1054 Lisp_Object elt
= XCAR (keymap
);
1055 if (CHAR_TABLE_P (elt
))
1057 Lisp_Object indices
[3];
1058 elt
= Fcopy_sequence (elt
);
1059 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, elt
, 0, indices
);
1061 else if (VECTORP (elt
))
1064 elt
= Fcopy_sequence (elt
);
1065 for (i
= 0; i
< ASIZE (elt
); i
++)
1066 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1068 else if (CONSP (elt
))
1069 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1070 XSETCDR (tail
, Fcons (elt
, Qnil
));
1072 keymap
= XCDR (keymap
);
1074 XSETCDR (tail
, keymap
);
1078 /* Simple Keymap mutators and accessors. */
1080 /* GC is possible in this function if it autoloads a keymap. */
1082 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1083 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1086 KEY is a string or a vector of symbols and characters meaning a
1087 sequence of keystrokes and events. Non-ASCII characters with codes
1088 above 127 (such as ISO Latin-1) can be included if you use a vector.
1089 Using [t] for KEY creates a default definition, which applies to any
1090 event type that has no other definition in this keymap.
1092 DEF is anything that can be a key's definition:
1093 nil (means key is undefined in this keymap),
1094 a command (a Lisp function suitable for interactive calling),
1095 a string (treated as a keyboard macro),
1096 a keymap (to define a prefix key),
1097 a symbol (when the key is looked up, the symbol will stand for its
1098 function definition, which should at that time be one of the above,
1099 or another symbol whose function definition is used, etc.),
1100 a cons (STRING . DEFN), meaning that DEFN is the definition
1101 (DEFN should be a valid definition in its own right),
1102 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1104 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1105 binding is altered. If there is no binding for KEY, the new pair
1106 binding KEY to DEF is added at the front of KEYMAP. */)
1113 register Lisp_Object c
;
1114 register Lisp_Object cmd
;
1118 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1120 GCPRO3 (keymap
, key
, def
);
1121 keymap
= get_keymap (keymap
, 1, 1);
1123 if (!VECTORP (key
) && !STRINGP (key
))
1124 key
= wrong_type_argument (Qarrayp
, key
);
1126 length
= XFASTINT (Flength (key
));
1128 RETURN_UNGCPRO (Qnil
);
1130 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1131 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1133 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1138 c
= Faref (key
, make_number (idx
));
1140 if (CONSP (c
) && lucid_event_type_list_p (c
))
1141 c
= Fevent_convert_list (c
);
1144 silly_event_symbol_error (c
);
1147 && (XINT (c
) & meta_bit
)
1150 c
= meta_prefix_char
;
1156 XSETINT (c
, XINT (c
) & ~meta_bit
);
1162 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1163 error ("Key sequence contains invalid event");
1166 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1168 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1170 /* If this key is undefined, make it a prefix. */
1172 cmd
= define_as_prefix (keymap
, c
);
1174 keymap
= get_keymap (cmd
, 0, 1);
1175 if (!CONSP (keymap
))
1176 /* We must use Fkey_description rather than just passing key to
1177 error; key might be a vector, not a string. */
1178 error ("Key sequence %s uses invalid prefix characters",
1179 SDATA (Fkey_description (key
, Qnil
)));
1183 /* This function may GC (it calls Fkey_binding). */
1185 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1186 doc
: /* Return the remapping for command COMMAND in current keymaps.
1187 Returns nil if COMMAND is not remapped (or not a symbol). */)
1189 Lisp_Object command
;
1191 if (!SYMBOLP (command
))
1194 ASET (command_remapping_vector
, 1, command
);
1195 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1198 /* Value is number if KEY is too long; nil if valid but has no definition. */
1199 /* GC is possible in this function if it autoloads a keymap. */
1201 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1202 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1203 nil means undefined. See doc of `define-key' for kinds of definitions.
1205 A number as value means KEY is "too long";
1206 that is, characters or symbols in it except for the last one
1207 fail to be a valid sequence of prefix characters in KEYMAP.
1208 The number is how many characters at the front of KEY
1209 it takes to reach a non-prefix command.
1211 Normally, `lookup-key' ignores bindings for t, which act as default
1212 bindings, used when nothing else in the keymap applies; this makes it
1213 usable as a general function for probing keymaps. However, if the
1214 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1215 recognize the default bindings, just as `read-key-sequence' does. */)
1216 (keymap
, key
, accept_default
)
1219 Lisp_Object accept_default
;
1222 register Lisp_Object cmd
;
1223 register Lisp_Object c
;
1225 int t_ok
= !NILP (accept_default
);
1226 struct gcpro gcpro1
, gcpro2
;
1228 GCPRO2 (keymap
, key
);
1229 keymap
= get_keymap (keymap
, 1, 1);
1231 if (!VECTORP (key
) && !STRINGP (key
))
1232 key
= wrong_type_argument (Qarrayp
, key
);
1234 length
= XFASTINT (Flength (key
));
1236 RETURN_UNGCPRO (keymap
);
1241 c
= Faref (key
, make_number (idx
++));
1243 if (CONSP (c
) && lucid_event_type_list_p (c
))
1244 c
= Fevent_convert_list (c
);
1246 /* Turn the 8th bit of string chars into a meta modifier. */
1247 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1248 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1250 /* Allow string since binding for `menu-bar-select-buffer'
1251 includes the buffer name in the key sequence. */
1252 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1253 error ("Key sequence contains invalid event");
1255 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1257 RETURN_UNGCPRO (cmd
);
1259 keymap
= get_keymap (cmd
, 0, 1);
1260 if (!CONSP (keymap
))
1261 RETURN_UNGCPRO (make_number (idx
));
1267 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1268 Assume that currently it does not define C at all.
1269 Return the keymap. */
1272 define_as_prefix (keymap
, c
)
1273 Lisp_Object keymap
, c
;
1277 cmd
= Fmake_sparse_keymap (Qnil
);
1278 /* If this key is defined as a prefix in an inherited keymap,
1279 make it a prefix in this map, and make its definition
1280 inherit the other prefix definition. */
1281 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1282 store_in_keymap (keymap
, c
, cmd
);
1287 /* Append a key to the end of a key sequence. We always make a vector. */
1290 append_key (key_sequence
, key
)
1291 Lisp_Object key_sequence
, key
;
1293 Lisp_Object args
[2];
1295 args
[0] = key_sequence
;
1297 args
[1] = Fcons (key
, Qnil
);
1298 return Fvconcat (2, args
);
1301 /* Given a event type C which is a symbol,
1302 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1305 silly_event_symbol_error (c
)
1308 Lisp_Object parsed
, base
, name
, assoc
;
1311 parsed
= parse_modifiers (c
);
1312 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1313 base
= XCAR (parsed
);
1314 name
= Fsymbol_name (base
);
1315 /* This alist includes elements such as ("RET" . "\\r"). */
1316 assoc
= Fassoc (name
, exclude_keys
);
1320 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1322 Lisp_Object keystring
;
1323 if (modifiers
& alt_modifier
)
1324 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1325 if (modifiers
& ctrl_modifier
)
1326 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1327 if (modifiers
& hyper_modifier
)
1328 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1329 if (modifiers
& meta_modifier
)
1330 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1331 if (modifiers
& shift_modifier
)
1332 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1333 if (modifiers
& super_modifier
)
1334 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1337 c
= reorder_modifiers (c
);
1338 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1340 error ((modifiers
& ~meta_modifier
1341 ? "To bind the key %s, use [?%s], not [%s]"
1342 : "To bind the key %s, use \"%s\", not [%s]"),
1343 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1344 SDATA (SYMBOL_NAME (c
)));
1348 /* Global, local, and minor mode keymap stuff. */
1350 /* We can't put these variables inside current_minor_maps, since under
1351 some systems, static gets macro-defined to be the empty string.
1353 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1354 static int cmm_size
= 0;
1356 /* Error handler used in current_minor_maps. */
1358 current_minor_maps_error ()
1363 /* Store a pointer to an array of the keymaps of the currently active
1364 minor modes in *buf, and return the number of maps it contains.
1366 This function always returns a pointer to the same buffer, and may
1367 free or reallocate it, so if you want to keep it for a long time or
1368 hand it out to lisp code, copy it. This procedure will be called
1369 for every key sequence read, so the nice lispy approach (return a
1370 new assoclist, list, what have you) for each invocation would
1371 result in a lot of consing over time.
1373 If we used xrealloc/xmalloc and ran out of memory, they would throw
1374 back to the command loop, which would try to read a key sequence,
1375 which would call this function again, resulting in an infinite
1376 loop. Instead, we'll use realloc/malloc and silently truncate the
1377 list, let the key sequence be read, and hope some other piece of
1378 code signals the error. */
1380 current_minor_maps (modeptr
, mapptr
)
1381 Lisp_Object
**modeptr
, **mapptr
;
1384 int list_number
= 0;
1385 Lisp_Object alist
, assoc
, var
, val
;
1386 Lisp_Object emulation_alists
;
1387 Lisp_Object lists
[2];
1389 emulation_alists
= Vemulation_mode_map_alists
;
1390 lists
[0] = Vminor_mode_overriding_map_alist
;
1391 lists
[1] = Vminor_mode_map_alist
;
1393 for (list_number
= 0; list_number
< 2; list_number
++)
1395 if (CONSP (emulation_alists
))
1397 alist
= XCAR (emulation_alists
);
1398 emulation_alists
= XCDR (emulation_alists
);
1399 if (SYMBOLP (alist
))
1400 alist
= find_symbol_value (alist
);
1404 alist
= lists
[list_number
];
1406 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1407 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1408 && (var
= XCAR (assoc
), SYMBOLP (var
))
1409 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1414 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1415 and also an entry in Vminor_mode_map_alist,
1416 ignore the latter. */
1417 if (list_number
== 1)
1419 val
= assq_no_quit (var
, lists
[0]);
1426 int newsize
, allocsize
;
1427 Lisp_Object
*newmodes
, *newmaps
;
1429 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1430 allocsize
= newsize
* sizeof *newmodes
;
1432 /* Use malloc here. See the comment above this function.
1433 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1435 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1440 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1443 cmm_modes
= newmodes
;
1446 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1451 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1458 if (newmodes
== NULL
|| newmaps
== NULL
)
1463 /* Get the keymap definition--or nil if it is not defined. */
1464 temp
= internal_condition_case_1 (Findirect_function
,
1466 Qerror
, current_minor_maps_error
);
1470 cmm_maps
[i
] = temp
;
1476 if (modeptr
) *modeptr
= cmm_modes
;
1477 if (mapptr
) *mapptr
= cmm_maps
;
1481 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1483 doc
: /* Return a list of the currently active keymaps.
1484 OLP if non-nil indicates that we should obey `overriding-local-map' and
1485 `overriding-terminal-local-map'. */)
1489 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1493 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1494 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1495 /* The doc said that overriding-terminal-local-map should
1496 override overriding-local-map. The code used them both,
1497 but it seems clearer to use just one. rms, jan 2005. */
1498 else if (!NILP (Voverriding_local_map
))
1499 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1501 if (NILP (XCDR (keymaps
)))
1507 /* This usually returns the buffer's local map,
1508 but that can be overridden by a `local-map' property. */
1509 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1511 keymaps
= Fcons (local
, keymaps
);
1513 /* Now put all the minor mode keymaps on the list. */
1514 nmaps
= current_minor_maps (0, &maps
);
1516 for (i
= --nmaps
; i
>= 0; i
--)
1517 if (!NILP (maps
[i
]))
1518 keymaps
= Fcons (maps
[i
], keymaps
);
1520 /* This returns nil unless there is a `keymap' property. */
1521 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1523 keymaps
= Fcons (local
, keymaps
);
1529 /* GC is possible in this function if it autoloads a keymap. */
1531 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1532 doc
: /* Return the binding for command KEY in current keymaps.
1533 KEY is a string or vector, a sequence of keystrokes.
1534 The binding is probably a symbol with a function definition.
1536 Normally, `key-binding' ignores bindings for t, which act as default
1537 bindings, used when nothing else in the keymap applies; this makes it
1538 usable as a general function for probing keymaps. However, if the
1539 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1540 recognize the default bindings, just as `read-key-sequence' does.
1542 Like the normal command loop, `key-binding' will remap the command
1543 resulting from looking up KEY by looking up the command in the
1544 current keymaps. However, if the optional third argument NO-REMAP
1545 is non-nil, `key-binding' returns the unmapped command. */)
1546 (key
, accept_default
, no_remap
)
1547 Lisp_Object key
, accept_default
, no_remap
;
1549 Lisp_Object
*maps
, value
;
1551 struct gcpro gcpro1
;
1555 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1557 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1558 key
, accept_default
);
1559 if (! NILP (value
) && !INTEGERP (value
))
1562 else if (!NILP (Voverriding_local_map
))
1564 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1565 if (! NILP (value
) && !INTEGERP (value
))
1572 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1575 value
= Flookup_key (local
, key
, accept_default
);
1576 if (! NILP (value
) && !INTEGERP (value
))
1580 nmaps
= current_minor_maps (0, &maps
);
1581 /* Note that all these maps are GCPRO'd
1582 in the places where we found them. */
1584 for (i
= 0; i
< nmaps
; i
++)
1585 if (! NILP (maps
[i
]))
1587 value
= Flookup_key (maps
[i
], key
, accept_default
);
1588 if (! NILP (value
) && !INTEGERP (value
))
1592 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1595 value
= Flookup_key (local
, key
, accept_default
);
1596 if (! NILP (value
) && !INTEGERP (value
))
1601 value
= Flookup_key (current_global_map
, key
, accept_default
);
1605 if (NILP (value
) || INTEGERP (value
))
1608 /* If the result of the ordinary keymap lookup is an interactive
1609 command, look for a key binding (ie. remapping) for that command. */
1611 if (NILP (no_remap
) && SYMBOLP (value
))
1614 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1621 /* GC is possible in this function if it autoloads a keymap. */
1623 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1624 doc
: /* Return the binding for command KEYS in current local keymap only.
1625 KEYS is a string or vector, a sequence of keystrokes.
1626 The binding is probably a symbol with a function definition.
1628 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1629 bindings; see the description of `lookup-key' for more details about this. */)
1630 (keys
, accept_default
)
1631 Lisp_Object keys
, accept_default
;
1633 register Lisp_Object map
;
1634 map
= current_buffer
->keymap
;
1637 return Flookup_key (map
, keys
, accept_default
);
1640 /* GC is possible in this function if it autoloads a keymap. */
1642 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1643 doc
: /* Return the binding for command KEYS in current global keymap only.
1644 KEYS is a string or vector, a sequence of keystrokes.
1645 The binding is probably a symbol with a function definition.
1646 This function's return values are the same as those of `lookup-key'
1649 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1650 bindings; see the description of `lookup-key' for more details about this. */)
1651 (keys
, accept_default
)
1652 Lisp_Object keys
, accept_default
;
1654 return Flookup_key (current_global_map
, keys
, accept_default
);
1657 /* GC is possible in this function if it autoloads a keymap. */
1659 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1660 doc
: /* Find the visible minor mode bindings of KEY.
1661 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the
1662 the symbol which names the minor mode binding KEY, and BINDING is
1663 KEY's definition in that mode. In particular, if KEY has no
1664 minor-mode bindings, return nil. If the first binding is a
1665 non-prefix, all subsequent bindings will be omitted, since they would
1666 be ignored. Similarly, the list doesn't include non-prefix bindings
1667 that come after prefix bindings.
1669 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1670 bindings; see the description of `lookup-key' for more details about this. */)
1671 (key
, accept_default
)
1672 Lisp_Object key
, accept_default
;
1674 Lisp_Object
*modes
, *maps
;
1676 Lisp_Object binding
;
1678 struct gcpro gcpro1
, gcpro2
;
1680 nmaps
= current_minor_maps (&modes
, &maps
);
1681 /* Note that all these maps are GCPRO'd
1682 in the places where we found them. */
1685 GCPRO2 (key
, binding
);
1687 for (i
= j
= 0; i
< nmaps
; i
++)
1689 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1690 && !INTEGERP (binding
))
1692 if (KEYMAPP (binding
))
1693 maps
[j
++] = Fcons (modes
[i
], binding
);
1695 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1699 return Flist (j
, maps
);
1702 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1703 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1704 A new sparse keymap is stored as COMMAND's function definition and its value.
1705 If a second optional argument MAPVAR is given, the map is stored as
1706 its value instead of as COMMAND's value; but COMMAND is still defined
1708 The third optional argument NAME, if given, supplies a menu name
1709 string for the map. This is required to use the keymap as a menu.
1710 This function returns COMMAND. */)
1711 (command
, mapvar
, name
)
1712 Lisp_Object command
, mapvar
, name
;
1715 map
= Fmake_sparse_keymap (name
);
1716 Ffset (command
, map
);
1720 Fset (command
, map
);
1724 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1725 doc
: /* Select KEYMAP as the global keymap. */)
1729 keymap
= get_keymap (keymap
, 1, 1);
1730 current_global_map
= keymap
;
1735 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1736 doc
: /* Select KEYMAP as the local keymap.
1737 If KEYMAP is nil, that means no local keymap. */)
1742 keymap
= get_keymap (keymap
, 1, 1);
1744 current_buffer
->keymap
= keymap
;
1749 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1750 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1753 return current_buffer
->keymap
;
1756 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1757 doc
: /* Return the current global keymap. */)
1760 return current_global_map
;
1763 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1764 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1768 int nmaps
= current_minor_maps (0, &maps
);
1770 return Flist (nmaps
, maps
);
1773 /* Help functions for describing and documenting keymaps. */
1777 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1778 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1779 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1783 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1787 /* Look for and break cycles. */
1788 while (!NILP (tem
= Frassq (cmd
, maps
)))
1790 Lisp_Object prefix
= XCAR (tem
);
1791 int lim
= XINT (Flength (XCAR (tem
)));
1792 if (lim
<= XINT (Flength (thisseq
)))
1793 { /* This keymap was already seen with a smaller prefix. */
1795 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1796 Faref (thisseq
, make_number (i
))))
1799 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1802 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1803 but maybe `cmd' occurs again further down in `maps', so keep
1805 maps
= XCDR (Fmemq (tem
, maps
));
1808 /* If the last key in thisseq is meta-prefix-char,
1809 turn it into a meta-ized keystroke. We know
1810 that the event we're about to append is an
1811 ascii keystroke since we're processing a
1815 int meta_bit
= meta_modifier
;
1816 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1817 tem
= Fcopy_sequence (thisseq
);
1819 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1821 /* This new sequence is the same length as
1822 thisseq, so stick it in the list right
1825 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1829 tem
= append_key (thisseq
, key
);
1830 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1835 accessible_keymaps_char_table (args
, index
, cmd
)
1836 Lisp_Object args
, index
, cmd
;
1838 accessible_keymaps_1 (index
, cmd
,
1842 XINT (XCDR (XCAR (args
))));
1845 /* This function cannot GC. */
1847 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1849 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1850 Returns a list of elements of the form (KEYS . MAP), where the sequence
1851 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1852 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1853 An optional argument PREFIX, if non-nil, should be a key sequence;
1854 then the value includes only maps for prefixes that start with PREFIX. */)
1856 Lisp_Object keymap
, prefix
;
1858 Lisp_Object maps
, tail
;
1861 /* no need for gcpro because we don't autoload any keymaps. */
1864 prefixlen
= XINT (Flength (prefix
));
1868 /* If a prefix was specified, start with the keymap (if any) for
1869 that prefix, so we don't waste time considering other prefixes. */
1871 tem
= Flookup_key (keymap
, prefix
, Qt
);
1872 /* Flookup_key may give us nil, or a number,
1873 if the prefix is not defined in this particular map.
1874 It might even give us a list that isn't a keymap. */
1875 tem
= get_keymap (tem
, 0, 0);
1878 /* Convert PREFIX to a vector now, so that later on
1879 we don't have to deal with the possibility of a string. */
1880 if (STRINGP (prefix
))
1885 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1886 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1890 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1891 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1892 c
^= 0200 | meta_modifier
;
1893 ASET (copy
, i_before
, make_number (c
));
1897 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1903 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1904 get_keymap (keymap
, 1, 0)),
1907 /* For each map in the list maps,
1908 look at any other maps it points to,
1909 and stick them at the end if they are not already in the list.
1911 This is a breadth-first traversal, where tail is the queue of
1912 nodes, and maps accumulates a list of all nodes visited. */
1914 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1916 register Lisp_Object thisseq
, thismap
;
1918 /* Does the current sequence end in the meta-prefix-char? */
1921 thisseq
= Fcar (Fcar (tail
));
1922 thismap
= Fcdr (Fcar (tail
));
1923 last
= make_number (XINT (Flength (thisseq
)) - 1);
1924 is_metized
= (XINT (last
) >= 0
1925 /* Don't metize the last char of PREFIX. */
1926 && XINT (last
) >= prefixlen
1927 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1929 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1933 elt
= XCAR (thismap
);
1937 if (CHAR_TABLE_P (elt
))
1939 Lisp_Object indices
[3];
1941 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
1942 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1943 Fcons (tail
, thisseq
)),
1946 else if (VECTORP (elt
))
1950 /* Vector keymap. Scan all the elements. */
1951 for (i
= 0; i
< ASIZE (elt
); i
++)
1952 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1953 maps
, tail
, thisseq
, is_metized
);
1956 else if (CONSP (elt
))
1957 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1958 maps
, tail
, thisseq
,
1959 is_metized
&& INTEGERP (XCAR (elt
)));
1967 Lisp_Object Qsingle_key_description
, Qkey_description
;
1969 /* This function cannot GC. */
1971 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
1972 doc
: /* Return a pretty description of key-sequence KEYS.
1973 Optional arg PREFIX is the sequence of keys leading up to KEYS.
1974 Control characters turn into "C-foo" sequences, meta into "M-foo",
1975 spaces are put between sequence elements, etc. */)
1977 Lisp_Object keys
, prefix
;
1982 int size
= XINT (Flength (keys
));
1984 Lisp_Object sep
= build_string (" ");
1989 size
+= XINT (Flength (prefix
));
1991 /* This has one extra element at the end that we don't pass to Fconcat. */
1992 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
1994 /* In effect, this computes
1995 (mapconcat 'single-key-description keys " ")
1996 but we shouldn't use mapconcat because it can do GC. */
2000 list
= prefix
, prefix
= Qnil
;
2001 else if (!NILP (keys
))
2002 list
= keys
, keys
= Qnil
;
2007 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2011 return empty_string
;
2012 return Fconcat (len
- 1, args
);
2016 size
= SCHARS (list
);
2017 else if (VECTORP (list
))
2018 size
= XVECTOR (list
)->size
;
2019 else if (CONSP (list
))
2020 size
= XINT (Flength (list
));
2022 wrong_type_argument (Qarrayp
, list
);
2031 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2032 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2033 c
^= 0200 | meta_modifier
;
2034 XSETFASTINT (key
, c
);
2036 else if (VECTORP (list
))
2038 key
= AREF (list
, i
++);
2050 || EQ (key
, meta_prefix_char
)
2051 || (XINT (key
) & meta_modifier
))
2053 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2055 if (EQ (key
, meta_prefix_char
))
2059 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2062 else if (EQ (key
, meta_prefix_char
))
2067 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2075 push_key_description (c
, p
, force_multibyte
)
2076 register unsigned int c
;
2078 int force_multibyte
;
2082 /* Clear all the meaningless bits above the meta bit. */
2083 c
&= meta_modifier
| ~ - meta_modifier
;
2084 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2085 | meta_modifier
| shift_modifier
| super_modifier
);
2087 if (c
& alt_modifier
)
2093 if ((c
& ctrl_modifier
) != 0
2094 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2098 c
&= ~ctrl_modifier
;
2100 if (c
& hyper_modifier
)
2104 c
-= hyper_modifier
;
2106 if (c
& meta_modifier
)
2112 if (c
& shift_modifier
)
2116 c
-= shift_modifier
;
2118 if (c
& super_modifier
)
2122 c
-= super_modifier
;
2138 else if (c
== Ctl ('M'))
2146 /* `C-' already added above. */
2147 if (c
> 0 && c
<= Ctl ('Z'))
2166 || (NILP (current_buffer
->enable_multibyte_characters
)
2167 && SINGLE_BYTE_CHAR_P (c
)
2168 && !force_multibyte
))
2174 int valid_p
= SINGLE_BYTE_CHAR_P (c
) || char_valid_p (c
, 0);
2176 if (force_multibyte
&& valid_p
)
2178 if (SINGLE_BYTE_CHAR_P (c
))
2179 c
= unibyte_char_to_multibyte (c
);
2180 p
+= CHAR_STRING (c
, p
);
2182 else if (NILP (current_buffer
->enable_multibyte_characters
)
2187 /* The biggest character code uses 19 bits. */
2188 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2190 if (c
>= (1 << bit_offset
))
2191 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2195 p
+= CHAR_STRING (c
, p
);
2201 /* This function cannot GC. */
2203 DEFUN ("single-key-description", Fsingle_key_description
,
2204 Ssingle_key_description
, 1, 2, 0,
2205 doc
: /* Return a pretty description of command character KEY.
2206 Control characters turn into C-whatever, etc.
2207 Optional argument NO-ANGLES non-nil means don't put angle brackets
2208 around function keys and event symbols. */)
2210 Lisp_Object key
, no_angles
;
2212 if (CONSP (key
) && lucid_event_type_list_p (key
))
2213 key
= Fevent_convert_list (key
);
2215 key
= EVENT_HEAD (key
);
2217 if (INTEGERP (key
)) /* Normal character */
2219 unsigned int charset
, c1
, c2
;
2220 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2222 if (SINGLE_BYTE_CHAR_P (without_bits
))
2225 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2228 && CHARSET_DEFINED_P (charset
)
2229 && ((c1
>= 0 && c1
< 32)
2230 || (c2
>= 0 && c2
< 32)))
2232 /* Handle a generic character. */
2234 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
2235 CHECK_STRING (name
);
2236 return concat2 (build_string ("Character set "), name
);
2240 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2244 end
= push_key_description (XUINT (key
), tem
, 1);
2246 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2247 if (nchars
== nbytes
)
2250 string
= build_string (tem
);
2253 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2257 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2259 if (NILP (no_angles
))
2262 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2263 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2264 return build_string (buffer
);
2267 return Fsymbol_name (key
);
2269 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2270 return Fcopy_sequence (key
);
2272 error ("KEY must be an integer, cons, symbol, or string");
2277 push_text_char_description (c
, p
)
2278 register unsigned int c
;
2290 *p
++ = c
+ 64; /* 'A' - 1 */
2302 /* This function cannot GC. */
2304 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2305 doc
: /* Return a pretty description of file-character CHARACTER.
2306 Control characters turn into "^char", etc. This differs from
2307 `single-key-description' which turns them into "C-char".
2308 Also, this function recognizes the 2**7 bit as the Meta character,
2309 whereas `single-key-description' uses the 2**27 bit for Meta.
2310 See Info node `(elisp)Describing Characters' for examples. */)
2312 Lisp_Object character
;
2314 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2315 unsigned char str
[6];
2318 CHECK_NUMBER (character
);
2320 c
= XINT (character
);
2321 if (!SINGLE_BYTE_CHAR_P (c
))
2323 int len
= CHAR_STRING (c
, str
);
2325 return make_multibyte_string (str
, 1, len
);
2328 *push_text_char_description (c
& 0377, str
) = 0;
2330 return build_string (str
);
2333 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2336 ascii_sequence_p (seq
)
2340 int len
= XINT (Flength (seq
));
2342 for (i
= 0; i
< len
; i
++)
2344 Lisp_Object ii
, elt
;
2346 XSETFASTINT (ii
, i
);
2347 elt
= Faref (seq
, ii
);
2350 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2358 /* where-is - finding a command in a set of keymaps. */
2360 static Lisp_Object
where_is_internal ();
2361 static Lisp_Object
where_is_internal_1 ();
2362 static void where_is_internal_2 ();
2364 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2365 Returns the first non-nil binding found in any of those maps. */
2368 shadow_lookup (shadow
, key
, flag
)
2369 Lisp_Object shadow
, key
, flag
;
2371 Lisp_Object tail
, value
;
2373 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2375 value
= Flookup_key (XCAR (tail
), key
, flag
);
2376 if (!NILP (value
) && !NATNUMP (value
))
2382 static Lisp_Object Vmouse_events
;
2384 /* This function can GC if Flookup_key autoloads any keymaps. */
2387 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2388 Lisp_Object definition
, keymaps
;
2389 Lisp_Object firstonly
, noindirect
, no_remap
;
2391 Lisp_Object maps
= Qnil
;
2392 Lisp_Object found
, sequences
;
2393 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2394 /* 1 means ignore all menu bindings entirely. */
2395 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2397 /* If this command is remapped, then it has no key bindings
2399 if (NILP (no_remap
) && SYMBOLP (definition
))
2402 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2407 while (CONSP (found
))
2411 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2412 found
= XCDR (found
);
2415 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2419 for (; !NILP (maps
); maps
= Fcdr (maps
))
2421 /* Key sequence to reach map, and the map that it reaches */
2422 register Lisp_Object
this, map
, tem
;
2424 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2425 [M-CHAR] sequences, check if last character of the sequence
2426 is the meta-prefix char. */
2430 this = Fcar (Fcar (maps
));
2431 map
= Fcdr (Fcar (maps
));
2432 last
= make_number (XINT (Flength (this)) - 1);
2433 last_is_meta
= (XINT (last
) >= 0
2434 && EQ (Faref (this, last
), meta_prefix_char
));
2436 /* if (nomenus && !ascii_sequence_p (this)) */
2437 if (nomenus
&& XINT (last
) >= 0
2438 && SYMBOLP (tem
= Faref (this, make_number (0)))
2439 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2440 /* If no menu entries should be returned, skip over the
2441 keymaps bound to `menu-bar' and `tool-bar' and other
2442 non-ascii prefixes like `C-down-mouse-2'. */
2449 /* Because the code we want to run on each binding is rather
2450 large, we don't want to have two separate loop bodies for
2451 sparse keymap bindings and tables; we want to iterate one
2452 loop body over both keymap and vector bindings.
2454 For this reason, if Fcar (map) is a vector, we don't
2455 advance map to the next element until i indicates that we
2456 have finished off the vector. */
2457 Lisp_Object elt
, key
, binding
;
2465 /* Set key and binding to the current key and binding, and
2466 advance map and i to the next binding. */
2469 Lisp_Object sequence
;
2471 /* In a vector, look at each element. */
2472 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2474 binding
= AREF (elt
, i
);
2475 XSETFASTINT (key
, i
);
2476 sequence
= where_is_internal_1 (binding
, key
, definition
,
2478 last
, nomenus
, last_is_meta
);
2479 if (!NILP (sequence
))
2480 sequences
= Fcons (sequence
, sequences
);
2483 else if (CHAR_TABLE_P (elt
))
2485 Lisp_Object indices
[3];
2488 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2489 Qnil
), /* Result accumulator. */
2490 Fcons (Fcons (this, last
),
2491 Fcons (make_number (nomenus
),
2492 make_number (last_is_meta
))));
2493 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2495 sequences
= XCDR (XCAR (args
));
2497 else if (CONSP (elt
))
2499 Lisp_Object sequence
;
2502 binding
= XCDR (elt
);
2504 sequence
= where_is_internal_1 (binding
, key
, definition
,
2506 last
, nomenus
, last_is_meta
);
2507 if (!NILP (sequence
))
2508 sequences
= Fcons (sequence
, sequences
);
2512 while (!NILP (sequences
))
2514 Lisp_Object sequence
, remapped
, function
;
2516 sequence
= XCAR (sequences
);
2517 sequences
= XCDR (sequences
);
2519 /* If the current sequence is a command remapping with
2520 format [remap COMMAND], find the key sequences
2521 which run COMMAND, and use those sequences instead. */
2524 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2525 && EQ (AREF (sequence
, 0), Qremap
)
2526 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2528 Lisp_Object remapped1
;
2530 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2531 if (CONSP (remapped1
))
2533 /* Verify that this key binding actually maps to the
2534 remapped command (see below). */
2535 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2537 sequence
= XCAR (remapped1
);
2538 remapped
= XCDR (remapped1
);
2539 goto record_sequence
;
2543 /* Verify that this key binding is not shadowed by another
2544 binding for the same key, before we say it exists.
2546 Mechanism: look for local definition of this key and if
2547 it is defined and does not match what we found then
2550 Either nil or number as value from Flookup_key
2552 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2556 /* It is a true unshadowed match. Record it, unless it's already
2557 been seen (as could happen when inheriting keymaps). */
2558 if (NILP (Fmember (sequence
, found
)))
2559 found
= Fcons (sequence
, found
);
2561 /* If firstonly is Qnon_ascii, then we can return the first
2562 binding we find. If firstonly is not Qnon_ascii but not
2563 nil, then we should return the first ascii-only binding
2565 if (EQ (firstonly
, Qnon_ascii
))
2566 RETURN_UNGCPRO (sequence
);
2567 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2568 RETURN_UNGCPRO (sequence
);
2570 if (CONSP (remapped
))
2572 sequence
= XCAR (remapped
);
2573 remapped
= XCDR (remapped
);
2574 goto record_sequence
;
2582 found
= Fnreverse (found
);
2584 /* firstonly may have been t, but we may have gone all the way through
2585 the keymaps without finding an all-ASCII key sequence. So just
2586 return the best we could find. */
2587 if (!NILP (firstonly
))
2588 return Fcar (found
);
2593 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2594 doc
: /* Return list of keys that invoke DEFINITION.
2595 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2596 If KEYMAP is nil, search all the currently active keymaps.
2597 If KEYMAP is a list of keymaps, search only those keymaps.
2599 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2600 rather than a list of all possible key sequences.
2601 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2602 no matter what it is.
2603 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2604 \(or their meta variants) and entirely reject menu bindings.
2606 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2607 to other keymaps or slots. This makes it possible to search for an
2608 indirect definition itself.
2610 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2611 that invoke a command which is remapped to DEFINITION, but include the
2612 remapped command in the returned list. */)
2613 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2614 Lisp_Object definition
, keymap
;
2615 Lisp_Object firstonly
, noindirect
, no_remap
;
2617 Lisp_Object sequences
, keymaps
;
2618 /* 1 means ignore all menu bindings entirely. */
2619 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2622 /* Find the relevant keymaps. */
2623 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2625 else if (!NILP (keymap
))
2626 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2628 keymaps
= Fcurrent_active_maps (Qnil
);
2630 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2631 We don't really need to check `keymap'. */
2632 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2636 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2638 /* Check heuristic-consistency of the cache. */
2639 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2640 where_is_cache
= Qnil
;
2642 if (NILP (where_is_cache
))
2644 /* We need to create the cache. */
2645 Lisp_Object args
[2];
2646 where_is_cache
= Fmake_hash_table (0, args
);
2647 where_is_cache_keymaps
= Qt
;
2649 /* Fill in the cache. */
2650 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2651 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2654 where_is_cache_keymaps
= keymaps
;
2657 /* We want to process definitions from the last to the first.
2658 Instead of consing, copy definitions to a vector and step
2659 over that vector. */
2660 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2661 n
= XINT (Flength (sequences
));
2662 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2663 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2664 defns
[i
++] = XCAR (sequences
);
2666 /* Verify that the key bindings are not shadowed. Note that
2667 the following can GC. */
2668 GCPRO2 (definition
, keymaps
);
2671 for (i
= n
- 1; i
>= 0; --i
)
2672 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2674 if (ascii_sequence_p (defns
[i
]))
2680 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2685 /* Kill the cache so that where_is_internal_1 doesn't think
2686 we're filling it up. */
2687 where_is_cache
= Qnil
;
2688 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2694 /* This is the function that Fwhere_is_internal calls using map_char_table.
2696 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2698 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2699 Since map_char_table doesn't really use the return value from this function,
2700 we the result append to RESULT, the slot in ARGS.
2702 This function can GC because it calls where_is_internal_1 which can
2706 where_is_internal_2 (args
, key
, binding
)
2707 Lisp_Object args
, key
, binding
;
2709 Lisp_Object definition
, noindirect
, this, last
;
2710 Lisp_Object result
, sequence
;
2711 int nomenus
, last_is_meta
;
2712 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2714 GCPRO3 (args
, key
, binding
);
2715 result
= XCDR (XCAR (args
));
2716 definition
= XCAR (XCAR (XCAR (args
)));
2717 noindirect
= XCDR (XCAR (XCAR (args
)));
2718 this = XCAR (XCAR (XCDR (args
)));
2719 last
= XCDR (XCAR (XCDR (args
)));
2720 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2721 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2723 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2724 this, last
, nomenus
, last_is_meta
);
2726 if (!NILP (sequence
))
2727 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2733 /* This function cannot GC. */
2736 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2737 nomenus
, last_is_meta
)
2738 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2739 int nomenus
, last_is_meta
;
2741 Lisp_Object sequence
;
2743 /* Search through indirections unless that's not wanted. */
2744 if (NILP (noindirect
))
2745 binding
= get_keyelt (binding
, 0);
2747 /* End this iteration if this element does not match
2750 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2751 || EQ (binding
, definition
)
2752 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2753 /* Doesn't match. */
2756 /* We have found a match. Construct the key sequence where we found it. */
2757 if (INTEGERP (key
) && last_is_meta
)
2759 sequence
= Fcopy_sequence (this);
2760 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2763 sequence
= append_key (this, key
);
2765 if (!NILP (where_is_cache
))
2767 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2768 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2775 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2777 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2778 doc
: /* Insert the list of all defined keys and their definitions.
2779 The list is inserted in the current buffer, while the bindings are
2780 looked up in BUFFER.
2781 The optional argument PREFIX, if non-nil, should be a key sequence;
2782 then we display only bindings that start with that prefix.
2783 The optional argument MENUS, if non-nil, says to mention menu bindings.
2784 \(Ordinarily these are omitted from the output.) */)
2785 (buffer
, prefix
, menus
)
2786 Lisp_Object buffer
, prefix
, menus
;
2788 Lisp_Object outbuf
, shadow
;
2789 int nomenu
= NILP (menus
);
2790 register Lisp_Object start1
;
2791 struct gcpro gcpro1
;
2793 char *alternate_heading
2795 Keyboard translations:\n\n\
2796 You type Translation\n\
2797 -------- -----------\n";
2802 outbuf
= Fcurrent_buffer ();
2804 /* Report on alternates for keys. */
2805 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2808 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2809 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2811 for (c
= 0; c
< translate_len
; c
++)
2812 if (translate
[c
] != c
)
2814 char buf
[KEY_DESCRIPTION_SIZE
];
2817 if (alternate_heading
)
2819 insert_string (alternate_heading
);
2820 alternate_heading
= 0;
2823 bufend
= push_key_description (translate
[c
], buf
, 1);
2824 insert (buf
, bufend
- buf
);
2825 Findent_to (make_number (16), make_number (1));
2826 bufend
= push_key_description (c
, buf
, 1);
2827 insert (buf
, bufend
- buf
);
2835 if (!NILP (Vkey_translation_map
))
2836 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2837 "Key translations", nomenu
, 1, 0);
2840 /* Print the (major mode) local map. */
2842 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2843 start1
= current_kboard
->Voverriding_terminal_local_map
;
2844 else if (!NILP (Voverriding_local_map
))
2845 start1
= Voverriding_local_map
;
2849 describe_map_tree (start1
, 1, shadow
, prefix
,
2850 "\f\nOverriding Bindings", nomenu
, 0, 0);
2851 shadow
= Fcons (start1
, shadow
);
2855 /* Print the minor mode and major mode keymaps. */
2857 Lisp_Object
*modes
, *maps
;
2859 /* Temporarily switch to `buffer', so that we can get that buffer's
2860 minor modes correctly. */
2861 Fset_buffer (buffer
);
2863 nmaps
= current_minor_maps (&modes
, &maps
);
2864 Fset_buffer (outbuf
);
2866 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2867 XBUFFER (buffer
), Qkeymap
);
2870 describe_map_tree (start1
, 1, shadow
, prefix
,
2871 "\f\n`keymap' Property Bindings", nomenu
, 0, 0);
2872 shadow
= Fcons (start1
, shadow
);
2875 /* Print the minor mode maps. */
2876 for (i
= 0; i
< nmaps
; i
++)
2878 /* The title for a minor mode keymap
2879 is constructed at run time.
2880 We let describe_map_tree do the actual insertion
2881 because it takes care of other features when doing so. */
2884 if (!SYMBOLP (modes
[i
]))
2887 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2891 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2892 SCHARS (SYMBOL_NAME (modes
[i
])));
2893 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2895 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2896 p
+= sizeof (" Minor Mode Bindings") - 1;
2899 describe_map_tree (maps
[i
], 1, shadow
, prefix
, title
, nomenu
, 0, 0);
2900 shadow
= Fcons (maps
[i
], shadow
);
2903 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2904 XBUFFER (buffer
), Qlocal_map
);
2907 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2908 describe_map_tree (start1
, 1, shadow
, prefix
,
2909 "\f\nMajor Mode Bindings", nomenu
, 0, 0);
2911 describe_map_tree (start1
, 1, shadow
, prefix
,
2912 "\f\n`local-map' Property Bindings",
2915 shadow
= Fcons (start1
, shadow
);
2919 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2920 "\f\nGlobal Bindings", nomenu
, 0, 1);
2922 /* Print the function-key-map translations under this prefix. */
2923 if (!NILP (Vfunction_key_map
))
2924 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2925 "\f\nFunction key map translations", nomenu
, 1, 0);
2931 /* Insert a description of the key bindings in STARTMAP,
2932 followed by those of all maps reachable through STARTMAP.
2933 If PARTIAL is nonzero, omit certain "uninteresting" commands
2934 (such as `undefined').
2935 If SHADOW is non-nil, it is a list of maps;
2936 don't mention keys which would be shadowed by any of them.
2937 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2938 TITLE, if not 0, is a string to insert at the beginning.
2939 TITLE should not end with a colon or a newline; we supply that.
2940 If NOMENU is not 0, then omit menu-bar commands.
2942 If TRANSL is nonzero, the definitions are actually key translations
2943 so print strings and vectors differently.
2945 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2949 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2951 Lisp_Object startmap
, shadow
, prefix
;
2958 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2959 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2966 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
2969 GCPRO3 (maps
, seen
, sub_shadows
);
2975 /* Delete from MAPS each element that is for the menu bar. */
2976 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
2978 Lisp_Object elt
, prefix
, tem
;
2981 prefix
= Fcar (elt
);
2982 if (XVECTOR (prefix
)->size
>= 1)
2984 tem
= Faref (prefix
, make_number (0));
2985 if (EQ (tem
, Qmenu_bar
))
2986 maps
= Fdelq (elt
, maps
);
2991 if (!NILP (maps
) || always_title
)
2995 insert_string (title
);
2998 insert_string (" Starting With ");
2999 insert1 (Fkey_description (prefix
, Qnil
));
3001 insert_string (":\n");
3003 insert_string (key_heading
);
3007 for (; !NILP (maps
); maps
= Fcdr (maps
))
3009 register Lisp_Object elt
, prefix
, tail
;
3012 prefix
= Fcar (elt
);
3016 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3020 shmap
= XCAR (tail
);
3022 /* If the sequence by which we reach this keymap is zero-length,
3023 then the shadow map for this keymap is just SHADOW. */
3024 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3025 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3027 /* If the sequence by which we reach this keymap actually has
3028 some elements, then the sequence's definition in SHADOW is
3029 what we should use. */
3032 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3033 if (INTEGERP (shmap
))
3037 /* If shmap is not nil and not a keymap,
3038 it completely shadows this map, so don't
3039 describe this map at all. */
3040 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3044 sub_shadows
= Fcons (shmap
, sub_shadows
);
3047 /* Maps we have already listed in this loop shadow this map. */
3048 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3051 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3053 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3056 describe_map (Fcdr (elt
), prefix
,
3057 transl
? describe_translation
: describe_command
,
3058 partial
, sub_shadows
, &seen
, nomenu
);
3064 insert_string ("\n");
3069 static int previous_description_column
;
3072 describe_command (definition
, args
)
3073 Lisp_Object definition
, args
;
3075 register Lisp_Object tem1
;
3076 int column
= (int) current_column (); /* iftc */
3077 int description_column
;
3079 /* If column 16 is no good, go to col 32;
3080 but don't push beyond that--go to next line instead. */
3084 description_column
= 32;
3086 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3087 description_column
= 32;
3089 description_column
= 16;
3091 Findent_to (make_number (description_column
), make_number (1));
3092 previous_description_column
= description_column
;
3094 if (SYMBOLP (definition
))
3096 tem1
= SYMBOL_NAME (definition
);
3098 insert_string ("\n");
3100 else if (STRINGP (definition
) || VECTORP (definition
))
3101 insert_string ("Keyboard Macro\n");
3102 else if (KEYMAPP (definition
))
3103 insert_string ("Prefix Command\n");
3105 insert_string ("??\n");
3109 describe_translation (definition
, args
)
3110 Lisp_Object definition
, args
;
3112 register Lisp_Object tem1
;
3114 Findent_to (make_number (16), make_number (1));
3116 if (SYMBOLP (definition
))
3118 tem1
= SYMBOL_NAME (definition
);
3120 insert_string ("\n");
3122 else if (STRINGP (definition
) || VECTORP (definition
))
3124 insert1 (Fkey_description (definition
, Qnil
));
3125 insert_string ("\n");
3127 else if (KEYMAPP (definition
))
3128 insert_string ("Prefix Command\n");
3130 insert_string ("??\n");
3133 /* Describe the contents of map MAP, assuming that this map itself is
3134 reached by the sequence of prefix keys PREFIX (a string or vector).
3135 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3138 describe_map (map
, prefix
, elt_describer
, partial
, shadow
, seen
, nomenu
)
3139 register Lisp_Object map
;
3141 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3147 Lisp_Object tail
, definition
, event
;
3149 Lisp_Object suppress
;
3152 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3157 suppress
= intern ("suppress-keymap");
3159 /* This vector gets used to present single keys to Flookup_key. Since
3160 that is done once per keymap element, we don't want to cons up a
3161 fresh vector every time. */
3162 kludge
= Fmake_vector (make_number (1), Qnil
);
3165 GCPRO3 (prefix
, definition
, kludge
);
3167 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3171 if (VECTORP (XCAR (tail
))
3172 || CHAR_TABLE_P (XCAR (tail
)))
3173 describe_vector (XCAR (tail
),
3174 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3176 else if (CONSP (XCAR (tail
)))
3178 event
= XCAR (XCAR (tail
));
3180 /* Ignore bindings whose "prefix" are not really valid events.
3181 (We get these in the frames and buffers menu.) */
3182 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3185 if (nomenu
&& EQ (event
, Qmenu_bar
))
3188 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3190 /* Don't show undefined commands or suppressed commands. */
3191 if (NILP (definition
)) continue;
3192 if (SYMBOLP (definition
) && partial
)
3194 tem
= Fget (definition
, suppress
);
3199 /* Don't show a command that isn't really visible
3200 because a local definition of the same key shadows it. */
3202 ASET (kludge
, 0, event
);
3205 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3206 if (!NILP (tem
)) continue;
3209 tem
= Flookup_key (map
, kludge
, Qt
);
3210 if (!EQ (tem
, definition
)) continue;
3214 previous_description_column
= 0;
3219 /* THIS gets the string to describe the character EVENT. */
3220 insert1 (Fkey_description (kludge
, prefix
));
3222 /* Print a description of the definition of this character.
3223 elt_describer will take care of spacing out far enough
3224 for alignment purposes. */
3225 (*elt_describer
) (definition
, Qnil
);
3227 else if (EQ (XCAR (tail
), Qkeymap
))
3229 /* The same keymap might be in the structure twice, if we're
3230 using an inherited keymap. So skip anything we've already
3232 tem
= Fassq (tail
, *seen
);
3233 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3235 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3243 describe_vector_princ (elt
, fun
)
3244 Lisp_Object elt
, fun
;
3246 Findent_to (make_number (16), make_number (1));
3251 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3252 doc
: /* Insert a description of contents of VECTOR.
3253 This is text showing the elements of vector matched against indices.
3254 DESCRIBER is the output function used; nil means use `princ'. */)
3256 Lisp_Object vector
, describer
;
3258 int count
= SPECPDL_INDEX ();
3259 if (NILP (describer
))
3260 describer
= intern ("princ");
3261 specbind (Qstandard_output
, Fcurrent_buffer ());
3262 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3263 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3264 Qnil
, Qnil
, (int *)0, 0, 0);
3266 return unbind_to (count
, Qnil
);
3269 /* Insert in the current buffer a description of the contents of VECTOR.
3270 We call ELT_DESCRIBER to insert the description of one value found
3273 ELT_PREFIX describes what "comes before" the keys or indices defined
3274 by this vector. This is a human-readable string whose size
3275 is not necessarily related to the situation.
3277 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3278 leads to this keymap.
3280 If the vector is a chartable, ELT_PREFIX is the vector
3281 of bytes that lead to the character set or portion of a character
3282 set described by this chartable.
3284 If PARTIAL is nonzero, it means do not mention suppressed commands
3285 (that assumes the vector is in a keymap).
3287 SHADOW is a list of keymaps that shadow this map.
3288 If it is non-nil, then we look up the key in those maps
3289 and we don't mention it now if it is defined by any of them.
3291 ENTIRE_MAP is the keymap in which this vector appears.
3292 If the definition in effect in the whole map does not match
3293 the one in this vector, we ignore this one.
3295 When describing a sub-char-table, INDICES is a list of
3296 indices at higher levels in this char-table,
3297 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3299 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3301 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3304 describe_vector (vector
, prefix
, args
, elt_describer
,
3305 partial
, shadow
, entire_map
,
3306 indices
, char_table_depth
, keymap_p
)
3307 register Lisp_Object vector
;
3308 Lisp_Object prefix
, args
;
3309 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3312 Lisp_Object entire_map
;
3314 int char_table_depth
;
3317 Lisp_Object definition
;
3319 Lisp_Object elt_prefix
= Qnil
;
3321 Lisp_Object suppress
;
3324 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3325 /* Range of elements to be handled. */
3327 /* A flag to tell if a leaf in this level of char-table is not a
3328 generic character (i.e. a complete multibyte character). */
3336 indices
= (int *) alloca (3 * sizeof (int));
3342 /* Call Fkey_description first, to avoid GC bug for the other string. */
3343 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3346 tem
= Fkey_description (prefix
, Qnil
);
3347 elt_prefix
= concat2 (tem
, build_string (" "));
3352 /* This vector gets used to present single keys to Flookup_key. Since
3353 that is done once per vector element, we don't want to cons up a
3354 fresh vector every time. */
3355 kludge
= Fmake_vector (make_number (1), Qnil
);
3356 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3359 suppress
= intern ("suppress-keymap");
3361 if (CHAR_TABLE_P (vector
))
3363 if (char_table_depth
== 0)
3365 /* VECTOR is a top level char-table. */
3368 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3372 /* VECTOR is a sub char-table. */
3373 if (char_table_depth
>= 3)
3374 /* A char-table is never that deep. */
3375 error ("Too deep char table");
3378 = (CHARSET_VALID_P (indices
[0])
3379 && ((CHARSET_DIMENSION (indices
[0]) == 1
3380 && char_table_depth
== 1)
3381 || char_table_depth
== 2));
3383 /* Meaningful elements are from 32th to 127th. */
3385 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3390 /* This does the right thing for ordinary vectors. */
3394 to
= XVECTOR (vector
)->size
;
3397 for (i
= from
; i
< to
; i
++)
3401 if (CHAR_TABLE_P (vector
))
3403 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3406 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3407 && !CHARSET_DEFINED_P (i
- 128))
3411 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3414 definition
= get_keyelt (AREF (vector
, i
), 0);
3416 if (NILP (definition
)) continue;
3418 /* Don't mention suppressed commands. */
3419 if (SYMBOLP (definition
) && partial
)
3423 tem
= Fget (definition
, suppress
);
3425 if (!NILP (tem
)) continue;
3428 /* Set CHARACTER to the character this entry describes, if any.
3429 Also update *INDICES. */
3430 if (CHAR_TABLE_P (vector
))
3432 indices
[char_table_depth
] = i
;
3434 if (char_table_depth
== 0)
3437 indices
[0] = i
- 128;
3439 else if (complete_char
)
3441 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3449 ASET (kludge
, 0, make_number (character
));
3451 /* If this binding is shadowed by some other map, ignore it. */
3452 if (!NILP (shadow
) && complete_char
)
3456 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3458 if (!NILP (tem
)) continue;
3461 /* Ignore this definition if it is shadowed by an earlier
3462 one in the same keymap. */
3463 if (!NILP (entire_map
) && complete_char
)
3467 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3469 if (!EQ (tem
, definition
))
3475 if (char_table_depth
== 0)
3480 /* For a sub char-table, show the depth by indentation.
3481 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3482 if (char_table_depth
> 0)
3483 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3485 /* Output the prefix that applies to every entry in this map. */
3486 if (!NILP (elt_prefix
))
3487 insert1 (elt_prefix
);
3489 /* Insert or describe the character this slot is for,
3490 or a description of what it is for. */
3491 if (SUB_CHAR_TABLE_P (vector
))
3494 insert_char (character
);
3497 /* We need an octal representation for this block of
3500 sprintf (work
, "(row %d)", i
);
3501 insert (work
, strlen (work
));
3504 else if (CHAR_TABLE_P (vector
))
3507 insert1 (Fkey_description (kludge
, prefix
));
3510 /* Print the information for this character set. */
3511 insert_string ("<");
3512 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3514 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3523 insert1 (Fkey_description (kludge
, prefix
));
3526 /* If we find a sub char-table within a char-table,
3527 scan it recursively; it defines the details for
3528 a character set or a portion of a character set. */
3529 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3532 describe_vector (definition
, prefix
, args
, elt_describer
,
3533 partial
, shadow
, entire_map
,
3534 indices
, char_table_depth
+ 1, keymap_p
);
3540 /* Find all consecutive characters or rows that have the same
3541 definition. But, for elements of a top level char table, if
3542 they are for charsets, we had better describe one by one even
3543 if they have the same definition. */
3544 if (CHAR_TABLE_P (vector
))
3548 if (char_table_depth
== 0)
3549 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3551 while (i
+ 1 < limit
3552 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3554 && !NILP (Fequal (tem2
, definition
)))
3559 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3561 && !NILP (Fequal (tem2
, definition
)))
3565 /* If we have a range of more than one character,
3566 print where the range reaches to. */
3568 if (i
!= starting_i
)
3572 ASET (kludge
, 0, make_number (i
));
3574 if (!NILP (elt_prefix
))
3575 insert1 (elt_prefix
);
3577 if (CHAR_TABLE_P (vector
))
3579 if (char_table_depth
== 0)
3581 insert1 (Fkey_description (kludge
, prefix
));
3583 else if (complete_char
)
3585 indices
[char_table_depth
] = i
;
3586 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3587 insert_char (character
);
3591 /* We need an octal representation for this block of
3594 sprintf (work
, "(row %d)", i
);
3595 insert (work
, strlen (work
));
3600 insert1 (Fkey_description (kludge
, prefix
));
3604 /* Print a description of the definition of this character.
3605 elt_describer will take care of spacing out far enough
3606 for alignment purposes. */
3607 (*elt_describer
) (definition
, args
);
3610 /* For (sub) char-table, print `defalt' slot at last. */
3611 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3613 insert (" ", char_table_depth
* 2);
3614 insert_string ("<<default>>");
3615 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3621 /* Apropos - finding all symbols whose names match a regexp. */
3622 static Lisp_Object apropos_predicate
;
3623 static Lisp_Object apropos_accumulate
;
3626 apropos_accum (symbol
, string
)
3627 Lisp_Object symbol
, string
;
3629 register Lisp_Object tem
;
3631 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3632 if (!NILP (tem
) && !NILP (apropos_predicate
))
3633 tem
= call1 (apropos_predicate
, symbol
);
3635 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3638 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3639 doc
: /* Show all symbols whose names contain match for REGEXP.
3640 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3641 for each symbol and a symbol is mentioned only if that returns non-nil.
3642 Return list of symbols found. */)
3644 Lisp_Object regexp
, predicate
;
3647 CHECK_STRING (regexp
);
3648 apropos_predicate
= predicate
;
3649 apropos_accumulate
= Qnil
;
3650 map_obarray (Vobarray
, apropos_accum
, regexp
);
3651 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3652 apropos_accumulate
= Qnil
;
3653 apropos_predicate
= Qnil
;
3660 Qkeymap
= intern ("keymap");
3661 staticpro (&Qkeymap
);
3662 staticpro (&apropos_predicate
);
3663 staticpro (&apropos_accumulate
);
3664 apropos_predicate
= Qnil
;
3665 apropos_accumulate
= Qnil
;
3667 /* Now we are ready to set up this property, so we can
3668 create char tables. */
3669 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3671 /* Initialize the keymaps standardly used.
3672 Each one is the value of a Lisp variable, and is also
3673 pointed to by a C variable */
3675 global_map
= Fmake_keymap (Qnil
);
3676 Fset (intern ("global-map"), global_map
);
3678 current_global_map
= global_map
;
3679 staticpro (&global_map
);
3680 staticpro (¤t_global_map
);
3682 meta_map
= Fmake_keymap (Qnil
);
3683 Fset (intern ("esc-map"), meta_map
);
3684 Ffset (intern ("ESC-prefix"), meta_map
);
3686 control_x_map
= Fmake_keymap (Qnil
);
3687 Fset (intern ("ctl-x-map"), control_x_map
);
3688 Ffset (intern ("Control-X-prefix"), control_x_map
);
3691 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3692 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3693 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3694 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3695 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3697 staticpro (&exclude_keys
);
3699 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3700 doc
: /* List of commands given new key bindings recently.
3701 This is used for internal purposes during Emacs startup;
3702 don't alter it yourself. */);
3703 Vdefine_key_rebound_commands
= Qt
;
3705 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3706 doc
: /* Default keymap to use when reading from the minibuffer. */);
3707 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3709 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3710 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3711 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3712 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3714 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3715 doc
: /* Local keymap for minibuffer input with completion. */);
3716 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3717 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3719 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3720 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3721 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3722 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3723 Vminibuffer_local_completion_map
);
3725 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3726 doc
: /* Alist of keymaps to use for minor modes.
3727 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3728 key sequences and look up bindings iff VARIABLE's value is non-nil.
3729 If two active keymaps bind the same key, the keymap appearing earlier
3730 in the list takes precedence. */);
3731 Vminor_mode_map_alist
= Qnil
;
3733 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3734 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3735 This variable is an alist just like `minor-mode-map-alist', and it is
3736 used the same way (and before `minor-mode-map-alist'); however,
3737 it is provided for major modes to bind locally. */);
3738 Vminor_mode_overriding_map_alist
= Qnil
;
3740 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3741 doc
: /* List of keymap alists to use for emulations modes.
3742 It is intended for modes or packages using multiple minor-mode keymaps.
3743 Each element is a keymap alist just like `minor-mode-map-alist', or a
3744 symbol with a variable binding which is a keymap alist, and it is used
3745 the same way. The "active" keymaps in each alist are used before
3746 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3747 Vemulation_mode_map_alists
= Qnil
;
3750 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3751 doc
: /* Keymap mapping ASCII function key sequences onto their preferred forms.
3752 This allows Emacs to recognize function keys sent from ASCII
3753 terminals at any point in a key sequence.
3755 The `read-key-sequence' function replaces any subsequence bound by
3756 `function-key-map' with its binding. More precisely, when the active
3757 keymaps have no binding for the current key sequence but
3758 `function-key-map' binds a suffix of the sequence to a vector or string,
3759 `read-key-sequence' replaces the matching suffix with its binding, and
3760 continues with the new sequence.
3762 The events that come from bindings in `function-key-map' are not
3763 themselves looked up in `function-key-map'.
3765 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3766 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3767 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3768 key, typing `ESC O P x' would return [f1 x]. */);
3769 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3771 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3772 doc
: /* Keymap of key translations that can override keymaps.
3773 This keymap works like `function-key-map', but comes after that,
3774 and its non-prefix bindings override ordinary bindings. */);
3775 Vkey_translation_map
= Qnil
;
3777 staticpro (&Vmouse_events
);
3778 Vmouse_events
= Fcons (intern ("menu-bar"),
3779 Fcons (intern ("tool-bar"),
3780 Fcons (intern ("header-line"),
3781 Fcons (intern ("mode-line"),
3782 Fcons (intern ("mouse-1"),
3783 Fcons (intern ("mouse-2"),
3784 Fcons (intern ("mouse-3"),
3785 Fcons (intern ("mouse-4"),
3786 Fcons (intern ("mouse-5"),
3790 Qsingle_key_description
= intern ("single-key-description");
3791 staticpro (&Qsingle_key_description
);
3793 Qkey_description
= intern ("key-description");
3794 staticpro (&Qkey_description
);
3796 Qkeymapp
= intern ("keymapp");
3797 staticpro (&Qkeymapp
);
3799 Qnon_ascii
= intern ("non-ascii");
3800 staticpro (&Qnon_ascii
);
3802 Qmenu_item
= intern ("menu-item");
3803 staticpro (&Qmenu_item
);
3805 Qremap
= intern ("remap");
3806 staticpro (&Qremap
);
3808 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3809 staticpro (&command_remapping_vector
);
3811 where_is_cache_keymaps
= Qt
;
3812 where_is_cache
= Qnil
;
3813 staticpro (&where_is_cache
);
3814 staticpro (&where_is_cache_keymaps
);
3816 defsubr (&Skeymapp
);
3817 defsubr (&Skeymap_parent
);
3818 defsubr (&Skeymap_prompt
);
3819 defsubr (&Sset_keymap_parent
);
3820 defsubr (&Smake_keymap
);
3821 defsubr (&Smake_sparse_keymap
);
3822 defsubr (&Smap_keymap
);
3823 defsubr (&Scopy_keymap
);
3824 defsubr (&Scommand_remapping
);
3825 defsubr (&Skey_binding
);
3826 defsubr (&Slocal_key_binding
);
3827 defsubr (&Sglobal_key_binding
);
3828 defsubr (&Sminor_mode_key_binding
);
3829 defsubr (&Sdefine_key
);
3830 defsubr (&Slookup_key
);
3831 defsubr (&Sdefine_prefix_command
);
3832 defsubr (&Suse_global_map
);
3833 defsubr (&Suse_local_map
);
3834 defsubr (&Scurrent_local_map
);
3835 defsubr (&Scurrent_global_map
);
3836 defsubr (&Scurrent_minor_mode_maps
);
3837 defsubr (&Scurrent_active_maps
);
3838 defsubr (&Saccessible_keymaps
);
3839 defsubr (&Skey_description
);
3840 defsubr (&Sdescribe_vector
);
3841 defsubr (&Ssingle_key_description
);
3842 defsubr (&Stext_char_description
);
3843 defsubr (&Swhere_is_internal
);
3844 defsubr (&Sdescribe_buffer_bindings
);
3845 defsubr (&Sapropos_internal
);
3851 initial_define_key (global_map
, 033, "ESC-prefix");
3852 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
3855 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
3856 (do not change this comment) */