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

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
/* Old BUGS:
   - [M-C-a] != [?\M-\C-a]
   - [M-f2] != [?\e f2].
   - (define-key map [menu-bar foo] <bla>) does not always place <bla>
     at the head of the menu (if `foo' was already bound earlier and
     then unbound, for example).
   TODO:
   - allow many more Meta -> ESC mappings (like Hyper -> C-e for Emacspeak)
   - Think about the various defaulting that's currently hard-coded in
     keyboard.c (uppercase->lowercase, char->charset, button-events, ...)
     and make it more generic.  Maybe we should allow mappings of the
     form (PREDICATE . BINDING) as generalization of the default binding,
     tho probably a cleaner way to attack this is to allow functional
     keymaps (i.e. keymaps that are implemented as functions that implement
     a few different methods like `lookup', `map', ...).
   - Make [a] equivalent to [?a].
   BEWARE:
   - map-keymap should work meaningfully even if entries are added/removed
     to the keymap while iterating through it:
       start - removed <= visited <= start + added
 */
Jim Blandy's avatar
Jim Blandy committed
41

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

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

59
/* Actually allocate storage for these variables.  */
Jim Blandy's avatar
Jim Blandy committed
60

61
Lisp_Object current_global_map;	/* Current global keymap.  */
Jim Blandy's avatar
Jim Blandy committed
62

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

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

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

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

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

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

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

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

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

96 97 98 99 100 101 102
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),
103
			  bool, Lisp_Object, Lisp_Object*, bool, bool);
104
static void describe_vector (Lisp_Object, Lisp_Object, Lisp_Object,
105 106
                             void (*) (Lisp_Object, Lisp_Object), bool,
                             Lisp_Object, Lisp_Object, bool, bool);
107
static void silly_event_symbol_error (Lisp_Object);
108
static Lisp_Object get_keyelt (Lisp_Object, bool);
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
   symbols).  If it is, return it.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static void
564
map_keymap_char_table_item (Lisp_Object args, Lisp_Object key, Lisp_Object val)
565 566 567
{
  if (!NILP (val))
    {
Paul Eggert's avatar
Paul Eggert committed
568 569
      map_keymap_function_t fun
	= (map_keymap_function_t) XSAVE_POINTER (args, 0);
570 571 572 573
      /* If the key is a range, make a copy since map_char_table modifies
	 it in place.  */
      if (CONSP (key))
	key = Fcons (XCAR (key), XCDR (key));
574 575
      map_keymap_item (fun, XSAVE_OBJECT (args, 2), key,
		       val, XSAVE_POINTER (args, 1));
576 577 578
    }
}

579 580
/* Call FUN for every binding in MAP and stop at (and return) the parent.
   FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).  */
581
static Lisp_Object
582 583 584 585
map_keymap_internal (Lisp_Object map,
		     map_keymap_function_t fun,
		     Lisp_Object args,
		     void *data)
586 587
{
  struct gcpro gcpro1, gcpro2, gcpro3;
588 589
  Lisp_Object tail
    = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
590 591

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

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

static void
622
map_keymap_call (Lisp_Object key, Lisp_Object val, Lisp_Object fun, void *dummy)
623 624 625 626
{
  call2 (fun, key, val);
}

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

651
static Lisp_Object Qkeymap_canonicalize;
652 653 654 655

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

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

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

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

697 698 699 700
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

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

710
   If AUTOLOAD, load autoloadable keymaps
711 712 713
   that are referred to with indirection.

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

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

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

738
	      object = XCDR (XCDR (object));
739
	      tem = object;
740 741
	      if (CONSP (object))
		object = XCAR (object);
742 743 744

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

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

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

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

796 797 798
  if (EQ (idx, Qkeymap))
    error ("`keymap' is reserved for embedded parent maps");

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

805
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
806 807
    error ("attempt to define a key in a non-keymap");

808 809 810 811 812 813 814 815 816
  /* 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
817

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

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
828
  {
829
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
830

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

839
    insertion_point = keymap;
840
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
841
      {
842
	Lisp_Object elt;
843

844
	elt = XCAR (tail);
845
	if (VECTORP (elt))
846
	  {
847
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
848
	      {
849
		CHECK_IMPURE (elt);
850
		ASET (elt, XFASTINT (idx), def);
851 852
		return def;
	      }
853 854 855 856 857 858 859 860 861 862 863 864 865
	    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;
	      }
866
	    insertion_point = tail;
867
	  }
868 869
	else if (CHAR_TABLE_P (elt))
	  {
870 871 872
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */