1 /* Manipulation of keymaps
2 Copyright (C) 1985, 86,87,88,93,94,95,98,99, 2000, 2001
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 silly_event_symbol_error
P_ ((Lisp_Object
));
127 /* Keymap object support - constructors and predicates. */
129 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
130 doc
: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
131 CHARTABLE is a char-table that holds the bindings for the ASCII
132 characters. ALIST is an assoc-list which holds bindings for function keys,
133 mouse events, and any other things that appear in the input stream.
134 All entries in it are initially nil, meaning "command undefined".
136 The optional arg STRING supplies a menu name for the keymap
137 in case you use it as a menu with `x-popup-menu'. */)
143 tail
= Fcons (string
, Qnil
);
146 return Fcons (Qkeymap
,
147 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
150 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
151 doc
: /* Construct and return a new sparse keymap.
152 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
153 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
154 which binds the function key or mouse event SYMBOL to DEFINITION.
155 Initially the alist is nil.
157 The optional arg STRING supplies a menu name for the keymap
158 in case you use it as a menu with `x-popup-menu'. */)
163 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
164 return Fcons (Qkeymap
, Qnil
);
167 /* This function is used for installing the standard key bindings
168 at initialization time.
172 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
175 initial_define_key (keymap
, key
, defname
)
180 store_in_keymap (keymap
, make_number (key
), intern (defname
));
184 initial_define_lispy_key (keymap
, keyname
, defname
)
189 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
192 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
193 doc
: /* Return t if OBJECT is a keymap.
195 A keymap is a list (keymap . ALIST),
196 or a symbol whose function definition is itself a keymap.
197 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
198 a vector of densely packed bindings for small character codes
199 is also allowed as an element. */)
203 return (KEYMAPP (object
) ? Qt
: Qnil
);
206 DEFUN ("keymap-prompt", Fkeymap_prompt
, Skeymap_prompt
, 1, 1, 0,
207 doc
: /* Return the prompt-string of a keymap MAP.
208 If non-nil, the prompt is shown in the echo-area
209 when reading a key-sequence to be looked-up in this keymap. */)
215 register Lisp_Object tem
;
224 /* Check that OBJECT is a keymap (after dereferencing through any
225 symbols). If it is, return it.
227 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
228 is an autoload form, do the autoload and try again.
229 If AUTOLOAD is nonzero, callers must assume GC is possible.
231 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
232 is zero as well), return Qt.
234 ERROR controls how we respond if OBJECT isn't a keymap.
235 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
237 Note that most of the time, we don't want to pursue autoloads.
238 Functions like Faccessible_keymaps which scan entire keymap trees
239 shouldn't load every autoloaded keymap. I'm not sure about this,
240 but it seems to me that only read_key_sequence, Flookup_key, and
241 Fdefine_key should cause keymaps to be autoloaded.
243 This function can GC when AUTOLOAD is non-zero, because it calls
244 do_autoload which can GC. */
247 get_keymap (object
, error
, autoload
)
256 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
259 tem
= indirect_function (object
);
262 if (EQ (XCAR (tem
), Qkeymap
))
265 /* Should we do an autoload? Autoload forms for keymaps have
266 Qkeymap as their fifth element. */
267 if ((autoload
|| !error
) && EQ (XCAR (tem
), Qautoload
))
271 tail
= Fnth (make_number (4), tem
);
272 if (EQ (tail
, Qkeymap
))
276 struct gcpro gcpro1
, gcpro2
;
278 GCPRO2 (tem
, object
);
279 do_autoload (tem
, object
);
292 wrong_type_argument (Qkeymapp
, object
);
296 /* Return the parent map of KEYMAP, or nil if it has none.
297 We assume that KEYMAP is a valid keymap. */
300 keymap_parent (keymap
, autoload
)
306 keymap
= get_keymap (keymap
, 1, autoload
);
308 /* Skip past the initial element `keymap'. */
309 list
= XCDR (keymap
);
310 for (; CONSP (list
); list
= XCDR (list
))
312 /* See if there is another `keymap'. */
317 return get_keymap (list
, 0, autoload
);
320 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
321 doc
: /* Return the parent keymap of KEYMAP. */)
325 return keymap_parent (keymap
, 1);
328 /* Check whether MAP is one of MAPS parents. */
330 keymap_memberp (map
, maps
)
331 Lisp_Object map
, maps
;
333 if (NILP (map
)) return 0;
334 while (KEYMAPP (maps
) && !EQ (map
, maps
))
335 maps
= keymap_parent (maps
, 0);
336 return (EQ (map
, maps
));
339 /* Set the parent keymap of MAP to PARENT. */
341 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
342 doc
: /* Modify KEYMAP to set its parent map to PARENT.
343 PARENT should be nil or another keymap. */)
345 Lisp_Object keymap
, parent
;
347 Lisp_Object list
, prev
;
348 struct gcpro gcpro1
, gcpro2
;
351 /* Force a keymap flush for the next call to where-is.
352 Since this can be called from within where-is, we don't set where_is_cache
353 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
354 be changed during where-is, while where_is_cache_keymaps is only used at
355 the very beginning of where-is and can thus be changed here without any
357 This is a very minor correctness (rather than safety) issue. */
358 where_is_cache_keymaps
= Qt
;
360 GCPRO2 (keymap
, parent
);
361 keymap
= get_keymap (keymap
, 1, 1);
365 parent
= get_keymap (parent
, 1, 1);
367 /* Check for cycles. */
368 if (keymap_memberp (keymap
, parent
))
369 error ("Cyclic keymap inheritance");
372 /* Skip past the initial element `keymap'. */
377 /* If there is a parent keymap here, replace it.
378 If we came to the end, add the parent in PREV. */
379 if (!CONSP (list
) || KEYMAPP (list
))
381 /* If we already have the right parent, return now
382 so that we avoid the loops below. */
383 if (EQ (XCDR (prev
), parent
))
384 RETURN_UNGCPRO (parent
);
386 XSETCDR (prev
, parent
);
392 /* Scan through for submaps, and set their parents too. */
394 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
396 /* Stop the scan when we come to the parent. */
397 if (EQ (XCAR (list
), Qkeymap
))
400 /* If this element holds a prefix map, deal with it. */
401 if (CONSP (XCAR (list
))
402 && CONSP (XCDR (XCAR (list
))))
403 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
406 if (VECTORP (XCAR (list
)))
407 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
408 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
409 fix_submap_inheritance (keymap
, make_number (i
),
410 XVECTOR (XCAR (list
))->contents
[i
]);
412 if (CHAR_TABLE_P (XCAR (list
)))
414 map_char_table (fix_submap_inheritance
, Qnil
, XCAR (list
), keymap
);
418 RETURN_UNGCPRO (parent
);
421 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
422 if EVENT is also a prefix in MAP's parent,
423 make sure that SUBMAP inherits that definition as its own parent. */
426 fix_submap_inheritance (map
, event
, submap
)
427 Lisp_Object map
, event
, submap
;
429 Lisp_Object map_parent
, parent_entry
;
431 /* SUBMAP is a cons that we found as a key binding.
432 Discard the other things found in a menu key binding. */
434 submap
= get_keymap (get_keyelt (submap
, 0), 0, 0);
436 /* If it isn't a keymap now, there's no work to do. */
440 map_parent
= keymap_parent (map
, 0);
441 if (!NILP (map_parent
))
443 get_keymap (access_keymap (map_parent
, event
, 0, 0, 0), 0, 0);
447 /* If MAP's parent has something other than a keymap,
448 our own submap shadows it completely. */
449 if (!CONSP (parent_entry
))
452 if (! EQ (parent_entry
, submap
))
454 Lisp_Object submap_parent
;
455 submap_parent
= submap
;
460 tem
= keymap_parent (submap_parent
, 0);
464 if (keymap_memberp (tem
, parent_entry
))
465 /* Fset_keymap_parent could create a cycle. */
472 Fset_keymap_parent (submap_parent
, parent_entry
);
476 /* Look up IDX in MAP. IDX may be any sort of event.
477 Note that this does only one level of lookup; IDX must be a single
478 event, not a sequence.
480 If T_OK is non-zero, bindings for Qt are treated as default
481 bindings; any key left unmentioned by other tables and bindings is
482 given the binding of Qt.
484 If T_OK is zero, bindings for Qt are not treated specially.
486 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
489 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
498 /* Qunbound in VAL means we have found no binding yet. */
501 /* If idx is a list (some sort of mouse click, perhaps?),
502 the index we want to use is the car of the list, which
503 ought to be a symbol. */
504 idx
= EVENT_HEAD (idx
);
506 /* If idx is a symbol, it might have modifiers, which need to
507 be put in the canonical order. */
509 idx
= reorder_modifiers (idx
);
510 else if (INTEGERP (idx
))
511 /* Clobber the high bits that can be present on a machine
512 with more than 24 bits of integer. */
513 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
515 /* Handle the special meta -> esc mapping. */
516 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
518 /* See if there is a meta-map. If there's none, there is
519 no binding for IDX, unless a default binding exists in MAP. */
521 Lisp_Object meta_map
;
523 meta_map
= get_keymap (access_keymap (map
, meta_prefix_char
,
524 t_ok
, noinherit
, autoload
),
527 if (CONSP (meta_map
))
530 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
533 /* Set IDX to t, so that we only find a default binding. */
536 /* We know there is no binding. */
540 /* t_binding is where we put a default binding that applies,
541 to use in case we do not find a binding specifically
542 for this key sequence. */
545 Lisp_Object t_binding
= Qnil
;
546 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
548 GCPRO4 (map
, tail
, idx
, t_binding
);
550 /* If `t_ok' is 2, both `t' is accepted. */
553 for (tail
= XCDR (map
);
555 || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
)));
560 binding
= XCAR (tail
);
561 if (SYMBOLP (binding
))
563 /* If NOINHERIT, stop finding prefix definitions
564 after we pass a second occurrence of the `keymap' symbol. */
565 if (noinherit
&& EQ (binding
, Qkeymap
))
566 RETURN_UNGCPRO (Qnil
);
568 else if (CONSP (binding
))
570 Lisp_Object key
= XCAR (binding
);
573 val
= XCDR (binding
);
574 else if (t_ok
> 1 && EQ (key
, Qt
))
576 t_binding
= XCDR (binding
);
580 else if (VECTORP (binding
))
582 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (binding
))
583 val
= AREF (binding
, XFASTINT (idx
));
585 else if (CHAR_TABLE_P (binding
))
587 /* Character codes with modifiers
588 are not included in a char-table.
589 All character codes without modifiers are included. */
590 if (NATNUMP (idx
) && (XFASTINT (idx
) & CHAR_MODIFIER_MASK
) == 0)
592 val
= Faref (binding
, idx
);
593 /* `nil' has a special meaning for char-tables, so
594 we use something else to record an explicitly
601 /* If we found a binding, clean it up and return it. */
602 if (!EQ (val
, Qunbound
))
605 /* A Qt binding is just like an explicit nil binding
606 (i.e. it shadows any parent binding but not bindings in
607 keymaps of lower precedence). */
609 val
= get_keyelt (val
, autoload
);
611 fix_submap_inheritance (map
, idx
, val
);
612 RETURN_UNGCPRO (val
);
617 return get_keyelt (t_binding
, autoload
);
622 map_keymap_item (fun
, args
, key
, val
, data
)
623 map_keymap_function_t fun
;
624 Lisp_Object args
, key
, val
;
627 /* We should maybe try to detect bindings shadowed by previous
628 ones and things like that. */
631 (*fun
) (key
, val
, args
, data
);
635 map_keymap_char_table_item (args
, key
, val
)
636 Lisp_Object args
, key
, val
;
640 map_keymap_function_t fun
= XSAVE_VALUE (XCAR (args
))->pointer
;
642 map_keymap_item (fun
, XCDR (args
), key
, val
,
643 XSAVE_VALUE (XCAR (args
))->pointer
);
647 /* Call FUN for every binding in MAP.
648 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
649 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
651 map_keymap (map
, fun
, args
, data
, autoload
)
652 map_keymap_function_t fun
;
653 Lisp_Object map
, args
;
657 struct gcpro gcpro1
, gcpro2
, gcpro3
;
660 GCPRO3 (map
, args
, tail
);
661 map
= get_keymap (map
, 1, autoload
);
662 for (tail
= (CONSP (map
) && EQ (Qkeymap
, XCAR (map
))) ? XCDR (map
) : map
;
663 CONSP (tail
) || (tail
= get_keymap (tail
, 0, autoload
), CONSP (tail
));
666 Lisp_Object binding
= XCAR (tail
);
669 map_keymap_item (fun
, args
, XCAR (binding
), XCDR (binding
), data
);
670 else if (VECTORP (binding
))
672 /* Loop over the char values represented in the vector. */
673 int len
= ASIZE (binding
);
676 for (c
= 0; c
< len
; c
++)
678 Lisp_Object character
;
679 XSETFASTINT (character
, c
);
680 map_keymap_item (fun
, args
, character
, AREF (binding
, c
), data
);
683 else if (CHAR_TABLE_P (binding
))
685 map_char_table (map_keymap_char_table_item
, Qnil
, binding
,
686 Fcons (make_save_value (fun
, 0),
687 Fcons (make_save_value (data
, 0),
695 map_keymap_call (key
, val
, fun
, dummy
)
696 Lisp_Object key
, val
, fun
;
699 call2 (fun
, key
, val
);
702 DEFUN ("map-keymap", Fmap_keymap
, Smap_keymap
, 2, 2, 0,
703 doc
: /* Call FUNCTION for every binding in KEYMAP.
704 FUNCTION is called with two arguments: the event and its binding. */)
706 Lisp_Object function
, keymap
;
708 if (INTEGERP (function
))
709 /* We have to stop integers early since map_keymap gives them special
711 Fsignal (Qinvalid_function
, Fcons (function
, Qnil
));
712 map_keymap (keymap
, map_keymap_call
, function
, NULL
, 1);
716 /* Given OBJECT which was found in a slot in a keymap,
717 trace indirect definitions to get the actual definition of that slot.
718 An indirect definition is a list of the form
719 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
720 and INDEX is the object to look up in KEYMAP to yield the definition.
722 Also if OBJECT has a menu string as the first element,
723 remove that. Also remove a menu help string as second element.
725 If AUTOLOAD is nonzero, load autoloadable keymaps
726 that are referred to with indirection. */
729 get_keyelt (object
, autoload
)
735 if (!(CONSP (object
)))
736 /* This is really the value. */
739 /* If the keymap contents looks like (keymap ...) or (lambda ...)
741 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
744 /* If the keymap contents looks like (menu-item name . DEFN)
745 or (menu-item name DEFN ...) then use DEFN.
746 This is a new format menu item. */
747 else if (EQ (XCAR (object
), Qmenu_item
))
749 if (CONSP (XCDR (object
)))
753 object
= XCDR (XCDR (object
));
756 object
= XCAR (object
);
758 /* If there's a `:filter FILTER', apply FILTER to the
759 menu-item's definition to get the real definition to
761 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
762 if (EQ (XCAR (tem
), QCfilter
) && autoload
)
765 filter
= XCAR (XCDR (tem
));
766 filter
= list2 (filter
, list2 (Qquote
, object
));
767 object
= menu_item_eval_property (filter
);
772 /* Invalid keymap. */
776 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
777 Keymap alist elements like (CHAR MENUSTRING . DEFN)
778 will be used by HierarKey menus. */
779 else if (STRINGP (XCAR (object
)))
781 object
= XCDR (object
);
782 /* Also remove a menu help string, if any,
783 following the menu item name. */
784 if (CONSP (object
) && STRINGP (XCAR (object
)))
785 object
= XCDR (object
);
786 /* Also remove the sublist that caches key equivalences, if any. */
787 if (CONSP (object
) && CONSP (XCAR (object
)))
790 carcar
= XCAR (XCAR (object
));
791 if (NILP (carcar
) || VECTORP (carcar
))
792 object
= XCDR (object
);
796 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
802 map
= get_keymap (Fcar_safe (object
), 0, autoload
);
804 return (!CONSP (map
) ? object
/* Invalid keymap */
805 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
811 store_in_keymap (keymap
, idx
, def
)
813 register Lisp_Object idx
;
814 register Lisp_Object def
;
816 /* Flush any reverse-map cache. */
817 where_is_cache
= Qnil
;
818 where_is_cache_keymaps
= Qt
;
820 /* If we are preparing to dump, and DEF is a menu element
821 with a menu item indicator, copy it to ensure it is not pure. */
822 if (CONSP (def
) && PURE_P (def
)
823 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
824 def
= Fcons (XCAR (def
), XCDR (def
));
826 if (!CONSP (keymap
) || !EQ (XCAR (keymap
), Qkeymap
))
827 error ("attempt to define a key in a non-keymap");
829 /* If idx is a list (some sort of mouse click, perhaps?),
830 the index we want to use is the car of the list, which
831 ought to be a symbol. */
832 idx
= EVENT_HEAD (idx
);
834 /* If idx is a symbol, it might have modifiers, which need to
835 be put in the canonical order. */
837 idx
= reorder_modifiers (idx
);
838 else if (INTEGERP (idx
))
839 /* Clobber the high bits that can be present on a machine
840 with more than 24 bits of integer. */
841 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
843 /* Scan the keymap for a binding of idx. */
847 /* The cons after which we should insert new bindings. If the
848 keymap has a table element, we record its position here, so new
849 bindings will go after it; this way, the table will stay
850 towards the front of the alist and character lookups in dense
851 keymaps will remain fast. Otherwise, this just points at the
852 front of the keymap. */
853 Lisp_Object insertion_point
;
855 insertion_point
= keymap
;
856 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
863 if (NATNUMP (idx
) && XFASTINT (idx
) < ASIZE (elt
))
865 ASET (elt
, XFASTINT (idx
), def
);
868 insertion_point
= tail
;
870 else if (CHAR_TABLE_P (elt
))
872 /* Character codes with modifiers
873 are not included in a char-table.
874 All character codes without modifiers are included. */
875 if (NATNUMP (idx
) && !(XFASTINT (idx
) & CHAR_MODIFIER_MASK
))
878 /* `nil' has a special meaning for char-tables, so
879 we use something else to record an explicitly
881 NILP (def
) ? Qt
: def
);
884 else if (CONSP (idx
) && CHARACTERP (XCAR (idx
)))
886 Fset_char_table_range (elt
, idx
, NILP (def
) ? Qt
: def
);
889 insertion_point
= tail
;
891 else if (CONSP (elt
))
893 if (EQ (idx
, XCAR (elt
)))
899 else if (EQ (elt
, Qkeymap
))
900 /* If we find a 'keymap' symbol in the spine of KEYMAP,
901 then we must have found the start of a second keymap
902 being used as the tail of KEYMAP, and a binding for IDX
903 should be inserted before it. */
910 /* We have scanned the entire keymap, and not found a binding for
911 IDX. Let's add one. */
912 XSETCDR (insertion_point
,
913 Fcons (Fcons (idx
, def
), XCDR (insertion_point
)));
919 EXFUN (Fcopy_keymap
, 1);
922 copy_keymap_item (elt
)
925 Lisp_Object res
, tem
;
932 /* Is this a new format menu item. */
933 if (EQ (XCAR (tem
), Qmenu_item
))
935 /* Copy cell with menu-item marker. */
936 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
940 /* Copy cell with menu-item name. */
941 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
947 /* Copy cell with binding and if the binding is a keymap,
949 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
952 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
953 XSETCAR (elt
, Fcopy_keymap (tem
));
955 if (CONSP (tem
) && CONSP (XCAR (tem
)))
956 /* Delete cache for key equivalences. */
957 XSETCDR (elt
, XCDR (tem
));
962 /* It may be an old fomat menu item.
963 Skip the optional menu string. */
964 if (STRINGP (XCAR (tem
)))
966 /* Copy the cell, since copy-alist didn't go this deep. */
967 res
= elt
= Fcons (XCAR (tem
), XCDR (tem
));
969 /* Also skip the optional menu help string. */
970 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
972 XSETCDR (elt
, Fcons (XCAR (tem
), XCDR (tem
)));
976 /* There may also be a list that caches key equivalences.
977 Just delete it for the new keymap. */
979 && CONSP (XCAR (tem
))
980 && (NILP (XCAR (XCAR (tem
)))
981 || VECTORP (XCAR (XCAR (tem
)))))
983 XSETCDR (elt
, XCDR (tem
));
986 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
987 XSETCDR (elt
, Fcopy_keymap (tem
));
989 else if (EQ (XCAR (tem
), Qkeymap
))
990 res
= Fcopy_keymap (elt
);
996 copy_keymap_1 (chartable
, idx
, elt
)
997 Lisp_Object chartable
, idx
, elt
;
999 Fset_char_table_range (chartable
, idx
, copy_keymap_item (elt
));
1002 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
1003 doc
: /* Return a copy of the keymap KEYMAP.
1004 The copy starts out with the same definitions of KEYMAP,
1005 but changing either the copy or KEYMAP does not affect the other.
1006 Any key definitions that are subkeymaps are recursively copied.
1007 However, a key definition which is a symbol whose definition is a keymap
1012 register Lisp_Object copy
, tail
;
1013 keymap
= get_keymap (keymap
, 1, 0);
1014 copy
= tail
= Fcons (Qkeymap
, Qnil
);
1015 keymap
= XCDR (keymap
); /* Skip the `keymap' symbol. */
1017 while (CONSP (keymap
) && !EQ (XCAR (keymap
), Qkeymap
))
1019 Lisp_Object elt
= XCAR (keymap
);
1020 if (CHAR_TABLE_P (elt
))
1022 elt
= Fcopy_sequence (elt
);
1023 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
);
1025 else if (VECTORP (elt
))
1028 elt
= Fcopy_sequence (elt
);
1029 for (i
= 0; i
< ASIZE (elt
); i
++)
1030 ASET (elt
, i
, copy_keymap_item (AREF (elt
, i
)));
1032 else if (CONSP (elt
))
1033 elt
= Fcons (XCAR (elt
), copy_keymap_item (XCDR (elt
)));
1034 XSETCDR (tail
, Fcons (elt
, Qnil
));
1036 keymap
= XCDR (keymap
);
1038 XSETCDR (tail
, keymap
);
1042 /* Simple Keymap mutators and accessors. */
1044 /* GC is possible in this function if it autoloads a keymap. */
1046 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
1047 doc
: /* In KEYMAP, define key sequence KEY as DEF.
1050 KEY is a string or a vector of symbols and characters meaning a
1051 sequence of keystrokes and events. Non-ASCII characters with codes
1052 above 127 (such as ISO Latin-1) can be included if you use a vector.
1053 Using [t] for KEY creates a default definition, which applies to any
1054 event type that has no other definition in this keymap.
1056 DEF is anything that can be a key's definition:
1057 nil (means key is undefined in this keymap),
1058 a command (a Lisp function suitable for interactive calling)
1059 a string (treated as a keyboard macro),
1060 a keymap (to define a prefix key),
1061 a symbol. When the key is looked up, the symbol will stand for its
1062 function definition, which should at that time be one of the above,
1063 or another symbol whose function definition is used, etc.
1064 a cons (STRING . DEFN), meaning that DEFN is the definition
1065 (DEFN should be a valid definition in its own right),
1066 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.
1068 If KEYMAP is a sparse keymap with a binding for KEY, the existing
1069 binding is altered. If there is no binding for KEY, the new pair
1070 binding KEY to DEF is added at the front of KEYMAP. */)
1077 register Lisp_Object c
;
1078 register Lisp_Object cmd
;
1082 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1084 GCPRO3 (keymap
, key
, def
);
1085 keymap
= get_keymap (keymap
, 1, 1);
1087 if (!VECTORP (key
) && !STRINGP (key
))
1088 key
= wrong_type_argument (Qarrayp
, key
);
1090 length
= XFASTINT (Flength (key
));
1092 RETURN_UNGCPRO (Qnil
);
1094 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
1095 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
1097 meta_bit
= VECTORP (key
) ? meta_modifier
: 0x80;
1102 c
= Faref (key
, make_number (idx
));
1106 /* C may be a cons (FROM . TO) specifying a range of
1108 if (CHARACTERP (XCAR (c
)))
1109 CHECK_CHARACTER_CDR (c
);
1110 else if (lucid_event_type_list_p (c
))
1111 c
= Fevent_convert_list (c
);
1115 silly_event_symbol_error (c
);
1118 && (XINT (c
) & meta_bit
)
1121 c
= meta_prefix_char
;
1127 XSETINT (c
, XINT (c
) & ~meta_bit
);
1133 if (!INTEGERP (c
) && !SYMBOLP (c
)
1135 /* If C is a range, it must be a leaf. */
1136 || (INTEGERP (XCAR (c
)) && idx
!= length
)))
1137 error ("Key sequence contains invalid event");
1140 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
1142 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
1144 /* If this key is undefined, make it a prefix. */
1146 cmd
= define_as_prefix (keymap
, c
);
1148 keymap
= get_keymap (cmd
, 0, 1);
1149 if (!CONSP (keymap
))
1150 /* We must use Fkey_description rather than just passing key to
1151 error; key might be a vector, not a string. */
1152 error ("Key sequence %s uses invalid prefix characters",
1153 SDATA (Fkey_description (key
)));
1157 /* This function may GC (it calls Fkey_binding). */
1159 DEFUN ("command-remapping", Fcommand_remapping
, Scommand_remapping
, 1, 1, 0,
1160 doc
: /* Return the remapping for command COMMAND in current keymaps.
1161 Returns nil if COMMAND is not remapped (or not a symbol). */)
1163 Lisp_Object command
;
1165 if (!SYMBOLP (command
))
1168 ASET (command_remapping_vector
, 1, command
);
1169 return Fkey_binding (command_remapping_vector
, Qnil
, Qt
);
1172 /* Value is number if KEY is too long; nil if valid but has no definition. */
1173 /* GC is possible in this function if it autoloads a keymap. */
1175 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1176 doc
: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1177 nil means undefined. See doc of `define-key' for kinds of definitions.
1179 A number as value means KEY is "too long";
1180 that is, characters or symbols in it except for the last one
1181 fail to be a valid sequence of prefix characters in KEYMAP.
1182 The number is how many characters at the front of KEY
1183 it takes to reach a non-prefix command.
1185 Normally, `lookup-key' ignores bindings for t, which act as default
1186 bindings, used when nothing else in the keymap applies; this makes it
1187 usable as a general function for probing keymaps. However, if the
1188 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1189 recognize the default bindings, just as `read-key-sequence' does. */)
1190 (keymap
, key
, accept_default
)
1193 Lisp_Object accept_default
;
1196 register Lisp_Object cmd
;
1197 register Lisp_Object c
;
1199 int t_ok
= !NILP (accept_default
);
1200 struct gcpro gcpro1
, gcpro2
;
1202 GCPRO2 (keymap
, key
);
1203 keymap
= get_keymap (keymap
, 1, 1);
1205 if (!VECTORP (key
) && !STRINGP (key
))
1206 key
= wrong_type_argument (Qarrayp
, key
);
1208 length
= XFASTINT (Flength (key
));
1210 RETURN_UNGCPRO (keymap
);
1215 c
= Faref (key
, make_number (idx
++));
1217 if (CONSP (c
) && lucid_event_type_list_p (c
))
1218 c
= Fevent_convert_list (c
);
1220 /* Turn the 8th bit of string chars into a meta modifier. */
1221 if (XINT (c
) & 0x80 && STRINGP (key
))
1222 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1224 /* Allow string since binding for `menu-bar-select-buffer'
1225 includes the buffer name in the key sequence. */
1226 if (!INTEGERP (c
) && !SYMBOLP (c
) && !CONSP (c
) && !STRINGP (c
))
1227 error ("Key sequence contains invalid event");
1229 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1231 RETURN_UNGCPRO (cmd
);
1233 keymap
= get_keymap (cmd
, 0, 1);
1234 if (!CONSP (keymap
))
1235 RETURN_UNGCPRO (make_number (idx
));
1241 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1242 Assume that currently it does not define C at all.
1243 Return the keymap. */
1246 define_as_prefix (keymap
, c
)
1247 Lisp_Object keymap
, c
;
1251 cmd
= Fmake_sparse_keymap (Qnil
);
1252 /* If this key is defined as a prefix in an inherited keymap,
1253 make it a prefix in this map, and make its definition
1254 inherit the other prefix definition. */
1255 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1256 store_in_keymap (keymap
, c
, cmd
);
1261 /* Append a key to the end of a key sequence. We always make a vector. */
1264 append_key (key_sequence
, key
)
1265 Lisp_Object key_sequence
, key
;
1267 Lisp_Object args
[2];
1269 args
[0] = key_sequence
;
1271 args
[1] = Fcons (key
, Qnil
);
1272 return Fvconcat (2, args
);
1275 /* Given a event type C which is a symbol,
1276 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1279 silly_event_symbol_error (c
)
1282 Lisp_Object parsed
, base
, name
, assoc
;
1285 parsed
= parse_modifiers (c
);
1286 modifiers
= (int) XUINT (XCAR (XCDR (parsed
)));
1287 base
= XCAR (parsed
);
1288 name
= Fsymbol_name (base
);
1289 /* This alist includes elements such as ("RET" . "\\r"). */
1290 assoc
= Fassoc (name
, exclude_keys
);
1294 char new_mods
[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1296 Lisp_Object keystring
;
1297 if (modifiers
& alt_modifier
)
1298 { *p
++ = '\\'; *p
++ = 'A'; *p
++ = '-'; }
1299 if (modifiers
& ctrl_modifier
)
1300 { *p
++ = '\\'; *p
++ = 'C'; *p
++ = '-'; }
1301 if (modifiers
& hyper_modifier
)
1302 { *p
++ = '\\'; *p
++ = 'H'; *p
++ = '-'; }
1303 if (modifiers
& meta_modifier
)
1304 { *p
++ = '\\'; *p
++ = 'M'; *p
++ = '-'; }
1305 if (modifiers
& shift_modifier
)
1306 { *p
++ = '\\'; *p
++ = 'S'; *p
++ = '-'; }
1307 if (modifiers
& super_modifier
)
1308 { *p
++ = '\\'; *p
++ = 's'; *p
++ = '-'; }
1311 c
= reorder_modifiers (c
);
1312 keystring
= concat2 (build_string (new_mods
), XCDR (assoc
));
1314 error ((modifiers
& ~meta_modifier
1315 ? "To bind the key %s, use [?%s], not [%s]"
1316 : "To bind the key %s, use \"%s\", not [%s]"),
1317 SDATA (SYMBOL_NAME (c
)), SDATA (keystring
),
1318 SDATA (SYMBOL_NAME (c
)));
1322 /* Global, local, and minor mode keymap stuff. */
1324 /* We can't put these variables inside current_minor_maps, since under
1325 some systems, static gets macro-defined to be the empty string.
1327 static Lisp_Object
*cmm_modes
= NULL
, *cmm_maps
= NULL
;
1328 static int cmm_size
= 0;
1330 /* Error handler used in current_minor_maps. */
1332 current_minor_maps_error ()
1337 /* Store a pointer to an array of the keymaps of the currently active
1338 minor modes in *buf, and return the number of maps it contains.
1340 This function always returns a pointer to the same buffer, and may
1341 free or reallocate it, so if you want to keep it for a long time or
1342 hand it out to lisp code, copy it. This procedure will be called
1343 for every key sequence read, so the nice lispy approach (return a
1344 new assoclist, list, what have you) for each invocation would
1345 result in a lot of consing over time.
1347 If we used xrealloc/xmalloc and ran out of memory, they would throw
1348 back to the command loop, which would try to read a key sequence,
1349 which would call this function again, resulting in an infinite
1350 loop. Instead, we'll use realloc/malloc and silently truncate the
1351 list, let the key sequence be read, and hope some other piece of
1352 code signals the error. */
1354 current_minor_maps (modeptr
, mapptr
)
1355 Lisp_Object
**modeptr
, **mapptr
;
1358 int list_number
= 0;
1359 Lisp_Object alist
, assoc
, var
, val
;
1360 Lisp_Object emulation_alists
;
1361 Lisp_Object lists
[2];
1363 emulation_alists
= Vemulation_mode_map_alists
;
1364 lists
[0] = Vminor_mode_overriding_map_alist
;
1365 lists
[1] = Vminor_mode_map_alist
;
1367 for (list_number
= 0; list_number
< 2; list_number
++)
1369 if (CONSP (emulation_alists
))
1371 alist
= XCAR (emulation_alists
);
1372 emulation_alists
= XCDR (emulation_alists
);
1373 if (SYMBOLP (alist
))
1374 alist
= find_symbol_value (alist
);
1378 alist
= lists
[list_number
];
1380 for ( ; CONSP (alist
); alist
= XCDR (alist
))
1381 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1382 && (var
= XCAR (assoc
), SYMBOLP (var
))
1383 && (val
= find_symbol_value (var
), !EQ (val
, Qunbound
))
1388 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1389 and also an entry in Vminor_mode_map_alist,
1390 ignore the latter. */
1391 if (list_number
== 1)
1393 val
= assq_no_quit (var
, lists
[0]);
1400 int newsize
, allocsize
;
1401 Lisp_Object
*newmodes
, *newmaps
;
1403 newsize
= cmm_size
== 0 ? 30 : cmm_size
* 2;
1404 allocsize
= newsize
* sizeof *newmodes
;
1406 /* Use malloc here. See the comment above this function.
1407 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1409 newmodes
= (Lisp_Object
*) malloc (allocsize
);
1414 bcopy (cmm_modes
, newmodes
, cmm_size
* sizeof cmm_modes
[0]);
1417 cmm_modes
= newmodes
;
1420 newmaps
= (Lisp_Object
*) malloc (allocsize
);
1425 bcopy (cmm_maps
, newmaps
, cmm_size
* sizeof cmm_maps
[0]);
1432 if (newmodes
== NULL
|| newmaps
== NULL
)
1437 /* Get the keymap definition--or nil if it is not defined. */
1438 temp
= internal_condition_case_1 (Findirect_function
,
1440 Qerror
, current_minor_maps_error
);
1444 cmm_maps
[i
] = temp
;
1450 if (modeptr
) *modeptr
= cmm_modes
;
1451 if (mapptr
) *mapptr
= cmm_maps
;
1455 DEFUN ("current-active-maps", Fcurrent_active_maps
, Scurrent_active_maps
,
1457 doc
: /* Return a list of the currently active keymaps.
1458 OLP if non-nil indicates that we should obey `overriding-local-map' and
1459 `overriding-terminal-local-map'. */)
1463 Lisp_Object keymaps
= Fcons (current_global_map
, Qnil
);
1467 if (!NILP (Voverriding_local_map
))
1468 keymaps
= Fcons (Voverriding_local_map
, keymaps
);
1469 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1470 keymaps
= Fcons (current_kboard
->Voverriding_terminal_local_map
, keymaps
);
1472 if (NILP (XCDR (keymaps
)))
1478 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1480 keymaps
= Fcons (local
, keymaps
);
1482 nmaps
= current_minor_maps (0, &maps
);
1484 for (i
= --nmaps
; i
>= 0; i
--)
1485 if (!NILP (maps
[i
]))
1486 keymaps
= Fcons (maps
[i
], keymaps
);
1488 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1490 keymaps
= Fcons (local
, keymaps
);
1496 /* GC is possible in this function if it autoloads a keymap. */
1498 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 3, 0,
1499 doc
: /* Return the binding for command KEY in current keymaps.
1500 KEY is a string or vector, a sequence of keystrokes.
1501 The binding is probably a symbol with a function definition.
1503 Normally, `key-binding' ignores bindings for t, which act as default
1504 bindings, used when nothing else in the keymap applies; this makes it
1505 usable as a general function for probing keymaps. However, if the
1506 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
1507 recognize the default bindings, just as `read-key-sequence' does.
1509 Like the normal command loop, `key-binding' will remap the command
1510 resulting from looking up KEY by looking up the command in the
1511 current keymaps. However, if the optional third argument NO-REMAP
1512 is non-nil, `key-binding' returns the unmapped command. */)
1513 (key
, accept_default
, no_remap
)
1514 Lisp_Object key
, accept_default
, no_remap
;
1516 Lisp_Object
*maps
, value
;
1518 struct gcpro gcpro1
;
1522 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1524 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1525 key
, accept_default
);
1526 if (! NILP (value
) && !INTEGERP (value
))
1529 else if (!NILP (Voverriding_local_map
))
1531 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1532 if (! NILP (value
) && !INTEGERP (value
))
1539 local
= get_local_map (PT
, current_buffer
, Qkeymap
);
1542 value
= Flookup_key (local
, key
, accept_default
);
1543 if (! NILP (value
) && !INTEGERP (value
))
1547 nmaps
= current_minor_maps (0, &maps
);
1548 /* Note that all these maps are GCPRO'd
1549 in the places where we found them. */
1551 for (i
= 0; i
< nmaps
; i
++)
1552 if (! NILP (maps
[i
]))
1554 value
= Flookup_key (maps
[i
], key
, accept_default
);
1555 if (! NILP (value
) && !INTEGERP (value
))
1559 local
= get_local_map (PT
, current_buffer
, Qlocal_map
);
1562 value
= Flookup_key (local
, key
, accept_default
);
1563 if (! NILP (value
) && !INTEGERP (value
))
1568 value
= Flookup_key (current_global_map
, key
, accept_default
);
1572 if (NILP (value
) || INTEGERP (value
))
1575 /* If the result of the ordinary keymap lookup is an interactive
1576 command, look for a key binding (ie. remapping) for that command. */
1578 if (NILP (no_remap
) && SYMBOLP (value
))
1581 if (value1
= Fcommand_remapping (value
), !NILP (value1
))
1588 /* GC is possible in this function if it autoloads a keymap. */
1590 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1591 doc
: /* Return the binding for command KEYS in current local keymap only.
1592 KEYS is a string, a sequence of keystrokes.
1593 The binding is probably a symbol with a function definition.
1595 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1596 bindings; see the description of `lookup-key' for more details about this. */)
1597 (keys
, accept_default
)
1598 Lisp_Object keys
, accept_default
;
1600 register Lisp_Object map
;
1601 map
= current_buffer
->keymap
;
1604 return Flookup_key (map
, keys
, accept_default
);
1607 /* GC is possible in this function if it autoloads a keymap. */
1609 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1610 doc
: /* Return the binding for command KEYS in current global keymap only.
1611 KEYS is a string, a sequence of keystrokes.
1612 The binding is probably a symbol with a function definition.
1613 This function's return values are the same as those of lookup-key
1616 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1617 bindings; see the description of `lookup-key' for more details about this. */)
1618 (keys
, accept_default
)
1619 Lisp_Object keys
, accept_default
;
1621 return Flookup_key (current_global_map
, keys
, accept_default
);
1624 /* GC is possible in this function if it autoloads a keymap. */
1626 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1627 doc
: /* Find the visible minor mode bindings of KEY.
1628 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the
1629 the symbol which names the minor mode binding KEY, and BINDING is
1630 KEY's definition in that mode. In particular, if KEY has no
1631 minor-mode bindings, return nil. If the first binding is a
1632 non-prefix, all subsequent bindings will be omitted, since they would
1633 be ignored. Similarly, the list doesn't include non-prefix bindings
1634 that come after prefix bindings.
1636 If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1637 bindings; see the description of `lookup-key' for more details about this. */)
1638 (key
, accept_default
)
1639 Lisp_Object key
, accept_default
;
1641 Lisp_Object
*modes
, *maps
;
1643 Lisp_Object binding
;
1645 struct gcpro gcpro1
, gcpro2
;
1647 nmaps
= current_minor_maps (&modes
, &maps
);
1648 /* Note that all these maps are GCPRO'd
1649 in the places where we found them. */
1652 GCPRO2 (key
, binding
);
1654 for (i
= j
= 0; i
< nmaps
; i
++)
1656 && !NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1657 && !INTEGERP (binding
))
1659 if (KEYMAPP (binding
))
1660 maps
[j
++] = Fcons (modes
[i
], binding
);
1662 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1666 return Flist (j
, maps
);
1669 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1670 doc
: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1671 A new sparse keymap is stored as COMMAND's function definition and its value.
1672 If a second optional argument MAPVAR is given, the map is stored as
1673 its value instead of as COMMAND's value; but COMMAND is still defined
1675 The third optional argument NAME, if given, supplies a menu name
1676 string for the map. This is required to use the keymap as a menu. */)
1677 (command
, mapvar
, name
)
1678 Lisp_Object command
, mapvar
, name
;
1681 map
= Fmake_sparse_keymap (name
);
1682 Ffset (command
, map
);
1686 Fset (command
, map
);
1690 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1691 doc
: /* Select KEYMAP as the global keymap. */)
1695 keymap
= get_keymap (keymap
, 1, 1);
1696 current_global_map
= keymap
;
1701 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1702 doc
: /* Select KEYMAP as the local keymap.
1703 If KEYMAP is nil, that means no local keymap. */)
1708 keymap
= get_keymap (keymap
, 1, 1);
1710 current_buffer
->keymap
= keymap
;
1715 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1716 doc
: /* Return current buffer's local keymap, or nil if it has none. */)
1719 return current_buffer
->keymap
;
1722 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1723 doc
: /* Return the current global keymap. */)
1726 return current_global_map
;
1729 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1730 doc
: /* Return a list of keymaps for the minor modes of the current buffer. */)
1734 int nmaps
= current_minor_maps (0, &maps
);
1736 return Flist (nmaps
, maps
);
1739 /* Help functions for describing and documenting keymaps. */
1743 accessible_keymaps_1 (key
, cmd
, maps
, tail
, thisseq
, is_metized
)
1744 Lisp_Object maps
, tail
, thisseq
, key
, cmd
;
1745 int is_metized
; /* If 1, `key' is assumed to be INTEGERP. */
1749 cmd
= get_keymap (get_keyelt (cmd
, 0), 0, 0);
1753 /* Look for and break cycles. */
1754 while (!NILP (tem
= Frassq (cmd
, maps
)))
1756 Lisp_Object prefix
= XCAR (tem
);
1757 int lim
= XINT (Flength (XCAR (tem
)));
1758 if (lim
<= XINT (Flength (thisseq
)))
1759 { /* This keymap was already seen with a smaller prefix. */
1761 while (i
< lim
&& EQ (Faref (prefix
, make_number (i
)),
1762 Faref (thisseq
, make_number (i
))))
1765 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1768 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1769 but maybe `cmd' occurs again further down in `maps', so keep
1771 maps
= XCDR (Fmemq (tem
, maps
));
1774 /* If the last key in thisseq is meta-prefix-char,
1775 turn it into a meta-ized keystroke. We know
1776 that the event we're about to append is an
1777 ascii keystroke since we're processing a
1781 int meta_bit
= meta_modifier
;
1782 Lisp_Object last
= make_number (XINT (Flength (thisseq
)) - 1);
1783 tem
= Fcopy_sequence (thisseq
);
1785 Faset (tem
, last
, make_number (XINT (key
) | meta_bit
));
1787 /* This new sequence is the same length as
1788 thisseq, so stick it in the list right
1791 Fcons (Fcons (tem
, cmd
), XCDR (tail
)));
1795 tem
= append_key (thisseq
, key
);
1796 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1801 accessible_keymaps_char_table (args
, index
, cmd
)
1802 Lisp_Object args
, index
, cmd
;
1804 accessible_keymaps_1 (index
, cmd
,
1808 XINT (XCDR (XCAR (args
))));
1811 /* This function cannot GC. */
1813 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1815 doc
: /* Find all keymaps accessible via prefix characters from KEYMAP.
1816 Returns a list of elements of the form (KEYS . MAP), where the sequence
1817 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1818 so that the KEYS increase in length. The first element is ([] . KEYMAP).
1819 An optional argument PREFIX, if non-nil, should be a key sequence;
1820 then the value includes only maps for prefixes that start with PREFIX. */)
1822 Lisp_Object keymap
, prefix
;
1824 Lisp_Object maps
, tail
;
1827 /* no need for gcpro because we don't autoload any keymaps. */
1830 prefixlen
= XINT (Flength (prefix
));
1834 /* If a prefix was specified, start with the keymap (if any) for
1835 that prefix, so we don't waste time considering other prefixes. */
1837 tem
= Flookup_key (keymap
, prefix
, Qt
);
1838 /* Flookup_key may give us nil, or a number,
1839 if the prefix is not defined in this particular map.
1840 It might even give us a list that isn't a keymap. */
1841 tem
= get_keymap (tem
, 0, 0);
1844 /* Convert PREFIX to a vector now, so that later on
1845 we don't have to deal with the possibility of a string. */
1846 if (STRINGP (prefix
))
1851 copy
= Fmake_vector (make_number (SCHARS (prefix
)), Qnil
);
1852 for (i
= 0, i_byte
= 0; i
< SCHARS (prefix
);)
1856 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1857 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1858 c
^= 0200 | meta_modifier
;
1859 ASET (copy
, i_before
, make_number (c
));
1863 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1869 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1870 get_keymap (keymap
, 1, 0)),
1873 /* For each map in the list maps,
1874 look at any other maps it points to,
1875 and stick them at the end if they are not already in the list.
1877 This is a breadth-first traversal, where tail is the queue of
1878 nodes, and maps accumulates a list of all nodes visited. */
1880 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1882 register Lisp_Object thisseq
, thismap
;
1884 /* Does the current sequence end in the meta-prefix-char? */
1887 thisseq
= Fcar (Fcar (tail
));
1888 thismap
= Fcdr (Fcar (tail
));
1889 last
= make_number (XINT (Flength (thisseq
)) - 1);
1890 is_metized
= (XINT (last
) >= 0
1891 /* Don't metize the last char of PREFIX. */
1892 && XINT (last
) >= prefixlen
1893 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1895 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1899 elt
= XCAR (thismap
);
1903 if (CHAR_TABLE_P (elt
))
1905 map_char_table (accessible_keymaps_char_table
, Qnil
,
1906 elt
, Fcons (Fcons (maps
, make_number (is_metized
)),
1907 Fcons (tail
, thisseq
)));
1909 else if (VECTORP (elt
))
1913 /* Vector keymap. Scan all the elements. */
1914 for (i
= 0; i
< ASIZE (elt
); i
++)
1915 accessible_keymaps_1 (make_number (i
), AREF (elt
, i
),
1916 maps
, tail
, thisseq
, is_metized
);
1919 else if (CONSP (elt
))
1920 accessible_keymaps_1 (XCAR (elt
), XCDR (elt
),
1921 maps
, tail
, thisseq
,
1922 is_metized
&& INTEGERP (XCAR (elt
)));
1930 Lisp_Object Qsingle_key_description
, Qkey_description
;
1932 /* This function cannot GC. */
1934 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 1, 0,
1935 doc
: /* Return a pretty description of key-sequence KEYS.
1936 Control characters turn into "C-foo" sequences, meta into "M-foo"
1937 spaces are put between sequence elements, etc. */)
1944 Lisp_Object
*args
= NULL
;
1949 vector
= Fmake_vector (Flength (keys
), Qnil
);
1950 for (i
= 0, i_byte
= 0; i
< SCHARS (keys
); )
1955 FETCH_STRING_CHAR_ADVANCE (c
, keys
, i
, i_byte
);
1956 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1957 c
^= 0200 | meta_modifier
;
1958 XSETFASTINT (AREF (vector
, i_before
), c
);
1965 /* In effect, this computes
1966 (mapconcat 'single-key-description keys " ")
1967 but we shouldn't use mapconcat because it can do GC. */
1969 len
= XVECTOR (keys
)->size
;
1970 sep
= build_string (" ");
1971 /* This has one extra element at the end that we don't pass to Fconcat. */
1972 args
= (Lisp_Object
*) alloca (len
* 2 * sizeof (Lisp_Object
));
1974 for (i
= 0; i
< len
; i
++)
1976 args
[i
* 2] = Fsingle_key_description (AREF (keys
, i
), Qnil
);
1977 args
[i
* 2 + 1] = sep
;
1980 else if (CONSP (keys
))
1982 /* In effect, this computes
1983 (mapconcat 'single-key-description keys " ")
1984 but we shouldn't use mapconcat because it can do GC. */
1986 len
= XFASTINT (Flength (keys
));
1987 sep
= build_string (" ");
1988 /* This has one extra element at the end that we don't pass to Fconcat. */
1989 args
= (Lisp_Object
*) alloca (len
* 2 * sizeof (Lisp_Object
));
1991 for (i
= 0; i
< len
; i
++)
1993 args
[i
* 2] = Fsingle_key_description (XCAR (keys
), Qnil
);
1994 args
[i
* 2 + 1] = sep
;
1999 keys
= wrong_type_argument (Qarrayp
, keys
);
2002 return empty_string
;
2003 return Fconcat (len
* 2 - 1, args
);
2007 push_key_description (c
, p
, force_multibyte
)
2008 register unsigned int c
;
2010 int force_multibyte
;
2014 /* Clear all the meaningless bits above the meta bit. */
2015 c
&= meta_modifier
| ~ - meta_modifier
;
2016 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
2017 | meta_modifier
| shift_modifier
| super_modifier
);
2019 if (c
& alt_modifier
)
2025 if ((c
& ctrl_modifier
) != 0
2026 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
2030 c
&= ~ctrl_modifier
;
2032 if (c
& hyper_modifier
)
2036 c
-= hyper_modifier
;
2038 if (c
& meta_modifier
)
2044 if (c
& shift_modifier
)
2048 c
-= shift_modifier
;
2050 if (c
& super_modifier
)
2054 c
-= super_modifier
;
2070 else if (c
== Ctl ('M'))
2078 /* `C-' already added above. */
2079 if (c
> 0 && c
<= Ctl ('Z'))
2098 || (NILP (current_buffer
->enable_multibyte_characters
)
2099 && SINGLE_BYTE_CHAR_P (c
)
2100 && !force_multibyte
))
2104 else if (CHARACTERP (make_number (c
)))
2106 if (NILP (current_buffer
->enable_multibyte_characters
)
2107 && ! force_multibyte
)
2108 *p
++ = multibyte_char_to_unibyte (c
, Qnil
);
2110 p
+= CHAR_STRING (c
, (unsigned char *) p
);
2116 /* The biggest character code uses 22 bits. */
2117 for (bit_offset
= 21; bit_offset
>= 0; bit_offset
-= 3)
2119 if (c
>= (1 << bit_offset
))
2120 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
2127 /* This function cannot GC. */
2129 DEFUN ("single-key-description", Fsingle_key_description
,
2130 Ssingle_key_description
, 1, 2, 0,
2131 doc
: /* Return a pretty description of command character KEY.
2132 Control characters turn into C-whatever, etc.
2133 Optional argument NO-ANGLES non-nil means don't put angle brackets
2134 around function keys and event symbols. */)
2136 Lisp_Object key
, no_angles
;
2138 if (CONSP (key
) && lucid_event_type_list_p (key
))
2139 key
= Fevent_convert_list (key
);
2141 key
= EVENT_HEAD (key
);
2143 if (INTEGERP (key
)) /* Normal character */
2145 char tem
[KEY_DESCRIPTION_SIZE
];
2147 *push_key_description (XUINT (key
), tem
, 1) = 0;
2148 return build_string (tem
);
2150 else if (SYMBOLP (key
)) /* Function key or event-symbol */
2152 if (NILP (no_angles
))
2155 = (char *) alloca (SBYTES (SYMBOL_NAME (key
)) + 5);
2156 sprintf (buffer
, "<%s>", SDATA (SYMBOL_NAME (key
)));
2157 return build_string (buffer
);
2160 return Fsymbol_name (key
);
2162 else if (STRINGP (key
)) /* Buffer names in the menubar. */
2163 return Fcopy_sequence (key
);
2165 error ("KEY must be an integer, cons, symbol, or string");
2170 push_text_char_description (c
, p
)
2171 register unsigned int c
;
2183 *p
++ = c
+ 64; /* 'A' - 1 */
2195 /* This function cannot GC. */
2197 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
2198 doc
: /* Return a pretty description of file-character CHARACTER.
2199 Control characters turn into "^char", etc. */)
2201 Lisp_Object character
;
2203 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2204 unsigned char str
[6];
2207 CHECK_NUMBER (character
);
2209 c
= XINT (character
);
2210 if (!ASCII_CHAR_P (c
))
2212 int len
= CHAR_STRING (c
, str
);
2214 return make_multibyte_string (str
, 1, len
);
2217 *push_text_char_description (c
& 0377, str
) = 0;
2219 return build_string (str
);
2222 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2225 ascii_sequence_p (seq
)
2229 int len
= XINT (Flength (seq
));
2231 for (i
= 0; i
< len
; i
++)
2233 Lisp_Object ii
, elt
;
2235 XSETFASTINT (ii
, i
);
2236 elt
= Faref (seq
, ii
);
2239 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2247 /* where-is - finding a command in a set of keymaps. */
2249 static Lisp_Object
where_is_internal ();
2250 static Lisp_Object
where_is_internal_1 ();
2251 static void where_is_internal_2 ();
2253 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2254 Returns the first non-nil binding found in any of those maps. */
2257 shadow_lookup (shadow
, key
, flag
)
2258 Lisp_Object shadow
, key
, flag
;
2260 Lisp_Object tail
, value
;
2262 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2264 value
= Flookup_key (XCAR (tail
), key
, flag
);
2265 if (!NILP (value
) && !NATNUMP (value
))
2271 static Lisp_Object Vmenu_events
;
2273 /* This function can GC if Flookup_key autoloads any keymaps. */
2276 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
)
2277 Lisp_Object definition
, keymaps
;
2278 Lisp_Object firstonly
, noindirect
, no_remap
;
2280 Lisp_Object maps
= Qnil
;
2281 Lisp_Object found
, sequences
;
2282 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2283 /* 1 means ignore all menu bindings entirely. */
2284 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2286 /* If this command is remapped, then it has no key bindings
2288 if (NILP (no_remap
) && SYMBOLP (definition
))
2291 if (tem
= Fcommand_remapping (definition
), !NILP (tem
))
2296 while (CONSP (found
))
2300 Faccessible_keymaps (get_keymap (XCAR (found
), 1, 0), Qnil
));
2301 found
= XCDR (found
);
2304 GCPRO5 (definition
, keymaps
, maps
, found
, sequences
);
2308 for (; !NILP (maps
); maps
= Fcdr (maps
))
2310 /* Key sequence to reach map, and the map that it reaches */
2311 register Lisp_Object
this, map
, tem
;
2313 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2314 [M-CHAR] sequences, check if last character of the sequence
2315 is the meta-prefix char. */
2319 this = Fcar (Fcar (maps
));
2320 map
= Fcdr (Fcar (maps
));
2321 last
= make_number (XINT (Flength (this)) - 1);
2322 last_is_meta
= (XINT (last
) >= 0
2323 && EQ (Faref (this, last
), meta_prefix_char
));
2325 /* if (nomenus && !ascii_sequence_p (this)) */
2326 if (nomenus
&& XINT (last
) >= 0
2327 && SYMBOLP (tem
= Faref (this, make_number (0)))
2328 && !NILP (Fmemq (XCAR (parse_modifiers (tem
)), Vmenu_events
)))
2329 /* If no menu entries should be returned, skip over the
2330 keymaps bound to `menu-bar' and `tool-bar' and other
2331 non-ascii prefixes like `C-down-mouse-2'. */
2338 /* Because the code we want to run on each binding is rather
2339 large, we don't want to have two separate loop bodies for
2340 sparse keymap bindings and tables; we want to iterate one
2341 loop body over both keymap and vector bindings.
2343 For this reason, if Fcar (map) is a vector, we don't
2344 advance map to the next element until i indicates that we
2345 have finished off the vector. */
2346 Lisp_Object elt
, key
, binding
;
2354 /* Set key and binding to the current key and binding, and
2355 advance map and i to the next binding. */
2358 Lisp_Object sequence
;
2360 /* In a vector, look at each element. */
2361 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2363 binding
= AREF (elt
, i
);
2364 XSETFASTINT (key
, i
);
2365 sequence
= where_is_internal_1 (binding
, key
, definition
,
2367 last
, nomenus
, last_is_meta
);
2368 if (!NILP (sequence
))
2369 sequences
= Fcons (sequence
, sequences
);
2372 else if (CHAR_TABLE_P (elt
))
2376 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2377 Qnil
), /* Result accumulator. */
2378 Fcons (Fcons (this, last
),
2379 Fcons (make_number (nomenus
),
2380 make_number (last_is_meta
))));
2381 map_char_table (where_is_internal_2
, Qnil
, elt
, args
);
2382 sequences
= XCDR (XCAR (args
));
2384 else if (CONSP (elt
))
2386 Lisp_Object sequence
;
2389 binding
= XCDR (elt
);
2391 sequence
= where_is_internal_1 (binding
, key
, definition
,
2393 last
, nomenus
, last_is_meta
);
2394 if (!NILP (sequence
))
2395 sequences
= Fcons (sequence
, sequences
);
2399 while (!NILP (sequences
))
2401 Lisp_Object sequence
, remapped
, function
;
2403 sequence
= XCAR (sequences
);
2404 sequences
= XCDR (sequences
);
2406 /* If the current sequence is a command remapping with
2407 format [remap COMMAND], find the key sequences
2408 which run COMMAND, and use those sequences instead. */
2411 && VECTORP (sequence
) && XVECTOR (sequence
)->size
== 2
2412 && EQ (AREF (sequence
, 0), Qremap
)
2413 && (function
= AREF (sequence
, 1), SYMBOLP (function
)))
2415 Lisp_Object remapped1
;
2417 remapped1
= where_is_internal (function
, keymaps
, firstonly
, noindirect
, Qt
);
2418 if (CONSP (remapped1
))
2420 /* Verify that this key binding actually maps to the
2421 remapped command (see below). */
2422 if (!EQ (shadow_lookup (keymaps
, XCAR (remapped1
), Qnil
), function
))
2424 sequence
= XCAR (remapped1
);
2425 remapped
= XCDR (remapped1
);
2426 goto record_sequence
;
2430 /* Verify that this key binding is not shadowed by another
2431 binding for the same key, before we say it exists.
2433 Mechanism: look for local definition of this key and if
2434 it is defined and does not match what we found then
2437 Either nil or number as value from Flookup_key
2439 if (!EQ (shadow_lookup (keymaps
, sequence
, Qnil
), definition
))
2443 /* It is a true unshadowed match. Record it, unless it's already
2444 been seen (as could happen when inheriting keymaps). */
2445 if (NILP (Fmember (sequence
, found
)))
2446 found
= Fcons (sequence
, found
);
2448 /* If firstonly is Qnon_ascii, then we can return the first
2449 binding we find. If firstonly is not Qnon_ascii but not
2450 nil, then we should return the first ascii-only binding
2452 if (EQ (firstonly
, Qnon_ascii
))
2453 RETURN_UNGCPRO (sequence
);
2454 else if (!NILP (firstonly
) && ascii_sequence_p (sequence
))
2455 RETURN_UNGCPRO (sequence
);
2457 if (CONSP (remapped
))
2459 sequence
= XCAR (remapped
);
2460 remapped
= XCDR (remapped
);
2461 goto record_sequence
;
2469 found
= Fnreverse (found
);
2471 /* firstonly may have been t, but we may have gone all the way through
2472 the keymaps without finding an all-ASCII key sequence. So just
2473 return the best we could find. */
2474 if (!NILP (firstonly
))
2475 return Fcar (found
);
2480 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 5, 0,
2481 doc
: /* Return list of keys that invoke DEFINITION.
2482 If KEYMAP is non-nil, search only KEYMAP and the global keymap.
2483 If KEYMAP is nil, search all the currently active keymaps.
2484 If KEYMAP is a list of keymaps, search only those keymaps.
2486 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2487 rather than a list of all possible key sequences.
2488 If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2489 no matter what it is.
2490 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters,
2491 and entirely reject menu bindings.
2493 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2494 to other keymaps or slots. This makes it possible to search for an
2495 indirect definition itself.
2497 If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2498 that invoke a command which is remapped to DEFINITION, but include the
2499 remapped command in the returned list. */)
2500 (definition
, keymap
, firstonly
, noindirect
, no_remap
)
2501 Lisp_Object definition
, keymap
;
2502 Lisp_Object firstonly
, noindirect
, no_remap
;
2504 Lisp_Object sequences
, keymaps
;
2505 /* 1 means ignore all menu bindings entirely. */
2506 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2509 /* Find the relevant keymaps. */
2510 if (CONSP (keymap
) && KEYMAPP (XCAR (keymap
)))
2512 else if (!NILP (keymap
))
2513 keymaps
= Fcons (keymap
, Fcons (current_global_map
, Qnil
));
2515 keymaps
= Fcurrent_active_maps (Qnil
);
2517 /* Only use caching for the menubar (i.e. called with (def nil t nil).
2518 We don't really need to check `keymap'. */
2519 if (nomenus
&& NILP (noindirect
) && NILP (keymap
))
2523 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2525 /* Check heuristic-consistency of the cache. */
2526 if (NILP (Fequal (keymaps
, where_is_cache_keymaps
)))
2527 where_is_cache
= Qnil
;
2529 if (NILP (where_is_cache
))
2531 /* We need to create the cache. */
2532 Lisp_Object args
[2];
2533 where_is_cache
= Fmake_hash_table (0, args
);
2534 where_is_cache_keymaps
= Qt
;
2536 /* Fill in the cache. */
2537 GCPRO5 (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2538 where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2541 where_is_cache_keymaps
= keymaps
;
2544 /* We want to process definitions from the last to the first.
2545 Instead of consing, copy definitions to a vector and step
2546 over that vector. */
2547 sequences
= Fgethash (definition
, where_is_cache
, Qnil
);
2548 n
= XINT (Flength (sequences
));
2549 defns
= (Lisp_Object
*) alloca (n
* sizeof *defns
);
2550 for (i
= 0; CONSP (sequences
); sequences
= XCDR (sequences
))
2551 defns
[i
++] = XCAR (sequences
);
2553 /* Verify that the key bindings are not shadowed. Note that
2554 the following can GC. */
2555 GCPRO2 (definition
, keymaps
);
2558 for (i
= n
- 1; i
>= 0; --i
)
2559 if (EQ (shadow_lookup (keymaps
, defns
[i
], Qnil
), definition
))
2561 if (ascii_sequence_p (defns
[i
]))
2567 result
= i
>= 0 ? defns
[i
] : (j
>= 0 ? defns
[j
] : Qnil
);
2572 /* Kill the cache so that where_is_internal_1 doesn't think
2573 we're filling it up. */
2574 where_is_cache
= Qnil
;
2575 result
= where_is_internal (definition
, keymaps
, firstonly
, noindirect
, no_remap
);
2581 /* This is the function that Fwhere_is_internal calls using map_char_table.
2583 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2585 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2586 Since map_char_table doesn't really use the return value from this function,
2587 we the result append to RESULT, the slot in ARGS.
2589 This function can GC because it calls where_is_internal_1 which can
2593 where_is_internal_2 (args
, key
, binding
)
2594 Lisp_Object args
, key
, binding
;
2596 Lisp_Object definition
, noindirect
, this, last
;
2597 Lisp_Object result
, sequence
;
2598 int nomenus
, last_is_meta
;
2599 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2601 GCPRO3 (args
, key
, binding
);
2602 result
= XCDR (XCAR (args
));
2603 definition
= XCAR (XCAR (XCAR (args
)));
2604 noindirect
= XCDR (XCAR (XCAR (args
)));
2605 this = XCAR (XCAR (XCDR (args
)));
2606 last
= XCDR (XCAR (XCDR (args
)));
2607 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2608 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2610 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
,
2611 this, last
, nomenus
, last_is_meta
);
2613 if (!NILP (sequence
))
2614 XSETCDR (XCAR (args
), Fcons (sequence
, result
));
2620 /* This function cannot GC. */
2623 where_is_internal_1 (binding
, key
, definition
, noindirect
, this, last
,
2624 nomenus
, last_is_meta
)
2625 Lisp_Object binding
, key
, definition
, noindirect
, this, last
;
2626 int nomenus
, last_is_meta
;
2628 Lisp_Object sequence
;
2630 /* Search through indirections unless that's not wanted. */
2631 if (NILP (noindirect
))
2632 binding
= get_keyelt (binding
, 0);
2634 /* End this iteration if this element does not match
2637 if (!(!NILP (where_is_cache
) /* everything "matches" during cache-fill. */
2638 || EQ (binding
, definition
)
2639 || (CONSP (definition
) && !NILP (Fequal (binding
, definition
)))))
2640 /* Doesn't match. */
2643 /* We have found a match. Construct the key sequence where we found it. */
2644 if (INTEGERP (key
) && last_is_meta
)
2646 sequence
= Fcopy_sequence (this);
2647 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2650 sequence
= append_key (this, key
);
2652 if (!NILP (where_is_cache
))
2654 Lisp_Object sequences
= Fgethash (binding
, where_is_cache
, Qnil
);
2655 Fputhash (binding
, Fcons (sequence
, sequences
), where_is_cache
);
2662 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2664 DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings
, Sdescribe_buffer_bindings
, 1, 3, 0,
2665 doc
: /* Insert the list of all defined keys and their definitions.
2666 The list is inserted in the current buffer, while the bindings are
2667 looked up in BUFFER.
2668 The optional argument PREFIX, if non-nil, should be a key sequence;
2669 then we display only bindings that start with that prefix.
2670 The optional argument MENUS, if non-nil, says to mention menu bindings.
2671 \(Ordinarily these are omitted from the output.) */)
2672 (buffer
, prefix
, menus
)
2673 Lisp_Object buffer
, prefix
, menus
;
2675 Lisp_Object outbuf
, shadow
;
2676 int nomenu
= NILP (menus
);
2677 register Lisp_Object start1
;
2678 struct gcpro gcpro1
;
2680 char *alternate_heading
2682 Keyboard translations:\n\n\
2683 You type Translation\n\
2684 -------- -----------\n";
2689 outbuf
= Fcurrent_buffer ();
2691 /* Report on alternates for keys. */
2692 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2695 const unsigned char *translate
= SDATA (Vkeyboard_translate_table
);
2696 int translate_len
= SCHARS (Vkeyboard_translate_table
);
2698 for (c
= 0; c
< translate_len
; c
++)
2699 if (translate
[c
] != c
)
2701 char buf
[KEY_DESCRIPTION_SIZE
];
2704 if (alternate_heading
)
2706 insert_string (alternate_heading
);
2707 alternate_heading
= 0;
2710 bufend
= push_key_description (translate
[c
], buf
, 1);
2711 insert (buf
, bufend
- buf
);
2712 Findent_to (make_number (16), make_number (1));
2713 bufend
= push_key_description (c
, buf
, 1);
2714 insert (buf
, bufend
- buf
);
2722 if (!NILP (Vkey_translation_map
))
2723 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2724 "Key translations", nomenu
, 1, 0);
2727 /* Print the (major mode) local map. */
2729 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2730 start1
= current_kboard
->Voverriding_terminal_local_map
;
2731 else if (!NILP (Voverriding_local_map
))
2732 start1
= Voverriding_local_map
;
2736 describe_map_tree (start1
, 1, shadow
, prefix
,
2737 "\f\nOverriding Bindings", nomenu
, 0, 0);
2738 shadow
= Fcons (start1
, shadow
);
2742 /* Print the minor mode and major mode keymaps. */
2744 Lisp_Object
*modes
, *maps
;
2746 /* Temporarily switch to `buffer', so that we can get that buffer's
2747 minor modes correctly. */
2748 Fset_buffer (buffer
);
2750 nmaps
= current_minor_maps (&modes
, &maps
);
2751 Fset_buffer (outbuf
);
2753 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2754 XBUFFER (buffer
), Qkeymap
);
2757 describe_map_tree (start1
, 1, shadow
, prefix
,
2758 "\f\n`keymap' Property Bindings", nomenu
, 0, 0);
2759 shadow
= Fcons (start1
, shadow
);
2762 /* Print the minor mode maps. */
2763 for (i
= 0; i
< nmaps
; i
++)
2765 /* The title for a minor mode keymap
2766 is constructed at run time.
2767 We let describe_map_tree do the actual insertion
2768 because it takes care of other features when doing so. */
2771 if (!SYMBOLP (modes
[i
]))
2774 p
= title
= (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes
[i
])));
2778 bcopy (SDATA (SYMBOL_NAME (modes
[i
])), p
,
2779 SCHARS (SYMBOL_NAME (modes
[i
])));
2780 p
+= SCHARS (SYMBOL_NAME (modes
[i
]));
2782 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2783 p
+= sizeof (" Minor Mode Bindings") - 1;
2786 describe_map_tree (maps
[i
], 1, shadow
, prefix
, title
, nomenu
, 0, 0);
2787 shadow
= Fcons (maps
[i
], shadow
);
2790 start1
= get_local_map (BUF_PT (XBUFFER (buffer
)),
2791 XBUFFER (buffer
), Qlocal_map
);
2794 if (EQ (start1
, XBUFFER (buffer
)->keymap
))
2795 describe_map_tree (start1
, 1, shadow
, prefix
,
2796 "\f\nMajor Mode Bindings", nomenu
, 0, 0);
2798 describe_map_tree (start1
, 1, shadow
, prefix
,
2799 "\f\n`local-map' Property Bindings",
2802 shadow
= Fcons (start1
, shadow
);
2806 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2807 "\f\nGlobal Bindings", nomenu
, 0, 1);
2809 /* Print the function-key-map translations under this prefix. */
2810 if (!NILP (Vfunction_key_map
))
2811 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2812 "\f\nFunction key map translations", nomenu
, 1, 0);
2818 /* Insert a description of the key bindings in STARTMAP,
2819 followed by those of all maps reachable through STARTMAP.
2820 If PARTIAL is nonzero, omit certain "uninteresting" commands
2821 (such as `undefined').
2822 If SHADOW is non-nil, it is a list of maps;
2823 don't mention keys which would be shadowed by any of them.
2824 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2825 TITLE, if not 0, is a string to insert at the beginning.
2826 TITLE should not end with a colon or a newline; we supply that.
2827 If NOMENU is not 0, then omit menu-bar commands.
2829 If TRANSL is nonzero, the definitions are actually key translations
2830 so print strings and vectors differently.
2832 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2836 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2838 Lisp_Object startmap
, shadow
, prefix
;
2845 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2846 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2853 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
2856 GCPRO3 (maps
, seen
, sub_shadows
);
2862 /* Delete from MAPS each element that is for the menu bar. */
2863 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
2865 Lisp_Object elt
, prefix
, tem
;
2868 prefix
= Fcar (elt
);
2869 if (XVECTOR (prefix
)->size
>= 1)
2871 tem
= Faref (prefix
, make_number (0));
2872 if (EQ (tem
, Qmenu_bar
))
2873 maps
= Fdelq (elt
, maps
);
2878 if (!NILP (maps
) || always_title
)
2882 insert_string (title
);
2885 insert_string (" Starting With ");
2886 insert1 (Fkey_description (prefix
));
2888 insert_string (":\n");
2890 insert_string (key_heading
);
2894 for (; !NILP (maps
); maps
= Fcdr (maps
))
2896 register Lisp_Object elt
, prefix
, tail
;
2899 prefix
= Fcar (elt
);
2903 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2907 shmap
= XCAR (tail
);
2909 /* If the sequence by which we reach this keymap is zero-length,
2910 then the shadow map for this keymap is just SHADOW. */
2911 if ((STRINGP (prefix
) && SCHARS (prefix
) == 0)
2912 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
2914 /* If the sequence by which we reach this keymap actually has
2915 some elements, then the sequence's definition in SHADOW is
2916 what we should use. */
2919 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
2920 if (INTEGERP (shmap
))
2924 /* If shmap is not nil and not a keymap,
2925 it completely shadows this map, so don't
2926 describe this map at all. */
2927 if (!NILP (shmap
) && !KEYMAPP (shmap
))
2931 sub_shadows
= Fcons (shmap
, sub_shadows
);
2934 /* Maps we have already listed in this loop shadow this map. */
2935 for (tail
= orig_maps
; !EQ (tail
, maps
); tail
= XCDR (tail
))
2938 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
2940 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
2943 describe_map (Fcdr (elt
), prefix
,
2944 transl
? describe_translation
: describe_command
,
2945 partial
, sub_shadows
, &seen
, nomenu
);
2951 insert_string ("\n");
2956 static int previous_description_column
;
2959 describe_command (definition
, args
)
2960 Lisp_Object definition
, args
;
2962 register Lisp_Object tem1
;
2963 int column
= (int) current_column (); /* iftc */
2964 int description_column
;
2966 /* If column 16 is no good, go to col 32;
2967 but don't push beyond that--go to next line instead. */
2971 description_column
= 32;
2973 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
2974 description_column
= 32;
2976 description_column
= 16;
2978 Findent_to (make_number (description_column
), make_number (1));
2979 previous_description_column
= description_column
;
2981 if (SYMBOLP (definition
))
2983 tem1
= SYMBOL_NAME (definition
);
2985 insert_string ("\n");
2987 else if (STRINGP (definition
) || VECTORP (definition
))
2988 insert_string ("Keyboard Macro\n");
2989 else if (KEYMAPP (definition
))
2990 insert_string ("Prefix Command\n");
2992 insert_string ("??\n");
2996 describe_translation (definition
, args
)
2997 Lisp_Object definition
, args
;
2999 register Lisp_Object tem1
;
3001 Findent_to (make_number (16), make_number (1));
3003 if (SYMBOLP (definition
))
3005 tem1
= SYMBOL_NAME (definition
);
3007 insert_string ("\n");
3009 else if (STRINGP (definition
) || VECTORP (definition
))
3011 insert1 (Fkey_description (definition
));
3012 insert_string ("\n");
3014 else if (KEYMAPP (definition
))
3015 insert_string ("Prefix Command\n");
3017 insert_string ("??\n");
3020 /* Describe the contents of map MAP, assuming that this map itself is
3021 reached by the sequence of prefix keys KEYS (a string or vector).
3022 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
3025 describe_map (map
, keys
, elt_describer
, partial
, shadow
, seen
, nomenu
)
3026 register Lisp_Object map
;
3028 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3034 Lisp_Object elt_prefix
;
3035 Lisp_Object tail
, definition
, event
;
3037 Lisp_Object suppress
;
3040 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3044 if (!NILP (keys
) && XFASTINT (Flength (keys
)) > 0)
3046 /* Call Fkey_description first, to avoid GC bug for the other string. */
3047 tem
= Fkey_description (keys
);
3048 elt_prefix
= concat2 (tem
, build_string (" "));
3054 suppress
= intern ("suppress-keymap");
3056 /* This vector gets used to present single keys to Flookup_key. Since
3057 that is done once per keymap element, we don't want to cons up a
3058 fresh vector every time. */
3059 kludge
= Fmake_vector (make_number (1), Qnil
);
3062 GCPRO3 (elt_prefix
, definition
, kludge
);
3064 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
3068 if (VECTORP (XCAR (tail
))
3069 || CHAR_TABLE_P (XCAR (tail
)))
3070 describe_vector (XCAR (tail
),
3071 elt_prefix
, Qnil
, elt_describer
, partial
, shadow
, map
,
3073 else if (CONSP (XCAR (tail
)))
3075 event
= XCAR (XCAR (tail
));
3077 /* Ignore bindings whose "keys" are not really valid events.
3078 (We get these in the frames and buffers menu.) */
3079 if (!(SYMBOLP (event
) || INTEGERP (event
)))
3082 if (nomenu
&& EQ (event
, Qmenu_bar
))
3085 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
3087 /* Don't show undefined commands or suppressed commands. */
3088 if (NILP (definition
)) continue;
3089 if (SYMBOLP (definition
) && partial
)
3091 tem
= Fget (definition
, suppress
);
3096 /* Don't show a command that isn't really visible
3097 because a local definition of the same key shadows it. */
3099 ASET (kludge
, 0, event
);
3102 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3103 if (!NILP (tem
)) continue;
3106 tem
= Flookup_key (map
, kludge
, Qt
);
3107 if (!EQ (tem
, definition
)) continue;
3111 previous_description_column
= 0;
3116 if (!NILP (elt_prefix
))
3117 insert1 (elt_prefix
);
3119 /* THIS gets the string to describe the character EVENT. */
3120 insert1 (Fsingle_key_description (event
, Qnil
));
3122 /* Print a description of the definition of this character.
3123 elt_describer will take care of spacing out far enough
3124 for alignment purposes. */
3125 (*elt_describer
) (definition
, Qnil
);
3127 else if (EQ (XCAR (tail
), Qkeymap
))
3129 /* The same keymap might be in the structure twice, if we're
3130 using an inherited keymap. So skip anything we've already
3132 tem
= Fassq (tail
, *seen
);
3133 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), keys
)))
3135 *seen
= Fcons (Fcons (tail
, keys
), *seen
);
3143 describe_vector_princ (elt
, fun
)
3144 Lisp_Object elt
, fun
;
3146 Findent_to (make_number (16), make_number (1));
3151 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 2, 0,
3152 doc
: /* Insert a description of contents of VECTOR.
3153 This is text showing the elements of vector matched against indices. */)
3155 Lisp_Object vector
, describer
;
3157 int count
= SPECPDL_INDEX ();
3158 if (NILP (describer
))
3159 describer
= intern ("princ");
3160 specbind (Qstandard_output
, Fcurrent_buffer ());
3161 CHECK_VECTOR_OR_CHAR_TABLE (vector
);
3162 describe_vector (vector
, Qnil
, describer
, describe_vector_princ
, 0,
3163 Qnil
, Qnil
, (int *)0, 0);
3165 return unbind_to (count
, Qnil
);
3168 /* Insert in the current buffer a description of the contents of VECTOR.
3169 We call ELT_DESCRIBER to insert the description of one value found
3172 ELT_PREFIX describes what "comes before" the keys or indices defined
3173 by this vector. This is a human-readable string whose size
3174 is not necessarily related to the situation.
3176 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3177 leads to this keymap.
3179 If the vector is a chartable, ELT_PREFIX is the vector
3180 of bytes that lead to the character set or portion of a character
3181 set described by this chartable.
3183 If PARTIAL is nonzero, it means do not mention suppressed commands
3184 (that assumes the vector is in a keymap).
3186 SHADOW is a list of keymaps that shadow this map.
3187 If it is non-nil, then we look up the key in those maps
3188 and we don't mention it now if it is defined by any of them.
3190 ENTIRE_MAP is the keymap in which this vector appears.
3191 If the definition in effect in the whole map does not match
3192 the one in this vector, we ignore this one.
3194 ARGS is simply passed as the second argument to ELT_DESCRIBER.
3196 INDICES and CHAR_TABLE_DEPTH are ignored. They will be removed in
3200 describe_vector (vector
, elt_prefix
, args
, elt_describer
,
3201 partial
, shadow
, entire_map
,
3202 indices
, char_table_depth
)
3203 register Lisp_Object vector
;
3204 Lisp_Object elt_prefix
, args
;
3205 void (*elt_describer
) P_ ((Lisp_Object
, Lisp_Object
));
3208 Lisp_Object entire_map
;
3210 int char_table_depth
;
3212 Lisp_Object definition
;
3215 Lisp_Object suppress
;
3217 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3218 /* Range of elements to be handled. */
3220 Lisp_Object character
;
3228 /* This vector gets used to present single keys to Flookup_key. Since
3229 that is done once per vector element, we don't want to cons up a
3230 fresh vector every time. */
3231 kludge
= Fmake_vector (make_number (1), Qnil
);
3232 GCPRO3 (elt_prefix
, definition
, kludge
);
3235 suppress
= intern ("suppress-keymap");
3238 to
= CHAR_TABLE_P (vector
) ? MAX_CHAR
+ 1 : XVECTOR (vector
)->size
;
3240 for (i
= from
; i
< to
; i
++)
3242 int range_beg
, range_end
;
3249 if (CHAR_TABLE_P (vector
))
3250 val
= char_table_ref_and_range (vector
, i
, &range_beg
, &i
);
3252 val
= AREF (vector
, i
);
3253 definition
= get_keyelt (val
, 0);
3255 if (NILP (definition
)) continue;
3257 /* Don't mention suppressed commands. */
3258 if (SYMBOLP (definition
) && partial
)
3262 tem
= Fget (definition
, suppress
);
3264 if (!NILP (tem
)) continue;
3267 character
= make_number (starting_i
);
3269 /* If this binding is shadowed by some other map, ignore it. */
3274 ASET (kludge
, 0, character
);
3275 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3277 if (!NILP (tem
)) continue;
3280 /* Ignore this definition if it is shadowed by an earlier
3281 one in the same keymap. */
3282 if (!NILP (entire_map
))
3286 ASET (kludge
, 0, character
);
3287 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3289 if (!EQ (tem
, definition
))
3299 /* Output the prefix that applies to every entry in this map. */
3300 if (!NILP (elt_prefix
))
3301 insert1 (elt_prefix
);
3303 insert1 (Fsingle_key_description (character
, Qnil
));
3305 /* Find all consecutive characters or rows that have the same
3306 definition. But, for elements of a top level char table, if
3307 they are for charsets, we had better describe one by one even
3308 if they have the same definition. */
3309 if (CHAR_TABLE_P (vector
))
3311 && (val
= char_table_ref_and_range (vector
, i
+ 1,
3312 &range_beg
, &range_end
),
3313 tem2
= get_keyelt (val
, 0),
3315 && !NILP (Fequal (tem2
, definition
)))
3319 && (tem2
= get_keyelt (AREF (vector
, i
+ 1), 0),
3321 && !NILP (Fequal (tem2
, definition
)))
3324 /* If we have a range of more than one character,
3325 print where the range reaches to. */
3327 if (i
!= starting_i
)
3331 if (!NILP (elt_prefix
))
3332 insert1 (elt_prefix
);
3334 insert1 (Fsingle_key_description (make_number (i
), Qnil
));
3337 /* Print a description of the definition of this character.
3338 elt_describer will take care of spacing out far enough
3339 for alignment purposes. */
3340 (*elt_describer
) (definition
, args
);
3346 /* Apropos - finding all symbols whose names match a regexp. */
3347 static Lisp_Object apropos_predicate
;
3348 static Lisp_Object apropos_accumulate
;
3351 apropos_accum (symbol
, string
)
3352 Lisp_Object symbol
, string
;
3354 register Lisp_Object tem
;
3356 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3357 if (!NILP (tem
) && !NILP (apropos_predicate
))
3358 tem
= call1 (apropos_predicate
, symbol
);
3360 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3363 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3364 doc
: /* Show all symbols whose names contain match for REGEXP.
3365 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3366 for each symbol and a symbol is mentioned only if that returns non-nil.
3367 Return list of symbols found. */)
3369 Lisp_Object regexp
, predicate
;
3372 CHECK_STRING (regexp
);
3373 apropos_predicate
= predicate
;
3374 apropos_accumulate
= Qnil
;
3375 map_obarray (Vobarray
, apropos_accum
, regexp
);
3376 tem
= Fsort (apropos_accumulate
, Qstring_lessp
);
3377 apropos_accumulate
= Qnil
;
3378 apropos_predicate
= Qnil
;
3385 Qkeymap
= intern ("keymap");
3386 staticpro (&Qkeymap
);
3387 staticpro (&apropos_predicate
);
3388 staticpro (&apropos_accumulate
);
3389 apropos_predicate
= Qnil
;
3390 apropos_accumulate
= Qnil
;
3392 /* Now we are ready to set up this property, so we can
3393 create char tables. */
3394 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3396 /* Initialize the keymaps standardly used.
3397 Each one is the value of a Lisp variable, and is also
3398 pointed to by a C variable */
3400 global_map
= Fmake_keymap (Qnil
);
3401 Fset (intern ("global-map"), global_map
);
3403 current_global_map
= global_map
;
3404 staticpro (&global_map
);
3405 staticpro (¤t_global_map
);
3407 meta_map
= Fmake_keymap (Qnil
);
3408 Fset (intern ("esc-map"), meta_map
);
3409 Ffset (intern ("ESC-prefix"), meta_map
);
3411 control_x_map
= Fmake_keymap (Qnil
);
3412 Fset (intern ("ctl-x-map"), control_x_map
);
3413 Ffset (intern ("Control-X-prefix"), control_x_map
);
3416 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3417 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3418 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3419 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3420 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3422 staticpro (&exclude_keys
);
3424 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3425 doc
: /* List of commands given new key bindings recently.
3426 This is used for internal purposes during Emacs startup;
3427 don't alter it yourself. */);
3428 Vdefine_key_rebound_commands
= Qt
;
3430 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3431 doc
: /* Default keymap to use when reading from the minibuffer. */);
3432 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3434 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3435 doc
: /* Local keymap for the minibuffer when spaces are not allowed. */);
3436 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3437 Fset_keymap_parent (Vminibuffer_local_ns_map
, Vminibuffer_local_map
);
3439 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3440 doc
: /* Local keymap for minibuffer input with completion. */);
3441 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3442 Fset_keymap_parent (Vminibuffer_local_completion_map
, Vminibuffer_local_map
);
3444 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3445 doc
: /* Local keymap for minibuffer input with completion, for exact match. */);
3446 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3447 Fset_keymap_parent (Vminibuffer_local_must_match_map
,
3448 Vminibuffer_local_completion_map
);
3450 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3451 doc
: /* Alist of keymaps to use for minor modes.
3452 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3453 key sequences and look up bindings iff VARIABLE's value is non-nil.
3454 If two active keymaps bind the same key, the keymap appearing earlier
3455 in the list takes precedence. */);
3456 Vminor_mode_map_alist
= Qnil
;
3458 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3459 doc
: /* Alist of keymaps to use for minor modes, in current major mode.
3460 This variable is an alist just like `minor-mode-map-alist', and it is
3461 used the same way (and before `minor-mode-map-alist'); however,
3462 it is provided for major modes to bind locally. */);
3463 Vminor_mode_overriding_map_alist
= Qnil
;
3465 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists
,
3466 doc
: /* List of keymap alists to use for emulations modes.
3467 It is intended for modes or packages using multiple minor-mode keymaps.
3468 Each element is a keymap alist just like `minor-mode-map-alist', or a
3469 symbol with a variable binding which is a keymap alist, and it is used
3470 the same way. The "active" keymaps in each alist are used before
3471 `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
3472 Vemulation_mode_map_alists
= Qnil
;
3475 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3476 doc
: /* Keymap mapping ASCII function key sequences onto their preferred forms.
3477 This allows Emacs to recognize function keys sent from ASCII
3478 terminals at any point in a key sequence.
3480 The `read-key-sequence' function replaces any subsequence bound by
3481 `function-key-map' with its binding. More precisely, when the active
3482 keymaps have no binding for the current key sequence but
3483 `function-key-map' binds a suffix of the sequence to a vector or string,
3484 `read-key-sequence' replaces the matching suffix with its binding, and
3485 continues with the new sequence.
3487 The events that come from bindings in `function-key-map' are not
3488 themselves looked up in `function-key-map'.
3490 For example, suppose `function-key-map' binds `ESC O P' to [f1].
3491 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3492 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3493 key, typing `ESC O P x' would return [f1 x]. */);
3494 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3496 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3497 doc
: /* Keymap of key translations that can override keymaps.
3498 This keymap works like `function-key-map', but comes after that,
3499 and applies even for keys that have ordinary bindings. */);
3500 Vkey_translation_map
= Qnil
;
3502 staticpro (&Vmenu_events
);
3503 Vmenu_events
= Fcons (intern ("menu-bar"),
3504 Fcons (intern ("tool-bar"),
3505 Fcons (intern ("mouse-1"),
3506 Fcons (intern ("mouse-2"),
3507 Fcons (intern ("mouse-3"),
3511 Qsingle_key_description
= intern ("single-key-description");
3512 staticpro (&Qsingle_key_description
);
3514 Qkey_description
= intern ("key-description");
3515 staticpro (&Qkey_description
);
3517 Qkeymapp
= intern ("keymapp");
3518 staticpro (&Qkeymapp
);
3520 Qnon_ascii
= intern ("non-ascii");
3521 staticpro (&Qnon_ascii
);
3523 Qmenu_item
= intern ("menu-item");
3524 staticpro (&Qmenu_item
);
3526 Qremap
= intern ("remap");
3527 staticpro (&Qremap
);
3529 command_remapping_vector
= Fmake_vector (make_number (2), Qremap
);
3530 staticpro (&command_remapping_vector
);
3532 where_is_cache_keymaps
= Qt
;
3533 where_is_cache
= Qnil
;
3534 staticpro (&where_is_cache
);
3535 staticpro (&where_is_cache_keymaps
);
3537 defsubr (&Skeymapp
);
3538 defsubr (&Skeymap_parent
);
3539 defsubr (&Skeymap_prompt
);
3540 defsubr (&Sset_keymap_parent
);
3541 defsubr (&Smake_keymap
);
3542 defsubr (&Smake_sparse_keymap
);
3543 defsubr (&Smap_keymap
);
3544 defsubr (&Scopy_keymap
);
3545 defsubr (&Scommand_remapping
);
3546 defsubr (&Skey_binding
);
3547 defsubr (&Slocal_key_binding
);
3548 defsubr (&Sglobal_key_binding
);
3549 defsubr (&Sminor_mode_key_binding
);
3550 defsubr (&Sdefine_key
);
3551 defsubr (&Slookup_key
);
3552 defsubr (&Sdefine_prefix_command
);
3553 defsubr (&Suse_global_map
);
3554 defsubr (&Suse_local_map
);
3555 defsubr (&Scurrent_local_map
);
3556 defsubr (&Scurrent_global_map
);
3557 defsubr (&Scurrent_minor_mode_maps
);
3558 defsubr (&Scurrent_active_maps
);
3559 defsubr (&Saccessible_keymaps
);
3560 defsubr (&Skey_description
);
3561 defsubr (&Sdescribe_vector
);
3562 defsubr (&Ssingle_key_description
);
3563 defsubr (&Stext_char_description
);
3564 defsubr (&Swhere_is_internal
);
3565 defsubr (&Sdescribe_buffer_bindings
);
3566 defsubr (&Sapropos_internal
);
3572 initial_define_key (global_map
, 033, "ESC-prefix");
3573 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");