Commit | Line | Data |
---|---|---|
2c6f1a39 | 1 | /* Manipulation of keymaps |
f8c25f1b | 2 | Copyright (C) 1985, 86, 87, 88, 93, 94, 95 Free Software Foundation, Inc. |
2c6f1a39 JB |
3 | |
4 | This file is part of GNU Emacs. | |
5 | ||
6 | GNU Emacs is free software; you can redistribute it and/or modify | |
7 | it under the terms of the GNU General Public License as published by | |
502ddf23 | 8 | the Free Software Foundation; either version 2, or (at your option) |
2c6f1a39 JB |
9 | any later version. |
10 | ||
11 | GNU Emacs is distributed in the hope that it will be useful, | |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
17 | along with GNU Emacs; see the file COPYING. If not, write to | |
3b7ad313 EN |
18 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
19 | Boston, MA 02111-1307, USA. */ | |
2c6f1a39 JB |
20 | |
21 | ||
18160b98 | 22 | #include <config.h> |
2c6f1a39 JB |
23 | #include <stdio.h> |
24 | #undef NULL | |
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" |
2c6f1a39 JB |
33 | |
34 | #define min(a, b) ((a) < (b) ? (a) : (b)) | |
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 | ||
41 | Lisp_Object current_global_map; /* Current global keymap */ | |
42 | ||
43 | Lisp_Object global_map; /* default global key bindings */ | |
44 | ||
45 | Lisp_Object meta_map; /* The keymap used for globally bound | |
46 | ESC-prefixed default commands */ | |
47 | ||
48 | Lisp_Object control_x_map; /* The keymap used for globally bound | |
49 | C-x-prefixed default commands */ | |
50 | ||
51 | /* was MinibufLocalMap */ | |
52 | Lisp_Object Vminibuffer_local_map; | |
53 | /* The keymap used by the minibuf for local | |
54 | bindings when spaces are allowed in the | |
55 | minibuf */ | |
56 | ||
57 | /* was MinibufLocalNSMap */ | |
58 | Lisp_Object Vminibuffer_local_ns_map; | |
59 | /* The keymap used by the minibuf for local | |
60 | bindings when spaces are not encouraged | |
61 | in the minibuf */ | |
62 | ||
63 | /* keymap used for minibuffers when doing completion */ | |
64 | /* was MinibufLocalCompletionMap */ | |
65 | Lisp_Object Vminibuffer_local_completion_map; | |
66 | ||
67 | /* keymap used for minibuffers when doing completion and require a match */ | |
68 | /* was MinibufLocalMustMatchMap */ | |
69 | Lisp_Object Vminibuffer_local_must_match_map; | |
70 | ||
cc0a8174 JB |
71 | /* Alist of minor mode variables and keymaps. */ |
72 | Lisp_Object Vminor_mode_map_alist; | |
73 | ||
dd9cda06 RS |
74 | /* Alist of major-mode-specific overrides for |
75 | minor mode variables and keymaps. */ | |
76 | Lisp_Object Vminor_mode_overriding_map_alist; | |
77 | ||
6bbbd9b0 JB |
78 | /* Keymap mapping ASCII function key sequences onto their preferred forms. |
79 | Initialized by the terminal-specific lisp files. See DEFVAR for more | |
80 | documentation. */ | |
81 | Lisp_Object Vfunction_key_map; | |
82 | ||
d7bf9bf5 RS |
83 | /* Keymap mapping ASCII function key sequences onto their preferred forms. */ |
84 | Lisp_Object Vkey_translation_map; | |
85 | ||
107fd03d RS |
86 | /* A list of all commands given new bindings since a certain time |
87 | when nil was stored here. | |
88 | This is used to speed up recomputation of menu key equivalents | |
89 | when Emacs starts up. t means don't record anything here. */ | |
90 | Lisp_Object Vdefine_key_rebound_commands; | |
91 | ||
2fc66973 | 92 | Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii; |
2c6f1a39 | 93 | |
3d248688 JB |
94 | /* A char with the CHAR_META bit set in a vector or the 0200 bit set |
95 | in a string key sequence is equivalent to prefixing with this | |
96 | character. */ | |
2c6f1a39 JB |
97 | extern Lisp_Object meta_prefix_char; |
98 | ||
7d92e329 RS |
99 | extern Lisp_Object Voverriding_local_map; |
100 | ||
c07aec97 | 101 | static Lisp_Object define_as_prefix (); |
2c6f1a39 | 102 | static Lisp_Object describe_buffer_bindings (); |
d7bf9bf5 | 103 | static void describe_command (), describe_translation (); |
2c6f1a39 | 104 | static void describe_map (); |
4b917187 | 105 | Lisp_Object Fcopy_keymap (); |
2c6f1a39 | 106 | \f |
cc0a8174 JB |
107 | /* Keymap object support - constructors and predicates. */ |
108 | ||
ce6e5d0b | 109 | DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0, |
2c6f1a39 | 110 | "Construct and return a new keymap, of the form (keymap VECTOR . ALIST).\n\ |
926a64aa | 111 | VECTOR is a vector which holds the bindings for the ASCII\n\ |
2c6f1a39 JB |
112 | characters. ALIST is an assoc-list which holds bindings for function keys,\n\ |
113 | mouse events, and any other things that appear in the input stream.\n\ | |
ce6e5d0b RS |
114 | All entries in it are initially nil, meaning \"command undefined\".\n\n\ |
115 | The optional arg STRING supplies a menu name for the keymap\n\ | |
116 | in case you use it as a menu with `x-popup-menu'.") | |
117 | (string) | |
118 | Lisp_Object string; | |
2c6f1a39 | 119 | { |
ce6e5d0b RS |
120 | Lisp_Object tail; |
121 | if (!NILP (string)) | |
122 | tail = Fcons (string, Qnil); | |
123 | else | |
124 | tail = Qnil; | |
2c6f1a39 | 125 | return Fcons (Qkeymap, |
0403641f | 126 | Fcons (Fmake_char_table (Qkeymap, Qnil), tail)); |
2c6f1a39 JB |
127 | } |
128 | ||
ce6e5d0b | 129 | DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0, |
2c6f1a39 JB |
130 | "Construct and return a new sparse-keymap list.\n\ |
131 | Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),\n\ | |
132 | which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),\n\ | |
133 | which binds the function key or mouse event SYMBOL to DEFINITION.\n\ | |
ce6e5d0b RS |
134 | Initially the alist is nil.\n\n\ |
135 | The optional arg STRING supplies a menu name for the keymap\n\ | |
136 | in case you use it as a menu with `x-popup-menu'.") | |
137 | (string) | |
138 | Lisp_Object string; | |
2c6f1a39 | 139 | { |
ce6e5d0b RS |
140 | if (!NILP (string)) |
141 | return Fcons (Qkeymap, Fcons (string, Qnil)); | |
2c6f1a39 JB |
142 | return Fcons (Qkeymap, Qnil); |
143 | } | |
144 | ||
145 | /* This function is used for installing the standard key bindings | |
146 | at initialization time. | |
147 | ||
148 | For example: | |
149 | ||
e25c4e44 | 150 | initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */ |
2c6f1a39 JB |
151 | |
152 | void | |
153 | initial_define_key (keymap, key, defname) | |
154 | Lisp_Object keymap; | |
155 | int key; | |
156 | char *defname; | |
157 | { | |
158 | store_in_keymap (keymap, make_number (key), intern (defname)); | |
159 | } | |
160 | ||
e25c4e44 JB |
161 | void |
162 | initial_define_lispy_key (keymap, keyname, defname) | |
163 | Lisp_Object keymap; | |
164 | char *keyname; | |
165 | char *defname; | |
166 | { | |
167 | store_in_keymap (keymap, intern (keyname), intern (defname)); | |
168 | } | |
169 | ||
2c6f1a39 JB |
170 | /* Define character fromchar in map frommap as an alias for character |
171 | tochar in map tomap. Subsequent redefinitions of the latter WILL | |
172 | affect the former. */ | |
173 | ||
174 | #if 0 | |
175 | void | |
176 | synkey (frommap, fromchar, tomap, tochar) | |
177 | struct Lisp_Vector *frommap, *tomap; | |
178 | int fromchar, tochar; | |
179 | { | |
180 | Lisp_Object v, c; | |
bff4ec1f | 181 | XSETVECTOR (v, tomap); |
6e344130 | 182 | XSETFASTINT (c, tochar); |
2c6f1a39 JB |
183 | frommap->contents[fromchar] = Fcons (v, c); |
184 | } | |
185 | #endif /* 0 */ | |
186 | ||
187 | DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0, | |
88539837 | 188 | "Return t if OBJECT is a keymap.\n\ |
1d8d96fa | 189 | \n\ |
926a64aa | 190 | A keymap is a list (keymap . ALIST),\n\ |
90f80bcf | 191 | or a symbol whose function definition is itself a keymap.\n\ |
1d8d96fa | 192 | ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\ |
926a64aa RS |
193 | a vector of densely packed bindings for small character codes\n\ |
194 | is also allowed as an element.") | |
2c6f1a39 JB |
195 | (object) |
196 | Lisp_Object object; | |
197 | { | |
d09b2024 | 198 | return (NILP (get_keymap_1 (object, 0, 0)) ? Qnil : Qt); |
2c6f1a39 JB |
199 | } |
200 | ||
201 | /* Check that OBJECT is a keymap (after dereferencing through any | |
d09b2024 JB |
202 | symbols). If it is, return it. |
203 | ||
204 | If AUTOLOAD is non-zero and OBJECT is a symbol whose function value | |
205 | is an autoload form, do the autoload and try again. | |
21a0d7a0 | 206 | If AUTOLOAD is nonzero, callers must assume GC is possible. |
d09b2024 JB |
207 | |
208 | ERROR controls how we respond if OBJECT isn't a keymap. | |
209 | If ERROR is non-zero, signal an error; otherwise, just return Qnil. | |
210 | ||
211 | Note that most of the time, we don't want to pursue autoloads. | |
212 | Functions like Faccessible_keymaps which scan entire keymap trees | |
213 | shouldn't load every autoloaded keymap. I'm not sure about this, | |
214 | but it seems to me that only read_key_sequence, Flookup_key, and | |
215 | Fdefine_key should cause keymaps to be autoloaded. */ | |
216 | ||
2c6f1a39 | 217 | Lisp_Object |
d09b2024 | 218 | get_keymap_1 (object, error, autoload) |
2c6f1a39 | 219 | Lisp_Object object; |
d09b2024 | 220 | int error, autoload; |
2c6f1a39 | 221 | { |
d09b2024 | 222 | Lisp_Object tem; |
2c6f1a39 | 223 | |
d09b2024 | 224 | autoload_retry: |
502ddf23 | 225 | tem = indirect_function (object); |
2c6f1a39 JB |
226 | if (CONSP (tem) && EQ (XCONS (tem)->car, Qkeymap)) |
227 | return tem; | |
f5b79c1c | 228 | |
8e4dfd54 JB |
229 | /* Should we do an autoload? Autoload forms for keymaps have |
230 | Qkeymap as their fifth element. */ | |
d09b2024 | 231 | if (autoload |
47684cd9 | 232 | && SYMBOLP (object) |
d09b2024 JB |
233 | && CONSP (tem) |
234 | && EQ (XCONS (tem)->car, Qautoload)) | |
235 | { | |
8e4dfd54 | 236 | Lisp_Object tail; |
d09b2024 | 237 | |
8e4dfd54 JB |
238 | tail = Fnth (make_number (4), tem); |
239 | if (EQ (tail, Qkeymap)) | |
240 | { | |
241 | struct gcpro gcpro1, gcpro2; | |
d09b2024 | 242 | |
81fa9e2f RS |
243 | GCPRO2 (tem, object); |
244 | do_autoload (tem, object); | |
8e4dfd54 JB |
245 | UNGCPRO; |
246 | ||
247 | goto autoload_retry; | |
248 | } | |
d09b2024 JB |
249 | } |
250 | ||
2c6f1a39 JB |
251 | if (error) |
252 | wrong_type_argument (Qkeymapp, object); | |
cc0a8174 JB |
253 | else |
254 | return Qnil; | |
2c6f1a39 JB |
255 | } |
256 | ||
d09b2024 JB |
257 | |
258 | /* Follow any symbol chaining, and return the keymap denoted by OBJECT. | |
259 | If OBJECT doesn't denote a keymap at all, signal an error. */ | |
2c6f1a39 JB |
260 | Lisp_Object |
261 | get_keymap (object) | |
262 | Lisp_Object object; | |
263 | { | |
224a16e8 | 264 | return get_keymap_1 (object, 1, 0); |
2c6f1a39 | 265 | } |
7d58ed99 RS |
266 | \f |
267 | /* Return the parent map of the keymap MAP, or nil if it has none. | |
268 | We assume that MAP is a valid keymap. */ | |
269 | ||
270 | DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0, | |
271 | "Return the parent keymap of KEYMAP.") | |
272 | (keymap) | |
273 | Lisp_Object keymap; | |
274 | { | |
275 | Lisp_Object list; | |
276 | ||
277 | keymap = get_keymap_1 (keymap, 1, 1); | |
278 | ||
279 | /* Skip past the initial element `keymap'. */ | |
280 | list = XCONS (keymap)->cdr; | |
281 | for (; CONSP (list); list = XCONS (list)->cdr) | |
282 | { | |
283 | /* See if there is another `keymap'. */ | |
284 | if (EQ (Qkeymap, XCONS (list)->car)) | |
285 | return list; | |
286 | } | |
287 | ||
288 | return Qnil; | |
289 | } | |
290 | ||
291 | /* Set the parent keymap of MAP to PARENT. */ | |
292 | ||
293 | DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0, | |
294 | "Modify KEYMAP to set its parent map to PARENT.\n\ | |
295 | PARENT should be nil or another keymap.") | |
296 | (keymap, parent) | |
297 | Lisp_Object keymap, parent; | |
298 | { | |
299 | Lisp_Object list, prev; | |
300 | int i; | |
2c6f1a39 | 301 | |
7d58ed99 RS |
302 | keymap = get_keymap_1 (keymap, 1, 1); |
303 | if (!NILP (parent)) | |
304 | parent = get_keymap_1 (parent, 1, 1); | |
2c6f1a39 | 305 | |
7d58ed99 RS |
306 | /* Skip past the initial element `keymap'. */ |
307 | prev = keymap; | |
308 | while (1) | |
309 | { | |
310 | list = XCONS (prev)->cdr; | |
311 | /* If there is a parent keymap here, replace it. | |
312 | If we came to the end, add the parent in PREV. */ | |
313 | if (! CONSP (list) || EQ (Qkeymap, XCONS (list)->car)) | |
314 | { | |
2a5af1cf RS |
315 | /* If we already have the right parent, return now |
316 | so that we avoid the loops below. */ | |
317 | if (EQ (XCONS (prev)->cdr, parent)) | |
318 | return parent; | |
319 | ||
7d58ed99 RS |
320 | XCONS (prev)->cdr = parent; |
321 | break; | |
322 | } | |
323 | prev = list; | |
324 | } | |
325 | ||
326 | /* Scan through for submaps, and set their parents too. */ | |
327 | ||
328 | for (list = XCONS (keymap)->cdr; CONSP (list); list = XCONS (list)->cdr) | |
329 | { | |
330 | /* Stop the scan when we come to the parent. */ | |
331 | if (EQ (XCONS (list)->car, Qkeymap)) | |
332 | break; | |
333 | ||
334 | /* If this element holds a prefix map, deal with it. */ | |
335 | if (CONSP (XCONS (list)->car) | |
336 | && CONSP (XCONS (XCONS (list)->car)->cdr)) | |
337 | fix_submap_inheritance (keymap, XCONS (XCONS (list)->car)->car, | |
338 | XCONS (XCONS (list)->car)->cdr); | |
339 | ||
340 | if (VECTORP (XCONS (list)->car)) | |
341 | for (i = 0; i < XVECTOR (XCONS (list)->car)->size; i++) | |
342 | if (CONSP (XVECTOR (XCONS (list)->car)->contents[i])) | |
343 | fix_submap_inheritance (keymap, make_number (i), | |
344 | XVECTOR (XCONS (list)->car)->contents[i]); | |
0403641f RS |
345 | |
346 | if (CHAR_TABLE_P (XCONS (list)->car)) | |
347 | { | |
23cf1efa | 348 | Lisp_Object indices[3]; |
0403641f RS |
349 | |
350 | map_char_table (fix_submap_inheritance, Qnil, XCONS (list)->car, | |
351 | keymap, 0, indices); | |
352 | } | |
7d58ed99 RS |
353 | } |
354 | ||
355 | return parent; | |
356 | } | |
357 | ||
358 | /* EVENT is defined in MAP as a prefix, and SUBMAP is its definition. | |
359 | if EVENT is also a prefix in MAP's parent, | |
360 | make sure that SUBMAP inherits that definition as its own parent. */ | |
361 | ||
71a956a6 | 362 | void |
7d58ed99 RS |
363 | fix_submap_inheritance (map, event, submap) |
364 | Lisp_Object map, event, submap; | |
365 | { | |
366 | Lisp_Object map_parent, parent_entry; | |
367 | ||
368 | /* SUBMAP is a cons that we found as a key binding. | |
369 | Discard the other things found in a menu key binding. */ | |
370 | ||
371 | if (CONSP (submap) | |
372 | && STRINGP (XCONS (submap)->car)) | |
373 | { | |
374 | submap = XCONS (submap)->cdr; | |
375 | /* Also remove a menu help string, if any, | |
376 | following the menu item name. */ | |
377 | if (CONSP (submap) && STRINGP (XCONS (submap)->car)) | |
378 | submap = XCONS (submap)->cdr; | |
379 | /* Also remove the sublist that caches key equivalences, if any. */ | |
380 | if (CONSP (submap) | |
381 | && CONSP (XCONS (submap)->car)) | |
382 | { | |
383 | Lisp_Object carcar; | |
384 | carcar = XCONS (XCONS (submap)->car)->car; | |
385 | if (NILP (carcar) || VECTORP (carcar)) | |
386 | submap = XCONS (submap)->cdr; | |
387 | } | |
388 | } | |
389 | ||
390 | /* If it isn't a keymap now, there's no work to do. */ | |
391 | if (! CONSP (submap) | |
392 | || ! EQ (XCONS (submap)->car, Qkeymap)) | |
393 | return; | |
394 | ||
395 | map_parent = Fkeymap_parent (map); | |
396 | if (! NILP (map_parent)) | |
397 | parent_entry = access_keymap (map_parent, event, 0, 0); | |
398 | else | |
399 | parent_entry = Qnil; | |
400 | ||
3393c3f5 RS |
401 | /* If MAP's parent has something other than a keymap, |
402 | our own submap shadows it completely, so use nil as SUBMAP's parent. */ | |
403 | if (! (CONSP (parent_entry) && EQ (XCONS (parent_entry)->car, Qkeymap))) | |
404 | parent_entry = Qnil; | |
405 | ||
7d58ed99 RS |
406 | if (! EQ (parent_entry, submap)) |
407 | Fset_keymap_parent (submap, parent_entry); | |
408 | } | |
409 | \f | |
2c6f1a39 | 410 | /* Look up IDX in MAP. IDX may be any sort of event. |
f5b79c1c | 411 | Note that this does only one level of lookup; IDX must be a single |
e25c4e44 JB |
412 | event, not a sequence. |
413 | ||
414 | If T_OK is non-zero, bindings for Qt are treated as default | |
415 | bindings; any key left unmentioned by other tables and bindings is | |
416 | given the binding of Qt. | |
417 | ||
c07aec97 RS |
418 | If T_OK is zero, bindings for Qt are not treated specially. |
419 | ||
420 | If NOINHERIT, don't accept a subkeymap found in an inherited keymap. */ | |
2c6f1a39 JB |
421 | |
422 | Lisp_Object | |
c07aec97 | 423 | access_keymap (map, idx, t_ok, noinherit) |
2c6f1a39 JB |
424 | Lisp_Object map; |
425 | Lisp_Object idx; | |
e25c4e44 | 426 | int t_ok; |
c07aec97 | 427 | int noinherit; |
2c6f1a39 | 428 | { |
c07aec97 RS |
429 | int noprefix = 0; |
430 | Lisp_Object val; | |
431 | ||
2c6f1a39 JB |
432 | /* If idx is a list (some sort of mouse click, perhaps?), |
433 | the index we want to use is the car of the list, which | |
434 | ought to be a symbol. */ | |
cebd887d | 435 | idx = EVENT_HEAD (idx); |
2c6f1a39 | 436 | |
f5b79c1c JB |
437 | /* If idx is a symbol, it might have modifiers, which need to |
438 | be put in the canonical order. */ | |
47684cd9 | 439 | if (SYMBOLP (idx)) |
f5b79c1c | 440 | idx = reorder_modifiers (idx); |
2732bdbb RS |
441 | else if (INTEGERP (idx)) |
442 | /* Clobber the high bits that can be present on a machine | |
443 | with more than 24 bits of integer. */ | |
6e344130 | 444 | XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1))); |
2c6f1a39 | 445 | |
f5b79c1c JB |
446 | { |
447 | Lisp_Object tail; | |
e9b6dfb0 | 448 | Lisp_Object t_binding; |
2c6f1a39 | 449 | |
e9b6dfb0 | 450 | t_binding = Qnil; |
f5b79c1c | 451 | for (tail = map; CONSP (tail); tail = XCONS (tail)->cdr) |
2c6f1a39 | 452 | { |
e9b6dfb0 | 453 | Lisp_Object binding; |
f5b79c1c | 454 | |
e9b6dfb0 | 455 | binding = XCONS (tail)->car; |
783a2838 | 456 | if (SYMBOLP (binding)) |
f5b79c1c | 457 | { |
c07aec97 RS |
458 | /* If NOINHERIT, stop finding prefix definitions |
459 | after we pass a second occurrence of the `keymap' symbol. */ | |
460 | if (noinherit && EQ (binding, Qkeymap) && ! EQ (tail, map)) | |
461 | noprefix = 1; | |
783a2838 KH |
462 | } |
463 | else if (CONSP (binding)) | |
464 | { | |
f5b79c1c | 465 | if (EQ (XCONS (binding)->car, idx)) |
c07aec97 RS |
466 | { |
467 | val = XCONS (binding)->cdr; | |
468 | if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap)) | |
469 | return Qnil; | |
7d58ed99 RS |
470 | if (CONSP (val)) |
471 | fix_submap_inheritance (map, idx, val); | |
c07aec97 RS |
472 | return val; |
473 | } | |
e25c4e44 JB |
474 | if (t_ok && EQ (XCONS (binding)->car, Qt)) |
475 | t_binding = XCONS (binding)->cdr; | |
783a2838 KH |
476 | } |
477 | else if (VECTORP (binding)) | |
478 | { | |
be3bfff1 | 479 | if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size) |
c07aec97 | 480 | { |
783a2838 | 481 | val = XVECTOR (binding)->contents[XFASTINT (idx)]; |
c07aec97 RS |
482 | if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap)) |
483 | return Qnil; | |
7d58ed99 RS |
484 | if (CONSP (val)) |
485 | fix_submap_inheritance (map, idx, val); | |
c07aec97 RS |
486 | return val; |
487 | } | |
f5b79c1c | 488 | } |
0403641f RS |
489 | else if (CHAR_TABLE_P (binding)) |
490 | { | |
6418ea16 RS |
491 | /* Character codes with modifiers |
492 | are not included in a char-table. | |
493 | All character codes without modifiers are included. */ | |
494 | if (NATNUMP (idx) | |
495 | && ! (XFASTINT (idx) | |
496 | & (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | |
497 | | CHAR_SHIFT | CHAR_CTL | CHAR_META))) | |
0403641f RS |
498 | { |
499 | val = Faref (binding, idx); | |
500 | if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap)) | |
501 | return Qnil; | |
502 | if (CONSP (val)) | |
503 | fix_submap_inheritance (map, idx, val); | |
504 | return val; | |
505 | } | |
506 | } | |
20218e2f JB |
507 | |
508 | QUIT; | |
2c6f1a39 | 509 | } |
fde3a52f | 510 | |
e25c4e44 JB |
511 | return t_binding; |
512 | } | |
2c6f1a39 JB |
513 | } |
514 | ||
515 | /* Given OBJECT which was found in a slot in a keymap, | |
516 | trace indirect definitions to get the actual definition of that slot. | |
517 | An indirect definition is a list of the form | |
518 | (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one | |
519 | and INDEX is the object to look up in KEYMAP to yield the definition. | |
520 | ||
521 | Also if OBJECT has a menu string as the first element, | |
224a16e8 RS |
522 | remove that. Also remove a menu help string as second element. |
523 | ||
524 | If AUTOLOAD is nonzero, load autoloadable keymaps | |
525 | that are referred to with indirection. */ | |
2c6f1a39 JB |
526 | |
527 | Lisp_Object | |
224a16e8 | 528 | get_keyelt (object, autoload) |
2c6f1a39 | 529 | register Lisp_Object object; |
224a16e8 | 530 | int autoload; |
2c6f1a39 JB |
531 | { |
532 | while (1) | |
533 | { | |
534 | register Lisp_Object map, tem; | |
535 | ||
fde3a52f | 536 | /* If the contents are (KEYMAP . ELEMENT), go indirect. */ |
224a16e8 | 537 | map = get_keymap_1 (Fcar_safe (object), 0, autoload); |
2c6f1a39 | 538 | tem = Fkeymapp (map); |
265a9e55 | 539 | if (!NILP (tem)) |
0403641f RS |
540 | { |
541 | Lisp_Object key; | |
542 | key = Fcdr (object); | |
543 | if (INTEGERP (key) && (XINT (key) & meta_modifier)) | |
544 | { | |
2e34157c | 545 | object = access_keymap (map, meta_prefix_char, 0, 0); |
0403641f RS |
546 | map = get_keymap_1 (object, 0, autoload); |
547 | object = access_keymap (map, | |
548 | make_number (XINT (key) & ~meta_modifier), | |
549 | 0, 0); | |
550 | } | |
551 | else | |
552 | object = access_keymap (map, key, 0, 0); | |
553 | } | |
554 | ||
2c6f1a39 JB |
555 | /* If the keymap contents looks like (STRING . DEFN), |
556 | use DEFN. | |
557 | Keymap alist elements like (CHAR MENUSTRING . DEFN) | |
558 | will be used by HierarKey menus. */ | |
47684cd9 RS |
559 | else if (CONSP (object) |
560 | && STRINGP (XCONS (object)->car)) | |
1a8c3f10 RS |
561 | { |
562 | object = XCONS (object)->cdr; | |
563 | /* Also remove a menu help string, if any, | |
564 | following the menu item name. */ | |
416349ec | 565 | if (CONSP (object) && STRINGP (XCONS (object)->car)) |
1a8c3f10 | 566 | object = XCONS (object)->cdr; |
c6ec9f6e RS |
567 | /* Also remove the sublist that caches key equivalences, if any. */ |
568 | if (CONSP (object) | |
569 | && CONSP (XCONS (object)->car)) | |
ffab2bd6 | 570 | { |
c6ec9f6e RS |
571 | Lisp_Object carcar; |
572 | carcar = XCONS (XCONS (object)->car)->car; | |
573 | if (NILP (carcar) || VECTORP (carcar)) | |
ffab2bd6 RS |
574 | object = XCONS (object)->cdr; |
575 | } | |
1a8c3f10 | 576 | } |
2c6f1a39 JB |
577 | |
578 | else | |
579 | /* Anything else is really the value. */ | |
580 | return object; | |
581 | } | |
582 | } | |
583 | ||
584 | Lisp_Object | |
585 | store_in_keymap (keymap, idx, def) | |
586 | Lisp_Object keymap; | |
587 | register Lisp_Object idx; | |
588 | register Lisp_Object def; | |
589 | { | |
dce4372a RS |
590 | /* If we are preparing to dump, and DEF is a menu element |
591 | with a menu item string, copy it to ensure it is not pure. */ | |
d964248c | 592 | if (CONSP (def) && PURE_P (def) && STRINGP (XCONS (def)->car)) |
32ce36ad RS |
593 | def = Fcons (XCONS (def)->car, XCONS (def)->cdr); |
594 | ||
416349ec | 595 | if (!CONSP (keymap) || ! EQ (XCONS (keymap)->car, Qkeymap)) |
f5b79c1c JB |
596 | error ("attempt to define a key in a non-keymap"); |
597 | ||
2c6f1a39 JB |
598 | /* If idx is a list (some sort of mouse click, perhaps?), |
599 | the index we want to use is the car of the list, which | |
600 | ought to be a symbol. */ | |
cebd887d | 601 | idx = EVENT_HEAD (idx); |
2c6f1a39 | 602 | |
f5b79c1c JB |
603 | /* If idx is a symbol, it might have modifiers, which need to |
604 | be put in the canonical order. */ | |
416349ec | 605 | if (SYMBOLP (idx)) |
f5b79c1c | 606 | idx = reorder_modifiers (idx); |
2732bdbb RS |
607 | else if (INTEGERP (idx)) |
608 | /* Clobber the high bits that can be present on a machine | |
609 | with more than 24 bits of integer. */ | |
6e344130 | 610 | XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1))); |
f5b79c1c JB |
611 | |
612 | /* Scan the keymap for a binding of idx. */ | |
2c6f1a39 | 613 | { |
f5b79c1c | 614 | Lisp_Object tail; |
2c6f1a39 | 615 | |
f5b79c1c JB |
616 | /* The cons after which we should insert new bindings. If the |
617 | keymap has a table element, we record its position here, so new | |
618 | bindings will go after it; this way, the table will stay | |
619 | towards the front of the alist and character lookups in dense | |
620 | keymaps will remain fast. Otherwise, this just points at the | |
621 | front of the keymap. */ | |
e9b6dfb0 | 622 | Lisp_Object insertion_point; |
2c6f1a39 | 623 | |
e9b6dfb0 | 624 | insertion_point = keymap; |
f5b79c1c | 625 | for (tail = XCONS (keymap)->cdr; CONSP (tail); tail = XCONS (tail)->cdr) |
2c6f1a39 | 626 | { |
e9b6dfb0 | 627 | Lisp_Object elt; |
f5b79c1c | 628 | |
e9b6dfb0 | 629 | elt = XCONS (tail)->car; |
783a2838 | 630 | if (VECTORP (elt)) |
f5b79c1c | 631 | { |
be3bfff1 | 632 | if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (elt)->size) |
f5b79c1c JB |
633 | { |
634 | XVECTOR (elt)->contents[XFASTINT (idx)] = def; | |
635 | return def; | |
636 | } | |
637 | insertion_point = tail; | |
783a2838 | 638 | } |
0403641f RS |
639 | else if (CHAR_TABLE_P (elt)) |
640 | { | |
6418ea16 RS |
641 | /* Character codes with modifiers |
642 | are not included in a char-table. | |
643 | All character codes without modifiers are included. */ | |
644 | if (NATNUMP (idx) | |
645 | && ! (XFASTINT (idx) | |
646 | & (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | |
647 | | CHAR_SHIFT | CHAR_CTL | CHAR_META))) | |
0403641f RS |
648 | { |
649 | Faset (elt, idx, def); | |
650 | return def; | |
651 | } | |
652 | insertion_point = tail; | |
653 | } | |
783a2838 KH |
654 | else if (CONSP (elt)) |
655 | { | |
f5b79c1c JB |
656 | if (EQ (idx, XCONS (elt)->car)) |
657 | { | |
658 | XCONS (elt)->cdr = def; | |
659 | return def; | |
660 | } | |
783a2838 KH |
661 | } |
662 | else if (SYMBOLP (elt)) | |
663 | { | |
f5b79c1c JB |
664 | /* If we find a 'keymap' symbol in the spine of KEYMAP, |
665 | then we must have found the start of a second keymap | |
666 | being used as the tail of KEYMAP, and a binding for IDX | |
667 | should be inserted before it. */ | |
668 | if (EQ (elt, Qkeymap)) | |
669 | goto keymap_end; | |
f5b79c1c | 670 | } |
0188441d JB |
671 | |
672 | QUIT; | |
2c6f1a39 | 673 | } |
2c6f1a39 | 674 | |
f5b79c1c JB |
675 | keymap_end: |
676 | /* We have scanned the entire keymap, and not found a binding for | |
677 | IDX. Let's add one. */ | |
32ce36ad RS |
678 | XCONS (insertion_point)->cdr |
679 | = Fcons (Fcons (idx, def), XCONS (insertion_point)->cdr); | |
f5b79c1c JB |
680 | } |
681 | ||
2c6f1a39 JB |
682 | return def; |
683 | } | |
684 | ||
69248761 | 685 | void |
0403641f RS |
686 | copy_keymap_1 (chartable, idx, elt) |
687 | Lisp_Object chartable, idx, elt; | |
688 | { | |
bee3fc83 RS |
689 | if (!SYMBOLP (elt) && ! NILP (Fkeymapp (elt))) |
690 | Faset (chartable, idx, Fcopy_keymap (elt)); | |
0403641f | 691 | } |
f5b79c1c | 692 | |
2c6f1a39 JB |
693 | DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0, |
694 | "Return a copy of the keymap KEYMAP.\n\ | |
695 | The copy starts out with the same definitions of KEYMAP,\n\ | |
696 | but changing either the copy or KEYMAP does not affect the other.\n\ | |
1d8d96fa JB |
697 | Any key definitions that are subkeymaps are recursively copied.\n\ |
698 | However, a key definition which is a symbol whose definition is a keymap\n\ | |
699 | is not copied.") | |
2c6f1a39 JB |
700 | (keymap) |
701 | Lisp_Object keymap; | |
702 | { | |
703 | register Lisp_Object copy, tail; | |
704 | ||
705 | copy = Fcopy_alist (get_keymap (keymap)); | |
2c6f1a39 | 706 | |
f5b79c1c | 707 | for (tail = copy; CONSP (tail); tail = XCONS (tail)->cdr) |
2c6f1a39 | 708 | { |
e9b6dfb0 | 709 | Lisp_Object elt; |
2c6f1a39 | 710 | |
e9b6dfb0 | 711 | elt = XCONS (tail)->car; |
0403641f RS |
712 | if (CHAR_TABLE_P (elt)) |
713 | { | |
23cf1efa | 714 | Lisp_Object indices[3]; |
0403641f RS |
715 | |
716 | elt = Fcopy_sequence (elt); | |
7cc06296 RS |
717 | XCONS (tail)->car = elt; |
718 | ||
0403641f RS |
719 | map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices); |
720 | } | |
721 | else if (VECTORP (elt)) | |
2c6f1a39 | 722 | { |
f5b79c1c | 723 | int i; |
2c6f1a39 | 724 | |
f5b79c1c JB |
725 | elt = Fcopy_sequence (elt); |
726 | XCONS (tail)->car = elt; | |
2c6f1a39 | 727 | |
926a64aa | 728 | for (i = 0; i < XVECTOR (elt)->size; i++) |
416349ec | 729 | if (!SYMBOLP (XVECTOR (elt)->contents[i]) |
98006242 | 730 | && ! NILP (Fkeymapp (XVECTOR (elt)->contents[i]))) |
0403641f RS |
731 | XVECTOR (elt)->contents[i] |
732 | = Fcopy_keymap (XVECTOR (elt)->contents[i]); | |
2c6f1a39 | 733 | } |
d65a13c5 KH |
734 | else if (CONSP (elt)) |
735 | { | |
736 | /* Skip the optional menu string. */ | |
737 | if (CONSP (XCONS (elt)->cdr) | |
738 | && STRINGP (XCONS (XCONS (elt)->cdr)->car)) | |
739 | { | |
740 | Lisp_Object tem; | |
741 | ||
742 | /* Copy the cell, since copy-alist didn't go this deep. */ | |
743 | XCONS (elt)->cdr = Fcons (XCONS (XCONS (elt)->cdr)->car, | |
744 | XCONS (XCONS (elt)->cdr)->cdr); | |
745 | elt = XCONS (elt)->cdr; | |
746 | ||
747 | /* Also skip the optional menu help string. */ | |
748 | if (CONSP (XCONS (elt)->cdr) | |
749 | && STRINGP (XCONS (XCONS (elt)->cdr)->car)) | |
750 | { | |
751 | XCONS (elt)->cdr = Fcons (XCONS (XCONS (elt)->cdr)->car, | |
752 | XCONS (XCONS (elt)->cdr)->cdr); | |
753 | elt = XCONS (elt)->cdr; | |
754 | } | |
755 | /* There may also be a list that caches key equivalences. | |
756 | Just delete it for the new keymap. */ | |
757 | if (CONSP (XCONS (elt)->cdr) | |
758 | && CONSP (XCONS (XCONS (elt)->cdr)->car) | |
759 | && (NILP (tem = XCONS (XCONS (XCONS (elt)->cdr)->car)->car) | |
760 | || VECTORP (tem))) | |
761 | XCONS (elt)->cdr = XCONS (XCONS (elt)->cdr)->cdr; | |
762 | } | |
763 | if (CONSP (elt) | |
764 | && ! SYMBOLP (XCONS (elt)->cdr) | |
765 | && ! NILP (Fkeymapp (XCONS (elt)->cdr))) | |
766 | XCONS (elt)->cdr = Fcopy_keymap (XCONS (elt)->cdr); | |
767 | } | |
2c6f1a39 JB |
768 | } |
769 | ||
770 | return copy; | |
771 | } | |
772 | \f | |
cc0a8174 JB |
773 | /* Simple Keymap mutators and accessors. */ |
774 | ||
21a0d7a0 RS |
775 | /* GC is possible in this function if it autoloads a keymap. */ |
776 | ||
2c6f1a39 JB |
777 | DEFUN ("define-key", Fdefine_key, Sdefine_key, 3, 3, 0, |
778 | "Args KEYMAP, KEY, DEF. Define key sequence KEY, in KEYMAP, as DEF.\n\ | |
779 | KEYMAP is a keymap. KEY is a string or a vector of symbols and characters\n\ | |
780 | meaning a sequence of keystrokes and events.\n\ | |
c818754b RS |
781 | Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\ |
782 | can be included if you use a vector.\n\ | |
2c6f1a39 JB |
783 | DEF is anything that can be a key's definition:\n\ |
784 | nil (means key is undefined in this keymap),\n\ | |
785 | a command (a Lisp function suitable for interactive calling)\n\ | |
786 | a string (treated as a keyboard macro),\n\ | |
787 | a keymap (to define a prefix key),\n\ | |
788 | a symbol. When the key is looked up, the symbol will stand for its\n\ | |
789 | function definition, which should at that time be one of the above,\n\ | |
790 | or another symbol whose function definition is used, etc.\n\ | |
791 | a cons (STRING . DEFN), meaning that DEFN is the definition\n\ | |
792 | (DEFN should be a valid definition in its own right),\n\ | |
6e8290aa JB |
793 | or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.\n\ |
794 | \n\ | |
795 | If KEYMAP is a sparse keymap, the pair binding KEY to DEF is added at\n\ | |
796 | the front of KEYMAP.") | |
2c6f1a39 | 797 | (keymap, key, def) |
d09b2024 | 798 | Lisp_Object keymap; |
2c6f1a39 JB |
799 | Lisp_Object key; |
800 | Lisp_Object def; | |
801 | { | |
802 | register int idx; | |
803 | register Lisp_Object c; | |
804 | register Lisp_Object tem; | |
805 | register Lisp_Object cmd; | |
806 | int metized = 0; | |
6ba6e250 | 807 | int meta_bit; |
2c6f1a39 | 808 | int length; |
d09b2024 | 809 | struct gcpro gcpro1, gcpro2, gcpro3; |
2c6f1a39 | 810 | |
224a16e8 | 811 | keymap = get_keymap_1 (keymap, 1, 1); |
2c6f1a39 | 812 | |
416349ec | 813 | if (!VECTORP (key) && !STRINGP (key)) |
2c6f1a39 JB |
814 | key = wrong_type_argument (Qarrayp, key); |
815 | ||
d09b2024 | 816 | length = XFASTINT (Flength (key)); |
2c6f1a39 JB |
817 | if (length == 0) |
818 | return Qnil; | |
819 | ||
107fd03d RS |
820 | if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt)) |
821 | Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands); | |
822 | ||
d09b2024 JB |
823 | GCPRO3 (keymap, key, def); |
824 | ||
416349ec | 825 | if (VECTORP (key)) |
6ba6e250 RS |
826 | meta_bit = meta_modifier; |
827 | else | |
828 | meta_bit = 0x80; | |
829 | ||
2c6f1a39 JB |
830 | idx = 0; |
831 | while (1) | |
832 | { | |
833 | c = Faref (key, make_number (idx)); | |
834 | ||
f09bc924 | 835 | if (CONSP (c) && lucid_event_type_list_p (c)) |
41015a19 | 836 | c = Fevent_convert_list (c); |
f09bc924 | 837 | |
416349ec | 838 | if (INTEGERP (c) |
6ba6e250 | 839 | && (XINT (c) & meta_bit) |
2c6f1a39 JB |
840 | && !metized) |
841 | { | |
842 | c = meta_prefix_char; | |
843 | metized = 1; | |
844 | } | |
845 | else | |
846 | { | |
416349ec | 847 | if (INTEGERP (c)) |
0b8fc2d4 | 848 | XSETINT (c, XINT (c) & ~meta_bit); |
2c6f1a39 JB |
849 | |
850 | metized = 0; | |
851 | idx++; | |
852 | } | |
853 | ||
5907b863 | 854 | if (! INTEGERP (c) && ! SYMBOLP (c) && ! CONSP (c)) |
4b04c52e | 855 | error ("Key sequence contains invalid events"); |
5907b863 | 856 | |
2c6f1a39 | 857 | if (idx == length) |
d09b2024 | 858 | RETURN_UNGCPRO (store_in_keymap (keymap, c, def)); |
2c6f1a39 | 859 | |
224a16e8 | 860 | cmd = get_keyelt (access_keymap (keymap, c, 0, 1), 1); |
2c6f1a39 | 861 | |
c07aec97 | 862 | /* If this key is undefined, make it a prefix. */ |
265a9e55 | 863 | if (NILP (cmd)) |
c07aec97 | 864 | cmd = define_as_prefix (keymap, c); |
2c6f1a39 | 865 | |
d09b2024 JB |
866 | keymap = get_keymap_1 (cmd, 0, 1); |
867 | if (NILP (keymap)) | |
e9b6dfb0 KH |
868 | /* We must use Fkey_description rather than just passing key to |
869 | error; key might be a vector, not a string. */ | |
870 | error ("Key sequence %s uses invalid prefix characters", | |
871 | XSTRING (Fkey_description (key))->data); | |
2c6f1a39 JB |
872 | } |
873 | } | |
874 | ||
875 | /* Value is number if KEY is too long; NIL if valid but has no definition. */ | |
21a0d7a0 | 876 | /* GC is possible in this function if it autoloads a keymap. */ |
2c6f1a39 | 877 | |
7c140252 | 878 | DEFUN ("lookup-key", Flookup_key, Slookup_key, 2, 3, 0, |
2c6f1a39 JB |
879 | "In keymap KEYMAP, look up key sequence KEY. Return the definition.\n\ |
880 | nil means undefined. See doc of `define-key' for kinds of definitions.\n\ | |
7c140252 | 881 | \n\ |
2c6f1a39 JB |
882 | A number as value means KEY is \"too long\";\n\ |
883 | that is, characters or symbols in it except for the last one\n\ | |
884 | fail to be a valid sequence of prefix characters in KEYMAP.\n\ | |
885 | The number is how many characters at the front of KEY\n\ | |
7c140252 JB |
886 | it takes to reach a non-prefix command.\n\ |
887 | \n\ | |
888 | Normally, `lookup-key' ignores bindings for t, which act as default\n\ | |
889 | bindings, used when nothing else in the keymap applies; this makes it\n\ | |
b31a4218 | 890 | usable as a general function for probing keymaps. However, if the\n\ |
7c140252 JB |
891 | third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will\n\ |
892 | recognize the default bindings, just as `read-key-sequence' does.") | |
893 | (keymap, key, accept_default) | |
2c6f1a39 JB |
894 | register Lisp_Object keymap; |
895 | Lisp_Object key; | |
7c140252 | 896 | Lisp_Object accept_default; |
2c6f1a39 JB |
897 | { |
898 | register int idx; | |
899 | register Lisp_Object tem; | |
900 | register Lisp_Object cmd; | |
901 | register Lisp_Object c; | |
902 | int metized = 0; | |
903 | int length; | |
7c140252 | 904 | int t_ok = ! NILP (accept_default); |
6ba6e250 | 905 | int meta_bit; |
21a0d7a0 | 906 | struct gcpro gcpro1; |
2c6f1a39 | 907 | |
224a16e8 | 908 | keymap = get_keymap_1 (keymap, 1, 1); |
2c6f1a39 | 909 | |
416349ec | 910 | if (!VECTORP (key) && !STRINGP (key)) |
2c6f1a39 JB |
911 | key = wrong_type_argument (Qarrayp, key); |
912 | ||
d09b2024 | 913 | length = XFASTINT (Flength (key)); |
2c6f1a39 JB |
914 | if (length == 0) |
915 | return keymap; | |
916 | ||
416349ec | 917 | if (VECTORP (key)) |
6ba6e250 RS |
918 | meta_bit = meta_modifier; |
919 | else | |
920 | meta_bit = 0x80; | |
921 | ||
21a0d7a0 RS |
922 | GCPRO1 (key); |
923 | ||
2c6f1a39 JB |
924 | idx = 0; |
925 | while (1) | |
926 | { | |
927 | c = Faref (key, make_number (idx)); | |
928 | ||
f09bc924 | 929 | if (CONSP (c) && lucid_event_type_list_p (c)) |
41015a19 | 930 | c = Fevent_convert_list (c); |
f09bc924 | 931 | |
416349ec | 932 | if (INTEGERP (c) |
6ba6e250 | 933 | && (XINT (c) & meta_bit) |
2c6f1a39 JB |
934 | && !metized) |
935 | { | |
936 | c = meta_prefix_char; | |
937 | metized = 1; | |
938 | } | |
939 | else | |
940 | { | |
416349ec | 941 | if (INTEGERP (c)) |
6ba6e250 | 942 | XSETINT (c, XINT (c) & ~meta_bit); |
2c6f1a39 JB |
943 | |
944 | metized = 0; | |
945 | idx++; | |
946 | } | |
947 | ||
224a16e8 | 948 | cmd = get_keyelt (access_keymap (keymap, c, t_ok, 0), 1); |
2c6f1a39 | 949 | if (idx == length) |
21a0d7a0 | 950 | RETURN_UNGCPRO (cmd); |
2c6f1a39 | 951 | |
224a16e8 | 952 | keymap = get_keymap_1 (cmd, 0, 1); |
d09b2024 | 953 | if (NILP (keymap)) |
21a0d7a0 | 954 | RETURN_UNGCPRO (make_number (idx)); |
2c6f1a39 | 955 | |
2c6f1a39 JB |
956 | QUIT; |
957 | } | |
958 | } | |
959 | ||
c07aec97 RS |
960 | /* Make KEYMAP define event C as a keymap (i.e., as a prefix). |
961 | Assume that currently it does not define C at all. | |
962 | Return the keymap. */ | |
963 | ||
964 | static Lisp_Object | |
965 | define_as_prefix (keymap, c) | |
966 | Lisp_Object keymap, c; | |
967 | { | |
968 | Lisp_Object inherit, cmd; | |
969 | ||
970 | cmd = Fmake_sparse_keymap (Qnil); | |
971 | /* If this key is defined as a prefix in an inherited keymap, | |
972 | make it a prefix in this map, and make its definition | |
973 | inherit the other prefix definition. */ | |
974 | inherit = access_keymap (keymap, c, 0, 0); | |
7d58ed99 RS |
975 | #if 0 |
976 | /* This code is needed to do the right thing in the following case: | |
977 | keymap A inherits from B, | |
978 | you define KEY as a prefix in A, | |
979 | then later you define KEY as a prefix in B. | |
980 | We want the old prefix definition in A to inherit from that in B. | |
981 | It is hard to do that retroactively, so this code | |
982 | creates the prefix in B right away. | |
983 | ||
984 | But it turns out that this code causes problems immediately | |
985 | when the prefix in A is defined: it causes B to define KEY | |
986 | as a prefix with no subcommands. | |
987 | ||
988 | So I took out this code. */ | |
c07aec97 RS |
989 | if (NILP (inherit)) |
990 | { | |
991 | /* If there's an inherited keymap | |
992 | and it doesn't define this key, | |
993 | make it define this key. */ | |
994 | Lisp_Object tail; | |
995 | ||
996 | for (tail = Fcdr (keymap); CONSP (tail); tail = XCONS (tail)->cdr) | |
997 | if (EQ (XCONS (tail)->car, Qkeymap)) | |
998 | break; | |
999 | ||
1000 | if (!NILP (tail)) | |
1001 | inherit = define_as_prefix (tail, c); | |
1002 | } | |
7d58ed99 | 1003 | #endif |
c07aec97 RS |
1004 | |
1005 | cmd = nconc2 (cmd, inherit); | |
1006 | store_in_keymap (keymap, c, cmd); | |
1007 | ||
1008 | return cmd; | |
1009 | } | |
1010 | ||
0b8fc2d4 RS |
1011 | /* Append a key to the end of a key sequence. We always make a vector. */ |
1012 | ||
2c6f1a39 JB |
1013 | Lisp_Object |
1014 | append_key (key_sequence, key) | |
1015 | Lisp_Object key_sequence, key; | |
1016 | { | |
1017 | Lisp_Object args[2]; | |
1018 | ||
1019 | args[0] = key_sequence; | |
1020 | ||
0b8fc2d4 RS |
1021 | args[1] = Fcons (key, Qnil); |
1022 | return Fvconcat (2, args); | |
2c6f1a39 JB |
1023 | } |
1024 | ||
1025 | \f | |
cc0a8174 JB |
1026 | /* Global, local, and minor mode keymap stuff. */ |
1027 | ||
265a9e55 | 1028 | /* We can't put these variables inside current_minor_maps, since under |
6bbbd9b0 JB |
1029 | some systems, static gets macro-defined to be the empty string. |
1030 | Ickypoo. */ | |
265a9e55 JB |
1031 | static Lisp_Object *cmm_modes, *cmm_maps; |
1032 | static int cmm_size; | |
1033 | ||
fbb90829 KH |
1034 | /* Error handler used in current_minor_maps. */ |
1035 | static Lisp_Object | |
1036 | current_minor_maps_error () | |
1037 | { | |
1038 | return Qnil; | |
1039 | } | |
1040 | ||
cc0a8174 JB |
1041 | /* Store a pointer to an array of the keymaps of the currently active |
1042 | minor modes in *buf, and return the number of maps it contains. | |
1043 | ||
1044 | This function always returns a pointer to the same buffer, and may | |
1045 | free or reallocate it, so if you want to keep it for a long time or | |
1046 | hand it out to lisp code, copy it. This procedure will be called | |
1047 | for every key sequence read, so the nice lispy approach (return a | |
1048 | new assoclist, list, what have you) for each invocation would | |
1049 | result in a lot of consing over time. | |
1050 | ||
1051 | If we used xrealloc/xmalloc and ran out of memory, they would throw | |
1052 | back to the command loop, which would try to read a key sequence, | |
1053 | which would call this function again, resulting in an infinite | |
1054 | loop. Instead, we'll use realloc/malloc and silently truncate the | |
1055 | list, let the key sequence be read, and hope some other piece of | |
1056 | code signals the error. */ | |
1057 | int | |
1058 | current_minor_maps (modeptr, mapptr) | |
1059 | Lisp_Object **modeptr, **mapptr; | |
1060 | { | |
cc0a8174 | 1061 | int i = 0; |
dd9cda06 | 1062 | int list_number = 0; |
6bbbd9b0 | 1063 | Lisp_Object alist, assoc, var, val; |
dd9cda06 RS |
1064 | Lisp_Object lists[2]; |
1065 | ||
1066 | lists[0] = Vminor_mode_overriding_map_alist; | |
1067 | lists[1] = Vminor_mode_map_alist; | |
1068 | ||
1069 | for (list_number = 0; list_number < 2; list_number++) | |
1070 | for (alist = lists[list_number]; | |
1071 | CONSP (alist); | |
1072 | alist = XCONS (alist)->cdr) | |
1073 | if ((assoc = XCONS (alist)->car, CONSP (assoc)) | |
1074 | && (var = XCONS (assoc)->car, SYMBOLP (var)) | |
1075 | && (val = find_symbol_value (var), ! EQ (val, Qunbound)) | |
1076 | && ! NILP (val)) | |
1077 | { | |
1078 | Lisp_Object temp; | |
cc0a8174 | 1079 | |
dd9cda06 RS |
1080 | if (i >= cmm_size) |
1081 | { | |
1082 | Lisp_Object *newmodes, *newmaps; | |
cc0a8174 | 1083 | |
dd9cda06 RS |
1084 | if (cmm_maps) |
1085 | { | |
1086 | BLOCK_INPUT; | |
1087 | cmm_size *= 2; | |
1088 | newmodes | |
1089 | = (Lisp_Object *) realloc (cmm_modes, | |
1090 | cmm_size * sizeof (Lisp_Object)); | |
1091 | newmaps | |
1092 | = (Lisp_Object *) realloc (cmm_maps, | |
1093 | cmm_size * sizeof (Lisp_Object)); | |
1094 | UNBLOCK_INPUT; | |
1095 | } | |
1096 | else | |
1097 | { | |
1098 | BLOCK_INPUT; | |
1099 | cmm_size = 30; | |
1100 | newmodes | |
1101 | = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object)); | |
1102 | newmaps | |
1103 | = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object)); | |
1104 | UNBLOCK_INPUT; | |
1105 | } | |
cc0a8174 | 1106 | |
dd9cda06 RS |
1107 | if (newmaps && newmodes) |
1108 | { | |
1109 | cmm_modes = newmodes; | |
1110 | cmm_maps = newmaps; | |
1111 | } | |
1112 | else | |
1113 | break; | |
1114 | } | |
fbb90829 | 1115 | |
dd9cda06 RS |
1116 | /* Get the keymap definition--or nil if it is not defined. */ |
1117 | temp = internal_condition_case_1 (Findirect_function, | |
1118 | XCONS (assoc)->cdr, | |
1119 | Qerror, current_minor_maps_error); | |
1120 | if (!NILP (temp)) | |
1121 | { | |
1122 | cmm_modes[i] = var; | |
1123 | cmm_maps [i] = temp; | |
1124 | i++; | |
1125 | } | |
1126 | } | |
cc0a8174 | 1127 | |
265a9e55 JB |
1128 | if (modeptr) *modeptr = cmm_modes; |
1129 | if (mapptr) *mapptr = cmm_maps; | |
cc0a8174 JB |
1130 | return i; |
1131 | } | |
1132 | ||
21a0d7a0 RS |
1133 | /* GC is possible in this function if it autoloads a keymap. */ |
1134 | ||
7c140252 | 1135 | DEFUN ("key-binding", Fkey_binding, Skey_binding, 1, 2, 0, |
2c6f1a39 | 1136 | "Return the binding for command KEY in current keymaps.\n\ |
7c140252 JB |
1137 | KEY is a string or vector, a sequence of keystrokes.\n\ |
1138 | The binding is probably a symbol with a function definition.\n\ | |
1139 | \n\ | |
1140 | Normally, `key-binding' ignores bindings for t, which act as default\n\ | |
1141 | bindings, used when nothing else in the keymap applies; this makes it\n\ | |
d831234b RS |
1142 | usable as a general function for probing keymaps. However, if the\n\ |
1143 | optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\ | |
7c140252 JB |
1144 | recognize the default bindings, just as `read-key-sequence' does.") |
1145 | (key, accept_default) | |
c2a2858a | 1146 | Lisp_Object key, accept_default; |
2c6f1a39 | 1147 | { |
cc0a8174 JB |
1148 | Lisp_Object *maps, value; |
1149 | int nmaps, i; | |
21a0d7a0 RS |
1150 | struct gcpro gcpro1; |
1151 | ||
1152 | GCPRO1 (key); | |
cc0a8174 | 1153 | |
e784236d KH |
1154 | if (!NILP (current_kboard->Voverriding_terminal_local_map)) |
1155 | { | |
1156 | value = Flookup_key (current_kboard->Voverriding_terminal_local_map, | |
1157 | key, accept_default); | |
1158 | if (! NILP (value) && !INTEGERP (value)) | |
1159 | RETURN_UNGCPRO (value); | |
1160 | } | |
1161 | else if (!NILP (Voverriding_local_map)) | |
2c6f1a39 | 1162 | { |
7d92e329 | 1163 | value = Flookup_key (Voverriding_local_map, key, accept_default); |
416349ec | 1164 | if (! NILP (value) && !INTEGERP (value)) |
21a0d7a0 | 1165 | RETURN_UNGCPRO (value); |
2c6f1a39 | 1166 | } |
7d92e329 RS |
1167 | else |
1168 | { | |
d964248c KH |
1169 | Lisp_Object local; |
1170 | ||
7d92e329 | 1171 | nmaps = current_minor_maps (0, &maps); |
21a0d7a0 RS |
1172 | /* Note that all these maps are GCPRO'd |
1173 | in the places where we found them. */ | |
1174 | ||
7d92e329 RS |
1175 | for (i = 0; i < nmaps; i++) |
1176 | if (! NILP (maps[i])) | |
1177 | { | |
1178 | value = Flookup_key (maps[i], key, accept_default); | |
416349ec | 1179 | if (! NILP (value) && !INTEGERP (value)) |
21a0d7a0 | 1180 | RETURN_UNGCPRO (value); |
7d92e329 RS |
1181 | } |
1182 | ||
d964248c KH |
1183 | local = get_local_map (PT, current_buffer); |
1184 | ||
1185 | if (! NILP (local)) | |
7d92e329 | 1186 | { |
d964248c | 1187 | value = Flookup_key (local, key, accept_default); |
416349ec | 1188 | if (! NILP (value) && !INTEGERP (value)) |
21a0d7a0 | 1189 | RETURN_UNGCPRO (value); |
7d92e329 RS |
1190 | } |
1191 | } | |
cc0a8174 | 1192 | |
7c140252 | 1193 | value = Flookup_key (current_global_map, key, accept_default); |
21a0d7a0 | 1194 | UNGCPRO; |
416349ec | 1195 | if (! NILP (value) && !INTEGERP (value)) |
cc0a8174 JB |
1196 | return value; |
1197 | ||
1198 | return Qnil; | |
2c6f1a39 JB |
1199 | } |
1200 | ||
21a0d7a0 RS |
1201 | /* GC is possible in this function if it autoloads a keymap. */ |
1202 | ||
7c140252 | 1203 | DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 2, 0, |
2c6f1a39 JB |
1204 | "Return the binding for command KEYS in current local keymap only.\n\ |
1205 | KEYS is a string, a sequence of keystrokes.\n\ | |
7c140252 JB |
1206 | The binding is probably a symbol with a function definition.\n\ |
1207 | \n\ | |
1208 | If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\ | |
1209 | bindings; see the description of `lookup-key' for more details about this.") | |
1210 | (keys, accept_default) | |
1211 | Lisp_Object keys, accept_default; | |
2c6f1a39 JB |
1212 | { |
1213 | register Lisp_Object map; | |
1214 | map = current_buffer->keymap; | |
265a9e55 | 1215 | if (NILP (map)) |
2c6f1a39 | 1216 | return Qnil; |
7c140252 | 1217 | return Flookup_key (map, keys, accept_default); |
2c6f1a39 JB |
1218 | } |
1219 | ||
21a0d7a0 RS |
1220 | /* GC is possible in this function if it autoloads a keymap. */ |
1221 | ||
7c140252 | 1222 | DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 2, 0, |
2c6f1a39 JB |
1223 | "Return the binding for command KEYS in current global keymap only.\n\ |
1224 | KEYS is a string, a sequence of keystrokes.\n\ | |
6bbbd9b0 JB |
1225 | The binding is probably a symbol with a function definition.\n\ |
1226 | This function's return values are the same as those of lookup-key\n\ | |
21a0d7a0 | 1227 | \(which see).\n\ |
7c140252 JB |
1228 | \n\ |
1229 | If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\ | |
1230 | bindings; see the description of `lookup-key' for more details about this.") | |
1231 | (keys, accept_default) | |
1232 | Lisp_Object keys, accept_default; | |
2c6f1a39 | 1233 | { |
7c140252 | 1234 | return Flookup_key (current_global_map, keys, accept_default); |
2c6f1a39 JB |
1235 | } |
1236 | ||
21a0d7a0 RS |
1237 | /* GC is possible in this function if it autoloads a keymap. */ |
1238 | ||
7c140252 | 1239 | DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 2, 0, |
cc0a8174 JB |
1240 | "Find the visible minor mode bindings of KEY.\n\ |
1241 | Return an alist of pairs (MODENAME . BINDING), where MODENAME is the\n\ | |
1242 | the symbol which names the minor mode binding KEY, and BINDING is\n\ | |
1243 | KEY's definition in that mode. In particular, if KEY has no\n\ | |
1244 | minor-mode bindings, return nil. If the first binding is a\n\ | |
1245 | non-prefix, all subsequent bindings will be omitted, since they would\n\ | |
1246 | be ignored. Similarly, the list doesn't include non-prefix bindings\n\ | |
7c140252 JB |
1247 | that come after prefix bindings.\n\ |
1248 | \n\ | |
1249 | If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\ | |
1250 | bindings; see the description of `lookup-key' for more details about this.") | |
1251 | (key, accept_default) | |
1252 | Lisp_Object key, accept_default; | |
cc0a8174 JB |
1253 | { |
1254 | Lisp_Object *modes, *maps; | |
1255 | int nmaps; | |
1256 | Lisp_Object binding; | |
1257 | int i, j; | |
21a0d7a0 | 1258 | struct gcpro gcpro1, gcpro2; |
cc0a8174 JB |
1259 | |
1260 | nmaps = current_minor_maps (&modes, &maps); | |
21a0d7a0 RS |
1261 | /* Note that all these maps are GCPRO'd |
1262 | in the places where we found them. */ | |
1263 | ||
1264 | binding = Qnil; | |
1265 | GCPRO2 (key, binding); | |
cc0a8174 JB |
1266 | |
1267 | for (i = j = 0; i < nmaps; i++) | |
265a9e55 | 1268 | if (! NILP (maps[i]) |
7c140252 | 1269 | && ! NILP (binding = Flookup_key (maps[i], key, accept_default)) |
416349ec | 1270 | && !INTEGERP (binding)) |
cc0a8174 | 1271 | { |
d09b2024 | 1272 | if (! NILP (get_keymap (binding))) |
cc0a8174 JB |
1273 | maps[j++] = Fcons (modes[i], binding); |
1274 | else if (j == 0) | |
21a0d7a0 | 1275 | RETURN_UNGCPRO (Fcons (Fcons (modes[i], binding), Qnil)); |
cc0a8174 JB |
1276 | } |
1277 | ||
21a0d7a0 | 1278 | UNGCPRO; |
cc0a8174 JB |
1279 | return Flist (j, maps); |
1280 | } | |
1281 | ||
2c6f1a39 | 1282 | DEFUN ("define-prefix-command", Fdefine_prefix_command, Sdefine_prefix_command, 1, 2, 0, |
cd8520b9 | 1283 | "Define COMMAND as a prefix command. COMMAND should be a symbol.\n\ |
2c6f1a39 | 1284 | A new sparse keymap is stored as COMMAND's function definition and its value.\n\ |
1d8d96fa JB |
1285 | If a second optional argument MAPVAR is given, the map is stored as\n\ |
1286 | its value instead of as COMMAND's value; but COMMAND is still defined\n\ | |
1287 | as a function.") | |
88539837 EN |
1288 | (command, mapvar) |
1289 | Lisp_Object command, mapvar; | |
2c6f1a39 JB |
1290 | { |
1291 | Lisp_Object map; | |
ce6e5d0b | 1292 | map = Fmake_sparse_keymap (Qnil); |
88539837 | 1293 | Ffset (command, map); |
265a9e55 | 1294 | if (!NILP (mapvar)) |
2c6f1a39 JB |
1295 | Fset (mapvar, map); |
1296 | else | |
88539837 EN |
1297 | Fset (command, map); |
1298 | return command; | |
2c6f1a39 JB |
1299 | } |
1300 | ||
1301 | DEFUN ("use-global-map", Fuse_global_map, Suse_global_map, 1, 1, 0, | |
1302 | "Select KEYMAP as the global keymap.") | |
1303 | (keymap) | |
1304 | Lisp_Object keymap; | |
1305 | { | |
1306 | keymap = get_keymap (keymap); | |
1307 | current_global_map = keymap; | |
6f27e7a2 | 1308 | |
2c6f1a39 JB |
1309 | return Qnil; |
1310 | } | |
1311 | ||
1312 | DEFUN ("use-local-map", Fuse_local_map, Suse_local_map, 1, 1, 0, | |
1313 | "Select KEYMAP as the local keymap.\n\ | |
1314 | If KEYMAP is nil, that means no local keymap.") | |
1315 | (keymap) | |
1316 | Lisp_Object keymap; | |
1317 | { | |
265a9e55 | 1318 | if (!NILP (keymap)) |
2c6f1a39 JB |
1319 | keymap = get_keymap (keymap); |
1320 | ||
1321 | current_buffer->keymap = keymap; | |
1322 | ||
1323 | return Qnil; | |
1324 | } | |
1325 | ||
1326 | DEFUN ("current-local-map", Fcurrent_local_map, Scurrent_local_map, 0, 0, 0, | |
1327 | "Return current buffer's local keymap, or nil if it has none.") | |
1328 | () | |
1329 | { | |
1330 | return current_buffer->keymap; | |
1331 | } | |
1332 | ||
1333 | DEFUN ("current-global-map", Fcurrent_global_map, Scurrent_global_map, 0, 0, 0, | |
1334 | "Return the current global keymap.") | |
1335 | () | |
1336 | { | |
1337 | return current_global_map; | |
1338 | } | |
cc0a8174 JB |
1339 | |
1340 | DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps, Scurrent_minor_mode_maps, 0, 0, 0, | |
1341 | "Return a list of keymaps for the minor modes of the current buffer.") | |
1342 | () | |
1343 | { | |
1344 | Lisp_Object *maps; | |
1345 | int nmaps = current_minor_maps (0, &maps); | |
1346 | ||
1347 | return Flist (nmaps, maps); | |
1348 | } | |
2c6f1a39 | 1349 | \f |
cc0a8174 JB |
1350 | /* Help functions for describing and documenting keymaps. */ |
1351 | ||
69248761 | 1352 | static void accessible_keymaps_char_table (); |
0403641f | 1353 | |
21a0d7a0 RS |
1354 | /* This function cannot GC. */ |
1355 | ||
2c6f1a39 | 1356 | DEFUN ("accessible-keymaps", Faccessible_keymaps, Saccessible_keymaps, |
53c8f9fa | 1357 | 1, 2, 0, |
2c6f1a39 JB |
1358 | "Find all keymaps accessible via prefix characters from KEYMAP.\n\ |
1359 | Returns a list of elements of the form (KEYS . MAP), where the sequence\n\ | |
1360 | KEYS starting from KEYMAP gets you to MAP. These elements are ordered\n\ | |
c3f27064 | 1361 | so that the KEYS increase in length. The first element is ([] . KEYMAP).\n\ |
f66ef185 RS |
1362 | An optional argument PREFIX, if non-nil, should be a key sequence;\n\ |
1363 | then the value includes only maps for prefixes that start with PREFIX.") | |
88539837 EN |
1364 | (keymap, prefix) |
1365 | Lisp_Object keymap, prefix; | |
2c6f1a39 | 1366 | { |
53c8f9fa RS |
1367 | Lisp_Object maps, good_maps, tail; |
1368 | int prefixlen = 0; | |
1369 | ||
21a0d7a0 RS |
1370 | /* no need for gcpro because we don't autoload any keymaps. */ |
1371 | ||
53c8f9fa RS |
1372 | if (!NILP (prefix)) |
1373 | prefixlen = XINT (Flength (prefix)); | |
2c6f1a39 | 1374 | |
44a4a59b RS |
1375 | if (!NILP (prefix)) |
1376 | { | |
1377 | /* If a prefix was specified, start with the keymap (if any) for | |
1378 | that prefix, so we don't waste time considering other prefixes. */ | |
1379 | Lisp_Object tem; | |
88539837 | 1380 | tem = Flookup_key (keymap, prefix, Qt); |
1ae2097f RS |
1381 | /* Flookup_key may give us nil, or a number, |
1382 | if the prefix is not defined in this particular map. | |
1383 | It might even give us a list that isn't a keymap. */ | |
1384 | tem = get_keymap_1 (tem, 0, 0); | |
44a4a59b | 1385 | if (!NILP (tem)) |
67fc16a3 RS |
1386 | { |
1387 | /* Convert PREFIX to a vector now, so that later on | |
1388 | we don't have to deal with the possibility of a string. */ | |
1389 | if (STRINGP (prefix)) | |
1390 | { | |
1391 | int i; | |
1392 | Lisp_Object copy; | |
1393 | ||
1394 | copy = Fmake_vector (make_number (XSTRING (prefix)->size), Qnil); | |
1395 | for (i = 0; i < XSTRING (prefix)->size; i++) | |
1396 | { | |
1397 | int c = XSTRING (prefix)->data[i]; | |
1398 | if (c & 0200) | |
1399 | c ^= 0200 | meta_modifier; | |
1400 | XVECTOR (copy)->contents[i] = make_number (c); | |
1401 | } | |
1402 | prefix = copy; | |
1403 | } | |
1404 | maps = Fcons (Fcons (prefix, tem), Qnil); | |
1405 | } | |
44a4a59b RS |
1406 | else |
1407 | return Qnil; | |
1408 | } | |
1409 | else | |
1410 | maps = Fcons (Fcons (Fmake_vector (make_number (0), Qnil), | |
88539837 | 1411 | get_keymap (keymap)), |
44a4a59b | 1412 | Qnil); |
2c6f1a39 JB |
1413 | |
1414 | /* For each map in the list maps, | |
1415 | look at any other maps it points to, | |
1416 | and stick them at the end if they are not already in the list. | |
1417 | ||
1418 | This is a breadth-first traversal, where tail is the queue of | |
1419 | nodes, and maps accumulates a list of all nodes visited. */ | |
1420 | ||
f5b79c1c | 1421 | for (tail = maps; CONSP (tail); tail = XCONS (tail)->cdr) |
2c6f1a39 | 1422 | { |
e9b6dfb0 KH |
1423 | register Lisp_Object thisseq, thismap; |
1424 | Lisp_Object last; | |
2c6f1a39 | 1425 | /* Does the current sequence end in the meta-prefix-char? */ |
e9b6dfb0 KH |
1426 | int is_metized; |
1427 | ||
1428 | thisseq = Fcar (Fcar (tail)); | |
1429 | thismap = Fcdr (Fcar (tail)); | |
1430 | last = make_number (XINT (Flength (thisseq)) - 1); | |
1431 | is_metized = (XINT (last) >= 0 | |
97ae4b89 RS |
1432 | /* Don't metize the last char of PREFIX. */ |
1433 | && XINT (last) >= prefixlen | |
e9b6dfb0 | 1434 | && EQ (Faref (thisseq, last), meta_prefix_char)); |
2c6f1a39 | 1435 | |
f5b79c1c | 1436 | for (; CONSP (thismap); thismap = XCONS (thismap)->cdr) |
2c6f1a39 | 1437 | { |
e9b6dfb0 KH |
1438 | Lisp_Object elt; |
1439 | ||
1440 | elt = XCONS (thismap)->car; | |
2c6f1a39 | 1441 | |
f5b79c1c JB |
1442 | QUIT; |
1443 | ||
0403641f RS |
1444 | if (CHAR_TABLE_P (elt)) |
1445 | { | |
23cf1efa | 1446 | Lisp_Object indices[3]; |
0403641f RS |
1447 | |
1448 | map_char_table (accessible_keymaps_char_table, Qnil, | |
1449 | elt, Fcons (maps, Fcons (tail, thisseq)), | |
1450 | 0, indices); | |
1451 | } | |
1452 | else if (VECTORP (elt)) | |
2c6f1a39 JB |
1453 | { |
1454 | register int i; | |
1455 | ||
1456 | /* Vector keymap. Scan all the elements. */ | |
db6f9d95 | 1457 | for (i = 0; i < XVECTOR (elt)->size; i++) |
2c6f1a39 JB |
1458 | { |
1459 | register Lisp_Object tem; | |
1460 | register Lisp_Object cmd; | |
1461 | ||
224a16e8 | 1462 | cmd = get_keyelt (XVECTOR (elt)->contents[i], 0); |
265a9e55 | 1463 | if (NILP (cmd)) continue; |
2c6f1a39 | 1464 | tem = Fkeymapp (cmd); |
265a9e55 | 1465 | if (!NILP (tem)) |
2c6f1a39 JB |
1466 | { |
1467 | cmd = get_keymap (cmd); | |
1468 | /* Ignore keymaps that are already added to maps. */ | |
1469 | tem = Frassq (cmd, maps); | |
265a9e55 | 1470 | if (NILP (tem)) |
2c6f1a39 JB |
1471 | { |
1472 | /* If the last key in thisseq is meta-prefix-char, | |
1473 | turn it into a meta-ized keystroke. We know | |
1474 | that the event we're about to append is an | |
f5b79c1c JB |
1475 | ascii keystroke since we're processing a |
1476 | keymap table. */ | |
2c6f1a39 JB |
1477 | if (is_metized) |
1478 | { | |
0b8fc2d4 | 1479 | int meta_bit = meta_modifier; |
2c6f1a39 | 1480 | tem = Fcopy_sequence (thisseq); |
0b8fc2d4 RS |
1481 | |
1482 | Faset (tem, last, make_number (i | meta_bit)); | |
2c6f1a39 JB |
1483 | |
1484 | /* This new sequence is the same length as | |
1485 | thisseq, so stick it in the list right | |
1486 | after this one. */ | |
0b8fc2d4 RS |
1487 | XCONS (tail)->cdr |
1488 | = Fcons (Fcons (tem, cmd), XCONS (tail)->cdr); | |
2c6f1a39 JB |
1489 | } |
1490 | else | |
1491 | { | |
1492 | tem = append_key (thisseq, make_number (i)); | |
1493 | nconc2 (tail, Fcons (Fcons (tem, cmd), Qnil)); | |
1494 | } | |
1495 | } | |
1496 | } | |
1497 | } | |
0403641f | 1498 | } |
f5b79c1c | 1499 | else if (CONSP (elt)) |
2c6f1a39 | 1500 | { |
e9b6dfb0 | 1501 | register Lisp_Object cmd, tem, filter; |
2c6f1a39 | 1502 | |
224a16e8 | 1503 | cmd = get_keyelt (XCONS (elt)->cdr, 0); |
2c6f1a39 JB |
1504 | /* Ignore definitions that aren't keymaps themselves. */ |
1505 | tem = Fkeymapp (cmd); | |
265a9e55 | 1506 | if (!NILP (tem)) |
2c6f1a39 JB |
1507 | { |
1508 | /* Ignore keymaps that have been seen already. */ | |
1509 | cmd = get_keymap (cmd); | |
1510 | tem = Frassq (cmd, maps); | |
265a9e55 | 1511 | if (NILP (tem)) |
2c6f1a39 | 1512 | { |
53c8f9fa | 1513 | /* Let elt be the event defined by this map entry. */ |
2c6f1a39 JB |
1514 | elt = XCONS (elt)->car; |
1515 | ||
1516 | /* If the last key in thisseq is meta-prefix-char, and | |
1517 | this entry is a binding for an ascii keystroke, | |
1518 | turn it into a meta-ized keystroke. */ | |
416349ec | 1519 | if (is_metized && INTEGERP (elt)) |
2c6f1a39 | 1520 | { |
97ae4b89 RS |
1521 | Lisp_Object element; |
1522 | ||
1523 | element = thisseq; | |
1524 | tem = Fvconcat (1, &element); | |
2e34157c RS |
1525 | XSETFASTINT (XVECTOR (tem)->contents[XINT (last)], |
1526 | XINT (elt) | meta_modifier); | |
2c6f1a39 JB |
1527 | |
1528 | /* This new sequence is the same length as | |
1529 | thisseq, so stick it in the list right | |
1530 | after this one. */ | |
53c8f9fa RS |
1531 | XCONS (tail)->cdr |
1532 | = Fcons (Fcons (tem, cmd), XCONS (tail)->cdr); | |
2c6f1a39 JB |
1533 | } |
1534 | else | |
1535 | nconc2 (tail, | |
1536 | Fcons (Fcons (append_key (thisseq, elt), cmd), | |
1537 | Qnil)); | |
1538 | } | |
1539 | } | |
1540 | } | |
2c6f1a39 | 1541 | } |
2c6f1a39 JB |
1542 | } |
1543 | ||
53c8f9fa RS |
1544 | if (NILP (prefix)) |
1545 | return maps; | |
1546 | ||
1547 | /* Now find just the maps whose access prefixes start with PREFIX. */ | |
1548 | ||
1549 | good_maps = Qnil; | |
1550 | for (; CONSP (maps); maps = XCONS (maps)->cdr) | |
1551 | { | |
1552 | Lisp_Object elt, thisseq; | |
1553 | elt = XCONS (maps)->car; | |
1554 | thisseq = XCONS (elt)->car; | |
1555 | /* The access prefix must be at least as long as PREFIX, | |
1556 | and the first elements must match those of PREFIX. */ | |
1557 | if (XINT (Flength (thisseq)) >= prefixlen) | |
1558 | { | |
1559 | int i; | |
1560 | for (i = 0; i < prefixlen; i++) | |
1561 | { | |
1562 | Lisp_Object i1; | |
6e344130 | 1563 | XSETFASTINT (i1, i); |
53c8f9fa RS |
1564 | if (!EQ (Faref (thisseq, i1), Faref (prefix, i1))) |
1565 | break; | |
1566 | } | |
1567 | if (i == prefixlen) | |
1568 | good_maps = Fcons (elt, good_maps); | |
1569 | } | |
1570 | } | |
1571 | ||
1572 | return Fnreverse (good_maps); | |
2c6f1a39 JB |
1573 | } |
1574 | ||
69248761 | 1575 | static void |
0403641f RS |
1576 | accessible_keymaps_char_table (args, index, cmd) |
1577 | Lisp_Object args, index, cmd; | |
1578 | { | |
1579 | Lisp_Object tem; | |
1580 | Lisp_Object maps, tail, thisseq; | |
1581 | ||
1582 | if (NILP (cmd)) | |
69248761 | 1583 | return; |
0403641f RS |
1584 | |
1585 | maps = XCONS (args)->car; | |
1586 | tail = XCONS (XCONS (args)->cdr)->car; | |
1587 | thisseq = XCONS (XCONS (args)->cdr)->cdr; | |
1588 | ||
1589 | tem = Fkeymapp (cmd); | |
1590 | if (!NILP (tem)) | |
1591 | { | |
1592 | cmd = get_keymap (cmd); | |
1593 | /* Ignore keymaps that are already added to maps. */ | |
1594 | tem = Frassq (cmd, maps); | |
1595 | if (NILP (tem)) | |
1596 | { | |
1597 | tem = append_key (thisseq, index); | |
1598 | nconc2 (tail, Fcons (Fcons (tem, cmd), Qnil)); | |
1599 | } | |
1600 | } | |
0403641f RS |
1601 | } |
1602 | \f | |
2c6f1a39 JB |
1603 | Lisp_Object Qsingle_key_description, Qkey_description; |
1604 | ||
21a0d7a0 RS |
1605 | /* This function cannot GC. */ |
1606 | ||
2c6f1a39 JB |
1607 | DEFUN ("key-description", Fkey_description, Skey_description, 1, 1, 0, |
1608 | "Return a pretty description of key-sequence KEYS.\n\ | |
1609 | Control characters turn into \"C-foo\" sequences, meta into \"M-foo\"\n\ | |
1610 | spaces are put between sequence elements, etc.") | |
1611 | (keys) | |
1612 | Lisp_Object keys; | |
1613 | { | |
4c7d5f13 RS |
1614 | int len; |
1615 | int i; | |
1616 | Lisp_Object sep; | |
1617 | Lisp_Object *args; | |
1618 | ||
47684cd9 | 1619 | if (STRINGP (keys)) |
6ba6e250 RS |
1620 | { |
1621 | Lisp_Object vector; | |
6ba6e250 RS |
1622 | vector = Fmake_vector (Flength (keys), Qnil); |
1623 | for (i = 0; i < XSTRING (keys)->size; i++) | |
1624 | { | |
1625 | if (XSTRING (keys)->data[i] & 0x80) | |
6e344130 KH |
1626 | XSETFASTINT (XVECTOR (vector)->contents[i], |
1627 | meta_modifier | (XSTRING (keys)->data[i] & ~0x80)); | |
6ba6e250 | 1628 | else |
6e344130 KH |
1629 | XSETFASTINT (XVECTOR (vector)->contents[i], |
1630 | XSTRING (keys)->data[i]); | |
6ba6e250 RS |
1631 | } |
1632 | keys = vector; | |
1633 | } | |
e283121b | 1634 | else if (!VECTORP (keys)) |
47684cd9 | 1635 | keys = wrong_type_argument (Qarrayp, keys); |
4c7d5f13 RS |
1636 | |
1637 | /* In effect, this computes | |
1638 | (mapconcat 'single-key-description keys " ") | |
1639 | but we shouldn't use mapconcat because it can do GC. */ | |
1640 | ||
1641 | len = XVECTOR (keys)->size; | |
1642 | sep = build_string (" "); | |
1643 | /* This has one extra element at the end that we don't pass to Fconcat. */ | |
1644 | args = (Lisp_Object *) alloca (len * 2 * sizeof (Lisp_Object)); | |
1645 | ||
1646 | for (i = 0; i < len; i++) | |
1647 | { | |
1648 | args[i * 2] = Fsingle_key_description (XVECTOR (keys)->contents[i]); | |
1649 | args[i * 2 + 1] = sep; | |
1650 | } | |
1651 | ||
1652 | return Fconcat (len * 2 - 1, args); | |
2c6f1a39 JB |
1653 | } |
1654 | ||
1655 | char * | |
1656 | push_key_description (c, p) | |
1657 | register unsigned int c; | |
1658 | register char *p; | |
1659 | { | |
71ac885b RS |
1660 | /* Clear all the meaningless bits above the meta bit. */ |
1661 | c &= meta_modifier | ~ - meta_modifier; | |
1662 | ||
6ba6e250 RS |
1663 | if (c & alt_modifier) |
1664 | { | |
1665 | *p++ = 'A'; | |
1666 | *p++ = '-'; | |
1667 | c -= alt_modifier; | |
1668 | } | |
1669 | if (c & ctrl_modifier) | |
1670 | { | |
1671 | *p++ = 'C'; | |
1672 | *p++ = '-'; | |
1673 | c -= ctrl_modifier; | |
1674 | } | |
1675 | if (c & hyper_modifier) | |
1676 | { | |
1677 | *p++ = 'H'; | |
1678 | *p++ = '-'; | |
1679 | c -= hyper_modifier; | |
1680 | } | |
1681 | if (c & meta_modifier) | |
2c6f1a39 JB |
1682 | { |
1683 | *p++ = 'M'; | |
1684 | *p++ = '-'; | |
6ba6e250 RS |
1685 | c -= meta_modifier; |
1686 | } | |
1687 | if (c & shift_modifier) | |
1688 | { | |
1689 | *p++ = 'S'; | |
1690 | *p++ = '-'; | |
1691 | c -= shift_modifier; | |
1692 | } | |
1693 | if (c & super_modifier) | |
1694 | { | |
1695 | *p++ = 's'; | |
1696 | *p++ = '-'; | |
1697 | c -= super_modifier; | |
2c6f1a39 JB |
1698 | } |
1699 | if (c < 040) | |
1700 | { | |
1701 | if (c == 033) | |
1702 | { | |
1703 | *p++ = 'E'; | |
1704 | *p++ = 'S'; | |
1705 | *p++ = 'C'; | |
1706 | } | |
6ba6e250 | 1707 | else if (c == '\t') |
2c6f1a39 JB |
1708 | { |
1709 | *p++ = 'T'; | |
1710 | *p++ = 'A'; | |
1711 | *p++ = 'B'; | |
1712 | } | |
b8cab006 | 1713 | else if (c == Ctl ('M')) |
2c6f1a39 JB |
1714 | { |
1715 | *p++ = 'R'; | |
1716 | *p++ = 'E'; | |
1717 | *p++ = 'T'; | |
1718 | } | |
1719 | else | |
1720 | { | |
1721 | *p++ = 'C'; | |
1722 | *p++ = '-'; | |
1723 | if (c > 0 && c <= Ctl ('Z')) | |
1724 | *p++ = c + 0140; | |
1725 | else | |
1726 | *p++ = c + 0100; | |
1727 | } | |
1728 | } | |
1729 | else if (c == 0177) | |
1730 | { | |
1731 | *p++ = 'D'; | |
1732 | *p++ = 'E'; | |
1733 | *p++ = 'L'; | |
1734 | } | |
1735 | else if (c == ' ') | |
1736 | { | |
1737 | *p++ = 'S'; | |
1738 | *p++ = 'P'; | |
1739 | *p++ = 'C'; | |
1740 | } | |
a98f1d1d | 1741 | else if (c < 256) |
1df19f02 KH |
1742 | *p++ = c; |
1743 | else if (c < 512) | |
a98f1d1d | 1744 | { |
1df19f02 KH |
1745 | *p++ = '\\'; |
1746 | *p++ = (7 & (c >> 6)) + '0'; | |
1747 | *p++ = (7 & (c >> 3)) + '0'; | |
1748 | *p++ = (7 & (c >> 0)) + '0'; | |
a98f1d1d | 1749 | } |
6ba6e250 RS |
1750 | else |
1751 | { | |
1752 | *p++ = '\\'; | |
1753 | *p++ = (7 & (c >> 15)) + '0'; | |
1754 | *p++ = (7 & (c >> 12)) + '0'; | |
1755 | *p++ = (7 & (c >> 9)) + '0'; | |
1756 | *p++ = (7 & (c >> 6)) + '0'; | |
1757 | *p++ = (7 & (c >> 3)) + '0'; | |
1758 | *p++ = (7 & (c >> 0)) + '0'; | |
1759 | } | |
2c6f1a39 JB |
1760 | |
1761 | return p; | |
1762 | } | |
1763 | ||
21a0d7a0 RS |
1764 | /* This function cannot GC. */ |
1765 | ||
2c6f1a39 JB |
1766 | DEFUN ("single-key-description", Fsingle_key_description, Ssingle_key_description, 1, 1, 0, |
1767 | "Return a pretty description of command character KEY.\n\ | |
1768 | Control characters turn into C-whatever, etc.") | |
1769 | (key) | |
1770 | Lisp_Object key; | |
1771 | { | |
6ba6e250 | 1772 | char tem[20]; |
2c6f1a39 | 1773 | |
cebd887d | 1774 | key = EVENT_HEAD (key); |
6bbbd9b0 | 1775 | |
e958fd9a | 1776 | if (INTEGERP (key)) /* Normal character */ |
2c6f1a39 | 1777 | { |
6ba6e250 | 1778 | *push_key_description (XUINT (key), tem) = 0; |
2c6f1a39 | 1779 | return build_string (tem); |
2c6f1a39 | 1780 | } |
e958fd9a KH |
1781 | else if (SYMBOLP (key)) /* Function key or event-symbol */ |
1782 | return Fsymbol_name (key); | |
1783 | else if (STRINGP (key)) /* Buffer names in the menubar. */ | |
1784 | return Fcopy_sequence (key); | |
1785 | else | |
1786 | error ("KEY must be an integer, cons, symbol, or string"); | |
2c6f1a39 JB |
1787 | } |
1788 | ||
1789 | char * | |
1790 | push_text_char_description (c, p) | |
1791 | register unsigned int c; | |
1792 | register char *p; | |
1793 | { | |
1794 | if (c >= 0200) | |
1795 | { | |
1796 | *p++ = 'M'; | |
1797 | *p++ = '-'; | |
1798 | c -= 0200; | |
1799 | } | |
1800 | if (c < 040) | |
1801 | { | |
1802 | *p++ = '^'; | |
1803 | *p++ = c + 64; /* 'A' - 1 */ | |
1804 | } | |
1805 | else if (c == 0177) | |
1806 | { | |
1807 | *p++ = '^'; | |
1808 | *p++ = '?'; | |
1809 | } | |
1810 | else | |
1811 | *p++ = c; | |
1812 | return p; | |
1813 | } | |
1814 | ||
21a0d7a0 RS |
1815 | /* This function cannot GC. */ |
1816 | ||
2c6f1a39 | 1817 | DEFUN ("text-char-description", Ftext_char_description, Stext_char_description, 1, 1, 0, |
88539837 | 1818 | "Return a pretty description of file-character CHARACTER.\n\ |
2c6f1a39 | 1819 | Control characters turn into \"^char\", etc.") |
88539837 EN |
1820 | (character) |
1821 | Lisp_Object character; | |
2c6f1a39 JB |
1822 | { |
1823 | char tem[6]; | |
1824 | ||
88539837 | 1825 | CHECK_NUMBER (character, 0); |
2c6f1a39 | 1826 | |
a98f1d1d KH |
1827 | if (!SINGLE_BYTE_CHAR_P (XFASTINT (character))) |
1828 | { | |
69248761 | 1829 | unsigned char *str; |
a98f1d1d KH |
1830 | int len = non_ascii_char_to_string (XFASTINT (character), tem, &str); |
1831 | ||
1832 | return make_string (str, len); | |
1833 | } | |
1834 | ||
88539837 | 1835 | *push_text_char_description (XINT (character) & 0377, tem) = 0; |
2c6f1a39 JB |
1836 | |
1837 | return build_string (tem); | |
1838 | } | |
2fc66973 JB |
1839 | |
1840 | /* Return non-zero if SEQ contains only ASCII characters, perhaps with | |
1841 | a meta bit. */ | |
1842 | static int | |
1843 | ascii_sequence_p (seq) | |
1844 | Lisp_Object seq; | |
1845 | { | |
6e344130 | 1846 | int i; |
2fc66973 | 1847 | int len = XINT (Flength (seq)); |
ffab2bd6 | 1848 | |
6e344130 | 1849 | for (i = 0; i < len; i++) |
2fc66973 | 1850 | { |
6e344130 | 1851 | Lisp_Object ii, elt; |
ffab2bd6 | 1852 | |
6e344130 KH |
1853 | XSETFASTINT (ii, i); |
1854 | elt = Faref (seq, ii); | |
2fc66973 | 1855 | |
416349ec | 1856 | if (!INTEGERP (elt) |
2fc66973 JB |
1857 | || (XUINT (elt) & ~CHAR_META) >= 0x80) |
1858 | return 0; | |
1859 | } | |
1860 | ||
1861 | return 1; | |
1862 | } | |
1863 | ||
2c6f1a39 | 1864 | \f |
cc0a8174 JB |
1865 | /* where-is - finding a command in a set of keymaps. */ |
1866 | ||
0403641f | 1867 | static Lisp_Object where_is_internal_1 (); |
69248761 | 1868 | static void where_is_internal_2 (); |
0403641f | 1869 | |
21a0d7a0 RS |
1870 | /* This function can GC if Flookup_key autoloads any keymaps. */ |
1871 | ||
f0148b5e RS |
1872 | DEFUN ("where-is-internal", Fwhere_is_internal, Swhere_is_internal, 1, 4, 0, |
1873 | "Return list of keys that invoke DEFINITION.\n\ | |
1874 | If KEYMAP is non-nil, search only KEYMAP and the global keymap.\n\ | |
1875 | If KEYMAP is nil, search all the currently active keymaps.\n\ | |
2c6f1a39 | 1876 | \n\ |
f0148b5e | 1877 | If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found,\n\ |
b8d584f6 | 1878 | rather than a list of all possible key sequences.\n\ |
0bc395d4 RS |
1879 | If FIRSTONLY is the symbol `non-ascii', return the first binding found,\n\ |
1880 | no matter what it is.\n\ | |
d7ec5fa2 | 1881 | If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters,\n\ |
0bc395d4 | 1882 | and entirely reject menu bindings.\n\ |
2c6f1a39 | 1883 | \n\ |
f0148b5e | 1884 | If optional 4th arg NOINDIRECT is non-nil, don't follow indirections\n\ |
2c6f1a39 JB |
1885 | to other keymaps or slots. This makes it possible to search for an\n\ |
1886 | indirect definition itself.") | |
f0148b5e RS |
1887 | (definition, keymap, firstonly, noindirect) |
1888 | Lisp_Object definition, keymap; | |
2c6f1a39 JB |
1889 | Lisp_Object firstonly, noindirect; |
1890 | { | |
21a0d7a0 | 1891 | Lisp_Object maps; |
0403641f | 1892 | Lisp_Object found, sequences; |
60b06e5e | 1893 | Lisp_Object keymap1; |
f0148b5e | 1894 | int keymap_specified = !NILP (keymap); |
21a0d7a0 | 1895 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5; |
0bc395d4 RS |
1896 | /* 1 means ignore all menu bindings entirely. */ |
1897 | int nomenus = !NILP (firstonly) && !EQ (firstonly, Qnon_ascii); | |
2c6f1a39 | 1898 | |
60b06e5e KH |
1899 | /* Find keymaps accessible from `keymap' or the current |
1900 | context. But don't muck with the value of `keymap', | |
1901 | because `where_is_internal_1' uses it to check for | |
1902 | shadowed bindings. */ | |
1903 | keymap1 = keymap; | |
f0148b5e RS |
1904 | if (! keymap_specified) |
1905 | { | |
1906 | #ifdef USE_TEXT_PROPERTIES | |
60b06e5e | 1907 | keymap1 = get_local_map (PT, current_buffer); |
f0148b5e | 1908 | #else |
60b06e5e | 1909 | keymap1 = current_buffer->keymap; |
f0148b5e RS |
1910 | #endif |
1911 | } | |
60b06e5e KH |
1912 | |
1913 | if (!NILP (keymap1)) | |
1914 | maps = nconc2 (Faccessible_keymaps (get_keymap (keymap1), Qnil), | |
f0148b5e RS |
1915 | Faccessible_keymaps (get_keymap (current_global_map), |
1916 | Qnil)); | |
2c6f1a39 | 1917 | else |
f0148b5e RS |
1918 | maps = Faccessible_keymaps (get_keymap (current_global_map), Qnil); |
1919 | ||
1920 | /* Put the minor mode keymaps on the front. */ | |
1921 | if (! keymap_specified) | |
1922 | { | |
1923 | Lisp_Object minors; | |
1924 | minors = Fnreverse (Fcurrent_minor_mode_maps ()); | |
1925 | while (!NILP (minors)) | |
1926 | { | |
1927 | maps = nconc2 (Faccessible_keymaps (get_keymap (XCONS (minors)->car), | |
1928 | Qnil), | |
1929 | maps); | |
1930 | minors = XCONS (minors)->cdr; | |
1931 | } | |
1932 | } | |
2c6f1a39 | 1933 | |
0403641f | 1934 | GCPRO5 (definition, keymap, maps, found, sequences); |
2c6f1a39 | 1935 | found = Qnil; |
0403641f | 1936 | sequences = Qnil; |
2c6f1a39 | 1937 | |
265a9e55 | 1938 | for (; !NILP (maps); maps = Fcdr (maps)) |
2c6f1a39 | 1939 | { |
e9b6dfb0 KH |
1940 | /* Key sequence to reach map, and the map that it reaches */ |
1941 | register Lisp_Object this, map; | |
f5b79c1c | 1942 | |
2c6f1a39 JB |
1943 | /* In order to fold [META-PREFIX-CHAR CHAR] sequences into |
1944 | [M-CHAR] sequences, check if last character of the sequence | |
1945 | is the meta-prefix char. */ | |
e9b6dfb0 KH |
1946 | Lisp_Object last; |
1947 | int last_is_meta; | |
1948 | ||
1949 | this = Fcar (Fcar (maps)); | |
1950 | map = Fcdr (Fcar (maps)); | |
1951 | last = make_number (XINT (Flength (this)) - 1); | |
1952 | last_is_meta = (XINT (last) >= 0 | |
1953 | && EQ (Faref (this, last), meta_prefix_char)); | |
2c6f1a39 | 1954 | |
fde3a52f JB |
1955 | QUIT; |
1956 | ||
f5b79c1c | 1957 | while (CONSP (map)) |
2c6f1a39 | 1958 | { |
f5b79c1c JB |
1959 | /* Because the code we want to run on each binding is rather |
1960 | large, we don't want to have two separate loop bodies for | |
1961 | sparse keymap bindings and tables; we want to iterate one | |
1962 | loop body over both keymap and vector bindings. | |
1963 | ||
1964 | For this reason, if Fcar (map) is a vector, we don't | |
1965 | advance map to the next element until i indicates that we | |
1966 | have finished off the vector. */ | |
21a0d7a0 | 1967 | Lisp_Object elt, key, binding; |
e9b6dfb0 | 1968 | elt = XCONS (map)->car; |
0403641f RS |
1969 | map = XCONS (map)->cdr; |
1970 | ||
1971 | sequences = Qnil; | |
f5b79c1c | 1972 | |
fde3a52f JB |
1973 | QUIT; |
1974 | ||
f5b79c1c JB |
1975 | /* Set key and binding to the current key and binding, and |
1976 | advance map and i to the next binding. */ | |
416349ec | 1977 | if (VECTORP (elt)) |
2c6f1a39 | 1978 | { |
0403641f RS |
1979 | Lisp_Object sequence; |
1980 | int i; | |
2c6f1a39 | 1981 | /* In a vector, look at each element. */ |
0403641f | 1982 | for (i = 0; i < XVECTOR (elt)->size; i++) |
2c6f1a39 | 1983 | { |
0403641f RS |
1984 | binding = XVECTOR (elt)->contents[i]; |
1985 | XSETFASTINT (key, i); | |
1986 | sequence = where_is_internal_1 (binding, key, definition, | |
1987 | noindirect, keymap, this, | |
1988 | last, nomenus, last_is_meta); | |
1989 | if (!NILP (sequence)) | |
1990 | sequences = Fcons (sequence, sequences); | |
2c6f1a39 | 1991 | } |
f5b79c1c | 1992 | } |
0403641f | 1993 | else if (CHAR_TABLE_P (elt)) |
f5b79c1c | 1994 | { |
23cf1efa | 1995 | Lisp_Object indices[3]; |
0403641f | 1996 | Lisp_Object args; |
23cf1efa | 1997 | |
0403641f RS |
1998 | args = Fcons (Fcons (Fcons (definition, noindirect), |
1999 | Fcons (keymap, Qnil)), | |
2000 | Fcons (Fcons (this, last), | |
2001 | Fcons (make_number (nomenus), | |
2002 | make_number (last_is_meta)))); | |
2003 | ||
2004 | map_char_table (where_is_internal_2, Qnil, elt, args, | |
2005 | 0, indices); | |
2006 | sequences = XCONS (XCONS (XCONS (args)->car)->cdr)->cdr; | |
2c6f1a39 | 2007 | } |
0403641f | 2008 | else if (CONSP (elt)) |
fde3a52f | 2009 | { |
0403641f | 2010 | Lisp_Object sequence; |
2c6f1a39 | 2011 | |
0403641f RS |
2012 | key = XCONS (elt)->car; |
2013 | binding = XCONS (elt)->cdr; | |
2c6f1a39 | 2014 | |
0403641f RS |
2015 | sequence = where_is_internal_1 (binding, key, definition, |
2016 | noindirect, keymap, this, | |
2017 | last, nomenus, last_is_meta); | |
2018 | if (!NILP (sequence)) | |
2019 | sequences = Fcons (sequence, sequences); | |
2c6f1a39 | 2020 | } |
2c6f1a39 | 2021 | |
2c6f1a39 | 2022 | |
0403641f | 2023 | for (; ! NILP (sequences); sequences = XCONS (sequences)->cdr) |
2c6f1a39 | 2024 | { |
0403641f RS |
2025 | Lisp_Object sequence; |
2026 | ||
2027 | sequence = XCONS (sequences)->car; | |
2028 | ||
2029 | /* It is a true unshadowed match. Record it, unless it's already | |
2030 | been seen (as could happen when inheriting keymaps). */ | |
2031 | if (NILP (Fmember (sequence, found))) | |
2032 | found = Fcons (sequence, found); | |
2033 | ||
2034 | /* If firstonly is Qnon_ascii, then we can return the first | |
2035 | binding we find. If firstonly is not Qnon_ascii but not | |
2036 | nil, then we should return the first ascii-only binding | |
2037 | we find. */ | |
2038 | if (EQ (firstonly, Qnon_ascii)) | |
2039 | RETURN_UNGCPRO (sequence); | |
2040 | else if (! NILP (firstonly) && ascii_sequence_p (sequence)) | |
2041 | RETURN_UNGCPRO (sequence); | |
2c6f1a39 | 2042 | } |
2c6f1a39 JB |
2043 | } |
2044 | } | |
2fc66973 | 2045 | |
21a0d7a0 RS |
2046 | UNGCPRO; |
2047 | ||
2fc66973 JB |
2048 | found = Fnreverse (found); |
2049 | ||
2050 | /* firstonly may have been t, but we may have gone all the way through | |
2051 | the keymaps without finding an all-ASCII key sequence. So just | |
2052 | return the best we could find. */ | |
2053 | if (! NILP (firstonly)) | |
2054 | return Fcar (found); | |
2055 | ||
2056 | return found; | |
2c6f1a39 | 2057 | } |
0403641f RS |
2058 | |
2059 | /* This is the function that Fwhere_is_internal calls using map_char_table. | |
2060 | ARGS has the form | |
2061 | (((DEFINITION . NOINDIRECT) . (KEYMAP . RESULT)) | |
2062 | . | |
2063 | ((THIS . LAST) . (NOMENUS . LAST_IS_META))) | |
2064 | Since map_char_table doesn't really use the return value from this function, | |
2065 | we the result append to RESULT, the slot in ARGS. */ | |
2066 | ||
69248761 | 2067 | static void |
0403641f RS |
2068 | where_is_internal_2 (args, key, binding) |
2069 | Lisp_Object args, key, binding; | |
2070 | { | |
2071 | Lisp_Object definition, noindirect, keymap, this, last; | |
2072 | Lisp_Object result, sequence; | |
2073 | int nomenus, last_is_meta; | |
2074 | ||
2075 | result = XCONS (XCONS (XCONS (args)->car)->cdr)->cdr; | |
2076 | definition = XCONS (XCONS (XCONS (args)->car)->car)->car; | |
2077 | noindirect = XCONS (XCONS (XCONS (args)->car)->car)->cdr; | |
2078 | keymap = XCONS (XCONS (XCONS (args)->car)->cdr)->car; | |
2079 | this = XCONS (XCONS (XCONS (args)->cdr)->car)->car; | |
2080 | last = XCONS (XCONS (XCONS (args)->cdr)->car)->cdr; | |
2081 | nomenus = XFASTINT (XCONS (XCONS (XCONS (args)->cdr)->cdr)->car); | |
2082 | last_is_meta = XFASTINT (XCONS (XCONS (XCONS (args)->cdr)->cdr)->cdr); | |
2083 | ||
2084 | sequence = where_is_internal_1 (binding, key, definition, noindirect, keymap, | |
2085 | this, last, nomenus, last_is_meta); | |
2086 | ||
2087 | if (!NILP (sequence)) | |
2088 | XCONS (XCONS (XCONS (args)->car)->cdr)->cdr | |
2089 | = Fcons (sequence, result); | |
0403641f RS |
2090 | } |
2091 | ||
2092 | static Lisp_Object | |
2093 | where_is_internal_1 (binding, key, definition, noindirect, keymap, this, last, | |
2094 | nomenus, last_is_meta) | |
2095 | Lisp_Object binding, key, definition, noindirect, keymap, this, last; | |
2096 | int nomenus, last_is_meta; | |
2097 | { | |
2098 | Lisp_Object sequence; | |
2099 | int keymap_specified = !NILP (keymap); | |
2100 | ||
2101 | /* Search through indirections unless that's not wanted. */ | |
2102 | if (NILP (noindirect)) | |
2103 | { | |
2104 | if (nomenus) | |
2105 | { | |
2106 | while (1) | |
2107 | { | |
2108 | Lisp_Object map, tem; | |
2109 | /* If the contents are (KEYMAP . ELEMENT), go indirect. */ | |
2110 | map = get_keymap_1 (Fcar_safe (definition), 0, 0); | |
2111 | tem = Fkeymapp (map); | |
2112 | if (!NILP (tem)) | |
2113 | definition = access_keymap (map, Fcdr (definition), 0, 0); | |
2114 | else | |
2115 | break; | |
2116 | } | |
2117 | /* If the contents are (STRING ...), reject. */ | |
2118 | if (CONSP (definition) | |
2119 | && STRINGP (XCONS (definition)->car)) | |
2120 | return Qnil; | |
2121 | } | |
2122 | else | |
2123 | binding = get_keyelt (binding, 0); | |
2124 | } | |
2125 | ||
2126 | /* End this iteration if this element does not match | |
2127 | the target. */ | |
2128 | ||
2129 | if (CONSP (definition)) | |
2130 | { | |
2131 | Lisp_Object tem; | |
2132 | tem = Fequal (binding, definition); | |
2133 | if (NILP (tem)) | |
2134 | return Qnil; | |
2135 | } | |
2136 | else | |
2137 | if (!EQ (binding, definition)) | |
2138 | return Qnil; | |
2139 | ||
2140 | /* We have found a match. | |
2141 | Construct the key sequence where we found it. */ | |
2142 | if (INTEGERP (key) && last_is_meta) | |
2143 | { | |
2144 | sequence = Fcopy_sequence (this); | |
2145 | Faset (sequence, last, make_number (XINT (key) | meta_modifier)); | |
2146 | } | |
2147 | else | |
2148 | sequence = append_key (this, key); | |
2149 | ||
2150 | /* Verify that this key binding is not shadowed by another | |
2151 | binding for the same key, before we say it exists. | |
2152 | ||
2153 | Mechanism: look for local definition of this key and if | |
2154 | it is defined and does not match what we found then | |
2155 | ignore this key. | |
2156 | ||
2157 | Either nil or number as value from Flookup_key | |
2158 | means undefined. */ | |
2159 | if (keymap_specified) | |
2160 | { | |
2161 | binding = Flookup_key (keymap, sequence, Qnil); | |
2162 | if (!NILP (binding) && !INTEGERP (binding)) | |
2163 | { | |
2164 | if (CONSP (definition)) | |
2165 | { | |
2166 | Lisp_Object tem; | |
2167 | tem = Fequal (binding, definition); | |
2168 | if (NILP (tem)) | |
2169 | return Qnil; | |
2170 | } | |
2171 | else | |
2172 | if (!EQ (binding, definition)) | |
2173 | return Qnil; | |
2174 | } | |
2175 | } | |
2176 | else | |
2177 | { | |
2178 | binding = Fkey_binding (sequence, Qnil); | |
2179 | if (!EQ (binding, definition)) | |
2180 | return Qnil; | |
2181 | } | |
2182 | ||
2183 | return sequence; | |
2184 | } | |
2c6f1a39 | 2185 | \f |
cc0a8174 JB |
2186 | /* describe-bindings - summarizing all the bindings in a set of keymaps. */ |
2187 | ||
53c8f9fa | 2188 | DEFUN ("describe-bindings", Fdescribe_bindings, Sdescribe_bindings, 0, 1, "", |
2c6f1a39 | 2189 | "Show a list of all defined keys, and their definitions.\n\ |
53c8f9fa RS |
2190 | The list is put in a buffer, which is displayed.\n\ |
2191 | An optional argument PREFIX, if non-nil, should be a key sequence;\n\ | |
2192 | then we display only bindings that start with that prefix.") | |
2193 | (prefix) | |
2194 | Lisp_Object prefix; | |
2c6f1a39 JB |
2195 | { |
2196 | register Lisp_Object thisbuf; | |
bff4ec1f | 2197 | XSETBUFFER (thisbuf, current_buffer); |
2c6f1a39 JB |
2198 | internal_with_output_to_temp_buffer ("*Help*", |
2199 | describe_buffer_bindings, | |
53c8f9fa | 2200 | Fcons (thisbuf, prefix)); |
2c6f1a39 JB |
2201 | return Qnil; |
2202 | } | |
2203 | ||
53c8f9fa RS |
2204 | /* ARG is (BUFFER . PREFIX). */ |
2205 | ||
2c6f1a39 | 2206 | static Lisp_Object |
53c8f9fa RS |
2207 | describe_buffer_bindings (arg) |
2208 | Lisp_Object arg; | |
2c6f1a39 | 2209 | { |
53c8f9fa | 2210 | Lisp_Object descbuf, prefix, shadow; |
d7ab90a9 KH |
2211 | register Lisp_Object start1; |
2212 | struct gcpro gcpro1; | |
2c6f1a39 | 2213 | |
4726a9f1 JB |
2214 | char *alternate_heading |
2215 | = "\ | |
2216 | Alternate Characters (use anywhere the nominal character is listed):\n\ | |
2217 | nominal alternate\n\ | |
2218 | ------- ---------\n"; | |
2c6f1a39 | 2219 | |
53c8f9fa RS |
2220 | descbuf = XCONS (arg)->car; |
2221 | prefix = XCONS (arg)->cdr; | |
a588e041 | 2222 | shadow = Qnil; |
d7ab90a9 | 2223 | GCPRO1 (shadow); |
53c8f9fa | 2224 | |
2c6f1a39 JB |
2225 | Fset_buffer (Vstandard_output); |
2226 | ||
4726a9f1 | 2227 | /* Report on alternates for keys. */ |
d7bf9bf5 | 2228 | if (STRINGP (Vkeyboard_translate_table) && !NILP (prefix)) |
4726a9f1 JB |
2229 | { |
2230 | int c; | |
2231 | unsigned char *translate = XSTRING (Vkeyboard_translate_table)->data; | |
2232 | int translate_len = XSTRING (Vkeyboard_translate_table)->size; | |
2233 | ||
2234 | for (c = 0; c < translate_len; c++) | |
2235 | if (translate[c] != c) | |
2236 | { | |
2237 | char buf[20]; | |
2238 | char *bufend; | |
2239 | ||
2240 | if (alternate_heading) | |
2241 | { | |
2242 | insert_string (alternate_heading); | |
2243 | alternate_heading = 0; | |
2244 | } | |
2245 | ||
2246 | bufend = push_key_description (translate[c], buf); | |
2247 | insert (buf, bufend - buf); | |
2248 | Findent_to (make_number (16), make_number (1)); | |
2249 | bufend = push_key_description (c, buf); | |
2250 | insert (buf, bufend - buf); | |
2251 | ||
2252 | insert ("\n", 1); | |
2253 | } | |
2254 | ||
2255 | insert ("\n", 1); | |
2256 | } | |
2257 | ||
d7bf9bf5 RS |
2258 | if (!NILP (Vkey_translation_map)) |
2259 | describe_map_tree (Vkey_translation_map, 0, Qnil, prefix, | |
c2b714de | 2260 | "Key translations", 0, 1, 0); |
d7bf9bf5 | 2261 | |
cc0a8174 JB |
2262 | { |
2263 | int i, nmaps; | |
2264 | Lisp_Object *modes, *maps; | |
2265 | ||
4726a9f1 JB |
2266 | /* Temporarily switch to descbuf, so that we can get that buffer's |
2267 | minor modes correctly. */ | |
2268 | Fset_buffer (descbuf); | |
d7bf9bf5 | 2269 | |
e784236d KH |
2270 | if (!NILP (current_kboard->Voverriding_terminal_local_map) |
2271 | || !NILP (Voverriding_local_map)) | |
7d92e329 RS |
2272 | nmaps = 0; |
2273 | else | |
2274 | nmaps = current_minor_maps (&modes, &maps); | |
4726a9f1 JB |
2275 | Fset_buffer (Vstandard_output); |
2276 | ||
53c8f9fa | 2277 | /* Print the minor mode maps. */ |
cc0a8174 JB |
2278 | for (i = 0; i < nmaps; i++) |
2279 | { | |
c9b7c53a | 2280 | /* The title for a minor mode keymap |
07f15dfd RS |
2281 | is constructed at run time. |
2282 | We let describe_map_tree do the actual insertion | |
2283 | because it takes care of other features when doing so. */ | |
c9b7c53a | 2284 | char *title, *p; |
07f15dfd | 2285 | |
416349ec | 2286 | if (!SYMBOLP (modes[i])) |
d7ab90a9 KH |
2287 | abort(); |
2288 | ||
2289 | p = title = (char *) alloca (40 + XSYMBOL (modes[i])->name->size); | |
2290 | *p++ = '`'; | |
2291 | bcopy (XSYMBOL (modes[i])->name->data, p, | |
2292 | XSYMBOL (modes[i])->name->size); | |
2293 | p += XSYMBOL (modes[i])->name->size; | |
2294 | *p++ = '\''; | |
c9b7c53a KH |
2295 | bcopy (" Minor Mode Bindings", p, sizeof (" Minor Mode Bindings") - 1); |
2296 | p += sizeof (" Minor Mode Bindings") - 1; | |
07f15dfd RS |
2297 | *p = 0; |
2298 | ||
91f64ec2 | 2299 | describe_map_tree (maps[i], 1, shadow, prefix, title, 0, 0, 0); |
53c8f9fa | 2300 | shadow = Fcons (maps[i], shadow); |
cc0a8174 JB |
2301 | } |
2302 | } | |
2303 | ||
53c8f9fa | 2304 | /* Print the (major mode) local map. */ |
e784236d KH |
2305 | if (!NILP (current_kboard->Voverriding_terminal_local_map)) |
2306 | start1 = current_kboard->Voverriding_terminal_local_map; | |
2307 | else if (!NILP (Voverriding_local_map)) | |
7d92e329 RS |
2308 | start1 = Voverriding_local_map; |
2309 | else | |
2310 | start1 = XBUFFER (descbuf)->keymap; | |
2311 | ||
265a9e55 | 2312 | if (!NILP (start1)) |
2c6f1a39 | 2313 | { |
91f64ec2 | 2314 | describe_map_tree (start1, 1, shadow, prefix, |
c2b714de | 2315 | "Major Mode Bindings", 0, 0, 0); |
53c8f9fa | 2316 | shadow = Fcons (start1, shadow); |
2c6f1a39 JB |
2317 | } |
2318 | ||
91f64ec2 | 2319 | describe_map_tree (current_global_map, 1, shadow, prefix, |
c2b714de | 2320 | "Global Bindings", 0, 0, 1); |
d7bf9bf5 RS |
2321 | |
2322 | /* Print the function-key-map translations under this prefix. */ | |
2323 | if (!NILP (Vfunction_key_map)) | |
2324 | describe_map_tree (Vfunction_key_map, 0, Qnil, prefix, | |
c2b714de | 2325 | "Function key map translations", 0, 1, 0); |
2c6f1a39 | 2326 | |
04befa07 | 2327 | call0 (intern ("help-mode")); |
2c6f1a39 | 2328 | Fset_buffer (descbuf); |
d7ab90a9 | 2329 | UNGCPRO; |
2c6f1a39 JB |
2330 | return Qnil; |
2331 | } | |
2332 | ||
b31a4218 | 2333 | /* Insert a description of the key bindings in STARTMAP, |
2c6f1a39 JB |
2334 | followed by those of all maps reachable through STARTMAP. |
2335 | If PARTIAL is nonzero, omit certain "uninteresting" commands | |
2336 | (such as `undefined'). | |
53c8f9fa RS |
2337 | If SHADOW is non-nil, it is a list of maps; |
2338 | don't mention keys which would be shadowed by any of them. | |
2339 | PREFIX, if non-nil, says mention only keys that start with PREFIX. | |
07f15dfd | 2340 | TITLE, if not 0, is a string to insert at the beginning. |
af1d6f09 | 2341 | TITLE should not end with a colon or a newline; we supply that. |
d7bf9bf5 RS |
2342 | If NOMENU is not 0, then omit menu-bar commands. |
2343 | ||
2344 | If TRANSL is nonzero, the definitions are actually key translations | |
c2b714de RS |
2345 | so print strings and vectors differently. |
2346 | ||
2347 | If ALWAYS_TITLE is nonzero, print the title even if there are no maps | |
2348 | to look through. */ | |
2c6f1a39 JB |
2349 | |
2350 | void | |
c2b714de RS |
2351 | describe_map_tree (startmap, partial, shadow, prefix, title, nomenu, transl, |
2352 | always_title) | |
53c8f9fa | 2353 | Lisp_Object startmap, shadow, prefix; |
2c6f1a39 | 2354 | int partial; |
53c8f9fa | 2355 | char *title; |
af1d6f09 | 2356 | int nomenu; |
d7bf9bf5 | 2357 | int transl; |
c2b714de | 2358 | int always_title; |
2c6f1a39 | 2359 | { |
e3dfcd4e KH |
2360 | Lisp_Object maps, seen, sub_shadows; |
2361 | struct gcpro gcpro1, gcpro2, gcpro3; | |
07f15dfd | 2362 | int something = 0; |
53c8f9fa RS |
2363 | char *key_heading |
2364 | = "\ | |
2365 | key binding\n\ | |
2366 | --- -------\n"; | |
2c6f1a39 | 2367 | |
53c8f9fa | 2368 | maps = Faccessible_keymaps (startmap, prefix); |
925083d1 | 2369 | seen = Qnil; |
e3dfcd4e KH |
2370 | sub_shadows = Qnil; |
2371 | GCPRO3 (maps, seen, sub_shadows); | |
2c6f1a39 | 2372 | |
af1d6f09 RS |
2373 | if (nomenu) |
2374 | { | |
2375 | Lisp_Object list; | |
2376 | ||
2377 | /* Delete from MAPS each element that is for the menu bar. */ | |
2378 | for (list = maps; !NILP (list); list = XCONS (list)->cdr) | |
2379 | { | |
2380 | Lisp_Object elt, prefix, tem; | |
2381 | ||
2382 | elt = Fcar (list); | |
2383 | prefix = Fcar (elt); | |
2384 | if (XVECTOR (prefix)->size >= 1) | |
2385 | { | |
2386 | tem = Faref (prefix, make_number (0)); | |
2387 | if (EQ (tem, Qmenu_bar)) | |
2388 | maps = Fdelq (elt, maps); | |
2389 | } | |
2390 | } | |
2391 | } | |
2392 | ||
c2b714de | 2393 | if (!NILP (maps) || always_title) |
53c8f9fa RS |
2394 | { |
2395 | if (title) | |
07f15dfd RS |
2396 | { |
2397 | insert_string (title); | |
2398 | if (!NILP (prefix)) | |
2399 | { | |
2400 | insert_string (" Starting With "); | |
2401 | insert1 (Fkey_description (prefix)); | |
2402 | } | |
2403 | insert_string (":\n"); | |
2404 | } | |
53c8f9fa | 2405 | insert_string (key_heading); |
07f15dfd | 2406 | something = 1; |
53c8f9fa RS |
2407 | } |
2408 | ||
265a9e55 | 2409 | for (; !NILP (maps); maps = Fcdr (maps)) |
2c6f1a39 | 2410 | { |
e3dfcd4e | 2411 | register Lisp_Object elt, prefix, tail; |
53c8f9fa | 2412 | |
2c6f1a39 | 2413 | elt = Fcar (maps); |
53c8f9fa RS |
2414 | prefix = Fcar (elt); |
2415 | ||
2416 | sub_shadows = Qnil; | |
2417 | ||
2418 | for (tail = shadow; CONSP (tail); tail = XCONS (tail)->cdr) | |
2c6f1a39 | 2419 | { |
53c8f9fa RS |
2420 | Lisp_Object shmap; |
2421 | ||
2422 | shmap = XCONS (tail)->car; | |
2423 | ||
2424 | /* If the sequence by which we reach this keymap is zero-length, | |
2425 | then the shadow map for this keymap is just SHADOW. */ | |
416349ec KH |
2426 | if ((STRINGP (prefix) && XSTRING (prefix)->size == 0) |
2427 | || (VECTORP (prefix) && XVECTOR (prefix)->size == 0)) | |
53c8f9fa RS |
2428 | ; |
2429 | /* If the sequence by which we reach this keymap actually has | |
2430 | some elements, then the sequence's definition in SHADOW is | |
2431 | what we should use. */ | |
2432 | else | |
2433 | { | |
98234407 | 2434 | shmap = Flookup_key (shmap, Fcar (elt), Qt); |
416349ec | 2435 | if (INTEGERP (shmap)) |
53c8f9fa RS |
2436 | shmap = Qnil; |
2437 | } | |
2438 | ||
2439 | /* If shmap is not nil and not a keymap, | |
2440 | it completely shadows this map, so don't | |
2441 | describe this map at all. */ | |
2442 | if (!NILP (shmap) && NILP (Fkeymapp (shmap))) | |
2443 | goto skip; | |
2444 | ||
2445 | if (!NILP (shmap)) | |
2446 | sub_shadows = Fcons (shmap, sub_shadows); | |
2c6f1a39 JB |
2447 | } |
2448 | ||
d7bf9bf5 RS |
2449 | describe_map (Fcdr (elt), Fcar (elt), |
2450 | transl ? describe_translation : describe_command, | |
279a482a | 2451 | partial, sub_shadows, &seen, nomenu); |
53c8f9fa RS |
2452 | |
2453 | skip: ; | |
2c6f1a39 JB |
2454 | } |
2455 | ||
07f15dfd RS |
2456 | if (something) |
2457 | insert_string ("\n"); | |
2458 | ||
2c6f1a39 JB |
2459 | UNGCPRO; |
2460 | } | |
2461 | ||
c3f27064 KH |
2462 | static int previous_description_column; |
2463 | ||
2c6f1a39 JB |
2464 | static void |
2465 | describe_command (definition) | |
2466 | Lisp_Object definition; | |
2467 | { | |
2468 | register Lisp_Object tem1; | |
c3f27064 KH |
2469 | int column = current_column (); |
2470 | int description_column; | |
2c6f1a39 | 2471 | |
c3f27064 KH |
2472 | /* If column 16 is no good, go to col 32; |
2473 | but don't push beyond that--go to next line instead. */ | |
2474 | if (column > 30) | |
2475 | { | |
2476 | insert_char ('\n'); | |
2477 | description_column = 32; | |
2478 | } | |
2479 | else if (column > 14 || (column > 10 && previous_description_column == 32)) | |
2480 | description_column = 32; | |
2481 | else | |
2482 | description_column = 16; | |
2483 | ||
2484 | Findent_to (make_number (description_column), make_number (1)); | |
2485 | previous_description_column = description_column; | |
2c6f1a39 | 2486 | |
416349ec | 2487 | if (SYMBOLP (definition)) |
2c6f1a39 | 2488 | { |
bff4ec1f | 2489 | XSETSTRING (tem1, XSYMBOL (definition)->name); |
2c6f1a39 JB |
2490 | insert1 (tem1); |
2491 | insert_string ("\n"); | |
2492 | } | |
d7bf9bf5 | 2493 | else if (STRINGP (definition) || VECTORP (definition)) |
24065b9c | 2494 | insert_string ("Keyboard Macro\n"); |
2c6f1a39 JB |
2495 | else |
2496 | { | |
2497 | tem1 = Fkeymapp (definition); | |
265a9e55 | 2498 | if (!NILP (tem1)) |
2c6f1a39 JB |
2499 | insert_string ("Prefix Command\n"); |
2500 | else | |
2501 | insert_string ("??\n"); | |
2502 | } | |
2503 | } | |
2504 | ||
d7bf9bf5 RS |
2505 | static void |
2506 | describe_translation (definition) | |
2507 | Lisp_Object definition; | |
2508 | { | |
2509 | register Lisp_Object tem1; | |
2510 | ||
2511 | Findent_to (make_number (16), make_number (1)); | |
2512 | ||
2513 | if (SYMBOLP (definition)) | |
2514 | { | |
2515 | XSETSTRING (tem1, XSYMBOL (definition)->name); | |
2516 | insert1 (tem1); | |
2517 | insert_string ("\n"); | |
2518 | } | |
2519 | else if (STRINGP (definition) || VECTORP (definition)) | |
b902ac28 RS |
2520 | { |
2521 | insert1 (Fkey_description (definition)); | |
2522 | insert_string ("\n"); | |
2523 | } | |
d7bf9bf5 RS |
2524 | else |
2525 | { | |
2526 | tem1 = Fkeymapp (definition); | |
2527 | if (!NILP (tem1)) | |
2528 | insert_string ("Prefix Command\n"); | |
2529 | else | |
2530 | insert_string ("??\n"); | |
2531 | } | |
2532 | } | |
2533 | ||
53c8f9fa RS |
2534 | /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map. |
2535 | Returns the first non-nil binding found in any of those maps. */ | |
2536 | ||
2537 | static Lisp_Object | |
2538 | shadow_lookup (shadow, key, flag) | |
2539 | Lisp_Object shadow, key, flag; | |
2540 | { | |
2541 | Lisp_Object tail, value; | |
2542 | ||
2543 | for (tail = shadow; CONSP (tail); tail = XCONS (tail)->cdr) | |
2544 | { | |
2545 | value = Flookup_key (XCONS (tail)->car, key, flag); | |
2546 | if (!NILP (value)) | |
2547 | return value; | |
2548 | } | |
2549 | return Qnil; | |
2550 | } | |
2551 | ||
c3c0ee93 KH |
2552 | /* Describe the contents of map MAP, assuming that this map itself is |
2553 | reached by the sequence of prefix keys KEYS (a string or vector). | |
279a482a | 2554 | PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */ |
2c6f1a39 JB |
2555 | |
2556 | static void | |
279a482a | 2557 | describe_map (map, keys, elt_describer, partial, shadow, seen, nomenu) |
c3c0ee93 KH |
2558 | register Lisp_Object map; |
2559 | Lisp_Object keys; | |
6e068770 | 2560 | void (*elt_describer) P_ ((Lisp_Object)); |
2c6f1a39 JB |
2561 | int partial; |
2562 | Lisp_Object shadow; | |
925083d1 | 2563 | Lisp_Object *seen; |
279a482a | 2564 | int nomenu; |
2c6f1a39 | 2565 | { |
c3c0ee93 | 2566 | Lisp_Object elt_prefix; |
53c8f9fa | 2567 | Lisp_Object tail, definition, event; |
99a225a9 | 2568 | Lisp_Object tem; |
2c6f1a39 JB |
2569 | Lisp_Object suppress; |
2570 | Lisp_Object kludge; | |
2571 | int first = 1; | |
2572 | struct gcpro gcpro1, gcpro2, gcpro3; | |
2573 | ||
c3c0ee93 KH |
2574 | if (!NILP (keys) && XFASTINT (Flength (keys)) > 0) |
2575 | { | |
c3c0ee93 KH |
2576 | /* Call Fkey_description first, to avoid GC bug for the other string. */ |
2577 | tem = Fkey_description (keys); | |
2578 | elt_prefix = concat2 (tem, build_string (" ")); | |
2579 | } | |
2580 | else | |
2581 | elt_prefix = Qnil; | |
2582 | ||
2c6f1a39 JB |
2583 | if (partial) |
2584 | suppress = intern ("suppress-keymap"); | |
2585 | ||
2586 | /* This vector gets used to present single keys to Flookup_key. Since | |
f5b79c1c | 2587 | that is done once per keymap element, we don't want to cons up a |
2c6f1a39 JB |
2588 | fresh vector every time. */ |
2589 | kludge = Fmake_vector (make_number (1), Qnil); | |
99a225a9 | 2590 | definition = Qnil; |
2c6f1a39 | 2591 | |
99a225a9 | 2592 | GCPRO3 (elt_prefix, definition, kludge); |
2c6f1a39 | 2593 | |
925083d1 | 2594 | for (tail = map; CONSP (tail); tail = XCONS (tail)->cdr) |
2c6f1a39 JB |
2595 | { |
2596 | QUIT; | |
2c6f1a39 | 2597 | |
0403641f RS |
2598 | if (VECTORP (XCONS (tail)->car) |
2599 | || CHAR_TABLE_P (XCONS (tail)->car)) | |
53c8f9fa | 2600 | describe_vector (XCONS (tail)->car, |
0403641f RS |
2601 | elt_prefix, elt_describer, partial, shadow, map, |
2602 | (int *)0, 0); | |
925083d1 | 2603 | else if (CONSP (XCONS (tail)->car)) |
2c6f1a39 | 2604 | { |
925083d1 | 2605 | event = XCONS (XCONS (tail)->car)->car; |
2c3b35b0 RS |
2606 | |
2607 | /* Ignore bindings whose "keys" are not really valid events. | |
2608 | (We get these in the frames and buffers menu.) */ | |
2609 | if (! (SYMBOLP (event) || INTEGERP (event))) | |
c96dcc01 | 2610 | continue; |
2c3b35b0 | 2611 | |
279a482a KH |
2612 | if (nomenu && EQ (event, Qmenu_bar)) |
2613 | continue; | |
2614 | ||
925083d1 | 2615 | definition = get_keyelt (XCONS (XCONS (tail)->car)->cdr, 0); |
2c6f1a39 | 2616 | |
f5b79c1c | 2617 | /* Don't show undefined commands or suppressed commands. */ |
99a225a9 | 2618 | if (NILP (definition)) continue; |
416349ec | 2619 | if (SYMBOLP (definition) && partial) |
f5b79c1c | 2620 | { |
99a225a9 RS |
2621 | tem = Fget (definition, suppress); |
2622 | if (!NILP (tem)) | |
f5b79c1c JB |
2623 | continue; |
2624 | } | |
2c6f1a39 | 2625 | |
f5b79c1c JB |
2626 | /* Don't show a command that isn't really visible |
2627 | because a local definition of the same key shadows it. */ | |
2c6f1a39 | 2628 | |
99a225a9 | 2629 | XVECTOR (kludge)->contents[0] = event; |
f5b79c1c JB |
2630 | if (!NILP (shadow)) |
2631 | { | |
53c8f9fa | 2632 | tem = shadow_lookup (shadow, kludge, Qt); |
f5b79c1c JB |
2633 | if (!NILP (tem)) continue; |
2634 | } | |
2635 | ||
c3c0ee93 | 2636 | tem = Flookup_key (map, kludge, Qt); |
99a225a9 RS |
2637 | if (! EQ (tem, definition)) continue; |
2638 | ||
f5b79c1c JB |
2639 | if (first) |
2640 | { | |
c3f27064 | 2641 | previous_description_column = 0; |
f5b79c1c JB |
2642 | insert ("\n", 1); |
2643 | first = 0; | |
2644 | } | |
2c6f1a39 | 2645 | |
f5b79c1c JB |
2646 | if (!NILP (elt_prefix)) |
2647 | insert1 (elt_prefix); | |
2c6f1a39 | 2648 | |
99a225a9 RS |
2649 | /* THIS gets the string to describe the character EVENT. */ |
2650 | insert1 (Fsingle_key_description (event)); | |
2c6f1a39 | 2651 | |
f5b79c1c JB |
2652 | /* Print a description of the definition of this character. |
2653 | elt_describer will take care of spacing out far enough | |
2654 | for alignment purposes. */ | |
99a225a9 | 2655 | (*elt_describer) (definition); |
f5b79c1c | 2656 | } |
925083d1 KH |
2657 | else if (EQ (XCONS (tail)->car, Qkeymap)) |
2658 | { | |
2659 | /* The same keymap might be in the structure twice, if we're | |
2660 | using an inherited keymap. So skip anything we've already | |
2661 | encountered. */ | |
2662 | tem = Fassq (tail, *seen); | |
b5b90d18 | 2663 | if (CONSP (tem) && !NILP (Fequal (XCONS (tem)->car, keys))) |
925083d1 KH |
2664 | break; |
2665 | *seen = Fcons (Fcons (tail, keys), *seen); | |
2666 | } | |
2c6f1a39 JB |
2667 | } |
2668 | ||
2669 | UNGCPRO; | |
2670 | } | |
2671 | ||
69248761 | 2672 | static void |
2c6f1a39 JB |
2673 | describe_vector_princ (elt) |
2674 | Lisp_Object elt; | |
2675 | { | |
81fa9e2f | 2676 | Findent_to (make_number (16), make_number (1)); |
2c6f1a39 | 2677 | Fprinc (elt, Qnil); |
ad4ec84a | 2678 | Fterpri (Qnil); |
2c6f1a39 JB |
2679 | } |
2680 | ||
2681 | DEFUN ("describe-vector", Fdescribe_vector, Sdescribe_vector, 1, 1, 0, | |
ad4ec84a | 2682 | "Insert a description of contents of VECTOR.\n\ |
2c6f1a39 JB |
2683 | This is text showing the elements of vector matched against indices.") |
2684 | (vector) | |
2685 | Lisp_Object vector; | |
2686 | { | |
ad4ec84a RS |
2687 | int count = specpdl_ptr - specpdl; |
2688 | ||
2689 | specbind (Qstandard_output, Fcurrent_buffer ()); | |
352e5dea | 2690 | CHECK_VECTOR_OR_CHAR_TABLE (vector, 0); |
0403641f RS |
2691 | describe_vector (vector, Qnil, describe_vector_princ, 0, |
2692 | Qnil, Qnil, (int *)0, 0); | |
ad4ec84a RS |
2693 | |
2694 | return unbind_to (count, Qnil); | |
2c6f1a39 JB |
2695 | } |
2696 | ||
352e5dea RS |
2697 | /* Insert in the current buffer a description of the contents of VECTOR. |
2698 | We call ELT_DESCRIBER to insert the description of one value found | |
2699 | in VECTOR. | |
2700 | ||
2701 | ELT_PREFIX describes what "comes before" the keys or indices defined | |
0403641f RS |
2702 | by this vector. This is a human-readable string whose size |
2703 | is not necessarily related to the situation. | |
352e5dea RS |
2704 | |
2705 | If the vector is in a keymap, ELT_PREFIX is a prefix key which | |
2706 | leads to this keymap. | |
2707 | ||
2708 | If the vector is a chartable, ELT_PREFIX is the vector | |
2709 | of bytes that lead to the character set or portion of a character | |
2710 | set described by this chartable. | |
2711 | ||
2712 | If PARTIAL is nonzero, it means do not mention suppressed commands | |
2713 | (that assumes the vector is in a keymap). | |
2714 | ||
2715 | SHADOW is a list of keymaps that shadow this map. | |
2716 | If it is non-nil, then we look up the key in those maps | |
2717 | and we don't mention it now if it is defined by any of them. | |
2718 | ||
2719 | ENTIRE_MAP is the keymap in which this vector appears. | |
2720 | If the definition in effect in the whole map does not match | |
0403641f RS |
2721 | the one in this vector, we ignore this one. |
2722 | ||
2723 | When describing a sub-char-table, INDICES is a list of | |
2724 | indices at higher levels in this char-table, | |
2725 | and CHAR_TABLE_DEPTH says how many levels down we have gone. */ | |
352e5dea | 2726 | |
71a956a6 | 2727 | void |
32bfcae1 | 2728 | describe_vector (vector, elt_prefix, elt_describer, |
0403641f RS |
2729 | partial, shadow, entire_map, |
2730 | indices, char_table_depth) | |
2c6f1a39 JB |
2731 | register Lisp_Object vector; |
2732 | Lisp_Object elt_prefix; | |
69248761 | 2733 | void (*elt_describer) P_ ((Lisp_Object)); |
2c6f1a39 JB |
2734 | int partial; |
2735 | Lisp_Object shadow; | |
32bfcae1 | 2736 | Lisp_Object entire_map; |
0403641f RS |
2737 | int *indices; |
2738 | int char_table_depth; | |
2c6f1a39 | 2739 | { |
32bfcae1 KH |
2740 | Lisp_Object definition; |
2741 | Lisp_Object tem2; | |
2c6f1a39 JB |
2742 | register int i; |
2743 | Lisp_Object suppress; | |
2744 | Lisp_Object kludge; | |
2745 | int first = 1; | |
352e5dea | 2746 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; |
a98f1d1d KH |
2747 | /* Range of elements to be handled. */ |
2748 | int from, to; | |
a20aa721 KH |
2749 | /* Flag to tell if we should handle multibyte characters. */ |
2750 | int multibyte = !NILP (current_buffer->enable_multibyte_characters); | |
a98f1d1d KH |
2751 | /* A flag to tell if a leaf in this level of char-table is not a |
2752 | generic character (i.e. a complete multibyte character). */ | |
2753 | int complete_char; | |
0403641f RS |
2754 | int character; |
2755 | int starting_i; | |
2756 | ||
2757 | if (indices == 0) | |
2e34157c | 2758 | indices = (int *) alloca (3 * sizeof (int)); |
2c6f1a39 | 2759 | |
32bfcae1 | 2760 | definition = Qnil; |
2c6f1a39 JB |
2761 | |
2762 | /* This vector gets used to present single keys to Flookup_key. Since | |
2763 | that is done once per vector element, we don't want to cons up a | |
2764 | fresh vector every time. */ | |
2765 | kludge = Fmake_vector (make_number (1), Qnil); | |
0403641f | 2766 | GCPRO3 (elt_prefix, definition, kludge); |
2c6f1a39 JB |
2767 | |
2768 | if (partial) | |
2769 | suppress = intern ("suppress-keymap"); | |
2770 | ||
a98f1d1d KH |
2771 | if (CHAR_TABLE_P (vector)) |
2772 | { | |
0403641f | 2773 | if (char_table_depth == 0) |
a98f1d1d | 2774 | { |
a1942d88 | 2775 | /* VECTOR is a top level char-table. */ |
0403641f | 2776 | complete_char = 1; |
a98f1d1d KH |
2777 | from = 0; |
2778 | to = CHAR_TABLE_ORDINARY_SLOTS; | |
2779 | } | |
2780 | else | |
2781 | { | |
a1942d88 | 2782 | /* VECTOR is a sub char-table. */ |
0403641f RS |
2783 | if (char_table_depth >= 3) |
2784 | /* A char-table is never that deep. */ | |
a1942d88 | 2785 | error ("Too deep char table"); |
a98f1d1d | 2786 | |
a98f1d1d | 2787 | complete_char |
0403641f RS |
2788 | = (CHARSET_VALID_P (indices[0]) |
2789 | && ((CHARSET_DIMENSION (indices[0]) == 1 | |
2790 | && char_table_depth == 1) | |
2791 | || char_table_depth == 2)); | |
a98f1d1d KH |
2792 | |
2793 | /* Meaningful elements are from 32th to 127th. */ | |
2794 | from = 32; | |
a1942d88 | 2795 | to = SUB_CHAR_TABLE_ORDINARY_SLOTS; |
a98f1d1d | 2796 | } |
a98f1d1d KH |
2797 | } |
2798 | else | |
2799 | { | |
a98f1d1d | 2800 | /* This does the right thing for ordinary vectors. */ |
0403641f RS |
2801 | |
2802 | complete_char = 1; | |
2803 | from = 0; | |
2804 | to = XVECTOR (vector)->size; | |
a98f1d1d | 2805 | } |
b5585f5c | 2806 | |
a98f1d1d | 2807 | for (i = from; i < to; i++) |
2c6f1a39 JB |
2808 | { |
2809 | QUIT; | |
2c6f1a39 | 2810 | |
a1942d88 KH |
2811 | if (CHAR_TABLE_P (vector)) |
2812 | { | |
0403641f RS |
2813 | if (char_table_depth == 0 && i >= CHAR_TABLE_SINGLE_BYTE_SLOTS) |
2814 | complete_char = 0; | |
2815 | ||
a1942d88 KH |
2816 | if (i >= CHAR_TABLE_SINGLE_BYTE_SLOTS |
2817 | && !CHARSET_DEFINED_P (i - 128)) | |
2818 | continue; | |
0403641f RS |
2819 | |
2820 | definition | |
2821 | = get_keyelt (XCHAR_TABLE (vector)->contents[i], 0); | |
a1942d88 KH |
2822 | } |
2823 | else | |
2824 | definition = get_keyelt (XVECTOR (vector)->contents[i], 0); | |
2c6f1a39 | 2825 | |
cc3e6465 RS |
2826 | if (NILP (definition)) continue; |
2827 | ||
2c6f1a39 | 2828 | /* Don't mention suppressed commands. */ |
32bfcae1 | 2829 | if (SYMBOLP (definition) && partial) |
2c6f1a39 | 2830 | { |
a98f1d1d KH |
2831 | Lisp_Object tem; |
2832 | ||
2833 | tem = Fget (definition, suppress); | |
2834 | ||
2835 | if (!NILP (tem)) continue; | |
2c6f1a39 JB |
2836 | } |
2837 | ||
0403641f RS |
2838 | /* Set CHARACTER to the character this entry describes, if any. |
2839 | Also update *INDICES. */ | |
2840 | if (CHAR_TABLE_P (vector)) | |
2841 | { | |
2842 | indices[char_table_depth] = i; | |
2843 | ||
2844 | if (char_table_depth == 0) | |
2845 | { | |
2846 | character = i; | |
2847 | indices[0] = i - 128; | |
2848 | } | |
2849 | else if (complete_char) | |
2850 | { | |
2851 | character | |
2852 | = MAKE_NON_ASCII_CHAR (indices[0], indices[1], indices[2]); | |
2853 | } | |
2854 | else | |
2855 | character = 0; | |
2856 | } | |
2857 | else | |
2858 | character = i; | |
2859 | ||
32bfcae1 | 2860 | /* If this binding is shadowed by some other map, ignore it. */ |
0403641f | 2861 | if (!NILP (shadow) && complete_char) |
2c6f1a39 JB |
2862 | { |
2863 | Lisp_Object tem; | |
2864 | ||
0403641f | 2865 | XVECTOR (kludge)->contents[0] = make_number (character); |
53c8f9fa | 2866 | tem = shadow_lookup (shadow, kludge, Qt); |
2c6f1a39 | 2867 | |
265a9e55 | 2868 | if (!NILP (tem)) continue; |
2c6f1a39 JB |
2869 | } |
2870 | ||
32bfcae1 KH |
2871 | /* Ignore this definition if it is shadowed by an earlier |
2872 | one in the same keymap. */ | |
0403641f | 2873 | if (!NILP (entire_map) && complete_char) |
32bfcae1 KH |
2874 | { |
2875 | Lisp_Object tem; | |
2876 | ||
0403641f | 2877 | XVECTOR (kludge)->contents[0] = make_number (character); |
32bfcae1 KH |
2878 | tem = Flookup_key (entire_map, kludge, Qt); |
2879 | ||
2880 | if (! EQ (tem, definition)) | |
2881 | continue; | |
2882 | } | |
2883 | ||
2c6f1a39 JB |
2884 | if (first) |
2885 | { | |
0403641f | 2886 | if (char_table_depth == 0) |
a98f1d1d | 2887 | insert ("\n", 1); |
2c6f1a39 JB |
2888 | first = 0; |
2889 | } | |
2890 | ||
0403641f RS |
2891 | /* For a sub char-table, show the depth by indentation. |
2892 | CHAR_TABLE_DEPTH can be greater than 0 only for a char-table. */ | |
2893 | if (char_table_depth > 0) | |
2894 | insert (" ", char_table_depth * 2); /* depth is 1 or 2. */ | |
a98f1d1d | 2895 | |
0403641f RS |
2896 | /* Output the prefix that applies to every entry in this map. */ |
2897 | if (!NILP (elt_prefix)) | |
2898 | insert1 (elt_prefix); | |
a98f1d1d | 2899 | |
0403641f RS |
2900 | /* Insert or describe the character this slot is for, |
2901 | or a description of what it is for. */ | |
2902 | if (SUB_CHAR_TABLE_P (vector)) | |
a1942d88 | 2903 | { |
0403641f RS |
2904 | if (complete_char) |
2905 | insert_char (character); | |
2906 | else | |
2907 | { | |
2908 | /* We need an octal representation for this block of | |
2909 | characters. */ | |
542d7fd2 RS |
2910 | char work[16]; |
2911 | sprintf (work, "(row %d)", i); | |
2912 | insert (work, strlen (work)); | |
0403641f RS |
2913 | } |
2914 | } | |
2915 | else if (CHAR_TABLE_P (vector)) | |
2916 | { | |
2917 | if (complete_char) | |
2918 | insert1 (Fsingle_key_description (make_number (character))); | |
a1942d88 KH |
2919 | else |
2920 | { | |
2921 | /* Print the information for this character set. */ | |
2922 | insert_string ("<"); | |
2923 | tem2 = CHARSET_TABLE_INFO (i - 128, CHARSET_SHORT_NAME_IDX); | |
2924 | if (STRINGP (tem2)) | |
2925 | insert_from_string (tem2, 0 , XSTRING (tem2)->size, 0); | |
2926 | else | |
2927 | insert ("?", 1); | |
2928 | insert (">", 1); | |
2929 | } | |
2930 | } | |
352e5dea RS |
2931 | else |
2932 | { | |
0403641f | 2933 | insert1 (Fsingle_key_description (make_number (character))); |
a98f1d1d | 2934 | } |
352e5dea | 2935 | |
a1942d88 | 2936 | /* If we find a sub char-table within a char-table, |
a98f1d1d KH |
2937 | scan it recursively; it defines the details for |
2938 | a character set or a portion of a character set. */ | |
a1942d88 | 2939 | if (multibyte && CHAR_TABLE_P (vector) && SUB_CHAR_TABLE_P (definition)) |
a98f1d1d | 2940 | { |
a98f1d1d | 2941 | insert ("\n", 1); |
0403641f RS |
2942 | describe_vector (definition, elt_prefix, elt_describer, |
2943 | partial, shadow, entire_map, | |
2944 | indices, char_table_depth + 1); | |
a98f1d1d | 2945 | continue; |
352e5dea | 2946 | } |
2c6f1a39 | 2947 | |
0403641f RS |
2948 | starting_i = i; |
2949 | ||
542d7fd2 | 2950 | /* Find all consecutive characters or rows that have the same |
a1942d88 KH |
2951 | definition. But, for elements of a top level char table, if |
2952 | they are for charsets, we had better describe one by one even | |
2953 | if they have the same definition. */ | |
2954 | if (CHAR_TABLE_P (vector)) | |
2955 | { | |
0403641f RS |
2956 | int limit = to; |
2957 | ||
2958 | if (char_table_depth == 0) | |
2959 | limit = CHAR_TABLE_SINGLE_BYTE_SLOTS; | |
2960 | ||
2961 | while (i + 1 < limit | |
2962 | && (tem2 = get_keyelt (XCHAR_TABLE (vector)->contents[i + 1], 0), | |
2963 | !NILP (tem2)) | |
2964 | && !NILP (Fequal (tem2, definition))) | |
2965 | i++; | |
a1942d88 KH |
2966 | } |
2967 | else | |
0403641f | 2968 | while (i + 1 < to |
a1942d88 KH |
2969 | && (tem2 = get_keyelt (XVECTOR (vector)->contents[i + 1], 0), |
2970 | !NILP (tem2)) | |
2971 | && !NILP (Fequal (tem2, definition))) | |
2972 | i++; | |
2973 | ||
2c6f1a39 JB |
2974 | |
2975 | /* If we have a range of more than one character, | |
2976 | print where the range reaches to. */ | |
2977 | ||
0403641f | 2978 | if (i != starting_i) |
2c6f1a39 JB |
2979 | { |
2980 | insert (" .. ", 4); | |
0403641f RS |
2981 | |
2982 | if (!NILP (elt_prefix)) | |
2983 | insert1 (elt_prefix); | |
2984 | ||
352e5dea RS |
2985 | if (CHAR_TABLE_P (vector)) |
2986 | { | |
0403641f | 2987 | if (char_table_depth == 0) |
a98f1d1d | 2988 | { |
0403641f | 2989 | insert1 (Fsingle_key_description (make_number (i))); |
a98f1d1d | 2990 | } |
0403641f | 2991 | else if (complete_char) |
352e5dea | 2992 | { |
0403641f RS |
2993 | indices[char_table_depth] = i; |
2994 | character | |
2995 | = MAKE_NON_ASCII_CHAR (indices[0], indices[1], indices[2]); | |
2996 | insert_char (character); | |
352e5dea RS |
2997 | } |
2998 | else | |
2999 | { | |
542d7fd2 RS |
3000 | /* We need an octal representation for this block of |
3001 | characters. */ | |
3002 | char work[16]; | |
3003 | sprintf (work, "(row %d)", i); | |
3004 | insert (work, strlen (work)); | |
352e5dea RS |
3005 | } |
3006 | } | |
3007 | else | |
3008 | { | |
0403641f | 3009 | insert1 (Fsingle_key_description (make_number (i))); |
352e5dea | 3010 | } |
2c6f1a39 JB |
3011 | } |
3012 | ||
3013 | /* Print a description of the definition of this character. | |
3014 | elt_describer will take care of spacing out far enough | |
3015 | for alignment purposes. */ | |
32bfcae1 | 3016 | (*elt_describer) (definition); |
2c6f1a39 JB |
3017 | } |
3018 | ||
a1942d88 | 3019 | /* For (sub) char-table, print `defalt' slot at last. */ |
a98f1d1d KH |
3020 | if (CHAR_TABLE_P (vector) && !NILP (XCHAR_TABLE (vector)->defalt)) |
3021 | { | |
0403641f | 3022 | insert (" ", char_table_depth * 2); |
a98f1d1d KH |
3023 | insert_string ("<<default>>"); |
3024 | (*elt_describer) (XCHAR_TABLE (vector)->defalt); | |
3025 | } | |
3026 | ||
2c6f1a39 JB |
3027 | UNGCPRO; |
3028 | } | |
3029 | \f | |
cc0a8174 | 3030 | /* Apropos - finding all symbols whose names match a regexp. */ |
2c6f1a39 JB |
3031 | Lisp_Object apropos_predicate; |
3032 | Lisp_Object apropos_accumulate; | |
3033 | ||
3034 | static void | |
3035 | apropos_accum (symbol, string) | |
3036 | Lisp_Object symbol, string; | |
3037 | { | |
3038 | register Lisp_Object tem; | |
3039 | ||
3040 | tem = Fstring_match (string, Fsymbol_name (symbol), Qnil); | |
265a9e55 | 3041 | if (!NILP (tem) && !NILP (apropos_predicate)) |
2c6f1a39 | 3042 | tem = call1 (apropos_predicate, symbol); |
265a9e55 | 3043 | if (!NILP (tem)) |
2c6f1a39 JB |
3044 | apropos_accumulate = Fcons (symbol, apropos_accumulate); |
3045 | } | |
3046 | ||
3047 | DEFUN ("apropos-internal", Fapropos_internal, Sapropos_internal, 1, 2, 0, | |
3048 | "Show all symbols whose names contain match for REGEXP.\n\ | |
88539837 | 3049 | If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done\n\ |
2c6f1a39 JB |
3050 | for each symbol and a symbol is mentioned only if that returns non-nil.\n\ |
3051 | Return list of symbols found.") | |
88539837 EN |
3052 | (regexp, predicate) |
3053 | Lisp_Object regexp, predicate; | |
2c6f1a39 JB |
3054 | { |
3055 | struct gcpro gcpro1, gcpro2; | |
9cd8b13a | 3056 | CHECK_STRING (regexp, 0); |
88539837 | 3057 | apropos_predicate = predicate; |
2c6f1a39 JB |
3058 | GCPRO2 (apropos_predicate, apropos_accumulate); |
3059 | apropos_accumulate = Qnil; | |
88539837 | 3060 | map_obarray (Vobarray, apropos_accum, regexp); |
2c6f1a39 JB |
3061 | apropos_accumulate = Fsort (apropos_accumulate, Qstring_lessp); |
3062 | UNGCPRO; | |
3063 | return apropos_accumulate; | |
3064 | } | |
3065 | \f | |
3066 | syms_of_keymap () | |
3067 | { | |
3068 | Lisp_Object tem; | |
3069 | ||
3070 | Qkeymap = intern ("keymap"); | |
3071 | staticpro (&Qkeymap); | |
3072 | ||
0403641f RS |
3073 | /* Now we are ready to set up this property, so we can |
3074 | create char tables. */ | |
3075 | Fput (Qkeymap, Qchar_table_extra_slots, make_number (0)); | |
3076 | ||
3077 | /* Initialize the keymaps standardly used. | |
3078 | Each one is the value of a Lisp variable, and is also | |
3079 | pointed to by a C variable */ | |
2c6f1a39 | 3080 | |
0403641f | 3081 | global_map = Fmake_keymap (Qnil); |
2c6f1a39 JB |
3082 | Fset (intern ("global-map"), global_map); |
3083 | ||
44bff953 | 3084 | current_global_map = global_map; |
a3e99933 | 3085 | staticpro (&global_map); |
44bff953 RS |
3086 | staticpro (¤t_global_map); |
3087 | ||
ce6e5d0b | 3088 | meta_map = Fmake_keymap (Qnil); |
2c6f1a39 JB |
3089 | Fset (intern ("esc-map"), meta_map); |
3090 | Ffset (intern ("ESC-prefix"), meta_map); | |
3091 | ||
ce6e5d0b | 3092 | control_x_map = Fmake_keymap (Qnil); |
2c6f1a39 JB |
3093 | Fset (intern ("ctl-x-map"), control_x_map); |
3094 | Ffset (intern ("Control-X-prefix"), control_x_map); | |
3095 | ||
107fd03d RS |
3096 | DEFVAR_LISP ("define-key-rebound-commands", &Vdefine_key_rebound_commands, |
3097 | "List of commands given new key bindings recently.\n\ | |
3098 | This is used for internal purposes during Emacs startup;\n\ | |
3099 | don't alter it yourself."); | |
3100 | Vdefine_key_rebound_commands = Qt; | |
3101 | ||
2c6f1a39 JB |
3102 | DEFVAR_LISP ("minibuffer-local-map", &Vminibuffer_local_map, |
3103 | "Default keymap to use when reading from the minibuffer."); | |
ce6e5d0b | 3104 | Vminibuffer_local_map = Fmake_sparse_keymap (Qnil); |
2c6f1a39 JB |
3105 | |
3106 | DEFVAR_LISP ("minibuffer-local-ns-map", &Vminibuffer_local_ns_map, | |
3107 | "Local keymap for the minibuffer when spaces are not allowed."); | |
ce6e5d0b | 3108 | Vminibuffer_local_ns_map = Fmake_sparse_keymap (Qnil); |
2c6f1a39 JB |
3109 | |
3110 | DEFVAR_LISP ("minibuffer-local-completion-map", &Vminibuffer_local_completion_map, | |
3111 | "Local keymap for minibuffer input with completion."); | |
ce6e5d0b | 3112 | Vminibuffer_local_completion_map = Fmake_sparse_keymap (Qnil); |
2c6f1a39 JB |
3113 | |
3114 | DEFVAR_LISP ("minibuffer-local-must-match-map", &Vminibuffer_local_must_match_map, | |
3115 | "Local keymap for minibuffer input with completion, for exact match."); | |
ce6e5d0b | 3116 | Vminibuffer_local_must_match_map = Fmake_sparse_keymap (Qnil); |
2c6f1a39 | 3117 | |
cc0a8174 JB |
3118 | DEFVAR_LISP ("minor-mode-map-alist", &Vminor_mode_map_alist, |
3119 | "Alist of keymaps to use for minor modes.\n\ | |
3120 | Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read\n\ | |
3121 | key sequences and look up bindings iff VARIABLE's value is non-nil.\n\ | |
3122 | If two active keymaps bind the same key, the keymap appearing earlier\n\ | |
3123 | in the list takes precedence."); | |
3124 | Vminor_mode_map_alist = Qnil; | |
3125 | ||
dd9cda06 RS |
3126 | DEFVAR_LISP ("minor-mode-overriding-map-alist", &Vminor_mode_overriding_map_alist, |
3127 | "Alist of keymaps to use for minor modes, in current major mode.\n\ | |
3128 | This variable is a alist just like `minor-mode-map-alist', and it is\n\ | |
3129 | used the same way (and before `minor-mode-map-alist'); however,\n\ | |
3130 | it is provided for major modes to bind locally."); | |
3131 | Vminor_mode_overriding_map_alist = Qnil; | |
3132 | ||
6bbbd9b0 JB |
3133 | DEFVAR_LISP ("function-key-map", &Vfunction_key_map, |
3134 | "Keymap mapping ASCII function key sequences onto their preferred forms.\n\ | |
3135 | This allows Emacs to recognize function keys sent from ASCII\n\ | |
3136 | terminals at any point in a key sequence.\n\ | |
3137 | \n\ | |
1981e886 RS |
3138 | The `read-key-sequence' function replaces any subsequence bound by\n\ |
3139 | `function-key-map' with its binding. More precisely, when the active\n\ | |
6bbbd9b0 | 3140 | keymaps have no binding for the current key sequence but\n\ |
1981e886 RS |
3141 | `function-key-map' binds a suffix of the sequence to a vector or string,\n\ |
3142 | `read-key-sequence' replaces the matching suffix with its binding, and\n\ | |
6bbbd9b0 JB |
3143 | continues with the new sequence.\n\ |
3144 | \n\ | |
1981e886 RS |
3145 | The events that come from bindings in `function-key-map' are not\n\ |
3146 | themselves looked up in `function-key-map'.\n\ | |
3147 | \n\ | |
3148 | For example, suppose `function-key-map' binds `ESC O P' to [f1].\n\ | |
3149 | Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing\n\ | |
718ca51e JB |
3150 | `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix\n\ |
3151 | key, typing `ESC O P x' would return [f1 x]."); | |
ce6e5d0b | 3152 | Vfunction_key_map = Fmake_sparse_keymap (Qnil); |
6bbbd9b0 | 3153 | |
d7bf9bf5 RS |
3154 | DEFVAR_LISP ("key-translation-map", &Vkey_translation_map, |
3155 | "Keymap of key translations that can override keymaps.\n\ | |
3156 | This keymap works like `function-key-map', but comes after that,\n\ | |
3157 | and applies even for keys that have ordinary bindings."); | |
3158 | Vkey_translation_map = Qnil; | |
3159 | ||
2c6f1a39 JB |
3160 | Qsingle_key_description = intern ("single-key-description"); |
3161 | staticpro (&Qsingle_key_description); | |
3162 | ||
3163 | Qkey_description = intern ("key-description"); | |
3164 | staticpro (&Qkey_description); | |
3165 | ||
3166 | Qkeymapp = intern ("keymapp"); | |
3167 | staticpro (&Qkeymapp); | |
3168 | ||
2fc66973 JB |
3169 | Qnon_ascii = intern ("non-ascii"); |
3170 | staticpro (&Qnon_ascii); | |
3171 | ||
2c6f1a39 | 3172 | defsubr (&Skeymapp); |
7d58ed99 RS |
3173 | defsubr (&Skeymap_parent); |
3174 | defsubr (&Sset_keymap_parent); | |
2c6f1a39 JB |
3175 | defsubr (&Smake_keymap); |
3176 | defsubr (&Smake_sparse_keymap); | |
3177 | defsubr (&Scopy_keymap); | |
3178 | defsubr (&Skey_binding); | |
3179 | defsubr (&Slocal_key_binding); | |
3180 | defsubr (&Sglobal_key_binding); | |
cc0a8174 | 3181 | defsubr (&Sminor_mode_key_binding); |
2c6f1a39 JB |
3182 | defsubr (&Sdefine_key); |
3183 | defsubr (&Slookup_key); | |
2c6f1a39 JB |
3184 | defsubr (&Sdefine_prefix_command); |
3185 | defsubr (&Suse_global_map); | |
3186 | defsubr (&Suse_local_map); | |
3187 | defsubr (&Scurrent_local_map); | |
3188 | defsubr (&Scurrent_global_map); | |
cc0a8174 | 3189 | defsubr (&Scurrent_minor_mode_maps); |
2c6f1a39 JB |
3190 | defsubr (&Saccessible_keymaps); |
3191 | defsubr (&Skey_description); | |
3192 | defsubr (&Sdescribe_vector); | |
3193 | defsubr (&Ssingle_key_description); | |
3194 | defsubr (&Stext_char_description); | |
3195 | defsubr (&Swhere_is_internal); | |
2c6f1a39 JB |
3196 | defsubr (&Sdescribe_bindings); |
3197 | defsubr (&Sapropos_internal); | |
3198 | } | |
3199 | ||
3200 | keys_of_keymap () | |
3201 | { | |
3202 | Lisp_Object tem; | |
3203 | ||
3204 | initial_define_key (global_map, 033, "ESC-prefix"); | |
3205 | initial_define_key (global_map, Ctl('X'), "Control-X-prefix"); | |
3206 | } |