keymap.c 110 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-2016 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 <http://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>
44

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

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

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

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

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

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

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

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

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

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

83 84 85 86 87
/* 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;

88 89 90 91 92 93 94
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),
95
			  bool, Lisp_Object, Lisp_Object*, bool, bool);
96
static void describe_vector (Lisp_Object, Lisp_Object, Lisp_Object,
97 98
                             void (*) (Lisp_Object, Lisp_Object), bool,
                             Lisp_Object, Lisp_Object, bool, bool);
99
static void silly_event_symbol_error (Lisp_Object);
100
static Lisp_Object get_keyelt (Lisp_Object, bool);
101 102 103 104 105 106

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
107

Jim Blandy's avatar
Jim Blandy committed
108 109
/* Keymap object support - constructors and predicates.			*/

110
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
111
       doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
112 113 114 115 116
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.
117 118 119

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
120
  (Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
121
{
122 123
  Lisp_Object tail;
  if (!NILP (string))
124
    tail = list1 (string);
125 126
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
127
  return Fcons (Qkeymap,
128
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
129 130
}

Paul Eggert's avatar
Paul Eggert committed
131
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
132 133 134 135 136 137 138 139
       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
140
  (Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
141
{
142
  if (!NILP (string))
143 144 145
    {
      if (!NILP (Vpurify_flag))
	string = Fpurecopy (string);
146
      return list2 (Qkeymap, string);
147
    }
148
  return list1 (Qkeymap);
Jim Blandy's avatar
Jim Blandy committed
149 150 151 152 153 154 155
}

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

   For example:

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

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

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

Jim Blandy's avatar
Jim Blandy committed
170
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
171 172 173 174 175 176 177
       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
178
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
179
{
180
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
181 182
}

Paul Eggert's avatar
Paul Eggert committed
183
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
184 185 186
       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
187
  (Lisp_Object map)
188
{
189
  map = get_keymap (map, 0, 0);
190 191
  while (CONSP (map))
    {
192
      Lisp_Object tem = XCAR (map);
193 194
      if (STRINGP (tem))
	return tem;
195 196 197 198 199 200
      else if (KEYMAPP (tem))
	{
	  tem = Fkeymap_prompt (tem);
	  if (!NILP (tem))
	    return tem;
	}
201
      map = XCDR (map);
202 203 204 205
    }
  return Qnil;
}

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

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

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

   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
221 222
   Fdefine_key should cause keymaps to be autoloaded.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

368
static Lisp_Object
369 370
access_keymap_1 (Lisp_Object map, Lisp_Object idx,
		 bool t_ok, bool noinherit, bool autoload)
Jim Blandy's avatar
Jim Blandy committed
371 372 373 374
{
  /* 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.  */
375
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
376

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

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

412 413 414
  /* 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.  */
415 416
  {
    Lisp_Object tail;
417 418 419
    Lisp_Object t_binding = Qunbound;
    Lisp_Object retval = Qunbound;
    Lisp_Object retval_tail = Qnil;
420

421
    for (tail = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
422
	 (CONSP (tail)
423
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
424
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
425
      {
426 427 428 429
	/* 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);
430

431
	if (EQ (binding, Qkeymap))
432
	  {
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
	    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);
460 461 462
	  }
	else if (CONSP (binding))
	  {
463
	    Lisp_Object key = XCAR (binding);
464

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

494 495 496
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
497 498 499 500 501
	    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;
502

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

	    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))
	      {
516
		XSETCDR (retval_tail, list1 (val));
517 518 519 520
		retval_tail = XCDR (retval_tail);
	      }
	    else
	      {
521
		retval_tail = list1 (val);
522 523
		retval = Fcons (Qkeymap, Fcons (retval, retval_tail));
	      }
524
	  }
525
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
526
      }
527

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

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

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

static void
549
map_keymap_char_table_item (Lisp_Object args, Lisp_Object key, Lisp_Object val)
550 551 552
{
  if (!NILP (val))
    {
Paul Eggert's avatar
Paul Eggert committed
553
      map_keymap_function_t fun
554
	= (map_keymap_function_t) XSAVE_FUNCPOINTER (args, 0);
555 556 557 558
      /* 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));
559 560
      map_keymap_item (fun, XSAVE_OBJECT (args, 2), key,
		       val, XSAVE_POINTER (args, 1));
561 562 563
    }
}

564 565
/* 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).  */
566
static Lisp_Object
567 568 569 570
map_keymap_internal (Lisp_Object map,
		     map_keymap_function_t fun,
		     Lisp_Object args,
		     void *data)
571
{
572 573
  Lisp_Object tail
    = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
574

575
  for (; CONSP (tail) && !EQ (Qkeymap, XCAR (tail)); tail = XCDR (tail))
576 577
    {
      Lisp_Object binding = XCAR (tail);
Kenichi Handa's avatar
Kenichi Handa committed
578

579 580 581
      if (KEYMAPP (binding))	/* An embedded parent.  */
	break;
      else if (CONSP (binding))
582 583 584 585 586 587 588 589 590 591 592 593 594 595
	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))
596
	map_char_table (map_keymap_char_table_item, Qnil, binding,
597 598
			make_save_funcptr_ptr_obj ((voidfuncptr) fun, data,
						   args));
599
    }
600

601
  return tail;
602 603 604
}

static void
605
map_keymap_call (Lisp_Object key, Lisp_Object val, Lisp_Object fun, void *dummy)
606 607 608 609
{
  call2 (fun, key, val);
}

610
/* Same as map_keymap_internal, but traverses parent keymaps as well.
611
   AUTOLOAD indicates that autoloaded keymaps should be loaded.  */
612
void
613 614
map_keymap (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args,
	    void *data, bool autoload)
615 616 617 618
{
  map = get_keymap (map, 1, autoload);
  while (CONSP (map))
    {
619 620 621 622 623 624 625 626 627
      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);
628 629 630
    }
}

631 632 633
/* Same as map_keymap, but does it right, properly eliminating duplicate
   bindings due to inheritance.   */
void
634
map_keymap_canonical (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, void *data)
635 636 637 638 639 640 641 642
{
  /* 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);
}

643 644 645 646 647
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
648
  (Lisp_Object function, Lisp_Object keymap)
649 650 651 652 653 654
{
  keymap = get_keymap (keymap, 1, 1);
  keymap = map_keymap_internal (keymap, map_keymap_call, function, NULL);
  return keymap;
}

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

660 661
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
662 663
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
664
  (Lisp_Object function, Lisp_Object keymap, Lisp_Object sort_first)
665
{
666
  if (! NILP (sort_first))
667
    return call2 (intern ("map-keymap-sorted"), function, keymap);
668

669 670 671 672
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
673 674 675 676 677 678 679
/* 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,
680 681
   remove that.  Also remove a menu help string as second element.

682
   If AUTOLOAD, load autoloadable keymaps
683 684 685
   that are referred to with indirection.

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

Andreas Schwab's avatar
Andreas Schwab committed
687
static Lisp_Object
688
get_keyelt (Lisp_Object object, bool autoload)
Jim Blandy's avatar
Jim Blandy committed
689 690 691
{
  while (1)
    {
692 693 694
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
695

696 697
      /* If the keymap contents looks like (menu-item name . DEFN)
	 or (menu-item name DEFN ...) then use DEFN.
698
	 This is a new format menu item.  */
699
      else if (EQ (XCAR (object), Qmenu_item))
700
	{
701
	  if (CONSP (XCDR (object)))
702
	    {
703 704
	      Lisp_Object tem;

705
	      object = XCDR (XCDR (object));
706
	      tem = object;
707 708
	      if (CONSP (object))
		object = XCAR (object);
709 710 711

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
712
		 use.  */
713
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
714
		if (EQ (XCAR (tem), QCfilter) && autoload)
715 716 717 718 719 720 721
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
722 723
	    }
	  else
724
	    /* Invalid keymap.  */
725
	    return object;
726 727
	}

728
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
729 730
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
731
      else if (STRINGP (XCAR (object)))
732
	object = XCDR (object);
Jim Blandy's avatar
Jim Blandy committed
733

734
      else
735
	return object;
Jim Blandy's avatar
Jim Blandy committed
736 737 738
    }
}

739
static Lisp_Object
740
store_in_keymap (Lisp_Object keymap, register Lisp_Object idx, Lisp_Object def)
Jim Blandy's avatar
Jim Blandy committed
741
{
742 743 744 745
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

746 747 748
  if (EQ (idx, Qkeymap))
    error ("`keymap' is reserved for embedded parent maps");

749
  /* If we are preparing to dump, and DEF is a menu element
750
     with a menu item indicator, copy it to ensure it is not pure.  */
Paul Eggert's avatar
Paul Eggert committed
751
  if (CONSP (def) && PURE_P (XCONS (def))
752 753
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
754

755
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
756 757
    error ("attempt to define a key in a non-keymap");

758 759 760 761 762 763 764 765 766
  /* 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
767

768 769
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
770
  if (SYMBOLP (idx))
771
    idx = reorder_modifiers (idx);
772 773 774
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
775
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
776 777

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
778
  {
779
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
780

781 782 783 784 785 786
    /* 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.  */
787
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
788

789
    insertion_point = keymap;
790
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
791
      {
792
	Lisp_Object elt;
793

794
	elt = XCAR (tail);
795
	if (VECTORP (elt))
796
	  {
797
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
798
	      {
Paul Eggert's avatar
Paul Eggert committed
799
		CHECK_IMPURE (elt, XVECTOR (elt));
800
		ASET (elt, XFASTINT (idx), def);
801 802
		return def;
	      }
803 804 805 806 807 808 809 810 811 812 813 814 815
	    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;
	      }
816
	    insertion_point = tail;
817
	  }
818 819
	else if (CHAR_TABLE_P (elt))
	  {
820 821 822
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
823
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
824
	      {
825
		Faset (elt, idx,
826
		       /* nil has a special meaning for char-tables, so
827 828 829
			  we use something else to record an explicitly
			  unbound entry.  */
		       NILP (def) ? Qt : def);
830 831
		return def;
	      }
Kenichi Handa's avatar
Kenichi Handa committed
832 833 834 835 836
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		Fset_char_table_range (elt, idx, NILP (def) ? Qt : def);
		return def;
	      }
837 838
	    insertion_point = tail;
	  }
839 840
	else if (CONSP (elt))
	  {
841 842 843 844 845 846 847 848 849 850
	    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)))
851
	      {
Paul Eggert's avatar
Paul Eggert committed
852
		CHECK_IMPURE (elt, XCONS (elt));
853
		XSETCDR (elt, def);
854 855
		return def;
	      }
856 857 858
	    else if (CONSP (idx)
		     && CHARACTERP (XCAR (idx))
		     && CHARACTERP (XCAR (elt)))
859 860 861 862 863 864 865 866 867 868 869 870
	      {
		int from = XFASTINT (XCAR (idx));
		int to = XFASTINT (XCDR (idx));

		if (from <= XFASTINT (XCAR (elt))
		    && to >= XFASTINT (XCAR (elt)))
		  {
		    XSETCDR (elt, def);
		    if (from == to)
		      return def;
		  }
	      }
871
	  }
872 873 874 875 876 877
	else if (EQ (elt, Qkeymap))
	  /* If we find a 'keymap' symbol in the spine of KEYMAP,
	     then we must have found the start of a second keymap
	     being used as the tail of KEYMAP, and a binding for IDX
	     should be inserted before it.  */
	  goto keymap_end;
878 879

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
880 881
      }

882 883 884
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
885 886 887 888 889 890 891 892 893 894 895 896 897
    {
      Lisp_Object elt;

      if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	{
	  /* IDX specifies a range of characters, and not all of them
	     were handled yet, which means this keymap doesn't have a
	     char-table.  So, we insert a char-table now.  */
	  elt = Fmake_char_table (Qkeymap, Qnil);
	  Fset_char_table_range (elt, idx, NILP (def) ? Qt : def);
	}
      else
	elt = Fcons (idx, def);
Paul Eggert's avatar
Paul Eggert committed
898
      CHECK_IMPURE (insertion_point, XCONS (insertion_point));
899 900
      XSETCDR (insertion_point, Fcons (elt, XCDR (insertion_point)));
    }
901
  }
902

Jim Blandy's avatar
Jim Blandy committed
903 904 905
  return def;
}

906
static Lisp_Object
907
copy_keymap_item (Lisp_Object elt)
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
{
  Lisp_Object res, tem;

  if (!CONSP (elt))
    return elt;

  res = tem = elt;

  /* Is this a new format menu item.  */
  if (EQ (XCAR (tem), Qmenu_item))
    {
      /* Copy cell with menu-item marker.  */
      res = elt = Fcons (XCAR (tem), XCDR (tem));
      tem = XCDR (elt);
      if (CONSP (tem))
	{
	  /* Copy cell with menu-item name.  */
	  XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
	  elt = XCDR (elt);
	  tem = XCDR (elt);
	}
      if (CONSP (tem))
	{
	  /* Copy cell with binding and if the binding is a keymap,
	     copy that.  */
	  XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
	  elt = XCDR (elt);
	  tem = XCAR (elt);
	  if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
	    XSETCAR (elt, Fcopy_keymap (tem));
	  tem = XCDR (elt);
	}
    }
  else
    {
Paul Eggert's avatar
Paul Eggert committed
943
      /* It may be an old format menu item.
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
	 Skip the optional menu string.  */
      if (STRINGP (XCAR (tem)))
	{
	  /* Copy the cell, since copy-alist didn't go this deep.  */
	  res = elt = Fcons (XCAR (tem), XCDR (tem));
	  tem = XCDR (elt);
	  /* Also skip the optional menu help string.  */
	  if (CONSP (tem) && STRINGP (XCAR (tem)))
	    {
	      XSETCDR (elt, Fcons (XCAR (tem), XCDR (tem)));
	      elt = XCDR (elt);
	      tem = XCDR (elt);
	    }
	  if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
	    XSETCDR (elt, Fcopy_keymap (tem));
	}
      else if (EQ (XCAR (tem), Qkeymap))
	res = Fcopy_keymap (elt);
    }
  return res;
}

966
static void
967
copy_keymap_1 (Lisp_Object chartable, Lisp_Object idx, Lisp_Object elt)
968
{
Kenichi Handa's avatar
Kenichi Handa committed
969
  Fset_char_table_range (chartable, idx, copy_keymap_item (elt));
970
}
971

Jim Blandy's avatar
Jim Blandy committed
972
DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0,
973
       doc: /* Return a copy of the keymap KEYMAP.
974 975 976 977 978 979 980 981 982 983 984 985

Note that this is almost never needed.  If you want a keymap that's like
another yet with a few changes, you should use map inheritance rather
than copying.  I.e. something like:

    (let ((map (make-sparse-keymap)))
      (set-keymap-parent map <theirmap>)
      (define-key map ...)
      ...)

After performing `copy-keymap', the copy starts out with the same definitions
of KEYMAP, but changing either the copy or KEYMAP does not affect the other.
986 987