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