Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-483
[bpt/emacs.git] / src / keymap.c
CommitLineData
2c6f1a39 1/* Manipulation of keymaps
9d209cfe 2 Copyright (C) 1985, 86,87,88,93,94,95,98,99, 2000, 01, 2004
11adc310 3 Free Software Foundation, Inc.
2c6f1a39
JB
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
502ddf23 9the Free Software Foundation; either version 2, or (at your option)
2c6f1a39
JB
10any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313
EN
19the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20Boston, MA 02111-1307, USA. */
2c6f1a39
JB
21
22
18160b98 23#include <config.h>
2c6f1a39 24#include <stdio.h>
2c6f1a39
JB
25#include "lisp.h"
26#include "commands.h"
27#include "buffer.h"
a98f1d1d 28#include "charset.h"
6bbbd9b0 29#include "keyboard.h"
6ba6e250 30#include "termhooks.h"
9ac0d9e0 31#include "blockinput.h"
d964248c 32#include "puresize.h"
93d2aa1c 33#include "intervals.h"
8feddab4 34#include "keymap.h"
2c6f1a39 35
f5b79c1c 36/* The number of elements in keymap vectors. */
2c6f1a39
JB
37#define DENSE_TABLE_SIZE (0200)
38
39/* Actually allocate storage for these variables */
40
41Lisp_Object current_global_map; /* Current global keymap */
42
43Lisp_Object global_map; /* default global key bindings */
44
45Lisp_Object meta_map; /* The keymap used for globally bound
46 ESC-prefixed default commands */
47
48Lisp_Object control_x_map; /* The keymap used for globally bound
49 C-x-prefixed default commands */
50
51/* was MinibufLocalMap */
52Lisp_Object Vminibuffer_local_map;
53 /* The keymap used by the minibuf for local
54 bindings when spaces are allowed in the
55 minibuf */
56
57/* was MinibufLocalNSMap */
d55627cc 58Lisp_Object Vminibuffer_local_ns_map;
2c6f1a39
JB
59 /* The keymap used by the minibuf for local
60 bindings when spaces are not encouraged
61 in the minibuf */
62
63/* keymap used for minibuffers when doing completion */
64/* was MinibufLocalCompletionMap */
65Lisp_Object Vminibuffer_local_completion_map;
66
67/* keymap used for minibuffers when doing completion and require a match */
68/* was MinibufLocalMustMatchMap */
69Lisp_Object Vminibuffer_local_must_match_map;
70
cc0a8174
JB
71/* Alist of minor mode variables and keymaps. */
72Lisp_Object Vminor_mode_map_alist;
73
dd9cda06
RS
74/* Alist of major-mode-specific overrides for
75 minor mode variables and keymaps. */
76Lisp_Object Vminor_mode_overriding_map_alist;
77
99cbcaca
KS
78/* List of emulation mode keymap alists. */
79Lisp_Object Vemulation_mode_map_alists;
80
6bbbd9b0
JB
81/* Keymap mapping ASCII function key sequences onto their preferred forms.
82 Initialized by the terminal-specific lisp files. See DEFVAR for more
83 documentation. */
84Lisp_Object Vfunction_key_map;
85
d7bf9bf5
RS
86/* Keymap mapping ASCII function key sequences onto their preferred forms. */
87Lisp_Object Vkey_translation_map;
88
107fd03d
RS
89/* A list of all commands given new bindings since a certain time
90 when nil was stored here.
91 This is used to speed up recomputation of menu key equivalents
92 when Emacs starts up. t means don't record anything here. */
93Lisp_Object Vdefine_key_rebound_commands;
94
a1df473f 95Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
2c6f1a39 96
ade19cac
RS
97/* Alist of elements like (DEL . "\d"). */
98static Lisp_Object exclude_keys;
99
023b93f6
KS
100/* Pre-allocated 2-element vector for Fcommand_remapping to use. */
101static Lisp_Object command_remapping_vector;
a1df473f 102
3d248688
JB
103/* A char with the CHAR_META bit set in a vector or the 0200 bit set
104 in a string key sequence is equivalent to prefixing with this
105 character. */
2c6f1a39
JB
106extern Lisp_Object meta_prefix_char;
107
7d92e329
RS
108extern Lisp_Object Voverriding_local_map;
109
1e7d1ab0
SM
110/* Hash table used to cache a reverse-map to speed up calls to where-is. */
111static Lisp_Object where_is_cache;
112/* Which keymaps are reverse-stored in the cache. */
113static Lisp_Object where_is_cache_keymaps;
114
57495396
SM
115static Lisp_Object store_in_keymap P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
116static void fix_submap_inheritance P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
117
118static Lisp_Object define_as_prefix P_ ((Lisp_Object, Lisp_Object));
d55627cc
SM
119static void describe_command P_ ((Lisp_Object, Lisp_Object));
120static void describe_translation P_ ((Lisp_Object, Lisp_Object));
57495396 121static void describe_map P_ ((Lisp_Object, Lisp_Object,
d55627cc 122 void (*) P_ ((Lisp_Object, Lisp_Object)),
57495396 123 int, Lisp_Object, Lisp_Object*, int));
f8d8ba40
KS
124static void describe_vector P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
125 void (*) (Lisp_Object, Lisp_Object), int,
126 Lisp_Object, Lisp_Object, int *, int, int));
15fff01d 127static void silly_event_symbol_error P_ ((Lisp_Object));
2c6f1a39 128\f
cc0a8174
JB
129/* Keymap object support - constructors and predicates. */
130
ce6e5d0b 131DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
335c5470
PJ
132 doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
133CHARTABLE is a char-table that holds the bindings for the ASCII
134characters. ALIST is an assoc-list which holds bindings for function keys,
135mouse events, and any other things that appear in the input stream.
136All entries in it are initially nil, meaning "command undefined".
137
138The optional arg STRING supplies a menu name for the keymap
139in case you use it as a menu with `x-popup-menu'. */)
140 (string)
ce6e5d0b 141 Lisp_Object string;
2c6f1a39 142{
ce6e5d0b
RS
143 Lisp_Object tail;
144 if (!NILP (string))
145 tail = Fcons (string, Qnil);
146 else
147 tail = Qnil;
2c6f1a39 148 return Fcons (Qkeymap,
0403641f 149 Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
2c6f1a39
JB
150}
151
ce6e5d0b 152DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
335c5470
PJ
153 doc: /* Construct and return a new sparse keymap.
154Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
155which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
156which binds the function key or mouse event SYMBOL to DEFINITION.
157Initially the alist is nil.
158
159The optional arg STRING supplies a menu name for the keymap
160in case you use it as a menu with `x-popup-menu'. */)
161 (string)
ce6e5d0b 162 Lisp_Object string;
2c6f1a39 163{
ce6e5d0b
RS
164 if (!NILP (string))
165 return Fcons (Qkeymap, Fcons (string, Qnil));
2c6f1a39
JB
166 return Fcons (Qkeymap, Qnil);
167}
168
169/* This function is used for installing the standard key bindings
170 at initialization time.
171
172 For example:
173
e25c4e44 174 initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */
2c6f1a39
JB
175
176void
177initial_define_key (keymap, key, defname)
178 Lisp_Object keymap;
179 int key;
180 char *defname;
181{
182 store_in_keymap (keymap, make_number (key), intern (defname));
183}
184
e25c4e44
JB
185void
186initial_define_lispy_key (keymap, keyname, defname)
187 Lisp_Object keymap;
188 char *keyname;
189 char *defname;
190{
191 store_in_keymap (keymap, intern (keyname), intern (defname));
192}
193
2c6f1a39 194DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
335c5470
PJ
195 doc: /* Return t if OBJECT is a keymap.
196
197A keymap is a list (keymap . ALIST),
198or a symbol whose function definition is itself a keymap.
199ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
200a vector of densely packed bindings for small character codes
201is also allowed as an element. */)
202 (object)
2c6f1a39
JB
203 Lisp_Object object;
204{
02067692 205 return (KEYMAPP (object) ? Qt : Qnil);
2c6f1a39
JB
206}
207
54cbc3d4 208DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
335c5470
PJ
209 doc: /* Return the prompt-string of a keymap MAP.
210If non-nil, the prompt is shown in the echo-area
211when reading a key-sequence to be looked-up in this keymap. */)
212 (map)
54cbc3d4
SM
213 Lisp_Object map;
214{
215 while (CONSP (map))
216 {
217 register Lisp_Object tem;
218 tem = Fcar (map);
219 if (STRINGP (tem))
220 return tem;
221 map = Fcdr (map);
222 }
223 return Qnil;
224}
225
2c6f1a39 226/* Check that OBJECT is a keymap (after dereferencing through any
d09b2024
JB
227 symbols). If it is, return it.
228
229 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
230 is an autoload form, do the autoload and try again.
21a0d7a0 231 If AUTOLOAD is nonzero, callers must assume GC is possible.
d09b2024 232
02067692
SM
233 If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
234 is zero as well), return Qt.
235
d09b2024
JB
236 ERROR controls how we respond if OBJECT isn't a keymap.
237 If ERROR is non-zero, signal an error; otherwise, just return Qnil.
238
239 Note that most of the time, we don't want to pursue autoloads.
240 Functions like Faccessible_keymaps which scan entire keymap trees
241 shouldn't load every autoloaded keymap. I'm not sure about this,
242 but it seems to me that only read_key_sequence, Flookup_key, and
df75b1a3
GM
243 Fdefine_key should cause keymaps to be autoloaded.
244
245 This function can GC when AUTOLOAD is non-zero, because it calls
246 do_autoload which can GC. */
d09b2024 247
2c6f1a39 248Lisp_Object
02067692 249get_keymap (object, error, autoload)
2c6f1a39 250 Lisp_Object object;
d09b2024 251 int error, autoload;
2c6f1a39 252{
d09b2024 253 Lisp_Object tem;
2c6f1a39 254
d09b2024 255 autoload_retry:
b1314e15
KH
256 if (NILP (object))
257 goto end;
258 if (CONSP (object) && EQ (XCAR (object), Qkeymap))
259 return object;
f5b79c1c 260
02067692
SM
261 tem = indirect_function (object);
262 if (CONSP (tem))
d09b2024 263 {
02067692
SM
264 if (EQ (XCAR (tem), Qkeymap))
265 return tem;
d09b2024 266
02067692
SM
267 /* Should we do an autoload? Autoload forms for keymaps have
268 Qkeymap as their fifth element. */
269 if ((autoload || !error) && EQ (XCAR (tem), Qautoload))
8e4dfd54 270 {
02067692 271 Lisp_Object tail;
d09b2024 272
02067692
SM
273 tail = Fnth (make_number (4), tem);
274 if (EQ (tail, Qkeymap))
275 {
276 if (autoload)
277 {
278 struct gcpro gcpro1, gcpro2;
31bea176 279
02067692
SM
280 GCPRO2 (tem, object);
281 do_autoload (tem, object);
282 UNGCPRO;
31bea176 283
02067692
SM
284 goto autoload_retry;
285 }
286 else
287 return Qt;
288 }
8e4dfd54 289 }
d09b2024
JB
290 }
291
b1314e15 292 end:
2c6f1a39
JB
293 if (error)
294 wrong_type_argument (Qkeymapp, object);
6bbd7a29 295 return Qnil;
2c6f1a39 296}
7d58ed99 297\f
31bea176
SM
298/* Return the parent map of KEYMAP, or nil if it has none.
299 We assume that KEYMAP is a valid keymap. */
7d58ed99 300
31bea176
SM
301Lisp_Object
302keymap_parent (keymap, autoload)
7d58ed99 303 Lisp_Object keymap;
31bea176 304 int autoload;
7d58ed99
RS
305{
306 Lisp_Object list;
307
31bea176 308 keymap = get_keymap (keymap, 1, autoload);
7d58ed99
RS
309
310 /* Skip past the initial element `keymap'. */
03699b14
KR
311 list = XCDR (keymap);
312 for (; CONSP (list); list = XCDR (list))
7d58ed99
RS
313 {
314 /* See if there is another `keymap'. */
57495396 315 if (KEYMAPP (list))
7d58ed99
RS
316 return list;
317 }
318
31bea176 319 return get_keymap (list, 0, autoload);
7d58ed99
RS
320}
321
31bea176
SM
322DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
323 doc: /* Return the parent keymap of KEYMAP. */)
324 (keymap)
325 Lisp_Object keymap;
326{
327 return keymap_parent (keymap, 1);
328}
3015eec0 329
b1904cd9
SM
330/* Check whether MAP is one of MAPS parents. */
331int
332keymap_memberp (map, maps)
333 Lisp_Object map, maps;
334{
7e05cdaf 335 if (NILP (map)) return 0;
b1904cd9 336 while (KEYMAPP (maps) && !EQ (map, maps))
31bea176 337 maps = keymap_parent (maps, 0);
b1904cd9
SM
338 return (EQ (map, maps));
339}
340
7d58ed99
RS
341/* Set the parent keymap of MAP to PARENT. */
342
343DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
335c5470 344 doc: /* Modify KEYMAP to set its parent map to PARENT.
14923440 345Return PARENT. PARENT should be nil or another keymap. */)
335c5470 346 (keymap, parent)
7d58ed99
RS
347 Lisp_Object keymap, parent;
348{
349 Lisp_Object list, prev;
31bea176 350 struct gcpro gcpro1, gcpro2;
7d58ed99 351 int i;
2c6f1a39 352
1e7d1ab0
SM
353 /* Force a keymap flush for the next call to where-is.
354 Since this can be called from within where-is, we don't set where_is_cache
355 directly but only where_is_cache_keymaps, since where_is_cache shouldn't
356 be changed during where-is, while where_is_cache_keymaps is only used at
357 the very beginning of where-is and can thus be changed here without any
358 adverse effect.
359 This is a very minor correctness (rather than safety) issue. */
360 where_is_cache_keymaps = Qt;
361
31bea176 362 GCPRO2 (keymap, parent);
02067692 363 keymap = get_keymap (keymap, 1, 1);
31bea176 364
7d58ed99 365 if (!NILP (parent))
3015eec0 366 {
02067692 367 parent = get_keymap (parent, 1, 1);
3015eec0
GM
368
369 /* Check for cycles. */
b1904cd9 370 if (keymap_memberp (keymap, parent))
3015eec0
GM
371 error ("Cyclic keymap inheritance");
372 }
2c6f1a39 373
7d58ed99
RS
374 /* Skip past the initial element `keymap'. */
375 prev = keymap;
376 while (1)
377 {
03699b14 378 list = XCDR (prev);
7d58ed99
RS
379 /* If there is a parent keymap here, replace it.
380 If we came to the end, add the parent in PREV. */
54cbc3d4 381 if (!CONSP (list) || KEYMAPP (list))
7d58ed99 382 {
2a5af1cf
RS
383 /* If we already have the right parent, return now
384 so that we avoid the loops below. */
03699b14 385 if (EQ (XCDR (prev), parent))
df75b1a3 386 RETURN_UNGCPRO (parent);
2a5af1cf 387
f3fbd155 388 XSETCDR (prev, parent);
7d58ed99
RS
389 break;
390 }
391 prev = list;
392 }
393
394 /* Scan through for submaps, and set their parents too. */
395
03699b14 396 for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
7d58ed99
RS
397 {
398 /* Stop the scan when we come to the parent. */
03699b14 399 if (EQ (XCAR (list), Qkeymap))
7d58ed99
RS
400 break;
401
402 /* If this element holds a prefix map, deal with it. */
03699b14
KR
403 if (CONSP (XCAR (list))
404 && CONSP (XCDR (XCAR (list))))
405 fix_submap_inheritance (keymap, XCAR (XCAR (list)),
406 XCDR (XCAR (list)));
407
408 if (VECTORP (XCAR (list)))
409 for (i = 0; i < XVECTOR (XCAR (list))->size; i++)
410 if (CONSP (XVECTOR (XCAR (list))->contents[i]))
7d58ed99 411 fix_submap_inheritance (keymap, make_number (i),
03699b14 412 XVECTOR (XCAR (list))->contents[i]);
0403641f 413
03699b14 414 if (CHAR_TABLE_P (XCAR (list)))
0403641f 415 {
23cf1efa 416 Lisp_Object indices[3];
0403641f 417
fe72189a
RS
418 map_char_table (fix_submap_inheritance, Qnil,
419 XCAR (list), XCAR (list),
0403641f
RS
420 keymap, 0, indices);
421 }
7d58ed99
RS
422 }
423
df75b1a3 424 RETURN_UNGCPRO (parent);
7d58ed99
RS
425}
426
427/* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
428 if EVENT is also a prefix in MAP's parent,
429 make sure that SUBMAP inherits that definition as its own parent. */
430
57495396 431static void
7d58ed99
RS
432fix_submap_inheritance (map, event, submap)
433 Lisp_Object map, event, submap;
434{
435 Lisp_Object map_parent, parent_entry;
436
437 /* SUBMAP is a cons that we found as a key binding.
438 Discard the other things found in a menu key binding. */
439
02067692 440 submap = get_keymap (get_keyelt (submap, 0), 0, 0);
7d58ed99
RS
441
442 /* If it isn't a keymap now, there's no work to do. */
02067692 443 if (!CONSP (submap))
7d58ed99
RS
444 return;
445
31bea176 446 map_parent = keymap_parent (map, 0);
02067692 447 if (!NILP (map_parent))
320c9428 448 parent_entry =
02067692 449 get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
7d58ed99
RS
450 else
451 parent_entry = Qnil;
452
3393c3f5 453 /* If MAP's parent has something other than a keymap,
9d0ffdd9 454 our own submap shadows it completely. */
02067692 455 if (!CONSP (parent_entry))
9d0ffdd9 456 return;
3393c3f5 457
7d58ed99 458 if (! EQ (parent_entry, submap))
61684f41
RS
459 {
460 Lisp_Object submap_parent;
461 submap_parent = submap;
462 while (1)
463 {
464 Lisp_Object tem;
9d0ffdd9 465
31bea176 466 tem = keymap_parent (submap_parent, 0);
9d0ffdd9
SM
467
468 if (KEYMAPP (tem))
469 {
470 if (keymap_memberp (tem, parent_entry))
471 /* Fset_keymap_parent could create a cycle. */
472 return;
473 submap_parent = tem;
474 }
61684f41
RS
475 else
476 break;
477 }
478 Fset_keymap_parent (submap_parent, parent_entry);
479 }
7d58ed99
RS
480}
481\f
2c6f1a39 482/* Look up IDX in MAP. IDX may be any sort of event.
f5b79c1c 483 Note that this does only one level of lookup; IDX must be a single
744cd66b 484 event, not a sequence.
e25c4e44
JB
485
486 If T_OK is non-zero, bindings for Qt are treated as default
487 bindings; any key left unmentioned by other tables and bindings is
744cd66b 488 given the binding of Qt.
e25c4e44 489
c07aec97
RS
490 If T_OK is zero, bindings for Qt are not treated specially.
491
492 If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */
2c6f1a39
JB
493
494Lisp_Object
db785038 495access_keymap (map, idx, t_ok, noinherit, autoload)
2c6f1a39
JB
496 Lisp_Object map;
497 Lisp_Object idx;
e25c4e44 498 int t_ok;
c07aec97 499 int noinherit;
db785038 500 int autoload;
2c6f1a39 501{
efb91645
RS
502 Lisp_Object val;
503
504 /* Qunbound in VAL means we have found no binding yet. */
505 val = Qunbound;
c07aec97 506
2c6f1a39
JB
507 /* If idx is a list (some sort of mouse click, perhaps?),
508 the index we want to use is the car of the list, which
509 ought to be a symbol. */
cebd887d 510 idx = EVENT_HEAD (idx);
2c6f1a39 511
f5b79c1c
JB
512 /* If idx is a symbol, it might have modifiers, which need to
513 be put in the canonical order. */
47684cd9 514 if (SYMBOLP (idx))
f5b79c1c 515 idx = reorder_modifiers (idx);
2732bdbb
RS
516 else if (INTEGERP (idx))
517 /* Clobber the high bits that can be present on a machine
518 with more than 24 bits of integer. */
6e344130 519 XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
2c6f1a39 520
db785038
SM
521 /* Handle the special meta -> esc mapping. */
522 if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
523 {
7396a36c
GM
524 /* See if there is a meta-map. If there's none, there is
525 no binding for IDX, unless a default binding exists in MAP. */
31bea176
SM
526 struct gcpro gcpro1;
527 Lisp_Object meta_map;
528 GCPRO1 (map);
529 meta_map = get_keymap (access_keymap (map, meta_prefix_char,
530 t_ok, noinherit, autoload),
531 0, autoload);
532 UNGCPRO;
02067692 533 if (CONSP (meta_map))
7396a36c 534 {
9d0ffdd9 535 map = meta_map;
7396a36c
GM
536 idx = make_number (XUINT (idx) & ~meta_modifier);
537 }
538 else if (t_ok)
539 /* Set IDX to t, so that we only find a default binding. */
540 idx = Qt;
541 else
542 /* We know there is no binding. */
543 return Qnil;
db785038
SM
544 }
545
31bea176
SM
546 /* t_binding is where we put a default binding that applies,
547 to use in case we do not find a binding specifically
548 for this key sequence. */
f5b79c1c
JB
549 {
550 Lisp_Object tail;
31bea176
SM
551 Lisp_Object t_binding = Qnil;
552 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
efb91645 553
31bea176 554 GCPRO4 (map, tail, idx, t_binding);
845e4cf4
SM
555
556 /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
557 If it is 1, only generic-char bindings are accepted.
558 Otherwise, neither are. */
559 t_ok = t_ok ? 2 : 0;
2c6f1a39 560
db785038 561 for (tail = XCDR (map);
7396a36c 562 (CONSP (tail)
02067692 563 || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
db785038 564 tail = XCDR (tail))
2c6f1a39 565 {
e9b6dfb0 566 Lisp_Object binding;
f5b79c1c 567
03699b14 568 binding = XCAR (tail);
783a2838 569 if (SYMBOLP (binding))
f5b79c1c 570 {
c07aec97
RS
571 /* If NOINHERIT, stop finding prefix definitions
572 after we pass a second occurrence of the `keymap' symbol. */
db785038 573 if (noinherit && EQ (binding, Qkeymap))
31bea176 574 RETURN_UNGCPRO (Qnil);
783a2838
KH
575 }
576 else if (CONSP (binding))
577 {
859ea4b8 578 Lisp_Object key = XCAR (binding);
744cd66b 579
859ea4b8 580 if (EQ (key, idx))
845e4cf4
SM
581 val = XCDR (binding);
582 else if (t_ok
583 && INTEGERP (idx)
62b366ff 584 && (XINT (idx) & CHAR_MODIFIER_MASK) == 0
859ea4b8 585 && INTEGERP (key)
62b366ff 586 && (XINT (key) & CHAR_MODIFIER_MASK) == 0
859ea4b8
GM
587 && !SINGLE_BYTE_CHAR_P (XINT (idx))
588 && !SINGLE_BYTE_CHAR_P (XINT (key))
589 && CHAR_VALID_P (XINT (key), 1)
590 && !CHAR_VALID_P (XINT (key), 0)
591 && (CHAR_CHARSET (XINT (key))
592 == CHAR_CHARSET (XINT (idx))))
593 {
594 /* KEY is the generic character of the charset of IDX.
595 Use KEY's binding if there isn't a binding for IDX
596 itself. */
845e4cf4
SM
597 t_binding = XCDR (binding);
598 t_ok = 0;
599 }
600 else if (t_ok > 1 && EQ (key, Qt))
601 {
602 t_binding = XCDR (binding);
603 t_ok = 1;
859ea4b8 604 }
783a2838
KH
605 }
606 else if (VECTORP (binding))
607 {
845e4cf4
SM
608 if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
609 val = AREF (binding, XFASTINT (idx));
f5b79c1c 610 }
0403641f
RS
611 else if (CHAR_TABLE_P (binding))
612 {
6418ea16
RS
613 /* Character codes with modifiers
614 are not included in a char-table.
615 All character codes without modifiers are included. */
4dc3eb25
SM
616 if (NATNUMP (idx) && (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0)
617 {
618 val = Faref (binding, idx);
619 /* `nil' has a special meaning for char-tables, so
620 we use something else to record an explicitly
621 unbound entry. */
622 if (NILP (val))
623 val = Qunbound;
624 }
0403641f 625 }
20218e2f 626
845e4cf4
SM
627 /* If we found a binding, clean it up and return it. */
628 if (!EQ (val, Qunbound))
629 {
4dc3eb25
SM
630 if (EQ (val, Qt))
631 /* A Qt binding is just like an explicit nil binding
632 (i.e. it shadows any parent binding but not bindings in
633 keymaps of lower precedence). */
634 val = Qnil;
845e4cf4
SM
635 val = get_keyelt (val, autoload);
636 if (KEYMAPP (val))
637 fix_submap_inheritance (map, idx, val);
31bea176 638 RETURN_UNGCPRO (val);
845e4cf4 639 }
20218e2f 640 QUIT;
2c6f1a39 641 }
31bea176 642 UNGCPRO;
db785038 643 return get_keyelt (t_binding, autoload);
e25c4e44 644 }
2c6f1a39
JB
645}
646
9d3153eb
SM
647static void
648map_keymap_item (fun, args, key, val, data)
649 map_keymap_function_t fun;
650 Lisp_Object args, key, val;
651 void *data;
652{
653 /* We should maybe try to detect bindings shadowed by previous
654 ones and things like that. */
655 if (EQ (val, Qt))
656 val = Qnil;
657 (*fun) (key, val, args, data);
658}
659
660static void
661map_keymap_char_table_item (args, key, val)
662 Lisp_Object args, key, val;
663{
664 if (!NILP (val))
665 {
666 map_keymap_function_t fun = XSAVE_VALUE (XCAR (args))->pointer;
667 args = XCDR (args);
668 map_keymap_item (fun, XCDR (args), key, val,
669 XSAVE_VALUE (XCAR (args))->pointer);
670 }
671}
672
673/* Call FUN for every binding in MAP.
edf505ce
SM
674 FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
675 AUTOLOAD if non-zero means that we can autoload keymaps if necessary. */
9d3153eb
SM
676void
677map_keymap (map, fun, args, data, autoload)
678 map_keymap_function_t fun;
679 Lisp_Object map, args;
680 void *data;
681 int autoload;
682{
683 struct gcpro gcpro1, gcpro2, gcpro3;
684 Lisp_Object tail;
685
686 GCPRO3 (map, args, tail);
687 map = get_keymap (map, 1, autoload);
688 for (tail = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
689 CONSP (tail) || (tail = get_keymap (tail, 0, autoload), CONSP (tail));
690 tail = XCDR (tail))
691 {
692 Lisp_Object binding = XCAR (tail);
f8d8ba40 693
9d3153eb
SM
694 if (CONSP (binding))
695 map_keymap_item (fun, args, XCAR (binding), XCDR (binding), data);
696 else if (VECTORP (binding))
697 {
698 /* Loop over the char values represented in the vector. */
699 int len = ASIZE (binding);
700 int c;
9d3153eb
SM
701 for (c = 0; c < len; c++)
702 {
703 Lisp_Object character;
704 XSETFASTINT (character, c);
705 map_keymap_item (fun, args, character, AREF (binding, c), data);
706 }
707 }
708 else if (CHAR_TABLE_P (binding))
709 {
710 Lisp_Object indices[3];
fe72189a 711 map_char_table (map_keymap_char_table_item, Qnil, binding, binding,
9d3153eb
SM
712 Fcons (make_save_value (fun, 0),
713 Fcons (make_save_value (data, 0),
714 args)),
715 0, indices);
716 }
717 }
718 UNGCPRO;
719}
720
721static void
722map_keymap_call (key, val, fun, dummy)
723 Lisp_Object key, val, fun;
724 void *dummy;
725{
726 call2 (fun, key, val);
727}
728
729DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 2, 0,
730 doc: /* Call FUNCTION for every binding in KEYMAP.
731FUNCTION is called with two arguments: the event and its binding. */)
732 (function, keymap)
733 Lisp_Object function, keymap;
734{
735 if (INTEGERP (function))
736 /* We have to stop integers early since map_keymap gives them special
737 significance. */
738 Fsignal (Qinvalid_function, Fcons (function, Qnil));
739 map_keymap (keymap, map_keymap_call, function, NULL, 1);
740 return Qnil;
741}
742
2c6f1a39
JB
743/* Given OBJECT which was found in a slot in a keymap,
744 trace indirect definitions to get the actual definition of that slot.
745 An indirect definition is a list of the form
746 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
747 and INDEX is the object to look up in KEYMAP to yield the definition.
748
749 Also if OBJECT has a menu string as the first element,
224a16e8
RS
750 remove that. Also remove a menu help string as second element.
751
752 If AUTOLOAD is nonzero, load autoloadable keymaps
753 that are referred to with indirection. */
2c6f1a39
JB
754
755Lisp_Object
224a16e8 756get_keyelt (object, autoload)
31bea176 757 Lisp_Object object;
224a16e8 758 int autoload;
2c6f1a39
JB
759{
760 while (1)
761 {
b1314e15
KH
762 if (!(CONSP (object)))
763 /* This is really the value. */
764 return object;
2c6f1a39 765
b1314e15
KH
766 /* If the keymap contents looks like (keymap ...) or (lambda ...)
767 then use itself. */
768 else if (EQ (XCAR (object), Qkeymap) || EQ (XCAR (object), Qlambda))
769 return object;
770
771 /* If the keymap contents looks like (menu-item name . DEFN)
772 or (menu-item name DEFN ...) then use DEFN.
3fc720e4 773 This is a new format menu item. */
b1314e15 774 else if (EQ (XCAR (object), Qmenu_item))
0403641f 775 {
b1314e15 776 if (CONSP (XCDR (object)))
0403641f 777 {
3fc720e4
GM
778 Lisp_Object tem;
779
b1314e15 780 object = XCDR (XCDR (object));
3fc720e4 781 tem = object;
b1314e15
KH
782 if (CONSP (object))
783 object = XCAR (object);
3fc720e4
GM
784
785 /* If there's a `:filter FILTER', apply FILTER to the
786 menu-item's definition to get the real definition to
d5b3eb1b 787 use. */
3fc720e4 788 for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
d5b3eb1b 789 if (EQ (XCAR (tem), QCfilter) && autoload)
3fc720e4
GM
790 {
791 Lisp_Object filter;
792 filter = XCAR (XCDR (tem));
793 filter = list2 (filter, list2 (Qquote, object));
794 object = menu_item_eval_property (filter);
795 break;
796 }
0403641f
RS
797 }
798 else
31bea176 799 /* Invalid keymap. */
b1314e15 800 return object;
0403641f
RS
801 }
802
b1314e15 803 /* If the keymap contents looks like (STRING . DEFN), use DEFN.
2c6f1a39
JB
804 Keymap alist elements like (CHAR MENUSTRING . DEFN)
805 will be used by HierarKey menus. */
b1314e15 806 else if (STRINGP (XCAR (object)))
1a8c3f10 807 {
b1314e15 808 object = XCDR (object);
1a8c3f10
RS
809 /* Also remove a menu help string, if any,
810 following the menu item name. */
b1314e15
KH
811 if (CONSP (object) && STRINGP (XCAR (object)))
812 object = XCDR (object);
c6ec9f6e 813 /* Also remove the sublist that caches key equivalences, if any. */
b1314e15 814 if (CONSP (object) && CONSP (XCAR (object)))
ffab2bd6 815 {
c6ec9f6e 816 Lisp_Object carcar;
b1314e15 817 carcar = XCAR (XCAR (object));
c6ec9f6e 818 if (NILP (carcar) || VECTORP (carcar))
b1314e15 819 object = XCDR (object);
ffab2bd6 820 }
1a8c3f10 821 }
2c6f1a39 822
b1314e15
KH
823 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
824 else
a3fc8840 825 {
31bea176 826 struct gcpro gcpro1;
df75b1a3 827 Lisp_Object map;
31bea176 828 GCPRO1 (object);
02067692 829 map = get_keymap (Fcar_safe (object), 0, autoload);
31bea176 830 UNGCPRO;
02067692 831 return (!CONSP (map) ? object /* Invalid keymap */
db785038 832 : access_keymap (map, Fcdr (object), 0, 0, autoload));
a3fc8840 833 }
2c6f1a39
JB
834 }
835}
836
2d929694 837static Lisp_Object
2c6f1a39
JB
838store_in_keymap (keymap, idx, def)
839 Lisp_Object keymap;
840 register Lisp_Object idx;
841 register Lisp_Object def;
842{
1e7d1ab0
SM
843 /* Flush any reverse-map cache. */
844 where_is_cache = Qnil;
845 where_is_cache_keymaps = Qt;
846
dce4372a 847 /* If we are preparing to dump, and DEF is a menu element
a3fc8840
RS
848 with a menu item indicator, copy it to ensure it is not pure. */
849 if (CONSP (def) && PURE_P (def)
03699b14
KR
850 && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
851 def = Fcons (XCAR (def), XCDR (def));
32ce36ad 852
54cbc3d4 853 if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
f5b79c1c
JB
854 error ("attempt to define a key in a non-keymap");
855
2c6f1a39
JB
856 /* If idx is a list (some sort of mouse click, perhaps?),
857 the index we want to use is the car of the list, which
858 ought to be a symbol. */
cebd887d 859 idx = EVENT_HEAD (idx);
2c6f1a39 860
f5b79c1c
JB
861 /* If idx is a symbol, it might have modifiers, which need to
862 be put in the canonical order. */
416349ec 863 if (SYMBOLP (idx))
f5b79c1c 864 idx = reorder_modifiers (idx);
2732bdbb
RS
865 else if (INTEGERP (idx))
866 /* Clobber the high bits that can be present on a machine
867 with more than 24 bits of integer. */
6e344130 868 XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
f5b79c1c
JB
869
870 /* Scan the keymap for a binding of idx. */
2c6f1a39 871 {
f5b79c1c 872 Lisp_Object tail;
2c6f1a39 873
f5b79c1c
JB
874 /* The cons after which we should insert new bindings. If the
875 keymap has a table element, we record its position here, so new
876 bindings will go after it; this way, the table will stay
877 towards the front of the alist and character lookups in dense
878 keymaps will remain fast. Otherwise, this just points at the
879 front of the keymap. */
e9b6dfb0 880 Lisp_Object insertion_point;
2c6f1a39 881
e9b6dfb0 882 insertion_point = keymap;
03699b14 883 for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
2c6f1a39 884 {
e9b6dfb0 885 Lisp_Object elt;
f5b79c1c 886
03699b14 887 elt = XCAR (tail);
783a2838 888 if (VECTORP (elt))
f5b79c1c 889 {
49801145 890 if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
f5b79c1c 891 {
49801145 892 ASET (elt, XFASTINT (idx), def);
f5b79c1c
JB
893 return def;
894 }
895 insertion_point = tail;
783a2838 896 }
0403641f
RS
897 else if (CHAR_TABLE_P (elt))
898 {
6418ea16
RS
899 /* Character codes with modifiers
900 are not included in a char-table.
901 All character codes without modifiers are included. */
4dc3eb25 902 if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
0403641f 903 {
4dc3eb25
SM
904 Faset (elt, idx,
905 /* `nil' has a special meaning for char-tables, so
906 we use something else to record an explicitly
907 unbound entry. */
908 NILP (def) ? Qt : def);
0403641f
RS
909 return def;
910 }
911 insertion_point = tail;
912 }
783a2838
KH
913 else if (CONSP (elt))
914 {
03699b14 915 if (EQ (idx, XCAR (elt)))
f5b79c1c 916 {
f3fbd155 917 XSETCDR (elt, def);
f5b79c1c
JB
918 return def;
919 }
783a2838 920 }
49801145
SM
921 else if (EQ (elt, Qkeymap))
922 /* If we find a 'keymap' symbol in the spine of KEYMAP,
923 then we must have found the start of a second keymap
924 being used as the tail of KEYMAP, and a binding for IDX
925 should be inserted before it. */
926 goto keymap_end;
0188441d
JB
927
928 QUIT;
2c6f1a39 929 }
2c6f1a39 930
f5b79c1c
JB
931 keymap_end:
932 /* We have scanned the entire keymap, and not found a binding for
933 IDX. Let's add one. */
f3fbd155
KR
934 XSETCDR (insertion_point,
935 Fcons (Fcons (idx, def), XCDR (insertion_point)));
f5b79c1c 936 }
31bea176 937
2c6f1a39
JB
938 return def;
939}
940
2b6748c0
SM
941EXFUN (Fcopy_keymap, 1);
942
31bea176
SM
943Lisp_Object
944copy_keymap_item (elt)
945 Lisp_Object elt;
946{
947 Lisp_Object res, tem;
948
949 if (!CONSP (elt))
950 return elt;
951
952 res = tem = elt;
953
954 /* Is this a new format menu item. */
955 if (EQ (XCAR (tem), Qmenu_item))
956 {
957 /* Copy cell with menu-item marker. */
958 res = elt = Fcons (XCAR (tem), XCDR (tem));
959 tem = XCDR (elt);
960 if (CONSP (tem))
961 {
962 /* Copy cell with menu-item name. */
963 XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
964 elt = XCDR (elt);
965 tem = XCDR (elt);
966 }
967 if (CONSP (tem))
968 {
969 /* Copy cell with binding and if the binding is a keymap,
970 copy that. */
971 XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
972 elt = XCDR (elt);
973 tem = XCAR (elt);
974 if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
975 XSETCAR (elt, Fcopy_keymap (tem));
976 tem = XCDR (elt);
977 if (CONSP (tem) && CONSP (XCAR (tem)))
978 /* Delete cache for key equivalences. */
979 XSETCDR (elt, XCDR (tem));
980 }
981 }
982 else
983 {
984 /* It may be an old fomat menu item.
985 Skip the optional menu string. */
986 if (STRINGP (XCAR (tem)))
987 {
988 /* Copy the cell, since copy-alist didn't go this deep. */
989 res = elt = Fcons (XCAR (tem), XCDR (tem));
990 tem = XCDR (elt);
991 /* Also skip the optional menu help string. */
992 if (CONSP (tem) && STRINGP (XCAR (tem)))
993 {
994 XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
995 elt = XCDR (elt);
996 tem = XCDR (elt);
997 }
998 /* There may also be a list that caches key equivalences.
999 Just delete it for the new keymap. */
1000 if (CONSP (tem)
1001 && CONSP (XCAR (tem))
1002 && (NILP (XCAR (XCAR (tem)))
1003 || VECTORP (XCAR (XCAR (tem)))))
1004 {
1005 XSETCDR (elt, XCDR (tem));
1006 tem = XCDR (tem);
1007 }
1008 if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
1009 XSETCDR (elt, Fcopy_keymap (tem));
1010 }
1011 else if (EQ (XCAR (tem), Qkeymap))
1012 res = Fcopy_keymap (elt);
1013 }
1014 return res;
1015}
1016
80951487 1017static void
0403641f
RS
1018copy_keymap_1 (chartable, idx, elt)
1019 Lisp_Object chartable, idx, elt;
1020{
31bea176 1021 Faset (chartable, idx, copy_keymap_item (elt));
0403641f 1022}
f5b79c1c 1023
2c6f1a39 1024DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0,
335c5470
PJ
1025 doc: /* Return a copy of the keymap KEYMAP.
1026The copy starts out with the same definitions of KEYMAP,
1027but changing either the copy or KEYMAP does not affect the other.
1028Any key definitions that are subkeymaps are recursively copied.
1029However, a key definition which is a symbol whose definition is a keymap
1030is not copied. */)
1031 (keymap)
2c6f1a39
JB
1032 Lisp_Object keymap;
1033{
1034 register Lisp_Object copy, tail;
31bea176
SM
1035 keymap = get_keymap (keymap, 1, 0);
1036 copy = tail = Fcons (Qkeymap, Qnil);
1037 keymap = XCDR (keymap); /* Skip the `keymap' symbol. */
2c6f1a39 1038
31bea176 1039 while (CONSP (keymap) && !EQ (XCAR (keymap), Qkeymap))
2c6f1a39 1040 {
31bea176 1041 Lisp_Object elt = XCAR (keymap);
0403641f
RS
1042 if (CHAR_TABLE_P (elt))
1043 {
23cf1efa 1044 Lisp_Object indices[3];
0403641f 1045 elt = Fcopy_sequence (elt);
fe72189a 1046 map_char_table (copy_keymap_1, Qnil, elt, elt, elt, 0, indices);
0403641f
RS
1047 }
1048 else if (VECTORP (elt))
2c6f1a39 1049 {
f5b79c1c 1050 int i;
f5b79c1c 1051 elt = Fcopy_sequence (elt);
49801145 1052 for (i = 0; i < ASIZE (elt); i++)
31bea176 1053 ASET (elt, i, copy_keymap_item (AREF (elt, i)));
d65a13c5 1054 }
31bea176
SM
1055 else if (CONSP (elt))
1056 elt = Fcons (XCAR (elt), copy_keymap_item (XCDR (elt)));
1057 XSETCDR (tail, Fcons (elt, Qnil));
1058 tail = XCDR (tail);
1059 keymap = XCDR (keymap);
2c6f1a39 1060 }
31bea176 1061 XSETCDR (tail, keymap);
2c6f1a39
JB
1062 return copy;
1063}
1064\f
cc0a8174
JB
1065/* Simple Keymap mutators and accessors. */
1066
21a0d7a0
RS
1067/* GC is possible in this function if it autoloads a keymap. */
1068
2c6f1a39 1069DEFUN ("define-key", Fdefine_key, Sdefine_key, 3, 3, 0,
2d772f45 1070 doc: /* In KEYMAP, define key sequence KEY as DEF.
0c412762
KS
1071KEYMAP is a keymap.
1072
1073KEY is a string or a vector of symbols and characters meaning a
1074sequence of keystrokes and events. Non-ASCII characters with codes
1075above 127 (such as ISO Latin-1) can be included if you use a vector.
bbc4541d 1076Using [t] for KEY creates a default definition, which applies to any
64239341 1077event type that has no other definition in this keymap.
0c412762 1078
335c5470
PJ
1079DEF is anything that can be a key's definition:
1080 nil (means key is undefined in this keymap),
f63fd14e 1081 a command (a Lisp function suitable for interactive calling),
335c5470
PJ
1082 a string (treated as a keyboard macro),
1083 a keymap (to define a prefix key),
f63fd14e 1084 a symbol (when the key is looked up, the symbol will stand for its
335c5470 1085 function definition, which should at that time be one of the above,
f63fd14e 1086 or another symbol whose function definition is used, etc.),
335c5470
PJ
1087 a cons (STRING . DEFN), meaning that DEFN is the definition
1088 (DEFN should be a valid definition in its own right),
f63fd14e 1089 or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP.
335c5470 1090
3abeca61
KG
1091If KEYMAP is a sparse keymap with a binding for KEY, the existing
1092binding is altered. If there is no binding for KEY, the new pair
1093binding KEY to DEF is added at the front of KEYMAP. */)
335c5470 1094 (keymap, key, def)
d09b2024 1095 Lisp_Object keymap;
2c6f1a39
JB
1096 Lisp_Object key;
1097 Lisp_Object def;
1098{
1099 register int idx;
1100 register Lisp_Object c;
2c6f1a39
JB
1101 register Lisp_Object cmd;
1102 int metized = 0;
6ba6e250 1103 int meta_bit;
2c6f1a39 1104 int length;
d09b2024 1105 struct gcpro gcpro1, gcpro2, gcpro3;
2c6f1a39 1106
31bea176 1107 GCPRO3 (keymap, key, def);
02067692 1108 keymap = get_keymap (keymap, 1, 1);
2c6f1a39 1109
a1df473f 1110 if (!VECTORP (key) && !STRINGP (key))
31bea176 1111 key = wrong_type_argument (Qarrayp, key);
2c6f1a39 1112
d09b2024 1113 length = XFASTINT (Flength (key));
2c6f1a39 1114 if (length == 0)
31bea176 1115 RETURN_UNGCPRO (Qnil);
a1df473f 1116
107fd03d
RS
1117 if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
1118 Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);
1119
31bea176 1120 meta_bit = VECTORP (key) ? meta_modifier : 0x80;
6ba6e250 1121
2c6f1a39
JB
1122 idx = 0;
1123 while (1)
1124 {
1125 c = Faref (key, make_number (idx));
1126
f09bc924 1127 if (CONSP (c) && lucid_event_type_list_p (c))
41015a19 1128 c = Fevent_convert_list (c);
f09bc924 1129
15fff01d
RS
1130 if (SYMBOLP (c))
1131 silly_event_symbol_error (c);
2fae9111 1132
416349ec 1133 if (INTEGERP (c)
6ba6e250 1134 && (XINT (c) & meta_bit)
2c6f1a39
JB
1135 && !metized)
1136 {
1137 c = meta_prefix_char;
1138 metized = 1;
1139 }
1140 else
1141 {
416349ec 1142 if (INTEGERP (c))
0b8fc2d4 1143 XSETINT (c, XINT (c) & ~meta_bit);
2c6f1a39
JB
1144
1145 metized = 0;
1146 idx++;
1147 }
1148
54cbc3d4 1149 if (!INTEGERP (c) && !SYMBOLP (c) && !CONSP (c))
2fae9111 1150 error ("Key sequence contains invalid event");
5907b863 1151
2c6f1a39 1152 if (idx == length)
d09b2024 1153 RETURN_UNGCPRO (store_in_keymap (keymap, c, def));
2c6f1a39 1154
db785038 1155 cmd = access_keymap (keymap, c, 0, 1, 1);
2c6f1a39 1156
c07aec97 1157 /* If this key is undefined, make it a prefix. */
265a9e55 1158 if (NILP (cmd))
c07aec97 1159 cmd = define_as_prefix (keymap, c);
2c6f1a39 1160
02067692
SM
1161 keymap = get_keymap (cmd, 0, 1);
1162 if (!CONSP (keymap))
e9b6dfb0
KH
1163 /* We must use Fkey_description rather than just passing key to
1164 error; key might be a vector, not a string. */
1165 error ("Key sequence %s uses invalid prefix characters",
f8d8ba40 1166 SDATA (Fkey_description (key, Qnil)));
2c6f1a39
JB
1167 }
1168}
1169
a1df473f
KS
1170/* This function may GC (it calls Fkey_binding). */
1171
023b93f6 1172DEFUN ("command-remapping", Fcommand_remapping, Scommand_remapping, 1, 1, 0,
a1df473f 1173 doc: /* Return the remapping for command COMMAND in current keymaps.
078d0f38 1174Returns nil if COMMAND is not remapped (or not a symbol). */)
a1df473f
KS
1175 (command)
1176 Lisp_Object command;
1177{
078d0f38
KS
1178 if (!SYMBOLP (command))
1179 return Qnil;
1180
023b93f6
KS
1181 ASET (command_remapping_vector, 1, command);
1182 return Fkey_binding (command_remapping_vector, Qnil, Qt);
a1df473f
KS
1183}
1184
f0529b5b 1185/* Value is number if KEY is too long; nil if valid but has no definition. */
21a0d7a0 1186/* GC is possible in this function if it autoloads a keymap. */
2c6f1a39 1187
7c140252 1188DEFUN ("lookup-key", Flookup_key, Slookup_key, 2, 3, 0,
335c5470
PJ
1189 doc: /* In keymap KEYMAP, look up key sequence KEY. Return the definition.
1190nil means undefined. See doc of `define-key' for kinds of definitions.
1191
1192A number as value means KEY is "too long";
1193that is, characters or symbols in it except for the last one
1194fail to be a valid sequence of prefix characters in KEYMAP.
1195The number is how many characters at the front of KEY
1196it takes to reach a non-prefix command.
1197
1198Normally, `lookup-key' ignores bindings for t, which act as default
1199bindings, used when nothing else in the keymap applies; this makes it
1200usable as a general function for probing keymaps. However, if the
1201third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will
1202recognize the default bindings, just as `read-key-sequence' does. */)
1203 (keymap, key, accept_default)
31bea176 1204 Lisp_Object keymap;
2c6f1a39 1205 Lisp_Object key;
7c140252 1206 Lisp_Object accept_default;
2c6f1a39
JB
1207{
1208 register int idx;
2c6f1a39
JB
1209 register Lisp_Object cmd;
1210 register Lisp_Object c;
2c6f1a39 1211 int length;
54cbc3d4 1212 int t_ok = !NILP (accept_default);
31bea176 1213 struct gcpro gcpro1, gcpro2;
2c6f1a39 1214
31bea176 1215 GCPRO2 (keymap, key);
02067692 1216 keymap = get_keymap (keymap, 1, 1);
2c6f1a39 1217
416349ec 1218 if (!VECTORP (key) && !STRINGP (key))
2c6f1a39
JB
1219 key = wrong_type_argument (Qarrayp, key);
1220
d09b2024 1221 length = XFASTINT (Flength (key));
2c6f1a39 1222 if (length == 0)
31bea176 1223 RETURN_UNGCPRO (keymap);
21a0d7a0 1224
2c6f1a39
JB
1225 idx = 0;
1226 while (1)
1227 {
db785038 1228 c = Faref (key, make_number (idx++));
2c6f1a39 1229
f09bc924 1230 if (CONSP (c) && lucid_event_type_list_p (c))
41015a19 1231 c = Fevent_convert_list (c);
f09bc924 1232
db785038
SM
1233 /* Turn the 8th bit of string chars into a meta modifier. */
1234 if (XINT (c) & 0x80 && STRINGP (key))
1235 XSETINT (c, (XINT (c) | meta_modifier) & ~0x80);
2c6f1a39 1236
5f245371
KS
1237 /* Allow string since binding for `menu-bar-select-buffer'
1238 includes the buffer name in the key sequence. */
1239 if (!INTEGERP (c) && !SYMBOLP (c) && !CONSP (c) && !STRINGP (c))
2fae9111
RS
1240 error ("Key sequence contains invalid event");
1241
db785038 1242 cmd = access_keymap (keymap, c, t_ok, 0, 1);
2c6f1a39 1243 if (idx == length)
21a0d7a0 1244 RETURN_UNGCPRO (cmd);
2c6f1a39 1245
02067692
SM
1246 keymap = get_keymap (cmd, 0, 1);
1247 if (!CONSP (keymap))
21a0d7a0 1248 RETURN_UNGCPRO (make_number (idx));
2c6f1a39 1249
2c6f1a39
JB
1250 QUIT;
1251 }
1252}
1253
c07aec97
RS
1254/* Make KEYMAP define event C as a keymap (i.e., as a prefix).
1255 Assume that currently it does not define C at all.
1256 Return the keymap. */
1257
1258static Lisp_Object
1259define_as_prefix (keymap, c)
1260 Lisp_Object keymap, c;
1261{
db785038 1262 Lisp_Object cmd;
c07aec97
RS
1263
1264 cmd = Fmake_sparse_keymap (Qnil);
1265 /* If this key is defined as a prefix in an inherited keymap,
1266 make it a prefix in this map, and make its definition
1267 inherit the other prefix definition. */
db785038 1268 cmd = nconc2 (cmd, access_keymap (keymap, c, 0, 0, 0));
c07aec97
RS
1269 store_in_keymap (keymap, c, cmd);
1270
1271 return cmd;
1272}
1273
0b8fc2d4
RS
1274/* Append a key to the end of a key sequence. We always make a vector. */
1275
2c6f1a39
JB
1276Lisp_Object
1277append_key (key_sequence, key)
1278 Lisp_Object key_sequence, key;
1279{
1280 Lisp_Object args[2];
1281
1282 args[0] = key_sequence;
1283
0b8fc2d4
RS
1284 args[1] = Fcons (key, Qnil);
1285 return Fvconcat (2, args);
2c6f1a39
JB
1286}
1287
15fff01d
RS
1288/* Given a event type C which is a symbol,
1289 signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */
1290
1291static void
1292silly_event_symbol_error (c)
1293 Lisp_Object c;
1294{
1295 Lisp_Object parsed, base, name, assoc;
1296 int modifiers;
744cd66b 1297
15fff01d
RS
1298 parsed = parse_modifiers (c);
1299 modifiers = (int) XUINT (XCAR (XCDR (parsed)));
1300 base = XCAR (parsed);
1301 name = Fsymbol_name (base);
1302 /* This alist includes elements such as ("RET" . "\\r"). */
1303 assoc = Fassoc (name, exclude_keys);
1304
1305 if (! NILP (assoc))
1306 {
1307 char new_mods[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")];
1308 char *p = new_mods;
1309 Lisp_Object keystring;
1310 if (modifiers & alt_modifier)
1311 { *p++ = '\\'; *p++ = 'A'; *p++ = '-'; }
1312 if (modifiers & ctrl_modifier)
1313 { *p++ = '\\'; *p++ = 'C'; *p++ = '-'; }
1314 if (modifiers & hyper_modifier)
1315 { *p++ = '\\'; *p++ = 'H'; *p++ = '-'; }
1316 if (modifiers & meta_modifier)
1317 { *p++ = '\\'; *p++ = 'M'; *p++ = '-'; }
1318 if (modifiers & shift_modifier)
1319 { *p++ = '\\'; *p++ = 'S'; *p++ = '-'; }
1320 if (modifiers & super_modifier)
1321 { *p++ = '\\'; *p++ = 's'; *p++ = '-'; }
1322 *p = 0;
1323
1324 c = reorder_modifiers (c);
1325 keystring = concat2 (build_string (new_mods), XCDR (assoc));
744cd66b 1326
15fff01d
RS
1327 error ((modifiers & ~meta_modifier
1328 ? "To bind the key %s, use [?%s], not [%s]"
1329 : "To bind the key %s, use \"%s\", not [%s]"),
d5db4077
KR
1330 SDATA (SYMBOL_NAME (c)), SDATA (keystring),
1331 SDATA (SYMBOL_NAME (c)));
15fff01d
RS
1332 }
1333}
2c6f1a39 1334\f
cc0a8174
JB
1335/* Global, local, and minor mode keymap stuff. */
1336
265a9e55 1337/* We can't put these variables inside current_minor_maps, since under
6bbbd9b0
JB
1338 some systems, static gets macro-defined to be the empty string.
1339 Ickypoo. */
cd6db61a
KS
1340static Lisp_Object *cmm_modes = NULL, *cmm_maps = NULL;
1341static int cmm_size = 0;
265a9e55 1342
fbb90829
KH
1343/* Error handler used in current_minor_maps. */
1344static Lisp_Object
1345current_minor_maps_error ()
1346{
1347 return Qnil;
1348}
1349
cc0a8174
JB
1350/* Store a pointer to an array of the keymaps of the currently active
1351 minor modes in *buf, and return the number of maps it contains.
1352
1353 This function always returns a pointer to the same buffer, and may
1354 free or reallocate it, so if you want to keep it for a long time or
1355 hand it out to lisp code, copy it. This procedure will be called
1356 for every key sequence read, so the nice lispy approach (return a
1357 new assoclist, list, what have you) for each invocation would
1358 result in a lot of consing over time.
1359
1360 If we used xrealloc/xmalloc and ran out of memory, they would throw
1361 back to the command loop, which would try to read a key sequence,
1362 which would call this function again, resulting in an infinite
1363 loop. Instead, we'll use realloc/malloc and silently truncate the
1364 list, let the key sequence be read, and hope some other piece of
1365 code signals the error. */
1366int
1367current_minor_maps (modeptr, mapptr)
1368 Lisp_Object **modeptr, **mapptr;
1369{
cc0a8174 1370 int i = 0;
dd9cda06 1371 int list_number = 0;
6bbbd9b0 1372 Lisp_Object alist, assoc, var, val;
99cbcaca 1373 Lisp_Object emulation_alists;
dd9cda06
RS
1374 Lisp_Object lists[2];
1375
99cbcaca 1376 emulation_alists = Vemulation_mode_map_alists;
dd9cda06
RS
1377 lists[0] = Vminor_mode_overriding_map_alist;
1378 lists[1] = Vminor_mode_map_alist;
1379
1380 for (list_number = 0; list_number < 2; list_number++)
99cbcaca
KS
1381 {
1382 if (CONSP (emulation_alists))
dd9cda06 1383 {
99cbcaca
KS
1384 alist = XCAR (emulation_alists);
1385 emulation_alists = XCDR (emulation_alists);
1386 if (SYMBOLP (alist))
1387 alist = find_symbol_value (alist);
1388 list_number = -1;
1389 }
1390 else
1391 alist = lists[list_number];
cc0a8174 1392
99cbcaca
KS
1393 for ( ; CONSP (alist); alist = XCDR (alist))
1394 if ((assoc = XCAR (alist), CONSP (assoc))
1395 && (var = XCAR (assoc), SYMBOLP (var))
1396 && (val = find_symbol_value (var), !EQ (val, Qunbound))
1397 && !NILP (val))
1398 {
1399 Lisp_Object temp;
64dd3629 1400
99cbcaca
KS
1401 /* If a variable has an entry in Vminor_mode_overriding_map_alist,
1402 and also an entry in Vminor_mode_map_alist,
1403 ignore the latter. */
1404 if (list_number == 1)
1405 {
1406 val = assq_no_quit (var, lists[0]);
1407 if (!NILP (val))
1408 continue;
1409 }
cc0a8174 1410
99cbcaca
KS
1411 if (i >= cmm_size)
1412 {
cd6db61a 1413 int newsize, allocsize;
99cbcaca 1414 Lisp_Object *newmodes, *newmaps;
cc0a8174 1415
cd6db61a
KS
1416 newsize = cmm_size == 0 ? 30 : cmm_size * 2;
1417 allocsize = newsize * sizeof *newmodes;
1418
744cd66b 1419 /* Use malloc here. See the comment above this function.
cd6db61a
KS
1420 Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */
1421 BLOCK_INPUT;
1422 newmodes = (Lisp_Object *) malloc (allocsize);
1423 if (newmodes)
99cbcaca 1424 {
cd6db61a
KS
1425 if (cmm_modes)
1426 {
1427 bcopy (cmm_modes, newmodes, cmm_size * sizeof cmm_modes[0]);
1428 free (cmm_modes);
1429 }
1430 cmm_modes = newmodes;
99cbcaca
KS
1431 }
1432
cd6db61a 1433 newmaps = (Lisp_Object *) malloc (allocsize);
99cbcaca 1434 if (newmaps)
cd6db61a
KS
1435 {
1436 if (cmm_maps)
1437 {
1438 bcopy (cmm_maps, newmaps, cmm_size * sizeof cmm_maps[0]);
1439 free (cmm_maps);
1440 }
1441 cmm_maps = newmaps;
1442 }
1443 UNBLOCK_INPUT;
744cd66b 1444
99cbcaca
KS
1445 if (newmodes == NULL || newmaps == NULL)
1446 break;
cd6db61a 1447 cmm_size = newsize;
99cbcaca 1448 }
fbb90829 1449
99cbcaca
KS
1450 /* Get the keymap definition--or nil if it is not defined. */
1451 temp = internal_condition_case_1 (Findirect_function,
1452 XCDR (assoc),
1453 Qerror, current_minor_maps_error);
1454 if (!NILP (temp))
1455 {
1456 cmm_modes[i] = var;
1457 cmm_maps [i] = temp;
1458 i++;
1459 }
1460 }
1461 }
cc0a8174 1462
265a9e55
JB
1463 if (modeptr) *modeptr = cmm_modes;
1464 if (mapptr) *mapptr = cmm_maps;
cc0a8174
JB
1465 return i;
1466}
1467
54cbc3d4 1468DEFUN ("current-active-maps", Fcurrent_active_maps, Scurrent_active_maps,
335c5470
PJ
1469 0, 1, 0,
1470 doc: /* Return a list of the currently active keymaps.
1471OLP if non-nil indicates that we should obey `overriding-local-map' and
1472`overriding-terminal-local-map'. */)
54cbc3d4
SM
1473 (olp)
1474 Lisp_Object olp;
1475{
1476 Lisp_Object keymaps = Fcons (current_global_map, Qnil);
1477
1478 if (!NILP (olp))
1479 {
1480 if (!NILP (Voverriding_local_map))
1481 keymaps = Fcons (Voverriding_local_map, keymaps);
1482 if (!NILP (current_kboard->Voverriding_terminal_local_map))
1483 keymaps = Fcons (current_kboard->Voverriding_terminal_local_map, keymaps);
1484 }
1485 if (NILP (XCDR (keymaps)))
1486 {
1487 Lisp_Object local;
1488 Lisp_Object *maps;
1489 int nmaps, i;
1490
1491 local = get_local_map (PT, current_buffer, Qlocal_map);
1492 if (!NILP (local))
1493 keymaps = Fcons (local, keymaps);
1494
54cbc3d4
SM
1495 nmaps = current_minor_maps (0, &maps);
1496
1497 for (i = --nmaps; i >= 0; i--)
1498 if (!NILP (maps[i]))
1499 keymaps = Fcons (maps[i], keymaps);
d1d070e3
RS
1500
1501 local = get_local_map (PT, current_buffer, Qkeymap);
1502 if (!NILP (local))
1503 keymaps = Fcons (local, keymaps);
54cbc3d4 1504 }
31bea176 1505
54cbc3d4
SM
1506 return keymaps;
1507}
1508
21a0d7a0
RS
1509/* GC is possible in this function if it autoloads a keymap. */
1510
0c412762 1511DEFUN ("key-binding", Fkey_binding, Skey_binding, 1, 3, 0,
335c5470
PJ
1512 doc: /* Return the binding for command KEY in current keymaps.
1513KEY is a string or vector, a sequence of keystrokes.
1514The binding is probably a symbol with a function definition.
1515
1516Normally, `key-binding' ignores bindings for t, which act as default
1517bindings, used when nothing else in the keymap applies; this makes it
1518usable as a general function for probing keymaps. However, if the
1519optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does
0c412762
KS
1520recognize the default bindings, just as `read-key-sequence' does.
1521
1522Like the normal command loop, `key-binding' will remap the command
1523resulting from looking up KEY by looking up the command in the
35936c5c 1524current keymaps. However, if the optional third argument NO-REMAP
0c412762
KS
1525is non-nil, `key-binding' returns the unmapped command. */)
1526 (key, accept_default, no_remap)
1527 Lisp_Object key, accept_default, no_remap;
2c6f1a39 1528{
cc0a8174
JB
1529 Lisp_Object *maps, value;
1530 int nmaps, i;
21a0d7a0
RS
1531 struct gcpro gcpro1;
1532
1533 GCPRO1 (key);
cc0a8174 1534
e784236d
KH
1535 if (!NILP (current_kboard->Voverriding_terminal_local_map))
1536 {
1537 value = Flookup_key (current_kboard->Voverriding_terminal_local_map,
1538 key, accept_default);
1539 if (! NILP (value) && !INTEGERP (value))
0c412762 1540 goto done;
e784236d
KH
1541 }
1542 else if (!NILP (Voverriding_local_map))
2c6f1a39 1543 {
7d92e329 1544 value = Flookup_key (Voverriding_local_map, key, accept_default);
416349ec 1545 if (! NILP (value) && !INTEGERP (value))
0c412762 1546 goto done;
2c6f1a39 1547 }
7d92e329 1548 else
744cd66b 1549 {
d964248c
KH
1550 Lisp_Object local;
1551
d1d070e3
RS
1552 local = get_local_map (PT, current_buffer, Qkeymap);
1553 if (! NILP (local))
1554 {
1555 value = Flookup_key (local, key, accept_default);
1556 if (! NILP (value) && !INTEGERP (value))
0c412762 1557 goto done;
d1d070e3
RS
1558 }
1559
7d92e329 1560 nmaps = current_minor_maps (0, &maps);
21a0d7a0
RS
1561 /* Note that all these maps are GCPRO'd
1562 in the places where we found them. */
1563
7d92e329
RS
1564 for (i = 0; i < nmaps; i++)
1565 if (! NILP (maps[i]))
1566 {
1567 value = Flookup_key (maps[i], key, accept_default);
416349ec 1568 if (! NILP (value) && !INTEGERP (value))
0c412762 1569 goto done;
7d92e329
RS
1570 }
1571
4956d1ef 1572 local = get_local_map (PT, current_buffer, Qlocal_map);
d964248c 1573 if (! NILP (local))
7d92e329 1574 {
d964248c 1575 value = Flookup_key (local, key, accept_default);
416349ec 1576 if (! NILP (value) && !INTEGERP (value))
0c412762 1577 goto done;
7d92e329
RS
1578 }
1579 }
cc0a8174 1580
7c140252 1581 value = Flookup_key (current_global_map, key, accept_default);
0c412762
KS
1582
1583 done:
21a0d7a0 1584 UNGCPRO;
0c412762
KS
1585 if (NILP (value) || INTEGERP (value))
1586 return Qnil;
1587
1588 /* If the result of the ordinary keymap lookup is an interactive
1589 command, look for a key binding (ie. remapping) for that command. */
744cd66b 1590
a1df473f 1591 if (NILP (no_remap) && SYMBOLP (value))
0c412762
KS
1592 {
1593 Lisp_Object value1;
023b93f6 1594 if (value1 = Fcommand_remapping (value), !NILP (value1))
0c412762
KS
1595 value = value1;
1596 }
744cd66b 1597
0c412762 1598 return value;
2c6f1a39
JB
1599}
1600
21a0d7a0
RS
1601/* GC is possible in this function if it autoloads a keymap. */
1602
7c140252 1603DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 2, 0,
335c5470 1604 doc: /* Return the binding for command KEYS in current local keymap only.
7a093e87 1605KEYS is a string or vector, a sequence of keystrokes.
335c5470
PJ
1606The binding is probably a symbol with a function definition.
1607
1608If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1609bindings; see the description of `lookup-key' for more details about this. */)
1610 (keys, accept_default)
7c140252 1611 Lisp_Object keys, accept_default;
2c6f1a39
JB
1612{
1613 register Lisp_Object map;
1614 map = current_buffer->keymap;
265a9e55 1615 if (NILP (map))
2c6f1a39 1616 return Qnil;
7c140252 1617 return Flookup_key (map, keys, accept_default);
2c6f1a39
JB
1618}
1619
21a0d7a0
RS
1620/* GC is possible in this function if it autoloads a keymap. */
1621
7c140252 1622DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 2, 0,
335c5470 1623 doc: /* Return the binding for command KEYS in current global keymap only.
7a093e87 1624KEYS is a string or vector, a sequence of keystrokes.
335c5470 1625The binding is probably a symbol with a function definition.
23715ea6 1626This function's return values are the same as those of `lookup-key'
335c5470
PJ
1627\(which see).
1628
1629If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1630bindings; see the description of `lookup-key' for more details about this. */)
1631 (keys, accept_default)
7c140252 1632 Lisp_Object keys, accept_default;
2c6f1a39 1633{
7c140252 1634 return Flookup_key (current_global_map, keys, accept_default);
2c6f1a39
JB
1635}
1636
21a0d7a0
RS
1637/* GC is possible in this function if it autoloads a keymap. */
1638
7c140252 1639DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 2, 0,
335c5470
PJ
1640 doc: /* Find the visible minor mode bindings of KEY.
1641Return an alist of pairs (MODENAME . BINDING), where MODENAME is the
1642the symbol which names the minor mode binding KEY, and BINDING is
1643KEY's definition in that mode. In particular, if KEY has no
1644minor-mode bindings, return nil. If the first binding is a
1645non-prefix, all subsequent bindings will be omitted, since they would
1646be ignored. Similarly, the list doesn't include non-prefix bindings
1647that come after prefix bindings.
1648
1649If optional argument ACCEPT-DEFAULT is non-nil, recognize default
1650bindings; see the description of `lookup-key' for more details about this. */)
1651 (key, accept_default)
7c140252 1652 Lisp_Object key, accept_default;
cc0a8174
JB
1653{
1654 Lisp_Object *modes, *maps;
1655 int nmaps;
1656 Lisp_Object binding;
1657 int i, j;
21a0d7a0 1658 struct gcpro gcpro1, gcpro2;
cc0a8174
JB
1659
1660 nmaps = current_minor_maps (&modes, &maps);
21a0d7a0
RS
1661 /* Note that all these maps are GCPRO'd
1662 in the places where we found them. */
1663
1664 binding = Qnil;
1665 GCPRO2 (key, binding);
cc0a8174
JB
1666
1667 for (i = j = 0; i < nmaps; i++)
02067692
SM
1668 if (!NILP (maps[i])
1669 && !NILP (binding = Flookup_key (maps[i], key, accept_default))
416349ec 1670 && !INTEGERP (binding))
cc0a8174 1671 {
02067692 1672 if (KEYMAPP (binding))
cc0a8174
JB
1673 maps[j++] = Fcons (modes[i], binding);
1674 else if (j == 0)
21a0d7a0 1675 RETURN_UNGCPRO (Fcons (Fcons (modes[i], binding), Qnil));
cc0a8174
JB
1676 }
1677
21a0d7a0 1678 UNGCPRO;
cc0a8174
JB
1679 return Flist (j, maps);
1680}
1681
7f8f0e67 1682DEFUN ("define-prefix-command", Fdefine_prefix_command, Sdefine_prefix_command, 1, 3, 0,
335c5470
PJ
1683 doc: /* Define COMMAND as a prefix command. COMMAND should be a symbol.
1684A new sparse keymap is stored as COMMAND's function definition and its value.
1685If a second optional argument MAPVAR is given, the map is stored as
1686its value instead of as COMMAND's value; but COMMAND is still defined
1687as a function.
1688The third optional argument NAME, if given, supplies a menu name
a523ade4
LT
1689string for the map. This is required to use the keymap as a menu.
1690This function returns COMMAND. */)
335c5470 1691 (command, mapvar, name)
7f8f0e67 1692 Lisp_Object command, mapvar, name;
2c6f1a39
JB
1693{
1694 Lisp_Object map;
7f8f0e67 1695 map = Fmake_sparse_keymap (name);
88539837 1696 Ffset (command, map);
265a9e55 1697 if (!NILP (mapvar))
2c6f1a39
JB
1698 Fset (mapvar, map);
1699 else
88539837
EN
1700 Fset (command, map);
1701 return command;
2c6f1a39
JB
1702}
1703
1704DEFUN ("use-global-map", Fuse_global_map, Suse_global_map, 1, 1, 0,
335c5470
PJ
1705 doc: /* Select KEYMAP as the global keymap. */)
1706 (keymap)
2c6f1a39
JB
1707 Lisp_Object keymap;
1708{
02067692 1709 keymap = get_keymap (keymap, 1, 1);
2c6f1a39 1710 current_global_map = keymap;
6f27e7a2 1711
2c6f1a39
JB
1712 return Qnil;
1713}
1714
1715DEFUN ("use-local-map", Fuse_local_map, Suse_local_map, 1, 1, 0,
335c5470
PJ
1716 doc: /* Select KEYMAP as the local keymap.
1717If KEYMAP is nil, that means no local keymap. */)
1718 (keymap)
2c6f1a39
JB
1719 Lisp_Object keymap;
1720{
265a9e55 1721 if (!NILP (keymap))
02067692 1722 keymap = get_keymap (keymap, 1, 1);
2c6f1a39
JB
1723
1724 current_buffer->keymap = keymap;
1725
1726 return Qnil;
1727}
1728
1729DEFUN ("current-local-map", Fcurrent_local_map, Scurrent_local_map, 0, 0, 0,
335c5470
PJ
1730 doc: /* Return current buffer's local keymap, or nil if it has none. */)
1731 ()
2c6f1a39
JB
1732{
1733 return current_buffer->keymap;
1734}
1735
1736DEFUN ("current-global-map", Fcurrent_global_map, Scurrent_global_map, 0, 0, 0,
335c5470
PJ
1737 doc: /* Return the current global keymap. */)
1738 ()
2c6f1a39
JB
1739{
1740 return current_global_map;
1741}
cc0a8174
JB
1742
1743DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps, Scurrent_minor_mode_maps, 0, 0, 0,
335c5470
PJ
1744 doc: /* Return a list of keymaps for the minor modes of the current buffer. */)
1745 ()
cc0a8174
JB
1746{
1747 Lisp_Object *maps;
1748 int nmaps = current_minor_maps (0, &maps);
1749
1750 return Flist (nmaps, maps);
1751}
2c6f1a39 1752\f
cc0a8174
JB
1753/* Help functions for describing and documenting keymaps. */
1754
54cbc3d4
SM
1755
1756static void
1757accessible_keymaps_1 (key, cmd, maps, tail, thisseq, is_metized)
1758 Lisp_Object maps, tail, thisseq, key, cmd;
1759 int is_metized; /* If 1, `key' is assumed to be INTEGERP. */
1760{
1761 Lisp_Object tem;
1762
73a4675c 1763 cmd = get_keymap (get_keyelt (cmd, 0), 0, 0);
54cbc3d4
SM
1764 if (NILP (cmd))
1765 return;
1766
73a4675c
SM
1767 /* Look for and break cycles. */
1768 while (!NILP (tem = Frassq (cmd, maps)))
54cbc3d4 1769 {
73a4675c
SM
1770 Lisp_Object prefix = XCAR (tem);
1771 int lim = XINT (Flength (XCAR (tem)));
1772 if (lim <= XINT (Flength (thisseq)))
1773 { /* This keymap was already seen with a smaller prefix. */
1774 int i = 0;
1775 while (i < lim && EQ (Faref (prefix, make_number (i)),
1776 Faref (thisseq, make_number (i))))
1777 i++;
1778 if (i >= lim)
1779 /* `prefix' is a prefix of `thisseq' => there's a cycle. */
1780 return;
54cbc3d4 1781 }
73a4675c
SM
1782 /* This occurrence of `cmd' in `maps' does not correspond to a cycle,
1783 but maybe `cmd' occurs again further down in `maps', so keep
1784 looking. */
1785 maps = XCDR (Fmemq (tem, maps));
1786 }
1787
1788 /* If the last key in thisseq is meta-prefix-char,
1789 turn it into a meta-ized keystroke. We know
1790 that the event we're about to append is an
1791 ascii keystroke since we're processing a
1792 keymap table. */
1793 if (is_metized)
1794 {
1795 int meta_bit = meta_modifier;
1796 Lisp_Object last = make_number (XINT (Flength (thisseq)) - 1);
1797 tem = Fcopy_sequence (thisseq);
f8d8ba40 1798
73a4675c 1799 Faset (tem, last, make_number (XINT (key) | meta_bit));
f8d8ba40 1800
73a4675c
SM
1801 /* This new sequence is the same length as
1802 thisseq, so stick it in the list right
1803 after this one. */
1804 XSETCDR (tail,
1805 Fcons (Fcons (tem, cmd), XCDR (tail)));
1806 }
1807 else
1808 {
1809 tem = append_key (thisseq, key);
1810 nconc2 (tail, Fcons (Fcons (tem, cmd), Qnil));
54cbc3d4
SM
1811 }
1812}
1813
1814static void
1815accessible_keymaps_char_table (args, index, cmd)
1816 Lisp_Object args, index, cmd;
1817{
1818 accessible_keymaps_1 (index, cmd,
1819 XCAR (XCAR (args)),
1820 XCAR (XCDR (args)),
1821 XCDR (XCDR (args)),
1822 XINT (XCDR (XCAR (args))));
1823}
0403641f 1824
21a0d7a0
RS
1825/* This function cannot GC. */
1826
2c6f1a39 1827DEFUN ("accessible-keymaps", Faccessible_keymaps, Saccessible_keymaps,
335c5470
PJ
1828 1, 2, 0,
1829 doc: /* Find all keymaps accessible via prefix characters from KEYMAP.
1830Returns a list of elements of the form (KEYS . MAP), where the sequence
1831KEYS starting from KEYMAP gets you to MAP. These elements are ordered
1832so that the KEYS increase in length. The first element is ([] . KEYMAP).
1833An optional argument PREFIX, if non-nil, should be a key sequence;
1834then the value includes only maps for prefixes that start with PREFIX. */)
1835 (keymap, prefix)
88539837 1836 Lisp_Object keymap, prefix;
2c6f1a39 1837{
fad865a3 1838 Lisp_Object maps, tail;
53c8f9fa
RS
1839 int prefixlen = 0;
1840
21a0d7a0
RS
1841 /* no need for gcpro because we don't autoload any keymaps. */
1842
53c8f9fa
RS
1843 if (!NILP (prefix))
1844 prefixlen = XINT (Flength (prefix));
2c6f1a39 1845
44a4a59b
RS
1846 if (!NILP (prefix))
1847 {
1848 /* If a prefix was specified, start with the keymap (if any) for
1849 that prefix, so we don't waste time considering other prefixes. */
1850 Lisp_Object tem;
88539837 1851 tem = Flookup_key (keymap, prefix, Qt);
1ae2097f
RS
1852 /* Flookup_key may give us nil, or a number,
1853 if the prefix is not defined in this particular map.
1854 It might even give us a list that isn't a keymap. */
02067692
SM
1855 tem = get_keymap (tem, 0, 0);
1856 if (CONSP (tem))
67fc16a3
RS
1857 {
1858 /* Convert PREFIX to a vector now, so that later on
1859 we don't have to deal with the possibility of a string. */
1860 if (STRINGP (prefix))
1861 {
f3ba5409 1862 int i, i_byte, c;
67fc16a3
RS
1863 Lisp_Object copy;
1864
d5db4077
KR
1865 copy = Fmake_vector (make_number (SCHARS (prefix)), Qnil);
1866 for (i = 0, i_byte = 0; i < SCHARS (prefix);)
67fc16a3 1867 {
f3ba5409 1868 int i_before = i;
54e03a4a
KH
1869
1870 FETCH_STRING_CHAR_ADVANCE (c, prefix, i, i_byte);
1871 if (SINGLE_BYTE_CHAR_P (c) && (c & 0200))
1872 c ^= 0200 | meta_modifier;
49801145 1873 ASET (copy, i_before, make_number (c));
67fc16a3
RS
1874 }
1875 prefix = copy;
1876 }
1877 maps = Fcons (Fcons (prefix, tem), Qnil);
1878 }
44a4a59b
RS
1879 else
1880 return Qnil;
1881 }
1882 else
1883 maps = Fcons (Fcons (Fmake_vector (make_number (0), Qnil),
02067692 1884 get_keymap (keymap, 1, 0)),
44a4a59b 1885 Qnil);
2c6f1a39
JB
1886
1887 /* For each map in the list maps,
1888 look at any other maps it points to,
1889 and stick them at the end if they are not already in the list.
1890
1891 This is a breadth-first traversal, where tail is the queue of
1892 nodes, and maps accumulates a list of all nodes visited. */
1893
03699b14 1894 for (tail = maps; CONSP (tail); tail = XCDR (tail))
2c6f1a39 1895 {
e9b6dfb0
KH
1896 register Lisp_Object thisseq, thismap;
1897 Lisp_Object last;
2c6f1a39 1898 /* Does the current sequence end in the meta-prefix-char? */
e9b6dfb0
KH
1899 int is_metized;
1900
1901 thisseq = Fcar (Fcar (tail));
1902 thismap = Fcdr (Fcar (tail));
1903 last = make_number (XINT (Flength (thisseq)) - 1);
1904 is_metized = (XINT (last) >= 0
97ae4b89
RS
1905 /* Don't metize the last char of PREFIX. */
1906 && XINT (last) >= prefixlen
e9b6dfb0 1907 && EQ (Faref (thisseq, last), meta_prefix_char));
2c6f1a39 1908
03699b14 1909 for (; CONSP (thismap); thismap = XCDR (thismap))
2c6f1a39 1910 {
e9b6dfb0
KH
1911 Lisp_Object elt;
1912
03699b14 1913 elt = XCAR (thismap);
2c6f1a39 1914
f5b79c1c
JB
1915 QUIT;
1916
0403641f
RS
1917 if (CHAR_TABLE_P (elt))
1918 {
23cf1efa 1919 Lisp_Object indices[3];
0403641f 1920
fe72189a 1921 map_char_table (accessible_keymaps_char_table, Qnil, elt,
fc18e547 1922 elt, Fcons (Fcons (maps, make_number (is_metized)),
f58c6494 1923 Fcons (tail, thisseq)),
0403641f
RS
1924 0, indices);
1925 }
1926 else if (VECTORP (elt))
2c6f1a39
JB
1927 {
1928 register int i;
1929
1930 /* Vector keymap. Scan all the elements. */
49801145 1931 for (i = 0; i < ASIZE (elt); i++)
54cbc3d4
SM
1932 accessible_keymaps_1 (make_number (i), AREF (elt, i),
1933 maps, tail, thisseq, is_metized);
31bea176 1934
0403641f 1935 }
f5b79c1c 1936 else if (CONSP (elt))
54cbc3d4
SM
1937 accessible_keymaps_1 (XCAR (elt), XCDR (elt),
1938 maps, tail, thisseq,
1939 is_metized && INTEGERP (XCAR (elt)));
31bea176 1940
2c6f1a39 1941 }
2c6f1a39
JB
1942 }
1943
73a4675c 1944 return maps;
2c6f1a39 1945}
0403641f 1946\f
2c6f1a39
JB
1947Lisp_Object Qsingle_key_description, Qkey_description;
1948
21a0d7a0
RS
1949/* This function cannot GC. */
1950
f8d8ba40 1951DEFUN ("key-description", Fkey_description, Skey_description, 1, 2, 0,
335c5470 1952 doc: /* Return a pretty description of key-sequence KEYS.
f8d8ba40 1953Optional arg PREFIX is the sequence of keys leading up to KEYS.
23715ea6 1954Control characters turn into "C-foo" sequences, meta into "M-foo",
335c5470 1955spaces are put between sequence elements, etc. */)
f8d8ba40
KS
1956 (keys, prefix)
1957 Lisp_Object keys, prefix;
2c6f1a39 1958{
6bbd7a29 1959 int len = 0;
f3ba5409 1960 int i, i_byte;
f8d8ba40 1961 Lisp_Object *args;
07f60146 1962 int size = XINT (Flength (keys));
f8d8ba40
KS
1963 Lisp_Object list;
1964 Lisp_Object sep = build_string (" ");
1965 Lisp_Object key;
1966 int add_meta = 0;
1967
1968 if (!NILP (prefix))
07f60146 1969 size += XINT (Flength (prefix));
f8d8ba40
KS
1970
1971 /* This has one extra element at the end that we don't pass to Fconcat. */
1972 args = (Lisp_Object *) alloca (size * 4 * sizeof (Lisp_Object));
1973
1974 /* In effect, this computes
1975 (mapconcat 'single-key-description keys " ")
1976 but we shouldn't use mapconcat because it can do GC. */
4c7d5f13 1977
f8d8ba40
KS
1978 next_list:
1979 if (!NILP (prefix))
1980 list = prefix, prefix = Qnil;
1981 else if (!NILP (keys))
1982 list = keys, keys = Qnil;
1983 else
6ba6e250 1984 {
f8d8ba40 1985 if (add_meta)
6ba6e250 1986 {
f8d8ba40
KS
1987 args[len] = Fsingle_key_description (meta_prefix_char, Qnil);
1988 len += 2;
6ba6e250 1989 }
f8d8ba40
KS
1990 else if (len == 0)
1991 return empty_string;
1992 return Fconcat (len - 1, args);
6ba6e250 1993 }
4c7d5f13 1994
f8d8ba40
KS
1995 if (STRINGP (list))
1996 size = SCHARS (list);
1997 else if (VECTORP (list))
1998 size = XVECTOR (list)->size;
1999 else if (CONSP (list))
07f60146 2000 size = XINT (Flength (list));
f8d8ba40
KS
2001 else
2002 wrong_type_argument (Qarrayp, list);
4c7d5f13 2003
f8d8ba40 2004 i = i_byte = 0;
4c7d5f13 2005
f8d8ba40
KS
2006 while (i < size)
2007 {
2008 if (STRINGP (list))
5c9c2c3f 2009 {
f8d8ba40
KS
2010 int c;
2011 FETCH_STRING_CHAR_ADVANCE (c, list, i, i_byte);
2012 if (SINGLE_BYTE_CHAR_P (c) && (c & 0200))
2013 c ^= 0200 | meta_modifier;
2014 XSETFASTINT (key, c);
2015 }
2016 else if (VECTORP (list))
2017 {
2018 key = AREF (list, i++);
2019 }
2020 else
2021 {
2022 key = XCAR (list);
2023 list = XCDR (list);
2024 i++;
5c9c2c3f 2025 }
5c9c2c3f 2026
f8d8ba40
KS
2027 if (add_meta)
2028 {
2029 if (!INTEGERP (key)
2030 || EQ (key, meta_prefix_char)
2031 || (XINT (key) & meta_modifier))
2032 {
2033 args[len++] = Fsingle_key_description (meta_prefix_char, Qnil);
2034 args[len++] = sep;
2035 if (EQ (key, meta_prefix_char))
2036 continue;
2037 }
2038 else
2039 XSETINT (key, (XINT (key) | meta_modifier) & ~0x80);
2040 add_meta = 0;
2041 }
2042 else if (EQ (key, meta_prefix_char))
5c9c2c3f 2043 {
f8d8ba40
KS
2044 add_meta = 1;
2045 continue;
5c9c2c3f 2046 }
f8d8ba40
KS
2047 args[len++] = Fsingle_key_description (key, Qnil);
2048 args[len++] = sep;
4c7d5f13 2049 }
f8d8ba40 2050 goto next_list;
2c6f1a39
JB
2051}
2052
f8d8ba40 2053
2c6f1a39 2054char *
f1cb0a25 2055push_key_description (c, p, force_multibyte)
2c6f1a39
JB
2056 register unsigned int c;
2057 register char *p;
f1cb0a25 2058 int force_multibyte;
2c6f1a39 2059{
bc89c609 2060 unsigned c2;
31bea176 2061
71ac885b
RS
2062 /* Clear all the meaningless bits above the meta bit. */
2063 c &= meta_modifier | ~ - meta_modifier;
bc89c609
GM
2064 c2 = c & ~(alt_modifier | ctrl_modifier | hyper_modifier
2065 | meta_modifier | shift_modifier | super_modifier);
71ac885b 2066
6ba6e250
RS
2067 if (c & alt_modifier)
2068 {
2069 *p++ = 'A';
2070 *p++ = '-';
2071 c -= alt_modifier;
2072 }
bc89c609
GM
2073 if ((c & ctrl_modifier) != 0
2074 || (c2 < ' ' && c2 != 27 && c2 != '\t' && c2 != Ctl ('M')))
6ba6e250
RS
2075 {
2076 *p++ = 'C';
2077 *p++ = '-';
bc89c609 2078 c &= ~ctrl_modifier;
6ba6e250
RS
2079 }
2080 if (c & hyper_modifier)
2081 {
2082 *p++ = 'H';
2083 *p++ = '-';
2084 c -= hyper_modifier;
2085 }
2086 if (c & meta_modifier)
2c6f1a39
JB
2087 {
2088 *p++ = 'M';
2089 *p++ = '-';
6ba6e250
RS
2090 c -= meta_modifier;
2091 }
2092 if (c & shift_modifier)
2093 {
2094 *p++ = 'S';
2095 *p++ = '-';
2096 c -= shift_modifier;
2097 }
2098 if (c & super_modifier)
2099 {
2100 *p++ = 's';
2101 *p++ = '-';
2102 c -= super_modifier;
2c6f1a39
JB
2103 }
2104 if (c < 040)
2105 {
2106 if (c == 033)
2107 {
2108 *p++ = 'E';
2109 *p++ = 'S';
2110 *p++ = 'C';
2111 }
6ba6e250 2112 else if (c == '\t')
2c6f1a39
JB
2113 {
2114 *p++ = 'T';
2115 *p++ = 'A';
2116 *p++ = 'B';
2117 }
b8cab006 2118 else if (c == Ctl ('M'))
2c6f1a39
JB
2119 {
2120 *p++ = 'R';
2121 *p++ = 'E';
2122 *p++ = 'T';
2123 }
2124 else
2125 {
bc89c609 2126 /* `C-' already added above. */
2c6f1a39
JB
2127 if (c > 0 && c <= Ctl ('Z'))
2128 *p++ = c + 0140;
2129 else
2130 *p++ = c + 0100;
2131 }
2132 }
2133 else if (c == 0177)
2134 {
2135 *p++ = 'D';
2136 *p++ = 'E';
2137 *p++ = 'L';
2138 }
2139 else if (c == ' ')
9fb71293 2140 {
2c6f1a39
JB
2141 *p++ = 'S';
2142 *p++ = 'P';
2143 *p++ = 'C';
2144 }
d3c00496
KH
2145 else if (c < 128
2146 || (NILP (current_buffer->enable_multibyte_characters)
f1cb0a25
GM
2147 && SINGLE_BYTE_CHAR_P (c)
2148 && !force_multibyte))
2149 {
2150 *p++ = c;
2151 }
6ba6e250
RS
2152 else
2153 {
f1cb0a25 2154 int valid_p = SINGLE_BYTE_CHAR_P (c) || char_valid_p (c, 0);
31bea176 2155
f1cb0a25
GM
2156 if (force_multibyte && valid_p)
2157 {
2158 if (SINGLE_BYTE_CHAR_P (c))
2159 c = unibyte_char_to_multibyte (c);
2160 p += CHAR_STRING (c, p);
2161 }
2162 else if (NILP (current_buffer->enable_multibyte_characters)
2163 || valid_p)
9fb71293
KH
2164 {
2165 int bit_offset;
2166 *p++ = '\\';
2167 /* The biggest character code uses 19 bits. */
2168 for (bit_offset = 18; bit_offset >= 0; bit_offset -= 3)
2169 {
2170 if (c >= (1 << bit_offset))
2171 *p++ = ((c & (7 << bit_offset)) >> bit_offset) + '0';
2172 }
2173 }
2174 else
f1cb0a25 2175 p += CHAR_STRING (c, p);
6ba6e250 2176 }
2c6f1a39 2177
d55627cc 2178 return p;
2c6f1a39
JB
2179}
2180
21a0d7a0
RS
2181/* This function cannot GC. */
2182
c1848a97
GM
2183DEFUN ("single-key-description", Fsingle_key_description,
2184 Ssingle_key_description, 1, 2, 0,
335c5470
PJ
2185 doc: /* Return a pretty description of command character KEY.
2186Control characters turn into C-whatever, etc.
2187Optional argument NO-ANGLES non-nil means don't put angle brackets
2188around function keys and event symbols. */)
2189 (key, no_angles)
c1848a97 2190 Lisp_Object key, no_angles;
2c6f1a39 2191{
5c9c2c3f
RS
2192 if (CONSP (key) && lucid_event_type_list_p (key))
2193 key = Fevent_convert_list (key);
2194
cebd887d 2195 key = EVENT_HEAD (key);
6bbbd9b0 2196
e958fd9a 2197 if (INTEGERP (key)) /* Normal character */
2c6f1a39 2198 {
47a18cef 2199 unsigned int charset, c1, c2;
f4977051 2200 int without_bits = XINT (key) & ~((-1) << CHARACTERBITS);
47a18cef 2201
f4977051 2202 if (SINGLE_BYTE_CHAR_P (without_bits))
47a18cef
RS
2203 charset = 0;
2204 else
54e03a4a 2205 SPLIT_CHAR (without_bits, charset, c1, c2);
47a18cef
RS
2206
2207 if (charset
9fb71293 2208 && CHARSET_DEFINED_P (charset)
47a18cef
RS
2209 && ((c1 >= 0 && c1 < 32)
2210 || (c2 >= 0 && c2 < 32)))
2211 {
2212 /* Handle a generic character. */
2213 Lisp_Object name;
2214 name = CHARSET_TABLE_INFO (charset, CHARSET_LONG_NAME_IDX);
b7826503 2215 CHECK_STRING (name);
47a18cef
RS
2216 return concat2 (build_string ("Character set "), name);
2217 }
2218 else
2219 {
3d9d7a9b
GM
2220 char tem[KEY_DESCRIPTION_SIZE], *end;
2221 int nbytes, nchars;
2222 Lisp_Object string;
2223
2224 end = push_key_description (XUINT (key), tem, 1);
2225 nbytes = end - tem;
2226 nchars = multibyte_chars_in_text (tem, nbytes);
2227 if (nchars == nbytes)
e15e2828
GM
2228 {
2229 *end = '\0';
2230 string = build_string (tem);
2231 }
3d9d7a9b
GM
2232 else
2233 string = make_multibyte_string (tem, nchars, nbytes);
2234 return string;
47a18cef 2235 }
2c6f1a39 2236 }
e958fd9a 2237 else if (SYMBOLP (key)) /* Function key or event-symbol */
c7edb960 2238 {
c1848a97
GM
2239 if (NILP (no_angles))
2240 {
2241 char *buffer
d5db4077
KR
2242 = (char *) alloca (SBYTES (SYMBOL_NAME (key)) + 5);
2243 sprintf (buffer, "<%s>", SDATA (SYMBOL_NAME (key)));
c1848a97
GM
2244 return build_string (buffer);
2245 }
2246 else
2247 return Fsymbol_name (key);
c7edb960 2248 }
e958fd9a
KH
2249 else if (STRINGP (key)) /* Buffer names in the menubar. */
2250 return Fcopy_sequence (key);
2251 else
2252 error ("KEY must be an integer, cons, symbol, or string");
6bbd7a29 2253 return Qnil;
2c6f1a39
JB
2254}
2255
2256char *
2257push_text_char_description (c, p)
2258 register unsigned int c;
2259 register char *p;
2260{
2261 if (c >= 0200)
2262 {
2263 *p++ = 'M';
2264 *p++ = '-';
2265 c -= 0200;
2266 }
2267 if (c < 040)
2268 {
2269 *p++ = '^';
2270 *p++ = c + 64; /* 'A' - 1 */
2271 }
2272 else if (c == 0177)
2273 {
2274 *p++ = '^';
2275 *p++ = '?';
2276 }
2277 else
2278 *p++ = c;
d55627cc 2279 return p;
2c6f1a39
JB
2280}
2281
21a0d7a0
RS
2282/* This function cannot GC. */
2283
2c6f1a39 2284DEFUN ("text-char-description", Ftext_char_description, Stext_char_description, 1, 1, 0,
335c5470 2285 doc: /* Return a pretty description of file-character CHARACTER.
bda67d96
LT
2286Control characters turn into "^char", etc. This differs from
2287`single-key-description' which turns them into "C-char".
2288Also, this function recognizes the 2**7 bit as the Meta character,
2289whereas `single-key-description' uses the 2**27 bit for Meta.
2290See Info node `(elisp)Describing Characters' for examples. */)
335c5470 2291 (character)
88539837 2292 Lisp_Object character;
2c6f1a39 2293{
0a16479f
KH
2294 /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */
2295 unsigned char str[6];
2296 int c;
2c6f1a39 2297
b7826503 2298 CHECK_NUMBER (character);
2c6f1a39 2299
0a16479f
KH
2300 c = XINT (character);
2301 if (!SINGLE_BYTE_CHAR_P (c))
a98f1d1d 2302 {
0a16479f 2303 int len = CHAR_STRING (c, str);
a98f1d1d 2304
f3ba5409 2305 return make_multibyte_string (str, 1, len);
a98f1d1d
KH
2306 }
2307
0a16479f 2308 *push_text_char_description (c & 0377, str) = 0;
2c6f1a39 2309
0a16479f 2310 return build_string (str);
2c6f1a39 2311}
2fc66973
JB
2312
2313/* Return non-zero if SEQ contains only ASCII characters, perhaps with
2314 a meta bit. */
2315static int
2316ascii_sequence_p (seq)
2317 Lisp_Object seq;
2318{
6e344130 2319 int i;
2fc66973 2320 int len = XINT (Flength (seq));
ffab2bd6 2321
6e344130 2322 for (i = 0; i < len; i++)
2fc66973 2323 {
6e344130 2324 Lisp_Object ii, elt;
ffab2bd6 2325
6e344130
KH
2326 XSETFASTINT (ii, i);
2327 elt = Faref (seq, ii);
2fc66973 2328
416349ec 2329 if (!INTEGERP (elt)
2fc66973
JB
2330 || (XUINT (elt) & ~CHAR_META) >= 0x80)
2331 return 0;
2332 }
2333
2334 return 1;
2335}
2336
2c6f1a39 2337\f
cc0a8174
JB
2338/* where-is - finding a command in a set of keymaps. */
2339
0c412762 2340static Lisp_Object where_is_internal ();
0403641f 2341static Lisp_Object where_is_internal_1 ();
69248761 2342static void where_is_internal_2 ();
0403641f 2343
49801145
SM
2344/* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map.
2345 Returns the first non-nil binding found in any of those maps. */
2346
2347static Lisp_Object
2348shadow_lookup (shadow, key, flag)
2349 Lisp_Object shadow, key, flag;
2350{
2351 Lisp_Object tail, value;
2352
2353 for (tail = shadow; CONSP (tail); tail = XCDR (tail))
2354 {
2355 value = Flookup_key (XCAR (tail), key, flag);
2356 if (!NILP (value) && !NATNUMP (value))
2357 return value;
2358 }
2359 return Qnil;
2360}
2361
9d209cfe 2362static Lisp_Object Vmouse_events;
d378869e 2363
49801145
SM
2364/* This function can GC if Flookup_key autoloads any keymaps. */
2365
1e7d1ab0 2366static Lisp_Object
0c412762 2367where_is_internal (definition, keymaps, firstonly, noindirect, no_remap)
1e7d1ab0 2368 Lisp_Object definition, keymaps;
0c412762 2369 Lisp_Object firstonly, noindirect, no_remap;
2c6f1a39 2370{
49801145 2371 Lisp_Object maps = Qnil;
0403641f 2372 Lisp_Object found, sequences;
21a0d7a0 2373 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
0bc395d4
RS
2374 /* 1 means ignore all menu bindings entirely. */
2375 int nomenus = !NILP (firstonly) && !EQ (firstonly, Qnon_ascii);
2c6f1a39 2376
0c412762
KS
2377 /* If this command is remapped, then it has no key bindings
2378 of its own. */
a1df473f
KS
2379 if (NILP (no_remap) && SYMBOLP (definition))
2380 {
2381 Lisp_Object tem;
023b93f6 2382 if (tem = Fcommand_remapping (definition), !NILP (tem))
a1df473f
KS
2383 return Qnil;
2384 }
0c412762 2385
49801145
SM
2386 found = keymaps;
2387 while (CONSP (found))
93d2aa1c 2388 {
49801145 2389 maps =
02067692
SM
2390 nconc2 (maps,
2391 Faccessible_keymaps (get_keymap (XCAR (found), 1, 0), Qnil));
49801145 2392 found = XCDR (found);
93d2aa1c 2393 }
31bea176 2394
49801145 2395 GCPRO5 (definition, keymaps, maps, found, sequences);
2c6f1a39 2396 found = Qnil;
0403641f 2397 sequences = Qnil;
2c6f1a39 2398
265a9e55 2399 for (; !NILP (maps); maps = Fcdr (maps))
2c6f1a39 2400 {
e9b6dfb0 2401 /* Key sequence to reach map, and the map that it reaches */
d378869e 2402 register Lisp_Object this, map, tem;
f5b79c1c 2403
2c6f1a39
JB
2404 /* In order to fold [META-PREFIX-CHAR CHAR] sequences into
2405 [M-CHAR] sequences, check if last character of the sequence
2406 is the meta-prefix char. */
e9b6dfb0
KH
2407 Lisp_Object last;
2408 int last_is_meta;
2409
2410 this = Fcar (Fcar (maps));
2411 map = Fcdr (Fcar (maps));
2412 last = make_number (XINT (Flength (this)) - 1);
2413 last_is_meta = (XINT (last) >= 0
2414 && EQ (Faref (this, last), meta_prefix_char));
2c6f1a39 2415
2ba11bbd 2416 /* if (nomenus && !ascii_sequence_p (this)) */
f58c6494 2417 if (nomenus && XINT (last) >= 0
d378869e 2418 && SYMBOLP (tem = Faref (this, make_number (0)))
9d209cfe 2419 && !NILP (Fmemq (XCAR (parse_modifiers (tem)), Vmouse_events)))
88416888
SM
2420 /* If no menu entries should be returned, skip over the
2421 keymaps bound to `menu-bar' and `tool-bar' and other
2ba11bbd 2422 non-ascii prefixes like `C-down-mouse-2'. */
88416888 2423 continue;
31bea176 2424
fde3a52f
JB
2425 QUIT;
2426
f5b79c1c 2427 while (CONSP (map))
2c6f1a39 2428 {
f5b79c1c
JB
2429 /* Because the code we want to run on each binding is rather
2430 large, we don't want to have two separate loop bodies for
2431 sparse keymap bindings and tables; we want to iterate one
2432 loop body over both keymap and vector bindings.
2433
2434 For this reason, if Fcar (map) is a vector, we don't
2435 advance map to the next element until i indicates that we
2436 have finished off the vector. */
21a0d7a0 2437 Lisp_Object elt, key, binding;
03699b14
KR
2438 elt = XCAR (map);
2439 map = XCDR (map);
0403641f
RS
2440
2441 sequences = Qnil;
f5b79c1c 2442
fde3a52f
JB
2443 QUIT;
2444
f5b79c1c
JB
2445 /* Set key and binding to the current key and binding, and
2446 advance map and i to the next binding. */
416349ec 2447 if (VECTORP (elt))
2c6f1a39 2448 {
0403641f
RS
2449 Lisp_Object sequence;
2450 int i;
2c6f1a39 2451 /* In a vector, look at each element. */
0403641f 2452 for (i = 0; i < XVECTOR (elt)->size; i++)
2c6f1a39 2453 {
49801145 2454 binding = AREF (elt, i);
0403641f
RS
2455 XSETFASTINT (key, i);
2456 sequence = where_is_internal_1 (binding, key, definition,
49801145 2457 noindirect, this,
0403641f
RS
2458 last, nomenus, last_is_meta);
2459 if (!NILP (sequence))
2460 sequences = Fcons (sequence, sequences);
2c6f1a39 2461 }
f5b79c1c 2462 }
0403641f 2463 else if (CHAR_TABLE_P (elt))
f5b79c1c 2464 {
23cf1efa 2465 Lisp_Object indices[3];
0403641f 2466 Lisp_Object args;
23cf1efa 2467
0403641f 2468 args = Fcons (Fcons (Fcons (definition, noindirect),
49801145 2469 Qnil), /* Result accumulator. */
0403641f
RS
2470 Fcons (Fcons (this, last),
2471 Fcons (make_number (nomenus),
2472 make_number (last_is_meta))));
fe72189a 2473 map_char_table (where_is_internal_2, Qnil, elt, elt, args,
0403641f 2474 0, indices);
49801145 2475 sequences = XCDR (XCAR (args));
2c6f1a39 2476 }
0403641f 2477 else if (CONSP (elt))
fde3a52f 2478 {
0403641f 2479 Lisp_Object sequence;
2c6f1a39 2480
03699b14
KR
2481 key = XCAR (elt);
2482 binding = XCDR (elt);
2c6f1a39 2483
0403641f 2484 sequence = where_is_internal_1 (binding, key, definition,
49801145 2485 noindirect, this,
0403641f
RS
2486 last, nomenus, last_is_meta);
2487 if (!NILP (sequence))
2488 sequences = Fcons (sequence, sequences);
2c6f1a39 2489 }
2c6f1a39 2490
2c6f1a39 2491
0c412762 2492 while (!NILP (sequences))
2c6f1a39 2493 {
a1df473f 2494 Lisp_Object sequence, remapped, function;
0403641f 2495
03699b14 2496 sequence = XCAR (sequences);
0c412762
KS
2497 sequences = XCDR (sequences);
2498
a1df473f
KS
2499 /* If the current sequence is a command remapping with
2500 format [remap COMMAND], find the key sequences
2501 which run COMMAND, and use those sequences instead. */
0c412762
KS
2502 remapped = Qnil;
2503 if (NILP (no_remap)
a1df473f
KS
2504 && VECTORP (sequence) && XVECTOR (sequence)->size == 2
2505 && EQ (AREF (sequence, 0), Qremap)
2506 && (function = AREF (sequence, 1), SYMBOLP (function)))
0c412762 2507 {
a1df473f 2508 Lisp_Object remapped1;
0c412762 2509
a1df473f
KS
2510 remapped1 = where_is_internal (function, keymaps, firstonly, noindirect, Qt);
2511 if (CONSP (remapped1))
0c412762 2512 {
a1df473f
KS
2513 /* Verify that this key binding actually maps to the
2514 remapped command (see below). */
2515 if (!EQ (shadow_lookup (keymaps, XCAR (remapped1), Qnil), function))
2516 continue;
2517 sequence = XCAR (remapped1);
2518 remapped = XCDR (remapped1);
2519 goto record_sequence;
0c412762
KS
2520 }
2521 }
0403641f 2522
49801145
SM
2523 /* Verify that this key binding is not shadowed by another
2524 binding for the same key, before we say it exists.
2525
2526 Mechanism: look for local definition of this key and if
2527 it is defined and does not match what we found then
2528 ignore this key.
2529
2530 Either nil or number as value from Flookup_key
2531 means undefined. */
1e7d1ab0 2532 if (!EQ (shadow_lookup (keymaps, sequence, Qnil), definition))
49801145
SM
2533 continue;
2534
0c412762 2535 record_sequence:
0403641f
RS
2536 /* It is a true unshadowed match. Record it, unless it's already
2537 been seen (as could happen when inheriting keymaps). */
2538 if (NILP (Fmember (sequence, found)))
2539 found = Fcons (sequence, found);
2540
2541 /* If firstonly is Qnon_ascii, then we can return the first
2542 binding we find. If firstonly is not Qnon_ascii but not
2543 nil, then we should return the first ascii-only binding
2544 we find. */
2545 if (EQ (firstonly, Qnon_ascii))
2546 RETURN_UNGCPRO (sequence);
54cbc3d4 2547 else if (!NILP (firstonly) && ascii_sequence_p (sequence))
0403641f 2548 RETURN_UNGCPRO (sequence);
0c412762
KS
2549
2550 if (CONSP (remapped))
2551 {
2552 sequence = XCAR (remapped);
2553 remapped = XCDR (remapped);
2554 goto record_sequence;
2555 }
2c6f1a39 2556 }
2c6f1a39
JB
2557 }
2558 }
2fc66973 2559
21a0d7a0
RS
2560 UNGCPRO;
2561
2fc66973
JB
2562 found = Fnreverse (found);
2563
2564 /* firstonly may have been t, but we may have gone all the way through
2565 the keymaps without finding an all-ASCII key sequence. So just
2566 return the best we could find. */
54cbc3d4 2567 if (!NILP (firstonly))
2fc66973 2568 return Fcar (found);
31bea176 2569
2fc66973 2570 return found;
2c6f1a39 2571}
0403641f 2572
0c412762 2573DEFUN ("where-is-internal", Fwhere_is_internal, Swhere_is_internal, 1, 5, 0,
335c5470
PJ
2574 doc: /* Return list of keys that invoke DEFINITION.
2575If KEYMAP is non-nil, search only KEYMAP and the global keymap.
2576If KEYMAP is nil, search all the currently active keymaps.
2577If KEYMAP is a list of keymaps, search only those keymaps.
2578
2579If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,
2580rather than a list of all possible key sequences.
2581If FIRSTONLY is the symbol `non-ascii', return the first binding found,
2582no matter what it is.
2583If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters,
2584and entirely reject menu bindings.
2585
2586If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
2587to other keymaps or slots. This makes it possible to search for an
0c412762
KS
2588indirect definition itself.
2589
2590If optional 5th arg NO-REMAP is non-nil, don't search for key sequences
2591that invoke a command which is remapped to DEFINITION, but include the
2592remapped command in the returned list. */)
2593 (definition, keymap, firstonly, noindirect, no_remap)
4956d1ef 2594 Lisp_Object definition, keymap;
0c412762 2595 Lisp_Object firstonly, noindirect, no_remap;
1e7d1ab0
SM
2596{
2597 Lisp_Object sequences, keymaps;
1e7d1ab0
SM
2598 /* 1 means ignore all menu bindings entirely. */
2599 int nomenus = !NILP (firstonly) && !EQ (firstonly, Qnon_ascii);
f9aaedb6 2600 Lisp_Object result;
1e7d1ab0
SM
2601
2602 /* Find the relevant keymaps. */
4956d1ef
GM
2603 if (CONSP (keymap) && KEYMAPP (XCAR (keymap)))
2604 keymaps = keymap;
54cbc3d4 2605 else if (!NILP (keymap))
4956d1ef 2606 keymaps = Fcons (keymap, Fcons (current_global_map, Qnil));
1e7d1ab0 2607 else
54cbc3d4 2608 keymaps = Fcurrent_active_maps (Qnil);
1e7d1ab0
SM
2609
2610 /* Only use caching for the menubar (i.e. called with (def nil t nil).
4956d1ef
GM
2611 We don't really need to check `keymap'. */
2612 if (nomenus && NILP (noindirect) && NILP (keymap))
1e7d1ab0 2613 {
f9aaedb6 2614 Lisp_Object *defns;
60dc6558 2615 int i, j, n;
0c412762 2616 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
744cd66b 2617
1e7d1ab0
SM
2618 /* Check heuristic-consistency of the cache. */
2619 if (NILP (Fequal (keymaps, where_is_cache_keymaps)))
2620 where_is_cache = Qnil;
2621
2622 if (NILP (where_is_cache))
2623 {
2624 /* We need to create the cache. */
2625 Lisp_Object args[2];
2626 where_is_cache = Fmake_hash_table (0, args);
2627 where_is_cache_keymaps = Qt;
31bea176 2628
1e7d1ab0 2629 /* Fill in the cache. */
0c412762
KS
2630 GCPRO5 (definition, keymaps, firstonly, noindirect, no_remap);
2631 where_is_internal (definition, keymaps, firstonly, noindirect, no_remap);
1e7d1ab0
SM
2632 UNGCPRO;
2633
2634 where_is_cache_keymaps = keymaps;
2635 }
2636
f9aaedb6
GM
2637 /* We want to process definitions from the last to the first.
2638 Instead of consing, copy definitions to a vector and step
2639 over that vector. */
1e7d1ab0 2640 sequences = Fgethash (definition, where_is_cache, Qnil);
f58c6494 2641 n = XINT (Flength (sequences));
f9aaedb6
GM
2642 defns = (Lisp_Object *) alloca (n * sizeof *defns);
2643 for (i = 0; CONSP (sequences); sequences = XCDR (sequences))
2644 defns[i++] = XCAR (sequences);
31bea176 2645
f9aaedb6
GM
2646 /* Verify that the key bindings are not shadowed. Note that
2647 the following can GC. */
2648 GCPRO2 (definition, keymaps);
2649 result = Qnil;
60dc6558 2650 j = -1;
f9aaedb6 2651 for (i = n - 1; i >= 0; --i)
60dc6558
SM
2652 if (EQ (shadow_lookup (keymaps, defns[i], Qnil), definition))
2653 {
2654 if (ascii_sequence_p (defns[i]))
2655 break;
2656 else if (j < 0)
2657 j = i;
2658 }
f9aaedb6 2659
60dc6558 2660 result = i >= 0 ? defns[i] : (j >= 0 ? defns[j] : Qnil);
f9aaedb6 2661 UNGCPRO;
1e7d1ab0
SM
2662 }
2663 else
2664 {
2665 /* Kill the cache so that where_is_internal_1 doesn't think
2666 we're filling it up. */
2667 where_is_cache = Qnil;
0c412762 2668 result = where_is_internal (definition, keymaps, firstonly, noindirect, no_remap);
1e7d1ab0 2669 }
f9aaedb6
GM
2670
2671 return result;
1e7d1ab0
SM
2672}
2673
0403641f
RS
2674/* This is the function that Fwhere_is_internal calls using map_char_table.
2675 ARGS has the form
2676 (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT))
2677 .
2678 ((THIS . LAST) . (NOMENUS . LAST_IS_META)))
2679 Since map_char_table doesn't really use the return value from this function,
df75b1a3
GM
2680 we the result append to RESULT, the slot in ARGS.
2681
2682 This function can GC because it calls where_is_internal_1 which can
2683 GC. */
0403641f 2684
69248761 2685static void
0403641f
RS
2686where_is_internal_2 (args, key, binding)
2687 Lisp_Object args, key, binding;
2688{
49801145 2689 Lisp_Object definition, noindirect, this, last;
0403641f
RS
2690 Lisp_Object result, sequence;
2691 int nomenus, last_is_meta;
df75b1a3 2692 struct gcpro gcpro1, gcpro2, gcpro3;
0403641f 2693
df75b1a3 2694 GCPRO3 (args, key, binding);
49801145 2695 result = XCDR (XCAR (args));
03699b14
KR
2696 definition = XCAR (XCAR (XCAR (args)));
2697 noindirect = XCDR (XCAR (XCAR (args)));
03699b14
KR
2698 this = XCAR (XCAR (XCDR (args)));
2699 last = XCDR (XCAR (XCDR (args)));
2700 nomenus = XFASTINT (XCAR (XCDR (XCDR (args))));
2701 last_is_meta = XFASTINT (XCDR (XCDR (XCDR (args))));
0403641f 2702
49801145 2703 sequence = where_is_internal_1 (binding, key, definition, noindirect,
0403641f
RS
2704 this, last, nomenus, last_is_meta);
2705
2706 if (!NILP (sequence))
f3fbd155 2707 XSETCDR (XCAR (args), Fcons (sequence, result));
df75b1a3
GM
2708
2709 UNGCPRO;
0403641f
RS
2710}
2711
df75b1a3 2712
49801145 2713/* This function cannot GC. */
df75b1a3 2714
0403641f 2715static Lisp_Object
49801145 2716where_is_internal_1 (binding, key, definition, noindirect, this, last,
0403641f 2717 nomenus, last_is_meta)
49801145 2718 Lisp_Object binding, key, definition, noindirect, this, last;
0403641f
RS
2719 int nomenus, last_is_meta;
2720{
2721 Lisp_Object sequence;
0403641f
RS
2722
2723 /* Search through indirections unless that's not wanted. */
2724 if (NILP (noindirect))
35810b6f 2725 binding = get_keyelt (binding, 0);
0403641f
RS
2726
2727 /* End this iteration if this element does not match
2728 the target. */
2729
1e7d1ab0
SM
2730 if (!(!NILP (where_is_cache) /* everything "matches" during cache-fill. */
2731 || EQ (binding, definition)
2732 || (CONSP (definition) && !NILP (Fequal (binding, definition)))))
2733 /* Doesn't match. */
2734 return Qnil;
0403641f 2735
1e7d1ab0 2736 /* We have found a match. Construct the key sequence where we found it. */
0403641f
RS
2737 if (INTEGERP (key) && last_is_meta)
2738 {
2739 sequence = Fcopy_sequence (this);
2740 Faset (sequence, last, make_number (XINT (key) | meta_modifier));
2741 }
2742 else
2743 sequence = append_key (this, key);
2744
1e7d1ab0
SM
2745 if (!NILP (where_is_cache))
2746 {
2747 Lisp_Object sequences = Fgethash (binding, where_is_cache, Qnil);
2748 Fputhash (binding, Fcons (sequence, sequences), where_is_cache);
2749 return Qnil;
2750 }
2751 else
2752 return sequence;
0403641f 2753}
2c6f1a39 2754\f
cc0a8174
JB
2755/* describe-bindings - summarizing all the bindings in a set of keymaps. */
2756
54cbc3d4 2757DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings, Sdescribe_buffer_bindings, 1, 3, 0,
335c5470
PJ
2758 doc: /* Insert the list of all defined keys and their definitions.
2759The list is inserted in the current buffer, while the bindings are
2760looked up in BUFFER.
2761The optional argument PREFIX, if non-nil, should be a key sequence;
2762then we display only bindings that start with that prefix.
2763The optional argument MENUS, if non-nil, says to mention menu bindings.
2764\(Ordinarily these are omitted from the output.) */)
2765 (buffer, prefix, menus)
54cbc3d4 2766 Lisp_Object buffer, prefix, menus;
2c6f1a39 2767{
54cbc3d4
SM
2768 Lisp_Object outbuf, shadow;
2769 int nomenu = NILP (menus);
d7ab90a9
KH
2770 register Lisp_Object start1;
2771 struct gcpro gcpro1;
2c6f1a39 2772
4726a9f1
JB
2773 char *alternate_heading
2774 = "\
6cec169a
RS
2775Keyboard translations:\n\n\
2776You type Translation\n\
2777-------- -----------\n";
2c6f1a39 2778
a588e041 2779 shadow = Qnil;
d7ab90a9 2780 GCPRO1 (shadow);
53c8f9fa 2781
36ca6189 2782 outbuf = Fcurrent_buffer ();
2c6f1a39 2783
4726a9f1 2784 /* Report on alternates for keys. */
d7bf9bf5 2785 if (STRINGP (Vkeyboard_translate_table) && !NILP (prefix))
4726a9f1
JB
2786 {
2787 int c;
3141e0ab 2788 const unsigned char *translate = SDATA (Vkeyboard_translate_table);
d5db4077 2789 int translate_len = SCHARS (Vkeyboard_translate_table);
4726a9f1
JB
2790
2791 for (c = 0; c < translate_len; c++)
2792 if (translate[c] != c)
2793 {
d2d9586a 2794 char buf[KEY_DESCRIPTION_SIZE];
4726a9f1
JB
2795 char *bufend;
2796
2797 if (alternate_heading)
2798 {
2799 insert_string (alternate_heading);
2800 alternate_heading = 0;
2801 }
2802
f1cb0a25 2803 bufend = push_key_description (translate[c], buf, 1);
4726a9f1
JB
2804 insert (buf, bufend - buf);
2805 Findent_to (make_number (16), make_number (1));
f1cb0a25 2806 bufend = push_key_description (c, buf, 1);
4726a9f1
JB
2807 insert (buf, bufend - buf);
2808
2809 insert ("\n", 1);
2810 }
2811
2812 insert ("\n", 1);
2813 }
2814
d7bf9bf5
RS
2815 if (!NILP (Vkey_translation_map))
2816 describe_map_tree (Vkey_translation_map, 0, Qnil, prefix,
6cec169a 2817 "Key translations", nomenu, 1, 0);
d7bf9bf5 2818
cc0a8174 2819
53c8f9fa 2820 /* Print the (major mode) local map. */
36ca6189 2821 start1 = Qnil;
e784236d
KH
2822 if (!NILP (current_kboard->Voverriding_terminal_local_map))
2823 start1 = current_kboard->Voverriding_terminal_local_map;
2824 else if (!NILP (Voverriding_local_map))
7d92e329 2825 start1 = Voverriding_local_map;
7d92e329 2826
265a9e55 2827 if (!NILP (start1))
2c6f1a39 2828 {
91f64ec2 2829 describe_map_tree (start1, 1, shadow, prefix,
36ca6189 2830 "\f\nOverriding Bindings", nomenu, 0, 0);
53c8f9fa 2831 shadow = Fcons (start1, shadow);
2c6f1a39 2832 }
36ca6189
RS
2833 else
2834 {
2835 /* Print the minor mode and major mode keymaps. */
2836 int i, nmaps;
2837 Lisp_Object *modes, *maps;
2838
2839 /* Temporarily switch to `buffer', so that we can get that buffer's
2840 minor modes correctly. */
2841 Fset_buffer (buffer);
2842
2843 nmaps = current_minor_maps (&modes, &maps);
2844 Fset_buffer (outbuf);
2845
d1d070e3
RS
2846 start1 = get_local_map (BUF_PT (XBUFFER (buffer)),
2847 XBUFFER (buffer), Qkeymap);
2848 if (!NILP (start1))
2849 {
2850 describe_map_tree (start1, 1, shadow, prefix,
2851 "\f\n`keymap' Property Bindings", nomenu, 0, 0);
2852 shadow = Fcons (start1, shadow);
2853 }
2854
36ca6189
RS
2855 /* Print the minor mode maps. */
2856 for (i = 0; i < nmaps; i++)
2857 {
2858 /* The title for a minor mode keymap
2859 is constructed at run time.
2860 We let describe_map_tree do the actual insertion
2861 because it takes care of other features when doing so. */
2862 char *title, *p;
2863
2864 if (!SYMBOLP (modes[i]))
2865 abort();
2866
d5db4077 2867 p = title = (char *) alloca (42 + SCHARS (SYMBOL_NAME (modes[i])));
36ca6189
RS
2868 *p++ = '\f';
2869 *p++ = '\n';
2870 *p++ = '`';
d5db4077
KR
2871 bcopy (SDATA (SYMBOL_NAME (modes[i])), p,
2872 SCHARS (SYMBOL_NAME (modes[i])));
2873 p += SCHARS (SYMBOL_NAME (modes[i]));
36ca6189
RS
2874 *p++ = '\'';
2875 bcopy (" Minor Mode Bindings", p, sizeof (" Minor Mode Bindings") - 1);
2876 p += sizeof (" Minor Mode Bindings") - 1;
2877 *p = 0;
2878
2879 describe_map_tree (maps[i], 1, shadow, prefix, title, nomenu, 0, 0);
2880 shadow = Fcons (maps[i], shadow);
2881 }
2882
36ca6189
RS
2883 start1 = get_local_map (BUF_PT (XBUFFER (buffer)),
2884 XBUFFER (buffer), Qlocal_map);
2885 if (!NILP (start1))
2886 {
2887 if (EQ (start1, XBUFFER (buffer)->keymap))
2888 describe_map_tree (start1, 1, shadow, prefix,
2889 "\f\nMajor Mode Bindings", nomenu, 0, 0);
2890 else
2891 describe_map_tree (start1, 1, shadow, prefix,
d1d070e3
RS
2892 "\f\n`local-map' Property Bindings",
2893 nomenu, 0, 0);
36ca6189
RS
2894
2895 shadow = Fcons (start1, shadow);
2896 }
2897 }
2c6f1a39 2898
91f64ec2 2899 describe_map_tree (current_global_map, 1, shadow, prefix,
97d4edaa 2900 "\f\nGlobal Bindings", nomenu, 0, 1);
d7bf9bf5
RS
2901
2902 /* Print the function-key-map translations under this prefix. */
2903 if (!NILP (Vfunction_key_map))
2904 describe_map_tree (Vfunction_key_map, 0, Qnil, prefix,
97d4edaa 2905 "\f\nFunction key map translations", nomenu, 1, 0);
2c6f1a39 2906
d7ab90a9 2907 UNGCPRO;
2c6f1a39
JB
2908 return Qnil;
2909}
2910
b31a4218 2911/* Insert a description of the key bindings in STARTMAP,
2c6f1a39
JB
2912 followed by those of all maps reachable through STARTMAP.
2913 If PARTIAL is nonzero, omit certain "uninteresting" commands
2914 (such as `undefined').
53c8f9fa
RS
2915 If SHADOW is non-nil, it is a list of maps;
2916 don't mention keys which would be shadowed by any of them.
2917 PREFIX, if non-nil, says mention only keys that start with PREFIX.
07f15dfd 2918 TITLE, if not 0, is a string to insert at the beginning.
af1d6f09 2919 TITLE should not end with a colon or a newline; we supply that.
d7bf9bf5
RS
2920 If NOMENU is not 0, then omit menu-bar commands.
2921
2922 If TRANSL is nonzero, the definitions are actually key translations
c2b714de
RS
2923 so print strings and vectors differently.
2924
2925 If ALWAYS_TITLE is nonzero, print the title even if there are no maps
2926 to look through. */
2c6f1a39
JB
2927
2928void
c2b714de
RS
2929describe_map_tree (startmap, partial, shadow, prefix, title, nomenu, transl,
2930 always_title)
53c8f9fa 2931 Lisp_Object startmap, shadow, prefix;
2c6f1a39 2932 int partial;
53c8f9fa 2933 char *title;
af1d6f09 2934 int nomenu;
d7bf9bf5 2935 int transl;
c2b714de 2936 int always_title;
2c6f1a39 2937{
e4b6f8e3 2938 Lisp_Object maps, orig_maps, seen, sub_shadows;
e3dfcd4e 2939 struct gcpro gcpro1, gcpro2, gcpro3;
07f15dfd 2940 int something = 0;
53c8f9fa
RS
2941 char *key_heading
2942 = "\
2943key binding\n\
2944--- -------\n";
2c6f1a39 2945
e4b6f8e3 2946 orig_maps = maps = Faccessible_keymaps (startmap, prefix);
925083d1 2947 seen = Qnil;
e3dfcd4e
KH
2948 sub_shadows = Qnil;
2949 GCPRO3 (maps, seen, sub_shadows);
2c6f1a39 2950
af1d6f09
RS
2951 if (nomenu)
2952 {
2953 Lisp_Object list;
2954
2955 /* Delete from MAPS each element that is for the menu bar. */
03699b14 2956 for (list = maps; !NILP (list); list = XCDR (list))
af1d6f09
RS
2957 {
2958 Lisp_Object elt, prefix, tem;
2959
2960 elt = Fcar (list);
2961 prefix = Fcar (elt);
2962 if (XVECTOR (prefix)->size >= 1)
2963 {
2964 tem = Faref (prefix, make_number (0));
2965 if (EQ (tem, Qmenu_bar))
2966 maps = Fdelq (elt, maps);
2967 }
2968 }
2969 }
2970
c2b714de 2971 if (!NILP (maps) || always_title)
53c8f9fa
RS
2972 {
2973 if (title)
07f15dfd
RS
2974 {
2975 insert_string (title);
2976 if (!NILP (prefix))
2977 {
2978 insert_string (" Starting With ");
f8d8ba40 2979 insert1 (Fkey_description (prefix, Qnil));
07f15dfd
RS
2980 }
2981 insert_string (":\n");
2982 }
53c8f9fa 2983 insert_string (key_heading);
07f15dfd 2984 something = 1;
53c8f9fa
RS
2985 }
2986
265a9e55 2987 for (; !NILP (maps); maps = Fcdr (maps))
2c6f1a39 2988 {
e3dfcd4e 2989 register Lisp_Object elt, prefix, tail;
53c8f9fa 2990
2c6f1a39 2991 elt = Fcar (maps);
53c8f9fa
RS
2992 prefix = Fcar (elt);
2993
2994 sub_shadows = Qnil;
2995
03699b14 2996 for (tail = shadow; CONSP (tail); tail = XCDR (tail))
2c6f1a39 2997 {
53c8f9fa
RS
2998 Lisp_Object shmap;
2999
03699b14 3000 shmap = XCAR (tail);
53c8f9fa
RS
3001
3002 /* If the sequence by which we reach this keymap is zero-length,
3003 then the shadow map for this keymap is just SHADOW. */
d5db4077 3004 if ((STRINGP (prefix) && SCHARS (prefix) == 0)
416349ec 3005 || (VECTORP (prefix) && XVECTOR (prefix)->size == 0))
53c8f9fa
RS
3006 ;
3007 /* If the sequence by which we reach this keymap actually has
3008 some elements, then the sequence's definition in SHADOW is
3009 what we should use. */
3010 else
3011 {
98234407 3012 shmap = Flookup_key (shmap, Fcar (elt), Qt);
416349ec 3013 if (INTEGERP (shmap))
53c8f9fa
RS
3014 shmap = Qnil;
3015 }
3016
3017 /* If shmap is not nil and not a keymap,
3018 it completely shadows this map, so don't
3019 describe this map at all. */
02067692 3020 if (!NILP (shmap) && !KEYMAPP (shmap))
53c8f9fa
RS
3021 goto skip;
3022
3023 if (!NILP (shmap))
3024 sub_shadows = Fcons (shmap, sub_shadows);
2c6f1a39
JB
3025 }
3026
e4b6f8e3 3027 /* Maps we have already listed in this loop shadow this map. */
54cbc3d4 3028 for (tail = orig_maps; !EQ (tail, maps); tail = XCDR (tail))
e4b6f8e3
RS
3029 {
3030 Lisp_Object tem;
3031 tem = Fequal (Fcar (XCAR (tail)), prefix);
54cbc3d4 3032 if (!NILP (tem))
e4b6f8e3
RS
3033 sub_shadows = Fcons (XCDR (XCAR (tail)), sub_shadows);
3034 }
3035
3036 describe_map (Fcdr (elt), prefix,
d7bf9bf5 3037 transl ? describe_translation : describe_command,
279a482a 3038 partial, sub_shadows, &seen, nomenu);
53c8f9fa
RS
3039
3040 skip: ;
2c6f1a39
JB
3041 }
3042
07f15dfd
RS
3043 if (something)
3044 insert_string ("\n");
3045
2c6f1a39
JB
3046 UNGCPRO;
3047}
3048
c3f27064
KH
3049static int previous_description_column;
3050
2c6f1a39 3051static void
d55627cc
SM
3052describe_command (definition, args)
3053 Lisp_Object definition, args;
2c6f1a39
JB
3054{
3055 register Lisp_Object tem1;
744cd66b 3056 int column = (int) current_column (); /* iftc */
c3f27064 3057 int description_column;
2c6f1a39 3058
c3f27064
KH
3059 /* If column 16 is no good, go to col 32;
3060 but don't push beyond that--go to next line instead. */
3061 if (column > 30)
3062 {
3063 insert_char ('\n');
3064 description_column = 32;
3065 }
3066 else if (column > 14 || (column > 10 && previous_description_column == 32))
3067 description_column = 32;
3068 else
3069 description_column = 16;
3070
3071 Findent_to (make_number (description_column), make_number (1));
3072 previous_description_column = description_column;
2c6f1a39 3073
416349ec 3074 if (SYMBOLP (definition))
2c6f1a39 3075 {
c85d524c 3076 tem1 = SYMBOL_NAME (definition);
2c6f1a39 3077 insert1 (tem1);
055234ef 3078 insert_string ("\n");
2c6f1a39 3079 }
d7bf9bf5 3080 else if (STRINGP (definition) || VECTORP (definition))
24065b9c 3081 insert_string ("Keyboard Macro\n");
02067692
SM
3082 else if (KEYMAPP (definition))
3083 insert_string ("Prefix Command\n");
2c6f1a39 3084 else
02067692 3085 insert_string ("??\n");
2c6f1a39
JB
3086}
3087
d7bf9bf5 3088static void
d55627cc
SM
3089describe_translation (definition, args)
3090 Lisp_Object definition, args;
d7bf9bf5
RS
3091{
3092 register Lisp_Object tem1;
3093
3094 Findent_to (make_number (16), make_number (1));
3095
3096 if (SYMBOLP (definition))
3097 {
c85d524c 3098 tem1 = SYMBOL_NAME (definition);
d7bf9bf5
RS
3099 insert1 (tem1);
3100 insert_string ("\n");
3101 }
3102 else if (STRINGP (definition) || VECTORP (definition))
b902ac28 3103 {
f8d8ba40 3104 insert1 (Fkey_description (definition, Qnil));
b902ac28
RS
3105 insert_string ("\n");
3106 }
02067692
SM
3107 else if (KEYMAPP (definition))
3108 insert_string ("Prefix Command\n");
d7bf9bf5 3109 else
02067692 3110 insert_string ("??\n");
d7bf9bf5
RS
3111}
3112
c3c0ee93 3113/* Describe the contents of map MAP, assuming that this map itself is
f8d8ba40 3114 reached by the sequence of prefix keys PREFIX (a string or vector).
279a482a 3115 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
2c6f1a39
JB
3116
3117static void
f8d8ba40 3118describe_map (map, prefix, elt_describer, partial, shadow, seen, nomenu)
c3c0ee93 3119 register Lisp_Object map;
f8d8ba40 3120 Lisp_Object prefix;
d55627cc 3121 void (*elt_describer) P_ ((Lisp_Object, Lisp_Object));
2c6f1a39
JB
3122 int partial;
3123 Lisp_Object shadow;
925083d1 3124 Lisp_Object *seen;
279a482a 3125 int nomenu;
2c6f1a39 3126{
53c8f9fa 3127 Lisp_Object tail, definition, event;
99a225a9 3128 Lisp_Object tem;
2c6f1a39
JB
3129 Lisp_Object suppress;
3130 Lisp_Object kludge;
3131 int first = 1;
3132 struct gcpro gcpro1, gcpro2, gcpro3;
3133
6bbd7a29
GM
3134 suppress = Qnil;
3135
2c6f1a39
JB
3136 if (partial)
3137 suppress = intern ("suppress-keymap");
3138
3139 /* This vector gets used to present single keys to Flookup_key. Since
f5b79c1c 3140 that is done once per keymap element, we don't want to cons up a
2c6f1a39
JB
3141 fresh vector every time. */
3142 kludge = Fmake_vector (make_number (1), Qnil);
99a225a9 3143 definition = Qnil;
2c6f1a39 3144
f8d8ba40 3145 GCPRO3 (prefix, definition, kludge);
2c6f1a39 3146
03699b14 3147 for (tail = map; CONSP (tail); tail = XCDR (tail))
2c6f1a39
JB
3148 {
3149 QUIT;
2c6f1a39 3150
03699b14
KR
3151 if (VECTORP (XCAR (tail))
3152 || CHAR_TABLE_P (XCAR (tail)))
3153 describe_vector (XCAR (tail),
f8d8ba40
KS
3154 prefix, Qnil, elt_describer, partial, shadow, map,
3155 (int *)0, 0, 1);
03699b14 3156 else if (CONSP (XCAR (tail)))
2c6f1a39 3157 {
03699b14 3158 event = XCAR (XCAR (tail));
2c3b35b0 3159
f8d8ba40 3160 /* Ignore bindings whose "prefix" are not really valid events.
2c3b35b0 3161 (We get these in the frames and buffers menu.) */
54cbc3d4 3162 if (!(SYMBOLP (event) || INTEGERP (event)))
c96dcc01 3163 continue;
2c3b35b0 3164
279a482a
KH
3165 if (nomenu && EQ (event, Qmenu_bar))
3166 continue;
3167
03699b14 3168 definition = get_keyelt (XCDR (XCAR (tail)), 0);
2c6f1a39 3169
f5b79c1c 3170 /* Don't show undefined commands or suppressed commands. */
99a225a9 3171 if (NILP (definition)) continue;
416349ec 3172 if (SYMBOLP (definition) && partial)
f5b79c1c 3173 {
99a225a9
RS
3174 tem = Fget (definition, suppress);
3175 if (!NILP (tem))
f5b79c1c
JB
3176 continue;
3177 }
2c6f1a39 3178
f5b79c1c
JB
3179 /* Don't show a command that isn't really visible
3180 because a local definition of the same key shadows it. */
2c6f1a39 3181
49801145 3182 ASET (kludge, 0, event);
f5b79c1c
JB
3183 if (!NILP (shadow))
3184 {
53c8f9fa 3185 tem = shadow_lookup (shadow, kludge, Qt);
f5b79c1c
JB
3186 if (!NILP (tem)) continue;
3187 }
3188
c3c0ee93 3189 tem = Flookup_key (map, kludge, Qt);
54cbc3d4 3190 if (!EQ (tem, definition)) continue;
99a225a9 3191
f5b79c1c
JB
3192 if (first)
3193 {
c3f27064 3194 previous_description_column = 0;
f5b79c1c
JB
3195 insert ("\n", 1);
3196 first = 0;
3197 }
2c6f1a39 3198
99a225a9 3199 /* THIS gets the string to describe the character EVENT. */
f8d8ba40 3200 insert1 (Fkey_description (kludge, prefix));
2c6f1a39 3201
f5b79c1c
JB
3202 /* Print a description of the definition of this character.
3203 elt_describer will take care of spacing out far enough
3204 for alignment purposes. */
d55627cc 3205 (*elt_describer) (definition, Qnil);
f5b79c1c 3206 }
03699b14 3207 else if (EQ (XCAR (tail), Qkeymap))
925083d1
KH
3208 {
3209 /* The same keymap might be in the structure twice, if we're
3210 using an inherited keymap. So skip anything we've already
3211 encountered. */
3212 tem = Fassq (tail, *seen);
f8d8ba40 3213 if (CONSP (tem) && !NILP (Fequal (XCAR (tem), prefix)))
925083d1 3214 break;
f8d8ba40 3215 *seen = Fcons (Fcons (tail, prefix), *seen);
925083d1 3216 }
2c6f1a39
JB
3217 }
3218
3219 UNGCPRO;
3220}
3221
69248761 3222static void
d55627cc
SM
3223describe_vector_princ (elt, fun)
3224 Lisp_Object elt, fun;
2c6f1a39 3225{
81fa9e2f 3226 Findent_to (make_number (16), make_number (1));
d55627cc 3227 call1 (fun, elt);
ad4ec84a 3228 Fterpri (Qnil);
2c6f1a39
JB
3229}
3230
d55627cc 3231DEFUN ("describe-vector", Fdescribe_vector, Sdescribe_vector, 1, 2, 0,
335c5470 3232 doc: /* Insert a description of contents of VECTOR.
23715ea6
JB
3233This is text showing the elements of vector matched against indices.
3234DESCRIBER is the output function used; nil means use `princ'. */)
d55627cc
SM
3235 (vector, describer)
3236 Lisp_Object vector, describer;
2c6f1a39 3237{
aed13378 3238 int count = SPECPDL_INDEX ();
d55627cc
SM
3239 if (NILP (describer))
3240 describer = intern ("princ");
ad4ec84a 3241 specbind (Qstandard_output, Fcurrent_buffer ());
b7826503 3242 CHECK_VECTOR_OR_CHAR_TABLE (vector);
d55627cc 3243 describe_vector (vector, Qnil, describer, describe_vector_princ, 0,
f8d8ba40 3244 Qnil, Qnil, (int *)0, 0, 0);
ad4ec84a
RS
3245
3246 return unbind_to (count, Qnil);
2c6f1a39
JB
3247}
3248
352e5dea
RS
3249/* Insert in the current buffer a description of the contents of VECTOR.
3250 We call ELT_DESCRIBER to insert the description of one value found
3251 in VECTOR.
3252
3253 ELT_PREFIX describes what "comes before" the keys or indices defined
0403641f
RS
3254 by this vector. This is a human-readable string whose size
3255 is not necessarily related to the situation.
352e5dea
RS
3256
3257 If the vector is in a keymap, ELT_PREFIX is a prefix key which
3258 leads to this keymap.
3259
3260 If the vector is a chartable, ELT_PREFIX is the vector
3261 of bytes that lead to the character set or portion of a character
3262 set described by this chartable.
3263
3264 If PARTIAL is nonzero, it means do not mention suppressed commands
3265 (that assumes the vector is in a keymap).
3266
3267 SHADOW is a list of keymaps that shadow this map.
3268 If it is non-nil, then we look up the key in those maps
3269 and we don't mention it now if it is defined by any of them.
3270
3271 ENTIRE_MAP is the keymap in which this vector appears.
3272 If the definition in effect in the whole map does not match
0403641f
RS
3273 the one in this vector, we ignore this one.
3274
3275 When describing a sub-char-table, INDICES is a list of
3276 indices at higher levels in this char-table,
d55627cc
SM
3277 and CHAR_TABLE_DEPTH says how many levels down we have gone.
3278
f8d8ba40
KS
3279 KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-.
3280
d55627cc 3281 ARGS is simply passed as the second argument to ELT_DESCRIBER. */
352e5dea 3282
f8d8ba40
KS
3283static void
3284describe_vector (vector, prefix, args, elt_describer,
0403641f 3285 partial, shadow, entire_map,
f8d8ba40 3286 indices, char_table_depth, keymap_p)
2c6f1a39 3287 register Lisp_Object vector;
f8d8ba40 3288 Lisp_Object prefix, args;
d55627cc 3289 void (*elt_describer) P_ ((Lisp_Object, Lisp_Object));
2c6f1a39
JB
3290 int partial;
3291 Lisp_Object shadow;
32bfcae1 3292 Lisp_Object entire_map;
0403641f
RS
3293 int *indices;
3294 int char_table_depth;
f8d8ba40 3295 int keymap_p;
2c6f1a39 3296{
32bfcae1
KH
3297 Lisp_Object definition;
3298 Lisp_Object tem2;
f8d8ba40 3299 Lisp_Object elt_prefix = Qnil;
2c6f1a39
JB
3300 register int i;
3301 Lisp_Object suppress;
3302 Lisp_Object kludge;
3303 int first = 1;
f8d8ba40 3304 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
a98f1d1d
KH
3305 /* Range of elements to be handled. */
3306 int from, to;
a98f1d1d
KH
3307 /* A flag to tell if a leaf in this level of char-table is not a
3308 generic character (i.e. a complete multibyte character). */
3309 int complete_char;
0403641f
RS
3310 int character;
3311 int starting_i;
3312
6bbd7a29
GM
3313 suppress = Qnil;
3314
0403641f 3315 if (indices == 0)
2e34157c 3316 indices = (int *) alloca (3 * sizeof (int));
2c6f1a39 3317
32bfcae1 3318 definition = Qnil;
2c6f1a39 3319
f8d8ba40
KS
3320 if (!keymap_p)
3321 {
3322 /* Call Fkey_description first, to avoid GC bug for the other string. */
3323 if (!NILP (prefix) && XFASTINT (Flength (prefix)) > 0)
3324 {
3325 Lisp_Object tem;
3326 tem = Fkey_description (prefix, Qnil);
3327 elt_prefix = concat2 (tem, build_string (" "));
3328 }
3329 prefix = Qnil;
3330 }
3331
2c6f1a39
JB
3332 /* This vector gets used to present single keys to Flookup_key. Since
3333 that is done once per vector element, we don't want to cons up a
3334 fresh vector every time. */
3335 kludge = Fmake_vector (make_number (1), Qnil);
f8d8ba40 3336 GCPRO4 (elt_prefix, prefix, definition, kludge);
2c6f1a39
JB
3337
3338 if (partial)
3339 suppress = intern ("suppress-keymap");
3340
a98f1d1d
KH
3341 if (CHAR_TABLE_P (vector))
3342 {
0403641f 3343 if (char_table_depth == 0)
a98f1d1d 3344 {
a1942d88 3345 /* VECTOR is a top level char-table. */
0403641f 3346 complete_char = 1;
a98f1d1d
KH
3347 from = 0;
3348 to = CHAR_TABLE_ORDINARY_SLOTS;
3349 }
3350 else
3351 {
a1942d88 3352 /* VECTOR is a sub char-table. */
0403641f
RS
3353 if (char_table_depth >= 3)
3354 /* A char-table is never that deep. */
a1942d88 3355 error ("Too deep char table");
a98f1d1d 3356
a98f1d1d 3357 complete_char
0403641f
RS
3358 = (CHARSET_VALID_P (indices[0])
3359 && ((CHARSET_DIMENSION (indices[0]) == 1
3360 && char_table_depth == 1)
3361 || char_table_depth == 2));
a98f1d1d
KH
3362
3363 /* Meaningful elements are from 32th to 127th. */
3364 from = 32;
a1942d88 3365 to = SUB_CHAR_TABLE_ORDINARY_SLOTS;
a98f1d1d 3366 }
a98f1d1d
KH
3367 }
3368 else
3369 {
a98f1d1d 3370 /* This does the right thing for ordinary vectors. */
0403641f
RS
3371
3372 complete_char = 1;
3373 from = 0;
3374 to = XVECTOR (vector)->size;
a98f1d1d 3375 }
b5585f5c 3376
a98f1d1d 3377 for (i = from; i < to; i++)
2c6f1a39
JB
3378 {
3379 QUIT;
2c6f1a39 3380
a1942d88
KH
3381 if (CHAR_TABLE_P (vector))
3382 {
0403641f
RS
3383 if (char_table_depth == 0 && i >= CHAR_TABLE_SINGLE_BYTE_SLOTS)
3384 complete_char = 0;
3385
a1942d88
KH
3386 if (i >= CHAR_TABLE_SINGLE_BYTE_SLOTS
3387 && !CHARSET_DEFINED_P (i - 128))
3388 continue;
0403641f
RS
3389
3390 definition
3391 = get_keyelt (XCHAR_TABLE (vector)->contents[i], 0);
a1942d88
KH
3392 }
3393 else
49801145 3394 definition = get_keyelt (AREF (vector, i), 0);
2c6f1a39 3395
d55627cc 3396 if (NILP (definition)) continue;
cc3e6465 3397
2c6f1a39 3398 /* Don't mention suppressed commands. */
32bfcae1 3399 if (SYMBOLP (definition) && partial)
2c6f1a39 3400 {
a98f1d1d
KH
3401 Lisp_Object tem;
3402
3403 tem = Fget (definition, suppress);
3404
3405 if (!NILP (tem)) continue;
2c6f1a39
JB
3406 }
3407
0403641f
RS
3408 /* Set CHARACTER to the character this entry describes, if any.
3409 Also update *INDICES. */
3410 if (CHAR_TABLE_P (vector))
3411 {
3412 indices[char_table_depth] = i;
3413
3414 if (char_table_depth == 0)
3415 {
3416 character = i;
3417 indices[0] = i - 128;
3418 }
3419 else if (complete_char)
3420 {
54e03a4a 3421 character = MAKE_CHAR (indices[0], indices[1], indices[2]);
0403641f
RS
3422 }
3423 else
3424 character = 0;
3425 }
3426 else
3427 character = i;
3428
f8d8ba40
KS
3429 ASET (kludge, 0, make_number (character));
3430
32bfcae1 3431 /* If this binding is shadowed by some other map, ignore it. */
0403641f 3432 if (!NILP (shadow) && complete_char)
2c6f1a39
JB
3433 {
3434 Lisp_Object tem;
31bea176 3435
53c8f9fa 3436 tem = shadow_lookup (shadow, kludge, Qt);
2c6f1a39 3437
265a9e55 3438 if (!NILP (tem)) continue;
2c6f1a39
JB
3439 }
3440
32bfcae1
KH
3441 /* Ignore this definition if it is shadowed by an earlier
3442 one in the same keymap. */
0403641f 3443 if (!NILP (entire_map) && complete_char)
32bfcae1
KH
3444 {
3445 Lisp_Object tem;
3446
32bfcae1
KH
3447 tem = Flookup_key (entire_map, kludge, Qt);
3448
54cbc3d4 3449 if (!EQ (tem, definition))
32bfcae1
KH
3450 continue;
3451 }
3452
2c6f1a39
JB
3453 if (first)
3454 {
0403641f 3455 if (char_table_depth == 0)
a98f1d1d 3456 insert ("\n", 1);
2c6f1a39
JB
3457 first = 0;
3458 }
3459
0403641f
RS
3460 /* For a sub char-table, show the depth by indentation.
3461 CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */
3462 if (char_table_depth > 0)
3463 insert (" ", char_table_depth * 2); /* depth is 1 or 2. */
a98f1d1d 3464
0403641f
RS
3465 /* Output the prefix that applies to every entry in this map. */
3466 if (!NILP (elt_prefix))
3467 insert1 (elt_prefix);
a98f1d1d 3468
0403641f
RS
3469 /* Insert or describe the character this slot is for,
3470 or a description of what it is for. */
3471 if (SUB_CHAR_TABLE_P (vector))
a1942d88 3472 {
0403641f
RS
3473 if (complete_char)
3474 insert_char (character);
3475 else
3476 {
3477 /* We need an octal representation for this block of
3478 characters. */
542d7fd2
RS
3479 char work[16];
3480 sprintf (work, "(row %d)", i);
3481 insert (work, strlen (work));
0403641f
RS
3482 }
3483 }
3484 else if (CHAR_TABLE_P (vector))
3485 {
3486 if (complete_char)
f8d8ba40 3487 insert1 (Fkey_description (kludge, prefix));
a1942d88
KH
3488 else
3489 {
3490 /* Print the information for this character set. */
3491 insert_string ("<");
3492 tem2 = CHARSET_TABLE_INFO (i - 128, CHARSET_SHORT_NAME_IDX);
3493 if (STRINGP (tem2))
d5db4077
KR
3494 insert_from_string (tem2, 0, 0, SCHARS (tem2),
3495 SBYTES (tem2), 0);
a1942d88
KH
3496 else
3497 insert ("?", 1);
3498 insert (">", 1);
3499 }
3500 }
352e5dea
RS
3501 else
3502 {
f8d8ba40 3503 insert1 (Fkey_description (kludge, prefix));
a98f1d1d 3504 }
352e5dea 3505
a1942d88 3506 /* If we find a sub char-table within a char-table,
a98f1d1d
KH
3507 scan it recursively; it defines the details for
3508 a character set or a portion of a character set. */
f3ba5409 3509 if (CHAR_TABLE_P (vector) && SUB_CHAR_TABLE_P (definition))
a98f1d1d 3510 {
a98f1d1d 3511 insert ("\n", 1);
f8d8ba40 3512 describe_vector (definition, prefix, args, elt_describer,
0403641f 3513 partial, shadow, entire_map,
f8d8ba40 3514 indices, char_table_depth + 1, keymap_p);
a98f1d1d 3515 continue;
352e5dea 3516 }
2c6f1a39 3517
0403641f
RS
3518 starting_i = i;
3519
542d7fd2 3520 /* Find all consecutive characters or rows that have the same
a1942d88
KH
3521 definition. But, for elements of a top level char table, if
3522 they are for charsets, we had better describe one by one even
3523 if they have the same definition. */
3524 if (CHAR_TABLE_P (vector))
3525 {
0403641f
RS
3526 int limit = to;
3527
3528 if (char_table_depth == 0)
3529 limit = CHAR_TABLE_SINGLE_BYTE_SLOTS;
3530
3531 while (i + 1 < limit
3532 && (tem2 = get_keyelt (XCHAR_TABLE (vector)->contents[i + 1], 0),
3533 !NILP (tem2))
3534 && !NILP (Fequal (tem2, definition)))
3535 i++;
a1942d88
KH
3536 }
3537 else
0403641f 3538 while (i + 1 < to
49801145 3539 && (tem2 = get_keyelt (AREF (vector, i + 1), 0),
a1942d88
KH
3540 !NILP (tem2))
3541 && !NILP (Fequal (tem2, definition)))
3542 i++;
31bea176 3543
2c6f1a39
JB
3544
3545 /* If we have a range of more than one character,
3546 print where the range reaches to. */
3547
0403641f 3548 if (i != starting_i)
2c6f1a39
JB
3549 {
3550 insert (" .. ", 4);
0403641f 3551
f8d8ba40
KS
3552 ASET (kludge, 0, make_number (i));
3553
0403641f
RS
3554 if (!NILP (elt_prefix))
3555 insert1 (elt_prefix);
3556
352e5dea
RS
3557 if (CHAR_TABLE_P (vector))
3558 {
0403641f 3559 if (char_table_depth == 0)
a98f1d1d 3560 {
f8d8ba40 3561 insert1 (Fkey_description (kludge, prefix));
a98f1d1d 3562 }
0403641f 3563 else if (complete_char)
352e5dea 3564 {
0403641f 3565 indices[char_table_depth] = i;
54e03a4a 3566 character = MAKE_CHAR (indices[0], indices[1], indices[2]);
0403641f 3567 insert_char (character);
352e5dea
RS
3568 }
3569 else
3570 {
542d7fd2
RS
3571 /* We need an octal representation for this block of
3572 characters. */
3573 char work[16];
3574 sprintf (work, "(row %d)", i);
3575 insert (work, strlen (work));
352e5dea
RS
3576 }
3577 }
3578 else
3579 {
f8d8ba40 3580 insert1 (Fkey_description (kludge, prefix));
352e5dea 3581 }
2c6f1a39
JB
3582 }
3583
3584 /* Print a description of the definition of this character.
3585 elt_describer will take care of spacing out far enough
3586 for alignment purposes. */
d55627cc 3587 (*elt_describer) (definition, args);
2c6f1a39
JB
3588 }
3589
a1942d88 3590 /* For (sub) char-table, print `defalt' slot at last. */
a98f1d1d
KH
3591 if (CHAR_TABLE_P (vector) && !NILP (XCHAR_TABLE (vector)->defalt))
3592 {
0403641f 3593 insert (" ", char_table_depth * 2);
a98f1d1d 3594 insert_string ("<<default>>");
d55627cc 3595 (*elt_describer) (XCHAR_TABLE (vector)->defalt, args);
a98f1d1d
KH
3596 }
3597
2c6f1a39
JB
3598 UNGCPRO;
3599}
3600\f
cc0a8174 3601/* Apropos - finding all symbols whose names match a regexp. */
5d55ffd0
RS
3602static Lisp_Object apropos_predicate;
3603static Lisp_Object apropos_accumulate;
2c6f1a39
JB
3604
3605static void
3606apropos_accum (symbol, string)
3607 Lisp_Object symbol, string;
3608{
3609 register Lisp_Object tem;
3610
3611 tem = Fstring_match (string, Fsymbol_name (symbol), Qnil);
265a9e55 3612 if (!NILP (tem) && !NILP (apropos_predicate))
2c6f1a39 3613 tem = call1 (apropos_predicate, symbol);
265a9e55 3614 if (!NILP (tem))
2c6f1a39
JB
3615 apropos_accumulate = Fcons (symbol, apropos_accumulate);
3616}
3617
744cd66b 3618DEFUN ("apropos-internal", Fapropos_internal, Sapropos_internal, 1, 2, 0,
335c5470
PJ
3619 doc: /* Show all symbols whose names contain match for REGEXP.
3620If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done
3621for each symbol and a symbol is mentioned only if that returns non-nil.
3622Return list of symbols found. */)
3623 (regexp, predicate)
88539837 3624 Lisp_Object regexp, predicate;
2c6f1a39 3625{
5d55ffd0 3626 Lisp_Object tem;
b7826503 3627 CHECK_STRING (regexp);
88539837 3628 apropos_predicate = predicate;
2c6f1a39 3629 apropos_accumulate = Qnil;
88539837 3630 map_obarray (Vobarray, apropos_accum, regexp);
5d55ffd0
RS
3631 tem = Fsort (apropos_accumulate, Qstring_lessp);
3632 apropos_accumulate = Qnil;
3633 apropos_predicate = Qnil;
3634 return tem;
2c6f1a39
JB
3635}
3636\f
dfcf069d 3637void
2c6f1a39
JB
3638syms_of_keymap ()
3639{
2c6f1a39
JB
3640 Qkeymap = intern ("keymap");
3641 staticpro (&Qkeymap);
5d55ffd0
RS
3642 staticpro (&apropos_predicate);
3643 staticpro (&apropos_accumulate);
3644 apropos_predicate = Qnil;
3645 apropos_accumulate = Qnil;
2c6f1a39 3646
0403641f
RS
3647 /* Now we are ready to set up this property, so we can
3648 create char tables. */
3649 Fput (Qkeymap, Qchar_table_extra_slots, make_number (0));
3650
3651 /* Initialize the keymaps standardly used.
3652 Each one is the value of a Lisp variable, and is also
3653 pointed to by a C variable */
2c6f1a39 3654
0403641f 3655 global_map = Fmake_keymap (Qnil);
2c6f1a39
JB
3656 Fset (intern ("global-map"), global_map);
3657
44bff953 3658 current_global_map = global_map;
a3e99933 3659 staticpro (&global_map);
44bff953
RS
3660 staticpro (&current_global_map);
3661
ce6e5d0b 3662 meta_map = Fmake_keymap (Qnil);
2c6f1a39
JB
3663 Fset (intern ("esc-map"), meta_map);
3664 Ffset (intern ("ESC-prefix"), meta_map);
3665
ce6e5d0b 3666 control_x_map = Fmake_keymap (Qnil);
2c6f1a39
JB
3667 Fset (intern ("ctl-x-map"), control_x_map);
3668 Ffset (intern ("Control-X-prefix"), control_x_map);
3669
2fae9111
RS
3670 exclude_keys
3671 = Fcons (Fcons (build_string ("DEL"), build_string ("\\d")),
3672 Fcons (Fcons (build_string ("TAB"), build_string ("\\t")),
3673 Fcons (Fcons (build_string ("RET"), build_string ("\\r")),
3674 Fcons (Fcons (build_string ("ESC"), build_string ("\\e")),
3675 Fcons (Fcons (build_string ("SPC"), build_string (" ")),
3676 Qnil)))));
3677 staticpro (&exclude_keys);
3678
107fd03d 3679 DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands,
335c5470
PJ
3680 doc: /* List of commands given new key bindings recently.
3681This is used for internal purposes during Emacs startup;
3682don't alter it yourself. */);
107fd03d
RS
3683 Vdefine_key_rebound_commands = Qt;
3684
2c6f1a39 3685 DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map,
335c5470 3686 doc: /* Default keymap to use when reading from the minibuffer. */);
ce6e5d0b 3687 Vminibuffer_local_map = Fmake_sparse_keymap (Qnil);
2c6f1a39
JB
3688
3689 DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map,
335c5470 3690 doc: /* Local keymap for the minibuffer when spaces are not allowed. */);
ce6e5d0b 3691 Vminibuffer_local_ns_map = Fmake_sparse_keymap (Qnil);
2b6748c0 3692 Fset_keymap_parent (Vminibuffer_local_ns_map, Vminibuffer_local_map);
2c6f1a39
JB
3693
3694 DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map,
335c5470 3695 doc: /* Local keymap for minibuffer input with completion. */);
ce6e5d0b 3696 Vminibuffer_local_completion_map = Fmake_sparse_keymap (Qnil);
2b6748c0 3697 Fset_keymap_parent (Vminibuffer_local_completion_map, Vminibuffer_local_map);
2c6f1a39
JB
3698
3699 DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map,
335c5470 3700 doc: /* Local keymap for minibuffer input with completion, for exact match. */);
ce6e5d0b 3701 Vminibuffer_local_must_match_map = Fmake_sparse_keymap (Qnil);
2b6748c0
SM
3702 Fset_keymap_parent (Vminibuffer_local_must_match_map,
3703 Vminibuffer_local_completion_map);
2c6f1a39 3704
cc0a8174 3705 DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist,
335c5470
PJ
3706 doc: /* Alist of keymaps to use for minor modes.
3707Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read
3708key sequences and look up bindings iff VARIABLE's value is non-nil.
3709If two active keymaps bind the same key, the keymap appearing earlier
3710in the list takes precedence. */);
cc0a8174
JB
3711 Vminor_mode_map_alist = Qnil;
3712
dd9cda06 3713 DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist,
335c5470 3714 doc: /* Alist of keymaps to use for minor modes, in current major mode.
95296eac 3715This variable is an alist just like `minor-mode-map-alist', and it is
335c5470
PJ
3716used the same way (and before `minor-mode-map-alist'); however,
3717it is provided for major modes to bind locally. */);
dd9cda06
RS
3718 Vminor_mode_overriding_map_alist = Qnil;
3719
99cbcaca
KS
3720 DEFVAR_LISP ("emulation-mode-map-alists", &Vemulation_mode_map_alists,
3721 doc: /* List of keymap alists to use for emulations modes.
3722It is intended for modes or packages using multiple minor-mode keymaps.
3723Each element is a keymap alist just like `minor-mode-map-alist', or a
3724symbol with a variable binding which is a keymap alist, and it is used
3725the same way. The "active" keymaps in each alist are used before
744cd66b 3726`minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */);
99cbcaca
KS
3727 Vemulation_mode_map_alists = Qnil;
3728
3729
6bbbd9b0 3730 DEFVAR_LISP ("function-key-map", &Vfunction_key_map,
335c5470
PJ
3731 doc: /* Keymap mapping ASCII function key sequences onto their preferred forms.
3732This allows Emacs to recognize function keys sent from ASCII
3733terminals at any point in a key sequence.
3734
3735The `read-key-sequence' function replaces any subsequence bound by
3736`function-key-map' with its binding. More precisely, when the active
3737keymaps have no binding for the current key sequence but
3738`function-key-map' binds a suffix of the sequence to a vector or string,
3739`read-key-sequence' replaces the matching suffix with its binding, and
3740continues with the new sequence.
3741
3742The events that come from bindings in `function-key-map' are not
3743themselves looked up in `function-key-map'.
3744
3745For example, suppose `function-key-map' binds `ESC O P' to [f1].
3746Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
3747`C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
3748key, typing `ESC O P x' would return [f1 x]. */);
ce6e5d0b 3749 Vfunction_key_map = Fmake_sparse_keymap (Qnil);
6bbbd9b0 3750
d7bf9bf5 3751 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map,
335c5470
PJ
3752 doc: /* Keymap of key translations that can override keymaps.
3753This keymap works like `function-key-map', but comes after that,
7a093e87 3754and its non-prefix bindings override ordinary bindings. */);
d7bf9bf5
RS
3755 Vkey_translation_map = Qnil;
3756
9d209cfe
SM
3757 staticpro (&Vmouse_events);
3758 Vmouse_events = Fcons (intern ("menu-bar"),
3759 Fcons (intern ("tool-bar"),
3760 Fcons (intern ("header-line"),
3761 Fcons (intern ("mode-line"),
3762 Fcons (intern ("mouse-1"),
3763 Fcons (intern ("mouse-2"),
3764 Fcons (intern ("mouse-3"),
3765 Fcons (intern ("mouse-4"),
3766 Fcons (intern ("mouse-5"),
3767 Qnil)))))))));
d378869e
SM
3768
3769
2c6f1a39
JB
3770 Qsingle_key_description = intern ("single-key-description");
3771 staticpro (&Qsingle_key_description);
3772
3773 Qkey_description = intern ("key-description");
3774 staticpro (&Qkey_description);
3775
3776 Qkeymapp = intern ("keymapp");
3777 staticpro (&Qkeymapp);
3778
2fc66973
JB
3779 Qnon_ascii = intern ("non-ascii");
3780 staticpro (&Qnon_ascii);
3781
a3fc8840
RS
3782 Qmenu_item = intern ("menu-item");
3783 staticpro (&Qmenu_item);
3784
a1df473f
KS
3785 Qremap = intern ("remap");
3786 staticpro (&Qremap);
3787
023b93f6
KS
3788 command_remapping_vector = Fmake_vector (make_number (2), Qremap);
3789 staticpro (&command_remapping_vector);
a1df473f 3790
1e7d1ab0
SM
3791 where_is_cache_keymaps = Qt;
3792 where_is_cache = Qnil;
3793 staticpro (&where_is_cache);
3794 staticpro (&where_is_cache_keymaps);
3795
2c6f1a39 3796 defsubr (&Skeymapp);
7d58ed99 3797 defsubr (&Skeymap_parent);
54cbc3d4 3798 defsubr (&Skeymap_prompt);
7d58ed99 3799 defsubr (&Sset_keymap_parent);
2c6f1a39
JB
3800 defsubr (&Smake_keymap);
3801 defsubr (&Smake_sparse_keymap);
9d3153eb 3802 defsubr (&Smap_keymap);
2c6f1a39 3803 defsubr (&Scopy_keymap);
023b93f6 3804 defsubr (&Scommand_remapping);
2c6f1a39
JB
3805 defsubr (&Skey_binding);
3806 defsubr (&Slocal_key_binding);
3807 defsubr (&Sglobal_key_binding);
cc0a8174 3808 defsubr (&Sminor_mode_key_binding);
2c6f1a39
JB
3809 defsubr (&Sdefine_key);
3810 defsubr (&Slookup_key);
2c6f1a39
JB
3811 defsubr (&Sdefine_prefix_command);
3812 defsubr (&Suse_global_map);
3813 defsubr (&Suse_local_map);
3814 defsubr (&Scurrent_local_map);
3815 defsubr (&Scurrent_global_map);
cc0a8174 3816 defsubr (&Scurrent_minor_mode_maps);
54cbc3d4 3817 defsubr (&Scurrent_active_maps);
2c6f1a39
JB
3818 defsubr (&Saccessible_keymaps);
3819 defsubr (&Skey_description);
3820 defsubr (&Sdescribe_vector);
3821 defsubr (&Ssingle_key_description);
3822 defsubr (&Stext_char_description);
3823 defsubr (&Swhere_is_internal);
54cbc3d4 3824 defsubr (&Sdescribe_buffer_bindings);
2c6f1a39
JB
3825 defsubr (&Sapropos_internal);
3826}
3827
dfcf069d 3828void
2c6f1a39
JB
3829keys_of_keymap ()
3830{
2c6f1a39
JB
3831 initial_define_key (global_map, 033, "ESC-prefix");
3832 initial_define_key (global_map, Ctl('X'), "Control-X-prefix");
3833}
ab5796a9
MB
3834
3835/* arch-tag: 6dd15c26-7cf1-41c4-b904-f42f7ddda463
3836 (do not change this comment) */