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

This file is part of GNU Emacs.

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

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

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


20
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
21
#include <stdio.h>
22
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
23 24 25
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Kenichi Handa's avatar
Kenichi Handa committed
26
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
27
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "keyboard.h"
29
#include "frame.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
30
#include "termhooks.h"
31
#include "blockinput.h"
32
#include "puresize.h"
Dave Love's avatar
Dave Love committed
33
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
34
#include "keymap.h"
35
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58

/* Actually allocate storage for these variables */

Lisp_Object current_global_map;	/* Current global keymap */

Lisp_Object global_map;		/* default global key bindings */

Lisp_Object meta_map;		/* The keymap used for globally bound
				   ESC-prefixed default commands */

Lisp_Object control_x_map;	/* The keymap used for globally bound
				   C-x-prefixed default commands */

				/* The keymap used by the minibuf for local
				   bindings when spaces are allowed in the
				   minibuf */

				/* The keymap used by the minibuf for local
				   bindings when spaces are not encouraged
				   in the minibuf */

/* keymap used for minibuffers when doing completion */
/* keymap used for minibuffers when doing completion and require a match */
59
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
60
Lisp_Object QCadvertised_binding;
Jim Blandy's avatar
Jim Blandy committed
61

62 63 64
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

65 66
/* Pre-allocated 2-element vector for Fcommand_remapping to use.  */
static Lisp_Object command_remapping_vector;
67

68 69 70 71 72
/* 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;

73 74 75 76 77 78 79 80 81 82 83 84 85 86
static Lisp_Object store_in_keymap (Lisp_Object, Lisp_Object, Lisp_Object);
static void fix_submap_inheritance (Lisp_Object, Lisp_Object, Lisp_Object);

static Lisp_Object define_as_prefix (Lisp_Object, Lisp_Object);
static void describe_command (Lisp_Object, Lisp_Object);
static void describe_translation (Lisp_Object, Lisp_Object);
static void describe_map (Lisp_Object, Lisp_Object,
                          void (*) (Lisp_Object, Lisp_Object),
			  int, Lisp_Object, Lisp_Object*, int, int);
static void describe_vector (Lisp_Object, Lisp_Object, Lisp_Object,
                             void (*) (Lisp_Object, Lisp_Object), int,
                             Lisp_Object, Lisp_Object, int *,
                             int, int, int);
static void silly_event_symbol_error (Lisp_Object);
Andreas Schwab's avatar
Andreas Schwab committed
87
static Lisp_Object get_keyelt (Lisp_Object, int);
Jim Blandy's avatar
Jim Blandy committed
88

Jim Blandy's avatar
Jim Blandy committed
89 90
/* Keymap object support - constructors and predicates.			*/

91
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
92
       doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
93 94 95 96 97
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.
98 99 100

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
101
  (Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
102
{
103 104 105 106 107
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
108
  return Fcons (Qkeymap,
109
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
110 111
}

112
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
113 114 115 116 117 118 119 120
       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
121
  (Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
122
{
123
  if (!NILP (string))
124 125 126 127 128
    {
      if (!NILP (Vpurify_flag))
	string = Fpurecopy (string);
      return Fcons (Qkeymap, Fcons (string, Qnil));
    }
Jim Blandy's avatar
Jim Blandy committed
129 130 131 132 133 134 135 136
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

137
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
138 139

void
140
initial_define_key (Lisp_Object keymap, int key, const char *defname)
Jim Blandy's avatar
Jim Blandy committed
141
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
142
  store_in_keymap (keymap, make_number (key), intern_c_string (defname));
Jim Blandy's avatar
Jim Blandy committed
143 144
}

145
void
146
initial_define_lispy_key (Lisp_Object keymap, const char *keyname, const char *defname)
147
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
148
  store_in_keymap (keymap, intern_c_string (keyname), intern_c_string (defname));
149 150
}

Jim Blandy's avatar
Jim Blandy committed
151
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
152 153 154 155 156 157 158
       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
159
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
160
{
161
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
162 163
}

164
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
165 166 167
       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
168
  (Lisp_Object map)
169
{
170
  map = get_keymap (map, 0, 0);
171 172
  while (CONSP (map))
    {
173
      Lisp_Object tem = XCAR (map);
174 175
      if (STRINGP (tem))
	return tem;
176
      map = XCDR (map);
177 178 179 180
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
181
/* Check that OBJECT is a keymap (after dereferencing through any
182 183 184 185
   symbols).  If it is, return it.

   If AUTOLOAD is non-zero and OBJECT is a symbol whose function value
   is an autoload form, do the autoload and try again.
186
   If AUTOLOAD is nonzero, callers must assume GC is possible.
187

188 189 190
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

191 192 193 194 195 196 197
   ERROR controls how we respond if OBJECT isn't a keymap.
   If ERROR is non-zero, signal an error; otherwise, just return Qnil.

   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
198 199 200 201
   Fdefine_key should cause keymaps to be autoloaded.

   This function can GC when AUTOLOAD is non-zero, because it calls
   do_autoload which can GC.  */
202

Jim Blandy's avatar
Jim Blandy committed
203
Lisp_Object
204
get_keymap (Lisp_Object object, int error, int autoload)
Jim Blandy's avatar
Jim Blandy committed
205
{
206
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
207

208
 autoload_retry:
209 210 211 212
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
213

214 215
  tem = indirect_function (object);
  if (CONSP (tem))
216
    {
217 218
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
219

220 221
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
222 223
      if ((autoload || !error) && EQ (XCAR (tem), Qautoload)
	  && SYMBOLP (object))
224
	{
225
	  Lisp_Object tail;
226

227 228 229 230 231 232
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
233

234 235 236
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
237

238 239 240
		  goto autoload_retry;
		}
	      else
241
	      	return object;
242
	    }
243
	}
244 245
    }

246
 end:
Jim Blandy's avatar
Jim Blandy committed
247 248
  if (error)
    wrong_type_argument (Qkeymapp, object);
249
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
250
}
251

252 253
/* Return the parent map of KEYMAP, or nil if it has none.
   We assume that KEYMAP is a valid keymap.  */
254

255
static Lisp_Object
256
keymap_parent (Lisp_Object keymap, int autoload)
257 258 259
{
  Lisp_Object list;

260
  keymap = get_keymap (keymap, 1, autoload);
261 262

  /* Skip past the initial element `keymap'.  */
263 264
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
265 266
    {
      /* See if there is another `keymap'.  */
267
      if (KEYMAPP (list))
268 269 270
	return list;
    }

271
  return get_keymap (list, 0, autoload);
272 273
}

274
DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
275 276
       doc: /* Return the parent keymap of KEYMAP.
If KEYMAP has no parent, return nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
277
  (Lisp_Object keymap)
278 279 280
{
  return keymap_parent (keymap, 1);
}
281

282
/* Check whether MAP is one of MAPS parents.  */
283
static int
284
keymap_memberp (Lisp_Object map, Lisp_Object maps)
285
{
286
  if (NILP (map)) return 0;
287
  while (KEYMAPP (maps) && !EQ (map, maps))
288
    maps = keymap_parent (maps, 0);
289 290 291
  return (EQ (map, maps));
}

292 293 294
/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
295
       doc: /* Modify KEYMAP to set its parent map to PARENT.
296
Return PARENT.  PARENT should be nil or another keymap.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
297
  (Lisp_Object keymap, Lisp_Object parent)
298 299
{
  Lisp_Object list, prev;
300
  struct gcpro gcpro1, gcpro2;
301
  int i;
Jim Blandy's avatar
Jim Blandy committed
302

303 304 305 306 307 308 309 310 311
  /* Force a keymap flush for the next call to where-is.
     Since this can be called from within where-is, we don't set where_is_cache
     directly but only where_is_cache_keymaps, since where_is_cache shouldn't
     be changed during where-is, while where_is_cache_keymaps is only used at
     the very beginning of where-is and can thus be changed here without any
     adverse effect.
     This is a very minor correctness (rather than safety) issue.  */
  where_is_cache_keymaps = Qt;

312
  GCPRO2 (keymap, parent);
313
  keymap = get_keymap (keymap, 1, 1);
314

315
  if (!NILP (parent))
316
    {
317
      parent = get_keymap (parent, 1, 1);
318 319

      /* Check for cycles.  */
320
      if (keymap_memberp (keymap, parent))
321 322
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
323

324 325 326 327
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
328
      list = XCDR (prev);
329 330
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
331
      if (!CONSP (list) || KEYMAPP (list))
332
	{
333 334
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
335
	  if (EQ (XCDR (prev), parent))
336
	    RETURN_UNGCPRO (parent);
337

338
	  CHECK_IMPURE (prev);
339
	  XSETCDR (prev, parent);
340 341 342 343 344 345 346
	  break;
	}
      prev = list;
    }

  /* Scan through for submaps, and set their parents too.  */

347
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
348 349
    {
      /* Stop the scan when we come to the parent.  */
350
      if (EQ (XCAR (list), Qkeymap))
351 352 353
	break;

      /* If this element holds a prefix map, deal with it.  */
354 355 356 357 358 359 360 361
      if (CONSP (XCAR (list))
	  && CONSP (XCDR (XCAR (list))))
	fix_submap_inheritance (keymap, XCAR (XCAR (list)),
				XCDR (XCAR (list)));

      if (VECTORP (XCAR (list)))
	for (i = 0; i < XVECTOR (XCAR (list))->size; i++)
	  if (CONSP (XVECTOR (XCAR (list))->contents[i]))
362
	    fix_submap_inheritance (keymap, make_number (i),
363
				    XVECTOR (XCAR (list))->contents[i]);
364

365
      if (CHAR_TABLE_P (XCAR (list)))
366
	{
367
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list), keymap);
368
	}
369 370
    }

371
  RETURN_UNGCPRO (parent);
372 373 374 375 376 377
}

/* EVENT is defined in MAP as a prefix, and SUBMAP is its definition.
   if EVENT is also a prefix in MAP's parent,
   make sure that SUBMAP inherits that definition as its own parent.  */

378
static void
379
fix_submap_inheritance (Lisp_Object map, Lisp_Object event, Lisp_Object submap)
380 381 382 383 384 385
{
  Lisp_Object map_parent, parent_entry;

  /* SUBMAP is a cons that we found as a key binding.
     Discard the other things found in a menu key binding.  */

386
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
387 388

  /* If it isn't a keymap now, there's no work to do.  */
389
  if (!CONSP (submap))
390 391
    return;

392
  map_parent = keymap_parent (map, 0);
393
  if (!NILP (map_parent))
394
    parent_entry =
395
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
396 397 398
  else
    parent_entry = Qnil;

399
  /* If MAP's parent has something other than a keymap,
400
     our own submap shadows it completely.  */
401
  if (!CONSP (parent_entry))
402
    return;
403

404
  if (! EQ (parent_entry, submap))
405 406 407 408 409 410
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
411

412
	  tem = keymap_parent (submap_parent, 0);
413 414 415 416 417 418 419 420

	  if (KEYMAPP (tem))
	    {
	      if (keymap_memberp (tem, parent_entry))
		/* Fset_keymap_parent could create a cycle.  */
		return;
	      submap_parent = tem;
	    }
421 422 423 424 425
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
426 427
}

Jim Blandy's avatar
Jim Blandy committed
428
/* Look up IDX in MAP.  IDX may be any sort of event.
429
   Note that this does only one level of lookup; IDX must be a single
430
   event, not a sequence.
431 432 433

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

436 437 438
   If T_OK is zero, bindings for Qt are not treated specially.

   If NOINHERIT, don't accept a subkeymap found in an inherited keymap.  */
Jim Blandy's avatar
Jim Blandy committed
439 440

Lisp_Object
441
access_keymap (Lisp_Object map, Lisp_Object idx, int t_ok, int noinherit, int autoload)
Jim Blandy's avatar
Jim Blandy committed
442
{
443 444 445 446
  Lisp_Object val;

  /* Qunbound in VAL means we have found no binding yet.  */
  val = Qunbound;
447

Jim Blandy's avatar
Jim Blandy committed
448 449 450
  /* 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.  */
451
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
452

453 454
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
455
  if (SYMBOLP (idx))
456
    idx = reorder_modifiers (idx);
457 458 459
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
460
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
461

462 463 464
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
465 466
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
467 468 469
      struct gcpro gcpro1;
      Lisp_Object meta_map;
      GCPRO1 (map);
470 471
      /* A strange value in which Meta is set would cause
	 infinite recursion.  Protect against that.  */
Stefan Monnier's avatar
Stefan Monnier committed
472
      if (XINT (meta_prefix_char) & CHAR_META)
473
	meta_prefix_char = make_number (27);
474 475 476 477
      meta_map = get_keymap (access_keymap (map, meta_prefix_char,
					    t_ok, noinherit, autoload),
			     0, autoload);
      UNGCPRO;
478
      if (CONSP (meta_map))
479
	{
480
	  map = meta_map;
481 482 483 484 485 486 487 488
	  idx = make_number (XUINT (idx) & ~meta_modifier);
	}
      else if (t_ok)
	/* Set IDX to t, so that we only find a default binding.  */
	idx = Qt;
      else
	/* We know there is no binding.  */
	return Qnil;
489 490
    }

491 492 493
  /* 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.  */
494 495
  {
    Lisp_Object tail;
496 497
    Lisp_Object t_binding = Qnil;
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
498

499
    GCPRO4 (map, tail, idx, t_binding);
500

501
    for (tail = XCDR (map);
502
	 (CONSP (tail)
503
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
504
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
505
      {
506
	Lisp_Object binding;
507

508
	binding = XCAR (tail);
509
	if (SYMBOLP (binding))
510
	  {
511 512
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
513
	    if (noinherit && EQ (binding, Qkeymap))
514
	      RETURN_UNGCPRO (Qnil);
515 516 517
	  }
	else if (CONSP (binding))
	  {
518
	    Lisp_Object key = XCAR (binding);
519

520
	    if (EQ (key, idx))
521
	      val = XCDR (binding);
522
	    else if (t_ok && EQ (key, Qt))
523 524
	      {
		t_binding = XCDR (binding);
525
		t_ok = 0;
526
	      }
527 528 529
	  }
	else if (VECTORP (binding))
	  {
530 531
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
	      val = AREF (binding, XFASTINT (idx));
532
	  }
533 534
	else if (CHAR_TABLE_P (binding))
	  {
535 536 537
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
538 539 540 541 542 543 544 545 546
	    if (NATNUMP (idx) && (XFASTINT (idx) & CHAR_MODIFIER_MASK) == 0)
	      {
		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;
	      }
547
	  }
548

549 550 551
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
552 553 554 555 556
	    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;
557 558 559
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
560
	    RETURN_UNGCPRO (val);
561
	  }
562
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
563
      }
564
    UNGCPRO;
565
    return get_keyelt (t_binding, autoload);
566
  }
Jim Blandy's avatar
Jim Blandy committed
567 568
}

569
static void
570
map_keymap_item (map_keymap_function_t fun, Lisp_Object args, Lisp_Object key, Lisp_Object val, void *data)
571 572 573 574 575 576 577 578 579
{
  /* We should maybe try to detect bindings shadowed by previous
     ones and things like that.  */
  if (EQ (val, Qt))
    val = Qnil;
  (*fun) (key, val, args, data);
}

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

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

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

613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
      if (CONSP (binding))
	map_keymap_item (fun, args, XCAR (binding), XCDR (binding), data);
      else if (VECTORP (binding))
	{
	  /* Loop over the char values represented in the vector.  */
	  int len = ASIZE (binding);
	  int c;
	  for (c = 0; c < len; c++)
	    {
	      Lisp_Object character;
	      XSETFASTINT (character, c);
	      map_keymap_item (fun, args, character, AREF (binding, c), data);
	    }
	}
      else if (CHAR_TABLE_P (binding))
	{
Kenichi Handa's avatar
Kenichi Handa committed
629
	  map_char_table (map_keymap_char_table_item, Qnil, binding,
630
			  Fcons (make_save_value ((void *) fun, 0),
631
				 Fcons (make_save_value (data, 0),
Kenichi Handa's avatar
Kenichi Handa committed
632
					args)));
633 634 635
	}
    }
  UNGCPRO;
636
  return tail;
637 638 639
}

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

645 646 647
/* Same as map_keymap_internal, but doesn't traverses parent keymaps as well.
   A non-zero AUTOLOAD indicates that autoloaded keymaps should be loaded.  */
void
648
map_keymap (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, void *data, int autoload)
649 650 651 652 653 654 655 656 657 658 659 660
{
  struct gcpro gcpro1;
  GCPRO1 (args);
  map = get_keymap (map, 1, autoload);
  while (CONSP (map))
    {
      map = map_keymap_internal (map, fun, args, data);
      map = get_keymap (map, 0, autoload);
    }
  UNGCPRO;
}

661 662 663 664 665
Lisp_Object Qkeymap_canonicalize;

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

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

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

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

707 708 709 710
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
711 712 713 714 715 716 717
/* 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,
718 719 720
   remove that.  Also remove a menu help string as second element.

   If AUTOLOAD is nonzero, load autoloadable keymaps
721 722 723
   that are referred to with indirection.

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

Andreas Schwab's avatar
Andreas Schwab committed
725
static Lisp_Object
726
get_keyelt (Lisp_Object object, int autoload)
Jim Blandy's avatar
Jim Blandy committed
727 728 729
{
  while (1)
    {
730 731 732
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
733

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

748
	      object = XCDR (XCDR (object));
749
	      tem = object;
750 751
	      if (CONSP (object))
		object = XCAR (object);
752 753 754

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

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

791 792
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
793
	{
794
	  struct gcpro gcpro1;
795
	  Lisp_Object map;
796
	  GCPRO1 (object);
797
	  map = get_keymap (Fcar_safe (object), 0, autoload);
798
	  UNGCPRO;
799
	  return (!CONSP (map) ? object /* Invalid keymap */
800
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
801
	}
Jim Blandy's avatar
Jim Blandy committed
802 803 804
    }
}

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

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

818
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
819 820
    error ("attempt to define a key in a non-keymap");

821 822 823 824 825 826 827 828 829
  /* 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
830

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

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
841
  {
842
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
843

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

852
    insertion_point = keymap;
853
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
854
      {
855
	Lisp_Object elt;
856

857
	elt = XCAR (tail);
858
	if (VECTORP (elt))
859
	  {
860
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
861
	      {
862
		CHECK_IMPURE (elt);
863
		ASET (elt, XFASTINT (idx), def);
864 865
		return def;
	      }
866 867 868 869 870 871 872 873 874 875 876 877 878
	    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;
	      }
879
	    insertion_point = tail;
880
	  }
881 882
	else if (CHAR_TABLE_P (elt))
	  {
883 884 885
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
886
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
887
	      {
888 889 890