1 /* Manipulation of keymaps
2 Copyright (C) 1985, 86, 87, 88, 93, 94, 95 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"
33 #define min(a, b) ((a) < (b) ? (a) : (b))
35 /* The number of elements in keymap vectors. */
36 #define DENSE_TABLE_SIZE (0200)
38 /* Actually allocate storage for these variables */
40 Lisp_Object current_global_map
; /* Current global keymap */
42 Lisp_Object global_map
; /* default global key bindings */
44 Lisp_Object meta_map
; /* The keymap used for globally bound
45 ESC-prefixed default commands */
47 Lisp_Object control_x_map
; /* The keymap used for globally bound
48 C-x-prefixed default commands */
50 /* was MinibufLocalMap */
51 Lisp_Object Vminibuffer_local_map
;
52 /* The keymap used by the minibuf for local
53 bindings when spaces are allowed in the
56 /* was MinibufLocalNSMap */
57 Lisp_Object Vminibuffer_local_ns_map
;
58 /* The keymap used by the minibuf for local
59 bindings when spaces are not encouraged
62 /* keymap used for minibuffers when doing completion */
63 /* was MinibufLocalCompletionMap */
64 Lisp_Object Vminibuffer_local_completion_map
;
66 /* keymap used for minibuffers when doing completion and require a match */
67 /* was MinibufLocalMustMatchMap */
68 Lisp_Object Vminibuffer_local_must_match_map
;
70 /* Alist of minor mode variables and keymaps. */
71 Lisp_Object Vminor_mode_map_alist
;
73 /* Keymap mapping ASCII function key sequences onto their preferred forms.
74 Initialized by the terminal-specific lisp files. See DEFVAR for more
76 Lisp_Object Vfunction_key_map
;
78 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
79 Lisp_Object Vkey_translation_map
;
81 /* A list of all commands given new bindings since a certain time
82 when nil was stored here.
83 This is used to speed up recomputation of menu key equivalents
84 when Emacs starts up. t means don't record anything here. */
85 Lisp_Object Vdefine_key_rebound_commands
;
87 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
;
89 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
90 in a string key sequence is equivalent to prefixing with this
92 extern Lisp_Object meta_prefix_char
;
94 extern Lisp_Object Voverriding_local_map
;
96 static Lisp_Object
define_as_prefix ();
97 static Lisp_Object
describe_buffer_bindings ();
98 static void describe_command (), describe_translation ();
99 static void describe_map ();
101 /* Keymap object support - constructors and predicates. */
103 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
104 "Construct and return a new keymap, of the form (keymap VECTOR . ALIST).\n\
105 VECTOR is a vector which holds the bindings for the ASCII\n\
106 characters. ALIST is an assoc-list which holds bindings for function keys,\n\
107 mouse events, and any other things that appear in the input stream.\n\
108 All entries in it are initially nil, meaning \"command undefined\".\n\n\
109 The optional arg STRING supplies a menu name for the keymap\n\
110 in case you use it as a menu with `x-popup-menu'.")
116 tail
= Fcons (string
, Qnil
);
119 return Fcons (Qkeymap
,
120 Fcons (Fmake_vector (make_number (DENSE_TABLE_SIZE
), Qnil
),
124 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
125 "Construct and return a new sparse-keymap list.\n\
126 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),\n\
127 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),\n\
128 which binds the function key or mouse event SYMBOL to DEFINITION.\n\
129 Initially the alist is nil.\n\n\
130 The optional arg STRING supplies a menu name for the keymap\n\
131 in case you use it as a menu with `x-popup-menu'.")
136 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
137 return Fcons (Qkeymap
, Qnil
);
140 /* This function is used for installing the standard key bindings
141 at initialization time.
145 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
148 initial_define_key (keymap
, key
, defname
)
153 store_in_keymap (keymap
, make_number (key
), intern (defname
));
157 initial_define_lispy_key (keymap
, keyname
, defname
)
162 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
165 /* Define character fromchar in map frommap as an alias for character
166 tochar in map tomap. Subsequent redefinitions of the latter WILL
167 affect the former. */
171 synkey (frommap
, fromchar
, tomap
, tochar
)
172 struct Lisp_Vector
*frommap
, *tomap
;
173 int fromchar
, tochar
;
176 XSETVECTOR (v
, tomap
);
177 XSETFASTINT (c
, tochar
);
178 frommap
->contents
[fromchar
] = Fcons (v
, c
);
182 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
183 "Return t if OBJECT is a keymap.\n\
185 A keymap is a list (keymap . ALIST),\n\
186 or a symbol whose function definition is itself a keymap.\n\
187 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
188 a vector of densely packed bindings for small character codes\n\
189 is also allowed as an element.")
193 return (NILP (get_keymap_1 (object
, 0, 0)) ? Qnil
: Qt
);
196 /* Check that OBJECT is a keymap (after dereferencing through any
197 symbols). If it is, return it.
199 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
200 is an autoload form, do the autoload and try again.
201 If AUTOLOAD is nonzero, callers must assume GC is possible.
203 ERROR controls how we respond if OBJECT isn't a keymap.
204 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
206 Note that most of the time, we don't want to pursue autoloads.
207 Functions like Faccessible_keymaps which scan entire keymap trees
208 shouldn't load every autoloaded keymap. I'm not sure about this,
209 but it seems to me that only read_key_sequence, Flookup_key, and
210 Fdefine_key should cause keymaps to be autoloaded. */
213 get_keymap_1 (object
, error
, autoload
)
220 tem
= indirect_function (object
);
221 if (CONSP (tem
) && EQ (XCONS (tem
)->car
, Qkeymap
))
224 /* Should we do an autoload? Autoload forms for keymaps have
225 Qkeymap as their fifth element. */
229 && EQ (XCONS (tem
)->car
, Qautoload
))
233 tail
= Fnth (make_number (4), tem
);
234 if (EQ (tail
, Qkeymap
))
236 struct gcpro gcpro1
, gcpro2
;
238 GCPRO2 (tem
, object
);
239 do_autoload (tem
, object
);
247 wrong_type_argument (Qkeymapp
, object
);
253 /* Follow any symbol chaining, and return the keymap denoted by OBJECT.
254 If OBJECT doesn't denote a keymap at all, signal an error. */
259 return get_keymap_1 (object
, 1, 0);
262 /* Return the parent map of the keymap MAP, or nil if it has none.
263 We assume that MAP is a valid keymap. */
265 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
266 "Return the parent keymap of KEYMAP.")
272 keymap
= get_keymap_1 (keymap
, 1, 1);
274 /* Skip past the initial element `keymap'. */
275 list
= XCONS (keymap
)->cdr
;
276 for (; CONSP (list
); list
= XCONS (list
)->cdr
)
278 /* See if there is another `keymap'. */
279 if (EQ (Qkeymap
, XCONS (list
)->car
))
286 /* Set the parent keymap of MAP to PARENT. */
288 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
289 "Modify KEYMAP to set its parent map to PARENT.\n\
290 PARENT should be nil or another keymap.")
292 Lisp_Object keymap
, parent
;
294 Lisp_Object list
, prev
;
297 keymap
= get_keymap_1 (keymap
, 1, 1);
299 parent
= get_keymap_1 (parent
, 1, 1);
301 /* Skip past the initial element `keymap'. */
305 list
= XCONS (prev
)->cdr
;
306 /* If there is a parent keymap here, replace it.
307 If we came to the end, add the parent in PREV. */
308 if (! CONSP (list
) || EQ (Qkeymap
, XCONS (list
)->car
))
310 XCONS (prev
)->cdr
= parent
;
316 /* Scan through for submaps, and set their parents too. */
318 for (list
= XCONS (keymap
)->cdr
; CONSP (list
); list
= XCONS (list
)->cdr
)
320 /* Stop the scan when we come to the parent. */
321 if (EQ (XCONS (list
)->car
, Qkeymap
))
324 /* If this element holds a prefix map, deal with it. */
325 if (CONSP (XCONS (list
)->car
)
326 && CONSP (XCONS (XCONS (list
)->car
)->cdr
))
327 fix_submap_inheritance (keymap
, XCONS (XCONS (list
)->car
)->car
,
328 XCONS (XCONS (list
)->car
)->cdr
);
330 if (VECTORP (XCONS (list
)->car
))
331 for (i
= 0; i
< XVECTOR (XCONS (list
)->car
)->size
; i
++)
332 if (CONSP (XVECTOR (XCONS (list
)->car
)->contents
[i
]))
333 fix_submap_inheritance (keymap
, make_number (i
),
334 XVECTOR (XCONS (list
)->car
)->contents
[i
]);
340 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
341 if EVENT is also a prefix in MAP's parent,
342 make sure that SUBMAP inherits that definition as its own parent. */
344 fix_submap_inheritance (map
, event
, submap
)
345 Lisp_Object map
, event
, submap
;
347 Lisp_Object map_parent
, parent_entry
;
349 /* SUBMAP is a cons that we found as a key binding.
350 Discard the other things found in a menu key binding. */
353 && STRINGP (XCONS (submap
)->car
))
355 submap
= XCONS (submap
)->cdr
;
356 /* Also remove a menu help string, if any,
357 following the menu item name. */
358 if (CONSP (submap
) && STRINGP (XCONS (submap
)->car
))
359 submap
= XCONS (submap
)->cdr
;
360 /* Also remove the sublist that caches key equivalences, if any. */
362 && CONSP (XCONS (submap
)->car
))
365 carcar
= XCONS (XCONS (submap
)->car
)->car
;
366 if (NILP (carcar
) || VECTORP (carcar
))
367 submap
= XCONS (submap
)->cdr
;
371 /* If it isn't a keymap now, there's no work to do. */
373 || ! EQ (XCONS (submap
)->car
, Qkeymap
))
376 map_parent
= Fkeymap_parent (map
);
377 if (! NILP (map_parent
))
378 parent_entry
= access_keymap (map_parent
, event
, 0, 0);
382 /* If MAP's parent has something other than a keymap,
383 our own submap shadows it completely, so use nil as SUBMAP's parent. */
384 if (! (CONSP (parent_entry
) && EQ (XCONS (parent_entry
)->car
, Qkeymap
)))
387 if (! EQ (parent_entry
, submap
))
388 Fset_keymap_parent (submap
, parent_entry
);
391 /* Look up IDX in MAP. IDX may be any sort of event.
392 Note that this does only one level of lookup; IDX must be a single
393 event, not a sequence.
395 If T_OK is non-zero, bindings for Qt are treated as default
396 bindings; any key left unmentioned by other tables and bindings is
397 given the binding of Qt.
399 If T_OK is zero, bindings for Qt are not treated specially.
401 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
404 access_keymap (map
, idx
, t_ok
, noinherit
)
413 /* If idx is a list (some sort of mouse click, perhaps?),
414 the index we want to use is the car of the list, which
415 ought to be a symbol. */
416 idx
= EVENT_HEAD (idx
);
418 /* If idx is a symbol, it might have modifiers, which need to
419 be put in the canonical order. */
421 idx
= reorder_modifiers (idx
);
422 else if (INTEGERP (idx
))
423 /* Clobber the high bits that can be present on a machine
424 with more than 24 bits of integer. */
425 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
429 Lisp_Object t_binding
;
432 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
436 binding
= XCONS (tail
)->car
;
437 if (SYMBOLP (binding
))
439 /* If NOINHERIT, stop finding prefix definitions
440 after we pass a second occurrence of the `keymap' symbol. */
441 if (noinherit
&& EQ (binding
, Qkeymap
) && ! EQ (tail
, map
))
444 else if (CONSP (binding
))
446 if (EQ (XCONS (binding
)->car
, idx
))
448 val
= XCONS (binding
)->cdr
;
449 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
452 fix_submap_inheritance (map
, idx
, val
);
455 if (t_ok
&& EQ (XCONS (binding
)->car
, Qt
))
456 t_binding
= XCONS (binding
)->cdr
;
458 else if (VECTORP (binding
))
460 if (NATNUMP (idx
) && XFASTINT (idx
) < XVECTOR (binding
)->size
)
462 val
= XVECTOR (binding
)->contents
[XFASTINT (idx
)];
463 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
466 fix_submap_inheritance (map
, idx
, val
);
478 /* Given OBJECT which was found in a slot in a keymap,
479 trace indirect definitions to get the actual definition of that slot.
480 An indirect definition is a list of the form
481 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
482 and INDEX is the object to look up in KEYMAP to yield the definition.
484 Also if OBJECT has a menu string as the first element,
485 remove that. Also remove a menu help string as second element.
487 If AUTOLOAD is nonzero, load autoloadable keymaps
488 that are referred to with indirection. */
491 get_keyelt (object
, autoload
)
492 register Lisp_Object object
;
497 register Lisp_Object map
, tem
;
499 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
500 map
= get_keymap_1 (Fcar_safe (object
), 0, autoload
);
501 tem
= Fkeymapp (map
);
503 object
= access_keymap (map
, Fcdr (object
), 0, 0);
505 /* If the keymap contents looks like (STRING . DEFN),
507 Keymap alist elements like (CHAR MENUSTRING . DEFN)
508 will be used by HierarKey menus. */
509 else if (CONSP (object
)
510 && STRINGP (XCONS (object
)->car
))
512 object
= XCONS (object
)->cdr
;
513 /* Also remove a menu help string, if any,
514 following the menu item name. */
515 if (CONSP (object
) && STRINGP (XCONS (object
)->car
))
516 object
= XCONS (object
)->cdr
;
517 /* Also remove the sublist that caches key equivalences, if any. */
519 && CONSP (XCONS (object
)->car
))
522 carcar
= XCONS (XCONS (object
)->car
)->car
;
523 if (NILP (carcar
) || VECTORP (carcar
))
524 object
= XCONS (object
)->cdr
;
529 /* Anything else is really the value. */
535 store_in_keymap (keymap
, idx
, def
)
537 register Lisp_Object idx
;
538 register Lisp_Object def
;
540 /* If we are preparing to dump, and DEF is a menu element
541 with a menu item string, copy it to ensure it is not pure. */
542 if (CONSP (def
) && PURE_P (def
) && STRINGP (XCONS (def
)->car
))
543 def
= Fcons (XCONS (def
)->car
, XCONS (def
)->cdr
);
545 if (!CONSP (keymap
) || ! EQ (XCONS (keymap
)->car
, Qkeymap
))
546 error ("attempt to define a key in a non-keymap");
548 /* If idx is a list (some sort of mouse click, perhaps?),
549 the index we want to use is the car of the list, which
550 ought to be a symbol. */
551 idx
= EVENT_HEAD (idx
);
553 /* If idx is a symbol, it might have modifiers, which need to
554 be put in the canonical order. */
556 idx
= reorder_modifiers (idx
);
557 else if (INTEGERP (idx
))
558 /* Clobber the high bits that can be present on a machine
559 with more than 24 bits of integer. */
560 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
562 /* Scan the keymap for a binding of idx. */
566 /* The cons after which we should insert new bindings. If the
567 keymap has a table element, we record its position here, so new
568 bindings will go after it; this way, the table will stay
569 towards the front of the alist and character lookups in dense
570 keymaps will remain fast. Otherwise, this just points at the
571 front of the keymap. */
572 Lisp_Object insertion_point
;
574 insertion_point
= keymap
;
575 for (tail
= XCONS (keymap
)->cdr
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
579 elt
= XCONS (tail
)->car
;
582 if (NATNUMP (idx
) && XFASTINT (idx
) < XVECTOR (elt
)->size
)
584 XVECTOR (elt
)->contents
[XFASTINT (idx
)] = def
;
587 insertion_point
= tail
;
589 else if (CONSP (elt
))
591 if (EQ (idx
, XCONS (elt
)->car
))
593 XCONS (elt
)->cdr
= def
;
597 else if (SYMBOLP (elt
))
599 /* If we find a 'keymap' symbol in the spine of KEYMAP,
600 then we must have found the start of a second keymap
601 being used as the tail of KEYMAP, and a binding for IDX
602 should be inserted before it. */
603 if (EQ (elt
, Qkeymap
))
611 /* We have scanned the entire keymap, and not found a binding for
612 IDX. Let's add one. */
613 XCONS (insertion_point
)->cdr
614 = Fcons (Fcons (idx
, def
), XCONS (insertion_point
)->cdr
);
621 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
622 "Return a copy of the keymap KEYMAP.\n\
623 The copy starts out with the same definitions of KEYMAP,\n\
624 but changing either the copy or KEYMAP does not affect the other.\n\
625 Any key definitions that are subkeymaps are recursively copied.\n\
626 However, a key definition which is a symbol whose definition is a keymap\n\
631 register Lisp_Object copy
, tail
;
633 copy
= Fcopy_alist (get_keymap (keymap
));
635 for (tail
= copy
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
639 elt
= XCONS (tail
)->car
;
644 elt
= Fcopy_sequence (elt
);
645 XCONS (tail
)->car
= elt
;
647 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
648 if (!SYMBOLP (XVECTOR (elt
)->contents
[i
])
649 && ! NILP (Fkeymapp (XVECTOR (elt
)->contents
[i
])))
650 XVECTOR (elt
)->contents
[i
] =
651 Fcopy_keymap (XVECTOR (elt
)->contents
[i
]);
653 else if (CONSP (elt
))
655 /* Skip the optional menu string. */
656 if (CONSP (XCONS (elt
)->cdr
)
657 && STRINGP (XCONS (XCONS (elt
)->cdr
)->car
))
661 /* Copy the cell, since copy-alist didn't go this deep. */
662 XCONS (elt
)->cdr
= Fcons (XCONS (XCONS (elt
)->cdr
)->car
,
663 XCONS (XCONS (elt
)->cdr
)->cdr
);
664 elt
= XCONS (elt
)->cdr
;
666 /* Also skip the optional menu help string. */
667 if (CONSP (XCONS (elt
)->cdr
)
668 && STRINGP (XCONS (XCONS (elt
)->cdr
)->car
))
670 XCONS (elt
)->cdr
= Fcons (XCONS (XCONS (elt
)->cdr
)->car
,
671 XCONS (XCONS (elt
)->cdr
)->cdr
);
672 elt
= XCONS (elt
)->cdr
;
674 /* There may also be a list that caches key equivalences.
675 Just delete it for the new keymap. */
676 if (CONSP (XCONS (elt
)->cdr
)
677 && CONSP (XCONS (XCONS (elt
)->cdr
)->car
)
678 && (NILP (tem
= XCONS (XCONS (XCONS (elt
)->cdr
)->car
)->car
)
680 XCONS (elt
)->cdr
= XCONS (XCONS (elt
)->cdr
)->cdr
;
683 && ! SYMBOLP (XCONS (elt
)->cdr
)
684 && ! NILP (Fkeymapp (XCONS (elt
)->cdr
)))
685 XCONS (elt
)->cdr
= Fcopy_keymap (XCONS (elt
)->cdr
);
692 /* Simple Keymap mutators and accessors. */
694 /* GC is possible in this function if it autoloads a keymap. */
696 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
697 "Args KEYMAP, KEY, DEF. Define key sequence KEY, in KEYMAP, as DEF.\n\
698 KEYMAP is a keymap. KEY is a string or a vector of symbols and characters\n\
699 meaning a sequence of keystrokes and events.\n\
700 Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
701 can be included if you use a vector.\n\
702 DEF is anything that can be a key's definition:\n\
703 nil (means key is undefined in this keymap),\n\
704 a command (a Lisp function suitable for interactive calling)\n\
705 a string (treated as a keyboard macro),\n\
706 a keymap (to define a prefix key),\n\
707 a symbol. When the key is looked up, the symbol will stand for its\n\
708 function definition, which should at that time be one of the above,\n\
709 or another symbol whose function definition is used, etc.\n\
710 a cons (STRING . DEFN), meaning that DEFN is the definition\n\
711 (DEFN should be a valid definition in its own right),\n\
712 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.\n\
714 If KEYMAP is a sparse keymap, the pair binding KEY to DEF is added at\n\
715 the front of KEYMAP.")
722 register Lisp_Object c
;
723 register Lisp_Object tem
;
724 register Lisp_Object cmd
;
728 struct gcpro gcpro1
, gcpro2
, gcpro3
;
730 keymap
= get_keymap_1 (keymap
, 1, 1);
732 if (!VECTORP (key
) && !STRINGP (key
))
733 key
= wrong_type_argument (Qarrayp
, key
);
735 length
= XFASTINT (Flength (key
));
739 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
740 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
742 GCPRO3 (keymap
, key
, def
);
745 meta_bit
= meta_modifier
;
752 c
= Faref (key
, make_number (idx
));
754 if (CONSP (c
) && lucid_event_type_list_p (c
))
755 c
= Fevent_convert_list (c
);
758 && (XINT (c
) & meta_bit
)
761 c
= meta_prefix_char
;
767 XSETINT (c
, XINT (c
) & ~meta_bit
);
773 if (! INTEGERP (c
) && ! SYMBOLP (c
) && ! CONSP (c
))
774 error ("Key sequence contains invalid events");
777 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
779 cmd
= get_keyelt (access_keymap (keymap
, c
, 0, 1), 1);
781 /* If this key is undefined, make it a prefix. */
783 cmd
= define_as_prefix (keymap
, c
);
785 keymap
= get_keymap_1 (cmd
, 0, 1);
787 /* We must use Fkey_description rather than just passing key to
788 error; key might be a vector, not a string. */
789 error ("Key sequence %s uses invalid prefix characters",
790 XSTRING (Fkey_description (key
))->data
);
794 /* Value is number if KEY is too long; NIL if valid but has no definition. */
795 /* GC is possible in this function if it autoloads a keymap. */
797 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
798 "In keymap KEYMAP, look up key sequence KEY. Return the definition.\n\
799 nil means undefined. See doc of `define-key' for kinds of definitions.\n\
801 A number as value means KEY is \"too long\";\n\
802 that is, characters or symbols in it except for the last one\n\
803 fail to be a valid sequence of prefix characters in KEYMAP.\n\
804 The number is how many characters at the front of KEY\n\
805 it takes to reach a non-prefix command.\n\
807 Normally, `lookup-key' ignores bindings for t, which act as default\n\
808 bindings, used when nothing else in the keymap applies; this makes it\n\
809 usable as a general function for probing keymaps. However, if the\n\
810 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will\n\
811 recognize the default bindings, just as `read-key-sequence' does.")
812 (keymap
, key
, accept_default
)
813 register Lisp_Object keymap
;
815 Lisp_Object accept_default
;
818 register Lisp_Object tem
;
819 register Lisp_Object cmd
;
820 register Lisp_Object c
;
823 int t_ok
= ! NILP (accept_default
);
827 keymap
= get_keymap_1 (keymap
, 1, 1);
829 if (!VECTORP (key
) && !STRINGP (key
))
830 key
= wrong_type_argument (Qarrayp
, key
);
832 length
= XFASTINT (Flength (key
));
837 meta_bit
= meta_modifier
;
846 c
= Faref (key
, make_number (idx
));
848 if (CONSP (c
) && lucid_event_type_list_p (c
))
849 c
= Fevent_convert_list (c
);
852 && (XINT (c
) & meta_bit
)
855 c
= meta_prefix_char
;
861 XSETINT (c
, XINT (c
) & ~meta_bit
);
867 cmd
= get_keyelt (access_keymap (keymap
, c
, t_ok
, 0), 1);
869 RETURN_UNGCPRO (cmd
);
871 keymap
= get_keymap_1 (cmd
, 0, 1);
873 RETURN_UNGCPRO (make_number (idx
));
879 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
880 Assume that currently it does not define C at all.
881 Return the keymap. */
884 define_as_prefix (keymap
, c
)
885 Lisp_Object keymap
, c
;
887 Lisp_Object inherit
, cmd
;
889 cmd
= Fmake_sparse_keymap (Qnil
);
890 /* If this key is defined as a prefix in an inherited keymap,
891 make it a prefix in this map, and make its definition
892 inherit the other prefix definition. */
893 inherit
= access_keymap (keymap
, c
, 0, 0);
895 /* This code is needed to do the right thing in the following case:
896 keymap A inherits from B,
897 you define KEY as a prefix in A,
898 then later you define KEY as a prefix in B.
899 We want the old prefix definition in A to inherit from that in B.
900 It is hard to do that retroactively, so this code
901 creates the prefix in B right away.
903 But it turns out that this code causes problems immediately
904 when the prefix in A is defined: it causes B to define KEY
905 as a prefix with no subcommands.
907 So I took out this code. */
910 /* If there's an inherited keymap
911 and it doesn't define this key,
912 make it define this key. */
915 for (tail
= Fcdr (keymap
); CONSP (tail
); tail
= XCONS (tail
)->cdr
)
916 if (EQ (XCONS (tail
)->car
, Qkeymap
))
920 inherit
= define_as_prefix (tail
, c
);
924 cmd
= nconc2 (cmd
, inherit
);
925 store_in_keymap (keymap
, c
, cmd
);
930 /* Append a key to the end of a key sequence. We always make a vector. */
933 append_key (key_sequence
, key
)
934 Lisp_Object key_sequence
, key
;
938 args
[0] = key_sequence
;
940 args
[1] = Fcons (key
, Qnil
);
941 return Fvconcat (2, args
);
945 /* Global, local, and minor mode keymap stuff. */
947 /* We can't put these variables inside current_minor_maps, since under
948 some systems, static gets macro-defined to be the empty string.
950 static Lisp_Object
*cmm_modes
, *cmm_maps
;
953 /* Error handler used in current_minor_maps. */
955 current_minor_maps_error ()
960 /* Store a pointer to an array of the keymaps of the currently active
961 minor modes in *buf, and return the number of maps it contains.
963 This function always returns a pointer to the same buffer, and may
964 free or reallocate it, so if you want to keep it for a long time or
965 hand it out to lisp code, copy it. This procedure will be called
966 for every key sequence read, so the nice lispy approach (return a
967 new assoclist, list, what have you) for each invocation would
968 result in a lot of consing over time.
970 If we used xrealloc/xmalloc and ran out of memory, they would throw
971 back to the command loop, which would try to read a key sequence,
972 which would call this function again, resulting in an infinite
973 loop. Instead, we'll use realloc/malloc and silently truncate the
974 list, let the key sequence be read, and hope some other piece of
975 code signals the error. */
977 current_minor_maps (modeptr
, mapptr
)
978 Lisp_Object
**modeptr
, **mapptr
;
981 Lisp_Object alist
, assoc
, var
, val
;
983 for (alist
= Vminor_mode_map_alist
;
985 alist
= XCONS (alist
)->cdr
)
986 if ((assoc
= XCONS (alist
)->car
, CONSP (assoc
))
987 && (var
= XCONS (assoc
)->car
, SYMBOLP (var
))
988 && (val
= find_symbol_value (var
), ! EQ (val
, Qunbound
))
995 Lisp_Object
*newmodes
, *newmaps
;
1002 = (Lisp_Object
*) realloc (cmm_modes
,
1003 cmm_size
* sizeof (Lisp_Object
));
1005 = (Lisp_Object
*) realloc (cmm_maps
,
1006 cmm_size
* sizeof (Lisp_Object
));
1014 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
1016 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
1020 if (newmaps
&& newmodes
)
1022 cmm_modes
= newmodes
;
1029 /* Get the keymap definition--or nil if it is not defined. */
1030 temp
= internal_condition_case_1 (Findirect_function
,
1032 Qerror
, current_minor_maps_error
);
1036 cmm_maps
[i
] = temp
;
1041 if (modeptr
) *modeptr
= cmm_modes
;
1042 if (mapptr
) *mapptr
= cmm_maps
;
1046 /* GC is possible in this function if it autoloads a keymap. */
1048 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 2, 0,
1049 "Return the binding for command KEY in current keymaps.\n\
1050 KEY is a string or vector, a sequence of keystrokes.\n\
1051 The binding is probably a symbol with a function definition.\n\
1053 Normally, `key-binding' ignores bindings for t, which act as default\n\
1054 bindings, used when nothing else in the keymap applies; this makes it\n\
1055 usable as a general function for probing keymaps. However, if the\n\
1056 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\
1057 recognize the default bindings, just as `read-key-sequence' does.")
1058 (key
, accept_default
)
1059 Lisp_Object key
, accept_default
;
1061 Lisp_Object
*maps
, value
;
1063 struct gcpro gcpro1
;
1067 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1069 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1070 key
, accept_default
);
1071 if (! NILP (value
) && !INTEGERP (value
))
1072 RETURN_UNGCPRO (value
);
1074 else if (!NILP (Voverriding_local_map
))
1076 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1077 if (! NILP (value
) && !INTEGERP (value
))
1078 RETURN_UNGCPRO (value
);
1084 nmaps
= current_minor_maps (0, &maps
);
1085 /* Note that all these maps are GCPRO'd
1086 in the places where we found them. */
1088 for (i
= 0; i
< nmaps
; i
++)
1089 if (! NILP (maps
[i
]))
1091 value
= Flookup_key (maps
[i
], key
, accept_default
);
1092 if (! NILP (value
) && !INTEGERP (value
))
1093 RETURN_UNGCPRO (value
);
1096 local
= get_local_map (PT
, current_buffer
);
1100 value
= Flookup_key (local
, key
, accept_default
);
1101 if (! NILP (value
) && !INTEGERP (value
))
1102 RETURN_UNGCPRO (value
);
1106 value
= Flookup_key (current_global_map
, key
, accept_default
);
1108 if (! NILP (value
) && !INTEGERP (value
))
1114 /* GC is possible in this function if it autoloads a keymap. */
1116 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1117 "Return the binding for command KEYS in current local keymap only.\n\
1118 KEYS is a string, a sequence of keystrokes.\n\
1119 The binding is probably a symbol with a function definition.\n\
1121 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1122 bindings; see the description of `lookup-key' for more details about this.")
1123 (keys
, accept_default
)
1124 Lisp_Object keys
, accept_default
;
1126 register Lisp_Object map
;
1127 map
= current_buffer
->keymap
;
1130 return Flookup_key (map
, keys
, accept_default
);
1133 /* GC is possible in this function if it autoloads a keymap. */
1135 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1136 "Return the binding for command KEYS in current global keymap only.\n\
1137 KEYS is a string, a sequence of keystrokes.\n\
1138 The binding is probably a symbol with a function definition.\n\
1139 This function's return values are the same as those of lookup-key\n\
1142 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1143 bindings; see the description of `lookup-key' for more details about this.")
1144 (keys
, accept_default
)
1145 Lisp_Object keys
, accept_default
;
1147 return Flookup_key (current_global_map
, keys
, accept_default
);
1150 /* GC is possible in this function if it autoloads a keymap. */
1152 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1153 "Find the visible minor mode bindings of KEY.\n\
1154 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the\n\
1155 the symbol which names the minor mode binding KEY, and BINDING is\n\
1156 KEY's definition in that mode. In particular, if KEY has no\n\
1157 minor-mode bindings, return nil. If the first binding is a\n\
1158 non-prefix, all subsequent bindings will be omitted, since they would\n\
1159 be ignored. Similarly, the list doesn't include non-prefix bindings\n\
1160 that come after prefix bindings.\n\
1162 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1163 bindings; see the description of `lookup-key' for more details about this.")
1164 (key
, accept_default
)
1165 Lisp_Object key
, accept_default
;
1167 Lisp_Object
*modes
, *maps
;
1169 Lisp_Object binding
;
1171 struct gcpro gcpro1
, gcpro2
;
1173 nmaps
= current_minor_maps (&modes
, &maps
);
1174 /* Note that all these maps are GCPRO'd
1175 in the places where we found them. */
1178 GCPRO2 (key
, binding
);
1180 for (i
= j
= 0; i
< nmaps
; i
++)
1181 if (! NILP (maps
[i
])
1182 && ! NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1183 && !INTEGERP (binding
))
1185 if (! NILP (get_keymap (binding
)))
1186 maps
[j
++] = Fcons (modes
[i
], binding
);
1188 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1192 return Flist (j
, maps
);
1195 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 2, 0,
1196 "Define COMMAND as a prefix command. COMMAND should be a symbol.\n\
1197 A new sparse keymap is stored as COMMAND's function definition and its value.\n\
1198 If a second optional argument MAPVAR is given, the map is stored as\n\
1199 its value instead of as COMMAND's value; but COMMAND is still defined\n\
1202 Lisp_Object command
, mapvar
;
1205 map
= Fmake_sparse_keymap (Qnil
);
1206 Ffset (command
, map
);
1210 Fset (command
, map
);
1214 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1215 "Select KEYMAP as the global keymap.")
1219 keymap
= get_keymap (keymap
);
1220 current_global_map
= keymap
;
1225 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1226 "Select KEYMAP as the local keymap.\n\
1227 If KEYMAP is nil, that means no local keymap.")
1232 keymap
= get_keymap (keymap
);
1234 current_buffer
->keymap
= keymap
;
1239 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1240 "Return current buffer's local keymap, or nil if it has none.")
1243 return current_buffer
->keymap
;
1246 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1247 "Return the current global keymap.")
1250 return current_global_map
;
1253 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1254 "Return a list of keymaps for the minor modes of the current buffer.")
1258 int nmaps
= current_minor_maps (0, &maps
);
1260 return Flist (nmaps
, maps
);
1263 /* Help functions for describing and documenting keymaps. */
1265 /* This function cannot GC. */
1267 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1269 "Find all keymaps accessible via prefix characters from KEYMAP.\n\
1270 Returns a list of elements of the form (KEYS . MAP), where the sequence\n\
1271 KEYS starting from KEYMAP gets you to MAP. These elements are ordered\n\
1272 so that the KEYS increase in length. The first element is ([] . KEYMAP).\n\
1273 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
1274 then the value includes only maps for prefixes that start with PREFIX.")
1276 Lisp_Object keymap
, prefix
;
1278 Lisp_Object maps
, good_maps
, tail
;
1281 /* no need for gcpro because we don't autoload any keymaps. */
1284 prefixlen
= XINT (Flength (prefix
));
1288 /* If a prefix was specified, start with the keymap (if any) for
1289 that prefix, so we don't waste time considering other prefixes. */
1291 tem
= Flookup_key (keymap
, prefix
, Qt
);
1292 /* Flookup_key may give us nil, or a number,
1293 if the prefix is not defined in this particular map.
1294 It might even give us a list that isn't a keymap. */
1295 tem
= get_keymap_1 (tem
, 0, 0);
1297 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1302 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1303 get_keymap (keymap
)),
1306 /* For each map in the list maps,
1307 look at any other maps it points to,
1308 and stick them at the end if they are not already in the list.
1310 This is a breadth-first traversal, where tail is the queue of
1311 nodes, and maps accumulates a list of all nodes visited. */
1313 for (tail
= maps
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1315 register Lisp_Object thisseq
, thismap
;
1317 /* Does the current sequence end in the meta-prefix-char? */
1320 thisseq
= Fcar (Fcar (tail
));
1321 thismap
= Fcdr (Fcar (tail
));
1322 last
= make_number (XINT (Flength (thisseq
)) - 1);
1323 is_metized
= (XINT (last
) >= 0
1324 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1326 for (; CONSP (thismap
); thismap
= XCONS (thismap
)->cdr
)
1330 elt
= XCONS (thismap
)->car
;
1338 /* Vector keymap. Scan all the elements. */
1339 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
1341 register Lisp_Object tem
;
1342 register Lisp_Object cmd
;
1344 cmd
= get_keyelt (XVECTOR (elt
)->contents
[i
], 0);
1345 if (NILP (cmd
)) continue;
1346 tem
= Fkeymapp (cmd
);
1349 cmd
= get_keymap (cmd
);
1350 /* Ignore keymaps that are already added to maps. */
1351 tem
= Frassq (cmd
, maps
);
1354 /* If the last key in thisseq is meta-prefix-char,
1355 turn it into a meta-ized keystroke. We know
1356 that the event we're about to append is an
1357 ascii keystroke since we're processing a
1361 int meta_bit
= meta_modifier
;
1362 tem
= Fcopy_sequence (thisseq
);
1364 Faset (tem
, last
, make_number (i
| meta_bit
));
1366 /* This new sequence is the same length as
1367 thisseq, so stick it in the list right
1370 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1374 tem
= append_key (thisseq
, make_number (i
));
1375 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1381 else if (CONSP (elt
))
1383 register Lisp_Object cmd
, tem
, filter
;
1385 cmd
= get_keyelt (XCONS (elt
)->cdr
, 0);
1386 /* Ignore definitions that aren't keymaps themselves. */
1387 tem
= Fkeymapp (cmd
);
1390 /* Ignore keymaps that have been seen already. */
1391 cmd
= get_keymap (cmd
);
1392 tem
= Frassq (cmd
, maps
);
1395 /* Let elt be the event defined by this map entry. */
1396 elt
= XCONS (elt
)->car
;
1398 /* If the last key in thisseq is meta-prefix-char, and
1399 this entry is a binding for an ascii keystroke,
1400 turn it into a meta-ized keystroke. */
1401 if (is_metized
&& INTEGERP (elt
))
1403 tem
= Fcopy_sequence (thisseq
);
1405 make_number (XINT (elt
) | meta_modifier
));
1407 /* This new sequence is the same length as
1408 thisseq, so stick it in the list right
1411 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1415 Fcons (Fcons (append_key (thisseq
, elt
), cmd
),
1426 /* Now find just the maps whose access prefixes start with PREFIX. */
1429 for (; CONSP (maps
); maps
= XCONS (maps
)->cdr
)
1431 Lisp_Object elt
, thisseq
;
1432 elt
= XCONS (maps
)->car
;
1433 thisseq
= XCONS (elt
)->car
;
1434 /* The access prefix must be at least as long as PREFIX,
1435 and the first elements must match those of PREFIX. */
1436 if (XINT (Flength (thisseq
)) >= prefixlen
)
1439 for (i
= 0; i
< prefixlen
; i
++)
1442 XSETFASTINT (i1
, i
);
1443 if (!EQ (Faref (thisseq
, i1
), Faref (prefix
, i1
)))
1447 good_maps
= Fcons (elt
, good_maps
);
1451 return Fnreverse (good_maps
);
1454 Lisp_Object Qsingle_key_description
, Qkey_description
;
1456 /* This function cannot GC. */
1458 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 1, 0,
1459 "Return a pretty description of key-sequence KEYS.\n\
1460 Control characters turn into \"C-foo\" sequences, meta into \"M-foo\"\n\
1461 spaces are put between sequence elements, etc.")
1473 vector
= Fmake_vector (Flength (keys
), Qnil
);
1474 for (i
= 0; i
< XSTRING (keys
)->size
; i
++)
1476 if (XSTRING (keys
)->data
[i
] & 0x80)
1477 XSETFASTINT (XVECTOR (vector
)->contents
[i
],
1478 meta_modifier
| (XSTRING (keys
)->data
[i
] & ~0x80));
1480 XSETFASTINT (XVECTOR (vector
)->contents
[i
],
1481 XSTRING (keys
)->data
[i
]);
1485 else if (!VECTORP (keys
))
1486 keys
= wrong_type_argument (Qarrayp
, keys
);
1488 /* In effect, this computes
1489 (mapconcat 'single-key-description keys " ")
1490 but we shouldn't use mapconcat because it can do GC. */
1492 len
= XVECTOR (keys
)->size
;
1493 sep
= build_string (" ");
1494 /* This has one extra element at the end that we don't pass to Fconcat. */
1495 args
= (Lisp_Object
*) alloca (len
* 2 * sizeof (Lisp_Object
));
1497 for (i
= 0; i
< len
; i
++)
1499 args
[i
* 2] = Fsingle_key_description (XVECTOR (keys
)->contents
[i
]);
1500 args
[i
* 2 + 1] = sep
;
1503 return Fconcat (len
* 2 - 1, args
);
1507 push_key_description (c
, p
)
1508 register unsigned int c
;
1511 /* Clear all the meaningless bits above the meta bit. */
1512 c
&= meta_modifier
| ~ - meta_modifier
;
1514 if (c
& alt_modifier
)
1520 if (c
& ctrl_modifier
)
1526 if (c
& hyper_modifier
)
1530 c
-= hyper_modifier
;
1532 if (c
& meta_modifier
)
1538 if (c
& shift_modifier
)
1542 c
-= shift_modifier
;
1544 if (c
& super_modifier
)
1548 c
-= super_modifier
;
1564 else if (c
== Ctl('J'))
1570 else if (c
== Ctl('M'))
1580 if (c
> 0 && c
<= Ctl ('Z'))
1603 *p
++ = (7 & (c
>> 15)) + '0';
1604 *p
++ = (7 & (c
>> 12)) + '0';
1605 *p
++ = (7 & (c
>> 9)) + '0';
1606 *p
++ = (7 & (c
>> 6)) + '0';
1607 *p
++ = (7 & (c
>> 3)) + '0';
1608 *p
++ = (7 & (c
>> 0)) + '0';
1614 /* This function cannot GC. */
1616 DEFUN ("single-key-description", Fsingle_key_description
, Ssingle_key_description
, 1, 1, 0,
1617 "Return a pretty description of command character KEY.\n\
1618 Control characters turn into C-whatever, etc.")
1624 key
= EVENT_HEAD (key
);
1626 if (INTEGERP (key
)) /* Normal character */
1628 *push_key_description (XUINT (key
), tem
) = 0;
1629 return build_string (tem
);
1631 else if (SYMBOLP (key
)) /* Function key or event-symbol */
1632 return Fsymbol_name (key
);
1633 else if (STRINGP (key
)) /* Buffer names in the menubar. */
1634 return Fcopy_sequence (key
);
1636 error ("KEY must be an integer, cons, symbol, or string");
1640 push_text_char_description (c
, p
)
1641 register unsigned int c
;
1653 *p
++ = c
+ 64; /* 'A' - 1 */
1665 /* This function cannot GC. */
1667 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
1668 "Return a pretty description of file-character CHARACTER.\n\
1669 Control characters turn into \"^char\", etc.")
1671 Lisp_Object character
;
1675 CHECK_NUMBER (character
, 0);
1677 *push_text_char_description (XINT (character
) & 0377, tem
) = 0;
1679 return build_string (tem
);
1682 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
1685 ascii_sequence_p (seq
)
1689 int len
= XINT (Flength (seq
));
1691 for (i
= 0; i
< len
; i
++)
1693 Lisp_Object ii
, elt
;
1695 XSETFASTINT (ii
, i
);
1696 elt
= Faref (seq
, ii
);
1699 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
1707 /* where-is - finding a command in a set of keymaps. */
1709 /* This function can GC if Flookup_key autoloads any keymaps. */
1711 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 4, 0,
1712 "Return list of keys that invoke DEFINITION.\n\
1713 If KEYMAP is non-nil, search only KEYMAP and the global keymap.\n\
1714 If KEYMAP is nil, search all the currently active keymaps.\n\
1716 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,\n\
1717 rather than a list of all possible key sequences.\n\
1718 If FIRSTONLY is the symbol `non-ascii', return the first binding found,\n\
1719 no matter what it is.\n\
1720 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters,\n\
1721 and entirely reject menu bindings.\n\
1723 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections\n\
1724 to other keymaps or slots. This makes it possible to search for an\n\
1725 indirect definition itself.")
1726 (definition
, keymap
, firstonly
, noindirect
)
1727 Lisp_Object definition
, keymap
;
1728 Lisp_Object firstonly
, noindirect
;
1731 Lisp_Object found
, sequence
;
1732 int keymap_specified
= !NILP (keymap
);
1733 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
1734 /* 1 means ignore all menu bindings entirely. */
1735 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
1737 if (! keymap_specified
)
1739 #ifdef USE_TEXT_PROPERTIES
1740 keymap
= get_local_map (PT
, current_buffer
);
1742 keymap
= current_buffer
->keymap
;
1747 maps
= nconc2 (Faccessible_keymaps (get_keymap (keymap
), Qnil
),
1748 Faccessible_keymaps (get_keymap (current_global_map
),
1751 maps
= Faccessible_keymaps (get_keymap (current_global_map
), Qnil
);
1753 /* Put the minor mode keymaps on the front. */
1754 if (! keymap_specified
)
1757 minors
= Fnreverse (Fcurrent_minor_mode_maps ());
1758 while (!NILP (minors
))
1760 maps
= nconc2 (Faccessible_keymaps (get_keymap (XCONS (minors
)->car
),
1763 minors
= XCONS (minors
)->cdr
;
1767 GCPRO5 (definition
, keymap
, maps
, found
, sequence
);
1771 for (; !NILP (maps
); maps
= Fcdr (maps
))
1773 /* Key sequence to reach map, and the map that it reaches */
1774 register Lisp_Object
this, map
;
1776 /* If Fcar (map) is a VECTOR, the current element within that vector. */
1779 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
1780 [M-CHAR] sequences, check if last character of the sequence
1781 is the meta-prefix char. */
1785 this = Fcar (Fcar (maps
));
1786 map
= Fcdr (Fcar (maps
));
1787 last
= make_number (XINT (Flength (this)) - 1);
1788 last_is_meta
= (XINT (last
) >= 0
1789 && EQ (Faref (this, last
), meta_prefix_char
));
1795 /* Because the code we want to run on each binding is rather
1796 large, we don't want to have two separate loop bodies for
1797 sparse keymap bindings and tables; we want to iterate one
1798 loop body over both keymap and vector bindings.
1800 For this reason, if Fcar (map) is a vector, we don't
1801 advance map to the next element until i indicates that we
1802 have finished off the vector. */
1804 Lisp_Object elt
, key
, binding
;
1805 elt
= XCONS (map
)->car
;
1809 /* Set key and binding to the current key and binding, and
1810 advance map and i to the next binding. */
1813 /* In a vector, look at each element. */
1814 binding
= XVECTOR (elt
)->contents
[i
];
1815 XSETFASTINT (key
, i
);
1818 /* If we've just finished scanning a vector, advance map
1819 to the next element, and reset i in anticipation of the
1820 next vector we may find. */
1821 if (i
>= XVECTOR (elt
)->size
)
1823 map
= XCONS (map
)->cdr
;
1827 else if (CONSP (elt
))
1829 key
= Fcar (Fcar (map
));
1830 binding
= Fcdr (Fcar (map
));
1832 map
= XCONS (map
)->cdr
;
1835 /* We want to ignore keymap elements that are neither
1836 vectors nor conses. */
1838 map
= XCONS (map
)->cdr
;
1842 /* Search through indirections unless that's not wanted. */
1843 if (NILP (noindirect
))
1849 Lisp_Object map
, tem
;
1850 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
1851 map
= get_keymap_1 (Fcar_safe (definition
), 0, 0);
1852 tem
= Fkeymapp (map
);
1854 definition
= access_keymap (map
, Fcdr (definition
), 0, 0);
1858 /* If the contents are (STRING ...), reject. */
1859 if (CONSP (definition
)
1860 && STRINGP (XCONS (definition
)->car
))
1864 binding
= get_keyelt (binding
, 0);
1867 /* End this iteration if this element does not match
1870 if (CONSP (definition
))
1873 tem
= Fequal (binding
, definition
);
1878 if (!EQ (binding
, definition
))
1881 /* We have found a match.
1882 Construct the key sequence where we found it. */
1883 if (INTEGERP (key
) && last_is_meta
)
1885 sequence
= Fcopy_sequence (this);
1886 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
1889 sequence
= append_key (this, key
);
1891 /* Verify that this key binding is not shadowed by another
1892 binding for the same key, before we say it exists.
1894 Mechanism: look for local definition of this key and if
1895 it is defined and does not match what we found then
1898 Either nil or number as value from Flookup_key
1900 if (keymap_specified
)
1902 binding
= Flookup_key (keymap
, sequence
, Qnil
);
1903 if (!NILP (binding
) && !INTEGERP (binding
))
1905 if (CONSP (definition
))
1908 tem
= Fequal (binding
, definition
);
1913 if (!EQ (binding
, definition
))
1919 binding
= Fkey_binding (sequence
, Qnil
);
1920 if (!EQ (binding
, definition
))
1924 /* It is a true unshadowed match. Record it, unless it's already
1925 been seen (as could happen when inheriting keymaps). */
1926 if (NILP (Fmember (sequence
, found
)))
1927 found
= Fcons (sequence
, found
);
1929 /* If firstonly is Qnon_ascii, then we can return the first
1930 binding we find. If firstonly is not Qnon_ascii but not
1931 nil, then we should return the first ascii-only binding
1933 if (EQ (firstonly
, Qnon_ascii
))
1934 RETURN_UNGCPRO (sequence
);
1935 else if (! NILP (firstonly
) && ascii_sequence_p (sequence
))
1936 RETURN_UNGCPRO (sequence
);
1942 found
= Fnreverse (found
);
1944 /* firstonly may have been t, but we may have gone all the way through
1945 the keymaps without finding an all-ASCII key sequence. So just
1946 return the best we could find. */
1947 if (! NILP (firstonly
))
1948 return Fcar (found
);
1953 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
1955 DEFUN ("describe-bindings", Fdescribe_bindings
, Sdescribe_bindings
, 0, 1, "",
1956 "Show a list of all defined keys, and their definitions.\n\
1957 The list is put in a buffer, which is displayed.\n\
1958 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
1959 then we display only bindings that start with that prefix.")
1963 register Lisp_Object thisbuf
;
1964 XSETBUFFER (thisbuf
, current_buffer
);
1965 internal_with_output_to_temp_buffer ("*Help*",
1966 describe_buffer_bindings
,
1967 Fcons (thisbuf
, prefix
));
1971 /* ARG is (BUFFER . PREFIX). */
1974 describe_buffer_bindings (arg
)
1977 Lisp_Object descbuf
, prefix
, shadow
;
1978 register Lisp_Object start1
;
1979 struct gcpro gcpro1
;
1981 char *alternate_heading
1983 Alternate Characters (use anywhere the nominal character is listed):\n\
1984 nominal alternate\n\
1985 ------- ---------\n";
1987 descbuf
= XCONS (arg
)->car
;
1988 prefix
= XCONS (arg
)->cdr
;
1992 Fset_buffer (Vstandard_output
);
1994 /* Report on alternates for keys. */
1995 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
1998 unsigned char *translate
= XSTRING (Vkeyboard_translate_table
)->data
;
1999 int translate_len
= XSTRING (Vkeyboard_translate_table
)->size
;
2001 for (c
= 0; c
< translate_len
; c
++)
2002 if (translate
[c
] != c
)
2007 if (alternate_heading
)
2009 insert_string (alternate_heading
);
2010 alternate_heading
= 0;
2013 bufend
= push_key_description (translate
[c
], buf
);
2014 insert (buf
, bufend
- buf
);
2015 Findent_to (make_number (16), make_number (1));
2016 bufend
= push_key_description (c
, buf
);
2017 insert (buf
, bufend
- buf
);
2025 if (!NILP (Vkey_translation_map
))
2026 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2027 "Key translations", 0, 1, 0);
2031 Lisp_Object
*modes
, *maps
;
2033 /* Temporarily switch to descbuf, so that we can get that buffer's
2034 minor modes correctly. */
2035 Fset_buffer (descbuf
);
2037 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
2038 || !NILP (Voverriding_local_map
))
2041 nmaps
= current_minor_maps (&modes
, &maps
);
2042 Fset_buffer (Vstandard_output
);
2044 /* Print the minor mode maps. */
2045 for (i
= 0; i
< nmaps
; i
++)
2047 /* The title for a minor mode keymap
2048 is constructed at run time.
2049 We let describe_map_tree do the actual insertion
2050 because it takes care of other features when doing so. */
2053 if (!SYMBOLP (modes
[i
]))
2056 p
= title
= (char *) alloca (40 + XSYMBOL (modes
[i
])->name
->size
);
2058 bcopy (XSYMBOL (modes
[i
])->name
->data
, p
,
2059 XSYMBOL (modes
[i
])->name
->size
);
2060 p
+= XSYMBOL (modes
[i
])->name
->size
;
2062 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2063 p
+= sizeof (" Minor Mode Bindings") - 1;
2066 describe_map_tree (maps
[i
], 0, shadow
, prefix
, title
, 0, 0, 0);
2067 shadow
= Fcons (maps
[i
], shadow
);
2071 /* Print the (major mode) local map. */
2072 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2073 start1
= current_kboard
->Voverriding_terminal_local_map
;
2074 else if (!NILP (Voverriding_local_map
))
2075 start1
= Voverriding_local_map
;
2077 start1
= XBUFFER (descbuf
)->keymap
;
2081 describe_map_tree (start1
, 0, shadow
, prefix
,
2082 "Major Mode Bindings", 0, 0, 0);
2083 shadow
= Fcons (start1
, shadow
);
2086 describe_map_tree (current_global_map
, 0, shadow
, prefix
,
2087 "Global Bindings", 0, 0, 1);
2089 /* Print the function-key-map translations under this prefix. */
2090 if (!NILP (Vfunction_key_map
))
2091 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2092 "Function key map translations", 0, 1, 0);
2094 call0 (intern ("help-mode"));
2095 Fset_buffer (descbuf
);
2100 /* Insert a description of the key bindings in STARTMAP,
2101 followed by those of all maps reachable through STARTMAP.
2102 If PARTIAL is nonzero, omit certain "uninteresting" commands
2103 (such as `undefined').
2104 If SHADOW is non-nil, it is a list of maps;
2105 don't mention keys which would be shadowed by any of them.
2106 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2107 TITLE, if not 0, is a string to insert at the beginning.
2108 TITLE should not end with a colon or a newline; we supply that.
2109 If NOMENU is not 0, then omit menu-bar commands.
2111 If TRANSL is nonzero, the definitions are actually key translations
2112 so print strings and vectors differently.
2114 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2118 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2120 Lisp_Object startmap
, shadow
, prefix
;
2127 Lisp_Object maps
, seen
, sub_shadows
;
2128 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2135 maps
= Faccessible_keymaps (startmap
, prefix
);
2138 GCPRO3 (maps
, seen
, sub_shadows
);
2144 /* Delete from MAPS each element that is for the menu bar. */
2145 for (list
= maps
; !NILP (list
); list
= XCONS (list
)->cdr
)
2147 Lisp_Object elt
, prefix
, tem
;
2150 prefix
= Fcar (elt
);
2151 if (XVECTOR (prefix
)->size
>= 1)
2153 tem
= Faref (prefix
, make_number (0));
2154 if (EQ (tem
, Qmenu_bar
))
2155 maps
= Fdelq (elt
, maps
);
2160 if (!NILP (maps
) || always_title
)
2164 insert_string (title
);
2167 insert_string (" Starting With ");
2168 insert1 (Fkey_description (prefix
));
2170 insert_string (":\n");
2172 insert_string (key_heading
);
2176 for (; !NILP (maps
); maps
= Fcdr (maps
))
2178 register Lisp_Object elt
, prefix
, tail
;
2181 prefix
= Fcar (elt
);
2185 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2189 shmap
= XCONS (tail
)->car
;
2191 /* If the sequence by which we reach this keymap is zero-length,
2192 then the shadow map for this keymap is just SHADOW. */
2193 if ((STRINGP (prefix
) && XSTRING (prefix
)->size
== 0)
2194 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
2196 /* If the sequence by which we reach this keymap actually has
2197 some elements, then the sequence's definition in SHADOW is
2198 what we should use. */
2201 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
2202 if (INTEGERP (shmap
))
2206 /* If shmap is not nil and not a keymap,
2207 it completely shadows this map, so don't
2208 describe this map at all. */
2209 if (!NILP (shmap
) && NILP (Fkeymapp (shmap
)))
2213 sub_shadows
= Fcons (shmap
, sub_shadows
);
2216 describe_map (Fcdr (elt
), Fcar (elt
),
2217 transl
? describe_translation
: describe_command
,
2218 partial
, sub_shadows
, &seen
, nomenu
);
2224 insert_string ("\n");
2229 static int previous_description_column
;
2232 describe_command (definition
)
2233 Lisp_Object definition
;
2235 register Lisp_Object tem1
;
2236 int column
= current_column ();
2237 int description_column
;
2239 /* If column 16 is no good, go to col 32;
2240 but don't push beyond that--go to next line instead. */
2244 description_column
= 32;
2246 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
2247 description_column
= 32;
2249 description_column
= 16;
2251 Findent_to (make_number (description_column
), make_number (1));
2252 previous_description_column
= description_column
;
2254 if (SYMBOLP (definition
))
2256 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2258 insert_string ("\n");
2260 else if (STRINGP (definition
) || VECTORP (definition
))
2261 insert_string ("Keyboard Macro\n");
2264 tem1
= Fkeymapp (definition
);
2266 insert_string ("Prefix Command\n");
2268 insert_string ("??\n");
2273 describe_translation (definition
)
2274 Lisp_Object definition
;
2276 register Lisp_Object tem1
;
2278 Findent_to (make_number (16), make_number (1));
2280 if (SYMBOLP (definition
))
2282 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2284 insert_string ("\n");
2286 else if (STRINGP (definition
) || VECTORP (definition
))
2288 insert1 (Fkey_description (definition
));
2289 insert_string ("\n");
2293 tem1
= Fkeymapp (definition
);
2295 insert_string ("Prefix Command\n");
2297 insert_string ("??\n");
2301 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2302 Returns the first non-nil binding found in any of those maps. */
2305 shadow_lookup (shadow
, key
, flag
)
2306 Lisp_Object shadow
, key
, flag
;
2308 Lisp_Object tail
, value
;
2310 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2312 value
= Flookup_key (XCONS (tail
)->car
, key
, flag
);
2319 /* Describe the contents of map MAP, assuming that this map itself is
2320 reached by the sequence of prefix keys KEYS (a string or vector).
2321 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
2324 describe_map (map
, keys
, elt_describer
, partial
, shadow
, seen
, nomenu
)
2325 register Lisp_Object map
;
2327 int (*elt_describer
) ();
2333 Lisp_Object elt_prefix
;
2334 Lisp_Object tail
, definition
, event
;
2336 Lisp_Object suppress
;
2339 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2341 if (!NILP (keys
) && XFASTINT (Flength (keys
)) > 0)
2343 /* Call Fkey_description first, to avoid GC bug for the other string. */
2344 tem
= Fkey_description (keys
);
2345 elt_prefix
= concat2 (tem
, build_string (" "));
2351 suppress
= intern ("suppress-keymap");
2353 /* This vector gets used to present single keys to Flookup_key. Since
2354 that is done once per keymap element, we don't want to cons up a
2355 fresh vector every time. */
2356 kludge
= Fmake_vector (make_number (1), Qnil
);
2359 GCPRO3 (elt_prefix
, definition
, kludge
);
2361 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2365 if (VECTORP (XCONS (tail
)->car
))
2366 describe_vector (XCONS (tail
)->car
,
2367 elt_prefix
, elt_describer
, partial
, shadow
, map
);
2368 else if (CONSP (XCONS (tail
)->car
))
2370 event
= XCONS (XCONS (tail
)->car
)->car
;
2372 /* Ignore bindings whose "keys" are not really valid events.
2373 (We get these in the frames and buffers menu.) */
2374 if (! (SYMBOLP (event
) || INTEGERP (event
)))
2377 if (nomenu
&& EQ (event
, Qmenu_bar
))
2380 definition
= get_keyelt (XCONS (XCONS (tail
)->car
)->cdr
, 0);
2382 /* Don't show undefined commands or suppressed commands. */
2383 if (NILP (definition
)) continue;
2384 if (SYMBOLP (definition
) && partial
)
2386 tem
= Fget (definition
, suppress
);
2391 /* Don't show a command that isn't really visible
2392 because a local definition of the same key shadows it. */
2394 XVECTOR (kludge
)->contents
[0] = event
;
2397 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2398 if (!NILP (tem
)) continue;
2401 tem
= Flookup_key (map
, kludge
, Qt
);
2402 if (! EQ (tem
, definition
)) continue;
2406 previous_description_column
= 0;
2411 if (!NILP (elt_prefix
))
2412 insert1 (elt_prefix
);
2414 /* THIS gets the string to describe the character EVENT. */
2415 insert1 (Fsingle_key_description (event
));
2417 /* Print a description of the definition of this character.
2418 elt_describer will take care of spacing out far enough
2419 for alignment purposes. */
2420 (*elt_describer
) (definition
);
2422 else if (EQ (XCONS (tail
)->car
, Qkeymap
))
2424 /* The same keymap might be in the structure twice, if we're
2425 using an inherited keymap. So skip anything we've already
2427 tem
= Fassq (tail
, *seen
);
2428 if (CONSP (tem
) && !NILP (Fequal (XCONS (tem
)->car
, keys
)))
2430 *seen
= Fcons (Fcons (tail
, keys
), *seen
);
2438 describe_vector_princ (elt
)
2441 Findent_to (make_number (16), make_number (1));
2446 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 1, 0,
2447 "Insert a description of contents of VECTOR.\n\
2448 This is text showing the elements of vector matched against indices.")
2452 int count
= specpdl_ptr
- specpdl
;
2454 specbind (Qstandard_output
, Fcurrent_buffer ());
2455 CHECK_VECTOR_OR_CHAR_TABLE (vector
, 0);
2456 describe_vector (vector
, Qnil
, describe_vector_princ
, 0, Qnil
, Qnil
);
2458 return unbind_to (count
, Qnil
);
2461 /* Insert in the current buffer a description of the contents of VECTOR.
2462 We call ELT_DESCRIBER to insert the description of one value found
2465 ELT_PREFIX describes what "comes before" the keys or indices defined
2468 If the vector is in a keymap, ELT_PREFIX is a prefix key which
2469 leads to this keymap.
2471 If the vector is a chartable, ELT_PREFIX is the vector
2472 of bytes that lead to the character set or portion of a character
2473 set described by this chartable.
2475 If PARTIAL is nonzero, it means do not mention suppressed commands
2476 (that assumes the vector is in a keymap).
2478 SHADOW is a list of keymaps that shadow this map.
2479 If it is non-nil, then we look up the key in those maps
2480 and we don't mention it now if it is defined by any of them.
2482 ENTIRE_MAP is the keymap in which this vector appears.
2483 If the definition in effect in the whole map does not match
2484 the one in this vector, we ignore this one. */
2486 describe_vector (vector
, elt_prefix
, elt_describer
,
2487 partial
, shadow
, entire_map
)
2488 register Lisp_Object vector
;
2489 Lisp_Object elt_prefix
;
2490 int (*elt_describer
) ();
2493 Lisp_Object entire_map
;
2497 Lisp_Object definition
;
2500 Lisp_Object suppress
;
2502 Lisp_Object chartable_kludge
;
2505 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2508 chartable_kludge
= Qnil
;
2510 /* This vector gets used to present single keys to Flookup_key. Since
2511 that is done once per vector element, we don't want to cons up a
2512 fresh vector every time. */
2513 kludge
= Fmake_vector (make_number (1), Qnil
);
2514 GCPRO4 (elt_prefix
, definition
, kludge
, chartable_kludge
);
2517 suppress
= intern ("suppress-keymap");
2519 /* This does the right thing for char-tables as well as ordinary vectors. */
2520 size
= XFASTINT (Flength (vector
));
2522 for (i
= 0; i
< size
; i
++)
2525 definition
= get_keyelt (XVECTOR (vector
)->contents
[i
], 0);
2527 if (NILP (definition
)) continue;
2529 /* Don't mention suppressed commands. */
2530 if (SYMBOLP (definition
) && partial
)
2532 this = Fget (definition
, suppress
);
2537 /* If this binding is shadowed by some other map, ignore it. */
2542 XVECTOR (kludge
)->contents
[0] = make_number (i
);
2543 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2545 if (!NILP (tem
)) continue;
2548 /* Ignore this definition if it is shadowed by an earlier
2549 one in the same keymap. */
2550 if (!NILP (entire_map
))
2554 XVECTOR (kludge
)->contents
[0] = make_number (i
);
2555 tem
= Flookup_key (entire_map
, kludge
, Qt
);
2557 if (! EQ (tem
, definition
))
2561 /* If we find a char-table within a char-table,
2562 scan it recursively; it defines the details for
2563 a character set or a portion of a character set. */
2564 if (CHAR_TABLE_P (vector
) && CHAR_TABLE_P (definition
))
2567 = !NILP (elt_prefix
) ? XVECTOR (elt_prefix
)->size
: 0;
2568 if (NILP (chartable_kludge
))
2571 = Fmake_vector (make_number (outer_level
+ 1), Qnil
);
2572 if (outer_level
!= 0)
2573 bcopy (XVECTOR (elt_prefix
)->contents
,
2574 XVECTOR (chartable_kludge
)->contents
,
2575 outer_level
* sizeof (Lisp_Object
));
2577 XVECTOR (chartable_kludge
)->contents
[outer_level
]
2579 describe_vector (definition
, chartable_kludge
, elt_describer
,
2580 partial
, shadow
, entire_map
);
2590 if (CHAR_TABLE_P (vector
))
2592 if (!NILP (elt_prefix
))
2594 /* Must combine elt_prefix with i to produce a character
2595 code, then insert that character's description. */
2599 /* Get the string to describe the character I, and print it. */
2600 XSETFASTINT (dummy
, i
);
2602 /* THIS gets the string to describe the character DUMMY. */
2603 this = Fsingle_key_description (dummy
);
2609 /* Output the prefix that applies to every entry in this map. */
2610 if (!NILP (elt_prefix
))
2611 insert1 (elt_prefix
);
2613 /* Get the string to describe the character I, and print it. */
2614 XSETFASTINT (dummy
, i
);
2616 /* THIS gets the string to describe the character DUMMY. */
2617 this = Fsingle_key_description (dummy
);
2621 /* Find all consecutive characters that have the same definition. */
2622 while (i
+ 1 < XVECTOR (vector
)->size
2623 && (tem2
= get_keyelt (XVECTOR (vector
)->contents
[i
+1], 0),
2624 EQ (tem2
, definition
)))
2627 /* If we have a range of more than one character,
2628 print where the range reaches to. */
2630 if (i
!= XINT (dummy
))
2633 if (CHAR_TABLE_P (vector
))
2635 if (!NILP (elt_prefix
))
2637 /* Must combine elt_prefix with i to produce a character
2638 code, then insert that character's description. */
2642 XSETFASTINT (dummy
, i
);
2644 this = Fsingle_key_description (dummy
);
2650 if (!NILP (elt_prefix
))
2651 insert1 (elt_prefix
);
2653 XSETFASTINT (dummy
, i
);
2654 insert1 (Fsingle_key_description (dummy
));
2658 /* Print a description of the definition of this character.
2659 elt_describer will take care of spacing out far enough
2660 for alignment purposes. */
2661 (*elt_describer
) (definition
);
2667 /* Apropos - finding all symbols whose names match a regexp. */
2668 Lisp_Object apropos_predicate
;
2669 Lisp_Object apropos_accumulate
;
2672 apropos_accum (symbol
, string
)
2673 Lisp_Object symbol
, string
;
2675 register Lisp_Object tem
;
2677 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
2678 if (!NILP (tem
) && !NILP (apropos_predicate
))
2679 tem
= call1 (apropos_predicate
, symbol
);
2681 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
2684 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
2685 "Show all symbols whose names contain match for REGEXP.\n\
2686 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done\n\
2687 for each symbol and a symbol is mentioned only if that returns non-nil.\n\
2688 Return list of symbols found.")
2690 Lisp_Object regexp
, predicate
;
2692 struct gcpro gcpro1
, gcpro2
;
2693 CHECK_STRING (regexp
, 0);
2694 apropos_predicate
= predicate
;
2695 GCPRO2 (apropos_predicate
, apropos_accumulate
);
2696 apropos_accumulate
= Qnil
;
2697 map_obarray (Vobarray
, apropos_accum
, regexp
);
2698 apropos_accumulate
= Fsort (apropos_accumulate
, Qstring_lessp
);
2700 return apropos_accumulate
;
2707 Qkeymap
= intern ("keymap");
2708 staticpro (&Qkeymap
);
2710 /* Initialize the keymaps standardly used.
2711 Each one is the value of a Lisp variable, and is also
2712 pointed to by a C variable */
2714 global_map
= Fcons (Qkeymap
,
2715 Fcons (Fmake_vector (make_number (0400), Qnil
), Qnil
));
2716 Fset (intern ("global-map"), global_map
);
2718 meta_map
= Fmake_keymap (Qnil
);
2719 Fset (intern ("esc-map"), meta_map
);
2720 Ffset (intern ("ESC-prefix"), meta_map
);
2722 control_x_map
= Fmake_keymap (Qnil
);
2723 Fset (intern ("ctl-x-map"), control_x_map
);
2724 Ffset (intern ("Control-X-prefix"), control_x_map
);
2726 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
2727 "List of commands given new key bindings recently.\n\
2728 This is used for internal purposes during Emacs startup;\n\
2729 don't alter it yourself.");
2730 Vdefine_key_rebound_commands
= Qt
;
2732 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
2733 "Default keymap to use when reading from the minibuffer.");
2734 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
2736 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
2737 "Local keymap for the minibuffer when spaces are not allowed.");
2738 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
2740 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
2741 "Local keymap for minibuffer input with completion.");
2742 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
2744 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
2745 "Local keymap for minibuffer input with completion, for exact match.");
2746 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
2748 current_global_map
= global_map
;
2750 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
2751 "Alist of keymaps to use for minor modes.\n\
2752 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read\n\
2753 key sequences and look up bindings iff VARIABLE's value is non-nil.\n\
2754 If two active keymaps bind the same key, the keymap appearing earlier\n\
2755 in the list takes precedence.");
2756 Vminor_mode_map_alist
= Qnil
;
2758 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
2759 "Keymap mapping ASCII function key sequences onto their preferred forms.\n\
2760 This allows Emacs to recognize function keys sent from ASCII\n\
2761 terminals at any point in a key sequence.\n\
2763 The `read-key-sequence' function replaces any subsequence bound by\n\
2764 `function-key-map' with its binding. More precisely, when the active\n\
2765 keymaps have no binding for the current key sequence but\n\
2766 `function-key-map' binds a suffix of the sequence to a vector or string,\n\
2767 `read-key-sequence' replaces the matching suffix with its binding, and\n\
2768 continues with the new sequence.\n\
2770 The events that come from bindings in `function-key-map' are not\n\
2771 themselves looked up in `function-key-map'.\n\
2773 For example, suppose `function-key-map' binds `ESC O P' to [f1].\n\
2774 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing\n\
2775 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix\n\
2776 key, typing `ESC O P x' would return [f1 x].");
2777 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
2779 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
2780 "Keymap of key translations that can override keymaps.\n\
2781 This keymap works like `function-key-map', but comes after that,\n\
2782 and applies even for keys that have ordinary bindings.");
2783 Vkey_translation_map
= Qnil
;
2785 Qsingle_key_description
= intern ("single-key-description");
2786 staticpro (&Qsingle_key_description
);
2788 Qkey_description
= intern ("key-description");
2789 staticpro (&Qkey_description
);
2791 Qkeymapp
= intern ("keymapp");
2792 staticpro (&Qkeymapp
);
2794 Qnon_ascii
= intern ("non-ascii");
2795 staticpro (&Qnon_ascii
);
2797 defsubr (&Skeymapp
);
2798 defsubr (&Skeymap_parent
);
2799 defsubr (&Sset_keymap_parent
);
2800 defsubr (&Smake_keymap
);
2801 defsubr (&Smake_sparse_keymap
);
2802 defsubr (&Scopy_keymap
);
2803 defsubr (&Skey_binding
);
2804 defsubr (&Slocal_key_binding
);
2805 defsubr (&Sglobal_key_binding
);
2806 defsubr (&Sminor_mode_key_binding
);
2807 defsubr (&Sdefine_key
);
2808 defsubr (&Slookup_key
);
2809 defsubr (&Sdefine_prefix_command
);
2810 defsubr (&Suse_global_map
);
2811 defsubr (&Suse_local_map
);
2812 defsubr (&Scurrent_local_map
);
2813 defsubr (&Scurrent_global_map
);
2814 defsubr (&Scurrent_minor_mode_maps
);
2815 defsubr (&Saccessible_keymaps
);
2816 defsubr (&Skey_description
);
2817 defsubr (&Sdescribe_vector
);
2818 defsubr (&Ssingle_key_description
);
2819 defsubr (&Stext_char_description
);
2820 defsubr (&Swhere_is_internal
);
2821 defsubr (&Sdescribe_bindings
);
2822 defsubr (&Sapropos_internal
);
2829 initial_define_key (global_map
, 033, "ESC-prefix");
2830 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");