keymap.c 110 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
Paul Eggert's avatar
Paul Eggert committed
2
   Copyright (C) 1985-1988, 1993-1995, 1998-2015 Free Software
3
   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 81
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

82 83
/* Pre-allocated 2-element vector for Fcommand_remapping to use.  */
static Lisp_Object command_remapping_vector;
84

85 86 87 88 89
/* 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;

90 91 92 93 94 95 96
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),
97
			  bool, Lisp_Object, Lisp_Object*, bool, bool);
98
static void describe_vector (Lisp_Object, Lisp_Object, Lisp_Object,
99 100
                             void (*) (Lisp_Object, Lisp_Object), bool,
                             Lisp_Object, Lisp_Object, bool, bool);
101
static void silly_event_symbol_error (Lisp_Object);
102
static Lisp_Object get_keyelt (Lisp_Object, bool);
103 104 105 106 107 108

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
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
  Lisp_Object tail;
  if (!NILP (string))
126
    tail = list1 (string);
127 128
  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
    {
      if (!NILP (Vpurify_flag))
	string = Fpurecopy (string);
148
      return list2 (Qkeymap, string);
149
    }
150
  return list1 (Qkeymap);
Jim Blandy's avatar
Jim Blandy committed
151 152 153 154 155 156 157
}

/* 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
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
257
		  Fautoload_do_load (tem, object, Qnil);
258 259 260
		  goto autoload_retry;
		}
	      else
261
	      	return object;
262
	    }
263
	}
264 265
    }

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

275
static Lisp_Object
276
keymap_parent (Lisp_Object keymap, bool autoload)
277 278 279
{
  Lisp_Object list;

280
  keymap = get_keymap (keymap, 1, autoload);
281 282

  /* Skip past the initial element `keymap'.  */
283 284
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
285 286
    {
      /* See if there is another `keymap'.  */
287
      if (KEYMAPP (list))
288 289 290
	return list;
    }

291
  return get_keymap (list, 0, autoload);
292 293
}

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

302
/* Check whether MAP is one of MAPS parents.  */
303
static bool
304
keymap_memberp (Lisp_Object map, Lisp_Object maps)
305
{
306
  if (NILP (map)) return 0;
307
  while (KEYMAPP (maps) && !EQ (map, maps))
308
    maps = keymap_parent (maps, 0);
309 310 311
  return (EQ (map, maps));
}

312 313
/* Set the parent keymap of MAP to PARENT.  */

Paul Eggert's avatar
Paul Eggert committed
314
DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
315
       doc: /* Modify KEYMAP to set its parent map to PARENT.
316
Return PARENT.  PARENT should be nil or another keymap.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
317
  (Lisp_Object keymap, Lisp_Object parent)
318 319
{
  Lisp_Object list, prev;
Jim Blandy's avatar
Jim Blandy committed
320

321 322
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil; where_is_cache_keymaps = Qt;
323

324
  keymap = get_keymap (keymap, 1, 1);
325

326
  if (!NILP (parent))
327
    {
328
      parent = get_keymap (parent, 1, 0);
329 330

      /* Check for cycles.  */
331
      if (keymap_memberp (keymap, parent))
332 333
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
334

335 336 337 338
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
339
      list = XCDR (prev);
340 341
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
342
      if (!CONSP (list) || KEYMAPP (list))
343
	{
344
	  CHECK_IMPURE (prev);
345
	  XSETCDR (prev, parent);
346
	  return parent;
347 348 349 350 351
	}
      prev = list;
    }
}

352

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

357 358
   MAP must be a keymap or a list of keymaps.

359
   If T_OK, bindings for Qt are treated as default
360
   bindings; any key left unmentioned by other tables and bindings is
361
   given the binding of Qt.
362

363
   If not T_OK, bindings for Qt are not treated specially.
364

365 366
   If NOINHERIT, don't accept a subkeymap found in an inherited keymap.

367
   Return Qunbound if no binding was found (and return Qnil if a nil
368
   binding was found).  */
Jim Blandy's avatar
Jim Blandy committed
369

370
static Lisp_Object
371 372
access_keymap_1 (Lisp_Object map, Lisp_Object idx,
		 bool t_ok, bool noinherit, bool autoload)
Jim Blandy's avatar
Jim Blandy committed
373 374 375 376
{
  /* 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.  */
377
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
378

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

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

414 415 416
  /* 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.  */
417 418
  {
    Lisp_Object tail;
419 420 421
    Lisp_Object t_binding = Qunbound;
    Lisp_Object retval = Qunbound;
    Lisp_Object retval_tail = Qnil;
422

423
    for (tail = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
424
	 (CONSP (tail)
425
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
426
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
427
      {
428 429 430 431
	/* 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);
432

433
	if (EQ (binding, Qkeymap))
434
	  {
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
	    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);
462 463 464
	  }
	else if (CONSP (binding))
	  {
465
	    Lisp_Object key = XCAR (binding);
466

467
	    if (EQ (key, idx))
468
	      val = XCDR (binding);
469
	    else if (t_ok && EQ (key, Qt))
470 471
	      {
		t_binding = XCDR (binding);
472
		t_ok = 0;
473
	      }
474 475 476
	  }
	else if (VECTORP (binding))
	  {
477
	    if (INTEGERP (idx) && XFASTINT (idx) < ASIZE (binding))
478
	      val = AREF (binding, XFASTINT (idx));
479
	  }
480 481
	else if (CHAR_TABLE_P (binding))
	  {
482 483 484
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
485
	    if (INTEGERP (idx) && (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0)
486 487
	      {
		val = Faref (binding, idx);
488
		/* nil has a special meaning for char-tables, so
489 490 491 492 493
		   we use something else to record an explicitly
		   unbound entry.  */
		if (NILP (val))
		  val = Qunbound;
	      }
494
	  }
495

496 497 498
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
499 500 501 502 503
	    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;
504

505
	    val = get_keyelt (val, autoload);
506 507 508 509 510 511 512 513 514 515 516 517

	    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))
	      {
518
		XSETCDR (retval_tail, list1 (val));
519 520 521 522
		retval_tail = XCDR (retval_tail);
	      }
	    else
	      {
523
		retval_tail = list1 (val);
524 525
		retval = Fcons (Qkeymap, Fcons (retval, retval_tail));
	      }
526
	  }
527
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
528
      }
529

530
    return EQ (Qunbound, retval) ? get_keyelt (t_binding, autoload) : retval;
531
  }
Jim Blandy's avatar
Jim Blandy committed
532 533
}

534 535
Lisp_Object
access_keymap (Lisp_Object map, Lisp_Object idx,
536
	       bool t_ok, bool noinherit, bool autoload)
537 538 539 540 541
{
  Lisp_Object val = access_keymap_1 (map, idx, t_ok, noinherit, autoload);
  return EQ (val, Qunbound) ? Qnil : val;
}

542
static void
543
map_keymap_item (map_keymap_function_t fun, Lisp_Object args, Lisp_Object key, Lisp_Object val, void *data)
544 545 546 547 548 549 550
{
  if (EQ (val, Qt))
    val = Qnil;
  (*fun) (key, val, args, data);
}

static void
551
map_keymap_char_table_item (Lisp_Object args, Lisp_Object key, Lisp_Object val)
552 553 554
{
  if (!NILP (val))
    {
Paul Eggert's avatar
Paul Eggert committed
555
      map_keymap_function_t fun
556
	= (map_keymap_function_t) XSAVE_FUNCPOINTER (args, 0);
557 558 559 560
      /* 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));
561 562
      map_keymap_item (fun, XSAVE_OBJECT (args, 2), key,
		       val, XSAVE_POINTER (args, 1));
563 564 565
    }
}

566 567
/* 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).  */
568
static Lisp_Object
569 570 571 572
map_keymap_internal (Lisp_Object map,
		     map_keymap_function_t fun,
		     Lisp_Object args,
		     void *data)
573
{
574 575
  Lisp_Object tail
    = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
576

577
  for (; CONSP (tail) && !EQ (Qkeymap, XCAR (tail)); tail = XCDR (tail))
578 579
    {
      Lisp_Object binding = XCAR (tail);
Kenichi Handa's avatar
Kenichi Handa committed
580

581 582 583
      if (KEYMAPP (binding))	/* An embedded parent.  */
	break;
      else if (CONSP (binding))
584 585 586 587 588 589 590 591 592 593 594 595 596 597
	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))
598
	map_char_table (map_keymap_char_table_item, Qnil, binding,
599 600
			make_save_funcptr_ptr_obj ((voidfuncptr) fun, data,
						   args));
601
    }
602

603
  return tail;
604 605 606
}

static void
607
map_keymap_call (Lisp_Object key, Lisp_Object val, Lisp_Object fun, void *dummy)
608 609 610 611
{
  call2 (fun, key, val);
}

612
/* Same as map_keymap_internal, but traverses parent keymaps as well.
613
   AUTOLOAD indicates that autoloaded keymaps should be loaded.  */
614
void
615 616
map_keymap (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args,
	    void *data, bool autoload)
617 618 619 620
{
  map = get_keymap (map, 1, autoload);
  while (CONSP (map))
    {
621 622 623 624 625 626 627 628 629
      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);
630 631 632
    }
}

633 634 635
/* Same as map_keymap, but does it right, properly eliminating duplicate
   bindings due to inheritance.   */
void
636
map_keymap_canonical (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, void *data)
637 638 639 640 641 642 643 644
{
  /* 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);
}

645 646 647 648 649
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
650
  (Lisp_Object function, Lisp_Object keymap)
651 652 653 654 655 656
{
  keymap = get_keymap (keymap, 1, 1);
  keymap = map_keymap_internal (keymap, map_keymap_call, function, NULL);
  return keymap;
}

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

662 663
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
664 665
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
666
  (Lisp_Object function, Lisp_Object keymap, Lisp_Object sort_first)
667
{
668
  if (! NILP (sort_first))
669
    return call2 (intern ("map-keymap-sorted"), function, keymap);
670

671 672 673 674
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
675 676 677 678 679 680 681
/* 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,
682 683
   remove that.  Also remove a menu help string as second element.

684
   If AUTOLOAD, load autoloadable keymaps
685 686 687
   that are referred to with indirection.

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

Andreas Schwab's avatar
Andreas Schwab committed
689
static Lisp_Object
690
get_keyelt (Lisp_Object object, bool autoload)
Jim Blandy's avatar
Jim Blandy committed
691 692 693
{
  while (1)
    {
694 695 696
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
697

698 699
      /* If the keymap contents looks like (menu-item name . DEFN)
	 or (menu-item name DEFN ...) then use DEFN.
700
	 This is a new format menu item.  */
701
      else if (EQ (XCAR (object), Qmenu_item))
702
	{
703
	  if (CONSP (XCDR (object)))
704
	    {
705 706
	      Lisp_Object tem;

707
	      object = XCDR (XCDR (object));
708
	      tem = object;
709 710
	      if (CONSP (object))
		object = XCAR (object);
711 712 713

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
714
		 use.  */
715
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
716
		if (EQ (XCAR (tem), QCfilter) && autoload)
717 718 719 720 721 722 723
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
724 725
	    }
	  else
726
	    /* Invalid keymap.  */
727
	    return object;
728 729
	}

730
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
731 732
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
733
      else if (STRINGP (XCAR (object)))
734
	object = XCDR (object);
Jim Blandy's avatar
Jim Blandy committed
735

736
      else
737
	return object;
Jim Blandy's avatar
Jim Blandy committed
738 739 740
    }
}

741
static Lisp_Object
742
store_in_keymap (Lisp_Object keymap, register Lisp_Object idx, Lisp_Object def)
Jim Blandy's avatar
Jim Blandy committed
743
{
744 745 746 747
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

748 749 750
  if (EQ (idx, Qkeymap))
    error ("`keymap' is reserved for embedded parent maps");

751
  /* If we are preparing to dump, and DEF is a menu element
752 753
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
754 755
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
756

757
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
758 759
    error ("attempt to define a key in a non-keymap");

760 761 762 763 764 765 766 767 768
  /* 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
769

770 771
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
772
  if (SYMBOLP (idx))
773
    idx = reorder_modifiers (idx);
774 775 776
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
777
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
778 779

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
780
  {
781
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
782

783 784 785 786 787 788
    /* 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.  */
789
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
790

791
    insertion_point = keymap;
792
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
793
      {
794
	Lisp_Object elt;
795

796
	elt = XCAR (tail);
797
	if (VECTORP (elt))
798
	  {
799
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
800
	      {
801
		CHECK_IMPURE (elt);
802
		ASET (elt, XFASTINT (idx), def);
803 804
		return def;
	      }
805 806 807 808 809 810 811 812 813 814 815 816 817
	    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;
	      }
818
	    insertion_point = tail;
819
	  }
820 821
	else if (CHAR_TABLE_P (elt))
	  {
822 823 824
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
825
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
826
	      {
827
		Faset (elt, idx,
828
		       /* nil has a special meaning for char-tables, so
829 830 831
			  we use something else to record an explicitly
			  unbound entry.  */
		       NILP (def) ? Qt : def);
832 833
		return def;
	      }
Kenichi Handa's avatar
Kenichi Handa committed
834 835 836 837 838
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		Fset_char_table_range (elt, idx, NILP (def) ? Qt : def);
		return def;
	      }
839 840
	    insertion_point = tail;
	  }
841 842
	else if (CONSP (elt))
	  {
843 844 845 846 847 848 849 850 851 852
	    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)))
853
	      {
854
		CHECK_IMPURE (elt);
855
		XSETCDR (elt, def);
856 857
		return def;
	      }
858 859 860 861 862 863 864 865 866 867 868 869 870
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		int from = XFASTINT (XCAR (idx));
		int to = XFASTINT (XCDR (idx));

		if (from <= XFASTINT (XCAR (elt))
		    && to >= XFASTINT (XCAR (elt)))
		  {
		    XSETCDR (elt, def);
		    if (from == to)
		      return def;
		  }
	      }