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