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 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>
25 26 27
#if HAVE_ALLOCA_H
# include <alloca.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
28 29 30
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Kenichi Handa's avatar
Kenichi Handa committed
31
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
32
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
33
#include "keyboard.h"
34
#include "frame.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
35
#include "termhooks.h"
36
#include "blockinput.h"
37
#include "puresize.h"
Dave Love's avatar
Dave Love committed
38
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
39
#include "keymap.h"
40
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
41

42
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
#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 */
64
Lisp_Object Vminibuffer_local_ns_map;
Jim Blandy's avatar
Jim Blandy committed
65 66 67 68 69 70 71 72
				/* 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;

73 74 75
/* keymap used for minibuffers when doing completion in filenames */
Lisp_Object Vminibuffer_local_filename_completion_map;

76
/* keymap used for minibuffers when doing completion in filenames
77
   with require-match*/
78
Lisp_Object Vminibuffer_local_filename_must_match_map;
79

Jim Blandy's avatar
Jim Blandy committed
80 81 82 83
/* 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
84 85 86
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

87 88 89 90
/* Alist of major-mode-specific overrides for
   minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_overriding_map_alist;

91 92 93
/* List of emulation mode keymap alists.  */
Lisp_Object Vemulation_mode_map_alists;

94 95 96 97 98 99
/* 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;

100
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
101
Lisp_Object QCadvertised_binding;
Jim Blandy's avatar
Jim Blandy committed
102

103 104 105
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

106 107
/* Pre-allocated 2-element vector for Fcommand_remapping to use.  */
static Lisp_Object command_remapping_vector;
108

Jim Blandy's avatar
Jim Blandy committed
109 110 111
/* A char with the CHAR_META bit set in a vector or the 0200 bit set
   in a string key sequence is equivalent to prefixing with this
   character.  */
Jim Blandy's avatar
Jim Blandy committed
112 113
extern Lisp_Object meta_prefix_char;

114 115
extern Lisp_Object Voverriding_local_map;

116 117 118 119 120
/* 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;

121 122 123 124
static Lisp_Object store_in_keymap P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
static void fix_submap_inheritance P_ ((Lisp_Object, Lisp_Object, Lisp_Object));

static Lisp_Object define_as_prefix P_ ((Lisp_Object, Lisp_Object));
125 126
static void describe_command P_ ((Lisp_Object, Lisp_Object));
static void describe_translation P_ ((Lisp_Object, Lisp_Object));
127
static void describe_map P_ ((Lisp_Object, Lisp_Object,
128
			      void (*) P_ ((Lisp_Object, Lisp_Object)),
129
			      int, Lisp_Object, Lisp_Object*, int, int));
130 131
static void describe_vector P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
				 void (*) (Lisp_Object, Lisp_Object), int,
132 133
				 Lisp_Object, Lisp_Object, int *,
				 int, int, int));
134
static void silly_event_symbol_error P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
135

Jim Blandy's avatar
Jim Blandy committed
136 137
/* Keymap object support - constructors and predicates.			*/

138
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
139
       doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
140 141 142 143 144
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.
145 146 147 148

The optional arg STRING supplies a menu name for the keymap
in case you use it as a menu with `x-popup-menu'.  */)
     (string)
149
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
150
{
151 152 153 154 155
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
156
  return Fcons (Qkeymap,
157
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
158 159
}

160
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
161 162 163 164 165 166 167 168 169
       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'.  */)
     (string)
170
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
171
{
172
  if (!NILP (string))
173 174 175 176 177
    {
      if (!NILP (Vpurify_flag))
	string = Fpurecopy (string);
      return Fcons (Qkeymap, Fcons (string, Qnil));
    }
Jim Blandy's avatar
Jim Blandy committed
178 179 180 181 182 183 184 185
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

186
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
187 188 189 190 191 192 193 194 195 196

void
initial_define_key (keymap, key, defname)
     Lisp_Object keymap;
     int key;
     char *defname;
{
  store_in_keymap (keymap, make_number (key), intern (defname));
}

197 198 199 200 201 202 203 204 205
void
initial_define_lispy_key (keymap, keyname, defname)
     Lisp_Object keymap;
     char *keyname;
     char *defname;
{
  store_in_keymap (keymap, intern (keyname), intern (defname));
}

Jim Blandy's avatar
Jim Blandy committed
206
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
207 208 209 210 211 212 213 214
       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.  */)
     (object)
Jim Blandy's avatar
Jim Blandy committed
215 216
     Lisp_Object object;
{
217
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
218 219
}

220
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
221 222 223 224
       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.  */)
     (map)
225 226
     Lisp_Object map;
{
227
  map = get_keymap (map, 0, 0);
228 229
  while (CONSP (map))
    {
230
      Lisp_Object tem = XCAR (map);
231 232
      if (STRINGP (tem))
	return tem;
233
      map = XCDR (map);
234 235 236 237
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
238
/* Check that OBJECT is a keymap (after dereferencing through any
239 240 241 242
   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.
243
   If AUTOLOAD is nonzero, callers must assume GC is possible.
244

245 246 247
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

248 249 250 251 252 253 254
   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
255 256 257 258
   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.  */
259

Jim Blandy's avatar
Jim Blandy committed
260
Lisp_Object
261
get_keymap (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
262
     Lisp_Object object;
263
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
264
{
265
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
266

267
 autoload_retry:
268 269 270 271
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
272

273 274
  tem = indirect_function (object);
  if (CONSP (tem))
275
    {
276 277
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
278

279 280
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
281 282
      if ((autoload || !error) && EQ (XCAR (tem), Qautoload)
	  && SYMBOLP (object))
283
	{
284
	  Lisp_Object tail;
285

286 287 288 289 290 291
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
292

293 294 295
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
296

297 298 299
		  goto autoload_retry;
		}
	      else
300
	      	return object;
301
	    }
302
	}
303 304
    }

305
 end:
Jim Blandy's avatar
Jim Blandy committed
306 307
  if (error)
    wrong_type_argument (Qkeymapp, object);
308
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
309
}
310

311 312
/* Return the parent map of KEYMAP, or nil if it has none.
   We assume that KEYMAP is a valid keymap.  */
313

314 315
Lisp_Object
keymap_parent (keymap, autoload)
316
     Lisp_Object keymap;
317
     int autoload;
318 319 320
{
  Lisp_Object list;

321
  keymap = get_keymap (keymap, 1, autoload);
322 323

  /* Skip past the initial element `keymap'.  */
324 325
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
326 327
    {
      /* See if there is another `keymap'.  */
328
      if (KEYMAPP (list))
329 330 331
	return list;
    }

332
  return get_keymap (list, 0, autoload);
333 334
}

335
DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
336 337
       doc: /* Return the parent keymap of KEYMAP.
If KEYMAP has no parent, return nil.  */)
338 339 340 341 342
     (keymap)
     Lisp_Object keymap;
{
  return keymap_parent (keymap, 1);
}
343

344 345 346 347 348
/* Check whether MAP is one of MAPS parents.  */
int
keymap_memberp (map, maps)
     Lisp_Object map, maps;
{
349
  if (NILP (map)) return 0;
350
  while (KEYMAPP (maps) && !EQ (map, maps))
351
    maps = keymap_parent (maps, 0);
352 353 354
  return (EQ (map, maps));
}

355 356 357
/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
358
       doc: /* Modify KEYMAP to set its parent map to PARENT.
359
Return PARENT.  PARENT should be nil or another keymap.  */)
360
     (keymap, parent)
361 362 363
     Lisp_Object keymap, parent;
{
  Lisp_Object list, prev;
364
  struct gcpro gcpro1, gcpro2;
365
  int i;
Jim Blandy's avatar
Jim Blandy committed
366

367 368 369 370 371 372 373 374 375
  /* 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;

376
  GCPRO2 (keymap, parent);
377
  keymap = get_keymap (keymap, 1, 1);
378

379
  if (!NILP (parent))
380
    {
381
      parent = get_keymap (parent, 1, 1);
382 383

      /* Check for cycles.  */
384
      if (keymap_memberp (keymap, parent))
385 386
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
387

388 389 390 391
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
392
      list = XCDR (prev);
393 394
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
395
      if (!CONSP (list) || KEYMAPP (list))
396
	{
397 398
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
399
	  if (EQ (XCDR (prev), parent))
400
	    RETURN_UNGCPRO (parent);
401

402
	  CHECK_IMPURE (prev);
403
	  XSETCDR (prev, parent);
404 405 406 407 408 409 410
	  break;
	}
      prev = list;
    }

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

411
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
412 413
    {
      /* Stop the scan when we come to the parent.  */
414
      if (EQ (XCAR (list), Qkeymap))
415 416 417
	break;

      /* If this element holds a prefix map, deal with it.  */
418 419 420 421 422 423 424 425
      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]))
426
	    fix_submap_inheritance (keymap, make_number (i),
427
				    XVECTOR (XCAR (list))->contents[i]);
428

429
      if (CHAR_TABLE_P (XCAR (list)))
430
	{
431
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list), keymap);
432
	}
433 434
    }

435
  RETURN_UNGCPRO (parent);
436 437 438 439 440 441
}

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

442
static void
443 444 445 446 447 448 449 450
fix_submap_inheritance (map, event, submap)
     Lisp_Object map, event, submap;
{
  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.  */

451
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
452 453

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

457
  map_parent = keymap_parent (map, 0);
458
  if (!NILP (map_parent))
459
    parent_entry =
460
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
461 462 463
  else
    parent_entry = Qnil;

464
  /* If MAP's parent has something other than a keymap,
465
     our own submap shadows it completely.  */
466
  if (!CONSP (parent_entry))
467
    return;
468

469
  if (! EQ (parent_entry, submap))
470 471 472 473 474 475
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
476

477
	  tem = keymap_parent (submap_parent, 0);
478 479 480 481 482 483 484 485

	  if (KEYMAPP (tem))
	    {
	      if (keymap_memberp (tem, parent_entry))
		/* Fset_keymap_parent could create a cycle.  */
		return;
	      submap_parent = tem;
	    }
486 487 488 489 490
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
491 492
}

Jim Blandy's avatar
Jim Blandy committed
493
/* Look up IDX in MAP.  IDX may be any sort of event.
494
   Note that this does only one level of lookup; IDX must be a single
495
   event, not a sequence.
496 497 498

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

501 502 503
   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
504 505

Lisp_Object
506
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
507 508
     Lisp_Object map;
     Lisp_Object idx;
509
     int t_ok;
510
     int noinherit;
511
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
512
{
513 514 515 516
  Lisp_Object val;

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

Jim Blandy's avatar
Jim Blandy committed
518 519 520
  /* 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.  */
521
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
522

523 524
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
525
  if (SYMBOLP (idx))
526
    idx = reorder_modifiers (idx);
527 528 529
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
530
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
531

532 533 534
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
535 536
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
537 538 539
      struct gcpro gcpro1;
      Lisp_Object meta_map;
      GCPRO1 (map);
540 541
      /* A strange value in which Meta is set would cause
	 infinite recursion.  Protect against that.  */
Stefan Monnier's avatar
Stefan Monnier committed
542
      if (XINT (meta_prefix_char) & CHAR_META)
543
	meta_prefix_char = make_number (27);
544 545 546 547
      meta_map = get_keymap (access_keymap (map, meta_prefix_char,
					    t_ok, noinherit, autoload),
			     0, autoload);
      UNGCPRO;
548
      if (CONSP (meta_map))
549
	{
550
	  map = meta_map;
551 552 553 554 555 556 557 558
	  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;
559 560
    }

561 562 563
  /* 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.  */
564 565
  {
    Lisp_Object tail;
566 567
    Lisp_Object t_binding = Qnil;
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
568

569
    GCPRO4 (map, tail, idx, t_binding);
570

571
    for (tail = XCDR (map);
572
	 (CONSP (tail)
573
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
574
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
575
      {
576
	Lisp_Object binding;
577

578
	binding = XCAR (tail);
579
	if (SYMBOLP (binding))
580
	  {
581 582
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
583
	    if (noinherit && EQ (binding, Qkeymap))
584
	      RETURN_UNGCPRO (Qnil);
585 586 587
	  }
	else if (CONSP (binding))
	  {
588
	    Lisp_Object key = XCAR (binding);
589

590
	    if (EQ (key, idx))
591
	      val = XCDR (binding);
592
	    else if (t_ok && EQ (key, Qt))
593 594
	      {
		t_binding = XCDR (binding);
595
		t_ok = 0;
596
	      }
597 598 599
	  }
	else if (VECTORP (binding))
	  {
600 601
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
	      val = AREF (binding, XFASTINT (idx));
602
	  }
603 604
	else if (CHAR_TABLE_P (binding))
	  {
605 606 607
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
608 609 610 611 612 613 614 615 616
	    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;
	      }
617
	  }
618

619 620 621
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
622 623 624 625 626
	    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;
627 628 629
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
630
	    RETURN_UNGCPRO (val);
631
	  }
632
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
633
      }
634
    UNGCPRO;
635
    return get_keyelt (t_binding, autoload);
636
  }
Jim Blandy's avatar
Jim Blandy committed
637 638
}

639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
static void
map_keymap_item (fun, args, key, val, data)
     map_keymap_function_t fun;
     Lisp_Object args, key, val;
     void *data;
{
  /* 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
map_keymap_char_table_item (args, key, val)
     Lisp_Object args, key, val;
{
  if (!NILP (val))
    {
      map_keymap_function_t fun = XSAVE_VALUE (XCAR (args))->pointer;
      args = XCDR (args);
660 661 662 663
      /* 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));
664 665 666 667 668
      map_keymap_item (fun, XCDR (args), key, val,
		       XSAVE_VALUE (XCAR (args))->pointer);
    }
}

669 670 671 672 673 674 675
/* 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)
676 677
{
  struct gcpro gcpro1, gcpro2, gcpro3;
678 679
  Lisp_Object tail
    = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
680 681

  GCPRO3 (map, args, tail);
682
  for (; CONSP (tail) && !EQ (Qkeymap, XCAR (tail)); tail = XCDR (tail))
683 684
    {
      Lisp_Object binding = XCAR (tail);
Kenichi Handa's avatar
Kenichi Handa committed
685

686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701
      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
702
	  map_char_table (map_keymap_char_table_item, Qnil, binding,
703 704
			  Fcons (make_save_value (fun, 0),
				 Fcons (make_save_value (data, 0),
Kenichi Handa's avatar
Kenichi Handa committed
705
					args)));
706 707 708
	}
    }
  UNGCPRO;
709
  return tail;
710 711 712 713 714 715 716 717 718 719
}

static void
map_keymap_call (key, val, fun, dummy)
     Lisp_Object key, val, fun;
     void *dummy;
{
  call2 (fun, key, val);
}

720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
/* 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
map_keymap (map, fun, args, data, autoload)
     map_keymap_function_t fun;
     Lisp_Object map, args;
     void *data;
     int autoload;
{
  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;
}

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
Lisp_Object Qkeymap_canonicalize;

/* Same as map_keymap, but does it right, properly eliminating duplicate
   bindings due to inheritance.   */
void
map_keymap_canonical (map, fun, args, data)
     map_keymap_function_t fun;
     Lisp_Object map, args;
     void *data;
{
  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;
}

760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
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.  */)
     (function, keymap)
     Lisp_Object function, keymap;
{
  struct gcpro gcpro1;
  GCPRO1 (function);
  keymap = get_keymap (keymap, 1, 1);
  keymap = map_keymap_internal (keymap, map_keymap_call, function, NULL);
  UNGCPRO;
  return keymap;
}

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

781 782
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
783 784 785 786
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
     (function, keymap, sort_first)
     Lisp_Object function, keymap, sort_first;
787
{
788
  if (! NILP (sort_first))
789
    return call2 (intern ("map-keymap-sorted"), function, keymap);
790

791 792 793 794
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
795 796 797 798 799 800 801
/* 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,
802 803 804
   remove that.  Also remove a menu help string as second element.

   If AUTOLOAD is nonzero, load autoloadable keymaps
805 806 807
   that are referred to with indirection.

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

Lisp_Object
810
get_keyelt (object, autoload)
811
     Lisp_Object object;
812
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
813 814 815
{
  while (1)
    {
816 817 818
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
819

820 821 822 823 824 825 826
      /* 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.
827
	 This is a new format menu item.  */
828
      else if (EQ (XCAR (object), Qmenu_item))
829
	{
830
	  if (CONSP (XCDR (object)))
831
	    {
832 833
	      Lisp_Object tem;

834
	      object = XCDR (XCDR (object));
835
	      tem = object;
836 837
	      if (CONSP (object))
		object = XCAR (object);
838 839 840

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
841
		 use.  */
842
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
843
		if (EQ (XCAR (tem), QCfilter) && autoload)
844 845 846 847 848 849 850
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
851 852
	    }
	  else
853
	    /* Invalid keymap.  */
854
	    return object;
855 856
	}

857
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
858 859
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
860
      else if (STRINGP (XCAR (object)))
861
	{
862
	  object = XCDR (object);
863 864
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
865 866
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
867
	  /* Also remove the sublist that caches key equivalences, if any.  */
868
	  if (CONSP (object) && CONSP (XCAR (object)))
869
	    {
870
	      Lisp_Object carcar;
871
	      carcar = XCAR (XCAR (object));
872
	      if (NILP (carcar) || VECTORP (carcar))
873
		object = XCDR (object);
874
	    }
875
	}
Jim Blandy's avatar
Jim Blandy committed
876

877 878
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
879
	{
880
	  struct gcpro gcpro1;
881
	  Lisp_Object map;
882
	  GCPRO1 (object);
883
	  map = get_keymap (Fcar_safe (object), 0, autoload);
884
	  UNGCPRO;
885
	  return (!CONSP (map) ? object /* Invalid keymap */
886
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
887
	}
Jim Blandy's avatar
Jim Blandy committed
888 889 890
    }
}

891
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
892 893 894
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
895
     Lisp_Object def;
Jim Blandy's avatar
Jim Blandy committed
896
{
897 898 899 900
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

901
  /* If we are preparing to dump, and DEF is a menu element
902 903
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
904 905
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
906

907
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
908 909
    error ("attempt to define a key in a non-keymap");

910 911 912 913 914 915 916 917 918
  /* 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
919

920 921
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
922
  if (SYMBOLP (idx))
923
    idx = reorder_modifiers (idx);
924 925 926
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
927
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
928 929

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
930
  {
931
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
932

933 934 935 936 937 938
    /* 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.  */
939
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
940

941
    insertion_point = keymap;
942
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
943
      {
944
	Lisp_Object elt;
945

946
	elt = XCAR (tail);
947
	if (VECTORP (elt))