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

This file is part of GNU Emacs.

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

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
17
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
18

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
/* 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
40

41
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
42
#include <stdio.h>
43

Jim Blandy's avatar
Jim Blandy committed
44 45
#include "lisp.h"
#include "commands.h"
Kenichi Handa's avatar
Kenichi Handa committed
46
#include "character.h"
47
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
48
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
49
#include "keyboard.h"
50
#include "frame.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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79

/* Actually allocate storage for these variables */

Lisp_Object current_global_map;	/* Current global keymap */

Lisp_Object global_map;		/* default global key bindings */

Lisp_Object meta_map;		/* The keymap used for globally bound
				   ESC-prefixed default commands */

Lisp_Object control_x_map;	/* The keymap used for globally bound
				   C-x-prefixed default commands */

				/* The keymap used by the minibuf for local
				   bindings when spaces are allowed in the
				   minibuf */

				/* The keymap used by the minibuf for local
				   bindings when spaces are not encouraged
				   in the minibuf */

/* keymap used for minibuffers when doing completion */
/* keymap used for minibuffers when doing completion and require a match */
80 81 82
static Lisp_Object Qkeymapp, Qnon_ascii;
Lisp_Object Qkeymap, Qmenu_item, Qremap;
static Lisp_Object QCadvertised_binding;
Jim Blandy's avatar
Jim Blandy committed
83

84 85 86
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

87 88
/* Pre-allocated 2-element vector for Fcommand_remapping to use.  */
static Lisp_Object command_remapping_vector;
89

90 91 92 93 94
/* 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;

95 96 97 98 99 100 101
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),
102
			  bool, Lisp_Object, Lisp_Object*, bool, bool);
103
static void describe_vector (Lisp_Object, Lisp_Object, Lisp_Object,
104 105
                             void (*) (Lisp_Object, Lisp_Object), bool,
                             Lisp_Object, Lisp_Object, bool, bool);
106
static void silly_event_symbol_error (Lisp_Object);
107
static Lisp_Object get_keyelt (Lisp_Object, bool);
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 125 126 127
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  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 147 148
    {
      if (!NILP (Vpurify_flag))
	string = Fpurecopy (string);
      return Fcons (Qkeymap, Fcons (string, Qnil));
    }
Jim Blandy's avatar
Jim Blandy committed
149 150 151 152 153 154 155 156
  return Fcons (Qkeymap, Qnil);
}

/* 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
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
162
  store_in_keymap (keymap, make_number (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 252 253 254 255 256
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
257

258
		  GCPRO2 (tem, object);
259
		  Fautoload_do_load (tem, object, Qnil);
260
		  UNGCPRO;
261

262 263 264
		  goto autoload_retry;
		}
	      else
265
	      	return object;
266
	    }
267
	}
268 269
    }

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

279
static Lisp_Object
280
keymap_parent (Lisp_Object keymap, bool autoload)
281 282 283
{
  Lisp_Object list;

284
  keymap = get_keymap (keymap, 1, autoload);
285 286

  /* Skip past the initial element `keymap'.  */
287 288
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
289 290
    {
      /* See if there is another `keymap'.  */
291
      if (KEYMAPP (list))
292 293 294
	return list;
    }

295
  return get_keymap (list, 0, autoload);
296 297
}

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

306
/* Check whether MAP is one of MAPS parents.  */
307
static bool
308
keymap_memberp (Lisp_Object map, Lisp_Object maps)
309
{
310
  if (NILP (map)) return 0;
311
  while (KEYMAPP (maps) && !EQ (map, maps))
312
    maps = keymap_parent (maps, 0);
313 314 315
  return (EQ (map, maps));
}

316 317
/* Set the parent keymap of MAP to PARENT.  */

Paul Eggert's avatar
Paul Eggert committed
318
DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
319
       doc: /* Modify KEYMAP to set its parent map to PARENT.
320
Return PARENT.  PARENT should be nil or another keymap.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
321
  (Lisp_Object keymap, Lisp_Object parent)
322 323
{
  Lisp_Object list, prev;
324
  struct gcpro gcpro1, gcpro2;
Jim Blandy's avatar
Jim Blandy committed
325

326 327
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil; where_is_cache_keymaps = Qt;
328

329
  GCPRO2 (keymap, parent);
330
  keymap = get_keymap (keymap, 1, 1);
331

332
  if (!NILP (parent))
333
    {
334
      parent = get_keymap (parent, 1, 0);
335 336

      /* Check for cycles.  */
337
      if (keymap_memberp (keymap, parent))
338 339
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
340

341 342 343 344
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
345
      list = XCDR (prev);
346 347
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
348
      if (!CONSP (list) || KEYMAPP (list))
349
	{
350
	  CHECK_IMPURE (prev);
351
	  XSETCDR (prev, parent);
352
	  RETURN_UNGCPRO (parent);
353 354 355 356 357
	}
      prev = list;
    }
}

358

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

363 364
   MAP must be a keymap or a list of keymaps.

365
   If T_OK, bindings for Qt are treated as default
366
   bindings; any key left unmentioned by other tables and bindings is
367
   given the binding of Qt.
368

369
   If not T_OK, bindings for Qt are not treated specially.
370

371 372
   If NOINHERIT, don't accept a subkeymap found in an inherited keymap.

373
   Return Qunbound if no binding was found (and return Qnil if a nil
374
   binding was found).  */
Jim Blandy's avatar
Jim Blandy committed
375

376
static Lisp_Object
377 378
access_keymap_1 (Lisp_Object map, Lisp_Object idx,
		 bool t_ok, bool noinherit, bool autoload)
Jim Blandy's avatar
Jim Blandy committed
379 380 381 382
{
  /* 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.  */
383
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
384

385 386
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
387
  if (SYMBOLP (idx))
388
    idx = reorder_modifiers (idx);
389 390 391
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
392
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
393

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

423 424 425
  /* 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.  */
426 427
  {
    Lisp_Object tail;
428 429 430
    Lisp_Object t_binding = Qunbound;
    Lisp_Object retval = Qunbound;
    Lisp_Object retval_tail = Qnil;
431
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
432

433
    GCPRO4 (tail, idx, t_binding, retval);
434

435
    for (tail = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
436
	 (CONSP (tail)
437
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
438
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
439
      {
440 441 442 443
	/* 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);
444

445
	if (EQ (binding, Qkeymap))
446
	  {
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
	    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);
474 475 476
	  }
	else if (CONSP (binding))
	  {
477
	    Lisp_Object key = XCAR (binding);
478

479
	    if (EQ (key, idx))
480
	      val = XCDR (binding);
481
	    else if (t_ok && EQ (key, Qt))
482 483
	      {
		t_binding = XCDR (binding);
484
		t_ok = 0;
485
	      }
486 487 488
	  }
	else if (VECTORP (binding))
	  {
489
	    if (INTEGERP (idx) && XFASTINT (idx) < ASIZE (binding))
490
	      val = AREF (binding, XFASTINT (idx));
491
	  }
492 493
	else if (CHAR_TABLE_P (binding))
	  {
494 495 496
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
497
	    if (INTEGERP (idx) && (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0)
498 499 500 501 502 503 504 505
	      {
		val = Faref (binding, idx);
		/* `nil' has a special meaning for char-tables, so
		   we use something else to record an explicitly
		   unbound entry.  */
		if (NILP (val))
		  val = Qunbound;
	      }
506
	  }
507

508 509 510
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
511 512 513 514 515
	    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;
516

517
	    val = get_keyelt (val, autoload);
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537

	    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))
	      {
		XSETCDR (retval_tail, Fcons (val, Qnil));
		retval_tail = XCDR (retval_tail);
	      }
	    else
	      {
		retval_tail = Fcons (val, Qnil);
		retval = Fcons (Qkeymap, Fcons (retval, retval_tail));
	      }
538
	  }
539
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
540
      }
541
    UNGCPRO;
542
    return EQ (Qunbound, retval) ? get_keyelt (t_binding, autoload) : retval;
543
  }
Jim Blandy's avatar
Jim Blandy committed
544 545
}

546 547
Lisp_Object
access_keymap (Lisp_Object map, Lisp_Object idx,
548
	       bool t_ok, bool noinherit, bool autoload)
549 550 551 552 553
{
  Lisp_Object val = access_keymap_1 (map, idx, t_ok, noinherit, autoload);
  return EQ (val, Qunbound) ? Qnil : val;
}

554
static void
555
map_keymap_item (map_keymap_function_t fun, Lisp_Object args, Lisp_Object key, Lisp_Object val, void *data)
556 557 558 559 560 561 562
{
  if (EQ (val, Qt))
    val = Qnil;
  (*fun) (key, val, args, data);
}

static void
563
map_keymap_char_table_item (Lisp_Object args, Lisp_Object key, Lisp_Object val)
564 565 566
{
  if (!NILP (val))
    {
567 568
      map_keymap_function_t fun
	= (map_keymap_function_t) XSAVE_VALUE (XCAR (args))->pointer;
569
      args = XCDR (args);
570 571 572 573
      /* 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));
574 575 576 577 578
      map_keymap_item (fun, XCDR (args), key, val,
		       XSAVE_VALUE (XCAR (args))->pointer);
    }
}

579 580
/* 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).  */
581
static Lisp_Object
582 583 584 585
map_keymap_internal (Lisp_Object map,
		     map_keymap_function_t fun,
		     Lisp_Object args,
		     void *data)
586 587
{
  struct gcpro gcpro1, gcpro2, gcpro3;
588 589
  Lisp_Object tail
    = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
590 591

  GCPRO3 (map, args, tail);
592
  for (; CONSP (tail) && !EQ (Qkeymap, XCAR (tail)); tail = XCDR (tail))
593 594
    {
      Lisp_Object binding = XCAR (tail);
Kenichi Handa's avatar
Kenichi Handa committed
595

596 597 598
      if (KEYMAPP (binding))	/* An embedded parent.  */
	break;
      else if (CONSP (binding))
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
	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))
	{
Kenichi Handa's avatar
Kenichi Handa committed
614
	  map_char_table (map_keymap_char_table_item, Qnil, binding,
615
			  Fcons (make_save_value ((void *) fun, 0),
616
				 Fcons (make_save_value (data, 0),
Kenichi Handa's avatar
Kenichi Handa committed
617
					args)));
618 619 620
	}
    }
  UNGCPRO;
621
  return tail;
622 623 624
}

static void
625
map_keymap_call (Lisp_Object key, Lisp_Object val, Lisp_Object fun, void *dummy)
626 627 628 629
{
  call2 (fun, key, val);
}

630
/* Same as map_keymap_internal, but traverses parent keymaps as well.
631
   AUTOLOAD indicates that autoloaded keymaps should be loaded.  */
632
void
633 634
map_keymap (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args,
	    void *data, bool autoload)
635 636 637 638 639 640
{
  struct gcpro gcpro1;
  GCPRO1 (args);
  map = get_keymap (map, 1, autoload);
  while (CONSP (map))
    {
641 642 643 644 645 646 647 648 649
      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);
650 651 652 653
    }
  UNGCPRO;
}

654
static Lisp_Object Qkeymap_canonicalize;
655 656 657 658

/* Same as map_keymap, but does it right, properly eliminating duplicate
   bindings due to inheritance.   */
void
659
map_keymap_canonical (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, void *data)
660 661 662 663 664 665 666 667 668 669 670
{
  struct gcpro gcpro1;
  GCPRO1 (args);
  /* 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);
  UNGCPRO;
}

671 672 673 674 675
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
676
  (Lisp_Object function, Lisp_Object keymap)
677 678 679 680 681 682 683 684 685
{
  struct gcpro gcpro1;
  GCPRO1 (function);
  keymap = get_keymap (keymap, 1, 1);
  keymap = map_keymap_internal (keymap, map_keymap_call, function, NULL);
  UNGCPRO;
  return keymap;
}

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

691 692
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
693 694
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
695
  (Lisp_Object function, Lisp_Object keymap, Lisp_Object sort_first)
696
{
697
  if (! NILP (sort_first))
698
    return call2 (intern ("map-keymap-sorted"), function, keymap);
699

700 701 702 703
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
704 705 706 707 708 709 710
/* 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,
711 712
   remove that.  Also remove a menu help string as second element.

713
   If AUTOLOAD, load autoloadable keymaps
714 715 716
   that are referred to with indirection.

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

Andreas Schwab's avatar
Andreas Schwab committed
718
static Lisp_Object
719
get_keyelt (Lisp_Object object, bool autoload)
Jim Blandy's avatar
Jim Blandy committed
720 721 722
{
  while (1)
    {
723 724 725
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
726

727 728 729 730 731 732 733
      /* If the keymap contents looks like (keymap ...) or (lambda ...)
	 then use itself. */
      else if (EQ (XCAR (object), Qkeymap) || EQ (XCAR (object), Qlambda))
	return object;

      /* If the keymap contents looks like (menu-item name . DEFN)
	 or (menu-item name DEFN ...) then use DEFN.
734
	 This is a new format menu item.  */
735
      else if (EQ (XCAR (object), Qmenu_item))
736
	{
737
	  if (CONSP (XCDR (object)))
738
	    {
739 740
	      Lisp_Object tem;

741
	      object = XCDR (XCDR (object));
742
	      tem = object;
743 744
	      if (CONSP (object))
		object = XCAR (object);
745 746 747

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
748
		 use.  */
749
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
750
		if (EQ (XCAR (tem), QCfilter) && autoload)
751 752 753 754 755 756 757
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
758 759
	    }
	  else
760
	    /* Invalid keymap.  */
761
	    return object;
762 763
	}

764
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
765 766
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
767
      else if (STRINGP (XCAR (object)))
768
	{
769
	  object = XCDR (object);
770 771
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
772 773
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
774
	  /* Also remove the sublist that caches key equivalences, if any.  */
775
	  if (CONSP (object) && CONSP (XCAR (object)))
776
	    {
777
	      Lisp_Object carcar;
778
	      carcar = XCAR (XCAR (object));
779
	      if (NILP (carcar) || VECTORP (carcar))
780
		object = XCDR (object);
781
	    }
782
	}
Jim Blandy's avatar
Jim Blandy committed
783

784
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
785 786
      else if (KEYMAPP (XCAR (object)))
	error ("Wow, indirect keymap entry!!");
787
      else
788
	return object;
Jim Blandy's avatar
Jim Blandy committed
789 790 791
    }
}

792
static Lisp_Object
793
store_in_keymap (Lisp_Object keymap, register Lisp_Object idx, Lisp_Object def)
Jim Blandy's avatar
Jim Blandy committed
794
{
795 796 797 798
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

799 800 801
  if (EQ (idx, Qkeymap))
    error ("`keymap' is reserved for embedded parent maps");

802
  /* If we are preparing to dump, and DEF is a menu element
803 804
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
805 806
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
807

808
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
809 810
    error ("attempt to define a key in a non-keymap");

811 812 813 814 815 816 817 818 819
  /* 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
820

821 822
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
823
  if (SYMBOLP (idx))
824
    idx = reorder_modifiers (idx);
825 826 827
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
828
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
829 830

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
831
  {
832
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
833

834 835 836 837 838 839
    /* 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.  */
840
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
841

842
    insertion_point = keymap;
843
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
844
      {
845
	Lisp_Object elt;
846

847
	elt = XCAR (tail);
848
	if (VECTORP (elt))
849
	  {
850
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
851
	      {
852
		CHECK_IMPURE (elt);
853
		ASET (elt, XFASTINT (idx), def);
854 855
		return def;
	      }
856 857 858 859 860 861 862 863 864 865 866 867 868
	    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;
	      }
869
	    insertion_point = tail;
870
	  }
871 872
	else if (CHAR_TABLE_P (elt))
	  {
873 874 875
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
876
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
877
	      {
878 879 880 881 882
		Faset (elt, idx,
		       /* `nil' has a special meaning for char-tables, so
			  we use something else to record an explicitly
			  unbound entry.  */
		       NILP (def) ? Qt : def);
883 884
		return def;
	      }
Kenichi Handa's avatar
Kenichi Handa committed
885 886 887 888 889
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		Fset_char_table_range (elt, idx, NILP (def) ? Qt : def);
		return def;
	      }
890 891
	    insertion_point = tail;
	  }
892 893
	else if (CONSP