keymap.c 111 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
Paul Eggert's avatar
Paul Eggert committed
2
   Copyright (C) 1985-1988, 1993-1995, 1998-2018 Free Software
3
   Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
18
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
/* Old BUGS:
   - [M-C-a] != [?\M-\C-a]
   - [M-f2] != [?\e f2].
   - (define-key map [menu-bar foo] <bla>) does not always place <bla>
     at the head of the menu (if `foo' was already bound earlier and
     then unbound, for example).
   TODO:
   - allow many more Meta -> ESC mappings (like Hyper -> C-e for Emacspeak)
   - Think about the various defaulting that's currently hard-coded in
     keyboard.c (uppercase->lowercase, char->charset, button-events, ...)
     and make it more generic.  Maybe we should allow mappings of the
     form (PREDICATE . BINDING) as generalization of the default binding,
     tho probably a cleaner way to attack this is to allow functional
     keymaps (i.e. keymaps that are implemented as functions that implement
     a few different methods like `lookup', `map', ...).
   - Make [a] equivalent to [?a].
   BEWARE:
   - map-keymap should work meaningfully even if entries are added/removed
     to the keymap while iterating through it:
       start - removed <= visited <= start + added
 */
Jim Blandy's avatar
Jim Blandy committed
41

42
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
43
#include <stdio.h>
Paul Eggert's avatar
Paul Eggert committed
44
#include <stdlib.h>
45

Jim Blandy's avatar
Jim Blandy committed
46 47
#include "lisp.h"
#include "commands.h"
Kenichi Handa's avatar
Kenichi Handa committed
48
#include "character.h"
49
#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
50
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
51
#include "termhooks.h"
52
#include "blockinput.h"
53
#include "puresize.h"
Dave Love's avatar
Dave Love committed
54
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
55
#include "keymap.h"
56
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
57

58
/* Actually allocate storage for these variables.  */
Jim Blandy's avatar
Jim Blandy committed
59

60
Lisp_Object current_global_map;	/* Current global keymap.  */
Jim Blandy's avatar
Jim Blandy committed
61

62
Lisp_Object global_map;		/* Default global key bindings.  */
Jim Blandy's avatar
Jim Blandy committed
63 64

Lisp_Object meta_map;		/* The keymap used for globally bound
65
				   ESC-prefixed default commands.  */
Jim Blandy's avatar
Jim Blandy committed
66 67

Lisp_Object control_x_map;	/* The keymap used for globally bound
68
				   C-x-prefixed default commands.  */
Jim Blandy's avatar
Jim Blandy committed
69 70 71

				/* The keymap used by the minibuf for local
				   bindings when spaces are allowed in the
72
				   minibuf.  */
Jim Blandy's avatar
Jim Blandy committed
73 74 75

				/* The keymap used by the minibuf for local
				   bindings when spaces are not encouraged
76
				   in the minibuf.  */
Jim Blandy's avatar
Jim Blandy committed
77

78 79 80
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

81 82
/* Pre-allocated 2-element vector for Fcommand_remapping to use.  */
static Lisp_Object command_remapping_vector;
83

84 85 86 87 88
/* Hash table used to cache a reverse-map to speed up calls to where-is.  */
static Lisp_Object where_is_cache;
/* Which keymaps are reverse-stored in the cache.  */
static Lisp_Object where_is_cache_keymaps;

89 90 91 92 93 94 95
static Lisp_Object store_in_keymap (Lisp_Object, Lisp_Object, Lisp_Object);

static Lisp_Object define_as_prefix (Lisp_Object, Lisp_Object);
static void describe_command (Lisp_Object, Lisp_Object);
static void describe_translation (Lisp_Object, Lisp_Object);
static void describe_map (Lisp_Object, Lisp_Object,
                          void (*) (Lisp_Object, Lisp_Object),
96
			  bool, Lisp_Object, Lisp_Object *, bool, bool);
97
static void describe_vector (Lisp_Object, Lisp_Object, Lisp_Object,
98 99
                             void (*) (Lisp_Object, Lisp_Object), bool,
                             Lisp_Object, Lisp_Object, bool, bool);
100
static void silly_event_symbol_error (Lisp_Object);
101
static Lisp_Object get_keyelt (Lisp_Object, bool);
102 103 104 105 106 107

static void
CHECK_VECTOR_OR_CHAR_TABLE (Lisp_Object x)
{
  CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x);
}
Jim Blandy's avatar
Jim Blandy committed
108

Jim Blandy's avatar
Jim Blandy committed
109 110
/* Keymap object support - constructors and predicates.			*/

111
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
112
       doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
113 114 115 116 117
CHARTABLE is a char-table that holds the bindings for all characters
without modifiers.  All entries in it are initially nil, meaning
"command undefined".  ALIST is an assoc-list which holds bindings for
function keys, mouse events, and any other things that appear in the
input stream.  Initially, ALIST is nil.
118 119 120

The optional arg STRING supplies a menu name for the keymap
in case you use it as a menu with `x-popup-menu'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
121
  (Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
122
{
123 124
  Lisp_Object tail;
  if (!NILP (string))
125
    tail = list1 (string);
126 127
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
128
  return Fcons (Qkeymap,
129
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
130 131
}

Paul Eggert's avatar
Paul Eggert committed
132
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
133 134 135 136 137 138 139 140
       doc: /* Construct and return a new sparse keymap.
Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),
which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),
which binds the function key or mouse event SYMBOL to DEFINITION.
Initially the alist is nil.

The optional arg STRING supplies a menu name for the keymap
in case you use it as a menu with `x-popup-menu'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
141
  (Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
142
{
143
  if (!NILP (string))
144 145 146
    {
      if (!NILP (Vpurify_flag))
	string = Fpurecopy (string);
147
      return list2 (Qkeymap, string);
148
    }
149
  return list1 (Qkeymap);
Jim Blandy's avatar
Jim Blandy committed
150 151 152 153 154 155 156
}

/* This function is used for installing the standard key bindings
   at initialization time.

   For example:

157
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
158 159

void
160
initial_define_key (Lisp_Object keymap, int key, const char *defname)
Jim Blandy's avatar
Jim Blandy committed
161
{
162
  store_in_keymap (keymap, make_fixnum (key), intern_c_string (defname));
Jim Blandy's avatar
Jim Blandy committed
163 164
}

165
void
166
initial_define_lispy_key (Lisp_Object keymap, const char *keyname, const char *defname)
167
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
168
  store_in_keymap (keymap, intern_c_string (keyname), intern_c_string (defname));
169 170
}

Jim Blandy's avatar
Jim Blandy committed
171
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
172 173 174 175 176 177 178
       doc: /* Return t if OBJECT is a keymap.

A keymap is a list (keymap . ALIST),
or a symbol whose function definition is itself a keymap.
ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);
a vector of densely packed bindings for small character codes
is also allowed as an element.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
179
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
180
{
181
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
182 183
}

Paul Eggert's avatar
Paul Eggert committed
184
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
185 186 187
       doc: /* Return the prompt-string of a keymap MAP.
If non-nil, the prompt is shown in the echo-area
when reading a key-sequence to be looked-up in this keymap.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
188
  (Lisp_Object map)
189
{
190
  map = get_keymap (map, 0, 0);
191 192
  while (CONSP (map))
    {
193
      Lisp_Object tem = XCAR (map);
194 195
      if (STRINGP (tem))
	return tem;
196 197 198 199 200 201
      else if (KEYMAPP (tem))
	{
	  tem = Fkeymap_prompt (tem);
	  if (!NILP (tem))
	    return tem;
	}
202
      map = XCDR (map);
203 204 205 206
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
207
/* Check that OBJECT is a keymap (after dereferencing through any
208 209
   symbols).  If it is, return it.

210
   If AUTOLOAD and if OBJECT is a symbol whose function value
211
   is an autoload form, do the autoload and try again.
212
   If AUTOLOAD, callers must assume GC is possible.
213

214
   ERROR_IF_NOT_KEYMAP controls how we respond if OBJECT isn't a keymap.
215
   If ERROR_IF_NOT_KEYMAP, signal an error; otherwise,
216
   just return Qnil.
217 218 219 220 221

   Note that most of the time, we don't want to pursue autoloads.
   Functions like Faccessible_keymaps which scan entire keymap trees
   shouldn't load every autoloaded keymap.  I'm not sure about this,
   but it seems to me that only read_key_sequence, Flookup_key, and
222 223
   Fdefine_key should cause keymaps to be autoloaded.

224
   This function can GC when AUTOLOAD is true, because it calls
225
   Fautoload_do_load which can GC.  */
226

Jim Blandy's avatar
Jim Blandy committed
227
Lisp_Object
228
get_keymap (Lisp_Object object, bool error_if_not_keymap, bool autoload)
Jim Blandy's avatar
Jim Blandy committed
229
{
230
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
231

232
 autoload_retry:
233 234 235 236
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
237

238 239
  tem = indirect_function (object);
  if (CONSP (tem))
240
    {
241 242
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
243

244 245
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
246
      if ((autoload || !error_if_not_keymap) && EQ (XCAR (tem), Qautoload)
247
	  && SYMBOLP (object))
248
	{
249
	  Lisp_Object tail;
250

251
	  tail = Fnth (make_fixnum (4), tem);
252 253 254 255
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
256
		  Fautoload_do_load (tem, object, Qnil);
257 258 259
		  goto autoload_retry;
		}
	      else
260
	      	return object;
261
	    }
262
	}
263 264
    }

265
 end:
266
  if (error_if_not_keymap)
Jim Blandy's avatar
Jim Blandy committed
267
    wrong_type_argument (Qkeymapp, object);
268
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
269
}
270

271 272
/* Return the parent map of KEYMAP, or nil if it has none.
   We assume that KEYMAP is a valid keymap.  */
273

274
static Lisp_Object
275
keymap_parent (Lisp_Object keymap, bool autoload)
276 277 278
{
  Lisp_Object list;

279
  keymap = get_keymap (keymap, 1, autoload);
280 281

  /* Skip past the initial element `keymap'.  */
282 283
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
284 285
    {
      /* See if there is another `keymap'.  */
286
      if (KEYMAPP (list))
287 288 289
	return list;
    }

290
  return get_keymap (list, 0, autoload);
291 292
}

293
DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
294 295
       doc: /* Return the parent keymap of KEYMAP.
If KEYMAP has no parent, return nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
296
  (Lisp_Object keymap)
297 298 299
{
  return keymap_parent (keymap, 1);
}
300

301
/* Check whether MAP is one of MAPS parents.  */
302
static bool
303
keymap_memberp (Lisp_Object map, Lisp_Object maps)
304
{
305
  if (NILP (map)) return 0;
306
  while (KEYMAPP (maps) && !EQ (map, maps))
307
    maps = keymap_parent (maps, 0);
308 309 310
  return (EQ (map, maps));
}

311 312
/* Set the parent keymap of MAP to PARENT.  */

Paul Eggert's avatar
Paul Eggert committed
313
DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
314
       doc: /* Modify KEYMAP to set its parent map to PARENT.
315
Return PARENT.  PARENT should be nil or another keymap.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
316
  (Lisp_Object keymap, Lisp_Object parent)
317 318
{
  Lisp_Object list, prev;
Jim Blandy's avatar
Jim Blandy committed
319

320 321
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil; where_is_cache_keymaps = Qt;
322

323
  keymap = get_keymap (keymap, 1, 1);
324

325
  if (!NILP (parent))
326
    {
327
      parent = get_keymap (parent, 1, 0);
328 329

      /* Check for cycles.  */
330
      if (keymap_memberp (keymap, parent))
331 332
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
333

334 335 336 337
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
338
      list = XCDR (prev);
339 340
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
341
      if (!CONSP (list) || KEYMAPP (list))
342
	{
Paul Eggert's avatar
Paul Eggert committed
343
	  CHECK_IMPURE (prev, XCONS (prev));
344
	  XSETCDR (prev, parent);
345
	  return parent;
346 347 348 349 350
	}
      prev = list;
    }
}

351

Jim Blandy's avatar
Jim Blandy committed
352
/* Look up IDX in MAP.  IDX may be any sort of event.
353
   Note that this does only one level of lookup; IDX must be a single
354
   event, not a sequence.
355

356 357
   MAP must be a keymap or a list of keymaps.

358
   If T_OK, bindings for Qt are treated as default
359
   bindings; any key left unmentioned by other tables and bindings is
360
   given the binding of Qt.
361

362
   If not T_OK, bindings for Qt are not treated specially.
363

364 365
   If NOINHERIT, don't accept a subkeymap found in an inherited keymap.

366
   Return Qunbound if no binding was found (and return Qnil if a nil
367
   binding was found).  */
Jim Blandy's avatar
Jim Blandy committed
368

369
static Lisp_Object
370 371
access_keymap_1 (Lisp_Object map, Lisp_Object idx,
		 bool t_ok, bool noinherit, bool autoload)
Jim Blandy's avatar
Jim Blandy committed
372 373 374 375
{
  /* If idx is a list (some sort of mouse click, perhaps?),
     the index we want to use is the car of the list, which
     ought to be a symbol.  */
376
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
377

378 379
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
380
  if (SYMBOLP (idx))
381
    idx = reorder_modifiers (idx);
382
  else if (FIXNUMP (idx))
383 384
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
385
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
386

387
  /* Handle the special meta -> esc mapping.  */
388
  if (FIXNUMP (idx) && XFASTINT (idx) & meta_modifier)
389
    {
390 391
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
392
      Lisp_Object event_meta_binding, event_meta_map;
393 394
      /* A strange value in which Meta is set would cause
	 infinite recursion.  Protect against that.  */
Stefan Monnier's avatar
Stefan Monnier committed
395
      if (XINT (meta_prefix_char) & CHAR_META)
396
	meta_prefix_char = make_fixnum (27);
397 398 399
      event_meta_binding = access_keymap_1 (map, meta_prefix_char, t_ok,
					    noinherit, autoload);
      event_meta_map = get_keymap (event_meta_binding, 0, autoload);
400
      if (CONSP (event_meta_map))
401
	{
402
	  map = event_meta_map;
403
	  idx = make_fixnum (XFASTINT (idx) & ~meta_modifier);
404 405 406 407 408
	}
      else if (t_ok)
	/* Set IDX to t, so that we only find a default binding.  */
	idx = Qt;
      else
409 410
	/* An explicit nil binding, or no binding at all.  */
	return NILP (event_meta_binding) ? Qnil : Qunbound;
411 412
    }

413 414 415
  /* t_binding is where we put a default binding that applies,
     to use in case we do not find a binding specifically
     for this key sequence.  */
416 417
  {
    Lisp_Object tail;
418 419 420
    Lisp_Object t_binding = Qunbound;
    Lisp_Object retval = Qunbound;
    Lisp_Object retval_tail = Qnil;
421

422
    for (tail = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
423
	 (CONSP (tail)
424
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
425
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
426
      {
427 428 429 430
	/* Qunbound in VAL means we have found no binding.  */
	Lisp_Object val = Qunbound;
	Lisp_Object binding = XCAR (tail);
	Lisp_Object submap = get_keymap (binding, 0, autoload);
431

432
	if (EQ (binding, Qkeymap))
433
	  {
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
	    if (noinherit || NILP (retval))
	      /* If NOINHERIT, stop here, the rest is inherited.  */
	      break;
	    else if (!EQ (retval, Qunbound))
	      {
		Lisp_Object parent_entry;
		eassert (KEYMAPP (retval));
		parent_entry
		  = get_keymap (access_keymap_1 (tail, idx,
						 t_ok, 0, autoload),
				0, autoload);
		if (KEYMAPP (parent_entry))
		  {
		    if (CONSP (retval_tail))
		      XSETCDR (retval_tail, parent_entry);
		    else
		      {
			retval_tail = Fcons (retval, parent_entry);
			retval = Fcons (Qkeymap, retval_tail);
		      }
		  }
		break;
	      }
	  }
	else if (CONSP (submap))
	  {
	    val = access_keymap_1 (submap, idx, t_ok, noinherit, autoload);
461 462 463
	  }
	else if (CONSP (binding))
	  {
464
	    Lisp_Object key = XCAR (binding);
465

466
	    if (EQ (key, idx))
467
	      val = XCDR (binding);
468
	    else if (t_ok && EQ (key, Qt))
469 470
	      {
		t_binding = XCDR (binding);
471
		t_ok = 0;
472
	      }
473 474 475
	  }
	else if (VECTORP (binding))
	  {
476
	    if (FIXNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
477
	      val = AREF (binding, XFASTINT (idx));
478
	  }
479 480
	else if (CHAR_TABLE_P (binding))
	  {
481 482 483
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
484
	    if (FIXNUMP (idx) && (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0)
485 486
	      {
		val = Faref (binding, idx);
487
		/* nil has a special meaning for char-tables, so
488 489 490 491 492
		   we use something else to record an explicitly
		   unbound entry.  */
		if (NILP (val))
		  val = Qunbound;
	      }
493
	  }
494

495 496 497
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
498 499 500 501 502
	    if (EQ (val, Qt))
	      /* A Qt binding is just like an explicit nil binding
		 (i.e. it shadows any parent binding but not bindings in
		 keymaps of lower precedence).  */
	      val = Qnil;
503

504
	    val = get_keyelt (val, autoload);
505 506 507 508 509 510 511 512 513 514 515 516

	    if (!KEYMAPP (val))
	      {
		if (NILP (retval) || EQ (retval, Qunbound))
		  retval = val;
		if (!NILP (val))
		  break;  /* Shadows everything that follows.  */
	      }
	    else if (NILP (retval) || EQ (retval, Qunbound))
	      retval = val;
	    else if (CONSP (retval_tail))
	      {
517
		XSETCDR (retval_tail, list1 (val));
518 519 520 521
		retval_tail = XCDR (retval_tail);
	      }
	    else
	      {
522
		retval_tail = list1 (val);
523 524
		retval = Fcons (Qkeymap, Fcons (retval, retval_tail));
	      }
525
	  }
Paul Eggert's avatar
Paul Eggert committed
526
	maybe_quit ();
Jim Blandy's avatar
Jim Blandy committed
527
      }
528

529
    return EQ (Qunbound, retval) ? get_keyelt (t_binding, autoload) : retval;
530
  }
Jim Blandy's avatar
Jim Blandy committed
531 532
}

533 534
Lisp_Object
access_keymap (Lisp_Object map, Lisp_Object idx,
535
	       bool t_ok, bool noinherit, bool autoload)
536 537 538 539 540
{
  Lisp_Object val = access_keymap_1 (map, idx, t_ok, noinherit, autoload);
  return EQ (val, Qunbound) ? Qnil : val;
}

541
static void
542
map_keymap_item (map_keymap_function_t fun, Lisp_Object args, Lisp_Object key, Lisp_Object val, void *data)
543 544 545 546 547 548
{
  if (EQ (val, Qt))
    val = Qnil;
  (*fun) (key, val, args, data);
}

549 550 551 552 553 554 555 556 557 558 559 560
union map_keymap
{
  struct
  {
    map_keymap_function_t fun;
    Lisp_Object args;
    void *data;
  } s;
  GCALIGNED_UNION
};
verify (alignof (union map_keymap) % GCALIGNMENT == 0);

561
static void
562
map_keymap_char_table_item (Lisp_Object args, Lisp_Object key, Lisp_Object val)
563 564 565
{
  if (!NILP (val))
    {
566 567 568 569
      /* If the key is a range, make a copy since map_char_table modifies
	 it in place.  */
      if (CONSP (key))
	key = Fcons (XCAR (key), XCDR (key));
570 571
      union map_keymap *md = XINTPTR (args);
      map_keymap_item (md->s.fun, md->s.args, key, val, md->s.data);
572 573 574
    }
}

575 576
/* Call FUN for every binding in MAP and stop at (and return) the parent.
   FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).  */
577
static Lisp_Object
578 579 580 581
map_keymap_internal (Lisp_Object map,
		     map_keymap_function_t fun,
		     Lisp_Object args,
		     void *data)
582
{
583 584
  Lisp_Object tail
    = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
585

586
  for (; CONSP (tail) && !EQ (Qkeymap, XCAR (tail)); tail = XCDR (tail))
587 588
    {
      Lisp_Object binding = XCAR (tail);
Kenichi Handa's avatar
Kenichi Handa committed
589

590 591 592
      if (KEYMAPP (binding))	/* An embedded parent.  */
	break;
      else if (CONSP (binding))
593 594 595 596 597 598 599 600 601 602 603 604 605 606
	map_keymap_item (fun, args, XCAR (binding), XCDR (binding), data);
      else if (VECTORP (binding))
	{
	  /* Loop over the char values represented in the vector.  */
	  int len = ASIZE (binding);
	  int c;
	  for (c = 0; c < len; c++)
	    {
	      Lisp_Object character;
	      XSETFASTINT (character, c);
	      map_keymap_item (fun, args, character, AREF (binding, c), data);
	    }
	}
      else if (CHAR_TABLE_P (binding))
607 608 609 610 611
	{
	  union map_keymap mapdata = {{fun, args, data}};
	  map_char_table (map_keymap_char_table_item, Qnil, binding,
			  make_pointer_integer (&mapdata));
	}
612
    }
613

614
  return tail;
615 616 617
}

static void
618
map_keymap_call (Lisp_Object key, Lisp_Object val, Lisp_Object fun, void *dummy)
619 620 621 622
{
  call2 (fun, key, val);
}

623
/* Same as map_keymap_internal, but traverses parent keymaps as well.
624
   AUTOLOAD indicates that autoloaded keymaps should be loaded.  */
625
void
626 627
map_keymap (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args,
	    void *data, bool autoload)
628 629 630 631
{
  map = get_keymap (map, 1, autoload);
  while (CONSP (map))
    {
632 633 634 635 636 637 638 639 640
      if (KEYMAPP (XCAR (map)))
	{
	  map_keymap (XCAR (map), fun, args, data, autoload);
	  map = XCDR (map);
	}
      else
	map = map_keymap_internal (map, fun, args, data);
      if (!CONSP (map))
	map = get_keymap (map, 0, autoload);
641 642 643
    }
}

644 645 646
/* Same as map_keymap, but does it right, properly eliminating duplicate
   bindings due to inheritance.   */
void
647
map_keymap_canonical (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, void *data)
648 649 650 651 652 653 654 655
{
  /* map_keymap_canonical may be used from redisplay (e.g. when building menus)
     so be careful to ignore errors and to inhibit redisplay.  */
  map = safe_call1 (Qkeymap_canonicalize, map);
  /* No need to use `map_keymap' here because canonical map has no parent.  */
  map_keymap_internal (map, fun, args, data);
}

656 657 658 659 660
DEFUN ("map-keymap-internal", Fmap_keymap_internal, Smap_keymap_internal, 2, 2, 0,
       doc: /* Call FUNCTION once for each event binding in KEYMAP.
FUNCTION is called with two arguments: the event that is bound, and
the definition it is bound to.  The event may be a character range.
If KEYMAP has a parent, this function returns it without processing it.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
661
  (Lisp_Object function, Lisp_Object keymap)
662 663 664 665 666 667
{
  keymap = get_keymap (keymap, 1, 1);
  keymap = map_keymap_internal (keymap, map_keymap_call, function, NULL);
  return keymap;
}

668
DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
669
       doc: /* Call FUNCTION once for each event binding in KEYMAP.
Richard M. Stallman's avatar
Richard M. Stallman committed
670
FUNCTION is called with two arguments: the event that is bound, and
671
the definition it is bound to.  The event may be a character range.
Richard M. Stallman's avatar
Richard M. Stallman committed
672

673 674
If KEYMAP has a parent, the parent's bindings are included as well.
This works recursively: if the parent has itself a parent, then the
675 676
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
677
  (Lisp_Object function, Lisp_Object keymap, Lisp_Object sort_first)
678
{
679
  if (! NILP (sort_first))
680
    return call2 (intern ("map-keymap-sorted"), function, keymap);
681

682 683 684 685
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
686 687 688 689 690 691 692
/* Given OBJECT which was found in a slot in a keymap,
   trace indirect definitions to get the actual definition of that slot.
   An indirect definition is a list of the form
   (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one
   and INDEX is the object to look up in KEYMAP to yield the definition.

   Also if OBJECT has a menu string as the first element,
693 694
   remove that.  Also remove a menu help string as second element.

695
   If AUTOLOAD, load autoloadable keymaps
696 697 698
   that are referred to with indirection.

   This can GC because menu_item_eval_property calls Feval.  */
Jim Blandy's avatar
Jim Blandy committed
699

Andreas Schwab's avatar
Andreas Schwab committed
700
static Lisp_Object
701
get_keyelt (Lisp_Object object, bool autoload)
Jim Blandy's avatar
Jim Blandy committed
702 703 704
{
  while (1)
    {
705 706 707
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
708

709 710
      /* If the keymap contents looks like (menu-item name . DEFN)
	 or (menu-item name DEFN ...) then use DEFN.
711
	 This is a new format menu item.  */
712
      else if (EQ (XCAR (object), Qmenu_item))
713
	{
714
	  if (CONSP (XCDR (object)))
715
	    {
716 717
	      Lisp_Object tem;

718
	      object = XCDR (XCDR (object));
719
	      tem = object;
720 721
	      if (CONSP (object))
		object = XCAR (object);
722 723 724

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
725
		 use.  */
726
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
727
		if (EQ (XCAR (tem), QCfilter) && autoload)
728 729 730 731 732 733 734
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
735 736
	    }
	  else
737
	    /* Invalid keymap.  */
738
	    return object;
739 740
	}

741
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
742 743
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
744
      else if (STRINGP (XCAR (object)))
745
	object = XCDR (object);
Jim Blandy's avatar
Jim Blandy committed
746

747
      else
748
	return object;
Jim Blandy's avatar
Jim Blandy committed
749 750 751
    }
}

752
static Lisp_Object
753
store_in_keymap (Lisp_Object keymap, register Lisp_Object idx, Lisp_Object def)
Jim Blandy's avatar
Jim Blandy committed
754
{
755 756 757 758
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

759 760 761
  if (EQ (idx, Qkeymap))
    error ("`keymap' is reserved for embedded parent maps");

762
  /* If we are preparing to dump, and DEF is a menu element
763
     with a menu item indicator, copy it to ensure it is not pure.  */
Paul Eggert's avatar
Paul Eggert committed
764
  if (CONSP (def) && PURE_P (XCONS (def))
765 766
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
767

768
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
769 770
    error ("attempt to define a key in a non-keymap");

771 772 773 774 775 776 777 778 779
  /* If idx is a cons, and the car part is a character, idx must be of
     the form (FROM-CHAR . TO-CHAR).  */
  if (CONSP (idx) && CHARACTERP (XCAR (idx)))
    CHECK_CHARACTER_CDR (idx);
  else
    /* If idx is a list (some sort of mouse click, perhaps?),
       the index we want to use is the car of the list, which
       ought to be a symbol.  */
    idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
780

781 782
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
783
  if (SYMBOLP (idx))
784
    idx = reorder_modifiers (idx);
785
  else if (FIXNUMP (idx))
786 787
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
788
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
789 790

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
791
  {
792
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
793

794 795 796 797 798 799
    /* The cons after which we should insert new bindings.  If the
       keymap has a table element, we record its position here, so new
       bindings will go after it; this way, the table will stay
       towards the front of the alist and character lookups in dense
       keymaps will remain fast.  Otherwise, this just points at the
       front of the keymap.  */
800
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
801

802
    insertion_point = keymap;
803
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
804
      {
805
	Lisp_Object elt;
806

807
	elt = XCAR (tail);
808
	if (VECTORP (elt))
809
	  {
810
	    if (FIXNATP (idx) && XFASTINT (idx) < ASIZE (elt))
811
	      {
Paul Eggert's avatar
Paul Eggert committed
812
		CHECK_IMPURE (elt, XVECTOR (elt));
813
		ASET (elt, XFASTINT (idx), def);
814 815
		return def;
	      }
816 817 818 819 820 821 822 823 824 825 826 827 828
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		int from = XFASTINT (XCAR (idx));
		int to = XFASTINT (XCDR (idx));

		if (to >= ASIZE (elt))
		  to = ASIZE (elt) - 1;
		for (; from <= to; from++)
		  ASET (elt, from, def);
		if (to == XFASTINT (XCDR (idx)))
		  /* We have defined all keys in IDX.  */
		  return def;
	      }
829
	    insertion_point = tail;
830
	  }
831 832
	else if (CHAR_TABLE_P (elt))
	  {
833 834 835
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
836
	    if (FIXNATP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
837
	      {
838
		Faset (elt, idx,
839
		       /* nil has a special meaning for char-tables, so
840 841 842
			  we use something else to record an explicitly
			  unbound entry.  */
		       NILP (def) ? Qt : def);
843 844
		return def;
	      }
Kenichi Handa's avatar
Kenichi Handa committed
845 846 847 848 849
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		Fset_char_table_range (elt, idx, NILP (def) ? Qt : def);
		return def;
	      }
850 851
	    insertion_point = tail;
	  }
852 853
	else if (CONSP (elt))
	  {
854 855 856 857 858 859 860 861 862 863
	    if (EQ (Qkeymap, XCAR (elt)))
	      { /* A sub keymap.  This might be due to a lookup that found
		   two matching bindings (maybe because of a sub keymap).
		   It almost never happens (since the second binding normally
		   only happens in the inherited part of the keymap), but
		   if it does, we want to update the sub-keymap since the
		   main one might be temporary (built by access_keymap).  */
		tail = insertion_point = elt;
	      }
	    else if (EQ (idx, XCAR (elt)))
864
	      {
Paul Eggert's avatar
Paul Eggert committed
865
		CHECK_IMPURE (elt, XCONS (elt));
866
		XSETCDR (elt, def);
867 868
		return def;
	      }