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. */
28 #include "character.h"
31 #include "termhooks.h"
32 #include "blockinput.h"
34 #include "intervals.h"
37 /* The number of elements in keymap vectors. */
38 #define DENSE_TABLE_SIZE (0200)
40 /* Actually allocate storage for these variables */
42 Lisp_Object current_global_map
; /* Current global keymap */
44 Lisp_Object global_map
; /* default global key bindings */
46 Lisp_Object meta_map
; /* The keymap used for globally bound
47 ESC-prefixed default commands */
49 Lisp_Object control_x_map
; /* The keymap used for globally bound
50 C-x-prefixed default commands */
52 /* was MinibufLocalMap */
53 Lisp_Object Vminibuffer_local_map
;
54 /* The keymap used by the minibuf for local
55 bindings when spaces are allowed in the
58 /* was MinibufLocalNSMap */
59 Lisp_Object Vminibuffer_local_ns_map
;
60 /* The keymap used by the minibuf for local
61 bindings when spaces are not encouraged
64 /* keymap used for minibuffers when doing completion */
65 /* was MinibufLocalCompletionMap */
66 Lisp_Object Vminibuffer_local_completion_map
;
68 /* keymap used for minibuffers when doing completion and require a match */
69 /* was MinibufLocalMustMatchMap */
70 Lisp_Object Vminibuffer_local_must_match_map
;
72 /* Alist of minor mode variables and keymaps. */
73 Lisp_Object Vminor_mode_map_alist
;
75 /* Alist of major-mode-specific overrides for
76 minor mode variables and keymaps. */
77 Lisp_Object Vminor_mode_overriding_map_alist
;
79 /* List of emulation mode keymap alists. */
80 Lisp_Object Vemulation_mode_map_alists
;
82 /* Keymap mapping ASCII function key sequences onto their preferred forms.
83 Initialized by the terminal-specific lisp files. See DEFVAR for more
85 Lisp_Object Vfunction_key_map
;
87 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
88 Lisp_Object Vkey_translation_map
;
90 /* A list of all commands given new bindings since a certain time
91 when nil was stored here.
92 This is used to speed up recomputation of menu key equivalents
93 when Emacs starts up. t means don't record anything here. */
94 Lisp_Object Vdefine_key_rebound_commands
;
96 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
, Qremap
;
98 /* Alist of elements like (DEL . "\d"). */
99 static Lisp_Object exclude_keys
;
101 /* Pre-allocated 2-element vector for Fcommand_remapping to use. */
102 static Lisp_Object command_remapping_vector
;
104 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
105 in a string key sequence is equivalent to prefixing with this
107 extern Lisp_Object meta_prefix_char
;
109 extern Lisp_Object Voverriding_local_map
;
111 /* Hash table used to cache a reverse-map to speed up calls to where-is. */
112 static Lisp_Object where_is_cache
;
113 /* Which keymaps are reverse-stored in the cache. */
114 static Lisp_Object where_is_cache_keymaps
;
116 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
117 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
119 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
120 static void describe_command
P_ ((Lisp_Object
, Lisp_Object
));
121 static void describe_translation
P_ ((Lisp_Object
, Lisp_Object
));
122 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
123 void (*) P_ ((Lisp_Object
, Lisp_Object
)),
124 int, Lisp_Object
, Lisp_Object
*, int));
125 static void describe_vector
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
126 void (*) (Lisp_Object
, Lisp_Object
), int,
127 Lisp_Object
, Lisp_Object
, int *, int, int));
128 static void silly_event_symbol_error
P_ ((Lisp_Object
));
130 /* Keymap object support - constructors and predicates. */
132 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
133 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
134 CHARTABLE is a char-table that holds the bindings for the ASCII
135 characters. ALIST is an assoc-list which holds bindings for function keys,
136 mouse events, and any other things that appear in the input stream.
137 All entries in it are initially nil, meaning "command undefined".
139 The optional arg STRING supplies a menu name for the keymap
140 in case you use it as a menu with `x-popup-menu'. */)
146 tail
= Fcons (string
, Qnil
);
149 return Fcons (Qkeymap
,
150 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
153 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
154 doc
: /* Construct and return a new sparse keymap.
155 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
156 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
157 which binds the function key or mouse event SYMBOL to DEFINITION.
158 Initially the alist is nil.
160 The optional arg STRING supplies a menu name for the keymap
161 in case you use it as a menu with `x-popup-menu'. */)
166 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
167 return Fcons (Qkeymap
, Qnil
);
170 /* This function is used for installing the standard key bindings
171 at initialization time.
175 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
178 initial_define_key (keymap
, key
, defname
)
183 store_in_keymap (keymap
, make_number (key
), intern (defname
));
187 initial_define_lispy_key (keymap
, keyname
, defname
)
192 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
195 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
196 doc
: /* Return t if OBJECT is a keymap.
198 A keymap is a list (keymap . ALIST),
199 or a symbol whose function definition is itself a keymap.
200 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
201 a vector of densely packed bindings for small character codes
202 is also allowed as an element. */)
206 return (KEYMAPP (object
) ? Qt
: Qnil
);
209 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
210 doc
: /* Return the prompt-string of a keymap MAP.
211 If non-nil, the prompt is shown in the echo-area
212 when reading a key-sequence to be looked-up in this keymap. */)
218 register Lisp_Object tem
;
227 /* Check that OBJECT is a keymap (after dereferencing through any
228 symbols). If it is, return it.
230 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
231 is an autoload form, do the autoload and try again.
232 If AUTOLOAD is nonzero, callers must assume GC is possible.
234 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
235 is zero as well), return Qt.
237 ERROR controls how we respond if OBJECT isn't a keymap.
238 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
240 Note that most of the time, we don't want to pursue autoloads.
241 Functions like Faccessible_keymaps which scan entire keymap trees
242 shouldn't load every autoloaded keymap. I'm not sure about this,
243 but it seems to me that only read_key_sequence, Flookup_key, and
244 Fdefine_key should cause keymaps to be autoloaded.
246 This function can GC when AUTOLOAD is non-zero, because it calls
247 do_autoload which can GC. */
250 get_keymap (object
, error
, autoload
)
259 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
262 tem
= indirect_function (object
);
265 if (EQ (XCAR (tem
), Qkeymap
))
268 /* Should we do an autoload? Autoload forms for keymaps have
269 Qkeymap as their fifth element. */
270 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
))
274 tail
= Fnth (make_number (4), tem
);
275 if (EQ (tail
, Qkeymap
))
279 struct gcpro gcpro1
, gcpro2
;
281 GCPRO2 (tem
, object
);
282 do_autoload (tem
, object
);
295 wrong_type_argument (Qkeymapp
, object
);
299 /* Return the parent map of KEYMAP, or nil if it has none.
300 We assume that KEYMAP is a valid keymap. */
303 keymap_parent (keymap
, autoload
)
309 keymap
= get_keymap (keymap
, 1, autoload
);
311 /* Skip past the initial element `keymap'. */
312 list
= XCDR (keymap
);
313 for (; CONSP (list
); list
= XCDR (list
))
315 /* See if there is another `keymap'. */
320 return get_keymap (list
, 0, autoload
);
323 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
324 doc
: /* Return the parent keymap of KEYMAP. */)
328 return keymap_parent (keymap
, 1);
331 /* Check whether MAP is one of MAPS parents. */
333 keymap_memberp (map
, maps
)
334 Lisp_Object map
, maps
;
336 if (NILP (map
)) return 0;
337 while (KEYMAPP (maps
) && !EQ (map
, maps
))
338 maps
= keymap_parent (maps
, 0);
339 return (EQ (map
, maps
));
342 /* Set the parent keymap of MAP to PARENT. */
344 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
345 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 map_char_table (fix_submap_inheritance
, Qnil
, XCAR (list
), keymap
);
421 RETURN_UNGCPRO (parent
);
424 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
425 if EVENT is also a prefix in MAP's parent,
426 make sure that SUBMAP inherits that definition as its own parent. */
429 fix_submap_inheritance (map
, event
, submap
)
430 Lisp_Object map
, event
, submap
;
432 Lisp_Object map_parent
, parent_entry
;
434 /* SUBMAP is a cons that we found as a key binding.
435 Discard the other things found in a menu key binding. */
437 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
439 /* If it isn't a keymap now, there's no work to do. */
443 map_parent
= keymap_parent (map
, 0);
444 if (!NILP (map_parent
))
446 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
450 /* If MAP's parent has something other than a keymap,
451 our own submap shadows it completely. */
452 if (!CONSP (parent_entry
))
455 if (! EQ (parent_entry
, submap
))
457 Lisp_Object submap_parent
;
458 submap_parent
= submap
;
463 tem
= keymap_parent (submap_parent
, 0);
467 if (keymap_memberp (tem
, parent_entry
))
468 /* Fset_keymap_parent could create a cycle. */
475 Fset_keymap_parent (submap_parent
, parent_entry
);
479 /* Look up IDX in MAP. IDX may be any sort of event.
480 Note that this does only one level of lookup; IDX must be a single
481 event, not a sequence.
483 If T_OK is non-zero, bindings for Qt are treated as default
484 bindings; any key left unmentioned by other tables and bindings is
485 given the binding of Qt.
487 If T_OK is zero, bindings for Qt are not treated specially.
489 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
492 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
501 /* Qunbound in VAL means we have found no binding yet. */
504 /* If idx is a list (some sort of mouse click, perhaps?),
505 the index we want to use is the car of the list, which
506 ought to be a symbol. */
507 idx
= EVENT_HEAD (idx
);
509 /* If idx is a symbol, it might have modifiers, which need to
510 be put in the canonical order. */
512 idx
= reorder_modifiers (idx
);
513 else if (INTEGERP (idx
))
514 /* Clobber the high bits that can be present on a machine
515 with more than 24 bits of integer. */
516 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
518 /* Handle the special meta -> esc mapping. */
519 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
521 /* See if there is a meta-map. If there's none, there is
522 no binding for IDX, unless a default binding exists in MAP. */
524 Lisp_Object meta_map
;
526 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
527 t_ok
, noinherit
, autoload
),
530 if (CONSP (meta_map
))
533 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
536 /* Set IDX to t, so that we only find a default binding. */
539 /* We know there is no binding. */
543 /* t_binding is where we put a default binding that applies,
544 to use in case we do not find a binding specifically
545 for this key sequence. */
548 Lisp_Object t_binding
= Qnil
;
549 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
551 GCPRO4 (map
, tail
, idx
, t_binding
);
553 /* If `t_ok' is 2, both `t' is accepted. */
556 for (tail
= XCDR (map
);
558 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
563 binding
= XCAR (tail
);
564 if (SYMBOLP (binding
))
566 /* If NOINHERIT, stop finding prefix definitions
567 after we pass a second occurrence of the `keymap' symbol. */
568 if (noinherit
&& EQ (binding
, Qkeymap
))
569 RETURN_UNGCPRO (Qnil
);
571 else if (CONSP (binding
))
573 Lisp_Object key
= XCAR (binding
);
576 val
= XCDR (binding
);
577 else if (t_ok
> 1 && EQ (key
, Qt
))
579 t_binding
= XCDR (binding
);
583 else if (VECTORP (binding
))
585 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
586 val
= AREF (binding
, XFASTINT (idx
));
588 else if (CHAR_TABLE_P (binding
))
590 /* Character codes with modifiers
591 are not included in a char-table.
592 All character codes without modifiers are included. */
593 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
595 val
= Faref (binding
, idx
);
596 /* `nil' has a special meaning for char-tables, so
597 we use something else to record an explicitly
604 /* If we found a binding, clean it up and return it. */
605 if (!EQ (val
, Qunbound
))
608 /* A Qt binding is just like an explicit nil binding
609 (i.e. it shadows any parent binding but not bindings in
610 keymaps of lower precedence). */
612 val
= get_keyelt (val
, autoload
);
614 fix_submap_inheritance (map
, idx
, val
);
615 RETURN_UNGCPRO (val
);
620 return get_keyelt (t_binding
, autoload
);
625 map_keymap_item (fun
, args
, key
, val
, data
)
626 map_keymap_function_t fun
;
627 Lisp_Object args
, key
, val
;
630 /* We should maybe try to detect bindings shadowed by previous
631 ones and things like that. */
634 (*fun
) (key
, val
, args
, data
);
638 map_keymap_char_table_item (args
, key
, val
)
639 Lisp_Object args
, key
, val
;
643 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
645 map_keymap_item (fun
, XCDR (args
), key
, val
,
646 XSAVE_VALUE (XCAR (args
))->pointer
);
650 /* Call FUN for every binding in MAP.
651 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
652 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
654 map_keymap (map
, fun
, args
, data
, autoload
)
655 map_keymap_function_t fun
;
656 Lisp_Object map
, args
;
660 struct gcpro gcpro1
, gcpro2
, gcpro3
;
663 GCPRO3 (map
, args
, tail
);
664 map
= get_keymap (map
, 1, autoload
);
665 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
666 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
669 Lisp_Object binding
= XCAR (tail
);
672 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
673 else if (VECTORP (binding
))
675 /* Loop over the char values represented in the vector. */
676 int len
= ASIZE (binding
);
678 for (c
= 0; c
< len
; c
++)
680 Lisp_Object character
;
681 XSETFASTINT (character
, c
);
682 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
685 else if (CHAR_TABLE_P (binding
))
687 map_char_table (map_keymap_char_table_item
, Qnil
, binding
,
688 Fcons (make_save_value (fun
, 0),
689 Fcons (make_save_value (data
, 0),
697 map_keymap_call (key
, val
, fun
, dummy
)
698 Lisp_Object key
, val
, fun
;
701 call2 (fun
, key
, val
);
704 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 2, 0,
705 doc
: /* Call FUNCTION for every binding in KEYMAP.
706 FUNCTION is called with two arguments: the event and its binding. */)
708 Lisp_Object function
, keymap
;
710 if (INTEGERP (function
))
711 /* We have to stop integers early since map_keymap gives them special
713 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
714 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
718 /* Given OBJECT which was found in a slot in a keymap,
719 trace indirect definitions to get the actual definition of that slot.
720 An indirect definition is a list of the form
721 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
722 and INDEX is the object to look up in KEYMAP to yield the definition.
724 Also if OBJECT has a menu string as the first element,
725 remove that. Also remove a menu help string as second element.
727 If AUTOLOAD is nonzero, load autoloadable keymaps
728 that are referred to with indirection. */
731 get_keyelt (object
, autoload
)
737 if (!(CONSP (object
)))
738 /* This is really the value. */
741 /* If the keymap contents looks like (keymap ...) or (lambda ...)
743 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
746 /* If the keymap contents looks like (menu-item name . DEFN)
747 or (menu-item name DEFN ...) then use DEFN.
748 This is a new format menu item. */
749 else if (EQ (XCAR (object
), Qmenu_item
))
751 if (CONSP (XCDR (object
)))
755 object
= XCDR (XCDR (object
));
758 object
= XCAR (object
);
760 /* If there's a `:filter FILTER', apply FILTER to the
761 menu-item's definition to get the real definition to
763 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
764 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
767 filter
= XCAR (XCDR (tem
));
768 filter
= list2 (filter
, list2 (Qquote
, object
));
769 object
= menu_item_eval_property (filter
);
774 /* Invalid keymap. */
778 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
779 Keymap alist elements like (CHAR MENUSTRING . DEFN)
780 will be used by HierarKey menus. */
781 else if (STRINGP (XCAR (object
)))
783 object
= XCDR (object
);
784 /* Also remove a menu help string, if any,
785 following the menu item name. */
786 if (CONSP (object
) && STRINGP (XCAR (object
)))
787 object
= XCDR (object
);
788 /* Also remove the sublist that caches key equivalences, if any. */
789 if (CONSP (object
) && CONSP (XCAR (object
)))
792 carcar
= XCAR (XCAR (object
));
793 if (NILP (carcar
) || VECTORP (carcar
))
794 object
= XCDR (object
);
798 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
804 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
806 return (!CONSP (map
) ? object
/* Invalid keymap */
807 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
813 store_in_keymap (keymap
, idx
, def
)
815 register Lisp_Object idx
;
816 register Lisp_Object def
;
818 /* Flush any reverse-map cache. */
819 where_is_cache
= Qnil
;
820 where_is_cache_keymaps
= Qt
;
822 /* If we are preparing to dump, and DEF is a menu element
823 with a menu item indicator, copy it to ensure it is not pure. */
824 if (CONSP (def
) && PURE_P (def
)
825 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
826 def
= Fcons (XCAR (def
), XCDR (def
));
828 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
829 error ("attempt to define a key in a non-keymap");
831 /* If idx is a cons, and the car part is a character, idx must be of
832 the form (FROM-CHAR . TO-CHAR). */
833 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
834 CHECK_CHARACTER_CDR (idx
);
836 /* If idx is a list (some sort of mouse click, perhaps?),
837 the index we want to use is the car of the list, which
838 ought to be a symbol. */
839 idx
= EVENT_HEAD (idx
);
841 /* If idx is a symbol, it might have modifiers, which need to
842 be put in the canonical order. */
844 idx
= reorder_modifiers (idx
);
845 else if (INTEGERP (idx
))
846 /* Clobber the high bits that can be present on a machine
847 with more than 24 bits of integer. */
848 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
850 /* Scan the keymap for a binding of idx. */
854 /* The cons after which we should insert new bindings. If the
855 keymap has a table element, we record its position here, so new
856 bindings will go after it; this way, the table will stay
857 towards the front of the alist and character lookups in dense
858 keymaps will remain fast. Otherwise, this just points at the
859 front of the keymap. */
860 Lisp_Object insertion_point
;
862 insertion_point
= keymap
;
863 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
870 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
872 ASET (elt
, XFASTINT (idx
), def
);
875 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
877 int from
= XFASTINT (XCAR (idx
));
878 int to
= XFASTINT (XCDR (idx
));
880 if (to
>= ASIZE (elt
))
881 to
= ASIZE (elt
) - 1;
882 for (; from
<= to
; from
++)
883 ASET (elt
, from
, def
);
884 if (to
== XFASTINT (XCDR (idx
)))
885 /* We have defined all keys in IDX. */
888 insertion_point
= tail
;
890 else if (CHAR_TABLE_P (elt
))
892 /* Character codes with modifiers
893 are not included in a char-table.
894 All character codes without modifiers are included. */
895 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
898 /* `nil' has a special meaning for char-tables, so
899 we use something else to record an explicitly
901 NILP (def
) ? Qt
: def
);
904 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
906 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
909 insertion_point
= tail
;
911 else if (CONSP (elt
))
913 if (EQ (idx
, XCAR (elt
)))
918 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
920 int from
= XFASTINT (XCAR (idx
));
921 int to
= XFASTINT (XCDR (idx
));
923 if (from
<= XFASTINT (XCAR (elt
))
924 && to
>= XFASTINT (XCAR (elt
)))
932 else if (EQ (elt
, Qkeymap
))
933 /* If we find a 'keymap' symbol in the spine of KEYMAP,
934 then we must have found the start of a second keymap
935 being used as the tail of KEYMAP, and a binding for IDX
936 should be inserted before it. */
943 /* We have scanned the entire keymap, and not found a binding for
944 IDX. Let's add one. */
948 if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
950 /* IDX specifies a range of characters, and not all of them
951 were handled yet, which means this keymap doesn't have a
952 char-table. So, we insert a char-table now. */
953 elt
= Fmake_char_table (Qkeymap
, Qnil
);
954 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
957 elt
= Fcons (idx
, def
);
958 XSETCDR (insertion_point
, Fcons (elt
, XCDR (insertion_point
)));
965 EXFUN (Fcopy_keymap
, 1);
968 copy_keymap_item (elt
)
971 Lisp_Object res
, tem
;
978 /* Is this a new format menu item. */
979 if (EQ (XCAR (tem
), Qmenu_item
))
981 /* Copy cell with menu-item marker. */
982 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
986 /* Copy cell with menu-item name. */
987 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
993 /* Copy cell with binding and if the binding is a keymap,
995 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
998 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
999 XSETCAR (elt
, Fcopy_keymap (tem
));
1001 if (CONSP (tem
) && CONSP (XCAR (tem
)))
1002 /* Delete cache for key equivalences. */
1003 XSETCDR (elt
, XCDR (tem
));
1008 /* It may be an old fomat menu item.
1009 Skip the optional menu string. */
1010 if (STRINGP (XCAR (tem
)))
1012 /* Copy the cell, since copy-alist didn't go this deep. */
1013 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
1015 /* Also skip the optional menu help string. */
1016 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
1018 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
1022 /* There may also be a list that caches key equivalences.
1023 Just delete it for the new keymap. */
1025 && CONSP (XCAR (tem
))
1026 && (NILP (XCAR (XCAR (tem
)))
1027 || VECTORP (XCAR (XCAR (tem
)))))
1029 XSETCDR (elt
, XCDR (tem
));
1032 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
1033 XSETCDR (elt
, Fcopy_keymap (tem
));
1035 else if (EQ (XCAR (tem
), Qkeymap
))
1036 res
= Fcopy_keymap (elt
);
1042 copy_keymap_1 (chartable
, idx
, elt
)
1043 Lisp_Object chartable
, idx
, elt
;
1045 Fset_char_table_range (chartable
, idx
, copy_keymap_item (elt
));
1048 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1049 doc
: /* Return a copy of the keymap KEYMAP.
1050 The copy starts out with the same definitions of KEYMAP,
1051 but changing either the copy or KEYMAP does not affect the other.
1052 Any key definitions that are subkeymaps are recursively copied.
1053 However, a key definition which is a symbol whose definition is a keymap
1058 register Lisp_Object copy
, tail
;
1059 keymap
= get_keymap (keymap
, 1, 0);
1060 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1061 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1063 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1065 Lisp_Object elt
= XCAR (keymap
);
1066 if (CHAR_TABLE_P (elt
))
1068 elt
= Fcopy_sequence (elt
);
1069 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
);
1071 else if (VECTORP (elt
))
1074 elt
= Fcopy_sequence (elt
);
1075 for (i
= 0; i
< ASIZE (elt
); i
++)
1076 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1078 else if (CONSP (elt
))
1079 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1080 XSETCDR (tail
, Fcons (elt
, Qnil
));
1082 keymap
= XCDR (keymap
);
1084 XSETCDR (tail
, keymap
);
1088 /* Simple Keymap mutators and accessors. */
1090 /* GC is possible in this function if it autoloads a keymap. */
1092 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1093 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1096 KEY is a string or a vector of symbols and characters meaning a
1097 sequence of keystrokes and events. Non-ASCII characters with codes
1098 above 127 (such as ISO Latin-1) can be included if you use a vector.
1099 Using [t] for KEY creates a default definition, which applies to any
1100 event type that has no other definition in this keymap.
1102 DEF is anything that can be a key's definition:
1103 nil (means key is undefined in this keymap),
1104 a command (a Lisp function suitable for interactive calling),
1105 a string (treated as a keyboard macro),
1106 a keymap (to define a prefix key),
1107 a symbol (when the key is looked up, the symbol will stand for its
1108 function definition, which should at that time be one of the above,
1109 or another symbol whose function definition is used, etc.),
1110 a cons (STRING . DEFN), meaning that DEFN is the definition
1111 (DEFN should be a valid definition in its own right),
1112 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
1114 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1115 binding is altered. If there is no binding for KEY, the new pair
1116 binding KEY to DEF is added at the front of KEYMAP. */)
1123 register Lisp_Object c
;
1124 register Lisp_Object cmd
;
1128 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1130 GCPRO3 (keymap
, key
, def
);
1131 keymap
= get_keymap (keymap
, 1, 1);
1133 if (!VECTORP (key
) && !STRINGP (key
))
1134 key
= wrong_type_argument (Qarrayp
, key
);
1136 length
= XFASTINT (Flength (key
));
1138 RETURN_UNGCPRO (Qnil
);
1140 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1141 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1143 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1148 c
= Faref (key
, make_number (idx
));
1152 /* C may be a Lucid style event type list or a cons (FROM .
1153 TO) specifying a range of characters. */
1154 if (lucid_event_type_list_p (c
))
1155 c
= Fevent_convert_list (c
);
1156 else if (CHARACTERP (XCAR (c
)))
1157 CHECK_CHARACTER_CDR (c
);
1161 silly_event_symbol_error (c
);
1164 && (XINT (c
) & meta_bit
)
1167 c
= meta_prefix_char
;
1173 XSETINT (c
, XINT (c
) & ~meta_bit
);
1179 if (!INTEGERP (c
) && !SYMBOLP (c
)
1181 /* If C is a range, it must be a leaf. */
1182 || (INTEGERP (XCAR (c
)) && idx
!= length
)))
1183 error ("Key sequence contains invalid event");
1186 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1188 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1190 /* If this key is undefined, make it a prefix. */
1192 cmd
= define_as_prefix (keymap
, c
);
1194 keymap
= get_keymap (cmd
, 0, 1);
1195 if (!CONSP (keymap
))
1196 /* We must use Fkey_description rather than just passing key to
1197 error; key might be a vector, not a string. */
1198 error ("Key sequence %s uses invalid prefix characters",
1199 SDATA (Fkey_description (key
, Qnil
)));
1203 /* This function may GC (it calls Fkey_binding). */
1205 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1206 doc
: /* Return the remapping for command COMMAND in current keymaps.
1207 Returns nil if COMMAND is not remapped (or not a symbol). */)
1209 Lisp_Object command
;
1211 if (!SYMBOLP (command
))
1214 ASET (command_remapping_vector
, 1, command
);
1215 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1218 /* Value is number if KEY is too long; nil if valid but has no definition. */
1219 /* GC is possible in this function if it autoloads a keymap. */
1221 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1222 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1223 nil means undefined. See doc of `define-key' for kinds of definitions.
1225 A number as value means KEY is "too long";
1226 that is, characters or symbols in it except for the last one
1227 fail to be a valid sequence of prefix characters in KEYMAP.
1228 The number is how many characters at the front of KEY
1229 it takes to reach a non-prefix command.
1231 Normally, `lookup-key' ignores bindings for t, which act as default
1232 bindings, used when nothing else in the keymap applies; this makes it
1233 usable as a general function for probing keymaps. However, if the
1234 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1235 recognize the default bindings, just as `read-key-sequence' does. */)
1236 (keymap
, key
, accept_default
)
1239 Lisp_Object accept_default
;
1242 register Lisp_Object cmd
;
1243 register Lisp_Object c
;
1245 int t_ok
= !NILP (accept_default
);
1246 struct gcpro gcpro1
, gcpro2
;
1248 GCPRO2 (keymap
, key
);
1249 keymap
= get_keymap (keymap
, 1, 1);
1251 if (!VECTORP (key
) && !STRINGP (key
))
1252 key
= wrong_type_argument (Qarrayp
, key
);
1254 length
= XFASTINT (Flength (key
));
1256 RETURN_UNGCPRO (keymap
);
1261 c
= Faref (key
, make_number (idx
++));
1263 if (CONSP (c
) && lucid_event_type_list_p (c
))
1264 c
= Fevent_convert_list (c
);
1266 /* Turn the 8th bit of string chars into a meta modifier. */
1267 if (XINT (c
) & 0x80 && STRINGP (key
))
1268 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1270 /* Allow string since binding for `menu-bar-select-buffer'
1271 includes the buffer name in the key sequence. */
1272 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1273 error ("Key sequence contains invalid event");
1275 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1277 RETURN_UNGCPRO (cmd
);
1279 keymap
= get_keymap (cmd
, 0, 1);
1280 if (!CONSP (keymap
))
1281 RETURN_UNGCPRO (make_number (idx
));
1287 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1288 Assume that currently it does not define C at all.
1289 Return the keymap. */
1292 define_as_prefix (keymap
, c
)
1293 Lisp_Object keymap
, c
;
1297 cmd
= Fmake_sparse_keymap (Qnil
);
1298 /* If this key is defined as a prefix in an inherited keymap,
1299 make it a prefix in this map, and make its definition
1300 inherit the other prefix definition. */
1301 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1302 store_in_keymap (keymap
, c
, cmd
);
1307 /* Append a key to the end of a key sequence. We always make a vector. */
1310 append_key (key_sequence
, key
)
1311 Lisp_Object key_sequence
, key
;
1313 Lisp_Object args
[2];
1315 args
[0] = key_sequence
;
1317 args
[1] = Fcons (key
, Qnil
);
1318 return Fvconcat (2, args
);
1321 /* Given a event type C which is a symbol,
1322 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1325 silly_event_symbol_error (c
)
1328 Lisp_Object parsed
, base
, name
, assoc
;
1331 parsed
= parse_modifiers (c
);
1332 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1333 base
= XCAR (parsed
);
1334 name
= Fsymbol_name (base
);
1335 /* This alist includes elements such as ("RET" . "\\r"). */
1336 assoc
= Fassoc (name
, exclude_keys
);
1340 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1342 Lisp_Object keystring
;
1343 if (modifiers
& alt_modifier
)
1344 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1345 if (modifiers
& ctrl_modifier
)
1346 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1347 if (modifiers
& hyper_modifier
)
1348 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1349 if (modifiers
& meta_modifier
)
1350 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1351 if (modifiers
& shift_modifier
)
1352 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1353 if (modifiers
& super_modifier
)
1354 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1357 c
= reorder_modifiers (c
);
1358 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1360 error ((modifiers
& ~meta_modifier
1361 ? "To bind the key %s, use [?%s], not [%s]"
1362 : "To bind the key %s, use \"%s\", not [%s]"),
1363 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1364 SDATA (SYMBOL_NAME (c
)));
1368 /* Global, local, and minor mode keymap stuff. */
1370 /* We can't put these variables inside current_minor_maps, since under
1371 some systems, static gets macro-defined to be the empty string.
1373 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1374 static int cmm_size
= 0;
1376 /* Error handler used in current_minor_maps. */
1378 current_minor_maps_error ()
1383 /* Store a pointer to an array of the keymaps of the currently active
1384 minor modes in *buf, and return the number of maps it contains.
1386 This function always returns a pointer to the same buffer, and may
1387 free or reallocate it, so if you want to keep it for a long time or
1388 hand it out to lisp code, copy it. This procedure will be called
1389 for every key sequence read, so the nice lispy approach (return a
1390 new assoclist, list, what have you) for each invocation would
1391 result in a lot of consing over time.
1393 If we used xrealloc/xmalloc and ran out of memory, they would throw
1394 back to the command loop, which would try to read a key sequence,
1395 which would call this function again, resulting in an infinite
1396 loop. Instead, we'll use realloc/malloc and silently truncate the
1397 list, let the key sequence be read, and hope some other piece of
1398 code signals the error. */
1400 current_minor_maps (modeptr
, mapptr
)
1401 Lisp_Object
**modeptr
, **mapptr
;
1404 int list_number
= 0;
1405 Lisp_Object alist
, assoc
, var
, val
;
1406 Lisp_Object emulation_alists
;
1407 Lisp_Object lists
[2];
1409 emulation_alists
= Vemulation_mode_map_alists
;
1410 lists
[0] = Vminor_mode_overriding_map_alist
;
1411 lists
[1] = Vminor_mode_map_alist
;
1413 for (list_number
= 0; list_number
< 2; list_number
++)
1415 if (CONSP (emulation_alists
))
1417 alist
= XCAR (emulation_alists
);
1418 emulation_alists
= XCDR (emulation_alists
);
1419 if (SYMBOLP (alist
))
1420 alist
= find_symbol_value (alist
);
1424 alist
= lists
[list_number
];
1426 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1427 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1428 && (var
= XCAR (assoc
), SYMBOLP (var
))
1429 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1434 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1435 and also an entry in Vminor_mode_map_alist,
1436 ignore the latter. */
1437 if (list_number
== 1)
1439 val
= assq_no_quit (var
, lists
[0]);
1446 int newsize
, allocsize
;
1447 Lisp_Object
*newmodes
, *newmaps
;
1449 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1450 allocsize
= newsize
* sizeof *newmodes
;
1452 /* Use malloc here. See the comment above this function.
1453 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1455 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1460 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1463 cmm_modes
= newmodes
;
1466 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1471 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1478 if (newmodes
== NULL
|| newmaps
== NULL
)
1483 /* Get the keymap definition--or nil if it is not defined. */
1484 temp
= internal_condition_case_1 (Findirect_function
,
1486 Qerror
, current_minor_maps_error
);
1490 cmm_maps
[i
] = temp
;
1496 if (modeptr
) *modeptr
= cmm_modes
;
1497 if (mapptr
) *mapptr
= cmm_maps
;
1501 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1503 doc
: /* Return a list of the currently active keymaps.
1504 OLP if non-nil indicates that we should obey `overriding-local-map' and
1505 `overriding-terminal-local-map'. */)
1509 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1513 if (!NILP (Voverriding_local_map
))
1514 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1515 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1516 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1518 if (NILP (XCDR (keymaps
)))
1524 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1526 keymaps
= Fcons (local
, keymaps
);
1528 nmaps
= current_minor_maps (0, &maps
);
1530 for (i
= --nmaps
; i
>= 0; i
--)
1531 if (!NILP (maps
[i
]))
1532 keymaps
= Fcons (maps
[i
], keymaps
);
1534 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1536 keymaps
= Fcons (local
, keymaps
);
1542 /* GC is possible in this function if it autoloads a keymap. */
1544 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1545 doc
: /* Return the binding for command KEY in current keymaps.
1546 KEY is a string or vector, a sequence of keystrokes.
1547 The binding is probably a symbol with a function definition.
1549 Normally, `key-binding' ignores bindings for t, which act as default
1550 bindings, used when nothing else in the keymap applies; this makes it
1551 usable as a general function for probing keymaps. However, if the
1552 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1553 recognize the default bindings, just as `read-key-sequence' does.
1555 Like the normal command loop, `key-binding' will remap the command
1556 resulting from looking up KEY by looking up the command in the
1557 current keymaps. However, if the optional third argument NO-REMAP
1558 is non-nil, `key-binding' returns the unmapped command. */)
1559 (key
, accept_default
, no_remap
)
1560 Lisp_Object key
, accept_default
, no_remap
;
1562 Lisp_Object
*maps
, value
;
1564 struct gcpro gcpro1
;
1568 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1570 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1571 key
, accept_default
);
1572 if (! NILP (value
) && !INTEGERP (value
))
1575 else if (!NILP (Voverriding_local_map
))
1577 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1578 if (! NILP (value
) && !INTEGERP (value
))
1585 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1588 value
= Flookup_key (local
, key
, accept_default
);
1589 if (! NILP (value
) && !INTEGERP (value
))
1593 nmaps
= current_minor_maps (0, &maps
);
1594 /* Note that all these maps are GCPRO'd
1595 in the places where we found them. */
1597 for (i
= 0; i
< nmaps
; i
++)
1598 if (! NILP (maps
[i
]))
1600 value
= Flookup_key (maps
[i
], key
, accept_default
);
1601 if (! NILP (value
) && !INTEGERP (value
))
1605 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1608 value
= Flookup_key (local
, key
, accept_default
);
1609 if (! NILP (value
) && !INTEGERP (value
))
1614 value
= Flookup_key (current_global_map
, key
, accept_default
);
1618 if (NILP (value
) || INTEGERP (value
))
1621 /* If the result of the ordinary keymap lookup is an interactive
1622 command, look for a key binding (ie. remapping) for that command. */
1624 if (NILP (no_remap
) && SYMBOLP (value
))
1627 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1634 /* GC is possible in this function if it autoloads a keymap. */
1636 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1637 doc
: /* Return the binding for command KEYS in current local keymap only.
1638 KEYS is a string, a sequence of keystrokes.
1639 The binding is probably a symbol with a function definition.
1641 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1642 bindings; see the description of `lookup-key' for more details about this. */)
1643 (keys
, accept_default
)
1644 Lisp_Object keys
, accept_default
;
1646 register Lisp_Object map
;
1647 map
= current_buffer
->keymap
;
1650 return Flookup_key (map
, keys
, accept_default
);
1653 /* GC is possible in this function if it autoloads a keymap. */
1655 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1656 doc
: /* Return the binding for command KEYS in current global keymap only.
1657 KEYS is a string, a sequence of keystrokes.
1658 The binding is probably a symbol with a function definition.
1659 This function's return values are the same as those of `lookup-key'
1662 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1663 bindings; see the description of `lookup-key' for more details about this. */)
1664 (keys
, accept_default
)
1665 Lisp_Object keys
, accept_default
;
1667 return Flookup_key (current_global_map
, keys
, accept_default
);
1670 /* GC is possible in this function if it autoloads a keymap. */
1672 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1673 doc
: /* Find the visible minor mode bindings of KEY.
1674 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the
1675 the symbol which names the minor mode binding KEY, and BINDING is
1676 KEY's definition in that mode. In particular, if KEY has no
1677 minor-mode bindings, return nil. If the first binding is a
1678 non-prefix, all subsequent bindings will be omitted, since they would
1679 be ignored. Similarly, the list doesn't include non-prefix bindings
1680 that come after prefix bindings.
1682 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1683 bindings; see the description of `lookup-key' for more details about this. */)
1684 (key
, accept_default
)
1685 Lisp_Object key
, accept_default
;
1687 Lisp_Object
*modes
, *maps
;
1689 Lisp_Object binding
;
1691 struct gcpro gcpro1
, gcpro2
;
1693 nmaps
= current_minor_maps (&modes
, &maps
);
1694 /* Note that all these maps are GCPRO'd
1695 in the places where we found them. */
1698 GCPRO2 (key
, binding
);
1700 for (i
= j
= 0; i
< nmaps
; i
++)
1702 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1703 && !INTEGERP (binding
))
1705 if (KEYMAPP (binding
))
1706 maps
[j
++] = Fcons (modes
[i
], binding
);
1708 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1712 return Flist (j
, maps
);
1715 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1716 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1717 A new sparse keymap is stored as COMMAND's function definition and its value.
1718 If a second optional argument MAPVAR is given, the map is stored as
1719 its value instead of as COMMAND's value; but COMMAND is still defined
1721 The third optional argument NAME, if given, supplies a menu name
1722 string for the map. This is required to use the keymap as a menu. */)
1723 (command
, mapvar
, name
)
1724 Lisp_Object command
, mapvar
, name
;
1727 map
= Fmake_sparse_keymap (name
);
1728 Ffset (command
, map
);
1732 Fset (command
, map
);
1736 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1737 doc
: /* Select KEYMAP as the global keymap. */)
1741 keymap
= get_keymap (keymap
, 1, 1);
1742 current_global_map
= keymap
;
1747 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1748 doc
: /* Select KEYMAP as the local keymap.
1749 If KEYMAP is nil, that means no local keymap. */)
1754 keymap
= get_keymap (keymap
, 1, 1);
1756 current_buffer
->keymap
= keymap
;
1761 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1762 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1765 return current_buffer
->keymap
;
1768 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1769 doc
: /* Return the current global keymap. */)
1772 return current_global_map
;
1775 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1776 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1780 int nmaps
= current_minor_maps (0, &maps
);
1782 return Flist (nmaps
, maps
);
1785 /* Help functions for describing and documenting keymaps. */
1789 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1790 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1791 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1795 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1799 /* Look for and break cycles. */
1800 while (!NILP (tem
= Frassq (cmd
, maps
)))
1802 Lisp_Object prefix
= XCAR (tem
);
1803 int lim
= XINT (Flength (XCAR (tem
)));
1804 if (lim
<= XINT (Flength (thisseq
)))
1805 { /* This keymap was already seen with a smaller prefix. */
1807 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1808 Faref (thisseq
, make_number (i
))))
1811 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1814 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1815 but maybe `cmd' occurs again further down in `maps', so keep
1817 maps
= XCDR (Fmemq (tem
, maps
));
1820 /* If the last key in thisseq is meta-prefix-char,
1821 turn it into a meta-ized keystroke. We know
1822 that the event we're about to append is an
1823 ascii keystroke since we're processing a
1827 int meta_bit
= meta_modifier
;
1828 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1829 tem
= Fcopy_sequence (thisseq
);
1831 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1833 /* This new sequence is the same length as
1834 thisseq, so stick it in the list right
1837 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1841 tem
= append_key (thisseq
, key
);
1842 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1847 accessible_keymaps_char_table (args
, index
, cmd
)
1848 Lisp_Object args
, index
, cmd
;
1850 accessible_keymaps_1 (index
, cmd
,
1854 XINT (XCDR (XCAR (args
))));
1857 /* This function cannot GC. */
1859 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1861 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1862 Returns a list of elements of the form (KEYS . MAP), where the sequence
1863 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1864 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1865 An optional argument PREFIX, if non-nil, should be a key sequence;
1866 then the value includes only maps for prefixes that start with PREFIX. */)
1868 Lisp_Object keymap
, prefix
;
1870 Lisp_Object maps
, tail
;
1873 /* no need for gcpro because we don't autoload any keymaps. */
1876 prefixlen
= XINT (Flength (prefix
));
1880 /* If a prefix was specified, start with the keymap (if any) for
1881 that prefix, so we don't waste time considering other prefixes. */
1883 tem
= Flookup_key (keymap
, prefix
, Qt
);
1884 /* Flookup_key may give us nil, or a number,
1885 if the prefix is not defined in this particular map.
1886 It might even give us a list that isn't a keymap. */
1887 tem
= get_keymap (tem
, 0, 0);
1890 /* Convert PREFIX to a vector now, so that later on
1891 we don't have to deal with the possibility of a string. */
1892 if (STRINGP (prefix
))
1897 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1898 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1902 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1903 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1904 c
^= 0200 | meta_modifier
;
1905 ASET (copy
, i_before
, make_number (c
));
1909 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1915 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1916 get_keymap (keymap
, 1, 0)),
1919 /* For each map in the list maps,
1920 look at any other maps it points to,
1921 and stick them at the end if they are not already in the list.
1923 This is a breadth-first traversal, where tail is the queue of
1924 nodes, and maps accumulates a list of all nodes visited. */
1926 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1928 register Lisp_Object thisseq
, thismap
;
1930 /* Does the current sequence end in the meta-prefix-char? */
1933 thisseq
= Fcar (Fcar (tail
));
1934 thismap
= Fcdr (Fcar (tail
));
1935 last
= make_number (XINT (Flength (thisseq
)) - 1);
1936 is_metized
= (XINT (last
) >= 0
1937 /* Don't metize the last char of PREFIX. */
1938 && XINT (last
) >= prefixlen
1939 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1941 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1945 elt
= XCAR (thismap
);
1949 if (CHAR_TABLE_P (elt
))
1951 map_char_table (accessible_keymaps_char_table
, Qnil
,
1952 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1953 Fcons (tail
, thisseq
)));
1955 else if (VECTORP (elt
))
1959 /* Vector keymap. Scan all the elements. */
1960 for (i
= 0; i
< ASIZE (elt
); i
++)
1961 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1962 maps
, tail
, thisseq
, is_metized
);
1965 else if (CONSP (elt
))
1966 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1967 maps
, tail
, thisseq
,
1968 is_metized
&& INTEGERP (XCAR (elt
)));
1976 Lisp_Object Qsingle_key_description
, Qkey_description
;
1978 /* This function cannot GC. */
1980 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 2, 0,
1981 doc
: /* Return a pretty description of key-sequence KEYS.
1982 Optional arg PREFIX is the sequence of keys leading up to KEYS.
1983 Control characters turn into "C-foo" sequences, meta into "M-foo",
1984 spaces are put between sequence elements, etc. */)
1986 Lisp_Object keys
, prefix
;
1991 int size
= XINT (Flength (keys
));
1993 Lisp_Object sep
= build_string (" ");
1998 size
+= XINT (Flength (prefix
));
2000 /* This has one extra element at the end that we don't pass to Fconcat. */
2001 args
= (Lisp_Object
*) alloca (size
* 4 * sizeof (Lisp_Object
));
2003 /* In effect, this computes
2004 (mapconcat 'single-key-description keys " ")
2005 but we shouldn't use mapconcat because it can do GC. */
2009 list
= prefix
, prefix
= Qnil
;
2010 else if (!NILP (keys
))
2011 list
= keys
, keys
= Qnil
;
2016 args
[len
] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2020 return empty_string
;
2021 return Fconcat (len
- 1, args
);
2025 size
= SCHARS (list
);
2026 else if (VECTORP (list
))
2027 size
= XVECTOR (list
)->size
;
2028 else if (CONSP (list
))
2029 size
= XINT (Flength (list
));
2031 wrong_type_argument (Qarrayp
, list
);
2040 FETCH_STRING_CHAR_ADVANCE (c
, list
, i
, i_byte
);
2041 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
2042 c
^= 0200 | meta_modifier
;
2043 XSETFASTINT (key
, c
);
2045 else if (VECTORP (list
))
2047 key
= AREF (list
, i
++);
2059 || EQ (key
, meta_prefix_char
)
2060 || (XINT (key
) & meta_modifier
))
2062 args
[len
++] = Fsingle_key_description (meta_prefix_char
, Qnil
);
2064 if (EQ (key
, meta_prefix_char
))
2068 XSETINT (key
, (XINT (key
) | meta_modifier
) & ~0x80);
2071 else if (EQ (key
, meta_prefix_char
))
2076 args
[len
++] = Fsingle_key_description (key
, Qnil
);
2084 push_key_description (c
, p
, force_multibyte
)
2085 register unsigned int c
;
2087 int force_multibyte
;
2091 /* Clear all the meaningless bits above the meta bit. */
2092 c
&= meta_modifier
| ~ - meta_modifier
;
2093 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2094 | meta_modifier
| shift_modifier
| super_modifier
);
2096 if (c
& alt_modifier
)
2102 if ((c
& ctrl_modifier
) != 0
2103 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2107 c
&= ~ctrl_modifier
;
2109 if (c
& hyper_modifier
)
2113 c
-= hyper_modifier
;
2115 if (c
& meta_modifier
)
2121 if (c
& shift_modifier
)
2125 c
-= shift_modifier
;
2127 if (c
& super_modifier
)
2131 c
-= super_modifier
;
2147 else if (c
== Ctl ('M'))
2155 /* `C-' already added above. */
2156 if (c
> 0 && c
<= Ctl ('Z'))
2175 || (NILP (current_buffer
->enable_multibyte_characters
)
2176 && SINGLE_BYTE_CHAR_P (c
)
2177 && !force_multibyte
))
2181 else if (CHARACTERP (make_number (c
)))
2183 if (NILP (current_buffer
->enable_multibyte_characters
)
2184 && ! force_multibyte
)
2185 *p
++ = multibyte_char_to_unibyte (c
, Qnil
);
2187 p
+= CHAR_STRING (c
, (unsigned char *) p
);
2193 /* The biggest character code uses 22 bits. */
2194 for (bit_offset
= 21; bit_offset
>= 0; bit_offset
-= 3)
2196 if (c
>= (1 << bit_offset
))
2197 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2204 /* This function cannot GC. */
2206 DEFUN ("single-key-description", Fsingle_key_description
,
2207 Ssingle_key_description
, 1, 2, 0,
2208 doc
: /* Return a pretty description of command character KEY.
2209 Control characters turn into C-whatever, etc.
2210 Optional argument NO-ANGLES non-nil means don't put angle brackets
2211 around function keys and event symbols. */)
2213 Lisp_Object key
, no_angles
;
2215 if (CONSP (key
) && lucid_event_type_list_p (key
))
2216 key
= Fevent_convert_list (key
);
2218 key
= EVENT_HEAD (key
);
2220 if (INTEGERP (key
)) /* Normal character */
2222 char tem
[KEY_DESCRIPTION_SIZE
];
2224 *push_key_description (XUINT (key
), tem
, 1) = 0;
2225 return build_string (tem
);
2227 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2229 if (NILP (no_angles
))
2232 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2233 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2234 return build_string (buffer
);
2237 return Fsymbol_name (key
);
2239 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2240 return Fcopy_sequence (key
);
2242 error ("KEY must be an integer, cons, symbol, or string");
2247 push_text_char_description (c
, p
)
2248 register unsigned int c
;
2260 *p
++ = c
+ 64; /* 'A' - 1 */
2272 /* This function cannot GC. */
2274 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2275 doc
: /* Return a pretty description of file-character CHARACTER.
2276 Control characters turn into "^char", etc. */)
2278 Lisp_Object character
;
2280 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2281 unsigned char str
[6];
2284 CHECK_NUMBER (character
);
2286 c
= XINT (character
);
2287 if (!ASCII_CHAR_P (c
))
2289 int len
= CHAR_STRING (c
, str
);
2291 return make_multibyte_string (str
, 1, len
);
2294 *push_text_char_description (c
& 0377, str
) = 0;
2296 return build_string (str
);
2299 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2302 ascii_sequence_p (seq
)
2306 int len
= XINT (Flength (seq
));
2308 for (i
= 0; i
< len
; i
++)
2310 Lisp_Object ii
, elt
;
2312 XSETFASTINT (ii
, i
);
2313 elt
= Faref (seq
, ii
);
2316 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2324 /* where-is - finding a command in a set of keymaps. */
2326 static Lisp_Object
where_is_internal ();
2327 static Lisp_Object
where_is_internal_1 ();
2328 static void where_is_internal_2 ();
2330 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2331 Returns the first non-nil binding found in any of those maps. */
2334 shadow_lookup (shadow
, key
, flag
)
2335 Lisp_Object shadow
, key
, flag
;
2337 Lisp_Object tail
, value
;
2339 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2341 value
= Flookup_key (XCAR (tail
), key
, flag
);
2342 if (!NILP (value
) && !NATNUMP (value
))
2348 static Lisp_Object Vmouse_events
;
2350 /* This function can GC if Flookup_key autoloads any keymaps. */
2353 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2354 Lisp_Object definition
, keymaps
;
2355 Lisp_Object firstonly
, noindirect
, no_remap
;
2357 Lisp_Object maps
= Qnil
;
2358 Lisp_Object found
, sequences
;
2359 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2360 /* 1 means ignore all menu bindings entirely. */
2361 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2363 /* If this command is remapped, then it has no key bindings
2365 if (NILP (no_remap
) && SYMBOLP (definition
))
2368 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2373 while (CONSP (found
))
2377 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2378 found
= XCDR (found
);
2381 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2385 for (; !NILP (maps
); maps
= Fcdr (maps
))
2387 /* Key sequence to reach map, and the map that it reaches */
2388 register Lisp_Object
this, map
, tem
;
2390 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2391 [M-CHAR] sequences, check if last character of the sequence
2392 is the meta-prefix char. */
2396 this = Fcar (Fcar (maps
));
2397 map
= Fcdr (Fcar (maps
));
2398 last
= make_number (XINT (Flength (this)) - 1);
2399 last_is_meta
= (XINT (last
) >= 0
2400 && EQ (Faref (this, last
), meta_prefix_char
));
2402 /* if (nomenus && !ascii_sequence_p (this)) */
2403 if (nomenus
&& XINT (last
) >= 0
2404 && SYMBOLP (tem
= Faref (this, make_number (0)))
2405 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmouse_events
)))
2406 /* If no menu entries should be returned, skip over the
2407 keymaps bound to `menu-bar' and `tool-bar' and other
2408 non-ascii prefixes like `C-down-mouse-2'. */
2415 /* Because the code we want to run on each binding is rather
2416 large, we don't want to have two separate loop bodies for
2417 sparse keymap bindings and tables; we want to iterate one
2418 loop body over both keymap and vector bindings.
2420 For this reason, if Fcar (map) is a vector, we don't
2421 advance map to the next element until i indicates that we
2422 have finished off the vector. */
2423 Lisp_Object elt
, key
, binding
;
2431 /* Set key and binding to the current key and binding, and
2432 advance map and i to the next binding. */
2435 Lisp_Object sequence
;
2437 /* In a vector, look at each element. */
2438 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2440 binding
= AREF (elt
, i
);
2441 XSETFASTINT (key
, i
);
2442 sequence
= where_is_internal_1 (binding
, key
, definition
,
2444 last
, nomenus
, last_is_meta
);
2445 if (!NILP (sequence
))
2446 sequences
= Fcons (sequence
, sequences
);
2449 else if (CHAR_TABLE_P (elt
))
2453 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2454 Qnil
), /* Result accumulator. */
2455 Fcons (Fcons (this, last
),
2456 Fcons (make_number (nomenus
),
2457 make_number (last_is_meta
))));
2458 map_char_table (where_is_internal_2
, Qnil
, elt
, args
);
2459 sequences
= XCDR (XCAR (args
));
2461 else if (CONSP (elt
))
2463 Lisp_Object sequence
;
2466 binding
= XCDR (elt
);
2468 sequence
= where_is_internal_1 (binding
, key
, definition
,
2470 last
, nomenus
, last_is_meta
);
2471 if (!NILP (sequence
))
2472 sequences
= Fcons (sequence
, sequences
);
2476 while (!NILP (sequences
))
2478 Lisp_Object sequence
, remapped
, function
;
2480 sequence
= XCAR (sequences
);
2481 sequences
= XCDR (sequences
);
2483 /* If the current sequence is a command remapping with
2484 format [remap COMMAND], find the key sequences
2485 which run COMMAND, and use those sequences instead. */
2488 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2489 && EQ (AREF (sequence
, 0), Qremap
)
2490 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2492 Lisp_Object remapped1
;
2494 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2495 if (CONSP (remapped1
))
2497 /* Verify that this key binding actually maps to the
2498 remapped command (see below). */
2499 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2501 sequence
= XCAR (remapped1
);
2502 remapped
= XCDR (remapped1
);
2503 goto record_sequence
;
2507 /* Verify that this key binding is not shadowed by another
2508 binding for the same key, before we say it exists.
2510 Mechanism: look for local definition of this key and if
2511 it is defined and does not match what we found then
2514 Either nil or number as value from Flookup_key
2516 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2520 /* It is a true unshadowed match. Record it, unless it's already
2521 been seen (as could happen when inheriting keymaps). */
2522 if (NILP (Fmember (sequence
, found
)))
2523 found
= Fcons (sequence
, found
);
2525 /* If firstonly is Qnon_ascii, then we can return the first
2526 binding we find. If firstonly is not Qnon_ascii but not
2527 nil, then we should return the first ascii-only binding
2529 if (EQ (firstonly
, Qnon_ascii
))
2530 RETURN_UNGCPRO (sequence
);
2531 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2532 RETURN_UNGCPRO (sequence
);
2534 if (CONSP (remapped
))
2536 sequence
= XCAR (remapped
);
2537 remapped
= XCDR (remapped
);
2538 goto record_sequence
;
2546 found
= Fnreverse (found
);
2548 /* firstonly may have been t, but we may have gone all the way through
2549 the keymaps without finding an all-ASCII key sequence. So just
2550 return the best we could find. */
2551 if (!NILP (firstonly
))
2552 return Fcar (found
);
2557 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2558 doc
: /* Return list of keys that invoke DEFINITION.
2559 If KEYMAP is non-nil, search only KEYMAP and the global keymap.
2560 If KEYMAP is nil, search all the currently active keymaps.
2561 If KEYMAP is a list of keymaps, search only those keymaps.
2563 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2564 rather than a list of all possible key sequences.
2565 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2566 no matter what it is.
2567 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters,
2568 and entirely reject menu bindings.
2570 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2571 to other keymaps or slots. This makes it possible to search for an
2572 indirect definition itself.
2574 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2575 that invoke a command which is remapped to DEFINITION, but include the
2576 remapped command in the returned list. */)
2577 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2578 Lisp_Object definition
, keymap
;
2579 Lisp_Object firstonly
, noindirect
, no_remap
;
2581 Lisp_Object sequences
, keymaps
;
2582 /* 1 means ignore all menu bindings entirely. */
2583 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2586 /* Find the relevant keymaps. */
2587 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2589 else if (!NILP (keymap
))
2590 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2592 keymaps
= Fcurrent_active_maps (Qnil
);
2594 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2595 We don't really need to check `keymap'. */
2596 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2600 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2602 /* Check heuristic-consistency of the cache. */
2603 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2604 where_is_cache
= Qnil
;
2606 if (NILP (where_is_cache
))
2608 /* We need to create the cache. */
2609 Lisp_Object args
[2];
2610 where_is_cache
= Fmake_hash_table (0, args
);
2611 where_is_cache_keymaps
= Qt
;
2613 /* Fill in the cache. */
2614 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2615 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2618 where_is_cache_keymaps
= keymaps
;
2621 /* We want to process definitions from the last to the first.
2622 Instead of consing, copy definitions to a vector and step
2623 over that vector. */
2624 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2625 n
= XINT (Flength (sequences
));
2626 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2627 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2628 defns
[i
++] = XCAR (sequences
);
2630 /* Verify that the key bindings are not shadowed. Note that
2631 the following can GC. */
2632 GCPRO2 (definition
, keymaps
);
2635 for (i
= n
- 1; i
>= 0; --i
)
2636 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2638 if (ascii_sequence_p (defns
[i
]))
2644 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2649 /* Kill the cache so that where_is_internal_1 doesn't think
2650 we're filling it up. */
2651 where_is_cache
= Qnil
;
2652 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2658 /* This is the function that Fwhere_is_internal calls using map_char_table.
2660 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2662 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2663 Since map_char_table doesn't really use the return value from this function,
2664 we the result append to RESULT, the slot in ARGS.
2666 This function can GC because it calls where_is_internal_1 which can
2670 where_is_internal_2 (args
, key
, binding
)
2671 Lisp_Object args
, key
, binding
;
2673 Lisp_Object definition
, noindirect
, this, last
;
2674 Lisp_Object result
, sequence
;
2675 int nomenus
, last_is_meta
;
2676 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2678 GCPRO3 (args
, key
, binding
);
2679 result
= XCDR (XCAR (args
));
2680 definition
= XCAR (XCAR (XCAR (args
)));
2681 noindirect
= XCDR (XCAR (XCAR (args
)));
2682 this = XCAR (XCAR (XCDR (args
)));
2683 last
= XCDR (XCAR (XCDR (args
)));
2684 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2685 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2687 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2688 this, last
, nomenus
, last_is_meta
);
2690 if (!NILP (sequence
))
2691 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2697 /* This function cannot GC. */
2700 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2701 nomenus
, last_is_meta
)
2702 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2703 int nomenus
, last_is_meta
;
2705 Lisp_Object sequence
;
2707 /* Search through indirections unless that's not wanted. */
2708 if (NILP (noindirect
))
2709 binding
= get_keyelt (binding
, 0);
2711 /* End this iteration if this element does not match
2714 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2715 || EQ (binding
, definition
)
2716 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2717 /* Doesn't match. */
2720 /* We have found a match. Construct the key sequence where we found it. */
2721 if (INTEGERP (key
) && last_is_meta
)
2723 sequence
= Fcopy_sequence (this);
2724 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2727 sequence
= append_key (this, key
);
2729 if (!NILP (where_is_cache
))
2731 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2732 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2739 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2741 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2742 doc
: /* Insert the list of all defined keys and their definitions.
2743 The list is inserted in the current buffer, while the bindings are
2744 looked up in BUFFER.
2745 The optional argument PREFIX, if non-nil, should be a key sequence;
2746 then we display only bindings that start with that prefix.
2747 The optional argument MENUS, if non-nil, says to mention menu bindings.
2748 \(Ordinarily these are omitted from the output.) */)
2749 (buffer
, prefix
, menus
)
2750 Lisp_Object buffer
, prefix
, menus
;
2752 Lisp_Object outbuf
, shadow
;
2753 int nomenu
= NILP (menus
);
2754 register Lisp_Object start1
;
2755 struct gcpro gcpro1
;
2757 char *alternate_heading
2759 Keyboard translations:\n\n\
2760 You type Translation\n\
2761 -------- -----------\n";
2766 outbuf
= Fcurrent_buffer ();
2768 /* Report on alternates for keys. */
2769 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2772 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2773 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2775 for (c
= 0; c
< translate_len
; c
++)
2776 if (translate
[c
] != c
)
2778 char buf
[KEY_DESCRIPTION_SIZE
];
2781 if (alternate_heading
)
2783 insert_string (alternate_heading
);
2784 alternate_heading
= 0;
2787 bufend
= push_key_description (translate
[c
], buf
, 1);
2788 insert (buf
, bufend
- buf
);
2789 Findent_to (make_number (16), make_number (1));
2790 bufend
= push_key_description (c
, buf
, 1);
2791 insert (buf
, bufend
- buf
);
2799 if (!NILP (Vkey_translation_map
))
2800 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2801 "Key translations", nomenu
, 1, 0);
2804 /* Print the (major mode) local map. */
2806 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2807 start1
= current_kboard
->Voverriding_terminal_local_map
;
2808 else if (!NILP (Voverriding_local_map
))
2809 start1
= Voverriding_local_map
;
2813 describe_map_tree (start1
, 1, shadow
, prefix
,
2814 "\f\nOverriding Bindings", nomenu
, 0, 0);
2815 shadow
= Fcons (start1
, shadow
);
2819 /* Print the minor mode and major mode keymaps. */
2821 Lisp_Object
*modes
, *maps
;
2823 /* Temporarily switch to `buffer', so that we can get that buffer's
2824 minor modes correctly. */
2825 Fset_buffer (buffer
);
2827 nmaps
= current_minor_maps (&modes
, &maps
);
2828 Fset_buffer (outbuf
);
2830 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2831 XBUFFER (buffer
), Qkeymap
);
2834 describe_map_tree (start1
, 1, shadow
, prefix
,
2835 "\f\n`keymap' Property Bindings", nomenu
, 0, 0);
2836 shadow
= Fcons (start1
, shadow
);
2839 /* Print the minor mode maps. */
2840 for (i
= 0; i
< nmaps
; i
++)
2842 /* The title for a minor mode keymap
2843 is constructed at run time.
2844 We let describe_map_tree do the actual insertion
2845 because it takes care of other features when doing so. */
2848 if (!SYMBOLP (modes
[i
]))
2851 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2855 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2856 SCHARS (SYMBOL_NAME (modes
[i
])));
2857 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2859 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2860 p
+= sizeof (" Minor Mode Bindings") - 1;
2863 describe_map_tree (maps
[i
], 1, shadow
, prefix
, title
, nomenu
, 0, 0);
2864 shadow
= Fcons (maps
[i
], shadow
);
2867 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2868 XBUFFER (buffer
), Qlocal_map
);
2871 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2872 describe_map_tree (start1
, 1, shadow
, prefix
,
2873 "\f\nMajor Mode Bindings", nomenu
, 0, 0);
2875 describe_map_tree (start1
, 1, shadow
, prefix
,
2876 "\f\n`local-map' Property Bindings",
2879 shadow
= Fcons (start1
, shadow
);
2883 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2884 "\f\nGlobal Bindings", nomenu
, 0, 1);
2886 /* Print the function-key-map translations under this prefix. */
2887 if (!NILP (Vfunction_key_map
))
2888 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2889 "\f\nFunction key map translations", nomenu
, 1, 0);
2895 /* Insert a description of the key bindings in STARTMAP,
2896 followed by those of all maps reachable through STARTMAP.
2897 If PARTIAL is nonzero, omit certain "uninteresting" commands
2898 (such as `undefined').
2899 If SHADOW is non-nil, it is a list of maps;
2900 don't mention keys which would be shadowed by any of them.
2901 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2902 TITLE, if not 0, is a string to insert at the beginning.
2903 TITLE should not end with a colon or a newline; we supply that.
2904 If NOMENU is not 0, then omit menu-bar commands.
2906 If TRANSL is nonzero, the definitions are actually key translations
2907 so print strings and vectors differently.
2909 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2913 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2915 Lisp_Object startmap
, shadow
, prefix
;
2922 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2923 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2930 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
2933 GCPRO3 (maps
, seen
, sub_shadows
);
2939 /* Delete from MAPS each element that is for the menu bar. */
2940 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
2942 Lisp_Object elt
, prefix
, tem
;
2945 prefix
= Fcar (elt
);
2946 if (XVECTOR (prefix
)->size
>= 1)
2948 tem
= Faref (prefix
, make_number (0));
2949 if (EQ (tem
, Qmenu_bar
))
2950 maps
= Fdelq (elt
, maps
);
2955 if (!NILP (maps
) || always_title
)
2959 insert_string (title
);
2962 insert_string (" Starting With ");
2963 insert1 (Fkey_description (prefix
, Qnil
));
2965 insert_string (":\n");
2967 insert_string (key_heading
);
2971 for (; !NILP (maps
); maps
= Fcdr (maps
))
2973 register Lisp_Object elt
, prefix
, tail
;
2976 prefix
= Fcar (elt
);
2980 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2984 shmap
= XCAR (tail
);
2986 /* If the sequence by which we reach this keymap is zero-length,
2987 then the shadow map for this keymap is just SHADOW. */
2988 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
2989 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
2991 /* If the sequence by which we reach this keymap actually has
2992 some elements, then the sequence's definition in SHADOW is
2993 what we should use. */
2996 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
2997 if (INTEGERP (shmap
))
3001 /* If shmap is not nil and not a keymap,
3002 it completely shadows this map, so don't
3003 describe this map at all. */
3004 if (!NILP (shmap
) && !KEYMAPP (shmap
))
3008 sub_shadows
= Fcons (shmap
, sub_shadows
);
3011 /* Maps we have already listed in this loop shadow this map. */
3012 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
3015 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
3017 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
3020 describe_map (Fcdr (elt
), prefix
,
3021 transl
? describe_translation
: describe_command
,
3022 partial
, sub_shadows
, &seen
, nomenu
);
3028 insert_string ("\n");
3033 static int previous_description_column
;
3036 describe_command (definition
, args
)
3037 Lisp_Object definition
, args
;
3039 register Lisp_Object tem1
;
3040 int column
= (int) current_column (); /* iftc */
3041 int description_column
;
3043 /* If column 16 is no good, go to col 32;
3044 but don't push beyond that--go to next line instead. */
3048 description_column
= 32;
3050 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
3051 description_column
= 32;
3053 description_column
= 16;
3055 Findent_to (make_number (description_column
), make_number (1));
3056 previous_description_column
= description_column
;
3058 if (SYMBOLP (definition
))
3060 tem1
= SYMBOL_NAME (definition
);
3062 insert_string ("\n");
3064 else if (STRINGP (definition
) || VECTORP (definition
))
3065 insert_string ("Keyboard Macro\n");
3066 else if (KEYMAPP (definition
))
3067 insert_string ("Prefix Command\n");
3069 insert_string ("??\n");
3073 describe_translation (definition
, args
)
3074 Lisp_Object definition
, args
;
3076 register Lisp_Object tem1
;
3078 Findent_to (make_number (16), make_number (1));
3080 if (SYMBOLP (definition
))
3082 tem1
= SYMBOL_NAME (definition
);
3084 insert_string ("\n");
3086 else if (STRINGP (definition
) || VECTORP (definition
))
3088 insert1 (Fkey_description (definition
, Qnil
));
3089 insert_string ("\n");
3091 else if (KEYMAPP (definition
))
3092 insert_string ("Prefix Command\n");
3094 insert_string ("??\n");
3097 /* Describe the contents of map MAP, assuming that this map itself is
3098 reached by the sequence of prefix keys PREFIX (a string or vector).
3099 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3102 describe_map (map
, prefix
, elt_describer
, partial
, shadow
, seen
, nomenu
)
3103 register Lisp_Object map
;
3105 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3111 Lisp_Object tail
, definition
, event
;
3113 Lisp_Object suppress
;
3116 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3121 suppress
= intern ("suppress-keymap");
3123 /* This vector gets used to present single keys to Flookup_key. Since
3124 that is done once per keymap element, we don't want to cons up a
3125 fresh vector every time. */
3126 kludge
= Fmake_vector (make_number (1), Qnil
);
3129 GCPRO3 (prefix
, definition
, kludge
);
3131 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3135 if (VECTORP (XCAR (tail
))
3136 || CHAR_TABLE_P (XCAR (tail
)))
3137 describe_vector (XCAR (tail
),
3138 prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3140 else if (CONSP (XCAR (tail
)))
3142 event
= XCAR (XCAR (tail
));
3144 /* Ignore bindings whose "prefix" are not really valid events.
3145 (We get these in the frames and buffers menu.) */
3146 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3149 if (nomenu
&& EQ (event
, Qmenu_bar
))
3152 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3154 /* Don't show undefined commands or suppressed commands. */
3155 if (NILP (definition
)) continue;
3156 if (SYMBOLP (definition
) && partial
)
3158 tem
= Fget (definition
, suppress
);
3163 /* Don't show a command that isn't really visible
3164 because a local definition of the same key shadows it. */
3166 ASET (kludge
, 0, event
);
3169 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3170 if (!NILP (tem
)) continue;
3173 tem
= Flookup_key (map
, kludge
, Qt
);
3174 if (!EQ (tem
, definition
)) continue;
3178 previous_description_column
= 0;
3183 /* THIS gets the string to describe the character EVENT. */
3184 insert1 (Fkey_description (kludge
, prefix
));
3186 /* Print a description of the definition of this character.
3187 elt_describer will take care of spacing out far enough
3188 for alignment purposes. */
3189 (*elt_describer
) (definition
, Qnil
);
3191 else if (EQ (XCAR (tail
), Qkeymap
))
3193 /* The same keymap might be in the structure twice, if we're
3194 using an inherited keymap. So skip anything we've already
3196 tem
= Fassq (tail
, *seen
);
3197 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), prefix
)))
3199 *seen
= Fcons (Fcons (tail
, prefix
), *seen
);
3207 describe_vector_princ (elt
, fun
)
3208 Lisp_Object elt
, fun
;
3210 Findent_to (make_number (16), make_number (1));
3215 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3216 doc
: /* Insert a description of contents of VECTOR.
3217 This is text showing the elements of vector matched against indices.
3218 DESCRIBER is the output function used; nil means use `princ'. */)
3220 Lisp_Object vector
, describer
;
3222 int count
= SPECPDL_INDEX ();
3223 if (NILP (describer
))
3224 describer
= intern ("princ");
3225 specbind (Qstandard_output
, Fcurrent_buffer ());
3226 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3227 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3228 Qnil
, Qnil
, (int *)0, 0, 0);
3230 return unbind_to (count
, Qnil
);
3233 /* Insert in the current buffer a description of the contents of VECTOR.
3234 We call ELT_DESCRIBER to insert the description of one value found
3237 ELT_PREFIX describes what "comes before" the keys or indices defined
3238 by this vector. This is a human-readable string whose size
3239 is not necessarily related to the situation.
3241 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3242 leads to this keymap.
3244 If the vector is a chartable, ELT_PREFIX is the vector
3245 of bytes that lead to the character set or portion of a character
3246 set described by this chartable.
3248 If PARTIAL is nonzero, it means do not mention suppressed commands
3249 (that assumes the vector is in a keymap).
3251 SHADOW is a list of keymaps that shadow this map.
3252 If it is non-nil, then we look up the key in those maps
3253 and we don't mention it now if it is defined by any of them.
3255 ENTIRE_MAP is the keymap in which this vector appears.
3256 If the definition in effect in the whole map does not match
3257 the one in this vector, we ignore this one.
3259 ARGS is simply passed as the second argument to ELT_DESCRIBER.
3261 INDICES and CHAR_TABLE_DEPTH are ignored. They will be removed in
3264 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3266 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
3269 describe_vector (vector
, prefix
, args
, elt_describer
,
3270 partial
, shadow
, entire_map
,
3271 indices
, char_table_depth
, keymap_p
)
3272 register Lisp_Object vector
;
3273 Lisp_Object prefix
, args
;
3274 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3277 Lisp_Object entire_map
;
3279 int char_table_depth
;
3282 Lisp_Object definition
;
3284 Lisp_Object elt_prefix
= Qnil
;
3286 Lisp_Object suppress
;
3289 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3290 /* Range of elements to be handled. */
3292 Lisp_Object character
;
3301 /* Call Fkey_description first, to avoid GC bug for the other string. */
3302 if (!NILP (prefix
) && XFASTINT (Flength (prefix
)) > 0)
3305 tem
= Fkey_description (prefix
, Qnil
);
3306 elt_prefix
= concat2 (tem
, build_string (" "));
3311 /* This vector gets used to present single keys to Flookup_key. Since
3312 that is done once per vector element, we don't want to cons up a
3313 fresh vector every time. */
3314 kludge
= Fmake_vector (make_number (1), Qnil
);
3315 GCPRO4 (elt_prefix
, prefix
, definition
, kludge
);
3318 suppress
= intern ("suppress-keymap");
3321 to
= CHAR_TABLE_P (vector
) ? MAX_CHAR
+ 1 : XVECTOR (vector
)->size
;
3323 for (i
= from
; i
< to
; i
++)
3325 int range_beg
, range_end
;
3332 if (CHAR_TABLE_P (vector
))
3333 val
= char_table_ref_and_range (vector
, i
, &range_beg
, &i
);
3335 val
= AREF (vector
, i
);
3336 definition
= get_keyelt (val
, 0);
3338 if (NILP (definition
)) continue;
3340 /* Don't mention suppressed commands. */
3341 if (SYMBOLP (definition
) && partial
)
3345 tem
= Fget (definition
, suppress
);
3347 if (!NILP (tem
)) continue;
3350 character
= make_number (starting_i
);
3351 ASET (kludge
, 0, character
);
3353 /* If this binding is shadowed by some other map, ignore it. */
3358 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3360 if (!NILP (tem
)) continue;
3363 /* Ignore this definition if it is shadowed by an earlier
3364 one in the same keymap. */
3365 if (!NILP (entire_map
))
3369 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3371 if (!EQ (tem
, definition
))
3381 /* Output the prefix that applies to every entry in this map. */
3382 if (!NILP (elt_prefix
))
3383 insert1 (elt_prefix
);
3385 insert1 (Fkey_description (kludge
, prefix
));
3387 /* Find all consecutive characters or rows that have the same
3388 definition. But, for elements of a top level char table, if
3389 they are for charsets, we had better describe one by one even
3390 if they have the same definition. */
3391 if (CHAR_TABLE_P (vector
))
3393 && (val
= char_table_ref_and_range (vector
, i
+ 1,
3394 &range_beg
, &range_end
),
3395 tem2
= get_keyelt (val
, 0),
3397 && !NILP (Fequal (tem2
, definition
)))
3401 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3403 && !NILP (Fequal (tem2
, definition
)))
3406 /* If we have a range of more than one character,
3407 print where the range reaches to. */
3409 if (i
!= starting_i
)
3413 ASET (kludge
, 0, make_number (i
));
3415 if (!NILP (elt_prefix
))
3416 insert1 (elt_prefix
);
3418 insert1 (Fkey_description (kludge
, prefix
));
3421 /* Print a description of the definition of this character.
3422 elt_describer will take care of spacing out far enough
3423 for alignment purposes. */
3424 (*elt_describer
) (definition
, args
);
3427 if (CHAR_TABLE_P (vector
) && ! NILP (XCHAR_TABLE (vector
)->defalt
))
3429 if (!NILP (elt_prefix
))
3430 insert1 (elt_prefix
);
3431 insert ("default", 7);
3432 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
, args
);
3438 /* Apropos - finding all symbols whose names match a regexp. */
3439 static Lisp_Object apropos_predicate
;
3440 static Lisp_Object apropos_accumulate
;
3443 apropos_accum (symbol
, string
)
3444 Lisp_Object symbol
, string
;
3446 register Lisp_Object tem
;
3448 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3449 if (!NILP (tem
) && !NILP (apropos_predicate
))
3450 tem
= call1 (apropos_predicate
, symbol
);
3452 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3455 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3456 doc
: /* Show all symbols whose names contain match for REGEXP.
3457 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3458 for each symbol and a symbol is mentioned only if that returns non-nil.
3459 Return list of symbols found. */)
3461 Lisp_Object regexp
, predicate
;
3464 CHECK_STRING (regexp
);
3465 apropos_predicate
= predicate
;
3466 apropos_accumulate
= Qnil
;
3467 map_obarray (Vobarray
, apropos_accum
, regexp
);
3468 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3469 apropos_accumulate
= Qnil
;
3470 apropos_predicate
= Qnil
;
3477 Qkeymap
= intern ("keymap");
3478 staticpro (&Qkeymap
);
3479 staticpro (&apropos_predicate
);
3480 staticpro (&apropos_accumulate
);
3481 apropos_predicate
= Qnil
;
3482 apropos_accumulate
= Qnil
;
3484 /* Now we are ready to set up this property, so we can
3485 create char tables. */
3486 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3488 /* Initialize the keymaps standardly used.
3489 Each one is the value of a Lisp variable, and is also
3490 pointed to by a C variable */
3492 global_map
= Fmake_keymap (Qnil
);
3493 Fset (intern ("global-map"), global_map
);
3495 current_global_map
= global_map
;
3496 staticpro (&global_map
);
3497 staticpro (¤t_global_map
);
3499 meta_map
= Fmake_keymap (Qnil
);
3500 Fset (intern ("esc-map"), meta_map
);
3501 Ffset (intern ("ESC-prefix"), meta_map
);
3503 control_x_map
= Fmake_keymap (Qnil
);
3504 Fset (intern ("ctl-x-map"), control_x_map
);
3505 Ffset (intern ("Control-X-prefix"), control_x_map
);
3508 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3509 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3510 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3511 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3512 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3514 staticpro (&exclude_keys
);
3516 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3517 doc
: /* List of commands given new key bindings recently.
3518 This is used for internal purposes during Emacs startup;
3519 don't alter it yourself. */);
3520 Vdefine_key_rebound_commands
= Qt
;
3522 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3523 doc
: /* Default keymap to use when reading from the minibuffer. */);
3524 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3526 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3527 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3528 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3529 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3531 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3532 doc
: /* Local keymap for minibuffer input with completion. */);
3533 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3534 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3536 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3537 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3538 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3539 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3540 Vminibuffer_local_completion_map
);
3542 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3543 doc
: /* Alist of keymaps to use for minor modes.
3544 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3545 key sequences and look up bindings iff VARIABLE's value is non-nil.
3546 If two active keymaps bind the same key, the keymap appearing earlier
3547 in the list takes precedence. */);
3548 Vminor_mode_map_alist
= Qnil
;
3550 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3551 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3552 This variable is an alist just like `minor-mode-map-alist', and it is
3553 used the same way (and before `minor-mode-map-alist'); however,
3554 it is provided for major modes to bind locally. */);
3555 Vminor_mode_overriding_map_alist
= Qnil
;
3557 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3558 doc
: /* List of keymap alists to use for emulations modes.
3559 It is intended for modes or packages using multiple minor-mode keymaps.
3560 Each element is a keymap alist just like `minor-mode-map-alist', or a
3561 symbol with a variable binding which is a keymap alist, and it is used
3562 the same way. The "active" keymaps in each alist are used before
3563 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3564 Vemulation_mode_map_alists
= Qnil
;
3567 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3568 doc
: /* Keymap mapping ASCII function key sequences onto their preferred forms.
3569 This allows Emacs to recognize function keys sent from ASCII
3570 terminals at any point in a key sequence.
3572 The `read-key-sequence' function replaces any subsequence bound by
3573 `function-key-map' with its binding. More precisely, when the active
3574 keymaps have no binding for the current key sequence but
3575 `function-key-map' binds a suffix of the sequence to a vector or string,
3576 `read-key-sequence' replaces the matching suffix with its binding, and
3577 continues with the new sequence.
3579 The events that come from bindings in `function-key-map' are not
3580 themselves looked up in `function-key-map'.
3582 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3583 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3584 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3585 key, typing `ESC O P x' would return [f1 x]. */);
3586 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3588 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3589 doc
: /* Keymap of key translations that can override keymaps.
3590 This keymap works like `function-key-map', but comes after that,
3591 and applies even for keys that have ordinary bindings. */);
3592 Vkey_translation_map
= Qnil
;
3594 staticpro (&Vmouse_events
);
3595 Vmouse_events
= Fcons (intern ("menu-bar"),
3596 Fcons (intern ("tool-bar"),
3597 Fcons (intern ("header-line"),
3598 Fcons (intern ("mode-line"),
3599 Fcons (intern ("mouse-1"),
3600 Fcons (intern ("mouse-2"),
3601 Fcons (intern ("mouse-3"),
3602 Fcons (intern ("mouse-4"),
3603 Fcons (intern ("mouse-5"),
3607 Qsingle_key_description
= intern ("single-key-description");
3608 staticpro (&Qsingle_key_description
);
3610 Qkey_description
= intern ("key-description");
3611 staticpro (&Qkey_description
);
3613 Qkeymapp
= intern ("keymapp");
3614 staticpro (&Qkeymapp
);
3616 Qnon_ascii
= intern ("non-ascii");
3617 staticpro (&Qnon_ascii
);
3619 Qmenu_item
= intern ("menu-item");
3620 staticpro (&Qmenu_item
);
3622 Qremap
= intern ("remap");
3623 staticpro (&Qremap
);
3625 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3626 staticpro (&command_remapping_vector
);
3628 where_is_cache_keymaps
= Qt
;
3629 where_is_cache
= Qnil
;
3630 staticpro (&where_is_cache
);
3631 staticpro (&where_is_cache_keymaps
);
3633 defsubr (&Skeymapp
);
3634 defsubr (&Skeymap_parent
);
3635 defsubr (&Skeymap_prompt
);
3636 defsubr (&Sset_keymap_parent
);
3637 defsubr (&Smake_keymap
);
3638 defsubr (&Smake_sparse_keymap
);
3639 defsubr (&Smap_keymap
);
3640 defsubr (&Scopy_keymap
);
3641 defsubr (&Scommand_remapping
);
3642 defsubr (&Skey_binding
);
3643 defsubr (&Slocal_key_binding
);
3644 defsubr (&Sglobal_key_binding
);
3645 defsubr (&Sminor_mode_key_binding
);
3646 defsubr (&Sdefine_key
);
3647 defsubr (&Slookup_key
);
3648 defsubr (&Sdefine_prefix_command
);
3649 defsubr (&Suse_global_map
);
3650 defsubr (&Suse_local_map
);
3651 defsubr (&Scurrent_local_map
);
3652 defsubr (&Scurrent_global_map
);
3653 defsubr (&Scurrent_minor_mode_maps
);
3654 defsubr (&Scurrent_active_maps
);
3655 defsubr (&Saccessible_keymaps
);
3656 defsubr (&Skey_description
);
3657 defsubr (&Sdescribe_vector
);
3658 defsubr (&Ssingle_key_description
);
3659 defsubr (&Stext_char_description
);
3660 defsubr (&Swhere_is_internal
);
3661 defsubr (&Sdescribe_buffer_bindings
);
3662 defsubr (&Sapropos_internal
);
3668 initial_define_key (global_map
, 033, "ESC-prefix");
3669 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");
3672 /* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
3673 (do not change this comment) */