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