1 /* Manipulation of keymaps
2 Copyright (C) 1985, 86,87,88,93,94,95,98,99, 2000, 01, 2004
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
30 #include "termhooks.h"
31 #include "blockinput.h"
33 #include "intervals.h"
36 /* The number of elements in keymap vectors. */
37 #define DENSE_TABLE_SIZE (0200)
39 /* Actually allocate storage for these variables */
41 Lisp_Object current_global_map
; /* Current global keymap */
43 Lisp_Object global_map
; /* default global key bindings */
45 Lisp_Object meta_map
; /* The keymap used for globally bound
46 ESC-prefixed default commands */
48 Lisp_Object control_x_map
; /* The keymap used for globally bound
49 C-x-prefixed default commands */
51 /* was MinibufLocalMap */
52 Lisp_Object Vminibuffer_local_map
;
53 /* The keymap used by the minibuf for local
54 bindings when spaces are allowed in the
57 /* was MinibufLocalNSMap */
58 Lisp_Object Vminibuffer_local_ns_map
;
59 /* The keymap used by the minibuf for local
60 bindings when spaces are not encouraged
63 /* keymap used for minibuffers when doing completion */
64 /* was MinibufLocalCompletionMap */
65 Lisp_Object Vminibuffer_local_completion_map
;
67 /* keymap used for minibuffers when doing completion and require a match */
68 /* was MinibufLocalMustMatchMap */
69 Lisp_Object Vminibuffer_local_must_match_map
;
71 /* Alist of minor mode variables and keymaps. */
72 Lisp_Object Vminor_mode_map_alist
;
74 /* Alist of major-mode-specific overrides for
75 minor mode variables and keymaps. */
76 Lisp_Object Vminor_mode_overriding_map_alist
;
78 /* List of emulation mode keymap alists. */
79 Lisp_Object Vemulation_mode_map_alists
;
81 /* Keymap mapping ASCII function key sequences onto their preferred forms.
82 Initialized by the terminal-specific lisp files. See DEFVAR for more
84 Lisp_Object Vfunction_key_map
;
86 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
87 Lisp_Object Vkey_translation_map
;
89 /* A list of all commands given new bindings since a certain time
90 when nil was stored here.
91 This is used to speed up recomputation of menu key equivalents
92 when Emacs starts up. t means don't record anything here. */
93 Lisp_Object Vdefine_key_rebound_commands
;
95 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
97 /* Alist of elements like (DEL . "\d"). */
98 static Lisp_Object exclude_keys
;
100 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
101 static Lisp_Object command_remapping_vector
;
103 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
104 in a string key sequence is equivalent to prefixing with this
106 extern Lisp_Object meta_prefix_char
;
108 extern Lisp_Object Voverriding_local_map
;
110 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
111 static Lisp_Object where_is_cache
;
112 /* Which keymaps are reverse-stored in the cache. */
113 static Lisp_Object where_is_cache_keymaps
;
115 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
116 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
118 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
119 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
120 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
121 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
122 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
123 int, Lisp_Object
, Lisp_Object
*, int));
124 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
125 void (*) (Lisp_Object
, Lisp_Object
), int,
126 Lisp_Object
, Lisp_Object
, int *, int, int));
127 static void silly_event_symbol_error
P_ ((Lisp_Object
));
129 /* Keymap object support - constructors and predicates. */
131 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
132 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
133 CHARTABLE is a char-table that holds the bindings for the ASCII
134 characters. ALIST is an assoc-list which holds bindings for function keys,
135 mouse events, and any other things that appear in the input stream.
136 All entries in it are initially nil, meaning "command undefined".
138 The optional arg STRING supplies a menu name for the keymap
139 in case you use it as a menu with `x-popup-menu'. */)
145 tail
= Fcons (string
, Qnil
);
148 return Fcons (Qkeymap
,
149 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
152 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
153 doc
: /* Construct and return a new sparse keymap.
154 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
155 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
156 which binds the function key or mouse event SYMBOL to DEFINITION.
157 Initially the alist is nil.
159 The optional arg STRING supplies a menu name for the keymap
160 in case you use it as a menu with `x-popup-menu'. */)
165 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
166 return Fcons (Qkeymap
, Qnil
);
169 /* This function is used for installing the standard key bindings
170 at initialization time.
174 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
177 initial_define_key (keymap
, key
, defname
)
182 store_in_keymap (keymap
, make_number (key
), intern (defname
));
186 initial_define_lispy_key (keymap
, keyname
, defname
)
191 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
194 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
195 doc
: /* Return t if OBJECT is a keymap.
197 A keymap is a list (keymap . ALIST),
198 or a symbol whose function definition is itself a keymap.
199 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
200 a vector of densely packed bindings for small character codes
201 is also allowed as an element. */)
205 return (KEYMAPP (object
) ? Qt
: Qnil
);
208 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
209 doc
: /* Return the prompt-string of a keymap MAP.
210 If non-nil, the prompt is shown in the echo-area
211 when reading a key-sequence to be looked-up in this keymap. */)
217 register Lisp_Object tem
;
226 /* Check that OBJECT is a keymap (after dereferencing through any
227 symbols). If it is, return it.
229 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
230 is an autoload form, do the autoload and try again.
231 If AUTOLOAD is nonzero, callers must assume GC is possible.
233 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
234 is zero as well), return Qt.
236 ERROR controls how we respond if OBJECT isn't a keymap.
237 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
239 Note that most of the time, we don't want to pursue autoloads.
240 Functions like Faccessible_keymaps which scan entire keymap trees
241 shouldn't load every autoloaded keymap. I'm not sure about this,
242 but it seems to me that only read_key_sequence, Flookup_key, and
243 Fdefine_key should cause keymaps to be autoloaded.
245 This function can GC when AUTOLOAD is non-zero, because it calls
246 do_autoload which can GC. */
249 get_keymap (object
, error
, autoload
)
258 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
261 tem
= indirect_function (object
);
264 if (EQ (XCAR (tem
), Qkeymap
))
267 /* Should we do an autoload? Autoload forms for keymaps have
268 Qkeymap as their fifth element. */
269 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
))
273 tail
= Fnth (make_number (4), tem
);
274 if (EQ (tail
, Qkeymap
))
278 struct gcpro gcpro1
, gcpro2
;
280 GCPRO2 (tem
, object
);
281 do_autoload (tem
, object
);
294 wrong_type_argument (Qkeymapp
, object
);
298 /* Return the parent map of KEYMAP, or nil if it has none.
299 We assume that KEYMAP is a valid keymap. */
302 keymap_parent (keymap
, autoload
)
308 keymap
= get_keymap (keymap
, 1, autoload
);
310 /* Skip past the initial element `keymap'. */
311 list
= XCDR (keymap
);
312 for (; CONSP (list
); list
= XCDR (list
))
314 /* See if there is another `keymap'. */
319 return get_keymap (list
, 0, autoload
);
322 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
323 doc
: /* Return the parent keymap of KEYMAP. */)
327 return keymap_parent (keymap
, 1);
330 /* Check whether MAP is one of MAPS parents. */
332 keymap_memberp (map
, maps
)
333 Lisp_Object map
, maps
;
335 if (NILP (map
)) return 0;
336 while (KEYMAPP (maps
) && !EQ (map
, maps
))
337 maps
= keymap_parent (maps
, 0);
338 return (EQ (map
, maps
));
341 /* Set the parent keymap of MAP to PARENT. */
343 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
344 doc
: /* Modify KEYMAP to set its parent map to PARENT.
346 PARENT should be nil or another keymap. */)
348 Lisp_Object keymap
, parent
;
350 Lisp_Object list
, prev
;
351 struct gcpro gcpro1
, gcpro2
;
354 /* Force a keymap flush for the next call to where-is.
355 Since this can be called from within where-is, we don't set where_is_cache
356 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
357 be changed during where-is, while where_is_cache_keymaps is only used at
358 the very beginning of where-is and can thus be changed here without any
360 This is a very minor correctness (rather than safety) issue. */
361 where_is_cache_keymaps
= Qt
;
363 GCPRO2 (keymap
, parent
);
364 keymap
= get_keymap (keymap
, 1, 1);
368 parent
= get_keymap (parent
, 1, 1);
370 /* Check for cycles. */
371 if (keymap_memberp (keymap
, parent
))
372 error ("Cyclic keymap inheritance");
375 /* Skip past the initial element `keymap'. */
380 /* If there is a parent keymap here, replace it.
381 If we came to the end, add the parent in PREV. */
382 if (!CONSP (list
) || KEYMAPP (list
))
384 /* If we already have the right parent, return now
385 so that we avoid the loops below. */
386 if (EQ (XCDR (prev
), parent
))
387 RETURN_UNGCPRO (parent
);
389 XSETCDR (prev
, parent
);
395 /* Scan through for submaps, and set their parents too. */
397 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
399 /* Stop the scan when we come to the parent. */
400 if (EQ (XCAR (list
), Qkeymap
))
403 /* If this element holds a prefix map, deal with it. */
404 if (CONSP (XCAR (list
))
405 && CONSP (XCDR (XCAR (list
))))
406 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
409 if (VECTORP (XCAR (list
)))
410 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
411 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
412 fix_submap_inheritance (keymap
, make_number (i
),
413 XVECTOR (XCAR (list
))->contents
[i
]);
415 if (CHAR_TABLE_P (XCAR (list
)))
417 Lisp_Object indices
[3];
419 map_char_table (fix_submap_inheritance
, Qnil
,
420 XCAR (list
), XCAR (list
),
425 RETURN_UNGCPRO (parent
);
428 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
429 if EVENT is also a prefix in MAP's parent,
430 make sure that SUBMAP inherits that definition as its own parent. */
433 fix_submap_inheritance (map
, event
, submap
)
434 Lisp_Object map
, event
, submap
;
436 Lisp_Object map_parent
, parent_entry
;
438 /* SUBMAP is a cons that we found as a key binding.
439 Discard the other things found in a menu key binding. */
441 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
443 /* If it isn't a keymap now, there's no work to do. */
447 map_parent
= keymap_parent (map
, 0);
448 if (!NILP (map_parent
))
450 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
454 /* If MAP's parent has something other than a keymap,
455 our own submap shadows it completely. */
456 if (!CONSP (parent_entry
))
459 if (! EQ (parent_entry
, submap
))
461 Lisp_Object submap_parent
;
462 submap_parent
= submap
;
467 tem
= keymap_parent (submap_parent
, 0);
471 if (keymap_memberp (tem
, parent_entry
))
472 /* Fset_keymap_parent could create a cycle. */
479 Fset_keymap_parent (submap_parent
, parent_entry
);
483 /* Look up IDX in MAP. IDX may be any sort of event.
484 Note that this does only one level of lookup; IDX must be a single
485 event, not a sequence.
487 If T_OK is non-zero, bindings for Qt are treated as default
488 bindings; any key left unmentioned by other tables and bindings is
489 given the binding of Qt.
491 If T_OK is zero, bindings for Qt are not treated specially.
493 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
496 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
505 /* Qunbound in VAL means we have found no binding yet. */
508 /* If idx is a list (some sort of mouse click, perhaps?),
509 the index we want to use is the car of the list, which
510 ought to be a symbol. */
511 idx
= EVENT_HEAD (idx
);
513 /* If idx is a symbol, it might have modifiers, which need to
514 be put in the canonical order. */
516 idx
= reorder_modifiers (idx
);
517 else if (INTEGERP (idx
))
518 /* Clobber the high bits that can be present on a machine
519 with more than 24 bits of integer. */
520 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
522 /* Handle the special meta -> esc mapping. */
523 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
525 /* See if there is a meta-map. If there's none, there is
526 no binding for IDX, unless a default binding exists in MAP. */
528 Lisp_Object meta_map
;
530 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
531 t_ok
, noinherit
, autoload
),
534 if (CONSP (meta_map
))
537 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
540 /* Set IDX to t, so that we only find a default binding. */
543 /* We know there is no binding. */
547 /* t_binding is where we put a default binding that applies,
548 to use in case we do not find a binding specifically
549 for this key sequence. */
552 Lisp_Object t_binding
= Qnil
;
553 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
555 GCPRO4 (map
, tail
, idx
, t_binding
);
557 /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
558 If it is 1, only generic-char bindings are accepted.
559 Otherwise, neither are. */
562 for (tail
= XCDR (map
);
564 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
569 binding
= XCAR (tail
);
570 if (SYMBOLP (binding
))
572 /* If NOINHERIT, stop finding prefix definitions
573 after we pass a second occurrence of the `keymap' symbol. */
574 if (noinherit
&& EQ (binding
, Qkeymap
))
575 RETURN_UNGCPRO (Qnil
);
577 else if (CONSP (binding
))
579 Lisp_Object key
= XCAR (binding
);
582 val
= XCDR (binding
);
585 && (XINT (idx
) & CHAR_MODIFIER_MASK
) == 0
587 && (XINT (key
) & CHAR_MODIFIER_MASK
) == 0
588 && !SINGLE_BYTE_CHAR_P (XINT (idx
))
589 && !SINGLE_BYTE_CHAR_P (XINT (key
))
590 && CHAR_VALID_P (XINT (key
), 1)
591 && !CHAR_VALID_P (XINT (key
), 0)
592 && (CHAR_CHARSET (XINT (key
))
593 == CHAR_CHARSET (XINT (idx
))))
595 /* KEY is the generic character of the charset of IDX.
596 Use KEY's binding if there isn't a binding for IDX
598 t_binding
= XCDR (binding
);
601 else if (t_ok
> 1 && EQ (key
, Qt
))
603 t_binding
= XCDR (binding
);
607 else if (VECTORP (binding
))
609 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
610 val
= AREF (binding
, XFASTINT (idx
));
612 else if (CHAR_TABLE_P (binding
))
614 /* Character codes with modifiers
615 are not included in a char-table.
616 All character codes without modifiers are included. */
617 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
619 val
= Faref (binding
, idx
);
620 /* `nil' has a special meaning for char-tables, so
621 we use something else to record an explicitly
628 /* If we found a binding, clean it up and return it. */
629 if (!EQ (val
, Qunbound
))
632 /* A Qt binding is just like an explicit nil binding
633 (i.e. it shadows any parent binding but not bindings in
634 keymaps of lower precedence). */
636 val
= get_keyelt (val
, autoload
);
638 fix_submap_inheritance (map
, idx
, val
);
639 RETURN_UNGCPRO (val
);
644 return get_keyelt (t_binding
, autoload
);
649 map_keymap_item (fun
, args
, key
, val
, data
)
650 map_keymap_function_t fun
;
651 Lisp_Object args
, key
, val
;
654 /* We should maybe try to detect bindings shadowed by previous
655 ones and things like that. */
658 (*fun
) (key
, val
, args
, data
);
662 map_keymap_char_table_item (args
, key
, val
)
663 Lisp_Object args
, key
, val
;
667 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
669 map_keymap_item (fun
, XCDR (args
), key
, val
,
670 XSAVE_VALUE (XCAR (args
))->pointer
);
674 /* Call FUN for every binding in MAP.
675 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
676 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
678 map_keymap (map
, fun
, args
, data
, autoload
)
679 map_keymap_function_t fun
;
680 Lisp_Object map
, args
;
684 struct gcpro gcpro1
, gcpro2
, gcpro3
;
687 GCPRO3 (map
, args
, tail
);
688 map
= get_keymap (map
, 1, autoload
);
689 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
690 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
693 Lisp_Object binding
= XCAR (tail
);
696 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
697 else if (VECTORP (binding
))
699 /* Loop over the char values represented in the vector. */
700 int len
= ASIZE (binding
);
702 for (c
= 0; c
< len
; c
++)
704 Lisp_Object character
;
705 XSETFASTINT (character
, c
);
706 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
709 else if (CHAR_TABLE_P (binding
))
711 Lisp_Object indices
[3];
712 map_char_table (map_keymap_char_table_item
, Qnil
, binding
, binding
,
713 Fcons (make_save_value (fun
, 0),
714 Fcons (make_save_value (data
, 0),
723 map_keymap_call (key
, val
, fun
, dummy
)
724 Lisp_Object key
, val
, fun
;
727 call2 (fun
, key
, val
);
730 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 2, 0,
731 doc
: /* Call FUNCTION for every binding in KEYMAP.
732 FUNCTION is called with two arguments: the event and its binding. */)
734 Lisp_Object function
, keymap
;
736 if (INTEGERP (function
))
737 /* We have to stop integers early since map_keymap gives them special
739 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
740 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
744 /* Given OBJECT which was found in a slot in a keymap,
745 trace indirect definitions to get the actual definition of that slot.
746 An indirect definition is a list of the form
747 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
748 and INDEX is the object to look up in KEYMAP to yield the definition.
750 Also if OBJECT has a menu string as the first element,
751 remove that. Also remove a menu help string as second element.
753 If AUTOLOAD is nonzero, load autoloadable keymaps
754 that are referred to with indirection. */
757 get_keyelt (object
, autoload
)
763 if (!(CONSP (object
)))
764 /* This is really the value. */
767 /* If the keymap contents looks like (keymap ...) or (lambda ...)
769 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
772 /* If the keymap contents looks like (menu-item name . DEFN)
773 or (menu-item name DEFN ...) then use DEFN.
774 This is a new format menu item. */
775 else if (EQ (XCAR (object
), Qmenu_item
))
777 if (CONSP (XCDR (object
)))
781 object
= XCDR (XCDR (object
));
784 object
= XCAR (object
);
786 /* If there's a `:filter FILTER', apply FILTER to the
787 menu-item's definition to get the real definition to
789 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
790 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
793 filter
= XCAR (XCDR (tem
));
794 filter
= list2 (filter
, list2 (Qquote
, object
));
795 object
= menu_item_eval_property (filter
);
800 /* Invalid keymap. */
804 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
805 Keymap alist elements like (CHAR MENUSTRING . DEFN)
806 will be used by HierarKey menus. */
807 else if (STRINGP (XCAR (object
)))
809 object
= XCDR (object
);
810 /* Also remove a menu help string, if any,
811 following the menu item name. */
812 if (CONSP (object
) && STRINGP (XCAR (object
)))
813 object
= XCDR (object
);
814 /* Also remove the sublist that caches key equivalences, if any. */
815 if (CONSP (object
) && CONSP (XCAR (object
)))
818 carcar
= XCAR (XCAR (object
));
819 if (NILP (carcar
) || VECTORP (carcar
))
820 object
= XCDR (object
);
824 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
830 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
832 return (!CONSP (map
) ? object
/* Invalid keymap */
833 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
839 store_in_keymap (keymap
, idx
, def
)
841 register Lisp_Object idx
;
842 register Lisp_Object def
;
844 /* Flush any reverse-map cache. */
845 where_is_cache
= Qnil
;
846 where_is_cache_keymaps
= Qt
;
848 /* If we are preparing to dump, and DEF is a menu element
849 with a menu item indicator, copy it to ensure it is not pure. */
850 if (CONSP (def
) && PURE_P (def
)
851 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
852 def
= Fcons (XCAR (def
), XCDR (def
));
854 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
855 error ("attempt to define a key in a non-keymap");
857 /* If idx is a list (some sort of mouse click, perhaps?),
858 the index we want to use is the car of the list, which
859 ought to be a symbol. */
860 idx
= EVENT_HEAD (idx
);
862 /* If idx is a symbol, it might have modifiers, which need to
863 be put in the canonical order. */
865 idx
= reorder_modifiers (idx
);
866 else if (INTEGERP (idx
))
867 /* Clobber the high bits that can be present on a machine
868 with more than 24 bits of integer. */
869 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
871 /* Scan the keymap for a binding of idx. */
875 /* The cons after which we should insert new bindings. If the
876 keymap has a table element, we record its position here, so new
877 bindings will go after it; this way, the table will stay
878 towards the front of the alist and character lookups in dense
879 keymaps will remain fast. Otherwise, this just points at the
880 front of the keymap. */
881 Lisp_Object insertion_point
;
883 insertion_point
= keymap
;
884 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
891 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
893 ASET (elt
, XFASTINT (idx
), def
);
896 insertion_point
= tail
;
898 else if (CHAR_TABLE_P (elt
))
900 /* Character codes with modifiers
901 are not included in a char-table.
902 All character codes without modifiers are included. */
903 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
906 /* `nil' has a special meaning for char-tables, so
907 we use something else to record an explicitly
909 NILP (def
) ? Qt
: def
);
912 insertion_point
= tail
;
914 else if (CONSP (elt
))
916 if (EQ (idx
, XCAR (elt
)))
922 else if (EQ (elt
, Qkeymap
))
923 /* If we find a 'keymap' symbol in the spine of KEYMAP,
924 then we must have found the start of a second keymap
925 being used as the tail of KEYMAP, and a binding for IDX
926 should be inserted before it. */
933 /* We have scanned the entire keymap, and not found a binding for
934 IDX. Let's add one. */
935 XSETCDR (insertion_point
,
936 Fcons (Fcons (idx
, def
), XCDR (insertion_point
)));
942 EXFUN (Fcopy_keymap
, 1);
945 copy_keymap_item (elt
)
948 Lisp_Object res
, tem
;
955 /* Is this a new format menu item. */
956 if (EQ (XCAR (tem
), Qmenu_item
))
958 /* Copy cell with menu-item marker. */
959 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
963 /* Copy cell with menu-item name. */
964 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
970 /* Copy cell with binding and if the binding is a keymap,
972 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
975 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
976 XSETCAR (elt
, Fcopy_keymap (tem
));
978 if (CONSP (tem
) && CONSP (XCAR (tem
)))
979 /* Delete cache for key equivalences. */
980 XSETCDR (elt
, XCDR (tem
));
985 /* It may be an old fomat menu item.
986 Skip the optional menu string. */
987 if (STRINGP (XCAR (tem
)))
989 /* Copy the cell, since copy-alist didn't go this deep. */
990 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
992 /* Also skip the optional menu help string. */
993 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
995 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
999 /* There may also be a list that caches key equivalences.
1000 Just delete it for the new keymap. */
1002 && CONSP (XCAR (tem
))
1003 && (NILP (XCAR (XCAR (tem
)))
1004 || VECTORP (XCAR (XCAR (tem
)))))
1006 XSETCDR (elt
, XCDR (tem
));
1009 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1010 XSETCDR (elt
, Fcopy_keymap (tem
));
1012 else if (EQ (XCAR (tem
), Qkeymap
))
1013 res
= Fcopy_keymap (elt
);
1019 copy_keymap_1 (chartable
, idx
, elt
)
1020 Lisp_Object chartable
, idx
, elt
;
1022 Faset (chartable
, idx
, copy_keymap_item (elt
));
1025 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1026 doc
: /* Return a copy of the keymap KEYMAP.
1027 The copy starts out with the same definitions of KEYMAP,
1028 but changing either the copy or KEYMAP does not affect the other.
1029 Any key definitions that are subkeymaps are recursively copied.
1030 However, a key definition which is a symbol whose definition is a keymap
1035 register Lisp_Object copy
, tail
;
1036 keymap
= get_keymap (keymap
, 1, 0);
1037 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1038 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1040 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1042 Lisp_Object elt
= XCAR (keymap
);
1043 if (CHAR_TABLE_P (elt
))
1045 Lisp_Object indices
[3];
1046 elt
= Fcopy_sequence (elt
);
1047 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, elt
, 0, indices
);
1049 else if (VECTORP (elt
))
1052 elt
= Fcopy_sequence (elt
);
1053 for (i
= 0; i
< ASIZE (elt
); i
++)
1054 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1056 else if (CONSP (elt
))
1057 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1058 XSETCDR (tail
, Fcons (elt
, Qnil
));
1060 keymap
= XCDR (keymap
);
1062 XSETCDR (tail
, keymap
);
1066 /* Simple Keymap mutators and accessors. */
1068 /* GC is possible in this function if it autoloads a keymap. */
1070 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1071 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1074 KEY is a string or a vector of symbols and characters meaning a
1075 sequence of keystrokes and events. Non-ASCII characters with codes
1076 above 127 (such as ISO Latin-1) can be included if you use a vector.
1077 Using [t] for KEY creates a default definition, which applies to any
1078 event type that has no other definition in this keymap.
1080 DEF is anything that can be a key's definition:
1081 nil (means key is undefined in this keymap),
1082 a command (a Lisp function suitable for interactive calling),
1083 a string (treated as a keyboard macro),
1084 a keymap (to define a prefix key),
1085 a symbol (when the key is looked up, the symbol will stand for its
1086 function definition, which should at that time be one of the above,
1087 or another symbol whose function definition is used, etc.),
1088 a cons (STRING . DEFN), meaning that DEFN is the definition
1089 (DEFN should be a valid definition in its own right),
1090 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1092 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1093 binding is altered. If there is no binding for KEY, the new pair
1094 binding KEY to DEF is added at the front of KEYMAP. */)
1101 register Lisp_Object c
;
1102 register Lisp_Object cmd
;
1106 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1108 GCPRO3 (keymap
, key
, def
);
1109 keymap
= get_keymap (keymap
, 1, 1);
1111 if (!VECTORP (key
) && !STRINGP (key
))
1112 key
= wrong_type_argument (Qarrayp
, key
);
1114 length
= XFASTINT (Flength (key
));
1116 RETURN_UNGCPRO (Qnil
);
1118 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1119 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1121 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1126 c
= Faref (key
, make_number (idx
));
1128 if (CONSP (c
) && lucid_event_type_list_p (c
))
1129 c
= Fevent_convert_list (c
);
1132 silly_event_symbol_error (c
);
1135 && (XINT (c
) & meta_bit
)
1138 c
= meta_prefix_char
;
1144 XSETINT (c
, XINT (c
) & ~meta_bit
);
1150 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
))
1151 error ("Key sequence contains invalid event");
1154 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1156 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1158 /* If this key is undefined, make it a prefix. */
1160 cmd
= define_as_prefix (keymap
, c
);
1162 keymap
= get_keymap (cmd
, 0, 1);
1163 if (!CONSP (keymap
))
1164 /* We must use Fkey_description rather than just passing key to
1165 error; key might be a vector, not a string. */
1166 error ("Key sequence %s uses invalid prefix characters",
1167 SDATA (Fkey_description (key
, Qnil
)));
1171 /* This function may GC (it calls Fkey_binding). */
1173 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1174 doc
: /* Return the remapping for command COMMAND in current keymaps.
1175 Returns nil if COMMAND is not remapped (or not a symbol). */)
1177 Lisp_Object command
;
1179 if (!SYMBOLP (command
))
1182 ASET (command_remapping_vector
, 1, command
);
1183 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1186 /* Value is number if KEY is too long; nil if valid but has no definition. */
1187 /* GC is possible in this function if it autoloads a keymap. */
1189 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1190 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1191 nil means undefined. See doc of `define-key' for kinds of definitions.
1193 A number as value means KEY is "too long";
1194 that is, characters or symbols in it except for the last one
1195 fail to be a valid sequence of prefix characters in KEYMAP.
1196 The number is how many characters at the front of KEY
1197 it takes to reach a non-prefix command.
1199 Normally, `lookup-key' ignores bindings for t, which act as default
1200 bindings, used when nothing else in the keymap applies; this makes it
1201 usable as a general function for probing keymaps. However, if the
1202 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1203 recognize the default bindings, just as `read-key-sequence' does. */)
1204 (keymap
, key
, accept_default
)
1207 Lisp_Object accept_default
;
1210 register Lisp_Object cmd
;
1211 register Lisp_Object c
;
1213 int t_ok
= !NILP (accept_default
);
1214 struct gcpro gcpro1
, gcpro2
;
1216 GCPRO2 (keymap
, key
);
1217 keymap
= get_keymap (keymap
, 1, 1);
1219 if (!VECTORP (key
) && !STRINGP (key
))
1220 key
= wrong_type_argument (Qarrayp
, key
);
1222 length
= XFASTINT (Flength (key
));
1224 RETURN_UNGCPRO (keymap
);
1229 c
= Faref (key
, make_number (idx
++));
1231 if (CONSP (c
) && lucid_event_type_list_p (c
))
1232 c
= Fevent_convert_list (c
);
1234 /* Turn the 8th bit of string chars into a meta modifier. */
1235 if (XINT (c
) & 0x80 && STRINGP (key
))
1236 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1238 /* Allow string since binding for `menu-bar-select-buffer'
1239 includes the buffer name in the key sequence. */
1240 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1241 error ("Key sequence contains invalid event");
1243 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1245 RETURN_UNGCPRO (cmd
);
1247 keymap
= get_keymap (cmd
, 0, 1);
1248 if (!CONSP (keymap
))
1249 RETURN_UNGCPRO (make_number (idx
));
1255 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1256 Assume that currently it does not define C at all.
1257 Return the keymap. */
1260 define_as_prefix (keymap
, c
)
1261 Lisp_Object keymap
, c
;
1265 cmd
= Fmake_sparse_keymap (Qnil
);
1266 /* If this key is defined as a prefix in an inherited keymap,
1267 make it a prefix in this map, and make its definition
1268 inherit the other prefix definition. */
1269 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1270 store_in_keymap (keymap
, c
, cmd
);
1275 /* Append a key to the end of a key sequence. We always make a vector. */
1278 append_key (key_sequence
, key
)
1279 Lisp_Object key_sequence
, key
;
1281 Lisp_Object args
[2];
1283 args
[0] = key_sequence
;
1285 args
[1] = Fcons (key
, Qnil
);
1286 return Fvconcat (2, args
);
1289 /* Given a event type C which is a symbol,
1290 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1293 silly_event_symbol_error (c
)
1296 Lisp_Object parsed
, base
, name
, assoc
;
1299 parsed
= parse_modifiers (c
);
1300 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1301 base
= XCAR (parsed
);
1302 name
= Fsymbol_name (base
);
1303 /* This alist includes elements such as ("RET" . "\\r"). */
1304 assoc
= Fassoc (name
, exclude_keys
);
1308 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1310 Lisp_Object keystring
;
1311 if (modifiers
& alt_modifier
)
1312 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1313 if (modifiers
& ctrl_modifier
)
1314 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1315 if (modifiers
& hyper_modifier
)
1316 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1317 if (modifiers
& meta_modifier
)
1318 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1319 if (modifiers
& shift_modifier
)
1320 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1321 if (modifiers
& super_modifier
)
1322 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1325 c
= reorder_modifiers (c
);
1326 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1328 error ((modifiers
& ~meta_modifier
1329 ? "To bind the key %s, use [?%s], not [%s]"
1330 : "To bind the key %s, use \"%s\", not [%s]"),
1331 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1332 SDATA (SYMBOL_NAME (c
)));
1336 /* Global, local, and minor mode keymap stuff. */
1338 /* We can't put these variables inside current_minor_maps, since under
1339 some systems, static gets macro-defined to be the empty string.
1341 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1342 static int cmm_size
= 0;
1344 /* Error handler used in current_minor_maps. */
1346 current_minor_maps_error ()
1351 /* Store a pointer to an array of the keymaps of the currently active
1352 minor modes in *buf, and return the number of maps it contains.
1354 This function always returns a pointer to the same buffer, and may
1355 free or reallocate it, so if you want to keep it for a long time or
1356 hand it out to lisp code, copy it. This procedure will be called
1357 for every key sequence read, so the nice lispy approach (return a
1358 new assoclist, list, what have you) for each invocation would
1359 result in a lot of consing over time.
1361 If we used xrealloc/xmalloc and ran out of memory, they would throw
1362 back to the command loop, which would try to read a key sequence,
1363 which would call this function again, resulting in an infinite
1364 loop. Instead, we'll use realloc/malloc and silently truncate the
1365 list, let the key sequence be read, and hope some other piece of
1366 code signals the error. */
1368 current_minor_maps (modeptr
, mapptr
)
1369 Lisp_Object
**modeptr
, **mapptr
;
1372 int list_number
= 0;
1373 Lisp_Object alist
, assoc
, var
, val
;
1374 Lisp_Object emulation_alists
;
1375 Lisp_Object lists
[2];
1377 emulation_alists
= Vemulation_mode_map_alists
;
1378 lists
[0] = Vminor_mode_overriding_map_alist
;
1379 lists
[1] = Vminor_mode_map_alist
;
1381 for (list_number
= 0; list_number
< 2; list_number
++)
1383 if (CONSP (emulation_alists
))
1385 alist
= XCAR (emulation_alists
);
1386 emulation_alists
= XCDR (emulation_alists
);
1387 if (SYMBOLP (alist
))
1388 alist
= find_symbol_value (alist
);
1392 alist
= lists
[list_number
];
1394 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1395 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1396 && (var
= XCAR (assoc
), SYMBOLP (var
))
1397 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1402 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1403 and also an entry in Vminor_mode_map_alist,
1404 ignore the latter. */
1405 if (list_number
== 1)
1407 val
= assq_no_quit (var
, lists
[0]);
1414 int newsize
, allocsize
;
1415 Lisp_Object
*newmodes
, *newmaps
;
1417 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1418 allocsize
= newsize
* sizeof *newmodes
;
1420 /* Use malloc here. See the comment above this function.
1421 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1423 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1428 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1431 cmm_modes
= newmodes
;
1434 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1439 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1446 if (newmodes
== NULL
|| newmaps
== NULL
)
1451 /* Get the keymap definition--or nil if it is not defined. */
1452 temp
= internal_condition_case_1 (Findirect_function
,
1454 Qerror
, current_minor_maps_error
);
1458 cmm_maps
[i
] = temp
;
1464 if (modeptr
) *modeptr
= cmm_modes
;
1465 if (mapptr
) *mapptr
= cmm_maps
;
1469 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1471 doc
: /* Return a list of the currently active keymaps.
1472 OLP if non-nil indicates that we should obey `overriding-local-map' and
1473 `overriding-terminal-local-map'. */)
1477 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1481 if (!NILP (Voverriding_local_map
))
1482 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1483 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1484 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1486 if (NILP (XCDR (keymaps
)))
1492 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1494 keymaps
= Fcons (local
, keymaps
);
1496 nmaps
= current_minor_maps (0, &maps
);
1498 for (i
= --nmaps
; i
>= 0; i
--)
1499 if (!NILP (maps
[i
]))
1500 keymaps
= Fcons (maps
[i
], keymaps
);
1502 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1504 keymaps
= Fcons (local
, keymaps
);
1510 /* GC is possible in this function if it autoloads a keymap. */
1512 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1513 doc
: /* Return the binding for command KEY in current keymaps.
1514 KEY is a string or vector, a sequence of keystrokes.
1515 The binding is probably a symbol with a function definition.
1517 Normally, `key-binding' ignores bindings for t, which act as default
1518 bindings, used when nothing else in the keymap applies; this makes it
1519 usable as a general function for probing keymaps. However, if the
1520 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1521 recognize the default bindings, just as `read-key-sequence' does.
1523 Like the normal command loop, `key-binding' will remap the command
1524 resulting from looking up KEY by looking up the command in the
1525 current keymaps. However, if the optional third argument NO-REMAP
1526 is non-nil, `key-binding' returns the unmapped command. */)
1527 (key
, accept_default
, no_remap
)
1528 Lisp_Object key
, accept_default
, no_remap
;
1530 Lisp_Object
*maps
, value
;
1532 struct gcpro gcpro1
;
1536 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1538 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1539 key
, accept_default
);
1540 if (! NILP (value
) && !INTEGERP (value
))
1543 else if (!NILP (Voverriding_local_map
))
1545 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1546 if (! NILP (value
) && !INTEGERP (value
))
1553 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1556 value
= Flookup_key (local
, key
, accept_default
);
1557 if (! NILP (value
) && !INTEGERP (value
))
1561 nmaps
= current_minor_maps (0, &maps
);
1562 /* Note that all these maps are GCPRO'd
1563 in the places where we found them. */
1565 for (i
= 0; i
< nmaps
; i
++)
1566 if (! NILP (maps
[i
]))
1568 value
= Flookup_key (maps
[i
], key
, accept_default
);
1569 if (! NILP (value
) && !INTEGERP (value
))
1573 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1576 value
= Flookup_key (local
, key
, accept_default
);
1577 if (! NILP (value
) && !INTEGERP (value
))
1582 value
= Flookup_key (current_global_map
, key
, accept_default
);
1586 if (NILP (value
) || INTEGERP (value
))
1589 /* If the result of the ordinary keymap lookup is an interactive
1590 command, look for a key binding (ie. remapping) for that command. */
1592 if (NILP (no_remap
) && SYMBOLP (value
))
1595 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1602 /* GC is possible in this function if it autoloads a keymap. */
1604 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1605 doc
: /* Return the binding for command KEYS in current local keymap only.
1606 KEYS is a string, a sequence of keystrokes.
1607 The binding is probably a symbol with a function definition.
1609 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1610 bindings; see the description of `lookup-key' for more details about this. */)
1611 (keys
, accept_default
)
1612 Lisp_Object keys
, accept_default
;
1614 register Lisp_Object map
;
1615 map
= current_buffer
->keymap
;
1618 return Flookup_key (map
, keys
, accept_default
);
1621 /* GC is possible in this function if it autoloads a keymap. */
1623 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1624 doc
: /* Return the binding for command KEYS in current global keymap only.
1625 KEYS is a string, a sequence of keystrokes.
1626 The binding is probably a symbol with a function definition.
1627 This function's return values are the same as those of `lookup-key'
1630 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1631 bindings; see the description of `lookup-key' for more details about this. */)
1632 (keys
, accept_default
)
1633 Lisp_Object keys
, accept_default
;
1635 return Flookup_key (current_global_map
, keys
, accept_default
);
1638 /* GC is possible in this function if it autoloads a keymap. */
1640 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1641 doc
: /* Find the visible minor mode bindings of KEY.
1642 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the
1643 the symbol which names the minor mode binding KEY, and BINDING is
1644 KEY's definition in that mode. In particular, if KEY has no
1645 minor-mode bindings, return nil. If the first binding is a
1646 non-prefix, all subsequent bindings will be omitted, since they would
1647 be ignored. Similarly, the list doesn't include non-prefix bindings
1648 that come after prefix bindings.
1650 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1651 bindings; see the description of `lookup-key' for more details about this. */)
1652 (key
, accept_default
)
1653 Lisp_Object key
, accept_default
;
1655 Lisp_Object
*modes
, *maps
;
1657 Lisp_Object binding
;
1659 struct gcpro gcpro1
, gcpro2
;
1661 nmaps
= current_minor_maps (&modes
, &maps
);
1662 /* Note that all these maps are GCPRO'd
1663 in the places where we found them. */
1666 GCPRO2 (key
, binding
);
1668 for (i
= j
= 0; i
< nmaps
; i
++)
1670 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1671 && !INTEGERP (binding
))
1673 if (KEYMAPP (binding
))
1674 maps
[j
++] = Fcons (modes
[i
], binding
);
1676 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1680 return Flist (j
, maps
);
1683 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1684 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1685 A new sparse keymap is stored as COMMAND's function definition and its value.
1686 If a second optional argument MAPVAR is given, the map is stored as
1687 its value instead of as COMMAND's value; but COMMAND is still defined
1689 The third optional argument NAME, if given, supplies a menu name
1690 string for the map. This is required to use the keymap as a menu.
1691 This function returns COMMAND. */)
1692 (command
, mapvar
, name
)
1693 Lisp_Object command
, mapvar
, name
;
1696 map
= Fmake_sparse_keymap (name
);
1697 Ffset (command
, map
);
1701 Fset (command
, map
);
1705 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1706 doc
: /* Select KEYMAP as the global keymap. */)
1710 keymap
= get_keymap (keymap
, 1, 1);
1711 current_global_map
= keymap
;
1716 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1717 doc
: /* Select KEYMAP as the local keymap.
1718 If KEYMAP is nil, that means no local keymap. */)
1723 keymap
= get_keymap (keymap
, 1, 1);
1725 current_buffer
->keymap
= keymap
;
1730 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1731 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1734 return current_buffer
->keymap
;
1737 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1738 doc
: /* Return the current global keymap. */)
1741 return current_global_map
;
1744 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1745 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1749 int nmaps
= current_minor_maps (0, &maps
);
1751 return Flist (nmaps
, maps
);
1754 /* Help functions for describing and documenting keymaps. */
1758 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1759 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1760 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1764 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1768 /* Look for and break cycles. */
1769 while (!NILP (tem
= Frassq (cmd
, maps
)))
1771 Lisp_Object prefix
= XCAR (tem
);
1772 int lim
= XINT (Flength (XCAR (tem
)));
1773 if (lim
<= XINT (Flength (thisseq
)))
1774 { /* This keymap was already seen with a smaller prefix. */
1776 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1777 Faref (thisseq
, make_number (i
))))
1780 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1783 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1784 but maybe `cmd' occurs again further down in `maps', so keep
1786 maps
= XCDR (Fmemq (tem
, maps
));
1789 /* If the last key in thisseq is meta-prefix-char,
1790 turn it into a meta-ized keystroke. We know
1791 that the event we're about to append is an
1792 ascii keystroke since we're processing a
1796 int meta_bit
= meta_modifier
;
1797 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1798 tem
= Fcopy_sequence (thisseq
);
1800 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1802 /* This new sequence is the same length as
1803 thisseq, so stick it in the list right
1806 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1810 tem
= append_key (thisseq
, key
);
1811 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1816 accessible_keymaps_char_table (args
, index
, cmd
)
1817 Lisp_Object args
, index
, cmd
;
1819 accessible_keymaps_1 (index
, cmd
,
1823 XINT (XCDR (XCAR (args
))));
1826 /* This function cannot GC. */
1828 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1830 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1831 Returns a list of elements of the form (KEYS . MAP), where the sequence
1832 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1833 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1834 An optional argument PREFIX, if non-nil, should be a key sequence;
1835 then the value includes only maps for prefixes that start with PREFIX. */)
1837 Lisp_Object keymap
, prefix
;
1839 Lisp_Object maps
, tail
;
1842 /* no need for gcpro because we don't autoload any keymaps. */
1845 prefixlen
= XINT (Flength (prefix
));
1849 /* If a prefix was specified, start with the keymap (if any) for
1850 that prefix, so we don't waste time considering other prefixes. */
1852 tem
= Flookup_key (keymap
, prefix
, Qt
);
1853 /* Flookup_key may give us nil, or a number,
1854 if the prefix is not defined in this particular map.
1855 It might even give us a list that isn't a keymap. */
1856 tem
= get_keymap (tem
, 0, 0);
1859 /* Convert PREFIX to a vector now, so that later on
1860 we don't have to deal with the possibility of a string. */
1861 if (STRINGP (prefix
))
1866 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1867 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1871 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1872 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1873 c
^= 0200 | meta_modifier
;
1874 ASET (copy
, i_before
, make_number (c
));
1878 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1884 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1885 get_keymap (keymap
, 1, 0)),
1888 /* For each map in the list maps,
1889 look at any other maps it points to,
1890 and stick them at the end if they are not already in the list.
1892 This is a breadth-first traversal, where tail is the queue of
1893 nodes, and maps accumulates a list of all nodes visited. */
1895 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1897 register Lisp_Object thisseq
, thismap
;
1899 /* Does the current sequence end in the meta-prefix-char? */
1902 thisseq
= Fcar (Fcar (tail
));
1903 thismap
= Fcdr (Fcar (tail
));
1904 last
= make_number (XINT (Flength (thisseq
)) - 1);
1905 is_metized
= (XINT (last
) >= 0
1906 /* Don't metize the last char of PREFIX. */
1907 && XINT (last
) >= prefixlen
1908 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1910 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1914 elt
= XCAR (thismap
);
1918 if (CHAR_TABLE_P (elt
))
1920 Lisp_Object indices
[3];
1922 map_char_table (accessible_keymaps_char_table
, Qnil
, elt
,
1923 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1924 Fcons (tail
, thisseq
)),
1927 else if (VECTORP (elt
))
1931 /* Vector keymap. Scan all the elements. */
1932 for (i
= 0; i
< ASIZE (elt
); i
++)
1933 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1934 maps
, tail
, thisseq
, is_metized
);
1937 else if (CONSP (elt
))
1938 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1939 maps
, tail
, thisseq
,
1940 is_metized
&& INTEGERP (XCAR (elt
)));
1948 Lisp_Object Qsingle_key_description
, Qkey_description
;
1950 /* This function cannot GC. */
1952 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
1953 doc
: /* Return a pretty description of key-sequence KEYS.
1954 Optional arg PREFIX is the sequence of keys leading up to KEYS.
1955 Control characters turn into "C-foo" sequences, meta into "M-foo",
1956 spaces are put between sequence elements, etc. */)
1958 Lisp_Object keys
, prefix
;
1963 int size
= XINT (Flength (keys
));
1965 Lisp_Object sep
= build_string (" ");
1970 size
+= XINT (Flength (prefix
));
1972 /* This has one extra element at the end that we don't pass to Fconcat. */
1973 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
1975 /* In effect, this computes
1976 (mapconcat 'single-key-description keys " ")
1977 but we shouldn't use mapconcat because it can do GC. */
1981 list
= prefix
, prefix
= Qnil
;
1982 else if (!NILP (keys
))
1983 list
= keys
, keys
= Qnil
;
1988 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
1992 return empty_string
;
1993 return Fconcat (len
- 1, args
);
1997 size
= SCHARS (list
);
1998 else if (VECTORP (list
))
1999 size
= XVECTOR (list
)->size
;
2000 else if (CONSP (list
))
2001 size
= XINT (Flength (list
));
2003 wrong_type_argument (Qarrayp
, list
);
2012 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2013 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2014 c
^= 0200 | meta_modifier
;
2015 XSETFASTINT (key
, c
);
2017 else if (VECTORP (list
))
2019 key
= AREF (list
, i
++);
2031 || EQ (key
, meta_prefix_char
)
2032 || (XINT (key
) & meta_modifier
))
2034 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2036 if (EQ (key
, meta_prefix_char
))
2040 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2043 else if (EQ (key
, meta_prefix_char
))
2048 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2056 push_key_description (c
, p
, force_multibyte
)
2057 register unsigned int c
;
2059 int force_multibyte
;
2063 /* Clear all the meaningless bits above the meta bit. */
2064 c
&= meta_modifier
| ~ - meta_modifier
;
2065 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2066 | meta_modifier
| shift_modifier
| super_modifier
);
2068 if (c
& alt_modifier
)
2074 if ((c
& ctrl_modifier
) != 0
2075 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2079 c
&= ~ctrl_modifier
;
2081 if (c
& hyper_modifier
)
2085 c
-= hyper_modifier
;
2087 if (c
& meta_modifier
)
2093 if (c
& shift_modifier
)
2097 c
-= shift_modifier
;
2099 if (c
& super_modifier
)
2103 c
-= super_modifier
;
2119 else if (c
== Ctl ('M'))
2127 /* `C-' already added above. */
2128 if (c
> 0 && c
<= Ctl ('Z'))
2147 || (NILP (current_buffer
->enable_multibyte_characters
)
2148 && SINGLE_BYTE_CHAR_P (c
)
2149 && !force_multibyte
))
2155 int valid_p
= SINGLE_BYTE_CHAR_P (c
) || char_valid_p (c
, 0);
2157 if (force_multibyte
&& valid_p
)
2159 if (SINGLE_BYTE_CHAR_P (c
))
2160 c
= unibyte_char_to_multibyte (c
);
2161 p
+= CHAR_STRING (c
, p
);
2163 else if (NILP (current_buffer
->enable_multibyte_characters
)
2168 /* The biggest character code uses 19 bits. */
2169 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
2171 if (c
>= (1 << bit_offset
))
2172 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2176 p
+= CHAR_STRING (c
, p
);
2182 /* This function cannot GC. */
2184 DEFUN ("single-key-description", Fsingle_key_description
,
2185 Ssingle_key_description
, 1, 2, 0,
2186 doc
: /* Return a pretty description of command character KEY.
2187 Control characters turn into C-whatever, etc.
2188 Optional argument NO-ANGLES non-nil means don't put angle brackets
2189 around function keys and event symbols. */)
2191 Lisp_Object key
, no_angles
;
2193 if (CONSP (key
) && lucid_event_type_list_p (key
))
2194 key
= Fevent_convert_list (key
);
2196 key
= EVENT_HEAD (key
);
2198 if (INTEGERP (key
)) /* Normal character */
2200 unsigned int charset
, c1
, c2
;
2201 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
2203 if (SINGLE_BYTE_CHAR_P (without_bits
))
2206 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
2209 && CHARSET_DEFINED_P (charset
)
2210 && ((c1
>= 0 && c1
< 32)
2211 || (c2
>= 0 && c2
< 32)))
2213 /* Handle a generic character. */
2215 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
2216 CHECK_STRING (name
);
2217 return concat2 (build_string ("Character set "), name
);
2221 char tem
[KEY_DESCRIPTION_SIZE
], *end
;
2225 end
= push_key_description (XUINT (key
), tem
, 1);
2227 nchars
= multibyte_chars_in_text (tem
, nbytes
);
2228 if (nchars
== nbytes
)
2231 string
= build_string (tem
);
2234 string
= make_multibyte_string (tem
, nchars
, nbytes
);
2238 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2240 if (NILP (no_angles
))
2243 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2244 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2245 return build_string (buffer
);
2248 return Fsymbol_name (key
);
2250 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2251 return Fcopy_sequence (key
);
2253 error ("KEY must be an integer, cons, symbol, or string");
2258 push_text_char_description (c
, p
)
2259 register unsigned int c
;
2271 *p
++ = c
+ 64; /* 'A' - 1 */
2283 /* This function cannot GC. */
2285 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2286 doc
: /* Return a pretty description of file-character CHARACTER.
2287 Control characters turn into "^char", etc. This differs from
2288 `single-key-description' which turns them into "C-char".
2289 Also, this function recognizes the 2**7 bit as the Meta character,
2290 whereas `single-key-description' uses the 2**27 bit for Meta.
2291 See Info node `(elisp)Describing Characters' for examples. */)
2293 Lisp_Object character
;
2295 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2296 unsigned char str
[6];
2299 CHECK_NUMBER (character
);
2301 c
= XINT (character
);
2302 if (!SINGLE_BYTE_CHAR_P (c
))
2304 int len
= CHAR_STRING (c
, str
);
2306 return make_multibyte_string (str
, 1, len
);
2309 *push_text_char_description (c
& 0377, str
) = 0;
2311 return build_string (str
);
2314 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2317 ascii_sequence_p (seq
)
2321 int len
= XINT (Flength (seq
));
2323 for (i
= 0; i
< len
; i
++)
2325 Lisp_Object ii
, elt
;
2327 XSETFASTINT (ii
, i
);
2328 elt
= Faref (seq
, ii
);
2331 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2339 /* where-is - finding a command in a set of keymaps. */
2341 static Lisp_Object
where_is_internal ();
2342 static Lisp_Object
where_is_internal_1 ();
2343 static void where_is_internal_2 ();
2345 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2346 Returns the first non-nil binding found in any of those maps. */
2349 shadow_lookup (shadow
, key
, flag
)
2350 Lisp_Object shadow
, key
, flag
;
2352 Lisp_Object tail
, value
;
2354 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2356 value
= Flookup_key (XCAR (tail
), key
, flag
);
2357 if (!NILP (value
) && !NATNUMP (value
))
2363 static Lisp_Object Vmouse_events
;
2365 /* This function can GC if Flookup_key autoloads any keymaps. */
2368 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2369 Lisp_Object definition
, keymaps
;
2370 Lisp_Object firstonly
, noindirect
, no_remap
;
2372 Lisp_Object maps
= Qnil
;
2373 Lisp_Object found
, sequences
;
2374 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2375 /* 1 means ignore all menu bindings entirely. */
2376 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2378 /* If this command is remapped, then it has no key bindings
2380 if (NILP (no_remap
) && SYMBOLP (definition
))
2383 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2388 while (CONSP (found
))
2392 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2393 found
= XCDR (found
);
2396 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2400 for (; !NILP (maps
); maps
= Fcdr (maps
))
2402 /* Key sequence to reach map, and the map that it reaches */
2403 register Lisp_Object
this, map
, tem
;
2405 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2406 [M-CHAR] sequences, check if last character of the sequence
2407 is the meta-prefix char. */
2411 this = Fcar (Fcar (maps
));
2412 map
= Fcdr (Fcar (maps
));
2413 last
= make_number (XINT (Flength (this)) - 1);
2414 last_is_meta
= (XINT (last
) >= 0
2415 && EQ (Faref (this, last
), meta_prefix_char
));
2417 /* if (nomenus && !ascii_sequence_p (this)) */
2418 if (nomenus
&& XINT (last
) >= 0
2419 && SYMBOLP (tem
= Faref (this, make_number (0)))
2420 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2421 /* If no menu entries should be returned, skip over the
2422 keymaps bound to `menu-bar' and `tool-bar' and other
2423 non-ascii prefixes like `C-down-mouse-2'. */
2430 /* Because the code we want to run on each binding is rather
2431 large, we don't want to have two separate loop bodies for
2432 sparse keymap bindings and tables; we want to iterate one
2433 loop body over both keymap and vector bindings.
2435 For this reason, if Fcar (map) is a vector, we don't
2436 advance map to the next element until i indicates that we
2437 have finished off the vector. */
2438 Lisp_Object elt
, key
, binding
;
2446 /* Set key and binding to the current key and binding, and
2447 advance map and i to the next binding. */
2450 Lisp_Object sequence
;
2452 /* In a vector, look at each element. */
2453 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2455 binding
= AREF (elt
, i
);
2456 XSETFASTINT (key
, i
);
2457 sequence
= where_is_internal_1 (binding
, key
, definition
,
2459 last
, nomenus
, last_is_meta
);
2460 if (!NILP (sequence
))
2461 sequences
= Fcons (sequence
, sequences
);
2464 else if (CHAR_TABLE_P (elt
))
2466 Lisp_Object indices
[3];
2469 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2470 Qnil
), /* Result accumulator. */
2471 Fcons (Fcons (this, last
),
2472 Fcons (make_number (nomenus
),
2473 make_number (last_is_meta
))));
2474 map_char_table (where_is_internal_2
, Qnil
, elt
, elt
, args
,
2476 sequences
= XCDR (XCAR (args
));
2478 else if (CONSP (elt
))
2480 Lisp_Object sequence
;
2483 binding
= XCDR (elt
);
2485 sequence
= where_is_internal_1 (binding
, key
, definition
,
2487 last
, nomenus
, last_is_meta
);
2488 if (!NILP (sequence
))
2489 sequences
= Fcons (sequence
, sequences
);
2493 while (!NILP (sequences
))
2495 Lisp_Object sequence
, remapped
, function
;
2497 sequence
= XCAR (sequences
);
2498 sequences
= XCDR (sequences
);
2500 /* If the current sequence is a command remapping with
2501 format [remap COMMAND], find the key sequences
2502 which run COMMAND, and use those sequences instead. */
2505 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2506 && EQ (AREF (sequence
, 0), Qremap
)
2507 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2509 Lisp_Object remapped1
;
2511 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2512 if (CONSP (remapped1
))
2514 /* Verify that this key binding actually maps to the
2515 remapped command (see below). */
2516 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2518 sequence
= XCAR (remapped1
);
2519 remapped
= XCDR (remapped1
);
2520 goto record_sequence
;
2524 /* Verify that this key binding is not shadowed by another
2525 binding for the same key, before we say it exists.
2527 Mechanism: look for local definition of this key and if
2528 it is defined and does not match what we found then
2531 Either nil or number as value from Flookup_key
2533 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2537 /* It is a true unshadowed match. Record it, unless it's already
2538 been seen (as could happen when inheriting keymaps). */
2539 if (NILP (Fmember (sequence
, found
)))
2540 found
= Fcons (sequence
, found
);
2542 /* If firstonly is Qnon_ascii, then we can return the first
2543 binding we find. If firstonly is not Qnon_ascii but not
2544 nil, then we should return the first ascii-only binding
2546 if (EQ (firstonly
, Qnon_ascii
))
2547 RETURN_UNGCPRO (sequence
);
2548 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2549 RETURN_UNGCPRO (sequence
);
2551 if (CONSP (remapped
))
2553 sequence
= XCAR (remapped
);
2554 remapped
= XCDR (remapped
);
2555 goto record_sequence
;
2563 found
= Fnreverse (found
);
2565 /* firstonly may have been t, but we may have gone all the way through
2566 the keymaps without finding an all-ASCII key sequence. So just
2567 return the best we could find. */
2568 if (!NILP (firstonly
))
2569 return Fcar (found
);
2574 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2575 doc
: /* Return list of keys that invoke DEFINITION.
2576 If KEYMAP is non-nil, search only KEYMAP and the global keymap.
2577 If KEYMAP is nil, search all the currently active keymaps.
2578 If KEYMAP is a list of keymaps, search only those keymaps.
2580 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2581 rather than a list of all possible key sequences.
2582 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2583 no matter what it is.
2584 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters,
2585 and entirely reject menu bindings.
2587 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2588 to other keymaps or slots. This makes it possible to search for an
2589 indirect definition itself.
2591 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2592 that invoke a command which is remapped to DEFINITION, but include the
2593 remapped command in the returned list. */)
2594 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2595 Lisp_Object definition
, keymap
;
2596 Lisp_Object firstonly
, noindirect
, no_remap
;
2598 Lisp_Object sequences
, keymaps
;
2599 /* 1 means ignore all menu bindings entirely. */
2600 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2603 /* Find the relevant keymaps. */
2604 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2606 else if (!NILP (keymap
))
2607 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2609 keymaps
= Fcurrent_active_maps (Qnil
);
2611 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2612 We don't really need to check `keymap'. */
2613 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2617 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2619 /* Check heuristic-consistency of the cache. */
2620 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2621 where_is_cache
= Qnil
;
2623 if (NILP (where_is_cache
))
2625 /* We need to create the cache. */
2626 Lisp_Object args
[2];
2627 where_is_cache
= Fmake_hash_table (0, args
);
2628 where_is_cache_keymaps
= Qt
;
2630 /* Fill in the cache. */
2631 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2632 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2635 where_is_cache_keymaps
= keymaps
;
2638 /* We want to process definitions from the last to the first.
2639 Instead of consing, copy definitions to a vector and step
2640 over that vector. */
2641 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2642 n
= XINT (Flength (sequences
));
2643 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2644 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2645 defns
[i
++] = XCAR (sequences
);
2647 /* Verify that the key bindings are not shadowed. Note that
2648 the following can GC. */
2649 GCPRO2 (definition
, keymaps
);
2652 for (i
= n
- 1; i
>= 0; --i
)
2653 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2655 if (ascii_sequence_p (defns
[i
]))
2661 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2666 /* Kill the cache so that where_is_internal_1 doesn't think
2667 we're filling it up. */
2668 where_is_cache
= Qnil
;
2669 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2675 /* This is the function that Fwhere_is_internal calls using map_char_table.
2677 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2679 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2680 Since map_char_table doesn't really use the return value from this function,
2681 we the result append to RESULT, the slot in ARGS.
2683 This function can GC because it calls where_is_internal_1 which can
2687 where_is_internal_2 (args
, key
, binding
)
2688 Lisp_Object args
, key
, binding
;
2690 Lisp_Object definition
, noindirect
, this, last
;
2691 Lisp_Object result
, sequence
;
2692 int nomenus
, last_is_meta
;
2693 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2695 GCPRO3 (args
, key
, binding
);
2696 result
= XCDR (XCAR (args
));
2697 definition
= XCAR (XCAR (XCAR (args
)));
2698 noindirect
= XCDR (XCAR (XCAR (args
)));
2699 this = XCAR (XCAR (XCDR (args
)));
2700 last
= XCDR (XCAR (XCDR (args
)));
2701 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2702 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2704 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2705 this, last
, nomenus
, last_is_meta
);
2707 if (!NILP (sequence
))
2708 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2714 /* This function cannot GC. */
2717 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2718 nomenus
, last_is_meta
)
2719 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2720 int nomenus
, last_is_meta
;
2722 Lisp_Object sequence
;
2724 /* Search through indirections unless that's not wanted. */
2725 if (NILP (noindirect
))
2726 binding
= get_keyelt (binding
, 0);
2728 /* End this iteration if this element does not match
2731 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2732 || EQ (binding
, definition
)
2733 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2734 /* Doesn't match. */
2737 /* We have found a match. Construct the key sequence where we found it. */
2738 if (INTEGERP (key
) && last_is_meta
)
2740 sequence
= Fcopy_sequence (this);
2741 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2744 sequence
= append_key (this, key
);
2746 if (!NILP (where_is_cache
))
2748 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2749 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2756 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2758 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2759 doc
: /* Insert the list of all defined keys and their definitions.
2760 The list is inserted in the current buffer, while the bindings are
2761 looked up in BUFFER.
2762 The optional argument PREFIX, if non-nil, should be a key sequence;
2763 then we display only bindings that start with that prefix.
2764 The optional argument MENUS, if non-nil, says to mention menu bindings.
2765 \(Ordinarily these are omitted from the output.) */)
2766 (buffer
, prefix
, menus
)
2767 Lisp_Object buffer
, prefix
, menus
;
2769 Lisp_Object outbuf
, shadow
;
2770 int nomenu
= NILP (menus
);
2771 register Lisp_Object start1
;
2772 struct gcpro gcpro1
;
2774 char *alternate_heading
2776 Keyboard translations:\n\n\
2777 You type Translation\n\
2778 -------- -----------\n";
2783 outbuf
= Fcurrent_buffer ();
2785 /* Report on alternates for keys. */
2786 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2789 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2790 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2792 for (c
= 0; c
< translate_len
; c
++)
2793 if (translate
[c
] != c
)
2795 char buf
[KEY_DESCRIPTION_SIZE
];
2798 if (alternate_heading
)
2800 insert_string (alternate_heading
);
2801 alternate_heading
= 0;
2804 bufend
= push_key_description (translate
[c
], buf
, 1);
2805 insert (buf
, bufend
- buf
);
2806 Findent_to (make_number (16), make_number (1));
2807 bufend
= push_key_description (c
, buf
, 1);
2808 insert (buf
, bufend
- buf
);
2816 if (!NILP (Vkey_translation_map
))
2817 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2818 "Key translations", nomenu
, 1, 0);
2821 /* Print the (major mode) local map. */
2823 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2824 start1
= current_kboard
->Voverriding_terminal_local_map
;
2825 else if (!NILP (Voverriding_local_map
))
2826 start1
= Voverriding_local_map
;
2830 describe_map_tree (start1
, 1, shadow
, prefix
,
2831 "\f\nOverriding Bindings", nomenu
, 0, 0);
2832 shadow
= Fcons (start1
, shadow
);
2836 /* Print the minor mode and major mode keymaps. */
2838 Lisp_Object
*modes
, *maps
;
2840 /* Temporarily switch to `buffer', so that we can get that buffer's
2841 minor modes correctly. */
2842 Fset_buffer (buffer
);
2844 nmaps
= current_minor_maps (&modes
, &maps
);
2845 Fset_buffer (outbuf
);
2847 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2848 XBUFFER (buffer
), Qkeymap
);
2851 describe_map_tree (start1
, 1, shadow
, prefix
,
2852 "\f\n`keymap' Property Bindings", nomenu
, 0, 0);
2853 shadow
= Fcons (start1
, shadow
);
2856 /* Print the minor mode maps. */
2857 for (i
= 0; i
< nmaps
; i
++)
2859 /* The title for a minor mode keymap
2860 is constructed at run time.
2861 We let describe_map_tree do the actual insertion
2862 because it takes care of other features when doing so. */
2865 if (!SYMBOLP (modes
[i
]))
2868 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2872 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2873 SCHARS (SYMBOL_NAME (modes
[i
])));
2874 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2876 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2877 p
+= sizeof (" Minor Mode Bindings") - 1;
2880 describe_map_tree (maps
[i
], 1, shadow
, prefix
, title
, nomenu
, 0, 0);
2881 shadow
= Fcons (maps
[i
], shadow
);
2884 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2885 XBUFFER (buffer
), Qlocal_map
);
2888 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2889 describe_map_tree (start1
, 1, shadow
, prefix
,
2890 "\f\nMajor Mode Bindings", nomenu
, 0, 0);
2892 describe_map_tree (start1
, 1, shadow
, prefix
,
2893 "\f\n`local-map' Property Bindings",
2896 shadow
= Fcons (start1
, shadow
);
2900 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2901 "\f\nGlobal Bindings", nomenu
, 0, 1);
2903 /* Print the function-key-map translations under this prefix. */
2904 if (!NILP (Vfunction_key_map
))
2905 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2906 "\f\nFunction key map translations", nomenu
, 1, 0);
2912 /* Insert a description of the key bindings in STARTMAP,
2913 followed by those of all maps reachable through STARTMAP.
2914 If PARTIAL is nonzero, omit certain "uninteresting" commands
2915 (such as `undefined').
2916 If SHADOW is non-nil, it is a list of maps;
2917 don't mention keys which would be shadowed by any of them.
2918 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2919 TITLE, if not 0, is a string to insert at the beginning.
2920 TITLE should not end with a colon or a newline; we supply that.
2921 If NOMENU is not 0, then omit menu-bar commands.
2923 If TRANSL is nonzero, the definitions are actually key translations
2924 so print strings and vectors differently.
2926 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2930 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2932 Lisp_Object startmap
, shadow
, prefix
;
2939 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2940 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2947 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
2950 GCPRO3 (maps
, seen
, sub_shadows
);
2956 /* Delete from MAPS each element that is for the menu bar. */
2957 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
2959 Lisp_Object elt
, prefix
, tem
;
2962 prefix
= Fcar (elt
);
2963 if (XVECTOR (prefix
)->size
>= 1)
2965 tem
= Faref (prefix
, make_number (0));
2966 if (EQ (tem
, Qmenu_bar
))
2967 maps
= Fdelq (elt
, maps
);
2972 if (!NILP (maps
) || always_title
)
2976 insert_string (title
);
2979 insert_string (" Starting With ");
2980 insert1 (Fkey_description (prefix
, Qnil
));
2982 insert_string (":\n");
2984 insert_string (key_heading
);
2988 for (; !NILP (maps
); maps
= Fcdr (maps
))
2990 register Lisp_Object elt
, prefix
, tail
;
2993 prefix
= Fcar (elt
);
2997 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
3001 shmap
= XCAR (tail
);
3003 /* If the sequence by which we reach this keymap is zero-length,
3004 then the shadow map for this keymap is just SHADOW. */
3005 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
3006 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
3008 /* If the sequence by which we reach this keymap actually has
3009 some elements, then the sequence's definition in SHADOW is
3010 what we should use. */
3013 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
3014 if (INTEGERP (shmap
))
3018 /* If shmap is not nil and not a keymap,
3019 it completely shadows this map, so don't
3020 describe this map at all. */
3021 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3025 sub_shadows
= Fcons (shmap
, sub_shadows
);
3028 /* Maps we have already listed in this loop shadow this map. */
3029 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3032 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3034 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3037 describe_map (Fcdr (elt
), prefix
,
3038 transl
? describe_translation
: describe_command
,
3039 partial
, sub_shadows
, &seen
, nomenu
);
3045 insert_string ("\n");
3050 static int previous_description_column
;
3053 describe_command (definition
, args
)
3054 Lisp_Object definition
, args
;
3056 register Lisp_Object tem1
;
3057 int column
= (int) current_column (); /* iftc */
3058 int description_column
;
3060 /* If column 16 is no good, go to col 32;
3061 but don't push beyond that--go to next line instead. */
3065 description_column
= 32;
3067 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3068 description_column
= 32;
3070 description_column
= 16;
3072 Findent_to (make_number (description_column
), make_number (1));
3073 previous_description_column
= description_column
;
3075 if (SYMBOLP (definition
))
3077 tem1
= SYMBOL_NAME (definition
);
3079 insert_string ("\n");
3081 else if (STRINGP (definition
) || VECTORP (definition
))
3082 insert_string ("Keyboard Macro\n");
3083 else if (KEYMAPP (definition
))
3084 insert_string ("Prefix Command\n");
3086 insert_string ("??\n");
3090 describe_translation (definition
, args
)
3091 Lisp_Object definition
, args
;
3093 register Lisp_Object tem1
;
3095 Findent_to (make_number (16), make_number (1));
3097 if (SYMBOLP (definition
))
3099 tem1
= SYMBOL_NAME (definition
);
3101 insert_string ("\n");
3103 else if (STRINGP (definition
) || VECTORP (definition
))
3105 insert1 (Fkey_description (definition
, Qnil
));
3106 insert_string ("\n");
3108 else if (KEYMAPP (definition
))
3109 insert_string ("Prefix Command\n");
3111 insert_string ("??\n");
3114 /* Describe the contents of map MAP, assuming that this map itself is
3115 reached by the sequence of prefix keys PREFIX (a string or vector).
3116 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3119 describe_map (map
, prefix
, elt_describer
, partial
, shadow
, seen
, nomenu
)
3120 register Lisp_Object map
;
3122 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3128 Lisp_Object tail
, definition
, event
;
3130 Lisp_Object suppress
;
3133 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3138 suppress
= intern ("suppress-keymap");
3140 /* This vector gets used to present single keys to Flookup_key. Since
3141 that is done once per keymap element, we don't want to cons up a
3142 fresh vector every time. */
3143 kludge
= Fmake_vector (make_number (1), Qnil
);
3146 GCPRO3 (prefix
, definition
, kludge
);
3148 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3152 if (VECTORP (XCAR (tail
))
3153 || CHAR_TABLE_P (XCAR (tail
)))
3154 describe_vector (XCAR (tail
),
3155 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3157 else if (CONSP (XCAR (tail
)))
3159 event
= XCAR (XCAR (tail
));
3161 /* Ignore bindings whose "prefix" are not really valid events.
3162 (We get these in the frames and buffers menu.) */
3163 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3166 if (nomenu
&& EQ (event
, Qmenu_bar
))
3169 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3171 /* Don't show undefined commands or suppressed commands. */
3172 if (NILP (definition
)) continue;
3173 if (SYMBOLP (definition
) && partial
)
3175 tem
= Fget (definition
, suppress
);
3180 /* Don't show a command that isn't really visible
3181 because a local definition of the same key shadows it. */
3183 ASET (kludge
, 0, event
);
3186 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3187 if (!NILP (tem
)) continue;
3190 tem
= Flookup_key (map
, kludge
, Qt
);
3191 if (!EQ (tem
, definition
)) continue;
3195 previous_description_column
= 0;
3200 /* THIS gets the string to describe the character EVENT. */
3201 insert1 (Fkey_description (kludge
, prefix
));
3203 /* Print a description of the definition of this character.
3204 elt_describer will take care of spacing out far enough
3205 for alignment purposes. */
3206 (*elt_describer
) (definition
, Qnil
);
3208 else if (EQ (XCAR (tail
), Qkeymap
))
3210 /* The same keymap might be in the structure twice, if we're
3211 using an inherited keymap. So skip anything we've already
3213 tem
= Fassq (tail
, *seen
);
3214 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3216 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3224 describe_vector_princ (elt
, fun
)
3225 Lisp_Object elt
, fun
;
3227 Findent_to (make_number (16), make_number (1));
3232 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3233 doc
: /* Insert a description of contents of VECTOR.
3234 This is text showing the elements of vector matched against indices.
3235 DESCRIBER is the output function used; nil means use `princ'. */)
3237 Lisp_Object vector
, describer
;
3239 int count
= SPECPDL_INDEX ();
3240 if (NILP (describer
))
3241 describer
= intern ("princ");
3242 specbind (Qstandard_output
, Fcurrent_buffer ());
3243 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3244 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3245 Qnil
, Qnil
, (int *)0, 0, 0);
3247 return unbind_to (count
, Qnil
);
3250 /* Insert in the current buffer a description of the contents of VECTOR.
3251 We call ELT_DESCRIBER to insert the description of one value found
3254 ELT_PREFIX describes what "comes before" the keys or indices defined
3255 by this vector. This is a human-readable string whose size
3256 is not necessarily related to the situation.
3258 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3259 leads to this keymap.
3261 If the vector is a chartable, ELT_PREFIX is the vector
3262 of bytes that lead to the character set or portion of a character
3263 set described by this chartable.
3265 If PARTIAL is nonzero, it means do not mention suppressed commands
3266 (that assumes the vector is in a keymap).
3268 SHADOW is a list of keymaps that shadow this map.
3269 If it is non-nil, then we look up the key in those maps
3270 and we don't mention it now if it is defined by any of them.
3272 ENTIRE_MAP is the keymap in which this vector appears.
3273 If the definition in effect in the whole map does not match
3274 the one in this vector, we ignore this one.
3276 When describing a sub-char-table, INDICES is a list of
3277 indices at higher levels in this char-table,
3278 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3280 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3282 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3285 describe_vector (vector
, prefix
, args
, elt_describer
,
3286 partial
, shadow
, entire_map
,
3287 indices
, char_table_depth
, keymap_p
)
3288 register Lisp_Object vector
;
3289 Lisp_Object prefix
, args
;
3290 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3293 Lisp_Object entire_map
;
3295 int char_table_depth
;
3298 Lisp_Object definition
;
3300 Lisp_Object elt_prefix
= Qnil
;
3302 Lisp_Object suppress
;
3305 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3306 /* Range of elements to be handled. */
3308 /* A flag to tell if a leaf in this level of char-table is not a
3309 generic character (i.e. a complete multibyte character). */
3317 indices
= (int *) alloca (3 * sizeof (int));
3323 /* Call Fkey_description first, to avoid GC bug for the other string. */
3324 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3327 tem
= Fkey_description (prefix
, Qnil
);
3328 elt_prefix
= concat2 (tem
, build_string (" "));
3333 /* This vector gets used to present single keys to Flookup_key. Since
3334 that is done once per vector element, we don't want to cons up a
3335 fresh vector every time. */
3336 kludge
= Fmake_vector (make_number (1), Qnil
);
3337 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3340 suppress
= intern ("suppress-keymap");
3342 if (CHAR_TABLE_P (vector
))
3344 if (char_table_depth
== 0)
3346 /* VECTOR is a top level char-table. */
3349 to
= CHAR_TABLE_ORDINARY_SLOTS
;
3353 /* VECTOR is a sub char-table. */
3354 if (char_table_depth
>= 3)
3355 /* A char-table is never that deep. */
3356 error ("Too deep char table");
3359 = (CHARSET_VALID_P (indices
[0])
3360 && ((CHARSET_DIMENSION (indices
[0]) == 1
3361 && char_table_depth
== 1)
3362 || char_table_depth
== 2));
3364 /* Meaningful elements are from 32th to 127th. */
3366 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3371 /* This does the right thing for ordinary vectors. */
3375 to
= XVECTOR (vector
)->size
;
3378 for (i
= from
; i
< to
; i
++)
3382 if (CHAR_TABLE_P (vector
))
3384 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3387 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3388 && !CHARSET_DEFINED_P (i
- 128))
3392 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3395 definition
= get_keyelt (AREF (vector
, i
), 0);
3397 if (NILP (definition
)) continue;
3399 /* Don't mention suppressed commands. */
3400 if (SYMBOLP (definition
) && partial
)
3404 tem
= Fget (definition
, suppress
);
3406 if (!NILP (tem
)) continue;
3409 /* Set CHARACTER to the character this entry describes, if any.
3410 Also update *INDICES. */
3411 if (CHAR_TABLE_P (vector
))
3413 indices
[char_table_depth
] = i
;
3415 if (char_table_depth
== 0)
3418 indices
[0] = i
- 128;
3420 else if (complete_char
)
3422 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3430 ASET (kludge
, 0, make_number (character
));
3432 /* If this binding is shadowed by some other map, ignore it. */
3433 if (!NILP (shadow
) && complete_char
)
3437 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3439 if (!NILP (tem
)) continue;
3442 /* Ignore this definition if it is shadowed by an earlier
3443 one in the same keymap. */
3444 if (!NILP (entire_map
) && complete_char
)
3448 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3450 if (!EQ (tem
, definition
))
3456 if (char_table_depth
== 0)
3461 /* For a sub char-table, show the depth by indentation.
3462 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3463 if (char_table_depth
> 0)
3464 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3466 /* Output the prefix that applies to every entry in this map. */
3467 if (!NILP (elt_prefix
))
3468 insert1 (elt_prefix
);
3470 /* Insert or describe the character this slot is for,
3471 or a description of what it is for. */
3472 if (SUB_CHAR_TABLE_P (vector
))
3475 insert_char (character
);
3478 /* We need an octal representation for this block of
3481 sprintf (work
, "(row %d)", i
);
3482 insert (work
, strlen (work
));
3485 else if (CHAR_TABLE_P (vector
))
3488 insert1 (Fkey_description (kludge
, prefix
));
3491 /* Print the information for this character set. */
3492 insert_string ("<");
3493 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3495 insert_from_string (tem2
, 0, 0, SCHARS (tem2
),
3504 insert1 (Fkey_description (kludge
, prefix
));
3507 /* If we find a sub char-table within a char-table,
3508 scan it recursively; it defines the details for
3509 a character set or a portion of a character set. */
3510 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3513 describe_vector (definition
, prefix
, args
, elt_describer
,
3514 partial
, shadow
, entire_map
,
3515 indices
, char_table_depth
+ 1, keymap_p
);
3521 /* Find all consecutive characters or rows that have the same
3522 definition. But, for elements of a top level char table, if
3523 they are for charsets, we had better describe one by one even
3524 if they have the same definition. */
3525 if (CHAR_TABLE_P (vector
))
3529 if (char_table_depth
== 0)
3530 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3532 while (i
+ 1 < limit
3533 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3535 && !NILP (Fequal (tem2
, definition
)))
3540 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3542 && !NILP (Fequal (tem2
, definition
)))
3546 /* If we have a range of more than one character,
3547 print where the range reaches to. */
3549 if (i
!= starting_i
)
3553 ASET (kludge
, 0, make_number (i
));
3555 if (!NILP (elt_prefix
))
3556 insert1 (elt_prefix
);
3558 if (CHAR_TABLE_P (vector
))
3560 if (char_table_depth
== 0)
3562 insert1 (Fkey_description (kludge
, prefix
));
3564 else if (complete_char
)
3566 indices
[char_table_depth
] = i
;
3567 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3568 insert_char (character
);
3572 /* We need an octal representation for this block of
3575 sprintf (work
, "(row %d)", i
);
3576 insert (work
, strlen (work
));
3581 insert1 (Fkey_description (kludge
, prefix
));
3585 /* Print a description of the definition of this character.
3586 elt_describer will take care of spacing out far enough
3587 for alignment purposes. */
3588 (*elt_describer
) (definition
, args
);
3591 /* For (sub) char-table, print `defalt' slot at last. */
3592 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3594 insert (" ", char_table_depth
* 2);
3595 insert_string ("<<default>>");
3596 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3602 /* Apropos - finding all symbols whose names match a regexp. */
3603 static Lisp_Object apropos_predicate
;
3604 static Lisp_Object apropos_accumulate
;
3607 apropos_accum (symbol
, string
)
3608 Lisp_Object symbol
, string
;
3610 register Lisp_Object tem
;
3612 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3613 if (!NILP (tem
) && !NILP (apropos_predicate
))
3614 tem
= call1 (apropos_predicate
, symbol
);
3616 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3619 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3620 doc
: /* Show all symbols whose names contain match for REGEXP.
3621 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3622 for each symbol and a symbol is mentioned only if that returns non-nil.
3623 Return list of symbols found. */)
3625 Lisp_Object regexp
, predicate
;
3628 CHECK_STRING (regexp
);
3629 apropos_predicate
= predicate
;
3630 apropos_accumulate
= Qnil
;
3631 map_obarray (Vobarray
, apropos_accum
, regexp
);
3632 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3633 apropos_accumulate
= Qnil
;
3634 apropos_predicate
= Qnil
;
3641 Qkeymap
= intern ("keymap");
3642 staticpro (&Qkeymap
);
3643 staticpro (&apropos_predicate
);
3644 staticpro (&apropos_accumulate
);
3645 apropos_predicate
= Qnil
;
3646 apropos_accumulate
= Qnil
;
3648 /* Now we are ready to set up this property, so we can
3649 create char tables. */
3650 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3652 /* Initialize the keymaps standardly used.
3653 Each one is the value of a Lisp variable, and is also
3654 pointed to by a C variable */
3656 global_map
= Fmake_keymap (Qnil
);
3657 Fset (intern ("global-map"), global_map
);
3659 current_global_map
= global_map
;
3660 staticpro (&global_map
);
3661 staticpro (¤t_global_map
);
3663 meta_map
= Fmake_keymap (Qnil
);
3664 Fset (intern ("esc-map"), meta_map
);
3665 Ffset (intern ("ESC-prefix"), meta_map
);
3667 control_x_map
= Fmake_keymap (Qnil
);
3668 Fset (intern ("ctl-x-map"), control_x_map
);
3669 Ffset (intern ("Control-X-prefix"), control_x_map
);
3672 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3673 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3674 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3675 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3676 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3678 staticpro (&exclude_keys
);
3680 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3681 doc
: /* List of commands given new key bindings recently.
3682 This is used for internal purposes during Emacs startup;
3683 don't alter it yourself. */);
3684 Vdefine_key_rebound_commands
= Qt
;
3686 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3687 doc
: /* Default keymap to use when reading from the minibuffer. */);
3688 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3690 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3691 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3692 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3693 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3695 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3696 doc
: /* Local keymap for minibuffer input with completion. */);
3697 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3698 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3700 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3701 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3702 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3703 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3704 Vminibuffer_local_completion_map
);
3706 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3707 doc
: /* Alist of keymaps to use for minor modes.
3708 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3709 key sequences and look up bindings iff VARIABLE's value is non-nil.
3710 If two active keymaps bind the same key, the keymap appearing earlier
3711 in the list takes precedence. */);
3712 Vminor_mode_map_alist
= Qnil
;
3714 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3715 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3716 This variable is an alist just like `minor-mode-map-alist', and it is
3717 used the same way (and before `minor-mode-map-alist'); however,
3718 it is provided for major modes to bind locally. */);
3719 Vminor_mode_overriding_map_alist
= Qnil
;
3721 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3722 doc
: /* List of keymap alists to use for emulations modes.
3723 It is intended for modes or packages using multiple minor-mode keymaps.
3724 Each element is a keymap alist just like `minor-mode-map-alist', or a
3725 symbol with a variable binding which is a keymap alist, and it is used
3726 the same way. The "active" keymaps in each alist are used before
3727 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3728 Vemulation_mode_map_alists
= Qnil
;
3731 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3732 doc
: /* Keymap mapping ASCII function key sequences onto their preferred forms.
3733 This allows Emacs to recognize function keys sent from ASCII
3734 terminals at any point in a key sequence.
3736 The `read-key-sequence' function replaces any subsequence bound by
3737 `function-key-map' with its binding. More precisely, when the active
3738 keymaps have no binding for the current key sequence but
3739 `function-key-map' binds a suffix of the sequence to a vector or string,
3740 `read-key-sequence' replaces the matching suffix with its binding, and
3741 continues with the new sequence.
3743 The events that come from bindings in `function-key-map' are not
3744 themselves looked up in `function-key-map'.
3746 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3747 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3748 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3749 key, typing `ESC O P x' would return [f1 x]. */);
3750 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3752 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3753 doc
: /* Keymap of key translations that can override keymaps.
3754 This keymap works like `function-key-map', but comes after that,
3755 and applies even for keys that have ordinary bindings. */);
3756 Vkey_translation_map
= Qnil
;
3758 staticpro (&Vmouse_events
);
3759 Vmouse_events
= Fcons (intern ("menu-bar"),
3760 Fcons (intern ("tool-bar"),
3761 Fcons (intern ("header-line"),
3762 Fcons (intern ("mode-line"),
3763 Fcons (intern ("mouse-1"),
3764 Fcons (intern ("mouse-2"),
3765 Fcons (intern ("mouse-3"),
3766 Fcons (intern ("mouse-4"),
3767 Fcons (intern ("mouse-5"),
3771 Qsingle_key_description
= intern ("single-key-description");
3772 staticpro (&Qsingle_key_description
);
3774 Qkey_description
= intern ("key-description");
3775 staticpro (&Qkey_description
);
3777 Qkeymapp
= intern ("keymapp");
3778 staticpro (&Qkeymapp
);
3780 Qnon_ascii
= intern ("non-ascii");
3781 staticpro (&Qnon_ascii
);
3783 Qmenu_item
= intern ("menu-item");
3784 staticpro (&Qmenu_item
);
3786 Qremap
= intern ("remap");
3787 staticpro (&Qremap
);
3789 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3790 staticpro (&command_remapping_vector
);
3792 where_is_cache_keymaps
= Qt
;
3793 where_is_cache
= Qnil
;
3794 staticpro (&where_is_cache
);
3795 staticpro (&where_is_cache_keymaps
);
3797 defsubr (&Skeymapp
);
3798 defsubr (&Skeymap_parent
);
3799 defsubr (&Skeymap_prompt
);
3800 defsubr (&Sset_keymap_parent
);
3801 defsubr (&Smake_keymap
);
3802 defsubr (&Smake_sparse_keymap
);
3803 defsubr (&Smap_keymap
);
3804 defsubr (&Scopy_keymap
);
3805 defsubr (&Scommand_remapping
);
3806 defsubr (&Skey_binding
);
3807 defsubr (&Slocal_key_binding
);
3808 defsubr (&Sglobal_key_binding
);
3809 defsubr (&Sminor_mode_key_binding
);
3810 defsubr (&Sdefine_key
);
3811 defsubr (&Slookup_key
);
3812 defsubr (&Sdefine_prefix_command
);
3813 defsubr (&Suse_global_map
);
3814 defsubr (&Suse_local_map
);
3815 defsubr (&Scurrent_local_map
);
3816 defsubr (&Scurrent_global_map
);
3817 defsubr (&Scurrent_minor_mode_maps
);
3818 defsubr (&Scurrent_active_maps
);
3819 defsubr (&Saccessible_keymaps
);
3820 defsubr (&Skey_description
);
3821 defsubr (&Sdescribe_vector
);
3822 defsubr (&Ssingle_key_description
);
3823 defsubr (&Stext_char_description
);
3824 defsubr (&Swhere_is_internal
);
3825 defsubr (&Sdescribe_buffer_bindings
);
3826 defsubr (&Sapropos_internal
);
3832 initial_define_key (global_map
, 033, "ESC-prefix");
3833 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
3836 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
3837 (do not change this comment) */