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);
109 110 111 112 113 114

static void
CHECK_VECTOR_OR_CHAR_TABLE (Lisp_Object x)
{
  CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x);
}
Jim Blandy's avatar
Jim Blandy committed
115

Jim Blandy's avatar
Jim Blandy committed
116 117
/* Keymap object support - constructors and predicates.			*/

118
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
119
       doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
120 121 122 123 124
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.
125 126 127

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
128
  (Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
129
{
130 131 132 133 134
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
135
  return Fcons (Qkeymap,
136
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
137 138
}

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

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

   For example:

164
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
165 166

void
167
initial_define_key (Lisp_Object keymap, int key, const char *defname)
Jim Blandy's avatar
Jim Blandy committed
168
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
169
  store_in_keymap (keymap, make_number (key), intern_c_string (defname));
Jim Blandy's avatar
Jim Blandy committed
170 171
}

172
void
173
initial_define_lispy_key (Lisp_Object keymap, const char *keyname, const char *defname)
174
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
175
  store_in_keymap (keymap, intern_c_string (keyname), intern_c_string (defname));
176 177
}

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

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

Jim Blandy's avatar
Jim Blandy committed
214
/* Check that OBJECT is a keymap (after dereferencing through any
215 216
   symbols).  If it is, return it.

217
   If AUTOLOAD and if OBJECT is a symbol whose function value
218
   is an autoload form, do the autoload and try again.
219
   If AUTOLOAD, callers must assume GC is possible.
220

221
   ERROR_IF_NOT_KEYMAP controls how we respond if OBJECT isn't a keymap.
222
   If ERROR_IF_NOT_KEYMAP, signal an error; otherwise,
223
   just return Qnil.
224 225 226 227 228

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

231
   This function can GC when AUTOLOAD is true, because it calls
232
   Fautoload_do_load which can GC.  */
233

Jim Blandy's avatar
Jim Blandy committed
234
Lisp_Object
235
get_keymap (Lisp_Object object, bool error_if_not_keymap, bool autoload)
Jim Blandy's avatar
Jim Blandy committed
236
{
237
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
238

239
 autoload_retry:
240 241 242 243
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
244

245 246
  tem = indirect_function (object);
  if (CONSP (tem))
247
    {
248 249
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
250

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

258 259 260 261 262 263
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
264

265
		  GCPRO2 (tem, object);
266
		  Fautoload_do_load (tem, object, Qnil);
267
		  UNGCPRO;
268

269 270 271
		  goto autoload_retry;
		}
	      else
272
	      	return object;
273
	    }
274
	}
275 276
    }

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

286
static Lisp_Object
287
keymap_parent (Lisp_Object keymap, bool autoload)
288 289 290
{
  Lisp_Object list;

291
  keymap = get_keymap (keymap, 1, autoload);
292 293

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

302
  return get_keymap (list, 0, autoload);
303 304
}

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

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

323 324
/* Set the parent keymap of MAP to PARENT.  */

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

333 334
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil; where_is_cache_keymaps = Qt;
335

336
  GCPRO2 (keymap, parent);
337
  keymap = get_keymap (keymap, 1, 1);
338

339
  if (!NILP (parent))
340
    {
341
      parent = get_keymap (parent, 1, 0);
342 343

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

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

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

370 371
   MAP must be a keymap or a list of keymaps.

372
   If T_OK, bindings for Qt are treated as default
373
   bindings; any key left unmentioned by other tables and bindings is
374
   given the binding of Qt.
375

376
   If not T_OK, bindings for Qt are not treated specially.
377

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

380
   Return Qunbound if no binding was found (and return Qnil if a nil
381
   binding was found).  */
Jim Blandy's avatar
Jim Blandy committed
382

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

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

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

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

440
    GCPRO4 (tail, idx, t_binding, retval);
441

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

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

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

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

524
	    val = get_keyelt (val, autoload);
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

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

553 554
Lisp_Object
access_keymap (Lisp_Object map, Lisp_Object idx,
555
	       bool t_ok, bool noinherit, bool autoload)
556 557 558 559 560
{
  Lisp_Object val = access_keymap_1 (map, idx, t_ok, noinherit, autoload);
  return EQ (val, Qunbound) ? Qnil : val;
}

561
static void
562
map_keymap_item (map_keymap_function_t fun, Lisp_Object args, Lisp_Object key, Lisp_Object val, void *data)
563 564 565 566 567 568 569
{
  if (EQ (val, Qt))
    val = Qnil;
  (*fun) (key, val, args, data);
}

static void
570
map_keymap_char_table_item (Lisp_Object args, Lisp_Object key, Lisp_Object val)
571 572 573
{
  if (!NILP (val))
    {
Paul Eggert's avatar
Paul Eggert committed
574
      map_keymap_function_t fun
575
	= (map_keymap_function_t) XSAVE_FUNCPOINTER (args, 0);
576 577 578 579
      /* 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));
580 581
      map_keymap_item (fun, XSAVE_OBJECT (args, 2), key,
		       val, XSAVE_POINTER (args, 1));
582 583 584
    }
}

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

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

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

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

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

657
static Lisp_Object Qkeymap_canonicalize;
658 659 660 661

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

850
	elt = XCAR (tail);
851
	if (VECTORP (elt))
852
	  {
853
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
854
	      {
855
		CHECK_IMPURE (elt);
856
		ASET (elt, XFASTINT (idx), def);
857 858
		return def;
	      }
859 860 861 862 863 864 865 866 867 868 869 870 871
	    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;
	      }
872
	    insertion_point = tail;