0
|
1 /* Manipulation of keymaps
|
|
2 Copyright (C) 1985, 1991-1995 Free Software Foundation, Inc.
|
|
3 Copyright (C) 1995 Board of Trustees, University of Illinois.
|
|
4 Copyright (C) 1995 Sun Microsystems, Inc.
|
|
5 Totally redesigned by jwz in 1991.
|
|
6
|
|
7 This file is part of XEmacs.
|
|
8
|
|
9 XEmacs is free software; you can redistribute it and/or modify it
|
|
10 under the terms of the GNU General Public License as published by the
|
|
11 Free Software Foundation; either version 2, or (at your option) any
|
|
12 later version.
|
|
13
|
|
14 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
17 for more details.
|
|
18
|
|
19 You should have received a copy of the GNU General Public License
|
|
20 along with XEmacs; see the file COPYING. If not, write to
|
|
21 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
22 Boston, MA 02111-1307, USA. */
|
|
23
|
70
|
24 /* Synched up with: Mule 2.0. Not synched with FSF. Substantially
|
|
25 different from FSF. */
|
|
26
|
0
|
27
|
|
28 #include <config.h>
|
|
29 #include "lisp.h"
|
|
30
|
|
31 #include "buffer.h"
|
|
32 #include "bytecode.h"
|
|
33 #include "console.h"
|
|
34 #include "elhash.h"
|
|
35 #include "events.h"
|
|
36 #include "frame.h"
|
|
37 #include "insdel.h"
|
|
38 #include "keymap.h"
|
|
39 #include "window.h"
|
412
|
40
|
|
41 #ifdef WINDOWSNT
|
|
42 /* Hmm, under unix we want X modifiers, under NT we want X modifiers if
|
|
43 we are running X and Windows modifiers otherwise.
|
|
44 gak. This is a kludge until we support multiple native GUIs!
|
|
45 */
|
|
46 #undef MOD_ALT
|
|
47 #undef MOD_CONTROL
|
|
48 #undef MOD_SHIFT
|
|
49 #endif
|
|
50
|
157
|
51 #include "events-mod.h"
|
100
|
52
|
0
|
53
|
245
|
54 /* A keymap contains six slots:
|
0
|
55
|
|
56 parents Ordered list of keymaps to search after
|
|
57 this one if no match is found.
|
|
58 Keymaps can thus be arranged in a hierarchy.
|
|
59
|
|
60 table A hash table, hashing keysyms to their bindings.
|
70
|
61 It will be one of the following:
|
|
62
|
|
63 -- a symbol, e.g. 'home
|
|
64 -- a character, representing something printable
|
|
65 (not ?\C-c meaning C-c, for instance)
|
|
66 -- an integer representing a modifier combination
|
0
|
67
|
|
68 inverse_table A hash table, hashing bindings to the list of keysyms
|
|
69 in this keymap which are bound to them. This is to make
|
|
70 the Fwhere_is_internal() function be fast. It needs to be
|
|
71 fast because we want to be able to call it in realtime to
|
|
72 update the keyboard-equivalents on the pulldown menus.
|
|
73 Values of the table are either atoms (keysyms)
|
|
74 or a dotted list of keysyms.
|
|
75
|
|
76 sub_maps_cache An alist; for each entry in this keymap whose binding is
|
|
77 a keymap (that is, Fkeymapp()) this alist associates that
|
|
78 keysym with that binding. This is used to optimize both
|
|
79 Fwhere_is_internal() and Faccessible_keymaps(). This slot
|
|
80 gets set to the symbol `t' every time a change is made to
|
|
81 this keymap, causing it to be recomputed when next needed.
|
|
82
|
|
83 prompt See `set-keymap-prompt'.
|
|
84
|
|
85 default_binding See `set-keymap-default-binding'.
|
|
86
|
|
87 Sequences of keys are stored in the obvious way: if the sequence of keys
|
|
88 "abc" was bound to some command `foo', the hierarchy would look like
|
|
89
|
|
90 keymap-1: associates "a" with keymap-2
|
|
91 keymap-2: associates "b" with keymap-3
|
|
92 keymap-3: associates "c" with foo
|
|
93
|
|
94 However, bucky bits ("modifiers" to the X-minded) are represented in the
|
|
95 keymap hierarchy as well. (This lets us use EQable objects as hash keys.)
|
|
96 Each combination of modifiers (e.g. control-hyper) gets its own submap
|
|
97 off of the main map. The hash key for a modifier combination is
|
70
|
98 an integer, computed by MAKE_MODIFIER_HASH_KEY().
|
185
|
99
|
0
|
100 If the key `C-a' was bound to some command, the hierarchy would look like
|
|
101
|
412
|
102 keymap-1: associates the integer MOD_CONTROL with keymap-2
|
0
|
103 keymap-2: associates "a" with the command
|
|
104
|
|
105 Similarly, if the key `C-H-a' was bound to some command, the hierarchy
|
|
106 would look like
|
|
107
|
412
|
108 keymap-1: associates the integer (MOD_CONTROL | MOD_HYPER)
|
0
|
109 with keymap-2
|
|
110 keymap-2: associates "a" with the command
|
|
111
|
|
112 Note that a special exception is made for the meta modifier, in order
|
|
113 to deal with ESC/meta lossage. Any key combination containing the
|
|
114 meta modifier is first indexed off of the main map into the meta
|
412
|
115 submap (with hash key MOD_META) and then indexed off of the
|
0
|
116 meta submap with the meta modifier removed from the key combination.
|
|
117 For example, when associating a command with C-M-H-a, we'd have
|
|
118
|
412
|
119 keymap-1: associates the integer MOD_META with keymap-2
|
|
120 keymap-2: associates the integer (MOD_CONTROL | MOD_HYPER)
|
0
|
121 with keymap-3
|
|
122 keymap-3: associates "a" with the command
|
|
123
|
|
124 Note that keymap-2 might have normal bindings in it; these would be
|
|
125 for key combinations containing only the meta modifier, such as
|
|
126 M-y or meta-backspace.
|
|
127
|
|
128 If the command that "a" was bound to in keymap-3 was itself a keymap,
|
|
129 then that would make the key "C-M-H-a" be a prefix character.
|
|
130
|
|
131 Note that this new model of keymaps takes much of the magic away from
|
|
132 the Escape key: the value of the variable `esc-map' is no longer indexed
|
|
133 in the `global-map' under the ESC key. It's indexed under the integer
|
412
|
134 MOD_META. This is not user-visible, however; none of the "bucky"
|
0
|
135 maps are.
|
|
136
|
|
137 There is a hack in Flookup_key() that makes (lookup-key global-map "\^[")
|
|
138 and (define-key some-random-map "\^[" my-esc-map) work as before, for
|
|
139 compatibility.
|
|
140
|
|
141 Since keymaps are opaque, the only way to extract information from them
|
|
142 is with the functions lookup-key, key-binding, local-key-binding, and
|
|
143 global-key-binding, which work just as before, and the new function
|
412
|
144 map-keymap, which is roughly analagous to maphash.
|
0
|
145
|
|
146 Note that map-keymap perpetuates the illusion that the "bucky" submaps
|
|
147 don't exist: if you map over a keymap with bucky submaps, it will also
|
|
148 map over those submaps. It does not, however, map over other random
|
|
149 submaps of the keymap, just the bucky ones.
|
|
150
|
|
151 One implication of this is that when you map over `global-map', you will
|
|
152 also map over `esc-map'. It is merely for compatibility that the esc-map
|
|
153 is accessible at all; I think that's a bad thing, since it blurs the
|
|
154 distinction between ESC and "meta" even more. "M-x" is no more a two-
|
|
155 key sequence than "C-x" is.
|
|
156
|
|
157 */
|
|
158
|
412
|
159 typedef struct Lisp_Keymap
|
0
|
160 {
|
|
161 struct lcrecord_header header;
|
412
|
162 Lisp_Object parents; /* Keymaps to be searched after this one
|
|
163 * An ordered list */
|
0
|
164 Lisp_Object prompt; /* Qnil or a string to print in the minibuffer
|
412
|
165 * when reading from this keymap */
|
|
166
|
0
|
167 Lisp_Object table; /* The contents of this keymap */
|
|
168 Lisp_Object inverse_table; /* The inverse mapping of the above */
|
412
|
169
|
0
|
170 Lisp_Object default_binding; /* Use this if no other binding is found
|
412
|
171 * (this overrides parent maps and the
|
|
172 * normal global-map lookup). */
|
|
173
|
|
174
|
0
|
175 Lisp_Object sub_maps_cache; /* Cache of directly inferior keymaps;
|
|
176 This holds an alist, of the key and the
|
|
177 maps, or the modifier bit and the map.
|
|
178 If this is the symbol t, then the cache
|
412
|
179 needs to be recomputed.
|
|
180 */
|
|
181 int fullness; /* How many entries there are in this table.
|
|
182 This should be the same as the fullness
|
|
183 of the `table', but hash.c is broken. */
|
0
|
184 Lisp_Object name; /* Just for debugging convenience */
|
412
|
185 } Lisp_Keymap;
|
0
|
186
|
70
|
187 #define MAKE_MODIFIER_HASH_KEY(modifier) make_int (modifier)
|
|
188 #define MODIFIER_HASH_KEY_BITS(x) (INTP (x) ? XINT (x) : 0)
|
0
|
189
|
|
190
|
|
191
|
|
192 /* Actually allocate storage for these variables */
|
|
193
|
412
|
194 static Lisp_Object Vcurrent_global_map; /* Always a keymap */
|
0
|
195
|
|
196 static Lisp_Object Vmouse_grabbed_buffer;
|
|
197
|
|
198 /* Alist of minor mode variables and keymaps. */
|
|
199 static Lisp_Object Qminor_mode_map_alist;
|
|
200
|
|
201 static Lisp_Object Voverriding_local_map;
|
|
202
|
|
203 static Lisp_Object Vkey_translation_map;
|
|
204
|
284
|
205 static Lisp_Object Vvertical_divider_map;
|
|
206
|
0
|
207 /* This is incremented whenever a change is made to a keymap. This is
|
|
208 so that things which care (such as the menubar code) can recompute
|
|
209 privately-cached data when the user has changed keybindings.
|
|
210 */
|
|
211 int keymap_tick;
|
|
212
|
|
213 /* Prefixing a key with this character is the same as sending a meta bit. */
|
|
214 Lisp_Object Vmeta_prefix_char;
|
|
215
|
|
216 Lisp_Object Qkeymapp;
|
|
217 Lisp_Object Vsingle_space_string;
|
|
218 Lisp_Object Qsuppress_keymap;
|
|
219 Lisp_Object Qmodeline_map;
|
|
220 Lisp_Object Qtoolbar_map;
|
|
221
|
272
|
222 EXFUN (Fkeymap_fullness, 1);
|
|
223 EXFUN (Fset_keymap_name, 2);
|
|
224 EXFUN (Fsingle_key_description, 1);
|
|
225
|
219
|
226 static void describe_command (Lisp_Object definition, Lisp_Object buffer);
|
0
|
227 static void describe_map (Lisp_Object keymap, Lisp_Object elt_prefix,
|
219
|
228 void (*elt_describer) (Lisp_Object, Lisp_Object),
|
185
|
229 int partial,
|
|
230 Lisp_Object shadow,
|
219
|
231 int mice_only_p,
|
|
232 Lisp_Object buffer);
|
272
|
233
|
0
|
234 Lisp_Object Qcontrol, Qctrl, Qmeta, Qsuper, Qhyper, Qalt, Qshift;
|
272
|
235 Lisp_Object Qbutton0, Qbutton1, Qbutton2, Qbutton3;
|
|
236 Lisp_Object Qbutton4, Qbutton5, Qbutton6, Qbutton7;
|
|
237 Lisp_Object Qbutton0up, Qbutton1up, Qbutton2up, Qbutton3up;
|
|
238 Lisp_Object Qbutton4up, Qbutton5up, Qbutton6up, Qbutton7up;
|
|
239
|
0
|
240 Lisp_Object Qmenu_selection;
|
98
|
241 /* Emacs compatibility */
|
265
|
242 Lisp_Object Qdown_mouse_1, Qdown_mouse_2, Qdown_mouse_3, Qdown_mouse_4,
|
|
243 Qdown_mouse_5;
|
|
244 Lisp_Object Qmouse_1, Qmouse_2, Qmouse_3, Qmouse_4, Qmouse_5;
|
0
|
245
|
|
246 /* Kludge kludge kludge */
|
|
247 Lisp_Object QLFD, QTAB, QRET, QESC, QDEL, QSPC, QBS;
|
|
248
|
|
249
|
|
250 /************************************************************************/
|
|
251 /* The keymap Lisp object */
|
|
252 /************************************************************************/
|
|
253
|
|
254 static Lisp_Object
|
412
|
255 mark_keymap (Lisp_Object obj, void (*markobj) (Lisp_Object))
|
0
|
256 {
|
380
|
257 Lisp_Keymap *keymap = XKEYMAP (obj);
|
412
|
258 markobj (keymap->parents);
|
|
259 markobj (keymap->prompt);
|
|
260 markobj (keymap->inverse_table);
|
|
261 markobj (keymap->sub_maps_cache);
|
|
262 markobj (keymap->default_binding);
|
|
263 markobj (keymap->name);
|
173
|
264 return keymap->table;
|
0
|
265 }
|
185
|
266
|
0
|
267 static void
|
|
268 print_keymap (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
|
|
269 {
|
|
270 /* This function can GC */
|
380
|
271 Lisp_Keymap *keymap = XKEYMAP (obj);
|
0
|
272 char buf[200];
|
412
|
273 int size = XINT (Fkeymap_fullness (obj));
|
0
|
274 if (print_readably)
|
|
275 error ("printing unreadable object #<keymap 0x%x>", keymap->header.uid);
|
|
276 write_c_string ("#<keymap ", printcharfun);
|
|
277 if (!NILP (keymap->name))
|
412
|
278 print_internal (keymap->name, printcharfun, 1);
|
|
279 /* #### Yuck! This is no way to form plural! --hniksic */
|
|
280 sprintf (buf, "%s%d entr%s 0x%x>",
|
|
281 ((NILP (keymap->name)) ? "" : " "),
|
|
282 size,
|
|
283 ((size == 1) ? "y" : "ies"),
|
|
284 keymap->header.uid);
|
0
|
285 write_c_string (buf, printcharfun);
|
|
286 }
|
|
287
|
420
|
288 static const struct lrecord_description keymap_description[] = {
|
|
289 { XD_LISP_OBJECT, offsetof(Lisp_Keymap, parents), 6 },
|
|
290 { XD_LISP_OBJECT, offsetof(Lisp_Keymap, name), 1 },
|
|
291 { XD_END }
|
|
292 };
|
|
293
|
272
|
294 /* No need for keymap_equal #### Why not? */
|
|
295 DEFINE_LRECORD_IMPLEMENTATION ("keymap", keymap,
|
|
296 mark_keymap, print_keymap, 0, 0, 0,
|
420
|
297 keymap_description,
|
380
|
298 Lisp_Keymap);
|
0
|
299
|
|
300 /************************************************************************/
|
|
301 /* Traversing keymaps and their parents */
|
|
302 /************************************************************************/
|
|
303
|
|
304 static Lisp_Object
|
|
305 traverse_keymaps (Lisp_Object start_keymap, Lisp_Object start_parents,
|
|
306 Lisp_Object (*mapper) (Lisp_Object keymap, void *mapper_arg),
|
|
307 void *mapper_arg)
|
|
308 {
|
|
309 /* This function can GC */
|
|
310 Lisp_Object keymap;
|
|
311 Lisp_Object tail = start_parents;
|
|
312 Lisp_Object malloc_sucks[10];
|
|
313 Lisp_Object malloc_bites = Qnil;
|
|
314 int stack_depth = 0;
|
|
315 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
|
|
316 GCPRO4 (*malloc_sucks, malloc_bites, start_keymap, tail);
|
|
317 gcpro1.nvars = 0;
|
|
318
|
|
319 start_keymap = get_keymap (start_keymap, 1, 1);
|
|
320 keymap = start_keymap;
|
|
321 /* Hack special-case parents at top-level */
|
412
|
322 tail = ((!NILP (tail)) ? tail : XKEYMAP (keymap)->parents);
|
0
|
323
|
|
324 for (;;)
|
|
325 {
|
|
326 Lisp_Object result;
|
|
327
|
|
328 QUIT;
|
412
|
329 result = ((mapper) (keymap, mapper_arg));
|
0
|
330 if (!NILP (result))
|
|
331 {
|
|
332 while (CONSP (malloc_bites))
|
|
333 {
|
412
|
334 struct Lisp_Cons *victim = XCONS (malloc_bites);
|
0
|
335 malloc_bites = victim->cdr;
|
|
336 free_cons (victim);
|
|
337 }
|
|
338 UNGCPRO;
|
173
|
339 return result;
|
0
|
340 }
|
|
341 if (NILP (tail))
|
|
342 {
|
|
343 if (stack_depth == 0)
|
|
344 {
|
|
345 UNGCPRO;
|
173
|
346 return Qnil; /* Nothing found */
|
0
|
347 }
|
|
348 stack_depth--;
|
|
349 if (CONSP (malloc_bites))
|
|
350 {
|
412
|
351 struct Lisp_Cons *victim = XCONS (malloc_bites);
|
0
|
352 tail = victim->car;
|
|
353 malloc_bites = victim->cdr;
|
|
354 free_cons (victim);
|
|
355 }
|
|
356 else
|
|
357 {
|
|
358 tail = malloc_sucks[stack_depth];
|
|
359 gcpro1.nvars = stack_depth;
|
|
360 }
|
|
361 keymap = XCAR (tail);
|
|
362 tail = XCDR (tail);
|
|
363 }
|
|
364 else
|
|
365 {
|
|
366 Lisp_Object parents;
|
|
367
|
|
368 keymap = XCAR (tail);
|
|
369 tail = XCDR (tail);
|
|
370 parents = XKEYMAP (keymap)->parents;
|
|
371 if (!CONSP (parents))
|
|
372 ;
|
|
373 else if (NILP (tail))
|
|
374 /* Tail-recurse */
|
|
375 tail = parents;
|
|
376 else
|
|
377 {
|
|
378 if (CONSP (malloc_bites))
|
|
379 malloc_bites = noseeum_cons (tail, malloc_bites);
|
|
380 else if (stack_depth < countof (malloc_sucks))
|
|
381 {
|
|
382 malloc_sucks[stack_depth++] = tail;
|
|
383 gcpro1.nvars = stack_depth;
|
|
384 }
|
|
385 else
|
|
386 {
|
|
387 /* *&@##[*&^$ C. @#[$*&@# Unix. Losers all. */
|
|
388 int i;
|
|
389 for (i = 0, malloc_bites = Qnil;
|
|
390 i < countof (malloc_sucks);
|
|
391 i++)
|
|
392 malloc_bites = noseeum_cons (malloc_sucks[i],
|
|
393 malloc_bites);
|
|
394 gcpro1.nvars = 0;
|
|
395 }
|
|
396 tail = parents;
|
|
397 }
|
|
398 }
|
|
399 keymap = get_keymap (keymap, 1, 1);
|
|
400 if (EQ (keymap, start_keymap))
|
|
401 {
|
|
402 signal_simple_error ("Cyclic keymap indirection",
|
|
403 start_keymap);
|
|
404 }
|
|
405 }
|
|
406 }
|
|
407
|
|
408
|
|
409 /************************************************************************/
|
|
410 /* Some low-level functions */
|
|
411 /************************************************************************/
|
|
412
|
412
|
413 static unsigned int
|
0
|
414 bucky_sym_to_bucky_bit (Lisp_Object sym)
|
|
415 {
|
412
|
416 if (EQ (sym, Qcontrol)) return MOD_CONTROL;
|
|
417 if (EQ (sym, Qmeta)) return MOD_META;
|
|
418 if (EQ (sym, Qsuper)) return MOD_SUPER;
|
|
419 if (EQ (sym, Qhyper)) return MOD_HYPER;
|
|
420 if (EQ (sym, Qalt)) return MOD_ALT;
|
|
421 if (EQ (sym, Qsymbol)) return MOD_ALT; /* #### - reverse compat */
|
|
422 if (EQ (sym, Qshift)) return MOD_SHIFT;
|
185
|
423
|
|
424 return 0;
|
0
|
425 }
|
|
426
|
|
427 static Lisp_Object
|
412
|
428 control_meta_superify (Lisp_Object frob, unsigned int modifiers)
|
0
|
429 {
|
|
430 if (modifiers == 0)
|
|
431 return frob;
|
|
432 frob = Fcons (frob, Qnil);
|
412
|
433 if (modifiers & MOD_SHIFT) frob = Fcons (Qshift, frob);
|
|
434 if (modifiers & MOD_ALT) frob = Fcons (Qalt, frob);
|
|
435 if (modifiers & MOD_HYPER) frob = Fcons (Qhyper, frob);
|
|
436 if (modifiers & MOD_SUPER) frob = Fcons (Qsuper, frob);
|
|
437 if (modifiers & MOD_CONTROL) frob = Fcons (Qcontrol, frob);
|
|
438 if (modifiers & MOD_META) frob = Fcons (Qmeta, frob);
|
173
|
439 return frob;
|
0
|
440 }
|
|
441
|
|
442 static Lisp_Object
|
412
|
443 make_key_description (CONST struct key_data *key, int prettify)
|
0
|
444 {
|
|
445 Lisp_Object keysym = key->keysym;
|
412
|
446 unsigned int modifiers = key->modifiers;
|
0
|
447
|
70
|
448 if (prettify && CHARP (keysym))
|
0
|
449 {
|
|
450 /* This is a little slow, but (control a) is prettier than (control 65).
|
|
451 It's now ok to do this for digit-chars too, since we've fixed the
|
|
452 bug where \9 read as the integer 9 instead of as the symbol with
|
|
453 "9" as its name.
|
|
454 */
|
|
455 /* !!#### I'm not sure how correct this is. */
|
|
456 Bufbyte str [1 + MAX_EMCHAR_LEN];
|
|
457 Bytecount count = set_charptr_emchar (str, XCHAR (keysym));
|
|
458 str[count] = 0;
|
|
459 keysym = intern ((char *) str);
|
|
460 }
|
173
|
461 return control_meta_superify (keysym, modifiers);
|
0
|
462 }
|
|
463
|
|
464
|
|
465 /************************************************************************/
|
|
466 /* Low-level keymap-store functions */
|
|
467 /************************************************************************/
|
|
468
|
|
469 static Lisp_Object
|
|
470 raw_lookup_key (Lisp_Object keymap,
|
412
|
471 CONST struct key_data *raw_keys, int raw_keys_count,
|
0
|
472 int keys_so_far, int accept_default);
|
|
473
|
|
474 /* Relies on caller to gc-protect args */
|
|
475 static Lisp_Object
|
|
476 keymap_lookup_directly (Lisp_Object keymap,
|
412
|
477 Lisp_Object keysym, unsigned int modifiers)
|
0
|
478 {
|
380
|
479 Lisp_Keymap *k;
|
0
|
480
|
412
|
481 if ((modifiers & ~(MOD_CONTROL | MOD_META | MOD_SUPER | MOD_HYPER
|
|
482 | MOD_ALT | MOD_SHIFT)) != 0)
|
0
|
483 abort ();
|
|
484
|
|
485 k = XKEYMAP (keymap);
|
|
486
|
|
487 /* If the keysym is a one-character symbol, use the char code instead. */
|
|
488 if (SYMBOLP (keysym) && string_char_length (XSYMBOL (keysym)->name) == 1)
|
|
489 {
|
|
490 Lisp_Object i_fart_on_gcc =
|
|
491 make_char (string_char (XSYMBOL (keysym)->name, 0));
|
|
492 keysym = i_fart_on_gcc;
|
|
493 }
|
|
494
|
412
|
495 if (modifiers & MOD_META) /* Utterly hateful ESC lossage */
|
2
|
496 {
|
412
|
497 Lisp_Object submap = Fgethash (MAKE_MODIFIER_HASH_KEY (MOD_META),
|
2
|
498 k->table, Qnil);
|
|
499 if (NILP (submap))
|
173
|
500 return Qnil;
|
2
|
501 k = XKEYMAP (submap);
|
412
|
502 modifiers &= ~MOD_META;
|
2
|
503 }
|
0
|
504
|
|
505 if (modifiers != 0)
|
2
|
506 {
|
|
507 Lisp_Object submap = Fgethash (MAKE_MODIFIER_HASH_KEY (modifiers),
|
|
508 k->table, Qnil);
|
|
509 if (NILP (submap))
|
173
|
510 return Qnil;
|
2
|
511 k = XKEYMAP (submap);
|
|
512 }
|
173
|
513 return Fgethash (keysym, k->table, Qnil);
|
0
|
514 }
|
|
515
|
|
516 static void
|
|
517 keymap_store_inverse_internal (Lisp_Object inverse_table,
|
|
518 Lisp_Object keysym,
|
|
519 Lisp_Object value)
|
|
520 {
|
|
521 Lisp_Object keys = Fgethash (value, inverse_table, Qunbound);
|
|
522
|
|
523 if (UNBOUNDP (keys))
|
|
524 {
|
|
525 keys = keysym;
|
|
526 /* Don't cons this unless necessary */
|
|
527 /* keys = Fcons (keysym, Qnil); */
|
|
528 Fputhash (value, keys, inverse_table);
|
|
529 }
|
|
530 else if (!CONSP (keys))
|
|
531 {
|
|
532 /* Now it's necessary to cons */
|
|
533 keys = Fcons (keys, keysym);
|
|
534 Fputhash (value, keys, inverse_table);
|
|
535 }
|
|
536 else
|
|
537 {
|
380
|
538 while (CONSP (XCDR (keys)))
|
0
|
539 keys = XCDR (keys);
|
|
540 XCDR (keys) = Fcons (XCDR (keys), keysym);
|
|
541 /* No need to call puthash because we've destructively
|
|
542 modified the list tail in place */
|
|
543 }
|
|
544 }
|
|
545
|
|
546
|
|
547 static void
|
|
548 keymap_delete_inverse_internal (Lisp_Object inverse_table,
|
185
|
549 Lisp_Object keysym,
|
0
|
550 Lisp_Object value)
|
|
551 {
|
|
552 Lisp_Object keys = Fgethash (value, inverse_table, Qunbound);
|
|
553 Lisp_Object new_keys = keys;
|
|
554 Lisp_Object tail;
|
|
555 Lisp_Object *prev;
|
|
556
|
|
557 if (UNBOUNDP (keys))
|
|
558 abort ();
|
|
559
|
|
560 for (prev = &new_keys, tail = new_keys;
|
|
561 ;
|
|
562 prev = &(XCDR (tail)), tail = XCDR (tail))
|
|
563 {
|
|
564 if (EQ (tail, keysym))
|
|
565 {
|
|
566 *prev = Qnil;
|
|
567 break;
|
|
568 }
|
|
569 else if (EQ (keysym, XCAR (tail)))
|
|
570 {
|
|
571 *prev = XCDR (tail);
|
|
572 break;
|
|
573 }
|
|
574 }
|
|
575
|
|
576 if (NILP (new_keys))
|
|
577 Fremhash (value, inverse_table);
|
|
578 else if (!EQ (keys, new_keys))
|
|
579 /* Removed the first elt */
|
|
580 Fputhash (value, new_keys, inverse_table);
|
|
581 /* else the list's tail has been modified, so we don't need to
|
|
582 touch the hash table again (the pointer in there is ok).
|
|
583 */
|
|
584 }
|
|
585
|
|
586
|
|
587 static void
|
380
|
588 keymap_store_internal (Lisp_Object keysym, Lisp_Keymap *keymap,
|
412
|
589 Lisp_Object value)
|
0
|
590 {
|
412
|
591 Lisp_Object prev_value = Fgethash (keysym, keymap->table, Qnil);
|
|
592
|
|
593 if (EQ (prev_value, value))
|
0
|
594 return;
|
412
|
595 if (!NILP (prev_value))
|
185
|
596 keymap_delete_inverse_internal (keymap->inverse_table,
|
412
|
597 keysym, prev_value);
|
|
598 if (NILP (value))
|
0
|
599 {
|
412
|
600 keymap->fullness--;
|
|
601 if (keymap->fullness < 0) abort ();
|
0
|
602 Fremhash (keysym, keymap->table);
|
|
603 }
|
|
604 else
|
|
605 {
|
412
|
606 if (NILP (prev_value))
|
|
607 keymap->fullness++;
|
|
608 Fputhash (keysym, value, keymap->table);
|
185
|
609 keymap_store_inverse_internal (keymap->inverse_table,
|
412
|
610 keysym, value);
|
0
|
611 }
|
|
612 keymap_tick++;
|
|
613 }
|
|
614
|
|
615
|
|
616 static Lisp_Object
|
412
|
617 create_bucky_submap (Lisp_Keymap *k, unsigned int modifiers,
|
0
|
618 Lisp_Object parent_for_debugging_info)
|
|
619 {
|
|
620 Lisp_Object submap = Fmake_sparse_keymap (Qnil);
|
|
621 /* User won't see this, but it is nice for debugging Emacs */
|
|
622 XKEYMAP (submap)->name
|
|
623 = control_meta_superify (parent_for_debugging_info, modifiers);
|
|
624 /* Invalidate cache */
|
|
625 k->sub_maps_cache = Qt;
|
|
626 keymap_store_internal (MAKE_MODIFIER_HASH_KEY (modifiers), k, submap);
|
173
|
627 return submap;
|
0
|
628 }
|
|
629
|
|
630
|
|
631 /* Relies on caller to gc-protect keymap, keysym, value */
|
|
632 static void
|
412
|
633 keymap_store (Lisp_Object keymap, CONST struct key_data *key,
|
0
|
634 Lisp_Object value)
|
|
635 {
|
|
636 Lisp_Object keysym = key->keysym;
|
412
|
637 unsigned int modifiers = key->modifiers;
|
|
638 Lisp_Keymap *k;
|
|
639
|
|
640 if ((modifiers & ~(MOD_CONTROL | MOD_META | MOD_SUPER | MOD_HYPER
|
|
641 | MOD_ALT | MOD_SHIFT)) != 0)
|
|
642 abort ();
|
|
643
|
|
644 k = XKEYMAP (keymap);
|
0
|
645
|
|
646 /* If the keysym is a one-character symbol, use the char code instead. */
|
|
647 if (SYMBOLP (keysym) && string_char_length (XSYMBOL (keysym)->name) == 1)
|
|
648 {
|
412
|
649 Lisp_Object run_the_gcc_developers_over_with_a_steamroller =
|
|
650 make_char (string_char (XSYMBOL (keysym)->name, 0));
|
|
651 keysym = run_the_gcc_developers_over_with_a_steamroller;
|
|
652 }
|
|
653
|
|
654 if (modifiers & MOD_META) /* Utterly hateful ESC lossage */
|
|
655 {
|
|
656 Lisp_Object submap = Fgethash (MAKE_MODIFIER_HASH_KEY (MOD_META),
|
0
|
657 k->table, Qnil);
|
|
658 if (NILP (submap))
|
412
|
659 submap = create_bucky_submap (k, MOD_META, keymap);
|
0
|
660 k = XKEYMAP (submap);
|
412
|
661 modifiers &= ~MOD_META;
|
0
|
662 }
|
|
663
|
|
664 if (modifiers != 0)
|
|
665 {
|
|
666 Lisp_Object submap = Fgethash (MAKE_MODIFIER_HASH_KEY (modifiers),
|
|
667 k->table, Qnil);
|
|
668 if (NILP (submap))
|
|
669 submap = create_bucky_submap (k, modifiers, keymap);
|
|
670 k = XKEYMAP (submap);
|
|
671 }
|
|
672 k->sub_maps_cache = Qt; /* Invalidate cache */
|
|
673 keymap_store_internal (keysym, k, value);
|
|
674 }
|
|
675
|
|
676
|
|
677 /************************************************************************/
|
|
678 /* Listing the submaps of a keymap */
|
|
679 /************************************************************************/
|
|
680
|
|
681 struct keymap_submaps_closure
|
|
682 {
|
|
683 Lisp_Object *result_locative;
|
|
684 };
|
|
685
|
241
|
686 static int
|
380
|
687 keymap_submaps_mapper_0 (Lisp_Object key, Lisp_Object value,
|
0
|
688 void *keymap_submaps_closure)
|
|
689 {
|
|
690 /* This function can GC */
|
|
691 /* Perform any autoloads, etc */
|
380
|
692 Fkeymapp (value);
|
241
|
693 return 0;
|
0
|
694 }
|
|
695
|
241
|
696 static int
|
380
|
697 keymap_submaps_mapper (Lisp_Object key, Lisp_Object value,
|
0
|
698 void *keymap_submaps_closure)
|
|
699 {
|
|
700 /* This function can GC */
|
|
701 Lisp_Object *result_locative;
|
185
|
702 struct keymap_submaps_closure *cl =
|
|
703 (struct keymap_submaps_closure *) keymap_submaps_closure;
|
0
|
704 result_locative = cl->result_locative;
|
|
705
|
380
|
706 if (!NILP (Fkeymapp (value)))
|
|
707 *result_locative = Fcons (Fcons (key, value), *result_locative);
|
241
|
708 return 0;
|
0
|
709 }
|
|
710
|
185
|
711 static int map_keymap_sort_predicate (Lisp_Object obj1, Lisp_Object obj2,
|
0
|
712 Lisp_Object pred);
|
|
713
|
|
714 static Lisp_Object
|
|
715 keymap_submaps (Lisp_Object keymap)
|
|
716 {
|
|
717 /* This function can GC */
|
380
|
718 Lisp_Keymap *k = XKEYMAP (keymap);
|
0
|
719
|
|
720 if (EQ (k->sub_maps_cache, Qt)) /* Unknown */
|
|
721 {
|
|
722 Lisp_Object result = Qnil;
|
|
723 struct gcpro gcpro1, gcpro2;
|
|
724 struct keymap_submaps_closure keymap_submaps_closure;
|
|
725
|
|
726 GCPRO2 (keymap, result);
|
|
727 keymap_submaps_closure.result_locative = &result;
|
|
728 /* Do this first pass to touch (and load) any autoloaded maps */
|
|
729 elisp_maphash (keymap_submaps_mapper_0, k->table,
|
|
730 &keymap_submaps_closure);
|
|
731 result = Qnil;
|
|
732 elisp_maphash (keymap_submaps_mapper, k->table,
|
|
733 &keymap_submaps_closure);
|
|
734 /* keep it sorted so that the result of accessible-keymaps is ordered */
|
185
|
735 k->sub_maps_cache = list_sort (result,
|
0
|
736 Qnil,
|
|
737 map_keymap_sort_predicate);
|
|
738 UNGCPRO;
|
|
739 }
|
173
|
740 return k->sub_maps_cache;
|
0
|
741 }
|
|
742
|
|
743
|
|
744 /************************************************************************/
|
|
745 /* Basic operations on keymaps */
|
|
746 /************************************************************************/
|
|
747
|
|
748 static Lisp_Object
|
380
|
749 make_keymap (size_t size)
|
0
|
750 {
|
272
|
751 Lisp_Object result;
|
398
|
752 Lisp_Keymap *keymap = alloc_lcrecord_type (Lisp_Keymap, &lrecord_keymap);
|
0
|
753
|
|
754 XSETKEYMAP (result, keymap);
|
|
755
|
380
|
756 keymap->parents = Qnil;
|
|
757 keymap->prompt = Qnil;
|
|
758 keymap->table = Qnil;
|
|
759 keymap->inverse_table = Qnil;
|
0
|
760 keymap->default_binding = Qnil;
|
380
|
761 keymap->sub_maps_cache = Qnil; /* No possible submaps */
|
412
|
762 keymap->fullness = 0;
|
380
|
763 keymap->name = Qnil;
|
|
764
|
0
|
765 if (size != 0) /* hack for copy-keymap */
|
|
766 {
|
380
|
767 keymap->table =
|
|
768 make_lisp_hash_table (size, HASH_TABLE_NON_WEAK, HASH_TABLE_EQ);
|
0
|
769 /* Inverse table is often less dense because of duplicate key-bindings.
|
|
770 If not, it will grow anyway. */
|
380
|
771 keymap->inverse_table =
|
|
772 make_lisp_hash_table (size * 3 / 4, HASH_TABLE_NON_WEAK, HASH_TABLE_EQ);
|
0
|
773 }
|
173
|
774 return result;
|
0
|
775 }
|
|
776
|
20
|
777 DEFUN ("make-keymap", Fmake_keymap, 0, 1, 0, /*
|
0
|
778 Construct and return a new keymap object.
|
185
|
779 All entries in it are nil, meaning "command undefined".
|
0
|
780
|
|
781 Optional argument NAME specifies a name to assign to the keymap,
|
|
782 as in `set-keymap-name'. This name is only a debugging convenience;
|
|
783 it is not used except when printing the keymap.
|
20
|
784 */
|
|
785 (name))
|
0
|
786 {
|
|
787 Lisp_Object keymap = make_keymap (60);
|
|
788 if (!NILP (name))
|
|
789 Fset_keymap_name (keymap, name);
|
|
790 return keymap;
|
|
791 }
|
|
792
|
20
|
793 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, 0, 1, 0, /*
|
0
|
794 Construct and return a new keymap object.
|
185
|
795 All entries in it are nil, meaning "command undefined". The only
|
0
|
796 difference between this function and make-keymap is that this function
|
185
|
797 returns a "smaller" keymap (one that is expected to contain fewer
|
0
|
798 entries). As keymaps dynamically resize, the distinction is not great.
|
|
799
|
|
800 Optional argument NAME specifies a name to assign to the keymap,
|
|
801 as in `set-keymap-name'. This name is only a debugging convenience;
|
|
802 it is not used except when printing the keymap.
|
20
|
803 */
|
|
804 (name))
|
0
|
805 {
|
|
806 Lisp_Object keymap = make_keymap (8);
|
|
807 if (!NILP (name))
|
|
808 Fset_keymap_name (keymap, name);
|
|
809 return keymap;
|
|
810 }
|
|
811
|
20
|
812 DEFUN ("keymap-parents", Fkeymap_parents, 1, 1, 0, /*
|
272
|
813 Return the `parent' keymaps of KEYMAP, or nil.
|
0
|
814 The parents of a keymap are searched for keybindings when a key sequence
|
|
815 isn't bound in this one. `(current-global-map)' is the default parent
|
|
816 of all keymaps.
|
20
|
817 */
|
|
818 (keymap))
|
0
|
819 {
|
|
820 keymap = get_keymap (keymap, 1, 1);
|
173
|
821 return Fcopy_sequence (XKEYMAP (keymap)->parents);
|
0
|
822 }
|
|
823
|
185
|
824
|
|
825
|
0
|
826 static Lisp_Object
|
|
827 traverse_keymaps_noop (Lisp_Object keymap, void *arg)
|
|
828 {
|
173
|
829 return Qnil;
|
0
|
830 }
|
|
831
|
20
|
832 DEFUN ("set-keymap-parents", Fset_keymap_parents, 2, 2, 0, /*
|
272
|
833 Set the `parent' keymaps of KEYMAP to PARENTS.
|
0
|
834 The parents of a keymap are searched for keybindings when a key sequence
|
|
835 isn't bound in this one. `(current-global-map)' is the default parent
|
|
836 of all keymaps.
|
20
|
837 */
|
|
838 (keymap, parents))
|
0
|
839 {
|
|
840 /* This function can GC */
|
|
841 Lisp_Object k;
|
|
842 struct gcpro gcpro1, gcpro2;
|
|
843
|
|
844 GCPRO2 (keymap, parents);
|
|
845 keymap = get_keymap (keymap, 1, 1);
|
|
846
|
|
847 if (KEYMAPP (parents)) /* backwards-compatibility */
|
|
848 parents = list1 (parents);
|
|
849 if (!NILP (parents))
|
|
850 {
|
|
851 Lisp_Object tail = parents;
|
|
852 while (!NILP (tail))
|
|
853 {
|
|
854 QUIT;
|
|
855 CHECK_CONS (tail);
|
|
856 k = XCAR (tail);
|
|
857 /* Require that it be an actual keymap object, rather than a symbol
|
|
858 with a (crockish) symbol-function which is a keymap */
|
|
859 CHECK_KEYMAP (k); /* get_keymap (k, 1, 1); */
|
|
860 tail = XCDR (tail);
|
|
861 }
|
|
862 }
|
|
863
|
|
864 /* Check for circularities */
|
|
865 traverse_keymaps (keymap, parents, traverse_keymaps_noop, 0);
|
|
866 keymap_tick++;
|
|
867 XKEYMAP (keymap)->parents = Fcopy_sequence (parents);
|
|
868 UNGCPRO;
|
173
|
869 return parents;
|
0
|
870 }
|
|
871
|
20
|
872 DEFUN ("set-keymap-name", Fset_keymap_name, 2, 2, 0, /*
|
0
|
873 Set the `name' of the KEYMAP to NEW-NAME.
|
|
874 The name is only a debugging convenience; it is not used except
|
|
875 when printing the keymap.
|
20
|
876 */
|
|
877 (keymap, new_name))
|
0
|
878 {
|
|
879 keymap = get_keymap (keymap, 1, 1);
|
|
880
|
|
881 XKEYMAP (keymap)->name = new_name;
|
173
|
882 return new_name;
|
0
|
883 }
|
|
884
|
20
|
885 DEFUN ("keymap-name", Fkeymap_name, 1, 1, 0, /*
|
0
|
886 Return the `name' of KEYMAP.
|
|
887 The name is only a debugging convenience; it is not used except
|
|
888 when printing the keymap.
|
20
|
889 */
|
|
890 (keymap))
|
0
|
891 {
|
|
892 keymap = get_keymap (keymap, 1, 1);
|
|
893
|
173
|
894 return XKEYMAP (keymap)->name;
|
0
|
895 }
|
|
896
|
20
|
897 DEFUN ("set-keymap-prompt", Fset_keymap_prompt, 2, 2, 0, /*
|
272
|
898 Set the `prompt' of KEYMAP to string NEW-PROMPT, or `nil'
|
0
|
899 if no prompt is desired. The prompt is shown in the echo-area
|
|
900 when reading a key-sequence to be looked-up in this keymap.
|
20
|
901 */
|
|
902 (keymap, new_prompt))
|
0
|
903 {
|
|
904 keymap = get_keymap (keymap, 1, 1);
|
185
|
905
|
0
|
906 if (!NILP (new_prompt))
|
|
907 CHECK_STRING (new_prompt);
|
|
908
|
|
909 XKEYMAP (keymap)->prompt = new_prompt;
|
173
|
910 return new_prompt;
|
0
|
911 }
|
|
912
|
|
913 static Lisp_Object
|
|
914 keymap_prompt_mapper (Lisp_Object keymap, void *arg)
|
|
915 {
|
173
|
916 return XKEYMAP (keymap)->prompt;
|
0
|
917 }
|
|
918
|
|
919
|
20
|
920 DEFUN ("keymap-prompt", Fkeymap_prompt, 1, 2, 0, /*
|
272
|
921 Return the `prompt' of KEYMAP.
|
0
|
922 If non-nil, the prompt is shown in the echo-area
|
|
923 when reading a key-sequence to be looked-up in this keymap.
|
20
|
924 */
|
|
925 (keymap, use_inherited))
|
0
|
926 {
|
|
927 /* This function can GC */
|
|
928 Lisp_Object prompt;
|
|
929
|
|
930 keymap = get_keymap (keymap, 1, 1);
|
|
931 prompt = XKEYMAP (keymap)->prompt;
|
|
932 if (!NILP (prompt) || NILP (use_inherited))
|
173
|
933 return prompt;
|
0
|
934 else
|
173
|
935 return traverse_keymaps (keymap, Qnil, keymap_prompt_mapper, 0);
|
0
|
936 }
|
|
937
|
20
|
938 DEFUN ("set-keymap-default-binding", Fset_keymap_default_binding, 2, 2, 0, /*
|
0
|
939 Sets the default binding of KEYMAP to COMMAND, or `nil'
|
|
940 if no default is desired. The default-binding is returned when
|
|
941 no other binding for a key-sequence is found in the keymap.
|
|
942 If a keymap has a non-nil default-binding, neither the keymap's
|
|
943 parents nor the current global map are searched for key bindings.
|
20
|
944 */
|
|
945 (keymap, command))
|
0
|
946 {
|
|
947 /* This function can GC */
|
|
948 keymap = get_keymap (keymap, 1, 1);
|
185
|
949
|
0
|
950 XKEYMAP (keymap)->default_binding = command;
|
173
|
951 return command;
|
0
|
952 }
|
|
953
|
20
|
954 DEFUN ("keymap-default-binding", Fkeymap_default_binding, 1, 1, 0, /*
|
0
|
955 Return the default binding of KEYMAP, or `nil' if it has none.
|
|
956 The default-binding is returned when no other binding for a key-sequence
|
|
957 is found in the keymap.
|
|
958 If a keymap has a non-nil default-binding, neither the keymap's
|
|
959 parents nor the current global map are searched for key bindings.
|
20
|
960 */
|
|
961 (keymap))
|
0
|
962 {
|
|
963 /* This function can GC */
|
|
964 keymap = get_keymap (keymap, 1, 1);
|
173
|
965 return XKEYMAP (keymap)->default_binding;
|
0
|
966 }
|
|
967
|
20
|
968 DEFUN ("keymapp", Fkeymapp, 1, 1, 0, /*
|
0
|
969 Return t if ARG is a keymap object.
|
|
970 The keymap may be autoloaded first if necessary.
|
20
|
971 */
|
|
972 (object))
|
0
|
973 {
|
|
974 /* This function can GC */
|
185
|
975 return KEYMAPP (get_keymap (object, 0, 0)) ? Qt : Qnil;
|
0
|
976 }
|
|
977
|
|
978 /* Check that OBJECT is a keymap (after dereferencing through any
|
|
979 symbols). If it is, return it.
|
|
980
|
|
981 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
|
|
982 is an autoload form, do the autoload and try again.
|
185
|
983 If AUTOLOAD is nonzero, callers must assume GC is possible.
|
0
|
984
|
|
985 ERRORP controls how we respond if OBJECT isn't a keymap.
|
185
|
986 If ERRORP is non-zero, signal an error; otherwise, just return Qnil.
|
|
987
|
|
988 Note that most of the time, we don't want to pursue autoloads.
|
|
989 Functions like Faccessible_keymaps which scan entire keymap trees
|
|
990 shouldn't load every autoloaded keymap. I'm not sure about this,
|
|
991 but it seems to me that only read_key_sequence, Flookup_key, and
|
|
992 Fdefine_key should cause keymaps to be autoloaded. */
|
|
993
|
0
|
994 Lisp_Object
|
|
995 get_keymap (Lisp_Object object, int errorp, int autoload)
|
|
996 {
|
|
997 /* This function can GC */
|
|
998 while (1)
|
|
999 {
|
|
1000 Lisp_Object tem = indirect_function (object, 0);
|
185
|
1001
|
0
|
1002 if (KEYMAPP (tem))
|
|
1003 return tem;
|
|
1004 /* Should we do an autoload? */
|
|
1005 else if (autoload
|
|
1006 /* (autoload "filename" doc nil keymap) */
|
|
1007 && SYMBOLP (object)
|
|
1008 && CONSP (tem)
|
|
1009 && EQ (XCAR (tem), Qautoload)
|
|
1010 && EQ (Fcar (Fcdr (Fcdr (Fcdr (Fcdr (tem))))), Qkeymap))
|
|
1011 {
|
|
1012 struct gcpro gcpro1, gcpro2;
|
|
1013 GCPRO2 (tem, object);
|
|
1014 do_autoload (tem, object);
|
|
1015 UNGCPRO;
|
|
1016 }
|
|
1017 else if (errorp)
|
|
1018 object = wrong_type_argument (Qkeymapp, object);
|
|
1019 else
|
|
1020 return Qnil;
|
|
1021 }
|
|
1022 }
|
|
1023
|
|
1024 /* Given OBJECT which was found in a slot in a keymap,
|
|
1025 trace indirect definitions to get the actual definition of that slot.
|
|
1026 An indirect definition is a list of the form
|
|
1027 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
|
|
1028 and INDEX is an ASCII code, or a cons of (KEYSYM . MODIFIERS).
|
|
1029 */
|
|
1030 static Lisp_Object
|
|
1031 get_keyelt (Lisp_Object object, int accept_default)
|
|
1032 {
|
|
1033 /* This function can GC */
|
|
1034 Lisp_Object map;
|
|
1035
|
|
1036 tail_recurse:
|
|
1037 if (!CONSP (object))
|
173
|
1038 return object;
|
0
|
1039
|
|
1040 {
|
|
1041 struct gcpro gcpro1;
|
|
1042 GCPRO1 (object);
|
|
1043 map = XCAR (object);
|
|
1044 map = get_keymap (map, 0, 1);
|
|
1045 UNGCPRO;
|
|
1046 }
|
|
1047 /* If the contents are (KEYMAP . ELEMENT), go indirect. */
|
|
1048 if (!NILP (map))
|
|
1049 {
|
|
1050 Lisp_Object idx = Fcdr (object);
|
|
1051 struct key_data indirection;
|
|
1052 if (CHARP (idx))
|
|
1053 {
|
412
|
1054 struct Lisp_Event event;
|
0
|
1055 event.event_type = empty_event;
|
|
1056 character_to_event (XCHAR (idx), &event,
|
263
|
1057 XCONSOLE (Vselected_console), 0, 0);
|
0
|
1058 indirection = event.event.key;
|
|
1059 }
|
|
1060 else if (CONSP (idx))
|
|
1061 {
|
|
1062 if (!INTP (XCDR (idx)))
|
173
|
1063 return Qnil;
|
0
|
1064 indirection.keysym = XCAR (idx);
|
412
|
1065 indirection.modifiers = XINT (XCDR (idx));
|
0
|
1066 }
|
|
1067 else if (SYMBOLP (idx))
|
|
1068 {
|
|
1069 indirection.keysym = idx;
|
|
1070 indirection.modifiers = 0;
|
|
1071 }
|
|
1072 else
|
|
1073 {
|
|
1074 /* Random junk */
|
173
|
1075 return Qnil;
|
0
|
1076 }
|
173
|
1077 return raw_lookup_key (map, &indirection, 1, 0, accept_default);
|
0
|
1078 }
|
|
1079 else if (STRINGP (XCAR (object)))
|
|
1080 {
|
|
1081 /* If the keymap contents looks like (STRING . DEFN),
|
|
1082 use DEFN.
|
|
1083 Keymap alist elements like (CHAR MENUSTRING . DEFN)
|
|
1084 will be used by HierarKey menus. */
|
|
1085 object = XCDR (object);
|
|
1086 goto tail_recurse;
|
|
1087 }
|
|
1088 else
|
|
1089 {
|
|
1090 /* Anything else is really the value. */
|
173
|
1091 return object;
|
0
|
1092 }
|
|
1093 }
|
|
1094
|
|
1095 static Lisp_Object
|
412
|
1096 keymap_lookup_1 (Lisp_Object keymap, CONST struct key_data *key,
|
0
|
1097 int accept_default)
|
|
1098 {
|
|
1099 /* This function can GC */
|
173
|
1100 return get_keyelt (keymap_lookup_directly (keymap,
|
|
1101 key->keysym, key->modifiers),
|
|
1102 accept_default);
|
0
|
1103 }
|
|
1104
|
|
1105
|
|
1106 /************************************************************************/
|
|
1107 /* Copying keymaps */
|
|
1108 /************************************************************************/
|
|
1109
|
|
1110 struct copy_keymap_inverse_closure
|
|
1111 {
|
|
1112 Lisp_Object inverse_table;
|
|
1113 };
|
|
1114
|
241
|
1115 static int
|
380
|
1116 copy_keymap_inverse_mapper (Lisp_Object key, Lisp_Object value,
|
0
|
1117 void *copy_keymap_inverse_closure)
|
|
1118 {
|
185
|
1119 struct copy_keymap_inverse_closure *closure =
|
|
1120 (struct copy_keymap_inverse_closure *) copy_keymap_inverse_closure;
|
0
|
1121
|
|
1122 /* copy-sequence deals with dotted lists. */
|
380
|
1123 if (CONSP (value))
|
|
1124 value = Fcopy_list (value);
|
|
1125 Fputhash (key, value, closure->inverse_table);
|
241
|
1126
|
|
1127 return 0;
|
0
|
1128 }
|
|
1129
|
|
1130
|
|
1131 static Lisp_Object
|
380
|
1132 copy_keymap_internal (Lisp_Keymap *keymap)
|
0
|
1133 {
|
|
1134 Lisp_Object nkm = make_keymap (0);
|
380
|
1135 Lisp_Keymap *new_keymap = XKEYMAP (nkm);
|
0
|
1136 struct copy_keymap_inverse_closure copy_keymap_inverse_closure;
|
|
1137 copy_keymap_inverse_closure.inverse_table = keymap->inverse_table;
|
|
1138
|
380
|
1139 new_keymap->parents = Fcopy_sequence (keymap->parents);
|
412
|
1140 new_keymap->fullness = keymap->fullness;
|
0
|
1141 new_keymap->sub_maps_cache = Qnil; /* No submaps */
|
380
|
1142 new_keymap->table = Fcopy_hash_table (keymap->table);
|
|
1143 new_keymap->inverse_table = Fcopy_hash_table (keymap->inverse_table);
|
422
|
1144 new_keymap->default_binding = keymap->default_binding;
|
0
|
1145 /* After copying the inverse map, we need to copy the conses which
|
|
1146 are its values, lest they be shared by the copy, and mangled.
|
|
1147 */
|
|
1148 elisp_maphash (copy_keymap_inverse_mapper, keymap->inverse_table,
|
|
1149 ©_keymap_inverse_closure);
|
|
1150 return nkm;
|
|
1151 }
|
|
1152
|
|
1153
|
|
1154 static Lisp_Object copy_keymap (Lisp_Object keymap);
|
|
1155
|
|
1156 struct copy_keymap_closure
|
|
1157 {
|
380
|
1158 Lisp_Keymap *self;
|
0
|
1159 };
|
|
1160
|
241
|
1161 static int
|
380
|
1162 copy_keymap_mapper (Lisp_Object key, Lisp_Object value,
|
0
|
1163 void *copy_keymap_closure)
|
|
1164 {
|
|
1165 /* This function can GC */
|
185
|
1166 struct copy_keymap_closure *closure =
|
|
1167 (struct copy_keymap_closure *) copy_keymap_closure;
|
0
|
1168
|
|
1169 /* When we encounter a keymap which is indirected through a
|
|
1170 symbol, we need to copy the sub-map. In v18, the form
|
|
1171 (lookup-key (copy-keymap global-map) "\C-x")
|
|
1172 returned a new keymap, not the symbol 'Control-X-prefix.
|
|
1173 */
|
380
|
1174 value = get_keymap (value, 0, 1); /* #### autoload GC-safe here? */
|
|
1175 if (KEYMAPP (value))
|
0
|
1176 keymap_store_internal (key, closure->self,
|
380
|
1177 copy_keymap (value));
|
241
|
1178 return 0;
|
0
|
1179 }
|
|
1180
|
|
1181 static Lisp_Object
|
|
1182 copy_keymap (Lisp_Object keymap)
|
|
1183 {
|
|
1184 /* This function can GC */
|
|
1185 struct copy_keymap_closure copy_keymap_closure;
|
|
1186
|
|
1187 keymap = copy_keymap_internal (XKEYMAP (keymap));
|
|
1188 copy_keymap_closure.self = XKEYMAP (keymap);
|
|
1189 elisp_maphash (copy_keymap_mapper,
|
|
1190 XKEYMAP (keymap)->table,
|
|
1191 ©_keymap_closure);
|
|
1192 return keymap;
|
|
1193 }
|
|
1194
|
20
|
1195 DEFUN ("copy-keymap", Fcopy_keymap, 1, 1, 0, /*
|
0
|
1196 Return a copy of the keymap KEYMAP.
|
|
1197 The copy starts out with the same definitions of KEYMAP,
|
|
1198 but changing either the copy or KEYMAP does not affect the other.
|
|
1199 Any key definitions that are subkeymaps are recursively copied.
|
20
|
1200 */
|
|
1201 (keymap))
|
0
|
1202 {
|
|
1203 /* This function can GC */
|
|
1204 keymap = get_keymap (keymap, 1, 1);
|
|
1205 return copy_keymap (keymap);
|
|
1206 }
|
|
1207
|
|
1208
|
|
1209 static int
|
|
1210 keymap_fullness (Lisp_Object keymap)
|
|
1211 {
|
|
1212 /* This function can GC */
|
|
1213 int fullness;
|
|
1214 Lisp_Object sub_maps;
|
|
1215 struct gcpro gcpro1, gcpro2;
|
|
1216
|
|
1217 keymap = get_keymap (keymap, 1, 1);
|
412
|
1218 fullness = XKEYMAP (keymap)->fullness;
|
|
1219 sub_maps = keymap_submaps (keymap);
|
0
|
1220 GCPRO2 (keymap, sub_maps);
|
412
|
1221 for (; !NILP (sub_maps); sub_maps = XCDR (sub_maps))
|
0
|
1222 {
|
|
1223 if (MODIFIER_HASH_KEY_BITS (XCAR (XCAR (sub_maps))) != 0)
|
|
1224 {
|
412
|
1225 Lisp_Object sub_map = XCDR (XCAR (sub_maps));
|
|
1226 fullness--; /* don't count bucky maps */
|
|
1227 fullness += keymap_fullness (sub_map);
|
0
|
1228 }
|
|
1229 }
|
|
1230 UNGCPRO;
|
173
|
1231 return fullness;
|
0
|
1232 }
|
|
1233
|
20
|
1234 DEFUN ("keymap-fullness", Fkeymap_fullness, 1, 1, 0, /*
|
0
|
1235 Return the number of bindings in the keymap.
|
20
|
1236 */
|
|
1237 (keymap))
|
0
|
1238 {
|
|
1239 /* This function can GC */
|
173
|
1240 return make_int (keymap_fullness (get_keymap (keymap, 1, 1)));
|
0
|
1241 }
|
|
1242
|
|
1243
|
|
1244 /************************************************************************/
|
|
1245 /* Defining keys in keymaps */
|
|
1246 /************************************************************************/
|
|
1247
|
70
|
1248 /* Given a keysym (should be a symbol, int, char), make sure it's valid
|
|
1249 and perform any necessary canonicalization. */
|
|
1250
|
0
|
1251 static void
|
70
|
1252 define_key_check_and_coerce_keysym (Lisp_Object spec,
|
|
1253 Lisp_Object *keysym,
|
412
|
1254 unsigned int modifiers)
|
0
|
1255 {
|
|
1256 /* Now, check and massage the trailing keysym specifier. */
|
8
|
1257 if (SYMBOLP (*keysym))
|
0
|
1258 {
|
70
|
1259 if (string_char_length (XSYMBOL (*keysym)->name) == 1)
|
0
|
1260 {
|
70
|
1261 Lisp_Object ream_gcc_up_the_ass =
|
|
1262 make_char (string_char (XSYMBOL (*keysym)->name, 0));
|
|
1263 *keysym = ream_gcc_up_the_ass;
|
0
|
1264 goto fixnum_keysym;
|
|
1265 }
|
|
1266 }
|
70
|
1267 else if (CHAR_OR_CHAR_INTP (*keysym))
|
0
|
1268 {
|
70
|
1269 CHECK_CHAR_COERCE_INT (*keysym);
|
0
|
1270 fixnum_keysym:
|
70
|
1271 if (XCHAR (*keysym) < ' '
|
|
1272 /* || (XCHAR (*keysym) >= 128 && XCHAR (*keysym) < 160) */)
|
|
1273 /* yuck! Can't make the above restriction; too many compatibility
|
|
1274 problems ... */
|
|
1275 signal_simple_error ("keysym char must be printable", *keysym);
|
0
|
1276 /* #### This bites! I want to be able to write (control shift a) */
|
412
|
1277 if (modifiers & MOD_SHIFT)
|
70
|
1278 signal_simple_error
|
380
|
1279 ("The `shift' modifier may not be applied to ASCII keysyms",
|
70
|
1280 spec);
|
0
|
1281 }
|
|
1282 else
|
|
1283 {
|
412
|
1284 signal_simple_error ("Unknown keysym specifier",
|
|
1285 *keysym);
|
8
|
1286 }
|
|
1287
|
|
1288 if (SYMBOLP (*keysym))
|
|
1289 {
|
412
|
1290 char *name = (char *)
|
|
1291 string_data (XSYMBOL (*keysym)->name);
|
8
|
1292
|
70
|
1293 /* FSFmacs uses symbols with the printed representation of keysyms in
|
|
1294 their names, like 'M-x, and we use the syntax '(meta x). So, to avoid
|
|
1295 confusion, notice the M-x syntax and signal an error - because
|
|
1296 otherwise it would be interpreted as a regular keysym, and would even
|
|
1297 show up in the list-buffers output, causing confusion to the naive.
|
|
1298
|
|
1299 We can get away with this because none of the X keysym names contain
|
|
1300 a hyphen (some contain underscore, however).
|
|
1301
|
|
1302 It might be useful to reject keysyms which are not x-valid-keysym-
|
|
1303 name-p, but that would interfere with various tricks we do to
|
|
1304 sanitize the Sun keyboards, and would make it trickier to
|
|
1305 conditionalize a .emacs file for multiple X servers.
|
|
1306 */
|
|
1307 if (((int) strlen (name) >= 2 && name[1] == '-')
|
|
1308 #if 1
|
|
1309 ||
|
|
1310 /* Ok, this is a bit more dubious - prevent people from doing things
|
|
1311 like (global-set-key 'RET 'something) because that will have the
|
|
1312 same problem as above. (Gag!) Maybe we should just silently
|
|
1313 accept these as aliases for the "real" names?
|
|
1314 */
|
185
|
1315 (string_length (XSYMBOL (*keysym)->name) <= 3 &&
|
70
|
1316 (!strcmp (name, "LFD") ||
|
|
1317 !strcmp (name, "TAB") ||
|
|
1318 !strcmp (name, "RET") ||
|
|
1319 !strcmp (name, "ESC") ||
|
|
1320 !strcmp (name, "DEL") ||
|
|
1321 !strcmp (name, "SPC") ||
|
|
1322 !strcmp (name, "BS")))
|
|
1323 #endif /* unused */
|
|
1324 )
|
|
1325 signal_simple_error
|
|
1326 ("Invalid (FSF Emacs) key format (see doc of define-key)",
|
|
1327 *keysym);
|
|
1328
|
|
1329 /* #### Ok, this is a bit more dubious - make people not lose if they
|
|
1330 do things like (global-set-key 'RET 'something) because that would
|
|
1331 otherwise have the same problem as above. (Gag!) We silently
|
|
1332 accept these as aliases for the "real" names.
|
|
1333 */
|
74
|
1334 else if (!strncmp(name, "kp_", 3)) {
|
|
1335 /* Likewise, the obsolete keysym binding of kp_.* should not lose. */
|
|
1336 char temp[50];
|
|
1337
|
|
1338 strncpy(temp, name, sizeof (temp));
|
|
1339 temp[sizeof (temp) - 1] = '\0';
|
|
1340 temp[2] = '-';
|
76
|
1341 *keysym = Fintern_soft(make_string((Bufbyte *)temp,
|
|
1342 strlen(temp)),
|
|
1343 Qnil);
|
74
|
1344 } else if (EQ (*keysym, QLFD))
|
70
|
1345 *keysym = QKlinefeed;
|
|
1346 else if (EQ (*keysym, QTAB))
|
|
1347 *keysym = QKtab;
|
|
1348 else if (EQ (*keysym, QRET))
|
|
1349 *keysym = QKreturn;
|
|
1350 else if (EQ (*keysym, QESC))
|
|
1351 *keysym = QKescape;
|
|
1352 else if (EQ (*keysym, QDEL))
|
|
1353 *keysym = QKdelete;
|
|
1354 else if (EQ (*keysym, QBS))
|
|
1355 *keysym = QKbackspace;
|
98
|
1356 /* Emacs compatibility */
|
|
1357 else if (EQ(*keysym, Qdown_mouse_1))
|
|
1358 *keysym = Qbutton1;
|
|
1359 else if (EQ(*keysym, Qdown_mouse_2))
|
|
1360 *keysym = Qbutton2;
|
|
1361 else if (EQ(*keysym, Qdown_mouse_3))
|
|
1362 *keysym = Qbutton3;
|
265
|
1363 else if (EQ(*keysym, Qdown_mouse_4))
|
|
1364 *keysym = Qbutton4;
|
|
1365 else if (EQ(*keysym, Qdown_mouse_5))
|
|
1366 *keysym = Qbutton5;
|
98
|
1367 else if (EQ(*keysym, Qmouse_1))
|
|
1368 *keysym = Qbutton1up;
|
|
1369 else if (EQ(*keysym, Qmouse_2))
|
|
1370 *keysym = Qbutton2up;
|
|
1371 else if (EQ(*keysym, Qmouse_3))
|
|
1372 *keysym = Qbutton3up;
|
265
|
1373 else if (EQ(*keysym, Qmouse_4))
|
|
1374 *keysym = Qbutton4up;
|
|
1375 else if (EQ(*keysym, Qmouse_5))
|
|
1376 *keysym = Qbutton5up;
|
0
|
1377 }
|
|
1378 }
|
|
1379
|
70
|
1380
|
0
|
1381 /* Given any kind of key-specifier, return a keysym and modifier mask.
|
70
|
1382 Proper canonicalization is performed:
|
|
1383
|
|
1384 -- integers are converted into the equivalent characters.
|
|
1385 -- one-character strings are converted into the equivalent characters.
|
0
|
1386 */
|
70
|
1387
|
0
|
1388 static void
|
|
1389 define_key_parser (Lisp_Object spec, struct key_data *returned_value)
|
|
1390 {
|
70
|
1391 if (CHAR_OR_CHAR_INTP (spec))
|
0
|
1392 {
|
412
|
1393 struct Lisp_Event event;
|
0
|
1394 event.event_type = empty_event;
|
70
|
1395 character_to_event (XCHAR_OR_CHAR_INT (spec), &event,
|
263
|
1396 XCONSOLE (Vselected_console), 0, 0);
|
185
|
1397 returned_value->keysym = event.event.key.keysym;
|
0
|
1398 returned_value->modifiers = event.event.key.modifiers;
|
|
1399 }
|
|
1400 else if (EVENTP (spec))
|
|
1401 {
|
|
1402 switch (XEVENT (spec)->event_type)
|
|
1403 {
|
|
1404 case key_press_event:
|
|
1405 {
|
185
|
1406 returned_value->keysym = XEVENT (spec)->event.key.keysym;
|
0
|
1407 returned_value->modifiers = XEVENT (spec)->event.key.modifiers;
|
|
1408 break;
|
|
1409 }
|
|
1410 case button_press_event:
|
|
1411 case button_release_event:
|
|
1412 {
|
|
1413 int down = (XEVENT (spec)->event_type == button_press_event);
|
|
1414 switch (XEVENT (spec)->event.button.button)
|
|
1415 {
|
|
1416 case 1:
|
|
1417 returned_value->keysym = (down ? Qbutton1 : Qbutton1up); break;
|
|
1418 case 2:
|
|
1419 returned_value->keysym = (down ? Qbutton2 : Qbutton2up); break;
|
|
1420 case 3:
|
|
1421 returned_value->keysym = (down ? Qbutton3 : Qbutton3up); break;
|
|
1422 case 4:
|
|
1423 returned_value->keysym = (down ? Qbutton4 : Qbutton4up); break;
|
|
1424 case 5:
|
|
1425 returned_value->keysym = (down ? Qbutton5 : Qbutton5up); break;
|
|
1426 case 6:
|
|
1427 returned_value->keysym = (down ? Qbutton6 : Qbutton6up); break;
|
|
1428 case 7:
|
|
1429 returned_value->keysym = (down ? Qbutton7 : Qbutton7up); break;
|
|
1430 default:
|
185
|
1431 returned_value->keysym = (down ? Qbutton0 : Qbutton0up); break;
|
0
|
1432 }
|
|
1433 returned_value->modifiers = XEVENT (spec)->event.button.modifiers;
|
|
1434 break;
|
|
1435 }
|
|
1436 default:
|
|
1437 signal_error (Qwrong_type_argument,
|
|
1438 list2 (build_translated_string
|
|
1439 ("unable to bind this type of event"),
|
|
1440 spec));
|
|
1441 }
|
|
1442 }
|
|
1443 else if (SYMBOLP (spec))
|
|
1444 {
|
|
1445 /* Be nice, allow = to mean (=) */
|
|
1446 if (bucky_sym_to_bucky_bit (spec) != 0)
|
|
1447 signal_simple_error ("Key is a modifier name", spec);
|
70
|
1448 define_key_check_and_coerce_keysym (spec, &spec, 0);
|
0
|
1449 returned_value->keysym = spec;
|
|
1450 returned_value->modifiers = 0;
|
|
1451 }
|
|
1452 else if (CONSP (spec))
|
|
1453 {
|
412
|
1454 unsigned int modifiers = 0;
|
0
|
1455 Lisp_Object keysym = Qnil;
|
|
1456 Lisp_Object rest = spec;
|
|
1457
|
|
1458 /* First, parse out the leading modifier symbols. */
|
|
1459 while (CONSP (rest))
|
|
1460 {
|
412
|
1461 unsigned int modifier;
|
0
|
1462
|
|
1463 keysym = XCAR (rest);
|
|
1464 modifier = bucky_sym_to_bucky_bit (keysym);
|
|
1465 modifiers |= modifier;
|
|
1466 if (!NILP (XCDR (rest)))
|
|
1467 {
|
|
1468 if (! modifier)
|
380
|
1469 signal_simple_error ("Unknown modifier", keysym);
|
0
|
1470 }
|
|
1471 else
|
|
1472 {
|
|
1473 if (modifier)
|
380
|
1474 signal_simple_error ("Nothing but modifiers here",
|
0
|
1475 spec);
|
|
1476 }
|
|
1477 rest = XCDR (rest);
|
|
1478 QUIT;
|
|
1479 }
|
|
1480 if (!NILP (rest))
|
380
|
1481 signal_simple_error ("List must be nil-terminated", spec);
|
0
|
1482
|
70
|
1483 define_key_check_and_coerce_keysym (spec, &keysym, modifiers);
|
0
|
1484 returned_value->keysym = keysym;
|
|
1485 returned_value->modifiers = modifiers;
|
|
1486 }
|
|
1487 else
|
|
1488 {
|
380
|
1489 signal_simple_error ("Unknown key-sequence specifier",
|
0
|
1490 spec);
|
|
1491 }
|
|
1492 }
|
|
1493
|
|
1494 /* Used by character-to-event */
|
|
1495 void
|
|
1496 key_desc_list_to_event (Lisp_Object list, Lisp_Object event,
|
|
1497 int allow_menu_events)
|
|
1498 {
|
|
1499 struct key_data raw_key;
|
|
1500
|
|
1501 if (allow_menu_events &&
|
|
1502 CONSP (list) &&
|
|
1503 /* #### where the hell does this come from? */
|
|
1504 EQ (XCAR (list), Qmenu_selection))
|
|
1505 {
|
|
1506 Lisp_Object fn, arg;
|
|
1507 if (! NILP (Fcdr (Fcdr (list))))
|
380
|
1508 signal_simple_error ("Invalid menu event desc", list);
|
0
|
1509 arg = Fcar (Fcdr (list));
|
|
1510 if (SYMBOLP (arg))
|
|
1511 fn = Qcall_interactively;
|
|
1512 else
|
|
1513 fn = Qeval;
|
|
1514 XSETFRAME (XEVENT (event)->channel, selected_frame ());
|
|
1515 XEVENT (event)->event_type = misc_user_event;
|
|
1516 XEVENT (event)->event.eval.function = fn;
|
|
1517 XEVENT (event)->event.eval.object = arg;
|
|
1518 return;
|
|
1519 }
|
|
1520
|
|
1521 define_key_parser (list, &raw_key);
|
|
1522
|
|
1523 if (EQ (raw_key.keysym, Qbutton0) || EQ (raw_key.keysym, Qbutton0up) ||
|
|
1524 EQ (raw_key.keysym, Qbutton1) || EQ (raw_key.keysym, Qbutton1up) ||
|
|
1525 EQ (raw_key.keysym, Qbutton2) || EQ (raw_key.keysym, Qbutton2up) ||
|
|
1526 EQ (raw_key.keysym, Qbutton3) || EQ (raw_key.keysym, Qbutton3up) ||
|
|
1527 EQ (raw_key.keysym, Qbutton4) || EQ (raw_key.keysym, Qbutton4up) ||
|
|
1528 EQ (raw_key.keysym, Qbutton5) || EQ (raw_key.keysym, Qbutton5up) ||
|
|
1529 EQ (raw_key.keysym, Qbutton6) || EQ (raw_key.keysym, Qbutton6up) ||
|
282
|
1530 EQ (raw_key.keysym, Qbutton7) || EQ (raw_key.keysym, Qbutton7up))
|
0
|
1531 error ("Mouse-clicks can't appear in saved keyboard macros.");
|
|
1532
|
|
1533 XEVENT (event)->channel = Vselected_console;
|
|
1534 XEVENT (event)->event_type = key_press_event;
|
|
1535 XEVENT (event)->event.key.keysym = raw_key.keysym;
|
|
1536 XEVENT (event)->event.key.modifiers = raw_key.modifiers;
|
|
1537 }
|
|
1538
|
|
1539
|
|
1540 int
|
412
|
1541 event_matches_key_specifier_p (struct Lisp_Event *event,
|
|
1542 Lisp_Object key_specifier)
|
0
|
1543 {
|
371
|
1544 Lisp_Object event2;
|
0
|
1545 int retval;
|
|
1546 struct gcpro gcpro1;
|
|
1547
|
|
1548 if (event->event_type != key_press_event || NILP (key_specifier) ||
|
70
|
1549 (INTP (key_specifier) && !CHAR_INTP (key_specifier)))
|
0
|
1550 return 0;
|
|
1551
|
|
1552 /* if the specifier is an integer such as 27, then it should match
|
|
1553 both of the events 'escape' and 'control ['. Calling
|
|
1554 Fcharacter_to_event() will only match 'escape'. */
|
70
|
1555 if (CHAR_OR_CHAR_INTP (key_specifier))
|
|
1556 return (XCHAR_OR_CHAR_INT (key_specifier)
|
|
1557 == event_to_character (event, 0, 0, 0));
|
0
|
1558
|
|
1559 /* Otherwise, we cannot call event_to_character() because we may
|
|
1560 be dealing with non-ASCII keystrokes. In any case, if I ask
|
|
1561 for 'control [' then I should get exactly that, and not
|
|
1562 'escape'.
|
|
1563
|
|
1564 However, we have to behave differently on TTY's, where 'control ['
|
|
1565 is silently converted into 'escape' by the keyboard driver.
|
|
1566 In this case, ASCII is the only thing we know about, so we have
|
|
1567 to compare the ASCII values. */
|
|
1568
|
|
1569 GCPRO1 (event2);
|
189
|
1570 event2 = Fmake_event (Qnil, Qnil);
|
0
|
1571 Fcharacter_to_event (key_specifier, event2, Qnil, Qnil);
|
|
1572 if (XEVENT (event2)->event_type != key_press_event)
|
|
1573 retval = 0;
|
|
1574 else if (CONSOLE_TTY_P (XCONSOLE (EVENT_CHANNEL (event))))
|
|
1575 {
|
|
1576 int ch1, ch2;
|
|
1577
|
|
1578 ch1 = event_to_character (event, 0, 0, 0);
|
|
1579 ch2 = event_to_character (XEVENT (event2), 0, 0, 0);
|
|
1580 retval = (ch1 >= 0 && ch2 >= 0 && ch1 == ch2);
|
|
1581 }
|
|
1582 else if (EQ (event->event.key.keysym, XEVENT (event2)->event.key.keysym) &&
|
|
1583 event->event.key.modifiers == XEVENT (event2)->event.key.modifiers)
|
|
1584 retval = 1;
|
|
1585 else
|
|
1586 retval = 0;
|
|
1587 Fdeallocate_event (event2);
|
|
1588 UNGCPRO;
|
|
1589 return retval;
|
|
1590 }
|
|
1591
|
|
1592 static int
|
412
|
1593 meta_prefix_char_p (CONST struct key_data *key)
|
0
|
1594 {
|
412
|
1595 struct Lisp_Event event;
|
0
|
1596
|
|
1597 event.event_type = key_press_event;
|
|
1598 event.channel = Vselected_console;
|
|
1599 event.event.key.keysym = key->keysym;
|
|
1600 event.event.key.modifiers = key->modifiers;
|
|
1601 return event_matches_key_specifier_p (&event, Vmeta_prefix_char);
|
|
1602 }
|
|
1603
|
20
|
1604 DEFUN ("event-matches-key-specifier-p", Fevent_matches_key_specifier_p, 2, 2, 0, /*
|
0
|
1605 Return non-nil if EVENT matches KEY-SPECIFIER.
|
|
1606 This can be useful, e.g., to determine if the user pressed `help-char' or
|
|
1607 `quit-char'.
|
20
|
1608 */
|
|
1609 (event, key_specifier))
|
0
|
1610 {
|
|
1611 CHECK_LIVE_EVENT (event);
|
|
1612 return (event_matches_key_specifier_p (XEVENT (event), key_specifier)
|
|
1613 ? Qt : Qnil);
|
|
1614 }
|
|
1615
|
380
|
1616 #define MACROLET(k,m) do { \
|
|
1617 returned_value->keysym = (k); \
|
|
1618 returned_value->modifiers = (m); \
|
|
1619 RETURN_SANS_WARNINGS; \
|
|
1620 } while (0)
|
|
1621
|
0
|
1622 /* ASCII grunge.
|
185
|
1623 Given a keysym, return another keysym/modifier pair which could be
|
|
1624 considered the same key in an ASCII world. Backspace returns ^H, for
|
0
|
1625 example.
|
|
1626 */
|
|
1627 static void
|
|
1628 define_key_alternate_name (struct key_data *key,
|
|
1629 struct key_data *returned_value)
|
|
1630 {
|
|
1631 Lisp_Object keysym = key->keysym;
|
412
|
1632 unsigned int modifiers = key->modifiers;
|
|
1633 unsigned int modifiers_sans_control = (modifiers & (~MOD_CONTROL));
|
|
1634 unsigned int modifiers_sans_meta = (modifiers & (~MOD_META));
|
0
|
1635 returned_value->keysym = Qnil; /* By default, no "alternate" key */
|
|
1636 returned_value->modifiers = 0;
|
412
|
1637 if (modifiers_sans_meta == MOD_CONTROL)
|
0
|
1638 {
|
|
1639 if EQ (keysym, QKspace)
|
|
1640 MACROLET (make_char ('@'), modifiers);
|
|
1641 else if (!CHARP (keysym))
|
|
1642 return;
|
|
1643 else switch (XCHAR (keysym))
|
|
1644 {
|
|
1645 case '@': /* c-@ => c-space */
|
|
1646 MACROLET (QKspace, modifiers);
|
|
1647 case 'h': /* c-h => backspace */
|
|
1648 MACROLET (QKbackspace, modifiers_sans_control);
|
|
1649 case 'i': /* c-i => tab */
|
|
1650 MACROLET (QKtab, modifiers_sans_control);
|
|
1651 case 'j': /* c-j => linefeed */
|
|
1652 MACROLET (QKlinefeed, modifiers_sans_control);
|
|
1653 case 'm': /* c-m => return */
|
|
1654 MACROLET (QKreturn, modifiers_sans_control);
|
|
1655 case '[': /* c-[ => escape */
|
|
1656 MACROLET (QKescape, modifiers_sans_control);
|
|
1657 default:
|
|
1658 return;
|
|
1659 }
|
|
1660 }
|
|
1661 else if (modifiers_sans_meta != 0)
|
|
1662 return;
|
|
1663 else if (EQ (keysym, QKbackspace)) /* backspace => c-h */
|
412
|
1664 MACROLET (make_char ('h'), (modifiers | MOD_CONTROL));
|
0
|
1665 else if (EQ (keysym, QKtab)) /* tab => c-i */
|
412
|
1666 MACROLET (make_char ('i'), (modifiers | MOD_CONTROL));
|
0
|
1667 else if (EQ (keysym, QKlinefeed)) /* linefeed => c-j */
|
412
|
1668 MACROLET (make_char ('j'), (modifiers | MOD_CONTROL));
|
0
|
1669 else if (EQ (keysym, QKreturn)) /* return => c-m */
|
412
|
1670 MACROLET (make_char ('m'), (modifiers | MOD_CONTROL));
|
0
|
1671 else if (EQ (keysym, QKescape)) /* escape => c-[ */
|
412
|
1672 MACROLET (make_char ('['), (modifiers | MOD_CONTROL));
|
0
|
1673 else
|
|
1674 return;
|
|
1675 #undef MACROLET
|
|
1676 }
|
|
1677
|
|
1678
|
|
1679 static void
|
|
1680 ensure_meta_prefix_char_keymapp (Lisp_Object keys, int indx,
|
|
1681 Lisp_Object keymap)
|
|
1682 {
|
|
1683 /* This function can GC */
|
|
1684 Lisp_Object new_keys;
|
|
1685 int i;
|
|
1686 Lisp_Object mpc_binding;
|
|
1687 struct key_data meta_key;
|
|
1688
|
|
1689 if (NILP (Vmeta_prefix_char) ||
|
70
|
1690 (INTP (Vmeta_prefix_char) && !CHAR_INTP (Vmeta_prefix_char)))
|
0
|
1691 return;
|
|
1692
|
|
1693 define_key_parser (Vmeta_prefix_char, &meta_key);
|
|
1694 mpc_binding = keymap_lookup_1 (keymap, &meta_key, 0);
|
|
1695 if (NILP (mpc_binding) || !NILP (Fkeymapp (mpc_binding)))
|
|
1696 return;
|
|
1697
|
|
1698 if (indx == 0)
|
|
1699 new_keys = keys;
|
|
1700 else if (STRINGP (keys))
|
|
1701 new_keys = Fsubstring (keys, Qzero, make_int (indx));
|
|
1702 else if (VECTORP (keys))
|
|
1703 {
|
|
1704 new_keys = make_vector (indx, Qnil);
|
|
1705 for (i = 0; i < indx; i++)
|
173
|
1706 XVECTOR_DATA (new_keys) [i] = XVECTOR_DATA (keys) [i];
|
0
|
1707 }
|
|
1708 else
|
|
1709 abort ();
|
267
|
1710
|
0
|
1711 if (EQ (keys, new_keys))
|
267
|
1712 error_with_frob (mpc_binding,
|
|
1713 "can't bind %s: %s has a non-keymap binding",
|
|
1714 (char *) XSTRING_DATA (Fkey_description (keys)),
|
|
1715 (char *) XSTRING_DATA (Fsingle_key_description
|
|
1716 (Vmeta_prefix_char)));
|
0
|
1717 else
|
267
|
1718 error_with_frob (mpc_binding,
|
|
1719 "can't bind %s: %s %s has a non-keymap binding",
|
|
1720 (char *) XSTRING_DATA (Fkey_description (keys)),
|
|
1721 (char *) XSTRING_DATA (Fkey_description (new_keys)),
|
|
1722 (char *) XSTRING_DATA (Fsingle_key_description
|
|
1723 (Vmeta_prefix_char)));
|
0
|
1724 }
|
|
1725
|
20
|
1726 DEFUN ("define-key", Fdefine_key, 3, 3, 0, /*
|
0
|
1727 Define key sequence KEYS, in KEYMAP, as DEF.
|
|
1728 KEYMAP is a keymap object.
|
|
1729 KEYS is the sequence of keystrokes to bind, described below.
|
|
1730 DEF is anything that can be a key's definition:
|
|
1731 nil (means key is undefined in this keymap);
|
|
1732 a command (a Lisp function suitable for interactive calling);
|
|
1733 a string or key sequence vector (treated as a keyboard macro);
|
|
1734 a keymap (to define a prefix key);
|
|
1735 a symbol; when the key is looked up, the symbol will stand for its
|
|
1736 function definition, that should at that time be one of the above,
|
|
1737 or another symbol whose function definition is used, and so on.
|
|
1738 a cons (STRING . DEFN), meaning that DEFN is the definition
|
|
1739 (DEFN should be a valid definition in its own right);
|
|
1740 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.
|
|
1741
|
|
1742 Contrary to popular belief, the world is not ASCII. When running under a
|
|
1743 window manager, XEmacs can tell the difference between, for example, the
|
|
1744 keystrokes control-h, control-shift-h, and backspace. You can, in fact,
|
|
1745 bind different commands to each of these.
|
|
1746
|
|
1747 A `key sequence' is a set of keystrokes. A `keystroke' is a keysym and some
|
|
1748 set of modifiers (such as control and meta). A `keysym' is what is printed
|
|
1749 on the keys on your keyboard.
|
|
1750
|
|
1751 A keysym may be represented by a symbol, or (if and only if it is equivalent
|
|
1752 to an ASCII character in the range 32 - 255) by a character or its equivalent
|
|
1753 ASCII code. The `A' key may be represented by the symbol `A', the character
|
|
1754 `?A', or by the number 65. The `break' key may be represented only by the
|
|
1755 symbol `break'.
|
|
1756
|
|
1757 A keystroke may be represented by a list: the last element of the list
|
|
1758 is the key (a symbol, character, or number, as above) and the
|
|
1759 preceding elements are the symbolic names of modifier keys (control,
|
|
1760 meta, super, hyper, alt, and shift). Thus, the sequence control-b is
|
|
1761 represented by the forms `(control b)', `(control ?b)', and `(control
|
|
1762 98)'. A keystroke may also be represented by an event object, as
|
|
1763 returned by the `next-command-event' and `read-key-sequence'
|
|
1764 functions.
|
|
1765
|
|
1766 Note that in this context, the keystroke `control-b' is *not* represented
|
|
1767 by the number 2 (the ASCII code for ^B) or the character `?\^B'. See below.
|
|
1768
|
|
1769 The `shift' modifier is somewhat of a special case. You should not (and
|
|
1770 cannot) use `(meta shift a)' to mean `(meta A)', since for characters that
|
|
1771 have ASCII equivalents, the state of the shift key is implicit in the
|
|
1772 keysym (a vs. A). You also cannot say `(shift =)' to mean `+', as that
|
|
1773 sort of thing varies from keyboard to keyboard. The shift modifier is for
|
|
1774 use only with characters that do not have a second keysym on the same key,
|
|
1775 such as `backspace' and `tab'.
|
|
1776
|
|
1777 A key sequence is a vector of keystrokes. As a degenerate case, elements
|
|
1778 of this vector may also be keysyms if they have no modifiers. That is,
|
|
1779 the `A' keystroke is represented by all of these forms:
|
|
1780 A ?A 65 (A) (?A) (65)
|
|
1781 [A] [?A] [65] [(A)] [(?A)] [(65)]
|
185
|
1782
|
0
|
1783 the `control-a' keystroke is represented by these forms:
|
|
1784 (control A) (control ?A) (control 65)
|
|
1785 [(control A)] [(control ?A)] [(control 65)]
|
|
1786 the key sequence `control-c control-a' is represented by these forms:
|
|
1787 [(control c) (control a)] [(control ?c) (control ?a)]
|
|
1788 [(control 99) (control 65)] etc.
|
|
1789
|
|
1790 Mouse button clicks work just like keypresses: (control button1) means
|
|
1791 pressing the left mouse button while holding down the control key.
|
|
1792 \[(control c) (shift button3)] means control-c, hold shift, click right.
|
|
1793
|
|
1794 Commands may be bound to the mouse-button up-stroke rather than the down-
|
|
1795 stroke as well. `button1' means the down-stroke, and `button1up' means the
|
|
1796 up-stroke. Different commands may be bound to the up and down strokes,
|
|
1797 though that is probably not what you want, so be careful.
|
|
1798
|
|
1799 For backward compatibility, a key sequence may also be represented by a
|
|
1800 string. In this case, it represents the key sequence(s) that would
|
|
1801 produce that sequence of ASCII characters in a purely ASCII world. For
|
185
|
1802 example, a string containing the ASCII backspace character, "\\^H", would
|
0
|
1803 represent two key sequences: `(control h)' and `backspace'. Binding a
|
|
1804 command to this will actually bind both of those key sequences. Likewise
|
|
1805 for the following pairs:
|
|
1806
|
|
1807 control h backspace
|
|
1808 control i tab
|
|
1809 control m return
|
|
1810 control j linefeed
|
|
1811 control [ escape
|
|
1812 control @ control space
|
|
1813
|
|
1814 After binding a command to two key sequences with a form like
|
|
1815
|
185
|
1816 (define-key global-map "\\^X\\^I" \'command-1)
|
0
|
1817
|
|
1818 it is possible to redefine only one of those sequences like so:
|
|
1819
|
|
1820 (define-key global-map [(control x) (control i)] \'command-2)
|
|
1821 (define-key global-map [(control x) tab] \'command-3)
|
|
1822
|
|
1823 Of course, all of this applies only when running under a window system. If
|
|
1824 you're talking to XEmacs through a TTY connection, you don't get any of
|
|
1825 these features.
|
20
|
1826 */
|
|
1827 (keymap, keys, def))
|
0
|
1828 {
|
|
1829 /* This function can GC */
|
|
1830 int idx;
|
|
1831 int metized = 0;
|
173
|
1832 int len;
|
0
|
1833 int ascii_hack;
|
|
1834 struct gcpro gcpro1, gcpro2, gcpro3;
|
|
1835
|
|
1836 if (VECTORP (keys))
|
173
|
1837 len = XVECTOR_LENGTH (keys);
|
0
|
1838 else if (STRINGP (keys))
|
272
|
1839 len = XSTRING_CHAR_LENGTH (keys);
|
70
|
1840 else if (CHAR_OR_CHAR_INTP (keys) || SYMBOLP (keys) || CONSP (keys))
|
0
|
1841 {
|
|
1842 if (!CONSP (keys)) keys = list1 (keys);
|
173
|
1843 len = 1;
|
0
|
1844 keys = make_vector (1, keys); /* this is kinda sleazy. */
|
|
1845 }
|
|
1846 else
|
|
1847 {
|
|
1848 keys = wrong_type_argument (Qsequencep, keys);
|
173
|
1849 len = XINT (Flength (keys));
|
0
|
1850 }
|
173
|
1851 if (len == 0)
|
|
1852 return Qnil;
|
0
|
1853
|
|
1854 GCPRO3 (keymap, keys, def);
|
|
1855
|
|
1856 /* ASCII grunge.
|
|
1857 When the user defines a key which, in a strictly ASCII world, would be
|
|
1858 produced by two different keys (^J and linefeed, or ^H and backspace,
|
|
1859 for example) then the binding will be made for both keysyms.
|
|
1860
|
|
1861 This is done if the user binds a command to a string, as in
|
|
1862 (define-key map "\^H" 'something), but not when using one of the new
|
|
1863 syntaxes, like (define-key map '(control h) 'something).
|
|
1864 */
|
|
1865 ascii_hack = (STRINGP (keys));
|
|
1866
|
|
1867 keymap = get_keymap (keymap, 1, 1);
|
|
1868
|
|
1869 idx = 0;
|
|
1870 while (1)
|
|
1871 {
|
|
1872 Lisp_Object c;
|
|
1873 struct key_data raw_key1;
|
|
1874 struct key_data raw_key2;
|
|
1875
|
|
1876 if (STRINGP (keys))
|
|
1877 c = make_char (string_char (XSTRING (keys), idx));
|
|
1878 else
|
173
|
1879 c = XVECTOR_DATA (keys) [idx];
|
0
|
1880
|
|
1881 define_key_parser (c, &raw_key1);
|
|
1882
|
|
1883 if (!metized && ascii_hack && meta_prefix_char_p (&raw_key1))
|
|
1884 {
|
173
|
1885 if (idx == (len - 1))
|
0
|
1886 {
|
|
1887 /* This is a hack to prevent a binding for the meta-prefix-char
|
|
1888 from being made in a map which already has a non-empty "meta"
|
|
1889 submap. That is, we can't let both "escape" and "meta" have
|
|
1890 a binding in the same keymap. This implies that the idiom
|
|
1891 (define-key my-map "\e" my-escape-map)
|
|
1892 (define-key my-escape-map "a" 'my-command)
|
|
1893 no longer works. That's ok. Instead the luser should do
|
|
1894 (define-key my-map "\ea" 'my-command)
|
|
1895 or, more correctly
|
|
1896 (define-key my-map "\M-a" 'my-command)
|
|
1897 and then perhaps
|
|
1898 (defvar my-escape-map (lookup-key my-map "\e"))
|
|
1899 if the luser really wants the map in a variable.
|
|
1900 */
|
412
|
1901 Lisp_Object mmap;
|
0
|
1902 struct gcpro ngcpro1;
|
|
1903
|
|
1904 NGCPRO1 (c);
|
412
|
1905 mmap = Fgethash (MAKE_MODIFIER_HASH_KEY (MOD_META),
|
|
1906 XKEYMAP (keymap)->table, Qnil);
|
|
1907 if (!NILP (mmap)
|
|
1908 && keymap_fullness (mmap) != 0)
|
|
1909 {
|
|
1910 Lisp_Object desc
|
|
1911 = Fsingle_key_description (Vmeta_prefix_char);
|
|
1912 signal_simple_error_2
|
|
1913 ("Map contains meta-bindings, can't bind", desc, keymap);
|
|
1914 }
|
0
|
1915 NUNGCPRO;
|
|
1916 }
|
|
1917 else
|
|
1918 {
|
|
1919 metized = 1;
|
|
1920 idx++;
|
|
1921 continue;
|
|
1922 }
|
|
1923 }
|
|
1924
|
|
1925 if (ascii_hack)
|
|
1926 define_key_alternate_name (&raw_key1, &raw_key2);
|
|
1927 else
|
|
1928 {
|
|
1929 raw_key2.keysym = Qnil;
|
|
1930 raw_key2.modifiers = 0;
|
|
1931 }
|
185
|
1932
|
0
|
1933 if (metized)
|
|
1934 {
|
412
|
1935 raw_key1.modifiers |= MOD_META;
|
|
1936 raw_key2.modifiers |= MOD_META;
|
0
|
1937 metized = 0;
|
|
1938 }
|
|
1939
|
|
1940 /* This crap is to make sure that someone doesn't bind something like
|
|
1941 "C-x M-a" while "C-x ESC" has a non-keymap binding. */
|
412
|
1942 if (raw_key1.modifiers & MOD_META)
|
0
|
1943 ensure_meta_prefix_char_keymapp (keys, idx, keymap);
|
|
1944
|
173
|
1945 if (++idx == len)
|
0
|
1946 {
|
|
1947 keymap_store (keymap, &raw_key1, def);
|
|
1948 if (ascii_hack && !NILP (raw_key2.keysym))
|
|
1949 keymap_store (keymap, &raw_key2, def);
|
|
1950 UNGCPRO;
|
|
1951 return def;
|
|
1952 }
|
185
|
1953
|
0
|
1954 {
|
|
1955 Lisp_Object cmd;
|
|
1956 struct gcpro ngcpro1;
|
|
1957 NGCPRO1 (c);
|
|
1958
|
|
1959 cmd = keymap_lookup_1 (keymap, &raw_key1, 0);
|
|
1960 if (NILP (cmd))
|
|
1961 {
|
|
1962 cmd = Fmake_sparse_keymap (Qnil);
|
|
1963 XKEYMAP (cmd)->name /* for debugging */
|
|
1964 = list2 (make_key_description (&raw_key1, 1), keymap);
|
|
1965 keymap_store (keymap, &raw_key1, cmd);
|
|
1966 }
|
|
1967 if (NILP (Fkeymapp (cmd)))
|
380
|
1968 signal_simple_error_2 ("Invalid prefix keys in sequence",
|
0
|
1969 c, keys);
|
|
1970
|
|
1971 if (ascii_hack && !NILP (raw_key2.keysym) &&
|
|
1972 NILP (keymap_lookup_1 (keymap, &raw_key2, 0)))
|
|
1973 keymap_store (keymap, &raw_key2, cmd);
|
|
1974
|
|
1975 keymap = get_keymap (cmd, 1, 1);
|
|
1976 NUNGCPRO;
|
|
1977 }
|
|
1978 }
|
|
1979 }
|
|
1980
|
|
1981
|
|
1982 /************************************************************************/
|
|
1983 /* Looking up keys in keymaps */
|
|
1984 /************************************************************************/
|
|
1985
|
185
|
1986 /* We need a very fast (i.e., non-consing) version of lookup-key in order
|
2
|
1987 to make where-is-internal really fly. */
|
0
|
1988
|
|
1989 struct raw_lookup_key_mapper_closure
|
2
|
1990 {
|
|
1991 int remaining;
|
412
|
1992 CONST struct key_data *raw_keys;
|
2
|
1993 int raw_keys_count;
|
|
1994 int keys_so_far;
|
|
1995 int accept_default;
|
|
1996 };
|
0
|
1997
|
|
1998 static Lisp_Object raw_lookup_key_mapper (Lisp_Object k, void *);
|
|
1999
|
|
2000 /* Caller should gc-protect args (keymaps may autoload) */
|
|
2001 static Lisp_Object
|
|
2002 raw_lookup_key (Lisp_Object keymap,
|
412
|
2003 CONST struct key_data *raw_keys, int raw_keys_count,
|
0
|
2004 int keys_so_far, int accept_default)
|
|
2005 {
|
|
2006 /* This function can GC */
|
|
2007 struct raw_lookup_key_mapper_closure c;
|
|
2008 c.remaining = raw_keys_count - 1;
|
|
2009 c.raw_keys = raw_keys;
|
|
2010 c.raw_keys_count = raw_keys_count;
|
|
2011 c.keys_so_far = keys_so_far;
|
|
2012 c.accept_default = accept_default;
|
|
2013
|
173
|
2014 return traverse_keymaps (keymap, Qnil, raw_lookup_key_mapper, &c);
|
0
|
2015 }
|
|
2016
|
|
2017 static Lisp_Object
|
|
2018 raw_lookup_key_mapper (Lisp_Object k, void *arg)
|
|
2019 {
|
|
2020 /* This function can GC */
|
185
|
2021 struct raw_lookup_key_mapper_closure *c =
|
|
2022 (struct raw_lookup_key_mapper_closure *) arg;
|
0
|
2023 int accept_default = c->accept_default;
|
|
2024 int remaining = c->remaining;
|
|
2025 int keys_so_far = c->keys_so_far;
|
412
|
2026 CONST struct key_data *raw_keys = c->raw_keys;
|
0
|
2027 Lisp_Object cmd;
|
185
|
2028
|
0
|
2029 if (! meta_prefix_char_p (&(raw_keys[0])))
|
|
2030 {
|
|
2031 /* Normal case: every case except the meta-hack (see below). */
|
|
2032 cmd = keymap_lookup_1 (k, &(raw_keys[0]), accept_default);
|
185
|
2033
|
0
|
2034 if (remaining == 0)
|
|
2035 /* Return whatever we found if we're out of keys */
|
|
2036 ;
|
|
2037 else if (NILP (cmd))
|
|
2038 /* Found nothing (though perhaps parent map may have binding) */
|
|
2039 ;
|
|
2040 else if (NILP (Fkeymapp (cmd)))
|
|
2041 /* Didn't find a keymap, and we have more keys.
|
|
2042 * Return a fixnum to indicate that keys were too long.
|
|
2043 */
|
|
2044 cmd = make_int (keys_so_far + 1);
|
|
2045 else
|
185
|
2046 cmd = raw_lookup_key (cmd, raw_keys + 1, remaining,
|
0
|
2047 keys_so_far + 1, accept_default);
|
|
2048 }
|
|
2049 else
|
|
2050 {
|
|
2051 /* This is a hack so that looking up a key-sequence whose last
|
|
2052 * element is the meta-prefix-char will return the keymap that
|
|
2053 * the "meta" keys are stored in, if there is no binding for
|
|
2054 * the meta-prefix-char (and if this map has a "meta" submap).
|
380
|
2055 * If this map doesn't have a "meta" submap, then the
|
0
|
2056 * meta-prefix-char is looked up just like any other key.
|
|
2057 */
|
|
2058 if (remaining == 0)
|
|
2059 {
|
|
2060 /* First look for the prefix-char directly */
|
|
2061 cmd = keymap_lookup_1 (k, &(raw_keys[0]), accept_default);
|
|
2062 if (NILP (cmd))
|
|
2063 {
|
185
|
2064 /* Do kludgy return of the meta-map */
|
412
|
2065 cmd = Fgethash (MAKE_MODIFIER_HASH_KEY (MOD_META),
|
0
|
2066 XKEYMAP (k)->table, Qnil);
|
|
2067 }
|
|
2068 }
|
|
2069 else
|
|
2070 {
|
|
2071 /* Search for the prefix-char-prefixed sequence directly */
|
|
2072 cmd = keymap_lookup_1 (k, &(raw_keys[0]), accept_default);
|
|
2073 cmd = get_keymap (cmd, 0, 1);
|
|
2074 if (!NILP (cmd))
|
185
|
2075 cmd = raw_lookup_key (cmd, raw_keys + 1, remaining,
|
0
|
2076 keys_so_far + 1, accept_default);
|
412
|
2077 else if ((raw_keys[1].modifiers & MOD_META) == 0)
|
0
|
2078 {
|
|
2079 struct key_data metified;
|
|
2080 metified.keysym = raw_keys[1].keysym;
|
412
|
2081 metified.modifiers = raw_keys[1].modifiers | MOD_META;
|
0
|
2082
|
|
2083 /* Search for meta-next-char sequence directly */
|
|
2084 cmd = keymap_lookup_1 (k, &metified, accept_default);
|
|
2085 if (remaining == 1)
|
|
2086 ;
|
|
2087 else
|
|
2088 {
|
|
2089 cmd = get_keymap (cmd, 0, 1);
|
|
2090 if (!NILP (cmd))
|
|
2091 cmd = raw_lookup_key (cmd, raw_keys + 2, remaining - 1,
|
|
2092 keys_so_far + 2,
|
|
2093 accept_default);
|
|
2094 }
|
|
2095 }
|
|
2096 }
|
|
2097 }
|
|
2098 if (accept_default && NILP (cmd))
|
|
2099 cmd = XKEYMAP (k)->default_binding;
|
173
|
2100 return cmd;
|
0
|
2101 }
|
|
2102
|
|
2103 /* Value is number if `keys' is too long; NIL if valid but has no definition.*/
|
|
2104 /* Caller should gc-protect arguments */
|
|
2105 static Lisp_Object
|
|
2106 lookup_keys (Lisp_Object keymap, int nkeys, Lisp_Object *keys,
|
|
2107 int accept_default)
|
|
2108 {
|
|
2109 /* This function can GC */
|
|
2110 struct key_data kkk[20];
|
|
2111 struct key_data *raw_keys;
|
|
2112 int i;
|
|
2113
|
|
2114 if (nkeys == 0)
|
|
2115 return Qnil;
|
|
2116
|
412
|
2117 if (nkeys < (countof (kkk)))
|
0
|
2118 raw_keys = kkk;
|
|
2119 else
|
185
|
2120 raw_keys = alloca_array (struct key_data, nkeys);
|
0
|
2121
|
|
2122 for (i = 0; i < nkeys; i++)
|
|
2123 {
|
|
2124 define_key_parser (keys[i], &(raw_keys[i]));
|
|
2125 }
|
173
|
2126 return raw_lookup_key (keymap, raw_keys, nkeys, 0, accept_default);
|
0
|
2127 }
|
|
2128
|
|
2129 static Lisp_Object
|
|
2130 lookup_events (Lisp_Object event_head, int nmaps, Lisp_Object keymaps[],
|
|
2131 int accept_default)
|
|
2132 {
|
|
2133 /* This function can GC */
|
|
2134 struct key_data kkk[20];
|
|
2135 Lisp_Object event;
|
|
2136
|
|
2137 int nkeys;
|
|
2138 struct key_data *raw_keys;
|
|
2139 Lisp_Object tem = Qnil;
|
|
2140 struct gcpro gcpro1, gcpro2;
|
|
2141 int iii;
|
|
2142
|
|
2143 CHECK_LIVE_EVENT (event_head);
|
|
2144
|
|
2145 nkeys = event_chain_count (event_head);
|
|
2146
|
412
|
2147 if (nkeys < (countof (kkk)))
|
0
|
2148 raw_keys = kkk;
|
|
2149 else
|
185
|
2150 raw_keys = alloca_array (struct key_data, nkeys);
|
0
|
2151
|
|
2152 nkeys = 0;
|
|
2153 EVENT_CHAIN_LOOP (event, event_head)
|
|
2154 define_key_parser (event, &(raw_keys[nkeys++]));
|
|
2155 GCPRO2 (keymaps[0], event_head);
|
|
2156 gcpro1.nvars = nmaps;
|
|
2157 /* ####raw_keys[].keysym slots aren't gc-protected. We rely (but shouldn't)
|
|
2158 * on somebody else somewhere (obarray) having a pointer to all keysyms. */
|
|
2159 for (iii = 0; iii < nmaps; iii++)
|
|
2160 {
|
|
2161 tem = raw_lookup_key (keymaps[iii], raw_keys, nkeys, 0,
|
|
2162 accept_default);
|
|
2163 if (INTP (tem))
|
|
2164 {
|
|
2165 /* Too long in some local map means don't look at global map */
|
|
2166 tem = Qnil;
|
|
2167 break;
|
|
2168 }
|
|
2169 else if (!NILP (tem))
|
|
2170 break;
|
|
2171 }
|
|
2172 UNGCPRO;
|
173
|
2173 return tem;
|
0
|
2174 }
|
|
2175
|
20
|
2176 DEFUN ("lookup-key", Flookup_key, 2, 3, 0, /*
|
0
|
2177 In keymap KEYMAP, look up key-sequence KEYS. Return the definition.
|
|
2178 Nil is returned if KEYS is unbound. See documentation of `define-key'
|
|
2179 for valid key definitions and key-sequence specifications.
|
185
|
2180 A number is returned if KEYS is "too long"; that is, the leading
|
0
|
2181 characters fail to be a valid sequence of prefix characters in KEYMAP.
|
|
2182 The number is how many characters at the front of KEYS
|
|
2183 it takes to reach a non-prefix command.
|
20
|
2184 */
|
|
2185 (keymap, keys, accept_default))
|
0
|
2186 {
|
|
2187 /* This function can GC */
|
|
2188 if (VECTORP (keys))
|
272
|
2189 return lookup_keys (keymap,
|
|
2190 XVECTOR_LENGTH (keys),
|
|
2191 XVECTOR_DATA (keys),
|
|
2192 !NILP (accept_default));
|
70
|
2193 else if (SYMBOLP (keys) || CHAR_OR_CHAR_INTP (keys) || CONSP (keys))
|
272
|
2194 return lookup_keys (keymap, 1, &keys, !NILP (accept_default));
|
|
2195 else if (STRINGP (keys))
|
0
|
2196 {
|
272
|
2197 int length = XSTRING_CHAR_LENGTH (keys);
|
0
|
2198 int i;
|
185
|
2199 struct key_data *raw_keys = alloca_array (struct key_data, length);
|
0
|
2200 if (length == 0)
|
|
2201 return Qnil;
|
|
2202
|
|
2203 for (i = 0; i < length; i++)
|
|
2204 {
|
|
2205 Emchar n = string_char (XSTRING (keys), i);
|
|
2206 define_key_parser (make_char (n), &(raw_keys[i]));
|
|
2207 }
|
173
|
2208 return raw_lookup_key (keymap, raw_keys, length, 0,
|
|
2209 !NILP (accept_default));
|
0
|
2210 }
|
272
|
2211 else
|
|
2212 {
|
|
2213 keys = wrong_type_argument (Qsequencep, keys);
|
|
2214 return Flookup_key (keymap, keys, accept_default);
|
|
2215 }
|
0
|
2216 }
|
|
2217
|
|
2218 /* Given a key sequence, returns a list of keymaps to search for bindings.
|
|
2219 Does all manner of semi-hairy heuristics, like looking in the current
|
|
2220 buffer's map before looking in the global map and looking in the local
|
|
2221 map of the buffer in which the mouse was clicked in event0 is a click.
|
|
2222
|
|
2223 It would be kind of nice if this were in Lisp so that this semi-hairy
|
380
|
2224 semi-heuristic command-lookup behavior could be readily understood and
|
0
|
2225 customised. However, this needs to be pretty fast, or performance of
|
|
2226 keyboard macros goes to shit; putting this in lisp slows macros down
|
185
|
2227 2-3x. And they're already slower than v18 by 5-6x.
|
0
|
2228 */
|
|
2229
|
|
2230 struct relevant_maps
|
|
2231 {
|
|
2232 int nmaps;
|
|
2233 unsigned int max_maps;
|
|
2234 Lisp_Object *maps;
|
|
2235 struct gcpro *gcpro;
|
|
2236 };
|
|
2237
|
|
2238 static void get_relevant_extent_keymaps (Lisp_Object pos,
|
|
2239 Lisp_Object buffer_or_string,
|
|
2240 Lisp_Object glyph,
|
|
2241 struct relevant_maps *closure);
|
|
2242 static void get_relevant_minor_maps (Lisp_Object buffer,
|
|
2243 struct relevant_maps *closure);
|
|
2244
|
|
2245 static void
|
|
2246 relevant_map_push (Lisp_Object map, struct relevant_maps *closure)
|
185
|
2247 {
|
0
|
2248 unsigned int nmaps = closure->nmaps;
|
|
2249
|
|
2250 if (!KEYMAPP (map))
|
|
2251 return;
|
|
2252 closure->nmaps = nmaps + 1;
|
|
2253 if (nmaps < closure->max_maps)
|
|
2254 {
|
|
2255 closure->maps[nmaps] = map;
|
|
2256 closure->gcpro->nvars = nmaps;
|
|
2257 }
|
|
2258 }
|
|
2259
|
|
2260 static int
|
|
2261 get_relevant_keymaps (Lisp_Object keys,
|
|
2262 int max_maps, Lisp_Object maps[])
|
|
2263 {
|
|
2264 /* This function can GC */
|
|
2265 Lisp_Object terminal = Qnil;
|
|
2266 struct gcpro gcpro1;
|
|
2267 struct relevant_maps closure;
|
|
2268 struct console *con;
|
|
2269
|
|
2270 GCPRO1 (*maps);
|
|
2271 gcpro1.nvars = 0;
|
|
2272 closure.nmaps = 0;
|
|
2273 closure.max_maps = max_maps;
|
|
2274 closure.maps = maps;
|
|
2275 closure.gcpro = &gcpro1;
|
|
2276
|
|
2277 if (EVENTP (keys))
|
|
2278 terminal = event_chain_tail (keys);
|
|
2279 else if (VECTORP (keys))
|
|
2280 {
|
173
|
2281 int len = XVECTOR_LENGTH (keys);
|
0
|
2282 if (len > 0)
|
173
|
2283 terminal = XVECTOR_DATA (keys)[len - 1];
|
0
|
2284 }
|
|
2285
|
|
2286 if (EVENTP (terminal))
|
|
2287 {
|
|
2288 CHECK_LIVE_EVENT (terminal);
|
|
2289 con = event_console_or_selected (terminal);
|
|
2290 }
|
|
2291 else
|
|
2292 con = XCONSOLE (Vselected_console);
|
185
|
2293
|
0
|
2294 if (KEYMAPP (con->overriding_terminal_local_map)
|
|
2295 || KEYMAPP (Voverriding_local_map))
|
|
2296 {
|
|
2297 if (KEYMAPP (con->overriding_terminal_local_map))
|
|
2298 relevant_map_push (con->overriding_terminal_local_map, &closure);
|
|
2299 if (KEYMAPP (Voverriding_local_map))
|
|
2300 relevant_map_push (Voverriding_local_map, &closure);
|
|
2301 }
|
|
2302 else if (!EVENTP (terminal)
|
185
|
2303 || (XEVENT (terminal)->event_type != button_press_event
|
0
|
2304 && XEVENT (terminal)->event_type != button_release_event))
|
|
2305 {
|
|
2306 Lisp_Object tem;
|
|
2307 XSETBUFFER (tem, current_buffer);
|
|
2308 /* It's not a mouse event; order of keymaps searched is:
|
|
2309 o keymap of any/all extents under the mouse
|
|
2310 o minor-mode maps
|
|
2311 o local-map of current-buffer
|
|
2312 o global-map
|
|
2313 */
|
|
2314 /* The terminal element of the lookup may be nil or a keysym.
|
|
2315 In those cases we don't want to check for an extent
|
|
2316 keymap. */
|
|
2317 if (EVENTP (terminal))
|
|
2318 {
|
|
2319 get_relevant_extent_keymaps (make_int (BUF_PT (current_buffer)),
|
|
2320 tem, Qnil, &closure);
|
|
2321 }
|
|
2322 get_relevant_minor_maps (tem, &closure);
|
|
2323
|
|
2324 tem = current_buffer->keymap;
|
|
2325 if (!NILP (tem))
|
|
2326 relevant_map_push (tem, &closure);
|
|
2327 }
|
|
2328 #ifdef HAVE_WINDOW_SYSTEM
|
|
2329 else
|
|
2330 {
|
|
2331 /* It's a mouse event; order of keymaps searched is:
|
284
|
2332 o vertical-divider-map, if event is over a divider
|
0
|
2333 o local-map of mouse-grabbed-buffer
|
|
2334 o keymap of any/all extents under the mouse
|
|
2335 if the mouse is over a modeline:
|
|
2336 o modeline-map of buffer corresponding to that modeline
|
|
2337 o else, local-map of buffer under the mouse
|
|
2338 o minor-mode maps
|
|
2339 o local-map of current-buffer
|
|
2340 o global-map
|
|
2341 */
|
|
2342 Lisp_Object window = Fevent_window (terminal);
|
|
2343
|
284
|
2344 if (!NILP (Fevent_over_vertical_divider_p (terminal)))
|
|
2345 {
|
|
2346 if (KEYMAPP (Vvertical_divider_map))
|
|
2347 relevant_map_push (Vvertical_divider_map, &closure);
|
|
2348 }
|
|
2349
|
0
|
2350 if (BUFFERP (Vmouse_grabbed_buffer))
|
|
2351 {
|
|
2352 Lisp_Object map = XBUFFER (Vmouse_grabbed_buffer)->keymap;
|
|
2353
|
|
2354 get_relevant_minor_maps (Vmouse_grabbed_buffer, &closure);
|
|
2355 if (!NILP (map))
|
|
2356 relevant_map_push (map, &closure);
|
|
2357 }
|
|
2358
|
|
2359 if (!NILP (window))
|
|
2360 {
|
|
2361 Lisp_Object buffer = Fwindow_buffer (window);
|
|
2362
|
|
2363 if (!NILP (buffer))
|
|
2364 {
|
|
2365 if (!NILP (Fevent_over_modeline_p (terminal)))
|
|
2366 {
|
|
2367 Lisp_Object map = symbol_value_in_buffer (Qmodeline_map,
|
|
2368 buffer);
|
|
2369
|
|
2370 get_relevant_extent_keymaps
|
|
2371 (Fevent_modeline_position (terminal),
|
|
2372 XBUFFER (buffer)->generated_modeline_string,
|
412
|
2373 /* #### third arg should maybe be a glyph. */
|
|
2374 Qnil, &closure);
|
0
|
2375
|
|
2376 if (!UNBOUNDP (map) && !NILP (map))
|
|
2377 relevant_map_push (get_keymap (map, 1, 1), &closure);
|
|
2378 }
|
|
2379 else
|
|
2380 {
|
|
2381 get_relevant_extent_keymaps (Fevent_point (terminal), buffer,
|
|
2382 Fevent_glyph_extent (terminal),
|
|
2383 &closure);
|
|
2384 }
|
|
2385
|
|
2386 if (!EQ (buffer, Vmouse_grabbed_buffer)) /* already pushed */
|
|
2387 {
|
114
|
2388 Lisp_Object map = XBUFFER (buffer)->keymap;
|
|
2389
|
0
|
2390 get_relevant_minor_maps (buffer, &closure);
|
114
|
2391 if (!NILP(map))
|
|
2392 relevant_map_push (map, &closure);
|
0
|
2393 }
|
|
2394 }
|
|
2395 }
|
|
2396 else if (!NILP (Fevent_over_toolbar_p (terminal)))
|
|
2397 {
|
|
2398 Lisp_Object map = Fsymbol_value (Qtoolbar_map);
|
|
2399
|
|
2400 if (!UNBOUNDP (map) && !NILP (map))
|
|
2401 relevant_map_push (map, &closure);
|
|
2402 }
|
|
2403 }
|
|
2404 #endif /* HAVE_WINDOW_SYSTEM */
|
|
2405
|
|
2406 {
|
|
2407 int nmaps = closure.nmaps;
|
380
|
2408 /* Silently truncate at 100 keymaps to prevent infinite lossage */
|
0
|
2409 if (nmaps >= max_maps && max_maps > 0)
|
|
2410 maps[max_maps - 1] = Vcurrent_global_map;
|
|
2411 else
|
|
2412 maps[nmaps] = Vcurrent_global_map;
|
|
2413 UNGCPRO;
|
173
|
2414 return nmaps + 1;
|
0
|
2415 }
|
|
2416 }
|
|
2417
|
|
2418 /* Returns a set of keymaps extracted from the extents at POS in
|
|
2419 BUFFER_OR_STRING. The GLYPH arg, if specified, is one more extent
|
|
2420 to look for a keymap in, and if it has one, its keymap will be the
|
|
2421 first element in the list returned. This is so we can correctly
|
|
2422 search the keymaps associated with glyphs which may be physically
|
|
2423 disjoint from their extents: for example, if a glyph is out in the
|
380
|
2424 margin, we should still consult the keymap of that glyph's extent,
|
0
|
2425 which may not itself be under the mouse.
|
|
2426 */
|
157
|
2427
|
0
|
2428 static void
|
|
2429 get_relevant_extent_keymaps (Lisp_Object pos, Lisp_Object buffer_or_string,
|
|
2430 Lisp_Object glyph,
|
|
2431 struct relevant_maps *closure)
|
|
2432 {
|
|
2433 /* This function can GC */
|
|
2434 /* the glyph keymap, if any, comes first.
|
|
2435 (Processing it twice is no big deal: noop.) */
|
|
2436 if (!NILP (glyph))
|
|
2437 {
|
|
2438 Lisp_Object keymap = Fextent_property (glyph, Qkeymap, Qnil);
|
|
2439 if (!NILP (keymap))
|
|
2440 relevant_map_push (get_keymap (keymap, 1, 1), closure);
|
|
2441 }
|
185
|
2442
|
0
|
2443 /* Next check the extents at the text position, if any */
|
|
2444 if (!NILP (pos))
|
|
2445 {
|
|
2446 Lisp_Object extent;
|
195
|
2447 for (extent = Fextent_at (pos, buffer_or_string, Qkeymap, Qnil, Qnil);
|
0
|
2448 !NILP (extent);
|
195
|
2449 extent = Fextent_at (pos, buffer_or_string, Qkeymap, extent, Qnil))
|
0
|
2450 {
|
195
|
2451 Lisp_Object keymap = Fextent_property (extent, Qkeymap, Qnil);
|
|
2452 if (!NILP (keymap))
|
|
2453 relevant_map_push (get_keymap (keymap, 1, 1), closure);
|
|
2454 QUIT;
|
0
|
2455 }
|
|
2456 }
|
|
2457 }
|
|
2458
|
|
2459 static Lisp_Object
|
|
2460 minor_mode_keymap_predicate (Lisp_Object assoc, Lisp_Object buffer)
|
|
2461 {
|
|
2462 /* This function can GC */
|
|
2463 if (CONSP (assoc))
|
|
2464 {
|
|
2465 Lisp_Object sym = XCAR (assoc);
|
|
2466 if (SYMBOLP (sym))
|
|
2467 {
|
|
2468 Lisp_Object val = symbol_value_in_buffer (sym, buffer);
|
|
2469 if (!NILP (val) && !UNBOUNDP (val))
|
|
2470 {
|
|
2471 Lisp_Object map = get_keymap (XCDR (assoc), 0, 1);
|
173
|
2472 return map;
|
0
|
2473 }
|
|
2474 }
|
|
2475 }
|
173
|
2476 return Qnil;
|
0
|
2477 }
|
|
2478
|
|
2479 static void
|
|
2480 get_relevant_minor_maps (Lisp_Object buffer, struct relevant_maps *closure)
|
|
2481 {
|
|
2482 /* This function can GC */
|
|
2483 Lisp_Object alist;
|
|
2484
|
|
2485 /* Will you ever lose badly if you make this circular! */
|
|
2486 for (alist = symbol_value_in_buffer (Qminor_mode_map_alist, buffer);
|
|
2487 CONSP (alist);
|
|
2488 alist = XCDR (alist))
|
|
2489 {
|
|
2490 Lisp_Object m = minor_mode_keymap_predicate (XCAR (alist),
|
|
2491 buffer);
|
|
2492 if (!NILP (m)) relevant_map_push (m, closure);
|
|
2493 QUIT;
|
|
2494 }
|
|
2495 }
|
|
2496
|
|
2497 /* #### Would map-current-keymaps be a better thing?? */
|
20
|
2498 DEFUN ("current-keymaps", Fcurrent_keymaps, 0, 1, 0, /*
|
0
|
2499 Return a list of the current keymaps that will be searched for bindings.
|
|
2500 This lists keymaps such as the current local map and the minor-mode maps,
|
|
2501 but does not list the parents of those keymaps.
|
|
2502 EVENT-OR-KEYS controls which keymaps will be listed.
|
|
2503 If EVENT-OR-KEYS is a mouse event (or a vector whose last element is a
|
|
2504 mouse event), the keymaps for that mouse event will be listed (see
|
|
2505 `key-binding'). Otherwise, the keymaps for key presses will be listed.
|
20
|
2506 */
|
|
2507 (event_or_keys))
|
0
|
2508 {
|
|
2509 /* This function can GC */
|
|
2510 struct gcpro gcpro1;
|
|
2511 Lisp_Object maps[100];
|
|
2512 Lisp_Object *gubbish = maps;
|
|
2513 int nmaps;
|
|
2514
|
|
2515 GCPRO1 (event_or_keys);
|
|
2516 nmaps = get_relevant_keymaps (event_or_keys, countof (maps),
|
|
2517 gubbish);
|
|
2518 if (nmaps > countof (maps))
|
|
2519 {
|
185
|
2520 gubbish = alloca_array (Lisp_Object, nmaps);
|
0
|
2521 nmaps = get_relevant_keymaps (event_or_keys, nmaps, gubbish);
|
|
2522 }
|
|
2523 UNGCPRO;
|
173
|
2524 return Flist (nmaps, gubbish);
|
0
|
2525 }
|
|
2526
|
20
|
2527 DEFUN ("key-binding", Fkey_binding, 1, 2, 0, /*
|
0
|
2528 Return the binding for command KEYS in current keymaps.
|
|
2529 KEYS is a string, a vector of events, or a vector of key-description lists
|
|
2530 as described in the documentation for the `define-key' function.
|
|
2531 The binding is probably a symbol with a function definition; see
|
|
2532 the documentation for `lookup-key' for more information.
|
|
2533
|
|
2534 For key-presses, the order of keymaps searched is:
|
|
2535 - the `keymap' property of any extent(s) at point;
|
|
2536 - any applicable minor-mode maps;
|
|
2537 - the current-local-map of the current-buffer;
|
|
2538 - the current global map.
|
|
2539
|
|
2540 For mouse-clicks, the order of keymaps searched is:
|
|
2541 - the current-local-map of the `mouse-grabbed-buffer' if any;
|
284
|
2542 - vertical-divider-map, if the event happened over a vertical divider
|
0
|
2543 - the `keymap' property of any extent(s) at the position of the click
|
|
2544 (this includes modeline extents);
|
|
2545 - the modeline-map of the buffer corresponding to the modeline under
|
|
2546 the mouse (if the click happened over a modeline);
|
|
2547 - the value of toolbar-map in the current-buffer (if the click
|
|
2548 happened over a toolbar);
|
|
2549 - the current-local-map of the buffer under the mouse (does not
|
|
2550 apply to toolbar clicks);
|
|
2551 - any applicable minor-mode maps;
|
|
2552 - the current global map.
|
|
2553
|
|
2554 Note that if `overriding-local-map' or `overriding-terminal-local-map'
|
|
2555 is non-nil, *only* those two maps and the current global map are searched.
|
20
|
2556 */
|
|
2557 (keys, accept_default))
|
0
|
2558 {
|
|
2559 /* This function can GC */
|
|
2560 int i;
|
|
2561 Lisp_Object maps[100];
|
|
2562 int nmaps;
|
|
2563 struct gcpro gcpro1, gcpro2;
|
|
2564 GCPRO2 (keys, accept_default); /* get_relevant_keymaps may autoload */
|
|
2565
|
|
2566 nmaps = get_relevant_keymaps (keys, countof (maps), maps);
|
|
2567
|
|
2568 UNGCPRO;
|
|
2569
|
|
2570 if (EVENTP (keys)) /* unadvertised "feature" for the future */
|
173
|
2571 return lookup_events (keys, nmaps, maps, !NILP (accept_default));
|
0
|
2572
|
|
2573 for (i = 0; i < nmaps; i++)
|
|
2574 {
|
|
2575 Lisp_Object tem = Flookup_key (maps[i], keys,
|
|
2576 accept_default);
|
|
2577 if (INTP (tem))
|
|
2578 {
|
|
2579 /* Too long in some local map means don't look at global map */
|
173
|
2580 return Qnil;
|
0
|
2581 }
|
|
2582 else if (!NILP (tem))
|
173
|
2583 return tem;
|
0
|
2584 }
|
173
|
2585 return Qnil;
|
0
|
2586 }
|
|
2587
|
|
2588 static Lisp_Object
|
|
2589 process_event_binding_result (Lisp_Object result)
|
|
2590 {
|
|
2591 if (EQ (result, Qundefined))
|
|
2592 /* The suppress-keymap function binds keys to 'undefined - special-case
|
|
2593 that here, so that being bound to that has the same error-behavior as
|
|
2594 not being defined at all.
|
|
2595 */
|
|
2596 result = Qnil;
|
|
2597 if (!NILP (result))
|
|
2598 {
|
|
2599 Lisp_Object map;
|
|
2600 /* Snap out possible keymap indirections */
|
|
2601 map = get_keymap (result, 0, 1);
|
|
2602 if (!NILP (map))
|
|
2603 result = map;
|
|
2604 }
|
|
2605
|
|
2606 return result;
|
|
2607 }
|
|
2608
|
|
2609 /* Attempts to find a command corresponding to the event-sequence
|
|
2610 whose head is event0 (sequence is threaded though event_next).
|
|
2611
|
|
2612 The return value will be
|
|
2613
|
|
2614 -- nil (there is no binding; this will also be returned
|
|
2615 whenever the event chain is "too long", i.e. there
|
|
2616 is a non-nil, non-keymap binding for a prefix of
|
|
2617 the event chain)
|
|
2618 -- a keymap (part of a command has been specified)
|
|
2619 -- a command (anything that satisfies `commandp'; this includes
|
|
2620 some symbols, lists, subrs, strings, vectors, and
|
|
2621 compiled-function objects) */
|
|
2622 Lisp_Object
|
|
2623 event_binding (Lisp_Object event0, int accept_default)
|
|
2624 {
|
|
2625 /* This function can GC */
|
|
2626 Lisp_Object maps[100];
|
|
2627 int nmaps;
|
|
2628
|
|
2629 assert (EVENTP (event0));
|
|
2630
|
|
2631 nmaps = get_relevant_keymaps (event0, countof (maps), maps);
|
114
|
2632 if (nmaps > countof (maps))
|
|
2633 nmaps = countof (maps);
|
173
|
2634 return process_event_binding_result (lookup_events (event0, nmaps, maps,
|
|
2635 accept_default));
|
0
|
2636 }
|
|
2637
|
175
|
2638 /* like event_binding, but specify a keymap to search */
|
|
2639
|
|
2640 Lisp_Object
|
|
2641 event_binding_in (Lisp_Object event0, Lisp_Object keymap, int accept_default)
|
|
2642 {
|
|
2643 /* This function can GC */
|
|
2644 if (!KEYMAPP (keymap))
|
|
2645 return Qnil;
|
185
|
2646
|
|
2647 return process_event_binding_result (lookup_events (event0, 1, &keymap,
|
175
|
2648 accept_default));
|
|
2649 }
|
|
2650
|
0
|
2651 /* Attempts to find a function key mapping corresponding to the
|
|
2652 event-sequence whose head is event0 (sequence is threaded through
|
|
2653 event_next). The return value will be the same as for event_binding(). */
|
|
2654 Lisp_Object
|
|
2655 munging_key_map_event_binding (Lisp_Object event0,
|
|
2656 enum munge_me_out_the_door munge)
|
|
2657 {
|
185
|
2658 Lisp_Object keymap = (munge == MUNGE_ME_FUNCTION_KEY) ?
|
|
2659 CONSOLE_FUNCTION_KEY_MAP (event_console_or_selected (event0)) :
|
|
2660 Vkey_translation_map;
|
|
2661
|
|
2662 if (NILP (keymap))
|
0
|
2663 return Qnil;
|
|
2664
|
185
|
2665 return process_event_binding_result (lookup_events (event0, 1, &keymap, 1));
|
0
|
2666 }
|
|
2667
|
|
2668
|
|
2669 /************************************************************************/
|
|
2670 /* Setting/querying the global and local maps */
|
|
2671 /************************************************************************/
|
|
2672
|
20
|
2673 DEFUN ("use-global-map", Fuse_global_map, 1, 1, 0, /*
|
0
|
2674 Select KEYMAP as the global keymap.
|
20
|
2675 */
|
|
2676 (keymap))
|
0
|
2677 {
|
|
2678 /* This function can GC */
|
|
2679 keymap = get_keymap (keymap, 1, 1);
|
|
2680 Vcurrent_global_map = keymap;
|
|
2681 return Qnil;
|
|
2682 }
|
|
2683
|
20
|
2684 DEFUN ("use-local-map", Fuse_local_map, 1, 2, 0, /*
|
0
|
2685 Select KEYMAP as the local keymap in BUFFER.
|
|
2686 If KEYMAP is nil, that means no local keymap.
|
|
2687 If BUFFER is nil, the current buffer is assumed.
|
20
|
2688 */
|
|
2689 (keymap, buffer))
|
0
|
2690 {
|
|
2691 /* This function can GC */
|
|
2692 struct buffer *b = decode_buffer (buffer, 0);
|
|
2693 if (!NILP (keymap))
|
|
2694 keymap = get_keymap (keymap, 1, 1);
|
|
2695
|
|
2696 b->keymap = keymap;
|
|
2697
|
|
2698 return Qnil;
|
|
2699 }
|
|
2700
|
20
|
2701 DEFUN ("current-local-map", Fcurrent_local_map, 0, 1, 0, /*
|
0
|
2702 Return BUFFER's local keymap, or nil if it has none.
|
|
2703 If BUFFER is nil, the current buffer is assumed.
|
20
|
2704 */
|
|
2705 (buffer))
|
0
|
2706 {
|
|
2707 struct buffer *b = decode_buffer (buffer, 0);
|
|
2708 return b->keymap;
|
|
2709 }
|
|
2710
|
20
|
2711 DEFUN ("current-global-map", Fcurrent_global_map, 0, 0, 0, /*
|
0
|
2712 Return the current global keymap.
|
20
|
2713 */
|
|
2714 ())
|
0
|
2715 {
|
173
|
2716 return Vcurrent_global_map;
|
0
|
2717 }
|
|
2718
|
|
2719
|
|
2720 /************************************************************************/
|
|
2721 /* Mapping over keymap elements */
|
|
2722 /************************************************************************/
|
|
2723
|
|
2724 /* Since keymaps are arranged in a hierarchy, one keymap per bucky bit or
|
185
|
2725 prefix key, it's not entirely obvious what map-keymap should do, but
|
0
|
2726 what it does is: map over all keys in this map; then recursively map
|
|
2727 over all submaps of this map that are "bucky" submaps. This means that,
|
|
2728 when mapping over a keymap, it appears that "x" and "C-x" are in the
|
|
2729 same map, although "C-x" is really in the "control" submap of this one.
|
|
2730 However, since we don't recursively descend the submaps that are bound
|
|
2731 to prefix keys (like C-x, C-h, etc) the caller will have to recurse on
|
|
2732 those explicitly, if that's what they want.
|
|
2733
|
|
2734 So the end result of this is that the bucky keymaps (the ones indexed
|
|
2735 under the large integers returned from MAKE_MODIFIER_HASH_KEY()) are
|
|
2736 invisible from elisp. They're just an implementation detail that code
|
|
2737 outside of this file doesn't need to know about.
|
|
2738 */
|
|
2739
|
|
2740 struct map_keymap_unsorted_closure
|
|
2741 {
|
412
|
2742 void (*fn) (CONST struct key_data *, Lisp_Object binding, void *arg);
|
0
|
2743 void *arg;
|
412
|
2744 unsigned int modifiers;
|
0
|
2745 };
|
|
2746
|
|
2747 /* used by map_keymap() */
|
241
|
2748 static int
|
380
|
2749 map_keymap_unsorted_mapper (Lisp_Object keysym, Lisp_Object value,
|
0
|
2750 void *map_keymap_unsorted_closure)
|
|
2751 {
|
|
2752 /* This function can GC */
|
185
|
2753 struct map_keymap_unsorted_closure *closure =
|
|
2754 (struct map_keymap_unsorted_closure *) map_keymap_unsorted_closure;
|
412
|
2755 unsigned int modifiers = closure->modifiers;
|
|
2756 unsigned int mod_bit;
|
0
|
2757 mod_bit = MODIFIER_HASH_KEY_BITS (keysym);
|
|
2758 if (mod_bit != 0)
|
|
2759 {
|
|
2760 int omod = modifiers;
|
|
2761 closure->modifiers = (modifiers | mod_bit);
|
380
|
2762 value = get_keymap (value, 1, 0);
|
0
|
2763 elisp_maphash (map_keymap_unsorted_mapper,
|
380
|
2764 XKEYMAP (value)->table,
|
0
|
2765 map_keymap_unsorted_closure);
|
|
2766 closure->modifiers = omod;
|
|
2767 }
|
|
2768 else
|
|
2769 {
|
|
2770 struct key_data key;
|
|
2771 key.keysym = keysym;
|
|
2772 key.modifiers = modifiers;
|
380
|
2773 ((*closure->fn) (&key, value, closure->arg));
|
0
|
2774 }
|
241
|
2775 return 0;
|
0
|
2776 }
|
|
2777
|
|
2778
|
|
2779 struct map_keymap_sorted_closure
|
|
2780 {
|
|
2781 Lisp_Object *result_locative;
|
|
2782 };
|
|
2783
|
|
2784 /* used by map_keymap_sorted() */
|
241
|
2785 static int
|
380
|
2786 map_keymap_sorted_mapper (Lisp_Object key, Lisp_Object value,
|
0
|
2787 void *map_keymap_sorted_closure)
|
|
2788 {
|
185
|
2789 struct map_keymap_sorted_closure *cl =
|
|
2790 (struct map_keymap_sorted_closure *) map_keymap_sorted_closure;
|
0
|
2791 Lisp_Object *list = cl->result_locative;
|
380
|
2792 *list = Fcons (Fcons (key, value), *list);
|
241
|
2793 return 0;
|
0
|
2794 }
|
|
2795
|
|
2796
|
|
2797 /* used by map_keymap_sorted(), describe_map_sort_predicate(),
|
|
2798 and keymap_submaps().
|
|
2799 */
|
|
2800 static int
|
185
|
2801 map_keymap_sort_predicate (Lisp_Object obj1, Lisp_Object obj2,
|
0
|
2802 Lisp_Object pred)
|
|
2803 {
|
|
2804 /* obj1 and obj2 are conses with keysyms in their cars. Cdrs are ignored.
|
|
2805 */
|
412
|
2806 unsigned int bit1, bit2;
|
0
|
2807 int sym1_p = 0;
|
|
2808 int sym2_p = 0;
|
|
2809 obj1 = XCAR (obj1);
|
|
2810 obj2 = XCAR (obj2);
|
|
2811
|
|
2812 if (EQ (obj1, obj2))
|
|
2813 return -1;
|
|
2814 bit1 = MODIFIER_HASH_KEY_BITS (obj1);
|
|
2815 bit2 = MODIFIER_HASH_KEY_BITS (obj2);
|
185
|
2816
|
0
|
2817 /* If either is a symbol with a character-set-property, then sort it by
|
|
2818 that code instead of alphabetically.
|
|
2819 */
|
|
2820 if (! bit1 && SYMBOLP (obj1))
|
|
2821 {
|
|
2822 Lisp_Object code = Fget (obj1, Vcharacter_set_property, Qnil);
|
70
|
2823 if (CHAR_OR_CHAR_INTP (code))
|
|
2824 {
|
|
2825 obj1 = code;
|
|
2826 CHECK_CHAR_COERCE_INT (obj1);
|
|
2827 sym1_p = 1;
|
|
2828 }
|
0
|
2829 }
|
|
2830 if (! bit2 && SYMBOLP (obj2))
|
|
2831 {
|
|
2832 Lisp_Object code = Fget (obj2, Vcharacter_set_property, Qnil);
|
70
|
2833 if (CHAR_OR_CHAR_INTP (code))
|
|
2834 {
|
|
2835 obj2 = code;
|
|
2836 CHECK_CHAR_COERCE_INT (obj2);
|
|
2837 sym2_p = 1;
|
|
2838 }
|
0
|
2839 }
|
|
2840
|
|
2841 /* all symbols (non-ASCIIs) come after characters (ASCIIs) */
|
|
2842 if (XTYPE (obj1) != XTYPE (obj2))
|
173
|
2843 return SYMBOLP (obj2) ? 1 : -1;
|
0
|
2844
|
|
2845 if (! bit1 && CHARP (obj1)) /* they're both ASCII */
|
|
2846 {
|
|
2847 int o1 = XCHAR (obj1);
|
|
2848 int o2 = XCHAR (obj2);
|
|
2849 if (o1 == o2 && /* If one started out as a symbol and the */
|
|
2850 sym1_p != sym2_p) /* other didn't, the symbol comes last. */
|
173
|
2851 return sym2_p ? 1 : -1;
|
|
2852
|
|
2853 return o1 < o2 ? 1 : -1; /* else just compare them */
|
0
|
2854 }
|
|
2855
|
|
2856 /* else they're both symbols. If they're both buckys, then order them. */
|
|
2857 if (bit1 && bit2)
|
173
|
2858 return bit1 < bit2 ? 1 : -1;
|
185
|
2859
|
0
|
2860 /* if only one is a bucky, then it comes later */
|
|
2861 if (bit1 || bit2)
|
173
|
2862 return bit2 ? 1 : -1;
|
0
|
2863
|
|
2864 /* otherwise, string-sort them. */
|
|
2865 {
|
|
2866 char *s1 = (char *) string_data (XSYMBOL (obj1)->name);
|
|
2867 char *s2 = (char *) string_data (XSYMBOL (obj2)->name);
|
|
2868 #ifdef I18N2
|
173
|
2869 return 0 > strcoll (s1, s2) ? 1 : -1;
|
0
|
2870 #else
|
173
|
2871 return 0 > strcmp (s1, s2) ? 1 : -1;
|
0
|
2872 #endif
|
|
2873 }
|
|
2874 }
|
|
2875
|
|
2876
|
|
2877 /* used by map_keymap() */
|
|
2878 static void
|
|
2879 map_keymap_sorted (Lisp_Object keymap_table,
|
412
|
2880 unsigned int modifiers,
|
|
2881 void (*function) (CONST struct key_data *key,
|
185
|
2882 Lisp_Object binding,
|
0
|
2883 void *map_keymap_sorted_closure),
|
|
2884 void *map_keymap_sorted_closure)
|
|
2885 {
|
|
2886 /* This function can GC */
|
|
2887 struct gcpro gcpro1;
|
|
2888 Lisp_Object contents = Qnil;
|
|
2889
|
380
|
2890 if (XINT (Fhash_table_count (keymap_table)) == 0)
|
0
|
2891 return;
|
|
2892
|
|
2893 GCPRO1 (contents);
|
|
2894
|
|
2895 {
|
|
2896 struct map_keymap_sorted_closure c1;
|
|
2897 c1.result_locative = &contents;
|
|
2898 elisp_maphash (map_keymap_sorted_mapper, keymap_table, &c1);
|
|
2899 }
|
|
2900 contents = list_sort (contents, Qnil, map_keymap_sort_predicate);
|
|
2901 for (; !NILP (contents); contents = XCDR (contents))
|
|
2902 {
|
|
2903 Lisp_Object keysym = XCAR (XCAR (contents));
|
|
2904 Lisp_Object binding = XCDR (XCAR (contents));
|
412
|
2905 unsigned int sub_bits = MODIFIER_HASH_KEY_BITS (keysym);
|
0
|
2906 if (sub_bits != 0)
|
|
2907 map_keymap_sorted (XKEYMAP (get_keymap (binding,
|
|
2908 1, 1))->table,
|
|
2909 (modifiers | sub_bits),
|
|
2910 function,
|
|
2911 map_keymap_sorted_closure);
|
|
2912 else
|
|
2913 {
|
|
2914 struct key_data k;
|
|
2915 k.keysym = keysym;
|
|
2916 k.modifiers = modifiers;
|
|
2917 ((*function) (&k, binding, map_keymap_sorted_closure));
|
|
2918 }
|
|
2919 }
|
|
2920 UNGCPRO;
|
|
2921 }
|
|
2922
|
|
2923
|
|
2924 /* used by Fmap_keymap() */
|
|
2925 static void
|
412
|
2926 map_keymap_mapper (CONST struct key_data *key,
|
185
|
2927 Lisp_Object binding,
|
0
|
2928 void *function)
|
|
2929 {
|
|
2930 /* This function can GC */
|
|
2931 Lisp_Object fn;
|
|
2932 VOID_TO_LISP (fn, function);
|
|
2933 call2 (fn, make_key_description (key, 1), binding);
|
|
2934 }
|
|
2935
|
|
2936
|
|
2937 static void
|
|
2938 map_keymap (Lisp_Object keymap_table, int sort_first,
|
412
|
2939 void (*function) (CONST struct key_data *key,
|
0
|
2940 Lisp_Object binding,
|
|
2941 void *fn_arg),
|
|
2942 void *fn_arg)
|
|
2943 {
|
|
2944 /* This function can GC */
|
|
2945 if (sort_first)
|
|
2946 map_keymap_sorted (keymap_table, 0, function, fn_arg);
|
|
2947 else
|
|
2948 {
|
|
2949 struct map_keymap_unsorted_closure map_keymap_unsorted_closure;
|
|
2950 map_keymap_unsorted_closure.fn = function;
|
|
2951 map_keymap_unsorted_closure.arg = fn_arg;
|
|
2952 map_keymap_unsorted_closure.modifiers = 0;
|
|
2953 elisp_maphash (map_keymap_unsorted_mapper, keymap_table,
|
|
2954 &map_keymap_unsorted_closure);
|
|
2955 }
|
|
2956 }
|
|
2957
|
20
|
2958 DEFUN ("map-keymap", Fmap_keymap, 2, 3, 0, /*
|
0
|
2959 Apply FUNCTION to each element of KEYMAP.
|
|
2960 FUNCTION will be called with two arguments: a key-description list, and
|
|
2961 the binding. The order in which the elements of the keymap are passed to
|
|
2962 the function is unspecified. If the function inserts new elements into
|
|
2963 the keymap, it may or may not be called with them later. No element of
|
|
2964 the keymap will ever be passed to the function more than once.
|
|
2965
|
|
2966 The function will not be called on elements of this keymap's parents
|
272
|
2967 \(see the function `keymap-parents') or upon keymaps which are contained
|
0
|
2968 within this keymap (multi-character definitions).
|
185
|
2969 It will be called on "meta" characters since they are not really
|
0
|
2970 two-character sequences.
|
|
2971
|
|
2972 If the optional third argument SORT-FIRST is non-nil, then the elements of
|
|
2973 the keymap will be passed to the mapper function in a canonical order.
|
|
2974 Otherwise, they will be passed in hash (that is, random) order, which is
|
|
2975 faster.
|
20
|
2976 */
|
70
|
2977 (function, keymap, sort_first))
|
0
|
2978 {
|
|
2979 /* This function can GC */
|
|
2980 struct gcpro gcpro1, gcpro2;
|
|
2981
|
|
2982 /* tolerate obviously transposed args */
|
|
2983 if (!NILP (Fkeymapp (function)))
|
|
2984 {
|
|
2985 Lisp_Object tmp = function;
|
|
2986 function = keymap;
|
|
2987 keymap = tmp;
|
|
2988 }
|
|
2989 GCPRO2 (function, keymap);
|
|
2990 keymap = get_keymap (keymap, 1, 1);
|
|
2991 map_keymap (XKEYMAP (keymap)->table, !NILP (sort_first),
|
|
2992 map_keymap_mapper, LISP_TO_VOID (function));
|
|
2993 UNGCPRO;
|
|
2994 return Qnil;
|
|
2995 }
|
|
2996
|
|
2997
|
|
2998
|
|
2999 /************************************************************************/
|
|
3000 /* Accessible keymaps */
|
|
3001 /************************************************************************/
|
|
3002
|
|
3003 struct accessible_keymaps_closure
|
|
3004 {
|
|
3005 Lisp_Object tail;
|
|
3006 };
|
|
3007
|
|
3008
|
|
3009 static void
|
|
3010 accessible_keymaps_mapper_1 (Lisp_Object keysym, Lisp_Object contents,
|
412
|
3011 unsigned int modifiers,
|
0
|
3012 struct accessible_keymaps_closure *closure)
|
|
3013 {
|
|
3014 /* This function can GC */
|
412
|
3015 unsigned int subbits = MODIFIER_HASH_KEY_BITS (keysym);
|
0
|
3016
|
|
3017 if (subbits != 0)
|
|
3018 {
|
|
3019 Lisp_Object submaps;
|
|
3020
|
|
3021 contents = get_keymap (contents, 1, 1);
|
|
3022 submaps = keymap_submaps (contents);
|
|
3023 for (; !NILP (submaps); submaps = XCDR (submaps))
|
|
3024 {
|
|
3025 accessible_keymaps_mapper_1 (XCAR (XCAR (submaps)),
|
|
3026 XCDR (XCAR (submaps)),
|
|
3027 (subbits | modifiers),
|
|
3028 closure);
|
|
3029 }
|
|
3030 }
|
|
3031 else
|
|
3032 {
|
|
3033 Lisp_Object thisseq = Fcar (Fcar (closure->tail));
|
|
3034 Lisp_Object cmd = get_keyelt (contents, 1);
|
|
3035 Lisp_Object vec;
|
|
3036 int j;
|
173
|
3037 int len;
|
0
|
3038 struct key_data key;
|
|
3039 key.keysym = keysym;
|
|
3040 key.modifiers = modifiers;
|
|
3041
|
|
3042 if (NILP (cmd))
|
|
3043 abort ();
|
|
3044 cmd = get_keymap (cmd, 0, 1);
|
|
3045 if (!KEYMAPP (cmd))
|
|
3046 abort ();
|
|
3047
|
173
|
3048 vec = make_vector (XVECTOR_LENGTH (thisseq) + 1, Qnil);
|
|
3049 len = XVECTOR_LENGTH (thisseq);
|
|
3050 for (j = 0; j < len; j++)
|
|
3051 XVECTOR_DATA (vec) [j] = XVECTOR_DATA (thisseq) [j];
|
|
3052 XVECTOR_DATA (vec) [j] = make_key_description (&key, 1);
|
0
|
3053
|
|
3054 nconc2 (closure->tail, list1 (Fcons (vec, cmd)));
|
|
3055 }
|
|
3056 }
|
|
3057
|
|
3058
|
|
3059 static Lisp_Object
|
|
3060 accessible_keymaps_keymap_mapper (Lisp_Object thismap, void *arg)
|
|
3061 {
|
|
3062 /* This function can GC */
|
185
|
3063 struct accessible_keymaps_closure *closure =
|
|
3064 (struct accessible_keymaps_closure *) arg;
|
0
|
3065 Lisp_Object submaps = keymap_submaps (thismap);
|
|
3066
|
|
3067 for (; !NILP (submaps); submaps = XCDR (submaps))
|
|
3068 {
|
|
3069 accessible_keymaps_mapper_1 (XCAR (XCAR (submaps)),
|
|
3070 XCDR (XCAR (submaps)),
|
|
3071 0,
|
|
3072 closure);
|
|
3073 }
|
173
|
3074 return Qnil;
|
0
|
3075 }
|
|
3076
|
|
3077
|
20
|
3078 DEFUN ("accessible-keymaps", Faccessible_keymaps, 1, 2, 0, /*
|
185
|
3079 Find all keymaps accessible via prefix characters from KEYMAP.
|
0
|
3080 Returns a list of elements of the form (KEYS . MAP), where the sequence
|
185
|
3081 KEYS starting from KEYMAP gets you to MAP. These elements are ordered
|
|
3082 so that the KEYS increase in length. The first element is ([] . KEYMAP).
|
0
|
3083 An optional argument PREFIX, if non-nil, should be a key sequence;
|
|
3084 then the value includes only maps for prefixes that start with PREFIX.
|
20
|
3085 */
|
185
|
3086 (keymap, prefix))
|
0
|
3087 {
|
|
3088 /* This function can GC */
|
|
3089 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
|
|
3090 Lisp_Object accessible_keymaps = Qnil;
|
|
3091 struct accessible_keymaps_closure c;
|
|
3092 c.tail = Qnil;
|
185
|
3093 GCPRO4 (accessible_keymaps, c.tail, prefix, keymap);
|
0
|
3094
|
412
|
3095 retry:
|
398
|
3096 keymap = get_keymap (keymap, 1, 1);
|
0
|
3097 if (NILP (prefix))
|
412
|
3098 prefix = make_vector (0, Qnil);
|
|
3099 else if (!VECTORP (prefix) || STRINGP (prefix))
|
0
|
3100 {
|
412
|
3101 prefix = wrong_type_argument (Qarrayp, prefix);
|
|
3102 goto retry;
|
0
|
3103 }
|
412
|
3104 else
|
0
|
3105 {
|
|
3106 int len = XINT (Flength (prefix));
|
412
|
3107 Lisp_Object def = Flookup_key (keymap, prefix, Qnil);
|
0
|
3108 Lisp_Object p;
|
|
3109 int iii;
|
|
3110 struct gcpro ngcpro1;
|
|
3111
|
|
3112 def = get_keymap (def, 0, 1);
|
|
3113 if (!KEYMAPP (def))
|
|
3114 goto RETURN;
|
|
3115
|
185
|
3116 keymap = def;
|
0
|
3117 p = make_vector (len, Qnil);
|
|
3118 NGCPRO1 (p);
|
|
3119 for (iii = 0; iii < len; iii++)
|
|
3120 {
|
|
3121 struct key_data key;
|
|
3122 define_key_parser (Faref (prefix, make_int (iii)), &key);
|
173
|
3123 XVECTOR_DATA (p)[iii] = make_key_description (&key, 1);
|
0
|
3124 }
|
|
3125 NUNGCPRO;
|
|
3126 prefix = p;
|
|
3127 }
|
185
|
3128
|
|
3129 accessible_keymaps = list1 (Fcons (prefix, keymap));
|
0
|
3130
|
412
|
3131 /* For each map in the list maps,
|
|
3132 look at any other maps it points to
|
|
3133 and stick them at the end if they are not already in the list */
|
0
|
3134
|
|
3135 for (c.tail = accessible_keymaps;
|
|
3136 !NILP (c.tail);
|
|
3137 c.tail = XCDR (c.tail))
|
|
3138 {
|
|
3139 Lisp_Object thismap = Fcdr (Fcar (c.tail));
|
|
3140 CHECK_KEYMAP (thismap);
|
|
3141 traverse_keymaps (thismap, Qnil,
|
|
3142 accessible_keymaps_keymap_mapper, &c);
|
|
3143 }
|
|
3144 RETURN:
|
|
3145 UNGCPRO;
|
173
|
3146 return accessible_keymaps;
|
0
|
3147 }
|
|
3148
|
|
3149
|
|
3150
|
|
3151 /************************************************************************/
|
|
3152 /* Pretty descriptions of key sequences */
|
|
3153 /************************************************************************/
|
|
3154
|
20
|
3155 DEFUN ("key-description", Fkey_description, 1, 1, 0, /*
|
0
|
3156 Return a pretty description of key-sequence KEYS.
|
185
|
3157 Control characters turn into "C-foo" sequences, meta into "M-foo",
|
|
3158 spaces are put between sequence elements, etc...
|
20
|
3159 */
|
|
3160 (keys))
|
0
|
3161 {
|
70
|
3162 if (CHAR_OR_CHAR_INTP (keys) || CONSP (keys) || SYMBOLP (keys)
|
|
3163 || EVENTP (keys))
|
0
|
3164 {
|
|
3165 return Fsingle_key_description (keys);
|
|
3166 }
|
|
3167 else if (VECTORP (keys) ||
|
|
3168 STRINGP (keys))
|
|
3169 {
|
|
3170 Lisp_Object string = Qnil;
|
|
3171 /* Lisp_Object sep = Qnil; */
|
|
3172 int size = XINT (Flength (keys));
|
|
3173 int i;
|
|
3174
|
|
3175 for (i = 0; i < size; i++)
|
|
3176 {
|
|
3177 Lisp_Object s2 = Fsingle_key_description
|
412
|
3178 (((STRINGP (keys))
|
|
3179 ? make_char (string_char (XSTRING (keys), i))
|
|
3180 : XVECTOR_DATA (keys)[i]));
|
0
|
3181
|
|
3182 if (i == 0)
|
|
3183 string = s2;
|
|
3184 else
|
|
3185 {
|
|
3186 /* if (NILP (sep)) Lisp_Object sep = build_string (" ") */;
|
|
3187 string = concat2 (string, concat2 (Vsingle_space_string, s2));
|
|
3188 }
|
|
3189 }
|
173
|
3190 return string;
|
0
|
3191 }
|
|
3192 return Fkey_description (wrong_type_argument (Qsequencep, keys));
|
|
3193 }
|
|
3194
|
20
|
3195 DEFUN ("single-key-description", Fsingle_key_description, 1, 1, 0, /*
|
0
|
3196 Return a pretty description of command character KEY.
|
|
3197 Control characters turn into C-whatever, etc.
|
|
3198 This differs from `text-char-description' in that it returns a description
|
|
3199 of a key read from the user rather than a character from a buffer.
|
20
|
3200 */
|
|
3201 (key))
|
0
|
3202 {
|
|
3203 if (SYMBOLP (key))
|
|
3204 key = Fcons (key, Qnil); /* sleaze sleaze */
|
|
3205
|
70
|
3206 if (EVENTP (key) || CHAR_OR_CHAR_INTP (key))
|
0
|
3207 {
|
|
3208 char buf [255];
|
|
3209 if (!EVENTP (key))
|
|
3210 {
|
412
|
3211 struct Lisp_Event event;
|
0
|
3212 event.event_type = empty_event;
|
|
3213 CHECK_CHAR_COERCE_INT (key);
|
|
3214 character_to_event (XCHAR (key), &event,
|
263
|
3215 XCONSOLE (Vselected_console), 0, 1);
|
0
|
3216 format_event_object (buf, &event, 1);
|
|
3217 }
|
|
3218 else
|
|
3219 format_event_object (buf, XEVENT (key), 1);
|
173
|
3220 return build_string (buf);
|
0
|
3221 }
|
|
3222
|
|
3223 if (CONSP (key))
|
|
3224 {
|
|
3225 char buf[255];
|
|
3226 char *bufp = buf;
|
|
3227 Lisp_Object rest;
|
|
3228 buf[0] = 0;
|
|
3229 LIST_LOOP (rest, key)
|
|
3230 {
|
|
3231 Lisp_Object keysym = XCAR (rest);
|
|
3232 if (EQ (keysym, Qcontrol)) strcpy (bufp, "C-"), bufp += 2;
|
|
3233 else if (EQ (keysym, Qctrl)) strcpy (bufp, "C-"), bufp += 2;
|
|
3234 else if (EQ (keysym, Qmeta)) strcpy (bufp, "M-"), bufp += 2;
|
|
3235 else if (EQ (keysym, Qsuper)) strcpy (bufp, "S-"), bufp += 2;
|
|
3236 else if (EQ (keysym, Qhyper)) strcpy (bufp, "H-"), bufp += 2;
|
|
3237 else if (EQ (keysym, Qalt)) strcpy (bufp, "A-"), bufp += 2;
|
|
3238 else if (EQ (keysym, Qshift)) strcpy (bufp, "Sh-"), bufp += 3;
|
70
|
3239 else if (CHAR_OR_CHAR_INTP (keysym))
|
|
3240 {
|
|
3241 bufp += set_charptr_emchar ((Bufbyte *) bufp,
|
|
3242 XCHAR_OR_CHAR_INT (keysym));
|
|
3243 *bufp = 0;
|
|
3244 }
|
0
|
3245 else
|
|
3246 {
|
|
3247 CHECK_SYMBOL (keysym);
|
|
3248 #if 0 /* This is bogus */
|
185
|
3249 if (EQ (keysym, QKlinefeed)) strcpy (bufp, "LFD");
|
|
3250 else if (EQ (keysym, QKtab)) strcpy (bufp, "TAB");
|
|
3251 else if (EQ (keysym, QKreturn)) strcpy (bufp, "RET");
|
|
3252 else if (EQ (keysym, QKescape)) strcpy (bufp, "ESC");
|
|
3253 else if (EQ (keysym, QKdelete)) strcpy (bufp, "DEL");
|
|
3254 else if (EQ (keysym, QKspace)) strcpy (bufp, "SPC");
|
|
3255 else if (EQ (keysym, QKbackspace)) strcpy (bufp, "BS");
|
0
|
3256 else
|
|
3257 #endif
|
|
3258 strcpy (bufp, (char *) string_data (XSYMBOL (keysym)->name));
|
|
3259 if (!NILP (XCDR (rest)))
|
380
|
3260 signal_simple_error ("Invalid key description",
|
0
|
3261 key);
|
|
3262 }
|
|
3263 }
|
|
3264 return build_string (buf);
|
|
3265 }
|
|
3266 return Fsingle_key_description
|
|
3267 (wrong_type_argument (intern ("char-or-event-p"), key));
|
|
3268 }
|
|
3269
|
20
|
3270 DEFUN ("text-char-description", Ftext_char_description, 1, 1, 0, /*
|
0
|
3271 Return a pretty description of file-character CHR.
|
185
|
3272 Unprintable characters turn into "^char" or \\NNN, depending on the value
|
0
|
3273 of the `ctl-arrow' variable.
|
|
3274 This differs from `single-key-description' in that it returns a description
|
|
3275 of a character from a buffer rather than a key read from the user.
|
20
|
3276 */
|
|
3277 (chr))
|
0
|
3278 {
|
|
3279 Bufbyte buf[200];
|
|
3280 Bufbyte *p;
|
272
|
3281 Emchar c;
|
0
|
3282 Lisp_Object ctl_arrow = current_buffer->ctl_arrow;
|
|
3283 int ctl_p = !NILP (ctl_arrow);
|
70
|
3284 Emchar printable_min = (CHAR_OR_CHAR_INTP (ctl_arrow)
|
|
3285 ? XCHAR_OR_CHAR_INT (ctl_arrow)
|
|
3286 : ((EQ (ctl_arrow, Qt) || NILP (ctl_arrow))
|
|
3287 ? 256 : 160));
|
0
|
3288
|
|
3289 if (EVENTP (chr))
|
|
3290 {
|
|
3291 Lisp_Object ch = Fevent_to_character (chr, Qnil, Qnil, Qt);
|
|
3292 if (NILP (ch))
|
|
3293 return
|
|
3294 signal_simple_continuable_error
|
|
3295 ("character has no ASCII equivalent", Fcopy_event (chr, Qnil));
|
|
3296 chr = ch;
|
|
3297 }
|
|
3298
|
|
3299 CHECK_CHAR_COERCE_INT (chr);
|
|
3300
|
|
3301 c = XCHAR (chr);
|
|
3302 p = buf;
|
|
3303
|
|
3304 if (c >= printable_min)
|
|
3305 {
|
|
3306 p += set_charptr_emchar (p, c);
|
|
3307 }
|
|
3308 else if (c < 040 && ctl_p)
|
|
3309 {
|
|
3310 *p++ = '^';
|
|
3311 *p++ = c + 64; /* 'A' - 1 */
|
|
3312 }
|
|
3313 else if (c == 0177)
|
|
3314 {
|
|
3315 *p++ = '^';
|
|
3316 *p++ = '?';
|
|
3317 }
|
|
3318 else if (c >= 0200 || c < 040)
|
|
3319 {
|
|
3320 *p++ = '\\';
|
70
|
3321 #ifdef MULE
|
|
3322 /* !!#### This syntax is not readable. It will
|
|
3323 be interpreted as a 3-digit octal number rather
|
|
3324 than a 7-digit octal number. */
|
|
3325 if (c >= 0400)
|
|
3326 {
|
|
3327 *p++ = '0' + ((c & 07000000) >> 18);
|
|
3328 *p++ = '0' + ((c & 0700000) >> 15);
|
|
3329 *p++ = '0' + ((c & 070000) >> 12);
|
|
3330 *p++ = '0' + ((c & 07000) >> 9);
|
|
3331 }
|
|
3332 #endif
|
0
|
3333 *p++ = '0' + ((c & 0700) >> 6);
|
|
3334 *p++ = '0' + ((c & 0070) >> 3);
|
|
3335 *p++ = '0' + ((c & 0007));
|
|
3336 }
|
|
3337 else
|
|
3338 {
|
|
3339 p += set_charptr_emchar (p, c);
|
|
3340 }
|
|
3341
|
|
3342 *p = 0;
|
|
3343 return build_string ((char *) buf);
|
|
3344 }
|
|
3345
|
|
3346
|
|
3347 /************************************************************************/
|
|
3348 /* where-is (mapping bindings to keys) */
|
|
3349 /************************************************************************/
|
|
3350
|
|
3351 static Lisp_Object
|
|
3352 where_is_internal (Lisp_Object definition, Lisp_Object *maps, int nmaps,
|
|
3353 Lisp_Object firstonly, char *target_buffer);
|
|
3354
|
20
|
3355 DEFUN ("where-is-internal", Fwhere_is_internal, 1, 5, 0, /*
|
0
|
3356 Return list of keys that invoke DEFINITION in KEYMAPS.
|
|
3357 KEYMAPS can be either a keymap (meaning search in that keymap and the
|
|
3358 current global keymap) or a list of keymaps (meaning search in exactly
|
|
3359 those keymaps and no others). If KEYMAPS is nil, search in the currently
|
|
3360 applicable maps for EVENT-OR-KEYS (this is equivalent to specifying
|
|
3361 `(current-keymaps EVENT-OR-KEYS)' as the argument to KEYMAPS).
|
|
3362
|
|
3363 If optional 3rd arg FIRSTONLY is non-nil, return a vector representing
|
|
3364 the first key sequence found, rather than a list of all possible key
|
|
3365 sequences.
|
|
3366
|
|
3367 If optional 4th arg NOINDIRECT is non-nil, don't follow indirections
|
|
3368 to other keymaps or slots. This makes it possible to search for an
|
|
3369 indirect definition itself.
|
20
|
3370 */
|
|
3371 (definition, keymaps, firstonly, noindirect, event_or_keys))
|
0
|
3372 {
|
|
3373 /* This function can GC */
|
|
3374 Lisp_Object maps[100];
|
|
3375 Lisp_Object *gubbish = maps;
|
|
3376 int nmaps;
|
|
3377
|
|
3378 /* Get keymaps as an array */
|
|
3379 if (NILP (keymaps))
|
|
3380 {
|
|
3381 nmaps = get_relevant_keymaps (event_or_keys, countof (maps),
|
|
3382 gubbish);
|
|
3383 if (nmaps > countof (maps))
|
|
3384 {
|
185
|
3385 gubbish = alloca_array (Lisp_Object, nmaps);
|
0
|
3386 nmaps = get_relevant_keymaps (event_or_keys, nmaps, gubbish);
|
|
3387 }
|
|
3388 }
|
|
3389 else if (CONSP (keymaps))
|
|
3390 {
|
|
3391 Lisp_Object rest;
|
|
3392 int i;
|
|
3393
|
|
3394 nmaps = XINT (Flength (keymaps));
|
|
3395 if (nmaps > countof (maps))
|
|
3396 {
|
185
|
3397 gubbish = alloca_array (Lisp_Object, nmaps);
|
0
|
3398 }
|
|
3399 for (rest = keymaps, i = 0; !NILP (rest);
|
|
3400 rest = XCDR (keymaps), i++)
|
|
3401 {
|
|
3402 gubbish[i] = get_keymap (XCAR (keymaps), 1, 1);
|
|
3403 }
|
|
3404 }
|
|
3405 else
|
|
3406 {
|
|
3407 nmaps = 1;
|
|
3408 gubbish[0] = get_keymap (keymaps, 1, 1);
|
|
3409 if (!EQ (gubbish[0], Vcurrent_global_map))
|
|
3410 {
|
|
3411 gubbish[1] = Vcurrent_global_map;
|
|
3412 nmaps++;
|
|
3413 }
|
|
3414 }
|
185
|
3415
|
0
|
3416 return where_is_internal (definition, gubbish, nmaps, firstonly, 0);
|
|
3417 }
|
|
3418
|
|
3419 /* This function is like
|
|
3420 (key-description (where-is-internal definition nil t))
|
185
|
3421 except that it writes its output into a (char *) buffer that you
|
0
|
3422 provide; it doesn't cons (or allocate memory) at all, so it's
|
|
3423 very fast. This is used by menubar.c.
|
|
3424 */
|
|
3425 void
|
|
3426 where_is_to_char (Lisp_Object definition, char *buffer)
|
|
3427 {
|
|
3428 /* This function can GC */
|
|
3429 Lisp_Object maps[100];
|
|
3430 Lisp_Object *gubbish = maps;
|
|
3431 int nmaps;
|
|
3432
|
|
3433 /* Get keymaps as an array */
|
|
3434 nmaps = get_relevant_keymaps (Qnil, countof (maps), gubbish);
|
|
3435 if (nmaps > countof (maps))
|
|
3436 {
|
185
|
3437 gubbish = alloca_array (Lisp_Object, nmaps);
|
0
|
3438 nmaps = get_relevant_keymaps (Qnil, nmaps, gubbish);
|
|
3439 }
|
|
3440
|
|
3441 buffer[0] = 0;
|
|
3442 where_is_internal (definition, maps, nmaps, Qt, buffer);
|
|
3443 }
|
|
3444
|
|
3445
|
185
|
3446 static Lisp_Object
|
0
|
3447 raw_keys_to_keys (struct key_data *keys, int count)
|
|
3448 {
|
|
3449 Lisp_Object result = make_vector (count, Qnil);
|
|
3450 while (count--)
|
173
|
3451 XVECTOR_DATA (result) [count] = make_key_description (&(keys[count]), 1);
|
|
3452 return result;
|
0
|
3453 }
|
|
3454
|
|
3455
|
|
3456 static void
|
|
3457 format_raw_keys (struct key_data *keys, int count, char *buf)
|
|
3458 {
|
|
3459 int i;
|
412
|
3460 struct Lisp_Event event;
|
0
|
3461 event.event_type = key_press_event;
|
|
3462 event.channel = Vselected_console;
|
|
3463 for (i = 0; i < count; i++)
|
|
3464 {
|
|
3465 event.event.key.keysym = keys[i].keysym;
|
|
3466 event.event.key.modifiers = keys[i].modifiers;
|
|
3467 format_event_object (buf, &event, 1);
|
|
3468 buf += strlen (buf);
|
|
3469 if (i < count-1)
|
|
3470 buf[0] = ' ', buf++;
|
|
3471 }
|
|
3472 }
|
|
3473
|
|
3474
|
|
3475 /* definition is the thing to look for.
|
|
3476 map is a keymap.
|
|
3477 shadow is an array of shadow_count keymaps; if there is a different
|
|
3478 binding in any of the keymaps of a key that we are considering
|
|
3479 returning, then we reconsider.
|
|
3480 firstonly means give up after finding the first match;
|
|
3481 keys_so_far and modifiers_so_far describe which map we're looking in;
|
|
3482 If we're in the "meta" submap of the map that "C-x 4" is bound to,
|
|
3483 then keys_so_far will be {(control x), \4}, and modifiers_so_far
|
412
|
3484 will be MOD_META. That is, keys_so_far is the chain of keys that we
|
0
|
3485 have followed, and modifiers_so_far_so_far is the bits (partial keys)
|
|
3486 beyond that.
|
185
|
3487
|
0
|
3488 (keys_so_far is a global buffer and the keys_count arg says how much
|
|
3489 of it we're currently interested in.)
|
185
|
3490
|
0
|
3491 If target_buffer is provided, then we write a key-description into it,
|
|
3492 to avoid consing a string. This only works with firstonly on.
|
|
3493 */
|
|
3494
|
|
3495 struct where_is_closure
|
|
3496 {
|
|
3497 Lisp_Object definition;
|
|
3498 Lisp_Object *shadow;
|
|
3499 int shadow_count;
|
|
3500 int firstonly;
|
|
3501 int keys_count;
|
412
|
3502 unsigned int modifiers_so_far;
|
0
|
3503 char *target_buffer;
|
|
3504 struct key_data *keys_so_far;
|
|
3505 int keys_so_far_total_size;
|
|
3506 int keys_so_far_malloced;
|
|
3507 };
|
|
3508
|
|
3509 static Lisp_Object where_is_recursive_mapper (Lisp_Object map, void *arg);
|
|
3510
|
|
3511 static Lisp_Object
|
|
3512 where_is_recursive_mapper (Lisp_Object map, void *arg)
|
|
3513 {
|
|
3514 /* This function can GC */
|
185
|
3515 struct where_is_closure *c = (struct where_is_closure *) arg;
|
0
|
3516 Lisp_Object definition = c->definition;
|
412
|
3517 CONST int firstonly = c->firstonly;
|
|
3518 CONST unsigned int keys_count = c->keys_count;
|
|
3519 CONST unsigned int modifiers_so_far = c->modifiers_so_far;
|
0
|
3520 char *target_buffer = c->target_buffer;
|
|
3521 Lisp_Object keys = Fgethash (definition,
|
|
3522 XKEYMAP (map)->inverse_table,
|
|
3523 Qnil);
|
|
3524 Lisp_Object submaps;
|
|
3525 Lisp_Object result = Qnil;
|
|
3526
|
|
3527 if (!NILP (keys))
|
|
3528 {
|
185
|
3529 /* One or more keys in this map match the definition we're looking for.
|
|
3530 Verify that these bindings aren't shadowed by other bindings
|
0
|
3531 in the shadow maps. Either nil or number as value from
|
185
|
3532 raw_lookup_key() means undefined. */
|
0
|
3533 struct key_data *so_far = c->keys_so_far;
|
|
3534
|
|
3535 for (;;) /* loop over all keys that match */
|
|
3536 {
|
412
|
3537 Lisp_Object k = ((CONSP (keys)) ? XCAR (keys) : keys);
|
0
|
3538 int i;
|
185
|
3539
|
0
|
3540 so_far [keys_count].keysym = k;
|
|
3541 so_far [keys_count].modifiers = modifiers_so_far;
|
|
3542
|
|
3543 /* now loop over all shadow maps */
|
|
3544 for (i = 0; i < c->shadow_count; i++)
|
|
3545 {
|
|
3546 Lisp_Object shadowed = raw_lookup_key (c->shadow[i],
|
|
3547 so_far,
|
185
|
3548 keys_count + 1,
|
0
|
3549 0, 1);
|
|
3550
|
|
3551 if (NILP (shadowed) || CHARP (shadowed) ||
|
|
3552 EQ (shadowed, definition))
|
|
3553 continue; /* we passed this test; it's not shadowed here. */
|
|
3554 else
|
|
3555 /* ignore this key binding, since it actually has a
|
|
3556 different binding in a shadowing map */
|
|
3557 goto c_doesnt_have_proper_loop_exit_statements;
|
|
3558 }
|
|
3559
|
|
3560 /* OK, the key is for real */
|
|
3561 if (target_buffer)
|
|
3562 {
|
|
3563 if (!firstonly) abort ();
|
|
3564 format_raw_keys (so_far, keys_count + 1, target_buffer);
|
173
|
3565 return make_int (1);
|
0
|
3566 }
|
|
3567 else if (firstonly)
|
|
3568 return raw_keys_to_keys (so_far, keys_count + 1);
|
|
3569 else
|
|
3570 result = Fcons (raw_keys_to_keys (so_far, keys_count + 1),
|
|
3571 result);
|
|
3572
|
|
3573 c_doesnt_have_proper_loop_exit_statements:
|
|
3574 /* now on to the next matching key ... */
|
|
3575 if (!CONSP (keys)) break;
|
|
3576 keys = XCDR (keys);
|
|
3577 }
|
|
3578 }
|
|
3579
|
|
3580 /* Now search the sub-keymaps of this map.
|
185
|
3581 If we're in "firstonly" mode and have already found one, this
|
0
|
3582 point is not reached. If we get one from lower down, either
|
|
3583 return it immediately (in firstonly mode) or tack it onto the
|
|
3584 end of the ones we've gotten so far.
|
|
3585 */
|
|
3586 for (submaps = keymap_submaps (map);
|
|
3587 !NILP (submaps);
|
|
3588 submaps = XCDR (submaps))
|
|
3589 {
|
|
3590 Lisp_Object key = XCAR (XCAR (submaps));
|
|
3591 Lisp_Object submap = XCDR (XCAR (submaps));
|
412
|
3592 unsigned int lower_modifiers;
|
0
|
3593 int lower_keys_count = keys_count;
|
412
|
3594 unsigned int bucky;
|
0
|
3595
|
185
|
3596 submap = get_keymap (submap, 0, 0);
|
0
|
3597
|
|
3598 if (EQ (submap, map))
|
|
3599 /* Arrgh! Some loser has introduced a loop... */
|
|
3600 continue;
|
|
3601
|
|
3602 /* If this is not a keymap, then that's probably because someone
|
|
3603 did an `fset' of a symbol that used to point to a map such that
|
|
3604 it no longer does. Sigh. Ignore this, and invalidate the cache
|
|
3605 so that it doesn't happen to us next time too.
|
|
3606 */
|
|
3607 if (NILP (submap))
|
|
3608 {
|
|
3609 XKEYMAP (map)->sub_maps_cache = Qt;
|
|
3610 continue;
|
|
3611 }
|
|
3612
|
|
3613 /* If the map is a "bucky" map, then add a bit to the
|
|
3614 modifiers_so_far list.
|
|
3615 Otherwise, add a new raw_key onto the end of keys_so_far.
|
|
3616 */
|
|
3617 bucky = MODIFIER_HASH_KEY_BITS (key);
|
|
3618 if (bucky != 0)
|
|
3619 lower_modifiers = (modifiers_so_far | bucky);
|
|
3620 else
|
|
3621 {
|
|
3622 struct key_data *so_far = c->keys_so_far;
|
|
3623 lower_modifiers = 0;
|
|
3624 so_far [lower_keys_count].keysym = key;
|
|
3625 so_far [lower_keys_count].modifiers = modifiers_so_far;
|
|
3626 lower_keys_count++;
|
|
3627 }
|
|
3628
|
|
3629 if (lower_keys_count >= c->keys_so_far_total_size)
|
|
3630 {
|
|
3631 int size = lower_keys_count + 50;
|
|
3632 if (! c->keys_so_far_malloced)
|
|
3633 {
|
185
|
3634 struct key_data *new = xnew_array (struct key_data, size);
|
412
|
3635 memcpy ((void *)new, (CONST void *)c->keys_so_far,
|
0
|
3636 c->keys_so_far_total_size * sizeof (struct key_data));
|
|
3637 }
|
|
3638 else
|
185
|
3639 XREALLOC_ARRAY (c->keys_so_far, struct key_data, size);
|
0
|
3640
|
|
3641 c->keys_so_far_total_size = size;
|
|
3642 c->keys_so_far_malloced = 1;
|
|
3643 }
|
|
3644
|
|
3645 {
|
|
3646 Lisp_Object lower;
|
|
3647
|
|
3648 c->keys_count = lower_keys_count;
|
|
3649 c->modifiers_so_far = lower_modifiers;
|
|
3650
|
185
|
3651 lower = traverse_keymaps (submap, Qnil, where_is_recursive_mapper, c);
|
|
3652
|
0
|
3653 c->keys_count = keys_count;
|
|
3654 c->modifiers_so_far = modifiers_so_far;
|
|
3655
|
|
3656 if (!firstonly)
|
|
3657 result = nconc2 (lower, result);
|
|
3658 else if (!NILP (lower))
|
173
|
3659 return lower;
|
0
|
3660 }
|
|
3661 }
|
173
|
3662 return result;
|
0
|
3663 }
|
|
3664
|
|
3665
|
|
3666 static Lisp_Object
|
|
3667 where_is_internal (Lisp_Object definition, Lisp_Object *maps, int nmaps,
|
|
3668 Lisp_Object firstonly, char *target_buffer)
|
|
3669 {
|
|
3670 /* This function can GC */
|
|
3671 Lisp_Object result = Qnil;
|
|
3672 int i;
|
|
3673 struct key_data raw[20];
|
|
3674 struct where_is_closure c;
|
|
3675
|
|
3676 c.definition = definition;
|
|
3677 c.shadow = maps;
|
|
3678 c.firstonly = !NILP (firstonly);
|
|
3679 c.target_buffer = target_buffer;
|
|
3680 c.keys_so_far = raw;
|
|
3681 c.keys_so_far_total_size = countof (raw);
|
|
3682 c.keys_so_far_malloced = 0;
|
|
3683
|
|
3684 /* Loop over each of the maps, accumulating the keys found.
|
|
3685 For each map searched, all previous maps shadow this one
|
|
3686 so that bogus keys aren't listed. */
|
|
3687 for (i = 0; i < nmaps; i++)
|
|
3688 {
|
|
3689 Lisp_Object this_result;
|
|
3690 c.shadow_count = i;
|
|
3691 /* Reset the things set in each iteration */
|
|
3692 c.keys_count = 0;
|
|
3693 c.modifiers_so_far = 0;
|
|
3694
|
|
3695 this_result = traverse_keymaps (maps[i], Qnil, where_is_recursive_mapper,
|
|
3696 &c);
|
|
3697 if (!NILP (firstonly))
|
|
3698 {
|
|
3699 result = this_result;
|
|
3700 if (!NILP (result))
|
|
3701 break;
|
|
3702 }
|
|
3703 else
|
|
3704 result = nconc2 (this_result, result);
|
|
3705 }
|
|
3706
|
|
3707 if (NILP (firstonly))
|
|
3708 result = Fnreverse (result);
|
|
3709
|
|
3710 if (c.keys_so_far_malloced)
|
|
3711 xfree (c.keys_so_far);
|
173
|
3712 return result;
|
0
|
3713 }
|
|
3714
|
|
3715
|
|
3716 /************************************************************************/
|
|
3717 /* Describing keymaps */
|
|
3718 /************************************************************************/
|
|
3719
|
20
|
3720 DEFUN ("describe-bindings-internal", Fdescribe_bindings_internal, 1, 5, 0, /*
|
0
|
3721 Insert a list of all defined keys and their definitions in MAP.
|
185
|
3722 Optional second argument ALL says whether to include even "uninteresting"
|
0
|
3723 definitions (ie symbols with a non-nil `suppress-keymap' property.
|
|
3724 Third argument SHADOW is a list of keymaps whose bindings shadow those
|
|
3725 of map; if a binding is present in any shadowing map, it is not printed.
|
|
3726 Fourth argument PREFIX, if non-nil, should be a key sequence;
|
|
3727 only bindings which start with that key sequence will be printed.
|
|
3728 Fifth argument MOUSE-ONLY-P says to only print bindings for mouse clicks.
|
20
|
3729 */
|
|
3730 (map, all, shadow, prefix, mouse_only_p))
|
0
|
3731 {
|
|
3732 /* This function can GC */
|
219
|
3733
|
|
3734 /* #### At some point, this function should be changed to accept a
|
|
3735 BUFFER argument. Currently, the BUFFER argument to
|
|
3736 describe_map_tree is being used only internally. */
|
0
|
3737 describe_map_tree (map, NILP (all), shadow, prefix,
|
219
|
3738 !NILP (mouse_only_p), Fcurrent_buffer ());
|
173
|
3739 return Qnil;
|
0
|
3740 }
|
|
3741
|
|
3742
|
380
|
3743 /* Insert a description of the key bindings in STARTMAP,
|
0
|
3744 followed by those of all maps reachable through STARTMAP.
|
|
3745 If PARTIAL is nonzero, omit certain "uninteresting" commands
|
|
3746 (such as `undefined').
|
|
3747 If SHADOW is non-nil, it is a list of other maps;
|
|
3748 don't mention keys which would be shadowed by any of them
|
185
|
3749 If PREFIX is non-nil, only list bindings which start with those keys.
|
0
|
3750 */
|
|
3751
|
|
3752 void
|
|
3753 describe_map_tree (Lisp_Object startmap, int partial, Lisp_Object shadow,
|
219
|
3754 Lisp_Object prefix, int mice_only_p, Lisp_Object buffer)
|
0
|
3755 {
|
|
3756 /* This function can GC */
|
|
3757 Lisp_Object maps = Qnil;
|
|
3758 struct gcpro gcpro1, gcpro2; /* get_keymap may autoload */
|
|
3759 GCPRO2 (maps, shadow);
|
|
3760
|
|
3761 maps = Faccessible_keymaps (startmap, prefix);
|
|
3762
|
|
3763 for (; !NILP (maps); maps = Fcdr (maps))
|
|
3764 {
|
|
3765 Lisp_Object sub_shadow = Qnil;
|
|
3766 Lisp_Object elt = Fcar (maps);
|
185
|
3767 Lisp_Object tail;
|
0
|
3768 int no_prefix = (VECTORP (Fcar (elt))
|
|
3769 && XINT (Flength (Fcar (elt))) == 0);
|
|
3770 struct gcpro ngcpro1, ngcpro2, ngcpro3;
|
|
3771 NGCPRO3 (sub_shadow, elt, tail);
|
|
3772
|
185
|
3773 for (tail = shadow; CONSP (tail); tail = XCDR (tail))
|
0
|
3774 {
|
185
|
3775 Lisp_Object shmap = XCAR (tail);
|
0
|
3776
|
|
3777 /* If the sequence by which we reach this keymap is zero-length,
|
|
3778 then the shadow maps for this keymap are just SHADOW. */
|
|
3779 if (no_prefix)
|
|
3780 ;
|
|
3781 /* If the sequence by which we reach this keymap actually has
|
|
3782 some elements, then the sequence's definition in SHADOW is
|
|
3783 what we should use. */
|
|
3784 else
|
|
3785 {
|
185
|
3786 shmap = Flookup_key (shmap, Fcar (elt), Qt);
|
|
3787 if (CHARP (shmap))
|
|
3788 shmap = Qnil;
|
0
|
3789 }
|
|
3790
|
185
|
3791 if (!NILP (shmap))
|
0
|
3792 {
|
185
|
3793 Lisp_Object shm = get_keymap (shmap, 0, 1);
|
|
3794 /* If shmap is not nil and not a keymap, it completely
|
|
3795 shadows this map, so don't describe this map at all. */
|
0
|
3796 if (!KEYMAPP (shm))
|
|
3797 goto SKIP;
|
|
3798 sub_shadow = Fcons (shm, sub_shadow);
|
|
3799 }
|
|
3800 }
|
|
3801
|
|
3802 {
|
|
3803 /* Describe the contents of map MAP, assuming that this map
|
|
3804 itself is reached by the sequence of prefix keys KEYS (a vector).
|
|
3805 PARTIAL and SHADOW are as in `describe_map_tree'. */
|
|
3806 Lisp_Object keysdesc
|
|
3807 = ((!no_prefix)
|
|
3808 ? concat2 (Fkey_description (Fcar (elt)), Vsingle_space_string)
|
|
3809 : Qnil);
|
|
3810 describe_map (Fcdr (elt), keysdesc,
|
|
3811 describe_command,
|
|
3812 partial,
|
|
3813 sub_shadow,
|
219
|
3814 mice_only_p,
|
|
3815 buffer);
|
0
|
3816 }
|
|
3817 SKIP:
|
|
3818 NUNGCPRO;
|
|
3819 }
|
|
3820 UNGCPRO;
|
|
3821 }
|
|
3822
|
|
3823
|
|
3824 static void
|
219
|
3825 describe_command (Lisp_Object definition, Lisp_Object buffer)
|
0
|
3826 {
|
|
3827 /* This function can GC */
|
|
3828 int keymapp = !NILP (Fkeymapp (definition));
|
219
|
3829 struct gcpro gcpro1;
|
|
3830 GCPRO1 (definition);
|
|
3831
|
0
|
3832 Findent_to (make_int (16), make_int (3), buffer);
|
|
3833 if (keymapp)
|
|
3834 buffer_insert_c_string (XBUFFER (buffer), "<< ");
|
|
3835
|
|
3836 if (SYMBOLP (definition))
|
|
3837 {
|
|
3838 buffer_insert1 (XBUFFER (buffer), Fsymbol_name (definition));
|
|
3839 }
|
|
3840 else if (STRINGP (definition) || VECTORP (definition))
|
|
3841 {
|
|
3842 buffer_insert_c_string (XBUFFER (buffer), "Kbd Macro: ");
|
|
3843 buffer_insert1 (XBUFFER (buffer), Fkey_description (definition));
|
|
3844 }
|
|
3845 else if (COMPILED_FUNCTIONP (definition))
|
|
3846 buffer_insert_c_string (XBUFFER (buffer), "Anonymous Compiled Function");
|
|
3847 else if (CONSP (definition) && EQ (XCAR (definition), Qlambda))
|
|
3848 buffer_insert_c_string (XBUFFER (buffer), "Anonymous Lambda");
|
|
3849 else if (KEYMAPP (definition))
|
|
3850 {
|
|
3851 Lisp_Object name = XKEYMAP (definition)->name;
|
|
3852 if (STRINGP (name) || (SYMBOLP (name) && !NILP (name)))
|
|
3853 {
|
|
3854 buffer_insert_c_string (XBUFFER (buffer), "Prefix command ");
|
185
|
3855 if (SYMBOLP (name)
|
0
|
3856 && EQ (find_symbol_value (name), definition))
|
|
3857 buffer_insert1 (XBUFFER (buffer), Fsymbol_name (name));
|
|
3858 else
|
|
3859 {
|
|
3860 buffer_insert1 (XBUFFER (buffer), Fprin1_to_string (name, Qnil));
|
|
3861 }
|
|
3862 }
|
|
3863 else
|
|
3864 buffer_insert_c_string (XBUFFER (buffer), "Prefix Command");
|
|
3865 }
|
|
3866 else
|
|
3867 buffer_insert_c_string (XBUFFER (buffer), "??");
|
|
3868
|
|
3869 if (keymapp)
|
|
3870 buffer_insert_c_string (XBUFFER (buffer), " >>");
|
|
3871 buffer_insert_c_string (XBUFFER (buffer), "\n");
|
|
3872 UNGCPRO;
|
|
3873 }
|
|
3874
|
|
3875 struct describe_map_closure
|
|
3876 {
|
|
3877 Lisp_Object *list; /* pointer to the list to update */
|
|
3878 Lisp_Object partial; /* whether to ignore suppressed commands */
|
|
3879 Lisp_Object shadow; /* list of maps shadowing this one */
|
|
3880 Lisp_Object self; /* this map */
|
|
3881 Lisp_Object self_root; /* this map, or some map that has this map as
|
|
3882 a parent. this is the base of the tree */
|
|
3883 int mice_only_p; /* whether we are to display only button bindings */
|
|
3884 };
|
|
3885
|
|
3886 struct describe_map_shadow_closure
|
|
3887 {
|
412
|
3888 CONST struct key_data *raw_key;
|
0
|
3889 Lisp_Object self;
|
|
3890 };
|
|
3891
|
|
3892 static Lisp_Object
|
|
3893 describe_map_mapper_shadow_search (Lisp_Object map, void *arg)
|
|
3894 {
|
185
|
3895 struct describe_map_shadow_closure *c =
|
|
3896 (struct describe_map_shadow_closure *) arg;
|
0
|
3897
|
|
3898 if (EQ (map, c->self))
|
173
|
3899 return Qzero; /* Not shadowed; terminate search */
|
185
|
3900
|
272
|
3901 return !NILP (keymap_lookup_directly (map,
|
|
3902 c->raw_key->keysym,
|
|
3903 c->raw_key->modifiers))
|
185
|
3904 ? Qt : Qnil;
|
0
|
3905 }
|
185
|
3906
|
0
|
3907
|
|
3908 static Lisp_Object
|
|
3909 keymap_lookup_inherited_mapper (Lisp_Object km, void *arg)
|
|
3910 {
|
185
|
3911 struct key_data *k = (struct key_data *) arg;
|
173
|
3912 return keymap_lookup_directly (km, k->keysym, k->modifiers);
|
0
|
3913 }
|
|
3914
|
|
3915
|
|
3916 static void
|
412
|
3917 describe_map_mapper (CONST struct key_data *key,
|
0
|
3918 Lisp_Object binding,
|
|
3919 void *describe_map_closure)
|
|
3920 {
|
|
3921 /* This function can GC */
|
185
|
3922 struct describe_map_closure *closure =
|
|
3923 (struct describe_map_closure *) describe_map_closure;
|
0
|
3924 Lisp_Object keysym = key->keysym;
|
412
|
3925 unsigned int modifiers = key->modifiers;
|
0
|
3926
|
380
|
3927 /* Don't mention suppressed commands. */
|
0
|
3928 if (SYMBOLP (binding)
|
|
3929 && !NILP (closure->partial)
|
|
3930 && !NILP (Fget (binding, closure->partial, Qnil)))
|
|
3931 return;
|
185
|
3932
|
0
|
3933 /* If we're only supposed to display mouse bindings and this isn't one,
|
|
3934 then bug out. */
|
|
3935 if (closure->mice_only_p &&
|
185
|
3936 (! (EQ (keysym, Qbutton0) ||
|
|
3937 EQ (keysym, Qbutton1) ||
|
|
3938 EQ (keysym, Qbutton2) ||
|
|
3939 EQ (keysym, Qbutton3) ||
|
|
3940 EQ (keysym, Qbutton4) ||
|
|
3941 EQ (keysym, Qbutton5) ||
|
|
3942 EQ (keysym, Qbutton6) ||
|
215
|
3943 EQ (keysym, Qbutton7) ||
|
|
3944 EQ (keysym, Qbutton0up) ||
|
|
3945 EQ (keysym, Qbutton1up) ||
|
|
3946 EQ (keysym, Qbutton2up) ||
|
|
3947 EQ (keysym, Qbutton3up) ||
|
|
3948 EQ (keysym, Qbutton4up) ||
|
|
3949 EQ (keysym, Qbutton5up) ||
|
|
3950 EQ (keysym, Qbutton6up) ||
|
|
3951 EQ (keysym, Qbutton7up))))
|
0
|
3952 return;
|
|
3953
|
|
3954 /* If this command in this map is shadowed by some other map, ignore it. */
|
|
3955 {
|
|
3956 Lisp_Object tail;
|
|
3957
|
|
3958 for (tail = closure->shadow; CONSP (tail); tail = XCDR (tail))
|
|
3959 {
|
|
3960 QUIT;
|
|
3961 if (!NILP (traverse_keymaps (XCAR (tail), Qnil,
|
|
3962 keymap_lookup_inherited_mapper,
|
|
3963 /* Cast to discard `const' */
|
|
3964 (void *)key)))
|
|
3965 return;
|
|
3966 }
|
|
3967 }
|
|
3968
|
|
3969 /* If this key is in some map of which this map is a parent, then ignore
|
|
3970 it (in that case, it has been shadowed).
|
|
3971 */
|
|
3972 {
|
|
3973 Lisp_Object sh;
|
|
3974 struct describe_map_shadow_closure c;
|
|
3975 c.raw_key = key;
|
|
3976 c.self = closure->self;
|
|
3977
|
|
3978 sh = traverse_keymaps (closure->self_root, Qnil,
|
|
3979 describe_map_mapper_shadow_search, &c);
|
|
3980 if (!NILP (sh) && !ZEROP (sh))
|
|
3981 return;
|
|
3982 }
|
|
3983
|
|
3984 /* Otherwise add it to the list to be sorted. */
|
|
3985 *(closure->list) = Fcons (Fcons (Fcons (keysym, make_int (modifiers)),
|
|
3986 binding),
|
|
3987 *(closure->list));
|
|
3988 }
|
|
3989
|
|
3990
|
|
3991 static int
|
185
|
3992 describe_map_sort_predicate (Lisp_Object obj1, Lisp_Object obj2,
|
0
|
3993 Lisp_Object pred)
|
|
3994 {
|
|
3995 /* obj1 and obj2 are conses of the form
|
|
3996 ( ( <keysym> . <modifiers> ) . <binding> )
|
|
3997 keysym and modifiers are used, binding is ignored.
|
|
3998 */
|
412
|
3999 unsigned int bit1, bit2;
|
0
|
4000 obj1 = XCAR (obj1);
|
|
4001 obj2 = XCAR (obj2);
|
|
4002 bit1 = XINT (XCDR (obj1));
|
|
4003 bit2 = XINT (XCDR (obj2));
|
|
4004 if (bit1 != bit2)
|
173
|
4005 return bit1 < bit2 ? 1 : -1;
|
0
|
4006 else
|
|
4007 return map_keymap_sort_predicate (obj1, obj2, pred);
|
|
4008 }
|
|
4009
|
|
4010 /* Elide 2 or more consecutive numeric keysyms bound to the same thing,
|
|
4011 or 2 or more symbolic keysyms that are bound to the same thing and
|
|
4012 have consecutive character-set-properties.
|
|
4013 */
|
|
4014 static int
|
|
4015 elide_next_two_p (Lisp_Object list)
|
|
4016 {
|
|
4017 Lisp_Object s1, s2;
|
|
4018
|
|
4019 if (NILP (XCDR (list)))
|
|
4020 return 0;
|
|
4021
|
|
4022 /* next two bindings differ */
|
|
4023 if (!EQ (XCDR (XCAR (list)),
|
|
4024 XCDR (XCAR (XCDR (list)))))
|
|
4025 return 0;
|
|
4026
|
|
4027 /* next two modifier-sets differ */
|
|
4028 if (!EQ (XCDR (XCAR (XCAR (list))),
|
|
4029 XCDR (XCAR (XCAR (XCDR (list))))))
|
|
4030 return 0;
|
|
4031
|
|
4032 s1 = XCAR (XCAR (XCAR (list)));
|
|
4033 s2 = XCAR (XCAR (XCAR (XCDR (list))));
|
|
4034
|
|
4035 if (SYMBOLP (s1))
|
|
4036 {
|
|
4037 Lisp_Object code = Fget (s1, Vcharacter_set_property, Qnil);
|
70
|
4038 if (CHAR_OR_CHAR_INTP (code))
|
|
4039 {
|
|
4040 s1 = code;
|
|
4041 CHECK_CHAR_COERCE_INT (s1);
|
|
4042 }
|
0
|
4043 else return 0;
|
|
4044 }
|
|
4045 if (SYMBOLP (s2))
|
|
4046 {
|
|
4047 Lisp_Object code = Fget (s2, Vcharacter_set_property, Qnil);
|
70
|
4048 if (CHAR_OR_CHAR_INTP (code))
|
|
4049 {
|
|
4050 s2 = code;
|
|
4051 CHECK_CHAR_COERCE_INT (s2);
|
|
4052 }
|
0
|
4053 else return 0;
|
|
4054 }
|
|
4055
|
185
|
4056 return (XCHAR (s1) == XCHAR (s2) ||
|
|
4057 XCHAR (s1) + 1 == XCHAR (s2));
|
0
|
4058 }
|
|
4059
|
|
4060
|
|
4061 static Lisp_Object
|
|
4062 describe_map_parent_mapper (Lisp_Object keymap, void *arg)
|
|
4063 {
|
|
4064 /* This function can GC */
|
185
|
4065 struct describe_map_closure *describe_map_closure =
|
|
4066 (struct describe_map_closure *) arg;
|
0
|
4067 describe_map_closure->self = keymap;
|
|
4068 map_keymap (XKEYMAP (keymap)->table,
|
|
4069 0, /* don't sort: we'll do it later */
|
|
4070 describe_map_mapper, describe_map_closure);
|
173
|
4071 return Qnil;
|
0
|
4072 }
|
|
4073
|
|
4074
|
185
|
4075 /* Describe the contents of map MAP, assuming that this map itself is
|
|
4076 reached by the sequence of prefix keys KEYS (a string or vector).
|
|
4077 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */
|
|
4078
|
0
|
4079 static void
|
|
4080 describe_map (Lisp_Object keymap, Lisp_Object elt_prefix,
|
219
|
4081 void (*elt_describer) (Lisp_Object, Lisp_Object),
|
185
|
4082 int partial,
|
0
|
4083 Lisp_Object shadow,
|
219
|
4084 int mice_only_p,
|
|
4085 Lisp_Object buffer)
|
0
|
4086 {
|
|
4087 /* This function can GC */
|
|
4088 struct describe_map_closure describe_map_closure;
|
|
4089 Lisp_Object list = Qnil;
|
219
|
4090 struct buffer *buf = XBUFFER (buffer);
|
0
|
4091 Emchar printable_min = (CHAR_OR_CHAR_INTP (buf->ctl_arrow)
|
|
4092 ? XCHAR_OR_CHAR_INT (buf->ctl_arrow)
|
|
4093 : ((EQ (buf->ctl_arrow, Qt)
|
|
4094 || EQ (buf->ctl_arrow, Qnil))
|
|
4095 ? 256 : 160));
|
|
4096 int elided = 0;
|
|
4097 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
|
|
4098
|
|
4099 keymap = get_keymap (keymap, 1, 1);
|
|
4100 describe_map_closure.partial = (partial ? Qsuppress_keymap : Qnil);
|
|
4101 describe_map_closure.shadow = shadow;
|
|
4102 describe_map_closure.list = &list;
|
|
4103 describe_map_closure.self_root = keymap;
|
|
4104 describe_map_closure.mice_only_p = mice_only_p;
|
|
4105
|
|
4106 GCPRO4 (keymap, elt_prefix, shadow, list);
|
|
4107
|
|
4108 traverse_keymaps (keymap, Qnil,
|
|
4109 describe_map_parent_mapper, &describe_map_closure);
|
|
4110
|
|
4111 if (!NILP (list))
|
|
4112 {
|
|
4113 list = list_sort (list, Qnil, describe_map_sort_predicate);
|
|
4114 buffer_insert_c_string (buf, "\n");
|
|
4115 while (!NILP (list))
|
|
4116 {
|
|
4117 Lisp_Object elt = XCAR (XCAR (list));
|
|
4118 Lisp_Object keysym = XCAR (elt);
|
412
|
4119 unsigned int modifiers = XINT (XCDR (elt));
|
0
|
4120
|
|
4121 if (!NILP (elt_prefix))
|
|
4122 buffer_insert_lisp_string (buf, elt_prefix);
|
|
4123
|
412
|
4124 if (modifiers & MOD_META) buffer_insert_c_string (buf, "M-");
|
|
4125 if (modifiers & MOD_CONTROL) buffer_insert_c_string (buf, "C-");
|
|
4126 if (modifiers & MOD_SUPER) buffer_insert_c_string (buf, "S-");
|
|
4127 if (modifiers & MOD_HYPER) buffer_insert_c_string (buf, "H-");
|
|
4128 if (modifiers & MOD_ALT) buffer_insert_c_string (buf, "Alt-");
|
|
4129 if (modifiers & MOD_SHIFT) buffer_insert_c_string (buf, "Sh-");
|
0
|
4130 if (SYMBOLP (keysym))
|
|
4131 {
|
|
4132 Lisp_Object code = Fget (keysym, Vcharacter_set_property, Qnil);
|
|
4133 Emchar c = (CHAR_OR_CHAR_INTP (code)
|
380
|
4134 ? XCHAR_OR_CHAR_INT (code) : (Emchar) -1);
|
0
|
4135 /* Calling Fsingle_key_description() would cons more */
|
|
4136 #if 0 /* This is bogus */
|
|
4137 if (EQ (keysym, QKlinefeed))
|
|
4138 buffer_insert_c_string (buf, "LFD");
|
|
4139 else if (EQ (keysym, QKtab))
|
|
4140 buffer_insert_c_string (buf, "TAB");
|
|
4141 else if (EQ (keysym, QKreturn))
|
|
4142 buffer_insert_c_string (buf, "RET");
|
|
4143 else if (EQ (keysym, QKescape))
|
|
4144 buffer_insert_c_string (buf, "ESC");
|
|
4145 else if (EQ (keysym, QKdelete))
|
|
4146 buffer_insert_c_string (buf, "DEL");
|
|
4147 else if (EQ (keysym, QKspace))
|
|
4148 buffer_insert_c_string (buf, "SPC");
|
|
4149 else if (EQ (keysym, QKbackspace))
|
|
4150 buffer_insert_c_string (buf, "BS");
|
185
|
4151 else
|
0
|
4152 #endif
|
|
4153 if (c >= printable_min)
|
|
4154 buffer_insert_emacs_char (buf, c);
|
|
4155 else buffer_insert1 (buf, Fsymbol_name (keysym));
|
|
4156 }
|
|
4157 else if (CHARP (keysym))
|
|
4158 buffer_insert_emacs_char (buf, XCHAR (keysym));
|
|
4159 else
|
|
4160 buffer_insert_c_string (buf, "---bad keysym---");
|
|
4161
|
|
4162 if (elided)
|
|
4163 elided = 0;
|
|
4164 else
|
|
4165 {
|
|
4166 int k = 0;
|
|
4167
|
|
4168 while (elide_next_two_p (list))
|
|
4169 {
|
|
4170 k++;
|
|
4171 list = XCDR (list);
|
|
4172 }
|
|
4173 if (k != 0)
|
|
4174 {
|
|
4175 if (k == 1)
|
|
4176 buffer_insert_c_string (buf, ", ");
|
|
4177 else
|
|
4178 buffer_insert_c_string (buf, " .. ");
|
|
4179 elided = 1;
|
|
4180 continue;
|
|
4181 }
|
|
4182 }
|
|
4183
|
|
4184 /* Print a description of the definition of this character. */
|
219
|
4185 (*elt_describer) (XCDR (XCAR (list)), buffer);
|
0
|
4186 list = XCDR (list);
|
|
4187 }
|
|
4188 }
|
|
4189 UNGCPRO;
|
|
4190 }
|
|
4191
|
|
4192
|
|
4193 void
|
|
4194 syms_of_keymap (void)
|
|
4195 {
|
|
4196 defsymbol (&Qminor_mode_map_alist, "minor-mode-map-alist");
|
|
4197
|
|
4198 defsymbol (&Qkeymapp, "keymapp");
|
|
4199
|
|
4200 defsymbol (&Qsuppress_keymap, "suppress-keymap");
|
|
4201
|
|
4202 defsymbol (&Qmodeline_map, "modeline-map");
|
|
4203 defsymbol (&Qtoolbar_map, "toolbar-map");
|
|
4204
|
20
|
4205 DEFSUBR (Fkeymap_parents);
|
|
4206 DEFSUBR (Fset_keymap_parents);
|
|
4207 DEFSUBR (Fkeymap_name);
|
|
4208 DEFSUBR (Fset_keymap_name);
|
|
4209 DEFSUBR (Fkeymap_prompt);
|
|
4210 DEFSUBR (Fset_keymap_prompt);
|
|
4211 DEFSUBR (Fkeymap_default_binding);
|
|
4212 DEFSUBR (Fset_keymap_default_binding);
|
|
4213
|
|
4214 DEFSUBR (Fkeymapp);
|
|
4215 DEFSUBR (Fmake_keymap);
|
|
4216 DEFSUBR (Fmake_sparse_keymap);
|
|
4217
|
|
4218 DEFSUBR (Fcopy_keymap);
|
|
4219 DEFSUBR (Fkeymap_fullness);
|
|
4220 DEFSUBR (Fmap_keymap);
|
|
4221 DEFSUBR (Fevent_matches_key_specifier_p);
|
|
4222 DEFSUBR (Fdefine_key);
|
|
4223 DEFSUBR (Flookup_key);
|
|
4224 DEFSUBR (Fkey_binding);
|
|
4225 DEFSUBR (Fuse_global_map);
|
|
4226 DEFSUBR (Fuse_local_map);
|
|
4227 DEFSUBR (Fcurrent_local_map);
|
|
4228 DEFSUBR (Fcurrent_global_map);
|
|
4229 DEFSUBR (Fcurrent_keymaps);
|
|
4230 DEFSUBR (Faccessible_keymaps);
|
|
4231 DEFSUBR (Fkey_description);
|
|
4232 DEFSUBR (Fsingle_key_description);
|
|
4233 DEFSUBR (Fwhere_is_internal);
|
|
4234 DEFSUBR (Fdescribe_bindings_internal);
|
|
4235
|
|
4236 DEFSUBR (Ftext_char_description);
|
0
|
4237
|
|
4238 defsymbol (&Qcontrol, "control");
|
|
4239 defsymbol (&Qctrl, "ctrl");
|
185
|
4240 defsymbol (&Qmeta, "meta");
|
|
4241 defsymbol (&Qsuper, "super");
|
|
4242 defsymbol (&Qhyper, "hyper");
|
0
|
4243 defsymbol (&Qalt, "alt");
|
|
4244 defsymbol (&Qshift, "shift");
|
|
4245 defsymbol (&Qbutton0, "button0");
|
|
4246 defsymbol (&Qbutton1, "button1");
|
|
4247 defsymbol (&Qbutton2, "button2");
|
|
4248 defsymbol (&Qbutton3, "button3");
|
|
4249 defsymbol (&Qbutton4, "button4");
|
|
4250 defsymbol (&Qbutton5, "button5");
|
|
4251 defsymbol (&Qbutton6, "button6");
|
|
4252 defsymbol (&Qbutton7, "button7");
|
|
4253 defsymbol (&Qbutton0up, "button0up");
|
|
4254 defsymbol (&Qbutton1up, "button1up");
|
|
4255 defsymbol (&Qbutton2up, "button2up");
|
|
4256 defsymbol (&Qbutton3up, "button3up");
|
|
4257 defsymbol (&Qbutton4up, "button4up");
|
|
4258 defsymbol (&Qbutton5up, "button5up");
|
|
4259 defsymbol (&Qbutton6up, "button6up");
|
|
4260 defsymbol (&Qbutton7up, "button7up");
|
98
|
4261 defsymbol (&Qmouse_1, "mouse-1");
|
|
4262 defsymbol (&Qmouse_2, "mouse-2");
|
|
4263 defsymbol (&Qmouse_3, "mouse-3");
|
265
|
4264 defsymbol (&Qmouse_4, "mouse-4");
|
|
4265 defsymbol (&Qmouse_5, "mouse-5");
|
98
|
4266 defsymbol (&Qdown_mouse_1, "down-mouse-1");
|
|
4267 defsymbol (&Qdown_mouse_2, "down-mouse-2");
|
|
4268 defsymbol (&Qdown_mouse_3, "down-mouse-3");
|
265
|
4269 defsymbol (&Qdown_mouse_4, "down-mouse-4");
|
|
4270 defsymbol (&Qdown_mouse_5, "down-mouse-5");
|
0
|
4271 defsymbol (&Qmenu_selection, "menu-selection");
|
|
4272 defsymbol (&QLFD, "LFD");
|
|
4273 defsymbol (&QTAB, "TAB");
|
|
4274 defsymbol (&QRET, "RET");
|
|
4275 defsymbol (&QESC, "ESC");
|
|
4276 defsymbol (&QDEL, "DEL");
|
|
4277 defsymbol (&QBS, "BS");
|
|
4278 }
|
|
4279
|
|
4280 void
|
|
4281 vars_of_keymap (void)
|
|
4282 {
|
|
4283 DEFVAR_LISP ("meta-prefix-char", &Vmeta_prefix_char /*
|
|
4284 Meta-prefix character.
|
|
4285 This character followed by some character `foo' turns into `Meta-foo'.
|
|
4286 This can be any form recognized as a single key specifier.
|
|
4287 To disable the meta-prefix-char, set it to a negative number.
|
|
4288 */ );
|
|
4289 Vmeta_prefix_char = make_char (033);
|
|
4290
|
|
4291 DEFVAR_LISP ("mouse-grabbed-buffer", &Vmouse_grabbed_buffer /*
|
|
4292 A buffer which should be consulted first for all mouse activity.
|
|
4293 When a mouse-click is processed, it will first be looked up in the
|
|
4294 local-map of this buffer, and then through the normal mechanism if there
|
|
4295 is no binding for that click. This buffer's value of `mode-motion-hook'
|
|
4296 will be consulted instead of the `mode-motion-hook' of the buffer of the
|
|
4297 window under the mouse. You should *bind* this, not set it.
|
|
4298 */ );
|
|
4299 Vmouse_grabbed_buffer = Qnil;
|
|
4300
|
|
4301 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map /*
|
|
4302 Keymap that overrides all other local keymaps.
|
|
4303 If this variable is non-nil, it is used as a keymap instead of the
|
|
4304 buffer's local map, and the minor mode keymaps and extent-local keymaps.
|
|
4305 You should *bind* this, not set it.
|
|
4306 */ );
|
|
4307 Voverriding_local_map = Qnil;
|
|
4308
|
|
4309 Fset (Qminor_mode_map_alist, Qnil);
|
|
4310
|
|
4311 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map /*
|
|
4312 Keymap of key translations that can override keymaps.
|
|
4313 This keymap works like `function-key-map', but comes after that,
|
|
4314 and applies even for keys that have ordinary bindings.
|
|
4315 */ );
|
373
|
4316 Vkey_translation_map = Qnil;
|
0
|
4317
|
284
|
4318 DEFVAR_LISP ("vertical-divider-map", &Vvertical_divider_map /*
|
|
4319 Keymap which handles mouse clicks over vertical dividers.
|
|
4320 */ );
|
373
|
4321 Vvertical_divider_map = Qnil;
|
284
|
4322
|
0
|
4323 DEFVAR_INT ("keymap-tick", &keymap_tick /*
|
|
4324 Incremented for each change to any keymap.
|
|
4325 */ );
|
|
4326 keymap_tick = 0;
|
|
4327
|
|
4328 staticpro (&Vcurrent_global_map);
|
|
4329
|
412
|
4330 Vsingle_space_string = make_string_nocopy ((CONST Bufbyte *) " ", 1);
|
0
|
4331 staticpro (&Vsingle_space_string);
|
|
4332 }
|
|
4333
|
|
4334 void
|
|
4335 complex_vars_of_keymap (void)
|
|
4336 {
|
|
4337 /* This function can GC */
|
|
4338 Lisp_Object ESC_prefix = intern ("ESC-prefix");
|
|
4339 Lisp_Object meta_disgustitute;
|
|
4340
|
|
4341 Vcurrent_global_map = Fmake_keymap (Qnil);
|
|
4342
|
|
4343 meta_disgustitute = Fmake_keymap (Qnil);
|
|
4344 Ffset (ESC_prefix, meta_disgustitute);
|
|
4345 /* no need to protect meta_disgustitute, though */
|
412
|
4346 keymap_store_internal (MAKE_MODIFIER_HASH_KEY (MOD_META),
|
0
|
4347 XKEYMAP (Vcurrent_global_map),
|
|
4348 meta_disgustitute);
|
|
4349 XKEYMAP (Vcurrent_global_map)->sub_maps_cache = Qt;
|
|
4350
|
|
4351 Vkey_translation_map = Fmake_sparse_keymap (intern ("key-translation-map"));
|
|
4352 }
|