keymap.c 112 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
2
   Copyright (C) 1985-1988, 1993-1995, 1998-2011 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
  return Fcons (Qkeymap, Qnil);
}

153 154 155 156 157 158 159 160 161 162 163
DEFUN ("make-composed-keymap", Fmake_composed_keymap, Smake_composed_keymap,
       0, MANY, 0,
       doc: /* Construct and return a new keymap composed of KEYMAPS.
When looking up a key in the returned map, the key is looked in each
keymap in turn until a binding is found.
usage: (make-composed-keymap &rest KEYMAPS)  */)
  (ptrdiff_t nargs, Lisp_Object *args)
{
  return Fcons (Qkeymap, Flist (nargs, args));
}

Jim Blandy's avatar
Jim Blandy committed
164 165 166 167 168
/* This function is used for installing the standard key bindings
   at initialization time.

   For example:

169
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
170 171

void
172
initial_define_key (Lisp_Object keymap, int key, const char *defname)
Jim Blandy's avatar
Jim Blandy committed
173
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
174
  store_in_keymap (keymap, make_number (key), intern_c_string (defname));
Jim Blandy's avatar
Jim Blandy committed
175 176
}

177
void
178
initial_define_lispy_key (Lisp_Object keymap, const char *keyname, const char *defname)
179
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
180
  store_in_keymap (keymap, intern_c_string (keyname), intern_c_string (defname));
181 182
}

Jim Blandy's avatar
Jim Blandy committed
183
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
184 185 186 187 188 189 190
       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
191
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
192
{
193
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
194 195
}

Paul Eggert's avatar
Paul Eggert committed
196
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
197 198 199
       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
200
  (Lisp_Object map)
201
{
202
  map = get_keymap (map, 0, 0);
203 204
  while (CONSP (map))
    {
205
      Lisp_Object tem = XCAR (map);
206 207
      if (STRINGP (tem))
	return tem;
208 209 210 211 212 213
      else if (KEYMAPP (tem))
	{
	  tem = Fkeymap_prompt (tem);
	  if (!NILP (tem))
	    return tem;
	}
214
      map = XCDR (map);
215 216 217 218
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
219
/* Check that OBJECT is a keymap (after dereferencing through any
220 221 222 223
   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.
224
   If AUTOLOAD is nonzero, callers must assume GC is possible.
225

226 227 228
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

229 230 231
   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.
232 233 234 235 236

   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
237 238 239 240
   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.  */
241

Jim Blandy's avatar
Jim Blandy committed
242
Lisp_Object
243
get_keymap (Lisp_Object object, int error_if_not_keymap, int autoload)
Jim Blandy's avatar
Jim Blandy committed
244
{
245
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
246

247
 autoload_retry:
248 249 250 251
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
252

253 254
  tem = indirect_function (object);
  if (CONSP (tem))
255
    {
256 257
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
258

259 260
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
261
      if ((autoload || !error_if_not_keymap) && EQ (XCAR (tem), Qautoload)
262
	  && SYMBOLP (object))
263
	{
264
	  Lisp_Object tail;
265

266 267 268 269 270 271
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
272

273 274 275
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
276

277 278 279
		  goto autoload_retry;
		}
	      else
280
	      	return object;
281
	    }
282
	}
283 284
    }

285
 end:
286
  if (error_if_not_keymap)
Jim Blandy's avatar
Jim Blandy committed
287
    wrong_type_argument (Qkeymapp, object);
288
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
289
}
290

291 292
/* Return the parent map of KEYMAP, or nil if it has none.
   We assume that KEYMAP is a valid keymap.  */
293

294
static Lisp_Object
295
keymap_parent (Lisp_Object keymap, int autoload)
296 297 298
{
  Lisp_Object list;

299
  keymap = get_keymap (keymap, 1, autoload);
300 301

  /* Skip past the initial element `keymap'.  */
302 303
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
304 305
    {
      /* See if there is another `keymap'.  */
306
      if (KEYMAPP (list))
307 308 309
	return list;
    }

310
  return get_keymap (list, 0, autoload);
311 312
}

313
DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
314 315
       doc: /* Return the parent keymap of KEYMAP.
If KEYMAP has no parent, return nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
316
  (Lisp_Object keymap)
317 318 319
{
  return keymap_parent (keymap, 1);
}
320

321
/* Check whether MAP is one of MAPS parents.  */
322
static int
323
keymap_memberp (Lisp_Object map, Lisp_Object maps)
324
{
325
  if (NILP (map)) return 0;
326
  while (KEYMAPP (maps) && !EQ (map, maps))
327
    maps = keymap_parent (maps, 0);
328 329 330
  return (EQ (map, maps));
}

331 332
/* Set the parent keymap of MAP to PARENT.  */

Paul Eggert's avatar
Paul Eggert committed
333
DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
334
       doc: /* Modify KEYMAP to set its parent map to PARENT.
335
Return PARENT.  PARENT should be nil or another keymap.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
336
  (Lisp_Object keymap, Lisp_Object parent)
337 338
{
  Lisp_Object list, prev;
339
  struct gcpro gcpro1, gcpro2;
Jim Blandy's avatar
Jim Blandy committed
340

341 342
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil; where_is_cache_keymaps = Qt;
343

344
  GCPRO2 (keymap, parent);
345
  keymap = get_keymap (keymap, 1, 1);
346

347
  if (!NILP (parent))
348
    {
349
      parent = get_keymap (parent, 1, 0);
350 351

      /* Check for cycles.  */
352
      if (keymap_memberp (keymap, parent))
353 354
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
355

356 357 358 359
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
360
      list = XCDR (prev);
361 362
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
363
      if (!CONSP (list) || KEYMAPP (list))
364
	{
365
	  CHECK_IMPURE (prev);
366
	  XSETCDR (prev, parent);
367
	  RETURN_UNGCPRO (parent);
368 369 370 371 372
	}
      prev = list;
    }
}

373

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

378 379
   MAP must be a keymap or a list of keymaps.

380 381
   If T_OK is non-zero, bindings for Qt are treated as default
   bindings; any key left unmentioned by other tables and bindings is
382
   given the binding of Qt.
383

384 385
   If T_OK is zero, bindings for Qt are not treated specially.

386 387 388 389
   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
390 391

Lisp_Object
392
access_keymap_1 (Lisp_Object map, Lisp_Object idx, int t_ok, int noinherit, int autoload)
Jim Blandy's avatar
Jim Blandy committed
393 394 395 396
{
  /* 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.  */
397
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
398

399 400
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
401
  if (SYMBOLP (idx))
402
    idx = reorder_modifiers (idx);
403 404 405
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
406
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
407

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

437 438 439
  /* 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.  */
440 441
  {
    Lisp_Object tail;
442 443 444
    Lisp_Object t_binding = Qunbound;
    Lisp_Object retval = Qunbound;
    Lisp_Object retval_tail = Qnil;
445
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
446

447
    GCPRO4 (tail, idx, t_binding, retval);
448

449
    for (tail = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
450
	 (CONSP (tail)
451
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
452
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
453
      {
454 455 456 457
	/* 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);
458

459
	if (EQ (binding, Qkeymap))
460
	  {
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
	    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);
488 489 490
	  }
	else if (CONSP (binding))
	  {
491
	    Lisp_Object key = XCAR (binding);
492

493
	    if (EQ (key, idx))
494
	      val = XCDR (binding);
495
	    else if (t_ok && EQ (key, Qt))
496 497
	      {
		t_binding = XCDR (binding);
498
		t_ok = 0;
499
	      }
500 501 502
	  }
	else if (VECTORP (binding))
	  {
503
	    if (INTEGERP (idx) && XFASTINT (idx) < ASIZE (binding))
504
	      val = AREF (binding, XFASTINT (idx));
505
	  }
506 507
	else if (CHAR_TABLE_P (binding))
	  {
508 509 510
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
511
	    if (INTEGERP (idx) && (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0)
512 513 514 515 516 517 518 519
	      {
		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;
	      }
520
	  }
521

522 523 524
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
525 526 527 528 529
	    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;
530

531
	    val = get_keyelt (val, autoload);
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551

	    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));
	      }
552
	  }
553
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
554
      }
555
    UNGCPRO;
556
    return EQ (Qunbound, retval) ? get_keyelt (t_binding, autoload) : retval;
557
  }
Jim Blandy's avatar
Jim Blandy committed
558 559
}

560 561 562 563 564 565 566 567
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;
}

568
static void
569
map_keymap_item (map_keymap_function_t fun, Lisp_Object args, Lisp_Object key, Lisp_Object val, void *data)
570 571 572 573 574 575 576
{
  if (EQ (val, Qt))
    val = Qnil;
  (*fun) (key, val, args, data);
}

static void
577
map_keymap_char_table_item (Lisp_Object args, Lisp_Object key, Lisp_Object val)
578 579 580
{
  if (!NILP (val))
    {
581 582
      map_keymap_function_t fun
	= (map_keymap_function_t) XSAVE_VALUE (XCAR (args))->pointer;
583
      args = XCDR (args);
584 585 586 587
      /* 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));
588 589 590 591 592
      map_keymap_item (fun, XCDR (args), key, val,
		       XSAVE_VALUE (XCAR (args))->pointer);
    }
}

593 594
/* 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).  */
595
static Lisp_Object
596 597 598 599
map_keymap_internal (Lisp_Object map,
		     map_keymap_function_t fun,
		     Lisp_Object args,
		     void *data)
600 601
{
  struct gcpro gcpro1, gcpro2, gcpro3;
602 603
  Lisp_Object tail
    = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
604 605

  GCPRO3 (map, args, tail);
606
  for (; CONSP (tail) && !EQ (Qkeymap, XCAR (tail)); tail = XCDR (tail))
607 608
    {
      Lisp_Object binding = XCAR (tail);
Kenichi Handa's avatar
Kenichi Handa committed
609

610 611 612
      if (KEYMAPP (binding))	/* An embedded parent.  */
	break;
      else if (CONSP (binding))
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
	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
628
	  map_char_table (map_keymap_char_table_item, Qnil, binding,
629
			  Fcons (make_save_value ((void *) fun, 0),
630
				 Fcons (make_save_value (data, 0),
Kenichi Handa's avatar
Kenichi Handa committed
631
					args)));
632 633 634
	}
    }
  UNGCPRO;
635
  return tail;
636 637 638
}

static void
639
map_keymap_call (Lisp_Object key, Lisp_Object val, Lisp_Object fun, void *dummy)
640 641 642 643
{
  call2 (fun, key, val);
}

644
/* Same as map_keymap_internal, but traverses parent keymaps as well.
645 646
   A non-zero AUTOLOAD indicates that autoloaded keymaps should be loaded.  */
void
647
map_keymap (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, void *data, int autoload)
648 649 650 651 652 653
{
  struct gcpro gcpro1;
  GCPRO1 (args);
  map = get_keymap (map, 1, autoload);
  while (CONSP (map))
    {
654 655 656 657 658 659 660 661 662
      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);
663 664 665 666
    }
  UNGCPRO;
}

667
static Lisp_Object Qkeymap_canonicalize;
668 669 670 671

/* Same as map_keymap, but does it right, properly eliminating duplicate
   bindings due to inheritance.   */
void
672
map_keymap_canonical (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, void *data)
673 674 675 676 677 678 679 680 681 682 683
{
  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;
}

684 685 686 687 688
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
689
  (Lisp_Object function, Lisp_Object keymap)
690 691 692 693 694 695 696 697 698
{
  struct gcpro gcpro1;
  GCPRO1 (function);
  keymap = get_keymap (keymap, 1, 1);
  keymap = map_keymap_internal (keymap, map_keymap_call, function, NULL);
  UNGCPRO;
  return keymap;
}

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

704 705
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
706 707
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
708
  (Lisp_Object function, Lisp_Object keymap, Lisp_Object sort_first)
709
{
710
  if (! NILP (sort_first))
711
    return call2 (intern ("map-keymap-sorted"), function, keymap);
712

713 714 715 716
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
717 718 719 720 721 722 723
/* 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,
724 725 726
   remove that.  Also remove a menu help string as second element.

   If AUTOLOAD is nonzero, load autoloadable keymaps
727 728 729
   that are referred to with indirection.

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

Andreas Schwab's avatar
Andreas Schwab committed
731
static Lisp_Object
732
get_keyelt (Lisp_Object object, int autoload)
Jim Blandy's avatar
Jim Blandy committed
733 734 735
{
  while (1)
    {
736 737 738
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
739

740 741 742 743 744 745 746
      /* 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.
747
	 This is a new format menu item.  */
748
      else if (EQ (XCAR (object), Qmenu_item))
749
	{
750
	  if (CONSP (XCDR (object)))
751
	    {
752 753
	      Lisp_Object tem;

754
	      object = XCDR (XCDR (object));
755
	      tem = object;
756 757
	      if (CONSP (object))
		object = XCAR (object);
758 759 760

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
761
		 use.  */
762
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
763
		if (EQ (XCAR (tem), QCfilter) && autoload)
764 765 766 767 768 769 770
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
771 772
	    }
	  else
773
	    /* Invalid keymap.  */
774
	    return object;
775 776
	}

777
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
778 779
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
780
      else if (STRINGP (XCAR (object)))
781
	{
782
	  object = XCDR (object);
783 784
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
785 786
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
787
	  /* Also remove the sublist that caches key equivalences, if any.  */
788
	  if (CONSP (object) && CONSP (XCAR (object)))
789
	    {
790
	      Lisp_Object carcar;
791
	      carcar = XCAR (XCAR (object));
792
	      if (NILP (carcar) || VECTORP (carcar))
793
		object = XCDR (object);
794
	    }
795
	}
Jim Blandy's avatar
Jim Blandy committed
796

797
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
798 799
      else if (KEYMAPP (XCAR (object)))
	error ("Wow, indirect keymap entry!!");
800
      else
801
	return object;
Jim Blandy's avatar
Jim Blandy committed
802 803 804
    }
}

805
static Lisp_Object
806
store_in_keymap (Lisp_Object keymap, register Lisp_Object idx, Lisp_Object def)
Jim Blandy's avatar
Jim Blandy committed
807
{
808 809 810 811
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

812 813 814
  if (EQ (idx, Qkeymap))
    error ("`keymap' is reserved for embedded parent maps");

815
  /* If we are preparing to dump, and DEF is a menu element
816 817
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
818 819
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
820

821
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
822 823
    error ("attempt to define a key in a non-keymap");

824 825 826 827 828 829 830 831 832
  /* 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
833

834 835
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
836
  if (SYMBOLP (idx))
837
    idx = reorder_modifiers (idx);
838 839 840
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
841
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
842 843

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
844
  {
845
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
846

847 848 849 850 851 852
    /* 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.  */
853
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
854

855
    insertion_point = keymap;
856
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
857
      {
858
	Lisp_Object elt;
859

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