1 /* Manipulation of keymaps
2 Copyright (C) 1985, 86,87,88,93,94,95,98 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
))
1080 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1081 and also an entry in Vminor_mode_map_alist,
1082 ignore the latter. */
1083 if (list_number
== 1)
1085 val
= assq_no_quit (var
, lists
[0]);
1092 Lisp_Object
*newmodes
, *newmaps
;
1099 = (Lisp_Object
*) realloc (cmm_modes
,
1100 cmm_size
* sizeof (Lisp_Object
));
1102 = (Lisp_Object
*) realloc (cmm_maps
,
1103 cmm_size
* sizeof (Lisp_Object
));
1111 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
1113 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
1117 if (newmaps
&& newmodes
)
1119 cmm_modes
= newmodes
;
1126 /* Get the keymap definition--or nil if it is not defined. */
1127 temp
= internal_condition_case_1 (Findirect_function
,
1129 Qerror
, current_minor_maps_error
);
1133 cmm_maps
[i
] = temp
;
1138 if (modeptr
) *modeptr
= cmm_modes
;
1139 if (mapptr
) *mapptr
= cmm_maps
;
1143 /* GC is possible in this function if it autoloads a keymap. */
1145 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 2, 0,
1146 "Return the binding for command KEY in current keymaps.\n\
1147 KEY is a string or vector, a sequence of keystrokes.\n\
1148 The binding is probably a symbol with a function definition.\n\
1150 Normally, `key-binding' ignores bindings for t, which act as default\n\
1151 bindings, used when nothing else in the keymap applies; this makes it\n\
1152 usable as a general function for probing keymaps. However, if the\n\
1153 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\
1154 recognize the default bindings, just as `read-key-sequence' does.")
1155 (key
, accept_default
)
1156 Lisp_Object key
, accept_default
;
1158 Lisp_Object
*maps
, value
;
1160 struct gcpro gcpro1
;
1164 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1166 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1167 key
, accept_default
);
1168 if (! NILP (value
) && !INTEGERP (value
))
1169 RETURN_UNGCPRO (value
);
1171 else if (!NILP (Voverriding_local_map
))
1173 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1174 if (! NILP (value
) && !INTEGERP (value
))
1175 RETURN_UNGCPRO (value
);
1181 nmaps
= current_minor_maps (0, &maps
);
1182 /* Note that all these maps are GCPRO'd
1183 in the places where we found them. */
1185 for (i
= 0; i
< nmaps
; i
++)
1186 if (! NILP (maps
[i
]))
1188 value
= Flookup_key (maps
[i
], key
, accept_default
);
1189 if (! NILP (value
) && !INTEGERP (value
))
1190 RETURN_UNGCPRO (value
);
1193 local
= get_local_map (PT
, current_buffer
);
1197 value
= Flookup_key (local
, key
, accept_default
);
1198 if (! NILP (value
) && !INTEGERP (value
))
1199 RETURN_UNGCPRO (value
);
1203 value
= Flookup_key (current_global_map
, key
, accept_default
);
1205 if (! NILP (value
) && !INTEGERP (value
))
1211 /* GC is possible in this function if it autoloads a keymap. */
1213 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1214 "Return the binding for command KEYS in current local keymap only.\n\
1215 KEYS is a string, a sequence of keystrokes.\n\
1216 The binding is probably a symbol with a function definition.\n\
1218 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1219 bindings; see the description of `lookup-key' for more details about this.")
1220 (keys
, accept_default
)
1221 Lisp_Object keys
, accept_default
;
1223 register Lisp_Object map
;
1224 map
= current_buffer
->keymap
;
1227 return Flookup_key (map
, keys
, accept_default
);
1230 /* GC is possible in this function if it autoloads a keymap. */
1232 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1233 "Return the binding for command KEYS in current global keymap only.\n\
1234 KEYS is a string, a sequence of keystrokes.\n\
1235 The binding is probably a symbol with a function definition.\n\
1236 This function's return values are the same as those of lookup-key\n\
1239 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1240 bindings; see the description of `lookup-key' for more details about this.")
1241 (keys
, accept_default
)
1242 Lisp_Object keys
, accept_default
;
1244 return Flookup_key (current_global_map
, keys
, accept_default
);
1247 /* GC is possible in this function if it autoloads a keymap. */
1249 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1250 "Find the visible minor mode bindings of KEY.\n\
1251 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the\n\
1252 the symbol which names the minor mode binding KEY, and BINDING is\n\
1253 KEY's definition in that mode. In particular, if KEY has no\n\
1254 minor-mode bindings, return nil. If the first binding is a\n\
1255 non-prefix, all subsequent bindings will be omitted, since they would\n\
1256 be ignored. Similarly, the list doesn't include non-prefix bindings\n\
1257 that come after prefix bindings.\n\
1259 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1260 bindings; see the description of `lookup-key' for more details about this.")
1261 (key
, accept_default
)
1262 Lisp_Object key
, accept_default
;
1264 Lisp_Object
*modes
, *maps
;
1266 Lisp_Object binding
;
1268 struct gcpro gcpro1
, gcpro2
;
1270 nmaps
= current_minor_maps (&modes
, &maps
);
1271 /* Note that all these maps are GCPRO'd
1272 in the places where we found them. */
1275 GCPRO2 (key
, binding
);
1277 for (i
= j
= 0; i
< nmaps
; i
++)
1278 if (! NILP (maps
[i
])
1279 && ! NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1280 && !INTEGERP (binding
))
1282 if (! NILP (get_keymap (binding
)))
1283 maps
[j
++] = Fcons (modes
[i
], binding
);
1285 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1289 return Flist (j
, maps
);
1292 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 2, 0,
1293 "Define COMMAND as a prefix command. COMMAND should be a symbol.\n\
1294 A new sparse keymap is stored as COMMAND's function definition and its value.\n\
1295 If a second optional argument MAPVAR is given, the map is stored as\n\
1296 its value instead of as COMMAND's value; but COMMAND is still defined\n\
1299 Lisp_Object command
, mapvar
;
1302 map
= Fmake_sparse_keymap (Qnil
);
1303 Ffset (command
, map
);
1307 Fset (command
, map
);
1311 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1312 "Select KEYMAP as the global keymap.")
1316 keymap
= get_keymap (keymap
);
1317 current_global_map
= keymap
;
1322 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1323 "Select KEYMAP as the local keymap.\n\
1324 If KEYMAP is nil, that means no local keymap.")
1329 keymap
= get_keymap (keymap
);
1331 current_buffer
->keymap
= keymap
;
1336 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1337 "Return current buffer's local keymap, or nil if it has none.")
1340 return current_buffer
->keymap
;
1343 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1344 "Return the current global keymap.")
1347 return current_global_map
;
1350 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1351 "Return a list of keymaps for the minor modes of the current buffer.")
1355 int nmaps
= current_minor_maps (0, &maps
);
1357 return Flist (nmaps
, maps
);
1360 /* Help functions for describing and documenting keymaps. */
1362 static void accessible_keymaps_char_table ();
1364 /* This function cannot GC. */
1366 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1368 "Find all keymaps accessible via prefix characters from KEYMAP.\n\
1369 Returns a list of elements of the form (KEYS . MAP), where the sequence\n\
1370 KEYS starting from KEYMAP gets you to MAP. These elements are ordered\n\
1371 so that the KEYS increase in length. The first element is ([] . KEYMAP).\n\
1372 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
1373 then the value includes only maps for prefixes that start with PREFIX.")
1375 Lisp_Object keymap
, prefix
;
1377 Lisp_Object maps
, good_maps
, tail
;
1380 /* no need for gcpro because we don't autoload any keymaps. */
1383 prefixlen
= XINT (Flength (prefix
));
1387 /* If a prefix was specified, start with the keymap (if any) for
1388 that prefix, so we don't waste time considering other prefixes. */
1390 tem
= Flookup_key (keymap
, prefix
, Qt
);
1391 /* Flookup_key may give us nil, or a number,
1392 if the prefix is not defined in this particular map.
1393 It might even give us a list that isn't a keymap. */
1394 tem
= get_keymap_1 (tem
, 0, 0);
1397 /* Convert PREFIX to a vector now, so that later on
1398 we don't have to deal with the possibility of a string. */
1399 if (STRINGP (prefix
))
1404 copy
= Fmake_vector (make_number (XSTRING (prefix
)->size
), Qnil
);
1405 for (i
= 0, i_byte
; i
< XSTRING (prefix
)->size
;)
1408 if (STRING_MULTIBYTE (prefix
))
1409 FETCH_STRING_CHAR_ADVANCE (c
, prefix
, i
, i_byte
);
1411 c
= XSTRING (prefix
)->data
[i
++];
1413 c
^= 0200 | meta_modifier
;
1414 XVECTOR (copy
)->contents
[i_before
] = make_number (c
);
1418 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1424 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1425 get_keymap (keymap
)),
1428 /* For each map in the list maps,
1429 look at any other maps it points to,
1430 and stick them at the end if they are not already in the list.
1432 This is a breadth-first traversal, where tail is the queue of
1433 nodes, and maps accumulates a list of all nodes visited. */
1435 for (tail
= maps
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1437 register Lisp_Object thisseq
, thismap
;
1439 /* Does the current sequence end in the meta-prefix-char? */
1442 thisseq
= Fcar (Fcar (tail
));
1443 thismap
= Fcdr (Fcar (tail
));
1444 last
= make_number (XINT (Flength (thisseq
)) - 1);
1445 is_metized
= (XINT (last
) >= 0
1446 /* Don't metize the last char of PREFIX. */
1447 && XINT (last
) >= prefixlen
1448 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1450 for (; CONSP (thismap
); thismap
= XCONS (thismap
)->cdr
)
1454 elt
= XCONS (thismap
)->car
;
1458 if (CHAR_TABLE_P (elt
))
1460 Lisp_Object indices
[3];
1462 map_char_table (accessible_keymaps_char_table
, Qnil
,
1463 elt
, Fcons (maps
, Fcons (tail
, thisseq
)),
1466 else if (VECTORP (elt
))
1470 /* Vector keymap. Scan all the elements. */
1471 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
1473 register Lisp_Object tem
;
1474 register Lisp_Object cmd
;
1476 cmd
= get_keyelt (XVECTOR (elt
)->contents
[i
], 0);
1477 if (NILP (cmd
)) continue;
1478 tem
= Fkeymapp (cmd
);
1481 cmd
= get_keymap (cmd
);
1482 /* Ignore keymaps that are already added to maps. */
1483 tem
= Frassq (cmd
, maps
);
1486 /* If the last key in thisseq is meta-prefix-char,
1487 turn it into a meta-ized keystroke. We know
1488 that the event we're about to append is an
1489 ascii keystroke since we're processing a
1493 int meta_bit
= meta_modifier
;
1494 tem
= Fcopy_sequence (thisseq
);
1496 Faset (tem
, last
, make_number (i
| meta_bit
));
1498 /* This new sequence is the same length as
1499 thisseq, so stick it in the list right
1502 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1506 tem
= append_key (thisseq
, make_number (i
));
1507 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1513 else if (CONSP (elt
))
1515 register Lisp_Object cmd
, tem
, filter
;
1517 cmd
= get_keyelt (XCONS (elt
)->cdr
, 0);
1518 /* Ignore definitions that aren't keymaps themselves. */
1519 tem
= Fkeymapp (cmd
);
1522 /* Ignore keymaps that have been seen already. */
1523 cmd
= get_keymap (cmd
);
1524 tem
= Frassq (cmd
, maps
);
1527 /* Let elt be the event defined by this map entry. */
1528 elt
= XCONS (elt
)->car
;
1530 /* If the last key in thisseq is meta-prefix-char, and
1531 this entry is a binding for an ascii keystroke,
1532 turn it into a meta-ized keystroke. */
1533 if (is_metized
&& INTEGERP (elt
))
1535 Lisp_Object element
;
1538 tem
= Fvconcat (1, &element
);
1539 XSETFASTINT (XVECTOR (tem
)->contents
[XINT (last
)],
1540 XINT (elt
) | meta_modifier
);
1542 /* This new sequence is the same length as
1543 thisseq, so stick it in the list right
1546 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1550 Fcons (Fcons (append_key (thisseq
, elt
), cmd
),
1561 /* Now find just the maps whose access prefixes start with PREFIX. */
1564 for (; CONSP (maps
); maps
= XCONS (maps
)->cdr
)
1566 Lisp_Object elt
, thisseq
;
1567 elt
= XCONS (maps
)->car
;
1568 thisseq
= XCONS (elt
)->car
;
1569 /* The access prefix must be at least as long as PREFIX,
1570 and the first elements must match those of PREFIX. */
1571 if (XINT (Flength (thisseq
)) >= prefixlen
)
1574 for (i
= 0; i
< prefixlen
; i
++)
1577 XSETFASTINT (i1
, i
);
1578 if (!EQ (Faref (thisseq
, i1
), Faref (prefix
, i1
)))
1582 good_maps
= Fcons (elt
, good_maps
);
1586 return Fnreverse (good_maps
);
1590 accessible_keymaps_char_table (args
, index
, cmd
)
1591 Lisp_Object args
, index
, cmd
;
1594 Lisp_Object maps
, tail
, thisseq
;
1599 maps
= XCONS (args
)->car
;
1600 tail
= XCONS (XCONS (args
)->cdr
)->car
;
1601 thisseq
= XCONS (XCONS (args
)->cdr
)->cdr
;
1603 tem
= Fkeymapp (cmd
);
1606 cmd
= get_keymap (cmd
);
1607 /* Ignore keymaps that are already added to maps. */
1608 tem
= Frassq (cmd
, maps
);
1611 tem
= append_key (thisseq
, index
);
1612 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1617 Lisp_Object Qsingle_key_description
, Qkey_description
;
1619 /* This function cannot GC. */
1621 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 1, 0,
1622 "Return a pretty description of key-sequence KEYS.\n\
1623 Control characters turn into \"C-foo\" sequences, meta into \"M-foo\"\n\
1624 spaces are put between sequence elements, etc.")
1636 vector
= Fmake_vector (Flength (keys
), Qnil
);
1637 for (i
= 0; i
< XSTRING (keys
)->size
; )
1642 if (STRING_MULTIBYTE (keys
))
1643 FETCH_STRING_CHAR_ADVANCE (c
, keys
, i
, i_byte
);
1645 c
= XSTRING (keys
)->data
[i
++];
1648 XSETFASTINT (XVECTOR (vector
)->contents
[i_before
],
1649 meta_modifier
| (c
& ~0x80));
1651 XSETFASTINT (XVECTOR (vector
)->contents
[i_before
], c
);
1655 else if (!VECTORP (keys
))
1656 keys
= wrong_type_argument (Qarrayp
, keys
);
1658 /* In effect, this computes
1659 (mapconcat 'single-key-description keys " ")
1660 but we shouldn't use mapconcat because it can do GC. */
1662 len
= XVECTOR (keys
)->size
;
1663 sep
= build_string (" ");
1664 /* This has one extra element at the end that we don't pass to Fconcat. */
1665 args
= (Lisp_Object
*) alloca (len
* 2 * sizeof (Lisp_Object
));
1667 for (i
= 0; i
< len
; i
++)
1669 args
[i
* 2] = Fsingle_key_description (XVECTOR (keys
)->contents
[i
]);
1670 args
[i
* 2 + 1] = sep
;
1673 return Fconcat (len
* 2 - 1, args
);
1677 push_key_description (c
, p
)
1678 register unsigned int c
;
1681 /* Clear all the meaningless bits above the meta bit. */
1682 c
&= meta_modifier
| ~ - meta_modifier
;
1684 if (c
& alt_modifier
)
1690 if (c
& ctrl_modifier
)
1696 if (c
& hyper_modifier
)
1700 c
-= hyper_modifier
;
1702 if (c
& meta_modifier
)
1708 if (c
& shift_modifier
)
1712 c
-= shift_modifier
;
1714 if (c
& super_modifier
)
1718 c
-= super_modifier
;
1734 else if (c
== Ctl ('M'))
1744 if (c
> 0 && c
<= Ctl ('Z'))
1767 *p
++ = (7 & (c
>> 6)) + '0';
1768 *p
++ = (7 & (c
>> 3)) + '0';
1769 *p
++ = (7 & (c
>> 0)) + '0';
1774 *p
++ = (7 & (c
>> 15)) + '0';
1775 *p
++ = (7 & (c
>> 12)) + '0';
1776 *p
++ = (7 & (c
>> 9)) + '0';
1777 *p
++ = (7 & (c
>> 6)) + '0';
1778 *p
++ = (7 & (c
>> 3)) + '0';
1779 *p
++ = (7 & (c
>> 0)) + '0';
1785 /* This function cannot GC. */
1787 DEFUN ("single-key-description", Fsingle_key_description
, Ssingle_key_description
, 1, 1, 0,
1788 "Return a pretty description of command character KEY.\n\
1789 Control characters turn into C-whatever, etc.")
1795 key
= EVENT_HEAD (key
);
1797 if (INTEGERP (key
)) /* Normal character */
1799 *push_key_description (XUINT (key
), tem
) = 0;
1800 return build_string (tem
);
1802 else if (SYMBOLP (key
)) /* Function key or event-symbol */
1803 return Fsymbol_name (key
);
1804 else if (STRINGP (key
)) /* Buffer names in the menubar. */
1805 return Fcopy_sequence (key
);
1807 error ("KEY must be an integer, cons, symbol, or string");
1811 push_text_char_description (c
, p
)
1812 register unsigned int c
;
1824 *p
++ = c
+ 64; /* 'A' - 1 */
1836 /* This function cannot GC. */
1838 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
1839 "Return a pretty description of file-character CHARACTER.\n\
1840 Control characters turn into \"^char\", etc.")
1842 Lisp_Object character
;
1846 CHECK_NUMBER (character
, 0);
1848 if (!SINGLE_BYTE_CHAR_P (XFASTINT (character
)))
1851 int len
= non_ascii_char_to_string (XFASTINT (character
), tem
, &str
);
1853 return make_multibyte_string (str
, 1, len
);
1856 *push_text_char_description (XINT (character
) & 0377, tem
) = 0;
1858 return build_string (tem
);
1861 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
1864 ascii_sequence_p (seq
)
1868 int len
= XINT (Flength (seq
));
1870 for (i
= 0; i
< len
; i
++)
1872 Lisp_Object ii
, elt
;
1874 XSETFASTINT (ii
, i
);
1875 elt
= Faref (seq
, ii
);
1878 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
1886 /* where-is - finding a command in a set of keymaps. */
1888 static Lisp_Object
where_is_internal_1 ();
1889 static void where_is_internal_2 ();
1891 /* This function can GC if Flookup_key autoloads any keymaps. */
1893 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 4, 0,
1894 "Return list of keys that invoke DEFINITION.\n\
1895 If KEYMAP is non-nil, search only KEYMAP and the global keymap.\n\
1896 If KEYMAP is nil, search all the currently active keymaps.\n\
1898 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,\n\
1899 rather than a list of all possible key sequences.\n\
1900 If FIRSTONLY is the symbol `non-ascii', return the first binding found,\n\
1901 no matter what it is.\n\
1902 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters,\n\
1903 and entirely reject menu bindings.\n\
1905 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections\n\
1906 to other keymaps or slots. This makes it possible to search for an\n\
1907 indirect definition itself.")
1908 (definition
, keymap
, firstonly
, noindirect
)
1909 Lisp_Object definition
, keymap
;
1910 Lisp_Object firstonly
, noindirect
;
1913 Lisp_Object found
, sequences
;
1914 Lisp_Object keymap1
;
1915 int keymap_specified
= !NILP (keymap
);
1916 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
1917 /* 1 means ignore all menu bindings entirely. */
1918 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
1920 /* Find keymaps accessible from `keymap' or the current
1921 context. But don't muck with the value of `keymap',
1922 because `where_is_internal_1' uses it to check for
1923 shadowed bindings. */
1925 if (! keymap_specified
)
1927 #ifdef USE_TEXT_PROPERTIES
1928 keymap1
= get_local_map (PT
, current_buffer
);
1930 keymap1
= current_buffer
->keymap
;
1934 if (!NILP (keymap1
))
1935 maps
= nconc2 (Faccessible_keymaps (get_keymap (keymap1
), Qnil
),
1936 Faccessible_keymaps (get_keymap (current_global_map
),
1939 maps
= Faccessible_keymaps (get_keymap (current_global_map
), Qnil
);
1941 /* Put the minor mode keymaps on the front. */
1942 if (! keymap_specified
)
1945 minors
= Fnreverse (Fcurrent_minor_mode_maps ());
1946 while (!NILP (minors
))
1948 maps
= nconc2 (Faccessible_keymaps (get_keymap (XCONS (minors
)->car
),
1951 minors
= XCONS (minors
)->cdr
;
1955 GCPRO5 (definition
, keymap
, maps
, found
, sequences
);
1959 for (; !NILP (maps
); maps
= Fcdr (maps
))
1961 /* Key sequence to reach map, and the map that it reaches */
1962 register Lisp_Object
this, map
;
1964 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
1965 [M-CHAR] sequences, check if last character of the sequence
1966 is the meta-prefix char. */
1970 this = Fcar (Fcar (maps
));
1971 map
= Fcdr (Fcar (maps
));
1972 last
= make_number (XINT (Flength (this)) - 1);
1973 last_is_meta
= (XINT (last
) >= 0
1974 && EQ (Faref (this, last
), meta_prefix_char
));
1980 /* Because the code we want to run on each binding is rather
1981 large, we don't want to have two separate loop bodies for
1982 sparse keymap bindings and tables; we want to iterate one
1983 loop body over both keymap and vector bindings.
1985 For this reason, if Fcar (map) is a vector, we don't
1986 advance map to the next element until i indicates that we
1987 have finished off the vector. */
1988 Lisp_Object elt
, key
, binding
;
1989 elt
= XCONS (map
)->car
;
1990 map
= XCONS (map
)->cdr
;
1996 /* Set key and binding to the current key and binding, and
1997 advance map and i to the next binding. */
2000 Lisp_Object sequence
;
2002 /* In a vector, look at each element. */
2003 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
2005 binding
= XVECTOR (elt
)->contents
[i
];
2006 XSETFASTINT (key
, i
);
2007 sequence
= where_is_internal_1 (binding
, key
, definition
,
2008 noindirect
, keymap
, this,
2009 last
, nomenus
, last_is_meta
);
2010 if (!NILP (sequence
))
2011 sequences
= Fcons (sequence
, sequences
);
2014 else if (CHAR_TABLE_P (elt
))
2016 Lisp_Object indices
[3];
2019 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
2020 Fcons (keymap
, Qnil
)),
2021 Fcons (Fcons (this, last
),
2022 Fcons (make_number (nomenus
),
2023 make_number (last_is_meta
))));
2025 map_char_table (where_is_internal_2
, Qnil
, elt
, args
,
2027 sequences
= XCONS (XCONS (XCONS (args
)->car
)->cdr
)->cdr
;
2029 else if (CONSP (elt
))
2031 Lisp_Object sequence
;
2033 key
= XCONS (elt
)->car
;
2034 binding
= XCONS (elt
)->cdr
;
2036 sequence
= where_is_internal_1 (binding
, key
, definition
,
2037 noindirect
, keymap
, this,
2038 last
, nomenus
, last_is_meta
);
2039 if (!NILP (sequence
))
2040 sequences
= Fcons (sequence
, sequences
);
2044 for (; ! NILP (sequences
); sequences
= XCONS (sequences
)->cdr
)
2046 Lisp_Object sequence
;
2048 sequence
= XCONS (sequences
)->car
;
2050 /* It is a true unshadowed match. Record it, unless it's already
2051 been seen (as could happen when inheriting keymaps). */
2052 if (NILP (Fmember (sequence
, found
)))
2053 found
= Fcons (sequence
, found
);
2055 /* If firstonly is Qnon_ascii, then we can return the first
2056 binding we find. If firstonly is not Qnon_ascii but not
2057 nil, then we should return the first ascii-only binding
2059 if (EQ (firstonly
, Qnon_ascii
))
2060 RETURN_UNGCPRO (sequence
);
2061 else if (! NILP (firstonly
) && ascii_sequence_p (sequence
))
2062 RETURN_UNGCPRO (sequence
);
2069 found
= Fnreverse (found
);
2071 /* firstonly may have been t, but we may have gone all the way through
2072 the keymaps without finding an all-ASCII key sequence. So just
2073 return the best we could find. */
2074 if (! NILP (firstonly
))
2075 return Fcar (found
);
2080 /* This is the function that Fwhere_is_internal calls using map_char_table.
2082 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2084 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2085 Since map_char_table doesn't really use the return value from this function,
2086 we the result append to RESULT, the slot in ARGS. */
2089 where_is_internal_2 (args
, key
, binding
)
2090 Lisp_Object args
, key
, binding
;
2092 Lisp_Object definition
, noindirect
, keymap
, this, last
;
2093 Lisp_Object result
, sequence
;
2094 int nomenus
, last_is_meta
;
2096 result
= XCONS (XCONS (XCONS (args
)->car
)->cdr
)->cdr
;
2097 definition
= XCONS (XCONS (XCONS (args
)->car
)->car
)->car
;
2098 noindirect
= XCONS (XCONS (XCONS (args
)->car
)->car
)->cdr
;
2099 keymap
= XCONS (XCONS (XCONS (args
)->car
)->cdr
)->car
;
2100 this = XCONS (XCONS (XCONS (args
)->cdr
)->car
)->car
;
2101 last
= XCONS (XCONS (XCONS (args
)->cdr
)->car
)->cdr
;
2102 nomenus
= XFASTINT (XCONS (XCONS (XCONS (args
)->cdr
)->cdr
)->car
);
2103 last_is_meta
= XFASTINT (XCONS (XCONS (XCONS (args
)->cdr
)->cdr
)->cdr
);
2105 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
, keymap
,
2106 this, last
, nomenus
, last_is_meta
);
2108 if (!NILP (sequence
))
2109 XCONS (XCONS (XCONS (args
)->car
)->cdr
)->cdr
2110 = Fcons (sequence
, result
);
2114 where_is_internal_1 (binding
, key
, definition
, noindirect
, keymap
, this, last
,
2115 nomenus
, last_is_meta
)
2116 Lisp_Object binding
, key
, definition
, noindirect
, keymap
, this, last
;
2117 int nomenus
, last_is_meta
;
2119 Lisp_Object sequence
;
2120 int keymap_specified
= !NILP (keymap
);
2122 /* Search through indirections unless that's not wanted. */
2123 if (NILP (noindirect
))
2129 Lisp_Object map
, tem
;
2130 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
2131 map
= get_keymap_1 (Fcar_safe (definition
), 0, 0);
2132 tem
= Fkeymapp (map
);
2134 definition
= access_keymap (map
, Fcdr (definition
), 0, 0);
2138 /* If the contents are (STRING ...), reject. */
2139 if (CONSP (definition
)
2140 && STRINGP (XCONS (definition
)->car
))
2144 binding
= get_keyelt (binding
, 0);
2147 /* End this iteration if this element does not match
2150 if (CONSP (definition
))
2153 tem
= Fequal (binding
, definition
);
2158 if (!EQ (binding
, definition
))
2161 /* We have found a match.
2162 Construct the key sequence where we found it. */
2163 if (INTEGERP (key
) && last_is_meta
)
2165 sequence
= Fcopy_sequence (this);
2166 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2169 sequence
= append_key (this, key
);
2171 /* Verify that this key binding is not shadowed by another
2172 binding for the same key, before we say it exists.
2174 Mechanism: look for local definition of this key and if
2175 it is defined and does not match what we found then
2178 Either nil or number as value from Flookup_key
2180 if (keymap_specified
)
2182 binding
= Flookup_key (keymap
, sequence
, Qnil
);
2183 if (!NILP (binding
) && !INTEGERP (binding
))
2185 if (CONSP (definition
))
2188 tem
= Fequal (binding
, definition
);
2193 if (!EQ (binding
, definition
))
2199 binding
= Fkey_binding (sequence
, Qnil
);
2200 if (!EQ (binding
, definition
))
2207 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2209 DEFUN ("describe-bindings", Fdescribe_bindings
, Sdescribe_bindings
, 0, 1, "",
2210 "Show a list of all defined keys, and their definitions.\n\
2211 The list is put in a buffer, which is displayed.\n\
2212 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
2213 then we display only bindings that start with that prefix.")
2217 register Lisp_Object thisbuf
;
2218 XSETBUFFER (thisbuf
, current_buffer
);
2219 internal_with_output_to_temp_buffer ("*Help*",
2220 describe_buffer_bindings
,
2221 Fcons (thisbuf
, prefix
));
2225 /* ARG is (BUFFER . PREFIX). */
2228 describe_buffer_bindings (arg
)
2231 Lisp_Object descbuf
, prefix
, shadow
;
2232 register Lisp_Object start1
;
2233 struct gcpro gcpro1
;
2235 char *alternate_heading
2237 Alternate Characters (use anywhere the nominal character is listed):\n\
2238 nominal alternate\n\
2239 ------- ---------\n";
2241 descbuf
= XCONS (arg
)->car
;
2242 prefix
= XCONS (arg
)->cdr
;
2246 Fset_buffer (Vstandard_output
);
2248 /* Report on alternates for keys. */
2249 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2252 unsigned char *translate
= XSTRING (Vkeyboard_translate_table
)->data
;
2253 int translate_len
= XSTRING (Vkeyboard_translate_table
)->size
;
2255 for (c
= 0; c
< translate_len
; c
++)
2256 if (translate
[c
] != c
)
2261 if (alternate_heading
)
2263 insert_string (alternate_heading
);
2264 alternate_heading
= 0;
2267 bufend
= push_key_description (translate
[c
], buf
);
2268 insert (buf
, bufend
- buf
);
2269 Findent_to (make_number (16), make_number (1));
2270 bufend
= push_key_description (c
, buf
);
2271 insert (buf
, bufend
- buf
);
2279 if (!NILP (Vkey_translation_map
))
2280 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2281 "Key translations", 0, 1, 0);
2285 Lisp_Object
*modes
, *maps
;
2287 /* Temporarily switch to descbuf, so that we can get that buffer's
2288 minor modes correctly. */
2289 Fset_buffer (descbuf
);
2291 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
2292 || !NILP (Voverriding_local_map
))
2295 nmaps
= current_minor_maps (&modes
, &maps
);
2296 Fset_buffer (Vstandard_output
);
2298 /* Print the minor mode maps. */
2299 for (i
= 0; i
< nmaps
; i
++)
2301 /* The title for a minor mode keymap
2302 is constructed at run time.
2303 We let describe_map_tree do the actual insertion
2304 because it takes care of other features when doing so. */
2307 if (!SYMBOLP (modes
[i
]))
2310 p
= title
= (char *) alloca (40 + XSYMBOL (modes
[i
])->name
->size
);
2312 bcopy (XSYMBOL (modes
[i
])->name
->data
, p
,
2313 XSYMBOL (modes
[i
])->name
->size
);
2314 p
+= XSYMBOL (modes
[i
])->name
->size
;
2316 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2317 p
+= sizeof (" Minor Mode Bindings") - 1;
2320 describe_map_tree (maps
[i
], 1, shadow
, prefix
, title
, 0, 0, 0);
2321 shadow
= Fcons (maps
[i
], shadow
);
2325 /* Print the (major mode) local map. */
2326 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2327 start1
= current_kboard
->Voverriding_terminal_local_map
;
2328 else if (!NILP (Voverriding_local_map
))
2329 start1
= Voverriding_local_map
;
2331 start1
= XBUFFER (descbuf
)->keymap
;
2335 describe_map_tree (start1
, 1, shadow
, prefix
,
2336 "Major Mode Bindings", 0, 0, 0);
2337 shadow
= Fcons (start1
, shadow
);
2340 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2341 "Global Bindings", 0, 0, 1);
2343 /* Print the function-key-map translations under this prefix. */
2344 if (!NILP (Vfunction_key_map
))
2345 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2346 "Function key map translations", 0, 1, 0);
2348 call0 (intern ("help-mode"));
2349 Fset_buffer (descbuf
);
2354 /* Insert a description of the key bindings in STARTMAP,
2355 followed by those of all maps reachable through STARTMAP.
2356 If PARTIAL is nonzero, omit certain "uninteresting" commands
2357 (such as `undefined').
2358 If SHADOW is non-nil, it is a list of maps;
2359 don't mention keys which would be shadowed by any of them.
2360 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2361 TITLE, if not 0, is a string to insert at the beginning.
2362 TITLE should not end with a colon or a newline; we supply that.
2363 If NOMENU is not 0, then omit menu-bar commands.
2365 If TRANSL is nonzero, the definitions are actually key translations
2366 so print strings and vectors differently.
2368 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2372 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2374 Lisp_Object startmap
, shadow
, prefix
;
2381 Lisp_Object maps
, seen
, sub_shadows
;
2382 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2389 maps
= Faccessible_keymaps (startmap
, prefix
);
2392 GCPRO3 (maps
, seen
, sub_shadows
);
2398 /* Delete from MAPS each element that is for the menu bar. */
2399 for (list
= maps
; !NILP (list
); list
= XCONS (list
)->cdr
)
2401 Lisp_Object elt
, prefix
, tem
;
2404 prefix
= Fcar (elt
);
2405 if (XVECTOR (prefix
)->size
>= 1)
2407 tem
= Faref (prefix
, make_number (0));
2408 if (EQ (tem
, Qmenu_bar
))
2409 maps
= Fdelq (elt
, maps
);
2414 if (!NILP (maps
) || always_title
)
2418 insert_string (title
);
2421 insert_string (" Starting With ");
2422 insert1 (Fkey_description (prefix
));
2424 insert_string (":\n");
2426 insert_string (key_heading
);
2430 for (; !NILP (maps
); maps
= Fcdr (maps
))
2432 register Lisp_Object elt
, prefix
, tail
;
2435 prefix
= Fcar (elt
);
2439 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2443 shmap
= XCONS (tail
)->car
;
2445 /* If the sequence by which we reach this keymap is zero-length,
2446 then the shadow map for this keymap is just SHADOW. */
2447 if ((STRINGP (prefix
) && XSTRING (prefix
)->size
== 0)
2448 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
2450 /* If the sequence by which we reach this keymap actually has
2451 some elements, then the sequence's definition in SHADOW is
2452 what we should use. */
2455 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
2456 if (INTEGERP (shmap
))
2460 /* If shmap is not nil and not a keymap,
2461 it completely shadows this map, so don't
2462 describe this map at all. */
2463 if (!NILP (shmap
) && NILP (Fkeymapp (shmap
)))
2467 sub_shadows
= Fcons (shmap
, sub_shadows
);
2470 describe_map (Fcdr (elt
), Fcar (elt
),
2471 transl
? describe_translation
: describe_command
,
2472 partial
, sub_shadows
, &seen
, nomenu
);
2478 insert_string ("\n");
2483 static int previous_description_column
;
2486 describe_command (definition
)
2487 Lisp_Object definition
;
2489 register Lisp_Object tem1
;
2490 int column
= current_column ();
2491 int description_column
;
2493 /* If column 16 is no good, go to col 32;
2494 but don't push beyond that--go to next line instead. */
2498 description_column
= 32;
2500 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
2501 description_column
= 32;
2503 description_column
= 16;
2505 Findent_to (make_number (description_column
), make_number (1));
2506 previous_description_column
= description_column
;
2508 if (SYMBOLP (definition
))
2510 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2512 insert_string ("\n");
2514 else if (STRINGP (definition
) || VECTORP (definition
))
2515 insert_string ("Keyboard Macro\n");
2518 tem1
= Fkeymapp (definition
);
2520 insert_string ("Prefix Command\n");
2522 insert_string ("??\n");
2527 describe_translation (definition
)
2528 Lisp_Object definition
;
2530 register Lisp_Object tem1
;
2532 Findent_to (make_number (16), make_number (1));
2534 if (SYMBOLP (definition
))
2536 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2538 insert_string ("\n");
2540 else if (STRINGP (definition
) || VECTORP (definition
))
2542 insert1 (Fkey_description (definition
));
2543 insert_string ("\n");
2547 tem1
= Fkeymapp (definition
);
2549 insert_string ("Prefix Command\n");
2551 insert_string ("??\n");
2555 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2556 Returns the first non-nil binding found in any of those maps. */
2559 shadow_lookup (shadow
, key
, flag
)
2560 Lisp_Object shadow
, key
, flag
;
2562 Lisp_Object tail
, value
;
2564 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2566 value
= Flookup_key (XCONS (tail
)->car
, key
, flag
);
2573 /* Describe the contents of map MAP, assuming that this map itself is
2574 reached by the sequence of prefix keys KEYS (a string or vector).
2575 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
2578 describe_map (map
, keys
, elt_describer
, partial
, shadow
, seen
, nomenu
)
2579 register Lisp_Object map
;
2581 void (*elt_describer
) P_ ((Lisp_Object
));
2587 Lisp_Object elt_prefix
;
2588 Lisp_Object tail
, definition
, event
;
2590 Lisp_Object suppress
;
2593 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2595 if (!NILP (keys
) && XFASTINT (Flength (keys
)) > 0)
2597 /* Call Fkey_description first, to avoid GC bug for the other string. */
2598 tem
= Fkey_description (keys
);
2599 elt_prefix
= concat2 (tem
, build_string (" "));
2605 suppress
= intern ("suppress-keymap");
2607 /* This vector gets used to present single keys to Flookup_key. Since
2608 that is done once per keymap element, we don't want to cons up a
2609 fresh vector every time. */
2610 kludge
= Fmake_vector (make_number (1), Qnil
);
2613 GCPRO3 (elt_prefix
, definition
, kludge
);
2615 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2619 if (VECTORP (XCONS (tail
)->car
)
2620 || CHAR_TABLE_P (XCONS (tail
)->car
))
2621 describe_vector (XCONS (tail
)->car
,
2622 elt_prefix
, elt_describer
, partial
, shadow
, map
,
2624 else if (CONSP (XCONS (tail
)->car
))
2626 event
= XCONS (XCONS (tail
)->car
)->car
;
2628 /* Ignore bindings whose "keys" are not really valid events.
2629 (We get these in the frames and buffers menu.) */
2630 if (! (SYMBOLP (event
) || INTEGERP (event
)))
2633 if (nomenu
&& EQ (event
, Qmenu_bar
))
2636 definition
= get_keyelt (XCONS (XCONS (tail
)->car
)->cdr
, 0);
2638 /* Don't show undefined commands or suppressed commands. */
2639 if (NILP (definition
)) continue;
2640 if (SYMBOLP (definition
) && partial
)
2642 tem
= Fget (definition
, suppress
);
2647 /* Don't show a command that isn't really visible
2648 because a local definition of the same key shadows it. */
2650 XVECTOR (kludge
)->contents
[0] = event
;
2653 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2654 if (!NILP (tem
)) continue;
2657 tem
= Flookup_key (map
, kludge
, Qt
);
2658 if (! EQ (tem
, definition
)) continue;
2662 previous_description_column
= 0;
2667 if (!NILP (elt_prefix
))
2668 insert1 (elt_prefix
);
2670 /* THIS gets the string to describe the character EVENT. */
2671 insert1 (Fsingle_key_description (event
));
2673 /* Print a description of the definition of this character.
2674 elt_describer will take care of spacing out far enough
2675 for alignment purposes. */
2676 (*elt_describer
) (definition
);
2678 else if (EQ (XCONS (tail
)->car
, Qkeymap
))
2680 /* The same keymap might be in the structure twice, if we're
2681 using an inherited keymap. So skip anything we've already
2683 tem
= Fassq (tail
, *seen
);
2684 if (CONSP (tem
) && !NILP (Fequal (XCONS (tem
)->car
, keys
)))
2686 *seen
= Fcons (Fcons (tail
, keys
), *seen
);
2694 describe_vector_princ (elt
)
2697 Findent_to (make_number (16), make_number (1));
2702 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 1, 0,
2703 "Insert a description of contents of VECTOR.\n\
2704 This is text showing the elements of vector matched against indices.")
2708 int count
= specpdl_ptr
- specpdl
;
2710 specbind (Qstandard_output
, Fcurrent_buffer ());
2711 CHECK_VECTOR_OR_CHAR_TABLE (vector
, 0);
2712 describe_vector (vector
, Qnil
, describe_vector_princ
, 0,
2713 Qnil
, Qnil
, (int *)0, 0);
2715 return unbind_to (count
, Qnil
);
2718 /* Insert in the current buffer a description of the contents of VECTOR.
2719 We call ELT_DESCRIBER to insert the description of one value found
2722 ELT_PREFIX describes what "comes before" the keys or indices defined
2723 by this vector. This is a human-readable string whose size
2724 is not necessarily related to the situation.
2726 If the vector is in a keymap, ELT_PREFIX is a prefix key which
2727 leads to this keymap.
2729 If the vector is a chartable, ELT_PREFIX is the vector
2730 of bytes that lead to the character set or portion of a character
2731 set described by this chartable.
2733 If PARTIAL is nonzero, it means do not mention suppressed commands
2734 (that assumes the vector is in a keymap).
2736 SHADOW is a list of keymaps that shadow this map.
2737 If it is non-nil, then we look up the key in those maps
2738 and we don't mention it now if it is defined by any of them.
2740 ENTIRE_MAP is the keymap in which this vector appears.
2741 If the definition in effect in the whole map does not match
2742 the one in this vector, we ignore this one.
2744 When describing a sub-char-table, INDICES is a list of
2745 indices at higher levels in this char-table,
2746 and CHAR_TABLE_DEPTH says how many levels down we have gone. */
2749 describe_vector (vector
, elt_prefix
, elt_describer
,
2750 partial
, shadow
, entire_map
,
2751 indices
, char_table_depth
)
2752 register Lisp_Object vector
;
2753 Lisp_Object elt_prefix
;
2754 void (*elt_describer
) P_ ((Lisp_Object
));
2757 Lisp_Object entire_map
;
2759 int char_table_depth
;
2761 Lisp_Object definition
;
2764 Lisp_Object suppress
;
2767 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2768 /* Range of elements to be handled. */
2770 /* A flag to tell if a leaf in this level of char-table is not a
2771 generic character (i.e. a complete multibyte character). */
2777 indices
= (int *) alloca (3 * sizeof (int));
2781 /* This vector gets used to present single keys to Flookup_key. Since
2782 that is done once per vector element, we don't want to cons up a
2783 fresh vector every time. */
2784 kludge
= Fmake_vector (make_number (1), Qnil
);
2785 GCPRO3 (elt_prefix
, definition
, kludge
);
2788 suppress
= intern ("suppress-keymap");
2790 if (CHAR_TABLE_P (vector
))
2792 if (char_table_depth
== 0)
2794 /* VECTOR is a top level char-table. */
2797 to
= CHAR_TABLE_ORDINARY_SLOTS
;
2801 /* VECTOR is a sub char-table. */
2802 if (char_table_depth
>= 3)
2803 /* A char-table is never that deep. */
2804 error ("Too deep char table");
2807 = (CHARSET_VALID_P (indices
[0])
2808 && ((CHARSET_DIMENSION (indices
[0]) == 1
2809 && char_table_depth
== 1)
2810 || char_table_depth
== 2));
2812 /* Meaningful elements are from 32th to 127th. */
2814 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
2819 /* This does the right thing for ordinary vectors. */
2823 to
= XVECTOR (vector
)->size
;
2826 for (i
= from
; i
< to
; i
++)
2830 if (CHAR_TABLE_P (vector
))
2832 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
2835 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
2836 && !CHARSET_DEFINED_P (i
- 128))
2840 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
2843 definition
= get_keyelt (XVECTOR (vector
)->contents
[i
], 0);
2845 if (NILP (definition
)) continue;
2847 /* Don't mention suppressed commands. */
2848 if (SYMBOLP (definition
) && partial
)
2852 tem
= Fget (definition
, suppress
);
2854 if (!NILP (tem
)) continue;
2857 /* Set CHARACTER to the character this entry describes, if any.
2858 Also update *INDICES. */
2859 if (CHAR_TABLE_P (vector
))
2861 indices
[char_table_depth
] = i
;
2863 if (char_table_depth
== 0)
2866 indices
[0] = i
- 128;
2868 else if (complete_char
)
2871 = MAKE_NON_ASCII_CHAR (indices
[0], indices
[1], indices
[2]);
2879 /* If this binding is shadowed by some other map, ignore it. */
2880 if (!NILP (shadow
) && complete_char
)
2884 XVECTOR (kludge
)->contents
[0] = make_number (character
);
2885 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2887 if (!NILP (tem
)) continue;
2890 /* Ignore this definition if it is shadowed by an earlier
2891 one in the same keymap. */
2892 if (!NILP (entire_map
) && complete_char
)
2896 XVECTOR (kludge
)->contents
[0] = make_number (character
);
2897 tem
= Flookup_key (entire_map
, kludge
, Qt
);
2899 if (! EQ (tem
, definition
))
2905 if (char_table_depth
== 0)
2910 /* For a sub char-table, show the depth by indentation.
2911 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
2912 if (char_table_depth
> 0)
2913 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
2915 /* Output the prefix that applies to every entry in this map. */
2916 if (!NILP (elt_prefix
))
2917 insert1 (elt_prefix
);
2919 /* Insert or describe the character this slot is for,
2920 or a description of what it is for. */
2921 if (SUB_CHAR_TABLE_P (vector
))
2924 insert_char (character
);
2927 /* We need an octal representation for this block of
2930 sprintf (work
, "(row %d)", i
);
2931 insert (work
, strlen (work
));
2934 else if (CHAR_TABLE_P (vector
))
2937 insert1 (Fsingle_key_description (make_number (character
)));
2940 /* Print the information for this character set. */
2941 insert_string ("<");
2942 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
2944 insert_from_string (tem2
, 0, 0, XSTRING (tem2
)->size
,
2945 XSTRING (tem2
)->size_byte
, 0);
2953 insert1 (Fsingle_key_description (make_number (character
)));
2956 /* If we find a sub char-table within a char-table,
2957 scan it recursively; it defines the details for
2958 a character set or a portion of a character set. */
2959 if (CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
2962 describe_vector (definition
, elt_prefix
, elt_describer
,
2963 partial
, shadow
, entire_map
,
2964 indices
, char_table_depth
+ 1);
2970 /* Find all consecutive characters or rows that have the same
2971 definition. But, for elements of a top level char table, if
2972 they are for charsets, we had better describe one by one even
2973 if they have the same definition. */
2974 if (CHAR_TABLE_P (vector
))
2978 if (char_table_depth
== 0)
2979 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
2981 while (i
+ 1 < limit
2982 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
2984 && !NILP (Fequal (tem2
, definition
)))
2989 && (tem2
= get_keyelt (XVECTOR (vector
)->contents
[i
+ 1], 0),
2991 && !NILP (Fequal (tem2
, definition
)))
2995 /* If we have a range of more than one character,
2996 print where the range reaches to. */
2998 if (i
!= starting_i
)
3002 if (!NILP (elt_prefix
))
3003 insert1 (elt_prefix
);
3005 if (CHAR_TABLE_P (vector
))
3007 if (char_table_depth
== 0)
3009 insert1 (Fsingle_key_description (make_number (i
)));
3011 else if (complete_char
)
3013 indices
[char_table_depth
] = i
;
3015 = MAKE_NON_ASCII_CHAR (indices
[0], indices
[1], indices
[2]);
3016 insert_char (character
);
3020 /* We need an octal representation for this block of
3023 sprintf (work
, "(row %d)", i
);
3024 insert (work
, strlen (work
));
3029 insert1 (Fsingle_key_description (make_number (i
)));
3033 /* Print a description of the definition of this character.
3034 elt_describer will take care of spacing out far enough
3035 for alignment purposes. */
3036 (*elt_describer
) (definition
);
3039 /* For (sub) char-table, print `defalt' slot at last. */
3040 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
3042 insert (" ", char_table_depth
* 2);
3043 insert_string ("<<default>>");
3044 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
);
3050 /* Apropos - finding all symbols whose names match a regexp. */
3051 Lisp_Object apropos_predicate
;
3052 Lisp_Object apropos_accumulate
;
3055 apropos_accum (symbol
, string
)
3056 Lisp_Object symbol
, string
;
3058 register Lisp_Object tem
;
3060 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3061 if (!NILP (tem
) && !NILP (apropos_predicate
))
3062 tem
= call1 (apropos_predicate
, symbol
);
3064 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3067 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3068 "Show all symbols whose names contain match for REGEXP.\n\
3069 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done\n\
3070 for each symbol and a symbol is mentioned only if that returns non-nil.\n\
3071 Return list of symbols found.")
3073 Lisp_Object regexp
, predicate
;
3075 struct gcpro gcpro1
, gcpro2
;
3076 CHECK_STRING (regexp
, 0);
3077 apropos_predicate
= predicate
;
3078 GCPRO2 (apropos_predicate
, apropos_accumulate
);
3079 apropos_accumulate
= Qnil
;
3080 map_obarray (Vobarray
, apropos_accum
, regexp
);
3081 apropos_accumulate
= Fsort (apropos_accumulate
, Qstring_lessp
);
3083 return apropos_accumulate
;
3090 Qkeymap
= intern ("keymap");
3091 staticpro (&Qkeymap
);
3093 /* Now we are ready to set up this property, so we can
3094 create char tables. */
3095 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3097 /* Initialize the keymaps standardly used.
3098 Each one is the value of a Lisp variable, and is also
3099 pointed to by a C variable */
3101 global_map
= Fmake_keymap (Qnil
);
3102 Fset (intern ("global-map"), global_map
);
3104 current_global_map
= global_map
;
3105 staticpro (&global_map
);
3106 staticpro (¤t_global_map
);
3108 meta_map
= Fmake_keymap (Qnil
);
3109 Fset (intern ("esc-map"), meta_map
);
3110 Ffset (intern ("ESC-prefix"), meta_map
);
3112 control_x_map
= Fmake_keymap (Qnil
);
3113 Fset (intern ("ctl-x-map"), control_x_map
);
3114 Ffset (intern ("Control-X-prefix"), control_x_map
);
3116 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3117 "List of commands given new key bindings recently.\n\
3118 This is used for internal purposes during Emacs startup;\n\
3119 don't alter it yourself.");
3120 Vdefine_key_rebound_commands
= Qt
;
3122 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3123 "Default keymap to use when reading from the minibuffer.");
3124 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3126 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3127 "Local keymap for the minibuffer when spaces are not allowed.");
3128 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3130 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3131 "Local keymap for minibuffer input with completion.");
3132 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3134 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3135 "Local keymap for minibuffer input with completion, for exact match.");
3136 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3138 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3139 "Alist of keymaps to use for minor modes.\n\
3140 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read\n\
3141 key sequences and look up bindings iff VARIABLE's value is non-nil.\n\
3142 If two active keymaps bind the same key, the keymap appearing earlier\n\
3143 in the list takes precedence.");
3144 Vminor_mode_map_alist
= Qnil
;
3146 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist
,
3147 "Alist of keymaps to use for minor modes, in current major mode.\n\
3148 This variable is a alist just like `minor-mode-map-alist', and it is\n\
3149 used the same way (and before `minor-mode-map-alist'); however,\n\
3150 it is provided for major modes to bind locally.");
3151 Vminor_mode_overriding_map_alist
= Qnil
;
3153 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3154 "Keymap mapping ASCII function key sequences onto their preferred forms.\n\
3155 This allows Emacs to recognize function keys sent from ASCII\n\
3156 terminals at any point in a key sequence.\n\
3158 The `read-key-sequence' function replaces any subsequence bound by\n\
3159 `function-key-map' with its binding. More precisely, when the active\n\
3160 keymaps have no binding for the current key sequence but\n\
3161 `function-key-map' binds a suffix of the sequence to a vector or string,\n\
3162 `read-key-sequence' replaces the matching suffix with its binding, and\n\
3163 continues with the new sequence.\n\
3165 The events that come from bindings in `function-key-map' are not\n\
3166 themselves looked up in `function-key-map'.\n\
3168 For example, suppose `function-key-map' binds `ESC O P' to [f1].\n\
3169 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing\n\
3170 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix\n\
3171 key, typing `ESC O P x' would return [f1 x].");
3172 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3174 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3175 "Keymap of key translations that can override keymaps.\n\
3176 This keymap works like `function-key-map', but comes after that,\n\
3177 and applies even for keys that have ordinary bindings.");
3178 Vkey_translation_map
= Qnil
;
3180 Qsingle_key_description
= intern ("single-key-description");
3181 staticpro (&Qsingle_key_description
);
3183 Qkey_description
= intern ("key-description");
3184 staticpro (&Qkey_description
);
3186 Qkeymapp
= intern ("keymapp");
3187 staticpro (&Qkeymapp
);
3189 Qnon_ascii
= intern ("non-ascii");
3190 staticpro (&Qnon_ascii
);
3192 defsubr (&Skeymapp
);
3193 defsubr (&Skeymap_parent
);
3194 defsubr (&Sset_keymap_parent
);
3195 defsubr (&Smake_keymap
);
3196 defsubr (&Smake_sparse_keymap
);
3197 defsubr (&Scopy_keymap
);
3198 defsubr (&Skey_binding
);
3199 defsubr (&Slocal_key_binding
);
3200 defsubr (&Sglobal_key_binding
);
3201 defsubr (&Sminor_mode_key_binding
);
3202 defsubr (&Sdefine_key
);
3203 defsubr (&Slookup_key
);
3204 defsubr (&Sdefine_prefix_command
);
3205 defsubr (&Suse_global_map
);
3206 defsubr (&Suse_local_map
);
3207 defsubr (&Scurrent_local_map
);
3208 defsubr (&Scurrent_global_map
);
3209 defsubr (&Scurrent_minor_mode_maps
);
3210 defsubr (&Saccessible_keymaps
);
3211 defsubr (&Skey_description
);
3212 defsubr (&Sdescribe_vector
);
3213 defsubr (&Ssingle_key_description
);
3214 defsubr (&Stext_char_description
);
3215 defsubr (&Swhere_is_internal
);
3216 defsubr (&Sdescribe_bindings
);
3217 defsubr (&Sapropos_internal
);
3224 initial_define_key (global_map
, 033, "ESC-prefix");
3225 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");