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 102 103 104
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,
105
                             Lisp_Object, Lisp_Object, int, int);
106
static void silly_event_symbol_error (Lisp_Object);
Andreas Schwab's avatar
Andreas Schwab committed
107
static Lisp_Object get_keyelt (Lisp_Object, int);
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 210 211
   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.
212
   If AUTOLOAD is nonzero, callers must assume GC is possible.
213

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

217 218 219
   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.
220 221 222 223 224

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

   This function can GC when AUTOLOAD is non-zero, because it calls
228
   Fautoload_do_load which can GC.  */
229

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

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

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

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

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

261
		  GCPRO2 (tem, object);
262
		  Fautoload_do_load (tem, object, Qnil);
263
		  UNGCPRO;
264

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

374 375 376 377
   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
378

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

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

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

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

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

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

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

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

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

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

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

548 549 550 551 552 553 554 555
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;
}

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

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

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

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

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

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

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

655
static Lisp_Object Qkeymap_canonicalize;
656 657 658 659

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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