1 /* Manipulation of keymaps
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
31 #include "termhooks.h"
32 #include "blockinput.h"
34 #include "intervals.h"
37 /* The number of elements in keymap vectors. */
38 #define DENSE_TABLE_SIZE (0200)
40 /* Actually allocate storage for these variables */
42 Lisp_Object current_global_map
; /* Current global keymap */
44 Lisp_Object global_map
; /* default global key bindings */
46 Lisp_Object meta_map
; /* The keymap used for globally bound
47 ESC-prefixed default commands */
49 Lisp_Object control_x_map
; /* The keymap used for globally bound
50 C-x-prefixed default commands */
52 /* was MinibufLocalMap */
53 Lisp_Object Vminibuffer_local_map
;
54 /* The keymap used by the minibuf for local
55 bindings when spaces are allowed in the
58 /* was MinibufLocalNSMap */
59 Lisp_Object Vminibuffer_local_ns_map
;
60 /* The keymap used by the minibuf for local
61 bindings when spaces are not encouraged
64 /* keymap used for minibuffers when doing completion */
65 /* was MinibufLocalCompletionMap */
66 Lisp_Object Vminibuffer_local_completion_map
;
68 /* keymap used for minibuffers when doing completion in filenames */
69 Lisp_Object Vminibuffer_local_filename_completion_map
;
71 /* keymap used for minibuffers when doing completion in filenames
73 Lisp_Object Vminibuffer_local_must_match_filename_map
;
75 /* keymap used for minibuffers when doing completion and require a match */
76 /* was MinibufLocalMustMatchMap */
77 Lisp_Object Vminibuffer_local_must_match_map
;
79 /* Alist of minor mode variables and keymaps. */
80 Lisp_Object Vminor_mode_map_alist
;
82 /* Alist of major-mode-specific overrides for
83 minor mode variables and keymaps. */
84 Lisp_Object Vminor_mode_overriding_map_alist
;
86 /* List of emulation mode keymap alists. */
87 Lisp_Object Vemulation_mode_map_alists
;
89 /* Keymap mapping ASCII function key sequences onto their preferred forms.
90 Initialized by the terminal-specific lisp files. See DEFVAR for more
92 Lisp_Object Vfunction_key_map
;
94 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
95 Lisp_Object Vkey_translation_map
;
97 /* A list of all commands given new bindings since a certain time
98 when nil was stored here.
99 This is used to speed up recomputation of menu key equivalents
100 when Emacs starts up. t means don't record anything here. */
101 Lisp_Object Vdefine_key_rebound_commands
;
103 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
105 /* Alist of elements like (DEL . "\d"). */
106 static Lisp_Object exclude_keys
;
108 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
109 static Lisp_Object command_remapping_vector
;
111 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
112 in a string key sequence is equivalent to prefixing with this
114 extern Lisp_Object meta_prefix_char
;
116 extern Lisp_Object Voverriding_local_map
;
118 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
119 static Lisp_Object where_is_cache
;
120 /* Which keymaps are reverse-stored in the cache. */
121 static Lisp_Object where_is_cache_keymaps
;
123 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
124 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
126 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
127 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
128 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
129 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
130 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
131 int, Lisp_Object
, Lisp_Object
*, int, int));
132 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
133 void (*) (Lisp_Object
, Lisp_Object
), int,
134 Lisp_Object
, Lisp_Object
, int *,
136 static void silly_event_symbol_error
P_ ((Lisp_Object
));
138 /* Keymap object support - constructors and predicates. */
140 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
141 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
142 CHARTABLE is a char-table that holds the bindings for all characters
143 without modifiers. All entries in it are initially nil, meaning
144 "command undefined". ALIST is an assoc-list which holds bindings for
145 function keys, mouse events, and any other things that appear in the
146 input stream. Initially, ALIST is nil.
148 The optional arg STRING supplies a menu name for the keymap
149 in case you use it as a menu with `x-popup-menu'. */)
155 tail
= Fcons (string
, Qnil
);
158 return Fcons (Qkeymap
,
159 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
162 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
163 doc
: /* Construct and return a new sparse keymap.
164 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
165 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
166 which binds the function key or mouse event SYMBOL to DEFINITION.
167 Initially the alist is nil.
169 The optional arg STRING supplies a menu name for the keymap
170 in case you use it as a menu with `x-popup-menu'. */)
175 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
176 return Fcons (Qkeymap
, Qnil
);
179 /* This function is used for installing the standard key bindings
180 at initialization time.
184 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
187 initial_define_key (keymap
, key
, defname
)
192 store_in_keymap (keymap
, make_number (key
), intern (defname
));
196 initial_define_lispy_key (keymap
, keyname
, defname
)
201 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
204 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
205 doc
: /* Return t if OBJECT is a keymap.
207 A keymap is a list (keymap . ALIST),
208 or a symbol whose function definition is itself a keymap.
209 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
210 a vector of densely packed bindings for small character codes
211 is also allowed as an element. */)
215 return (KEYMAPP (object
) ? Qt
: Qnil
);
218 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
219 doc
: /* Return the prompt-string of a keymap MAP.
220 If non-nil, the prompt is shown in the echo-area
221 when reading a key-sequence to be looked-up in this keymap. */)
225 map
= get_keymap (map
, 0, 0);
228 Lisp_Object tem
= XCAR (map
);
236 /* Check that OBJECT is a keymap (after dereferencing through any
237 symbols). If it is, return it.
239 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
240 is an autoload form, do the autoload and try again.
241 If AUTOLOAD is nonzero, callers must assume GC is possible.
243 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
244 is zero as well), return Qt.
246 ERROR controls how we respond if OBJECT isn't a keymap.
247 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
249 Note that most of the time, we don't want to pursue autoloads.
250 Functions like Faccessible_keymaps which scan entire keymap trees
251 shouldn't load every autoloaded keymap. I'm not sure about this,
252 but it seems to me that only read_key_sequence, Flookup_key, and
253 Fdefine_key should cause keymaps to be autoloaded.
255 This function can GC when AUTOLOAD is non-zero, because it calls
256 do_autoload which can GC. */
259 get_keymap (object
, error
, autoload
)
268 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
271 tem
= indirect_function (object
);
274 if (EQ (XCAR (tem
), Qkeymap
))
277 /* Should we do an autoload? Autoload forms for keymaps have
278 Qkeymap as their fifth element. */
279 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
)
284 tail
= Fnth (make_number (4), tem
);
285 if (EQ (tail
, Qkeymap
))
289 struct gcpro gcpro1
, gcpro2
;
291 GCPRO2 (tem
, object
);
292 do_autoload (tem
, object
);
305 wrong_type_argument (Qkeymapp
, object
);
309 /* Return the parent map of KEYMAP, or nil if it has none.
310 We assume that KEYMAP is a valid keymap. */
313 keymap_parent (keymap
, autoload
)
319 keymap
= get_keymap (keymap
, 1, autoload
);
321 /* Skip past the initial element `keymap'. */
322 list
= XCDR (keymap
);
323 for (; CONSP (list
); list
= XCDR (list
))
325 /* See if there is another `keymap'. */
330 return get_keymap (list
, 0, autoload
);
333 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
334 doc
: /* Return the parent keymap of KEYMAP. */)
338 return keymap_parent (keymap
, 1);
341 /* Check whether MAP is one of MAPS parents. */
343 keymap_memberp (map
, maps
)
344 Lisp_Object map
, maps
;
346 if (NILP (map
)) return 0;
347 while (KEYMAPP (maps
) && !EQ (map
, maps
))
348 maps
= keymap_parent (maps
, 0);
349 return (EQ (map
, maps
));
352 /* Set the parent keymap of MAP to PARENT. */
354 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
355 doc
: /* Modify KEYMAP to set its parent map to PARENT.
356 Return PARENT. PARENT should be nil or another keymap. */)
358 Lisp_Object keymap
, parent
;
360 Lisp_Object list
, prev
;
361 struct gcpro gcpro1
, gcpro2
;
364 /* Force a keymap flush for the next call to where-is.
365 Since this can be called from within where-is, we don't set where_is_cache
366 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
367 be changed during where-is, while where_is_cache_keymaps is only used at
368 the very beginning of where-is and can thus be changed here without any
370 This is a very minor correctness (rather than safety) issue. */
371 where_is_cache_keymaps
= Qt
;
373 GCPRO2 (keymap
, parent
);
374 keymap
= get_keymap (keymap
, 1, 1);
378 parent
= get_keymap (parent
, 1, 1);
380 /* Check for cycles. */
381 if (keymap_memberp (keymap
, parent
))
382 error ("Cyclic keymap inheritance");
385 /* Skip past the initial element `keymap'. */
390 /* If there is a parent keymap here, replace it.
391 If we came to the end, add the parent in PREV. */
392 if (!CONSP (list
) || KEYMAPP (list
))
394 /* If we already have the right parent, return now
395 so that we avoid the loops below. */
396 if (EQ (XCDR (prev
), parent
))
397 RETURN_UNGCPRO (parent
);
399 XSETCDR (prev
, parent
);
405 /* Scan through for submaps, and set their parents too. */
407 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
409 /* Stop the scan when we come to the parent. */
410 if (EQ (XCAR (list
), Qkeymap
))
413 /* If this element holds a prefix map, deal with it. */
414 if (CONSP (XCAR (list
))
415 && CONSP (XCDR (XCAR (list
))))
416 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
419 if (VECTORP (XCAR (list
)))
420 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
421 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
422 fix_submap_inheritance (keymap
, make_number (i
),
423 XVECTOR (XCAR (list
))->contents
[i
]);
425 if (CHAR_TABLE_P (XCAR (list
)))
427 Lisp_Object indices
[3];
429 map_char_table (fix_submap_inheritance
, Qnil
,
430 XCAR (list
), XCAR (list
),
435 RETURN_UNGCPRO (parent
);
438 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
439 if EVENT is also a prefix in MAP's parent,
440 make sure that SUBMAP inherits that definition as its own parent. */
443 fix_submap_inheritance (map
, event
, submap
)
444 Lisp_Object map
, event
, submap
;
446 Lisp_Object map_parent
, parent_entry
;
448 /* SUBMAP is a cons that we found as a key binding.
449 Discard the other things found in a menu key binding. */
451 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
453 /* If it isn't a keymap now, there's no work to do. */
457 map_parent
= keymap_parent (map
, 0);
458 if (!NILP (map_parent
))
460 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
464 /* If MAP's parent has something other than a keymap,
465 our own submap shadows it completely. */
466 if (!CONSP (parent_entry
))
469 if (! EQ (parent_entry
, submap
))
471 Lisp_Object submap_parent
;
472 submap_parent
= submap
;
477 tem
= keymap_parent (submap_parent
, 0);
481 if (keymap_memberp (tem
, parent_entry
))
482 /* Fset_keymap_parent could create a cycle. */
489 Fset_keymap_parent (submap_parent
, parent_entry
);
493 /* Look up IDX in MAP. IDX may be any sort of event.
494 Note that this does only one level of lookup; IDX must be a single
495 event, not a sequence.
497 If T_OK is non-zero, bindings for Qt are treated as default
498 bindings; any key left unmentioned by other tables and bindings is
499 given the binding of Qt.
501 If T_OK is zero, bindings for Qt are not treated specially.
503 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
506 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
515 /* Qunbound in VAL means we have found no binding yet. */
518 /* If idx is a list (some sort of mouse click, perhaps?),
519 the index we want to use is the car of the list, which
520 ought to be a symbol. */
521 idx
= EVENT_HEAD (idx
);
523 /* If idx is a symbol, it might have modifiers, which need to
524 be put in the canonical order. */
526 idx
= reorder_modifiers (idx
);
527 else if (INTEGERP (idx
))
528 /* Clobber the high bits that can be present on a machine
529 with more than 24 bits of integer. */
530 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
532 /* Handle the special meta -> esc mapping. */
533 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
535 /* See if there is a meta-map. If there's none, there is
536 no binding for IDX, unless a default binding exists in MAP. */
538 Lisp_Object meta_map
;
540 /* A strange value in which Meta is set would cause
541 infinite recursion. Protect against that. */
542 if (XINT (meta_prefix_char
) & CHAR_META
)
543 meta_prefix_char
= make_number (27);
544 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
545 t_ok
, noinherit
, autoload
),
548 if (CONSP (meta_map
))
551 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
554 /* Set IDX to t, so that we only find a default binding. */
557 /* We know there is no binding. */
561 /* t_binding is where we put a default binding that applies,
562 to use in case we do not find a binding specifically
563 for this key sequence. */
566 Lisp_Object t_binding
= Qnil
;
567 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
569 GCPRO4 (map
, tail
, idx
, t_binding
);
571 /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
572 If it is 1, only generic-char bindings are accepted.
573 Otherwise, neither are. */
576 for (tail
= XCDR (map
);
578 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
583 binding
= XCAR (tail
);
584 if (SYMBOLP (binding
))
586 /* If NOINHERIT, stop finding prefix definitions
587 after we pass a second occurrence of the `keymap' symbol. */
588 if (noinherit
&& EQ (binding
, Qkeymap
))
589 RETURN_UNGCPRO (Qnil
);
591 else if (CONSP (binding
))
593 Lisp_Object key
= XCAR (binding
);
596 val
= XCDR (binding
);
599 && (XINT (idx
) & CHAR_MODIFIER_MASK
) == 0
601 && (XINT (key
) & CHAR_MODIFIER_MASK
) == 0
602 && !SINGLE_BYTE_CHAR_P (XINT (idx
))
603 && !SINGLE_BYTE_CHAR_P (XINT (key
))
604 && CHAR_VALID_P (XINT (key
), 1)
605 && !CHAR_VALID_P (XINT (key
), 0)
606 && (CHAR_CHARSET (XINT (key
))
607 == CHAR_CHARSET (XINT (idx
))))
609 /* KEY is the generic character of the charset of IDX.
610 Use KEY's binding if there isn't a binding for IDX
612 t_binding
= XCDR (binding
);
615 else if (t_ok
> 1 && EQ (key
, Qt
))
617 t_binding
= XCDR (binding
);
621 else if (VECTORP (binding
))
623 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
624 val
= AREF (binding
, XFASTINT (idx
));
626 else if (CHAR_TABLE_P (binding
))
628 /* Character codes with modifiers
629 are not included in a char-table.
630 All character codes without modifiers are included. */
631 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
633 val
= Faref (binding
, idx
);
634 /* `nil' has a special meaning for char-tables, so
635 we use something else to record an explicitly
642 /* If we found a binding, clean it up and return it. */
643 if (!EQ (val
, Qunbound
))
646 /* A Qt binding is just like an explicit nil binding
647 (i.e. it shadows any parent binding but not bindings in
648 keymaps of lower precedence). */
650 val
= get_keyelt (val
, autoload
);
652 fix_submap_inheritance (map
, idx
, val
);
653 RETURN_UNGCPRO (val
);
658 return get_keyelt (t_binding
, autoload
);
663 map_keymap_item (fun
, args
, key
, val
, data
)
664 map_keymap_function_t fun
;
665 Lisp_Object args
, key
, val
;
668 /* We should maybe try to detect bindings shadowed by previous
669 ones and things like that. */
672 (*fun
) (key
, val
, args
, data
);
676 map_keymap_char_table_item (args
, key
, val
)
677 Lisp_Object args
, key
, val
;
681 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
683 map_keymap_item (fun
, XCDR (args
), key
, val
,
684 XSAVE_VALUE (XCAR (args
))->pointer
);
688 /* Call FUN for every binding in MAP.
689 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
690 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
692 map_keymap (map
, fun
, args
, data
, autoload
)
693 map_keymap_function_t fun
;
694 Lisp_Object map
, args
;
698 struct gcpro gcpro1
, gcpro2
, gcpro3
;
701 GCPRO3 (map
, args
, tail
);
702 map
= get_keymap (map
, 1, autoload
);
703 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
704 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
707 Lisp_Object binding
= XCAR (tail
);
710 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
711 else if (VECTORP (binding
))
713 /* Loop over the char values represented in the vector. */
714 int len
= ASIZE (binding
);
716 for (c
= 0; c
< len
; c
++)
718 Lisp_Object character
;
719 XSETFASTINT (character
, c
);
720 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
723 else if (CHAR_TABLE_P (binding
))
725 Lisp_Object indices
[3];
726 map_char_table (map_keymap_char_table_item
, Qnil
, binding
, binding
,
727 Fcons (make_save_value (fun
, 0),
728 Fcons (make_save_value (data
, 0),
737 map_keymap_call (key
, val
, fun
, dummy
)
738 Lisp_Object key
, val
, fun
;
741 call2 (fun
, key
, val
);
744 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 3, 0,
745 doc
: /* Call FUNCTION for every binding in KEYMAP.
746 FUNCTION is called with two arguments: the event and its binding.
747 If KEYMAP has a parent, the parent's bindings are included as well.
748 This works recursively: if the parent has itself a parent, then the
749 grandparent's bindings are also included and so on.
750 usage: (map-keymap FUNCTION KEYMAP) */)
751 (function
, keymap
, sort_first
)
752 Lisp_Object function
, keymap
, sort_first
;
754 if (INTEGERP (function
))
755 /* We have to stop integers early since map_keymap gives them special
757 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
758 if (! NILP (sort_first
))
759 return call3 (intern ("map-keymap-internal"), function
, keymap
, Qt
);
761 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
765 /* Given OBJECT which was found in a slot in a keymap,
766 trace indirect definitions to get the actual definition of that slot.
767 An indirect definition is a list of the form
768 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
769 and INDEX is the object to look up in KEYMAP to yield the definition.
771 Also if OBJECT has a menu string as the first element,
772 remove that. Also remove a menu help string as second element.
774 If AUTOLOAD is nonzero, load autoloadable keymaps
775 that are referred to with indirection.
777 This can GC because menu_item_eval_property calls Feval. */
780 get_keyelt (object
, autoload
)
786 if (!(CONSP (object
)))
787 /* This is really the value. */
790 /* If the keymap contents looks like (keymap ...) or (lambda ...)
792 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
795 /* If the keymap contents looks like (menu-item name . DEFN)
796 or (menu-item name DEFN ...) then use DEFN.
797 This is a new format menu item. */
798 else if (EQ (XCAR (object
), Qmenu_item
))
800 if (CONSP (XCDR (object
)))
804 object
= XCDR (XCDR (object
));
807 object
= XCAR (object
);
809 /* If there's a `:filter FILTER', apply FILTER to the
810 menu-item's definition to get the real definition to
812 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
813 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
816 filter
= XCAR (XCDR (tem
));
817 filter
= list2 (filter
, list2 (Qquote
, object
));
818 object
= menu_item_eval_property (filter
);
823 /* Invalid keymap. */
827 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
828 Keymap alist elements like (CHAR MENUSTRING . DEFN)
829 will be used by HierarKey menus. */
830 else if (STRINGP (XCAR (object
)))
832 object
= XCDR (object
);
833 /* Also remove a menu help string, if any,
834 following the menu item name. */
835 if (CONSP (object
) && STRINGP (XCAR (object
)))
836 object
= XCDR (object
);
837 /* Also remove the sublist that caches key equivalences, if any. */
838 if (CONSP (object
) && CONSP (XCAR (object
)))
841 carcar
= XCAR (XCAR (object
));
842 if (NILP (carcar
) || VECTORP (carcar
))
843 object
= XCDR (object
);
847 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
853 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
855 return (!CONSP (map
) ? object
/* Invalid keymap */
856 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
862 store_in_keymap (keymap
, idx
, def
)
864 register Lisp_Object idx
;
865 register Lisp_Object def
;
867 /* Flush any reverse-map cache. */
868 where_is_cache
= Qnil
;
869 where_is_cache_keymaps
= Qt
;
871 /* If we are preparing to dump, and DEF is a menu element
872 with a menu item indicator, copy it to ensure it is not pure. */
873 if (CONSP (def
) && PURE_P (def
)
874 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
875 def
= Fcons (XCAR (def
), XCDR (def
));
877 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
878 error ("attempt to define a key in a non-keymap");
880 /* If idx is a list (some sort of mouse click, perhaps?),
881 the index we want to use is the car of the list, which
882 ought to be a symbol. */
883 idx
= EVENT_HEAD (idx
);
885 /* If idx is a symbol, it might have modifiers, which need to
886 be put in the canonical order. */
888 idx
= reorder_modifiers (idx
);
889 else if (INTEGERP (idx
))
890 /* Clobber the high bits that can be present on a machine
891 with more than 24 bits of integer. */
892 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
894 /* Scan the keymap for a binding of idx. */
898 /* The cons after which we should insert new bindings. If the
899 keymap has a table element, we record its position here, so new
900 bindings will go after it; this way, the table will stay
901 towards the front of the alist and character lookups in dense
902 keymaps will remain fast. Otherwise, this just points at the
903 front of the keymap. */
904 Lisp_Object insertion_point
;
906 insertion_point
= keymap
;
907 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
914 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
916 ASET (elt
, XFASTINT (idx
), def
);
919 insertion_point
= tail
;
921 else if (CHAR_TABLE_P (elt
))
923 /* Character codes with modifiers
924 are not included in a char-table.
925 All character codes without modifiers are included. */
926 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
929 /* `nil' has a special meaning for char-tables, so
930 we use something else to record an explicitly
932 NILP (def
) ? Qt
: def
);
935 insertion_point
= tail
;
937 else if (CONSP (elt
))
939 if (EQ (idx
, XCAR (elt
)))
945 else if (EQ (elt
, Qkeymap
))
946 /* If we find a 'keymap' symbol in the spine of KEYMAP,
947 then we must have found the start of a second keymap
948 being used as the tail of KEYMAP, and a binding for IDX
949 should be inserted before it. */
956 /* We have scanned the entire keymap, and not found a binding for
957 IDX. Let's add one. */
958 XSETCDR (insertion_point
,
959 Fcons (Fcons (idx
, def
), XCDR (insertion_point
)));
965 EXFUN (Fcopy_keymap
, 1);
968 copy_keymap_item (elt
)
971 Lisp_Object res
, tem
;
978 /* Is this a new format menu item. */
979 if (EQ (XCAR (tem
), Qmenu_item
))
981 /* Copy cell with menu-item marker. */
982 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
986 /* Copy cell with menu-item name. */
987 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
993 /* Copy cell with binding and if the binding is a keymap,
995 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
998 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
999 XSETCAR (elt
, Fcopy_keymap (tem
));
1001 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1002 /* Delete cache for key equivalences. */
1003 XSETCDR (elt
, XCDR (tem
));
1008 /* It may be an old fomat menu item.
1009 Skip the optional menu string. */
1010 if (STRINGP (XCAR (tem
)))
1012 /* Copy the cell, since copy-alist didn't go this deep. */
1013 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1015 /* Also skip the optional menu help string. */
1016 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1018 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1022 /* There may also be a list that caches key equivalences.
1023 Just delete it for the new keymap. */
1025 && CONSP (XCAR (tem
))
1026 && (NILP (XCAR (XCAR (tem
)))
1027 || VECTORP (XCAR (XCAR (tem
)))))
1029 XSETCDR (elt
, XCDR (tem
));
1032 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1033 XSETCDR (elt
, Fcopy_keymap (tem
));
1035 else if (EQ (XCAR (tem
), Qkeymap
))
1036 res
= Fcopy_keymap (elt
);
1042 copy_keymap_1 (chartable
, idx
, elt
)
1043 Lisp_Object chartable
, idx
, elt
;
1045 Faset (chartable
, idx
, copy_keymap_item (elt
));
1048 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1049 doc
: /* Return a copy of the keymap KEYMAP.
1050 The copy starts out with the same definitions of KEYMAP,
1051 but changing either the copy or KEYMAP does not affect the other.
1052 Any key definitions that are subkeymaps are recursively copied.
1053 However, a key definition which is a symbol whose definition is a keymap
1058 register Lisp_Object copy
, tail
;
1059 keymap
= get_keymap (keymap
, 1, 0);
1060 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1061 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1063 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1065 Lisp_Object elt
= XCAR (keymap
);
1066 if (CHAR_TABLE_P (elt
))
1068 Lisp_Object indices
[3];
1069 elt
= Fcopy_sequence (elt
);
1070 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, elt
, 0, indices
);
1072 else if (VECTORP (elt
))
1075 elt
= Fcopy_sequence (elt
);
1076 for (i
= 0; i
< ASIZE (elt
); i
++)
1077 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1079 else if (CONSP (elt
))
1080 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1081 XSETCDR (tail
, Fcons (elt
, Qnil
));
1083 keymap
= XCDR (keymap
);
1085 XSETCDR (tail
, keymap
);
1089 /* Simple Keymap mutators and accessors. */
1091 /* GC is possible in this function if it autoloads a keymap. */
1093 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1094 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1097 KEY is a string or a vector of symbols and characters meaning a
1098 sequence of keystrokes and events. Non-ASCII characters with codes
1099 above 127 (such as ISO Latin-1) can be included if you use a vector.
1100 Using [t] for KEY creates a default definition, which applies to any
1101 event type that has no other definition in this keymap.
1103 DEF is anything that can be a key's definition:
1104 nil (means key is undefined in this keymap),
1105 a command (a Lisp function suitable for interactive calling),
1106 a string (treated as a keyboard macro),
1107 a keymap (to define a prefix key),
1108 a symbol (when the key is looked up, the symbol will stand for its
1109 function definition, which should at that time be one of the above,
1110 or another symbol whose function definition is used, etc.),
1111 a cons (STRING . DEFN), meaning that DEFN is the definition
1112 (DEFN should be a valid definition in its own right),
1113 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1115 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1116 binding is altered. If there is no binding for KEY, the new pair
1117 binding KEY to DEF is added at the front of KEYMAP. */)
1124 register Lisp_Object c
;
1125 register Lisp_Object cmd
;
1129 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1131 GCPRO3 (keymap
, key
, def
);
1132 keymap
= get_keymap (keymap
, 1, 1);
1134 if (!VECTORP (key
) && !STRINGP (key
))
1135 key
= wrong_type_argument (Qarrayp
, key
);
1137 length
= XFASTINT (Flength (key
));
1139 RETURN_UNGCPRO (Qnil
);
1141 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1142 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1144 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1149 c
= Faref (key
, make_number (idx
));
1151 if (CONSP (c
) && lucid_event_type_list_p (c
))
1152 c
= Fevent_convert_list (c
);
1155 silly_event_symbol_error (c
);
1158 && (XINT (c
) & meta_bit
)
1161 c
= meta_prefix_char
;
1167 XSETINT (c
, XINT (c
) & ~meta_bit
);
1173 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1174 error ("Key sequence contains invalid event");
1177 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1179 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1181 /* If this key is undefined, make it a prefix. */
1183 cmd
= define_as_prefix (keymap
, c
);
1185 keymap
= get_keymap (cmd
, 0, 1);
1186 if (!CONSP (keymap
))
1187 /* We must use Fkey_description rather than just passing key to
1188 error; key might be a vector, not a string. */
1189 error ("Key sequence %s uses invalid prefix characters",
1190 SDATA (Fkey_description (key
, Qnil
)));
1194 /* This function may GC (it calls Fkey_binding). */
1196 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1197 doc
: /* Return the remapping for command COMMAND in current keymaps.
1198 Returns nil if COMMAND is not remapped (or not a symbol). */)
1200 Lisp_Object command
;
1202 if (!SYMBOLP (command
))
1205 ASET (command_remapping_vector
, 1, command
);
1206 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1209 /* Value is number if KEY is too long; nil if valid but has no definition. */
1210 /* GC is possible in this function if it autoloads a keymap. */
1212 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1213 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1214 nil means undefined. See doc of `define-key' for kinds of definitions.
1216 A number as value means KEY is "too long";
1217 that is, characters or symbols in it except for the last one
1218 fail to be a valid sequence of prefix characters in KEYMAP.
1219 The number is how many characters at the front of KEY
1220 it takes to reach a non-prefix command.
1222 Normally, `lookup-key' ignores bindings for t, which act as default
1223 bindings, used when nothing else in the keymap applies; this makes it
1224 usable as a general function for probing keymaps. However, if the
1225 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1226 recognize the default bindings, just as `read-key-sequence' does. */)
1227 (keymap
, key
, accept_default
)
1230 Lisp_Object accept_default
;
1233 register Lisp_Object cmd
;
1234 register Lisp_Object c
;
1236 int t_ok
= !NILP (accept_default
);
1237 struct gcpro gcpro1
, gcpro2
;
1239 GCPRO2 (keymap
, key
);
1240 keymap
= get_keymap (keymap
, 1, 1);
1242 if (!VECTORP (key
) && !STRINGP (key
))
1243 key
= wrong_type_argument (Qarrayp
, key
);
1245 length
= XFASTINT (Flength (key
));
1247 RETURN_UNGCPRO (keymap
);
1252 c
= Faref (key
, make_number (idx
++));
1254 if (CONSP (c
) && lucid_event_type_list_p (c
))
1255 c
= Fevent_convert_list (c
);
1257 /* Turn the 8th bit of string chars into a meta modifier. */
1258 if (INTEGERP (c
) && XINT (c
) & 0x80 && STRINGP (key
))
1259 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1261 /* Allow string since binding for `menu-bar-select-buffer'
1262 includes the buffer name in the key sequence. */
1263 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1264 error ("Key sequence contains invalid event");
1266 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1268 RETURN_UNGCPRO (cmd
);
1270 keymap
= get_keymap (cmd
, 0, 1);
1271 if (!CONSP (keymap
))
1272 RETURN_UNGCPRO (make_number (idx
));
1278 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1279 Assume that currently it does not define C at all.
1280 Return the keymap. */
1283 define_as_prefix (keymap
, c
)
1284 Lisp_Object keymap
, c
;
1288 cmd
= Fmake_sparse_keymap (Qnil
);
1289 /* If this key is defined as a prefix in an inherited keymap,
1290 make it a prefix in this map, and make its definition
1291 inherit the other prefix definition. */
1292 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1293 store_in_keymap (keymap
, c
, cmd
);
1298 /* Append a key to the end of a key sequence. We always make a vector. */
1301 append_key (key_sequence
, key
)
1302 Lisp_Object key_sequence
, key
;
1304 Lisp_Object args
[2];
1306 args
[0] = key_sequence
;
1308 args
[1] = Fcons (key
, Qnil
);
1309 return Fvconcat (2, args
);
1312 /* Given a event type C which is a symbol,
1313 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1316 silly_event_symbol_error (c
)
1319 Lisp_Object parsed
, base
, name
, assoc
;
1322 parsed
= parse_modifiers (c
);
1323 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1324 base
= XCAR (parsed
);
1325 name
= Fsymbol_name (base
);
1326 /* This alist includes elements such as ("RET" . "\\r"). */
1327 assoc
= Fassoc (name
, exclude_keys
);
1331 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1333 Lisp_Object keystring
;
1334 if (modifiers
& alt_modifier
)
1335 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1336 if (modifiers
& ctrl_modifier
)
1337 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1338 if (modifiers
& hyper_modifier
)
1339 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1340 if (modifiers
& meta_modifier
)
1341 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1342 if (modifiers
& shift_modifier
)
1343 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1344 if (modifiers
& super_modifier
)
1345 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1348 c
= reorder_modifiers (c
);
1349 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1351 error ((modifiers
& ~meta_modifier
1352 ? "To bind the key %s, use [?%s], not [%s]"
1353 : "To bind the key %s, use \"%s\", not [%s]"),
1354 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1355 SDATA (SYMBOL_NAME (c
)));
1359 /* Global, local, and minor mode keymap stuff. */
1361 /* We can't put these variables inside current_minor_maps, since under
1362 some systems, static gets macro-defined to be the empty string.
1364 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1365 static int cmm_size
= 0;
1367 /* Error handler used in current_minor_maps. */
1369 current_minor_maps_error ()
1374 /* Store a pointer to an array of the keymaps of the currently active
1375 minor modes in *buf, and return the number of maps it contains.
1377 This function always returns a pointer to the same buffer, and may
1378 free or reallocate it, so if you want to keep it for a long time or
1379 hand it out to lisp code, copy it. This procedure will be called
1380 for every key sequence read, so the nice lispy approach (return a
1381 new assoclist, list, what have you) for each invocation would
1382 result in a lot of consing over time.
1384 If we used xrealloc/xmalloc and ran out of memory, they would throw
1385 back to the command loop, which would try to read a key sequence,
1386 which would call this function again, resulting in an infinite
1387 loop. Instead, we'll use realloc/malloc and silently truncate the
1388 list, let the key sequence be read, and hope some other piece of
1389 code signals the error. */
1391 current_minor_maps (modeptr
, mapptr
)
1392 Lisp_Object
**modeptr
, **mapptr
;
1395 int list_number
= 0;
1396 Lisp_Object alist
, assoc
, var
, val
;
1397 Lisp_Object emulation_alists
;
1398 Lisp_Object lists
[2];
1400 emulation_alists
= Vemulation_mode_map_alists
;
1401 lists
[0] = Vminor_mode_overriding_map_alist
;
1402 lists
[1] = Vminor_mode_map_alist
;
1404 for (list_number
= 0; list_number
< 2; list_number
++)
1406 if (CONSP (emulation_alists
))
1408 alist
= XCAR (emulation_alists
);
1409 emulation_alists
= XCDR (emulation_alists
);
1410 if (SYMBOLP (alist
))
1411 alist
= find_symbol_value (alist
);
1415 alist
= lists
[list_number
];
1417 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1418 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1419 && (var
= XCAR (assoc
), SYMBOLP (var
))
1420 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1425 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1426 and also an entry in Vminor_mode_map_alist,
1427 ignore the latter. */
1428 if (list_number
== 1)
1430 val
= assq_no_quit (var
, lists
[0]);
1437 int newsize
, allocsize
;
1438 Lisp_Object
*newmodes
, *newmaps
;
1440 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1441 allocsize
= newsize
* sizeof *newmodes
;
1443 /* Use malloc here. See the comment above this function.
1444 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1446 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1451 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1454 cmm_modes
= newmodes
;
1457 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1462 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1469 if (newmodes
== NULL
|| newmaps
== NULL
)
1474 /* Get the keymap definition--or nil if it is not defined. */
1475 temp
= internal_condition_case_1 (Findirect_function
,
1477 Qerror
, current_minor_maps_error
);
1481 cmm_maps
[i
] = temp
;
1487 if (modeptr
) *modeptr
= cmm_modes
;
1488 if (mapptr
) *mapptr
= cmm_maps
;
1492 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1494 doc
: /* Return a list of the currently active keymaps.
1495 OLP if non-nil indicates that we should obey `overriding-local-map' and
1496 `overriding-terminal-local-map'. */)
1500 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1504 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1505 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1506 /* The doc said that overriding-terminal-local-map should
1507 override overriding-local-map. The code used them both,
1508 but it seems clearer to use just one. rms, jan 2005. */
1509 else if (!NILP (Voverriding_local_map
))
1510 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1512 if (NILP (XCDR (keymaps
)))
1518 /* This usually returns the buffer's local map,
1519 but that can be overridden by a `local-map' property. */
1520 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1522 keymaps
= Fcons (local
, keymaps
);
1524 /* Now put all the minor mode keymaps on the list. */
1525 nmaps
= current_minor_maps (0, &maps
);
1527 for (i
= --nmaps
; i
>= 0; i
--)
1528 if (!NILP (maps
[i
]))
1529 keymaps
= Fcons (maps
[i
], keymaps
);
1531 /* This returns nil unless there is a `keymap' property. */
1532 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1534 keymaps
= Fcons (local
, keymaps
);
1540 /* GC is possible in this function if it autoloads a keymap. */
1542 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1543 doc
: /* Return the binding for command KEY in current keymaps.
1544 KEY is a string or vector, a sequence of keystrokes.
1545 The binding is probably a symbol with a function definition.
1547 Normally, `key-binding' ignores bindings for t, which act as default
1548 bindings, used when nothing else in the keymap applies; this makes it
1549 usable as a general function for probing keymaps. However, if the
1550 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1551 recognize the default bindings, just as `read-key-sequence' does.
1553 Like the normal command loop, `key-binding' will remap the command
1554 resulting from looking up KEY by looking up the command in the
1555 current keymaps. However, if the optional third argument NO-REMAP
1556 is non-nil, `key-binding' returns the unmapped command. */)
1557 (key
, accept_default
, no_remap
)
1558 Lisp_Object key
, accept_default
, no_remap
;
1560 Lisp_Object
*maps
, value
;
1562 struct gcpro gcpro1
;
1566 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1568 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1569 key
, accept_default
);
1570 if (! NILP (value
) && !INTEGERP (value
))
1573 else if (!NILP (Voverriding_local_map
))
1575 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1576 if (! NILP (value
) && !INTEGERP (value
))
1583 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1586 value
= Flookup_key (local
, key
, accept_default
);
1587 if (! NILP (value
) && !INTEGERP (value
))
1591 nmaps
= current_minor_maps (0, &maps
);
1592 /* Note that all these maps are GCPRO'd
1593 in the places where we found them. */
1595 for (i
= 0; i
< nmaps
; i
++)
1596 if (! NILP (maps
[i
]))
1598 value
= Flookup_key (maps
[i
], key
, accept_default
);
1599 if (! NILP (value
) && !INTEGERP (value
))
1603 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1606 value
= Flookup_key (local
, key
, accept_default
);
1607 if (! NILP (value
) && !INTEGERP (value
))
1612 value
= Flookup_key (current_global_map
, key
, accept_default
);
1616 if (NILP (value
) || INTEGERP (value
))
1619 /* If the result of the ordinary keymap lookup is an interactive
1620 command, look for a key binding (ie. remapping) for that command. */
1622 if (NILP (no_remap
) && SYMBOLP (value
))
1625 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1632 /* GC is possible in this function if it autoloads a keymap. */
1634 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1635 doc
: /* Return the binding for command KEYS in current local keymap only.
1636 KEYS is a string or vector, a sequence of keystrokes.
1637 The binding is probably a symbol with a function definition.
1639 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1640 bindings; see the description of `lookup-key' for more details about this. */)
1641 (keys
, accept_default
)
1642 Lisp_Object keys
, accept_default
;
1644 register Lisp_Object map
;
1645 map
= current_buffer
->keymap
;
1648 return Flookup_key (map
, keys
, accept_default
);
1651 /* GC is possible in this function if it autoloads a keymap. */
1653 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1654 doc
: /* Return the binding for command KEYS in current global keymap only.
1655 KEYS is a string or vector, a sequence of keystrokes.
1656 The binding is probably a symbol with a function definition.
1657 This function's return values are the same as those of `lookup-key'
1660 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1661 bindings; see the description of `lookup-key' for more details about this. */)
1662 (keys
, accept_default
)
1663 Lisp_Object keys
, accept_default
;
1665 return Flookup_key (current_global_map
, keys
, accept_default
);
1668 /* GC is possible in this function if it autoloads a keymap. */
1670 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1671 doc
: /* Find the visible minor mode bindings of KEY.
1672 Return an alist of pairs (MODENAME . BINDING), where MODENAME is
1673 the symbol which names the minor mode binding KEY, and BINDING is
1674 KEY's definition in that mode. In particular, if KEY has no
1675 minor-mode bindings, return nil. If the first binding is a
1676 non-prefix, all subsequent bindings will be omitted, since they would
1677 be ignored. Similarly, the list doesn't include non-prefix bindings
1678 that come after prefix bindings.
1680 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1681 bindings; see the description of `lookup-key' for more details about this. */)
1682 (key
, accept_default
)
1683 Lisp_Object key
, accept_default
;
1685 Lisp_Object
*modes
, *maps
;
1687 Lisp_Object binding
;
1689 struct gcpro gcpro1
, gcpro2
;
1691 nmaps
= current_minor_maps (&modes
, &maps
);
1692 /* Note that all these maps are GCPRO'd
1693 in the places where we found them. */
1696 GCPRO2 (key
, binding
);
1698 for (i
= j
= 0; i
< nmaps
; i
++)
1700 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1701 && !INTEGERP (binding
))
1703 if (KEYMAPP (binding
))
1704 maps
[j
++] = Fcons (modes
[i
], binding
);
1706 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1710 return Flist (j
, maps
);
1713 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1714 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1715 A new sparse keymap is stored as COMMAND's function definition and its value.
1716 If a second optional argument MAPVAR is given, the map is stored as
1717 its value instead of as COMMAND's value; but COMMAND is still defined
1719 The third optional argument NAME, if given, supplies a menu name
1720 string for the map. This is required to use the keymap as a menu.
1721 This function returns COMMAND. */)
1722 (command
, mapvar
, name
)
1723 Lisp_Object command
, mapvar
, name
;
1726 map
= Fmake_sparse_keymap (name
);
1727 Ffset (command
, map
);
1731 Fset (command
, map
);
1735 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1736 doc
: /* Select KEYMAP as the global keymap. */)
1740 keymap
= get_keymap (keymap
, 1, 1);
1741 current_global_map
= keymap
;
1746 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1747 doc
: /* Select KEYMAP as the local keymap.
1748 If KEYMAP is nil, that means no local keymap. */)
1753 keymap
= get_keymap (keymap
, 1, 1);
1755 current_buffer
->keymap
= keymap
;
1760 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1761 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1764 return current_buffer
->keymap
;
1767 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1768 doc
: /* Return the current global keymap. */)
1771 return current_global_map
;
1774 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1775 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1779 int nmaps
= current_minor_maps (0, &maps
);
1781 return Flist (nmaps
, maps
);
1784 /* Help functions for describing and documenting keymaps. */
1788 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1789 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1790 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1794 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1798 /* Look for and break cycles. */
1799 while (!NILP (tem
= Frassq (cmd
, maps
)))
1801 Lisp_Object prefix
= XCAR (tem
);
1802 int lim
= XINT (Flength (XCAR (tem
)));
1803 if (lim
<= XINT (Flength (thisseq
)))
1804 { /* This keymap was already seen with a smaller prefix. */
1806 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1807 Faref (thisseq
, make_number (i
))))
1810 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1813 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1814 but maybe `cmd' occurs again further down in `maps', so keep
1816 maps
= XCDR (Fmemq (tem
, maps
));
1819 /* If the last key in thisseq is meta-prefix-char,
1820 turn it into a meta-ized keystroke. We know
1821 that the event we're about to append is an
1822 ascii keystroke since we're processing a
1826 int meta_bit
= meta_modifier
;
1827 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1828 tem
= Fcopy_sequence (thisseq
);
1830 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1832 /* This new sequence is the same length as
1833 thisseq, so stick it in the list right
1836 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1840 tem
= append_key (thisseq
, key
);
1841 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1846 accessible_keymaps_char_table (args
, index
, cmd
)
1847 Lisp_Object args
, index
, cmd
;
1849 accessible_keymaps_1 (index
, cmd
,
1853 XINT (XCDR (XCAR (args
))));
1856 /* This function cannot GC. */
1858 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1860 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1861 Returns a list of elements of the form (KEYS . MAP), where the sequence
1862 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1863 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1864 An optional argument PREFIX, if non-nil, should be a key sequence;
1865 then the value includes only maps for prefixes that start with PREFIX. */)
1867 Lisp_Object keymap
, prefix
;
1869 Lisp_Object maps
, tail
;
1872 /* no need for gcpro because we don't autoload any keymaps. */
1875 prefixlen
= XINT (Flength (prefix
));
1879 /* If a prefix was specified, start with the keymap (if any) for
1880 that prefix, so we don't waste time considering other prefixes. */
1882 tem
= Flookup_key (keymap
, prefix
, Qt
);
1883 /* Flookup_key may give us nil, or a number,
1884 if the prefix is not defined in this particular map.
1885 It might even give us a list that isn't a keymap. */
1886 tem
= get_keymap (tem
, 0, 0);
1889 /* Convert PREFIX to a vector now, so that later on
1890 we don't have to deal with the possibility of a string. */
1891 if (STRINGP (prefix
))
1896 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1897 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1901 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1902 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1903 c
^= 0200 | meta_modifier
;
1904 ASET (copy
, i_before
, make_number (c
));
1908 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1914 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1915 get_keymap (keymap
, 1, 0)),
1918 /* For each map in the list maps,
1919 look at any other maps it points to,
1920 and stick them at the end if they are not already in the list.
1922 This is a breadth-first traversal, where tail is the queue of
1923 nodes, and maps accumulates a list of all nodes visited. */
1925 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1927 register Lisp_Object thisseq
, thismap
;
1929 /* Does the current sequence end in the meta-prefix-char? */
1932 thisseq
= Fcar (Fcar (tail
));
1933 thismap
= Fcdr (Fcar (tail
));
1934 last
= make_number (XINT (Flength (thisseq
)) - 1);
1935 is_metized
= (XINT (last
) >= 0
1936 /* Don't metize the last char of PREFIX. */
1937 && XINT (last
) >= prefixlen
1938 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1940 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1944 elt
= XCAR (thismap
);
1948 if (CHAR_TABLE_P (elt
))
1950 Lisp_Object indices
[3];
1952 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
1953 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1954 Fcons (tail
, thisseq
)),
1957 else if (VECTORP (elt
))
1961 /* Vector keymap. Scan all the elements. */
1962 for (i
= 0; i
< ASIZE (elt
); i
++)
1963 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1964 maps
, tail
, thisseq
, is_metized
);
1967 else if (CONSP (elt
))
1968 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1969 maps
, tail
, thisseq
,
1970 is_metized
&& INTEGERP (XCAR (elt
)));
1978 Lisp_Object Qsingle_key_description
, Qkey_description
;
1980 /* This function cannot GC. */
1982 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
1983 doc
: /* Return a pretty description of key-sequence KEYS.
1984 Optional arg PREFIX is the sequence of keys leading up to KEYS.
1985 Control characters turn into "C-foo" sequences, meta into "M-foo",
1986 spaces are put between sequence elements, etc. */)
1988 Lisp_Object keys
, prefix
;
1993 int size
= XINT (Flength (keys
));
1995 Lisp_Object sep
= build_string (" ");
2000 size
+= XINT (Flength (prefix
));
2002 /* This has one extra element at the end that we don't pass to Fconcat. */
2003 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2005 /* In effect, this computes
2006 (mapconcat 'single-key-description keys " ")
2007 but we shouldn't use mapconcat because it can do GC. */
2011 list
= prefix
, prefix
= Qnil
;
2012 else if (!NILP (keys
))
2013 list
= keys
, keys
= Qnil
;
2018 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2022 return empty_string
;
2023 return Fconcat (len
- 1, args
);
2027 size
= SCHARS (list
);
2028 else if (VECTORP (list
))
2029 size
= XVECTOR (list
)->size
;
2030 else if (CONSP (list
))
2031 size
= XINT (Flength (list
));
2033 wrong_type_argument (Qarrayp
, list
);
2042 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2043 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2044 c
^= 0200 | meta_modifier
;
2045 XSETFASTINT (key
, c
);
2047 else if (VECTORP (list
))
2049 key
= AREF (list
, i
++);
2061 || EQ (key
, meta_prefix_char
)
2062 || (XINT (key
) & meta_modifier
))
2064 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2066 if (EQ (key
, meta_prefix_char
))
2070 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2073 else if (EQ (key
, meta_prefix_char
))
2078 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2086 push_key_description (c
, p
, force_multibyte
)
2087 register unsigned int c
;
2089 int force_multibyte
;
2093 /* Clear all the meaningless bits above the meta bit. */
2094 c
&= meta_modifier
| ~ - meta_modifier
;
2095 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2096 | meta_modifier
| shift_modifier
| super_modifier
);
2098 if (c
& alt_modifier
)
2104 if ((c
& ctrl_modifier
) != 0
2105 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2109 c
&= ~ctrl_modifier
;
2111 if (c
& hyper_modifier
)
2115 c
-= hyper_modifier
;
2117 if (c
& meta_modifier
)
2123 if (c
& shift_modifier
)
2127 c
-= shift_modifier
;
2129 if (c
& super_modifier
)
2133 c
-= super_modifier
;
2149 else if (c
== Ctl ('M'))
2157 /* `C-' already added above. */
2158 if (c
> 0 && c
<= Ctl ('Z'))
2177 || (NILP (current_buffer
->enable_multibyte_characters
)
2178 && SINGLE_BYTE_CHAR_P (c
)
2179 && !force_multibyte
))
2185 int valid_p
= SINGLE_BYTE_CHAR_P (c
) || char_valid_p (c
, 0);
2187 if (force_multibyte
&& valid_p
)
2189 if (SINGLE_BYTE_CHAR_P (c
))
2190 c
= unibyte_char_to_multibyte (c
);
2191 p
+= CHAR_STRING (c
, p
);
2193 else if (NILP (current_buffer
->enable_multibyte_characters
)
2198 /* The biggest character code uses 19 bits. */
2199 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2201 if (c
>= (1 << bit_offset
))
2202 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2206 p
+= CHAR_STRING (c
, p
);
2212 /* This function cannot GC. */
2214 DEFUN ("single-key-description", Fsingle_key_description
,
2215 Ssingle_key_description
, 1, 2, 0,
2216 doc
: /* Return a pretty description of command character KEY.
2217 Control characters turn into C-whatever, etc.
2218 Optional argument NO-ANGLES non-nil means don't put angle brackets
2219 around function keys and event symbols. */)
2221 Lisp_Object key
, no_angles
;
2223 if (CONSP (key
) && lucid_event_type_list_p (key
))
2224 key
= Fevent_convert_list (key
);
2226 key
= EVENT_HEAD (key
);
2228 if (INTEGERP (key
)) /* Normal character */
2230 unsigned int charset
, c1
, c2
;
2231 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2233 if (SINGLE_BYTE_CHAR_P (without_bits
))
2236 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2239 && CHARSET_DEFINED_P (charset
)
2240 && ((c1
>= 0 && c1
< 32)
2241 || (c2
>= 0 && c2
< 32)))
2243 /* Handle a generic character. */
2245 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
2246 CHECK_STRING (name
);
2247 return concat2 (build_string ("Character set "), name
);
2251 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2255 end
= push_key_description (XUINT (key
), tem
, 1);
2257 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2258 if (nchars
== nbytes
)
2261 string
= build_string (tem
);
2264 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2268 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2270 if (NILP (no_angles
))
2273 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2274 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2275 return build_string (buffer
);
2278 return Fsymbol_name (key
);
2280 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2281 return Fcopy_sequence (key
);
2283 error ("KEY must be an integer, cons, symbol, or string");
2288 push_text_char_description (c
, p
)
2289 register unsigned int c
;
2301 *p
++ = c
+ 64; /* 'A' - 1 */
2313 /* This function cannot GC. */
2315 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2316 doc
: /* Return a pretty description of file-character CHARACTER.
2317 Control characters turn into "^char", etc. This differs from
2318 `single-key-description' which turns them into "C-char".
2319 Also, this function recognizes the 2**7 bit as the Meta character,
2320 whereas `single-key-description' uses the 2**27 bit for Meta.
2321 See Info node `(elisp)Describing Characters' for examples. */)
2323 Lisp_Object character
;
2325 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2326 unsigned char str
[6];
2329 CHECK_NUMBER (character
);
2331 c
= XINT (character
);
2332 if (!SINGLE_BYTE_CHAR_P (c
))
2334 int len
= CHAR_STRING (c
, str
);
2336 return make_multibyte_string (str
, 1, len
);
2339 *push_text_char_description (c
& 0377, str
) = 0;
2341 return build_string (str
);
2344 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2347 ascii_sequence_p (seq
)
2351 int len
= XINT (Flength (seq
));
2353 for (i
= 0; i
< len
; i
++)
2355 Lisp_Object ii
, elt
;
2357 XSETFASTINT (ii
, i
);
2358 elt
= Faref (seq
, ii
);
2361 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2369 /* where-is - finding a command in a set of keymaps. */
2371 static Lisp_Object
where_is_internal ();
2372 static Lisp_Object
where_is_internal_1 ();
2373 static void where_is_internal_2 ();
2375 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2376 Returns the first non-nil binding found in any of those maps. */
2379 shadow_lookup (shadow
, key
, flag
)
2380 Lisp_Object shadow
, key
, flag
;
2382 Lisp_Object tail
, value
;
2384 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2386 value
= Flookup_key (XCAR (tail
), key
, flag
);
2387 if (NATNUMP (value
))
2389 value
= Flookup_key (XCAR (tail
),
2390 Fsubstring (key
, make_number (0), value
), flag
);
2394 else if (!NILP (value
))
2400 static Lisp_Object Vmouse_events
;
2402 /* This function can GC if Flookup_key autoloads any keymaps. */
2405 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2406 Lisp_Object definition
, keymaps
;
2407 Lisp_Object firstonly
, noindirect
, no_remap
;
2409 Lisp_Object maps
= Qnil
;
2410 Lisp_Object found
, sequences
;
2411 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2412 /* 1 means ignore all menu bindings entirely. */
2413 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2415 /* If this command is remapped, then it has no key bindings
2417 if (NILP (no_remap
) && SYMBOLP (definition
))
2420 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2425 while (CONSP (found
))
2429 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2430 found
= XCDR (found
);
2433 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2437 for (; !NILP (maps
); maps
= Fcdr (maps
))
2439 /* Key sequence to reach map, and the map that it reaches */
2440 register Lisp_Object
this, map
, tem
;
2442 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2443 [M-CHAR] sequences, check if last character of the sequence
2444 is the meta-prefix char. */
2448 this = Fcar (Fcar (maps
));
2449 map
= Fcdr (Fcar (maps
));
2450 last
= make_number (XINT (Flength (this)) - 1);
2451 last_is_meta
= (XINT (last
) >= 0
2452 && EQ (Faref (this, last
), meta_prefix_char
));
2454 /* if (nomenus && !ascii_sequence_p (this)) */
2455 if (nomenus
&& XINT (last
) >= 0
2456 && SYMBOLP (tem
= Faref (this, make_number (0)))
2457 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2458 /* If no menu entries should be returned, skip over the
2459 keymaps bound to `menu-bar' and `tool-bar' and other
2460 non-ascii prefixes like `C-down-mouse-2'. */
2467 /* Because the code we want to run on each binding is rather
2468 large, we don't want to have two separate loop bodies for
2469 sparse keymap bindings and tables; we want to iterate one
2470 loop body over both keymap and vector bindings.
2472 For this reason, if Fcar (map) is a vector, we don't
2473 advance map to the next element until i indicates that we
2474 have finished off the vector. */
2475 Lisp_Object elt
, key
, binding
;
2483 /* Set key and binding to the current key and binding, and
2484 advance map and i to the next binding. */
2487 Lisp_Object sequence
;
2489 /* In a vector, look at each element. */
2490 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2492 binding
= AREF (elt
, i
);
2493 XSETFASTINT (key
, i
);
2494 sequence
= where_is_internal_1 (binding
, key
, definition
,
2496 last
, nomenus
, last_is_meta
);
2497 if (!NILP (sequence
))
2498 sequences
= Fcons (sequence
, sequences
);
2501 else if (CHAR_TABLE_P (elt
))
2503 Lisp_Object indices
[3];
2506 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2507 Qnil
), /* Result accumulator. */
2508 Fcons (Fcons (this, last
),
2509 Fcons (make_number (nomenus
),
2510 make_number (last_is_meta
))));
2511 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2513 sequences
= XCDR (XCAR (args
));
2515 else if (CONSP (elt
))
2517 Lisp_Object sequence
;
2520 binding
= XCDR (elt
);
2522 sequence
= where_is_internal_1 (binding
, key
, definition
,
2524 last
, nomenus
, last_is_meta
);
2525 if (!NILP (sequence
))
2526 sequences
= Fcons (sequence
, sequences
);
2530 while (!NILP (sequences
))
2532 Lisp_Object sequence
, remapped
, function
;
2534 sequence
= XCAR (sequences
);
2535 sequences
= XCDR (sequences
);
2537 /* If the current sequence is a command remapping with
2538 format [remap COMMAND], find the key sequences
2539 which run COMMAND, and use those sequences instead. */
2542 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2543 && EQ (AREF (sequence
, 0), Qremap
)
2544 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2546 Lisp_Object remapped1
;
2548 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2549 if (CONSP (remapped1
))
2551 /* Verify that this key binding actually maps to the
2552 remapped command (see below). */
2553 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2555 sequence
= XCAR (remapped1
);
2556 remapped
= XCDR (remapped1
);
2557 goto record_sequence
;
2561 /* Verify that this key binding is not shadowed by another
2562 binding for the same key, before we say it exists.
2564 Mechanism: look for local definition of this key and if
2565 it is defined and does not match what we found then
2568 Either nil or number as value from Flookup_key
2570 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2574 /* Don't annoy user with strings from a menu such as
2575 Select Paste. Change them all to "(any string)",
2576 so that there seems to be only one menu item
2578 if (! NILP (sequence
))
2581 tem
= Faref (sequence
, make_number (XVECTOR (sequence
)->size
- 1));
2583 Faset (sequence
, make_number (XVECTOR (sequence
)->size
- 1),
2584 build_string ("(any string)"));
2587 /* It is a true unshadowed match. Record it, unless it's already
2588 been seen (as could happen when inheriting keymaps). */
2589 if (NILP (Fmember (sequence
, found
)))
2590 found
= Fcons (sequence
, found
);
2592 /* If firstonly is Qnon_ascii, then we can return the first
2593 binding we find. If firstonly is not Qnon_ascii but not
2594 nil, then we should return the first ascii-only binding
2596 if (EQ (firstonly
, Qnon_ascii
))
2597 RETURN_UNGCPRO (sequence
);
2598 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2599 RETURN_UNGCPRO (sequence
);
2601 if (CONSP (remapped
))
2603 sequence
= XCAR (remapped
);
2604 remapped
= XCDR (remapped
);
2605 goto record_sequence
;
2613 found
= Fnreverse (found
);
2615 /* firstonly may have been t, but we may have gone all the way through
2616 the keymaps without finding an all-ASCII key sequence. So just
2617 return the best we could find. */
2618 if (!NILP (firstonly
))
2619 return Fcar (found
);
2624 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2625 doc
: /* Return list of keys that invoke DEFINITION.
2626 If KEYMAP is a keymap, search only KEYMAP and the global keymap.
2627 If KEYMAP is nil, search all the currently active keymaps.
2628 If KEYMAP is a list of keymaps, search only those keymaps.
2630 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2631 rather than a list of all possible key sequences.
2632 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2633 no matter what it is.
2634 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters
2635 \(or their meta variants) and entirely reject menu bindings.
2637 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2638 to other keymaps or slots. This makes it possible to search for an
2639 indirect definition itself.
2641 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2642 that invoke a command which is remapped to DEFINITION, but include the
2643 remapped command in the returned list. */)
2644 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2645 Lisp_Object definition
, keymap
;
2646 Lisp_Object firstonly
, noindirect
, no_remap
;
2648 Lisp_Object sequences
, keymaps
;
2649 /* 1 means ignore all menu bindings entirely. */
2650 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2653 /* Find the relevant keymaps. */
2654 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2656 else if (!NILP (keymap
))
2657 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2659 keymaps
= Fcurrent_active_maps (Qnil
);
2661 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2662 We don't really need to check `keymap'. */
2663 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2667 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2669 /* Check heuristic-consistency of the cache. */
2670 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2671 where_is_cache
= Qnil
;
2673 if (NILP (where_is_cache
))
2675 /* We need to create the cache. */
2676 Lisp_Object args
[2];
2677 where_is_cache
= Fmake_hash_table (0, args
);
2678 where_is_cache_keymaps
= Qt
;
2680 /* Fill in the cache. */
2681 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2682 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2685 where_is_cache_keymaps
= keymaps
;
2688 /* We want to process definitions from the last to the first.
2689 Instead of consing, copy definitions to a vector and step
2690 over that vector. */
2691 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2692 n
= XINT (Flength (sequences
));
2693 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2694 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2695 defns
[i
++] = XCAR (sequences
);
2697 /* Verify that the key bindings are not shadowed. Note that
2698 the following can GC. */
2699 GCPRO2 (definition
, keymaps
);
2702 for (i
= n
- 1; i
>= 0; --i
)
2703 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2705 if (ascii_sequence_p (defns
[i
]))
2711 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2716 /* Kill the cache so that where_is_internal_1 doesn't think
2717 we're filling it up. */
2718 where_is_cache
= Qnil
;
2719 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2725 /* This is the function that Fwhere_is_internal calls using map_char_table.
2727 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2729 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2730 Since map_char_table doesn't really use the return value from this function,
2731 we the result append to RESULT, the slot in ARGS.
2733 This function can GC because it calls where_is_internal_1 which can
2737 where_is_internal_2 (args
, key
, binding
)
2738 Lisp_Object args
, key
, binding
;
2740 Lisp_Object definition
, noindirect
, this, last
;
2741 Lisp_Object result
, sequence
;
2742 int nomenus
, last_is_meta
;
2743 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2745 GCPRO3 (args
, key
, binding
);
2746 result
= XCDR (XCAR (args
));
2747 definition
= XCAR (XCAR (XCAR (args
)));
2748 noindirect
= XCDR (XCAR (XCAR (args
)));
2749 this = XCAR (XCAR (XCDR (args
)));
2750 last
= XCDR (XCAR (XCDR (args
)));
2751 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2752 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2754 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2755 this, last
, nomenus
, last_is_meta
);
2757 if (!NILP (sequence
))
2758 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2764 /* This function can GC because get_keyelt can. */
2767 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2768 nomenus
, last_is_meta
)
2769 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2770 int nomenus
, last_is_meta
;
2772 Lisp_Object sequence
;
2774 /* Search through indirections unless that's not wanted. */
2775 if (NILP (noindirect
))
2776 binding
= get_keyelt (binding
, 0);
2778 /* End this iteration if this element does not match
2781 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2782 || EQ (binding
, definition
)
2783 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2784 /* Doesn't match. */
2787 /* We have found a match. Construct the key sequence where we found it. */
2788 if (INTEGERP (key
) && last_is_meta
)
2790 sequence
= Fcopy_sequence (this);
2791 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2794 sequence
= append_key (this, key
);
2796 if (!NILP (where_is_cache
))
2798 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2799 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2806 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2808 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2809 doc
: /* Insert the list of all defined keys and their definitions.
2810 The list is inserted in the current buffer, while the bindings are
2811 looked up in BUFFER.
2812 The optional argument PREFIX, if non-nil, should be a key sequence;
2813 then we display only bindings that start with that prefix.
2814 The optional argument MENUS, if non-nil, says to mention menu bindings.
2815 \(Ordinarily these are omitted from the output.) */)
2816 (buffer
, prefix
, menus
)
2817 Lisp_Object buffer
, prefix
, menus
;
2819 Lisp_Object outbuf
, shadow
;
2820 int nomenu
= NILP (menus
);
2821 register Lisp_Object start1
;
2822 struct gcpro gcpro1
;
2824 char *alternate_heading
2826 Keyboard translations:\n\n\
2827 You type Translation\n\
2828 -------- -----------\n";
2833 outbuf
= Fcurrent_buffer ();
2835 /* Report on alternates for keys. */
2836 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2839 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2840 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2842 for (c
= 0; c
< translate_len
; c
++)
2843 if (translate
[c
] != c
)
2845 char buf
[KEY_DESCRIPTION_SIZE
];
2848 if (alternate_heading
)
2850 insert_string (alternate_heading
);
2851 alternate_heading
= 0;
2854 bufend
= push_key_description (translate
[c
], buf
, 1);
2855 insert (buf
, bufend
- buf
);
2856 Findent_to (make_number (16), make_number (1));
2857 bufend
= push_key_description (c
, buf
, 1);
2858 insert (buf
, bufend
- buf
);
2862 /* Insert calls signal_after_change which may GC. */
2863 translate
= SDATA (Vkeyboard_translate_table
);
2869 if (!NILP (Vkey_translation_map
))
2870 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2871 "Key translations", nomenu
, 1, 0, 0);
2874 /* Print the (major mode) local map. */
2876 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2877 start1
= current_kboard
->Voverriding_terminal_local_map
;
2878 else if (!NILP (Voverriding_local_map
))
2879 start1
= Voverriding_local_map
;
2883 describe_map_tree (start1
, 1, shadow
, prefix
,
2884 "\f\nOverriding Bindings", nomenu
, 0, 0, 0);
2885 shadow
= Fcons (start1
, shadow
);
2889 /* Print the minor mode and major mode keymaps. */
2891 Lisp_Object
*modes
, *maps
;
2893 /* Temporarily switch to `buffer', so that we can get that buffer's
2894 minor modes correctly. */
2895 Fset_buffer (buffer
);
2897 nmaps
= current_minor_maps (&modes
, &maps
);
2898 Fset_buffer (outbuf
);
2900 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2901 XBUFFER (buffer
), Qkeymap
);
2904 describe_map_tree (start1
, 1, shadow
, prefix
,
2905 "\f\n`keymap' Property Bindings", nomenu
,
2907 shadow
= Fcons (start1
, shadow
);
2910 /* Print the minor mode maps. */
2911 for (i
= 0; i
< nmaps
; i
++)
2913 /* The title for a minor mode keymap
2914 is constructed at run time.
2915 We let describe_map_tree do the actual insertion
2916 because it takes care of other features when doing so. */
2919 if (!SYMBOLP (modes
[i
]))
2922 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2926 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2927 SCHARS (SYMBOL_NAME (modes
[i
])));
2928 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2930 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2931 p
+= sizeof (" Minor Mode Bindings") - 1;
2934 describe_map_tree (maps
[i
], 1, shadow
, prefix
,
2935 title
, nomenu
, 0, 0, 0);
2936 shadow
= Fcons (maps
[i
], shadow
);
2939 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2940 XBUFFER (buffer
), Qlocal_map
);
2943 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2944 describe_map_tree (start1
, 1, shadow
, prefix
,
2945 "\f\nMajor Mode Bindings", nomenu
, 0, 0, 0);
2947 describe_map_tree (start1
, 1, shadow
, prefix
,
2948 "\f\n`local-map' Property Bindings",
2951 shadow
= Fcons (start1
, shadow
);
2955 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2956 "\f\nGlobal Bindings", nomenu
, 0, 1, 0);
2958 /* Print the function-key-map translations under this prefix. */
2959 if (!NILP (Vfunction_key_map
))
2960 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2961 "\f\nFunction key map translations", nomenu
, 1, 0, 0);
2967 /* Insert a description of the key bindings in STARTMAP,
2968 followed by those of all maps reachable through STARTMAP.
2969 If PARTIAL is nonzero, omit certain "uninteresting" commands
2970 (such as `undefined').
2971 If SHADOW is non-nil, it is a list of maps;
2972 don't mention keys which would be shadowed by any of them.
2973 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2974 TITLE, if not 0, is a string to insert at the beginning.
2975 TITLE should not end with a colon or a newline; we supply that.
2976 If NOMENU is not 0, then omit menu-bar commands.
2978 If TRANSL is nonzero, the definitions are actually key translations
2979 so print strings and vectors differently.
2981 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2984 If MENTION_SHADOW is nonzero, then when something is shadowed by SHADOW,
2985 don't omit it; instead, mention it but say it is shadowed. */
2988 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2989 always_title
, mention_shadow
)
2990 Lisp_Object startmap
, shadow
, prefix
;
2998 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2999 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3006 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
3009 GCPRO3 (maps
, seen
, sub_shadows
);
3015 /* Delete from MAPS each element that is for the menu bar. */
3016 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
3018 Lisp_Object elt
, prefix
, tem
;
3021 prefix
= Fcar (elt
);
3022 if (XVECTOR (prefix
)->size
>= 1)
3024 tem
= Faref (prefix
, make_number (0));
3025 if (EQ (tem
, Qmenu_bar
))
3026 maps
= Fdelq (elt
, maps
);
3031 if (!NILP (maps
) || always_title
)
3035 insert_string (title
);
3038 insert_string (" Starting With ");
3039 insert1 (Fkey_description (prefix
, Qnil
));
3041 insert_string (":\n");
3043 insert_string (key_heading
);
3047 for (; !NILP (maps
); maps
= Fcdr (maps
))
3049 register Lisp_Object elt
, prefix
, tail
;
3052 prefix
= Fcar (elt
);
3056 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3060 shmap
= XCAR (tail
);
3062 /* If the sequence by which we reach this keymap is zero-length,
3063 then the shadow map for this keymap is just SHADOW. */
3064 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3065 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3067 /* If the sequence by which we reach this keymap actually has
3068 some elements, then the sequence's definition in SHADOW is
3069 what we should use. */
3072 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3073 if (INTEGERP (shmap
))
3077 /* If shmap is not nil and not a keymap,
3078 it completely shadows this map, so don't
3079 describe this map at all. */
3080 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3084 sub_shadows
= Fcons (shmap
, sub_shadows
);
3087 /* Maps we have already listed in this loop shadow this map. */
3088 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3091 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3093 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3096 describe_map (Fcdr (elt
), prefix
,
3097 transl
? describe_translation
: describe_command
,
3098 partial
, sub_shadows
, &seen
, nomenu
, mention_shadow
);
3104 insert_string ("\n");
3109 static int previous_description_column
;
3112 describe_command (definition
, args
)
3113 Lisp_Object definition
, args
;
3115 register Lisp_Object tem1
;
3116 int column
= (int) current_column (); /* iftc */
3117 int description_column
;
3119 /* If column 16 is no good, go to col 32;
3120 but don't push beyond that--go to next line instead. */
3124 description_column
= 32;
3126 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3127 description_column
= 32;
3129 description_column
= 16;
3131 Findent_to (make_number (description_column
), make_number (1));
3132 previous_description_column
= description_column
;
3134 if (SYMBOLP (definition
))
3136 tem1
= SYMBOL_NAME (definition
);
3138 insert_string ("\n");
3140 else if (STRINGP (definition
) || VECTORP (definition
))
3141 insert_string ("Keyboard Macro\n");
3142 else if (KEYMAPP (definition
))
3143 insert_string ("Prefix Command\n");
3145 insert_string ("??\n");
3149 describe_translation (definition
, args
)
3150 Lisp_Object definition
, args
;
3152 register Lisp_Object tem1
;
3154 Findent_to (make_number (16), make_number (1));
3156 if (SYMBOLP (definition
))
3158 tem1
= SYMBOL_NAME (definition
);
3160 insert_string ("\n");
3162 else if (STRINGP (definition
) || VECTORP (definition
))
3164 insert1 (Fkey_description (definition
, Qnil
));
3165 insert_string ("\n");
3167 else if (KEYMAPP (definition
))
3168 insert_string ("Prefix Command\n");
3170 insert_string ("??\n");
3173 /* Describe the contents of map MAP, assuming that this map itself is
3174 reached by the sequence of prefix keys PREFIX (a string or vector).
3175 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3178 describe_map (map
, prefix
, elt_describer
, partial
, shadow
,
3179 seen
, nomenu
, mention_shadow
)
3180 register Lisp_Object map
;
3182 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3189 Lisp_Object tail
, definition
, event
;
3191 Lisp_Object suppress
;
3194 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3199 suppress
= intern ("suppress-keymap");
3201 /* This vector gets used to present single keys to Flookup_key. Since
3202 that is done once per keymap element, we don't want to cons up a
3203 fresh vector every time. */
3204 kludge
= Fmake_vector (make_number (1), Qnil
);
3207 GCPRO3 (prefix
, definition
, kludge
);
3209 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3213 if (VECTORP (XCAR (tail
))
3214 || CHAR_TABLE_P (XCAR (tail
)))
3215 describe_vector (XCAR (tail
),
3216 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3217 (int *)0, 0, 1, mention_shadow
);
3218 else if (CONSP (XCAR (tail
)))
3220 int this_shadowed
= 0;
3221 event
= XCAR (XCAR (tail
));
3223 /* Ignore bindings whose "prefix" are not really valid events.
3224 (We get these in the frames and buffers menu.) */
3225 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3228 if (nomenu
&& EQ (event
, Qmenu_bar
))
3231 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3233 /* Don't show undefined commands or suppressed commands. */
3234 if (NILP (definition
)) continue;
3235 if (SYMBOLP (definition
) && partial
)
3237 tem
= Fget (definition
, suppress
);
3242 /* Don't show a command that isn't really visible
3243 because a local definition of the same key shadows it. */
3245 ASET (kludge
, 0, event
);
3248 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3258 tem
= Flookup_key (map
, kludge
, Qt
);
3259 if (!EQ (tem
, definition
)) continue;
3263 previous_description_column
= 0;
3268 /* THIS gets the string to describe the character EVENT. */
3269 insert1 (Fkey_description (kludge
, prefix
));
3271 /* Print a description of the definition of this character.
3272 elt_describer will take care of spacing out far enough
3273 for alignment purposes. */
3274 (*elt_describer
) (definition
, Qnil
);
3279 insert_string (" (binding currently shadowed)");
3283 else if (EQ (XCAR (tail
), Qkeymap
))
3285 /* The same keymap might be in the structure twice, if we're
3286 using an inherited keymap. So skip anything we've already
3288 tem
= Fassq (tail
, *seen
);
3289 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3291 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3299 describe_vector_princ (elt
, fun
)
3300 Lisp_Object elt
, fun
;
3302 Findent_to (make_number (16), make_number (1));
3307 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3308 doc
: /* Insert a description of contents of VECTOR.
3309 This is text showing the elements of vector matched against indices.
3310 DESCRIBER is the output function used; nil means use `princ'. */)
3312 Lisp_Object vector
, describer
;
3314 int count
= SPECPDL_INDEX ();
3315 if (NILP (describer
))
3316 describer
= intern ("princ");
3317 specbind (Qstandard_output
, Fcurrent_buffer ());
3318 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3319 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3320 Qnil
, Qnil
, (int *)0, 0, 0, 0);
3322 return unbind_to (count
, Qnil
);
3325 /* Insert in the current buffer a description of the contents of VECTOR.
3326 We call ELT_DESCRIBER to insert the description of one value found
3329 ELT_PREFIX describes what "comes before" the keys or indices defined
3330 by this vector. This is a human-readable string whose size
3331 is not necessarily related to the situation.
3333 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3334 leads to this keymap.
3336 If the vector is a chartable, ELT_PREFIX is the vector
3337 of bytes that lead to the character set or portion of a character
3338 set described by this chartable.
3340 If PARTIAL is nonzero, it means do not mention suppressed commands
3341 (that assumes the vector is in a keymap).
3343 SHADOW is a list of keymaps that shadow this map.
3344 If it is non-nil, then we look up the key in those maps
3345 and we don't mention it now if it is defined by any of them.
3347 ENTIRE_MAP is the keymap in which this vector appears.
3348 If the definition in effect in the whole map does not match
3349 the one in this vector, we ignore this one.
3351 When describing a sub-char-table, INDICES is a list of
3352 indices at higher levels in this char-table,
3353 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3355 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3357 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3360 describe_vector (vector
, prefix
, args
, elt_describer
,
3361 partial
, shadow
, entire_map
,
3362 indices
, char_table_depth
, keymap_p
,
3364 register Lisp_Object vector
;
3365 Lisp_Object prefix
, args
;
3366 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3369 Lisp_Object entire_map
;
3371 int char_table_depth
;
3375 Lisp_Object definition
;
3377 Lisp_Object elt_prefix
= Qnil
;
3379 Lisp_Object suppress
;
3382 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3383 /* Range of elements to be handled. */
3385 /* A flag to tell if a leaf in this level of char-table is not a
3386 generic character (i.e. a complete multibyte character). */
3394 indices
= (int *) alloca (3 * sizeof (int));
3400 /* Call Fkey_description first, to avoid GC bug for the other string. */
3401 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3404 tem
= Fkey_description (prefix
, Qnil
);
3405 elt_prefix
= concat2 (tem
, build_string (" "));
3410 /* This vector gets used to present single keys to Flookup_key. Since
3411 that is done once per vector element, we don't want to cons up a
3412 fresh vector every time. */
3413 kludge
= Fmake_vector (make_number (1), Qnil
);
3414 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3417 suppress
= intern ("suppress-keymap");
3419 if (CHAR_TABLE_P (vector
))
3421 if (char_table_depth
== 0)
3423 /* VECTOR is a top level char-table. */
3426 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3430 /* VECTOR is a sub char-table. */
3431 if (char_table_depth
>= 3)
3432 /* A char-table is never that deep. */
3433 error ("Too deep char table");
3436 = (CHARSET_VALID_P (indices
[0])
3437 && ((CHARSET_DIMENSION (indices
[0]) == 1
3438 && char_table_depth
== 1)
3439 || char_table_depth
== 2));
3441 /* Meaningful elements are from 32th to 127th. */
3443 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3448 /* This does the right thing for ordinary vectors. */
3452 to
= XVECTOR (vector
)->size
;
3455 for (i
= from
; i
< to
; i
++)
3457 int this_shadowed
= 0;
3460 if (CHAR_TABLE_P (vector
))
3462 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3465 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3466 && !CHARSET_DEFINED_P (i
- 128))
3470 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3473 definition
= get_keyelt (AREF (vector
, i
), 0);
3475 if (NILP (definition
)) continue;
3477 /* Don't mention suppressed commands. */
3478 if (SYMBOLP (definition
) && partial
)
3482 tem
= Fget (definition
, suppress
);
3484 if (!NILP (tem
)) continue;
3487 /* Set CHARACTER to the character this entry describes, if any.
3488 Also update *INDICES. */
3489 if (CHAR_TABLE_P (vector
))
3491 indices
[char_table_depth
] = i
;
3493 if (char_table_depth
== 0)
3496 indices
[0] = i
- 128;
3498 else if (complete_char
)
3500 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3508 ASET (kludge
, 0, make_number (character
));
3510 /* If this binding is shadowed by some other map, ignore it. */
3511 if (!NILP (shadow
) && complete_char
)
3515 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3526 /* Ignore this definition if it is shadowed by an earlier
3527 one in the same keymap. */
3528 if (!NILP (entire_map
) && complete_char
)
3532 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3534 if (!EQ (tem
, definition
))
3540 if (char_table_depth
== 0)
3545 /* For a sub char-table, show the depth by indentation.
3546 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3547 if (char_table_depth
> 0)
3548 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3550 /* Output the prefix that applies to every entry in this map. */
3551 if (!NILP (elt_prefix
))
3552 insert1 (elt_prefix
);
3554 /* Insert or describe the character this slot is for,
3555 or a description of what it is for. */
3556 if (SUB_CHAR_TABLE_P (vector
))
3559 insert_char (character
);
3562 /* We need an octal representation for this block of
3565 sprintf (work
, "(row %d)", i
);
3566 insert (work
, strlen (work
));
3569 else if (CHAR_TABLE_P (vector
))
3572 insert1 (Fkey_description (kludge
, prefix
));
3575 /* Print the information for this character set. */
3576 insert_string ("<");
3577 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3579 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3588 insert1 (Fkey_description (kludge
, prefix
));
3591 /* If we find a sub char-table within a char-table,
3592 scan it recursively; it defines the details for
3593 a character set or a portion of a character set. */
3594 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3597 describe_vector (definition
, prefix
, args
, elt_describer
,
3598 partial
, shadow
, entire_map
,
3599 indices
, char_table_depth
+ 1, keymap_p
,
3606 /* Find all consecutive characters or rows that have the same
3607 definition. But, for elements of a top level char table, if
3608 they are for charsets, we had better describe one by one even
3609 if they have the same definition. */
3610 if (CHAR_TABLE_P (vector
))
3614 if (char_table_depth
== 0)
3615 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3617 while (i
+ 1 < limit
3618 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3620 && !NILP (Fequal (tem2
, definition
)))
3625 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3627 && !NILP (Fequal (tem2
, definition
)))
3631 /* If we have a range of more than one character,
3632 print where the range reaches to. */
3634 if (i
!= starting_i
)
3638 ASET (kludge
, 0, make_number (i
));
3640 if (!NILP (elt_prefix
))
3641 insert1 (elt_prefix
);
3643 if (CHAR_TABLE_P (vector
))
3645 if (char_table_depth
== 0)
3647 insert1 (Fkey_description (kludge
, prefix
));
3649 else if (complete_char
)
3651 indices
[char_table_depth
] = i
;
3652 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3653 insert_char (character
);
3657 /* We need an octal representation for this block of
3660 sprintf (work
, "(row %d)", i
);
3661 insert (work
, strlen (work
));
3666 insert1 (Fkey_description (kludge
, prefix
));
3670 /* Print a description of the definition of this character.
3671 elt_describer will take care of spacing out far enough
3672 for alignment purposes. */
3673 (*elt_describer
) (definition
, args
);
3678 insert_string (" (binding currently shadowed)");
3683 /* For (sub) char-table, print `defalt' slot at last. */
3684 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3686 insert (" ", char_table_depth
* 2);
3687 insert_string ("<<default>>");
3688 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3694 /* Apropos - finding all symbols whose names match a regexp. */
3695 static Lisp_Object apropos_predicate
;
3696 static Lisp_Object apropos_accumulate
;
3699 apropos_accum (symbol
, string
)
3700 Lisp_Object symbol
, string
;
3702 register Lisp_Object tem
;
3704 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3705 if (!NILP (tem
) && !NILP (apropos_predicate
))
3706 tem
= call1 (apropos_predicate
, symbol
);
3708 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3711 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3712 doc
: /* Show all symbols whose names contain match for REGEXP.
3713 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3714 for each symbol and a symbol is mentioned only if that returns non-nil.
3715 Return list of symbols found. */)
3717 Lisp_Object regexp
, predicate
;
3720 CHECK_STRING (regexp
);
3721 apropos_predicate
= predicate
;
3722 apropos_accumulate
= Qnil
;
3723 map_obarray (Vobarray
, apropos_accum
, regexp
);
3724 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3725 apropos_accumulate
= Qnil
;
3726 apropos_predicate
= Qnil
;
3733 Qkeymap
= intern ("keymap");
3734 staticpro (&Qkeymap
);
3735 staticpro (&apropos_predicate
);
3736 staticpro (&apropos_accumulate
);
3737 apropos_predicate
= Qnil
;
3738 apropos_accumulate
= Qnil
;
3740 /* Now we are ready to set up this property, so we can
3741 create char tables. */
3742 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3744 /* Initialize the keymaps standardly used.
3745 Each one is the value of a Lisp variable, and is also
3746 pointed to by a C variable */
3748 global_map
= Fmake_keymap (Qnil
);
3749 Fset (intern ("global-map"), global_map
);
3751 current_global_map
= global_map
;
3752 staticpro (&global_map
);
3753 staticpro (¤t_global_map
);
3755 meta_map
= Fmake_keymap (Qnil
);
3756 Fset (intern ("esc-map"), meta_map
);
3757 Ffset (intern ("ESC-prefix"), meta_map
);
3759 control_x_map
= Fmake_keymap (Qnil
);
3760 Fset (intern ("ctl-x-map"), control_x_map
);
3761 Ffset (intern ("Control-X-prefix"), control_x_map
);
3764 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3765 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3766 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3767 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3768 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3770 staticpro (&exclude_keys
);
3772 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3773 doc
: /* List of commands given new key bindings recently.
3774 This is used for internal purposes during Emacs startup;
3775 don't alter it yourself. */);
3776 Vdefine_key_rebound_commands
= Qt
;
3778 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3779 doc
: /* Default keymap to use when reading from the minibuffer. */);
3780 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3782 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3783 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3784 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3785 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3787 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3788 doc
: /* Local keymap for minibuffer input with completion. */);
3789 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3790 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3792 DEFVAR_LISP ("minibuffer-local-filename-completion-map",
3793 &Vminibuffer_local_filename_completion_map
,
3794 doc
: /* Local keymap for minibuffer input with completion for filenames. */);
3795 Vminibuffer_local_filename_completion_map
= Fmake_sparse_keymap (Qnil
);
3796 Fset_keymap_parent (Vminibuffer_local_filename_completion_map
,
3797 Vminibuffer_local_completion_map
);
3800 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3801 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3802 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3803 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3804 Vminibuffer_local_completion_map
);
3806 DEFVAR_LISP ("minibuffer-local-must-match-filename-map",
3807 &Vminibuffer_local_must_match_filename_map
,
3808 doc
: /* Local keymap for minibuffer input with completion for filenames with exact match. */);
3809 Vminibuffer_local_must_match_filename_map
= Fmake_sparse_keymap (Qnil
);
3810 Fset_keymap_parent (Vminibuffer_local_must_match_filename_map
,
3811 Vminibuffer_local_must_match_map
);
3813 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3814 doc
: /* Alist of keymaps to use for minor modes.
3815 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3816 key sequences and look up bindings iff VARIABLE's value is non-nil.
3817 If two active keymaps bind the same key, the keymap appearing earlier
3818 in the list takes precedence. */);
3819 Vminor_mode_map_alist
= Qnil
;
3821 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3822 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3823 This variable is an alist just like `minor-mode-map-alist', and it is
3824 used the same way (and before `minor-mode-map-alist'); however,
3825 it is provided for major modes to bind locally. */);
3826 Vminor_mode_overriding_map_alist
= Qnil
;
3828 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3829 doc
: /* List of keymap alists to use for emulations modes.
3830 It is intended for modes or packages using multiple minor-mode keymaps.
3831 Each element is a keymap alist just like `minor-mode-map-alist', or a
3832 symbol with a variable binding which is a keymap alist, and it is used
3833 the same way. The "active" keymaps in each alist are used before
3834 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3835 Vemulation_mode_map_alists
= Qnil
;
3838 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3839 doc
: /* Keymap mapping ASCII function key sequences onto their preferred forms.
3840 This allows Emacs to recognize function keys sent from ASCII
3841 terminals at any point in a key sequence.
3843 The `read-key-sequence' function replaces any subsequence bound by
3844 `function-key-map' with its binding. More precisely, when the active
3845 keymaps have no binding for the current key sequence but
3846 `function-key-map' binds a suffix of the sequence to a vector or string,
3847 `read-key-sequence' replaces the matching suffix with its binding, and
3848 continues with the new sequence.
3850 The events that come from bindings in `function-key-map' are not
3851 themselves looked up in `function-key-map'.
3853 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3854 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3855 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3856 key, typing `ESC O P x' would return [f1 x]. */);
3857 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3859 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3860 doc
: /* Keymap of key translations that can override keymaps.
3861 This keymap works like `function-key-map', but comes after that,
3862 and its non-prefix bindings override ordinary bindings. */);
3863 Vkey_translation_map
= Qnil
;
3865 staticpro (&Vmouse_events
);
3866 Vmouse_events
= Fcons (intern ("menu-bar"),
3867 Fcons (intern ("tool-bar"),
3868 Fcons (intern ("header-line"),
3869 Fcons (intern ("mode-line"),
3870 Fcons (intern ("mouse-1"),
3871 Fcons (intern ("mouse-2"),
3872 Fcons (intern ("mouse-3"),
3873 Fcons (intern ("mouse-4"),
3874 Fcons (intern ("mouse-5"),
3878 Qsingle_key_description
= intern ("single-key-description");
3879 staticpro (&Qsingle_key_description
);
3881 Qkey_description
= intern ("key-description");
3882 staticpro (&Qkey_description
);
3884 Qkeymapp
= intern ("keymapp");
3885 staticpro (&Qkeymapp
);
3887 Qnon_ascii
= intern ("non-ascii");
3888 staticpro (&Qnon_ascii
);
3890 Qmenu_item
= intern ("menu-item");
3891 staticpro (&Qmenu_item
);
3893 Qremap
= intern ("remap");
3894 staticpro (&Qremap
);
3896 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3897 staticpro (&command_remapping_vector
);
3899 where_is_cache_keymaps
= Qt
;
3900 where_is_cache
= Qnil
;
3901 staticpro (&where_is_cache
);
3902 staticpro (&where_is_cache_keymaps
);
3904 defsubr (&Skeymapp
);
3905 defsubr (&Skeymap_parent
);
3906 defsubr (&Skeymap_prompt
);
3907 defsubr (&Sset_keymap_parent
);
3908 defsubr (&Smake_keymap
);
3909 defsubr (&Smake_sparse_keymap
);
3910 defsubr (&Smap_keymap
);
3911 defsubr (&Scopy_keymap
);
3912 defsubr (&Scommand_remapping
);
3913 defsubr (&Skey_binding
);
3914 defsubr (&Slocal_key_binding
);
3915 defsubr (&Sglobal_key_binding
);
3916 defsubr (&Sminor_mode_key_binding
);
3917 defsubr (&Sdefine_key
);
3918 defsubr (&Slookup_key
);
3919 defsubr (&Sdefine_prefix_command
);
3920 defsubr (&Suse_global_map
);
3921 defsubr (&Suse_local_map
);
3922 defsubr (&Scurrent_local_map
);
3923 defsubr (&Scurrent_global_map
);
3924 defsubr (&Scurrent_minor_mode_maps
);
3925 defsubr (&Scurrent_active_maps
);
3926 defsubr (&Saccessible_keymaps
);
3927 defsubr (&Skey_description
);
3928 defsubr (&Sdescribe_vector
);
3929 defsubr (&Ssingle_key_description
);
3930 defsubr (&Stext_char_description
);
3931 defsubr (&Swhere_is_internal
);
3932 defsubr (&Sdescribe_buffer_bindings
);
3933 defsubr (&Sapropos_internal
);
3939 initial_define_key (global_map
, 033, "ESC-prefix");
3940 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
3943 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
3944 (do not change this comment) */