keymap.c 118 KB
Newer Older
</
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
                 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
                 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23
#include <stdio.h>
24
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
25 26 27
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Kenichi Handa's avatar
Kenichi Handa committed
28
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
29
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "keyboard.h"
31
#include "frame.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
32
#include "termhooks.h"
33
#include "blockinput.h"
34
#include "puresize.h"
Dave Love's avatar
Dave Love committed
35
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
36
#include "keymap.h"
37
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
38

39
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
#define DENSE_TABLE_SIZE (0200)

/* 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 */

/* was MinibufLocalMap */
Lisp_Object Vminibuffer_local_map;
				/* The keymap used by the minibuf for local
				   bindings when spaces are allowed in the
				   minibuf */

/* was MinibufLocalNSMap */
61
Lisp_Object Vminibuffer_local_ns_map;
Jim Blandy's avatar
Jim Blandy committed
62 63 64 65 66 67 68 69
				/* The keymap used by the minibuf for local
				   bindings when spaces are not encouraged
				   in the minibuf */

/* keymap used for minibuffers when doing completion */
/* was MinibufLocalCompletionMap */
Lisp_Object Vminibuffer_local_completion_map;

70 71 72
/* keymap used for minibuffers when doing completion in filenames */
Lisp_Object Vminibuffer_local_filename_completion_map;

73
/* keymap used for minibuffers when doing completion in filenames
74
   with require-match*/
75
Lisp_Object Vminibuffer_local_filename_must_match_map;
76

Jim Blandy's avatar
Jim Blandy committed
77 78 79 80
/* keymap used for minibuffers when doing completion and require a match */
/* was MinibufLocalMustMatchMap */
Lisp_Object Vminibuffer_local_must_match_map;

Jim Blandy's avatar
Jim Blandy committed
81 82 83
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

84 85 86 87
/* Alist of major-mode-specific overrides for
   minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_overriding_map_alist;

88 89 90
/* List of emulation mode keymap alists.  */
Lisp_Object Vemulation_mode_map_alists;

91 92 93 94 95 96
/* A list of all commands given new bindings since a certain time
   when nil was stored here.
   This is used to speed up recomputation of menu key equivalents
   when Emacs starts up.   t means don't record anything here.  */
Lisp_Object Vdefine_key_rebound_commands;

97
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
98
Lisp_Object QCadvertised_binding;
Jim Blandy's avatar
Jim Blandy committed
99

100 101 102
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

103 104
/* Pre-allocated 2-element vector for Fcommand_remapping to use.  */
static Lisp_Object command_remapping_vector;
105

106 107 108 109 110
/* 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;

111 112 113 114 115 116 117 118 119 120 121 122 123 124
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);
Jim Blandy's avatar
Jim Blandy committed
125

Jim Blandy's avatar
Jim Blandy committed
126 127
/* Keymap object support - constructors and predicates.			*/

128
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
129
       doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
130 131 132 133 134
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.
135 136 137

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
138
  (Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
139
{
140 141 142 143 144
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
145
  return Fcons (Qkeymap,
146
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
147 148
}

149
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
150 151 152 153 154 155 156 157
       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
158
  (Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
159
{
160
  if (!NILP (string))
161 162 163 164 165
    {
      if (!NILP (Vpurify_flag))
	string = Fpurecopy (string);
      return Fcons (Qkeymap, Fcons (string, Qnil));
    }
Jim Blandy's avatar
Jim Blandy committed
166 167 168 169 170 171 172 173
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

174
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
175 176

void
177
initial_define_key (Lisp_Object keymap, int key, char *defname)
Jim Blandy's avatar
Jim Blandy committed
178
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
179
  store_in_keymap (keymap, make_number (key), intern_c_string (defname));
Jim Blandy's avatar
Jim Blandy committed
180 181
}

182
void
183
initial_define_lispy_key (Lisp_Object keymap, char *keyname, char *defname)
184
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
185
  store_in_keymap (keymap, intern_c_string (keyname), intern_c_string (defname));
186 187
}

Jim Blandy's avatar
Jim Blandy committed
188
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
189 190 191 192 193 194 195
       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
196
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
197
{
198
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
199 200
}

201
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
202 203 204
       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
205
  (Lisp_Object map)
206
{
207
  map = get_keymap (map, 0, 0);
208 209
  while (CONSP (map))
    {
210
      Lisp_Object tem = XCAR (map);
211 212
      if (STRINGP (tem))
	return tem;
213
      map = XCDR (map);
214 215 216 217
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
218
/* Check that OBJECT is a keymap (after dereferencing through any
219 220 221 222
   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.
223
   If AUTOLOAD is nonzero, callers must assume GC is possible.
224

225 226 227
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

228 229 230 231 232 233 234
   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
235 236 237 238
   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.  */
239

Jim Blandy's avatar
Jim Blandy committed
240
Lisp_Object
241
get_keymap (Lisp_Object object, int error, int autoload)
Jim Blandy's avatar
Jim Blandy committed
242
{
243
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
244

245
 autoload_retry:
246 247 248 249
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
250

251 252
  tem = indirect_function (object);
  if (CONSP (tem))
253
    {
254 255
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
256

257 258
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
259 260
      if ((autoload || !error) && EQ (XCAR (tem), Qautoload)
	  && SYMBOLP (object))
261
	{
262
	  Lisp_Object tail;
263

264 265 266 267 268 269
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
270

271 272 273
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
274

275 276 277
		  goto autoload_retry;
		}
	      else
278
	      	return object;
279
	    }
280
	}
281 282
    }

283
 end:
Jim Blandy's avatar
Jim Blandy committed
284 285
  if (error)
    wrong_type_argument (Qkeymapp, object);
286
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
287
}
288

289 290
/* Return the parent map of KEYMAP, or nil if it has none.
   We assume that KEYMAP is a valid keymap.  */
291

292
Lisp_Object
293
keymap_parent (Lisp_Object keymap, int autoload)
294 295 296
{
  Lisp_Object list;

297
  keymap = get_keymap (keymap, 1, autoload);
298 299

  /* Skip past the initial element `keymap'.  */
300 301
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
302 303
    {
      /* See if there is another `keymap'.  */
304
      if (KEYMAPP (list))
305 306 307
	return list;
    }

308
  return get_keymap (list, 0, autoload);
309 310
}

311
DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
312 313
       doc: /* Return the parent keymap of KEYMAP.
If KEYMAP has no parent, return nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
314
  (Lisp_Object keymap)
315 316 317
{
  return keymap_parent (keymap, 1);
}
318

319 320
/* Check whether MAP is one of MAPS parents.  */
int
321
keymap_memberp (Lisp_Object map, Lisp_Object maps)
322
{
323
  if (NILP (map)) return 0;
324
  while (KEYMAPP (maps) && !EQ (map, maps))
325
    maps = keymap_parent (maps, 0);
326 327 328
  return (EQ (map, maps));
}

329 330 331
/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
332
       doc: /* Modify KEYMAP to set its parent map to PARENT.
333
Return PARENT.  PARENT should be nil or another keymap.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
334
  (Lisp_Object keymap, Lisp_Object parent)
335 336
{
  Lisp_Object list, prev;
337
  struct gcpro gcpro1, gcpro2;
338
  int i;
Jim Blandy's avatar
Jim Blandy committed
339

340 341 342 343 344 345 346 347 348
  /* 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;

349
  GCPRO2 (keymap, parent);
350
  keymap = get_keymap (keymap, 1, 1);
351

352
  if (!NILP (parent))
353
    {
354
      parent = get_keymap (parent, 1, 1);
355 356

      /* Check for cycles.  */
357
      if (keymap_memberp (keymap, parent))
358 359
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
360

361 362 363 364
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
365
      list = XCDR (prev);
366 367
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
368
      if (!CONSP (list) || KEYMAPP (list))
369
	{
370 371
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
372
	  if (EQ (XCDR (prev), parent))
373
	    RETURN_UNGCPRO (parent);
374

375
	  CHECK_IMPURE (prev);
376
	  XSETCDR (prev, parent);
377 378 379 380 381 382 383
	  break;
	}
      prev = list;
    }

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

384
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
385 386
    {
      /* Stop the scan when we come to the parent.  */
387
      if (EQ (XCAR (list), Qkeymap))
388 389 390
	break;

      /* If this element holds a prefix map, deal with it.  */
391 392 393 394 395 396 397 398
      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]))
399
	    fix_submap_inheritance (keymap, make_number (i),
400
				    XVECTOR (XCAR (list))->contents[i]);
401

402
      if (CHAR_TABLE_P (XCAR (list)))
403
	{
404
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list), keymap);
405
	}
406 407
    }

408
  RETURN_UNGCPRO (parent);
409 410 411 412 413 414
}

/* 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.  */

415
static void
416
fix_submap_inheritance (Lisp_Object map, Lisp_Object event, Lisp_Object submap)
417 418 419 420 421 422
{
  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.  */

423
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
424 425

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

429
  map_parent = keymap_parent (map, 0);
430
  if (!NILP (map_parent))
431
    parent_entry =
432
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
433 434 435
  else
    parent_entry = Qnil;

436
  /* If MAP's parent has something other than a keymap,
437
     our own submap shadows it completely.  */
438
  if (!CONSP (parent_entry))
439
    return;
440

441
  if (! EQ (parent_entry, submap))
442 443 444 445 446 447
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
448

449
	  tem = keymap_parent (submap_parent, 0);
450 451 452 453 454 455 456 457

	  if (KEYMAPP (tem))
	    {
	      if (keymap_memberp (tem, parent_entry))
		/* Fset_keymap_parent could create a cycle.  */
		return;
	      submap_parent = tem;
	    }
458 459 460 461 462
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
463 464
}

Jim Blandy's avatar
Jim Blandy committed
465
/* Look up IDX in MAP.  IDX may be any sort of event.
466
   Note that this does only one level of lookup; IDX must be a single
467
   event, not a sequence.
468 469 470

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

473 474 475
   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
476 477

Lisp_Object
478
access_keymap (Lisp_Object map, Lisp_Object idx, int t_ok, int noinherit, int autoload)
Jim Blandy's avatar
Jim Blandy committed
479
{
480 481 482 483
  Lisp_Object val;

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

Jim Blandy's avatar
Jim Blandy committed
485 486 487
  /* 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.  */
488
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
489

490 491
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
492
  if (SYMBOLP (idx))
493
    idx = reorder_modifiers (idx);
494 495 496
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
497
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
498

499 500 501
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
502 503
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
504 505 506
      struct gcpro gcpro1;
      Lisp_Object meta_map;
      GCPRO1 (map);
507 508
      /* A strange value in which Meta is set would cause
	 infinite recursion.  Protect against that.  */
Stefan Monnier's avatar
Stefan Monnier committed
509
      if (XINT (meta_prefix_char) & CHAR_META)
510
	meta_prefix_char = make_number (27);
511 512 513 514
      meta_map = get_keymap (access_keymap (map, meta_prefix_char,
					    t_ok, noinherit, autoload),
			     0, autoload);
      UNGCPRO;
515
      if (CONSP (meta_map))
516
	{
517
	  map = meta_map;
518 519 520 521 522 523 524 525
	  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;
526 527
    }

528 529 530
  /* 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.  */
531 532
  {
    Lisp_Object tail;
533 534
    Lisp_Object t_binding = Qnil;
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
535

536
    GCPRO4 (map, tail, idx, t_binding);
537

538
    for (tail = XCDR (map);
539
	 (CONSP (tail)
540
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
541
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
542
      {
543
	Lisp_Object binding;
544

545
	binding = XCAR (tail);
546
	if (SYMBOLP (binding))
547
	  {
548 549
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
550
	    if (noinherit && EQ (binding, Qkeymap))
551
	      RETURN_UNGCPRO (Qnil);
552 553 554
	  }
	else if (CONSP (binding))
	  {
555
	    Lisp_Object key = XCAR (binding);
556

557
	    if (EQ (key, idx))
558
	      val = XCDR (binding);
559
	    else if (t_ok && EQ (key, Qt))
560 561
	      {
		t_binding = XCDR (binding);
562
		t_ok = 0;
563
	      }
564 565 566
	  }
	else if (VECTORP (binding))
	  {
567 568
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
	      val = AREF (binding, XFASTINT (idx));
569
	  }
570 571
	else if (CHAR_TABLE_P (binding))
	  {
572 573 574
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
575 576 577 578 579 580 581 582 583
	    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;
	      }
584
	  }
585

586 587 588
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
589 590 591 592 593
	    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;
594 595 596
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
597
	    RETURN_UNGCPRO (val);
598
	  }
599
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
600
      }
601
    UNGCPRO;
602
    return get_keyelt (t_binding, autoload);
603
  }
Jim Blandy's avatar
Jim Blandy committed
604 605
}

606
static void
607
map_keymap_item (map_keymap_function_t fun, Lisp_Object args, Lisp_Object key, Lisp_Object val, void *data)
608 609 610 611 612 613 614 615 616
{
  /* 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
617
map_keymap_char_table_item (Lisp_Object args, Lisp_Object key, Lisp_Object val)
618 619 620 621 622
{
  if (!NILP (val))
    {
      map_keymap_function_t fun = XSAVE_VALUE (XCAR (args))->pointer;
      args = XCDR (args);
623 624 625 626
      /* 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));
627 628 629 630 631
      map_keymap_item (fun, XCDR (args), key, val,
		       XSAVE_VALUE (XCAR (args))->pointer);
    }
}

632 633 634 635 636 637 638
/* 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).  */
Lisp_Object
map_keymap_internal (Lisp_Object map,
		     map_keymap_function_t fun,
		     Lisp_Object args,
		     void *data)
639 640
{
  struct gcpro gcpro1, gcpro2, gcpro3;
641 642
  Lisp_Object tail
    = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
643 644

  GCPRO3 (map, args, tail);
645
  for (; CONSP (tail) && !EQ (Qkeymap, XCAR (tail)); tail = XCDR (tail))
646 647
    {
      Lisp_Object binding = XCAR (tail);
Kenichi Handa's avatar
Kenichi Handa committed
648

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
      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
665
	  map_char_table (map_keymap_char_table_item, Qnil, binding,
666 667
			  Fcons (make_save_value (fun, 0),
				 Fcons (make_save_value (data, 0),
Kenichi Handa's avatar
Kenichi Handa committed
668
					args)));
669 670 671
	}
    }
  UNGCPRO;
672
  return tail;
673 674 675
}

static void
676
map_keymap_call (Lisp_Object key, Lisp_Object val, Lisp_Object fun, void *dummy)
677 678 679 680
{
  call2 (fun, key, val);
}

681 682 683
/* 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
684
map_keymap (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, void *data, int autoload)
685 686 687 688 689 690 691 692 693 694 695 696
{
  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;
}

697 698 699 700 701
Lisp_Object Qkeymap_canonicalize;

/* Same as map_keymap, but does it right, properly eliminating duplicate
   bindings due to inheritance.   */
void
702
map_keymap_canonical (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, void *data)
703 704 705 706 707 708 709 710 711 712 713
{
  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;
}

714 715 716 717 718
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
719
  (Lisp_Object function, Lisp_Object keymap)
720 721 722 723 724 725 726 727 728
{
  struct gcpro gcpro1;
  GCPRO1 (function);
  keymap = get_keymap (keymap, 1, 1);
  keymap = map_keymap_internal (keymap, map_keymap_call, function, NULL);
  UNGCPRO;
  return keymap;
}

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

734 735
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
736 737
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
738
  (Lisp_Object function, Lisp_Object keymap, Lisp_Object sort_first)
739
{
740
  if (! NILP (sort_first))
741
    return call2 (intern ("map-keymap-sorted"), function, keymap);
742

743 744 745 746
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
747 748 749 750 751 752 753
/* 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,
754 755 756
   remove that.  Also remove a menu help string as second element.

   If AUTOLOAD is nonzero, load autoloadable keymaps
757 758 759
   that are referred to with indirection.

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

Lisp_Object
762
get_keyelt (Lisp_Object object, int autoload)
Jim Blandy's avatar
Jim Blandy committed
763 764 765
{
  while (1)
    {
766 767 768
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
769

770 771 772 773 774 775 776
      /* 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.
777
	 This is a new format menu item.  */
778
      else if (EQ (XCAR (object), Qmenu_item))
779
	{
780
	  if (CONSP (XCDR (object)))
781
	    {
782 783
	      Lisp_Object tem;

784
	      object = XCDR (XCDR (object));
785
	      tem = object;
786 787
	      if (CONSP (object))
		object = XCAR (object);
788 789 790

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
791
		 use.  */
792
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
793
		if (EQ (XCAR (tem), QCfilter) && autoload)
794 795 796 797 798 799 800
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
801 802
	    }
	  else
803
	    /* Invalid keymap.  */
804
	    return object;
805 806
	}

807
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
808 809
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
810
      else if (STRINGP (XCAR (object)))
811
	{
812
	  object = XCDR (object);
813 814
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
815 816
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
817
	  /* Also remove the sublist that caches key equivalences, if any.  */
818
	  if (CONSP (object) && CONSP (XCAR (object)))
819
	    {
820
	      Lisp_Object carcar;
821
	      carcar = XCAR (XCAR (object));
822
	      if (NILP (carcar) || VECTORP (carcar))
823
		object = XCDR (object);
824
	    }
825
	}
Jim Blandy's avatar
Jim Blandy committed
826

827 828
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
829
	{
830
	  struct gcpro gcpro1;
831
	  Lisp_Object map;
832
	  GCPRO1 (object);
833
	  map = get_keymap (Fcar_safe (object), 0, autoload);
834
	  UNGCPRO;
835
	  return (!CONSP (map) ? object /* Invalid keymap */
836
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
837
	}
Jim Blandy's avatar
Jim Blandy committed
838 839 840
    }
}

841
static Lisp_Object
842
store_in_keymap (Lisp_Object keymap, register Lisp_Object idx, Lisp_Object def)
Jim Blandy's avatar
Jim Blandy committed
843
{
844 845 846 847
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

848
  /* If we are preparing to dump, and DEF is a menu element
849 850
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
851 852
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
853

854
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
855 856
    error ("attempt to define a key in a non-keymap");

857 858 859 860 861 862 863 864 865
  /* 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
866

867 868
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
869
  if (SYMBOLP (idx))
870
    idx = reorder_modifiers (idx);
871 872 873
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
874
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
875 876

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
877
  {
878
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
879

880 881 882 883 884 885
    /* 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.  */
886
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
887

888
    insertion_point = keymap;
889
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
890
      {
891
	Lisp_Object elt;
892

893
	elt = XCAR (tail);
894
	if (VECTORP (elt))
895
	  {
896
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
897
	      {
898
		CHECK_IMPURE (elt);
899
		ASET (elt, XFASTINT (idx), def);
900 901
		return def;
	      }