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_vector (make_number (DENSE_TABLE_SIZE
), Qnil
),
125 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap
, Smake_sparse_keymap
, 0, 1, 0,
126 "Construct and return a new sparse-keymap list.\n\
127 Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),\n\
128 which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),\n\
129 which binds the function key or mouse event SYMBOL to DEFINITION.\n\
130 Initially the alist is nil.\n\n\
131 The optional arg STRING supplies a menu name for the keymap\n\
132 in case you use it as a menu with `x-popup-menu'.")
137 return Fcons (Qkeymap
, Fcons (string
, Qnil
));
138 return Fcons (Qkeymap
, Qnil
);
141 /* This function is used for installing the standard key bindings
142 at initialization time.
146 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
149 initial_define_key (keymap
, key
, defname
)
154 store_in_keymap (keymap
, make_number (key
), intern (defname
));
158 initial_define_lispy_key (keymap
, keyname
, defname
)
163 store_in_keymap (keymap
, intern (keyname
), intern (defname
));
166 /* Define character fromchar in map frommap as an alias for character
167 tochar in map tomap. Subsequent redefinitions of the latter WILL
168 affect the former. */
172 synkey (frommap
, fromchar
, tomap
, tochar
)
173 struct Lisp_Vector
*frommap
, *tomap
;
174 int fromchar
, tochar
;
177 XSETVECTOR (v
, tomap
);
178 XSETFASTINT (c
, tochar
);
179 frommap
->contents
[fromchar
] = Fcons (v
, c
);
183 DEFUN ("keymapp", Fkeymapp
, Skeymapp
, 1, 1, 0,
184 "Return t if OBJECT is a keymap.\n\
186 A keymap is a list (keymap . ALIST),\n\
187 or a symbol whose function definition is itself a keymap.\n\
188 ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
189 a vector of densely packed bindings for small character codes\n\
190 is also allowed as an element.")
194 return (NILP (get_keymap_1 (object
, 0, 0)) ? Qnil
: Qt
);
197 /* Check that OBJECT is a keymap (after dereferencing through any
198 symbols). If it is, return it.
200 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
201 is an autoload form, do the autoload and try again.
202 If AUTOLOAD is nonzero, callers must assume GC is possible.
204 ERROR controls how we respond if OBJECT isn't a keymap.
205 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
207 Note that most of the time, we don't want to pursue autoloads.
208 Functions like Faccessible_keymaps which scan entire keymap trees
209 shouldn't load every autoloaded keymap. I'm not sure about this,
210 but it seems to me that only read_key_sequence, Flookup_key, and
211 Fdefine_key should cause keymaps to be autoloaded. */
214 get_keymap_1 (object
, error
, autoload
)
221 tem
= indirect_function (object
);
222 if (CONSP (tem
) && EQ (XCONS (tem
)->car
, Qkeymap
))
225 /* Should we do an autoload? Autoload forms for keymaps have
226 Qkeymap as their fifth element. */
230 && EQ (XCONS (tem
)->car
, Qautoload
))
234 tail
= Fnth (make_number (4), tem
);
235 if (EQ (tail
, Qkeymap
))
237 struct gcpro gcpro1
, gcpro2
;
239 GCPRO2 (tem
, object
);
240 do_autoload (tem
, object
);
248 wrong_type_argument (Qkeymapp
, object
);
254 /* Follow any symbol chaining, and return the keymap denoted by OBJECT.
255 If OBJECT doesn't denote a keymap at all, signal an error. */
260 return get_keymap_1 (object
, 1, 0);
263 /* Return the parent map of the keymap MAP, or nil if it has none.
264 We assume that MAP is a valid keymap. */
266 DEFUN ("keymap-parent", Fkeymap_parent
, Skeymap_parent
, 1, 1, 0,
267 "Return the parent keymap of KEYMAP.")
273 keymap
= get_keymap_1 (keymap
, 1, 1);
275 /* Skip past the initial element `keymap'. */
276 list
= XCONS (keymap
)->cdr
;
277 for (; CONSP (list
); list
= XCONS (list
)->cdr
)
279 /* See if there is another `keymap'. */
280 if (EQ (Qkeymap
, XCONS (list
)->car
))
287 /* Set the parent keymap of MAP to PARENT. */
289 DEFUN ("set-keymap-parent", Fset_keymap_parent
, Sset_keymap_parent
, 2, 2, 0,
290 "Modify KEYMAP to set its parent map to PARENT.\n\
291 PARENT should be nil or another keymap.")
293 Lisp_Object keymap
, parent
;
295 Lisp_Object list
, prev
;
298 keymap
= get_keymap_1 (keymap
, 1, 1);
300 parent
= get_keymap_1 (parent
, 1, 1);
302 /* Skip past the initial element `keymap'. */
306 list
= XCONS (prev
)->cdr
;
307 /* If there is a parent keymap here, replace it.
308 If we came to the end, add the parent in PREV. */
309 if (! CONSP (list
) || EQ (Qkeymap
, XCONS (list
)->car
))
311 /* If we already have the right parent, return now
312 so that we avoid the loops below. */
313 if (EQ (XCONS (prev
)->cdr
, parent
))
316 XCONS (prev
)->cdr
= parent
;
322 /* Scan through for submaps, and set their parents too. */
324 for (list
= XCONS (keymap
)->cdr
; CONSP (list
); list
= XCONS (list
)->cdr
)
326 /* Stop the scan when we come to the parent. */
327 if (EQ (XCONS (list
)->car
, Qkeymap
))
330 /* If this element holds a prefix map, deal with it. */
331 if (CONSP (XCONS (list
)->car
)
332 && CONSP (XCONS (XCONS (list
)->car
)->cdr
))
333 fix_submap_inheritance (keymap
, XCONS (XCONS (list
)->car
)->car
,
334 XCONS (XCONS (list
)->car
)->cdr
);
336 if (VECTORP (XCONS (list
)->car
))
337 for (i
= 0; i
< XVECTOR (XCONS (list
)->car
)->size
; i
++)
338 if (CONSP (XVECTOR (XCONS (list
)->car
)->contents
[i
]))
339 fix_submap_inheritance (keymap
, make_number (i
),
340 XVECTOR (XCONS (list
)->car
)->contents
[i
]);
346 /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
347 if EVENT is also a prefix in MAP's parent,
348 make sure that SUBMAP inherits that definition as its own parent. */
350 fix_submap_inheritance (map
, event
, submap
)
351 Lisp_Object map
, event
, submap
;
353 Lisp_Object map_parent
, parent_entry
;
355 /* SUBMAP is a cons that we found as a key binding.
356 Discard the other things found in a menu key binding. */
359 && STRINGP (XCONS (submap
)->car
))
361 submap
= XCONS (submap
)->cdr
;
362 /* Also remove a menu help string, if any,
363 following the menu item name. */
364 if (CONSP (submap
) && STRINGP (XCONS (submap
)->car
))
365 submap
= XCONS (submap
)->cdr
;
366 /* Also remove the sublist that caches key equivalences, if any. */
368 && CONSP (XCONS (submap
)->car
))
371 carcar
= XCONS (XCONS (submap
)->car
)->car
;
372 if (NILP (carcar
) || VECTORP (carcar
))
373 submap
= XCONS (submap
)->cdr
;
377 /* If it isn't a keymap now, there's no work to do. */
379 || ! EQ (XCONS (submap
)->car
, Qkeymap
))
382 map_parent
= Fkeymap_parent (map
);
383 if (! NILP (map_parent
))
384 parent_entry
= access_keymap (map_parent
, event
, 0, 0);
388 /* If MAP's parent has something other than a keymap,
389 our own submap shadows it completely, so use nil as SUBMAP's parent. */
390 if (! (CONSP (parent_entry
) && EQ (XCONS (parent_entry
)->car
, Qkeymap
)))
393 if (! EQ (parent_entry
, submap
))
394 Fset_keymap_parent (submap
, parent_entry
);
397 /* Look up IDX in MAP. IDX may be any sort of event.
398 Note that this does only one level of lookup; IDX must be a single
399 event, not a sequence.
401 If T_OK is non-zero, bindings for Qt are treated as default
402 bindings; any key left unmentioned by other tables and bindings is
403 given the binding of Qt.
405 If T_OK is zero, bindings for Qt are not treated specially.
407 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
410 access_keymap (map
, idx
, t_ok
, noinherit
)
419 /* If idx is a list (some sort of mouse click, perhaps?),
420 the index we want to use is the car of the list, which
421 ought to be a symbol. */
422 idx
= EVENT_HEAD (idx
);
424 /* If idx is a symbol, it might have modifiers, which need to
425 be put in the canonical order. */
427 idx
= reorder_modifiers (idx
);
428 else if (INTEGERP (idx
))
429 /* Clobber the high bits that can be present on a machine
430 with more than 24 bits of integer. */
431 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
435 Lisp_Object t_binding
;
438 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
442 binding
= XCONS (tail
)->car
;
443 if (SYMBOLP (binding
))
445 /* If NOINHERIT, stop finding prefix definitions
446 after we pass a second occurrence of the `keymap' symbol. */
447 if (noinherit
&& EQ (binding
, Qkeymap
) && ! EQ (tail
, map
))
450 else if (CONSP (binding
))
452 if (EQ (XCONS (binding
)->car
, idx
))
454 val
= XCONS (binding
)->cdr
;
455 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
458 fix_submap_inheritance (map
, idx
, val
);
461 if (t_ok
&& EQ (XCONS (binding
)->car
, Qt
))
462 t_binding
= XCONS (binding
)->cdr
;
464 else if (VECTORP (binding
))
466 if (NATNUMP (idx
) && XFASTINT (idx
) < XVECTOR (binding
)->size
)
468 val
= XVECTOR (binding
)->contents
[XFASTINT (idx
)];
469 if (noprefix
&& CONSP (val
) && EQ (XCONS (val
)->car
, Qkeymap
))
472 fix_submap_inheritance (map
, idx
, val
);
484 /* Given OBJECT which was found in a slot in a keymap,
485 trace indirect definitions to get the actual definition of that slot.
486 An indirect definition is a list of the form
487 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
488 and INDEX is the object to look up in KEYMAP to yield the definition.
490 Also if OBJECT has a menu string as the first element,
491 remove that. Also remove a menu help string as second element.
493 If AUTOLOAD is nonzero, load autoloadable keymaps
494 that are referred to with indirection. */
497 get_keyelt (object
, autoload
)
498 register Lisp_Object object
;
503 register Lisp_Object map
, tem
;
505 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
506 map
= get_keymap_1 (Fcar_safe (object
), 0, autoload
);
507 tem
= Fkeymapp (map
);
509 object
= access_keymap (map
, Fcdr (object
), 0, 0);
511 /* If the keymap contents looks like (STRING . DEFN),
513 Keymap alist elements like (CHAR MENUSTRING . DEFN)
514 will be used by HierarKey menus. */
515 else if (CONSP (object
)
516 && STRINGP (XCONS (object
)->car
))
518 object
= XCONS (object
)->cdr
;
519 /* Also remove a menu help string, if any,
520 following the menu item name. */
521 if (CONSP (object
) && STRINGP (XCONS (object
)->car
))
522 object
= XCONS (object
)->cdr
;
523 /* Also remove the sublist that caches key equivalences, if any. */
525 && CONSP (XCONS (object
)->car
))
528 carcar
= XCONS (XCONS (object
)->car
)->car
;
529 if (NILP (carcar
) || VECTORP (carcar
))
530 object
= XCONS (object
)->cdr
;
535 /* Anything else is really the value. */
541 store_in_keymap (keymap
, idx
, def
)
543 register Lisp_Object idx
;
544 register Lisp_Object def
;
546 /* If we are preparing to dump, and DEF is a menu element
547 with a menu item string, copy it to ensure it is not pure. */
548 if (CONSP (def
) && PURE_P (def
) && STRINGP (XCONS (def
)->car
))
549 def
= Fcons (XCONS (def
)->car
, XCONS (def
)->cdr
);
551 if (!CONSP (keymap
) || ! EQ (XCONS (keymap
)->car
, Qkeymap
))
552 error ("attempt to define a key in a non-keymap");
554 /* If idx is a list (some sort of mouse click, perhaps?),
555 the index we want to use is the car of the list, which
556 ought to be a symbol. */
557 idx
= EVENT_HEAD (idx
);
559 /* If idx is a symbol, it might have modifiers, which need to
560 be put in the canonical order. */
562 idx
= reorder_modifiers (idx
);
563 else if (INTEGERP (idx
))
564 /* Clobber the high bits that can be present on a machine
565 with more than 24 bits of integer. */
566 XSETFASTINT (idx
, XINT (idx
) & (CHAR_META
| (CHAR_META
- 1)));
568 /* Scan the keymap for a binding of idx. */
572 /* The cons after which we should insert new bindings. If the
573 keymap has a table element, we record its position here, so new
574 bindings will go after it; this way, the table will stay
575 towards the front of the alist and character lookups in dense
576 keymaps will remain fast. Otherwise, this just points at the
577 front of the keymap. */
578 Lisp_Object insertion_point
;
580 insertion_point
= keymap
;
581 for (tail
= XCONS (keymap
)->cdr
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
585 elt
= XCONS (tail
)->car
;
588 if (NATNUMP (idx
) && XFASTINT (idx
) < XVECTOR (elt
)->size
)
590 XVECTOR (elt
)->contents
[XFASTINT (idx
)] = def
;
593 insertion_point
= tail
;
595 else if (CONSP (elt
))
597 if (EQ (idx
, XCONS (elt
)->car
))
599 XCONS (elt
)->cdr
= def
;
603 else if (SYMBOLP (elt
))
605 /* If we find a 'keymap' symbol in the spine of KEYMAP,
606 then we must have found the start of a second keymap
607 being used as the tail of KEYMAP, and a binding for IDX
608 should be inserted before it. */
609 if (EQ (elt
, Qkeymap
))
617 /* We have scanned the entire keymap, and not found a binding for
618 IDX. Let's add one. */
619 XCONS (insertion_point
)->cdr
620 = Fcons (Fcons (idx
, def
), XCONS (insertion_point
)->cdr
);
627 DEFUN ("copy-keymap", Fcopy_keymap
, Scopy_keymap
, 1, 1, 0,
628 "Return a copy of the keymap KEYMAP.\n\
629 The copy starts out with the same definitions of KEYMAP,\n\
630 but changing either the copy or KEYMAP does not affect the other.\n\
631 Any key definitions that are subkeymaps are recursively copied.\n\
632 However, a key definition which is a symbol whose definition is a keymap\n\
637 register Lisp_Object copy
, tail
;
639 copy
= Fcopy_alist (get_keymap (keymap
));
641 for (tail
= copy
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
645 elt
= XCONS (tail
)->car
;
650 elt
= Fcopy_sequence (elt
);
651 XCONS (tail
)->car
= elt
;
653 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
654 if (!SYMBOLP (XVECTOR (elt
)->contents
[i
])
655 && ! NILP (Fkeymapp (XVECTOR (elt
)->contents
[i
])))
656 XVECTOR (elt
)->contents
[i
] =
657 Fcopy_keymap (XVECTOR (elt
)->contents
[i
]);
659 else if (CONSP (elt
))
661 /* Skip the optional menu string. */
662 if (CONSP (XCONS (elt
)->cdr
)
663 && STRINGP (XCONS (XCONS (elt
)->cdr
)->car
))
667 /* Copy the cell, since copy-alist didn't go this deep. */
668 XCONS (elt
)->cdr
= Fcons (XCONS (XCONS (elt
)->cdr
)->car
,
669 XCONS (XCONS (elt
)->cdr
)->cdr
);
670 elt
= XCONS (elt
)->cdr
;
672 /* Also skip the optional menu help string. */
673 if (CONSP (XCONS (elt
)->cdr
)
674 && STRINGP (XCONS (XCONS (elt
)->cdr
)->car
))
676 XCONS (elt
)->cdr
= Fcons (XCONS (XCONS (elt
)->cdr
)->car
,
677 XCONS (XCONS (elt
)->cdr
)->cdr
);
678 elt
= XCONS (elt
)->cdr
;
680 /* There may also be a list that caches key equivalences.
681 Just delete it for the new keymap. */
682 if (CONSP (XCONS (elt
)->cdr
)
683 && CONSP (XCONS (XCONS (elt
)->cdr
)->car
)
684 && (NILP (tem
= XCONS (XCONS (XCONS (elt
)->cdr
)->car
)->car
)
686 XCONS (elt
)->cdr
= XCONS (XCONS (elt
)->cdr
)->cdr
;
689 && ! SYMBOLP (XCONS (elt
)->cdr
)
690 && ! NILP (Fkeymapp (XCONS (elt
)->cdr
)))
691 XCONS (elt
)->cdr
= Fcopy_keymap (XCONS (elt
)->cdr
);
698 /* Simple Keymap mutators and accessors. */
700 /* GC is possible in this function if it autoloads a keymap. */
702 DEFUN ("define-key", Fdefine_key
, Sdefine_key
, 3, 3, 0,
703 "Args KEYMAP, KEY, DEF. Define key sequence KEY, in KEYMAP, as DEF.\n\
704 KEYMAP is a keymap. KEY is a string or a vector of symbols and characters\n\
705 meaning a sequence of keystrokes and events.\n\
706 Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
707 can be included if you use a vector.\n\
708 DEF is anything that can be a key's definition:\n\
709 nil (means key is undefined in this keymap),\n\
710 a command (a Lisp function suitable for interactive calling)\n\
711 a string (treated as a keyboard macro),\n\
712 a keymap (to define a prefix key),\n\
713 a symbol. When the key is looked up, the symbol will stand for its\n\
714 function definition, which should at that time be one of the above,\n\
715 or another symbol whose function definition is used, etc.\n\
716 a cons (STRING . DEFN), meaning that DEFN is the definition\n\
717 (DEFN should be a valid definition in its own right),\n\
718 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.\n\
720 If KEYMAP is a sparse keymap, the pair binding KEY to DEF is added at\n\
721 the front of KEYMAP.")
728 register Lisp_Object c
;
729 register Lisp_Object tem
;
730 register Lisp_Object cmd
;
734 struct gcpro gcpro1
, gcpro2
, gcpro3
;
736 keymap
= get_keymap_1 (keymap
, 1, 1);
738 if (!VECTORP (key
) && !STRINGP (key
))
739 key
= wrong_type_argument (Qarrayp
, key
);
741 length
= XFASTINT (Flength (key
));
745 if (SYMBOLP (def
) && !EQ (Vdefine_key_rebound_commands
, Qt
))
746 Vdefine_key_rebound_commands
= Fcons (def
, Vdefine_key_rebound_commands
);
748 GCPRO3 (keymap
, key
, def
);
751 meta_bit
= meta_modifier
;
758 c
= Faref (key
, make_number (idx
));
760 if (CONSP (c
) && lucid_event_type_list_p (c
))
761 c
= Fevent_convert_list (c
);
764 && (XINT (c
) & meta_bit
)
767 c
= meta_prefix_char
;
773 XSETINT (c
, XINT (c
) & ~meta_bit
);
779 if (! INTEGERP (c
) && ! SYMBOLP (c
) && ! CONSP (c
))
780 error ("Key sequence contains invalid events");
783 RETURN_UNGCPRO (store_in_keymap (keymap
, c
, def
));
785 cmd
= get_keyelt (access_keymap (keymap
, c
, 0, 1), 1);
787 /* If this key is undefined, make it a prefix. */
789 cmd
= define_as_prefix (keymap
, c
);
791 keymap
= get_keymap_1 (cmd
, 0, 1);
793 /* We must use Fkey_description rather than just passing key to
794 error; key might be a vector, not a string. */
795 error ("Key sequence %s uses invalid prefix characters",
796 XSTRING (Fkey_description (key
))->data
);
800 /* Value is number if KEY is too long; NIL if valid but has no definition. */
801 /* GC is possible in this function if it autoloads a keymap. */
803 DEFUN ("lookup-key", Flookup_key
, Slookup_key
, 2, 3, 0,
804 "In keymap KEYMAP, look up key sequence KEY. Return the definition.\n\
805 nil means undefined. See doc of `define-key' for kinds of definitions.\n\
807 A number as value means KEY is \"too long\";\n\
808 that is, characters or symbols in it except for the last one\n\
809 fail to be a valid sequence of prefix characters in KEYMAP.\n\
810 The number is how many characters at the front of KEY\n\
811 it takes to reach a non-prefix command.\n\
813 Normally, `lookup-key' ignores bindings for t, which act as default\n\
814 bindings, used when nothing else in the keymap applies; this makes it\n\
815 usable as a general function for probing keymaps. However, if the\n\
816 third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will\n\
817 recognize the default bindings, just as `read-key-sequence' does.")
818 (keymap
, key
, accept_default
)
819 register Lisp_Object keymap
;
821 Lisp_Object accept_default
;
824 register Lisp_Object tem
;
825 register Lisp_Object cmd
;
826 register Lisp_Object c
;
829 int t_ok
= ! NILP (accept_default
);
833 keymap
= get_keymap_1 (keymap
, 1, 1);
835 if (!VECTORP (key
) && !STRINGP (key
))
836 key
= wrong_type_argument (Qarrayp
, key
);
838 length
= XFASTINT (Flength (key
));
843 meta_bit
= meta_modifier
;
852 c
= Faref (key
, make_number (idx
));
854 if (CONSP (c
) && lucid_event_type_list_p (c
))
855 c
= Fevent_convert_list (c
);
858 && (XINT (c
) & meta_bit
)
861 c
= meta_prefix_char
;
867 XSETINT (c
, XINT (c
) & ~meta_bit
);
873 cmd
= get_keyelt (access_keymap (keymap
, c
, t_ok
, 0), 1);
875 RETURN_UNGCPRO (cmd
);
877 keymap
= get_keymap_1 (cmd
, 0, 1);
879 RETURN_UNGCPRO (make_number (idx
));
885 /* Make KEYMAP define event C as a keymap (i.e., as a prefix).
886 Assume that currently it does not define C at all.
887 Return the keymap. */
890 define_as_prefix (keymap
, c
)
891 Lisp_Object keymap
, c
;
893 Lisp_Object inherit
, cmd
;
895 cmd
= Fmake_sparse_keymap (Qnil
);
896 /* If this key is defined as a prefix in an inherited keymap,
897 make it a prefix in this map, and make its definition
898 inherit the other prefix definition. */
899 inherit
= access_keymap (keymap
, c
, 0, 0);
901 /* This code is needed to do the right thing in the following case:
902 keymap A inherits from B,
903 you define KEY as a prefix in A,
904 then later you define KEY as a prefix in B.
905 We want the old prefix definition in A to inherit from that in B.
906 It is hard to do that retroactively, so this code
907 creates the prefix in B right away.
909 But it turns out that this code causes problems immediately
910 when the prefix in A is defined: it causes B to define KEY
911 as a prefix with no subcommands.
913 So I took out this code. */
916 /* If there's an inherited keymap
917 and it doesn't define this key,
918 make it define this key. */
921 for (tail
= Fcdr (keymap
); CONSP (tail
); tail
= XCONS (tail
)->cdr
)
922 if (EQ (XCONS (tail
)->car
, Qkeymap
))
926 inherit
= define_as_prefix (tail
, c
);
930 cmd
= nconc2 (cmd
, inherit
);
931 store_in_keymap (keymap
, c
, cmd
);
936 /* Append a key to the end of a key sequence. We always make a vector. */
939 append_key (key_sequence
, key
)
940 Lisp_Object key_sequence
, key
;
944 args
[0] = key_sequence
;
946 args
[1] = Fcons (key
, Qnil
);
947 return Fvconcat (2, args
);
951 /* Global, local, and minor mode keymap stuff. */
953 /* We can't put these variables inside current_minor_maps, since under
954 some systems, static gets macro-defined to be the empty string.
956 static Lisp_Object
*cmm_modes
, *cmm_maps
;
959 /* Error handler used in current_minor_maps. */
961 current_minor_maps_error ()
966 /* Store a pointer to an array of the keymaps of the currently active
967 minor modes in *buf, and return the number of maps it contains.
969 This function always returns a pointer to the same buffer, and may
970 free or reallocate it, so if you want to keep it for a long time or
971 hand it out to lisp code, copy it. This procedure will be called
972 for every key sequence read, so the nice lispy approach (return a
973 new assoclist, list, what have you) for each invocation would
974 result in a lot of consing over time.
976 If we used xrealloc/xmalloc and ran out of memory, they would throw
977 back to the command loop, which would try to read a key sequence,
978 which would call this function again, resulting in an infinite
979 loop. Instead, we'll use realloc/malloc and silently truncate the
980 list, let the key sequence be read, and hope some other piece of
981 code signals the error. */
983 current_minor_maps (modeptr
, mapptr
)
984 Lisp_Object
**modeptr
, **mapptr
;
987 Lisp_Object alist
, assoc
, var
, val
;
989 for (alist
= Vminor_mode_map_alist
;
991 alist
= XCONS (alist
)->cdr
)
992 if ((assoc
= XCONS (alist
)->car
, CONSP (assoc
))
993 && (var
= XCONS (assoc
)->car
, SYMBOLP (var
))
994 && (val
= find_symbol_value (var
), ! EQ (val
, Qunbound
))
1001 Lisp_Object
*newmodes
, *newmaps
;
1008 = (Lisp_Object
*) realloc (cmm_modes
,
1009 cmm_size
* sizeof (Lisp_Object
));
1011 = (Lisp_Object
*) realloc (cmm_maps
,
1012 cmm_size
* sizeof (Lisp_Object
));
1020 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
1022 = (Lisp_Object
*) malloc (cmm_size
* sizeof (Lisp_Object
));
1026 if (newmaps
&& newmodes
)
1028 cmm_modes
= newmodes
;
1035 /* Get the keymap definition--or nil if it is not defined. */
1036 temp
= internal_condition_case_1 (Findirect_function
,
1038 Qerror
, current_minor_maps_error
);
1042 cmm_maps
[i
] = temp
;
1047 if (modeptr
) *modeptr
= cmm_modes
;
1048 if (mapptr
) *mapptr
= cmm_maps
;
1052 /* GC is possible in this function if it autoloads a keymap. */
1054 DEFUN ("key-binding", Fkey_binding
, Skey_binding
, 1, 2, 0,
1055 "Return the binding for command KEY in current keymaps.\n\
1056 KEY is a string or vector, a sequence of keystrokes.\n\
1057 The binding is probably a symbol with a function definition.\n\
1059 Normally, `key-binding' ignores bindings for t, which act as default\n\
1060 bindings, used when nothing else in the keymap applies; this makes it\n\
1061 usable as a general function for probing keymaps. However, if the\n\
1062 optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\
1063 recognize the default bindings, just as `read-key-sequence' does.")
1064 (key
, accept_default
)
1065 Lisp_Object key
, accept_default
;
1067 Lisp_Object
*maps
, value
;
1069 struct gcpro gcpro1
;
1073 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
1075 value
= Flookup_key (current_kboard
->Voverriding_terminal_local_map
,
1076 key
, accept_default
);
1077 if (! NILP (value
) && !INTEGERP (value
))
1078 RETURN_UNGCPRO (value
);
1080 else if (!NILP (Voverriding_local_map
))
1082 value
= Flookup_key (Voverriding_local_map
, key
, accept_default
);
1083 if (! NILP (value
) && !INTEGERP (value
))
1084 RETURN_UNGCPRO (value
);
1090 nmaps
= current_minor_maps (0, &maps
);
1091 /* Note that all these maps are GCPRO'd
1092 in the places where we found them. */
1094 for (i
= 0; i
< nmaps
; i
++)
1095 if (! NILP (maps
[i
]))
1097 value
= Flookup_key (maps
[i
], key
, accept_default
);
1098 if (! NILP (value
) && !INTEGERP (value
))
1099 RETURN_UNGCPRO (value
);
1102 local
= get_local_map (PT
, current_buffer
);
1106 value
= Flookup_key (local
, key
, accept_default
);
1107 if (! NILP (value
) && !INTEGERP (value
))
1108 RETURN_UNGCPRO (value
);
1112 value
= Flookup_key (current_global_map
, key
, accept_default
);
1114 if (! NILP (value
) && !INTEGERP (value
))
1120 /* GC is possible in this function if it autoloads a keymap. */
1122 DEFUN ("local-key-binding", Flocal_key_binding
, Slocal_key_binding
, 1, 2, 0,
1123 "Return the binding for command KEYS in current local keymap only.\n\
1124 KEYS is a string, a sequence of keystrokes.\n\
1125 The binding is probably a symbol with a function definition.\n\
1127 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1128 bindings; see the description of `lookup-key' for more details about this.")
1129 (keys
, accept_default
)
1130 Lisp_Object keys
, accept_default
;
1132 register Lisp_Object map
;
1133 map
= current_buffer
->keymap
;
1136 return Flookup_key (map
, keys
, accept_default
);
1139 /* GC is possible in this function if it autoloads a keymap. */
1141 DEFUN ("global-key-binding", Fglobal_key_binding
, Sglobal_key_binding
, 1, 2, 0,
1142 "Return the binding for command KEYS in current global keymap only.\n\
1143 KEYS is a string, a sequence of keystrokes.\n\
1144 The binding is probably a symbol with a function definition.\n\
1145 This function's return values are the same as those of lookup-key\n\
1148 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1149 bindings; see the description of `lookup-key' for more details about this.")
1150 (keys
, accept_default
)
1151 Lisp_Object keys
, accept_default
;
1153 return Flookup_key (current_global_map
, keys
, accept_default
);
1156 /* GC is possible in this function if it autoloads a keymap. */
1158 DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding
, Sminor_mode_key_binding
, 1, 2, 0,
1159 "Find the visible minor mode bindings of KEY.\n\
1160 Return an alist of pairs (MODENAME . BINDING), where MODENAME is the\n\
1161 the symbol which names the minor mode binding KEY, and BINDING is\n\
1162 KEY's definition in that mode. In particular, if KEY has no\n\
1163 minor-mode bindings, return nil. If the first binding is a\n\
1164 non-prefix, all subsequent bindings will be omitted, since they would\n\
1165 be ignored. Similarly, the list doesn't include non-prefix bindings\n\
1166 that come after prefix bindings.\n\
1168 If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
1169 bindings; see the description of `lookup-key' for more details about this.")
1170 (key
, accept_default
)
1171 Lisp_Object key
, accept_default
;
1173 Lisp_Object
*modes
, *maps
;
1175 Lisp_Object binding
;
1177 struct gcpro gcpro1
, gcpro2
;
1179 nmaps
= current_minor_maps (&modes
, &maps
);
1180 /* Note that all these maps are GCPRO'd
1181 in the places where we found them. */
1184 GCPRO2 (key
, binding
);
1186 for (i
= j
= 0; i
< nmaps
; i
++)
1187 if (! NILP (maps
[i
])
1188 && ! NILP (binding
= Flookup_key (maps
[i
], key
, accept_default
))
1189 && !INTEGERP (binding
))
1191 if (! NILP (get_keymap (binding
)))
1192 maps
[j
++] = Fcons (modes
[i
], binding
);
1194 RETURN_UNGCPRO (Fcons (Fcons (modes
[i
], binding
), Qnil
));
1198 return Flist (j
, maps
);
1201 DEFUN ("define-prefix-command", Fdefine_prefix_command
, Sdefine_prefix_command
, 1, 2, 0,
1202 "Define COMMAND as a prefix command. COMMAND should be a symbol.\n\
1203 A new sparse keymap is stored as COMMAND's function definition and its value.\n\
1204 If a second optional argument MAPVAR is given, the map is stored as\n\
1205 its value instead of as COMMAND's value; but COMMAND is still defined\n\
1208 Lisp_Object command
, mapvar
;
1211 map
= Fmake_sparse_keymap (Qnil
);
1212 Ffset (command
, map
);
1216 Fset (command
, map
);
1220 DEFUN ("use-global-map", Fuse_global_map
, Suse_global_map
, 1, 1, 0,
1221 "Select KEYMAP as the global keymap.")
1225 keymap
= get_keymap (keymap
);
1226 current_global_map
= keymap
;
1231 DEFUN ("use-local-map", Fuse_local_map
, Suse_local_map
, 1, 1, 0,
1232 "Select KEYMAP as the local keymap.\n\
1233 If KEYMAP is nil, that means no local keymap.")
1238 keymap
= get_keymap (keymap
);
1240 current_buffer
->keymap
= keymap
;
1245 DEFUN ("current-local-map", Fcurrent_local_map
, Scurrent_local_map
, 0, 0, 0,
1246 "Return current buffer's local keymap, or nil if it has none.")
1249 return current_buffer
->keymap
;
1252 DEFUN ("current-global-map", Fcurrent_global_map
, Scurrent_global_map
, 0, 0, 0,
1253 "Return the current global keymap.")
1256 return current_global_map
;
1259 DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps
, Scurrent_minor_mode_maps
, 0, 0, 0,
1260 "Return a list of keymaps for the minor modes of the current buffer.")
1264 int nmaps
= current_minor_maps (0, &maps
);
1266 return Flist (nmaps
, maps
);
1269 /* Help functions for describing and documenting keymaps. */
1271 /* This function cannot GC. */
1273 DEFUN ("accessible-keymaps", Faccessible_keymaps
, Saccessible_keymaps
,
1275 "Find all keymaps accessible via prefix characters from KEYMAP.\n\
1276 Returns a list of elements of the form (KEYS . MAP), where the sequence\n\
1277 KEYS starting from KEYMAP gets you to MAP. These elements are ordered\n\
1278 so that the KEYS increase in length. The first element is ([] . KEYMAP).\n\
1279 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
1280 then the value includes only maps for prefixes that start with PREFIX.")
1282 Lisp_Object keymap
, prefix
;
1284 Lisp_Object maps
, good_maps
, tail
;
1287 /* no need for gcpro because we don't autoload any keymaps. */
1290 prefixlen
= XINT (Flength (prefix
));
1294 /* If a prefix was specified, start with the keymap (if any) for
1295 that prefix, so we don't waste time considering other prefixes. */
1297 tem
= Flookup_key (keymap
, prefix
, Qt
);
1298 /* Flookup_key may give us nil, or a number,
1299 if the prefix is not defined in this particular map.
1300 It might even give us a list that isn't a keymap. */
1301 tem
= get_keymap_1 (tem
, 0, 0);
1303 maps
= Fcons (Fcons (prefix
, tem
), Qnil
);
1308 maps
= Fcons (Fcons (Fmake_vector (make_number (0), Qnil
),
1309 get_keymap (keymap
)),
1312 /* For each map in the list maps,
1313 look at any other maps it points to,
1314 and stick them at the end if they are not already in the list.
1316 This is a breadth-first traversal, where tail is the queue of
1317 nodes, and maps accumulates a list of all nodes visited. */
1319 for (tail
= maps
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
1321 register Lisp_Object thisseq
, thismap
;
1323 /* Does the current sequence end in the meta-prefix-char? */
1326 thisseq
= Fcar (Fcar (tail
));
1327 thismap
= Fcdr (Fcar (tail
));
1328 last
= make_number (XINT (Flength (thisseq
)) - 1);
1329 is_metized
= (XINT (last
) >= 0
1330 /* Don't metize the last char of PREFIX. */
1331 && XINT (last
) >= prefixlen
1332 && EQ (Faref (thisseq
, last
), meta_prefix_char
));
1334 for (; CONSP (thismap
); thismap
= XCONS (thismap
)->cdr
)
1338 elt
= XCONS (thismap
)->car
;
1346 /* Vector keymap. Scan all the elements. */
1347 for (i
= 0; i
< XVECTOR (elt
)->size
; i
++)
1349 register Lisp_Object tem
;
1350 register Lisp_Object cmd
;
1352 cmd
= get_keyelt (XVECTOR (elt
)->contents
[i
], 0);
1353 if (NILP (cmd
)) continue;
1354 tem
= Fkeymapp (cmd
);
1357 cmd
= get_keymap (cmd
);
1358 /* Ignore keymaps that are already added to maps. */
1359 tem
= Frassq (cmd
, maps
);
1362 /* If the last key in thisseq is meta-prefix-char,
1363 turn it into a meta-ized keystroke. We know
1364 that the event we're about to append is an
1365 ascii keystroke since we're processing a
1369 int meta_bit
= meta_modifier
;
1370 tem
= Fcopy_sequence (thisseq
);
1372 Faset (tem
, last
, make_number (i
| meta_bit
));
1374 /* This new sequence is the same length as
1375 thisseq, so stick it in the list right
1378 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1382 tem
= append_key (thisseq
, make_number (i
));
1383 nconc2 (tail
, Fcons (Fcons (tem
, cmd
), Qnil
));
1389 else if (CONSP (elt
))
1391 register Lisp_Object cmd
, tem
, filter
;
1393 cmd
= get_keyelt (XCONS (elt
)->cdr
, 0);
1394 /* Ignore definitions that aren't keymaps themselves. */
1395 tem
= Fkeymapp (cmd
);
1398 /* Ignore keymaps that have been seen already. */
1399 cmd
= get_keymap (cmd
);
1400 tem
= Frassq (cmd
, maps
);
1403 /* Let elt be the event defined by this map entry. */
1404 elt
= XCONS (elt
)->car
;
1406 /* If the last key in thisseq is meta-prefix-char, and
1407 this entry is a binding for an ascii keystroke,
1408 turn it into a meta-ized keystroke. */
1409 if (is_metized
&& INTEGERP (elt
))
1411 Lisp_Object element
;
1414 tem
= Fvconcat (1, &element
);
1415 XVECTOR (tem
)->contents
[XINT (last
)]
1416 = XINT (elt
) | meta_modifier
;
1418 /* This new sequence is the same length as
1419 thisseq, so stick it in the list right
1422 = Fcons (Fcons (tem
, cmd
), XCONS (tail
)->cdr
);
1426 Fcons (Fcons (append_key (thisseq
, elt
), cmd
),
1437 /* Now find just the maps whose access prefixes start with PREFIX. */
1440 for (; CONSP (maps
); maps
= XCONS (maps
)->cdr
)
1442 Lisp_Object elt
, thisseq
;
1443 elt
= XCONS (maps
)->car
;
1444 thisseq
= XCONS (elt
)->car
;
1445 /* The access prefix must be at least as long as PREFIX,
1446 and the first elements must match those of PREFIX. */
1447 if (XINT (Flength (thisseq
)) >= prefixlen
)
1450 for (i
= 0; i
< prefixlen
; i
++)
1453 XSETFASTINT (i1
, i
);
1454 if (!EQ (Faref (thisseq
, i1
), Faref (prefix
, i1
)))
1458 good_maps
= Fcons (elt
, good_maps
);
1462 return Fnreverse (good_maps
);
1465 Lisp_Object Qsingle_key_description
, Qkey_description
;
1467 /* This function cannot GC. */
1469 DEFUN ("key-description", Fkey_description
, Skey_description
, 1, 1, 0,
1470 "Return a pretty description of key-sequence KEYS.\n\
1471 Control characters turn into \"C-foo\" sequences, meta into \"M-foo\"\n\
1472 spaces are put between sequence elements, etc.")
1484 vector
= Fmake_vector (Flength (keys
), Qnil
);
1485 for (i
= 0; i
< XSTRING (keys
)->size
; i
++)
1487 if (XSTRING (keys
)->data
[i
] & 0x80)
1488 XSETFASTINT (XVECTOR (vector
)->contents
[i
],
1489 meta_modifier
| (XSTRING (keys
)->data
[i
] & ~0x80));
1491 XSETFASTINT (XVECTOR (vector
)->contents
[i
],
1492 XSTRING (keys
)->data
[i
]);
1496 else if (!VECTORP (keys
))
1497 keys
= wrong_type_argument (Qarrayp
, keys
);
1499 /* In effect, this computes
1500 (mapconcat 'single-key-description keys " ")
1501 but we shouldn't use mapconcat because it can do GC. */
1503 len
= XVECTOR (keys
)->size
;
1504 sep
= build_string (" ");
1505 /* This has one extra element at the end that we don't pass to Fconcat. */
1506 args
= (Lisp_Object
*) alloca (len
* 2 * sizeof (Lisp_Object
));
1508 for (i
= 0; i
< len
; i
++)
1510 args
[i
* 2] = Fsingle_key_description (XVECTOR (keys
)->contents
[i
]);
1511 args
[i
* 2 + 1] = sep
;
1514 return Fconcat (len
* 2 - 1, args
);
1518 push_key_description (c
, p
)
1519 register unsigned int c
;
1522 /* Clear all the meaningless bits above the meta bit. */
1523 c
&= meta_modifier
| ~ - meta_modifier
;
1525 if (c
& alt_modifier
)
1531 if (c
& ctrl_modifier
)
1537 if (c
& hyper_modifier
)
1541 c
-= hyper_modifier
;
1543 if (c
& meta_modifier
)
1549 if (c
& shift_modifier
)
1553 c
-= shift_modifier
;
1555 if (c
& super_modifier
)
1559 c
-= super_modifier
;
1575 else if (c
== Ctl ('M'))
1585 if (c
> 0 && c
<= Ctl ('Z'))
1610 *p
++ = (7 & (c
>> 6)) + '0';
1611 *p
++ = (7 & (c
>> 3)) + '0';
1612 *p
++ = (7 & (c
>> 0)) + '0';
1617 *p
++ = (7 & (c
>> 15)) + '0';
1618 *p
++ = (7 & (c
>> 12)) + '0';
1619 *p
++ = (7 & (c
>> 9)) + '0';
1620 *p
++ = (7 & (c
>> 6)) + '0';
1621 *p
++ = (7 & (c
>> 3)) + '0';
1622 *p
++ = (7 & (c
>> 0)) + '0';
1628 /* This function cannot GC. */
1630 DEFUN ("single-key-description", Fsingle_key_description
, Ssingle_key_description
, 1, 1, 0,
1631 "Return a pretty description of command character KEY.\n\
1632 Control characters turn into C-whatever, etc.")
1638 key
= EVENT_HEAD (key
);
1640 if (INTEGERP (key
)) /* Normal character */
1642 *push_key_description (XUINT (key
), tem
) = 0;
1643 return build_string (tem
);
1645 else if (SYMBOLP (key
)) /* Function key or event-symbol */
1646 return Fsymbol_name (key
);
1647 else if (STRINGP (key
)) /* Buffer names in the menubar. */
1648 return Fcopy_sequence (key
);
1650 error ("KEY must be an integer, cons, symbol, or string");
1654 push_text_char_description (c
, p
)
1655 register unsigned int c
;
1667 *p
++ = c
+ 64; /* 'A' - 1 */
1679 /* This function cannot GC. */
1681 DEFUN ("text-char-description", Ftext_char_description
, Stext_char_description
, 1, 1, 0,
1682 "Return a pretty description of file-character CHARACTER.\n\
1683 Control characters turn into \"^char\", etc.")
1685 Lisp_Object character
;
1689 CHECK_NUMBER (character
, 0);
1691 if (!SINGLE_BYTE_CHAR_P (XFASTINT (character
)))
1694 int len
= non_ascii_char_to_string (XFASTINT (character
), tem
, &str
);
1696 return make_string (str
, len
);
1699 *push_text_char_description (XINT (character
) & 0377, tem
) = 0;
1701 return build_string (tem
);
1704 /* Return non-zero if SEQ contains only ASCII characters, perhaps with
1707 ascii_sequence_p (seq
)
1711 int len
= XINT (Flength (seq
));
1713 for (i
= 0; i
< len
; i
++)
1715 Lisp_Object ii
, elt
;
1717 XSETFASTINT (ii
, i
);
1718 elt
= Faref (seq
, ii
);
1721 || (XUINT (elt
) & ~CHAR_META
) >= 0x80)
1729 /* where-is - finding a command in a set of keymaps. */
1731 /* This function can GC if Flookup_key autoloads any keymaps. */
1733 DEFUN ("where-is-internal", Fwhere_is_internal
, Swhere_is_internal
, 1, 4, 0,
1734 "Return list of keys that invoke DEFINITION.\n\
1735 If KEYMAP is non-nil, search only KEYMAP and the global keymap.\n\
1736 If KEYMAP is nil, search all the currently active keymaps.\n\
1738 If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,\n\
1739 rather than a list of all possible key sequences.\n\
1740 If FIRSTONLY is the symbol `non-ascii', return the first binding found,\n\
1741 no matter what it is.\n\
1742 If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters,\n\
1743 and entirely reject menu bindings.\n\
1745 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections\n\
1746 to other keymaps or slots. This makes it possible to search for an\n\
1747 indirect definition itself.")
1748 (definition
, keymap
, firstonly
, noindirect
)
1749 Lisp_Object definition
, keymap
;
1750 Lisp_Object firstonly
, noindirect
;
1753 Lisp_Object found
, sequence
;
1754 int keymap_specified
= !NILP (keymap
);
1755 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
1756 /* 1 means ignore all menu bindings entirely. */
1757 int nomenus
= !NILP (firstonly
) && !EQ (firstonly
, Qnon_ascii
);
1759 if (! keymap_specified
)
1761 #ifdef USE_TEXT_PROPERTIES
1762 keymap
= get_local_map (PT
, current_buffer
);
1764 keymap
= current_buffer
->keymap
;
1769 maps
= nconc2 (Faccessible_keymaps (get_keymap (keymap
), Qnil
),
1770 Faccessible_keymaps (get_keymap (current_global_map
),
1773 maps
= Faccessible_keymaps (get_keymap (current_global_map
), Qnil
);
1775 /* Put the minor mode keymaps on the front. */
1776 if (! keymap_specified
)
1779 minors
= Fnreverse (Fcurrent_minor_mode_maps ());
1780 while (!NILP (minors
))
1782 maps
= nconc2 (Faccessible_keymaps (get_keymap (XCONS (minors
)->car
),
1785 minors
= XCONS (minors
)->cdr
;
1789 GCPRO5 (definition
, keymap
, maps
, found
, sequence
);
1793 for (; !NILP (maps
); maps
= Fcdr (maps
))
1795 /* Key sequence to reach map, and the map that it reaches */
1796 register Lisp_Object
this, map
;
1798 /* If Fcar (map) is a VECTOR, the current element within that vector. */
1801 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
1802 [M-CHAR] sequences, check if last character of the sequence
1803 is the meta-prefix char. */
1807 this = Fcar (Fcar (maps
));
1808 map
= Fcdr (Fcar (maps
));
1809 last
= make_number (XINT (Flength (this)) - 1);
1810 last_is_meta
= (XINT (last
) >= 0
1811 && EQ (Faref (this, last
), meta_prefix_char
));
1817 /* Because the code we want to run on each binding is rather
1818 large, we don't want to have two separate loop bodies for
1819 sparse keymap bindings and tables; we want to iterate one
1820 loop body over both keymap and vector bindings.
1822 For this reason, if Fcar (map) is a vector, we don't
1823 advance map to the next element until i indicates that we
1824 have finished off the vector. */
1826 Lisp_Object elt
, key
, binding
;
1827 elt
= XCONS (map
)->car
;
1831 /* Set key and binding to the current key and binding, and
1832 advance map and i to the next binding. */
1835 /* In a vector, look at each element. */
1836 binding
= XVECTOR (elt
)->contents
[i
];
1837 XSETFASTINT (key
, i
);
1840 /* If we've just finished scanning a vector, advance map
1841 to the next element, and reset i in anticipation of the
1842 next vector we may find. */
1843 if (i
>= XVECTOR (elt
)->size
)
1845 map
= XCONS (map
)->cdr
;
1849 else if (CONSP (elt
))
1851 key
= Fcar (Fcar (map
));
1852 binding
= Fcdr (Fcar (map
));
1854 map
= XCONS (map
)->cdr
;
1857 /* We want to ignore keymap elements that are neither
1858 vectors nor conses. */
1860 map
= XCONS (map
)->cdr
;
1864 /* Search through indirections unless that's not wanted. */
1865 if (NILP (noindirect
))
1871 Lisp_Object map
, tem
;
1872 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
1873 map
= get_keymap_1 (Fcar_safe (definition
), 0, 0);
1874 tem
= Fkeymapp (map
);
1876 definition
= access_keymap (map
, Fcdr (definition
), 0, 0);
1880 /* If the contents are (STRING ...), reject. */
1881 if (CONSP (definition
)
1882 && STRINGP (XCONS (definition
)->car
))
1886 binding
= get_keyelt (binding
, 0);
1889 /* End this iteration if this element does not match
1892 if (CONSP (definition
))
1895 tem
= Fequal (binding
, definition
);
1900 if (!EQ (binding
, definition
))
1903 /* We have found a match.
1904 Construct the key sequence where we found it. */
1905 if (INTEGERP (key
) && last_is_meta
)
1907 sequence
= Fcopy_sequence (this);
1908 Faset (sequence
, last
, make_number (XINT (key
) | meta_modifier
));
1911 sequence
= append_key (this, key
);
1913 /* Verify that this key binding is not shadowed by another
1914 binding for the same key, before we say it exists.
1916 Mechanism: look for local definition of this key and if
1917 it is defined and does not match what we found then
1920 Either nil or number as value from Flookup_key
1922 if (keymap_specified
)
1924 binding
= Flookup_key (keymap
, sequence
, Qnil
);
1925 if (!NILP (binding
) && !INTEGERP (binding
))
1927 if (CONSP (definition
))
1930 tem
= Fequal (binding
, definition
);
1935 if (!EQ (binding
, definition
))
1941 binding
= Fkey_binding (sequence
, Qnil
);
1942 if (!EQ (binding
, definition
))
1946 /* It is a true unshadowed match. Record it, unless it's already
1947 been seen (as could happen when inheriting keymaps). */
1948 if (NILP (Fmember (sequence
, found
)))
1949 found
= Fcons (sequence
, found
);
1951 /* If firstonly is Qnon_ascii, then we can return the first
1952 binding we find. If firstonly is not Qnon_ascii but not
1953 nil, then we should return the first ascii-only binding
1955 if (EQ (firstonly
, Qnon_ascii
))
1956 RETURN_UNGCPRO (sequence
);
1957 else if (! NILP (firstonly
) && ascii_sequence_p (sequence
))
1958 RETURN_UNGCPRO (sequence
);
1964 found
= Fnreverse (found
);
1966 /* firstonly may have been t, but we may have gone all the way through
1967 the keymaps without finding an all-ASCII key sequence. So just
1968 return the best we could find. */
1969 if (! NILP (firstonly
))
1970 return Fcar (found
);
1975 /* describe-bindings - summarizing all the bindings in a set of keymaps. */
1977 DEFUN ("describe-bindings", Fdescribe_bindings
, Sdescribe_bindings
, 0, 1, "",
1978 "Show a list of all defined keys, and their definitions.\n\
1979 The list is put in a buffer, which is displayed.\n\
1980 An optional argument PREFIX, if non-nil, should be a key sequence;\n\
1981 then we display only bindings that start with that prefix.")
1985 register Lisp_Object thisbuf
;
1986 XSETBUFFER (thisbuf
, current_buffer
);
1987 internal_with_output_to_temp_buffer ("*Help*",
1988 describe_buffer_bindings
,
1989 Fcons (thisbuf
, prefix
));
1993 /* ARG is (BUFFER . PREFIX). */
1996 describe_buffer_bindings (arg
)
1999 Lisp_Object descbuf
, prefix
, shadow
;
2000 register Lisp_Object start1
;
2001 struct gcpro gcpro1
;
2003 char *alternate_heading
2005 Alternate Characters (use anywhere the nominal character is listed):\n\
2006 nominal alternate\n\
2007 ------- ---------\n";
2009 descbuf
= XCONS (arg
)->car
;
2010 prefix
= XCONS (arg
)->cdr
;
2014 Fset_buffer (Vstandard_output
);
2016 /* Report on alternates for keys. */
2017 if (STRINGP (Vkeyboard_translate_table
) && !NILP (prefix
))
2020 unsigned char *translate
= XSTRING (Vkeyboard_translate_table
)->data
;
2021 int translate_len
= XSTRING (Vkeyboard_translate_table
)->size
;
2023 for (c
= 0; c
< translate_len
; c
++)
2024 if (translate
[c
] != c
)
2029 if (alternate_heading
)
2031 insert_string (alternate_heading
);
2032 alternate_heading
= 0;
2035 bufend
= push_key_description (translate
[c
], buf
);
2036 insert (buf
, bufend
- buf
);
2037 Findent_to (make_number (16), make_number (1));
2038 bufend
= push_key_description (c
, buf
);
2039 insert (buf
, bufend
- buf
);
2047 if (!NILP (Vkey_translation_map
))
2048 describe_map_tree (Vkey_translation_map
, 0, Qnil
, prefix
,
2049 "Key translations", 0, 1, 0);
2053 Lisp_Object
*modes
, *maps
;
2055 /* Temporarily switch to descbuf, so that we can get that buffer's
2056 minor modes correctly. */
2057 Fset_buffer (descbuf
);
2059 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
2060 || !NILP (Voverriding_local_map
))
2063 nmaps
= current_minor_maps (&modes
, &maps
);
2064 Fset_buffer (Vstandard_output
);
2066 /* Print the minor mode maps. */
2067 for (i
= 0; i
< nmaps
; i
++)
2069 /* The title for a minor mode keymap
2070 is constructed at run time.
2071 We let describe_map_tree do the actual insertion
2072 because it takes care of other features when doing so. */
2075 if (!SYMBOLP (modes
[i
]))
2078 p
= title
= (char *) alloca (40 + XSYMBOL (modes
[i
])->name
->size
);
2080 bcopy (XSYMBOL (modes
[i
])->name
->data
, p
,
2081 XSYMBOL (modes
[i
])->name
->size
);
2082 p
+= XSYMBOL (modes
[i
])->name
->size
;
2084 bcopy (" Minor Mode Bindings", p
, sizeof (" Minor Mode Bindings") - 1);
2085 p
+= sizeof (" Minor Mode Bindings") - 1;
2088 describe_map_tree (maps
[i
], 1, shadow
, prefix
, title
, 0, 0, 0);
2089 shadow
= Fcons (maps
[i
], shadow
);
2093 /* Print the (major mode) local map. */
2094 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
2095 start1
= current_kboard
->Voverriding_terminal_local_map
;
2096 else if (!NILP (Voverriding_local_map
))
2097 start1
= Voverriding_local_map
;
2099 start1
= XBUFFER (descbuf
)->keymap
;
2103 describe_map_tree (start1
, 1, shadow
, prefix
,
2104 "Major Mode Bindings", 0, 0, 0);
2105 shadow
= Fcons (start1
, shadow
);
2108 describe_map_tree (current_global_map
, 1, shadow
, prefix
,
2109 "Global Bindings", 0, 0, 1);
2111 /* Print the function-key-map translations under this prefix. */
2112 if (!NILP (Vfunction_key_map
))
2113 describe_map_tree (Vfunction_key_map
, 0, Qnil
, prefix
,
2114 "Function key map translations", 0, 1, 0);
2116 call0 (intern ("help-mode"));
2117 Fset_buffer (descbuf
);
2122 /* Insert a description of the key bindings in STARTMAP,
2123 followed by those of all maps reachable through STARTMAP.
2124 If PARTIAL is nonzero, omit certain "uninteresting" commands
2125 (such as `undefined').
2126 If SHADOW is non-nil, it is a list of maps;
2127 don't mention keys which would be shadowed by any of them.
2128 PREFIX, if non-nil, says mention only keys that start with PREFIX.
2129 TITLE, if not 0, is a string to insert at the beginning.
2130 TITLE should not end with a colon or a newline; we supply that.
2131 If NOMENU is not 0, then omit menu-bar commands.
2133 If TRANSL is nonzero, the definitions are actually key translations
2134 so print strings and vectors differently.
2136 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2140 describe_map_tree (startmap
, partial
, shadow
, prefix
, title
, nomenu
, transl
,
2142 Lisp_Object startmap
, shadow
, prefix
;
2149 Lisp_Object maps
, seen
, sub_shadows
;
2150 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2157 maps
= Faccessible_keymaps (startmap
, prefix
);
2160 GCPRO3 (maps
, seen
, sub_shadows
);
2166 /* Delete from MAPS each element that is for the menu bar. */
2167 for (list
= maps
; !NILP (list
); list
= XCONS (list
)->cdr
)
2169 Lisp_Object elt
, prefix
, tem
;
2172 prefix
= Fcar (elt
);
2173 if (XVECTOR (prefix
)->size
>= 1)
2175 tem
= Faref (prefix
, make_number (0));
2176 if (EQ (tem
, Qmenu_bar
))
2177 maps
= Fdelq (elt
, maps
);
2182 if (!NILP (maps
) || always_title
)
2186 insert_string (title
);
2189 insert_string (" Starting With ");
2190 insert1 (Fkey_description (prefix
));
2192 insert_string (":\n");
2194 insert_string (key_heading
);
2198 for (; !NILP (maps
); maps
= Fcdr (maps
))
2200 register Lisp_Object elt
, prefix
, tail
;
2203 prefix
= Fcar (elt
);
2207 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2211 shmap
= XCONS (tail
)->car
;
2213 /* If the sequence by which we reach this keymap is zero-length,
2214 then the shadow map for this keymap is just SHADOW. */
2215 if ((STRINGP (prefix
) && XSTRING (prefix
)->size
== 0)
2216 || (VECTORP (prefix
) && XVECTOR (prefix
)->size
== 0))
2218 /* If the sequence by which we reach this keymap actually has
2219 some elements, then the sequence's definition in SHADOW is
2220 what we should use. */
2223 shmap
= Flookup_key (shmap
, Fcar (elt
), Qt
);
2224 if (INTEGERP (shmap
))
2228 /* If shmap is not nil and not a keymap,
2229 it completely shadows this map, so don't
2230 describe this map at all. */
2231 if (!NILP (shmap
) && NILP (Fkeymapp (shmap
)))
2235 sub_shadows
= Fcons (shmap
, sub_shadows
);
2238 describe_map (Fcdr (elt
), Fcar (elt
),
2239 transl
? describe_translation
: describe_command
,
2240 partial
, sub_shadows
, &seen
, nomenu
);
2246 insert_string ("\n");
2251 static int previous_description_column
;
2254 describe_command (definition
)
2255 Lisp_Object definition
;
2257 register Lisp_Object tem1
;
2258 int column
= current_column ();
2259 int description_column
;
2261 /* If column 16 is no good, go to col 32;
2262 but don't push beyond that--go to next line instead. */
2266 description_column
= 32;
2268 else if (column
> 14 || (column
> 10 && previous_description_column
== 32))
2269 description_column
= 32;
2271 description_column
= 16;
2273 Findent_to (make_number (description_column
), make_number (1));
2274 previous_description_column
= description_column
;
2276 if (SYMBOLP (definition
))
2278 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2280 insert_string ("\n");
2282 else if (STRINGP (definition
) || VECTORP (definition
))
2283 insert_string ("Keyboard Macro\n");
2286 tem1
= Fkeymapp (definition
);
2288 insert_string ("Prefix Command\n");
2290 insert_string ("??\n");
2295 describe_translation (definition
)
2296 Lisp_Object definition
;
2298 register Lisp_Object tem1
;
2300 Findent_to (make_number (16), make_number (1));
2302 if (SYMBOLP (definition
))
2304 XSETSTRING (tem1
, XSYMBOL (definition
)->name
);
2306 insert_string ("\n");
2308 else if (STRINGP (definition
) || VECTORP (definition
))
2310 insert1 (Fkey_description (definition
));
2311 insert_string ("\n");
2315 tem1
= Fkeymapp (definition
);
2317 insert_string ("Prefix Command\n");
2319 insert_string ("??\n");
2323 /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2324 Returns the first non-nil binding found in any of those maps. */
2327 shadow_lookup (shadow
, key
, flag
)
2328 Lisp_Object shadow
, key
, flag
;
2330 Lisp_Object tail
, value
;
2332 for (tail
= shadow
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2334 value
= Flookup_key (XCONS (tail
)->car
, key
, flag
);
2341 /* Describe the contents of map MAP, assuming that this map itself is
2342 reached by the sequence of prefix keys KEYS (a string or vector).
2343 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
2346 describe_map (map
, keys
, elt_describer
, partial
, shadow
, seen
, nomenu
)
2347 register Lisp_Object map
;
2349 int (*elt_describer
) ();
2355 Lisp_Object elt_prefix
;
2356 Lisp_Object tail
, definition
, event
;
2358 Lisp_Object suppress
;
2361 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2363 if (!NILP (keys
) && XFASTINT (Flength (keys
)) > 0)
2365 /* Call Fkey_description first, to avoid GC bug for the other string. */
2366 tem
= Fkey_description (keys
);
2367 elt_prefix
= concat2 (tem
, build_string (" "));
2373 suppress
= intern ("suppress-keymap");
2375 /* This vector gets used to present single keys to Flookup_key. Since
2376 that is done once per keymap element, we don't want to cons up a
2377 fresh vector every time. */
2378 kludge
= Fmake_vector (make_number (1), Qnil
);
2381 GCPRO3 (elt_prefix
, definition
, kludge
);
2383 for (tail
= map
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
2387 if (VECTORP (XCONS (tail
)->car
))
2388 describe_vector (XCONS (tail
)->car
,
2389 elt_prefix
, elt_describer
, partial
, shadow
, map
);
2390 else if (CONSP (XCONS (tail
)->car
))
2392 event
= XCONS (XCONS (tail
)->car
)->car
;
2394 /* Ignore bindings whose "keys" are not really valid events.
2395 (We get these in the frames and buffers menu.) */
2396 if (! (SYMBOLP (event
) || INTEGERP (event
)))
2399 if (nomenu
&& EQ (event
, Qmenu_bar
))
2402 definition
= get_keyelt (XCONS (XCONS (tail
)->car
)->cdr
, 0);
2404 /* Don't show undefined commands or suppressed commands. */
2405 if (NILP (definition
)) continue;
2406 if (SYMBOLP (definition
) && partial
)
2408 tem
= Fget (definition
, suppress
);
2413 /* Don't show a command that isn't really visible
2414 because a local definition of the same key shadows it. */
2416 XVECTOR (kludge
)->contents
[0] = event
;
2419 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2420 if (!NILP (tem
)) continue;
2423 tem
= Flookup_key (map
, kludge
, Qt
);
2424 if (! EQ (tem
, definition
)) continue;
2428 previous_description_column
= 0;
2433 if (!NILP (elt_prefix
))
2434 insert1 (elt_prefix
);
2436 /* THIS gets the string to describe the character EVENT. */
2437 insert1 (Fsingle_key_description (event
));
2439 /* Print a description of the definition of this character.
2440 elt_describer will take care of spacing out far enough
2441 for alignment purposes. */
2442 (*elt_describer
) (definition
);
2444 else if (EQ (XCONS (tail
)->car
, Qkeymap
))
2446 /* The same keymap might be in the structure twice, if we're
2447 using an inherited keymap. So skip anything we've already
2449 tem
= Fassq (tail
, *seen
);
2450 if (CONSP (tem
) && !NILP (Fequal (XCONS (tem
)->car
, keys
)))
2452 *seen
= Fcons (Fcons (tail
, keys
), *seen
);
2460 describe_vector_princ (elt
)
2463 Findent_to (make_number (16), make_number (1));
2468 DEFUN ("describe-vector", Fdescribe_vector
, Sdescribe_vector
, 1, 1, 0,
2469 "Insert a description of contents of VECTOR.\n\
2470 This is text showing the elements of vector matched against indices.")
2474 int count
= specpdl_ptr
- specpdl
;
2476 specbind (Qstandard_output
, Fcurrent_buffer ());
2477 CHECK_VECTOR_OR_CHAR_TABLE (vector
, 0);
2478 describe_vector (vector
, Qnil
, describe_vector_princ
, 0, Qnil
, Qnil
);
2480 return unbind_to (count
, Qnil
);
2483 /* Insert in the current buffer a description of the contents of VECTOR.
2484 We call ELT_DESCRIBER to insert the description of one value found
2487 ELT_PREFIX describes what "comes before" the keys or indices defined
2490 If the vector is in a keymap, ELT_PREFIX is a prefix key which
2491 leads to this keymap.
2493 If the vector is a chartable, ELT_PREFIX is the vector
2494 of bytes that lead to the character set or portion of a character
2495 set described by this chartable.
2497 If PARTIAL is nonzero, it means do not mention suppressed commands
2498 (that assumes the vector is in a keymap).
2500 SHADOW is a list of keymaps that shadow this map.
2501 If it is non-nil, then we look up the key in those maps
2502 and we don't mention it now if it is defined by any of them.
2504 ENTIRE_MAP is the keymap in which this vector appears.
2505 If the definition in effect in the whole map does not match
2506 the one in this vector, we ignore this one. */
2508 describe_vector (vector
, elt_prefix
, elt_describer
,
2509 partial
, shadow
, entire_map
)
2510 register Lisp_Object vector
;
2511 Lisp_Object elt_prefix
;
2512 int (*elt_describer
) ();
2515 Lisp_Object entire_map
;
2518 Lisp_Object definition
;
2521 Lisp_Object suppress
;
2523 Lisp_Object chartable_kludge
;
2525 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2526 /* Range of elements to be handled. */
2528 /* The current depth of VECTOR if it is char-table. */
2530 /* Flag to tell if we should handle multibyte characters. */
2531 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
2532 /* Array of indices to access each level of char-table.
2533 The elements are charset, code1, and code2. */
2535 /* A flag to tell if a leaf in this level of char-table is not a
2536 generic character (i.e. a complete multibyte character). */
2541 /* This vector gets used to present single keys to Flookup_key. Since
2542 that is done once per vector element, we don't want to cons up a
2543 fresh vector every time. */
2544 kludge
= Fmake_vector (make_number (1), Qnil
);
2545 GCPRO4 (elt_prefix
, definition
, kludge
, chartable_kludge
);
2548 suppress
= intern ("suppress-keymap");
2550 if (CHAR_TABLE_P (vector
))
2552 /* Prepare for handling a nested char-table. */
2553 if (NILP (elt_prefix
))
2555 /* VECTOR is a top level char-table. */
2559 to
= CHAR_TABLE_ORDINARY_SLOTS
;
2563 /* VECTOR is a sub char-table. */
2564 this_level
= XVECTOR (elt_prefix
)->size
;
2565 if (this_level
>= 3)
2566 /* A char-table is not that deep. */
2567 error ("Too deep char table");
2569 /* For multibyte characters, the top level index for
2570 charsets starts from 256. */
2571 idx
[0] = XINT (XVECTOR (elt_prefix
)->contents
[0]) - 128;
2572 for (i
= 1; i
< this_level
; i
++)
2573 idx
[i
] = XINT (XVECTOR (elt_prefix
)->contents
[i
]);
2575 = (CHARSET_VALID_P (idx
[0])
2576 && ((CHARSET_DIMENSION (idx
[0]) == 1 && this_level
== 1)
2577 || this_level
== 2));
2579 /* Meaningful elements are from 32th to 127th. */
2581 to
= SUB_CHAR_TABLE_ORDINARY_SLOTS
;
2583 chartable_kludge
= Fmake_vector (make_number (this_level
+ 1), Qnil
);
2584 if (this_level
!= 0)
2585 bcopy (XVECTOR (elt_prefix
)->contents
,
2586 XVECTOR (chartable_kludge
)->contents
,
2587 this_level
* sizeof (Lisp_Object
));
2593 /* This does the right thing for ordinary vectors. */
2594 to
= XFASTINT (Flength (vector
));
2595 /* Now, can this be just `XVECTOR (vector)->size'? -- K.Handa */
2598 for (i
= from
; i
< to
; i
++)
2602 if (CHAR_TABLE_P (vector
))
2604 if (i
>= CHAR_TABLE_SINGLE_BYTE_SLOTS
2605 && !CHARSET_DEFINED_P (i
- 128))
2607 definition
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
]);
2608 if (NILP (definition
)) continue;
2611 definition
= get_keyelt (XVECTOR (vector
)->contents
[i
], 0);
2613 /* Don't mention suppressed commands. */
2614 if (SYMBOLP (definition
) && partial
)
2618 tem
= Fget (definition
, suppress
);
2620 if (!NILP (tem
)) continue;
2623 /* If this binding is shadowed by some other map, ignore it. */
2628 XVECTOR (kludge
)->contents
[0] = make_number (i
);
2629 tem
= shadow_lookup (shadow
, kludge
, Qt
);
2631 if (!NILP (tem
)) continue;
2634 /* Ignore this definition if it is shadowed by an earlier
2635 one in the same keymap. */
2636 if (!NILP (entire_map
))
2640 XVECTOR (kludge
)->contents
[0] = make_number (i
);
2641 tem
= Flookup_key (entire_map
, kludge
, Qt
);
2643 if (! EQ (tem
, definition
))
2649 if (this_level
== 0)
2654 /* If VECTOR is a sub char-table, show the depth by indentation.
2655 THIS_LEVEL can be greater than 0 only for char-table. */
2657 insert (" ", this_level
* 2); /* THIS_LEVEL is 1 or 2. */
2659 /* Get a Lisp object for the character I. */
2660 XSETFASTINT (dummy
, i
);
2662 if (this_level
== 0 && CHAR_TABLE_P (vector
))
2664 if (i
< CHAR_TABLE_SINGLE_BYTE_SLOTS
)
2665 insert1 (Fsingle_key_description (dummy
));
2668 /* Print the information for this character set. */
2669 insert_string ("<");
2670 tem2
= CHARSET_TABLE_INFO (i
- 128, CHARSET_SHORT_NAME_IDX
);
2672 insert_from_string (tem2
, 0 , XSTRING (tem2
)->size
, 0);
2678 else if (this_level
> 0 && SUB_CHAR_TABLE_P (vector
))
2682 /* Combine ELT_PREFIX with I to produce a character code,
2683 then insert that character's description. */
2684 idx
[this_level
] = i
;
2685 insert_char (MAKE_NON_ASCII_CHAR (idx
[0], idx
[1], idx
[2]));
2689 /* We need an octal representation for this block of
2692 sprintf (work
, "\\%03o", i
& 255);
2698 /* Output the prefix that applies to every entry in this map. */
2699 if (!NILP (elt_prefix
))
2700 insert1 (elt_prefix
);
2702 /* Get the string to describe the character DUMMY, and print it. */
2703 insert1 (Fsingle_key_description (dummy
));
2706 /* If we find a sub char-table within a char-table,
2707 scan it recursively; it defines the details for
2708 a character set or a portion of a character set. */
2709 if (multibyte
&& CHAR_TABLE_P (vector
) && SUB_CHAR_TABLE_P (definition
))
2712 XVECTOR (chartable_kludge
)->contents
[this_level
] = make_number (i
);
2713 describe_vector (definition
, chartable_kludge
, elt_describer
,
2714 partial
, shadow
, entire_map
);
2718 /* Find all consecutive characters that have the same
2719 definition. But, for elements of a top level char table, if
2720 they are for charsets, we had better describe one by one even
2721 if they have the same definition. */
2722 if (CHAR_TABLE_P (vector
))
2724 if (this_level
== 0)
2725 while (i
+ 1 < CHAR_TABLE_SINGLE_BYTE_SLOTS
2727 = get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
2729 && !NILP (Fequal (tem2
, definition
)))
2733 && (tem2
= get_keyelt (XCHAR_TABLE (vector
)->contents
[i
+ 1], 0),
2735 && !NILP (Fequal (tem2
, definition
)))
2739 while (i
+ 1 < CHAR_TABLE_SINGLE_BYTE_SLOTS
2740 && (tem2
= get_keyelt (XVECTOR (vector
)->contents
[i
+ 1], 0),
2742 && !NILP (Fequal (tem2
, definition
)))
2746 /* If we have a range of more than one character,
2747 print where the range reaches to. */
2749 if (i
!= XINT (dummy
))
2752 if (CHAR_TABLE_P (vector
))
2756 idx
[this_level
] = i
;
2757 insert_char (MAKE_NON_ASCII_CHAR (idx
[0], idx
[1], idx
[2]));
2759 else if (this_level
> 0)
2762 sprintf (work
, "\\%03o", i
& 255);
2767 XSETFASTINT (dummy
, i
);
2768 insert1 (Fsingle_key_description (dummy
));
2773 if (!NILP (elt_prefix
) && !CHAR_TABLE_P (vector
))
2774 insert1 (elt_prefix
);
2776 XSETFASTINT (dummy
, i
);
2777 insert1 (Fsingle_key_description (dummy
));
2781 /* Print a description of the definition of this character.
2782 elt_describer will take care of spacing out far enough
2783 for alignment purposes. */
2784 (*elt_describer
) (definition
);
2787 /* For (sub) char-table, print `defalt' slot at last. */
2788 if (CHAR_TABLE_P (vector
) && !NILP (XCHAR_TABLE (vector
)->defalt
))
2790 insert (" ", this_level
* 2);
2791 insert_string ("<<default>>");
2792 (*elt_describer
) (XCHAR_TABLE (vector
)->defalt
);
2798 /* Apropos - finding all symbols whose names match a regexp. */
2799 Lisp_Object apropos_predicate
;
2800 Lisp_Object apropos_accumulate
;
2803 apropos_accum (symbol
, string
)
2804 Lisp_Object symbol
, string
;
2806 register Lisp_Object tem
;
2808 tem
= Fstring_match (string
, Fsymbol_name (symbol
), Qnil
);
2809 if (!NILP (tem
) && !NILP (apropos_predicate
))
2810 tem
= call1 (apropos_predicate
, symbol
);
2812 apropos_accumulate
= Fcons (symbol
, apropos_accumulate
);
2815 DEFUN ("apropos-internal", Fapropos_internal
, Sapropos_internal
, 1, 2, 0,
2816 "Show all symbols whose names contain match for REGEXP.\n\
2817 If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done\n\
2818 for each symbol and a symbol is mentioned only if that returns non-nil.\n\
2819 Return list of symbols found.")
2821 Lisp_Object regexp
, predicate
;
2823 struct gcpro gcpro1
, gcpro2
;
2824 CHECK_STRING (regexp
, 0);
2825 apropos_predicate
= predicate
;
2826 GCPRO2 (apropos_predicate
, apropos_accumulate
);
2827 apropos_accumulate
= Qnil
;
2828 map_obarray (Vobarray
, apropos_accum
, regexp
);
2829 apropos_accumulate
= Fsort (apropos_accumulate
, Qstring_lessp
);
2831 return apropos_accumulate
;
2838 Qkeymap
= intern ("keymap");
2839 staticpro (&Qkeymap
);
2841 /* Initialize the keymaps standardly used.
2842 Each one is the value of a Lisp variable, and is also
2843 pointed to by a C variable */
2845 global_map
= Fcons (Qkeymap
,
2846 Fcons (Fmake_vector (make_number (0400), Qnil
), Qnil
));
2847 Fset (intern ("global-map"), global_map
);
2849 current_global_map
= global_map
;
2850 staticpro (&global_map
);
2851 staticpro (¤t_global_map
);
2853 meta_map
= Fmake_keymap (Qnil
);
2854 Fset (intern ("esc-map"), meta_map
);
2855 Ffset (intern ("ESC-prefix"), meta_map
);
2857 control_x_map
= Fmake_keymap (Qnil
);
2858 Fset (intern ("ctl-x-map"), control_x_map
);
2859 Ffset (intern ("Control-X-prefix"), control_x_map
);
2861 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands
,
2862 "List of commands given new key bindings recently.\n\
2863 This is used for internal purposes during Emacs startup;\n\
2864 don't alter it yourself.");
2865 Vdefine_key_rebound_commands
= Qt
;
2867 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map
,
2868 "Default keymap to use when reading from the minibuffer.");
2869 Vminibuffer_local_map
= Fmake_sparse_keymap (Qnil
);
2871 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map
,
2872 "Local keymap for the minibuffer when spaces are not allowed.");
2873 Vminibuffer_local_ns_map
= Fmake_sparse_keymap (Qnil
);
2875 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map
,
2876 "Local keymap for minibuffer input with completion.");
2877 Vminibuffer_local_completion_map
= Fmake_sparse_keymap (Qnil
);
2879 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map
,
2880 "Local keymap for minibuffer input with completion, for exact match.");
2881 Vminibuffer_local_must_match_map
= Fmake_sparse_keymap (Qnil
);
2883 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist
,
2884 "Alist of keymaps to use for minor modes.\n\
2885 Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read\n\
2886 key sequences and look up bindings iff VARIABLE's value is non-nil.\n\
2887 If two active keymaps bind the same key, the keymap appearing earlier\n\
2888 in the list takes precedence.");
2889 Vminor_mode_map_alist
= Qnil
;
2891 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
2892 "Keymap mapping ASCII function key sequences onto their preferred forms.\n\
2893 This allows Emacs to recognize function keys sent from ASCII\n\
2894 terminals at any point in a key sequence.\n\
2896 The `read-key-sequence' function replaces any subsequence bound by\n\
2897 `function-key-map' with its binding. More precisely, when the active\n\
2898 keymaps have no binding for the current key sequence but\n\
2899 `function-key-map' binds a suffix of the sequence to a vector or string,\n\
2900 `read-key-sequence' replaces the matching suffix with its binding, and\n\
2901 continues with the new sequence.\n\
2903 The events that come from bindings in `function-key-map' are not\n\
2904 themselves looked up in `function-key-map'.\n\
2906 For example, suppose `function-key-map' binds `ESC O P' to [f1].\n\
2907 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing\n\
2908 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix\n\
2909 key, typing `ESC O P x' would return [f1 x].");
2910 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
2912 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
2913 "Keymap of key translations that can override keymaps.\n\
2914 This keymap works like `function-key-map', but comes after that,\n\
2915 and applies even for keys that have ordinary bindings.");
2916 Vkey_translation_map
= Qnil
;
2918 Qsingle_key_description
= intern ("single-key-description");
2919 staticpro (&Qsingle_key_description
);
2921 Qkey_description
= intern ("key-description");
2922 staticpro (&Qkey_description
);
2924 Qkeymapp
= intern ("keymapp");
2925 staticpro (&Qkeymapp
);
2927 Qnon_ascii
= intern ("non-ascii");
2928 staticpro (&Qnon_ascii
);
2930 defsubr (&Skeymapp
);
2931 defsubr (&Skeymap_parent
);
2932 defsubr (&Sset_keymap_parent
);
2933 defsubr (&Smake_keymap
);
2934 defsubr (&Smake_sparse_keymap
);
2935 defsubr (&Scopy_keymap
);
2936 defsubr (&Skey_binding
);
2937 defsubr (&Slocal_key_binding
);
2938 defsubr (&Sglobal_key_binding
);
2939 defsubr (&Sminor_mode_key_binding
);
2940 defsubr (&Sdefine_key
);
2941 defsubr (&Slookup_key
);
2942 defsubr (&Sdefine_prefix_command
);
2943 defsubr (&Suse_global_map
);
2944 defsubr (&Suse_local_map
);
2945 defsubr (&Scurrent_local_map
);
2946 defsubr (&Scurrent_global_map
);
2947 defsubr (&Scurrent_minor_mode_maps
);
2948 defsubr (&Saccessible_keymaps
);
2949 defsubr (&Skey_description
);
2950 defsubr (&Sdescribe_vector
);
2951 defsubr (&Ssingle_key_description
);
2952 defsubr (&Stext_char_description
);
2953 defsubr (&Swhere_is_internal
);
2954 defsubr (&Sdescribe_bindings
);
2955 defsubr (&Sapropos_internal
);
2962 initial_define_key (global_map
, 033, "ESC-prefix");
2963 initial_define_key (global_map
, Ctl('X'), "Control-X-prefix");