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

Jim Blandy's avatar
Jim Blandy committed
106 107 108
/* 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
109 110
extern Lisp_Object meta_prefix_char;

111 112
extern Lisp_Object Voverriding_local_map;

113 114 115 116 117
/* 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;

118 119 120 121 122 123 124 125 126 127 128 129 130 131
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
132

Jim Blandy's avatar
Jim Blandy committed
133 134
/* Keymap object support - constructors and predicates.			*/

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

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

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

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

   For example:

183
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
184 185

void
186
initial_define_key (Lisp_Object keymap, int key, char *defname)
Jim Blandy's avatar
Jim Blandy committed
187
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
188
  store_in_keymap (keymap, make_number (key), intern_c_string (defname));
Jim Blandy's avatar
Jim Blandy committed
189 190
}

191
void
192
initial_define_lispy_key (Lisp_Object keymap, char *keyname, char *defname)
193
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
194
  store_in_keymap (keymap, intern_c_string (keyname), intern_c_string (defname));
195 196
}

Jim Blandy's avatar
Jim Blandy committed
197
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
198 199 200 201 202 203 204 205
       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
206 207
     Lisp_Object object;
{
208
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
209 210
}

211
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
212 213 214 215
       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)
216 217
     Lisp_Object map;
{
218
  map = get_keymap (map, 0, 0);
219 220
  while (CONSP (map))
    {
221
      Lisp_Object tem = XCAR (map);
222 223
      if (STRINGP (tem))
	return tem;
224
      map = XCDR (map);
225 226 227 228
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
229
/* Check that OBJECT is a keymap (after dereferencing through any
230 231 232 233
   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.
234
   If AUTOLOAD is nonzero, callers must assume GC is possible.
235

236 237 238
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

239 240 241 242 243 244 245
   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
246 247 248 249
   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.  */
250

Jim Blandy's avatar
Jim Blandy committed
251
Lisp_Object
252
get_keymap (Lisp_Object object, int error, int autoload)
Jim Blandy's avatar
Jim Blandy committed
253
{
254
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
255

256
 autoload_retry:
257 258 259 260
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
261

262 263
  tem = indirect_function (object);
  if (CONSP (tem))
264
    {
265 266
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
267

268 269
      /* Should we do an autoload?  Autoload forms for keymaps have
	 Qkeymap as their fifth element.  */
270 271
      if ((autoload || !error) && EQ (XCAR (tem), Qautoload)
	  && SYMBOLP (object))
272
	{
273
	  Lisp_Object tail;
274

275 276 277 278 279 280
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
281

282 283 284
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
285

286 287 288
		  goto autoload_retry;
		}
	      else
289
	      	return object;
290
	    }
291
	}
292 293
    }

294
 end:
Jim Blandy's avatar
Jim Blandy committed
295 296
  if (error)
    wrong_type_argument (Qkeymapp, object);
297
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
298
}
299

300 301
/* Return the parent map of KEYMAP, or nil if it has none.
   We assume that KEYMAP is a valid keymap.  */
302

303
Lisp_Object
304
keymap_parent (Lisp_Object keymap, int autoload)
305 306 307
{
  Lisp_Object list;

308
  keymap = get_keymap (keymap, 1, autoload);
309 310

  /* Skip past the initial element `keymap'.  */
311 312
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
313 314
    {
      /* See if there is another `keymap'.  */
315
      if (KEYMAPP (list))
316 317 318
	return list;
    }

319
  return get_keymap (list, 0, autoload);
320 321
}

322
DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
323 324
       doc: /* Return the parent keymap of KEYMAP.
If KEYMAP has no parent, return nil.  */)
325 326 327 328 329
     (keymap)
     Lisp_Object keymap;
{
  return keymap_parent (keymap, 1);
}
330

331 332
/* Check whether MAP is one of MAPS parents.  */
int
333
keymap_memberp (Lisp_Object map, Lisp_Object maps)
334
{
335
  if (NILP (map)) return 0;
336
  while (KEYMAPP (maps) && !EQ (map, maps))
337
    maps = keymap_parent (maps, 0);
338 339 340
  return (EQ (map, maps));
}

341 342 343
/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
344
       doc: /* Modify KEYMAP to set its parent map to PARENT.
345
Return PARENT.  PARENT should be nil or another keymap.  */)
346
     (keymap, parent)
347 348 349
     Lisp_Object keymap, parent;
{
  Lisp_Object list, prev;
350
  struct gcpro gcpro1, gcpro2;
351
  int i;
Jim Blandy's avatar
Jim Blandy committed
352

353 354 355 356 357 358 359 360 361
  /* 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;

362
  GCPRO2 (keymap, parent);
363
  keymap = get_keymap (keymap, 1, 1);
364

365
  if (!NILP (parent))
366
    {
367
      parent = get_keymap (parent, 1, 1);
368 369

      /* Check for cycles.  */
370
      if (keymap_memberp (keymap, parent))
371 372
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
373

374 375 376 377
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
378
      list = XCDR (prev);
379 380
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
381
      if (!CONSP (list) || KEYMAPP (list))
382
	{
383 384
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
385
	  if (EQ (XCDR (prev), parent))
386
	    RETURN_UNGCPRO (parent);
387

388
	  CHECK_IMPURE (prev);
389
	  XSETCDR (prev, parent);
390 391 392 393 394 395 396
	  break;
	}
      prev = list;
    }

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

397
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
398 399
    {
      /* Stop the scan when we come to the parent.  */
400
      if (EQ (XCAR (list), Qkeymap))
401 402 403
	break;

      /* If this element holds a prefix map, deal with it.  */
404 405 406 407 408 409 410 411
      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]))
412
	    fix_submap_inheritance (keymap, make_number (i),
413
				    XVECTOR (XCAR (list))->contents[i]);
414

415
      if (CHAR_TABLE_P (XCAR (list)))
416
	{
417
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list), keymap);
418
	}
419 420
    }

421
  RETURN_UNGCPRO (parent);
422 423 424 425 426 427
}

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

428
static void
429
fix_submap_inheritance (Lisp_Object map, Lisp_Object event, Lisp_Object submap)
430 431 432 433 434 435
{
  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.  */

436
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
437 438

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

442
  map_parent = keymap_parent (map, 0);
443
  if (!NILP (map_parent))
444
    parent_entry =
445
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
446 447 448
  else
    parent_entry = Qnil;

449
  /* If MAP's parent has something other than a keymap,
450
     our own submap shadows it completely.  */
451
  if (!CONSP (parent_entry))
452
    return;
453

454
  if (! EQ (parent_entry, submap))
455 456 457 458 459 460
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
461

462
	  tem = keymap_parent (submap_parent, 0);
463 464 465 466 467 468 469 470

	  if (KEYMAPP (tem))
	    {
	      if (keymap_memberp (tem, parent_entry))
		/* Fset_keymap_parent could create a cycle.  */
		return;
	      submap_parent = tem;
	    }
471 472 473 474 475
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
476 477
}

Jim Blandy's avatar
Jim Blandy committed
478
/* Look up IDX in MAP.  IDX may be any sort of event.
479
   Note that this does only one level of lookup; IDX must be a single
480
   event, not a sequence.
481 482 483

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

486 487 488
   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
489 490

Lisp_Object
491
access_keymap (Lisp_Object map, Lisp_Object idx, int t_ok, int noinherit, int autoload)
Jim Blandy's avatar
Jim Blandy committed
492
{
493 494 495 496
  Lisp_Object val;

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

Jim Blandy's avatar
Jim Blandy committed
498 499 500
  /* 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.  */
501
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
502

503 504
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
505
  if (SYMBOLP (idx))
506
    idx = reorder_modifiers (idx);
507 508 509
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
510
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
511

512 513 514
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
515 516
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
517 518 519
      struct gcpro gcpro1;
      Lisp_Object meta_map;
      GCPRO1 (map);
520 521
      /* A strange value in which Meta is set would cause
	 infinite recursion.  Protect against that.  */
Stefan Monnier's avatar
Stefan Monnier committed
522
      if (XINT (meta_prefix_char) & CHAR_META)
523
	meta_prefix_char = make_number (27);
524 525 526 527
      meta_map = get_keymap (access_keymap (map, meta_prefix_char,
					    t_ok, noinherit, autoload),
			     0, autoload);
      UNGCPRO;
528
      if (CONSP (meta_map))
529
	{
530
	  map = meta_map;
531 532 533 534 535 536 537 538
	  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;
539 540
    }

541 542 543
  /* 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.  */
544 545
  {
    Lisp_Object tail;
546 547
    Lisp_Object t_binding = Qnil;
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
548

549
    GCPRO4 (map, tail, idx, t_binding);
550

551
    for (tail = XCDR (map);
552
	 (CONSP (tail)
553
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
554
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
555
      {
556
	Lisp_Object binding;
557

558
	binding = XCAR (tail);
559
	if (SYMBOLP (binding))
560
	  {
561 562
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
563
	    if (noinherit && EQ (binding, Qkeymap))
564
	      RETURN_UNGCPRO (Qnil);
565 566 567
	  }
	else if (CONSP (binding))
	  {
568
	    Lisp_Object key = XCAR (binding);
569

570
	    if (EQ (key, idx))
571
	      val = XCDR (binding);
572
	    else if (t_ok && EQ (key, Qt))
573 574
	      {
		t_binding = XCDR (binding);
575
		t_ok = 0;
576
	      }
577 578 579
	  }
	else if (VECTORP (binding))
	  {
580 581
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
	      val = AREF (binding, XFASTINT (idx));
582
	  }
583 584
	else if (CHAR_TABLE_P (binding))
	  {
585 586 587
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
588 589 590 591 592 593 594 595 596
	    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;
	      }
597
	  }
598

599 600 601
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
602 603 604 605 606
	    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;
607 608 609
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
610
	    RETURN_UNGCPRO (val);
611
	  }
612
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
613
      }
614
    UNGCPRO;
615
    return get_keyelt (t_binding, autoload);
616
  }
Jim Blandy's avatar
Jim Blandy committed
617 618
}

619
static void
620
map_keymap_item (map_keymap_function_t fun, Lisp_Object args, Lisp_Object key, Lisp_Object val, void *data)
621 622 623 624 625 626 627 628 629
{
  /* 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
630
map_keymap_char_table_item (Lisp_Object args, Lisp_Object key, Lisp_Object val)
631 632 633 634 635
{
  if (!NILP (val))
    {
      map_keymap_function_t fun = XSAVE_VALUE (XCAR (args))->pointer;
      args = XCDR (args);
636 637 638 639
      /* 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));
640 641 642 643 644
      map_keymap_item (fun, XCDR (args), key, val,
		       XSAVE_VALUE (XCAR (args))->pointer);
    }
}

645 646 647 648 649 650 651
/* 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)
652 653
{
  struct gcpro gcpro1, gcpro2, gcpro3;
654 655
  Lisp_Object tail
    = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
656 657

  GCPRO3 (map, args, tail);
658
  for (; CONSP (tail) && !EQ (Qkeymap, XCAR (tail)); tail = XCDR (tail))
659 660
    {
      Lisp_Object binding = XCAR (tail);
Kenichi Handa's avatar
Kenichi Handa committed
661

662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
      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
678
	  map_char_table (map_keymap_char_table_item, Qnil, binding,
679 680
			  Fcons (make_save_value (fun, 0),
				 Fcons (make_save_value (data, 0),
Kenichi Handa's avatar
Kenichi Handa committed
681
					args)));
682 683 684
	}
    }
  UNGCPRO;
685
  return tail;
686 687 688
}

static void
689
map_keymap_call (Lisp_Object key, Lisp_Object val, Lisp_Object fun, void *dummy)
690 691 692 693
{
  call2 (fun, key, val);
}

694 695 696
/* 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
697
map_keymap (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, void *data, int autoload)
698 699 700 701 702 703 704 705 706 707 708 709
{
  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;
}

710 711 712 713 714
Lisp_Object Qkeymap_canonicalize;

/* Same as map_keymap, but does it right, properly eliminating duplicate
   bindings due to inheritance.   */
void
715
map_keymap_canonical (Lisp_Object map, map_keymap_function_t fun, Lisp_Object args, void *data)
716 717 718 719 720 721 722 723 724 725 726
{
  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;
}

727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
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;
}

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

748 749
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
750 751 752 753
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
     (function, keymap, sort_first)
     Lisp_Object function, keymap, sort_first;
754
{
755
  if (! NILP (sort_first))
756
    return call2 (intern ("map-keymap-sorted"), function, keymap);
757

758 759 760 761
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
762 763 764 765 766 767 768
/* 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,
769 770 771
   remove that.  Also remove a menu help string as second element.

   If AUTOLOAD is nonzero, load autoloadable keymaps
772 773 774
   that are referred to with indirection.

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

Lisp_Object
777
get_keyelt (Lisp_Object object, int autoload)
Jim Blandy's avatar
Jim Blandy committed
778 779 780
{
  while (1)
    {
781 782 783
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
784

785 786 787 788 789 790 791
      /* 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.
792
	 This is a new format menu item.  */
793
      else if (EQ (XCAR (object), Qmenu_item))
794
	{
795
	  if (CONSP (XCDR (object)))
796
	    {
797 798
	      Lisp_Object tem;

799
	      object = XCDR (XCDR (object));
800
	      tem = object;
801 802
	      if (CONSP (object))
		object = XCAR (object);
803 804 805

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
806
		 use.  */
807
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
808
		if (EQ (XCAR (tem), QCfilter) && autoload)
809 810 811 812 813 814 815
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
816 817
	    }
	  else
818
	    /* Invalid keymap.  */
819
	    return object;
820 821
	}

822
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
823 824
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
825
      else if (STRINGP (XCAR (object)))
826
	{
827
	  object = XCDR (object);
828 829
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
830 831
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
832
	  /* Also remove the sublist that caches key equivalences, if any.  */
833
	  if (CONSP (object) && CONSP (XCAR (object)))
834
	    {
835
	      Lisp_Object carcar;
836
	      carcar = XCAR (XCAR (object));
837
	      if (NILP (carcar) || VECTORP (carcar))
838
		object = XCDR (object);
839
	    }
840
	}
Jim Blandy's avatar
Jim Blandy committed
841

842 843
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
844
	{
845
	  struct gcpro gcpro1;
846
	  Lisp_Object map;
847
	  GCPRO1 (object);
848
	  map = get_keymap (Fcar_safe (object), 0, autoload);
849
	  UNGCPRO;
850
	  return (!CONSP (map) ? object /* Invalid keymap */
851
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
852
	}
Jim Blandy's avatar
Jim Blandy committed
853 854 855
    }
}

856
static Lisp_Object
857
store_in_keymap (Lisp_Object keymap, register Lisp_Object idx, Lisp_Object def)
Jim Blandy's avatar
Jim Blandy committed
858
{
859 860 861 862
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

863
  /* If we are preparing to dump, and DEF is a menu element
864 865
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
866 867
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
868

869
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
870 871
    error ("attempt to define a key in a non-keymap");

872 873 874 875 876 877 878 879 880
  /* 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
881

882 883
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
884
  if (SYMBOLP (idx))
885
    idx = reorder_modifiers (idx);
886 887 888
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
889
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
890 891

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
892
  {
893
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
894

895 896 897 898 899 900
    /* 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.  */
901
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
902

903
    insertion_point = keymap;
904
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
905
      {
906
	Lisp_Object elt;
907

908
	elt = XCAR (tail);
909
	if (VECTORP (elt))
910
	  {
911
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
912
	      {
913
		CHECK_IMPURE (elt);
914
		ASET (elt, XFASTINT (idx), def);