| 1 | /* Manipulation of keymaps |
| 2 | Copyright (C) 1985-1988, 1993-1995, 1998-2014 Free Software |
| 3 | Foundation, Inc. |
| 4 | |
| 5 | This file is part of GNU Emacs. |
| 6 | |
| 7 | GNU Emacs is free software: you can redistribute it and/or modify |
| 8 | it under the terms of the GNU General Public License as published by |
| 9 | the Free Software Foundation, either version 3 of the License, or |
| 10 | (at your option) any later version. |
| 11 | |
| 12 | GNU Emacs is distributed in the hope that it will be useful, |
| 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | GNU General Public License for more details. |
| 16 | |
| 17 | You should have received a copy of the GNU General Public License |
| 18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
| 19 | |
| 20 | /* Old BUGS: |
| 21 | - [M-C-a] != [?\M-\C-a] |
| 22 | - [M-f2] != [?\e f2]. |
| 23 | - (define-key map [menu-bar foo] <bla>) does not always place <bla> |
| 24 | at the head of the menu (if `foo' was already bound earlier and |
| 25 | then unbound, for example). |
| 26 | TODO: |
| 27 | - allow many more Meta -> ESC mappings (like Hyper -> C-e for Emacspeak) |
| 28 | - Think about the various defaulting that's currently hard-coded in |
| 29 | keyboard.c (uppercase->lowercase, char->charset, button-events, ...) |
| 30 | and make it more generic. Maybe we should allow mappings of the |
| 31 | form (PREDICATE . BINDING) as generalization of the default binding, |
| 32 | tho probably a cleaner way to attack this is to allow functional |
| 33 | keymaps (i.e. keymaps that are implemented as functions that implement |
| 34 | a few different methods like `lookup', `map', ...). |
| 35 | - Make [a] equivalent to [?a]. |
| 36 | BEWARE: |
| 37 | - map-keymap should work meaningfully even if entries are added/removed |
| 38 | to the keymap while iterating through it: |
| 39 | start - removed <= visited <= start + added |
| 40 | */ |
| 41 | |
| 42 | #include <config.h> |
| 43 | #include <stdio.h> |
| 44 | |
| 45 | #include "lisp.h" |
| 46 | #include "commands.h" |
| 47 | #include "character.h" |
| 48 | #include "buffer.h" |
| 49 | #include "charset.h" |
| 50 | #include "keyboard.h" |
| 51 | #include "frame.h" |
| 52 | #include "termhooks.h" |
| 53 | #include "blockinput.h" |
| 54 | #include "puresize.h" |
| 55 | #include "intervals.h" |
| 56 | #include "keymap.h" |
| 57 | #include "window.h" |
| 58 | |
| 59 | /* Actually allocate storage for these variables. */ |
| 60 | |
| 61 | Lisp_Object current_global_map; /* Current global keymap. */ |
| 62 | |
| 63 | Lisp_Object global_map; /* Default global key bindings. */ |
| 64 | |
| 65 | Lisp_Object meta_map; /* The keymap used for globally bound |
| 66 | ESC-prefixed default commands. */ |
| 67 | |
| 68 | Lisp_Object control_x_map; /* The keymap used for globally bound |
| 69 | C-x-prefixed default commands. */ |
| 70 | |
| 71 | /* The keymap used by the minibuf for local |
| 72 | bindings when spaces are allowed in the |
| 73 | minibuf. */ |
| 74 | |
| 75 | /* The keymap used by the minibuf for local |
| 76 | bindings when spaces are not encouraged |
| 77 | in the minibuf. */ |
| 78 | |
| 79 | /* Keymap used for minibuffers when doing completion. */ |
| 80 | /* Keymap used for minibuffers when doing completion and require a match. */ |
| 81 | static Lisp_Object Qkeymapp, Qnon_ascii; |
| 82 | Lisp_Object Qkeymap, Qmenu_item, Qremap; |
| 83 | static Lisp_Object QCadvertised_binding; |
| 84 | |
| 85 | /* Alist of elements like (DEL . "\d"). */ |
| 86 | static Lisp_Object exclude_keys; |
| 87 | |
| 88 | /* Pre-allocated 2-element vector for Fcommand_remapping to use. */ |
| 89 | static Lisp_Object command_remapping_vector; |
| 90 | |
| 91 | /* Hash table used to cache a reverse-map to speed up calls to where-is. */ |
| 92 | static Lisp_Object where_is_cache; |
| 93 | /* Which keymaps are reverse-stored in the cache. */ |
| 94 | static Lisp_Object where_is_cache_keymaps; |
| 95 | |
| 96 | static Lisp_Object store_in_keymap (Lisp_Object, Lisp_Object, Lisp_Object); |
| 97 | |
| 98 | static Lisp_Object define_as_prefix (Lisp_Object, Lisp_Object); |
| 99 | static void describe_command (Lisp_Object, Lisp_Object); |
| 100 | static void describe_translation (Lisp_Object, Lisp_Object); |
| 101 | static void describe_map (Lisp_Object, Lisp_Object, |
| 102 | void (*) (Lisp_Object, Lisp_Object), |
| 103 | bool, Lisp_Object, Lisp_Object*, bool, bool); |
| 104 | static void describe_vector (Lisp_Object, Lisp_Object, Lisp_Object, |
| 105 | void (*) (Lisp_Object, Lisp_Object), bool, |
| 106 | Lisp_Object, Lisp_Object, bool, bool); |
| 107 | static void silly_event_symbol_error (Lisp_Object); |
| 108 | static Lisp_Object get_keyelt (Lisp_Object, bool); |
| 109 | |
| 110 | static void |
| 111 | CHECK_VECTOR_OR_CHAR_TABLE (Lisp_Object x) |
| 112 | { |
| 113 | CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x); |
| 114 | } |
| 115 | \f |
| 116 | /* Keymap object support - constructors and predicates. */ |
| 117 | |
| 118 | DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0, |
| 119 | doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST). |
| 120 | CHARTABLE is a char-table that holds the bindings for all characters |
| 121 | without modifiers. All entries in it are initially nil, meaning |
| 122 | "command undefined". ALIST is an assoc-list which holds bindings for |
| 123 | function keys, mouse events, and any other things that appear in the |
| 124 | input stream. Initially, ALIST is nil. |
| 125 | |
| 126 | The optional arg STRING supplies a menu name for the keymap |
| 127 | in case you use it as a menu with `x-popup-menu'. */) |
| 128 | (Lisp_Object string) |
| 129 | { |
| 130 | Lisp_Object tail; |
| 131 | if (!NILP (string)) |
| 132 | tail = list1 (string); |
| 133 | else |
| 134 | tail = Qnil; |
| 135 | return Fcons (Qkeymap, |
| 136 | Fcons (Fmake_char_table (Qkeymap, Qnil), tail)); |
| 137 | } |
| 138 | |
| 139 | DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0, |
| 140 | doc: /* Construct and return a new sparse keymap. |
| 141 | Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION), |
| 142 | which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION), |
| 143 | which binds the function key or mouse event SYMBOL to DEFINITION. |
| 144 | Initially the alist is nil. |
| 145 | |
| 146 | The optional arg STRING supplies a menu name for the keymap |
| 147 | in case you use it as a menu with `x-popup-menu'. */) |
| 148 | (Lisp_Object string) |
| 149 | { |
| 150 | if (!NILP (string)) |
| 151 | { |
| 152 | if (!NILP (Vpurify_flag)) |
| 153 | string = Fpurecopy (string); |
| 154 | return list2 (Qkeymap, string); |
| 155 | } |
| 156 | return list1 (Qkeymap); |
| 157 | } |
| 158 | |
| 159 | /* This function is used for installing the standard key bindings |
| 160 | at initialization time. |
| 161 | |
| 162 | For example: |
| 163 | |
| 164 | initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark"); */ |
| 165 | |
| 166 | void |
| 167 | initial_define_key (Lisp_Object keymap, int key, const char *defname) |
| 168 | { |
| 169 | store_in_keymap (keymap, make_number (key), intern_c_string (defname)); |
| 170 | } |
| 171 | |
| 172 | void |
| 173 | initial_define_lispy_key (Lisp_Object keymap, const char *keyname, const char *defname) |
| 174 | { |
| 175 | store_in_keymap (keymap, intern_c_string (keyname), intern_c_string (defname)); |
| 176 | } |
| 177 | |
| 178 | DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0, |
| 179 | doc: /* Return t if OBJECT is a keymap. |
| 180 | |
| 181 | A keymap is a list (keymap . ALIST), |
| 182 | or a symbol whose function definition is itself a keymap. |
| 183 | ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN); |
| 184 | a vector of densely packed bindings for small character codes |
| 185 | is also allowed as an element. */) |
| 186 | (Lisp_Object object) |
| 187 | { |
| 188 | return (KEYMAPP (object) ? Qt : Qnil); |
| 189 | } |
| 190 | |
| 191 | DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0, |
| 192 | doc: /* Return the prompt-string of a keymap MAP. |
| 193 | If non-nil, the prompt is shown in the echo-area |
| 194 | when reading a key-sequence to be looked-up in this keymap. */) |
| 195 | (Lisp_Object map) |
| 196 | { |
| 197 | map = get_keymap (map, 0, 0); |
| 198 | while (CONSP (map)) |
| 199 | { |
| 200 | Lisp_Object tem = XCAR (map); |
| 201 | if (STRINGP (tem)) |
| 202 | return tem; |
| 203 | else if (KEYMAPP (tem)) |
| 204 | { |
| 205 | tem = Fkeymap_prompt (tem); |
| 206 | if (!NILP (tem)) |
| 207 | return tem; |
| 208 | } |
| 209 | map = XCDR (map); |
| 210 | } |
| 211 | return Qnil; |
| 212 | } |
| 213 | |
| 214 | /* Check that OBJECT is a keymap (after dereferencing through any |
| 215 | symbols). If it is, return it. |
| 216 | |
| 217 | If AUTOLOAD and if OBJECT is a symbol whose function value |
| 218 | is an autoload form, do the autoload and try again. |
| 219 | If AUTOLOAD, callers must assume GC is possible. |
| 220 | |
| 221 | ERROR_IF_NOT_KEYMAP controls how we respond if OBJECT isn't a keymap. |
| 222 | If ERROR_IF_NOT_KEYMAP, signal an error; otherwise, |
| 223 | just return Qnil. |
| 224 | |
| 225 | Note that most of the time, we don't want to pursue autoloads. |
| 226 | Functions like Faccessible_keymaps which scan entire keymap trees |
| 227 | shouldn't load every autoloaded keymap. I'm not sure about this, |
| 228 | but it seems to me that only read_key_sequence, Flookup_key, and |
| 229 | Fdefine_key should cause keymaps to be autoloaded. |
| 230 | |
| 231 | This function can GC when AUTOLOAD is true, because it calls |
| 232 | Fautoload_do_load which can GC. */ |
| 233 | |
| 234 | Lisp_Object |
| 235 | get_keymap (Lisp_Object object, bool error_if_not_keymap, bool autoload) |
| 236 | { |
| 237 | Lisp_Object tem; |
| 238 | |
| 239 | autoload_retry: |
| 240 | if (NILP (object)) |
| 241 | goto end; |
| 242 | if (CONSP (object) && EQ (XCAR (object), Qkeymap)) |
| 243 | return object; |
| 244 | |
| 245 | tem = indirect_function (object); |
| 246 | if (CONSP (tem)) |
| 247 | { |
| 248 | if (EQ (XCAR (tem), Qkeymap)) |
| 249 | return tem; |
| 250 | |
| 251 | /* Should we do an autoload? Autoload forms for keymaps have |
| 252 | Qkeymap as their fifth element. */ |
| 253 | if ((autoload || !error_if_not_keymap) && EQ (XCAR (tem), Qautoload) |
| 254 | && SYMBOLP (object)) |
| 255 | { |
| 256 | Lisp_Object tail; |
| 257 | |
| 258 | tail = Fnth (make_number (4), tem); |
| 259 | if (EQ (tail, Qkeymap)) |
| 260 | { |
| 261 | if (autoload) |
| 262 | { |
| 263 | struct gcpro gcpro1, gcpro2; |
| 264 | |
| 265 | GCPRO2 (tem, object); |
| 266 | Fautoload_do_load (tem, object, Qnil); |
| 267 | UNGCPRO; |
| 268 | |
| 269 | goto autoload_retry; |
| 270 | } |
| 271 | else |
| 272 | return object; |
| 273 | } |
| 274 | } |
| 275 | } |
| 276 | |
| 277 | end: |
| 278 | if (error_if_not_keymap) |
| 279 | wrong_type_argument (Qkeymapp, object); |
| 280 | return Qnil; |
| 281 | } |
| 282 | \f |
| 283 | /* Return the parent map of KEYMAP, or nil if it has none. |
| 284 | We assume that KEYMAP is a valid keymap. */ |
| 285 | |
| 286 | static Lisp_Object |
| 287 | keymap_parent (Lisp_Object keymap, bool autoload) |
| 288 | { |
| 289 | Lisp_Object list; |
| 290 | |
| 291 | keymap = get_keymap (keymap, 1, autoload); |
| 292 | |
| 293 | /* Skip past the initial element `keymap'. */ |
| 294 | list = XCDR (keymap); |
| 295 | for (; CONSP (list); list = XCDR (list)) |
| 296 | { |
| 297 | /* See if there is another `keymap'. */ |
| 298 | if (KEYMAPP (list)) |
| 299 | return list; |
| 300 | } |
| 301 | |
| 302 | return get_keymap (list, 0, autoload); |
| 303 | } |
| 304 | |
| 305 | DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0, |
| 306 | doc: /* Return the parent keymap of KEYMAP. |
| 307 | If KEYMAP has no parent, return nil. */) |
| 308 | (Lisp_Object keymap) |
| 309 | { |
| 310 | return keymap_parent (keymap, 1); |
| 311 | } |
| 312 | |
| 313 | /* Check whether MAP is one of MAPS parents. */ |
| 314 | static bool |
| 315 | keymap_memberp (Lisp_Object map, Lisp_Object maps) |
| 316 | { |
| 317 | if (NILP (map)) return 0; |
| 318 | while (KEYMAPP (maps) && !EQ (map, maps)) |
| 319 | maps = keymap_parent (maps, 0); |
| 320 | return (EQ (map, maps)); |
| 321 | } |
| 322 | |
| 323 | /* Set the parent keymap of MAP to PARENT. */ |
| 324 | |
| 325 | DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0, |
| 326 | doc: /* Modify KEYMAP to set its parent map to PARENT. |
| 327 | Return PARENT. PARENT should be nil or another keymap. */) |
| 328 | (Lisp_Object keymap, Lisp_Object parent) |
| 329 | { |
| 330 | Lisp_Object list, prev; |
| 331 | struct gcpro gcpro1, gcpro2; |
| 332 | |
| 333 | /* Flush any reverse-map cache. */ |
| 334 | where_is_cache = Qnil; where_is_cache_keymaps = Qt; |
| 335 | |
| 336 | GCPRO2 (keymap, parent); |
| 337 | keymap = get_keymap (keymap, 1, 1); |
| 338 | |
| 339 | if (!NILP (parent)) |
| 340 | { |
| 341 | parent = get_keymap (parent, 1, 0); |
| 342 | |
| 343 | /* Check for cycles. */ |
| 344 | if (keymap_memberp (keymap, parent)) |
| 345 | error ("Cyclic keymap inheritance"); |
| 346 | } |
| 347 | |
| 348 | /* Skip past the initial element `keymap'. */ |
| 349 | prev = keymap; |
| 350 | while (1) |
| 351 | { |
| 352 | list = XCDR (prev); |
| 353 | /* If there is a parent keymap here, replace it. |
| 354 | If we came to the end, add the parent in PREV. */ |
| 355 | if (!CONSP (list) || KEYMAPP (list)) |
| 356 | { |
| 357 | CHECK_IMPURE (prev); |
| 358 | XSETCDR (prev, parent); |
| 359 | RETURN_UNGCPRO (parent); |
| 360 | } |
| 361 | prev = list; |
| 362 | } |
| 363 | } |
| 364 | \f |
| 365 | |
| 366 | /* Look up IDX in MAP. IDX may be any sort of event. |
| 367 | Note that this does only one level of lookup; IDX must be a single |
| 368 | event, not a sequence. |
| 369 | |
| 370 | MAP must be a keymap or a list of keymaps. |
| 371 | |
| 372 | If T_OK, bindings for Qt are treated as default |
| 373 | bindings; any key left unmentioned by other tables and bindings is |
| 374 | given the binding of Qt. |
| 375 | |
| 376 | If not T_OK, bindings for Qt are not treated specially. |
| 377 | |
| 378 | If NOINHERIT, don't accept a subkeymap found in an inherited keymap. |
| 379 | |
| 380 | Return Qunbound if no binding was found (and return Qnil if a nil |
| 381 | binding was found). */ |
| 382 | |
| 383 | static Lisp_Object |
| 384 | access_keymap_1 (Lisp_Object map, Lisp_Object idx, |
| 385 | bool t_ok, bool noinherit, bool autoload) |
| 386 | { |
| 387 | /* If idx is a list (some sort of mouse click, perhaps?), |
| 388 | the index we want to use is the car of the list, which |
| 389 | ought to be a symbol. */ |
| 390 | idx = EVENT_HEAD (idx); |
| 391 | |
| 392 | /* If idx is a symbol, it might have modifiers, which need to |
| 393 | be put in the canonical order. */ |
| 394 | if (SYMBOLP (idx)) |
| 395 | idx = reorder_modifiers (idx); |
| 396 | else if (INTEGERP (idx)) |
| 397 | /* Clobber the high bits that can be present on a machine |
| 398 | with more than 24 bits of integer. */ |
| 399 | XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1))); |
| 400 | |
| 401 | /* Handle the special meta -> esc mapping. */ |
| 402 | if (INTEGERP (idx) && XFASTINT (idx) & meta_modifier) |
| 403 | { |
| 404 | /* See if there is a meta-map. If there's none, there is |
| 405 | no binding for IDX, unless a default binding exists in MAP. */ |
| 406 | struct gcpro gcpro1; |
| 407 | Lisp_Object event_meta_binding, event_meta_map; |
| 408 | GCPRO1 (map); |
| 409 | /* A strange value in which Meta is set would cause |
| 410 | infinite recursion. Protect against that. */ |
| 411 | if (XINT (meta_prefix_char) & CHAR_META) |
| 412 | meta_prefix_char = make_number (27); |
| 413 | event_meta_binding = access_keymap_1 (map, meta_prefix_char, t_ok, |
| 414 | noinherit, autoload); |
| 415 | event_meta_map = get_keymap (event_meta_binding, 0, autoload); |
| 416 | UNGCPRO; |
| 417 | if (CONSP (event_meta_map)) |
| 418 | { |
| 419 | map = event_meta_map; |
| 420 | idx = make_number (XFASTINT (idx) & ~meta_modifier); |
| 421 | } |
| 422 | else if (t_ok) |
| 423 | /* Set IDX to t, so that we only find a default binding. */ |
| 424 | idx = Qt; |
| 425 | else |
| 426 | /* An explicit nil binding, or no binding at all. */ |
| 427 | return NILP (event_meta_binding) ? Qnil : Qunbound; |
| 428 | } |
| 429 | |
| 430 | /* t_binding is where we put a default binding that applies, |
| 431 | to use in case we do not find a binding specifically |
| 432 | for this key sequence. */ |
| 433 | { |
| 434 | Lisp_Object tail; |
| 435 | Lisp_Object t_binding = Qunbound; |
| 436 | Lisp_Object retval = Qunbound; |
| 437 | Lisp_Object retval_tail = Qnil; |
| 438 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; |
| 439 | |
| 440 | GCPRO4 (tail, idx, t_binding, retval); |
| 441 | |
| 442 | for (tail = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map; |
| 443 | (CONSP (tail) |
| 444 | || (tail = get_keymap (tail, 0, autoload), CONSP (tail))); |
| 445 | tail = XCDR (tail)) |
| 446 | { |
| 447 | /* Qunbound in VAL means we have found no binding. */ |
| 448 | Lisp_Object val = Qunbound; |
| 449 | Lisp_Object binding = XCAR (tail); |
| 450 | Lisp_Object submap = get_keymap (binding, 0, autoload); |
| 451 | |
| 452 | if (EQ (binding, Qkeymap)) |
| 453 | { |
| 454 | if (noinherit || NILP (retval)) |
| 455 | /* If NOINHERIT, stop here, the rest is inherited. */ |
| 456 | break; |
| 457 | else if (!EQ (retval, Qunbound)) |
| 458 | { |
| 459 | Lisp_Object parent_entry; |
| 460 | eassert (KEYMAPP (retval)); |
| 461 | parent_entry |
| 462 | = get_keymap (access_keymap_1 (tail, idx, |
| 463 | t_ok, 0, autoload), |
| 464 | 0, autoload); |
| 465 | if (KEYMAPP (parent_entry)) |
| 466 | { |
| 467 | if (CONSP (retval_tail)) |
| 468 | XSETCDR (retval_tail, parent_entry); |
| 469 | else |
| 470 | { |
| 471 | retval_tail = Fcons (retval, parent_entry); |
| 472 | retval = Fcons (Qkeymap, retval_tail); |
| 473 | } |
| 474 | } |
| 475 | break; |
| 476 | } |
| 477 | } |
| 478 | else if (CONSP (submap)) |
| 479 | { |
| 480 | val = access_keymap_1 (submap, idx, t_ok, noinherit, autoload); |
| 481 | } |
| 482 | else if (CONSP (binding)) |
| 483 | { |
| 484 | Lisp_Object key = XCAR (binding); |
| 485 | |
| 486 | if (EQ (key, idx)) |
| 487 | val = XCDR (binding); |
| 488 | else if (t_ok && EQ (key, Qt)) |
| 489 | { |
| 490 | t_binding = XCDR (binding); |
| 491 | t_ok = 0; |
| 492 | } |
| 493 | } |
| 494 | else if (VECTORP (binding)) |
| 495 | { |
| 496 | if (INTEGERP (idx) && XFASTINT (idx) < ASIZE (binding)) |
| 497 | val = AREF (binding, XFASTINT (idx)); |
| 498 | } |
| 499 | else if (CHAR_TABLE_P (binding)) |
| 500 | { |
| 501 | /* Character codes with modifiers |
| 502 | are not included in a char-table. |
| 503 | All character codes without modifiers are included. */ |
| 504 | if (INTEGERP (idx) && (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0) |
| 505 | { |
| 506 | val = Faref (binding, idx); |
| 507 | /* `nil' has a special meaning for char-tables, so |
| 508 | we use something else to record an explicitly |
| 509 | unbound entry. */ |
| 510 | if (NILP (val)) |
| 511 | val = Qunbound; |
| 512 | } |
| 513 | } |
| 514 | |
| 515 | /* If we found a binding, clean it up and return it. */ |
| 516 | if (!EQ (val, Qunbound)) |
| 517 | { |
| 518 | if (EQ (val, Qt)) |
| 519 | /* A Qt binding is just like an explicit nil binding |
| 520 | (i.e. it shadows any parent binding but not bindings in |
| 521 | keymaps of lower precedence). */ |
| 522 | val = Qnil; |
| 523 | |
| 524 | val = get_keyelt (val, autoload); |
| 525 | |
| 526 | if (!KEYMAPP (val)) |
| 527 | { |
| 528 | if (NILP (retval) || EQ (retval, Qunbound)) |
| 529 | retval = val; |
| 530 | if (!NILP (val)) |
| 531 | break; /* Shadows everything that follows. */ |
| 532 | } |
| 533 | else if (NILP (retval) || EQ (retval, Qunbound)) |
| 534 | retval = val; |
| 535 | else if (CONSP (retval_tail)) |
| 536 | { |
| 537 | XSETCDR (retval_tail, list1 (val)); |
| 538 | retval_tail = XCDR (retval_tail); |
| 539 | } |
| 540 | else |
| 541 | { |
| 542 | retval_tail = list1 (val); |
| 543 | retval = Fcons (Qkeymap, Fcons (retval, retval_tail)); |
| 544 | } |
| 545 | } |
| 546 | QUIT; |
| 547 | } |
| 548 | UNGCPRO; |
| 549 | return EQ (Qunbound, retval) ? get_keyelt (t_binding, autoload) : retval; |
| 550 | } |
| 551 | } |
| 552 | |
| 553 | Lisp_Object |
| 554 | access_keymap (Lisp_Object map, Lisp_Object idx, |
| 555 | bool t_ok, bool noinherit, bool autoload) |
| 556 | { |
| 557 | Lisp_Object val = access_keymap_1 (map, idx, t_ok, noinherit, autoload); |
| 558 | return EQ (val, Qunbound) ? Qnil : val; |
| 559 | } |
| 560 | |
| 561 | static void |
| 562 | map_keymap_item (map_keymap_function_t fun, Lisp_Object args, Lisp_Object key, Lisp_Object val, void *data) |
| 563 | { |
| 564 | if (EQ (val, Qt)) |
| 565 | val = Qnil; |
| 566 | (*fun) (key, val, args, data); |
| 567 | } |
| 568 | |
| 569 | static void |
| 570 | map_keymap_char_table_item (Lisp_Object args, Lisp_Object key, Lisp_Object val) |
| 571 | { |
| 572 | if (!NILP (val)) |
| 573 | { |
| 574 | map_keymap_function_t fun |
| 575 | = (map_keymap_function_t) XSAVE_FUNCPOINTER (args, 0); |
| 576 | /* If the key is a range, make a copy since map_char_table modifies |
| 577 | it in place. */ |
| 578 | if (CONSP (key)) |
| 579 | key = Fcons (XCAR (key), XCDR (key)); |
| 580 | map_keymap_item (fun, XSAVE_OBJECT (args, 2), key, |
| 581 | val, XSAVE_POINTER (args, 1)); |
| 582 | } |
| 583 | } |
| 584 | |
| 585 | /* Call FUN for every binding in MAP and stop at (and return) the parent. |
| 586 | FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA). */ |
| 587 | static Lisp_Object |
| 588 | map_keymap_internal (Lisp_Object map, |
| 589 | map_keymap_function_t fun, |
| 590 | Lisp_Object args, |
| 591 | void *data) |
| 592 | { |
| 593 | struct gcpro gcpro1, gcpro2, gcpro3; |
| 594 | Lisp_Object tail |
| 595 | = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map; |
| 596 | |
| 597 | GCPRO3 (map, args, tail); |
| 598 | for (; CONSP (tail) && !EQ (Qkeymap, XCAR (tail)); tail = XCDR (tail)) |
| 599 | { |
| 600 | Lisp_Object binding = XCAR (tail); |
| 601 | |
| 602 | if (KEYMAPP (binding)) /* An embedded parent. */ |
| 603 | break; |
| 604 | else if (CONSP (binding)) |
| 605 | map_keymap_item (fun, args, XCAR (binding), XCDR (binding), data); |
| 606 | else if (VECTORP (binding)) |
| 607 | { |
| 608 | /* Loop over the char values represented in the vector. */ |
| 609 | int len = ASIZE (binding); |
| 610 | int c; |
| 611 | for (c = 0; c < len; c++) |
| 612 | { |
| 613 | Lisp_Object character; |
| 614 | XSETFASTINT (character, c); |
| 615 | map_keymap_item (fun, args, character, AREF (binding, c), data); |
| 616 | } |
| 617 | } |
| 618 | else if (CHAR_TABLE_P (binding)) |
| 619 | map_char_table (map_keymap_char_table_item, Qnil, binding, |
| 620 | make_save_funcptr_ptr_obj ((voidfuncptr) fun, data, |
| 621 | args)); |
| 622 | } |
| 623 | UNGCPRO; |
| 624 | return tail; |
| 625 | } |
| 626 | |
| 627 | static void |
| 628 | map_keymap_call (Lisp_Object key, Lisp_Object val, Lisp_Object fun, void *dummy) |
| 629 | { |
| 630 | call2 (fun, key, val); |
| 631 | } |
| 632 | |
| 633 | /* Same as map_keymap_internal, but traverses parent keymaps as well. |
| 634 | AUTOLOAD indicates that autoloaded keymaps should be loaded. */ |
| 635 | void |
| 636 | map_keymap (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, |
| 637 | void *data, bool autoload) |
| 638 | { |
| 639 | struct gcpro gcpro1; |
| 640 | GCPRO1 (args); |
| 641 | map = get_keymap (map, 1, autoload); |
| 642 | while (CONSP (map)) |
| 643 | { |
| 644 | if (KEYMAPP (XCAR (map))) |
| 645 | { |
| 646 | map_keymap (XCAR (map), fun, args, data, autoload); |
| 647 | map = XCDR (map); |
| 648 | } |
| 649 | else |
| 650 | map = map_keymap_internal (map, fun, args, data); |
| 651 | if (!CONSP (map)) |
| 652 | map = get_keymap (map, 0, autoload); |
| 653 | } |
| 654 | UNGCPRO; |
| 655 | } |
| 656 | |
| 657 | static Lisp_Object Qkeymap_canonicalize; |
| 658 | |
| 659 | /* Same as map_keymap, but does it right, properly eliminating duplicate |
| 660 | bindings due to inheritance. */ |
| 661 | void |
| 662 | map_keymap_canonical (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, void *data) |
| 663 | { |
| 664 | struct gcpro gcpro1; |
| 665 | GCPRO1 (args); |
| 666 | /* map_keymap_canonical may be used from redisplay (e.g. when building menus) |
| 667 | so be careful to ignore errors and to inhibit redisplay. */ |
| 668 | map = safe_call1 (Qkeymap_canonicalize, map); |
| 669 | /* No need to use `map_keymap' here because canonical map has no parent. */ |
| 670 | map_keymap_internal (map, fun, args, data); |
| 671 | UNGCPRO; |
| 672 | } |
| 673 | |
| 674 | DEFUN ("map-keymap-internal", Fmap_keymap_internal, Smap_keymap_internal, 2, 2, 0, |
| 675 | doc: /* Call FUNCTION once for each event binding in KEYMAP. |
| 676 | FUNCTION is called with two arguments: the event that is bound, and |
| 677 | the definition it is bound to. The event may be a character range. |
| 678 | If KEYMAP has a parent, this function returns it without processing it. */) |
| 679 | (Lisp_Object function, Lisp_Object keymap) |
| 680 | { |
| 681 | struct gcpro gcpro1; |
| 682 | GCPRO1 (function); |
| 683 | keymap = get_keymap (keymap, 1, 1); |
| 684 | keymap = map_keymap_internal (keymap, map_keymap_call, function, NULL); |
| 685 | UNGCPRO; |
| 686 | return keymap; |
| 687 | } |
| 688 | |
| 689 | DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 3, 0, |
| 690 | doc: /* Call FUNCTION once for each event binding in KEYMAP. |
| 691 | FUNCTION is called with two arguments: the event that is bound, and |
| 692 | the definition it is bound to. The event may be a character range. |
| 693 | |
| 694 | If KEYMAP has a parent, the parent's bindings are included as well. |
| 695 | This works recursively: if the parent has itself a parent, then the |
| 696 | grandparent's bindings are also included and so on. |
| 697 | usage: (map-keymap FUNCTION KEYMAP) */) |
| 698 | (Lisp_Object function, Lisp_Object keymap, Lisp_Object sort_first) |
| 699 | { |
| 700 | if (! NILP (sort_first)) |
| 701 | return call2 (intern ("map-keymap-sorted"), function, keymap); |
| 702 | |
| 703 | map_keymap (keymap, map_keymap_call, function, NULL, 1); |
| 704 | return Qnil; |
| 705 | } |
| 706 | |
| 707 | /* Given OBJECT which was found in a slot in a keymap, |
| 708 | trace indirect definitions to get the actual definition of that slot. |
| 709 | An indirect definition is a list of the form |
| 710 | (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one |
| 711 | and INDEX is the object to look up in KEYMAP to yield the definition. |
| 712 | |
| 713 | Also if OBJECT has a menu string as the first element, |
| 714 | remove that. Also remove a menu help string as second element. |
| 715 | |
| 716 | If AUTOLOAD, load autoloadable keymaps |
| 717 | that are referred to with indirection. |
| 718 | |
| 719 | This can GC because menu_item_eval_property calls Feval. */ |
| 720 | |
| 721 | static Lisp_Object |
| 722 | get_keyelt (Lisp_Object object, bool autoload) |
| 723 | { |
| 724 | while (1) |
| 725 | { |
| 726 | if (!(CONSP (object))) |
| 727 | /* This is really the value. */ |
| 728 | return object; |
| 729 | |
| 730 | /* If the keymap contents looks like (keymap ...) or (lambda ...) |
| 731 | then use itself. */ |
| 732 | else if (EQ (XCAR (object), Qkeymap) || EQ (XCAR (object), Qlambda)) |
| 733 | return object; |
| 734 | |
| 735 | /* If the keymap contents looks like (menu-item name . DEFN) |
| 736 | or (menu-item name DEFN ...) then use DEFN. |
| 737 | This is a new format menu item. */ |
| 738 | else if (EQ (XCAR (object), Qmenu_item)) |
| 739 | { |
| 740 | if (CONSP (XCDR (object))) |
| 741 | { |
| 742 | Lisp_Object tem; |
| 743 | |
| 744 | object = XCDR (XCDR (object)); |
| 745 | tem = object; |
| 746 | if (CONSP (object)) |
| 747 | object = XCAR (object); |
| 748 | |
| 749 | /* If there's a `:filter FILTER', apply FILTER to the |
| 750 | menu-item's definition to get the real definition to |
| 751 | use. */ |
| 752 | for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem)) |
| 753 | if (EQ (XCAR (tem), QCfilter) && autoload) |
| 754 | { |
| 755 | Lisp_Object filter; |
| 756 | filter = XCAR (XCDR (tem)); |
| 757 | filter = list2 (filter, list2 (Qquote, object)); |
| 758 | object = menu_item_eval_property (filter); |
| 759 | break; |
| 760 | } |
| 761 | } |
| 762 | else |
| 763 | /* Invalid keymap. */ |
| 764 | return object; |
| 765 | } |
| 766 | |
| 767 | /* If the keymap contents looks like (STRING . DEFN), use DEFN. |
| 768 | Keymap alist elements like (CHAR MENUSTRING . DEFN) |
| 769 | will be used by HierarKey menus. */ |
| 770 | else if (STRINGP (XCAR (object))) |
| 771 | { |
| 772 | object = XCDR (object); |
| 773 | /* Also remove a menu help string, if any, |
| 774 | following the menu item name. */ |
| 775 | if (CONSP (object) && STRINGP (XCAR (object))) |
| 776 | object = XCDR (object); |
| 777 | /* Also remove the sublist that caches key equivalences, if any. */ |
| 778 | if (CONSP (object) && CONSP (XCAR (object))) |
| 779 | { |
| 780 | Lisp_Object carcar; |
| 781 | carcar = XCAR (XCAR (object)); |
| 782 | if (NILP (carcar) || VECTORP (carcar)) |
| 783 | object = XCDR (object); |
| 784 | } |
| 785 | } |
| 786 | |
| 787 | /* If the contents are (KEYMAP . ELEMENT), go indirect. */ |
| 788 | else if (KEYMAPP (XCAR (object))) |
| 789 | error ("Wow, indirect keymap entry!!"); |
| 790 | else |
| 791 | return object; |
| 792 | } |
| 793 | } |
| 794 | |
| 795 | static Lisp_Object |
| 796 | store_in_keymap (Lisp_Object keymap, register Lisp_Object idx, Lisp_Object def) |
| 797 | { |
| 798 | /* Flush any reverse-map cache. */ |
| 799 | where_is_cache = Qnil; |
| 800 | where_is_cache_keymaps = Qt; |
| 801 | |
| 802 | if (EQ (idx, Qkeymap)) |
| 803 | error ("`keymap' is reserved for embedded parent maps"); |
| 804 | |
| 805 | /* If we are preparing to dump, and DEF is a menu element |
| 806 | with a menu item indicator, copy it to ensure it is not pure. */ |
| 807 | if (CONSP (def) && PURE_P (def) |
| 808 | && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def)))) |
| 809 | def = Fcons (XCAR (def), XCDR (def)); |
| 810 | |
| 811 | if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap)) |
| 812 | error ("attempt to define a key in a non-keymap"); |
| 813 | |
| 814 | /* If idx is a cons, and the car part is a character, idx must be of |
| 815 | the form (FROM-CHAR . TO-CHAR). */ |
| 816 | if (CONSP (idx) && CHARACTERP (XCAR (idx))) |
| 817 | CHECK_CHARACTER_CDR (idx); |
| 818 | else |
| 819 | /* If idx is a list (some sort of mouse click, perhaps?), |
| 820 | the index we want to use is the car of the list, which |
| 821 | ought to be a symbol. */ |
| 822 | idx = EVENT_HEAD (idx); |
| 823 | |
| 824 | /* If idx is a symbol, it might have modifiers, which need to |
| 825 | be put in the canonical order. */ |
| 826 | if (SYMBOLP (idx)) |
| 827 | idx = reorder_modifiers (idx); |
| 828 | else if (INTEGERP (idx)) |
| 829 | /* Clobber the high bits that can be present on a machine |
| 830 | with more than 24 bits of integer. */ |
| 831 | XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1))); |
| 832 | |
| 833 | /* Scan the keymap for a binding of idx. */ |
| 834 | { |
| 835 | Lisp_Object tail; |
| 836 | |
| 837 | /* The cons after which we should insert new bindings. If the |
| 838 | keymap has a table element, we record its position here, so new |
| 839 | bindings will go after it; this way, the table will stay |
| 840 | towards the front of the alist and character lookups in dense |
| 841 | keymaps will remain fast. Otherwise, this just points at the |
| 842 | front of the keymap. */ |
| 843 | Lisp_Object insertion_point; |
| 844 | |
| 845 | insertion_point = keymap; |
| 846 | for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail)) |
| 847 | { |
| 848 | Lisp_Object elt; |
| 849 | |
| 850 | elt = XCAR (tail); |
| 851 | if (VECTORP (elt)) |
| 852 | { |
| 853 | if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt)) |
| 854 | { |
| 855 | CHECK_IMPURE (elt); |
| 856 | ASET (elt, XFASTINT (idx), def); |
| 857 | return def; |
| 858 | } |
| 859 | else if (CONSP (idx) && CHARACTERP (XCAR (idx))) |
| 860 | { |
| 861 | int from = XFASTINT (XCAR (idx)); |
| 862 | int to = XFASTINT (XCDR (idx)); |
| 863 | |
| 864 | if (to >= ASIZE (elt)) |
| 865 | to = ASIZE (elt) - 1; |
| 866 | for (; from <= to; from++) |
| 867 | ASET (elt, from, def); |
| 868 | if (to == XFASTINT (XCDR (idx))) |
| 869 | /* We have defined all keys in IDX. */ |
| 870 | return def; |
| 871 | } |
| 872 | insertion_point = tail; |
| 873 | } |
| 874 | else if (CHAR_TABLE_P (elt)) |
| 875 | { |
| 876 | /* Character codes with modifiers |
| 877 | are not included in a char-table. |
| 878 | All character codes without modifiers are included. */ |
| 879 | if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK)) |
| 880 | { |
| 881 | Faset (elt, idx, |
| 882 | /* `nil' has a special meaning for char-tables, so |
| 883 | we use something else to record an explicitly |
| 884 | unbound entry. */ |
| 885 | NILP (def) ? Qt : def); |
| 886 | return def; |
| 887 | } |
| 888 | else if (CONSP (idx) && CHARACTERP (XCAR (idx))) |
| 889 | { |
| 890 | Fset_char_table_range (elt, idx, NILP (def) ? Qt : def); |
| 891 | return def; |
| 892 | } |
| 893 | insertion_point = tail; |
| 894 | } |
| 895 | else if (CONSP (elt)) |
| 896 | { |
| 897 | if (EQ (Qkeymap, XCAR (elt))) |
| 898 | { /* A sub keymap. This might be due to a lookup that found |
| 899 | two matching bindings (maybe because of a sub keymap). |
| 900 | It almost never happens (since the second binding normally |
| 901 | only happens in the inherited part of the keymap), but |
| 902 | if it does, we want to update the sub-keymap since the |
| 903 | main one might be temporary (built by access_keymap). */ |
| 904 | tail = insertion_point = elt; |
| 905 | } |
| 906 | else if (EQ (idx, XCAR (elt))) |
| 907 | { |
| 908 | CHECK_IMPURE (elt); |
| 909 | XSETCDR (elt, def); |
| 910 | return def; |
| 911 | } |
| 912 | else if (CONSP (idx) && CHARACTERP (XCAR (idx))) |
| 913 | { |
| 914 | int from = XFASTINT (XCAR (idx)); |
| 915 | int to = XFASTINT (XCDR (idx)); |
| 916 | |
| 917 | if (from <= XFASTINT (XCAR (elt)) |
| 918 | && to >= XFASTINT (XCAR (elt))) |
| 919 | { |
| 920 | XSETCDR (elt, def); |
| 921 | if (from == to) |
| 922 | return def; |
| 923 | } |
| 924 | } |
| 925 | } |
| 926 | else if (EQ (elt, Qkeymap)) |
| 927 | /* If we find a 'keymap' symbol in the spine of KEYMAP, |
| 928 | then we must have found the start of a second keymap |
| 929 | being used as the tail of KEYMAP, and a binding for IDX |
| 930 | should be inserted before it. */ |
| 931 | goto keymap_end; |
| 932 | |
| 933 | QUIT; |
| 934 | } |
| 935 | |
| 936 | keymap_end: |
| 937 | /* We have scanned the entire keymap, and not found a binding for |
| 938 | IDX. Let's add one. */ |
| 939 | { |
| 940 | Lisp_Object elt; |
| 941 | |
| 942 | if (CONSP (idx) && CHARACTERP (XCAR (idx))) |
| 943 | { |
| 944 | /* IDX specifies a range of characters, and not all of them |
| 945 | were handled yet, which means this keymap doesn't have a |
| 946 | char-table. So, we insert a char-table now. */ |
| 947 | elt = Fmake_char_table (Qkeymap, Qnil); |
| 948 | Fset_char_table_range (elt, idx, NILP (def) ? Qt : def); |
| 949 | } |
| 950 | else |
| 951 | elt = Fcons (idx, def); |
| 952 | CHECK_IMPURE (insertion_point); |
| 953 | XSETCDR (insertion_point, Fcons (elt, XCDR (insertion_point))); |
| 954 | } |
| 955 | } |
| 956 | |
| 957 | return def; |
| 958 | } |
| 959 | |
| 960 | static Lisp_Object |
| 961 | copy_keymap_item (Lisp_Object elt) |
| 962 | { |
| 963 | Lisp_Object res, tem; |
| 964 | |
| 965 | if (!CONSP (elt)) |
| 966 | return elt; |
| 967 | |
| 968 | res = tem = elt; |
| 969 | |
| 970 | /* Is this a new format menu item. */ |
| 971 | if (EQ (XCAR (tem), Qmenu_item)) |
| 972 | { |
| 973 | /* Copy cell with menu-item marker. */ |
| 974 | res = elt = Fcons (XCAR (tem), XCDR (tem)); |
| 975 | tem = XCDR (elt); |
| 976 | if (CONSP (tem)) |
| 977 | { |
| 978 | /* Copy cell with menu-item name. */ |
| 979 | XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem))); |
| 980 | elt = XCDR (elt); |
| 981 | tem = XCDR (elt); |
| 982 | } |
| 983 | if (CONSP (tem)) |
| 984 | { |
| 985 | /* Copy cell with binding and if the binding is a keymap, |
| 986 | copy that. */ |
| 987 | XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem))); |
| 988 | elt = XCDR (elt); |
| 989 | tem = XCAR (elt); |
| 990 | if (CONSP (tem) && EQ (XCAR (tem), Qkeymap)) |
| 991 | XSETCAR (elt, Fcopy_keymap (tem)); |
| 992 | tem = XCDR (elt); |
| 993 | if (CONSP (tem) && CONSP (XCAR (tem))) |
| 994 | /* Delete cache for key equivalences. */ |
| 995 | XSETCDR (elt, XCDR (tem)); |
| 996 | } |
| 997 | } |
| 998 | else |
| 999 | { |
| 1000 | /* It may be an old format menu item. |
| 1001 | Skip the optional menu string. */ |
| 1002 | if (STRINGP (XCAR (tem))) |
| 1003 | { |
| 1004 | /* Copy the cell, since copy-alist didn't go this deep. */ |
| 1005 | res = elt = Fcons (XCAR (tem), XCDR (tem)); |
| 1006 | tem = XCDR (elt); |
| 1007 | /* Also skip the optional menu help string. */ |
| 1008 | if (CONSP (tem) && STRINGP (XCAR (tem))) |
| 1009 | { |
| 1010 | XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem))); |
| 1011 | elt = XCDR (elt); |
| 1012 | tem = XCDR (elt); |
| 1013 | } |
| 1014 | /* There may also be a list that caches key equivalences. |
| 1015 | Just delete it for the new keymap. */ |
| 1016 | if (CONSP (tem) |
| 1017 | && CONSP (XCAR (tem)) |
| 1018 | && (NILP (XCAR (XCAR (tem))) |
| 1019 | || VECTORP (XCAR (XCAR (tem))))) |
| 1020 | { |
| 1021 | XSETCDR (elt, XCDR (tem)); |
| 1022 | tem = XCDR (tem); |
| 1023 | } |
| 1024 | if (CONSP (tem) && EQ (XCAR (tem), Qkeymap)) |
| 1025 | XSETCDR (elt, Fcopy_keymap (tem)); |
| 1026 | } |
| 1027 | else if (EQ (XCAR (tem), Qkeymap)) |
| 1028 | res = Fcopy_keymap (elt); |
| 1029 | } |
| 1030 | return res; |
| 1031 | } |
| 1032 | |
| 1033 | static void |
| 1034 | copy_keymap_1 (Lisp_Object chartable, Lisp_Object idx, Lisp_Object elt) |
| 1035 | { |
| 1036 | Fset_char_table_range (chartable, idx, copy_keymap_item (elt)); |
| 1037 | } |
| 1038 | |
| 1039 | DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0, |
| 1040 | doc: /* Return a copy of the keymap KEYMAP. |
| 1041 | The copy starts out with the same definitions of KEYMAP, |
| 1042 | but changing either the copy or KEYMAP does not affect the other. |
| 1043 | Any key definitions that are subkeymaps are recursively copied. |
| 1044 | However, a key definition which is a symbol whose definition is a keymap |
| 1045 | is not copied. */) |
| 1046 | (Lisp_Object keymap) |
| 1047 | { |
| 1048 | Lisp_Object copy, tail; |
| 1049 | keymap = get_keymap (keymap, 1, 0); |
| 1050 | copy = tail = list1 (Qkeymap); |
| 1051 | keymap = XCDR (keymap); /* Skip the `keymap' symbol. */ |
| 1052 | |
| 1053 | while (CONSP (keymap) && !EQ (XCAR (keymap), Qkeymap)) |
| 1054 | { |
| 1055 | Lisp_Object elt = XCAR (keymap); |
| 1056 | if (CHAR_TABLE_P (elt)) |
| 1057 | { |
| 1058 | elt = Fcopy_sequence (elt); |
| 1059 | map_char_table (copy_keymap_1, Qnil, elt, elt); |
| 1060 | } |
| 1061 | else if (VECTORP (elt)) |
| 1062 | { |
| 1063 | int i; |
| 1064 | elt = Fcopy_sequence (elt); |
| 1065 | for (i = 0; i < ASIZE (elt); i++) |
| 1066 | ASET (elt, i, copy_keymap_item (AREF (elt, i))); |
| 1067 | } |
| 1068 | else if (CONSP (elt)) |
| 1069 | { |
| 1070 | if (EQ (XCAR (elt), Qkeymap)) |
| 1071 | /* This is a sub keymap. */ |
| 1072 | elt = Fcopy_keymap (elt); |
| 1073 | else |
| 1074 | elt = Fcons (XCAR (elt), copy_keymap_item (XCDR (elt))); |
| 1075 | } |
| 1076 | XSETCDR (tail, list1 (elt)); |
| 1077 | tail = XCDR (tail); |
| 1078 | keymap = XCDR (keymap); |
| 1079 | } |
| 1080 | XSETCDR (tail, keymap); |
| 1081 | return copy; |
| 1082 | } |
| 1083 | \f |
| 1084 | /* Simple Keymap mutators and accessors. */ |
| 1085 | |
| 1086 | /* GC is possible in this function if it autoloads a keymap. */ |
| 1087 | |
| 1088 | DEFUN ("define-key", Fdefine_key, Sdefine_key, 3, 3, 0, |
| 1089 | doc: /* In KEYMAP, define key sequence KEY as DEF. |
| 1090 | KEYMAP is a keymap. |
| 1091 | |
| 1092 | KEY is a string or a vector of symbols and characters, representing a |
| 1093 | sequence of keystrokes and events. Non-ASCII characters with codes |
| 1094 | above 127 (such as ISO Latin-1) can be represented by vectors. |
| 1095 | Two types of vector have special meanings: |
| 1096 | [remap COMMAND] remaps any key binding for COMMAND. |
| 1097 | [t] creates a default definition, which applies to any event with no |
| 1098 | other definition in KEYMAP. |
| 1099 | |
| 1100 | DEF is anything that can be a key's definition: |
| 1101 | nil (means key is undefined in this keymap), |
| 1102 | a command (a Lisp function suitable for interactive calling), |
| 1103 | a string (treated as a keyboard macro), |
| 1104 | a keymap (to define a prefix key), |
| 1105 | a symbol (when the key is looked up, the symbol will stand for its |
| 1106 | function definition, which should at that time be one of the above, |
| 1107 | or another symbol whose function definition is used, etc.), |
| 1108 | a cons (STRING . DEFN), meaning that DEFN is the definition |
| 1109 | (DEFN should be a valid definition in its own right), |
| 1110 | or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP, |
| 1111 | or an extended menu item definition. |
| 1112 | (See info node `(elisp)Extended Menu Items'.) |
| 1113 | |
| 1114 | If KEYMAP is a sparse keymap with a binding for KEY, the existing |
| 1115 | binding is altered. If there is no binding for KEY, the new pair |
| 1116 | binding KEY to DEF is added at the front of KEYMAP. */) |
| 1117 | (Lisp_Object keymap, Lisp_Object key, Lisp_Object def) |
| 1118 | { |
| 1119 | ptrdiff_t idx; |
| 1120 | Lisp_Object c; |
| 1121 | Lisp_Object cmd; |
| 1122 | bool metized = 0; |
| 1123 | int meta_bit; |
| 1124 | ptrdiff_t length; |
| 1125 | struct gcpro gcpro1, gcpro2, gcpro3; |
| 1126 | |
| 1127 | GCPRO3 (keymap, key, def); |
| 1128 | keymap = get_keymap (keymap, 1, 1); |
| 1129 | |
| 1130 | CHECK_VECTOR_OR_STRING (key); |
| 1131 | |
| 1132 | length = XFASTINT (Flength (key)); |
| 1133 | if (length == 0) |
| 1134 | RETURN_UNGCPRO (Qnil); |
| 1135 | |
| 1136 | if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt)) |
| 1137 | Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands); |
| 1138 | |
| 1139 | meta_bit = (VECTORP (key) || (STRINGP (key) && STRING_MULTIBYTE (key)) |
| 1140 | ? meta_modifier : 0x80); |
| 1141 | |
| 1142 | if (VECTORP (def) && ASIZE (def) > 0 && CONSP (AREF (def, 0))) |
| 1143 | { /* DEF is apparently an XEmacs-style keyboard macro. */ |
| 1144 | Lisp_Object tmp = Fmake_vector (make_number (ASIZE (def)), Qnil); |
| 1145 | ptrdiff_t i = ASIZE (def); |
| 1146 | while (--i >= 0) |
| 1147 | { |
| 1148 | Lisp_Object defi = AREF (def, i); |
| 1149 | if (CONSP (defi) && lucid_event_type_list_p (defi)) |
| 1150 | defi = Fevent_convert_list (defi); |
| 1151 | ASET (tmp, i, defi); |
| 1152 | } |
| 1153 | def = tmp; |
| 1154 | } |
| 1155 | |
| 1156 | idx = 0; |
| 1157 | while (1) |
| 1158 | { |
| 1159 | c = Faref (key, make_number (idx)); |
| 1160 | |
| 1161 | if (CONSP (c)) |
| 1162 | { |
| 1163 | /* C may be a Lucid style event type list or a cons (FROM . |
| 1164 | TO) specifying a range of characters. */ |
| 1165 | if (lucid_event_type_list_p (c)) |
| 1166 | c = Fevent_convert_list (c); |
| 1167 | else if (CHARACTERP (XCAR (c))) |
| 1168 | CHECK_CHARACTER_CDR (c); |
| 1169 | } |
| 1170 | |
| 1171 | if (SYMBOLP (c)) |
| 1172 | silly_event_symbol_error (c); |
| 1173 | |
| 1174 | if (INTEGERP (c) |
| 1175 | && (XINT (c) & meta_bit) |
| 1176 | && !metized) |
| 1177 | { |
| 1178 | c = meta_prefix_char; |
| 1179 | metized = 1; |
| 1180 | } |
| 1181 | else |
| 1182 | { |
| 1183 | if (INTEGERP (c)) |
| 1184 | XSETINT (c, XINT (c) & ~meta_bit); |
| 1185 | |
| 1186 | metized = 0; |
| 1187 | idx++; |
| 1188 | } |
| 1189 | |
| 1190 | if (!INTEGERP (c) && !SYMBOLP (c) |
| 1191 | && (!CONSP (c) |
| 1192 | /* If C is a range, it must be a leaf. */ |
| 1193 | || (INTEGERP (XCAR (c)) && idx != length))) |
| 1194 | message_with_string ("Key sequence contains invalid event %s", c, 1); |
| 1195 | |
| 1196 | if (idx == length) |
| 1197 | RETURN_UNGCPRO (store_in_keymap (keymap, c, def)); |
| 1198 | |
| 1199 | cmd = access_keymap (keymap, c, 0, 1, 1); |
| 1200 | |
| 1201 | /* If this key is undefined, make it a prefix. */ |
| 1202 | if (NILP (cmd)) |
| 1203 | cmd = define_as_prefix (keymap, c); |
| 1204 | |
| 1205 | keymap = get_keymap (cmd, 0, 1); |
| 1206 | if (!CONSP (keymap)) |
| 1207 | { |
| 1208 | const char *trailing_esc = ((EQ (c, meta_prefix_char) && metized) |
| 1209 | ? (idx == 0 ? "ESC" : " ESC") |
| 1210 | : ""); |
| 1211 | |
| 1212 | /* We must use Fkey_description rather than just passing key to |
| 1213 | error; key might be a vector, not a string. */ |
| 1214 | error ("Key sequence %s starts with non-prefix key %s%s", |
| 1215 | SDATA (Fkey_description (key, Qnil)), |
| 1216 | SDATA (Fkey_description (Fsubstring (key, make_number (0), |
| 1217 | make_number (idx)), |
| 1218 | Qnil)), |
| 1219 | trailing_esc); |
| 1220 | } |
| 1221 | } |
| 1222 | } |
| 1223 | |
| 1224 | /* This function may GC (it calls Fkey_binding). */ |
| 1225 | |
| 1226 | DEFUN ("command-remapping", Fcommand_remapping, Scommand_remapping, 1, 3, 0, |
| 1227 | doc: /* Return the remapping for command COMMAND. |
| 1228 | Returns nil if COMMAND is not remapped (or not a symbol). |
| 1229 | |
| 1230 | If the optional argument POSITION is non-nil, it specifies a mouse |
| 1231 | position as returned by `event-start' and `event-end', and the |
| 1232 | remapping occurs in the keymaps associated with it. It can also be a |
| 1233 | number or marker, in which case the keymap properties at the specified |
| 1234 | buffer position instead of point are used. The KEYMAPS argument is |
| 1235 | ignored if POSITION is non-nil. |
| 1236 | |
| 1237 | If the optional argument KEYMAPS is non-nil, it should be a list of |
| 1238 | keymaps to search for command remapping. Otherwise, search for the |
| 1239 | remapping in all currently active keymaps. */) |
| 1240 | (Lisp_Object command, Lisp_Object position, Lisp_Object keymaps) |
| 1241 | { |
| 1242 | if (!SYMBOLP (command)) |
| 1243 | return Qnil; |
| 1244 | |
| 1245 | ASET (command_remapping_vector, 1, command); |
| 1246 | |
| 1247 | if (NILP (keymaps)) |
| 1248 | command = Fkey_binding (command_remapping_vector, Qnil, Qt, position); |
| 1249 | else |
| 1250 | command = Flookup_key (Fcons (Qkeymap, keymaps), |
| 1251 | command_remapping_vector, Qnil); |
| 1252 | return INTEGERP (command) ? Qnil : command; |
| 1253 | } |
| 1254 | |
| 1255 | /* Value is number if KEY is too long; nil if valid but has no definition. */ |
| 1256 | /* GC is possible in this function. */ |
| 1257 | |
| 1258 | DEFUN ("lookup-key", Flookup_key, Slookup_key, 2, 3, 0, |
| 1259 | doc: /* In keymap KEYMAP, look up key sequence KEY. Return the definition. |
| 1260 | A value of nil means undefined. See doc of `define-key' |
| 1261 | for kinds of definitions. |
| 1262 | |
| 1263 | A number as value means KEY is "too long"; |
| 1264 | that is, characters or symbols in it except for the last one |
| 1265 | fail to be a valid sequence of prefix characters in KEYMAP. |
| 1266 | The number is how many characters at the front of KEY |
| 1267 | it takes to reach a non-prefix key. |
| 1268 | |
| 1269 | Normally, `lookup-key' ignores bindings for t, which act as default |
| 1270 | bindings, used when nothing else in the keymap applies; this makes it |
| 1271 | usable as a general function for probing keymaps. However, if the |
| 1272 | third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will |
| 1273 | recognize the default bindings, just as `read-key-sequence' does. */) |
| 1274 | (Lisp_Object keymap, Lisp_Object key, Lisp_Object accept_default) |
| 1275 | { |
| 1276 | ptrdiff_t idx; |
| 1277 | Lisp_Object cmd; |
| 1278 | Lisp_Object c; |
| 1279 | ptrdiff_t length; |
| 1280 | bool t_ok = !NILP (accept_default); |
| 1281 | struct gcpro gcpro1, gcpro2; |
| 1282 | |
| 1283 | GCPRO2 (keymap, key); |
| 1284 | keymap = get_keymap (keymap, 1, 1); |
| 1285 | |
| 1286 | CHECK_VECTOR_OR_STRING (key); |
| 1287 | |
| 1288 | length = XFASTINT (Flength (key)); |
| 1289 | if (length == 0) |
| 1290 | RETURN_UNGCPRO (keymap); |
| 1291 | |
| 1292 | idx = 0; |
| 1293 | while (1) |
| 1294 | { |
| 1295 | c = Faref (key, make_number (idx++)); |
| 1296 | |
| 1297 | if (CONSP (c) && lucid_event_type_list_p (c)) |
| 1298 | c = Fevent_convert_list (c); |
| 1299 | |
| 1300 | /* Turn the 8th bit of string chars into a meta modifier. */ |
| 1301 | if (STRINGP (key) && XINT (c) & 0x80 && !STRING_MULTIBYTE (key)) |
| 1302 | XSETINT (c, (XINT (c) | meta_modifier) & ~0x80); |
| 1303 | |
| 1304 | /* Allow string since binding for `menu-bar-select-buffer' |
| 1305 | includes the buffer name in the key sequence. */ |
| 1306 | if (!INTEGERP (c) && !SYMBOLP (c) && !CONSP (c) && !STRINGP (c)) |
| 1307 | message_with_string ("Key sequence contains invalid event %s", c, 1); |
| 1308 | |
| 1309 | cmd = access_keymap (keymap, c, t_ok, 0, 1); |
| 1310 | if (idx == length) |
| 1311 | RETURN_UNGCPRO (cmd); |
| 1312 | |
| 1313 | keymap = get_keymap (cmd, 0, 1); |
| 1314 | if (!CONSP (keymap)) |
| 1315 | RETURN_UNGCPRO (make_number (idx)); |
| 1316 | |
| 1317 | QUIT; |
| 1318 | } |
| 1319 | } |
| 1320 | |
| 1321 | /* Make KEYMAP define event C as a keymap (i.e., as a prefix). |
| 1322 | Assume that currently it does not define C at all. |
| 1323 | Return the keymap. */ |
| 1324 | |
| 1325 | static Lisp_Object |
| 1326 | define_as_prefix (Lisp_Object keymap, Lisp_Object c) |
| 1327 | { |
| 1328 | Lisp_Object cmd; |
| 1329 | |
| 1330 | cmd = Fmake_sparse_keymap (Qnil); |
| 1331 | store_in_keymap (keymap, c, cmd); |
| 1332 | |
| 1333 | return cmd; |
| 1334 | } |
| 1335 | |
| 1336 | /* Append a key to the end of a key sequence. We always make a vector. */ |
| 1337 | |
| 1338 | static Lisp_Object |
| 1339 | append_key (Lisp_Object key_sequence, Lisp_Object key) |
| 1340 | { |
| 1341 | Lisp_Object args[2]; |
| 1342 | |
| 1343 | args[0] = key_sequence; |
| 1344 | args[1] = list1 (key); |
| 1345 | return Fvconcat (2, args); |
| 1346 | } |
| 1347 | |
| 1348 | /* Given a event type C which is a symbol, |
| 1349 | signal an error if is a mistake such as RET or M-RET or C-DEL, etc. */ |
| 1350 | |
| 1351 | static void |
| 1352 | silly_event_symbol_error (Lisp_Object c) |
| 1353 | { |
| 1354 | Lisp_Object parsed, base, name, assoc; |
| 1355 | int modifiers; |
| 1356 | |
| 1357 | parsed = parse_modifiers (c); |
| 1358 | modifiers = XFASTINT (XCAR (XCDR (parsed))); |
| 1359 | base = XCAR (parsed); |
| 1360 | name = Fsymbol_name (base); |
| 1361 | /* This alist includes elements such as ("RET" . "\\r"). */ |
| 1362 | assoc = Fassoc (name, exclude_keys); |
| 1363 | |
| 1364 | if (! NILP (assoc)) |
| 1365 | { |
| 1366 | char new_mods[sizeof ("\\A-\\C-\\H-\\M-\\S-\\s-")]; |
| 1367 | char *p = new_mods; |
| 1368 | Lisp_Object keystring; |
| 1369 | if (modifiers & alt_modifier) |
| 1370 | { *p++ = '\\'; *p++ = 'A'; *p++ = '-'; } |
| 1371 | if (modifiers & ctrl_modifier) |
| 1372 | { *p++ = '\\'; *p++ = 'C'; *p++ = '-'; } |
| 1373 | if (modifiers & hyper_modifier) |
| 1374 | { *p++ = '\\'; *p++ = 'H'; *p++ = '-'; } |
| 1375 | if (modifiers & meta_modifier) |
| 1376 | { *p++ = '\\'; *p++ = 'M'; *p++ = '-'; } |
| 1377 | if (modifiers & shift_modifier) |
| 1378 | { *p++ = '\\'; *p++ = 'S'; *p++ = '-'; } |
| 1379 | if (modifiers & super_modifier) |
| 1380 | { *p++ = '\\'; *p++ = 's'; *p++ = '-'; } |
| 1381 | *p = 0; |
| 1382 | |
| 1383 | c = reorder_modifiers (c); |
| 1384 | keystring = concat2 (build_string (new_mods), XCDR (assoc)); |
| 1385 | |
| 1386 | error ("To bind the key %s, use [?%s], not [%s]", |
| 1387 | SDATA (SYMBOL_NAME (c)), SDATA (keystring), |
| 1388 | SDATA (SYMBOL_NAME (c))); |
| 1389 | } |
| 1390 | } |
| 1391 | \f |
| 1392 | /* Global, local, and minor mode keymap stuff. */ |
| 1393 | |
| 1394 | /* We can't put these variables inside current_minor_maps, since under |
| 1395 | some systems, static gets macro-defined to be the empty string. |
| 1396 | Ickypoo. */ |
| 1397 | static Lisp_Object *cmm_modes = NULL, *cmm_maps = NULL; |
| 1398 | static ptrdiff_t cmm_size = 0; |
| 1399 | |
| 1400 | /* Store a pointer to an array of the currently active minor modes in |
| 1401 | *modeptr, a pointer to an array of the keymaps of the currently |
| 1402 | active minor modes in *mapptr, and return the number of maps |
| 1403 | *mapptr contains. |
| 1404 | |
| 1405 | This function always returns a pointer to the same buffer, and may |
| 1406 | free or reallocate it, so if you want to keep it for a long time or |
| 1407 | hand it out to lisp code, copy it. This procedure will be called |
| 1408 | for every key sequence read, so the nice lispy approach (return a |
| 1409 | new assoclist, list, what have you) for each invocation would |
| 1410 | result in a lot of consing over time. |
| 1411 | |
| 1412 | If we used xrealloc/xmalloc and ran out of memory, they would throw |
| 1413 | back to the command loop, which would try to read a key sequence, |
| 1414 | which would call this function again, resulting in an infinite |
| 1415 | loop. Instead, we'll use realloc/malloc and silently truncate the |
| 1416 | list, let the key sequence be read, and hope some other piece of |
| 1417 | code signals the error. */ |
| 1418 | ptrdiff_t |
| 1419 | current_minor_maps (Lisp_Object **modeptr, Lisp_Object **mapptr) |
| 1420 | { |
| 1421 | ptrdiff_t i = 0; |
| 1422 | int list_number = 0; |
| 1423 | Lisp_Object alist, assoc, var, val; |
| 1424 | Lisp_Object emulation_alists; |
| 1425 | Lisp_Object lists[2]; |
| 1426 | |
| 1427 | emulation_alists = Vemulation_mode_map_alists; |
| 1428 | lists[0] = Vminor_mode_overriding_map_alist; |
| 1429 | lists[1] = Vminor_mode_map_alist; |
| 1430 | |
| 1431 | for (list_number = 0; list_number < 2; list_number++) |
| 1432 | { |
| 1433 | if (CONSP (emulation_alists)) |
| 1434 | { |
| 1435 | alist = XCAR (emulation_alists); |
| 1436 | emulation_alists = XCDR (emulation_alists); |
| 1437 | if (SYMBOLP (alist)) |
| 1438 | alist = find_symbol_value (alist); |
| 1439 | list_number = -1; |
| 1440 | } |
| 1441 | else |
| 1442 | alist = lists[list_number]; |
| 1443 | |
| 1444 | for ( ; CONSP (alist); alist = XCDR (alist)) |
| 1445 | if ((assoc = XCAR (alist), CONSP (assoc)) |
| 1446 | && (var = XCAR (assoc), SYMBOLP (var)) |
| 1447 | && (val = find_symbol_value (var), !EQ (val, Qunbound)) |
| 1448 | && !NILP (val)) |
| 1449 | { |
| 1450 | Lisp_Object temp; |
| 1451 | |
| 1452 | /* If a variable has an entry in Vminor_mode_overriding_map_alist, |
| 1453 | and also an entry in Vminor_mode_map_alist, |
| 1454 | ignore the latter. */ |
| 1455 | if (list_number == 1) |
| 1456 | { |
| 1457 | val = assq_no_quit (var, lists[0]); |
| 1458 | if (!NILP (val)) |
| 1459 | continue; |
| 1460 | } |
| 1461 | |
| 1462 | if (i >= cmm_size) |
| 1463 | { |
| 1464 | ptrdiff_t newsize, allocsize; |
| 1465 | Lisp_Object *newmodes, *newmaps; |
| 1466 | |
| 1467 | /* Check for size calculation overflow. Other code |
| 1468 | (e.g., read_key_sequence) adds 3 to the count |
| 1469 | later, so subtract 3 from the limit here. */ |
| 1470 | if (min (PTRDIFF_MAX, SIZE_MAX) / (2 * sizeof *newmodes) - 3 |
| 1471 | < cmm_size) |
| 1472 | break; |
| 1473 | |
| 1474 | newsize = cmm_size == 0 ? 30 : cmm_size * 2; |
| 1475 | allocsize = newsize * sizeof *newmodes; |
| 1476 | |
| 1477 | /* Use malloc here. See the comment above this function. |
| 1478 | Avoid realloc here; it causes spurious traps on GNU/Linux [KFS] */ |
| 1479 | block_input (); |
| 1480 | newmodes = xmalloc_unsafe (allocsize); |
| 1481 | if (newmodes) |
| 1482 | { |
| 1483 | if (cmm_modes) |
| 1484 | { |
| 1485 | memcpy (newmodes, cmm_modes, |
| 1486 | cmm_size * sizeof cmm_modes[0]); |
| 1487 | xfree (cmm_modes); |
| 1488 | } |
| 1489 | cmm_modes = newmodes; |
| 1490 | } |
| 1491 | |
| 1492 | newmaps = xmalloc_unsafe (allocsize); |
| 1493 | if (newmaps) |
| 1494 | { |
| 1495 | if (cmm_maps) |
| 1496 | { |
| 1497 | memcpy (newmaps, cmm_maps, |
| 1498 | cmm_size * sizeof cmm_maps[0]); |
| 1499 | xfree (cmm_maps); |
| 1500 | } |
| 1501 | cmm_maps = newmaps; |
| 1502 | } |
| 1503 | unblock_input (); |
| 1504 | |
| 1505 | if (newmodes == NULL || newmaps == NULL) |
| 1506 | break; |
| 1507 | cmm_size = newsize; |
| 1508 | } |
| 1509 | |
| 1510 | /* Get the keymap definition--or nil if it is not defined. */ |
| 1511 | temp = Findirect_function (XCDR (assoc), Qt); |
| 1512 | if (!NILP (temp)) |
| 1513 | { |
| 1514 | cmm_modes[i] = var; |
| 1515 | cmm_maps [i] = temp; |
| 1516 | i++; |
| 1517 | } |
| 1518 | } |
| 1519 | } |
| 1520 | |
| 1521 | if (modeptr) *modeptr = cmm_modes; |
| 1522 | if (mapptr) *mapptr = cmm_maps; |
| 1523 | return i; |
| 1524 | } |
| 1525 | |
| 1526 | /* Return the offset of POSITION, a click position, in the style of |
| 1527 | the respective argument of Fkey_binding. */ |
| 1528 | static ptrdiff_t |
| 1529 | click_position (Lisp_Object position) |
| 1530 | { |
| 1531 | EMACS_INT pos = (INTEGERP (position) ? XINT (position) |
| 1532 | : MARKERP (position) ? marker_position (position) |
| 1533 | : PT); |
| 1534 | if (! (BEGV <= pos && pos <= ZV)) |
| 1535 | args_out_of_range (Fcurrent_buffer (), position); |
| 1536 | return pos; |
| 1537 | } |
| 1538 | |
| 1539 | DEFUN ("current-active-maps", Fcurrent_active_maps, Scurrent_active_maps, |
| 1540 | 0, 2, 0, |
| 1541 | doc: /* Return a list of the currently active keymaps. |
| 1542 | OLP if non-nil indicates that we should obey `overriding-local-map' and |
| 1543 | `overriding-terminal-local-map'. POSITION can specify a click position |
| 1544 | like in the respective argument of `key-binding'. */) |
| 1545 | (Lisp_Object olp, Lisp_Object position) |
| 1546 | { |
| 1547 | ptrdiff_t count = SPECPDL_INDEX (); |
| 1548 | |
| 1549 | Lisp_Object keymaps = list1 (current_global_map); |
| 1550 | |
| 1551 | /* If a mouse click position is given, our variables are based on |
| 1552 | the buffer clicked on, not the current buffer. So we may have to |
| 1553 | switch the buffer here. */ |
| 1554 | |
| 1555 | if (CONSP (position)) |
| 1556 | { |
| 1557 | Lisp_Object window; |
| 1558 | |
| 1559 | window = POSN_WINDOW (position); |
| 1560 | |
| 1561 | if (WINDOWP (window) |
| 1562 | && BUFFERP (XWINDOW (window)->contents) |
| 1563 | && XBUFFER (XWINDOW (window)->contents) != current_buffer) |
| 1564 | { |
| 1565 | /* Arrange to go back to the original buffer once we're done |
| 1566 | processing the key sequence. We don't use |
| 1567 | save_excursion_{save,restore} here, in analogy to |
| 1568 | `read-key-sequence' to avoid saving point. Maybe this |
| 1569 | would not be a problem here, but it is easier to keep |
| 1570 | things the same. |
| 1571 | */ |
| 1572 | record_unwind_current_buffer (); |
| 1573 | set_buffer_internal (XBUFFER (XWINDOW (window)->contents)); |
| 1574 | } |
| 1575 | } |
| 1576 | |
| 1577 | if (!NILP (olp) |
| 1578 | /* The doc said that overriding-terminal-local-map should |
| 1579 | override overriding-local-map. The code used them both, |
| 1580 | but it seems clearer to use just one. rms, jan 2005. */ |
| 1581 | && NILP (KVAR (current_kboard, Voverriding_terminal_local_map)) |
| 1582 | && !NILP (Voverriding_local_map)) |
| 1583 | keymaps = Fcons (Voverriding_local_map, keymaps); |
| 1584 | |
| 1585 | if (NILP (XCDR (keymaps))) |
| 1586 | { |
| 1587 | Lisp_Object *maps; |
| 1588 | int nmaps, i; |
| 1589 | ptrdiff_t pt = click_position (position); |
| 1590 | /* This usually returns the buffer's local map, |
| 1591 | but that can be overridden by a `local-map' property. */ |
| 1592 | Lisp_Object local_map = get_local_map (pt, current_buffer, Qlocal_map); |
| 1593 | /* This returns nil unless there is a `keymap' property. */ |
| 1594 | Lisp_Object keymap = get_local_map (pt, current_buffer, Qkeymap); |
| 1595 | Lisp_Object otlp = KVAR (current_kboard, Voverriding_terminal_local_map); |
| 1596 | |
| 1597 | if (CONSP (position)) |
| 1598 | { |
| 1599 | Lisp_Object string = POSN_STRING (position); |
| 1600 | |
| 1601 | /* For a mouse click, get the local text-property keymap |
| 1602 | of the place clicked on, rather than point. */ |
| 1603 | |
| 1604 | if (POSN_INBUFFER_P (position)) |
| 1605 | { |
| 1606 | Lisp_Object pos; |
| 1607 | |
| 1608 | pos = POSN_BUFFER_POSN (position); |
| 1609 | if (INTEGERP (pos) |
| 1610 | && XINT (pos) >= BEG && XINT (pos) <= Z) |
| 1611 | { |
| 1612 | local_map = get_local_map (XINT (pos), |
| 1613 | current_buffer, Qlocal_map); |
| 1614 | |
| 1615 | keymap = get_local_map (XINT (pos), |
| 1616 | current_buffer, Qkeymap); |
| 1617 | } |
| 1618 | } |
| 1619 | |
| 1620 | /* If on a mode line string with a local keymap, |
| 1621 | or for a click on a string, i.e. overlay string or a |
| 1622 | string displayed via the `display' property, |
| 1623 | consider `local-map' and `keymap' properties of |
| 1624 | that string. */ |
| 1625 | |
| 1626 | if (CONSP (string) && STRINGP (XCAR (string))) |
| 1627 | { |
| 1628 | Lisp_Object pos, map; |
| 1629 | |
| 1630 | pos = XCDR (string); |
| 1631 | string = XCAR (string); |
| 1632 | if (INTEGERP (pos) |
| 1633 | && XINT (pos) >= 0 |
| 1634 | && XINT (pos) < SCHARS (string)) |
| 1635 | { |
| 1636 | map = Fget_text_property (pos, Qlocal_map, string); |
| 1637 | if (!NILP (map)) |
| 1638 | local_map = map; |
| 1639 | |
| 1640 | map = Fget_text_property (pos, Qkeymap, string); |
| 1641 | if (!NILP (map)) |
| 1642 | keymap = map; |
| 1643 | } |
| 1644 | } |
| 1645 | |
| 1646 | } |
| 1647 | |
| 1648 | if (!NILP (local_map)) |
| 1649 | keymaps = Fcons (local_map, keymaps); |
| 1650 | |
| 1651 | /* Now put all the minor mode keymaps on the list. */ |
| 1652 | nmaps = current_minor_maps (0, &maps); |
| 1653 | |
| 1654 | for (i = --nmaps; i >= 0; i--) |
| 1655 | if (!NILP (maps[i])) |
| 1656 | keymaps = Fcons (maps[i], keymaps); |
| 1657 | |
| 1658 | if (!NILP (keymap)) |
| 1659 | keymaps = Fcons (keymap, keymaps); |
| 1660 | |
| 1661 | if (!NILP (olp) && !NILP (otlp)) |
| 1662 | keymaps = Fcons (otlp, keymaps); |
| 1663 | } |
| 1664 | |
| 1665 | unbind_to (count, Qnil); |
| 1666 | |
| 1667 | return keymaps; |
| 1668 | } |
| 1669 | |
| 1670 | /* GC is possible in this function if it autoloads a keymap. */ |
| 1671 | |
| 1672 | DEFUN ("key-binding", Fkey_binding, Skey_binding, 1, 4, 0, |
| 1673 | doc: /* Return the binding for command KEY in current keymaps. |
| 1674 | KEY is a string or vector, a sequence of keystrokes. |
| 1675 | The binding is probably a symbol with a function definition. |
| 1676 | |
| 1677 | Normally, `key-binding' ignores bindings for t, which act as default |
| 1678 | bindings, used when nothing else in the keymap applies; this makes it |
| 1679 | usable as a general function for probing keymaps. However, if the |
| 1680 | optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does |
| 1681 | recognize the default bindings, just as `read-key-sequence' does. |
| 1682 | |
| 1683 | Like the normal command loop, `key-binding' will remap the command |
| 1684 | resulting from looking up KEY by looking up the command in the |
| 1685 | current keymaps. However, if the optional third argument NO-REMAP |
| 1686 | is non-nil, `key-binding' returns the unmapped command. |
| 1687 | |
| 1688 | If KEY is a key sequence initiated with the mouse, the used keymaps |
| 1689 | will depend on the clicked mouse position with regard to the buffer |
| 1690 | and possible local keymaps on strings. |
| 1691 | |
| 1692 | If the optional argument POSITION is non-nil, it specifies a mouse |
| 1693 | position as returned by `event-start' and `event-end', and the lookup |
| 1694 | occurs in the keymaps associated with it instead of KEY. It can also |
| 1695 | be a number or marker, in which case the keymap properties at the |
| 1696 | specified buffer position instead of point are used. |
| 1697 | */) |
| 1698 | (Lisp_Object key, Lisp_Object accept_default, Lisp_Object no_remap, Lisp_Object position) |
| 1699 | { |
| 1700 | Lisp_Object value; |
| 1701 | |
| 1702 | if (NILP (position) && VECTORP (key)) |
| 1703 | { |
| 1704 | Lisp_Object event |
| 1705 | /* mouse events may have a symbolic prefix indicating the |
| 1706 | scrollbar or mode line */ |
| 1707 | = AREF (key, SYMBOLP (AREF (key, 0)) && ASIZE (key) > 1 ? 1 : 0); |
| 1708 | |
| 1709 | /* We are not interested in locations without event data */ |
| 1710 | |
| 1711 | if (EVENT_HAS_PARAMETERS (event) && CONSP (XCDR (event))) |
| 1712 | { |
| 1713 | Lisp_Object kind = EVENT_HEAD_KIND (EVENT_HEAD (event)); |
| 1714 | if (EQ (kind, Qmouse_click)) |
| 1715 | position = EVENT_START (event); |
| 1716 | } |
| 1717 | } |
| 1718 | |
| 1719 | value = Flookup_key (Fcons (Qkeymap, Fcurrent_active_maps (Qt, position)), |
| 1720 | key, accept_default); |
| 1721 | |
| 1722 | if (NILP (value) || INTEGERP (value)) |
| 1723 | return Qnil; |
| 1724 | |
| 1725 | /* If the result of the ordinary keymap lookup is an interactive |
| 1726 | command, look for a key binding (ie. remapping) for that command. */ |
| 1727 | |
| 1728 | if (NILP (no_remap) && SYMBOLP (value)) |
| 1729 | { |
| 1730 | Lisp_Object value1; |
| 1731 | if (value1 = Fcommand_remapping (value, position, Qnil), !NILP (value1)) |
| 1732 | value = value1; |
| 1733 | } |
| 1734 | |
| 1735 | return value; |
| 1736 | } |
| 1737 | |
| 1738 | /* GC is possible in this function if it autoloads a keymap. */ |
| 1739 | |
| 1740 | DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 2, 0, |
| 1741 | doc: /* Return the binding for command KEYS in current local keymap only. |
| 1742 | KEYS is a string or vector, a sequence of keystrokes. |
| 1743 | The binding is probably a symbol with a function definition. |
| 1744 | |
| 1745 | If optional argument ACCEPT-DEFAULT is non-nil, recognize default |
| 1746 | bindings; see the description of `lookup-key' for more details about this. */) |
| 1747 | (Lisp_Object keys, Lisp_Object accept_default) |
| 1748 | { |
| 1749 | register Lisp_Object map; |
| 1750 | map = BVAR (current_buffer, keymap); |
| 1751 | if (NILP (map)) |
| 1752 | return Qnil; |
| 1753 | return Flookup_key (map, keys, accept_default); |
| 1754 | } |
| 1755 | |
| 1756 | /* GC is possible in this function if it autoloads a keymap. */ |
| 1757 | |
| 1758 | DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 2, 0, |
| 1759 | doc: /* Return the binding for command KEYS in current global keymap only. |
| 1760 | KEYS is a string or vector, a sequence of keystrokes. |
| 1761 | The binding is probably a symbol with a function definition. |
| 1762 | This function's return values are the same as those of `lookup-key' |
| 1763 | \(which see). |
| 1764 | |
| 1765 | If optional argument ACCEPT-DEFAULT is non-nil, recognize default |
| 1766 | bindings; see the description of `lookup-key' for more details about this. */) |
| 1767 | (Lisp_Object keys, Lisp_Object accept_default) |
| 1768 | { |
| 1769 | return Flookup_key (current_global_map, keys, accept_default); |
| 1770 | } |
| 1771 | |
| 1772 | /* GC is possible in this function if it autoloads a keymap. */ |
| 1773 | |
| 1774 | DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 2, 0, |
| 1775 | doc: /* Find the visible minor mode bindings of KEY. |
| 1776 | Return an alist of pairs (MODENAME . BINDING), where MODENAME is |
| 1777 | the symbol which names the minor mode binding KEY, and BINDING is |
| 1778 | KEY's definition in that mode. In particular, if KEY has no |
| 1779 | minor-mode bindings, return nil. If the first binding is a |
| 1780 | non-prefix, all subsequent bindings will be omitted, since they would |
| 1781 | be ignored. Similarly, the list doesn't include non-prefix bindings |
| 1782 | that come after prefix bindings. |
| 1783 | |
| 1784 | If optional argument ACCEPT-DEFAULT is non-nil, recognize default |
| 1785 | bindings; see the description of `lookup-key' for more details about this. */) |
| 1786 | (Lisp_Object key, Lisp_Object accept_default) |
| 1787 | { |
| 1788 | Lisp_Object *modes, *maps; |
| 1789 | int nmaps; |
| 1790 | Lisp_Object binding; |
| 1791 | int i, j; |
| 1792 | struct gcpro gcpro1, gcpro2; |
| 1793 | |
| 1794 | nmaps = current_minor_maps (&modes, &maps); |
| 1795 | /* Note that all these maps are GCPRO'd |
| 1796 | in the places where we found them. */ |
| 1797 | |
| 1798 | binding = Qnil; |
| 1799 | GCPRO2 (key, binding); |
| 1800 | |
| 1801 | for (i = j = 0; i < nmaps; i++) |
| 1802 | if (!NILP (maps[i]) |
| 1803 | && !NILP (binding = Flookup_key (maps[i], key, accept_default)) |
| 1804 | && !INTEGERP (binding)) |
| 1805 | { |
| 1806 | if (KEYMAPP (binding)) |
| 1807 | maps[j++] = Fcons (modes[i], binding); |
| 1808 | else if (j == 0) |
| 1809 | RETURN_UNGCPRO (list1 (Fcons (modes[i], binding))); |
| 1810 | } |
| 1811 | |
| 1812 | UNGCPRO; |
| 1813 | return Flist (j, maps); |
| 1814 | } |
| 1815 | |
| 1816 | DEFUN ("define-prefix-command", Fdefine_prefix_command, Sdefine_prefix_command, 1, 3, 0, |
| 1817 | doc: /* Define COMMAND as a prefix command. COMMAND should be a symbol. |
| 1818 | A new sparse keymap is stored as COMMAND's function definition and its value. |
| 1819 | If a second optional argument MAPVAR is given, the map is stored as |
| 1820 | its value instead of as COMMAND's value; but COMMAND is still defined |
| 1821 | as a function. |
| 1822 | The third optional argument NAME, if given, supplies a menu name |
| 1823 | string for the map. This is required to use the keymap as a menu. |
| 1824 | This function returns COMMAND. */) |
| 1825 | (Lisp_Object command, Lisp_Object mapvar, Lisp_Object name) |
| 1826 | { |
| 1827 | Lisp_Object map; |
| 1828 | map = Fmake_sparse_keymap (name); |
| 1829 | Ffset (command, map); |
| 1830 | if (!NILP (mapvar)) |
| 1831 | Fset (mapvar, map); |
| 1832 | else |
| 1833 | Fset (command, map); |
| 1834 | return command; |
| 1835 | } |
| 1836 | |
| 1837 | DEFUN ("use-global-map", Fuse_global_map, Suse_global_map, 1, 1, 0, |
| 1838 | doc: /* Select KEYMAP as the global keymap. */) |
| 1839 | (Lisp_Object keymap) |
| 1840 | { |
| 1841 | keymap = get_keymap (keymap, 1, 1); |
| 1842 | current_global_map = keymap; |
| 1843 | |
| 1844 | return Qnil; |
| 1845 | } |
| 1846 | |
| 1847 | DEFUN ("use-local-map", Fuse_local_map, Suse_local_map, 1, 1, 0, |
| 1848 | doc: /* Select KEYMAP as the local keymap. |
| 1849 | If KEYMAP is nil, that means no local keymap. */) |
| 1850 | (Lisp_Object keymap) |
| 1851 | { |
| 1852 | if (!NILP (keymap)) |
| 1853 | keymap = get_keymap (keymap, 1, 1); |
| 1854 | |
| 1855 | bset_keymap (current_buffer, keymap); |
| 1856 | |
| 1857 | return Qnil; |
| 1858 | } |
| 1859 | |
| 1860 | DEFUN ("current-local-map", Fcurrent_local_map, Scurrent_local_map, 0, 0, 0, |
| 1861 | doc: /* Return current buffer's local keymap, or nil if it has none. |
| 1862 | Normally the local keymap is set by the major mode with `use-local-map'. */) |
| 1863 | (void) |
| 1864 | { |
| 1865 | return BVAR (current_buffer, keymap); |
| 1866 | } |
| 1867 | |
| 1868 | DEFUN ("current-global-map", Fcurrent_global_map, Scurrent_global_map, 0, 0, 0, |
| 1869 | doc: /* Return the current global keymap. */) |
| 1870 | (void) |
| 1871 | { |
| 1872 | return current_global_map; |
| 1873 | } |
| 1874 | |
| 1875 | DEFUN ("current-minor-mode-maps", Fcurrent_minor_mode_maps, Scurrent_minor_mode_maps, 0, 0, 0, |
| 1876 | doc: /* Return a list of keymaps for the minor modes of the current buffer. */) |
| 1877 | (void) |
| 1878 | { |
| 1879 | Lisp_Object *maps; |
| 1880 | int nmaps = current_minor_maps (0, &maps); |
| 1881 | |
| 1882 | return Flist (nmaps, maps); |
| 1883 | } |
| 1884 | \f |
| 1885 | /* Help functions for describing and documenting keymaps. */ |
| 1886 | |
| 1887 | struct accessible_keymaps_data { |
| 1888 | Lisp_Object maps, tail, thisseq; |
| 1889 | /* Does the current sequence end in the meta-prefix-char? */ |
| 1890 | bool is_metized; |
| 1891 | }; |
| 1892 | |
| 1893 | static void |
| 1894 | accessible_keymaps_1 (Lisp_Object key, Lisp_Object cmd, Lisp_Object args, void *data) |
| 1895 | /* Use void * data to be compatible with map_keymap_function_t. */ |
| 1896 | { |
| 1897 | struct accessible_keymaps_data *d = data; /* Cast! */ |
| 1898 | Lisp_Object maps = d->maps; |
| 1899 | Lisp_Object tail = d->tail; |
| 1900 | Lisp_Object thisseq = d->thisseq; |
| 1901 | bool is_metized = d->is_metized && INTEGERP (key); |
| 1902 | Lisp_Object tem; |
| 1903 | |
| 1904 | cmd = get_keymap (get_keyelt (cmd, 0), 0, 0); |
| 1905 | if (NILP (cmd)) |
| 1906 | return; |
| 1907 | |
| 1908 | /* Look for and break cycles. */ |
| 1909 | while (!NILP (tem = Frassq (cmd, maps))) |
| 1910 | { |
| 1911 | Lisp_Object prefix = XCAR (tem); |
| 1912 | ptrdiff_t lim = XINT (Flength (XCAR (tem))); |
| 1913 | if (lim <= XINT (Flength (thisseq))) |
| 1914 | { /* This keymap was already seen with a smaller prefix. */ |
| 1915 | ptrdiff_t i = 0; |
| 1916 | while (i < lim && EQ (Faref (prefix, make_number (i)), |
| 1917 | Faref (thisseq, make_number (i)))) |
| 1918 | i++; |
| 1919 | if (i >= lim) |
| 1920 | /* `prefix' is a prefix of `thisseq' => there's a cycle. */ |
| 1921 | return; |
| 1922 | } |
| 1923 | /* This occurrence of `cmd' in `maps' does not correspond to a cycle, |
| 1924 | but maybe `cmd' occurs again further down in `maps', so keep |
| 1925 | looking. */ |
| 1926 | maps = XCDR (Fmemq (tem, maps)); |
| 1927 | } |
| 1928 | |
| 1929 | /* If the last key in thisseq is meta-prefix-char, |
| 1930 | turn it into a meta-ized keystroke. We know |
| 1931 | that the event we're about to append is an |
| 1932 | ascii keystroke since we're processing a |
| 1933 | keymap table. */ |
| 1934 | if (is_metized) |
| 1935 | { |
| 1936 | int meta_bit = meta_modifier; |
| 1937 | Lisp_Object last = make_number (XINT (Flength (thisseq)) - 1); |
| 1938 | tem = Fcopy_sequence (thisseq); |
| 1939 | |
| 1940 | Faset (tem, last, make_number (XINT (key) | meta_bit)); |
| 1941 | |
| 1942 | /* This new sequence is the same length as |
| 1943 | thisseq, so stick it in the list right |
| 1944 | after this one. */ |
| 1945 | XSETCDR (tail, |
| 1946 | Fcons (Fcons (tem, cmd), XCDR (tail))); |
| 1947 | } |
| 1948 | else |
| 1949 | { |
| 1950 | tem = append_key (thisseq, key); |
| 1951 | nconc2 (tail, list1 (Fcons (tem, cmd))); |
| 1952 | } |
| 1953 | } |
| 1954 | |
| 1955 | /* This function cannot GC. */ |
| 1956 | |
| 1957 | DEFUN ("accessible-keymaps", Faccessible_keymaps, Saccessible_keymaps, |
| 1958 | 1, 2, 0, |
| 1959 | doc: /* Find all keymaps accessible via prefix characters from KEYMAP. |
| 1960 | Returns a list of elements of the form (KEYS . MAP), where the sequence |
| 1961 | KEYS starting from KEYMAP gets you to MAP. These elements are ordered |
| 1962 | so that the KEYS increase in length. The first element is ([] . KEYMAP). |
| 1963 | An optional argument PREFIX, if non-nil, should be a key sequence; |
| 1964 | then the value includes only maps for prefixes that start with PREFIX. */) |
| 1965 | (Lisp_Object keymap, Lisp_Object prefix) |
| 1966 | { |
| 1967 | Lisp_Object maps, tail; |
| 1968 | EMACS_INT prefixlen = XFASTINT (Flength (prefix)); |
| 1969 | |
| 1970 | /* no need for gcpro because we don't autoload any keymaps. */ |
| 1971 | |
| 1972 | if (!NILP (prefix)) |
| 1973 | { |
| 1974 | /* If a prefix was specified, start with the keymap (if any) for |
| 1975 | that prefix, so we don't waste time considering other prefixes. */ |
| 1976 | Lisp_Object tem; |
| 1977 | tem = Flookup_key (keymap, prefix, Qt); |
| 1978 | /* Flookup_key may give us nil, or a number, |
| 1979 | if the prefix is not defined in this particular map. |
| 1980 | It might even give us a list that isn't a keymap. */ |
| 1981 | tem = get_keymap (tem, 0, 0); |
| 1982 | /* If the keymap is autoloaded `tem' is not a cons-cell, but we still |
| 1983 | want to return it. */ |
| 1984 | if (!NILP (tem)) |
| 1985 | { |
| 1986 | /* Convert PREFIX to a vector now, so that later on |
| 1987 | we don't have to deal with the possibility of a string. */ |
| 1988 | if (STRINGP (prefix)) |
| 1989 | { |
| 1990 | int i, i_byte, c; |
| 1991 | Lisp_Object copy; |
| 1992 | |
| 1993 | copy = Fmake_vector (make_number (SCHARS (prefix)), Qnil); |
| 1994 | for (i = 0, i_byte = 0; i < SCHARS (prefix);) |
| 1995 | { |
| 1996 | int i_before = i; |
| 1997 | |
| 1998 | FETCH_STRING_CHAR_ADVANCE (c, prefix, i, i_byte); |
| 1999 | if (SINGLE_BYTE_CHAR_P (c) && (c & 0200)) |
| 2000 | c ^= 0200 | meta_modifier; |
| 2001 | ASET (copy, i_before, make_number (c)); |
| 2002 | } |
| 2003 | prefix = copy; |
| 2004 | } |
| 2005 | maps = list1 (Fcons (prefix, tem)); |
| 2006 | } |
| 2007 | else |
| 2008 | return Qnil; |
| 2009 | } |
| 2010 | else |
| 2011 | maps = list1 (Fcons (zero_vector, get_keymap (keymap, 1, 0))); |
| 2012 | |
| 2013 | /* For each map in the list maps, |
| 2014 | look at any other maps it points to, |
| 2015 | and stick them at the end if they are not already in the list. |
| 2016 | |
| 2017 | This is a breadth-first traversal, where tail is the queue of |
| 2018 | nodes, and maps accumulates a list of all nodes visited. */ |
| 2019 | |
| 2020 | for (tail = maps; CONSP (tail); tail = XCDR (tail)) |
| 2021 | { |
| 2022 | struct accessible_keymaps_data data; |
| 2023 | register Lisp_Object thismap = Fcdr (XCAR (tail)); |
| 2024 | Lisp_Object last; |
| 2025 | |
| 2026 | data.thisseq = Fcar (XCAR (tail)); |
| 2027 | data.maps = maps; |
| 2028 | data.tail = tail; |
| 2029 | last = make_number (XINT (Flength (data.thisseq)) - 1); |
| 2030 | /* Does the current sequence end in the meta-prefix-char? */ |
| 2031 | data.is_metized = (XINT (last) >= 0 |
| 2032 | /* Don't metize the last char of PREFIX. */ |
| 2033 | && XINT (last) >= prefixlen |
| 2034 | && EQ (Faref (data.thisseq, last), meta_prefix_char)); |
| 2035 | |
| 2036 | /* Since we can't run lisp code, we can't scan autoloaded maps. */ |
| 2037 | if (CONSP (thismap)) |
| 2038 | map_keymap (thismap, accessible_keymaps_1, Qnil, &data, 0); |
| 2039 | } |
| 2040 | return maps; |
| 2041 | } |
| 2042 | static Lisp_Object Qsingle_key_description, Qkey_description; |
| 2043 | |
| 2044 | /* This function cannot GC. */ |
| 2045 | |
| 2046 | DEFUN ("key-description", Fkey_description, Skey_description, 1, 2, 0, |
| 2047 | doc: /* Return a pretty description of key-sequence KEYS. |
| 2048 | Optional arg PREFIX is the sequence of keys leading up to KEYS. |
| 2049 | For example, [?\C-x ?l] is converted into the string \"C-x l\". |
| 2050 | |
| 2051 | For an approximate inverse of this, see `kbd'. */) |
| 2052 | (Lisp_Object keys, Lisp_Object prefix) |
| 2053 | { |
| 2054 | ptrdiff_t len = 0; |
| 2055 | EMACS_INT i; |
| 2056 | ptrdiff_t i_byte; |
| 2057 | Lisp_Object *args; |
| 2058 | EMACS_INT size = XINT (Flength (keys)); |
| 2059 | Lisp_Object list; |
| 2060 | Lisp_Object sep = build_string (" "); |
| 2061 | Lisp_Object key; |
| 2062 | Lisp_Object result; |
| 2063 | bool add_meta = 0; |
| 2064 | USE_SAFE_ALLOCA; |
| 2065 | |
| 2066 | if (!NILP (prefix)) |
| 2067 | size += XINT (Flength (prefix)); |
| 2068 | |
| 2069 | /* This has one extra element at the end that we don't pass to Fconcat. */ |
| 2070 | if (min (PTRDIFF_MAX, SIZE_MAX) / word_size / 4 < size) |
| 2071 | memory_full (SIZE_MAX); |
| 2072 | SAFE_ALLOCA_LISP (args, size * 4); |
| 2073 | |
| 2074 | /* In effect, this computes |
| 2075 | (mapconcat 'single-key-description keys " ") |
| 2076 | but we shouldn't use mapconcat because it can do GC. */ |
| 2077 | |
| 2078 | next_list: |
| 2079 | if (!NILP (prefix)) |
| 2080 | list = prefix, prefix = Qnil; |
| 2081 | else if (!NILP (keys)) |
| 2082 | list = keys, keys = Qnil; |
| 2083 | else |
| 2084 | { |
| 2085 | if (add_meta) |
| 2086 | { |
| 2087 | args[len] = Fsingle_key_description (meta_prefix_char, Qnil); |
| 2088 | result = Fconcat (len + 1, args); |
| 2089 | } |
| 2090 | else if (len == 0) |
| 2091 | result = empty_unibyte_string; |
| 2092 | else |
| 2093 | result = Fconcat (len - 1, args); |
| 2094 | SAFE_FREE (); |
| 2095 | return result; |
| 2096 | } |
| 2097 | |
| 2098 | if (STRINGP (list)) |
| 2099 | size = SCHARS (list); |
| 2100 | else if (VECTORP (list)) |
| 2101 | size = ASIZE (list); |
| 2102 | else if (CONSP (list)) |
| 2103 | size = XINT (Flength (list)); |
| 2104 | else |
| 2105 | wrong_type_argument (Qarrayp, list); |
| 2106 | |
| 2107 | i = i_byte = 0; |
| 2108 | |
| 2109 | while (i < size) |
| 2110 | { |
| 2111 | if (STRINGP (list)) |
| 2112 | { |
| 2113 | int c; |
| 2114 | FETCH_STRING_CHAR_ADVANCE (c, list, i, i_byte); |
| 2115 | if (SINGLE_BYTE_CHAR_P (c) && (c & 0200)) |
| 2116 | c ^= 0200 | meta_modifier; |
| 2117 | XSETFASTINT (key, c); |
| 2118 | } |
| 2119 | else if (VECTORP (list)) |
| 2120 | { |
| 2121 | key = AREF (list, i); i++; |
| 2122 | } |
| 2123 | else |
| 2124 | { |
| 2125 | key = XCAR (list); |
| 2126 | list = XCDR (list); |
| 2127 | i++; |
| 2128 | } |
| 2129 | |
| 2130 | if (add_meta) |
| 2131 | { |
| 2132 | if (!INTEGERP (key) |
| 2133 | || EQ (key, meta_prefix_char) |
| 2134 | || (XINT (key) & meta_modifier)) |
| 2135 | { |
| 2136 | args[len++] = Fsingle_key_description (meta_prefix_char, Qnil); |
| 2137 | args[len++] = sep; |
| 2138 | if (EQ (key, meta_prefix_char)) |
| 2139 | continue; |
| 2140 | } |
| 2141 | else |
| 2142 | XSETINT (key, XINT (key) | meta_modifier); |
| 2143 | add_meta = 0; |
| 2144 | } |
| 2145 | else if (EQ (key, meta_prefix_char)) |
| 2146 | { |
| 2147 | add_meta = 1; |
| 2148 | continue; |
| 2149 | } |
| 2150 | args[len++] = Fsingle_key_description (key, Qnil); |
| 2151 | args[len++] = sep; |
| 2152 | } |
| 2153 | goto next_list; |
| 2154 | } |
| 2155 | |
| 2156 | |
| 2157 | char * |
| 2158 | push_key_description (EMACS_INT ch, char *p) |
| 2159 | { |
| 2160 | int c, c2; |
| 2161 | bool tab_as_ci; |
| 2162 | |
| 2163 | /* Clear all the meaningless bits above the meta bit. */ |
| 2164 | c = ch & (meta_modifier | ~ - meta_modifier); |
| 2165 | c2 = c & ~(alt_modifier | ctrl_modifier | hyper_modifier |
| 2166 | | meta_modifier | shift_modifier | super_modifier); |
| 2167 | |
| 2168 | if (! CHARACTERP (make_number (c2))) |
| 2169 | { |
| 2170 | /* KEY_DESCRIPTION_SIZE is large enough for this. */ |
| 2171 | p += sprintf (p, "[%d]", c); |
| 2172 | return p; |
| 2173 | } |
| 2174 | |
| 2175 | tab_as_ci = (c2 == '\t' && (c & meta_modifier)); |
| 2176 | |
| 2177 | if (c & alt_modifier) |
| 2178 | { |
| 2179 | *p++ = 'A'; |
| 2180 | *p++ = '-'; |
| 2181 | c -= alt_modifier; |
| 2182 | } |
| 2183 | if ((c & ctrl_modifier) != 0 |
| 2184 | || (c2 < ' ' && c2 != 27 && c2 != '\t' && c2 != Ctl ('M')) |
| 2185 | || tab_as_ci) |
| 2186 | { |
| 2187 | *p++ = 'C'; |
| 2188 | *p++ = '-'; |
| 2189 | c &= ~ctrl_modifier; |
| 2190 | } |
| 2191 | if (c & hyper_modifier) |
| 2192 | { |
| 2193 | *p++ = 'H'; |
| 2194 | *p++ = '-'; |
| 2195 | c -= hyper_modifier; |
| 2196 | } |
| 2197 | if (c & meta_modifier) |
| 2198 | { |
| 2199 | *p++ = 'M'; |
| 2200 | *p++ = '-'; |
| 2201 | c -= meta_modifier; |
| 2202 | } |
| 2203 | if (c & shift_modifier) |
| 2204 | { |
| 2205 | *p++ = 'S'; |
| 2206 | *p++ = '-'; |
| 2207 | c -= shift_modifier; |
| 2208 | } |
| 2209 | if (c & super_modifier) |
| 2210 | { |
| 2211 | *p++ = 's'; |
| 2212 | *p++ = '-'; |
| 2213 | c -= super_modifier; |
| 2214 | } |
| 2215 | if (c < 040) |
| 2216 | { |
| 2217 | if (c == 033) |
| 2218 | { |
| 2219 | *p++ = 'E'; |
| 2220 | *p++ = 'S'; |
| 2221 | *p++ = 'C'; |
| 2222 | } |
| 2223 | else if (tab_as_ci) |
| 2224 | { |
| 2225 | *p++ = 'i'; |
| 2226 | } |
| 2227 | else if (c == '\t') |
| 2228 | { |
| 2229 | *p++ = 'T'; |
| 2230 | *p++ = 'A'; |
| 2231 | *p++ = 'B'; |
| 2232 | } |
| 2233 | else if (c == Ctl ('M')) |
| 2234 | { |
| 2235 | *p++ = 'R'; |
| 2236 | *p++ = 'E'; |
| 2237 | *p++ = 'T'; |
| 2238 | } |
| 2239 | else |
| 2240 | { |
| 2241 | /* `C-' already added above. */ |
| 2242 | if (c > 0 && c <= Ctl ('Z')) |
| 2243 | *p++ = c + 0140; |
| 2244 | else |
| 2245 | *p++ = c + 0100; |
| 2246 | } |
| 2247 | } |
| 2248 | else if (c == 0177) |
| 2249 | { |
| 2250 | *p++ = 'D'; |
| 2251 | *p++ = 'E'; |
| 2252 | *p++ = 'L'; |
| 2253 | } |
| 2254 | else if (c == ' ') |
| 2255 | { |
| 2256 | *p++ = 'S'; |
| 2257 | *p++ = 'P'; |
| 2258 | *p++ = 'C'; |
| 2259 | } |
| 2260 | else if (c < 128) |
| 2261 | *p++ = c; |
| 2262 | else |
| 2263 | { |
| 2264 | /* Now we are sure that C is a valid character code. */ |
| 2265 | p += CHAR_STRING (c, (unsigned char *) p); |
| 2266 | } |
| 2267 | |
| 2268 | return p; |
| 2269 | } |
| 2270 | |
| 2271 | /* This function cannot GC. */ |
| 2272 | |
| 2273 | DEFUN ("single-key-description", Fsingle_key_description, |
| 2274 | Ssingle_key_description, 1, 2, 0, |
| 2275 | doc: /* Return a pretty description of command character KEY. |
| 2276 | Control characters turn into C-whatever, etc. |
| 2277 | Optional argument NO-ANGLES non-nil means don't put angle brackets |
| 2278 | around function keys and event symbols. */) |
| 2279 | (Lisp_Object key, Lisp_Object no_angles) |
| 2280 | { |
| 2281 | if (CONSP (key) && lucid_event_type_list_p (key)) |
| 2282 | key = Fevent_convert_list (key); |
| 2283 | |
| 2284 | if (CONSP (key) && INTEGERP (XCAR (key)) && INTEGERP (XCDR (key))) |
| 2285 | /* An interval from a map-char-table. */ |
| 2286 | return concat3 (Fsingle_key_description (XCAR (key), no_angles), |
| 2287 | build_string (".."), |
| 2288 | Fsingle_key_description (XCDR (key), no_angles)); |
| 2289 | |
| 2290 | key = EVENT_HEAD (key); |
| 2291 | |
| 2292 | if (INTEGERP (key)) /* Normal character. */ |
| 2293 | { |
| 2294 | char tem[KEY_DESCRIPTION_SIZE]; |
| 2295 | char *p = push_key_description (XINT (key), tem); |
| 2296 | *p = 0; |
| 2297 | return make_specified_string (tem, -1, p - tem, 1); |
| 2298 | } |
| 2299 | else if (SYMBOLP (key)) /* Function key or event-symbol. */ |
| 2300 | { |
| 2301 | if (NILP (no_angles)) |
| 2302 | { |
| 2303 | Lisp_Object result; |
| 2304 | USE_SAFE_ALLOCA; |
| 2305 | char *buffer = SAFE_ALLOCA (sizeof "<>" |
| 2306 | + SBYTES (SYMBOL_NAME (key))); |
| 2307 | esprintf (buffer, "<%s>", SDATA (SYMBOL_NAME (key))); |
| 2308 | result = build_string (buffer); |
| 2309 | SAFE_FREE (); |
| 2310 | return result; |
| 2311 | } |
| 2312 | else |
| 2313 | return Fsymbol_name (key); |
| 2314 | } |
| 2315 | else if (STRINGP (key)) /* Buffer names in the menubar. */ |
| 2316 | return Fcopy_sequence (key); |
| 2317 | else |
| 2318 | error ("KEY must be an integer, cons, symbol, or string"); |
| 2319 | } |
| 2320 | |
| 2321 | static char * |
| 2322 | push_text_char_description (register unsigned int c, register char *p) |
| 2323 | { |
| 2324 | if (c >= 0200) |
| 2325 | { |
| 2326 | *p++ = 'M'; |
| 2327 | *p++ = '-'; |
| 2328 | c -= 0200; |
| 2329 | } |
| 2330 | if (c < 040) |
| 2331 | { |
| 2332 | *p++ = '^'; |
| 2333 | *p++ = c + 64; /* 'A' - 1 */ |
| 2334 | } |
| 2335 | else if (c == 0177) |
| 2336 | { |
| 2337 | *p++ = '^'; |
| 2338 | *p++ = '?'; |
| 2339 | } |
| 2340 | else |
| 2341 | *p++ = c; |
| 2342 | return p; |
| 2343 | } |
| 2344 | |
| 2345 | /* This function cannot GC. */ |
| 2346 | |
| 2347 | DEFUN ("text-char-description", Ftext_char_description, Stext_char_description, 1, 1, 0, |
| 2348 | doc: /* Return a pretty description of file-character CHARACTER. |
| 2349 | Control characters turn into "^char", etc. This differs from |
| 2350 | `single-key-description' which turns them into "C-char". |
| 2351 | Also, this function recognizes the 2**7 bit as the Meta character, |
| 2352 | whereas `single-key-description' uses the 2**27 bit for Meta. |
| 2353 | See Info node `(elisp)Describing Characters' for examples. */) |
| 2354 | (Lisp_Object character) |
| 2355 | { |
| 2356 | /* Currently MAX_MULTIBYTE_LENGTH is 4 (< 6). */ |
| 2357 | char str[6]; |
| 2358 | int c; |
| 2359 | |
| 2360 | CHECK_CHARACTER (character); |
| 2361 | |
| 2362 | c = XINT (character); |
| 2363 | if (!ASCII_CHAR_P (c)) |
| 2364 | { |
| 2365 | int len = CHAR_STRING (c, (unsigned char *) str); |
| 2366 | |
| 2367 | return make_multibyte_string (str, 1, len); |
| 2368 | } |
| 2369 | |
| 2370 | *push_text_char_description (c & 0377, str) = 0; |
| 2371 | |
| 2372 | return build_string (str); |
| 2373 | } |
| 2374 | |
| 2375 | static int where_is_preferred_modifier; |
| 2376 | |
| 2377 | /* Return 0 if SEQ uses non-preferred modifiers or non-char events. |
| 2378 | Else, return 2 if SEQ uses the where_is_preferred_modifier, |
| 2379 | and 1 otherwise. */ |
| 2380 | static int |
| 2381 | preferred_sequence_p (Lisp_Object seq) |
| 2382 | { |
| 2383 | EMACS_INT i; |
| 2384 | EMACS_INT len = XFASTINT (Flength (seq)); |
| 2385 | int result = 1; |
| 2386 | |
| 2387 | for (i = 0; i < len; i++) |
| 2388 | { |
| 2389 | Lisp_Object ii, elt; |
| 2390 | |
| 2391 | XSETFASTINT (ii, i); |
| 2392 | elt = Faref (seq, ii); |
| 2393 | |
| 2394 | if (!INTEGERP (elt)) |
| 2395 | return 0; |
| 2396 | else |
| 2397 | { |
| 2398 | int modifiers = XINT (elt) & (CHAR_MODIFIER_MASK & ~CHAR_META); |
| 2399 | if (modifiers == where_is_preferred_modifier) |
| 2400 | result = 2; |
| 2401 | else if (modifiers) |
| 2402 | return 0; |
| 2403 | } |
| 2404 | } |
| 2405 | |
| 2406 | return result; |
| 2407 | } |
| 2408 | |
| 2409 | \f |
| 2410 | /* where-is - finding a command in a set of keymaps. */ |
| 2411 | |
| 2412 | static void where_is_internal_1 (Lisp_Object key, Lisp_Object binding, |
| 2413 | Lisp_Object args, void *data); |
| 2414 | |
| 2415 | /* Like Flookup_key, but uses a list of keymaps SHADOW instead of a single map. |
| 2416 | Returns the first non-nil binding found in any of those maps. |
| 2417 | If REMAP is true, pass the result of the lookup through command |
| 2418 | remapping before returning it. */ |
| 2419 | |
| 2420 | static Lisp_Object |
| 2421 | shadow_lookup (Lisp_Object shadow, Lisp_Object key, Lisp_Object flag, |
| 2422 | bool remap) |
| 2423 | { |
| 2424 | Lisp_Object tail, value; |
| 2425 | |
| 2426 | for (tail = shadow; CONSP (tail); tail = XCDR (tail)) |
| 2427 | { |
| 2428 | value = Flookup_key (XCAR (tail), key, flag); |
| 2429 | if (NATNUMP (value)) |
| 2430 | { |
| 2431 | value = Flookup_key (XCAR (tail), |
| 2432 | Fsubstring (key, make_number (0), value), flag); |
| 2433 | if (!NILP (value)) |
| 2434 | return Qnil; |
| 2435 | } |
| 2436 | else if (!NILP (value)) |
| 2437 | { |
| 2438 | Lisp_Object remapping; |
| 2439 | if (remap && SYMBOLP (value) |
| 2440 | && (remapping = Fcommand_remapping (value, Qnil, shadow), |
| 2441 | !NILP (remapping))) |
| 2442 | return remapping; |
| 2443 | else |
| 2444 | return value; |
| 2445 | } |
| 2446 | } |
| 2447 | return Qnil; |
| 2448 | } |
| 2449 | |
| 2450 | static Lisp_Object Vmouse_events; |
| 2451 | |
| 2452 | struct where_is_internal_data { |
| 2453 | Lisp_Object definition, this, last; |
| 2454 | bool last_is_meta, noindirect; |
| 2455 | Lisp_Object sequences; |
| 2456 | }; |
| 2457 | |
| 2458 | /* This function can't GC, AFAIK. */ |
| 2459 | /* Return the list of bindings found. This list is ordered "longest |
| 2460 | to shortest". It may include bindings that are actually shadowed |
| 2461 | by others, as well as duplicate bindings and remapping bindings. |
| 2462 | The list returned is potentially shared with where_is_cache, so |
| 2463 | be careful not to modify it via side-effects. */ |
| 2464 | |
| 2465 | static Lisp_Object |
| 2466 | where_is_internal (Lisp_Object definition, Lisp_Object keymaps, |
| 2467 | bool noindirect, bool nomenus) |
| 2468 | { |
| 2469 | Lisp_Object maps = Qnil; |
| 2470 | Lisp_Object found; |
| 2471 | struct where_is_internal_data data; |
| 2472 | |
| 2473 | /* Only important use of caching is for the menubar |
| 2474 | (i.e. where-is-internal called with (def nil t nil nil)). */ |
| 2475 | if (nomenus && !noindirect) |
| 2476 | { |
| 2477 | /* Check heuristic-consistency of the cache. */ |
| 2478 | if (NILP (Fequal (keymaps, where_is_cache_keymaps))) |
| 2479 | where_is_cache = Qnil; |
| 2480 | |
| 2481 | if (NILP (where_is_cache)) |
| 2482 | { |
| 2483 | /* We need to create the cache. */ |
| 2484 | Lisp_Object args[2]; |
| 2485 | where_is_cache = Fmake_hash_table (0, args); |
| 2486 | where_is_cache_keymaps = Qt; |
| 2487 | } |
| 2488 | else |
| 2489 | /* We can reuse the cache. */ |
| 2490 | return Fgethash (definition, where_is_cache, Qnil); |
| 2491 | } |
| 2492 | else |
| 2493 | /* Kill the cache so that where_is_internal_1 doesn't think |
| 2494 | we're filling it up. */ |
| 2495 | where_is_cache = Qnil; |
| 2496 | |
| 2497 | found = keymaps; |
| 2498 | while (CONSP (found)) |
| 2499 | { |
| 2500 | maps = |
| 2501 | nconc2 (maps, |
| 2502 | Faccessible_keymaps (get_keymap (XCAR (found), 1, 0), Qnil)); |
| 2503 | found = XCDR (found); |
| 2504 | } |
| 2505 | |
| 2506 | data.sequences = Qnil; |
| 2507 | for (; CONSP (maps); maps = XCDR (maps)) |
| 2508 | { |
| 2509 | /* Key sequence to reach map, and the map that it reaches */ |
| 2510 | register Lisp_Object this, map, tem; |
| 2511 | |
| 2512 | /* In order to fold [META-PREFIX-CHAR CHAR] sequences into |
| 2513 | [M-CHAR] sequences, check if last character of the sequence |
| 2514 | is the meta-prefix char. */ |
| 2515 | Lisp_Object last; |
| 2516 | bool last_is_meta; |
| 2517 | |
| 2518 | this = Fcar (XCAR (maps)); |
| 2519 | map = Fcdr (XCAR (maps)); |
| 2520 | last = make_number (XINT (Flength (this)) - 1); |
| 2521 | last_is_meta = (XINT (last) >= 0 |
| 2522 | && EQ (Faref (this, last), meta_prefix_char)); |
| 2523 | |
| 2524 | /* if (nomenus && !preferred_sequence_p (this)) */ |
| 2525 | if (nomenus && XINT (last) >= 0 |
| 2526 | && SYMBOLP (tem = Faref (this, make_number (0))) |
| 2527 | && !NILP (Fmemq (XCAR (parse_modifiers (tem)), Vmouse_events))) |
| 2528 | /* If no menu entries should be returned, skip over the |
| 2529 | keymaps bound to `menu-bar' and `tool-bar' and other |
| 2530 | non-ascii prefixes like `C-down-mouse-2'. */ |
| 2531 | continue; |
| 2532 | |
| 2533 | QUIT; |
| 2534 | |
| 2535 | data.definition = definition; |
| 2536 | data.noindirect = noindirect; |
| 2537 | data.this = this; |
| 2538 | data.last = last; |
| 2539 | data.last_is_meta = last_is_meta; |
| 2540 | |
| 2541 | if (CONSP (map)) |
| 2542 | map_keymap (map, where_is_internal_1, Qnil, &data, 0); |
| 2543 | } |
| 2544 | |
| 2545 | if (nomenus && !noindirect) |
| 2546 | { /* Remember for which keymaps this cache was built. |
| 2547 | We do it here (late) because we want to keep where_is_cache_keymaps |
| 2548 | set to t while the cache isn't fully filled. */ |
| 2549 | where_is_cache_keymaps = keymaps; |
| 2550 | /* During cache-filling, data.sequences is not filled by |
| 2551 | where_is_internal_1. */ |
| 2552 | return Fgethash (definition, where_is_cache, Qnil); |
| 2553 | } |
| 2554 | else |
| 2555 | return data.sequences; |
| 2556 | } |
| 2557 | |
| 2558 | /* This function can GC if Flookup_key autoloads any keymaps. */ |
| 2559 | |
| 2560 | DEFUN ("where-is-internal", Fwhere_is_internal, Swhere_is_internal, 1, 5, 0, |
| 2561 | doc: /* Return list of keys that invoke DEFINITION. |
| 2562 | If KEYMAP is a keymap, search only KEYMAP and the global keymap. |
| 2563 | If KEYMAP is nil, search all the currently active keymaps, except |
| 2564 | for `overriding-local-map' (which is ignored). |
| 2565 | If KEYMAP is a list of keymaps, search only those keymaps. |
| 2566 | |
| 2567 | If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found, |
| 2568 | rather than a list of all possible key sequences. |
| 2569 | If FIRSTONLY is the symbol `non-ascii', return the first binding found, |
| 2570 | no matter what it is. |
| 2571 | If FIRSTONLY has another non-nil value, prefer bindings |
| 2572 | that use the modifier key specified in `where-is-preferred-modifier' |
| 2573 | \(or their meta variants) and entirely reject menu bindings. |
| 2574 | |
| 2575 | If optional 4th arg NOINDIRECT is non-nil, don't follow indirections |
| 2576 | to other keymaps or slots. This makes it possible to search for an |
| 2577 | indirect definition itself. |
| 2578 | |
| 2579 | The optional 5th arg NO-REMAP alters how command remapping is handled: |
| 2580 | |
| 2581 | - If another command OTHER-COMMAND is remapped to DEFINITION, normally |
| 2582 | search for the bindings of OTHER-COMMAND and include them in the |
| 2583 | returned list. But if NO-REMAP is non-nil, include the vector |
| 2584 | [remap OTHER-COMMAND] in the returned list instead, without |
| 2585 | searching for those other bindings. |
| 2586 | |
| 2587 | - If DEFINITION is remapped to OTHER-COMMAND, normally return the |
| 2588 | bindings for OTHER-COMMAND. But if NO-REMAP is non-nil, return the |
| 2589 | bindings for DEFINITION instead, ignoring its remapping. */) |
| 2590 | (Lisp_Object definition, Lisp_Object keymap, Lisp_Object firstonly, Lisp_Object noindirect, Lisp_Object no_remap) |
| 2591 | { |
| 2592 | /* The keymaps in which to search. */ |
| 2593 | Lisp_Object keymaps; |
| 2594 | /* Potentially relevant bindings in "shortest to longest" order. */ |
| 2595 | Lisp_Object sequences = Qnil; |
| 2596 | /* Actually relevant bindings. */ |
| 2597 | Lisp_Object found = Qnil; |
| 2598 | /* 1 means ignore all menu bindings entirely. */ |
| 2599 | bool nomenus = !NILP (firstonly) && !EQ (firstonly, Qnon_ascii); |
| 2600 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6; |
| 2601 | /* List of sequences found via remapping. Keep them in a separate |
| 2602 | variable, so as to push them later, since we prefer |
| 2603 | non-remapped binding. */ |
| 2604 | Lisp_Object remapped_sequences = Qnil; |
| 2605 | /* Whether or not we're handling remapped sequences. This is needed |
| 2606 | because remapping is not done recursively by Fcommand_remapping: you |
| 2607 | can't remap a remapped command. */ |
| 2608 | bool remapped = 0; |
| 2609 | Lisp_Object tem = Qnil; |
| 2610 | |
| 2611 | /* Refresh the C version of the modifier preference. */ |
| 2612 | where_is_preferred_modifier |
| 2613 | = parse_solitary_modifier (Vwhere_is_preferred_modifier); |
| 2614 | |
| 2615 | /* Find the relevant keymaps. */ |
| 2616 | if (CONSP (keymap) && KEYMAPP (XCAR (keymap))) |
| 2617 | keymaps = keymap; |
| 2618 | else if (!NILP (keymap)) |
| 2619 | keymaps = list2 (keymap, current_global_map); |
| 2620 | else |
| 2621 | keymaps = Fcurrent_active_maps (Qnil, Qnil); |
| 2622 | |
| 2623 | GCPRO6 (definition, keymaps, found, sequences, remapped_sequences, tem); |
| 2624 | |
| 2625 | tem = Fcommand_remapping (definition, Qnil, keymaps); |
| 2626 | /* If `definition' is remapped to tem', then OT1H no key will run |
| 2627 | that command (since they will run `tem' instead), so we should |
| 2628 | return nil; but OTOH all keys bound to `definition' (or to `tem') |
| 2629 | will run the same command. |
| 2630 | So for menu-shortcut purposes, we want to find all the keys bound (maybe |
| 2631 | via remapping) to `tem'. But for the purpose of finding the keys that |
| 2632 | run `definition', then we'd want to just return nil. |
| 2633 | We choose to make it work right for menu-shortcuts, since it's the most |
| 2634 | common use. |
| 2635 | Known bugs: if you remap switch-to-buffer to toto, C-h f switch-to-buffer |
| 2636 | will tell you that switch-to-buffer is bound to C-x b even though C-x b |
| 2637 | will run toto instead. And if `toto' is itself remapped to forward-char, |
| 2638 | then C-h f toto will tell you that it's bound to C-f even though C-f does |
| 2639 | not run toto and it won't tell you that C-x b does run toto. */ |
| 2640 | if (NILP (no_remap) && !NILP (tem)) |
| 2641 | definition = tem; |
| 2642 | |
| 2643 | if (SYMBOLP (definition) |
| 2644 | && !NILP (firstonly) |
| 2645 | && !NILP (tem = Fget (definition, QCadvertised_binding))) |
| 2646 | { |
| 2647 | /* We have a list of advertised bindings. */ |
| 2648 | while (CONSP (tem)) |
| 2649 | if (EQ (shadow_lookup (keymaps, XCAR (tem), Qnil, 0), definition)) |
| 2650 | RETURN_UNGCPRO (XCAR (tem)); |
| 2651 | else |
| 2652 | tem = XCDR (tem); |
| 2653 | if (EQ (shadow_lookup (keymaps, tem, Qnil, 0), definition)) |
| 2654 | RETURN_UNGCPRO (tem); |
| 2655 | } |
| 2656 | |
| 2657 | sequences = Freverse (where_is_internal (definition, keymaps, |
| 2658 | !NILP (noindirect), nomenus)); |
| 2659 | |
| 2660 | while (CONSP (sequences) |
| 2661 | /* If we're at the end of the `sequences' list and we haven't |
| 2662 | considered remapped sequences yet, copy them over and |
| 2663 | process them. */ |
| 2664 | || (!remapped && (sequences = remapped_sequences, |
| 2665 | remapped = 1, |
| 2666 | CONSP (sequences)))) |
| 2667 | { |
| 2668 | Lisp_Object sequence, function; |
| 2669 | |
| 2670 | sequence = XCAR (sequences); |
| 2671 | sequences = XCDR (sequences); |
| 2672 | |
| 2673 | /* Verify that this key binding is not shadowed by another |
| 2674 | binding for the same key, before we say it exists. |
| 2675 | |
| 2676 | Mechanism: look for local definition of this key and if |
| 2677 | it is defined and does not match what we found then |
| 2678 | ignore this key. |
| 2679 | |
| 2680 | Either nil or number as value from Flookup_key |
| 2681 | means undefined. */ |
| 2682 | if (NILP (Fequal (shadow_lookup (keymaps, sequence, Qnil, remapped), |
| 2683 | definition))) |
| 2684 | continue; |
| 2685 | |
| 2686 | /* If the current sequence is a command remapping with |
| 2687 | format [remap COMMAND], find the key sequences |
| 2688 | which run COMMAND, and use those sequences instead. */ |
| 2689 | if (NILP (no_remap) && !remapped |
| 2690 | && VECTORP (sequence) && ASIZE (sequence) == 2 |
| 2691 | && EQ (AREF (sequence, 0), Qremap) |
| 2692 | && (function = AREF (sequence, 1), SYMBOLP (function))) |
| 2693 | { |
| 2694 | Lisp_Object seqs = where_is_internal (function, keymaps, |
| 2695 | !NILP (noindirect), nomenus); |
| 2696 | remapped_sequences = nconc2 (Freverse (seqs), remapped_sequences); |
| 2697 | continue; |
| 2698 | } |
| 2699 | |
| 2700 | /* Don't annoy user with strings from a menu such as the |
| 2701 | entries from the "Edit => Paste from Kill Menu". |
| 2702 | Change them all to "(any string)", so that there |
| 2703 | seems to be only one menu item to report. */ |
| 2704 | if (! NILP (sequence)) |
| 2705 | { |
| 2706 | Lisp_Object tem1; |
| 2707 | tem1 = Faref (sequence, make_number (ASIZE (sequence) - 1)); |
| 2708 | if (STRINGP (tem1)) |
| 2709 | Faset (sequence, make_number (ASIZE (sequence) - 1), |
| 2710 | build_string ("(any string)")); |
| 2711 | } |
| 2712 | |
| 2713 | /* It is a true unshadowed match. Record it, unless it's already |
| 2714 | been seen (as could happen when inheriting keymaps). */ |
| 2715 | if (NILP (Fmember (sequence, found))) |
| 2716 | found = Fcons (sequence, found); |
| 2717 | |
| 2718 | /* If firstonly is Qnon_ascii, then we can return the first |
| 2719 | binding we find. If firstonly is not Qnon_ascii but not |
| 2720 | nil, then we should return the first ascii-only binding |
| 2721 | we find. */ |
| 2722 | if (EQ (firstonly, Qnon_ascii)) |
| 2723 | RETURN_UNGCPRO (sequence); |
| 2724 | else if (!NILP (firstonly) |
| 2725 | && 2 == preferred_sequence_p (sequence)) |
| 2726 | RETURN_UNGCPRO (sequence); |
| 2727 | } |
| 2728 | |
| 2729 | UNGCPRO; |
| 2730 | |
| 2731 | found = Fnreverse (found); |
| 2732 | |
| 2733 | /* firstonly may have been t, but we may have gone all the way through |
| 2734 | the keymaps without finding an all-ASCII key sequence. So just |
| 2735 | return the best we could find. */ |
| 2736 | if (NILP (firstonly)) |
| 2737 | return found; |
| 2738 | else if (where_is_preferred_modifier == 0) |
| 2739 | return Fcar (found); |
| 2740 | else |
| 2741 | { /* Maybe we did not find a preferred_modifier binding, but we did find |
| 2742 | some ASCII binding. */ |
| 2743 | Lisp_Object bindings = found; |
| 2744 | while (CONSP (bindings)) |
| 2745 | if (preferred_sequence_p (XCAR (bindings))) |
| 2746 | return XCAR (bindings); |
| 2747 | else |
| 2748 | bindings = XCDR (bindings); |
| 2749 | return Fcar (found); |
| 2750 | } |
| 2751 | } |
| 2752 | |
| 2753 | /* This function can GC because get_keyelt can. */ |
| 2754 | |
| 2755 | static void |
| 2756 | where_is_internal_1 (Lisp_Object key, Lisp_Object binding, Lisp_Object args, void *data) |
| 2757 | { |
| 2758 | struct where_is_internal_data *d = data; /* Cast! */ |
| 2759 | Lisp_Object definition = d->definition; |
| 2760 | bool noindirect = d->noindirect; |
| 2761 | Lisp_Object this = d->this; |
| 2762 | Lisp_Object last = d->last; |
| 2763 | bool last_is_meta = d->last_is_meta; |
| 2764 | Lisp_Object sequence; |
| 2765 | |
| 2766 | /* Search through indirections unless that's not wanted. */ |
| 2767 | if (!noindirect) |
| 2768 | binding = get_keyelt (binding, 0); |
| 2769 | |
| 2770 | /* End this iteration if this element does not match |
| 2771 | the target. */ |
| 2772 | |
| 2773 | if (!(!NILP (where_is_cache) /* everything "matches" during cache-fill. */ |
| 2774 | || EQ (binding, definition) |
| 2775 | || (CONSP (definition) && !NILP (Fequal (binding, definition))))) |
| 2776 | /* Doesn't match. */ |
| 2777 | return; |
| 2778 | |
| 2779 | /* We have found a match. Construct the key sequence where we found it. */ |
| 2780 | if (INTEGERP (key) && last_is_meta) |
| 2781 | { |
| 2782 | sequence = Fcopy_sequence (this); |
| 2783 | Faset (sequence, last, make_number (XINT (key) | meta_modifier)); |
| 2784 | } |
| 2785 | else |
| 2786 | { |
| 2787 | if (CONSP (key)) |
| 2788 | key = Fcons (XCAR (key), XCDR (key)); |
| 2789 | sequence = append_key (this, key); |
| 2790 | } |
| 2791 | |
| 2792 | if (!NILP (where_is_cache)) |
| 2793 | { |
| 2794 | Lisp_Object sequences = Fgethash (binding, where_is_cache, Qnil); |
| 2795 | Fputhash (binding, Fcons (sequence, sequences), where_is_cache); |
| 2796 | } |
| 2797 | else |
| 2798 | d->sequences = Fcons (sequence, d->sequences); |
| 2799 | } |
| 2800 | \f |
| 2801 | /* describe-bindings - summarizing all the bindings in a set of keymaps. */ |
| 2802 | |
| 2803 | DEFUN ("describe-buffer-bindings", Fdescribe_buffer_bindings, Sdescribe_buffer_bindings, 1, 3, 0, |
| 2804 | doc: /* Insert the list of all defined keys and their definitions. |
| 2805 | The list is inserted in the current buffer, while the bindings are |
| 2806 | looked up in BUFFER. |
| 2807 | The optional argument PREFIX, if non-nil, should be a key sequence; |
| 2808 | then we display only bindings that start with that prefix. |
| 2809 | The optional argument MENUS, if non-nil, says to mention menu bindings. |
| 2810 | \(Ordinarily these are omitted from the output.) */) |
| 2811 | (Lisp_Object buffer, Lisp_Object prefix, Lisp_Object menus) |
| 2812 | { |
| 2813 | Lisp_Object outbuf, shadow; |
| 2814 | bool nomenu = NILP (menus); |
| 2815 | Lisp_Object start1; |
| 2816 | struct gcpro gcpro1; |
| 2817 | |
| 2818 | const char *alternate_heading |
| 2819 | = "\ |
| 2820 | Keyboard translations:\n\n\ |
| 2821 | You type Translation\n\ |
| 2822 | -------- -----------\n"; |
| 2823 | |
| 2824 | CHECK_BUFFER (buffer); |
| 2825 | |
| 2826 | shadow = Qnil; |
| 2827 | GCPRO1 (shadow); |
| 2828 | |
| 2829 | outbuf = Fcurrent_buffer (); |
| 2830 | |
| 2831 | /* Report on alternates for keys. */ |
| 2832 | if (STRINGP (KVAR (current_kboard, Vkeyboard_translate_table)) && !NILP (prefix)) |
| 2833 | { |
| 2834 | int c; |
| 2835 | const unsigned char *translate = SDATA (KVAR (current_kboard, Vkeyboard_translate_table)); |
| 2836 | int translate_len = SCHARS (KVAR (current_kboard, Vkeyboard_translate_table)); |
| 2837 | |
| 2838 | for (c = 0; c < translate_len; c++) |
| 2839 | if (translate[c] != c) |
| 2840 | { |
| 2841 | char buf[KEY_DESCRIPTION_SIZE]; |
| 2842 | char *bufend; |
| 2843 | |
| 2844 | if (alternate_heading) |
| 2845 | { |
| 2846 | insert_string (alternate_heading); |
| 2847 | alternate_heading = 0; |
| 2848 | } |
| 2849 | |
| 2850 | bufend = push_key_description (translate[c], buf); |
| 2851 | insert (buf, bufend - buf); |
| 2852 | Findent_to (make_number (16), make_number (1)); |
| 2853 | bufend = push_key_description (c, buf); |
| 2854 | insert (buf, bufend - buf); |
| 2855 | |
| 2856 | insert ("\n", 1); |
| 2857 | |
| 2858 | /* Insert calls signal_after_change which may GC. */ |
| 2859 | translate = SDATA (KVAR (current_kboard, Vkeyboard_translate_table)); |
| 2860 | } |
| 2861 | |
| 2862 | insert ("\n", 1); |
| 2863 | } |
| 2864 | |
| 2865 | if (!NILP (Vkey_translation_map)) |
| 2866 | describe_map_tree (Vkey_translation_map, 0, Qnil, prefix, |
| 2867 | "Key translations", nomenu, 1, 0, 0); |
| 2868 | |
| 2869 | |
| 2870 | /* Print the (major mode) local map. */ |
| 2871 | start1 = Qnil; |
| 2872 | if (!NILP (KVAR (current_kboard, Voverriding_terminal_local_map))) |
| 2873 | start1 = KVAR (current_kboard, Voverriding_terminal_local_map); |
| 2874 | |
| 2875 | if (!NILP (start1)) |
| 2876 | { |
| 2877 | describe_map_tree (start1, 1, shadow, prefix, |
| 2878 | "\f\nOverriding Bindings", nomenu, 0, 0, 0); |
| 2879 | shadow = Fcons (start1, shadow); |
| 2880 | start1 = Qnil; |
| 2881 | } |
| 2882 | else if (!NILP (Voverriding_local_map)) |
| 2883 | start1 = Voverriding_local_map; |
| 2884 | |
| 2885 | if (!NILP (start1)) |
| 2886 | { |
| 2887 | describe_map_tree (start1, 1, shadow, prefix, |
| 2888 | "\f\nOverriding Bindings", nomenu, 0, 0, 0); |
| 2889 | shadow = Fcons (start1, shadow); |
| 2890 | } |
| 2891 | else |
| 2892 | { |
| 2893 | /* Print the minor mode and major mode keymaps. */ |
| 2894 | int i, nmaps; |
| 2895 | Lisp_Object *modes, *maps; |
| 2896 | |
| 2897 | /* Temporarily switch to `buffer', so that we can get that buffer's |
| 2898 | minor modes correctly. */ |
| 2899 | Fset_buffer (buffer); |
| 2900 | |
| 2901 | nmaps = current_minor_maps (&modes, &maps); |
| 2902 | Fset_buffer (outbuf); |
| 2903 | |
| 2904 | start1 = get_local_map (BUF_PT (XBUFFER (buffer)), |
| 2905 | XBUFFER (buffer), Qkeymap); |
| 2906 | if (!NILP (start1)) |
| 2907 | { |
| 2908 | describe_map_tree (start1, 1, shadow, prefix, |
| 2909 | "\f\n`keymap' Property Bindings", nomenu, |
| 2910 | 0, 0, 0); |
| 2911 | shadow = Fcons (start1, shadow); |
| 2912 | } |
| 2913 | |
| 2914 | /* Print the minor mode maps. */ |
| 2915 | for (i = 0; i < nmaps; i++) |
| 2916 | { |
| 2917 | /* The title for a minor mode keymap |
| 2918 | is constructed at run time. |
| 2919 | We let describe_map_tree do the actual insertion |
| 2920 | because it takes care of other features when doing so. */ |
| 2921 | char *title, *p; |
| 2922 | |
| 2923 | if (!SYMBOLP (modes[i])) |
| 2924 | emacs_abort (); |
| 2925 | |
| 2926 | p = title = alloca (42 + SCHARS (SYMBOL_NAME (modes[i]))); |
| 2927 | *p++ = '\f'; |
| 2928 | *p++ = '\n'; |
| 2929 | *p++ = '`'; |
| 2930 | memcpy (p, SDATA (SYMBOL_NAME (modes[i])), |
| 2931 | SCHARS (SYMBOL_NAME (modes[i]))); |
| 2932 | p += SCHARS (SYMBOL_NAME (modes[i])); |
| 2933 | *p++ = '\''; |
| 2934 | memcpy (p, " Minor Mode Bindings", strlen (" Minor Mode Bindings")); |
| 2935 | p += strlen (" Minor Mode Bindings"); |
| 2936 | *p = 0; |
| 2937 | |
| 2938 | describe_map_tree (maps[i], 1, shadow, prefix, |
| 2939 | title, nomenu, 0, 0, 0); |
| 2940 | shadow = Fcons (maps[i], shadow); |
| 2941 | } |
| 2942 | |
| 2943 | start1 = get_local_map (BUF_PT (XBUFFER (buffer)), |
| 2944 | XBUFFER (buffer), Qlocal_map); |
| 2945 | if (!NILP (start1)) |
| 2946 | { |
| 2947 | if (EQ (start1, BVAR (XBUFFER (buffer), keymap))) |
| 2948 | describe_map_tree (start1, 1, shadow, prefix, |
| 2949 | "\f\nMajor Mode Bindings", nomenu, 0, 0, 0); |
| 2950 | else |
| 2951 | describe_map_tree (start1, 1, shadow, prefix, |
| 2952 | "\f\n`local-map' Property Bindings", |
| 2953 | nomenu, 0, 0, 0); |
| 2954 | |
| 2955 | shadow = Fcons (start1, shadow); |
| 2956 | } |
| 2957 | } |
| 2958 | |
| 2959 | describe_map_tree (current_global_map, 1, shadow, prefix, |
| 2960 | "\f\nGlobal Bindings", nomenu, 0, 1, 0); |
| 2961 | |
| 2962 | /* Print the function-key-map translations under this prefix. */ |
| 2963 | if (!NILP (KVAR (current_kboard, Vlocal_function_key_map))) |
| 2964 | describe_map_tree (KVAR (current_kboard, Vlocal_function_key_map), 0, Qnil, prefix, |
| 2965 | "\f\nFunction key map translations", nomenu, 1, 0, 0); |
| 2966 | |
| 2967 | /* Print the input-decode-map translations under this prefix. */ |
| 2968 | if (!NILP (KVAR (current_kboard, Vinput_decode_map))) |
| 2969 | describe_map_tree (KVAR (current_kboard, Vinput_decode_map), 0, Qnil, prefix, |
| 2970 | "\f\nInput decoding map translations", nomenu, 1, 0, 0); |
| 2971 | |
| 2972 | UNGCPRO; |
| 2973 | return Qnil; |
| 2974 | } |
| 2975 | |
| 2976 | /* Insert a description of the key bindings in STARTMAP, |
| 2977 | followed by those of all maps reachable through STARTMAP. |
| 2978 | If PARTIAL, omit certain "uninteresting" commands |
| 2979 | (such as `undefined'). |
| 2980 | If SHADOW is non-nil, it is a list of maps; |
| 2981 | don't mention keys which would be shadowed by any of them. |
| 2982 | PREFIX, if non-nil, says mention only keys that start with PREFIX. |
| 2983 | TITLE, if not 0, is a string to insert at the beginning. |
| 2984 | TITLE should not end with a colon or a newline; we supply that. |
| 2985 | If NOMENU, then omit menu-bar commands. |
| 2986 | |
| 2987 | If TRANSL, the definitions are actually key translations |
| 2988 | so print strings and vectors differently. |
| 2989 | |
| 2990 | If ALWAYS_TITLE, print the title even if there are no maps |
| 2991 | to look through. |
| 2992 | |
| 2993 | If MENTION_SHADOW, then when something is shadowed by SHADOW, |
| 2994 | don't omit it; instead, mention it but say it is shadowed. |
| 2995 | |
| 2996 | Any inserted text ends in two newlines (used by `help-make-xrefs'). */ |
| 2997 | |
| 2998 | void |
| 2999 | describe_map_tree (Lisp_Object startmap, bool partial, Lisp_Object shadow, |
| 3000 | Lisp_Object prefix, const char *title, bool nomenu, |
| 3001 | bool transl, bool always_title, bool mention_shadow) |
| 3002 | { |
| 3003 | Lisp_Object maps, orig_maps, seen, sub_shadows; |
| 3004 | struct gcpro gcpro1, gcpro2, gcpro3; |
| 3005 | bool something = 0; |
| 3006 | const char *key_heading |
| 3007 | = "\ |
| 3008 | key binding\n\ |
| 3009 | --- -------\n"; |
| 3010 | |
| 3011 | orig_maps = maps = Faccessible_keymaps (startmap, prefix); |
| 3012 | seen = Qnil; |
| 3013 | sub_shadows = Qnil; |
| 3014 | GCPRO3 (maps, seen, sub_shadows); |
| 3015 | |
| 3016 | if (nomenu) |
| 3017 | { |
| 3018 | Lisp_Object list; |
| 3019 | |
| 3020 | /* Delete from MAPS each element that is for the menu bar. */ |
| 3021 | for (list = maps; CONSP (list); list = XCDR (list)) |
| 3022 | { |
| 3023 | Lisp_Object elt, elt_prefix, tem; |
| 3024 | |
| 3025 | elt = XCAR (list); |
| 3026 | elt_prefix = Fcar (elt); |
| 3027 | if (ASIZE (elt_prefix) >= 1) |
| 3028 | { |
| 3029 | tem = Faref (elt_prefix, make_number (0)); |
| 3030 | if (EQ (tem, Qmenu_bar)) |
| 3031 | maps = Fdelq (elt, maps); |
| 3032 | } |
| 3033 | } |
| 3034 | } |
| 3035 | |
| 3036 | if (!NILP (maps) || always_title) |
| 3037 | { |
| 3038 | if (title) |
| 3039 | { |
| 3040 | insert_string (title); |
| 3041 | if (!NILP (prefix)) |
| 3042 | { |
| 3043 | insert_string (" Starting With "); |
| 3044 | insert1 (Fkey_description (prefix, Qnil)); |
| 3045 | } |
| 3046 | insert_string (":\n"); |
| 3047 | } |
| 3048 | insert_string (key_heading); |
| 3049 | something = 1; |
| 3050 | } |
| 3051 | |
| 3052 | for (; CONSP (maps); maps = XCDR (maps)) |
| 3053 | { |
| 3054 | register Lisp_Object elt, elt_prefix, tail; |
| 3055 | |
| 3056 | elt = XCAR (maps); |
| 3057 | elt_prefix = Fcar (elt); |
| 3058 | |
| 3059 | sub_shadows = Qnil; |
| 3060 | |
| 3061 | for (tail = shadow; CONSP (tail); tail = XCDR (tail)) |
| 3062 | { |
| 3063 | Lisp_Object shmap; |
| 3064 | |
| 3065 | shmap = XCAR (tail); |
| 3066 | |
| 3067 | /* If the sequence by which we reach this keymap is zero-length, |
| 3068 | then the shadow map for this keymap is just SHADOW. */ |
| 3069 | if ((STRINGP (elt_prefix) && SCHARS (elt_prefix) == 0) |
| 3070 | || (VECTORP (elt_prefix) && ASIZE (elt_prefix) == 0)) |
| 3071 | ; |
| 3072 | /* If the sequence by which we reach this keymap actually has |
| 3073 | some elements, then the sequence's definition in SHADOW is |
| 3074 | what we should use. */ |
| 3075 | else |
| 3076 | { |
| 3077 | shmap = Flookup_key (shmap, Fcar (elt), Qt); |
| 3078 | if (INTEGERP (shmap)) |
| 3079 | shmap = Qnil; |
| 3080 | } |
| 3081 | |
| 3082 | /* If shmap is not nil and not a keymap, |
| 3083 | it completely shadows this map, so don't |
| 3084 | describe this map at all. */ |
| 3085 | if (!NILP (shmap) && !KEYMAPP (shmap)) |
| 3086 | goto skip; |
| 3087 | |
| 3088 | if (!NILP (shmap)) |
| 3089 | sub_shadows = Fcons (shmap, sub_shadows); |
| 3090 | } |
| 3091 | |
| 3092 | /* Maps we have already listed in this loop shadow this map. */ |
| 3093 | for (tail = orig_maps; !EQ (tail, maps); tail = XCDR (tail)) |
| 3094 | { |
| 3095 | Lisp_Object tem; |
| 3096 | tem = Fequal (Fcar (XCAR (tail)), elt_prefix); |
| 3097 | if (!NILP (tem)) |
| 3098 | sub_shadows = Fcons (XCDR (XCAR (tail)), sub_shadows); |
| 3099 | } |
| 3100 | |
| 3101 | describe_map (Fcdr (elt), elt_prefix, |
| 3102 | transl ? describe_translation : describe_command, |
| 3103 | partial, sub_shadows, &seen, nomenu, mention_shadow); |
| 3104 | |
| 3105 | skip: ; |
| 3106 | } |
| 3107 | |
| 3108 | if (something) |
| 3109 | insert_string ("\n"); |
| 3110 | |
| 3111 | UNGCPRO; |
| 3112 | } |
| 3113 | |
| 3114 | static int previous_description_column; |
| 3115 | |
| 3116 | static void |
| 3117 | describe_command (Lisp_Object definition, Lisp_Object args) |
| 3118 | { |
| 3119 | register Lisp_Object tem1; |
| 3120 | ptrdiff_t column = current_column (); |
| 3121 | int description_column; |
| 3122 | |
| 3123 | /* If column 16 is no good, go to col 32; |
| 3124 | but don't push beyond that--go to next line instead. */ |
| 3125 | if (column > 30) |
| 3126 | { |
| 3127 | insert_char ('\n'); |
| 3128 | description_column = 32; |
| 3129 | } |
| 3130 | else if (column > 14 || (column > 10 && previous_description_column == 32)) |
| 3131 | description_column = 32; |
| 3132 | else |
| 3133 | description_column = 16; |
| 3134 | |
| 3135 | Findent_to (make_number (description_column), make_number (1)); |
| 3136 | previous_description_column = description_column; |
| 3137 | |
| 3138 | if (SYMBOLP (definition)) |
| 3139 | { |
| 3140 | tem1 = SYMBOL_NAME (definition); |
| 3141 | insert1 (tem1); |
| 3142 | insert_string ("\n"); |
| 3143 | } |
| 3144 | else if (STRINGP (definition) || VECTORP (definition)) |
| 3145 | insert_string ("Keyboard Macro\n"); |
| 3146 | else if (KEYMAPP (definition)) |
| 3147 | insert_string ("Prefix Command\n"); |
| 3148 | else |
| 3149 | insert_string ("??\n"); |
| 3150 | } |
| 3151 | |
| 3152 | static void |
| 3153 | describe_translation (Lisp_Object definition, Lisp_Object args) |
| 3154 | { |
| 3155 | register Lisp_Object tem1; |
| 3156 | |
| 3157 | Findent_to (make_number (16), make_number (1)); |
| 3158 | |
| 3159 | if (SYMBOLP (definition)) |
| 3160 | { |
| 3161 | tem1 = SYMBOL_NAME (definition); |
| 3162 | insert1 (tem1); |
| 3163 | insert_string ("\n"); |
| 3164 | } |
| 3165 | else if (STRINGP (definition) || VECTORP (definition)) |
| 3166 | { |
| 3167 | insert1 (Fkey_description (definition, Qnil)); |
| 3168 | insert_string ("\n"); |
| 3169 | } |
| 3170 | else if (KEYMAPP (definition)) |
| 3171 | insert_string ("Prefix Command\n"); |
| 3172 | else |
| 3173 | insert_string ("??\n"); |
| 3174 | } |
| 3175 | |
| 3176 | /* describe_map puts all the usable elements of a sparse keymap |
| 3177 | into an array of `struct describe_map_elt', |
| 3178 | then sorts them by the events. */ |
| 3179 | |
| 3180 | struct describe_map_elt |
| 3181 | { |
| 3182 | Lisp_Object event; |
| 3183 | Lisp_Object definition; |
| 3184 | bool shadowed; |
| 3185 | }; |
| 3186 | |
| 3187 | /* qsort comparison function for sorting `struct describe_map_elt' by |
| 3188 | the event field. */ |
| 3189 | |
| 3190 | static int |
| 3191 | describe_map_compare (const void *aa, const void *bb) |
| 3192 | { |
| 3193 | const struct describe_map_elt *a = aa, *b = bb; |
| 3194 | if (INTEGERP (a->event) && INTEGERP (b->event)) |
| 3195 | return ((XINT (a->event) > XINT (b->event)) |
| 3196 | - (XINT (a->event) < XINT (b->event))); |
| 3197 | if (!INTEGERP (a->event) && INTEGERP (b->event)) |
| 3198 | return 1; |
| 3199 | if (INTEGERP (a->event) && !INTEGERP (b->event)) |
| 3200 | return -1; |
| 3201 | if (SYMBOLP (a->event) && SYMBOLP (b->event)) |
| 3202 | return (!NILP (Fstring_lessp (a->event, b->event)) ? -1 |
| 3203 | : !NILP (Fstring_lessp (b->event, a->event)) ? 1 |
| 3204 | : 0); |
| 3205 | return 0; |
| 3206 | } |
| 3207 | |
| 3208 | /* Describe the contents of map MAP, assuming that this map itself is |
| 3209 | reached by the sequence of prefix keys PREFIX (a string or vector). |
| 3210 | PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */ |
| 3211 | |
| 3212 | static void |
| 3213 | describe_map (Lisp_Object map, Lisp_Object prefix, |
| 3214 | void (*elt_describer) (Lisp_Object, Lisp_Object), |
| 3215 | bool partial, Lisp_Object shadow, |
| 3216 | Lisp_Object *seen, bool nomenu, bool mention_shadow) |
| 3217 | { |
| 3218 | Lisp_Object tail, definition, event; |
| 3219 | Lisp_Object tem; |
| 3220 | Lisp_Object suppress; |
| 3221 | Lisp_Object kludge; |
| 3222 | bool first = 1; |
| 3223 | struct gcpro gcpro1, gcpro2, gcpro3; |
| 3224 | |
| 3225 | /* These accumulate the values from sparse keymap bindings, |
| 3226 | so we can sort them and handle them in order. */ |
| 3227 | int length_needed = 0; |
| 3228 | struct describe_map_elt *vect; |
| 3229 | int slots_used = 0; |
| 3230 | int i; |
| 3231 | |
| 3232 | suppress = Qnil; |
| 3233 | |
| 3234 | if (partial) |
| 3235 | suppress = intern ("suppress-keymap"); |
| 3236 | |
| 3237 | /* This vector gets used to present single keys to Flookup_key. Since |
| 3238 | that is done once per keymap element, we don't want to cons up a |
| 3239 | fresh vector every time. */ |
| 3240 | kludge = Fmake_vector (make_number (1), Qnil); |
| 3241 | definition = Qnil; |
| 3242 | |
| 3243 | GCPRO3 (prefix, definition, kludge); |
| 3244 | |
| 3245 | map = call1 (Qkeymap_canonicalize, map); |
| 3246 | |
| 3247 | for (tail = map; CONSP (tail); tail = XCDR (tail)) |
| 3248 | length_needed++; |
| 3249 | |
| 3250 | vect = alloca (length_needed * sizeof *vect); |
| 3251 | |
| 3252 | for (tail = map; CONSP (tail); tail = XCDR (tail)) |
| 3253 | { |
| 3254 | QUIT; |
| 3255 | |
| 3256 | if (VECTORP (XCAR (tail)) |
| 3257 | || CHAR_TABLE_P (XCAR (tail))) |
| 3258 | describe_vector (XCAR (tail), |
| 3259 | prefix, Qnil, elt_describer, partial, shadow, map, |
| 3260 | 1, mention_shadow); |
| 3261 | else if (CONSP (XCAR (tail))) |
| 3262 | { |
| 3263 | bool this_shadowed = 0; |
| 3264 | |
| 3265 | event = XCAR (XCAR (tail)); |
| 3266 | |
| 3267 | /* Ignore bindings whose "prefix" are not really valid events. |
| 3268 | (We get these in the frames and buffers menu.) */ |
| 3269 | if (!(SYMBOLP (event) || INTEGERP (event))) |
| 3270 | continue; |
| 3271 | |
| 3272 | if (nomenu && EQ (event, Qmenu_bar)) |
| 3273 | continue; |
| 3274 | |
| 3275 | definition = get_keyelt (XCDR (XCAR (tail)), 0); |
| 3276 | |
| 3277 | /* Don't show undefined commands or suppressed commands. */ |
| 3278 | if (NILP (definition)) continue; |
| 3279 | if (SYMBOLP (definition) && partial) |
| 3280 | { |
| 3281 | tem = Fget (definition, suppress); |
| 3282 | if (!NILP (tem)) |
| 3283 | continue; |
| 3284 | } |
| 3285 | |
| 3286 | /* Don't show a command that isn't really visible |
| 3287 | because a local definition of the same key shadows it. */ |
| 3288 | |
| 3289 | ASET (kludge, 0, event); |
| 3290 | if (!NILP (shadow)) |
| 3291 | { |
| 3292 | tem = shadow_lookup (shadow, kludge, Qt, 0); |
| 3293 | if (!NILP (tem)) |
| 3294 | { |
| 3295 | /* If both bindings are keymaps, this key is a prefix key, |
| 3296 | so don't say it is shadowed. */ |
| 3297 | if (KEYMAPP (definition) && KEYMAPP (tem)) |
| 3298 | ; |
| 3299 | /* Avoid generating duplicate entries if the |
| 3300 | shadowed binding has the same definition. */ |
| 3301 | else if (mention_shadow && !EQ (tem, definition)) |
| 3302 | this_shadowed = 1; |
| 3303 | else |
| 3304 | continue; |
| 3305 | } |
| 3306 | } |
| 3307 | |
| 3308 | tem = Flookup_key (map, kludge, Qt); |
| 3309 | if (!EQ (tem, definition)) continue; |
| 3310 | |
| 3311 | vect[slots_used].event = event; |
| 3312 | vect[slots_used].definition = definition; |
| 3313 | vect[slots_used].shadowed = this_shadowed; |
| 3314 | slots_used++; |
| 3315 | } |
| 3316 | else if (EQ (XCAR (tail), Qkeymap)) |
| 3317 | { |
| 3318 | /* The same keymap might be in the structure twice, if we're |
| 3319 | using an inherited keymap. So skip anything we've already |
| 3320 | encountered. */ |
| 3321 | tem = Fassq (tail, *seen); |
| 3322 | if (CONSP (tem) && !NILP (Fequal (XCAR (tem), prefix))) |
| 3323 | break; |
| 3324 | *seen = Fcons (Fcons (tail, prefix), *seen); |
| 3325 | } |
| 3326 | } |
| 3327 | |
| 3328 | /* If we found some sparse map events, sort them. */ |
| 3329 | |
| 3330 | qsort (vect, slots_used, sizeof (struct describe_map_elt), |
| 3331 | describe_map_compare); |
| 3332 | |
| 3333 | /* Now output them in sorted order. */ |
| 3334 | |
| 3335 | for (i = 0; i < slots_used; i++) |
| 3336 | { |
| 3337 | Lisp_Object start, end; |
| 3338 | |
| 3339 | if (first) |
| 3340 | { |
| 3341 | previous_description_column = 0; |
| 3342 | insert ("\n", 1); |
| 3343 | first = 0; |
| 3344 | } |
| 3345 | |
| 3346 | ASET (kludge, 0, vect[i].event); |
| 3347 | start = vect[i].event; |
| 3348 | end = start; |
| 3349 | |
| 3350 | definition = vect[i].definition; |
| 3351 | |
| 3352 | /* Find consecutive chars that are identically defined. */ |
| 3353 | if (INTEGERP (vect[i].event)) |
| 3354 | { |
| 3355 | while (i + 1 < slots_used |
| 3356 | && EQ (vect[i+1].event, make_number (XINT (vect[i].event) + 1)) |
| 3357 | && !NILP (Fequal (vect[i + 1].definition, definition)) |
| 3358 | && vect[i].shadowed == vect[i + 1].shadowed) |
| 3359 | i++; |
| 3360 | end = vect[i].event; |
| 3361 | } |
| 3362 | |
| 3363 | /* Now START .. END is the range to describe next. */ |
| 3364 | |
| 3365 | /* Insert the string to describe the event START. */ |
| 3366 | insert1 (Fkey_description (kludge, prefix)); |
| 3367 | |
| 3368 | if (!EQ (start, end)) |
| 3369 | { |
| 3370 | insert (" .. ", 4); |
| 3371 | |
| 3372 | ASET (kludge, 0, end); |
| 3373 | /* Insert the string to describe the character END. */ |
| 3374 | insert1 (Fkey_description (kludge, prefix)); |
| 3375 | } |
| 3376 | |
| 3377 | /* Print a description of the definition of this character. |
| 3378 | elt_describer will take care of spacing out far enough |
| 3379 | for alignment purposes. */ |
| 3380 | (*elt_describer) (vect[i].definition, Qnil); |
| 3381 | |
| 3382 | if (vect[i].shadowed) |
| 3383 | { |
| 3384 | ptrdiff_t pt = max (PT - 1, BEG); |
| 3385 | |
| 3386 | SET_PT (pt); |
| 3387 | insert_string ("\n (that binding is currently shadowed by another mode)"); |
| 3388 | pt = min (PT + 1, Z); |
| 3389 | SET_PT (pt); |
| 3390 | } |
| 3391 | } |
| 3392 | |
| 3393 | UNGCPRO; |
| 3394 | } |
| 3395 | |
| 3396 | static void |
| 3397 | describe_vector_princ (Lisp_Object elt, Lisp_Object fun) |
| 3398 | { |
| 3399 | Findent_to (make_number (16), make_number (1)); |
| 3400 | call1 (fun, elt); |
| 3401 | Fterpri (Qnil); |
| 3402 | } |
| 3403 | |
| 3404 | DEFUN ("describe-vector", Fdescribe_vector, Sdescribe_vector, 1, 2, 0, |
| 3405 | doc: /* Insert a description of contents of VECTOR. |
| 3406 | This is text showing the elements of vector matched against indices. |
| 3407 | DESCRIBER is the output function used; nil means use `princ'. */) |
| 3408 | (Lisp_Object vector, Lisp_Object describer) |
| 3409 | { |
| 3410 | ptrdiff_t count = SPECPDL_INDEX (); |
| 3411 | if (NILP (describer)) |
| 3412 | describer = intern ("princ"); |
| 3413 | specbind (Qstandard_output, Fcurrent_buffer ()); |
| 3414 | CHECK_VECTOR_OR_CHAR_TABLE (vector); |
| 3415 | describe_vector (vector, Qnil, describer, describe_vector_princ, 0, |
| 3416 | Qnil, Qnil, 0, 0); |
| 3417 | |
| 3418 | return unbind_to (count, Qnil); |
| 3419 | } |
| 3420 | |
| 3421 | /* Insert in the current buffer a description of the contents of VECTOR. |
| 3422 | We call ELT_DESCRIBER to insert the description of one value found |
| 3423 | in VECTOR. |
| 3424 | |
| 3425 | ELT_PREFIX describes what "comes before" the keys or indices defined |
| 3426 | by this vector. This is a human-readable string whose size |
| 3427 | is not necessarily related to the situation. |
| 3428 | |
| 3429 | If the vector is in a keymap, ELT_PREFIX is a prefix key which |
| 3430 | leads to this keymap. |
| 3431 | |
| 3432 | If the vector is a chartable, ELT_PREFIX is the vector |
| 3433 | of bytes that lead to the character set or portion of a character |
| 3434 | set described by this chartable. |
| 3435 | |
| 3436 | If PARTIAL, it means do not mention suppressed commands |
| 3437 | (that assumes the vector is in a keymap). |
| 3438 | |
| 3439 | SHADOW is a list of keymaps that shadow this map. |
| 3440 | If it is non-nil, then we look up the key in those maps |
| 3441 | and we don't mention it now if it is defined by any of them. |
| 3442 | |
| 3443 | ENTIRE_MAP is the keymap in which this vector appears. |
| 3444 | If the definition in effect in the whole map does not match |
| 3445 | the one in this vector, we ignore this one. |
| 3446 | |
| 3447 | ARGS is simply passed as the second argument to ELT_DESCRIBER. |
| 3448 | |
| 3449 | KEYMAP_P is 1 if vector is known to be a keymap, so map ESC to M-. |
| 3450 | |
| 3451 | ARGS is simply passed as the second argument to ELT_DESCRIBER. */ |
| 3452 | |
| 3453 | static void |
| 3454 | describe_vector (Lisp_Object vector, Lisp_Object prefix, Lisp_Object args, |
| 3455 | void (*elt_describer) (Lisp_Object, Lisp_Object), |
| 3456 | bool partial, Lisp_Object shadow, Lisp_Object entire_map, |
| 3457 | bool keymap_p, bool mention_shadow) |
| 3458 | { |
| 3459 | Lisp_Object definition; |
| 3460 | Lisp_Object tem2; |
| 3461 | Lisp_Object elt_prefix = Qnil; |
| 3462 | int i; |
| 3463 | Lisp_Object suppress; |
| 3464 | Lisp_Object kludge; |
| 3465 | bool first = 1; |
| 3466 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; |
| 3467 | /* Range of elements to be handled. */ |
| 3468 | int from, to, stop; |
| 3469 | Lisp_Object character; |
| 3470 | int starting_i; |
| 3471 | |
| 3472 | suppress = Qnil; |
| 3473 | |
| 3474 | definition = Qnil; |
| 3475 | |
| 3476 | if (!keymap_p) |
| 3477 | { |
| 3478 | /* Call Fkey_description first, to avoid GC bug for the other string. */ |
| 3479 | if (!NILP (prefix) && XFASTINT (Flength (prefix)) > 0) |
| 3480 | { |
| 3481 | Lisp_Object tem; |
| 3482 | tem = Fkey_description (prefix, Qnil); |
| 3483 | elt_prefix = concat2 (tem, build_string (" ")); |
| 3484 | } |
| 3485 | prefix = Qnil; |
| 3486 | } |
| 3487 | |
| 3488 | /* This vector gets used to present single keys to Flookup_key. Since |
| 3489 | that is done once per vector element, we don't want to cons up a |
| 3490 | fresh vector every time. */ |
| 3491 | kludge = Fmake_vector (make_number (1), Qnil); |
| 3492 | GCPRO4 (elt_prefix, prefix, definition, kludge); |
| 3493 | |
| 3494 | if (partial) |
| 3495 | suppress = intern ("suppress-keymap"); |
| 3496 | |
| 3497 | from = 0; |
| 3498 | if (CHAR_TABLE_P (vector)) |
| 3499 | stop = MAX_5_BYTE_CHAR + 1, to = MAX_CHAR + 1; |
| 3500 | else |
| 3501 | stop = to = ASIZE (vector); |
| 3502 | |
| 3503 | for (i = from; ; i++) |
| 3504 | { |
| 3505 | bool this_shadowed = 0; |
| 3506 | int range_beg, range_end; |
| 3507 | Lisp_Object val; |
| 3508 | |
| 3509 | QUIT; |
| 3510 | |
| 3511 | if (i == stop) |
| 3512 | { |
| 3513 | if (i == to) |
| 3514 | break; |
| 3515 | stop = to; |
| 3516 | } |
| 3517 | |
| 3518 | starting_i = i; |
| 3519 | |
| 3520 | if (CHAR_TABLE_P (vector)) |
| 3521 | { |
| 3522 | range_beg = i; |
| 3523 | i = stop - 1; |
| 3524 | val = char_table_ref_and_range (vector, range_beg, &range_beg, &i); |
| 3525 | } |
| 3526 | else |
| 3527 | val = AREF (vector, i); |
| 3528 | definition = get_keyelt (val, 0); |
| 3529 | |
| 3530 | if (NILP (definition)) continue; |
| 3531 | |
| 3532 | /* Don't mention suppressed commands. */ |
| 3533 | if (SYMBOLP (definition) && partial) |
| 3534 | { |
| 3535 | Lisp_Object tem; |
| 3536 | |
| 3537 | tem = Fget (definition, suppress); |
| 3538 | |
| 3539 | if (!NILP (tem)) continue; |
| 3540 | } |
| 3541 | |
| 3542 | character = make_number (starting_i); |
| 3543 | ASET (kludge, 0, character); |
| 3544 | |
| 3545 | /* If this binding is shadowed by some other map, ignore it. */ |
| 3546 | if (!NILP (shadow)) |
| 3547 | { |
| 3548 | Lisp_Object tem; |
| 3549 | |
| 3550 | tem = shadow_lookup (shadow, kludge, Qt, 0); |
| 3551 | |
| 3552 | if (!NILP (tem)) |
| 3553 | { |
| 3554 | if (mention_shadow) |
| 3555 | this_shadowed = 1; |
| 3556 | else |
| 3557 | continue; |
| 3558 | } |
| 3559 | } |
| 3560 | |
| 3561 | /* Ignore this definition if it is shadowed by an earlier |
| 3562 | one in the same keymap. */ |
| 3563 | if (!NILP (entire_map)) |
| 3564 | { |
| 3565 | Lisp_Object tem; |
| 3566 | |
| 3567 | tem = Flookup_key (entire_map, kludge, Qt); |
| 3568 | |
| 3569 | if (!EQ (tem, definition)) |
| 3570 | continue; |
| 3571 | } |
| 3572 | |
| 3573 | if (first) |
| 3574 | { |
| 3575 | insert ("\n", 1); |
| 3576 | first = 0; |
| 3577 | } |
| 3578 | |
| 3579 | /* Output the prefix that applies to every entry in this map. */ |
| 3580 | if (!NILP (elt_prefix)) |
| 3581 | insert1 (elt_prefix); |
| 3582 | |
| 3583 | insert1 (Fkey_description (kludge, prefix)); |
| 3584 | |
| 3585 | /* Find all consecutive characters or rows that have the same |
| 3586 | definition. But, VECTOR is a char-table, we had better put a |
| 3587 | boundary between normal characters (-#x3FFF7F) and 8-bit |
| 3588 | characters (#x3FFF80-). */ |
| 3589 | if (CHAR_TABLE_P (vector)) |
| 3590 | { |
| 3591 | while (i + 1 < stop |
| 3592 | && (range_beg = i + 1, range_end = stop - 1, |
| 3593 | val = char_table_ref_and_range (vector, range_beg, |
| 3594 | &range_beg, &range_end), |
| 3595 | tem2 = get_keyelt (val, 0), |
| 3596 | !NILP (tem2)) |
| 3597 | && !NILP (Fequal (tem2, definition))) |
| 3598 | i = range_end; |
| 3599 | } |
| 3600 | else |
| 3601 | while (i + 1 < stop |
| 3602 | && (tem2 = get_keyelt (AREF (vector, i + 1), 0), |
| 3603 | !NILP (tem2)) |
| 3604 | && !NILP (Fequal (tem2, definition))) |
| 3605 | i++; |
| 3606 | |
| 3607 | /* If we have a range of more than one character, |
| 3608 | print where the range reaches to. */ |
| 3609 | |
| 3610 | if (i != starting_i) |
| 3611 | { |
| 3612 | insert (" .. ", 4); |
| 3613 | |
| 3614 | ASET (kludge, 0, make_number (i)); |
| 3615 | |
| 3616 | if (!NILP (elt_prefix)) |
| 3617 | insert1 (elt_prefix); |
| 3618 | |
| 3619 | insert1 (Fkey_description (kludge, prefix)); |
| 3620 | } |
| 3621 | |
| 3622 | /* Print a description of the definition of this character. |
| 3623 | elt_describer will take care of spacing out far enough |
| 3624 | for alignment purposes. */ |
| 3625 | (*elt_describer) (definition, args); |
| 3626 | |
| 3627 | if (this_shadowed) |
| 3628 | { |
| 3629 | SET_PT (PT - 1); |
| 3630 | insert_string (" (binding currently shadowed)"); |
| 3631 | SET_PT (PT + 1); |
| 3632 | } |
| 3633 | } |
| 3634 | |
| 3635 | if (CHAR_TABLE_P (vector) && ! NILP (XCHAR_TABLE (vector)->defalt)) |
| 3636 | { |
| 3637 | if (!NILP (elt_prefix)) |
| 3638 | insert1 (elt_prefix); |
| 3639 | insert ("default", 7); |
| 3640 | (*elt_describer) (XCHAR_TABLE (vector)->defalt, args); |
| 3641 | } |
| 3642 | |
| 3643 | UNGCPRO; |
| 3644 | } |
| 3645 | \f |
| 3646 | /* Apropos - finding all symbols whose names match a regexp. */ |
| 3647 | static Lisp_Object apropos_predicate; |
| 3648 | static Lisp_Object apropos_accumulate; |
| 3649 | |
| 3650 | static void |
| 3651 | apropos_accum (Lisp_Object symbol, Lisp_Object string) |
| 3652 | { |
| 3653 | register Lisp_Object tem; |
| 3654 | |
| 3655 | tem = Fstring_match (string, Fsymbol_name (symbol), Qnil); |
| 3656 | if (!NILP (tem) && !NILP (apropos_predicate)) |
| 3657 | tem = call1 (apropos_predicate, symbol); |
| 3658 | if (!NILP (tem)) |
| 3659 | apropos_accumulate = Fcons (symbol, apropos_accumulate); |
| 3660 | } |
| 3661 | |
| 3662 | DEFUN ("apropos-internal", Fapropos_internal, Sapropos_internal, 1, 2, 0, |
| 3663 | doc: /* Show all symbols whose names contain match for REGEXP. |
| 3664 | If optional 2nd arg PREDICATE is non-nil, (funcall PREDICATE SYMBOL) is done |
| 3665 | for each symbol and a symbol is mentioned only if that returns non-nil. |
| 3666 | Return list of symbols found. */) |
| 3667 | (Lisp_Object regexp, Lisp_Object predicate) |
| 3668 | { |
| 3669 | Lisp_Object tem; |
| 3670 | CHECK_STRING (regexp); |
| 3671 | apropos_predicate = predicate; |
| 3672 | apropos_accumulate = Qnil; |
| 3673 | map_obarray (Vobarray, apropos_accum, regexp); |
| 3674 | tem = Fsort (apropos_accumulate, Qstring_lessp); |
| 3675 | apropos_accumulate = Qnil; |
| 3676 | apropos_predicate = Qnil; |
| 3677 | return tem; |
| 3678 | } |
| 3679 | \f |
| 3680 | void |
| 3681 | syms_of_keymap (void) |
| 3682 | { |
| 3683 | DEFSYM (Qkeymap, "keymap"); |
| 3684 | staticpro (&apropos_predicate); |
| 3685 | staticpro (&apropos_accumulate); |
| 3686 | apropos_predicate = Qnil; |
| 3687 | apropos_accumulate = Qnil; |
| 3688 | |
| 3689 | DEFSYM (Qkeymap_canonicalize, "keymap-canonicalize"); |
| 3690 | |
| 3691 | /* Now we are ready to set up this property, so we can |
| 3692 | create char tables. */ |
| 3693 | Fput (Qkeymap, Qchar_table_extra_slots, make_number (0)); |
| 3694 | |
| 3695 | /* Initialize the keymaps standardly used. |
| 3696 | Each one is the value of a Lisp variable, and is also |
| 3697 | pointed to by a C variable */ |
| 3698 | |
| 3699 | global_map = Fmake_keymap (Qnil); |
| 3700 | Fset (intern_c_string ("global-map"), global_map); |
| 3701 | |
| 3702 | current_global_map = global_map; |
| 3703 | staticpro (&global_map); |
| 3704 | staticpro (¤t_global_map); |
| 3705 | |
| 3706 | meta_map = Fmake_keymap (Qnil); |
| 3707 | Fset (intern_c_string ("esc-map"), meta_map); |
| 3708 | Ffset (intern_c_string ("ESC-prefix"), meta_map); |
| 3709 | |
| 3710 | control_x_map = Fmake_keymap (Qnil); |
| 3711 | Fset (intern_c_string ("ctl-x-map"), control_x_map); |
| 3712 | Ffset (intern_c_string ("Control-X-prefix"), control_x_map); |
| 3713 | |
| 3714 | exclude_keys = listn (CONSTYPE_PURE, 5, |
| 3715 | pure_cons (build_pure_c_string ("DEL"), build_pure_c_string ("\\d")), |
| 3716 | pure_cons (build_pure_c_string ("TAB"), build_pure_c_string ("\\t")), |
| 3717 | pure_cons (build_pure_c_string ("RET"), build_pure_c_string ("\\r")), |
| 3718 | pure_cons (build_pure_c_string ("ESC"), build_pure_c_string ("\\e")), |
| 3719 | pure_cons (build_pure_c_string ("SPC"), build_pure_c_string (" "))); |
| 3720 | staticpro (&exclude_keys); |
| 3721 | |
| 3722 | DEFVAR_LISP ("define-key-rebound-commands", Vdefine_key_rebound_commands, |
| 3723 | doc: /* List of commands given new key bindings recently. |
| 3724 | This is used for internal purposes during Emacs startup; |
| 3725 | don't alter it yourself. */); |
| 3726 | Vdefine_key_rebound_commands = Qt; |
| 3727 | |
| 3728 | DEFVAR_LISP ("minibuffer-local-map", Vminibuffer_local_map, |
| 3729 | doc: /* Default keymap to use when reading from the minibuffer. */); |
| 3730 | Vminibuffer_local_map = Fmake_sparse_keymap (Qnil); |
| 3731 | |
| 3732 | DEFVAR_LISP ("minibuffer-local-ns-map", Vminibuffer_local_ns_map, |
| 3733 | doc: /* Local keymap for the minibuffer when spaces are not allowed. */); |
| 3734 | Vminibuffer_local_ns_map = Fmake_sparse_keymap (Qnil); |
| 3735 | Fset_keymap_parent (Vminibuffer_local_ns_map, Vminibuffer_local_map); |
| 3736 | |
| 3737 | |
| 3738 | DEFVAR_LISP ("minor-mode-map-alist", Vminor_mode_map_alist, |
| 3739 | doc: /* Alist of keymaps to use for minor modes. |
| 3740 | Each element looks like (VARIABLE . KEYMAP); KEYMAP is used to read |
| 3741 | key sequences and look up bindings if VARIABLE's value is non-nil. |
| 3742 | If two active keymaps bind the same key, the keymap appearing earlier |
| 3743 | in the list takes precedence. */); |
| 3744 | Vminor_mode_map_alist = Qnil; |
| 3745 | |
| 3746 | DEFVAR_LISP ("minor-mode-overriding-map-alist", Vminor_mode_overriding_map_alist, |
| 3747 | doc: /* Alist of keymaps to use for minor modes, in current major mode. |
| 3748 | This variable is an alist just like `minor-mode-map-alist', and it is |
| 3749 | used the same way (and before `minor-mode-map-alist'); however, |
| 3750 | it is provided for major modes to bind locally. */); |
| 3751 | Vminor_mode_overriding_map_alist = Qnil; |
| 3752 | |
| 3753 | DEFVAR_LISP ("emulation-mode-map-alists", Vemulation_mode_map_alists, |
| 3754 | doc: /* List of keymap alists to use for emulation modes. |
| 3755 | It is intended for modes or packages using multiple minor-mode keymaps. |
| 3756 | Each element is a keymap alist just like `minor-mode-map-alist', or a |
| 3757 | symbol with a variable binding which is a keymap alist, and it is used |
| 3758 | the same way. The "active" keymaps in each alist are used before |
| 3759 | `minor-mode-map-alist' and `minor-mode-overriding-map-alist'. */); |
| 3760 | Vemulation_mode_map_alists = Qnil; |
| 3761 | |
| 3762 | DEFVAR_LISP ("where-is-preferred-modifier", Vwhere_is_preferred_modifier, |
| 3763 | doc: /* Preferred modifier key to use for `where-is'. |
| 3764 | When a single binding is requested, `where-is' will return one that |
| 3765 | uses this modifier key if possible. If nil, or if no such binding |
| 3766 | exists, bindings using keys without modifiers (or only with meta) will |
| 3767 | be preferred. */); |
| 3768 | Vwhere_is_preferred_modifier = Qnil; |
| 3769 | where_is_preferred_modifier = 0; |
| 3770 | |
| 3771 | staticpro (&Vmouse_events); |
| 3772 | Vmouse_events = listn (CONSTYPE_PURE, 9, |
| 3773 | intern_c_string ("menu-bar"), |
| 3774 | intern_c_string ("tool-bar"), |
| 3775 | intern_c_string ("header-line"), |
| 3776 | intern_c_string ("mode-line"), |
| 3777 | intern_c_string ("mouse-1"), |
| 3778 | intern_c_string ("mouse-2"), |
| 3779 | intern_c_string ("mouse-3"), |
| 3780 | intern_c_string ("mouse-4"), |
| 3781 | intern_c_string ("mouse-5")); |
| 3782 | |
| 3783 | DEFSYM (Qsingle_key_description, "single-key-description"); |
| 3784 | DEFSYM (Qkey_description, "key-description"); |
| 3785 | DEFSYM (Qkeymapp, "keymapp"); |
| 3786 | DEFSYM (Qnon_ascii, "non-ascii"); |
| 3787 | DEFSYM (Qmenu_item, "menu-item"); |
| 3788 | DEFSYM (Qremap, "remap"); |
| 3789 | DEFSYM (QCadvertised_binding, ":advertised-binding"); |
| 3790 | |
| 3791 | command_remapping_vector = Fmake_vector (make_number (2), Qremap); |
| 3792 | staticpro (&command_remapping_vector); |
| 3793 | |
| 3794 | where_is_cache_keymaps = Qt; |
| 3795 | where_is_cache = Qnil; |
| 3796 | staticpro (&where_is_cache); |
| 3797 | staticpro (&where_is_cache_keymaps); |
| 3798 | |
| 3799 | defsubr (&Skeymapp); |
| 3800 | defsubr (&Skeymap_parent); |
| 3801 | defsubr (&Skeymap_prompt); |
| 3802 | defsubr (&Sset_keymap_parent); |
| 3803 | defsubr (&Smake_keymap); |
| 3804 | defsubr (&Smake_sparse_keymap); |
| 3805 | defsubr (&Smap_keymap_internal); |
| 3806 | defsubr (&Smap_keymap); |
| 3807 | defsubr (&Scopy_keymap); |
| 3808 | defsubr (&Scommand_remapping); |
| 3809 | defsubr (&Skey_binding); |
| 3810 | defsubr (&Slocal_key_binding); |
| 3811 | defsubr (&Sglobal_key_binding); |
| 3812 | defsubr (&Sminor_mode_key_binding); |
| 3813 | defsubr (&Sdefine_key); |
| 3814 | defsubr (&Slookup_key); |
| 3815 | defsubr (&Sdefine_prefix_command); |
| 3816 | defsubr (&Suse_global_map); |
| 3817 | defsubr (&Suse_local_map); |
| 3818 | defsubr (&Scurrent_local_map); |
| 3819 | defsubr (&Scurrent_global_map); |
| 3820 | defsubr (&Scurrent_minor_mode_maps); |
| 3821 | defsubr (&Scurrent_active_maps); |
| 3822 | defsubr (&Saccessible_keymaps); |
| 3823 | defsubr (&Skey_description); |
| 3824 | defsubr (&Sdescribe_vector); |
| 3825 | defsubr (&Ssingle_key_description); |
| 3826 | defsubr (&Stext_char_description); |
| 3827 | defsubr (&Swhere_is_internal); |
| 3828 | defsubr (&Sdescribe_buffer_bindings); |
| 3829 | defsubr (&Sapropos_internal); |
| 3830 | } |
| 3831 | |
| 3832 | void |
| 3833 | keys_of_keymap (void) |
| 3834 | { |
| 3835 | initial_define_key (global_map, 033, "ESC-prefix"); |
| 3836 | initial_define_key (global_map, Ctl ('X'), "Control-X-prefix"); |
| 3837 | } |