1 /* Manipulation of keymaps
2 Copyright (C) 1985, 86,87,88,93,94,95,98,99 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
29 #include "termhooks.h"
30 #include "blockinput.h"
32 #include "intervals.h"
34 #define min(a, b) ((a) < (b) ? (a) : (b))
35 #define KEYMAPP(m) (!NILP (Fkeymapp (m)))
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 /* Keymap mapping ASCII function key sequences onto their preferred forms.
80 Initialized by the terminal-specific lisp files. See DEFVAR for more
82 Lisp_Object Vfunction_key_map
;
84 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
85 Lisp_Object Vkey_translation_map
;
87 /* A list of all commands given new bindings since a certain time
88 when nil was stored here.
89 This is used to speed up recomputation of menu key equivalents
90 when Emacs starts up. t means don't record anything here. */
91 Lisp_Object Vdefine_key_rebound_commands
;
93 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
, Qmenu_item
;
95 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
96 in a string key sequence is equivalent to prefixing with this
98 extern Lisp_Object meta_prefix_char
;
100 extern Lisp_Object Voverriding_local_map
;
102 static Lisp_Object store_in_keymap
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
103 static void fix_submap_inheritance
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
105 static Lisp_Object define_as_prefix
P_ ((Lisp_Object
, Lisp_Object
));
106 static Lisp_Object describe_buffer_bindings
P_ ((Lisp_Object
));
107 static void describe_command
P_ ((Lisp_Object
));
108 static void describe_translation
P_ ((Lisp_Object
));
109 static void describe_map
P_ ((Lisp_Object
, Lisp_Object
,
110 void (*) P_ ((Lisp_Object
)),
111 int, Lisp_Object
, Lisp_Object
*, int));
113 /* Keymap object support - constructors and predicates. */
115 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
116 "Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).\n\
117 CHARTABLE is a char-table that holds the bindings for the ASCII\n\
118 characters. ALIST is an assoc-list which holds bindings for function keys,\n\
119 mouse events, and any other things that appear in the input stream.\n\
120 All entries in it are initially nil, meaning \"command undefined\".\n\n\
121 The optional arg STRING supplies a menu name for the keymap\n\
122 in case you use it as a menu with `x-popup-menu'.")
128 tail
= Fcons (string
, Qnil
);
131 return Fcons (Qkeymap
,
132 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
135 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
136 "Construct and return a new sparse-keymap list.\n\
137 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),\n\
138 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),\n\
139 which binds the function key or mouse event SYMBOL to DEFINITION.\n\
140 Initially the alist is nil.\n\n\
141 The optional arg STRING supplies a menu name for the keymap\n\
142 in case you use it as a menu with `x-popup-menu'.")
147 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
148 return Fcons (Qkeymap
, Qnil
);
151 /* This function is used for installing the standard key bindings
152 at initialization time.
156 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
159 initial_define_key (keymap
, key
, defname
)
164 store_in_keymap (keymap
, make_number (key
), intern (defname
));
168 initial_define_lispy_key (keymap
, keyname
, defname
)
173 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
176 /* Define character fromchar in map frommap as an alias for character
177 tochar in map tomap. Subsequent redefinitions of the latter WILL
178 affect the former. */
182 synkey (frommap
, fromchar
, tomap
, tochar
)
183 struct Lisp_Vector
*frommap
, *tomap
;
184 int fromchar
, tochar
;
187 XSETVECTOR (v
, tomap
);
188 XSETFASTINT (c
, tochar
);
189 frommap
->contents
[fromchar
] = Fcons (v
, c
);
193 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
194 "Return t if OBJECT is a keymap.\n\
196 A keymap is a list (keymap . ALIST),\n\
197 or a symbol whose function definition is itself a keymap.\n\
198 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
199 a vector of densely packed bindings for small character codes\n\
200 is also allowed as an element.")
204 /* FIXME: Maybe this should return t for autoloaded keymaps? -sm */
205 return (NILP (get_keymap_1 (object
, 0, 0)) ? Qnil
: Qt
);
208 /* Check that OBJECT is a keymap (after dereferencing through any
209 symbols). If it is, return it.
211 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
212 is an autoload form, do the autoload and try again.
213 If AUTOLOAD is nonzero, callers must assume GC is possible.
215 ERROR controls how we respond if OBJECT isn't a keymap.
216 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
218 Note that most of the time, we don't want to pursue autoloads.
219 Functions like Faccessible_keymaps which scan entire keymap trees
220 shouldn't load every autoloaded keymap. I'm not sure about this,
221 but it seems to me that only read_key_sequence, Flookup_key, and
222 Fdefine_key should cause keymaps to be autoloaded.
224 This function can GC when AUTOLOAD is non-zero, because it calls
225 do_autoload which can GC. */
228 get_keymap_1 (object
, error
, autoload
)
237 if (CONSP (object
) && EQ (XCAR (object
), Qkeymap
))
241 tem
= indirect_function (object
);
242 if (CONSP (tem
) && EQ (XCAR (tem
), Qkeymap
))
246 /* Should we do an autoload? Autoload forms for keymaps have
247 Qkeymap as their fifth element. */
251 && EQ (XCAR (tem
), Qautoload
))
255 tail
= Fnth (make_number (4), tem
);
256 if (EQ (tail
, Qkeymap
))
258 struct gcpro gcpro1
, gcpro2
;
260 GCPRO2 (tem
, object
);
261 do_autoload (tem
, object
);
270 wrong_type_argument (Qkeymapp
, object
);
275 /* Follow any symbol chaining, and return the keymap denoted by OBJECT.
276 If OBJECT doesn't denote a keymap at all, signal an error. */
281 return get_keymap_1 (object
, 1, 0);
284 /* Return the parent map of the keymap MAP, or nil if it has none.
285 We assume that MAP is a valid keymap. */
287 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
288 "Return the parent keymap of KEYMAP.")
294 keymap
= get_keymap_1 (keymap
, 1, 1);
296 /* Skip past the initial element `keymap'. */
297 list
= XCDR (keymap
);
298 for (; CONSP (list
); list
= XCDR (list
))
300 /* See if there is another `keymap'. */
305 return get_keymap_1(list
, 0, 1);
309 /* Check whether MAP is one of MAPS parents. */
311 keymap_memberp (map
, maps
)
312 Lisp_Object map
, maps
;
314 if (NILP (map
)) return 0;
315 while (KEYMAPP (maps
) && !EQ (map
, maps
))
316 maps
= Fkeymap_parent (maps
);
317 return (EQ (map
, maps
));
320 /* Set the parent keymap of MAP to PARENT. */
322 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
323 "Modify KEYMAP to set its parent map to PARENT.\n\
324 PARENT should be nil or another keymap.")
326 Lisp_Object keymap
, parent
;
328 Lisp_Object list
, prev
;
332 keymap
= get_keymap_1 (keymap
, 1, 1);
337 parent
= get_keymap_1 (parent
, 1, 1);
339 /* Check for cycles. */
340 if (keymap_memberp (keymap
, parent
))
341 error ("Cyclic keymap inheritance");
344 /* Skip past the initial element `keymap'. */
349 /* If there is a parent keymap here, replace it.
350 If we came to the end, add the parent in PREV. */
351 if (! CONSP (list
) || KEYMAPP (list
))
353 /* If we already have the right parent, return now
354 so that we avoid the loops below. */
355 if (EQ (XCDR (prev
), parent
))
356 RETURN_UNGCPRO (parent
);
358 XCDR (prev
) = parent
;
364 /* Scan through for submaps, and set their parents too. */
366 for (list
= XCDR (keymap
); CONSP (list
); list
= XCDR (list
))
368 /* Stop the scan when we come to the parent. */
369 if (EQ (XCAR (list
), Qkeymap
))
372 /* If this element holds a prefix map, deal with it. */
373 if (CONSP (XCAR (list
))
374 && CONSP (XCDR (XCAR (list
))))
375 fix_submap_inheritance (keymap
, XCAR (XCAR (list
)),
378 if (VECTORP (XCAR (list
)))
379 for (i
= 0; i
< XVECTOR (XCAR (list
))->size
; i
++)
380 if (CONSP (XVECTOR (XCAR (list
))->contents
[i
]))
381 fix_submap_inheritance (keymap
, make_number (i
),
382 XVECTOR (XCAR (list
))->contents
[i
]);
384 if (CHAR_TABLE_P (XCAR (list
)))
386 Lisp_Object indices
[3];
388 map_char_table (fix_submap_inheritance
, Qnil
, XCAR (list
),
393 RETURN_UNGCPRO (parent
);
396 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
397 if EVENT is also a prefix in MAP's parent,
398 make sure that SUBMAP inherits that definition as its own parent. */
401 fix_submap_inheritance (map
, event
, submap
)
402 Lisp_Object map
, event
, submap
;
404 Lisp_Object map_parent
, parent_entry
;
406 /* SUBMAP is a cons that we found as a key binding.
407 Discard the other things found in a menu key binding. */
409 submap
= get_keymap_1 (get_keyelt (submap
, 0), 0, 0);
411 /* If it isn't a keymap now, there's no work to do. */
415 map_parent
= Fkeymap_parent (map
);
416 if (! NILP (map_parent
))
417 parent_entry
= access_keymap (map_parent
, event
, 0, 0, 0);
421 /* If MAP's parent has something other than a keymap,
422 our own submap shadows it completely. */
423 if (! KEYMAPP (parent_entry
))
426 if (! EQ (parent_entry
, submap
))
428 Lisp_Object submap_parent
;
429 submap_parent
= submap
;
434 tem
= Fkeymap_parent (submap_parent
);
438 if (keymap_memberp (tem
, parent_entry
))
439 /* Fset_keymap_parent could create a cycle. */
446 Fset_keymap_parent (submap_parent
, parent_entry
);
450 /* Look up IDX in MAP. IDX may be any sort of event.
451 Note that this does only one level of lookup; IDX must be a single
452 event, not a sequence.
454 If T_OK is non-zero, bindings for Qt are treated as default
455 bindings; any key left unmentioned by other tables and bindings is
456 given the binding of Qt.
458 If T_OK is zero, bindings for Qt are not treated specially.
460 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
463 access_keymap (map
, idx
, t_ok
, noinherit
, autoload
)
473 /* If idx is a list (some sort of mouse click, perhaps?),
474 the index we want to use is the car of the list, which
475 ought to be a symbol. */
476 idx
= EVENT_HEAD (idx
);
478 /* If idx is a symbol, it might have modifiers, which need to
479 be put in the canonical order. */
481 idx
= reorder_modifiers (idx
);
482 else if (INTEGERP (idx
))
483 /* Clobber the high bits that can be present on a machine
484 with more than 24 bits of integer. */
485 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
487 /* Handle the special meta -> esc mapping. */
488 if (INTEGERP (idx
) && XUINT (idx
) & meta_modifier
)
490 /* See if there is a meta-map. If there's none, there is
491 no binding for IDX, unless a default binding exists in MAP. */
492 Lisp_Object meta_map
=
493 get_keymap_1 (access_keymap
494 (map
, meta_prefix_char
, t_ok
, noinherit
, autoload
),
496 if (!NILP (meta_map
))
499 idx
= make_number (XUINT (idx
) & ~meta_modifier
);
502 /* Set IDX to t, so that we only find a default binding. */
505 /* We know there is no binding. */
511 Lisp_Object t_binding
;
514 for (tail
= XCDR (map
);
516 || (tail
= get_keymap_1 (tail
, 0, autoload
),
522 binding
= XCAR (tail
);
523 if (SYMBOLP (binding
))
525 /* If NOINHERIT, stop finding prefix definitions
526 after we pass a second occurrence of the `keymap' symbol. */
527 if (noinherit
&& EQ (binding
, Qkeymap
))
530 else if (CONSP (binding
))
532 if (EQ (XCAR (binding
), idx
))
534 val
= XCDR (binding
);
535 if (noprefix
&& KEYMAPP (val
))
538 fix_submap_inheritance (map
, idx
, val
);
539 return get_keyelt (val
, autoload
);
541 if (t_ok
&& EQ (XCAR (binding
), Qt
))
542 t_binding
= XCDR (binding
);
544 else if (VECTORP (binding
))
546 if (NATNUMP (idx
) && XFASTINT (idx
) < XVECTOR (binding
)->size
)
548 val
= XVECTOR (binding
)->contents
[XFASTINT (idx
)];
549 if (noprefix
&& KEYMAPP (val
))
552 fix_submap_inheritance (map
, idx
, val
);
553 return get_keyelt (val
, autoload
);
556 else if (CHAR_TABLE_P (binding
))
558 /* Character codes with modifiers
559 are not included in a char-table.
560 All character codes without modifiers are included. */
563 & (CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
564 | CHAR_SHIFT
| CHAR_CTL
| CHAR_META
)))
566 val
= Faref (binding
, idx
);
567 if (noprefix
&& KEYMAPP (val
))
570 fix_submap_inheritance (map
, idx
, val
);
571 return get_keyelt (val
, autoload
);
578 return get_keyelt (t_binding
, autoload
);
582 /* Given OBJECT which was found in a slot in a keymap,
583 trace indirect definitions to get the actual definition of that slot.
584 An indirect definition is a list of the form
585 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
586 and INDEX is the object to look up in KEYMAP to yield the definition.
588 Also if OBJECT has a menu string as the first element,
589 remove that. Also remove a menu help string as second element.
591 If AUTOLOAD is nonzero, load autoloadable keymaps
592 that are referred to with indirection. */
595 get_keyelt (object
, autoload
)
596 register Lisp_Object object
;
601 if (!(CONSP (object
)))
602 /* This is really the value. */
605 /* If the keymap contents looks like (keymap ...) or (lambda ...)
607 else if (EQ (XCAR (object
), Qkeymap
) || EQ (XCAR (object
), Qlambda
))
610 /* If the keymap contents looks like (menu-item name . DEFN)
611 or (menu-item name DEFN ...) then use DEFN.
612 This is a new format menu item. */
613 else if (EQ (XCAR (object
), Qmenu_item
))
615 if (CONSP (XCDR (object
)))
619 object
= XCDR (XCDR (object
));
622 object
= XCAR (object
);
624 /* If there's a `:filter FILTER', apply FILTER to the
625 menu-item's definition to get the real definition to
626 use. Temporarily inhibit GC while evaluating FILTER,
627 because not functions calling get_keyelt are prepared
629 for (; CONSP (tem
) && CONSP (XCDR (tem
)); tem
= XCDR (tem
))
630 if (EQ (XCAR (tem
), QCfilter
))
632 int count
= inhibit_garbage_collection ();
634 filter
= XCAR (XCDR (tem
));
635 filter
= list2 (filter
, list2 (Qquote
, object
));
636 object
= menu_item_eval_property (filter
);
637 unbind_to (count
, Qnil
);
646 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
647 Keymap alist elements like (CHAR MENUSTRING . DEFN)
648 will be used by HierarKey menus. */
649 else if (STRINGP (XCAR (object
)))
651 object
= XCDR (object
);
652 /* Also remove a menu help string, if any,
653 following the menu item name. */
654 if (CONSP (object
) && STRINGP (XCAR (object
)))
655 object
= XCDR (object
);
656 /* Also remove the sublist that caches key equivalences, if any. */
657 if (CONSP (object
) && CONSP (XCAR (object
)))
660 carcar
= XCAR (XCAR (object
));
661 if (NILP (carcar
) || VECTORP (carcar
))
662 object
= XCDR (object
);
666 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
670 map
= get_keymap_1 (Fcar_safe (object
), 0, autoload
);
671 return (NILP (map
) ? object
/* Invalid keymap */
672 : access_keymap (map
, Fcdr (object
), 0, 0, autoload
));
678 store_in_keymap (keymap
, idx
, def
)
680 register Lisp_Object idx
;
681 register Lisp_Object def
;
683 /* If we are preparing to dump, and DEF is a menu element
684 with a menu item indicator, copy it to ensure it is not pure. */
685 if (CONSP (def
) && PURE_P (def
)
686 && (EQ (XCAR (def
), Qmenu_item
) || STRINGP (XCAR (def
))))
687 def
= Fcons (XCAR (def
), XCDR (def
));
689 if (!CONSP (keymap
) || ! EQ (XCAR (keymap
), Qkeymap
))
690 error ("attempt to define a key in a non-keymap");
692 /* If idx is a list (some sort of mouse click, perhaps?),
693 the index we want to use is the car of the list, which
694 ought to be a symbol. */
695 idx
= EVENT_HEAD (idx
);
697 /* If idx is a symbol, it might have modifiers, which need to
698 be put in the canonical order. */
700 idx
= reorder_modifiers (idx
);
701 else if (INTEGERP (idx
))
702 /* Clobber the high bits that can be present on a machine
703 with more than 24 bits of integer. */
704 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
706 /* Scan the keymap for a binding of idx. */
710 /* The cons after which we should insert new bindings. If the
711 keymap has a table element, we record its position here, so new
712 bindings will go after it; this way, the table will stay
713 towards the front of the alist and character lookups in dense
714 keymaps will remain fast. Otherwise, this just points at the
715 front of the keymap. */
716 Lisp_Object insertion_point
;
718 insertion_point
= keymap
;
719 for (tail
= XCDR (keymap
); CONSP (tail
); tail
= XCDR (tail
))
726 if (NATNUMP (idx
) && XFASTINT (idx
) < XVECTOR (elt
)->size
)
728 XVECTOR (elt
)->contents
[XFASTINT (idx
)] = def
;
731 insertion_point
= tail
;
733 else if (CHAR_TABLE_P (elt
))
735 /* Character codes with modifiers
736 are not included in a char-table.
737 All character codes without modifiers are included. */
740 & (CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
741 | CHAR_SHIFT
| CHAR_CTL
| CHAR_META
)))
743 Faset (elt
, idx
, def
);
746 insertion_point
= tail
;
748 else if (CONSP (elt
))
750 if (EQ (idx
, XCAR (elt
)))
756 else if (SYMBOLP (elt
))
758 /* If we find a 'keymap' symbol in the spine of KEYMAP,
759 then we must have found the start of a second keymap
760 being used as the tail of KEYMAP, and a binding for IDX
761 should be inserted before it. */
762 if (EQ (elt
, Qkeymap
))
770 /* We have scanned the entire keymap, and not found a binding for
771 IDX. Let's add one. */
772 XCDR (insertion_point
)
773 = Fcons (Fcons (idx
, def
), XCDR (insertion_point
));
780 copy_keymap_1 (chartable
, idx
, elt
)
781 Lisp_Object chartable
, idx
, elt
;
783 if (!SYMBOLP (elt
) && ! NILP (Fkeymapp (elt
)))
784 Faset (chartable
, idx
, Fcopy_keymap (elt
));
787 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
788 "Return a copy of the keymap KEYMAP.\n\
789 The copy starts out with the same definitions of KEYMAP,\n\
790 but changing either the copy or KEYMAP does not affect the other.\n\
791 Any key definitions that are subkeymaps are recursively copied.\n\
792 However, a key definition which is a symbol whose definition is a keymap\n\
797 register Lisp_Object copy
, tail
;
799 copy
= Fcopy_alist (get_keymap (keymap
));
801 for (tail
= copy
; CONSP (tail
); tail
= XCDR (tail
))
806 if (CHAR_TABLE_P (elt
))
808 Lisp_Object indices
[3];
810 elt
= Fcopy_sequence (elt
);
813 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, 0, indices
);
815 else if (VECTORP (elt
))
819 elt
= Fcopy_sequence (elt
);
822 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
823 if (!SYMBOLP (XVECTOR (elt
)->contents
[i
])
824 && ! NILP (Fkeymapp (XVECTOR (elt
)->contents
[i
])))
825 XVECTOR (elt
)->contents
[i
]
826 = Fcopy_keymap (XVECTOR (elt
)->contents
[i
]);
828 else if (CONSP (elt
) && CONSP (XCDR (elt
)))
833 /* Is this a new format menu item. */
834 if (EQ (XCAR (tem
),Qmenu_item
))
836 /* Copy cell with menu-item marker. */
838 = Fcons (XCAR (tem
), XCDR (tem
));
843 /* Copy cell with menu-item name. */
845 = Fcons (XCAR (tem
), XCDR (tem
));
851 /* Copy cell with binding and if the binding is a keymap,
854 = Fcons (XCAR (tem
), XCDR (tem
));
857 if (!(SYMBOLP (tem
) || NILP (Fkeymapp (tem
))))
858 XCAR (elt
) = Fcopy_keymap (tem
);
860 if (CONSP (tem
) && CONSP (XCAR (tem
)))
861 /* Delete cache for key equivalences. */
862 XCDR (elt
) = XCDR (tem
);
867 /* It may be an old fomat menu item.
868 Skip the optional menu string.
870 if (STRINGP (XCAR (tem
)))
872 /* Copy the cell, since copy-alist didn't go this deep. */
874 = Fcons (XCAR (tem
), XCDR (tem
));
877 /* Also skip the optional menu help string. */
878 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
881 = Fcons (XCAR (tem
), XCDR (tem
));
885 /* There may also be a list that caches key equivalences.
886 Just delete it for the new keymap. */
888 && CONSP (XCAR (tem
))
889 && (NILP (XCAR (XCAR (tem
)))
890 || VECTORP (XCAR (XCAR (tem
)))))
891 XCDR (elt
) = XCDR (tem
);
894 && ! SYMBOLP (XCDR (elt
))
895 && ! NILP (Fkeymapp (XCDR (elt
))))
896 XCDR (elt
) = Fcopy_keymap (XCDR (elt
));
905 /* Simple Keymap mutators and accessors. */
907 /* GC is possible in this function if it autoloads a keymap. */
909 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
910 "Args KEYMAP, KEY, DEF. Define key sequence KEY, in KEYMAP, as DEF.\n\
911 KEYMAP is a keymap. KEY is a string or a vector of symbols and characters\n\
912 meaning a sequence of keystrokes and events.\n\
913 Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
914 can be included if you use a vector.\n\
915 DEF is anything that can be a key's definition:\n\
916 nil (means key is undefined in this keymap),\n\
917 a command (a Lisp function suitable for interactive calling)\n\
918 a string (treated as a keyboard macro),\n\
919 a keymap (to define a prefix key),\n\
920 a symbol. When the key is looked up, the symbol will stand for its\n\
921 function definition, which should at that time be one of the above,\n\
922 or another symbol whose function definition is used, etc.\n\
923 a cons (STRING . DEFN), meaning that DEFN is the definition\n\
924 (DEFN should be a valid definition in its own right),\n\
925 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.\n\
927 If KEYMAP is a sparse keymap, the pair binding KEY to DEF is added at\n\
928 the front of KEYMAP.")
935 register Lisp_Object c
;
936 register Lisp_Object cmd
;
940 struct gcpro gcpro1
, gcpro2
, gcpro3
;
942 keymap
= get_keymap_1 (keymap
, 1, 1);
944 if (!VECTORP (key
) && !STRINGP (key
))
945 key
= wrong_type_argument (Qarrayp
, key
);
947 length
= XFASTINT (Flength (key
));
951 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
952 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
954 GCPRO3 (keymap
, key
, def
);
957 meta_bit
= meta_modifier
;
964 c
= Faref (key
, make_number (idx
));
966 if (CONSP (c
) && lucid_event_type_list_p (c
))
967 c
= Fevent_convert_list (c
);
970 && (XINT (c
) & meta_bit
)
973 c
= meta_prefix_char
;
979 XSETINT (c
, XINT (c
) & ~meta_bit
);
985 if (! INTEGERP (c
) && ! SYMBOLP (c
) && ! CONSP (c
))
986 error ("Key sequence contains invalid events");
989 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
991 cmd
= access_keymap (keymap
, c
, 0, 1, 1);
993 /* If this key is undefined, make it a prefix. */
995 cmd
= define_as_prefix (keymap
, c
);
997 keymap
= get_keymap_1 (cmd
, 0, 1);
999 /* We must use Fkey_description rather than just passing key to
1000 error; key might be a vector, not a string. */
1001 error ("Key sequence %s uses invalid prefix characters",
1002 XSTRING (Fkey_description (key
))->data
);
1006 /* Value is number if KEY is too long; NIL if valid but has no definition. */
1007 /* GC is possible in this function if it autoloads a keymap. */
1009 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
1010 "In keymap KEYMAP, look up key sequence KEY. Return the definition.\n\
1011 nil means undefined. See doc of `define-key' for kinds of definitions.\n\
1013 A number as value means KEY is \"too long\";\n\
1014 that is, characters or symbols in it except for the last one\n\
1015 fail to be a valid sequence of prefix characters in KEYMAP.\n\
1016 The number is how many characters at the front of KEY\n\
1017 it takes to reach a non-prefix command.\n\
1019 Normally, `lookup-key' ignores bindings for t, which act as default\n\
1020 bindings, used when nothing else in the keymap applies; this makes it\n\
1021 usable as a general function for probing keymaps. However, if the\n\
1022 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will\n\
1023 recognize the default bindings, just as `read-key-sequence' does.")
1024 (keymap
, key
, accept_default
)
1025 register Lisp_Object keymap
;
1027 Lisp_Object accept_default
;
1030 register Lisp_Object cmd
;
1031 register Lisp_Object c
;
1033 int t_ok
= ! NILP (accept_default
);
1034 struct gcpro gcpro1
;
1036 keymap
= get_keymap_1 (keymap
, 1, 1);
1038 if (!VECTORP (key
) && !STRINGP (key
))
1039 key
= wrong_type_argument (Qarrayp
, key
);
1041 length
= XFASTINT (Flength (key
));
1050 c
= Faref (key
, make_number (idx
++));
1052 if (CONSP (c
) && lucid_event_type_list_p (c
))
1053 c
= Fevent_convert_list (c
);
1055 /* Turn the 8th bit of string chars into a meta modifier. */
1056 if (XINT (c
) & 0x80 && STRINGP (key
))
1057 XSETINT (c
, (XINT (c
) | meta_modifier
) & ~0x80);
1059 cmd
= access_keymap (keymap
, c
, t_ok
, 0, 1);
1061 RETURN_UNGCPRO (cmd
);
1063 keymap
= get_keymap_1 (cmd
, 0, 1);
1065 RETURN_UNGCPRO (make_number (idx
));
1071 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1072 Assume that currently it does not define C at all.
1073 Return the keymap. */
1076 define_as_prefix (keymap
, c
)
1077 Lisp_Object keymap
, c
;
1081 cmd
= Fmake_sparse_keymap (Qnil
);
1082 /* If this key is defined as a prefix in an inherited keymap,
1083 make it a prefix in this map, and make its definition
1084 inherit the other prefix definition. */
1085 cmd
= nconc2 (cmd
, access_keymap (keymap
, c
, 0, 0, 0));
1086 store_in_keymap (keymap
, c
, cmd
);
1091 /* Append a key to the end of a key sequence. We always make a vector. */
1094 append_key (key_sequence
, key
)
1095 Lisp_Object key_sequence
, key
;
1097 Lisp_Object args
[2];
1099 args
[0] = key_sequence
;
1101 args
[1] = Fcons (key
, Qnil
);
1102 return Fvconcat (2, args
);
1106 /* Global, local, and minor mode keymap stuff. */
1108 /* We can't put these variables inside current_minor_maps, since under
1109 some systems, static gets macro-defined to be the empty string.
1111 static Lisp_Object
*cmm_modes
, *cmm_maps
;
1112 static int cmm_size
;
1114 /* Error handler used in current_minor_maps. */
1116 current_minor_maps_error ()
1121 /* Store a pointer to an array of the keymaps of the currently active
1122 minor modes in *buf, and return the number of maps it contains.
1124 This function always returns a pointer to the same buffer, and may
1125 free or reallocate it, so if you want to keep it for a long time or
1126 hand it out to lisp code, copy it. This procedure will be called
1127 for every key sequence read, so the nice lispy approach (return a
1128 new assoclist, list, what have you) for each invocation would
1129 result in a lot of consing over time.
1131 If we used xrealloc/xmalloc and ran out of memory, they would throw
1132 back to the command loop, which would try to read a key sequence,
1133 which would call this function again, resulting in an infinite
1134 loop. Instead, we'll use realloc/malloc and silently truncate the
1135 list, let the key sequence be read, and hope some other piece of
1136 code signals the error. */
1138 current_minor_maps (modeptr
, mapptr
)
1139 Lisp_Object
**modeptr
, **mapptr
;
1142 int list_number
= 0;
1143 Lisp_Object alist
, assoc
, var
, val
;
1144 Lisp_Object lists
[2];
1146 lists
[0] = Vminor_mode_overriding_map_alist
;
1147 lists
[1] = Vminor_mode_map_alist
;
1149 for (list_number
= 0; list_number
< 2; list_number
++)
1150 for (alist
= lists
[list_number
];
1152 alist
= XCDR (alist
))
1153 if ((assoc
= XCAR (alist
), CONSP (assoc
))
1154 && (var
= XCAR (assoc
), SYMBOLP (var
))
1155 && (val
= find_symbol_value (var
), ! EQ (val
, Qunbound
))
1160 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1161 and also an entry in Vminor_mode_map_alist,
1162 ignore the latter. */
1163 if (list_number
== 1)
1165 val
= assq_no_quit (var
, lists
[0]);
1172 Lisp_Object
*newmodes
, *newmaps
;
1179 = (Lisp_Object
*) realloc (cmm_modes
,
1180 cmm_size
* sizeof (Lisp_Object
));
1182 = (Lisp_Object
*) realloc (cmm_maps
,
1183 cmm_size
* sizeof (Lisp_Object
));
1191 = (Lisp_Object
*) xmalloc (cmm_size
* sizeof (Lisp_Object
));
1193 = (Lisp_Object
*) xmalloc (cmm_size
* sizeof (Lisp_Object
));
1197 if (newmaps
&& newmodes
)
1199 cmm_modes
= newmodes
;
1206 /* Get the keymap definition--or nil if it is not defined. */
1207 temp
= internal_condition_case_1 (Findirect_function
,
1209 Qerror
, current_minor_maps_error
);
1213 cmm_maps
[i
] = temp
;
1218 if (modeptr
) *modeptr
= cmm_modes
;
1219 if (mapptr
) *mapptr
= cmm_maps
;
1223 /* GC is possible in this function if it autoloads a keymap. */
1225 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 2, 0,
1226 "Return the binding for command KEY in current keymaps.\n\
1227 KEY is a string or vector, a sequence of keystrokes.\n\
1228 The binding is probably a symbol with a function definition.\n\
1230 Normally, `key-binding' ignores bindings for t, which act as default\n\
1231 bindings, used when nothing else in the keymap applies; this makes it\n\
1232 usable as a general function for probing keymaps. However, if the\n\
1233 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\
1234 recognize the default bindings, just as `read-key-sequence' does.")
1235 (key
, accept_default
)
1236 Lisp_Object key
, accept_default
;
1238 Lisp_Object
*maps
, value
;
1240 struct gcpro gcpro1
;
1244 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1246 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1247 key
, accept_default
);
1248 if (! NILP (value
) && !INTEGERP (value
))
1249 RETURN_UNGCPRO (value
);
1251 else if (!NILP (Voverriding_local_map
))
1253 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1254 if (! NILP (value
) && !INTEGERP (value
))
1255 RETURN_UNGCPRO (value
);
1261 nmaps
= current_minor_maps (0, &maps
);
1262 /* Note that all these maps are GCPRO'd
1263 in the places where we found them. */
1265 for (i
= 0; i
< nmaps
; i
++)
1266 if (! NILP (maps
[i
]))
1268 value
= Flookup_key (maps
[i
], key
, accept_default
);
1269 if (! NILP (value
) && !INTEGERP (value
))
1270 RETURN_UNGCPRO (value
);
1273 local
= get_local_map (PT
, current_buffer
, keymap
);
1276 value
= Flookup_key (local
, key
, accept_default
);
1277 if (! NILP (value
) && !INTEGERP (value
))
1278 RETURN_UNGCPRO (value
);
1281 local
= get_local_map (PT
, current_buffer
, local_map
);
1285 value
= Flookup_key (local
, key
, accept_default
);
1286 if (! NILP (value
) && !INTEGERP (value
))
1287 RETURN_UNGCPRO (value
);
1291 value
= Flookup_key (current_global_map
, key
, accept_default
);
1293 if (! NILP (value
) && !INTEGERP (value
))
1299 /* GC is possible in this function if it autoloads a keymap. */
1301 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1302 "Return the binding for command KEYS in current local keymap only.\n\
1303 KEYS is a string, a sequence of keystrokes.\n\
1304 The binding is probably a symbol with a function definition.\n\
1306 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1307 bindings; see the description of `lookup-key' for more details about this.")
1308 (keys
, accept_default
)
1309 Lisp_Object keys
, accept_default
;
1311 register Lisp_Object map
;
1312 map
= current_buffer
->keymap
;
1315 return Flookup_key (map
, keys
, accept_default
);
1318 /* GC is possible in this function if it autoloads a keymap. */
1320 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1321 "Return the binding for command KEYS in current global keymap only.\n\
1322 KEYS is a string, a sequence of keystrokes.\n\
1323 The binding is probably a symbol with a function definition.\n\
1324 This function's return values are the same as those of lookup-key\n\
1327 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1328 bindings; see the description of `lookup-key' for more details about this.")
1329 (keys
, accept_default
)
1330 Lisp_Object keys
, accept_default
;
1332 return Flookup_key (current_global_map
, keys
, accept_default
);
1335 /* GC is possible in this function if it autoloads a keymap. */
1337 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1338 "Find the visible minor mode bindings of KEY.\n\
1339 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the\n\
1340 the symbol which names the minor mode binding KEY, and BINDING is\n\
1341 KEY's definition in that mode. In particular, if KEY has no\n\
1342 minor-mode bindings, return nil. If the first binding is a\n\
1343 non-prefix, all subsequent bindings will be omitted, since they would\n\
1344 be ignored. Similarly, the list doesn't include non-prefix bindings\n\
1345 that come after prefix bindings.\n\
1347 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1348 bindings; see the description of `lookup-key' for more details about this.")
1349 (key
, accept_default
)
1350 Lisp_Object key
, accept_default
;
1352 Lisp_Object
*modes
, *maps
;
1354 Lisp_Object binding
;
1356 struct gcpro gcpro1
, gcpro2
;
1358 nmaps
= current_minor_maps (&modes
, &maps
);
1359 /* Note that all these maps are GCPRO'd
1360 in the places where we found them. */
1363 GCPRO2 (key
, binding
);
1365 for (i
= j
= 0; i
< nmaps
; i
++)
1366 if (! NILP (maps
[i
])
1367 && ! NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1368 && !INTEGERP (binding
))
1370 if (! NILP (get_keymap (binding
)))
1371 maps
[j
++] = Fcons (modes
[i
], binding
);
1373 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1377 return Flist (j
, maps
);
1380 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 3, 0,
1381 "Define COMMAND as a prefix command. COMMAND should be a symbol.\n\
1382 A new sparse keymap is stored as COMMAND's function definition and its value.\n\
1383 If a second optional argument MAPVAR is given, the map is stored as\n\
1384 its value instead of as COMMAND's value; but COMMAND is still defined\n\
1386 The third optional argument NAME, if given, supplies a menu name\n\
1387 string for the map. This is required to use the keymap as a menu.")
1388 (command
, mapvar
, name
)
1389 Lisp_Object command
, mapvar
, name
;
1392 map
= Fmake_sparse_keymap (name
);
1393 Ffset (command
, map
);
1397 Fset (command
, map
);
1401 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1402 "Select KEYMAP as the global keymap.")
1406 keymap
= get_keymap (keymap
);
1407 current_global_map
= keymap
;
1412 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1413 "Select KEYMAP as the local keymap.\n\
1414 If KEYMAP is nil, that means no local keymap.")
1419 keymap
= get_keymap (keymap
);
1421 current_buffer
->keymap
= keymap
;
1426 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1427 "Return current buffer's local keymap, or nil if it has none.")
1430 return current_buffer
->keymap
;
1433 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1434 "Return the current global keymap.")
1437 return current_global_map
;
1440 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1441 "Return a list of keymaps for the minor modes of the current buffer.")
1445 int nmaps
= current_minor_maps (0, &maps
);
1447 return Flist (nmaps
, maps
);
1450 /* Help functions for describing and documenting keymaps. */
1452 static void accessible_keymaps_char_table ();
1454 /* This function cannot GC. */
1456 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1458 "Find all keymaps accessible via prefix characters from KEYMAP.\n\
1459 Returns a list of elements of the form (KEYS . MAP), where the sequence\n\
1460 KEYS starting from KEYMAP gets you to MAP. These elements are ordered\n\
1461 so that the KEYS increase in length. The first element is ([] . KEYMAP).\n\
1462 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
1463 then the value includes only maps for prefixes that start with PREFIX.")
1465 Lisp_Object keymap
, prefix
;
1467 Lisp_Object maps
, good_maps
, tail
;
1470 /* no need for gcpro because we don't autoload any keymaps. */
1473 prefixlen
= XINT (Flength (prefix
));
1477 /* If a prefix was specified, start with the keymap (if any) for
1478 that prefix, so we don't waste time considering other prefixes. */
1480 tem
= Flookup_key (keymap
, prefix
, Qt
);
1481 /* Flookup_key may give us nil, or a number,
1482 if the prefix is not defined in this particular map.
1483 It might even give us a list that isn't a keymap. */
1484 tem
= get_keymap_1 (tem
, 0, 0);
1487 /* Convert PREFIX to a vector now, so that later on
1488 we don't have to deal with the possibility of a string. */
1489 if (STRINGP (prefix
))
1494 copy
= Fmake_vector (make_number (XSTRING (prefix
)->size
), Qnil
);
1495 for (i
= 0, i_byte
= 0; i
< XSTRING (prefix
)->size
;)
1499 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1500 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1501 c
^= 0200 | meta_modifier
;
1502 XVECTOR (copy
)->contents
[i_before
] = make_number (c
);
1506 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1512 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1513 get_keymap (keymap
)),
1516 /* For each map in the list maps,
1517 look at any other maps it points to,
1518 and stick them at the end if they are not already in the list.
1520 This is a breadth-first traversal, where tail is the queue of
1521 nodes, and maps accumulates a list of all nodes visited. */
1523 for (tail
= maps
; CONSP (tail
); tail
= XCDR (tail
))
1525 register Lisp_Object thisseq
, thismap
;
1527 /* Does the current sequence end in the meta-prefix-char? */
1530 thisseq
= Fcar (Fcar (tail
));
1531 thismap
= Fcdr (Fcar (tail
));
1532 last
= make_number (XINT (Flength (thisseq
)) - 1);
1533 is_metized
= (XINT (last
) >= 0
1534 /* Don't metize the last char of PREFIX. */
1535 && XINT (last
) >= prefixlen
1536 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1538 for (; CONSP (thismap
); thismap
= XCDR (thismap
))
1542 elt
= XCAR (thismap
);
1546 if (CHAR_TABLE_P (elt
))
1548 Lisp_Object indices
[3];
1550 map_char_table (accessible_keymaps_char_table
, Qnil
,
1551 elt
, Fcons (maps
, Fcons (tail
, thisseq
)),
1554 else if (VECTORP (elt
))
1558 /* Vector keymap. Scan all the elements. */
1559 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
1561 register Lisp_Object tem
;
1562 register Lisp_Object cmd
;
1564 cmd
= get_keyelt (XVECTOR (elt
)->contents
[i
], 0);
1565 if (NILP (cmd
)) continue;
1566 tem
= Fkeymapp (cmd
);
1569 cmd
= get_keymap (cmd
);
1570 /* Ignore keymaps that are already added to maps. */
1571 tem
= Frassq (cmd
, maps
);
1574 /* If the last key in thisseq is meta-prefix-char,
1575 turn it into a meta-ized keystroke. We know
1576 that the event we're about to append is an
1577 ascii keystroke since we're processing a
1581 int meta_bit
= meta_modifier
;
1582 tem
= Fcopy_sequence (thisseq
);
1584 Faset (tem
, last
, make_number (i
| meta_bit
));
1586 /* This new sequence is the same length as
1587 thisseq, so stick it in the list right
1590 = Fcons (Fcons (tem
, cmd
), XCDR (tail
));
1594 tem
= append_key (thisseq
, make_number (i
));
1595 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1601 else if (CONSP (elt
))
1603 register Lisp_Object cmd
, tem
;
1605 cmd
= get_keyelt (XCDR (elt
), 0);
1606 /* Ignore definitions that aren't keymaps themselves. */
1607 tem
= Fkeymapp (cmd
);
1610 /* Ignore keymaps that have been seen already. */
1611 cmd
= get_keymap (cmd
);
1612 tem
= Frassq (cmd
, maps
);
1615 /* Let elt be the event defined by this map entry. */
1618 /* If the last key in thisseq is meta-prefix-char, and
1619 this entry is a binding for an ascii keystroke,
1620 turn it into a meta-ized keystroke. */
1621 if (is_metized
&& INTEGERP (elt
))
1623 Lisp_Object element
;
1626 tem
= Fvconcat (1, &element
);
1627 XSETFASTINT (XVECTOR (tem
)->contents
[XINT (last
)],
1628 XINT (elt
) | meta_modifier
);
1630 /* This new sequence is the same length as
1631 thisseq, so stick it in the list right
1634 = Fcons (Fcons (tem
, cmd
), XCDR (tail
));
1638 Fcons (Fcons (append_key (thisseq
, elt
), cmd
),
1649 /* Now find just the maps whose access prefixes start with PREFIX. */
1652 for (; CONSP (maps
); maps
= XCDR (maps
))
1654 Lisp_Object elt
, thisseq
;
1656 thisseq
= XCAR (elt
);
1657 /* The access prefix must be at least as long as PREFIX,
1658 and the first elements must match those of PREFIX. */
1659 if (XINT (Flength (thisseq
)) >= prefixlen
)
1662 for (i
= 0; i
< prefixlen
; i
++)
1665 XSETFASTINT (i1
, i
);
1666 if (!EQ (Faref (thisseq
, i1
), Faref (prefix
, i1
)))
1670 good_maps
= Fcons (elt
, good_maps
);
1674 return Fnreverse (good_maps
);
1678 accessible_keymaps_char_table (args
, index
, cmd
)
1679 Lisp_Object args
, index
, cmd
;
1682 Lisp_Object maps
, tail
, thisseq
;
1688 tail
= XCAR (XCDR (args
));
1689 thisseq
= XCDR (XCDR (args
));
1691 tem
= Fkeymapp (cmd
);
1694 cmd
= get_keymap (cmd
);
1695 /* Ignore keymaps that are already added to maps. */
1696 tem
= Frassq (cmd
, maps
);
1699 tem
= append_key (thisseq
, index
);
1700 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1705 Lisp_Object Qsingle_key_description
, Qkey_description
;
1707 /* This function cannot GC. */
1709 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 1, 0,
1710 "Return a pretty description of key-sequence KEYS.\n\
1711 Control characters turn into \"C-foo\" sequences, meta into \"M-foo\"\n\
1712 spaces are put between sequence elements, etc.")
1719 Lisp_Object
*args
= NULL
;
1724 vector
= Fmake_vector (Flength (keys
), Qnil
);
1725 for (i
= 0, i_byte
= 0; i
< XSTRING (keys
)->size
; )
1730 FETCH_STRING_CHAR_ADVANCE (c
, keys
, i
, i_byte
);
1731 if (SINGLE_BYTE_CHAR_P (c
) && (c
& 0200))
1732 c
^= 0200 | meta_modifier
;
1733 XSETFASTINT (XVECTOR (vector
)->contents
[i_before
], c
);
1740 /* In effect, this computes
1741 (mapconcat 'single-key-description keys " ")
1742 but we shouldn't use mapconcat because it can do GC. */
1744 len
= XVECTOR (keys
)->size
;
1745 sep
= build_string (" ");
1746 /* This has one extra element at the end that we don't pass to Fconcat. */
1747 args
= (Lisp_Object
*) alloca (len
* 2 * sizeof (Lisp_Object
));
1749 for (i
= 0; i
< len
; i
++)
1751 args
[i
* 2] = Fsingle_key_description (XVECTOR (keys
)->contents
[i
],
1753 args
[i
* 2 + 1] = sep
;
1756 else if (CONSP (keys
))
1758 /* In effect, this computes
1759 (mapconcat 'single-key-description keys " ")
1760 but we shouldn't use mapconcat because it can do GC. */
1762 len
= XFASTINT (Flength (keys
));
1763 sep
= build_string (" ");
1764 /* This has one extra element at the end that we don't pass to Fconcat. */
1765 args
= (Lisp_Object
*) alloca (len
* 2 * sizeof (Lisp_Object
));
1767 for (i
= 0; i
< len
; i
++)
1769 args
[i
* 2] = Fsingle_key_description (XCAR (keys
), Qnil
);
1770 args
[i
* 2 + 1] = sep
;
1775 keys
= wrong_type_argument (Qarrayp
, keys
);
1777 return Fconcat (len
* 2 - 1, args
);
1781 push_key_description (c
, p
)
1782 register unsigned int c
;
1787 /* Clear all the meaningless bits above the meta bit. */
1788 c
&= meta_modifier
| ~ - meta_modifier
;
1789 c2
= c
& ~(alt_modifier
| ctrl_modifier
| hyper_modifier
1790 | meta_modifier
| shift_modifier
| super_modifier
);
1792 if (c
& alt_modifier
)
1798 if ((c
& ctrl_modifier
) != 0
1799 || (c2
< ' ' && c2
!= 27 && c2
!= '\t' && c2
!= Ctl ('M')))
1803 c
&= ~ctrl_modifier
;
1805 if (c
& hyper_modifier
)
1809 c
-= hyper_modifier
;
1811 if (c
& meta_modifier
)
1817 if (c
& shift_modifier
)
1821 c
-= shift_modifier
;
1823 if (c
& super_modifier
)
1827 c
-= super_modifier
;
1843 else if (c
== Ctl ('M'))
1851 /* `C-' already added above. */
1852 if (c
> 0 && c
<= Ctl ('Z'))
1871 || (NILP (current_buffer
->enable_multibyte_characters
)
1872 && SINGLE_BYTE_CHAR_P (c
)))
1876 if (! NILP (current_buffer
->enable_multibyte_characters
))
1877 c
= unibyte_char_to_multibyte (c
);
1879 if (NILP (current_buffer
->enable_multibyte_characters
)
1880 || SINGLE_BYTE_CHAR_P (c
)
1881 || ! char_valid_p (c
, 0))
1885 /* The biggest character code uses 19 bits. */
1886 for (bit_offset
= 18; bit_offset
>= 0; bit_offset
-= 3)
1888 if (c
>= (1 << bit_offset
))
1889 *p
++ = ((c
& (7 << bit_offset
)) >> bit_offset
) + '0';
1894 p
+= CHAR_STRING (c
, p
);
1901 /* This function cannot GC. */
1903 DEFUN ("single-key-description", Fsingle_key_description
,
1904 Ssingle_key_description
, 1, 2, 0,
1905 "Return a pretty description of command character KEY.\n\
1906 Control characters turn into C-whatever, etc.\n\
1907 Optional argument NO-ANGLES non-nil means don't put angle brackets\n\
1908 around function keys and event symbols.")
1910 Lisp_Object key
, no_angles
;
1912 if (CONSP (key
) && lucid_event_type_list_p (key
))
1913 key
= Fevent_convert_list (key
);
1915 key
= EVENT_HEAD (key
);
1917 if (INTEGERP (key
)) /* Normal character */
1919 unsigned int charset
, c1
, c2
;
1920 int without_bits
= XINT (key
) & ~((-1) << CHARACTERBITS
);
1922 if (SINGLE_BYTE_CHAR_P (without_bits
))
1925 SPLIT_CHAR (without_bits
, charset
, c1
, c2
);
1928 && CHARSET_DEFINED_P (charset
)
1929 && ((c1
>= 0 && c1
< 32)
1930 || (c2
>= 0 && c2
< 32)))
1932 /* Handle a generic character. */
1934 name
= CHARSET_TABLE_INFO (charset
, CHARSET_LONG_NAME_IDX
);
1935 CHECK_STRING (name
, 0);
1936 return concat2 (build_string ("Character set "), name
);
1940 char tem
[KEY_DESCRIPTION_SIZE
];
1942 *push_key_description (XUINT (key
), tem
) = 0;
1943 return build_string (tem
);
1946 else if (SYMBOLP (key
)) /* Function key or event-symbol */
1948 if (NILP (no_angles
))
1951 = (char *) alloca (STRING_BYTES (XSYMBOL (key
)->name
) + 5);
1952 sprintf (buffer
, "<%s>", XSYMBOL (key
)->name
->data
);
1953 return build_string (buffer
);
1956 return Fsymbol_name (key
);
1958 else if (STRINGP (key
)) /* Buffer names in the menubar. */
1959 return Fcopy_sequence (key
);
1961 error ("KEY must be an integer, cons, symbol, or string");
1966 push_text_char_description (c
, p
)
1967 register unsigned int c
;
1979 *p
++ = c
+ 64; /* 'A' - 1 */
1991 /* This function cannot GC. */
1993 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
1994 "Return a pretty description of file-character CHARACTER.\n\
1995 Control characters turn into \"^char\", etc.")
1997 Lisp_Object character
;
1999 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2000 unsigned char str
[6];
2003 CHECK_NUMBER (character
, 0);
2005 c
= XINT (character
);
2006 if (!SINGLE_BYTE_CHAR_P (c
))
2008 int len
= CHAR_STRING (c
, str
);
2010 return make_multibyte_string (str
, 1, len
);
2013 *push_text_char_description (c
& 0377, str
) = 0;
2015 return build_string (str
);
2018 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
2021 ascii_sequence_p (seq
)
2025 int len
= XINT (Flength (seq
));
2027 for (i
= 0; i
< len
; i
++)
2029 Lisp_Object ii
, elt
;
2031 XSETFASTINT (ii
, i
);
2032 elt
= Faref (seq
, ii
);
2035 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
2043 /* where-is - finding a command in a set of keymaps. */
2045 static Lisp_Object
where_is_internal_1 ();
2046 static void where_is_internal_2 ();
2048 /* This function can GC if Flookup_key autoloads any keymaps. */
2054 return (CONSP (item
)
2055 && (EQ (XCAR (item
),Qmenu_item
)
2056 || STRINGP (XCAR (item
))));
2059 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 4, 0,
2060 "Return list of keys that invoke DEFINITION.\n\
2061 If KEYMAP is non-nil, search only KEYMAP and the global keymap.\n\
2062 If KEYMAP is nil, search all the currently active keymaps.\n\
2064 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,\n\
2065 rather than a list of all possible key sequences.\n\
2066 If FIRSTONLY is the symbol `non-ascii', return the first binding found,\n\
2067 no matter what it is.\n\
2068 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters,\n\
2069 and entirely reject menu bindings.\n\
2071 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections\n\
2072 to other keymaps or slots. This makes it possible to search for an\n\
2073 indirect definition itself.")
2074 (definition
, xkeymap
, firstonly
, noindirect
)
2075 Lisp_Object definition
, xkeymap
;
2076 Lisp_Object firstonly
, noindirect
;
2079 Lisp_Object found
, sequences
;
2080 Lisp_Object keymap1
;
2081 int keymap_specified
= !NILP (xkeymap
);
2082 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2083 /* 1 means ignore all menu bindings entirely. */
2084 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
2086 /* Find keymaps accessible from `keymap' or the current
2087 context. But don't muck with the value of `keymap',
2088 because `where_is_internal_1' uses it to check for
2089 shadowed bindings. */
2091 if (! keymap_specified
)
2092 keymap1
= get_local_map (PT
, current_buffer
, keymap
);
2094 if (!NILP (keymap1
))
2095 maps
= nconc2 (Faccessible_keymaps (get_keymap (keymap1
), Qnil
),
2096 Faccessible_keymaps (get_keymap (current_global_map
),
2101 if (! keymap_specified
)
2102 keymap1
= get_local_map (PT
, current_buffer
, local_map
);
2104 if (!NILP (keymap1
))
2105 maps
= nconc2 (Faccessible_keymaps (get_keymap (keymap1
), Qnil
),
2106 Faccessible_keymaps (get_keymap (current_global_map
),
2109 maps
= Faccessible_keymaps (get_keymap (current_global_map
), Qnil
);
2112 /* Put the minor mode keymaps on the front. */
2113 if (! keymap_specified
)
2116 minors
= Fnreverse (Fcurrent_minor_mode_maps ());
2117 while (!NILP (minors
))
2119 maps
= nconc2 (Faccessible_keymaps (get_keymap (XCAR (minors
)),
2122 minors
= XCDR (minors
);
2126 GCPRO5 (definition
, xkeymap
, maps
, found
, sequences
);
2130 for (; !NILP (maps
); maps
= Fcdr (maps
))
2132 /* Key sequence to reach map, and the map that it reaches */
2133 register Lisp_Object
this, map
;
2135 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2136 [M-CHAR] sequences, check if last character of the sequence
2137 is the meta-prefix char. */
2141 this = Fcar (Fcar (maps
));
2142 map
= Fcdr (Fcar (maps
));
2143 last
= make_number (XINT (Flength (this)) - 1);
2144 last_is_meta
= (XINT (last
) >= 0
2145 && EQ (Faref (this, last
), meta_prefix_char
));
2147 if (nomenus
&& XINT (last
) >= 0)
2148 { /* If no menu entries should be returned, skip over the
2149 keymaps bound to `menu-bar' and `tool-bar'. */
2150 Lisp_Object tem
= Faref (this, 0);
2151 if (EQ (tem
, Qmenu_bar
) || EQ (tem
, Qtool_bar
))
2159 /* Because the code we want to run on each binding is rather
2160 large, we don't want to have two separate loop bodies for
2161 sparse keymap bindings and tables; we want to iterate one
2162 loop body over both keymap and vector bindings.
2164 For this reason, if Fcar (map) is a vector, we don't
2165 advance map to the next element until i indicates that we
2166 have finished off the vector. */
2167 Lisp_Object elt
, key
, binding
;
2175 /* Set key and binding to the current key and binding, and
2176 advance map and i to the next binding. */
2179 Lisp_Object sequence
;
2181 /* In a vector, look at each element. */
2182 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2184 binding
= XVECTOR (elt
)->contents
[i
];
2185 XSETFASTINT (key
, i
);
2186 sequence
= where_is_internal_1 (binding
, key
, definition
,
2187 noindirect
, xkeymap
, this,
2188 last
, nomenus
, last_is_meta
);
2189 if (!NILP (sequence
))
2190 sequences
= Fcons (sequence
, sequences
);
2193 else if (CHAR_TABLE_P (elt
))
2195 Lisp_Object indices
[3];
2198 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2199 Fcons (xkeymap
, Qnil
)),
2200 Fcons (Fcons (this, last
),
2201 Fcons (make_number (nomenus
),
2202 make_number (last_is_meta
))));
2203 map_char_table (where_is_internal_2
, Qnil
, elt
, args
,
2205 sequences
= XCDR (XCDR (XCAR (args
)));
2207 else if (CONSP (elt
))
2209 Lisp_Object sequence
;
2212 binding
= XCDR (elt
);
2214 sequence
= where_is_internal_1 (binding
, key
, definition
,
2215 noindirect
, xkeymap
, this,
2216 last
, nomenus
, last_is_meta
);
2217 if (!NILP (sequence
))
2218 sequences
= Fcons (sequence
, sequences
);
2222 for (; ! NILP (sequences
); sequences
= XCDR (sequences
))
2224 Lisp_Object sequence
;
2226 sequence
= XCAR (sequences
);
2228 /* It is a true unshadowed match. Record it, unless it's already
2229 been seen (as could happen when inheriting keymaps). */
2230 if (NILP (Fmember (sequence
, found
)))
2231 found
= Fcons (sequence
, found
);
2233 /* If firstonly is Qnon_ascii, then we can return the first
2234 binding we find. If firstonly is not Qnon_ascii but not
2235 nil, then we should return the first ascii-only binding
2237 if (EQ (firstonly
, Qnon_ascii
))
2238 RETURN_UNGCPRO (sequence
);
2239 else if (! NILP (firstonly
) && ascii_sequence_p (sequence
))
2240 RETURN_UNGCPRO (sequence
);
2247 found
= Fnreverse (found
);
2249 /* firstonly may have been t, but we may have gone all the way through
2250 the keymaps without finding an all-ASCII key sequence. So just
2251 return the best we could find. */
2252 if (! NILP (firstonly
))
2253 return Fcar (found
);
2258 /* This is the function that Fwhere_is_internal calls using map_char_table.
2260 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2262 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2263 Since map_char_table doesn't really use the return value from this function,
2264 we the result append to RESULT, the slot in ARGS.
2266 This function can GC because it calls where_is_internal_1 which can
2270 where_is_internal_2 (args
, key
, binding
)
2271 Lisp_Object args
, key
, binding
;
2273 Lisp_Object definition
, noindirect
, keymap
, this, last
;
2274 Lisp_Object result
, sequence
;
2275 int nomenus
, last_is_meta
;
2276 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2278 GCPRO3 (args
, key
, binding
);
2279 result
= XCDR (XCDR (XCAR (args
)));
2280 definition
= XCAR (XCAR (XCAR (args
)));
2281 noindirect
= XCDR (XCAR (XCAR (args
)));
2282 keymap
= XCAR (XCDR (XCAR (args
)));
2283 this = XCAR (XCAR (XCDR (args
)));
2284 last
= XCDR (XCAR (XCDR (args
)));
2285 nomenus
= XFASTINT (XCAR (XCDR (XCDR (args
))));
2286 last_is_meta
= XFASTINT (XCDR (XCDR (XCDR (args
))));
2288 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
, keymap
,
2289 this, last
, nomenus
, last_is_meta
);
2291 if (!NILP (sequence
))
2292 XCDR (XCDR (XCAR (args
))) = Fcons (sequence
, result
);
2298 /* This function can GC.because Flookup_key calls get_keymap_1 with
2299 non-zero argument AUTOLOAD. */
2302 where_is_internal_1 (binding
, key
, definition
, noindirect
, keymap
, this, last
,
2303 nomenus
, last_is_meta
)
2304 Lisp_Object binding
, key
, definition
, noindirect
, keymap
, this, last
;
2305 int nomenus
, last_is_meta
;
2307 Lisp_Object sequence
;
2308 int keymap_specified
= !NILP (keymap
);
2309 struct gcpro gcpro1
, gcpro2
;
2311 /* Skip left-over menu-items.
2312 These can appear in a keymap bound to a mouse click, for example. */
2313 if (nomenus
&& menu_item_p (binding
))
2315 /* Search through indirections unless that's not wanted. */
2316 if (NILP (noindirect
))
2317 binding
= get_keyelt (binding
, 0);
2319 /* End this iteration if this element does not match
2322 if (CONSP (definition
))
2325 tem
= Fequal (binding
, definition
);
2330 if (!EQ (binding
, definition
))
2333 /* We have found a match.
2334 Construct the key sequence where we found it. */
2335 if (INTEGERP (key
) && last_is_meta
)
2337 sequence
= Fcopy_sequence (this);
2338 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2341 sequence
= append_key (this, key
);
2343 /* Verify that this key binding is not shadowed by another
2344 binding for the same key, before we say it exists.
2346 Mechanism: look for local definition of this key and if
2347 it is defined and does not match what we found then
2350 Either nil or number as value from Flookup_key
2352 GCPRO2 (sequence
, binding
);
2353 if (keymap_specified
)
2355 binding
= Flookup_key (keymap
, sequence
, Qnil
);
2356 if (!NILP (binding
) && !INTEGERP (binding
))
2358 if (CONSP (definition
))
2361 tem
= Fequal (binding
, definition
);
2363 RETURN_UNGCPRO (Qnil
);
2366 if (!EQ (binding
, definition
))
2367 RETURN_UNGCPRO (Qnil
);
2372 binding
= Fkey_binding (sequence
, Qnil
);
2373 if (!EQ (binding
, definition
))
2374 RETURN_UNGCPRO (Qnil
);
2377 RETURN_UNGCPRO (sequence
);
2380 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2382 DEFUN ("describe-bindings-internal", Fdescribe_bindings_internal
, Sdescribe_bindings_internal
, 0, 2, "",
2383 "Show a list of all defined keys, and their definitions.\n\
2384 We put that list in a buffer, and display the buffer.\n\
2386 The optional argument MENUS, if non-nil, says to mention menu bindings.\n\
2387 \(Ordinarily these are omitted from the output.)\n\
2388 The optional argument PREFIX, if non-nil, should be a key sequence;\n\
2389 then we display only bindings that start with that prefix.")
2391 Lisp_Object menus
, prefix
;
2393 register Lisp_Object thisbuf
;
2394 XSETBUFFER (thisbuf
, current_buffer
);
2395 internal_with_output_to_temp_buffer ("*Help*",
2396 describe_buffer_bindings
,
2397 list3 (thisbuf
, prefix
, menus
));
2401 /* ARG is (BUFFER PREFIX MENU-FLAG). */
2404 describe_buffer_bindings (arg
)
2407 Lisp_Object descbuf
, prefix
, shadow
;
2409 register Lisp_Object start1
;
2410 struct gcpro gcpro1
;
2412 char *alternate_heading
2414 Keyboard translations:\n\n\
2415 You type Translation\n\
2416 -------- -----------\n";
2418 descbuf
= XCAR (arg
);
2420 prefix
= XCAR (arg
);
2422 nomenu
= NILP (XCAR (arg
));
2427 Fset_buffer (Vstandard_output
);
2429 /* Report on alternates for keys. */
2430 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2433 unsigned char *translate
= XSTRING (Vkeyboard_translate_table
)->data
;
2434 int translate_len
= XSTRING (Vkeyboard_translate_table
)->size
;
2436 for (c
= 0; c
< translate_len
; c
++)
2437 if (translate
[c
] != c
)
2439 char buf
[KEY_DESCRIPTION_SIZE
];
2442 if (alternate_heading
)
2444 insert_string (alternate_heading
);
2445 alternate_heading
= 0;
2448 bufend
= push_key_description (translate
[c
], buf
);
2449 insert (buf
, bufend
- buf
);
2450 Findent_to (make_number (16), make_number (1));
2451 bufend
= push_key_description (c
, buf
);
2452 insert (buf
, bufend
- buf
);
2460 if (!NILP (Vkey_translation_map
))
2461 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2462 "Key translations", nomenu
, 1, 0);
2466 Lisp_Object
*modes
, *maps
;
2468 /* Temporarily switch to descbuf, so that we can get that buffer's
2469 minor modes correctly. */
2470 Fset_buffer (descbuf
);
2472 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
2473 || !NILP (Voverriding_local_map
))
2476 nmaps
= current_minor_maps (&modes
, &maps
);
2477 Fset_buffer (Vstandard_output
);
2479 /* Print the minor mode maps. */
2480 for (i
= 0; i
< nmaps
; i
++)
2482 /* The title for a minor mode keymap
2483 is constructed at run time.
2484 We let describe_map_tree do the actual insertion
2485 because it takes care of other features when doing so. */
2488 if (!SYMBOLP (modes
[i
]))
2491 p
= title
= (char *) alloca (42 + XSYMBOL (modes
[i
])->name
->size
);
2495 bcopy (XSYMBOL (modes
[i
])->name
->data
, p
,
2496 XSYMBOL (modes
[i
])->name
->size
);
2497 p
+= XSYMBOL (modes
[i
])->name
->size
;
2499 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2500 p
+= sizeof (" Minor Mode Bindings") - 1;
2503 describe_map_tree (maps
[i
], 1, shadow
, prefix
, title
, nomenu
, 0, 0);
2504 shadow
= Fcons (maps
[i
], shadow
);
2508 /* Print the (major mode) local map. */
2509 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2510 start1
= current_kboard
->Voverriding_terminal_local_map
;
2511 else if (!NILP (Voverriding_local_map
))
2512 start1
= Voverriding_local_map
;
2514 start1
= XBUFFER (descbuf
)->keymap
;
2518 describe_map_tree (start1
, 1, shadow
, prefix
,
2519 "\f\nMajor Mode Bindings", nomenu
, 0, 0);
2520 shadow
= Fcons (start1
, shadow
);
2523 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2524 "\f\nGlobal Bindings", nomenu
, 0, 1);
2526 /* Print the function-key-map translations under this prefix. */
2527 if (!NILP (Vfunction_key_map
))
2528 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2529 "\f\nFunction key map translations", nomenu
, 1, 0);
2531 call0 (intern ("help-mode"));
2532 Fset_buffer (descbuf
);
2537 /* Insert a description of the key bindings in STARTMAP,
2538 followed by those of all maps reachable through STARTMAP.
2539 If PARTIAL is nonzero, omit certain "uninteresting" commands
2540 (such as `undefined').
2541 If SHADOW is non-nil, it is a list of maps;
2542 don't mention keys which would be shadowed by any of them.
2543 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2544 TITLE, if not 0, is a string to insert at the beginning.
2545 TITLE should not end with a colon or a newline; we supply that.
2546 If NOMENU is not 0, then omit menu-bar commands.
2548 If TRANSL is nonzero, the definitions are actually key translations
2549 so print strings and vectors differently.
2551 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2555 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2557 Lisp_Object startmap
, shadow
, prefix
;
2564 Lisp_Object maps
, orig_maps
, seen
, sub_shadows
;
2565 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2572 orig_maps
= maps
= Faccessible_keymaps (startmap
, prefix
);
2575 GCPRO3 (maps
, seen
, sub_shadows
);
2581 /* Delete from MAPS each element that is for the menu bar. */
2582 for (list
= maps
; !NILP (list
); list
= XCDR (list
))
2584 Lisp_Object elt
, prefix
, tem
;
2587 prefix
= Fcar (elt
);
2588 if (XVECTOR (prefix
)->size
>= 1)
2590 tem
= Faref (prefix
, make_number (0));
2591 if (EQ (tem
, Qmenu_bar
))
2592 maps
= Fdelq (elt
, maps
);
2597 if (!NILP (maps
) || always_title
)
2601 insert_string (title
);
2604 insert_string (" Starting With ");
2605 insert1 (Fkey_description (prefix
));
2607 insert_string (":\n");
2609 insert_string (key_heading
);
2613 for (; !NILP (maps
); maps
= Fcdr (maps
))
2615 register Lisp_Object elt
, prefix
, tail
;
2618 prefix
= Fcar (elt
);
2622 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2626 shmap
= XCAR (tail
);
2628 /* If the sequence by which we reach this keymap is zero-length,
2629 then the shadow map for this keymap is just SHADOW. */
2630 if ((STRINGP (prefix
) && XSTRING (prefix
)->size
== 0)
2631 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
2633 /* If the sequence by which we reach this keymap actually has
2634 some elements, then the sequence's definition in SHADOW is
2635 what we should use. */
2638 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
2639 if (INTEGERP (shmap
))
2643 /* If shmap is not nil and not a keymap,
2644 it completely shadows this map, so don't
2645 describe this map at all. */
2646 if (!NILP (shmap
) && NILP (Fkeymapp (shmap
)))
2650 sub_shadows
= Fcons (shmap
, sub_shadows
);
2653 /* Maps we have already listed in this loop shadow this map. */
2654 for (tail
= orig_maps
; ! EQ (tail
, maps
); tail
= XCDR (tail
))
2657 tem
= Fequal (Fcar (XCAR (tail
)), prefix
);
2659 sub_shadows
= Fcons (XCDR (XCAR (tail
)), sub_shadows
);
2662 describe_map (Fcdr (elt
), prefix
,
2663 transl
? describe_translation
: describe_command
,
2664 partial
, sub_shadows
, &seen
, nomenu
);
2670 insert_string ("\n");
2675 static int previous_description_column
;
2678 describe_command (definition
)
2679 Lisp_Object definition
;
2681 register Lisp_Object tem1
;
2682 int column
= current_column ();
2683 int description_column
;
2685 /* If column 16 is no good, go to col 32;
2686 but don't push beyond that--go to next line instead. */
2690 description_column
= 32;
2692 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
2693 description_column
= 32;
2695 description_column
= 16;
2697 Findent_to (make_number (description_column
), make_number (1));
2698 previous_description_column
= description_column
;
2700 if (SYMBOLP (definition
))
2702 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2704 insert_string ("\n");
2706 else if (STRINGP (definition
) || VECTORP (definition
))
2707 insert_string ("Keyboard Macro\n");
2710 tem1
= Fkeymapp (definition
);
2712 insert_string ("Prefix Command\n");
2714 insert_string ("??\n");
2719 describe_translation (definition
)
2720 Lisp_Object definition
;
2722 register Lisp_Object tem1
;
2724 Findent_to (make_number (16), make_number (1));
2726 if (SYMBOLP (definition
))
2728 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2730 insert_string ("\n");
2732 else if (STRINGP (definition
) || VECTORP (definition
))
2734 insert1 (Fkey_description (definition
));
2735 insert_string ("\n");
2739 tem1
= Fkeymapp (definition
);
2741 insert_string ("Prefix Command\n");
2743 insert_string ("??\n");
2747 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2748 Returns the first non-nil binding found in any of those maps. */
2751 shadow_lookup (shadow
, key
, flag
)
2752 Lisp_Object shadow
, key
, flag
;
2754 Lisp_Object tail
, value
;
2756 for (tail
= shadow
; CONSP (tail
); tail
= XCDR (tail
))
2758 value
= Flookup_key (XCAR (tail
), key
, flag
);
2765 /* Describe the contents of map MAP, assuming that this map itself is
2766 reached by the sequence of prefix keys KEYS (a string or vector).
2767 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
2770 describe_map (map
, keys
, elt_describer
, partial
, shadow
, seen
, nomenu
)
2771 register Lisp_Object map
;
2773 void (*elt_describer
) P_ ((Lisp_Object
));
2779 Lisp_Object elt_prefix
;
2780 Lisp_Object tail
, definition
, event
;
2782 Lisp_Object suppress
;
2785 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2789 if (!NILP (keys
) && XFASTINT (Flength (keys
)) > 0)
2791 /* Call Fkey_description first, to avoid GC bug for the other string. */
2792 tem
= Fkey_description (keys
);
2793 elt_prefix
= concat2 (tem
, build_string (" "));
2799 suppress
= intern ("suppress-keymap");
2801 /* This vector gets used to present single keys to Flookup_key. Since
2802 that is done once per keymap element, we don't want to cons up a
2803 fresh vector every time. */
2804 kludge
= Fmake_vector (make_number (1), Qnil
);
2807 GCPRO3 (elt_prefix
, definition
, kludge
);
2809 for (tail
= map
; CONSP (tail
); tail
= XCDR (tail
))
2813 if (VECTORP (XCAR (tail
))
2814 || CHAR_TABLE_P (XCAR (tail
)))
2815 describe_vector (XCAR (tail
),
2816 elt_prefix
, elt_describer
, partial
, shadow
, map
,
2818 else if (CONSP (XCAR (tail
)))
2820 event
= XCAR (XCAR (tail
));
2822 /* Ignore bindings whose "keys" are not really valid events.
2823 (We get these in the frames and buffers menu.) */
2824 if (! (SYMBOLP (event
) || INTEGERP (event
)))
2827 if (nomenu
&& EQ (event
, Qmenu_bar
))
2830 definition
= get_keyelt (XCDR (XCAR (tail
)), 0);
2832 /* Don't show undefined commands or suppressed commands. */
2833 if (NILP (definition
)) continue;
2834 if (SYMBOLP (definition
) && partial
)
2836 tem
= Fget (definition
, suppress
);
2841 /* Don't show a command that isn't really visible
2842 because a local definition of the same key shadows it. */
2844 XVECTOR (kludge
)->contents
[0] = event
;
2847 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2848 if (!NILP (tem
)) continue;
2851 tem
= Flookup_key (map
, kludge
, Qt
);
2852 if (! EQ (tem
, definition
)) continue;
2856 previous_description_column
= 0;
2861 if (!NILP (elt_prefix
))
2862 insert1 (elt_prefix
);
2864 /* THIS gets the string to describe the character EVENT. */
2865 insert1 (Fsingle_key_description (event
, Qnil
));
2867 /* Print a description of the definition of this character.
2868 elt_describer will take care of spacing out far enough
2869 for alignment purposes. */
2870 (*elt_describer
) (definition
);
2872 else if (EQ (XCAR (tail
), Qkeymap
))
2874 /* The same keymap might be in the structure twice, if we're
2875 using an inherited keymap. So skip anything we've already
2877 tem
= Fassq (tail
, *seen
);
2878 if (CONSP (tem
) && !NILP (Fequal (XCAR (tem
), keys
)))
2880 *seen
= Fcons (Fcons (tail
, keys
), *seen
);
2888 describe_vector_princ (elt
)
2891 Findent_to (make_number (16), make_number (1));
2896 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 1, 0,
2897 "Insert a description of contents of VECTOR.\n\
2898 This is text showing the elements of vector matched against indices.")
2902 int count
= specpdl_ptr
- specpdl
;
2904 specbind (Qstandard_output
, Fcurrent_buffer ());
2905 CHECK_VECTOR_OR_CHAR_TABLE (vector
, 0);
2906 describe_vector (vector
, Qnil
, describe_vector_princ
, 0,
2907 Qnil
, Qnil
, (int *)0, 0);
2909 return unbind_to (count
, Qnil
);
2912 /* Insert in the current buffer a description of the contents of VECTOR.
2913 We call ELT_DESCRIBER to insert the description of one value found
2916 ELT_PREFIX describes what "comes before" the keys or indices defined
2917 by this vector. This is a human-readable string whose size
2918 is not necessarily related to the situation.
2920 If the vector is in a keymap, ELT_PREFIX is a prefix key which
2921 leads to this keymap.
2923 If the vector is a chartable, ELT_PREFIX is the vector
2924 of bytes that lead to the character set or portion of a character
2925 set described by this chartable.
2927 If PARTIAL is nonzero, it means do not mention suppressed commands
2928 (that assumes the vector is in a keymap).
2930 SHADOW is a list of keymaps that shadow this map.
2931 If it is non-nil, then we look up the key in those maps
2932 and we don't mention it now if it is defined by any of them.
2934 ENTIRE_MAP is the keymap in which this vector appears.
2935 If the definition in effect in the whole map does not match
2936 the one in this vector, we ignore this one.
2938 When describing a sub-char-table, INDICES is a list of
2939 indices at higher levels in this char-table,
2940 and CHAR_TABLE_DEPTH says how many levels down we have gone. */
2943 describe_vector (vector
, elt_prefix
, elt_describer
,
2944 partial
, shadow
, entire_map
,
2945 indices
, char_table_depth
)
2946 register Lisp_Object vector
;
2947 Lisp_Object elt_prefix
;
2948 void (*elt_describer
) P_ ((Lisp_Object
));
2951 Lisp_Object entire_map
;
2953 int char_table_depth
;
2955 Lisp_Object definition
;
2958 Lisp_Object suppress
;
2961 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2962 /* Range of elements to be handled. */
2964 /* A flag to tell if a leaf in this level of char-table is not a
2965 generic character (i.e. a complete multibyte character). */
2973 indices
= (int *) alloca (3 * sizeof (int));
2977 /* This vector gets used to present single keys to Flookup_key. Since
2978 that is done once per vector element, we don't want to cons up a
2979 fresh vector every time. */
2980 kludge
= Fmake_vector (make_number (1), Qnil
);
2981 GCPRO3 (elt_prefix
, definition
, kludge
);
2984 suppress
= intern ("suppress-keymap");
2986 if (CHAR_TABLE_P (vector
))
2988 if (char_table_depth
== 0)
2990 /* VECTOR is a top level char-table. */
2993 to
= CHAR_TABLE_ORDINARY_SLOTS
;
2997 /* VECTOR is a sub char-table. */
2998 if (char_table_depth
>= 3)
2999 /* A char-table is never that deep. */
3000 error ("Too deep char table");
3003 = (CHARSET_VALID_P (indices
[0])
3004 && ((CHARSET_DIMENSION (indices
[0]) == 1
3005 && char_table_depth
== 1)
3006 || char_table_depth
== 2));
3008 /* Meaningful elements are from 32th to 127th. */
3010 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
3015 /* This does the right thing for ordinary vectors. */
3019 to
= XVECTOR (vector
)->size
;
3022 for (i
= from
; i
< to
; i
++)
3026 if (CHAR_TABLE_P (vector
))
3028 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
3031 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
3032 && !CHARSET_DEFINED_P (i
- 128))
3036 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
3039 definition
= get_keyelt (XVECTOR (vector
)->contents
[i
], 0);
3041 if (NILP (definition
)) continue;
3043 /* Don't mention suppressed commands. */
3044 if (SYMBOLP (definition
) && partial
)
3048 tem
= Fget (definition
, suppress
);
3050 if (!NILP (tem
)) continue;
3053 /* Set CHARACTER to the character this entry describes, if any.
3054 Also update *INDICES. */
3055 if (CHAR_TABLE_P (vector
))
3057 indices
[char_table_depth
] = i
;
3059 if (char_table_depth
== 0)
3062 indices
[0] = i
- 128;
3064 else if (complete_char
)
3066 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3074 /* If this binding is shadowed by some other map, ignore it. */
3075 if (!NILP (shadow
) && complete_char
)
3079 XVECTOR (kludge
)->contents
[0] = make_number (character
);
3080 tem
= shadow_lookup (shadow
, kludge
, Qt
);
3082 if (!NILP (tem
)) continue;
3085 /* Ignore this definition if it is shadowed by an earlier
3086 one in the same keymap. */
3087 if (!NILP (entire_map
) && complete_char
)
3091 XVECTOR (kludge
)->contents
[0] = make_number (character
);
3092 tem
= Flookup_key (entire_map
, kludge
, Qt
);
3094 if (! EQ (tem
, definition
))
3100 if (char_table_depth
== 0)
3105 /* For a sub char-table, show the depth by indentation.
3106 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3107 if (char_table_depth
> 0)
3108 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
3110 /* Output the prefix that applies to every entry in this map. */
3111 if (!NILP (elt_prefix
))
3112 insert1 (elt_prefix
);
3114 /* Insert or describe the character this slot is for,
3115 or a description of what it is for. */
3116 if (SUB_CHAR_TABLE_P (vector
))
3119 insert_char (character
);
3122 /* We need an octal representation for this block of
3125 sprintf (work
, "(row %d)", i
);
3126 insert (work
, strlen (work
));
3129 else if (CHAR_TABLE_P (vector
))
3132 insert1 (Fsingle_key_description (make_number (character
), Qnil
));
3135 /* Print the information for this character set. */
3136 insert_string ("<");
3137 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
3139 insert_from_string (tem2
, 0, 0, XSTRING (tem2
)->size
,
3140 STRING_BYTES (XSTRING (tem2
)), 0);
3148 insert1 (Fsingle_key_description (make_number (character
), Qnil
));
3151 /* If we find a sub char-table within a char-table,
3152 scan it recursively; it defines the details for
3153 a character set or a portion of a character set. */
3154 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
3157 describe_vector (definition
, elt_prefix
, elt_describer
,
3158 partial
, shadow
, entire_map
,
3159 indices
, char_table_depth
+ 1);
3165 /* Find all consecutive characters or rows that have the same
3166 definition. But, for elements of a top level char table, if
3167 they are for charsets, we had better describe one by one even
3168 if they have the same definition. */
3169 if (CHAR_TABLE_P (vector
))
3173 if (char_table_depth
== 0)
3174 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
3176 while (i
+ 1 < limit
3177 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
3179 && !NILP (Fequal (tem2
, definition
)))
3184 && (tem2
= get_keyelt (XVECTOR (vector
)->contents
[i
+ 1], 0),
3186 && !NILP (Fequal (tem2
, definition
)))
3190 /* If we have a range of more than one character,
3191 print where the range reaches to. */
3193 if (i
!= starting_i
)
3197 if (!NILP (elt_prefix
))
3198 insert1 (elt_prefix
);
3200 if (CHAR_TABLE_P (vector
))
3202 if (char_table_depth
== 0)
3204 insert1 (Fsingle_key_description (make_number (i
), Qnil
));
3206 else if (complete_char
)
3208 indices
[char_table_depth
] = i
;
3209 character
= MAKE_CHAR (indices
[0], indices
[1], indices
[2]);
3210 insert_char (character
);
3214 /* We need an octal representation for this block of
3217 sprintf (work
, "(row %d)", i
);
3218 insert (work
, strlen (work
));
3223 insert1 (Fsingle_key_description (make_number (i
), Qnil
));
3227 /* Print a description of the definition of this character.
3228 elt_describer will take care of spacing out far enough
3229 for alignment purposes. */
3230 (*elt_describer
) (definition
);
3233 /* For (sub) char-table, print `defalt' slot at last. */
3234 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3236 insert (" ", char_table_depth
* 2);
3237 insert_string ("<<default>>");
3238 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
);
3244 /* Apropos - finding all symbols whose names match a regexp. */
3245 Lisp_Object apropos_predicate
;
3246 Lisp_Object apropos_accumulate
;
3249 apropos_accum (symbol
, string
)
3250 Lisp_Object symbol
, string
;
3252 register Lisp_Object tem
;
3254 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3255 if (!NILP (tem
) && !NILP (apropos_predicate
))
3256 tem
= call1 (apropos_predicate
, symbol
);
3258 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3261 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3262 "Show all symbols whose names contain match for REGEXP.\n\
3263 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done\n\
3264 for each symbol and a symbol is mentioned only if that returns non-nil.\n\
3265 Return list of symbols found.")
3267 Lisp_Object regexp
, predicate
;
3269 struct gcpro gcpro1
, gcpro2
;
3270 CHECK_STRING (regexp
, 0);
3271 apropos_predicate
= predicate
;
3272 GCPRO2 (apropos_predicate
, apropos_accumulate
);
3273 apropos_accumulate
= Qnil
;
3274 map_obarray (Vobarray
, apropos_accum
, regexp
);
3275 apropos_accumulate
= Fsort (apropos_accumulate
, Qstring_lessp
);
3277 return apropos_accumulate
;
3283 Qkeymap
= intern ("keymap");
3284 staticpro (&Qkeymap
);
3286 /* Now we are ready to set up this property, so we can
3287 create char tables. */
3288 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3290 /* Initialize the keymaps standardly used.
3291 Each one is the value of a Lisp variable, and is also
3292 pointed to by a C variable */
3294 global_map
= Fmake_keymap (Qnil
);
3295 Fset (intern ("global-map"), global_map
);
3297 current_global_map
= global_map
;
3298 staticpro (&global_map
);
3299 staticpro (¤t_global_map
);
3301 meta_map
= Fmake_keymap (Qnil
);
3302 Fset (intern ("esc-map"), meta_map
);
3303 Ffset (intern ("ESC-prefix"), meta_map
);
3305 control_x_map
= Fmake_keymap (Qnil
);
3306 Fset (intern ("ctl-x-map"), control_x_map
);
3307 Ffset (intern ("Control-X-prefix"), control_x_map
);
3309 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3310 "List of commands given new key bindings recently.\n\
3311 This is used for internal purposes during Emacs startup;\n\
3312 don't alter it yourself.");
3313 Vdefine_key_rebound_commands
= Qt
;
3315 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3316 "Default keymap to use when reading from the minibuffer.");
3317 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3319 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3320 "Local keymap for the minibuffer when spaces are not allowed.");
3321 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3323 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3324 "Local keymap for minibuffer input with completion.");
3325 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3327 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3328 "Local keymap for minibuffer input with completion, for exact match.");
3329 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3331 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3332 "Alist of keymaps to use for minor modes.\n\
3333 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read\n\
3334 key sequences and look up bindings iff VARIABLE's value is non-nil.\n\
3335 If two active keymaps bind the same key, the keymap appearing earlier\n\
3336 in the list takes precedence.");
3337 Vminor_mode_map_alist
= Qnil
;
3339 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3340 "Alist of keymaps to use for minor modes, in current major mode.\n\
3341 This variable is a alist just like `minor-mode-map-alist', and it is\n\
3342 used the same way (and before `minor-mode-map-alist'); however,\n\
3343 it is provided for major modes to bind locally.");
3344 Vminor_mode_overriding_map_alist
= Qnil
;
3346 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3347 "Keymap mapping ASCII function key sequences onto their preferred forms.\n\
3348 This allows Emacs to recognize function keys sent from ASCII\n\
3349 terminals at any point in a key sequence.\n\
3351 The `read-key-sequence' function replaces any subsequence bound by\n\
3352 `function-key-map' with its binding. More precisely, when the active\n\
3353 keymaps have no binding for the current key sequence but\n\
3354 `function-key-map' binds a suffix of the sequence to a vector or string,\n\
3355 `read-key-sequence' replaces the matching suffix with its binding, and\n\
3356 continues with the new sequence.\n\
3358 The events that come from bindings in `function-key-map' are not\n\
3359 themselves looked up in `function-key-map'.\n\
3361 For example, suppose `function-key-map' binds `ESC O P' to [f1].\n\
3362 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing\n\
3363 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix\n\
3364 key, typing `ESC O P x' would return [f1 x].");
3365 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3367 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3368 "Keymap of key translations that can override keymaps.\n\
3369 This keymap works like `function-key-map', but comes after that,\n\
3370 and applies even for keys that have ordinary bindings.");
3371 Vkey_translation_map
= Qnil
;
3373 Qsingle_key_description
= intern ("single-key-description");
3374 staticpro (&Qsingle_key_description
);
3376 Qkey_description
= intern ("key-description");
3377 staticpro (&Qkey_description
);
3379 Qkeymapp
= intern ("keymapp");
3380 staticpro (&Qkeymapp
);
3382 Qnon_ascii
= intern ("non-ascii");
3383 staticpro (&Qnon_ascii
);
3385 Qmenu_item
= intern ("menu-item");
3386 staticpro (&Qmenu_item
);
3388 defsubr (&Skeymapp
);
3389 defsubr (&Skeymap_parent
);
3390 defsubr (&Sset_keymap_parent
);
3391 defsubr (&Smake_keymap
);
3392 defsubr (&Smake_sparse_keymap
);
3393 defsubr (&Scopy_keymap
);
3394 defsubr (&Skey_binding
);
3395 defsubr (&Slocal_key_binding
);
3396 defsubr (&Sglobal_key_binding
);
3397 defsubr (&Sminor_mode_key_binding
);
3398 defsubr (&Sdefine_key
);
3399 defsubr (&Slookup_key
);
3400 defsubr (&Sdefine_prefix_command
);
3401 defsubr (&Suse_global_map
);
3402 defsubr (&Suse_local_map
);
3403 defsubr (&Scurrent_local_map
);
3404 defsubr (&Scurrent_global_map
);
3405 defsubr (&Scurrent_minor_mode_maps
);
3406 defsubr (&Saccessible_keymaps
);
3407 defsubr (&Skey_description
);
3408 defsubr (&Sdescribe_vector
);
3409 defsubr (&Ssingle_key_description
);
3410 defsubr (&Stext_char_description
);
3411 defsubr (&Swhere_is_internal
);
3412 defsubr (&Sdescribe_bindings_internal
);
3413 defsubr (&Sapropos_internal
);
3419 initial_define_key (global_map
, 033, "ESC-prefix");
3420 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");