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. */
30 #include "termhooks.h"
31 #include "blockinput.h"
34 #define min(a, b) ((a) < (b) ? (a) : (b))
36 /* The number of elements in keymap vectors. */
37 #define DENSE_TABLE_SIZE (0200)
39 /* Actually allocate storage for these variables */
41 Lisp_Object current_global_map
; /* Current global keymap */
43 Lisp_Object global_map
; /* default global key bindings */
45 Lisp_Object meta_map
; /* The keymap used for globally bound
46 ESC-prefixed default commands */
48 Lisp_Object control_x_map
; /* The keymap used for globally bound
49 C-x-prefixed default commands */
51 /* was MinibufLocalMap */
52 Lisp_Object Vminibuffer_local_map
;
53 /* The keymap used by the minibuf for local
54 bindings when spaces are allowed in the
57 /* was MinibufLocalNSMap */
58 Lisp_Object Vminibuffer_local_ns_map
;
59 /* The keymap used by the minibuf for local
60 bindings when spaces are not encouraged
63 /* keymap used for minibuffers when doing completion */
64 /* was MinibufLocalCompletionMap */
65 Lisp_Object Vminibuffer_local_completion_map
;
67 /* keymap used for minibuffers when doing completion and require a match */
68 /* was MinibufLocalMustMatchMap */
69 Lisp_Object Vminibuffer_local_must_match_map
;
71 /* Alist of minor mode variables and keymaps. */
72 Lisp_Object Vminor_mode_map_alist
;
74 /* Alist of major-mode-specific overrides for
75 minor mode variables and keymaps. */
76 Lisp_Object Vminor_mode_overriding_map_alist
;
78 /* Keymap mapping ASCII function key sequences onto their preferred forms.
79 Initialized by the terminal-specific lisp files. See DEFVAR for more
81 Lisp_Object Vfunction_key_map
;
83 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
84 Lisp_Object Vkey_translation_map
;
86 /* A list of all commands given new bindings since a certain time
87 when nil was stored here.
88 This is used to speed up recomputation of menu key equivalents
89 when Emacs starts up. t means don't record anything here. */
90 Lisp_Object Vdefine_key_rebound_commands
;
92 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
;
94 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
95 in a string key sequence is equivalent to prefixing with this
97 extern Lisp_Object meta_prefix_char
;
99 extern Lisp_Object Voverriding_local_map
;
101 static Lisp_Object
define_as_prefix ();
102 static Lisp_Object
describe_buffer_bindings ();
103 static void describe_command (), describe_translation ();
104 static void describe_map ();
105 Lisp_Object
Fcopy_keymap ();
107 /* Keymap object support - constructors and predicates. */
109 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
110 "Construct and return a new keymap, of the form (keymap VECTOR . ALIST).\n\
111 VECTOR is a vector which holds the bindings for the ASCII\n\
112 characters. ALIST is an assoc-list which holds bindings for function keys,\n\
113 mouse events, and any other things that appear in the input stream.\n\
114 All entries in it are initially nil, meaning \"command undefined\".\n\n\
115 The optional arg STRING supplies a menu name for the keymap\n\
116 in case you use it as a menu with `x-popup-menu'.")
122 tail
= Fcons (string
, Qnil
);
125 return Fcons (Qkeymap
,
126 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
129 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
130 "Construct and return a new sparse-keymap list.\n\
131 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),\n\
132 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),\n\
133 which binds the function key or mouse event SYMBOL to DEFINITION.\n\
134 Initially the alist is nil.\n\n\
135 The optional arg STRING supplies a menu name for the keymap\n\
136 in case you use it as a menu with `x-popup-menu'.")
141 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
142 return Fcons (Qkeymap
, Qnil
);
145 /* This function is used for installing the standard key bindings
146 at initialization time.
150 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
153 initial_define_key (keymap
, key
, defname
)
158 store_in_keymap (keymap
, make_number (key
), intern (defname
));
162 initial_define_lispy_key (keymap
, keyname
, defname
)
167 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
170 /* Define character fromchar in map frommap as an alias for character
171 tochar in map tomap. Subsequent redefinitions of the latter WILL
172 affect the former. */
176 synkey (frommap
, fromchar
, tomap
, tochar
)
177 struct Lisp_Vector
*frommap
, *tomap
;
178 int fromchar
, tochar
;
181 XSETVECTOR (v
, tomap
);
182 XSETFASTINT (c
, tochar
);
183 frommap
->contents
[fromchar
] = Fcons (v
, c
);
187 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
188 "Return t if OBJECT is a keymap.\n\
190 A keymap is a list (keymap . ALIST),\n\
191 or a symbol whose function definition is itself a keymap.\n\
192 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
193 a vector of densely packed bindings for small character codes\n\
194 is also allowed as an element.")
198 return (NILP (get_keymap_1 (object
, 0, 0)) ? Qnil
: Qt
);
201 /* Check that OBJECT is a keymap (after dereferencing through any
202 symbols). If it is, return it.
204 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
205 is an autoload form, do the autoload and try again.
206 If AUTOLOAD is nonzero, callers must assume GC is possible.
208 ERROR controls how we respond if OBJECT isn't a keymap.
209 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
211 Note that most of the time, we don't want to pursue autoloads.
212 Functions like Faccessible_keymaps which scan entire keymap trees
213 shouldn't load every autoloaded keymap. I'm not sure about this,
214 but it seems to me that only read_key_sequence, Flookup_key, and
215 Fdefine_key should cause keymaps to be autoloaded. */
218 get_keymap_1 (object
, error
, autoload
)
225 tem
= indirect_function (object
);
226 if (CONSP (tem
) && EQ (XCONS (tem
)->car
, Qkeymap
))
229 /* Should we do an autoload? Autoload forms for keymaps have
230 Qkeymap as their fifth element. */
234 && EQ (XCONS (tem
)->car
, Qautoload
))
238 tail
= Fnth (make_number (4), tem
);
239 if (EQ (tail
, Qkeymap
))
241 struct gcpro gcpro1
, gcpro2
;
243 GCPRO2 (tem
, object
);
244 do_autoload (tem
, object
);
252 wrong_type_argument (Qkeymapp
, object
);
258 /* Follow any symbol chaining, and return the keymap denoted by OBJECT.
259 If OBJECT doesn't denote a keymap at all, signal an error. */
264 return get_keymap_1 (object
, 1, 0);
267 /* Return the parent map of the keymap MAP, or nil if it has none.
268 We assume that MAP is a valid keymap. */
270 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
271 "Return the parent keymap of KEYMAP.")
277 keymap
= get_keymap_1 (keymap
, 1, 1);
279 /* Skip past the initial element `keymap'. */
280 list
= XCONS (keymap
)->cdr
;
281 for (; CONSP (list
); list
= XCONS (list
)->cdr
)
283 /* See if there is another `keymap'. */
284 if (EQ (Qkeymap
, XCONS (list
)->car
))
291 /* Set the parent keymap of MAP to PARENT. */
293 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
294 "Modify KEYMAP to set its parent map to PARENT.\n\
295 PARENT should be nil or another keymap.")
297 Lisp_Object keymap
, parent
;
299 Lisp_Object list
, prev
;
302 keymap
= get_keymap_1 (keymap
, 1, 1);
304 parent
= get_keymap_1 (parent
, 1, 1);
306 /* Skip past the initial element `keymap'. */
310 list
= XCONS (prev
)->cdr
;
311 /* If there is a parent keymap here, replace it.
312 If we came to the end, add the parent in PREV. */
313 if (! CONSP (list
) || EQ (Qkeymap
, XCONS (list
)->car
))
315 /* If we already have the right parent, return now
316 so that we avoid the loops below. */
317 if (EQ (XCONS (prev
)->cdr
, parent
))
320 XCONS (prev
)->cdr
= parent
;
326 /* Scan through for submaps, and set their parents too. */
328 for (list
= XCONS (keymap
)->cdr
; CONSP (list
); list
= XCONS (list
)->cdr
)
330 /* Stop the scan when we come to the parent. */
331 if (EQ (XCONS (list
)->car
, Qkeymap
))
334 /* If this element holds a prefix map, deal with it. */
335 if (CONSP (XCONS (list
)->car
)
336 && CONSP (XCONS (XCONS (list
)->car
)->cdr
))
337 fix_submap_inheritance (keymap
, XCONS (XCONS (list
)->car
)->car
,
338 XCONS (XCONS (list
)->car
)->cdr
);
340 if (VECTORP (XCONS (list
)->car
))
341 for (i
= 0; i
< XVECTOR (XCONS (list
)->car
)->size
; i
++)
342 if (CONSP (XVECTOR (XCONS (list
)->car
)->contents
[i
]))
343 fix_submap_inheritance (keymap
, make_number (i
),
344 XVECTOR (XCONS (list
)->car
)->contents
[i
]);
346 if (CHAR_TABLE_P (XCONS (list
)->car
))
348 Lisp_Object indices
[3];
350 map_char_table (fix_submap_inheritance
, Qnil
, XCONS (list
)->car
,
358 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
359 if EVENT is also a prefix in MAP's parent,
360 make sure that SUBMAP inherits that definition as its own parent. */
363 fix_submap_inheritance (map
, event
, submap
)
364 Lisp_Object map
, event
, submap
;
366 Lisp_Object map_parent
, parent_entry
;
368 /* SUBMAP is a cons that we found as a key binding.
369 Discard the other things found in a menu key binding. */
372 && STRINGP (XCONS (submap
)->car
))
374 submap
= XCONS (submap
)->cdr
;
375 /* Also remove a menu help string, if any,
376 following the menu item name. */
377 if (CONSP (submap
) && STRINGP (XCONS (submap
)->car
))
378 submap
= XCONS (submap
)->cdr
;
379 /* Also remove the sublist that caches key equivalences, if any. */
381 && CONSP (XCONS (submap
)->car
))
384 carcar
= XCONS (XCONS (submap
)->car
)->car
;
385 if (NILP (carcar
) || VECTORP (carcar
))
386 submap
= XCONS (submap
)->cdr
;
390 /* If it isn't a keymap now, there's no work to do. */
392 || ! EQ (XCONS (submap
)->car
, Qkeymap
))
395 map_parent
= Fkeymap_parent (map
);
396 if (! NILP (map_parent
))
397 parent_entry
= access_keymap (map_parent
, event
, 0, 0);
401 /* If MAP's parent has something other than a keymap,
402 our own submap shadows it completely, so use nil as SUBMAP's parent. */
403 if (! (CONSP (parent_entry
) && EQ (XCONS (parent_entry
)->car
, Qkeymap
)))
406 if (! EQ (parent_entry
, submap
))
407 Fset_keymap_parent (submap
, parent_entry
);
410 /* Look up IDX in MAP. IDX may be any sort of event.
411 Note that this does only one level of lookup; IDX must be a single
412 event, not a sequence.
414 If T_OK is non-zero, bindings for Qt are treated as default
415 bindings; any key left unmentioned by other tables and bindings is
416 given the binding of Qt.
418 If T_OK is zero, bindings for Qt are not treated specially.
420 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
423 access_keymap (map
, idx
, t_ok
, noinherit
)
432 /* If idx is a list (some sort of mouse click, perhaps?),
433 the index we want to use is the car of the list, which
434 ought to be a symbol. */
435 idx
= EVENT_HEAD (idx
);
437 /* If idx is a symbol, it might have modifiers, which need to
438 be put in the canonical order. */
440 idx
= reorder_modifiers (idx
);
441 else if (INTEGERP (idx
))
442 /* Clobber the high bits that can be present on a machine
443 with more than 24 bits of integer. */
444 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
448 Lisp_Object t_binding
;
451 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
455 binding
= XCONS (tail
)->car
;
456 if (SYMBOLP (binding
))
458 /* If NOINHERIT, stop finding prefix definitions
459 after we pass a second occurrence of the `keymap' symbol. */
460 if (noinherit
&& EQ (binding
, Qkeymap
) && ! EQ (tail
, map
))
463 else if (CONSP (binding
))
465 if (EQ (XCONS (binding
)->car
, idx
))
467 val
= XCONS (binding
)->cdr
;
468 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
471 fix_submap_inheritance (map
, idx
, val
);
474 if (t_ok
&& EQ (XCONS (binding
)->car
, Qt
))
475 t_binding
= XCONS (binding
)->cdr
;
477 else if (VECTORP (binding
))
479 if (NATNUMP (idx
) && XFASTINT (idx
) < XVECTOR (binding
)->size
)
481 val
= XVECTOR (binding
)->contents
[XFASTINT (idx
)];
482 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
485 fix_submap_inheritance (map
, idx
, val
);
489 else if (CHAR_TABLE_P (binding
))
491 /* Character codes with modifiers
492 are not included in a char-table.
493 All character codes without modifiers are included. */
496 & (CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
497 | CHAR_SHIFT
| CHAR_CTL
| CHAR_META
)))
499 val
= Faref (binding
, idx
);
500 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
503 fix_submap_inheritance (map
, idx
, val
);
515 /* Given OBJECT which was found in a slot in a keymap,
516 trace indirect definitions to get the actual definition of that slot.
517 An indirect definition is a list of the form
518 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
519 and INDEX is the object to look up in KEYMAP to yield the definition.
521 Also if OBJECT has a menu string as the first element,
522 remove that. Also remove a menu help string as second element.
524 If AUTOLOAD is nonzero, load autoloadable keymaps
525 that are referred to with indirection. */
528 get_keyelt (object
, autoload
)
529 register Lisp_Object object
;
534 register Lisp_Object map
, tem
;
536 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
537 map
= get_keymap_1 (Fcar_safe (object
), 0, autoload
);
538 tem
= Fkeymapp (map
);
543 if (INTEGERP (key
) && (XINT (key
) & meta_modifier
))
545 object
= access_keymap (map
, meta_prefix_char
, 0, 0);
546 map
= get_keymap_1 (object
, 0, autoload
);
547 object
= access_keymap (map
,
548 make_number (XINT (key
) & ~meta_modifier
),
552 object
= access_keymap (map
, key
, 0, 0);
555 /* If the keymap contents looks like (STRING . DEFN),
557 Keymap alist elements like (CHAR MENUSTRING . DEFN)
558 will be used by HierarKey menus. */
559 else if (CONSP (object
)
560 && STRINGP (XCONS (object
)->car
))
562 object
= XCONS (object
)->cdr
;
563 /* Also remove a menu help string, if any,
564 following the menu item name. */
565 if (CONSP (object
) && STRINGP (XCONS (object
)->car
))
566 object
= XCONS (object
)->cdr
;
567 /* Also remove the sublist that caches key equivalences, if any. */
569 && CONSP (XCONS (object
)->car
))
572 carcar
= XCONS (XCONS (object
)->car
)->car
;
573 if (NILP (carcar
) || VECTORP (carcar
))
574 object
= XCONS (object
)->cdr
;
579 /* Anything else is really the value. */
585 store_in_keymap (keymap
, idx
, def
)
587 register Lisp_Object idx
;
588 register Lisp_Object def
;
590 /* If we are preparing to dump, and DEF is a menu element
591 with a menu item string, copy it to ensure it is not pure. */
592 if (CONSP (def
) && PURE_P (def
) && STRINGP (XCONS (def
)->car
))
593 def
= Fcons (XCONS (def
)->car
, XCONS (def
)->cdr
);
595 if (!CONSP (keymap
) || ! EQ (XCONS (keymap
)->car
, Qkeymap
))
596 error ("attempt to define a key in a non-keymap");
598 /* If idx is a list (some sort of mouse click, perhaps?),
599 the index we want to use is the car of the list, which
600 ought to be a symbol. */
601 idx
= EVENT_HEAD (idx
);
603 /* If idx is a symbol, it might have modifiers, which need to
604 be put in the canonical order. */
606 idx
= reorder_modifiers (idx
);
607 else if (INTEGERP (idx
))
608 /* Clobber the high bits that can be present on a machine
609 with more than 24 bits of integer. */
610 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
612 /* Scan the keymap for a binding of idx. */
616 /* The cons after which we should insert new bindings. If the
617 keymap has a table element, we record its position here, so new
618 bindings will go after it; this way, the table will stay
619 towards the front of the alist and character lookups in dense
620 keymaps will remain fast. Otherwise, this just points at the
621 front of the keymap. */
622 Lisp_Object insertion_point
;
624 insertion_point
= keymap
;
625 for (tail
= XCONS (keymap
)->cdr
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
629 elt
= XCONS (tail
)->car
;
632 if (NATNUMP (idx
) && XFASTINT (idx
) < XVECTOR (elt
)->size
)
634 XVECTOR (elt
)->contents
[XFASTINT (idx
)] = def
;
637 insertion_point
= tail
;
639 else if (CHAR_TABLE_P (elt
))
641 /* Character codes with modifiers
642 are not included in a char-table.
643 All character codes without modifiers are included. */
646 & (CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
647 | CHAR_SHIFT
| CHAR_CTL
| CHAR_META
)))
649 Faset (elt
, idx
, def
);
652 insertion_point
= tail
;
654 else if (CONSP (elt
))
656 if (EQ (idx
, XCONS (elt
)->car
))
658 XCONS (elt
)->cdr
= def
;
662 else if (SYMBOLP (elt
))
664 /* If we find a 'keymap' symbol in the spine of KEYMAP,
665 then we must have found the start of a second keymap
666 being used as the tail of KEYMAP, and a binding for IDX
667 should be inserted before it. */
668 if (EQ (elt
, Qkeymap
))
676 /* We have scanned the entire keymap, and not found a binding for
677 IDX. Let's add one. */
678 XCONS (insertion_point
)->cdr
679 = Fcons (Fcons (idx
, def
), XCONS (insertion_point
)->cdr
);
686 copy_keymap_1 (chartable
, idx
, elt
)
687 Lisp_Object chartable
, idx
, elt
;
689 if (!SYMBOLP (elt
) && ! NILP (Fkeymapp (elt
)))
690 Faset (chartable
, idx
, Fcopy_keymap (elt
));
693 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
694 "Return a copy of the keymap KEYMAP.\n\
695 The copy starts out with the same definitions of KEYMAP,\n\
696 but changing either the copy or KEYMAP does not affect the other.\n\
697 Any key definitions that are subkeymaps are recursively copied.\n\
698 However, a key definition which is a symbol whose definition is a keymap\n\
703 register Lisp_Object copy
, tail
;
705 copy
= Fcopy_alist (get_keymap (keymap
));
707 for (tail
= copy
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
711 elt
= XCONS (tail
)->car
;
712 if (CHAR_TABLE_P (elt
))
714 Lisp_Object indices
[3];
716 elt
= Fcopy_sequence (elt
);
717 XCONS (tail
)->car
= elt
;
719 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, 0, indices
);
721 else if (VECTORP (elt
))
725 elt
= Fcopy_sequence (elt
);
726 XCONS (tail
)->car
= elt
;
728 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
729 if (!SYMBOLP (XVECTOR (elt
)->contents
[i
])
730 && ! NILP (Fkeymapp (XVECTOR (elt
)->contents
[i
])))
731 XVECTOR (elt
)->contents
[i
]
732 = Fcopy_keymap (XVECTOR (elt
)->contents
[i
]);
734 else if (CONSP (elt
))
736 /* Skip the optional menu string. */
737 if (CONSP (XCONS (elt
)->cdr
)
738 && STRINGP (XCONS (XCONS (elt
)->cdr
)->car
))
742 /* Copy the cell, since copy-alist didn't go this deep. */
743 XCONS (elt
)->cdr
= Fcons (XCONS (XCONS (elt
)->cdr
)->car
,
744 XCONS (XCONS (elt
)->cdr
)->cdr
);
745 elt
= XCONS (elt
)->cdr
;
747 /* Also skip the optional menu help string. */
748 if (CONSP (XCONS (elt
)->cdr
)
749 && STRINGP (XCONS (XCONS (elt
)->cdr
)->car
))
751 XCONS (elt
)->cdr
= Fcons (XCONS (XCONS (elt
)->cdr
)->car
,
752 XCONS (XCONS (elt
)->cdr
)->cdr
);
753 elt
= XCONS (elt
)->cdr
;
755 /* There may also be a list that caches key equivalences.
756 Just delete it for the new keymap. */
757 if (CONSP (XCONS (elt
)->cdr
)
758 && CONSP (XCONS (XCONS (elt
)->cdr
)->car
)
759 && (NILP (tem
= XCONS (XCONS (XCONS (elt
)->cdr
)->car
)->car
)
761 XCONS (elt
)->cdr
= XCONS (XCONS (elt
)->cdr
)->cdr
;
764 && ! SYMBOLP (XCONS (elt
)->cdr
)
765 && ! NILP (Fkeymapp (XCONS (elt
)->cdr
)))
766 XCONS (elt
)->cdr
= Fcopy_keymap (XCONS (elt
)->cdr
);
773 /* Simple Keymap mutators and accessors. */
775 /* GC is possible in this function if it autoloads a keymap. */
777 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
778 "Args KEYMAP, KEY, DEF. Define key sequence KEY, in KEYMAP, as DEF.\n\
779 KEYMAP is a keymap. KEY is a string or a vector of symbols and characters\n\
780 meaning a sequence of keystrokes and events.\n\
781 Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
782 can be included if you use a vector.\n\
783 DEF is anything that can be a key's definition:\n\
784 nil (means key is undefined in this keymap),\n\
785 a command (a Lisp function suitable for interactive calling)\n\
786 a string (treated as a keyboard macro),\n\
787 a keymap (to define a prefix key),\n\
788 a symbol. When the key is looked up, the symbol will stand for its\n\
789 function definition, which should at that time be one of the above,\n\
790 or another symbol whose function definition is used, etc.\n\
791 a cons (STRING . DEFN), meaning that DEFN is the definition\n\
792 (DEFN should be a valid definition in its own right),\n\
793 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.\n\
795 If KEYMAP is a sparse keymap, the pair binding KEY to DEF is added at\n\
796 the front of KEYMAP.")
803 register Lisp_Object c
;
804 register Lisp_Object tem
;
805 register Lisp_Object cmd
;
809 struct gcpro gcpro1
, gcpro2
, gcpro3
;
811 keymap
= get_keymap_1 (keymap
, 1, 1);
813 if (!VECTORP (key
) && !STRINGP (key
))
814 key
= wrong_type_argument (Qarrayp
, key
);
816 length
= XFASTINT (Flength (key
));
820 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
821 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
823 GCPRO3 (keymap
, key
, def
);
826 meta_bit
= meta_modifier
;
833 c
= Faref (key
, make_number (idx
));
835 if (CONSP (c
) && lucid_event_type_list_p (c
))
836 c
= Fevent_convert_list (c
);
839 && (XINT (c
) & meta_bit
)
842 c
= meta_prefix_char
;
848 XSETINT (c
, XINT (c
) & ~meta_bit
);
854 if (! INTEGERP (c
) && ! SYMBOLP (c
) && ! CONSP (c
))
855 error ("Key sequence contains invalid events");
858 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
860 cmd
= get_keyelt (access_keymap (keymap
, c
, 0, 1), 1);
862 /* If this key is undefined, make it a prefix. */
864 cmd
= define_as_prefix (keymap
, c
);
866 keymap
= get_keymap_1 (cmd
, 0, 1);
868 /* We must use Fkey_description rather than just passing key to
869 error; key might be a vector, not a string. */
870 error ("Key sequence %s uses invalid prefix characters",
871 XSTRING (Fkey_description (key
))->data
);
875 /* Value is number if KEY is too long; NIL if valid but has no definition. */
876 /* GC is possible in this function if it autoloads a keymap. */
878 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
879 "In keymap KEYMAP, look up key sequence KEY. Return the definition.\n\
880 nil means undefined. See doc of `define-key' for kinds of definitions.\n\
882 A number as value means KEY is \"too long\";\n\
883 that is, characters or symbols in it except for the last one\n\
884 fail to be a valid sequence of prefix characters in KEYMAP.\n\
885 The number is how many characters at the front of KEY\n\
886 it takes to reach a non-prefix command.\n\
888 Normally, `lookup-key' ignores bindings for t, which act as default\n\
889 bindings, used when nothing else in the keymap applies; this makes it\n\
890 usable as a general function for probing keymaps. However, if the\n\
891 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will\n\
892 recognize the default bindings, just as `read-key-sequence' does.")
893 (keymap
, key
, accept_default
)
894 register Lisp_Object keymap
;
896 Lisp_Object accept_default
;
899 register Lisp_Object tem
;
900 register Lisp_Object cmd
;
901 register Lisp_Object c
;
904 int t_ok
= ! NILP (accept_default
);
908 keymap
= get_keymap_1 (keymap
, 1, 1);
910 if (!VECTORP (key
) && !STRINGP (key
))
911 key
= wrong_type_argument (Qarrayp
, key
);
913 length
= XFASTINT (Flength (key
));
918 meta_bit
= meta_modifier
;
927 c
= Faref (key
, make_number (idx
));
929 if (CONSP (c
) && lucid_event_type_list_p (c
))
930 c
= Fevent_convert_list (c
);
933 && (XINT (c
) & meta_bit
)
936 c
= meta_prefix_char
;
942 XSETINT (c
, XINT (c
) & ~meta_bit
);
948 cmd
= get_keyelt (access_keymap (keymap
, c
, t_ok
, 0), 1);
950 RETURN_UNGCPRO (cmd
);
952 keymap
= get_keymap_1 (cmd
, 0, 1);
954 RETURN_UNGCPRO (make_number (idx
));
960 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
961 Assume that currently it does not define C at all.
962 Return the keymap. */
965 define_as_prefix (keymap
, c
)
966 Lisp_Object keymap
, c
;
968 Lisp_Object inherit
, cmd
;
970 cmd
= Fmake_sparse_keymap (Qnil
);
971 /* If this key is defined as a prefix in an inherited keymap,
972 make it a prefix in this map, and make its definition
973 inherit the other prefix definition. */
974 inherit
= access_keymap (keymap
, c
, 0, 0);
976 /* This code is needed to do the right thing in the following case:
977 keymap A inherits from B,
978 you define KEY as a prefix in A,
979 then later you define KEY as a prefix in B.
980 We want the old prefix definition in A to inherit from that in B.
981 It is hard to do that retroactively, so this code
982 creates the prefix in B right away.
984 But it turns out that this code causes problems immediately
985 when the prefix in A is defined: it causes B to define KEY
986 as a prefix with no subcommands.
988 So I took out this code. */
991 /* If there's an inherited keymap
992 and it doesn't define this key,
993 make it define this key. */
996 for (tail
= Fcdr (keymap
); CONSP (tail
); tail
= XCONS (tail
)->cdr
)
997 if (EQ (XCONS (tail
)->car
, Qkeymap
))
1001 inherit
= define_as_prefix (tail
, c
);
1005 cmd
= nconc2 (cmd
, inherit
);
1006 store_in_keymap (keymap
, c
, cmd
);
1011 /* Append a key to the end of a key sequence. We always make a vector. */
1014 append_key (key_sequence
, key
)
1015 Lisp_Object key_sequence
, key
;
1017 Lisp_Object args
[2];
1019 args
[0] = key_sequence
;
1021 args
[1] = Fcons (key
, Qnil
);
1022 return Fvconcat (2, args
);
1026 /* Global, local, and minor mode keymap stuff. */
1028 /* We can't put these variables inside current_minor_maps, since under
1029 some systems, static gets macro-defined to be the empty string.
1031 static Lisp_Object
*cmm_modes
, *cmm_maps
;
1032 static int cmm_size
;
1034 /* Error handler used in current_minor_maps. */
1036 current_minor_maps_error ()
1041 /* Store a pointer to an array of the keymaps of the currently active
1042 minor modes in *buf, and return the number of maps it contains.
1044 This function always returns a pointer to the same buffer, and may
1045 free or reallocate it, so if you want to keep it for a long time or
1046 hand it out to lisp code, copy it. This procedure will be called
1047 for every key sequence read, so the nice lispy approach (return a
1048 new assoclist, list, what have you) for each invocation would
1049 result in a lot of consing over time.
1051 If we used xrealloc/xmalloc and ran out of memory, they would throw
1052 back to the command loop, which would try to read a key sequence,
1053 which would call this function again, resulting in an infinite
1054 loop. Instead, we'll use realloc/malloc and silently truncate the
1055 list, let the key sequence be read, and hope some other piece of
1056 code signals the error. */
1058 current_minor_maps (modeptr
, mapptr
)
1059 Lisp_Object
**modeptr
, **mapptr
;
1062 int list_number
= 0;
1063 Lisp_Object alist
, assoc
, var
, val
;
1064 Lisp_Object lists
[2];
1066 lists
[0] = Vminor_mode_overriding_map_alist
;
1067 lists
[1] = Vminor_mode_map_alist
;
1069 for (list_number
= 0; list_number
< 2; list_number
++)
1070 for (alist
= lists
[list_number
];
1072 alist
= XCONS (alist
)->cdr
)
1073 if ((assoc
= XCONS (alist
)->car
, CONSP (assoc
))
1074 && (var
= XCONS (assoc
)->car
, SYMBOLP (var
))
1075 && (val
= find_symbol_value (var
), ! EQ (val
, Qunbound
))
1082 Lisp_Object
*newmodes
, *newmaps
;
1089 = (Lisp_Object
*) realloc (cmm_modes
,
1090 cmm_size
* sizeof (Lisp_Object
));
1092 = (Lisp_Object
*) realloc (cmm_maps
,
1093 cmm_size
* sizeof (Lisp_Object
));
1101 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
1103 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
1107 if (newmaps
&& newmodes
)
1109 cmm_modes
= newmodes
;
1116 /* Get the keymap definition--or nil if it is not defined. */
1117 temp
= internal_condition_case_1 (Findirect_function
,
1119 Qerror
, current_minor_maps_error
);
1123 cmm_maps
[i
] = temp
;
1128 if (modeptr
) *modeptr
= cmm_modes
;
1129 if (mapptr
) *mapptr
= cmm_maps
;
1133 /* GC is possible in this function if it autoloads a keymap. */
1135 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 2, 0,
1136 "Return the binding for command KEY in current keymaps.\n\
1137 KEY is a string or vector, a sequence of keystrokes.\n\
1138 The binding is probably a symbol with a function definition.\n\
1140 Normally, `key-binding' ignores bindings for t, which act as default\n\
1141 bindings, used when nothing else in the keymap applies; this makes it\n\
1142 usable as a general function for probing keymaps. However, if the\n\
1143 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\
1144 recognize the default bindings, just as `read-key-sequence' does.")
1145 (key
, accept_default
)
1146 Lisp_Object key
, accept_default
;
1148 Lisp_Object
*maps
, value
;
1150 struct gcpro gcpro1
;
1154 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1156 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1157 key
, accept_default
);
1158 if (! NILP (value
) && !INTEGERP (value
))
1159 RETURN_UNGCPRO (value
);
1161 else if (!NILP (Voverriding_local_map
))
1163 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1164 if (! NILP (value
) && !INTEGERP (value
))
1165 RETURN_UNGCPRO (value
);
1171 nmaps
= current_minor_maps (0, &maps
);
1172 /* Note that all these maps are GCPRO'd
1173 in the places where we found them. */
1175 for (i
= 0; i
< nmaps
; i
++)
1176 if (! NILP (maps
[i
]))
1178 value
= Flookup_key (maps
[i
], key
, accept_default
);
1179 if (! NILP (value
) && !INTEGERP (value
))
1180 RETURN_UNGCPRO (value
);
1183 local
= get_local_map (PT
, current_buffer
);
1187 value
= Flookup_key (local
, key
, accept_default
);
1188 if (! NILP (value
) && !INTEGERP (value
))
1189 RETURN_UNGCPRO (value
);
1193 value
= Flookup_key (current_global_map
, key
, accept_default
);
1195 if (! NILP (value
) && !INTEGERP (value
))
1201 /* GC is possible in this function if it autoloads a keymap. */
1203 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1204 "Return the binding for command KEYS in current local keymap only.\n\
1205 KEYS is a string, a sequence of keystrokes.\n\
1206 The binding is probably a symbol with a function definition.\n\
1208 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1209 bindings; see the description of `lookup-key' for more details about this.")
1210 (keys
, accept_default
)
1211 Lisp_Object keys
, accept_default
;
1213 register Lisp_Object map
;
1214 map
= current_buffer
->keymap
;
1217 return Flookup_key (map
, keys
, accept_default
);
1220 /* GC is possible in this function if it autoloads a keymap. */
1222 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1223 "Return the binding for command KEYS in current global keymap only.\n\
1224 KEYS is a string, a sequence of keystrokes.\n\
1225 The binding is probably a symbol with a function definition.\n\
1226 This function's return values are the same as those of lookup-key\n\
1229 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1230 bindings; see the description of `lookup-key' for more details about this.")
1231 (keys
, accept_default
)
1232 Lisp_Object keys
, accept_default
;
1234 return Flookup_key (current_global_map
, keys
, accept_default
);
1237 /* GC is possible in this function if it autoloads a keymap. */
1239 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1240 "Find the visible minor mode bindings of KEY.\n\
1241 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the\n\
1242 the symbol which names the minor mode binding KEY, and BINDING is\n\
1243 KEY's definition in that mode. In particular, if KEY has no\n\
1244 minor-mode bindings, return nil. If the first binding is a\n\
1245 non-prefix, all subsequent bindings will be omitted, since they would\n\
1246 be ignored. Similarly, the list doesn't include non-prefix bindings\n\
1247 that come after prefix bindings.\n\
1249 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1250 bindings; see the description of `lookup-key' for more details about this.")
1251 (key
, accept_default
)
1252 Lisp_Object key
, accept_default
;
1254 Lisp_Object
*modes
, *maps
;
1256 Lisp_Object binding
;
1258 struct gcpro gcpro1
, gcpro2
;
1260 nmaps
= current_minor_maps (&modes
, &maps
);
1261 /* Note that all these maps are GCPRO'd
1262 in the places where we found them. */
1265 GCPRO2 (key
, binding
);
1267 for (i
= j
= 0; i
< nmaps
; i
++)
1268 if (! NILP (maps
[i
])
1269 && ! NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1270 && !INTEGERP (binding
))
1272 if (! NILP (get_keymap (binding
)))
1273 maps
[j
++] = Fcons (modes
[i
], binding
);
1275 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1279 return Flist (j
, maps
);
1282 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 2, 0,
1283 "Define COMMAND as a prefix command. COMMAND should be a symbol.\n\
1284 A new sparse keymap is stored as COMMAND's function definition and its value.\n\
1285 If a second optional argument MAPVAR is given, the map is stored as\n\
1286 its value instead of as COMMAND's value; but COMMAND is still defined\n\
1289 Lisp_Object command
, mapvar
;
1292 map
= Fmake_sparse_keymap (Qnil
);
1293 Ffset (command
, map
);
1297 Fset (command
, map
);
1301 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1302 "Select KEYMAP as the global keymap.")
1306 keymap
= get_keymap (keymap
);
1307 current_global_map
= keymap
;
1312 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1313 "Select KEYMAP as the local keymap.\n\
1314 If KEYMAP is nil, that means no local keymap.")
1319 keymap
= get_keymap (keymap
);
1321 current_buffer
->keymap
= keymap
;
1326 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1327 "Return current buffer's local keymap, or nil if it has none.")
1330 return current_buffer
->keymap
;
1333 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1334 "Return the current global keymap.")
1337 return current_global_map
;
1340 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1341 "Return a list of keymaps for the minor modes of the current buffer.")
1345 int nmaps
= current_minor_maps (0, &maps
);
1347 return Flist (nmaps
, maps
);
1350 /* Help functions for describing and documenting keymaps. */
1352 static void accessible_keymaps_char_table ();
1354 /* This function cannot GC. */
1356 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1358 "Find all keymaps accessible via prefix characters from KEYMAP.\n\
1359 Returns a list of elements of the form (KEYS . MAP), where the sequence\n\
1360 KEYS starting from KEYMAP gets you to MAP. These elements are ordered\n\
1361 so that the KEYS increase in length. The first element is ([] . KEYMAP).\n\
1362 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
1363 then the value includes only maps for prefixes that start with PREFIX.")
1365 Lisp_Object keymap
, prefix
;
1367 Lisp_Object maps
, good_maps
, tail
;
1370 /* no need for gcpro because we don't autoload any keymaps. */
1373 prefixlen
= XINT (Flength (prefix
));
1377 /* If a prefix was specified, start with the keymap (if any) for
1378 that prefix, so we don't waste time considering other prefixes. */
1380 tem
= Flookup_key (keymap
, prefix
, Qt
);
1381 /* Flookup_key may give us nil, or a number,
1382 if the prefix is not defined in this particular map.
1383 It might even give us a list that isn't a keymap. */
1384 tem
= get_keymap_1 (tem
, 0, 0);
1387 /* Convert PREFIX to a vector now, so that later on
1388 we don't have to deal with the possibility of a string. */
1389 if (STRINGP (prefix
))
1394 copy
= Fmake_vector (make_number (XSTRING (prefix
)->size
), Qnil
);
1395 for (i
= 0; i
< XSTRING (prefix
)->size
; i
++)
1397 int c
= XSTRING (prefix
)->data
[i
];
1399 c
^= 0200 | meta_modifier
;
1400 XVECTOR (copy
)->contents
[i
] = make_number (c
);
1404 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1410 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1411 get_keymap (keymap
)),
1414 /* For each map in the list maps,
1415 look at any other maps it points to,
1416 and stick them at the end if they are not already in the list.
1418 This is a breadth-first traversal, where tail is the queue of
1419 nodes, and maps accumulates a list of all nodes visited. */
1421 for (tail
= maps
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1423 register Lisp_Object thisseq
, thismap
;
1425 /* Does the current sequence end in the meta-prefix-char? */
1428 thisseq
= Fcar (Fcar (tail
));
1429 thismap
= Fcdr (Fcar (tail
));
1430 last
= make_number (XINT (Flength (thisseq
)) - 1);
1431 is_metized
= (XINT (last
) >= 0
1432 /* Don't metize the last char of PREFIX. */
1433 && XINT (last
) >= prefixlen
1434 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1436 for (; CONSP (thismap
); thismap
= XCONS (thismap
)->cdr
)
1440 elt
= XCONS (thismap
)->car
;
1444 if (CHAR_TABLE_P (elt
))
1446 Lisp_Object indices
[3];
1448 map_char_table (accessible_keymaps_char_table
, Qnil
,
1449 elt
, Fcons (maps
, Fcons (tail
, thisseq
)),
1452 else if (VECTORP (elt
))
1456 /* Vector keymap. Scan all the elements. */
1457 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
1459 register Lisp_Object tem
;
1460 register Lisp_Object cmd
;
1462 cmd
= get_keyelt (XVECTOR (elt
)->contents
[i
], 0);
1463 if (NILP (cmd
)) continue;
1464 tem
= Fkeymapp (cmd
);
1467 cmd
= get_keymap (cmd
);
1468 /* Ignore keymaps that are already added to maps. */
1469 tem
= Frassq (cmd
, maps
);
1472 /* If the last key in thisseq is meta-prefix-char,
1473 turn it into a meta-ized keystroke. We know
1474 that the event we're about to append is an
1475 ascii keystroke since we're processing a
1479 int meta_bit
= meta_modifier
;
1480 tem
= Fcopy_sequence (thisseq
);
1482 Faset (tem
, last
, make_number (i
| meta_bit
));
1484 /* This new sequence is the same length as
1485 thisseq, so stick it in the list right
1488 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1492 tem
= append_key (thisseq
, make_number (i
));
1493 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1499 else if (CONSP (elt
))
1501 register Lisp_Object cmd
, tem
, filter
;
1503 cmd
= get_keyelt (XCONS (elt
)->cdr
, 0);
1504 /* Ignore definitions that aren't keymaps themselves. */
1505 tem
= Fkeymapp (cmd
);
1508 /* Ignore keymaps that have been seen already. */
1509 cmd
= get_keymap (cmd
);
1510 tem
= Frassq (cmd
, maps
);
1513 /* Let elt be the event defined by this map entry. */
1514 elt
= XCONS (elt
)->car
;
1516 /* If the last key in thisseq is meta-prefix-char, and
1517 this entry is a binding for an ascii keystroke,
1518 turn it into a meta-ized keystroke. */
1519 if (is_metized
&& INTEGERP (elt
))
1521 Lisp_Object element
;
1524 tem
= Fvconcat (1, &element
);
1525 XSETFASTINT (XVECTOR (tem
)->contents
[XINT (last
)],
1526 XINT (elt
) | meta_modifier
);
1528 /* This new sequence is the same length as
1529 thisseq, so stick it in the list right
1532 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1536 Fcons (Fcons (append_key (thisseq
, elt
), cmd
),
1547 /* Now find just the maps whose access prefixes start with PREFIX. */
1550 for (; CONSP (maps
); maps
= XCONS (maps
)->cdr
)
1552 Lisp_Object elt
, thisseq
;
1553 elt
= XCONS (maps
)->car
;
1554 thisseq
= XCONS (elt
)->car
;
1555 /* The access prefix must be at least as long as PREFIX,
1556 and the first elements must match those of PREFIX. */
1557 if (XINT (Flength (thisseq
)) >= prefixlen
)
1560 for (i
= 0; i
< prefixlen
; i
++)
1563 XSETFASTINT (i1
, i
);
1564 if (!EQ (Faref (thisseq
, i1
), Faref (prefix
, i1
)))
1568 good_maps
= Fcons (elt
, good_maps
);
1572 return Fnreverse (good_maps
);
1576 accessible_keymaps_char_table (args
, index
, cmd
)
1577 Lisp_Object args
, index
, cmd
;
1580 Lisp_Object maps
, tail
, thisseq
;
1585 maps
= XCONS (args
)->car
;
1586 tail
= XCONS (XCONS (args
)->cdr
)->car
;
1587 thisseq
= XCONS (XCONS (args
)->cdr
)->cdr
;
1589 tem
= Fkeymapp (cmd
);
1592 cmd
= get_keymap (cmd
);
1593 /* Ignore keymaps that are already added to maps. */
1594 tem
= Frassq (cmd
, maps
);
1597 tem
= append_key (thisseq
, index
);
1598 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1603 Lisp_Object Qsingle_key_description
, Qkey_description
;
1605 /* This function cannot GC. */
1607 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 1, 0,
1608 "Return a pretty description of key-sequence KEYS.\n\
1609 Control characters turn into \"C-foo\" sequences, meta into \"M-foo\"\n\
1610 spaces are put between sequence elements, etc.")
1622 vector
= Fmake_vector (Flength (keys
), Qnil
);
1623 for (i
= 0; i
< XSTRING (keys
)->size
; i
++)
1625 if (XSTRING (keys
)->data
[i
] & 0x80)
1626 XSETFASTINT (XVECTOR (vector
)->contents
[i
],
1627 meta_modifier
| (XSTRING (keys
)->data
[i
] & ~0x80));
1629 XSETFASTINT (XVECTOR (vector
)->contents
[i
],
1630 XSTRING (keys
)->data
[i
]);
1634 else if (!VECTORP (keys
))
1635 keys
= wrong_type_argument (Qarrayp
, keys
);
1637 /* In effect, this computes
1638 (mapconcat 'single-key-description keys " ")
1639 but we shouldn't use mapconcat because it can do GC. */
1641 len
= XVECTOR (keys
)->size
;
1642 sep
= build_string (" ");
1643 /* This has one extra element at the end that we don't pass to Fconcat. */
1644 args
= (Lisp_Object
*) alloca (len
* 2 * sizeof (Lisp_Object
));
1646 for (i
= 0; i
< len
; i
++)
1648 args
[i
* 2] = Fsingle_key_description (XVECTOR (keys
)->contents
[i
]);
1649 args
[i
* 2 + 1] = sep
;
1652 return Fconcat (len
* 2 - 1, args
);
1656 push_key_description (c
, p
)
1657 register unsigned int c
;
1660 /* Clear all the meaningless bits above the meta bit. */
1661 c
&= meta_modifier
| ~ - meta_modifier
;
1663 if (c
& alt_modifier
)
1669 if (c
& ctrl_modifier
)
1675 if (c
& hyper_modifier
)
1679 c
-= hyper_modifier
;
1681 if (c
& meta_modifier
)
1687 if (c
& shift_modifier
)
1691 c
-= shift_modifier
;
1693 if (c
& super_modifier
)
1697 c
-= super_modifier
;
1713 else if (c
== Ctl ('M'))
1723 if (c
> 0 && c
<= Ctl ('Z'))
1746 *p
++ = (7 & (c
>> 6)) + '0';
1747 *p
++ = (7 & (c
>> 3)) + '0';
1748 *p
++ = (7 & (c
>> 0)) + '0';
1753 *p
++ = (7 & (c
>> 15)) + '0';
1754 *p
++ = (7 & (c
>> 12)) + '0';
1755 *p
++ = (7 & (c
>> 9)) + '0';
1756 *p
++ = (7 & (c
>> 6)) + '0';
1757 *p
++ = (7 & (c
>> 3)) + '0';
1758 *p
++ = (7 & (c
>> 0)) + '0';
1764 /* This function cannot GC. */
1766 DEFUN ("single-key-description", Fsingle_key_description
, Ssingle_key_description
, 1, 1, 0,
1767 "Return a pretty description of command character KEY.\n\
1768 Control characters turn into C-whatever, etc.")
1774 key
= EVENT_HEAD (key
);
1776 if (INTEGERP (key
)) /* Normal character */
1778 *push_key_description (XUINT (key
), tem
) = 0;
1779 return build_string (tem
);
1781 else if (SYMBOLP (key
)) /* Function key or event-symbol */
1782 return Fsymbol_name (key
);
1783 else if (STRINGP (key
)) /* Buffer names in the menubar. */
1784 return Fcopy_sequence (key
);
1786 error ("KEY must be an integer, cons, symbol, or string");
1790 push_text_char_description (c
, p
)
1791 register unsigned int c
;
1803 *p
++ = c
+ 64; /* 'A' - 1 */
1815 /* This function cannot GC. */
1817 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
1818 "Return a pretty description of file-character CHARACTER.\n\
1819 Control characters turn into \"^char\", etc.")
1821 Lisp_Object character
;
1825 CHECK_NUMBER (character
, 0);
1827 if (!SINGLE_BYTE_CHAR_P (XFASTINT (character
)))
1830 int len
= non_ascii_char_to_string (XFASTINT (character
), tem
, &str
);
1832 return make_string (str
, len
);
1835 *push_text_char_description (XINT (character
) & 0377, tem
) = 0;
1837 return build_string (tem
);
1840 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
1843 ascii_sequence_p (seq
)
1847 int len
= XINT (Flength (seq
));
1849 for (i
= 0; i
< len
; i
++)
1851 Lisp_Object ii
, elt
;
1853 XSETFASTINT (ii
, i
);
1854 elt
= Faref (seq
, ii
);
1857 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
1865 /* where-is - finding a command in a set of keymaps. */
1867 static Lisp_Object
where_is_internal_1 ();
1868 static void where_is_internal_2 ();
1870 /* This function can GC if Flookup_key autoloads any keymaps. */
1872 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 4, 0,
1873 "Return list of keys that invoke DEFINITION.\n\
1874 If KEYMAP is non-nil, search only KEYMAP and the global keymap.\n\
1875 If KEYMAP is nil, search all the currently active keymaps.\n\
1877 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,\n\
1878 rather than a list of all possible key sequences.\n\
1879 If FIRSTONLY is the symbol `non-ascii', return the first binding found,\n\
1880 no matter what it is.\n\
1881 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters,\n\
1882 and entirely reject menu bindings.\n\
1884 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections\n\
1885 to other keymaps or slots. This makes it possible to search for an\n\
1886 indirect definition itself.")
1887 (definition
, keymap
, firstonly
, noindirect
)
1888 Lisp_Object definition
, keymap
;
1889 Lisp_Object firstonly
, noindirect
;
1892 Lisp_Object found
, sequences
;
1893 Lisp_Object keymap1
;
1894 int keymap_specified
= !NILP (keymap
);
1895 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
1896 /* 1 means ignore all menu bindings entirely. */
1897 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
1899 /* Find keymaps accessible from `keymap' or the current
1900 context. But don't muck with the value of `keymap',
1901 because `where_is_internal_1' uses it to check for
1902 shadowed bindings. */
1904 if (! keymap_specified
)
1906 #ifdef USE_TEXT_PROPERTIES
1907 keymap1
= get_local_map (PT
, current_buffer
);
1909 keymap1
= current_buffer
->keymap
;
1913 if (!NILP (keymap1
))
1914 maps
= nconc2 (Faccessible_keymaps (get_keymap (keymap1
), Qnil
),
1915 Faccessible_keymaps (get_keymap (current_global_map
),
1918 maps
= Faccessible_keymaps (get_keymap (current_global_map
), Qnil
);
1920 /* Put the minor mode keymaps on the front. */
1921 if (! keymap_specified
)
1924 minors
= Fnreverse (Fcurrent_minor_mode_maps ());
1925 while (!NILP (minors
))
1927 maps
= nconc2 (Faccessible_keymaps (get_keymap (XCONS (minors
)->car
),
1930 minors
= XCONS (minors
)->cdr
;
1934 GCPRO5 (definition
, keymap
, maps
, found
, sequences
);
1938 for (; !NILP (maps
); maps
= Fcdr (maps
))
1940 /* Key sequence to reach map, and the map that it reaches */
1941 register Lisp_Object
this, map
;
1943 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
1944 [M-CHAR] sequences, check if last character of the sequence
1945 is the meta-prefix char. */
1949 this = Fcar (Fcar (maps
));
1950 map
= Fcdr (Fcar (maps
));
1951 last
= make_number (XINT (Flength (this)) - 1);
1952 last_is_meta
= (XINT (last
) >= 0
1953 && EQ (Faref (this, last
), meta_prefix_char
));
1959 /* Because the code we want to run on each binding is rather
1960 large, we don't want to have two separate loop bodies for
1961 sparse keymap bindings and tables; we want to iterate one
1962 loop body over both keymap and vector bindings.
1964 For this reason, if Fcar (map) is a vector, we don't
1965 advance map to the next element until i indicates that we
1966 have finished off the vector. */
1967 Lisp_Object elt
, key
, binding
;
1968 elt
= XCONS (map
)->car
;
1969 map
= XCONS (map
)->cdr
;
1975 /* Set key and binding to the current key and binding, and
1976 advance map and i to the next binding. */
1979 Lisp_Object sequence
;
1981 /* In a vector, look at each element. */
1982 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
1984 binding
= XVECTOR (elt
)->contents
[i
];
1985 XSETFASTINT (key
, i
);
1986 sequence
= where_is_internal_1 (binding
, key
, definition
,
1987 noindirect
, keymap
, this,
1988 last
, nomenus
, last_is_meta
);
1989 if (!NILP (sequence
))
1990 sequences
= Fcons (sequence
, sequences
);
1993 else if (CHAR_TABLE_P (elt
))
1995 Lisp_Object indices
[3];
1998 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
1999 Fcons (keymap
, Qnil
)),
2000 Fcons (Fcons (this, last
),
2001 Fcons (make_number (nomenus
),
2002 make_number (last_is_meta
))));
2004 map_char_table (where_is_internal_2
, Qnil
, elt
, args
,
2006 sequences
= XCONS (XCONS (XCONS (args
)->car
)->cdr
)->cdr
;
2008 else if (CONSP (elt
))
2010 Lisp_Object sequence
;
2012 key
= XCONS (elt
)->car
;
2013 binding
= XCONS (elt
)->cdr
;
2015 sequence
= where_is_internal_1 (binding
, key
, definition
,
2016 noindirect
, keymap
, this,
2017 last
, nomenus
, last_is_meta
);
2018 if (!NILP (sequence
))
2019 sequences
= Fcons (sequence
, sequences
);
2023 for (; ! NILP (sequences
); sequences
= XCONS (sequences
)->cdr
)
2025 Lisp_Object sequence
;
2027 sequence
= XCONS (sequences
)->car
;
2029 /* It is a true unshadowed match. Record it, unless it's already
2030 been seen (as could happen when inheriting keymaps). */
2031 if (NILP (Fmember (sequence
, found
)))
2032 found
= Fcons (sequence
, found
);
2034 /* If firstonly is Qnon_ascii, then we can return the first
2035 binding we find. If firstonly is not Qnon_ascii but not
2036 nil, then we should return the first ascii-only binding
2038 if (EQ (firstonly
, Qnon_ascii
))
2039 RETURN_UNGCPRO (sequence
);
2040 else if (! NILP (firstonly
) && ascii_sequence_p (sequence
))
2041 RETURN_UNGCPRO (sequence
);
2048 found
= Fnreverse (found
);
2050 /* firstonly may have been t, but we may have gone all the way through
2051 the keymaps without finding an all-ASCII key sequence. So just
2052 return the best we could find. */
2053 if (! NILP (firstonly
))
2054 return Fcar (found
);
2059 /* This is the function that Fwhere_is_internal calls using map_char_table.
2061 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2063 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2064 Since map_char_table doesn't really use the return value from this function,
2065 we the result append to RESULT, the slot in ARGS. */
2068 where_is_internal_2 (args
, key
, binding
)
2069 Lisp_Object args
, key
, binding
;
2071 Lisp_Object definition
, noindirect
, keymap
, this, last
;
2072 Lisp_Object result
, sequence
;
2073 int nomenus
, last_is_meta
;
2075 result
= XCONS (XCONS (XCONS (args
)->car
)->cdr
)->cdr
;
2076 definition
= XCONS (XCONS (XCONS (args
)->car
)->car
)->car
;
2077 noindirect
= XCONS (XCONS (XCONS (args
)->car
)->car
)->cdr
;
2078 keymap
= XCONS (XCONS (XCONS (args
)->car
)->cdr
)->car
;
2079 this = XCONS (XCONS (XCONS (args
)->cdr
)->car
)->car
;
2080 last
= XCONS (XCONS (XCONS (args
)->cdr
)->car
)->cdr
;
2081 nomenus
= XFASTINT (XCONS (XCONS (XCONS (args
)->cdr
)->cdr
)->car
);
2082 last_is_meta
= XFASTINT (XCONS (XCONS (XCONS (args
)->cdr
)->cdr
)->cdr
);
2084 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
, keymap
,
2085 this, last
, nomenus
, last_is_meta
);
2087 if (!NILP (sequence
))
2088 XCONS (XCONS (XCONS (args
)->car
)->cdr
)->cdr
2089 = Fcons (sequence
, result
);
2093 where_is_internal_1 (binding
, key
, definition
, noindirect
, keymap
, this, last
,
2094 nomenus
, last_is_meta
)
2095 Lisp_Object binding
, key
, definition
, noindirect
, keymap
, this, last
;
2096 int nomenus
, last_is_meta
;
2098 Lisp_Object sequence
;
2099 int keymap_specified
= !NILP (keymap
);
2101 /* Search through indirections unless that's not wanted. */
2102 if (NILP (noindirect
))
2108 Lisp_Object map
, tem
;
2109 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
2110 map
= get_keymap_1 (Fcar_safe (definition
), 0, 0);
2111 tem
= Fkeymapp (map
);
2113 definition
= access_keymap (map
, Fcdr (definition
), 0, 0);
2117 /* If the contents are (STRING ...), reject. */
2118 if (CONSP (definition
)
2119 && STRINGP (XCONS (definition
)->car
))
2123 binding
= get_keyelt (binding
, 0);
2126 /* End this iteration if this element does not match
2129 if (CONSP (definition
))
2132 tem
= Fequal (binding
, definition
);
2137 if (!EQ (binding
, definition
))
2140 /* We have found a match.
2141 Construct the key sequence where we found it. */
2142 if (INTEGERP (key
) && last_is_meta
)
2144 sequence
= Fcopy_sequence (this);
2145 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2148 sequence
= append_key (this, key
);
2150 /* Verify that this key binding is not shadowed by another
2151 binding for the same key, before we say it exists.
2153 Mechanism: look for local definition of this key and if
2154 it is defined and does not match what we found then
2157 Either nil or number as value from Flookup_key
2159 if (keymap_specified
)
2161 binding
= Flookup_key (keymap
, sequence
, Qnil
);
2162 if (!NILP (binding
) && !INTEGERP (binding
))
2164 if (CONSP (definition
))
2167 tem
= Fequal (binding
, definition
);
2172 if (!EQ (binding
, definition
))
2178 binding
= Fkey_binding (sequence
, Qnil
);
2179 if (!EQ (binding
, definition
))
2186 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2188 DEFUN ("describe-bindings", Fdescribe_bindings
, Sdescribe_bindings
, 0, 1, "",
2189 "Show a list of all defined keys, and their definitions.\n\
2190 The list is put in a buffer, which is displayed.\n\
2191 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
2192 then we display only bindings that start with that prefix.")
2196 register Lisp_Object thisbuf
;
2197 XSETBUFFER (thisbuf
, current_buffer
);
2198 internal_with_output_to_temp_buffer ("*Help*",
2199 describe_buffer_bindings
,
2200 Fcons (thisbuf
, prefix
));
2204 /* ARG is (BUFFER . PREFIX). */
2207 describe_buffer_bindings (arg
)
2210 Lisp_Object descbuf
, prefix
, shadow
;
2211 register Lisp_Object start1
;
2212 struct gcpro gcpro1
;
2214 char *alternate_heading
2216 Alternate Characters (use anywhere the nominal character is listed):\n\
2217 nominal alternate\n\
2218 ------- ---------\n";
2220 descbuf
= XCONS (arg
)->car
;
2221 prefix
= XCONS (arg
)->cdr
;
2225 Fset_buffer (Vstandard_output
);
2227 /* Report on alternates for keys. */
2228 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2231 unsigned char *translate
= XSTRING (Vkeyboard_translate_table
)->data
;
2232 int translate_len
= XSTRING (Vkeyboard_translate_table
)->size
;
2234 for (c
= 0; c
< translate_len
; c
++)
2235 if (translate
[c
] != c
)
2240 if (alternate_heading
)
2242 insert_string (alternate_heading
);
2243 alternate_heading
= 0;
2246 bufend
= push_key_description (translate
[c
], buf
);
2247 insert (buf
, bufend
- buf
);
2248 Findent_to (make_number (16), make_number (1));
2249 bufend
= push_key_description (c
, buf
);
2250 insert (buf
, bufend
- buf
);
2258 if (!NILP (Vkey_translation_map
))
2259 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2260 "Key translations", 0, 1, 0);
2264 Lisp_Object
*modes
, *maps
;
2266 /* Temporarily switch to descbuf, so that we can get that buffer's
2267 minor modes correctly. */
2268 Fset_buffer (descbuf
);
2270 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
2271 || !NILP (Voverriding_local_map
))
2274 nmaps
= current_minor_maps (&modes
, &maps
);
2275 Fset_buffer (Vstandard_output
);
2277 /* Print the minor mode maps. */
2278 for (i
= 0; i
< nmaps
; i
++)
2280 /* The title for a minor mode keymap
2281 is constructed at run time.
2282 We let describe_map_tree do the actual insertion
2283 because it takes care of other features when doing so. */
2286 if (!SYMBOLP (modes
[i
]))
2289 p
= title
= (char *) alloca (40 + XSYMBOL (modes
[i
])->name
->size
);
2291 bcopy (XSYMBOL (modes
[i
])->name
->data
, p
,
2292 XSYMBOL (modes
[i
])->name
->size
);
2293 p
+= XSYMBOL (modes
[i
])->name
->size
;
2295 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2296 p
+= sizeof (" Minor Mode Bindings") - 1;
2299 describe_map_tree (maps
[i
], 1, shadow
, prefix
, title
, 0, 0, 0);
2300 shadow
= Fcons (maps
[i
], shadow
);
2304 /* Print the (major mode) local map. */
2305 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2306 start1
= current_kboard
->Voverriding_terminal_local_map
;
2307 else if (!NILP (Voverriding_local_map
))
2308 start1
= Voverriding_local_map
;
2310 start1
= XBUFFER (descbuf
)->keymap
;
2314 describe_map_tree (start1
, 1, shadow
, prefix
,
2315 "Major Mode Bindings", 0, 0, 0);
2316 shadow
= Fcons (start1
, shadow
);
2319 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2320 "Global Bindings", 0, 0, 1);
2322 /* Print the function-key-map translations under this prefix. */
2323 if (!NILP (Vfunction_key_map
))
2324 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2325 "Function key map translations", 0, 1, 0);
2327 call0 (intern ("help-mode"));
2328 Fset_buffer (descbuf
);
2333 /* Insert a description of the key bindings in STARTMAP,
2334 followed by those of all maps reachable through STARTMAP.
2335 If PARTIAL is nonzero, omit certain "uninteresting" commands
2336 (such as `undefined').
2337 If SHADOW is non-nil, it is a list of maps;
2338 don't mention keys which would be shadowed by any of them.
2339 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2340 TITLE, if not 0, is a string to insert at the beginning.
2341 TITLE should not end with a colon or a newline; we supply that.
2342 If NOMENU is not 0, then omit menu-bar commands.
2344 If TRANSL is nonzero, the definitions are actually key translations
2345 so print strings and vectors differently.
2347 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2351 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2353 Lisp_Object startmap
, shadow
, prefix
;
2360 Lisp_Object maps
, seen
, sub_shadows
;
2361 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2368 maps
= Faccessible_keymaps (startmap
, prefix
);
2371 GCPRO3 (maps
, seen
, sub_shadows
);
2377 /* Delete from MAPS each element that is for the menu bar. */
2378 for (list
= maps
; !NILP (list
); list
= XCONS (list
)->cdr
)
2380 Lisp_Object elt
, prefix
, tem
;
2383 prefix
= Fcar (elt
);
2384 if (XVECTOR (prefix
)->size
>= 1)
2386 tem
= Faref (prefix
, make_number (0));
2387 if (EQ (tem
, Qmenu_bar
))
2388 maps
= Fdelq (elt
, maps
);
2393 if (!NILP (maps
) || always_title
)
2397 insert_string (title
);
2400 insert_string (" Starting With ");
2401 insert1 (Fkey_description (prefix
));
2403 insert_string (":\n");
2405 insert_string (key_heading
);
2409 for (; !NILP (maps
); maps
= Fcdr (maps
))
2411 register Lisp_Object elt
, prefix
, tail
;
2414 prefix
= Fcar (elt
);
2418 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2422 shmap
= XCONS (tail
)->car
;
2424 /* If the sequence by which we reach this keymap is zero-length,
2425 then the shadow map for this keymap is just SHADOW. */
2426 if ((STRINGP (prefix
) && XSTRING (prefix
)->size
== 0)
2427 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
2429 /* If the sequence by which we reach this keymap actually has
2430 some elements, then the sequence's definition in SHADOW is
2431 what we should use. */
2434 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
2435 if (INTEGERP (shmap
))
2439 /* If shmap is not nil and not a keymap,
2440 it completely shadows this map, so don't
2441 describe this map at all. */
2442 if (!NILP (shmap
) && NILP (Fkeymapp (shmap
)))
2446 sub_shadows
= Fcons (shmap
, sub_shadows
);
2449 describe_map (Fcdr (elt
), Fcar (elt
),
2450 transl
? describe_translation
: describe_command
,
2451 partial
, sub_shadows
, &seen
, nomenu
);
2457 insert_string ("\n");
2462 static int previous_description_column
;
2465 describe_command (definition
)
2466 Lisp_Object definition
;
2468 register Lisp_Object tem1
;
2469 int column
= current_column ();
2470 int description_column
;
2472 /* If column 16 is no good, go to col 32;
2473 but don't push beyond that--go to next line instead. */
2477 description_column
= 32;
2479 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
2480 description_column
= 32;
2482 description_column
= 16;
2484 Findent_to (make_number (description_column
), make_number (1));
2485 previous_description_column
= description_column
;
2487 if (SYMBOLP (definition
))
2489 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2491 insert_string ("\n");
2493 else if (STRINGP (definition
) || VECTORP (definition
))
2494 insert_string ("Keyboard Macro\n");
2497 tem1
= Fkeymapp (definition
);
2499 insert_string ("Prefix Command\n");
2501 insert_string ("??\n");
2506 describe_translation (definition
)
2507 Lisp_Object definition
;
2509 register Lisp_Object tem1
;
2511 Findent_to (make_number (16), make_number (1));
2513 if (SYMBOLP (definition
))
2515 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2517 insert_string ("\n");
2519 else if (STRINGP (definition
) || VECTORP (definition
))
2521 insert1 (Fkey_description (definition
));
2522 insert_string ("\n");
2526 tem1
= Fkeymapp (definition
);
2528 insert_string ("Prefix Command\n");
2530 insert_string ("??\n");
2534 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2535 Returns the first non-nil binding found in any of those maps. */
2538 shadow_lookup (shadow
, key
, flag
)
2539 Lisp_Object shadow
, key
, flag
;
2541 Lisp_Object tail
, value
;
2543 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2545 value
= Flookup_key (XCONS (tail
)->car
, key
, flag
);
2552 /* Describe the contents of map MAP, assuming that this map itself is
2553 reached by the sequence of prefix keys KEYS (a string or vector).
2554 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
2557 describe_map (map
, keys
, elt_describer
, partial
, shadow
, seen
, nomenu
)
2558 register Lisp_Object map
;
2560 void (*elt_describer
) P_ ((Lisp_Object
));
2566 Lisp_Object elt_prefix
;
2567 Lisp_Object tail
, definition
, event
;
2569 Lisp_Object suppress
;
2572 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2574 if (!NILP (keys
) && XFASTINT (Flength (keys
)) > 0)
2576 /* Call Fkey_description first, to avoid GC bug for the other string. */
2577 tem
= Fkey_description (keys
);
2578 elt_prefix
= concat2 (tem
, build_string (" "));
2584 suppress
= intern ("suppress-keymap");
2586 /* This vector gets used to present single keys to Flookup_key. Since
2587 that is done once per keymap element, we don't want to cons up a
2588 fresh vector every time. */
2589 kludge
= Fmake_vector (make_number (1), Qnil
);
2592 GCPRO3 (elt_prefix
, definition
, kludge
);
2594 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2598 if (VECTORP (XCONS (tail
)->car
)
2599 || CHAR_TABLE_P (XCONS (tail
)->car
))
2600 describe_vector (XCONS (tail
)->car
,
2601 elt_prefix
, elt_describer
, partial
, shadow
, map
,
2603 else if (CONSP (XCONS (tail
)->car
))
2605 event
= XCONS (XCONS (tail
)->car
)->car
;
2607 /* Ignore bindings whose "keys" are not really valid events.
2608 (We get these in the frames and buffers menu.) */
2609 if (! (SYMBOLP (event
) || INTEGERP (event
)))
2612 if (nomenu
&& EQ (event
, Qmenu_bar
))
2615 definition
= get_keyelt (XCONS (XCONS (tail
)->car
)->cdr
, 0);
2617 /* Don't show undefined commands or suppressed commands. */
2618 if (NILP (definition
)) continue;
2619 if (SYMBOLP (definition
) && partial
)
2621 tem
= Fget (definition
, suppress
);
2626 /* Don't show a command that isn't really visible
2627 because a local definition of the same key shadows it. */
2629 XVECTOR (kludge
)->contents
[0] = event
;
2632 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2633 if (!NILP (tem
)) continue;
2636 tem
= Flookup_key (map
, kludge
, Qt
);
2637 if (! EQ (tem
, definition
)) continue;
2641 previous_description_column
= 0;
2646 if (!NILP (elt_prefix
))
2647 insert1 (elt_prefix
);
2649 /* THIS gets the string to describe the character EVENT. */
2650 insert1 (Fsingle_key_description (event
));
2652 /* Print a description of the definition of this character.
2653 elt_describer will take care of spacing out far enough
2654 for alignment purposes. */
2655 (*elt_describer
) (definition
);
2657 else if (EQ (XCONS (tail
)->car
, Qkeymap
))
2659 /* The same keymap might be in the structure twice, if we're
2660 using an inherited keymap. So skip anything we've already
2662 tem
= Fassq (tail
, *seen
);
2663 if (CONSP (tem
) && !NILP (Fequal (XCONS (tem
)->car
, keys
)))
2665 *seen
= Fcons (Fcons (tail
, keys
), *seen
);
2673 describe_vector_princ (elt
)
2676 Findent_to (make_number (16), make_number (1));
2681 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 1, 0,
2682 "Insert a description of contents of VECTOR.\n\
2683 This is text showing the elements of vector matched against indices.")
2687 int count
= specpdl_ptr
- specpdl
;
2689 specbind (Qstandard_output
, Fcurrent_buffer ());
2690 CHECK_VECTOR_OR_CHAR_TABLE (vector
, 0);
2691 describe_vector (vector
, Qnil
, describe_vector_princ
, 0,
2692 Qnil
, Qnil
, (int *)0, 0);
2694 return unbind_to (count
, Qnil
);
2697 /* Insert in the current buffer a description of the contents of VECTOR.
2698 We call ELT_DESCRIBER to insert the description of one value found
2701 ELT_PREFIX describes what "comes before" the keys or indices defined
2702 by this vector. This is a human-readable string whose size
2703 is not necessarily related to the situation.
2705 If the vector is in a keymap, ELT_PREFIX is a prefix key which
2706 leads to this keymap.
2708 If the vector is a chartable, ELT_PREFIX is the vector
2709 of bytes that lead to the character set or portion of a character
2710 set described by this chartable.
2712 If PARTIAL is nonzero, it means do not mention suppressed commands
2713 (that assumes the vector is in a keymap).
2715 SHADOW is a list of keymaps that shadow this map.
2716 If it is non-nil, then we look up the key in those maps
2717 and we don't mention it now if it is defined by any of them.
2719 ENTIRE_MAP is the keymap in which this vector appears.
2720 If the definition in effect in the whole map does not match
2721 the one in this vector, we ignore this one.
2723 When describing a sub-char-table, INDICES is a list of
2724 indices at higher levels in this char-table,
2725 and CHAR_TABLE_DEPTH says how many levels down we have gone. */
2728 describe_vector (vector
, elt_prefix
, elt_describer
,
2729 partial
, shadow
, entire_map
,
2730 indices
, char_table_depth
)
2731 register Lisp_Object vector
;
2732 Lisp_Object elt_prefix
;
2733 void (*elt_describer
) P_ ((Lisp_Object
));
2736 Lisp_Object entire_map
;
2738 int char_table_depth
;
2740 Lisp_Object definition
;
2743 Lisp_Object suppress
;
2746 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2747 /* Range of elements to be handled. */
2749 /* Flag to tell if we should handle multibyte characters. */
2750 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
2751 /* A flag to tell if a leaf in this level of char-table is not a
2752 generic character (i.e. a complete multibyte character). */
2758 indices
= (int *) alloca (3 * sizeof (int));
2762 /* This vector gets used to present single keys to Flookup_key. Since
2763 that is done once per vector element, we don't want to cons up a
2764 fresh vector every time. */
2765 kludge
= Fmake_vector (make_number (1), Qnil
);
2766 GCPRO3 (elt_prefix
, definition
, kludge
);
2769 suppress
= intern ("suppress-keymap");
2771 if (CHAR_TABLE_P (vector
))
2773 if (char_table_depth
== 0)
2775 /* VECTOR is a top level char-table. */
2778 to
= CHAR_TABLE_ORDINARY_SLOTS
;
2782 /* VECTOR is a sub char-table. */
2783 if (char_table_depth
>= 3)
2784 /* A char-table is never that deep. */
2785 error ("Too deep char table");
2788 = (CHARSET_VALID_P (indices
[0])
2789 && ((CHARSET_DIMENSION (indices
[0]) == 1
2790 && char_table_depth
== 1)
2791 || char_table_depth
== 2));
2793 /* Meaningful elements are from 32th to 127th. */
2795 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
2800 /* This does the right thing for ordinary vectors. */
2804 to
= XVECTOR (vector
)->size
;
2807 for (i
= from
; i
< to
; i
++)
2811 if (CHAR_TABLE_P (vector
))
2813 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
2816 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
2817 && !CHARSET_DEFINED_P (i
- 128))
2821 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
2824 definition
= get_keyelt (XVECTOR (vector
)->contents
[i
], 0);
2826 if (NILP (definition
)) continue;
2828 /* Don't mention suppressed commands. */
2829 if (SYMBOLP (definition
) && partial
)
2833 tem
= Fget (definition
, suppress
);
2835 if (!NILP (tem
)) continue;
2838 /* Set CHARACTER to the character this entry describes, if any.
2839 Also update *INDICES. */
2840 if (CHAR_TABLE_P (vector
))
2842 indices
[char_table_depth
] = i
;
2844 if (char_table_depth
== 0)
2847 indices
[0] = i
- 128;
2849 else if (complete_char
)
2852 = MAKE_NON_ASCII_CHAR (indices
[0], indices
[1], indices
[2]);
2860 /* If this binding is shadowed by some other map, ignore it. */
2861 if (!NILP (shadow
) && complete_char
)
2865 XVECTOR (kludge
)->contents
[0] = make_number (character
);
2866 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2868 if (!NILP (tem
)) continue;
2871 /* Ignore this definition if it is shadowed by an earlier
2872 one in the same keymap. */
2873 if (!NILP (entire_map
) && complete_char
)
2877 XVECTOR (kludge
)->contents
[0] = make_number (character
);
2878 tem
= Flookup_key (entire_map
, kludge
, Qt
);
2880 if (! EQ (tem
, definition
))
2886 if (char_table_depth
== 0)
2891 /* For a sub char-table, show the depth by indentation.
2892 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
2893 if (char_table_depth
> 0)
2894 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
2896 /* Output the prefix that applies to every entry in this map. */
2897 if (!NILP (elt_prefix
))
2898 insert1 (elt_prefix
);
2900 /* Insert or describe the character this slot is for,
2901 or a description of what it is for. */
2902 if (SUB_CHAR_TABLE_P (vector
))
2905 insert_char (character
);
2908 /* We need an octal representation for this block of
2911 sprintf (work
, "(row %d)", i
);
2912 insert (work
, strlen (work
));
2915 else if (CHAR_TABLE_P (vector
))
2918 insert1 (Fsingle_key_description (make_number (character
)));
2921 /* Print the information for this character set. */
2922 insert_string ("<");
2923 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
2925 insert_from_string (tem2
, 0 , XSTRING (tem2
)->size
, 0);
2933 insert1 (Fsingle_key_description (make_number (character
)));
2936 /* If we find a sub char-table within a char-table,
2937 scan it recursively; it defines the details for
2938 a character set or a portion of a character set. */
2939 if (multibyte
&& CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
2942 describe_vector (definition
, elt_prefix
, elt_describer
,
2943 partial
, shadow
, entire_map
,
2944 indices
, char_table_depth
+ 1);
2950 /* Find all consecutive characters or rows that have the same
2951 definition. But, for elements of a top level char table, if
2952 they are for charsets, we had better describe one by one even
2953 if they have the same definition. */
2954 if (CHAR_TABLE_P (vector
))
2958 if (char_table_depth
== 0)
2959 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
2961 while (i
+ 1 < limit
2962 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
2964 && !NILP (Fequal (tem2
, definition
)))
2969 && (tem2
= get_keyelt (XVECTOR (vector
)->contents
[i
+ 1], 0),
2971 && !NILP (Fequal (tem2
, definition
)))
2975 /* If we have a range of more than one character,
2976 print where the range reaches to. */
2978 if (i
!= starting_i
)
2982 if (!NILP (elt_prefix
))
2983 insert1 (elt_prefix
);
2985 if (CHAR_TABLE_P (vector
))
2987 if (char_table_depth
== 0)
2989 insert1 (Fsingle_key_description (make_number (i
)));
2991 else if (complete_char
)
2993 indices
[char_table_depth
] = i
;
2995 = MAKE_NON_ASCII_CHAR (indices
[0], indices
[1], indices
[2]);
2996 insert_char (character
);
3000 /* We need an octal representation for this block of
3003 sprintf (work
, "(row %d)", i
);
3004 insert (work
, strlen (work
));
3009 insert1 (Fsingle_key_description (make_number (i
)));
3013 /* Print a description of the definition of this character.
3014 elt_describer will take care of spacing out far enough
3015 for alignment purposes. */
3016 (*elt_describer
) (definition
);
3019 /* For (sub) char-table, print `defalt' slot at last. */
3020 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3022 insert (" ", char_table_depth
* 2);
3023 insert_string ("<<default>>");
3024 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
);
3030 /* Apropos - finding all symbols whose names match a regexp. */
3031 Lisp_Object apropos_predicate
;
3032 Lisp_Object apropos_accumulate
;
3035 apropos_accum (symbol
, string
)
3036 Lisp_Object symbol
, string
;
3038 register Lisp_Object tem
;
3040 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3041 if (!NILP (tem
) && !NILP (apropos_predicate
))
3042 tem
= call1 (apropos_predicate
, symbol
);
3044 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3047 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3048 "Show all symbols whose names contain match for REGEXP.\n\
3049 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done\n\
3050 for each symbol and a symbol is mentioned only if that returns non-nil.\n\
3051 Return list of symbols found.")
3053 Lisp_Object regexp
, predicate
;
3055 struct gcpro gcpro1
, gcpro2
;
3056 CHECK_STRING (regexp
, 0);
3057 apropos_predicate
= predicate
;
3058 GCPRO2 (apropos_predicate
, apropos_accumulate
);
3059 apropos_accumulate
= Qnil
;
3060 map_obarray (Vobarray
, apropos_accum
, regexp
);
3061 apropos_accumulate
= Fsort (apropos_accumulate
, Qstring_lessp
);
3063 return apropos_accumulate
;
3070 Qkeymap
= intern ("keymap");
3071 staticpro (&Qkeymap
);
3073 /* Now we are ready to set up this property, so we can
3074 create char tables. */
3075 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3077 /* Initialize the keymaps standardly used.
3078 Each one is the value of a Lisp variable, and is also
3079 pointed to by a C variable */
3081 global_map
= Fmake_keymap (Qnil
);
3082 Fset (intern ("global-map"), global_map
);
3084 current_global_map
= global_map
;
3085 staticpro (&global_map
);
3086 staticpro (¤t_global_map
);
3088 meta_map
= Fmake_keymap (Qnil
);
3089 Fset (intern ("esc-map"), meta_map
);
3090 Ffset (intern ("ESC-prefix"), meta_map
);
3092 control_x_map
= Fmake_keymap (Qnil
);
3093 Fset (intern ("ctl-x-map"), control_x_map
);
3094 Ffset (intern ("Control-X-prefix"), control_x_map
);
3096 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3097 "List of commands given new key bindings recently.\n\
3098 This is used for internal purposes during Emacs startup;\n\
3099 don't alter it yourself.");
3100 Vdefine_key_rebound_commands
= Qt
;
3102 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3103 "Default keymap to use when reading from the minibuffer.");
3104 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3106 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3107 "Local keymap for the minibuffer when spaces are not allowed.");
3108 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3110 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3111 "Local keymap for minibuffer input with completion.");
3112 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3114 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3115 "Local keymap for minibuffer input with completion, for exact match.");
3116 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3118 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3119 "Alist of keymaps to use for minor modes.\n\
3120 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read\n\
3121 key sequences and look up bindings iff VARIABLE's value is non-nil.\n\
3122 If two active keymaps bind the same key, the keymap appearing earlier\n\
3123 in the list takes precedence.");
3124 Vminor_mode_map_alist
= Qnil
;
3126 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3127 "Alist of keymaps to use for minor modes, in current major mode.\n\
3128 This variable is a alist just like `minor-mode-map-alist', and it is\n\
3129 used the same way (and before `minor-mode-map-alist'); however,\n\
3130 it is provided for major modes to bind locally.");
3131 Vminor_mode_overriding_map_alist
= Qnil
;
3133 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3134 "Keymap mapping ASCII function key sequences onto their preferred forms.\n\
3135 This allows Emacs to recognize function keys sent from ASCII\n\
3136 terminals at any point in a key sequence.\n\
3138 The `read-key-sequence' function replaces any subsequence bound by\n\
3139 `function-key-map' with its binding. More precisely, when the active\n\
3140 keymaps have no binding for the current key sequence but\n\
3141 `function-key-map' binds a suffix of the sequence to a vector or string,\n\
3142 `read-key-sequence' replaces the matching suffix with its binding, and\n\
3143 continues with the new sequence.\n\
3145 The events that come from bindings in `function-key-map' are not\n\
3146 themselves looked up in `function-key-map'.\n\
3148 For example, suppose `function-key-map' binds `ESC O P' to [f1].\n\
3149 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing\n\
3150 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix\n\
3151 key, typing `ESC O P x' would return [f1 x].");
3152 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3154 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3155 "Keymap of key translations that can override keymaps.\n\
3156 This keymap works like `function-key-map', but comes after that,\n\
3157 and applies even for keys that have ordinary bindings.");
3158 Vkey_translation_map
= Qnil
;
3160 Qsingle_key_description
= intern ("single-key-description");
3161 staticpro (&Qsingle_key_description
);
3163 Qkey_description
= intern ("key-description");
3164 staticpro (&Qkey_description
);
3166 Qkeymapp
= intern ("keymapp");
3167 staticpro (&Qkeymapp
);
3169 Qnon_ascii
= intern ("non-ascii");
3170 staticpro (&Qnon_ascii
);
3172 defsubr (&Skeymapp
);
3173 defsubr (&Skeymap_parent
);
3174 defsubr (&Sset_keymap_parent
);
3175 defsubr (&Smake_keymap
);
3176 defsubr (&Smake_sparse_keymap
);
3177 defsubr (&Scopy_keymap
);
3178 defsubr (&Skey_binding
);
3179 defsubr (&Slocal_key_binding
);
3180 defsubr (&Sglobal_key_binding
);
3181 defsubr (&Sminor_mode_key_binding
);
3182 defsubr (&Sdefine_key
);
3183 defsubr (&Slookup_key
);
3184 defsubr (&Sdefine_prefix_command
);
3185 defsubr (&Suse_global_map
);
3186 defsubr (&Suse_local_map
);
3187 defsubr (&Scurrent_local_map
);
3188 defsubr (&Scurrent_global_map
);
3189 defsubr (&Scurrent_minor_mode_maps
);
3190 defsubr (&Saccessible_keymaps
);
3191 defsubr (&Skey_description
);
3192 defsubr (&Sdescribe_vector
);
3193 defsubr (&Ssingle_key_description
);
3194 defsubr (&Stext_char_description
);
3195 defsubr (&Swhere_is_internal
);
3196 defsubr (&Sdescribe_bindings
);
3197 defsubr (&Sapropos_internal
);
3204 initial_define_key (global_map
, 033, "ESC-prefix");
3205 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");