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
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
44 45 46
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Kenichi Handa's avatar
Kenichi Handa committed
47
#include "character.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
static Lisp_Object Flookup_key (Lisp_Object, Lisp_Object, Lisp_Object);
96 97 98 99 100 101 102 103 104 105
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),
			  int, Lisp_Object, Lisp_Object*, int, int);
static void describe_vector (Lisp_Object, Lisp_Object, Lisp_Object,
                             void (*) (Lisp_Object, Lisp_Object), int,
106
                             Lisp_Object, Lisp_Object, int, int);
107
static void silly_event_symbol_error (Lisp_Object);
Andreas Schwab's avatar
Andreas Schwab committed
108
static Lisp_Object get_keyelt (Lisp_Object, int);
Jim Blandy's avatar
Jim Blandy committed
109

Jim Blandy's avatar
Jim Blandy committed
110 111
/* Keymap object support - constructors and predicates.			*/

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

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

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

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

   For example:

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

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

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

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

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

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

   If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
   is an autoload form, do the autoload and try again.
213
   If AUTOLOAD is nonzero, callers must assume GC is possible.
214

215 216 217
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

218 219 220
   ERROR_IF_NOT_KEYMAP controls how we respond if OBJECT isn't a keymap.
   If ERROR_IF_NOT_KEYMAP is non-zero, signal an error; otherwise,
   just return Qnil.
221 222 223 224 225

   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
226 227 228 229
   Fdefine_key should cause keymaps to be autoloaded.

   This function can GC when AUTOLOAD is non-zero, because it calls
   do_autoload which can GC.  */
230

Jim Blandy's avatar
Jim Blandy committed
231
Lisp_Object
232
get_keymap (Lisp_Object object, int error_if_not_keymap, int autoload)
Jim Blandy's avatar
Jim Blandy committed
233
{
234
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
235

236
 autoload_retry:
237 238 239 240
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
241

242 243
  tem = indirect_function (object);
  if (CONSP (tem))
244
    {
245 246
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
247

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

255 256 257 258 259 260
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
261

262 263 264
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
265

266 267 268
		  goto autoload_retry;
		}
	      else
269
	      	return object;
270
	    }
271
	}
272 273
    }

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

283
static Lisp_Object
284
keymap_parent (Lisp_Object keymap, int autoload)
285 286 287
{
  Lisp_Object list;

288
  keymap = get_keymap (keymap, 1, autoload);
289 290

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

299
  return get_keymap (list, 0, autoload);
300 301
}

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

310
/* Check whether MAP is one of MAPS parents.  */
311
static int
312
keymap_memberp (Lisp_Object map, Lisp_Object maps)
313
{
314
  if (NILP (map)) return 0;
315
  while (KEYMAPP (maps) && !EQ (map, maps))
316
    maps = keymap_parent (maps, 0);
317 318 319
  return (EQ (map, maps));
}

320 321
/* Set the parent keymap of MAP to PARENT.  */

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

330 331
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil; where_is_cache_keymaps = Qt;
332

333
  GCPRO2 (keymap, parent);
334
  keymap = get_keymap (keymap, 1, 1);
335

336
  if (!NILP (parent))
337
    {
338
      parent = get_keymap (parent, 1, 0);
339 340

      /* Check for cycles.  */
341
      if (keymap_memberp (keymap, parent))
342 343
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
344

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

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

367 368
   MAP must be a keymap or a list of keymaps.

369 370
   If T_OK is non-zero, bindings for Qt are treated as default
   bindings; any key left unmentioned by other tables and bindings is
371
   given the binding of Qt.
372

373 374
   If T_OK is zero, bindings for Qt are not treated specially.

375 376 377 378
   If NOINHERIT, don't accept a subkeymap found in an inherited keymap.

   Returns Qunbound if no binding was found (and returns Qnil if a nil
   binding was found).  */
Jim Blandy's avatar
Jim Blandy committed
379

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

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

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

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

436
    GCPRO4 (tail, idx, t_binding, retval);
437

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

448
	if (EQ (binding, Qkeymap))
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 474 475 476
	    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);
477 478 479
	  }
	else if (CONSP (binding))
	  {
480
	    Lisp_Object key = XCAR (binding);
481

482
	    if (EQ (key, idx))
483
	      val = XCDR (binding);
484
	    else if (t_ok && EQ (key, Qt))
485 486
	      {
		t_binding = XCDR (binding);
487
		t_ok = 0;
488
	      }
489 490 491
	  }
	else if (VECTORP (binding))
	  {
492
	    if (INTEGERP (idx) && XFASTINT (idx) < ASIZE (binding))
493
	      val = AREF (binding, XFASTINT (idx));
494
	  }
495 496
	else if (CHAR_TABLE_P (binding))
	  {
497 498 499
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
500
	    if (INTEGERP (idx) && (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0)
501 502 503 504 505 506 507 508
	      {
		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;
	      }
509
	  }
510

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

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

	    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));
	      }
541
	  }
542
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
543
      }
544
    UNGCPRO;
545
    return EQ (Qunbound, retval) ? get_keyelt (t_binding, autoload) : retval;
546
  }
Jim Blandy's avatar
Jim Blandy committed
547 548
}

549 550 551 552 553 554 555 556
Lisp_Object
access_keymap (Lisp_Object map, Lisp_Object idx,
	       int t_ok, int noinherit, int autoload)
{
  Lisp_Object val = access_keymap_1 (map, idx, t_ok, noinherit, autoload);
  return EQ (val, Qunbound) ? Qnil : val;
}

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

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

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

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

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

static void
628
map_keymap_call (Lisp_Object key, Lisp_Object val, Lisp_Object fun, void *dummy)
629 630 631 632
{
  call2 (fun, key, val);
}

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

656
static Lisp_Object Qkeymap_canonicalize;
657 658 659 660

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

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

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

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

702 703 704 705
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

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

   If AUTOLOAD is nonzero, load autoloadable keymaps
716 717 718
   that are referred to with indirection.

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

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

729 730 731 732 733 734 735
      /* 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.
736
	 This is a new format menu item.  */
737
      else if (EQ (XCAR (object), Qmenu_item))
738
	{
739
	  if (CONSP (XCDR (object)))
740
	    {
741 742
	      Lisp_Object tem;

743
	      object = XCDR (XCDR (object));
744
	      tem = object;
745 746
	      if (CONSP (object))
		object = XCAR (object);
747 748 749

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

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

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

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

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

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

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

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

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

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

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

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

849
	elt = XCAR (tail);
850
	if (VECTORP (elt))
851
	  {
852
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
853
	      {
854
		CHECK_IMPURE (elt);
855
		ASET (elt, XFASTINT (idx), def);
856 857
		return def;
	      }
858 859 860 861 862 863 864 865 866 867 868 869 870
	    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;
	      }
871
	    insertion_point = tail;
872
	  }
873 874
	else if (CHAR_TABLE_P (elt))
	  {
875 876 877
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
878
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
879
	      {
880 881 882 883 884
		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);
885 886
		return def;
	      }
Kenichi Handa's avatar
Kenichi Handa committed
887 888 889 890 891
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		Fset_char_table_range (elt, idx, NILP (def) ? Qt : def);
		return def;
	      }
892 893
	    insertion_point = tail;
	  }
894 895
	else if (CONSP (elt))
	  {
896 897 898 899 900 901 902 903 904 905
	    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)))
906
	      {
907
		CHECK_IMPURE (elt);
908
		XSETCDR (elt, def);
909 910
		return def;
	      }
911 912 913 914 915 916 917 918 919 920 921 922 923
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		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;
		  }
	      }
924
	  }