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 /* Keymap mapping ASCII function key sequences onto their preferred forms.
75 Initialized by the terminal-specific lisp files. See DEFVAR for more
77 Lisp_Object Vfunction_key_map
;
79 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
80 Lisp_Object Vkey_translation_map
;
82 /* A list of all commands given new bindings since a certain time
83 when nil was stored here.
84 This is used to speed up recomputation of menu key equivalents
85 when Emacs starts up. t means don't record anything here. */
86 Lisp_Object Vdefine_key_rebound_commands
;
88 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
;
90 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
91 in a string key sequence is equivalent to prefixing with this
93 extern Lisp_Object meta_prefix_char
;
95 extern Lisp_Object Voverriding_local_map
;
97 static Lisp_Object
define_as_prefix ();
98 static Lisp_Object
describe_buffer_bindings ();
99 static void describe_command (), describe_translation ();
100 static void describe_map ();
102 /* Keymap object support - constructors and predicates. */
104 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
105 "Construct and return a new keymap, of the form (keymap VECTOR . ALIST).\n\
106 VECTOR is a vector which holds the bindings for the ASCII\n\
107 characters. ALIST is an assoc-list which holds bindings for function keys,\n\
108 mouse events, and any other things that appear in the input stream.\n\
109 All entries in it are initially nil, meaning \"command undefined\".\n\n\
110 The optional arg STRING supplies a menu name for the keymap\n\
111 in case you use it as a menu with `x-popup-menu'.")
117 tail
= Fcons (string
, Qnil
);
120 return Fcons (Qkeymap
,
121 Fcons (Fmake_char_table (Qkeymap
, Qnil
), tail
));
124 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
125 "Construct and return a new sparse-keymap list.\n\
126 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),\n\
127 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),\n\
128 which binds the function key or mouse event SYMBOL to DEFINITION.\n\
129 Initially the alist is nil.\n\n\
130 The optional arg STRING supplies a menu name for the keymap\n\
131 in case you use it as a menu with `x-popup-menu'.")
136 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
137 return Fcons (Qkeymap
, Qnil
);
140 /* This function is used for installing the standard key bindings
141 at initialization time.
145 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
148 initial_define_key (keymap
, key
, defname
)
153 store_in_keymap (keymap
, make_number (key
), intern (defname
));
157 initial_define_lispy_key (keymap
, keyname
, defname
)
162 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
165 /* Define character fromchar in map frommap as an alias for character
166 tochar in map tomap. Subsequent redefinitions of the latter WILL
167 affect the former. */
171 synkey (frommap
, fromchar
, tomap
, tochar
)
172 struct Lisp_Vector
*frommap
, *tomap
;
173 int fromchar
, tochar
;
176 XSETVECTOR (v
, tomap
);
177 XSETFASTINT (c
, tochar
);
178 frommap
->contents
[fromchar
] = Fcons (v
, c
);
182 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
183 "Return t if OBJECT is a keymap.\n\
185 A keymap is a list (keymap . ALIST),\n\
186 or a symbol whose function definition is itself a keymap.\n\
187 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
188 a vector of densely packed bindings for small character codes\n\
189 is also allowed as an element.")
193 return (NILP (get_keymap_1 (object
, 0, 0)) ? Qnil
: Qt
);
196 /* Check that OBJECT is a keymap (after dereferencing through any
197 symbols). If it is, return it.
199 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
200 is an autoload form, do the autoload and try again.
201 If AUTOLOAD is nonzero, callers must assume GC is possible.
203 ERROR controls how we respond if OBJECT isn't a keymap.
204 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
206 Note that most of the time, we don't want to pursue autoloads.
207 Functions like Faccessible_keymaps which scan entire keymap trees
208 shouldn't load every autoloaded keymap. I'm not sure about this,
209 but it seems to me that only read_key_sequence, Flookup_key, and
210 Fdefine_key should cause keymaps to be autoloaded. */
213 get_keymap_1 (object
, error
, autoload
)
220 tem
= indirect_function (object
);
221 if (CONSP (tem
) && EQ (XCONS (tem
)->car
, Qkeymap
))
224 /* Should we do an autoload? Autoload forms for keymaps have
225 Qkeymap as their fifth element. */
229 && EQ (XCONS (tem
)->car
, Qautoload
))
233 tail
= Fnth (make_number (4), tem
);
234 if (EQ (tail
, Qkeymap
))
236 struct gcpro gcpro1
, gcpro2
;
238 GCPRO2 (tem
, object
);
239 do_autoload (tem
, object
);
247 wrong_type_argument (Qkeymapp
, object
);
253 /* Follow any symbol chaining, and return the keymap denoted by OBJECT.
254 If OBJECT doesn't denote a keymap at all, signal an error. */
259 return get_keymap_1 (object
, 1, 0);
262 /* Return the parent map of the keymap MAP, or nil if it has none.
263 We assume that MAP is a valid keymap. */
265 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
266 "Return the parent keymap of KEYMAP.")
272 keymap
= get_keymap_1 (keymap
, 1, 1);
274 /* Skip past the initial element `keymap'. */
275 list
= XCONS (keymap
)->cdr
;
276 for (; CONSP (list
); list
= XCONS (list
)->cdr
)
278 /* See if there is another `keymap'. */
279 if (EQ (Qkeymap
, XCONS (list
)->car
))
286 /* Set the parent keymap of MAP to PARENT. */
288 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
289 "Modify KEYMAP to set its parent map to PARENT.\n\
290 PARENT should be nil or another keymap.")
292 Lisp_Object keymap
, parent
;
294 Lisp_Object list
, prev
;
297 keymap
= get_keymap_1 (keymap
, 1, 1);
299 parent
= get_keymap_1 (parent
, 1, 1);
301 /* Skip past the initial element `keymap'. */
305 list
= XCONS (prev
)->cdr
;
306 /* If there is a parent keymap here, replace it.
307 If we came to the end, add the parent in PREV. */
308 if (! CONSP (list
) || EQ (Qkeymap
, XCONS (list
)->car
))
310 /* If we already have the right parent, return now
311 so that we avoid the loops below. */
312 if (EQ (XCONS (prev
)->cdr
, parent
))
315 XCONS (prev
)->cdr
= parent
;
321 /* Scan through for submaps, and set their parents too. */
323 for (list
= XCONS (keymap
)->cdr
; CONSP (list
); list
= XCONS (list
)->cdr
)
325 /* Stop the scan when we come to the parent. */
326 if (EQ (XCONS (list
)->car
, Qkeymap
))
329 /* If this element holds a prefix map, deal with it. */
330 if (CONSP (XCONS (list
)->car
)
331 && CONSP (XCONS (XCONS (list
)->car
)->cdr
))
332 fix_submap_inheritance (keymap
, XCONS (XCONS (list
)->car
)->car
,
333 XCONS (XCONS (list
)->car
)->cdr
);
335 if (VECTORP (XCONS (list
)->car
))
336 for (i
= 0; i
< XVECTOR (XCONS (list
)->car
)->size
; i
++)
337 if (CONSP (XVECTOR (XCONS (list
)->car
)->contents
[i
]))
338 fix_submap_inheritance (keymap
, make_number (i
),
339 XVECTOR (XCONS (list
)->car
)->contents
[i
]);
341 if (CHAR_TABLE_P (XCONS (list
)->car
))
344 = (Lisp_Object
*) alloca (3 * sizeof (Lisp_Object
));
346 map_char_table (fix_submap_inheritance
, Qnil
, XCONS (list
)->car
,
354 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
355 if EVENT is also a prefix in MAP's parent,
356 make sure that SUBMAP inherits that definition as its own parent. */
358 fix_submap_inheritance (map
, event
, submap
)
359 Lisp_Object map
, event
, submap
;
361 Lisp_Object map_parent
, parent_entry
;
363 /* SUBMAP is a cons that we found as a key binding.
364 Discard the other things found in a menu key binding. */
367 && STRINGP (XCONS (submap
)->car
))
369 submap
= XCONS (submap
)->cdr
;
370 /* Also remove a menu help string, if any,
371 following the menu item name. */
372 if (CONSP (submap
) && STRINGP (XCONS (submap
)->car
))
373 submap
= XCONS (submap
)->cdr
;
374 /* Also remove the sublist that caches key equivalences, if any. */
376 && CONSP (XCONS (submap
)->car
))
379 carcar
= XCONS (XCONS (submap
)->car
)->car
;
380 if (NILP (carcar
) || VECTORP (carcar
))
381 submap
= XCONS (submap
)->cdr
;
385 /* If it isn't a keymap now, there's no work to do. */
387 || ! EQ (XCONS (submap
)->car
, Qkeymap
))
390 map_parent
= Fkeymap_parent (map
);
391 if (! NILP (map_parent
))
392 parent_entry
= access_keymap (map_parent
, event
, 0, 0);
396 /* If MAP's parent has something other than a keymap,
397 our own submap shadows it completely, so use nil as SUBMAP's parent. */
398 if (! (CONSP (parent_entry
) && EQ (XCONS (parent_entry
)->car
, Qkeymap
)))
401 if (! EQ (parent_entry
, submap
))
402 Fset_keymap_parent (submap
, parent_entry
);
405 /* Look up IDX in MAP. IDX may be any sort of event.
406 Note that this does only one level of lookup; IDX must be a single
407 event, not a sequence.
409 If T_OK is non-zero, bindings for Qt are treated as default
410 bindings; any key left unmentioned by other tables and bindings is
411 given the binding of Qt.
413 If T_OK is zero, bindings for Qt are not treated specially.
415 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
418 access_keymap (map
, idx
, t_ok
, noinherit
)
427 /* If idx is a list (some sort of mouse click, perhaps?),
428 the index we want to use is the car of the list, which
429 ought to be a symbol. */
430 idx
= EVENT_HEAD (idx
);
432 /* If idx is a symbol, it might have modifiers, which need to
433 be put in the canonical order. */
435 idx
= reorder_modifiers (idx
);
436 else if (INTEGERP (idx
))
437 /* Clobber the high bits that can be present on a machine
438 with more than 24 bits of integer. */
439 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
443 Lisp_Object t_binding
;
446 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
450 binding
= XCONS (tail
)->car
;
451 if (SYMBOLP (binding
))
453 /* If NOINHERIT, stop finding prefix definitions
454 after we pass a second occurrence of the `keymap' symbol. */
455 if (noinherit
&& EQ (binding
, Qkeymap
) && ! EQ (tail
, map
))
458 else if (CONSP (binding
))
460 if (EQ (XCONS (binding
)->car
, idx
))
462 val
= XCONS (binding
)->cdr
;
463 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
466 fix_submap_inheritance (map
, idx
, val
);
469 if (t_ok
&& EQ (XCONS (binding
)->car
, Qt
))
470 t_binding
= XCONS (binding
)->cdr
;
472 else if (VECTORP (binding
))
474 if (NATNUMP (idx
) && XFASTINT (idx
) < XVECTOR (binding
)->size
)
476 val
= XVECTOR (binding
)->contents
[XFASTINT (idx
)];
477 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
480 fix_submap_inheritance (map
, idx
, val
);
484 else if (CHAR_TABLE_P (binding
))
488 val
= Faref (binding
, idx
);
489 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
492 fix_submap_inheritance (map
, idx
, val
);
504 /* Given OBJECT which was found in a slot in a keymap,
505 trace indirect definitions to get the actual definition of that slot.
506 An indirect definition is a list of the form
507 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
508 and INDEX is the object to look up in KEYMAP to yield the definition.
510 Also if OBJECT has a menu string as the first element,
511 remove that. Also remove a menu help string as second element.
513 If AUTOLOAD is nonzero, load autoloadable keymaps
514 that are referred to with indirection. */
517 get_keyelt (object
, autoload
)
518 register Lisp_Object object
;
523 register Lisp_Object map
, tem
;
525 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
526 map
= get_keymap_1 (Fcar_safe (object
), 0, autoload
);
527 tem
= Fkeymapp (map
);
532 if (INTEGERP (key
) && (XINT (key
) & meta_modifier
))
534 object
= access_keymap (map
, make_number (meta_prefix_char
),
536 map
= get_keymap_1 (object
, 0, autoload
);
537 object
= access_keymap (map
,
538 make_number (XINT (key
) & ~meta_modifier
),
542 object
= access_keymap (map
, key
, 0, 0);
545 /* If the keymap contents looks like (STRING . DEFN),
547 Keymap alist elements like (CHAR MENUSTRING . DEFN)
548 will be used by HierarKey menus. */
549 else if (CONSP (object
)
550 && STRINGP (XCONS (object
)->car
))
552 object
= XCONS (object
)->cdr
;
553 /* Also remove a menu help string, if any,
554 following the menu item name. */
555 if (CONSP (object
) && STRINGP (XCONS (object
)->car
))
556 object
= XCONS (object
)->cdr
;
557 /* Also remove the sublist that caches key equivalences, if any. */
559 && CONSP (XCONS (object
)->car
))
562 carcar
= XCONS (XCONS (object
)->car
)->car
;
563 if (NILP (carcar
) || VECTORP (carcar
))
564 object
= XCONS (object
)->cdr
;
569 /* Anything else is really the value. */
575 store_in_keymap (keymap
, idx
, def
)
577 register Lisp_Object idx
;
578 register Lisp_Object def
;
580 /* If we are preparing to dump, and DEF is a menu element
581 with a menu item string, copy it to ensure it is not pure. */
582 if (CONSP (def
) && PURE_P (def
) && STRINGP (XCONS (def
)->car
))
583 def
= Fcons (XCONS (def
)->car
, XCONS (def
)->cdr
);
585 if (!CONSP (keymap
) || ! EQ (XCONS (keymap
)->car
, Qkeymap
))
586 error ("attempt to define a key in a non-keymap");
588 /* If idx is a list (some sort of mouse click, perhaps?),
589 the index we want to use is the car of the list, which
590 ought to be a symbol. */
591 idx
= EVENT_HEAD (idx
);
593 /* If idx is a symbol, it might have modifiers, which need to
594 be put in the canonical order. */
596 idx
= reorder_modifiers (idx
);
597 else if (INTEGERP (idx
))
598 /* Clobber the high bits that can be present on a machine
599 with more than 24 bits of integer. */
600 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
602 /* Scan the keymap for a binding of idx. */
606 /* The cons after which we should insert new bindings. If the
607 keymap has a table element, we record its position here, so new
608 bindings will go after it; this way, the table will stay
609 towards the front of the alist and character lookups in dense
610 keymaps will remain fast. Otherwise, this just points at the
611 front of the keymap. */
612 Lisp_Object insertion_point
;
614 insertion_point
= keymap
;
615 for (tail
= XCONS (keymap
)->cdr
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
619 elt
= XCONS (tail
)->car
;
622 if (NATNUMP (idx
) && XFASTINT (idx
) < XVECTOR (elt
)->size
)
624 XVECTOR (elt
)->contents
[XFASTINT (idx
)] = def
;
627 insertion_point
= tail
;
629 else if (CHAR_TABLE_P (elt
))
633 Faset (elt
, idx
, def
);
636 insertion_point
= tail
;
638 else if (CONSP (elt
))
640 if (EQ (idx
, XCONS (elt
)->car
))
642 XCONS (elt
)->cdr
= def
;
646 else if (SYMBOLP (elt
))
648 /* If we find a 'keymap' symbol in the spine of KEYMAP,
649 then we must have found the start of a second keymap
650 being used as the tail of KEYMAP, and a binding for IDX
651 should be inserted before it. */
652 if (EQ (elt
, Qkeymap
))
660 /* We have scanned the entire keymap, and not found a binding for
661 IDX. Let's add one. */
662 XCONS (insertion_point
)->cdr
663 = Fcons (Fcons (idx
, def
), XCONS (insertion_point
)->cdr
);
670 copy_keymap_1 (chartable
, idx
, elt
)
671 Lisp_Object chartable
, idx
, elt
;
673 Faset (chartable
, idx
, Fcopy_keymap (elt
));
676 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
677 "Return a copy of the keymap KEYMAP.\n\
678 The copy starts out with the same definitions of KEYMAP,\n\
679 but changing either the copy or KEYMAP does not affect the other.\n\
680 Any key definitions that are subkeymaps are recursively copied.\n\
681 However, a key definition which is a symbol whose definition is a keymap\n\
686 register Lisp_Object copy
, tail
;
688 copy
= Fcopy_alist (get_keymap (keymap
));
690 for (tail
= copy
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
694 elt
= XCONS (tail
)->car
;
695 if (CHAR_TABLE_P (elt
))
698 = (Lisp_Object
*) alloca (3 * sizeof (Lisp_Object
));
700 elt
= Fcopy_sequence (elt
);
701 map_char_table (copy_keymap_1
, Qnil
, elt
, elt
, 0, indices
);
703 else if (VECTORP (elt
))
707 elt
= Fcopy_sequence (elt
);
708 XCONS (tail
)->car
= elt
;
710 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
711 if (!SYMBOLP (XVECTOR (elt
)->contents
[i
])
712 && ! NILP (Fkeymapp (XVECTOR (elt
)->contents
[i
])))
713 XVECTOR (elt
)->contents
[i
]
714 = Fcopy_keymap (XVECTOR (elt
)->contents
[i
]);
716 else if (CONSP (elt
))
718 /* Skip the optional menu string. */
719 if (CONSP (XCONS (elt
)->cdr
)
720 && STRINGP (XCONS (XCONS (elt
)->cdr
)->car
))
724 /* Copy the cell, since copy-alist didn't go this deep. */
725 XCONS (elt
)->cdr
= Fcons (XCONS (XCONS (elt
)->cdr
)->car
,
726 XCONS (XCONS (elt
)->cdr
)->cdr
);
727 elt
= XCONS (elt
)->cdr
;
729 /* Also skip the optional menu help string. */
730 if (CONSP (XCONS (elt
)->cdr
)
731 && STRINGP (XCONS (XCONS (elt
)->cdr
)->car
))
733 XCONS (elt
)->cdr
= Fcons (XCONS (XCONS (elt
)->cdr
)->car
,
734 XCONS (XCONS (elt
)->cdr
)->cdr
);
735 elt
= XCONS (elt
)->cdr
;
737 /* There may also be a list that caches key equivalences.
738 Just delete it for the new keymap. */
739 if (CONSP (XCONS (elt
)->cdr
)
740 && CONSP (XCONS (XCONS (elt
)->cdr
)->car
)
741 && (NILP (tem
= XCONS (XCONS (XCONS (elt
)->cdr
)->car
)->car
)
743 XCONS (elt
)->cdr
= XCONS (XCONS (elt
)->cdr
)->cdr
;
746 && ! SYMBOLP (XCONS (elt
)->cdr
)
747 && ! NILP (Fkeymapp (XCONS (elt
)->cdr
)))
748 XCONS (elt
)->cdr
= Fcopy_keymap (XCONS (elt
)->cdr
);
755 /* Simple Keymap mutators and accessors. */
757 /* GC is possible in this function if it autoloads a keymap. */
759 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
760 "Args KEYMAP, KEY, DEF. Define key sequence KEY, in KEYMAP, as DEF.\n\
761 KEYMAP is a keymap. KEY is a string or a vector of symbols and characters\n\
762 meaning a sequence of keystrokes and events.\n\
763 Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
764 can be included if you use a vector.\n\
765 DEF is anything that can be a key's definition:\n\
766 nil (means key is undefined in this keymap),\n\
767 a command (a Lisp function suitable for interactive calling)\n\
768 a string (treated as a keyboard macro),\n\
769 a keymap (to define a prefix key),\n\
770 a symbol. When the key is looked up, the symbol will stand for its\n\
771 function definition, which should at that time be one of the above,\n\
772 or another symbol whose function definition is used, etc.\n\
773 a cons (STRING . DEFN), meaning that DEFN is the definition\n\
774 (DEFN should be a valid definition in its own right),\n\
775 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.\n\
777 If KEYMAP is a sparse keymap, the pair binding KEY to DEF is added at\n\
778 the front of KEYMAP.")
785 register Lisp_Object c
;
786 register Lisp_Object tem
;
787 register Lisp_Object cmd
;
791 struct gcpro gcpro1
, gcpro2
, gcpro3
;
793 keymap
= get_keymap_1 (keymap
, 1, 1);
795 if (!VECTORP (key
) && !STRINGP (key
))
796 key
= wrong_type_argument (Qarrayp
, key
);
798 length
= XFASTINT (Flength (key
));
802 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
803 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
805 GCPRO3 (keymap
, key
, def
);
808 meta_bit
= meta_modifier
;
815 c
= Faref (key
, make_number (idx
));
817 if (CONSP (c
) && lucid_event_type_list_p (c
))
818 c
= Fevent_convert_list (c
);
821 && (XINT (c
) & meta_bit
)
824 c
= meta_prefix_char
;
830 XSETINT (c
, XINT (c
) & ~meta_bit
);
836 if (! INTEGERP (c
) && ! SYMBOLP (c
) && ! CONSP (c
))
837 error ("Key sequence contains invalid events");
840 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
842 cmd
= get_keyelt (access_keymap (keymap
, c
, 0, 1), 1);
844 /* If this key is undefined, make it a prefix. */
846 cmd
= define_as_prefix (keymap
, c
);
848 keymap
= get_keymap_1 (cmd
, 0, 1);
850 /* We must use Fkey_description rather than just passing key to
851 error; key might be a vector, not a string. */
852 error ("Key sequence %s uses invalid prefix characters",
853 XSTRING (Fkey_description (key
))->data
);
857 /* Value is number if KEY is too long; NIL if valid but has no definition. */
858 /* GC is possible in this function if it autoloads a keymap. */
860 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
861 "In keymap KEYMAP, look up key sequence KEY. Return the definition.\n\
862 nil means undefined. See doc of `define-key' for kinds of definitions.\n\
864 A number as value means KEY is \"too long\";\n\
865 that is, characters or symbols in it except for the last one\n\
866 fail to be a valid sequence of prefix characters in KEYMAP.\n\
867 The number is how many characters at the front of KEY\n\
868 it takes to reach a non-prefix command.\n\
870 Normally, `lookup-key' ignores bindings for t, which act as default\n\
871 bindings, used when nothing else in the keymap applies; this makes it\n\
872 usable as a general function for probing keymaps. However, if the\n\
873 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will\n\
874 recognize the default bindings, just as `read-key-sequence' does.")
875 (keymap
, key
, accept_default
)
876 register Lisp_Object keymap
;
878 Lisp_Object accept_default
;
881 register Lisp_Object tem
;
882 register Lisp_Object cmd
;
883 register Lisp_Object c
;
886 int t_ok
= ! NILP (accept_default
);
890 keymap
= get_keymap_1 (keymap
, 1, 1);
892 if (!VECTORP (key
) && !STRINGP (key
))
893 key
= wrong_type_argument (Qarrayp
, key
);
895 length
= XFASTINT (Flength (key
));
900 meta_bit
= meta_modifier
;
909 c
= Faref (key
, make_number (idx
));
911 if (CONSP (c
) && lucid_event_type_list_p (c
))
912 c
= Fevent_convert_list (c
);
915 && (XINT (c
) & meta_bit
)
918 c
= meta_prefix_char
;
924 XSETINT (c
, XINT (c
) & ~meta_bit
);
930 cmd
= get_keyelt (access_keymap (keymap
, c
, t_ok
, 0), 1);
932 RETURN_UNGCPRO (cmd
);
934 keymap
= get_keymap_1 (cmd
, 0, 1);
936 RETURN_UNGCPRO (make_number (idx
));
942 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
943 Assume that currently it does not define C at all.
944 Return the keymap. */
947 define_as_prefix (keymap
, c
)
948 Lisp_Object keymap
, c
;
950 Lisp_Object inherit
, cmd
;
952 cmd
= Fmake_sparse_keymap (Qnil
);
953 /* If this key is defined as a prefix in an inherited keymap,
954 make it a prefix in this map, and make its definition
955 inherit the other prefix definition. */
956 inherit
= access_keymap (keymap
, c
, 0, 0);
958 /* This code is needed to do the right thing in the following case:
959 keymap A inherits from B,
960 you define KEY as a prefix in A,
961 then later you define KEY as a prefix in B.
962 We want the old prefix definition in A to inherit from that in B.
963 It is hard to do that retroactively, so this code
964 creates the prefix in B right away.
966 But it turns out that this code causes problems immediately
967 when the prefix in A is defined: it causes B to define KEY
968 as a prefix with no subcommands.
970 So I took out this code. */
973 /* If there's an inherited keymap
974 and it doesn't define this key,
975 make it define this key. */
978 for (tail
= Fcdr (keymap
); CONSP (tail
); tail
= XCONS (tail
)->cdr
)
979 if (EQ (XCONS (tail
)->car
, Qkeymap
))
983 inherit
= define_as_prefix (tail
, c
);
987 cmd
= nconc2 (cmd
, inherit
);
988 store_in_keymap (keymap
, c
, cmd
);
993 /* Append a key to the end of a key sequence. We always make a vector. */
996 append_key (key_sequence
, key
)
997 Lisp_Object key_sequence
, key
;
1001 args
[0] = key_sequence
;
1003 args
[1] = Fcons (key
, Qnil
);
1004 return Fvconcat (2, args
);
1008 /* Global, local, and minor mode keymap stuff. */
1010 /* We can't put these variables inside current_minor_maps, since under
1011 some systems, static gets macro-defined to be the empty string.
1013 static Lisp_Object
*cmm_modes
, *cmm_maps
;
1014 static int cmm_size
;
1016 /* Error handler used in current_minor_maps. */
1018 current_minor_maps_error ()
1023 /* Store a pointer to an array of the keymaps of the currently active
1024 minor modes in *buf, and return the number of maps it contains.
1026 This function always returns a pointer to the same buffer, and may
1027 free or reallocate it, so if you want to keep it for a long time or
1028 hand it out to lisp code, copy it. This procedure will be called
1029 for every key sequence read, so the nice lispy approach (return a
1030 new assoclist, list, what have you) for each invocation would
1031 result in a lot of consing over time.
1033 If we used xrealloc/xmalloc and ran out of memory, they would throw
1034 back to the command loop, which would try to read a key sequence,
1035 which would call this function again, resulting in an infinite
1036 loop. Instead, we'll use realloc/malloc and silently truncate the
1037 list, let the key sequence be read, and hope some other piece of
1038 code signals the error. */
1040 current_minor_maps (modeptr
, mapptr
)
1041 Lisp_Object
**modeptr
, **mapptr
;
1044 Lisp_Object alist
, assoc
, var
, val
;
1046 for (alist
= Vminor_mode_map_alist
;
1048 alist
= XCONS (alist
)->cdr
)
1049 if ((assoc
= XCONS (alist
)->car
, CONSP (assoc
))
1050 && (var
= XCONS (assoc
)->car
, SYMBOLP (var
))
1051 && (val
= find_symbol_value (var
), ! EQ (val
, Qunbound
))
1058 Lisp_Object
*newmodes
, *newmaps
;
1065 = (Lisp_Object
*) realloc (cmm_modes
,
1066 cmm_size
* sizeof (Lisp_Object
));
1068 = (Lisp_Object
*) realloc (cmm_maps
,
1069 cmm_size
* sizeof (Lisp_Object
));
1077 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
1079 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
1083 if (newmaps
&& newmodes
)
1085 cmm_modes
= newmodes
;
1092 /* Get the keymap definition--or nil if it is not defined. */
1093 temp
= internal_condition_case_1 (Findirect_function
,
1095 Qerror
, current_minor_maps_error
);
1099 cmm_maps
[i
] = temp
;
1104 if (modeptr
) *modeptr
= cmm_modes
;
1105 if (mapptr
) *mapptr
= cmm_maps
;
1109 /* GC is possible in this function if it autoloads a keymap. */
1111 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 2, 0,
1112 "Return the binding for command KEY in current keymaps.\n\
1113 KEY is a string or vector, a sequence of keystrokes.\n\
1114 The binding is probably a symbol with a function definition.\n\
1116 Normally, `key-binding' ignores bindings for t, which act as default\n\
1117 bindings, used when nothing else in the keymap applies; this makes it\n\
1118 usable as a general function for probing keymaps. However, if the\n\
1119 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\
1120 recognize the default bindings, just as `read-key-sequence' does.")
1121 (key
, accept_default
)
1122 Lisp_Object key
, accept_default
;
1124 Lisp_Object
*maps
, value
;
1126 struct gcpro gcpro1
;
1130 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1132 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1133 key
, accept_default
);
1134 if (! NILP (value
) && !INTEGERP (value
))
1135 RETURN_UNGCPRO (value
);
1137 else if (!NILP (Voverriding_local_map
))
1139 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1140 if (! NILP (value
) && !INTEGERP (value
))
1141 RETURN_UNGCPRO (value
);
1147 nmaps
= current_minor_maps (0, &maps
);
1148 /* Note that all these maps are GCPRO'd
1149 in the places where we found them. */
1151 for (i
= 0; i
< nmaps
; i
++)
1152 if (! NILP (maps
[i
]))
1154 value
= Flookup_key (maps
[i
], key
, accept_default
);
1155 if (! NILP (value
) && !INTEGERP (value
))
1156 RETURN_UNGCPRO (value
);
1159 local
= get_local_map (PT
, current_buffer
);
1163 value
= Flookup_key (local
, key
, accept_default
);
1164 if (! NILP (value
) && !INTEGERP (value
))
1165 RETURN_UNGCPRO (value
);
1169 value
= Flookup_key (current_global_map
, key
, accept_default
);
1171 if (! NILP (value
) && !INTEGERP (value
))
1177 /* GC is possible in this function if it autoloads a keymap. */
1179 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1180 "Return the binding for command KEYS in current local keymap only.\n\
1181 KEYS is a string, a sequence of keystrokes.\n\
1182 The binding is probably a symbol with a function definition.\n\
1184 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1185 bindings; see the description of `lookup-key' for more details about this.")
1186 (keys
, accept_default
)
1187 Lisp_Object keys
, accept_default
;
1189 register Lisp_Object map
;
1190 map
= current_buffer
->keymap
;
1193 return Flookup_key (map
, keys
, accept_default
);
1196 /* GC is possible in this function if it autoloads a keymap. */
1198 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1199 "Return the binding for command KEYS in current global keymap only.\n\
1200 KEYS is a string, a sequence of keystrokes.\n\
1201 The binding is probably a symbol with a function definition.\n\
1202 This function's return values are the same as those of lookup-key\n\
1205 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1206 bindings; see the description of `lookup-key' for more details about this.")
1207 (keys
, accept_default
)
1208 Lisp_Object keys
, accept_default
;
1210 return Flookup_key (current_global_map
, keys
, accept_default
);
1213 /* GC is possible in this function if it autoloads a keymap. */
1215 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1216 "Find the visible minor mode bindings of KEY.\n\
1217 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the\n\
1218 the symbol which names the minor mode binding KEY, and BINDING is\n\
1219 KEY's definition in that mode. In particular, if KEY has no\n\
1220 minor-mode bindings, return nil. If the first binding is a\n\
1221 non-prefix, all subsequent bindings will be omitted, since they would\n\
1222 be ignored. Similarly, the list doesn't include non-prefix bindings\n\
1223 that come after prefix bindings.\n\
1225 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1226 bindings; see the description of `lookup-key' for more details about this.")
1227 (key
, accept_default
)
1228 Lisp_Object key
, accept_default
;
1230 Lisp_Object
*modes
, *maps
;
1232 Lisp_Object binding
;
1234 struct gcpro gcpro1
, gcpro2
;
1236 nmaps
= current_minor_maps (&modes
, &maps
);
1237 /* Note that all these maps are GCPRO'd
1238 in the places where we found them. */
1241 GCPRO2 (key
, binding
);
1243 for (i
= j
= 0; i
< nmaps
; i
++)
1244 if (! NILP (maps
[i
])
1245 && ! NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1246 && !INTEGERP (binding
))
1248 if (! NILP (get_keymap (binding
)))
1249 maps
[j
++] = Fcons (modes
[i
], binding
);
1251 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1255 return Flist (j
, maps
);
1258 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 2, 0,
1259 "Define COMMAND as a prefix command. COMMAND should be a symbol.\n\
1260 A new sparse keymap is stored as COMMAND's function definition and its value.\n\
1261 If a second optional argument MAPVAR is given, the map is stored as\n\
1262 its value instead of as COMMAND's value; but COMMAND is still defined\n\
1265 Lisp_Object command
, mapvar
;
1268 map
= Fmake_sparse_keymap (Qnil
);
1269 Ffset (command
, map
);
1273 Fset (command
, map
);
1277 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1278 "Select KEYMAP as the global keymap.")
1282 keymap
= get_keymap (keymap
);
1283 current_global_map
= keymap
;
1288 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1289 "Select KEYMAP as the local keymap.\n\
1290 If KEYMAP is nil, that means no local keymap.")
1295 keymap
= get_keymap (keymap
);
1297 current_buffer
->keymap
= keymap
;
1302 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1303 "Return current buffer's local keymap, or nil if it has none.")
1306 return current_buffer
->keymap
;
1309 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1310 "Return the current global keymap.")
1313 return current_global_map
;
1316 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1317 "Return a list of keymaps for the minor modes of the current buffer.")
1321 int nmaps
= current_minor_maps (0, &maps
);
1323 return Flist (nmaps
, maps
);
1326 /* Help functions for describing and documenting keymaps. */
1328 static Lisp_Object
accessible_keymaps_char_table ();
1330 /* This function cannot GC. */
1332 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1334 "Find all keymaps accessible via prefix characters from KEYMAP.\n\
1335 Returns a list of elements of the form (KEYS . MAP), where the sequence\n\
1336 KEYS starting from KEYMAP gets you to MAP. These elements are ordered\n\
1337 so that the KEYS increase in length. The first element is ([] . KEYMAP).\n\
1338 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
1339 then the value includes only maps for prefixes that start with PREFIX.")
1341 Lisp_Object keymap
, prefix
;
1343 Lisp_Object maps
, good_maps
, tail
;
1346 /* no need for gcpro because we don't autoload any keymaps. */
1349 prefixlen
= XINT (Flength (prefix
));
1353 /* If a prefix was specified, start with the keymap (if any) for
1354 that prefix, so we don't waste time considering other prefixes. */
1356 tem
= Flookup_key (keymap
, prefix
, Qt
);
1357 /* Flookup_key may give us nil, or a number,
1358 if the prefix is not defined in this particular map.
1359 It might even give us a list that isn't a keymap. */
1360 tem
= get_keymap_1 (tem
, 0, 0);
1363 /* Convert PREFIX to a vector now, so that later on
1364 we don't have to deal with the possibility of a string. */
1365 if (STRINGP (prefix
))
1370 copy
= Fmake_vector (make_number (XSTRING (prefix
)->size
), Qnil
);
1371 for (i
= 0; i
< XSTRING (prefix
)->size
; i
++)
1373 int c
= XSTRING (prefix
)->data
[i
];
1375 c
^= 0200 | meta_modifier
;
1376 XVECTOR (copy
)->contents
[i
] = make_number (c
);
1380 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1386 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1387 get_keymap (keymap
)),
1390 /* For each map in the list maps,
1391 look at any other maps it points to,
1392 and stick them at the end if they are not already in the list.
1394 This is a breadth-first traversal, where tail is the queue of
1395 nodes, and maps accumulates a list of all nodes visited. */
1397 for (tail
= maps
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1399 register Lisp_Object thisseq
, thismap
;
1401 /* Does the current sequence end in the meta-prefix-char? */
1404 thisseq
= Fcar (Fcar (tail
));
1405 thismap
= Fcdr (Fcar (tail
));
1406 last
= make_number (XINT (Flength (thisseq
)) - 1);
1407 is_metized
= (XINT (last
) >= 0
1408 /* Don't metize the last char of PREFIX. */
1409 && XINT (last
) >= prefixlen
1410 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1412 for (; CONSP (thismap
); thismap
= XCONS (thismap
)->cdr
)
1416 elt
= XCONS (thismap
)->car
;
1420 if (CHAR_TABLE_P (elt
))
1422 Lisp_Object
*indices
1423 = (Lisp_Object
*) alloca (3 * sizeof (Lisp_Object
));
1425 map_char_table (accessible_keymaps_char_table
, Qnil
,
1426 elt
, Fcons (maps
, Fcons (tail
, thisseq
)),
1429 else if (VECTORP (elt
))
1433 /* Vector keymap. Scan all the elements. */
1434 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
1436 register Lisp_Object tem
;
1437 register Lisp_Object cmd
;
1439 cmd
= get_keyelt (XVECTOR (elt
)->contents
[i
], 0);
1440 if (NILP (cmd
)) continue;
1441 tem
= Fkeymapp (cmd
);
1444 cmd
= get_keymap (cmd
);
1445 /* Ignore keymaps that are already added to maps. */
1446 tem
= Frassq (cmd
, maps
);
1449 /* If the last key in thisseq is meta-prefix-char,
1450 turn it into a meta-ized keystroke. We know
1451 that the event we're about to append is an
1452 ascii keystroke since we're processing a
1456 int meta_bit
= meta_modifier
;
1457 tem
= Fcopy_sequence (thisseq
);
1459 Faset (tem
, last
, make_number (i
| meta_bit
));
1461 /* This new sequence is the same length as
1462 thisseq, so stick it in the list right
1465 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1469 tem
= append_key (thisseq
, make_number (i
));
1470 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1476 else if (CONSP (elt
))
1478 register Lisp_Object cmd
, tem
, filter
;
1480 cmd
= get_keyelt (XCONS (elt
)->cdr
, 0);
1481 /* Ignore definitions that aren't keymaps themselves. */
1482 tem
= Fkeymapp (cmd
);
1485 /* Ignore keymaps that have been seen already. */
1486 cmd
= get_keymap (cmd
);
1487 tem
= Frassq (cmd
, maps
);
1490 /* Let elt be the event defined by this map entry. */
1491 elt
= XCONS (elt
)->car
;
1493 /* If the last key in thisseq is meta-prefix-char, and
1494 this entry is a binding for an ascii keystroke,
1495 turn it into a meta-ized keystroke. */
1496 if (is_metized
&& INTEGERP (elt
))
1498 Lisp_Object element
;
1501 tem
= Fvconcat (1, &element
);
1502 XVECTOR (tem
)->contents
[XINT (last
)]
1503 = XINT (elt
) | meta_modifier
;
1505 /* This new sequence is the same length as
1506 thisseq, so stick it in the list right
1509 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1513 Fcons (Fcons (append_key (thisseq
, elt
), cmd
),
1524 /* Now find just the maps whose access prefixes start with PREFIX. */
1527 for (; CONSP (maps
); maps
= XCONS (maps
)->cdr
)
1529 Lisp_Object elt
, thisseq
;
1530 elt
= XCONS (maps
)->car
;
1531 thisseq
= XCONS (elt
)->car
;
1532 /* The access prefix must be at least as long as PREFIX,
1533 and the first elements must match those of PREFIX. */
1534 if (XINT (Flength (thisseq
)) >= prefixlen
)
1537 for (i
= 0; i
< prefixlen
; i
++)
1540 XSETFASTINT (i1
, i
);
1541 if (!EQ (Faref (thisseq
, i1
), Faref (prefix
, i1
)))
1545 good_maps
= Fcons (elt
, good_maps
);
1549 return Fnreverse (good_maps
);
1553 accessible_keymaps_char_table (args
, index
, cmd
)
1554 Lisp_Object args
, index
, cmd
;
1557 Lisp_Object maps
, tail
, thisseq
;
1562 maps
= XCONS (args
)->car
;
1563 tail
= XCONS (XCONS (args
)->cdr
)->car
;
1564 thisseq
= XCONS (XCONS (args
)->cdr
)->cdr
;
1566 tem
= Fkeymapp (cmd
);
1569 cmd
= get_keymap (cmd
);
1570 /* Ignore keymaps that are already added to maps. */
1571 tem
= Frassq (cmd
, maps
);
1574 tem
= append_key (thisseq
, index
);
1575 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1581 Lisp_Object Qsingle_key_description
, Qkey_description
;
1583 /* This function cannot GC. */
1585 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 1, 0,
1586 "Return a pretty description of key-sequence KEYS.\n\
1587 Control characters turn into \"C-foo\" sequences, meta into \"M-foo\"\n\
1588 spaces are put between sequence elements, etc.")
1600 vector
= Fmake_vector (Flength (keys
), Qnil
);
1601 for (i
= 0; i
< XSTRING (keys
)->size
; i
++)
1603 if (XSTRING (keys
)->data
[i
] & 0x80)
1604 XSETFASTINT (XVECTOR (vector
)->contents
[i
],
1605 meta_modifier
| (XSTRING (keys
)->data
[i
] & ~0x80));
1607 XSETFASTINT (XVECTOR (vector
)->contents
[i
],
1608 XSTRING (keys
)->data
[i
]);
1612 else if (!VECTORP (keys
))
1613 keys
= wrong_type_argument (Qarrayp
, keys
);
1615 /* In effect, this computes
1616 (mapconcat 'single-key-description keys " ")
1617 but we shouldn't use mapconcat because it can do GC. */
1619 len
= XVECTOR (keys
)->size
;
1620 sep
= build_string (" ");
1621 /* This has one extra element at the end that we don't pass to Fconcat. */
1622 args
= (Lisp_Object
*) alloca (len
* 2 * sizeof (Lisp_Object
));
1624 for (i
= 0; i
< len
; i
++)
1626 args
[i
* 2] = Fsingle_key_description (XVECTOR (keys
)->contents
[i
]);
1627 args
[i
* 2 + 1] = sep
;
1630 return Fconcat (len
* 2 - 1, args
);
1634 push_key_description (c
, p
)
1635 register unsigned int c
;
1638 /* Clear all the meaningless bits above the meta bit. */
1639 c
&= meta_modifier
| ~ - meta_modifier
;
1641 if (c
& alt_modifier
)
1647 if (c
& ctrl_modifier
)
1653 if (c
& hyper_modifier
)
1657 c
-= hyper_modifier
;
1659 if (c
& meta_modifier
)
1665 if (c
& shift_modifier
)
1669 c
-= shift_modifier
;
1671 if (c
& super_modifier
)
1675 c
-= super_modifier
;
1691 else if (c
== Ctl ('M'))
1701 if (c
> 0 && c
<= Ctl ('Z'))
1726 *p
++ = (7 & (c
>> 6)) + '0';
1727 *p
++ = (7 & (c
>> 3)) + '0';
1728 *p
++ = (7 & (c
>> 0)) + '0';
1733 *p
++ = (7 & (c
>> 15)) + '0';
1734 *p
++ = (7 & (c
>> 12)) + '0';
1735 *p
++ = (7 & (c
>> 9)) + '0';
1736 *p
++ = (7 & (c
>> 6)) + '0';
1737 *p
++ = (7 & (c
>> 3)) + '0';
1738 *p
++ = (7 & (c
>> 0)) + '0';
1744 /* This function cannot GC. */
1746 DEFUN ("single-key-description", Fsingle_key_description
, Ssingle_key_description
, 1, 1, 0,
1747 "Return a pretty description of command character KEY.\n\
1748 Control characters turn into C-whatever, etc.")
1754 key
= EVENT_HEAD (key
);
1756 if (INTEGERP (key
)) /* Normal character */
1758 *push_key_description (XUINT (key
), tem
) = 0;
1759 return build_string (tem
);
1761 else if (SYMBOLP (key
)) /* Function key or event-symbol */
1762 return Fsymbol_name (key
);
1763 else if (STRINGP (key
)) /* Buffer names in the menubar. */
1764 return Fcopy_sequence (key
);
1766 error ("KEY must be an integer, cons, symbol, or string");
1770 push_text_char_description (c
, p
)
1771 register unsigned int c
;
1783 *p
++ = c
+ 64; /* 'A' - 1 */
1795 /* This function cannot GC. */
1797 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
1798 "Return a pretty description of file-character CHARACTER.\n\
1799 Control characters turn into \"^char\", etc.")
1801 Lisp_Object character
;
1805 CHECK_NUMBER (character
, 0);
1807 if (!SINGLE_BYTE_CHAR_P (XFASTINT (character
)))
1810 int len
= non_ascii_char_to_string (XFASTINT (character
), tem
, &str
);
1812 return make_string (str
, len
);
1815 *push_text_char_description (XINT (character
) & 0377, tem
) = 0;
1817 return build_string (tem
);
1820 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
1823 ascii_sequence_p (seq
)
1827 int len
= XINT (Flength (seq
));
1829 for (i
= 0; i
< len
; i
++)
1831 Lisp_Object ii
, elt
;
1833 XSETFASTINT (ii
, i
);
1834 elt
= Faref (seq
, ii
);
1837 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
1845 /* where-is - finding a command in a set of keymaps. */
1847 static Lisp_Object
where_is_internal_1 ();
1848 static Lisp_Object
where_is_internal_2 ();
1850 /* This function can GC if Flookup_key autoloads any keymaps. */
1852 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 4, 0,
1853 "Return list of keys that invoke DEFINITION.\n\
1854 If KEYMAP is non-nil, search only KEYMAP and the global keymap.\n\
1855 If KEYMAP is nil, search all the currently active keymaps.\n\
1857 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,\n\
1858 rather than a list of all possible key sequences.\n\
1859 If FIRSTONLY is the symbol `non-ascii', return the first binding found,\n\
1860 no matter what it is.\n\
1861 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters,\n\
1862 and entirely reject menu bindings.\n\
1864 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections\n\
1865 to other keymaps or slots. This makes it possible to search for an\n\
1866 indirect definition itself.")
1867 (definition
, keymap
, firstonly
, noindirect
)
1868 Lisp_Object definition
, keymap
;
1869 Lisp_Object firstonly
, noindirect
;
1872 Lisp_Object found
, sequences
;
1873 int keymap_specified
= !NILP (keymap
);
1874 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
1875 /* 1 means ignore all menu bindings entirely. */
1876 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
1878 if (! keymap_specified
)
1880 #ifdef USE_TEXT_PROPERTIES
1881 keymap
= get_local_map (PT
, current_buffer
);
1883 keymap
= current_buffer
->keymap
;
1888 maps
= nconc2 (Faccessible_keymaps (get_keymap (keymap
), Qnil
),
1889 Faccessible_keymaps (get_keymap (current_global_map
),
1892 maps
= Faccessible_keymaps (get_keymap (current_global_map
), Qnil
);
1894 /* Put the minor mode keymaps on the front. */
1895 if (! keymap_specified
)
1898 minors
= Fnreverse (Fcurrent_minor_mode_maps ());
1899 while (!NILP (minors
))
1901 maps
= nconc2 (Faccessible_keymaps (get_keymap (XCONS (minors
)->car
),
1904 minors
= XCONS (minors
)->cdr
;
1908 GCPRO5 (definition
, keymap
, maps
, found
, sequences
);
1912 for (; !NILP (maps
); maps
= Fcdr (maps
))
1914 /* Key sequence to reach map, and the map that it reaches */
1915 register Lisp_Object
this, map
;
1917 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
1918 [M-CHAR] sequences, check if last character of the sequence
1919 is the meta-prefix char. */
1923 this = Fcar (Fcar (maps
));
1924 map
= Fcdr (Fcar (maps
));
1925 last
= make_number (XINT (Flength (this)) - 1);
1926 last_is_meta
= (XINT (last
) >= 0
1927 && EQ (Faref (this, last
), meta_prefix_char
));
1933 /* Because the code we want to run on each binding is rather
1934 large, we don't want to have two separate loop bodies for
1935 sparse keymap bindings and tables; we want to iterate one
1936 loop body over both keymap and vector bindings.
1938 For this reason, if Fcar (map) is a vector, we don't
1939 advance map to the next element until i indicates that we
1940 have finished off the vector. */
1941 Lisp_Object elt
, key
, binding
;
1942 elt
= XCONS (map
)->car
;
1943 map
= XCONS (map
)->cdr
;
1949 /* Set key and binding to the current key and binding, and
1950 advance map and i to the next binding. */
1953 Lisp_Object sequence
;
1955 /* In a vector, look at each element. */
1956 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
1958 binding
= XVECTOR (elt
)->contents
[i
];
1959 XSETFASTINT (key
, i
);
1960 sequence
= where_is_internal_1 (binding
, key
, definition
,
1961 noindirect
, keymap
, this,
1962 last
, nomenus
, last_is_meta
);
1963 if (!NILP (sequence
))
1964 sequences
= Fcons (sequence
, sequences
);
1967 else if (CHAR_TABLE_P (elt
))
1969 Lisp_Object
*indices
1970 = (Lisp_Object
*) alloca (3 * sizeof (Lisp_Object
));
1972 args
= Fcons (Fcons (Fcons (definition
, noindirect
),
1973 Fcons (keymap
, Qnil
)),
1974 Fcons (Fcons (this, last
),
1975 Fcons (make_number (nomenus
),
1976 make_number (last_is_meta
))));
1978 map_char_table (where_is_internal_2
, Qnil
, elt
, args
,
1980 sequences
= XCONS (XCONS (XCONS (args
)->car
)->cdr
)->cdr
;
1982 else if (CONSP (elt
))
1984 Lisp_Object sequence
;
1986 key
= XCONS (elt
)->car
;
1987 binding
= XCONS (elt
)->cdr
;
1989 sequence
= where_is_internal_1 (binding
, key
, definition
,
1990 noindirect
, keymap
, this,
1991 last
, nomenus
, last_is_meta
);
1992 if (!NILP (sequence
))
1993 sequences
= Fcons (sequence
, sequences
);
1997 for (; ! NILP (sequences
); sequences
= XCONS (sequences
)->cdr
)
1999 Lisp_Object sequence
;
2001 sequence
= XCONS (sequences
)->car
;
2003 /* It is a true unshadowed match. Record it, unless it's already
2004 been seen (as could happen when inheriting keymaps). */
2005 if (NILP (Fmember (sequence
, found
)))
2006 found
= Fcons (sequence
, found
);
2008 /* If firstonly is Qnon_ascii, then we can return the first
2009 binding we find. If firstonly is not Qnon_ascii but not
2010 nil, then we should return the first ascii-only binding
2012 if (EQ (firstonly
, Qnon_ascii
))
2013 RETURN_UNGCPRO (sequence
);
2014 else if (! NILP (firstonly
) && ascii_sequence_p (sequence
))
2015 RETURN_UNGCPRO (sequence
);
2022 found
= Fnreverse (found
);
2024 /* firstonly may have been t, but we may have gone all the way through
2025 the keymaps without finding an all-ASCII key sequence. So just
2026 return the best we could find. */
2027 if (! NILP (firstonly
))
2028 return Fcar (found
);
2033 /* This is the function that Fwhere_is_internal calls using map_char_table.
2035 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2037 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2038 Since map_char_table doesn't really use the return value from this function,
2039 we the result append to RESULT, the slot in ARGS. */
2042 where_is_internal_2 (args
, key
, binding
)
2043 Lisp_Object args
, key
, binding
;
2045 Lisp_Object definition
, noindirect
, keymap
, this, last
;
2046 Lisp_Object result
, sequence
;
2047 int nomenus
, last_is_meta
;
2049 result
= XCONS (XCONS (XCONS (args
)->car
)->cdr
)->cdr
;
2050 definition
= XCONS (XCONS (XCONS (args
)->car
)->car
)->car
;
2051 noindirect
= XCONS (XCONS (XCONS (args
)->car
)->car
)->cdr
;
2052 keymap
= XCONS (XCONS (XCONS (args
)->car
)->cdr
)->car
;
2053 this = XCONS (XCONS (XCONS (args
)->cdr
)->car
)->car
;
2054 last
= XCONS (XCONS (XCONS (args
)->cdr
)->car
)->cdr
;
2055 nomenus
= XFASTINT (XCONS (XCONS (XCONS (args
)->cdr
)->cdr
)->car
);
2056 last_is_meta
= XFASTINT (XCONS (XCONS (XCONS (args
)->cdr
)->cdr
)->cdr
);
2058 sequence
= where_is_internal_1 (binding
, key
, definition
, noindirect
, keymap
,
2059 this, last
, nomenus
, last_is_meta
);
2061 if (!NILP (sequence
))
2062 XCONS (XCONS (XCONS (args
)->car
)->cdr
)->cdr
2063 = Fcons (sequence
, result
);
2069 where_is_internal_1 (binding
, key
, definition
, noindirect
, keymap
, this, last
,
2070 nomenus
, last_is_meta
)
2071 Lisp_Object binding
, key
, definition
, noindirect
, keymap
, this, last
;
2072 int nomenus
, last_is_meta
;
2074 Lisp_Object sequence
;
2075 int keymap_specified
= !NILP (keymap
);
2077 /* Search through indirections unless that's not wanted. */
2078 if (NILP (noindirect
))
2084 Lisp_Object map
, tem
;
2085 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
2086 map
= get_keymap_1 (Fcar_safe (definition
), 0, 0);
2087 tem
= Fkeymapp (map
);
2089 definition
= access_keymap (map
, Fcdr (definition
), 0, 0);
2093 /* If the contents are (STRING ...), reject. */
2094 if (CONSP (definition
)
2095 && STRINGP (XCONS (definition
)->car
))
2099 binding
= get_keyelt (binding
, 0);
2102 /* End this iteration if this element does not match
2105 if (CONSP (definition
))
2108 tem
= Fequal (binding
, definition
);
2113 if (!EQ (binding
, definition
))
2116 /* We have found a match.
2117 Construct the key sequence where we found it. */
2118 if (INTEGERP (key
) && last_is_meta
)
2120 sequence
= Fcopy_sequence (this);
2121 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
2124 sequence
= append_key (this, key
);
2126 /* Verify that this key binding is not shadowed by another
2127 binding for the same key, before we say it exists.
2129 Mechanism: look for local definition of this key and if
2130 it is defined and does not match what we found then
2133 Either nil or number as value from Flookup_key
2135 if (keymap_specified
)
2137 binding
= Flookup_key (keymap
, sequence
, Qnil
);
2138 if (!NILP (binding
) && !INTEGERP (binding
))
2140 if (CONSP (definition
))
2143 tem
= Fequal (binding
, definition
);
2148 if (!EQ (binding
, definition
))
2154 binding
= Fkey_binding (sequence
, Qnil
);
2155 if (!EQ (binding
, definition
))
2162 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
2164 DEFUN ("describe-bindings", Fdescribe_bindings
, Sdescribe_bindings
, 0, 1, "",
2165 "Show a list of all defined keys, and their definitions.\n\
2166 The list is put in a buffer, which is displayed.\n\
2167 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
2168 then we display only bindings that start with that prefix.")
2172 register Lisp_Object thisbuf
;
2173 XSETBUFFER (thisbuf
, current_buffer
);
2174 internal_with_output_to_temp_buffer ("*Help*",
2175 describe_buffer_bindings
,
2176 Fcons (thisbuf
, prefix
));
2180 /* ARG is (BUFFER . PREFIX). */
2183 describe_buffer_bindings (arg
)
2186 Lisp_Object descbuf
, prefix
, shadow
;
2187 register Lisp_Object start1
;
2188 struct gcpro gcpro1
;
2190 char *alternate_heading
2192 Alternate Characters (use anywhere the nominal character is listed):\n\
2193 nominal alternate\n\
2194 ------- ---------\n";
2196 descbuf
= XCONS (arg
)->car
;
2197 prefix
= XCONS (arg
)->cdr
;
2201 Fset_buffer (Vstandard_output
);
2203 /* Report on alternates for keys. */
2204 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2207 unsigned char *translate
= XSTRING (Vkeyboard_translate_table
)->data
;
2208 int translate_len
= XSTRING (Vkeyboard_translate_table
)->size
;
2210 for (c
= 0; c
< translate_len
; c
++)
2211 if (translate
[c
] != c
)
2216 if (alternate_heading
)
2218 insert_string (alternate_heading
);
2219 alternate_heading
= 0;
2222 bufend
= push_key_description (translate
[c
], buf
);
2223 insert (buf
, bufend
- buf
);
2224 Findent_to (make_number (16), make_number (1));
2225 bufend
= push_key_description (c
, buf
);
2226 insert (buf
, bufend
- buf
);
2234 if (!NILP (Vkey_translation_map
))
2235 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2236 "Key translations", 0, 1, 0);
2240 Lisp_Object
*modes
, *maps
;
2242 /* Temporarily switch to descbuf, so that we can get that buffer's
2243 minor modes correctly. */
2244 Fset_buffer (descbuf
);
2246 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
2247 || !NILP (Voverriding_local_map
))
2250 nmaps
= current_minor_maps (&modes
, &maps
);
2251 Fset_buffer (Vstandard_output
);
2253 /* Print the minor mode maps. */
2254 for (i
= 0; i
< nmaps
; i
++)
2256 /* The title for a minor mode keymap
2257 is constructed at run time.
2258 We let describe_map_tree do the actual insertion
2259 because it takes care of other features when doing so. */
2262 if (!SYMBOLP (modes
[i
]))
2265 p
= title
= (char *) alloca (40 + XSYMBOL (modes
[i
])->name
->size
);
2267 bcopy (XSYMBOL (modes
[i
])->name
->data
, p
,
2268 XSYMBOL (modes
[i
])->name
->size
);
2269 p
+= XSYMBOL (modes
[i
])->name
->size
;
2271 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2272 p
+= sizeof (" Minor Mode Bindings") - 1;
2275 describe_map_tree (maps
[i
], 1, shadow
, prefix
, title
, 0, 0, 0);
2276 shadow
= Fcons (maps
[i
], shadow
);
2280 /* Print the (major mode) local map. */
2281 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2282 start1
= current_kboard
->Voverriding_terminal_local_map
;
2283 else if (!NILP (Voverriding_local_map
))
2284 start1
= Voverriding_local_map
;
2286 start1
= XBUFFER (descbuf
)->keymap
;
2290 describe_map_tree (start1
, 1, shadow
, prefix
,
2291 "Major Mode Bindings", 0, 0, 0);
2292 shadow
= Fcons (start1
, shadow
);
2295 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2296 "Global Bindings", 0, 0, 1);
2298 /* Print the function-key-map translations under this prefix. */
2299 if (!NILP (Vfunction_key_map
))
2300 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2301 "Function key map translations", 0, 1, 0);
2303 call0 (intern ("help-mode"));
2304 Fset_buffer (descbuf
);
2309 /* Insert a description of the key bindings in STARTMAP,
2310 followed by those of all maps reachable through STARTMAP.
2311 If PARTIAL is nonzero, omit certain "uninteresting" commands
2312 (such as `undefined').
2313 If SHADOW is non-nil, it is a list of maps;
2314 don't mention keys which would be shadowed by any of them.
2315 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2316 TITLE, if not 0, is a string to insert at the beginning.
2317 TITLE should not end with a colon or a newline; we supply that.
2318 If NOMENU is not 0, then omit menu-bar commands.
2320 If TRANSL is nonzero, the definitions are actually key translations
2321 so print strings and vectors differently.
2323 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2327 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2329 Lisp_Object startmap
, shadow
, prefix
;
2336 Lisp_Object maps
, seen
, sub_shadows
;
2337 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2344 maps
= Faccessible_keymaps (startmap
, prefix
);
2347 GCPRO3 (maps
, seen
, sub_shadows
);
2353 /* Delete from MAPS each element that is for the menu bar. */
2354 for (list
= maps
; !NILP (list
); list
= XCONS (list
)->cdr
)
2356 Lisp_Object elt
, prefix
, tem
;
2359 prefix
= Fcar (elt
);
2360 if (XVECTOR (prefix
)->size
>= 1)
2362 tem
= Faref (prefix
, make_number (0));
2363 if (EQ (tem
, Qmenu_bar
))
2364 maps
= Fdelq (elt
, maps
);
2369 if (!NILP (maps
) || always_title
)
2373 insert_string (title
);
2376 insert_string (" Starting With ");
2377 insert1 (Fkey_description (prefix
));
2379 insert_string (":\n");
2381 insert_string (key_heading
);
2385 for (; !NILP (maps
); maps
= Fcdr (maps
))
2387 register Lisp_Object elt
, prefix
, tail
;
2390 prefix
= Fcar (elt
);
2394 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2398 shmap
= XCONS (tail
)->car
;
2400 /* If the sequence by which we reach this keymap is zero-length,
2401 then the shadow map for this keymap is just SHADOW. */
2402 if ((STRINGP (prefix
) && XSTRING (prefix
)->size
== 0)
2403 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
2405 /* If the sequence by which we reach this keymap actually has
2406 some elements, then the sequence's definition in SHADOW is
2407 what we should use. */
2410 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
2411 if (INTEGERP (shmap
))
2415 /* If shmap is not nil and not a keymap,
2416 it completely shadows this map, so don't
2417 describe this map at all. */
2418 if (!NILP (shmap
) && NILP (Fkeymapp (shmap
)))
2422 sub_shadows
= Fcons (shmap
, sub_shadows
);
2425 describe_map (Fcdr (elt
), Fcar (elt
),
2426 transl
? describe_translation
: describe_command
,
2427 partial
, sub_shadows
, &seen
, nomenu
);
2433 insert_string ("\n");
2438 static int previous_description_column
;
2441 describe_command (definition
)
2442 Lisp_Object definition
;
2444 register Lisp_Object tem1
;
2445 int column
= current_column ();
2446 int description_column
;
2448 /* If column 16 is no good, go to col 32;
2449 but don't push beyond that--go to next line instead. */
2453 description_column
= 32;
2455 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
2456 description_column
= 32;
2458 description_column
= 16;
2460 Findent_to (make_number (description_column
), make_number (1));
2461 previous_description_column
= description_column
;
2463 if (SYMBOLP (definition
))
2465 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2467 insert_string ("\n");
2469 else if (STRINGP (definition
) || VECTORP (definition
))
2470 insert_string ("Keyboard Macro\n");
2473 tem1
= Fkeymapp (definition
);
2475 insert_string ("Prefix Command\n");
2477 insert_string ("??\n");
2482 describe_translation (definition
)
2483 Lisp_Object definition
;
2485 register Lisp_Object tem1
;
2487 Findent_to (make_number (16), make_number (1));
2489 if (SYMBOLP (definition
))
2491 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2493 insert_string ("\n");
2495 else if (STRINGP (definition
) || VECTORP (definition
))
2497 insert1 (Fkey_description (definition
));
2498 insert_string ("\n");
2502 tem1
= Fkeymapp (definition
);
2504 insert_string ("Prefix Command\n");
2506 insert_string ("??\n");
2510 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2511 Returns the first non-nil binding found in any of those maps. */
2514 shadow_lookup (shadow
, key
, flag
)
2515 Lisp_Object shadow
, key
, flag
;
2517 Lisp_Object tail
, value
;
2519 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2521 value
= Flookup_key (XCONS (tail
)->car
, key
, flag
);
2528 /* Describe the contents of map MAP, assuming that this map itself is
2529 reached by the sequence of prefix keys KEYS (a string or vector).
2530 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
2533 describe_map (map
, keys
, elt_describer
, partial
, shadow
, seen
, nomenu
)
2534 register Lisp_Object map
;
2536 int (*elt_describer
) ();
2542 Lisp_Object elt_prefix
;
2543 Lisp_Object tail
, definition
, event
;
2545 Lisp_Object suppress
;
2548 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2550 if (!NILP (keys
) && XFASTINT (Flength (keys
)) > 0)
2552 /* Call Fkey_description first, to avoid GC bug for the other string. */
2553 tem
= Fkey_description (keys
);
2554 elt_prefix
= concat2 (tem
, build_string (" "));
2560 suppress
= intern ("suppress-keymap");
2562 /* This vector gets used to present single keys to Flookup_key. Since
2563 that is done once per keymap element, we don't want to cons up a
2564 fresh vector every time. */
2565 kludge
= Fmake_vector (make_number (1), Qnil
);
2568 GCPRO3 (elt_prefix
, definition
, kludge
);
2570 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2574 if (VECTORP (XCONS (tail
)->car
)
2575 || CHAR_TABLE_P (XCONS (tail
)->car
))
2576 describe_vector (XCONS (tail
)->car
,
2577 elt_prefix
, elt_describer
, partial
, shadow
, map
,
2579 else if (CONSP (XCONS (tail
)->car
))
2581 event
= XCONS (XCONS (tail
)->car
)->car
;
2583 /* Ignore bindings whose "keys" are not really valid events.
2584 (We get these in the frames and buffers menu.) */
2585 if (! (SYMBOLP (event
) || INTEGERP (event
)))
2588 if (nomenu
&& EQ (event
, Qmenu_bar
))
2591 definition
= get_keyelt (XCONS (XCONS (tail
)->car
)->cdr
, 0);
2593 /* Don't show undefined commands or suppressed commands. */
2594 if (NILP (definition
)) continue;
2595 if (SYMBOLP (definition
) && partial
)
2597 tem
= Fget (definition
, suppress
);
2602 /* Don't show a command that isn't really visible
2603 because a local definition of the same key shadows it. */
2605 XVECTOR (kludge
)->contents
[0] = event
;
2608 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2609 if (!NILP (tem
)) continue;
2612 tem
= Flookup_key (map
, kludge
, Qt
);
2613 if (! EQ (tem
, definition
)) continue;
2617 previous_description_column
= 0;
2622 if (!NILP (elt_prefix
))
2623 insert1 (elt_prefix
);
2625 /* THIS gets the string to describe the character EVENT. */
2626 insert1 (Fsingle_key_description (event
));
2628 /* Print a description of the definition of this character.
2629 elt_describer will take care of spacing out far enough
2630 for alignment purposes. */
2631 (*elt_describer
) (definition
);
2633 else if (EQ (XCONS (tail
)->car
, Qkeymap
))
2635 /* The same keymap might be in the structure twice, if we're
2636 using an inherited keymap. So skip anything we've already
2638 tem
= Fassq (tail
, *seen
);
2639 if (CONSP (tem
) && !NILP (Fequal (XCONS (tem
)->car
, keys
)))
2641 *seen
= Fcons (Fcons (tail
, keys
), *seen
);
2649 describe_vector_princ (elt
)
2652 Findent_to (make_number (16), make_number (1));
2657 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 1, 0,
2658 "Insert a description of contents of VECTOR.\n\
2659 This is text showing the elements of vector matched against indices.")
2663 int count
= specpdl_ptr
- specpdl
;
2665 specbind (Qstandard_output
, Fcurrent_buffer ());
2666 CHECK_VECTOR_OR_CHAR_TABLE (vector
, 0);
2667 describe_vector (vector
, Qnil
, describe_vector_princ
, 0,
2668 Qnil
, Qnil
, (int *)0, 0);
2670 return unbind_to (count
, Qnil
);
2673 /* Insert in the current buffer a description of the contents of VECTOR.
2674 We call ELT_DESCRIBER to insert the description of one value found
2677 ELT_PREFIX describes what "comes before" the keys or indices defined
2678 by this vector. This is a human-readable string whose size
2679 is not necessarily related to the situation.
2681 If the vector is in a keymap, ELT_PREFIX is a prefix key which
2682 leads to this keymap.
2684 If the vector is a chartable, ELT_PREFIX is the vector
2685 of bytes that lead to the character set or portion of a character
2686 set described by this chartable.
2688 If PARTIAL is nonzero, it means do not mention suppressed commands
2689 (that assumes the vector is in a keymap).
2691 SHADOW is a list of keymaps that shadow this map.
2692 If it is non-nil, then we look up the key in those maps
2693 and we don't mention it now if it is defined by any of them.
2695 ENTIRE_MAP is the keymap in which this vector appears.
2696 If the definition in effect in the whole map does not match
2697 the one in this vector, we ignore this one.
2699 When describing a sub-char-table, INDICES is a list of
2700 indices at higher levels in this char-table,
2701 and CHAR_TABLE_DEPTH says how many levels down we have gone. */
2703 describe_vector (vector
, elt_prefix
, elt_describer
,
2704 partial
, shadow
, entire_map
,
2705 indices
, char_table_depth
)
2706 register Lisp_Object vector
;
2707 Lisp_Object elt_prefix
;
2708 int (*elt_describer
) ();
2711 Lisp_Object entire_map
;
2713 int char_table_depth
;
2715 Lisp_Object definition
;
2718 Lisp_Object suppress
;
2721 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2722 /* Range of elements to be handled. */
2724 /* Flag to tell if we should handle multibyte characters. */
2725 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
2726 /* A flag to tell if a leaf in this level of char-table is not a
2727 generic character (i.e. a complete multibyte character). */
2733 indices
= (Lisp_Object
*) alloca (3 * sizeof (Lisp_Object
));
2737 /* This vector gets used to present single keys to Flookup_key. Since
2738 that is done once per vector element, we don't want to cons up a
2739 fresh vector every time. */
2740 kludge
= Fmake_vector (make_number (1), Qnil
);
2741 GCPRO3 (elt_prefix
, definition
, kludge
);
2744 suppress
= intern ("suppress-keymap");
2746 if (CHAR_TABLE_P (vector
))
2748 if (char_table_depth
== 0)
2750 /* VECTOR is a top level char-table. */
2753 to
= CHAR_TABLE_ORDINARY_SLOTS
;
2757 /* VECTOR is a sub char-table. */
2758 if (char_table_depth
>= 3)
2759 /* A char-table is never that deep. */
2760 error ("Too deep char table");
2763 = (CHARSET_VALID_P (indices
[0])
2764 && ((CHARSET_DIMENSION (indices
[0]) == 1
2765 && char_table_depth
== 1)
2766 || char_table_depth
== 2));
2768 /* Meaningful elements are from 32th to 127th. */
2770 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
2775 /* This does the right thing for ordinary vectors. */
2779 to
= XVECTOR (vector
)->size
;
2782 for (i
= from
; i
< to
; i
++)
2786 if (CHAR_TABLE_P (vector
))
2788 if (char_table_depth
== 0 && i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
)
2791 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
2792 && !CHARSET_DEFINED_P (i
- 128))
2796 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
], 0);
2799 definition
= get_keyelt (XVECTOR (vector
)->contents
[i
], 0);
2801 if (NILP (definition
)) continue;
2803 /* Don't mention suppressed commands. */
2804 if (SYMBOLP (definition
) && partial
)
2808 tem
= Fget (definition
, suppress
);
2810 if (!NILP (tem
)) continue;
2813 /* Set CHARACTER to the character this entry describes, if any.
2814 Also update *INDICES. */
2815 if (CHAR_TABLE_P (vector
))
2817 indices
[char_table_depth
] = i
;
2819 if (char_table_depth
== 0)
2822 indices
[0] = i
- 128;
2824 else if (complete_char
)
2827 = MAKE_NON_ASCII_CHAR (indices
[0], indices
[1], indices
[2]);
2835 /* If this binding is shadowed by some other map, ignore it. */
2836 if (!NILP (shadow
) && complete_char
)
2840 XVECTOR (kludge
)->contents
[0] = make_number (character
);
2841 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2843 if (!NILP (tem
)) continue;
2846 /* Ignore this definition if it is shadowed by an earlier
2847 one in the same keymap. */
2848 if (!NILP (entire_map
) && complete_char
)
2852 XVECTOR (kludge
)->contents
[0] = make_number (character
);
2853 tem
= Flookup_key (entire_map
, kludge
, Qt
);
2855 if (! EQ (tem
, definition
))
2861 if (char_table_depth
== 0)
2866 /* For a sub char-table, show the depth by indentation.
2867 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
2868 if (char_table_depth
> 0)
2869 insert (" ", char_table_depth
* 2); /* depth is 1 or 2. */
2871 /* Output the prefix that applies to every entry in this map. */
2872 if (!NILP (elt_prefix
))
2873 insert1 (elt_prefix
);
2875 /* Insert or describe the character this slot is for,
2876 or a description of what it is for. */
2877 if (SUB_CHAR_TABLE_P (vector
))
2880 insert_char (character
);
2883 /* We need an octal representation for this block of
2886 sprintf (work
, "(row %d)", i
);
2887 insert (work
, strlen (work
));
2890 else if (CHAR_TABLE_P (vector
))
2893 insert1 (Fsingle_key_description (make_number (character
)));
2896 /* Print the information for this character set. */
2897 insert_string ("<");
2898 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
2900 insert_from_string (tem2
, 0 , XSTRING (tem2
)->size
, 0);
2908 insert1 (Fsingle_key_description (make_number (character
)));
2911 /* If we find a sub char-table within a char-table,
2912 scan it recursively; it defines the details for
2913 a character set or a portion of a character set. */
2914 if (multibyte
&& CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
2917 describe_vector (definition
, elt_prefix
, elt_describer
,
2918 partial
, shadow
, entire_map
,
2919 indices
, char_table_depth
+ 1);
2925 /* Find all consecutive characters or rows that have the same
2926 definition. But, for elements of a top level char table, if
2927 they are for charsets, we had better describe one by one even
2928 if they have the same definition. */
2929 if (CHAR_TABLE_P (vector
))
2933 if (char_table_depth
== 0)
2934 limit
= CHAR_TABLE_SINGLE_BYTE_SLOTS
;
2936 while (i
+ 1 < limit
2937 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
2939 && !NILP (Fequal (tem2
, definition
)))
2944 && (tem2
= get_keyelt (XVECTOR (vector
)->contents
[i
+ 1], 0),
2946 && !NILP (Fequal (tem2
, definition
)))
2950 /* If we have a range of more than one character,
2951 print where the range reaches to. */
2953 if (i
!= starting_i
)
2957 if (!NILP (elt_prefix
))
2958 insert1 (elt_prefix
);
2960 if (CHAR_TABLE_P (vector
))
2962 if (char_table_depth
== 0)
2964 insert1 (Fsingle_key_description (make_number (i
)));
2966 else if (complete_char
)
2968 indices
[char_table_depth
] = i
;
2970 = MAKE_NON_ASCII_CHAR (indices
[0], indices
[1], indices
[2]);
2971 insert_char (character
);
2975 /* We need an octal representation for this block of
2978 sprintf (work
, "(row %d)", i
);
2979 insert (work
, strlen (work
));
2984 insert1 (Fsingle_key_description (make_number (i
)));
2988 /* Print a description of the definition of this character.
2989 elt_describer will take care of spacing out far enough
2990 for alignment purposes. */
2991 (*elt_describer
) (definition
);
2994 /* For (sub) char-table, print `defalt' slot at last. */
2995 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
2997 insert (" ", char_table_depth
* 2);
2998 insert_string ("<<default>>");
2999 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
);
3005 /* Apropos - finding all symbols whose names match a regexp. */
3006 Lisp_Object apropos_predicate
;
3007 Lisp_Object apropos_accumulate
;
3010 apropos_accum (symbol
, string
)
3011 Lisp_Object symbol
, string
;
3013 register Lisp_Object tem
;
3015 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
3016 if (!NILP (tem
) && !NILP (apropos_predicate
))
3017 tem
= call1 (apropos_predicate
, symbol
);
3019 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
3022 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
3023 "Show all symbols whose names contain match for REGEXP.\n\
3024 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done\n\
3025 for each symbol and a symbol is mentioned only if that returns non-nil.\n\
3026 Return list of symbols found.")
3028 Lisp_Object regexp
, predicate
;
3030 struct gcpro gcpro1
, gcpro2
;
3031 CHECK_STRING (regexp
, 0);
3032 apropos_predicate
= predicate
;
3033 GCPRO2 (apropos_predicate
, apropos_accumulate
);
3034 apropos_accumulate
= Qnil
;
3035 map_obarray (Vobarray
, apropos_accum
, regexp
);
3036 apropos_accumulate
= Fsort (apropos_accumulate
, Qstring_lessp
);
3038 return apropos_accumulate
;
3045 Qkeymap
= intern ("keymap");
3046 staticpro (&Qkeymap
);
3048 /* Now we are ready to set up this property, so we can
3049 create char tables. */
3050 Fput (Qkeymap
, Qchar_table_extra_slots
, make_number (0));
3052 /* Initialize the keymaps standardly used.
3053 Each one is the value of a Lisp variable, and is also
3054 pointed to by a C variable */
3056 global_map
= Fmake_keymap (Qnil
);
3057 Fset (intern ("global-map"), global_map
);
3059 current_global_map
= global_map
;
3060 staticpro (&global_map
);
3061 staticpro (¤t_global_map
);
3063 meta_map
= Fmake_keymap (Qnil
);
3064 Fset (intern ("esc-map"), meta_map
);
3065 Ffset (intern ("ESC-prefix"), meta_map
);
3067 control_x_map
= Fmake_keymap (Qnil
);
3068 Fset (intern ("ctl-x-map"), control_x_map
);
3069 Ffset (intern ("Control-X-prefix"), control_x_map
);
3071 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
3072 "List of commands given new key bindings recently.\n\
3073 This is used for internal purposes during Emacs startup;\n\
3074 don't alter it yourself.");
3075 Vdefine_key_rebound_commands
= Qt
;
3077 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
3078 "Default keymap to use when reading from the minibuffer.");
3079 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
3081 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
3082 "Local keymap for the minibuffer when spaces are not allowed.");
3083 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
3085 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
3086 "Local keymap for minibuffer input with completion.");
3087 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
3089 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
3090 "Local keymap for minibuffer input with completion, for exact match.");
3091 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
3093 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
3094 "Alist of keymaps to use for minor modes.\n\
3095 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read\n\
3096 key sequences and look up bindings iff VARIABLE's value is non-nil.\n\
3097 If two active keymaps bind the same key, the keymap appearing earlier\n\
3098 in the list takes precedence.");
3099 Vminor_mode_map_alist
= Qnil
;
3101 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
3102 "Keymap mapping ASCII function key sequences onto their preferred forms.\n\
3103 This allows Emacs to recognize function keys sent from ASCII\n\
3104 terminals at any point in a key sequence.\n\
3106 The `read-key-sequence' function replaces any subsequence bound by\n\
3107 `function-key-map' with its binding. More precisely, when the active\n\
3108 keymaps have no binding for the current key sequence but\n\
3109 `function-key-map' binds a suffix of the sequence to a vector or string,\n\
3110 `read-key-sequence' replaces the matching suffix with its binding, and\n\
3111 continues with the new sequence.\n\
3113 The events that come from bindings in `function-key-map' are not\n\
3114 themselves looked up in `function-key-map'.\n\
3116 For example, suppose `function-key-map' binds `ESC O P' to [f1].\n\
3117 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing\n\
3118 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix\n\
3119 key, typing `ESC O P x' would return [f1 x].");
3120 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
3122 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
3123 "Keymap of key translations that can override keymaps.\n\
3124 This keymap works like `function-key-map', but comes after that,\n\
3125 and applies even for keys that have ordinary bindings.");
3126 Vkey_translation_map
= Qnil
;
3128 Qsingle_key_description
= intern ("single-key-description");
3129 staticpro (&Qsingle_key_description
);
3131 Qkey_description
= intern ("key-description");
3132 staticpro (&Qkey_description
);
3134 Qkeymapp
= intern ("keymapp");
3135 staticpro (&Qkeymapp
);
3137 Qnon_ascii
= intern ("non-ascii");
3138 staticpro (&Qnon_ascii
);
3140 defsubr (&Skeymapp
);
3141 defsubr (&Skeymap_parent
);
3142 defsubr (&Sset_keymap_parent
);
3143 defsubr (&Smake_keymap
);
3144 defsubr (&Smake_sparse_keymap
);
3145 defsubr (&Scopy_keymap
);
3146 defsubr (&Skey_binding
);
3147 defsubr (&Slocal_key_binding
);
3148 defsubr (&Sglobal_key_binding
);
3149 defsubr (&Sminor_mode_key_binding
);
3150 defsubr (&Sdefine_key
);
3151 defsubr (&Slookup_key
);
3152 defsubr (&Sdefine_prefix_command
);
3153 defsubr (&Suse_global_map
);
3154 defsubr (&Suse_local_map
);
3155 defsubr (&Scurrent_local_map
);
3156 defsubr (&Scurrent_global_map
);
3157 defsubr (&Scurrent_minor_mode_maps
);
3158 defsubr (&Saccessible_keymaps
);
3159 defsubr (&Skey_description
);
3160 defsubr (&Sdescribe_vector
);
3161 defsubr (&Ssingle_key_description
);
3162 defsubr (&Stext_char_description
);
3163 defsubr (&Swhere_is_internal
);
3164 defsubr (&Sdescribe_bindings
);
3165 defsubr (&Sapropos_internal
);
3172 initial_define_key (global_map
, 033, "ESC-prefix");
3173 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");