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