1 /* Manipulation of keymaps
2 Copyright (C) 1985, 86, 87, 88, 93, 94 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, 675 Mass Ave, Cambridge, MA 02139, USA. */
28 #include "termhooks.h"
29 #include "blockinput.h"
31 #define min(a, b) ((a) < (b) ? (a) : (b))
33 /* The number of elements in keymap vectors. */
34 #define DENSE_TABLE_SIZE (0200)
36 /* Actually allocate storage for these variables */
38 Lisp_Object current_global_map
; /* Current global keymap */
40 Lisp_Object global_map
; /* default global key bindings */
42 Lisp_Object meta_map
; /* The keymap used for globally bound
43 ESC-prefixed default commands */
45 Lisp_Object control_x_map
; /* The keymap used for globally bound
46 C-x-prefixed default commands */
48 /* was MinibufLocalMap */
49 Lisp_Object Vminibuffer_local_map
;
50 /* The keymap used by the minibuf for local
51 bindings when spaces are allowed in the
54 /* was MinibufLocalNSMap */
55 Lisp_Object Vminibuffer_local_ns_map
;
56 /* The keymap used by the minibuf for local
57 bindings when spaces are not encouraged
60 /* keymap used for minibuffers when doing completion */
61 /* was MinibufLocalCompletionMap */
62 Lisp_Object Vminibuffer_local_completion_map
;
64 /* keymap used for minibuffers when doing completion and require a match */
65 /* was MinibufLocalMustMatchMap */
66 Lisp_Object Vminibuffer_local_must_match_map
;
68 /* Alist of minor mode variables and keymaps. */
69 Lisp_Object Vminor_mode_map_alist
;
71 /* Keymap mapping ASCII function key sequences onto their preferred forms.
72 Initialized by the terminal-specific lisp files. See DEFVAR for more
74 Lisp_Object Vfunction_key_map
;
76 Lisp_Object Qkeymapp
, Qkeymap
, Qnon_ascii
;
78 /* A char with the CHAR_META bit set in a vector or the 0200 bit set
79 in a string key sequence is equivalent to prefixing with this
81 extern Lisp_Object meta_prefix_char
;
83 extern Lisp_Object Voverriding_local_map
;
85 void describe_map_tree ();
86 static Lisp_Object
define_as_prefix ();
87 static Lisp_Object
describe_buffer_bindings ();
88 static void describe_command ();
89 static void describe_map ();
91 /* Keymap object support - constructors and predicates. */
93 DEFUN ("make-keymap", Fmake_keymap
, Smake_keymap
, 0, 1, 0,
94 "Construct and return a new keymap, of the form (keymap VECTOR . ALIST).\n\
95 VECTOR is a vector which holds the bindings for the ASCII\n\
96 characters. ALIST is an assoc-list which holds bindings for function keys,\n\
97 mouse events, and any other things that appear in the input stream.\n\
98 All entries in it are initially nil, meaning \"command undefined\".\n\n\
99 The optional arg STRING supplies a menu name for the keymap\n\
100 in case you use it as a menu with `x-popup-menu'.")
106 tail
= Fcons (string
, Qnil
);
109 return Fcons (Qkeymap
,
110 Fcons (Fmake_vector (make_number (DENSE_TABLE_SIZE
), Qnil
),
114 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
115 "Construct and return a new sparse-keymap list.\n\
116 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),\n\
117 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),\n\
118 which binds the function key or mouse event SYMBOL to DEFINITION.\n\
119 Initially the alist is nil.\n\n\
120 The optional arg STRING supplies a menu name for the keymap\n\
121 in case you use it as a menu with `x-popup-menu'.")
126 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
127 return Fcons (Qkeymap
, Qnil
);
130 /* This function is used for installing the standard key bindings
131 at initialization time.
135 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
138 initial_define_key (keymap
, key
, defname
)
143 store_in_keymap (keymap
, make_number (key
), intern (defname
));
147 initial_define_lispy_key (keymap
, keyname
, defname
)
152 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
155 /* Define character fromchar in map frommap as an alias for character
156 tochar in map tomap. Subsequent redefinitions of the latter WILL
157 affect the former. */
161 synkey (frommap
, fromchar
, tomap
, tochar
)
162 struct Lisp_Vector
*frommap
, *tomap
;
163 int fromchar
, tochar
;
166 XSET (v
, Lisp_Vector
, tomap
);
167 XFASTINT (c
) = tochar
;
168 frommap
->contents
[fromchar
] = Fcons (v
, c
);
172 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
173 "Return t if ARG is a keymap.\n\
175 A keymap is a list (keymap . ALIST),\n\
176 or a symbol whose function definition is itself a keymap.\n\
177 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
178 a vector of densely packed bindings for small character codes\n\
179 is also allowed as an element.")
183 return (NILP (get_keymap_1 (object
, 0, 0)) ? Qnil
: Qt
);
186 /* Check that OBJECT is a keymap (after dereferencing through any
187 symbols). If it is, return it.
189 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
190 is an autoload form, do the autoload and try again.
192 ERROR controls how we respond if OBJECT isn't a keymap.
193 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
195 Note that most of the time, we don't want to pursue autoloads.
196 Functions like Faccessible_keymaps which scan entire keymap trees
197 shouldn't load every autoloaded keymap. I'm not sure about this,
198 but it seems to me that only read_key_sequence, Flookup_key, and
199 Fdefine_key should cause keymaps to be autoloaded. */
202 get_keymap_1 (object
, error
, autoload
)
209 tem
= indirect_function (object
);
210 if (CONSP (tem
) && EQ (XCONS (tem
)->car
, Qkeymap
))
213 /* Should we do an autoload? Autoload forms for keymaps have
214 Qkeymap as their fifth element. */
216 && XTYPE (object
) == Lisp_Symbol
218 && EQ (XCONS (tem
)->car
, Qautoload
))
222 tail
= Fnth (make_number (4), tem
);
223 if (EQ (tail
, Qkeymap
))
225 struct gcpro gcpro1
, gcpro2
;
227 GCPRO2 (tem
, object
);
228 do_autoload (tem
, object
);
236 wrong_type_argument (Qkeymapp
, object
);
242 /* Follow any symbol chaining, and return the keymap denoted by OBJECT.
243 If OBJECT doesn't denote a keymap at all, signal an error. */
248 return get_keymap_1 (object
, 1, 0);
252 /* Look up IDX in MAP. IDX may be any sort of event.
253 Note that this does only one level of lookup; IDX must be a single
254 event, not a sequence.
256 If T_OK is non-zero, bindings for Qt are treated as default
257 bindings; any key left unmentioned by other tables and bindings is
258 given the binding of Qt.
260 If T_OK is zero, bindings for Qt are not treated specially.
262 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
265 access_keymap (map
, idx
, t_ok
, noinherit
)
274 /* If idx is a list (some sort of mouse click, perhaps?),
275 the index we want to use is the car of the list, which
276 ought to be a symbol. */
277 idx
= EVENT_HEAD (idx
);
279 /* If idx is a symbol, it might have modifiers, which need to
280 be put in the canonical order. */
281 if (XTYPE (idx
) == Lisp_Symbol
)
282 idx
= reorder_modifiers (idx
);
283 else if (INTEGERP (idx
))
284 /* Clobber the high bits that can be present on a machine
285 with more than 24 bits of integer. */
286 XFASTINT (idx
) = XINT (idx
) & (CHAR_META
| (CHAR_META
- 1));
290 Lisp_Object t_binding
;
293 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
297 binding
= XCONS (tail
)->car
;
298 switch (XTYPE (binding
))
301 /* If NOINHERIT, stop finding prefix definitions
302 after we pass a second occurrence of the `keymap' symbol. */
303 if (noinherit
&& EQ (binding
, Qkeymap
) && ! EQ (tail
, map
))
308 if (EQ (XCONS (binding
)->car
, idx
))
310 val
= XCONS (binding
)->cdr
;
311 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
315 if (t_ok
&& EQ (XCONS (binding
)->car
, Qt
))
316 t_binding
= XCONS (binding
)->cdr
;
320 if (XTYPE (idx
) == Lisp_Int
322 && XINT (idx
) < XVECTOR (binding
)->size
)
324 val
= XVECTOR (binding
)->contents
[XINT (idx
)];
325 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
339 /* Given OBJECT which was found in a slot in a keymap,
340 trace indirect definitions to get the actual definition of that slot.
341 An indirect definition is a list of the form
342 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
343 and INDEX is the object to look up in KEYMAP to yield the definition.
345 Also if OBJECT has a menu string as the first element,
346 remove that. Also remove a menu help string as second element.
348 If AUTOLOAD is nonzero, load autoloadable keymaps
349 that are referred to with indirection. */
352 get_keyelt (object
, autoload
)
353 register Lisp_Object object
;
358 register Lisp_Object map
, tem
;
360 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
361 map
= get_keymap_1 (Fcar_safe (object
), 0, autoload
);
362 tem
= Fkeymapp (map
);
364 object
= access_keymap (map
, Fcdr (object
), 0, 0);
366 /* If the keymap contents looks like (STRING . DEFN),
368 Keymap alist elements like (CHAR MENUSTRING . DEFN)
369 will be used by HierarKey menus. */
370 else if (XTYPE (object
) == Lisp_Cons
371 && XTYPE (XCONS (object
)->car
) == Lisp_String
)
373 object
= XCONS (object
)->cdr
;
374 /* Also remove a menu help string, if any,
375 following the menu item name. */
376 if (XTYPE (object
) == Lisp_Cons
377 && XTYPE (XCONS (object
)->car
) == Lisp_String
)
378 object
= XCONS (object
)->cdr
;
379 /* Also remove the sublist that caches key equivalences, if any. */
381 && CONSP (XCONS (object
)->car
))
384 carcar
= XCONS (XCONS (object
)->car
)->car
;
385 if (NILP (carcar
) || VECTORP (carcar
))
386 object
= XCONS (object
)->cdr
;
391 /* Anything else is really the value. */
397 store_in_keymap (keymap
, idx
, def
)
399 register Lisp_Object idx
;
400 register Lisp_Object def
;
402 if (XTYPE (keymap
) != Lisp_Cons
403 || ! EQ (XCONS (keymap
)->car
, Qkeymap
))
404 error ("attempt to define a key in a non-keymap");
406 /* If idx is a list (some sort of mouse click, perhaps?),
407 the index we want to use is the car of the list, which
408 ought to be a symbol. */
409 idx
= EVENT_HEAD (idx
);
411 /* If idx is a symbol, it might have modifiers, which need to
412 be put in the canonical order. */
413 if (XTYPE (idx
) == Lisp_Symbol
)
414 idx
= reorder_modifiers (idx
);
415 else if (INTEGERP (idx
))
416 /* Clobber the high bits that can be present on a machine
417 with more than 24 bits of integer. */
418 XFASTINT (idx
) = XINT (idx
) & (CHAR_META
| (CHAR_META
- 1));
420 /* Scan the keymap for a binding of idx. */
424 /* The cons after which we should insert new bindings. If the
425 keymap has a table element, we record its position here, so new
426 bindings will go after it; this way, the table will stay
427 towards the front of the alist and character lookups in dense
428 keymaps will remain fast. Otherwise, this just points at the
429 front of the keymap. */
430 Lisp_Object insertion_point
;
432 insertion_point
= keymap
;
433 for (tail
= XCONS (keymap
)->cdr
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
437 elt
= XCONS (tail
)->car
;
441 if (XTYPE (idx
) == Lisp_Int
442 && XINT (idx
) >= 0 && XINT (idx
) < XVECTOR (elt
)->size
)
444 XVECTOR (elt
)->contents
[XFASTINT (idx
)] = def
;
447 insertion_point
= tail
;
451 if (EQ (idx
, XCONS (elt
)->car
))
453 XCONS (elt
)->cdr
= def
;
459 /* If we find a 'keymap' symbol in the spine of KEYMAP,
460 then we must have found the start of a second keymap
461 being used as the tail of KEYMAP, and a binding for IDX
462 should be inserted before it. */
463 if (EQ (elt
, Qkeymap
))
472 /* We have scanned the entire keymap, and not found a binding for
473 IDX. Let's add one. */
474 XCONS (insertion_point
)->cdr
=
475 Fcons (Fcons (idx
, def
), XCONS (insertion_point
)->cdr
);
482 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
483 "Return a copy of the keymap KEYMAP.\n\
484 The copy starts out with the same definitions of KEYMAP,\n\
485 but changing either the copy or KEYMAP does not affect the other.\n\
486 Any key definitions that are subkeymaps are recursively copied.\n\
487 However, a key definition which is a symbol whose definition is a keymap\n\
492 register Lisp_Object copy
, tail
;
494 copy
= Fcopy_alist (get_keymap (keymap
));
496 for (tail
= copy
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
500 elt
= XCONS (tail
)->car
;
501 if (XTYPE (elt
) == Lisp_Vector
)
505 elt
= Fcopy_sequence (elt
);
506 XCONS (tail
)->car
= elt
;
508 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
509 if (XTYPE (XVECTOR (elt
)->contents
[i
]) != Lisp_Symbol
510 && ! NILP (Fkeymapp (XVECTOR (elt
)->contents
[i
])))
511 XVECTOR (elt
)->contents
[i
] =
512 Fcopy_keymap (XVECTOR (elt
)->contents
[i
]);
514 else if (CONSP (elt
))
516 /* Skip the optional menu string. */
517 if (CONSP (XCONS (elt
)->cdr
)
518 && STRINGP (XCONS (XCONS (elt
)->cdr
)->car
))
522 /* Copy the cell, since copy-alist didn't go this deep. */
523 XCONS (elt
)->cdr
= Fcons (XCONS (XCONS (elt
)->cdr
)->car
,
524 XCONS (XCONS (elt
)->cdr
)->cdr
);
525 elt
= XCONS (elt
)->cdr
;
527 /* Also skip the optional menu help string. */
528 if (CONSP (XCONS (elt
)->cdr
)
529 && STRINGP (XCONS (XCONS (elt
)->cdr
)->car
))
531 XCONS (elt
)->cdr
= Fcons (XCONS (XCONS (elt
)->cdr
)->car
,
532 XCONS (XCONS (elt
)->cdr
)->cdr
);
533 elt
= XCONS (elt
)->cdr
;
535 /* There may also be a list that caches key equivalences.
536 Just delete it for the new keymap. */
537 if (CONSP (XCONS (elt
)->cdr
)
538 && CONSP (XCONS (XCONS (elt
)->cdr
)->car
)
539 && (NILP (tem
= XCONS (XCONS (XCONS (elt
)->cdr
)->car
)->car
)
541 XCONS (elt
)->cdr
= XCONS (XCONS (elt
)->cdr
)->cdr
;
544 && ! SYMBOLP (XCONS (elt
)->cdr
)
545 && ! NILP (Fkeymapp (XCONS (elt
)->cdr
)))
546 XCONS (elt
)->cdr
= Fcopy_keymap (XCONS (elt
)->cdr
);
553 /* Simple Keymap mutators and accessors. */
555 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
556 "Args KEYMAP, KEY, DEF. Define key sequence KEY, in KEYMAP, as DEF.\n\
557 KEYMAP is a keymap. KEY is a string or a vector of symbols and characters\n\
558 meaning a sequence of keystrokes and events.\n\
559 Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
560 can be included if you use a vector.\n\
561 DEF is anything that can be a key's definition:\n\
562 nil (means key is undefined in this keymap),\n\
563 a command (a Lisp function suitable for interactive calling)\n\
564 a string (treated as a keyboard macro),\n\
565 a keymap (to define a prefix key),\n\
566 a symbol. When the key is looked up, the symbol will stand for its\n\
567 function definition, which should at that time be one of the above,\n\
568 or another symbol whose function definition is used, etc.\n\
569 a cons (STRING . DEFN), meaning that DEFN is the definition\n\
570 (DEFN should be a valid definition in its own right),\n\
571 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.\n\
573 If KEYMAP is a sparse keymap, the pair binding KEY to DEF is added at\n\
574 the front of KEYMAP.")
581 register Lisp_Object c
;
582 register Lisp_Object tem
;
583 register Lisp_Object cmd
;
587 struct gcpro gcpro1
, gcpro2
, gcpro3
;
589 keymap
= get_keymap_1 (keymap
, 1, 1);
591 if (XTYPE (key
) != Lisp_Vector
592 && XTYPE (key
) != Lisp_String
)
593 key
= wrong_type_argument (Qarrayp
, key
);
595 length
= XFASTINT (Flength (key
));
599 GCPRO3 (keymap
, key
, def
);
601 if (XTYPE (key
) == Lisp_Vector
)
602 meta_bit
= meta_modifier
;
609 c
= Faref (key
, make_number (idx
));
611 if (XTYPE (c
) == Lisp_Int
612 && (XINT (c
) & meta_bit
)
615 c
= meta_prefix_char
;
620 if (XTYPE (c
) == Lisp_Int
)
621 XSETINT (c
, XINT (c
) & ~meta_bit
);
627 if (! INTEGERP (c
) && ! SYMBOLP (c
) && ! CONSP (c
))
628 error ("Key sequence contains illegal events");
631 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
633 cmd
= get_keyelt (access_keymap (keymap
, c
, 0, 1), 1);
635 /* If this key is undefined, make it a prefix. */
637 cmd
= define_as_prefix (keymap
, c
);
639 keymap
= get_keymap_1 (cmd
, 0, 1);
641 /* We must use Fkey_description rather than just passing key to
642 error; key might be a vector, not a string. */
643 error ("Key sequence %s uses invalid prefix characters",
644 XSTRING (Fkey_description (key
))->data
);
648 /* Value is number if KEY is too long; NIL if valid but has no definition. */
650 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
651 "In keymap KEYMAP, look up key sequence KEY. Return the definition.\n\
652 nil means undefined. See doc of `define-key' for kinds of definitions.\n\
654 A number as value means KEY is \"too long\";\n\
655 that is, characters or symbols in it except for the last one\n\
656 fail to be a valid sequence of prefix characters in KEYMAP.\n\
657 The number is how many characters at the front of KEY\n\
658 it takes to reach a non-prefix command.\n\
660 Normally, `lookup-key' ignores bindings for t, which act as default\n\
661 bindings, used when nothing else in the keymap applies; this makes it\n\
662 useable as a general function for probing keymaps. However, if the\n\
663 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will\n\
664 recognize the default bindings, just as `read-key-sequence' does.")
665 (keymap
, key
, accept_default
)
666 register Lisp_Object keymap
;
668 Lisp_Object accept_default
;
671 register Lisp_Object tem
;
672 register Lisp_Object cmd
;
673 register Lisp_Object c
;
676 int t_ok
= ! NILP (accept_default
);
679 keymap
= get_keymap_1 (keymap
, 1, 1);
681 if (XTYPE (key
) != Lisp_Vector
682 && XTYPE (key
) != Lisp_String
)
683 key
= wrong_type_argument (Qarrayp
, key
);
685 length
= XFASTINT (Flength (key
));
689 if (XTYPE (key
) == Lisp_Vector
)
690 meta_bit
= meta_modifier
;
697 c
= Faref (key
, make_number (idx
));
699 if (XTYPE (c
) == Lisp_Int
700 && (XINT (c
) & meta_bit
)
703 c
= meta_prefix_char
;
708 if (XTYPE (c
) == Lisp_Int
)
709 XSETINT (c
, XINT (c
) & ~meta_bit
);
715 cmd
= get_keyelt (access_keymap (keymap
, c
, t_ok
, 0), 1);
719 keymap
= get_keymap_1 (cmd
, 0, 1);
721 return make_number (idx
);
727 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
728 Assume that currently it does not define C at all.
729 Return the keymap. */
732 define_as_prefix (keymap
, c
)
733 Lisp_Object keymap
, c
;
735 Lisp_Object inherit
, cmd
;
737 cmd
= Fmake_sparse_keymap (Qnil
);
738 /* If this key is defined as a prefix in an inherited keymap,
739 make it a prefix in this map, and make its definition
740 inherit the other prefix definition. */
741 inherit
= access_keymap (keymap
, c
, 0, 0);
744 /* If there's an inherited keymap
745 and it doesn't define this key,
746 make it define this key. */
749 for (tail
= Fcdr (keymap
); CONSP (tail
); tail
= XCONS (tail
)->cdr
)
750 if (EQ (XCONS (tail
)->car
, Qkeymap
))
754 inherit
= define_as_prefix (tail
, c
);
757 cmd
= nconc2 (cmd
, inherit
);
758 store_in_keymap (keymap
, c
, cmd
);
763 /* Append a key to the end of a key sequence. We always make a vector. */
766 append_key (key_sequence
, key
)
767 Lisp_Object key_sequence
, key
;
771 args
[0] = key_sequence
;
773 args
[1] = Fcons (key
, Qnil
);
774 return Fvconcat (2, args
);
778 /* Global, local, and minor mode keymap stuff. */
780 /* We can't put these variables inside current_minor_maps, since under
781 some systems, static gets macro-defined to be the empty string.
783 static Lisp_Object
*cmm_modes
, *cmm_maps
;
786 /* Store a pointer to an array of the keymaps of the currently active
787 minor modes in *buf, and return the number of maps it contains.
789 This function always returns a pointer to the same buffer, and may
790 free or reallocate it, so if you want to keep it for a long time or
791 hand it out to lisp code, copy it. This procedure will be called
792 for every key sequence read, so the nice lispy approach (return a
793 new assoclist, list, what have you) for each invocation would
794 result in a lot of consing over time.
796 If we used xrealloc/xmalloc and ran out of memory, they would throw
797 back to the command loop, which would try to read a key sequence,
798 which would call this function again, resulting in an infinite
799 loop. Instead, we'll use realloc/malloc and silently truncate the
800 list, let the key sequence be read, and hope some other piece of
801 code signals the error. */
803 current_minor_maps (modeptr
, mapptr
)
804 Lisp_Object
**modeptr
, **mapptr
;
807 Lisp_Object alist
, assoc
, var
, val
;
809 for (alist
= Vminor_mode_map_alist
;
811 alist
= XCONS (alist
)->cdr
)
812 if (CONSP (assoc
= XCONS (alist
)->car
)
813 && XTYPE (var
= XCONS (assoc
)->car
) == Lisp_Symbol
814 && ! EQ ((val
= find_symbol_value (var
)), Qunbound
)
819 Lisp_Object
*newmodes
, *newmaps
;
826 = (Lisp_Object
*) realloc (cmm_modes
,
827 cmm_size
* sizeof (Lisp_Object
));
829 = (Lisp_Object
*) realloc (cmm_maps
,
830 cmm_size
* sizeof (Lisp_Object
));
838 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
840 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
844 if (newmaps
&& newmodes
)
846 cmm_modes
= newmodes
;
853 cmm_maps
[i
] = Findirect_function (XCONS (assoc
)->cdr
);
857 if (modeptr
) *modeptr
= cmm_modes
;
858 if (mapptr
) *mapptr
= cmm_maps
;
862 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 2, 0,
863 "Return the binding for command KEY in current keymaps.\n\
864 KEY is a string or vector, a sequence of keystrokes.\n\
865 The binding is probably a symbol with a function definition.\n\
867 Normally, `key-binding' ignores bindings for t, which act as default\n\
868 bindings, used when nothing else in the keymap applies; this makes it\n\
869 usable as a general function for probing keymaps. However, if the\n\
870 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\
871 recognize the default bindings, just as `read-key-sequence' does.")
872 (key
, accept_default
)
873 Lisp_Object key
, accept_default
;
875 Lisp_Object
*maps
, value
;
878 if (!NILP (Voverriding_local_map
))
880 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
881 if (! NILP (value
) && XTYPE (value
) != Lisp_Int
)
886 nmaps
= current_minor_maps (0, &maps
);
887 for (i
= 0; i
< nmaps
; i
++)
888 if (! NILP (maps
[i
]))
890 value
= Flookup_key (maps
[i
], key
, accept_default
);
891 if (! NILP (value
) && XTYPE (value
) != Lisp_Int
)
895 if (! NILP (current_buffer
->keymap
))
897 value
= Flookup_key (current_buffer
->keymap
, key
, accept_default
);
898 if (! NILP (value
) && XTYPE (value
) != Lisp_Int
)
903 value
= Flookup_key (current_global_map
, key
, accept_default
);
904 if (! NILP (value
) && XTYPE (value
) != Lisp_Int
)
910 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
911 "Return the binding for command KEYS in current local keymap only.\n\
912 KEYS is a string, a sequence of keystrokes.\n\
913 The binding is probably a symbol with a function definition.\n\
915 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
916 bindings; see the description of `lookup-key' for more details about this.")
917 (keys
, accept_default
)
918 Lisp_Object keys
, accept_default
;
920 register Lisp_Object map
;
921 map
= current_buffer
->keymap
;
924 return Flookup_key (map
, keys
, accept_default
);
927 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
928 "Return the binding for command KEYS in current global keymap only.\n\
929 KEYS is a string, a sequence of keystrokes.\n\
930 The binding is probably a symbol with a function definition.\n\
931 This function's return values are the same as those of lookup-key\n\
934 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
935 bindings; see the description of `lookup-key' for more details about this.")
936 (keys
, accept_default
)
937 Lisp_Object keys
, accept_default
;
939 return Flookup_key (current_global_map
, keys
, accept_default
);
942 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
943 "Find the visible minor mode bindings of KEY.\n\
944 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the\n\
945 the symbol which names the minor mode binding KEY, and BINDING is\n\
946 KEY's definition in that mode. In particular, if KEY has no\n\
947 minor-mode bindings, return nil. If the first binding is a\n\
948 non-prefix, all subsequent bindings will be omitted, since they would\n\
949 be ignored. Similarly, the list doesn't include non-prefix bindings\n\
950 that come after prefix bindings.\n\
952 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
953 bindings; see the description of `lookup-key' for more details about this.")
954 (key
, accept_default
)
955 Lisp_Object key
, accept_default
;
957 Lisp_Object
*modes
, *maps
;
962 nmaps
= current_minor_maps (&modes
, &maps
);
964 for (i
= j
= 0; i
< nmaps
; i
++)
966 && ! NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
967 && XTYPE (binding
) != Lisp_Int
)
969 if (! NILP (get_keymap (binding
)))
970 maps
[j
++] = Fcons (modes
[i
], binding
);
972 return Fcons (Fcons (modes
[i
], binding
), Qnil
);
975 return Flist (j
, maps
);
978 DEFUN ("global-set-key", Fglobal_set_key
, Sglobal_set_key
, 2, 2,
979 "kSet key globally: \nCSet key %s to command: ",
980 "Give KEY a global binding as COMMAND.\n\
981 COMMAND is a symbol naming an interactively-callable function.\n\
982 KEY is a key sequence (a string or vector of characters or event types).\n\
983 Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
984 can be included if you use a vector.\n\
985 Note that if KEY has a local binding in the current buffer\n\
986 that local binding will continue to shadow any global binding.")
988 Lisp_Object keys
, function
;
990 if (XTYPE (keys
) != Lisp_Vector
991 && XTYPE (keys
) != Lisp_String
)
992 keys
= wrong_type_argument (Qarrayp
, keys
);
994 Fdefine_key (current_global_map
, keys
, function
);
998 DEFUN ("local-set-key", Flocal_set_key
, Slocal_set_key
, 2, 2,
999 "kSet key locally: \nCSet key %s locally to command: ",
1000 "Give KEY a local binding as COMMAND.\n\
1001 COMMAND is a symbol naming an interactively-callable function.\n\
1002 KEY is a key sequence (a string or vector of characters or event types).\n\
1003 Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
1004 can be included if you use a vector.\n\
1005 The binding goes in the current buffer's local map,\n\
1006 which in most cases is shared with all other buffers in the same major mode.")
1008 Lisp_Object keys
, function
;
1010 register Lisp_Object map
;
1011 map
= current_buffer
->keymap
;
1014 map
= Fmake_sparse_keymap (Qnil
);
1015 current_buffer
->keymap
= map
;
1018 if (XTYPE (keys
) != Lisp_Vector
1019 && XTYPE (keys
) != Lisp_String
)
1020 keys
= wrong_type_argument (Qarrayp
, keys
);
1022 Fdefine_key (map
, keys
, function
);
1026 DEFUN ("global-unset-key", Fglobal_unset_key
, Sglobal_unset_key
,
1027 1, 1, "kUnset key globally: ",
1028 "Remove global binding of KEY.\n\
1029 KEY is a string representing a sequence of keystrokes.")
1033 return Fglobal_set_key (keys
, Qnil
);
1036 DEFUN ("local-unset-key", Flocal_unset_key
, Slocal_unset_key
, 1, 1,
1037 "kUnset key locally: ",
1038 "Remove local binding of KEY.\n\
1039 KEY is a string representing a sequence of keystrokes.")
1043 if (!NILP (current_buffer
->keymap
))
1044 Flocal_set_key (keys
, Qnil
);
1048 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 2, 0,
1049 "Define COMMAND as a prefix command. COMMAND should be a symbol.\n\
1050 A new sparse keymap is stored as COMMAND's function definition and its value.\n\
1051 If a second optional argument MAPVAR is given, the map is stored as\n\
1052 its value instead of as COMMAND's value; but COMMAND is still defined\n\
1055 Lisp_Object name
, mapvar
;
1058 map
= Fmake_sparse_keymap (Qnil
);
1067 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1068 "Select KEYMAP as the global keymap.")
1072 keymap
= get_keymap (keymap
);
1073 current_global_map
= keymap
;
1077 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1078 "Select KEYMAP as the local keymap.\n\
1079 If KEYMAP is nil, that means no local keymap.")
1084 keymap
= get_keymap (keymap
);
1086 current_buffer
->keymap
= keymap
;
1091 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1092 "Return current buffer's local keymap, or nil if it has none.")
1095 return current_buffer
->keymap
;
1098 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1099 "Return the current global keymap.")
1102 return current_global_map
;
1105 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1106 "Return a list of keymaps for the minor modes of the current buffer.")
1110 int nmaps
= current_minor_maps (0, &maps
);
1112 return Flist (nmaps
, maps
);
1115 /* Help functions for describing and documenting keymaps. */
1117 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1119 "Find all keymaps accessible via prefix characters from KEYMAP.\n\
1120 Returns a list of elements of the form (KEYS . MAP), where the sequence\n\
1121 KEYS starting from KEYMAP gets you to MAP. These elements are ordered\n\
1122 so that the KEYS increase in length. The first element is (\"\" . KEYMAP).\n\
1123 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
1124 then the value includes only maps for prefixes that start with PREFIX.")
1126 Lisp_Object startmap
, prefix
;
1128 Lisp_Object maps
, good_maps
, tail
;
1132 prefixlen
= XINT (Flength (prefix
));
1134 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1135 get_keymap (startmap
)),
1138 /* For each map in the list maps,
1139 look at any other maps it points to,
1140 and stick them at the end if they are not already in the list.
1142 This is a breadth-first traversal, where tail is the queue of
1143 nodes, and maps accumulates a list of all nodes visited. */
1145 for (tail
= maps
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1147 register Lisp_Object thisseq
, thismap
;
1149 /* Does the current sequence end in the meta-prefix-char? */
1152 thisseq
= Fcar (Fcar (tail
));
1153 thismap
= Fcdr (Fcar (tail
));
1154 last
= make_number (XINT (Flength (thisseq
)) - 1);
1155 is_metized
= (XINT (last
) >= 0
1156 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1158 for (; CONSP (thismap
); thismap
= XCONS (thismap
)->cdr
)
1162 elt
= XCONS (thismap
)->car
;
1166 if (XTYPE (elt
) == Lisp_Vector
)
1170 /* Vector keymap. Scan all the elements. */
1171 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
1173 register Lisp_Object tem
;
1174 register Lisp_Object cmd
;
1176 cmd
= get_keyelt (XVECTOR (elt
)->contents
[i
], 0);
1177 if (NILP (cmd
)) continue;
1178 tem
= Fkeymapp (cmd
);
1181 cmd
= get_keymap (cmd
);
1182 /* Ignore keymaps that are already added to maps. */
1183 tem
= Frassq (cmd
, maps
);
1186 /* If the last key in thisseq is meta-prefix-char,
1187 turn it into a meta-ized keystroke. We know
1188 that the event we're about to append is an
1189 ascii keystroke since we're processing a
1193 int meta_bit
= meta_modifier
;
1194 tem
= Fcopy_sequence (thisseq
);
1196 Faset (tem
, last
, make_number (i
| meta_bit
));
1198 /* This new sequence is the same length as
1199 thisseq, so stick it in the list right
1202 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1206 tem
= append_key (thisseq
, make_number (i
));
1207 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1213 else if (CONSP (elt
))
1215 register Lisp_Object cmd
, tem
, filter
;
1217 cmd
= get_keyelt (XCONS (elt
)->cdr
, 0);
1218 /* Ignore definitions that aren't keymaps themselves. */
1219 tem
= Fkeymapp (cmd
);
1222 /* Ignore keymaps that have been seen already. */
1223 cmd
= get_keymap (cmd
);
1224 tem
= Frassq (cmd
, maps
);
1227 /* Let elt be the event defined by this map entry. */
1228 elt
= XCONS (elt
)->car
;
1230 /* If the last key in thisseq is meta-prefix-char, and
1231 this entry is a binding for an ascii keystroke,
1232 turn it into a meta-ized keystroke. */
1233 if (is_metized
&& XTYPE (elt
) == Lisp_Int
)
1235 tem
= Fcopy_sequence (thisseq
);
1237 make_number (XINT (elt
) | meta_modifier
));
1239 /* This new sequence is the same length as
1240 thisseq, so stick it in the list right
1243 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1247 Fcons (Fcons (append_key (thisseq
, elt
), cmd
),
1258 /* Now find just the maps whose access prefixes start with PREFIX. */
1261 for (; CONSP (maps
); maps
= XCONS (maps
)->cdr
)
1263 Lisp_Object elt
, thisseq
;
1264 elt
= XCONS (maps
)->car
;
1265 thisseq
= XCONS (elt
)->car
;
1266 /* The access prefix must be at least as long as PREFIX,
1267 and the first elements must match those of PREFIX. */
1268 if (XINT (Flength (thisseq
)) >= prefixlen
)
1271 for (i
= 0; i
< prefixlen
; i
++)
1275 if (!EQ (Faref (thisseq
, i1
), Faref (prefix
, i1
)))
1279 good_maps
= Fcons (elt
, good_maps
);
1283 return Fnreverse (good_maps
);
1286 Lisp_Object Qsingle_key_description
, Qkey_description
;
1288 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 1, 0,
1289 "Return a pretty description of key-sequence KEYS.\n\
1290 Control characters turn into \"C-foo\" sequences, meta into \"M-foo\"\n\
1291 spaces are put between sequence elements, etc.")
1295 if (XTYPE (keys
) == Lisp_String
)
1299 vector
= Fmake_vector (Flength (keys
), Qnil
);
1300 for (i
= 0; i
< XSTRING (keys
)->size
; i
++)
1302 if (XSTRING (keys
)->data
[i
] & 0x80)
1303 XFASTINT (XVECTOR (vector
)->contents
[i
])
1304 = meta_modifier
| (XSTRING (keys
)->data
[i
] & ~0x80);
1306 XFASTINT (XVECTOR (vector
)->contents
[i
])
1307 = XSTRING (keys
)->data
[i
];
1311 return Fmapconcat (Qsingle_key_description
, keys
, build_string (" "));
1315 push_key_description (c
, p
)
1316 register unsigned int c
;
1319 /* Clear all the meaningless bits above the meta bit. */
1320 c
&= meta_modifier
| ~ - meta_modifier
;
1322 if (c
& alt_modifier
)
1328 if (c
& ctrl_modifier
)
1334 if (c
& hyper_modifier
)
1338 c
-= hyper_modifier
;
1340 if (c
& meta_modifier
)
1346 if (c
& shift_modifier
)
1350 c
-= shift_modifier
;
1352 if (c
& super_modifier
)
1356 c
-= super_modifier
;
1372 else if (c
== Ctl('J'))
1378 else if (c
== Ctl('M'))
1388 if (c
> 0 && c
<= Ctl ('Z'))
1411 *p
++ = (7 & (c
>> 15)) + '0';
1412 *p
++ = (7 & (c
>> 12)) + '0';
1413 *p
++ = (7 & (c
>> 9)) + '0';
1414 *p
++ = (7 & (c
>> 6)) + '0';
1415 *p
++ = (7 & (c
>> 3)) + '0';
1416 *p
++ = (7 & (c
>> 0)) + '0';
1422 DEFUN ("single-key-description", Fsingle_key_description
, Ssingle_key_description
, 1, 1, 0,
1423 "Return a pretty description of command character KEY.\n\
1424 Control characters turn into C-whatever, etc.")
1430 key
= EVENT_HEAD (key
);
1432 switch (XTYPE (key
))
1434 case Lisp_Int
: /* Normal character */
1435 *push_key_description (XUINT (key
), tem
) = 0;
1436 return build_string (tem
);
1438 case Lisp_Symbol
: /* Function key or event-symbol */
1439 return Fsymbol_name (key
);
1442 error ("KEY must be an integer, cons, or symbol.");
1447 push_text_char_description (c
, p
)
1448 register unsigned int c
;
1460 *p
++ = c
+ 64; /* 'A' - 1 */
1472 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
1473 "Return a pretty description of file-character CHAR.\n\
1474 Control characters turn into \"^char\", etc.")
1480 CHECK_NUMBER (chr
, 0);
1482 *push_text_char_description (XINT (chr
) & 0377, tem
) = 0;
1484 return build_string (tem
);
1487 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
1490 ascii_sequence_p (seq
)
1494 int len
= XINT (Flength (seq
));
1496 for (XFASTINT (i
) = 0; XFASTINT (i
) < len
; XFASTINT (i
)++)
1500 elt
= Faref (seq
, i
);
1502 if (XTYPE (elt
) != Lisp_Int
1503 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
1511 /* where-is - finding a command in a set of keymaps. */
1513 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 4, 0,
1514 "Return list of keys that invoke DEFINITION.\n\
1515 If KEYMAP is non-nil, search only KEYMAP and the global keymap.\n\
1516 If KEYMAP is nil, search all the currently active keymaps.\n\
1518 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,\n\
1519 rather than a list of all possible key sequences.\n\
1520 If FIRSTONLY is t, avoid key sequences which use non-ASCII\n\
1521 keys and therefore may not be usable on ASCII terminals. If FIRSTONLY\n\
1522 is the symbol `non-ascii', return the first binding found, no matter\n\
1523 what its components.\n\
1525 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections\n\
1526 to other keymaps or slots. This makes it possible to search for an\n\
1527 indirect definition itself.")
1528 (definition
, keymap
, firstonly
, noindirect
)
1529 Lisp_Object definition
, keymap
;
1530 Lisp_Object firstonly
, noindirect
;
1532 register Lisp_Object maps
;
1534 int keymap_specified
= !NILP (keymap
);
1536 if (! keymap_specified
)
1538 #ifdef USE_TEXT_PROPERTIES
1539 keymap
= get_local_map (PT
, current_buffer
);
1541 keymap
= current_buffer
->keymap
;
1546 maps
= nconc2 (Faccessible_keymaps (get_keymap (keymap
), Qnil
),
1547 Faccessible_keymaps (get_keymap (current_global_map
),
1550 maps
= Faccessible_keymaps (get_keymap (current_global_map
), Qnil
);
1552 /* Put the minor mode keymaps on the front. */
1553 if (! keymap_specified
)
1556 minors
= Fnreverse (Fcurrent_minor_mode_maps ());
1557 while (!NILP (minors
))
1559 maps
= nconc2 (Faccessible_keymaps (get_keymap (XCONS (minors
)->car
),
1562 minors
= XCONS (minors
)->cdr
;
1568 for (; !NILP (maps
); maps
= Fcdr (maps
))
1570 /* Key sequence to reach map, and the map that it reaches */
1571 register Lisp_Object
this, map
;
1573 /* If Fcar (map) is a VECTOR, the current element within that vector. */
1576 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
1577 [M-CHAR] sequences, check if last character of the sequence
1578 is the meta-prefix char. */
1582 this = Fcar (Fcar (maps
));
1583 map
= Fcdr (Fcar (maps
));
1584 last
= make_number (XINT (Flength (this)) - 1);
1585 last_is_meta
= (XINT (last
) >= 0
1586 && EQ (Faref (this, last
), meta_prefix_char
));
1592 /* Because the code we want to run on each binding is rather
1593 large, we don't want to have two separate loop bodies for
1594 sparse keymap bindings and tables; we want to iterate one
1595 loop body over both keymap and vector bindings.
1597 For this reason, if Fcar (map) is a vector, we don't
1598 advance map to the next element until i indicates that we
1599 have finished off the vector. */
1601 Lisp_Object elt
, key
, binding
, sequence
;
1602 elt
= XCONS (map
)->car
;
1606 /* Set key and binding to the current key and binding, and
1607 advance map and i to the next binding. */
1608 if (XTYPE (elt
) == Lisp_Vector
)
1610 /* In a vector, look at each element. */
1611 binding
= XVECTOR (elt
)->contents
[i
];
1615 /* If we've just finished scanning a vector, advance map
1616 to the next element, and reset i in anticipation of the
1617 next vector we may find. */
1618 if (i
>= XVECTOR (elt
)->size
)
1620 map
= XCONS (map
)->cdr
;
1624 else if (CONSP (elt
))
1626 key
= Fcar (Fcar (map
));
1627 binding
= Fcdr (Fcar (map
));
1629 map
= XCONS (map
)->cdr
;
1632 /* We want to ignore keymap elements that are neither
1633 vectors nor conses. */
1635 map
= XCONS (map
)->cdr
;
1639 /* Search through indirections unless that's not wanted. */
1640 if (NILP (noindirect
))
1641 binding
= get_keyelt (binding
, 0);
1643 /* End this iteration if this element does not match
1646 if (XTYPE (definition
) == Lisp_Cons
)
1649 tem
= Fequal (binding
, definition
);
1654 if (!EQ (binding
, definition
))
1657 /* We have found a match.
1658 Construct the key sequence where we found it. */
1659 if (XTYPE (key
) == Lisp_Int
&& last_is_meta
)
1661 sequence
= Fcopy_sequence (this);
1662 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
1665 sequence
= append_key (this, key
);
1667 /* Verify that this key binding is not shadowed by another
1668 binding for the same key, before we say it exists.
1670 Mechanism: look for local definition of this key and if
1671 it is defined and does not match what we found then
1674 Either nil or number as value from Flookup_key
1676 if (keymap_specified
)
1678 binding
= Flookup_key (keymap
, sequence
, Qnil
);
1679 if (!NILP (binding
) && XTYPE (binding
) != Lisp_Int
)
1681 if (XTYPE (definition
) == Lisp_Cons
)
1684 tem
= Fequal (binding
, definition
);
1689 if (!EQ (binding
, definition
))
1695 binding
= Fkey_binding (sequence
, Qnil
);
1696 if (!EQ (binding
, definition
))
1700 /* It is a true unshadowed match. Record it, unless it's already
1701 been seen (as could happen when inheriting keymaps). */
1702 if (NILP (Fmember (sequence
, found
)))
1703 found
= Fcons (sequence
, found
);
1705 /* If firstonly is Qnon_ascii, then we can return the first
1706 binding we find. If firstonly is not Qnon_ascii but not
1707 nil, then we should return the first ascii-only binding
1709 if (EQ (firstonly
, Qnon_ascii
))
1711 else if (! NILP (firstonly
) && ascii_sequence_p (sequence
))
1716 found
= Fnreverse (found
);
1718 /* firstonly may have been t, but we may have gone all the way through
1719 the keymaps without finding an all-ASCII key sequence. So just
1720 return the best we could find. */
1721 if (! NILP (firstonly
))
1722 return Fcar (found
);
1727 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
1729 DEFUN ("describe-bindings", Fdescribe_bindings
, Sdescribe_bindings
, 0, 1, "",
1730 "Show a list of all defined keys, and their definitions.\n\
1731 The list is put in a buffer, which is displayed.\n\
1732 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
1733 then we display only bindings that start with that prefix.")
1737 register Lisp_Object thisbuf
;
1738 XSET (thisbuf
, Lisp_Buffer
, current_buffer
);
1739 internal_with_output_to_temp_buffer ("*Help*",
1740 describe_buffer_bindings
,
1741 Fcons (thisbuf
, prefix
));
1745 /* ARG is (BUFFER . PREFIX). */
1748 describe_buffer_bindings (arg
)
1751 Lisp_Object descbuf
, prefix
, shadow
;
1752 register Lisp_Object start1
;
1753 struct gcpro gcpro1
;
1755 char *alternate_heading
1757 Alternate Characters (use anywhere the nominal character is listed):\n\
1758 nominal alternate\n\
1759 ------- ---------\n";
1761 descbuf
= XCONS (arg
)->car
;
1762 prefix
= XCONS (arg
)->cdr
;
1766 Fset_buffer (Vstandard_output
);
1768 /* Report on alternates for keys. */
1769 if (XTYPE (Vkeyboard_translate_table
) == Lisp_String
)
1772 unsigned char *translate
= XSTRING (Vkeyboard_translate_table
)->data
;
1773 int translate_len
= XSTRING (Vkeyboard_translate_table
)->size
;
1775 for (c
= 0; c
< translate_len
; c
++)
1776 if (translate
[c
] != c
)
1781 if (alternate_heading
)
1783 insert_string (alternate_heading
);
1784 alternate_heading
= 0;
1787 bufend
= push_key_description (translate
[c
], buf
);
1788 insert (buf
, bufend
- buf
);
1789 Findent_to (make_number (16), make_number (1));
1790 bufend
= push_key_description (c
, buf
);
1791 insert (buf
, bufend
- buf
);
1801 Lisp_Object
*modes
, *maps
;
1803 /* Temporarily switch to descbuf, so that we can get that buffer's
1804 minor modes correctly. */
1805 Fset_buffer (descbuf
);
1806 if (!NILP (Voverriding_local_map
))
1809 nmaps
= current_minor_maps (&modes
, &maps
);
1810 Fset_buffer (Vstandard_output
);
1812 /* Print the minor mode maps. */
1813 for (i
= 0; i
< nmaps
; i
++)
1815 /* The title for a minor mode keymap
1816 is constructed at run time.
1817 We let describe_map_tree do the actual insertion
1818 because it takes care of other features when doing so. */
1821 if (XTYPE (modes
[i
]) != Lisp_Symbol
)
1824 p
= title
= (char *) alloca (40 + XSYMBOL (modes
[i
])->name
->size
);
1826 bcopy (XSYMBOL (modes
[i
])->name
->data
, p
,
1827 XSYMBOL (modes
[i
])->name
->size
);
1828 p
+= XSYMBOL (modes
[i
])->name
->size
;
1830 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
1831 p
+= sizeof (" Minor Mode Bindings") - 1;
1834 describe_map_tree (maps
[i
], 0, shadow
, prefix
, title
, 0);
1835 shadow
= Fcons (maps
[i
], shadow
);
1839 /* Print the (major mode) local map. */
1840 if (!NILP (Voverriding_local_map
))
1841 start1
= Voverriding_local_map
;
1843 start1
= XBUFFER (descbuf
)->keymap
;
1847 describe_map_tree (start1
, 0, shadow
, prefix
,
1848 "Major Mode Bindings", 0);
1849 shadow
= Fcons (start1
, shadow
);
1852 describe_map_tree (current_global_map
, 0, shadow
, prefix
,
1853 "Global Bindings", 0);
1855 Fset_buffer (descbuf
);
1860 /* Insert a desription of the key bindings in STARTMAP,
1861 followed by those of all maps reachable through STARTMAP.
1862 If PARTIAL is nonzero, omit certain "uninteresting" commands
1863 (such as `undefined').
1864 If SHADOW is non-nil, it is a list of maps;
1865 don't mention keys which would be shadowed by any of them.
1866 PREFIX, if non-nil, says mention only keys that start with PREFIX.
1867 TITLE, if not 0, is a string to insert at the beginning.
1868 TITLE should not end with a colon or a newline; we supply that.
1869 If NOMENU is not 0, then omit menu-bar commands. */
1872 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
)
1873 Lisp_Object startmap
, shadow
, prefix
;
1878 Lisp_Object maps
, seen
, sub_shadows
;
1879 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1886 maps
= Faccessible_keymaps (startmap
, prefix
);
1889 GCPRO3 (maps
, seen
, sub_shadows
);
1895 /* Delete from MAPS each element that is for the menu bar. */
1896 for (list
= maps
; !NILP (list
); list
= XCONS (list
)->cdr
)
1898 Lisp_Object elt
, prefix
, tem
;
1901 prefix
= Fcar (elt
);
1902 if (XVECTOR (prefix
)->size
>= 1)
1904 tem
= Faref (prefix
, make_number (0));
1905 if (EQ (tem
, Qmenu_bar
))
1906 maps
= Fdelq (elt
, maps
);
1915 insert_string (title
);
1918 insert_string (" Starting With ");
1919 insert1 (Fkey_description (prefix
));
1921 insert_string (":\n");
1923 insert_string (key_heading
);
1927 for (; !NILP (maps
); maps
= Fcdr (maps
))
1929 register Lisp_Object elt
, prefix
, tail
;
1932 prefix
= Fcar (elt
);
1936 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1940 shmap
= XCONS (tail
)->car
;
1942 /* If the sequence by which we reach this keymap is zero-length,
1943 then the shadow map for this keymap is just SHADOW. */
1944 if ((XTYPE (prefix
) == Lisp_String
1945 && XSTRING (prefix
)->size
== 0)
1946 || (XTYPE (prefix
) == Lisp_Vector
1947 && XVECTOR (prefix
)->size
== 0))
1949 /* If the sequence by which we reach this keymap actually has
1950 some elements, then the sequence's definition in SHADOW is
1951 what we should use. */
1954 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
1955 if (XTYPE (shmap
) == Lisp_Int
)
1959 /* If shmap is not nil and not a keymap,
1960 it completely shadows this map, so don't
1961 describe this map at all. */
1962 if (!NILP (shmap
) && NILP (Fkeymapp (shmap
)))
1966 sub_shadows
= Fcons (shmap
, sub_shadows
);
1969 describe_map (Fcdr (elt
), Fcar (elt
), describe_command
,
1970 partial
, sub_shadows
, &seen
);
1976 insert_string ("\n");
1982 describe_command (definition
)
1983 Lisp_Object definition
;
1985 register Lisp_Object tem1
;
1987 Findent_to (make_number (16), make_number (1));
1989 if (XTYPE (definition
) == Lisp_Symbol
)
1991 XSET (tem1
, Lisp_String
, XSYMBOL (definition
)->name
);
1993 insert_string ("\n");
1995 else if (STRINGP (definition
))
1996 insert_string ("Keyboard Macro\n");
1999 tem1
= Fkeymapp (definition
);
2001 insert_string ("Prefix Command\n");
2003 insert_string ("??\n");
2007 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2008 Returns the first non-nil binding found in any of those maps. */
2011 shadow_lookup (shadow
, key
, flag
)
2012 Lisp_Object shadow
, key
, flag
;
2014 Lisp_Object tail
, value
;
2016 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2018 value
= Flookup_key (XCONS (tail
)->car
, key
, flag
);
2025 /* Describe the contents of map MAP, assuming that this map itself is
2026 reached by the sequence of prefix keys KEYS (a string or vector).
2027 PARTIAL, SHADOW are as in `describe_map_tree' above. */
2030 describe_map (map
, keys
, elt_describer
, partial
, shadow
, seen
)
2031 register Lisp_Object map
;
2033 int (*elt_describer
) ();
2038 Lisp_Object elt_prefix
;
2039 Lisp_Object tail
, definition
, event
;
2041 Lisp_Object suppress
;
2044 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2046 if (!NILP (keys
) && XFASTINT (Flength (keys
)) > 0)
2048 /* Call Fkey_description first, to avoid GC bug for the other string. */
2049 tem
= Fkey_description (keys
);
2050 elt_prefix
= concat2 (tem
, build_string (" "));
2056 suppress
= intern ("suppress-keymap");
2058 /* This vector gets used to present single keys to Flookup_key. Since
2059 that is done once per keymap element, we don't want to cons up a
2060 fresh vector every time. */
2061 kludge
= Fmake_vector (make_number (1), Qnil
);
2064 GCPRO3 (elt_prefix
, definition
, kludge
);
2066 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2070 if (XTYPE (XCONS (tail
)->car
) == Lisp_Vector
)
2071 describe_vector (XCONS (tail
)->car
,
2072 elt_prefix
, elt_describer
, partial
, shadow
);
2073 else if (CONSP (XCONS (tail
)->car
))
2075 event
= XCONS (XCONS (tail
)->car
)->car
;
2077 /* Ignore bindings whose "keys" are not really valid events.
2078 (We get these in the frames and buffers menu.) */
2079 if (! (SYMBOLP (event
) || INTEGERP (event
)))
2082 definition
= get_keyelt (XCONS (XCONS (tail
)->car
)->cdr
, 0);
2084 /* Don't show undefined commands or suppressed commands. */
2085 if (NILP (definition
)) continue;
2086 if (XTYPE (definition
) == Lisp_Symbol
&& partial
)
2088 tem
= Fget (definition
, suppress
);
2093 /* Don't show a command that isn't really visible
2094 because a local definition of the same key shadows it. */
2096 XVECTOR (kludge
)->contents
[0] = event
;
2099 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2100 if (!NILP (tem
)) continue;
2103 tem
= Flookup_key (map
, kludge
, Qt
);
2104 if (! EQ (tem
, definition
)) continue;
2112 if (!NILP (elt_prefix
))
2113 insert1 (elt_prefix
);
2115 /* THIS gets the string to describe the character EVENT. */
2116 insert1 (Fsingle_key_description (event
));
2118 /* Print a description of the definition of this character.
2119 elt_describer will take care of spacing out far enough
2120 for alignment purposes. */
2121 (*elt_describer
) (definition
);
2123 else if (EQ (XCONS (tail
)->car
, Qkeymap
))
2125 /* The same keymap might be in the structure twice, if we're
2126 using an inherited keymap. So skip anything we've already
2128 tem
= Fassq (tail
, *seen
);
2129 if (CONSP (tem
) && !NILP (Fequal (XCONS (tem
)->car
, keys
)))
2131 *seen
= Fcons (Fcons (tail
, keys
), *seen
);
2139 describe_vector_princ (elt
)
2142 Findent_to (make_number (16), make_number (1));
2147 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 1, 0,
2148 "Insert a description of contents of VECTOR.\n\
2149 This is text showing the elements of vector matched against indices.")
2153 int count
= specpdl_ptr
- specpdl
;
2155 specbind (Qstandard_output
, Fcurrent_buffer ());
2156 CHECK_VECTOR (vector
, 0);
2157 describe_vector (vector
, Qnil
, describe_vector_princ
, 0, Qnil
);
2159 return unbind_to (count
, Qnil
);
2162 describe_vector (vector
, elt_prefix
, elt_describer
, partial
, shadow
)
2163 register Lisp_Object vector
;
2164 Lisp_Object elt_prefix
;
2165 int (*elt_describer
) ();
2171 Lisp_Object tem1
, tem2
;
2173 Lisp_Object suppress
;
2176 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2180 /* This vector gets used to present single keys to Flookup_key. Since
2181 that is done once per vector element, we don't want to cons up a
2182 fresh vector every time. */
2183 kludge
= Fmake_vector (make_number (1), Qnil
);
2184 GCPRO3 (elt_prefix
, tem1
, kludge
);
2187 suppress
= intern ("suppress-keymap");
2189 for (i
= 0; i
< XVECTOR (vector
)->size
; i
++)
2192 tem1
= get_keyelt (XVECTOR (vector
)->contents
[i
], 0);
2194 if (NILP (tem1
)) continue;
2196 /* Don't mention suppressed commands. */
2197 if (XTYPE (tem1
) == Lisp_Symbol
&& partial
)
2199 this = Fget (tem1
, suppress
);
2204 /* If this command in this map is shadowed by some other map,
2210 XVECTOR (kludge
)->contents
[0] = make_number (i
);
2211 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2213 if (!NILP (tem
)) continue;
2222 /* Output the prefix that applies to every entry in this map. */
2223 if (!NILP (elt_prefix
))
2224 insert1 (elt_prefix
);
2226 /* Get the string to describe the character I, and print it. */
2227 XFASTINT (dummy
) = i
;
2229 /* THIS gets the string to describe the character DUMMY. */
2230 this = Fsingle_key_description (dummy
);
2233 /* Find all consecutive characters that have the same definition. */
2234 while (i
+ 1 < XVECTOR (vector
)->size
2235 && (tem2
= get_keyelt (XVECTOR (vector
)->contents
[i
+1], 0),
2239 /* If we have a range of more than one character,
2240 print where the range reaches to. */
2242 if (i
!= XINT (dummy
))
2245 if (!NILP (elt_prefix
))
2246 insert1 (elt_prefix
);
2248 XFASTINT (dummy
) = i
;
2249 insert1 (Fsingle_key_description (dummy
));
2252 /* Print a description of the definition of this character.
2253 elt_describer will take care of spacing out far enough
2254 for alignment purposes. */
2255 (*elt_describer
) (tem1
);
2261 /* Apropos - finding all symbols whose names match a regexp. */
2262 Lisp_Object apropos_predicate
;
2263 Lisp_Object apropos_accumulate
;
2266 apropos_accum (symbol
, string
)
2267 Lisp_Object symbol
, string
;
2269 register Lisp_Object tem
;
2271 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
2272 if (!NILP (tem
) && !NILP (apropos_predicate
))
2273 tem
= call1 (apropos_predicate
, symbol
);
2275 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
2278 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
2279 "Show all symbols whose names contain match for REGEXP.\n\
2280 If optional 2nd arg PRED is non-nil, (funcall PRED SYM) is done\n\
2281 for each symbol and a symbol is mentioned only if that returns non-nil.\n\
2282 Return list of symbols found.")
2284 Lisp_Object string
, pred
;
2286 struct gcpro gcpro1
, gcpro2
;
2287 CHECK_STRING (string
, 0);
2288 apropos_predicate
= pred
;
2289 GCPRO2 (apropos_predicate
, apropos_accumulate
);
2290 apropos_accumulate
= Qnil
;
2291 map_obarray (Vobarray
, apropos_accum
, string
);
2292 apropos_accumulate
= Fsort (apropos_accumulate
, Qstring_lessp
);
2294 return apropos_accumulate
;
2301 Qkeymap
= intern ("keymap");
2302 staticpro (&Qkeymap
);
2304 /* Initialize the keymaps standardly used.
2305 Each one is the value of a Lisp variable, and is also
2306 pointed to by a C variable */
2308 global_map
= Fcons (Qkeymap
,
2309 Fcons (Fmake_vector (make_number (0400), Qnil
), Qnil
));
2310 Fset (intern ("global-map"), global_map
);
2312 meta_map
= Fmake_keymap (Qnil
);
2313 Fset (intern ("esc-map"), meta_map
);
2314 Ffset (intern ("ESC-prefix"), meta_map
);
2316 control_x_map
= Fmake_keymap (Qnil
);
2317 Fset (intern ("ctl-x-map"), control_x_map
);
2318 Ffset (intern ("Control-X-prefix"), control_x_map
);
2320 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
2321 "Default keymap to use when reading from the minibuffer.");
2322 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
2324 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
2325 "Local keymap for the minibuffer when spaces are not allowed.");
2326 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
2328 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
2329 "Local keymap for minibuffer input with completion.");
2330 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
2332 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
2333 "Local keymap for minibuffer input with completion, for exact match.");
2334 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
2336 current_global_map
= global_map
;
2338 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
2339 "Alist of keymaps to use for minor modes.\n\
2340 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read\n\
2341 key sequences and look up bindings iff VARIABLE's value is non-nil.\n\
2342 If two active keymaps bind the same key, the keymap appearing earlier\n\
2343 in the list takes precedence.");
2344 Vminor_mode_map_alist
= Qnil
;
2346 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
2347 "Keymap mapping ASCII function key sequences onto their preferred forms.\n\
2348 This allows Emacs to recognize function keys sent from ASCII\n\
2349 terminals at any point in a key sequence.\n\
2351 The read-key-sequence function replaces subsequences bound by\n\
2352 function-key-map with their bindings. When the current local and global\n\
2353 keymaps have no binding for the current key sequence but\n\
2354 function-key-map binds a suffix of the sequence to a vector or string,\n\
2355 read-key-sequence replaces the matching suffix with its binding, and\n\
2356 continues with the new sequence.\n\
2358 For example, suppose function-key-map binds `ESC O P' to [f1].\n\
2359 Typing `ESC O P' to read-key-sequence would return [f1]. Typing\n\
2360 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix\n\
2361 key, typing `ESC O P x' would return [f1 x].");
2362 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
2364 Qsingle_key_description
= intern ("single-key-description");
2365 staticpro (&Qsingle_key_description
);
2367 Qkey_description
= intern ("key-description");
2368 staticpro (&Qkey_description
);
2370 Qkeymapp
= intern ("keymapp");
2371 staticpro (&Qkeymapp
);
2373 Qnon_ascii
= intern ("non-ascii");
2374 staticpro (&Qnon_ascii
);
2376 defsubr (&Skeymapp
);
2377 defsubr (&Smake_keymap
);
2378 defsubr (&Smake_sparse_keymap
);
2379 defsubr (&Scopy_keymap
);
2380 defsubr (&Skey_binding
);
2381 defsubr (&Slocal_key_binding
);
2382 defsubr (&Sglobal_key_binding
);
2383 defsubr (&Sminor_mode_key_binding
);
2384 defsubr (&Sglobal_set_key
);
2385 defsubr (&Slocal_set_key
);
2386 defsubr (&Sdefine_key
);
2387 defsubr (&Slookup_key
);
2388 defsubr (&Sglobal_unset_key
);
2389 defsubr (&Slocal_unset_key
);
2390 defsubr (&Sdefine_prefix_command
);
2391 defsubr (&Suse_global_map
);
2392 defsubr (&Suse_local_map
);
2393 defsubr (&Scurrent_local_map
);
2394 defsubr (&Scurrent_global_map
);
2395 defsubr (&Scurrent_minor_mode_maps
);
2396 defsubr (&Saccessible_keymaps
);
2397 defsubr (&Skey_description
);
2398 defsubr (&Sdescribe_vector
);
2399 defsubr (&Ssingle_key_description
);
2400 defsubr (&Stext_char_description
);
2401 defsubr (&Swhere_is_internal
);
2402 defsubr (&Sdescribe_bindings
);
2403 defsubr (&Sapropos_internal
);
2410 initial_define_key (global_map
, 033, "ESC-prefix");
2411 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");