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

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22 23


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

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

/* 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
72 73 74
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

75 76 77 78
/* Alist of major-mode-specific overrides for
   minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_overriding_map_alist;

79 80 81
/* List of emulation mode keymap alists.  */
Lisp_Object Vemulation_mode_map_alists;

Jim Blandy's avatar
Jim Blandy committed
82 83 84 85 86
/* Keymap mapping ASCII function key sequences onto their preferred forms.
   Initialized by the terminal-specific lisp files.  See DEFVAR for more
   documentation.  */
Lisp_Object Vfunction_key_map;

87 88 89
/* Keymap mapping ASCII function key sequences onto their preferred forms.  */
Lisp_Object Vkey_translation_map;

90 91 92 93 94 95
/* 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;

96
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
Jim Blandy's avatar
Jim Blandy committed
97

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

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

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

109 110
extern Lisp_Object Voverriding_local_map;

111 112 113 114 115
/* 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;

116 117 118 119
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));
120 121
static void describe_command P_ ((Lisp_Object, Lisp_Object));
static void describe_translation P_ ((Lisp_Object, Lisp_Object));
122
static void describe_map P_ ((Lisp_Object, Lisp_Object,
123
			      void (*) P_ ((Lisp_Object, Lisp_Object)),
124
			      int, Lisp_Object, Lisp_Object*, int, int));
125 126
static void describe_vector P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
				 void (*) (Lisp_Object, Lisp_Object), int,
127 128
				 Lisp_Object, Lisp_Object, int *,
				 int, int, int));
129
static void silly_event_symbol_error P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
130

Jim Blandy's avatar
Jim Blandy committed
131 132
/* Keymap object support - constructors and predicates.			*/

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

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

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

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

   For example:

177
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
178 179 180 181 182 183 184 185 186 187

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

188 189 190 191 192 193 194 195 196
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
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 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
253
     Lisp_Object object;
254
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
255
{
256
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
257

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

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

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

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

284 285 286
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
287

288 289 290 291 292
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
293
	}
294 295
    }

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

305 306
Lisp_Object
keymap_parent (keymap, autoload)
307
     Lisp_Object keymap;
308
     int autoload;
309 310 311
{
  Lisp_Object list;

312
  keymap = get_keymap (keymap, 1, autoload);
313 314

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

323
  return get_keymap (list, 0, autoload);
324 325
}

326 327 328 329 330 331 332
DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
       doc: /* Return the parent keymap of KEYMAP.  */)
     (keymap)
     Lisp_Object keymap;
{
  return keymap_parent (keymap, 1);
}
333

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

345 346 347
/* Set the parent keymap of MAP to PARENT.  */

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

357 358 359 360 361 362 363 364 365
  /* 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;

366
  GCPRO2 (keymap, parent);
367
  keymap = get_keymap (keymap, 1, 1);
368

369
  if (!NILP (parent))
370
    {
371
      parent = get_keymap (parent, 1, 1);
372 373

      /* Check for cycles.  */
374
      if (keymap_memberp (keymap, parent))
375 376
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
377

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

392
	  XSETCDR (prev, parent);
393 394 395 396 397 398 399
	  break;
	}
      prev = list;
    }

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

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

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

418
      if (CHAR_TABLE_P (XCAR (list)))
419
	{
420
	  Lisp_Object indices[3];
421

422 423
	  map_char_table (fix_submap_inheritance, Qnil,
			  XCAR (list), XCAR (list),
424 425
			  keymap, 0, indices);
	}
426 427
    }

428
  RETURN_UNGCPRO (parent);
429 430 431 432 433 434
}

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

435
static void
436 437 438 439 440 441 442 443
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.  */

444
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
445 446

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

450
  map_parent = keymap_parent (map, 0);
451
  if (!NILP (map_parent))
452
    parent_entry =
453
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
454 455 456
  else
    parent_entry = Qnil;

457
  /* If MAP's parent has something other than a keymap,
458
     our own submap shadows it completely.  */
459
  if (!CONSP (parent_entry))
460
    return;
461

462
  if (! EQ (parent_entry, submap))
463 464 465 466 467 468
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
469

470
	  tem = keymap_parent (submap_parent, 0);
471 472 473 474 475 476 477 478

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

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

494 495 496
   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
497 498

Lisp_Object
499
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
500 501
     Lisp_Object map;
     Lisp_Object idx;
502
     int t_ok;
503
     int noinherit;
504
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
505
{
506 507 508 509
  Lisp_Object val;

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

Jim Blandy's avatar
Jim Blandy committed
511 512 513
  /* 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.  */
514
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
515

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

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

554 555 556
  /* 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.  */
557 558
  {
    Lisp_Object tail;
559 560
    Lisp_Object t_binding = Qnil;
    struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
561

562
    GCPRO4 (map, tail, idx, t_binding);
563 564 565 566 567

    /* If `t_ok' is 2, both `t' and generic-char bindings are accepted.
       If it is 1, only generic-char bindings are accepted.
       Otherwise, neither are.  */
    t_ok = t_ok ? 2 : 0;
Jim Blandy's avatar
Jim Blandy committed
568

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

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

588
	    if (EQ (key, idx))
589 590 591
	      val = XCDR (binding);
	    else if (t_ok
		     && INTEGERP (idx)
592
		     && (XINT (idx) & CHAR_MODIFIER_MASK) == 0
593
		     && INTEGERP (key)
594
		     && (XINT (key) & CHAR_MODIFIER_MASK) == 0
595 596 597 598 599 600 601 602 603 604
		     && !SINGLE_BYTE_CHAR_P (XINT (idx))
		     && !SINGLE_BYTE_CHAR_P (XINT (key))
		     && CHAR_VALID_P (XINT (key), 1)
		     && !CHAR_VALID_P (XINT (key), 0)
		     && (CHAR_CHARSET (XINT (key))
			 == CHAR_CHARSET (XINT (idx))))
	      {
		/* KEY is the generic character of the charset of IDX.
		   Use KEY's binding if there isn't a binding for IDX
		   itself.  */
605 606 607 608 609 610 611
		t_binding = XCDR (binding);
		t_ok = 0;
	      }
	    else if (t_ok > 1 && EQ (key, Qt))
	      {
		t_binding = XCDR (binding);
		t_ok = 1;
612
	      }
613 614 615
	  }
	else if (VECTORP (binding))
	  {
616 617
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
	      val = AREF (binding, XFASTINT (idx));
618
	  }
619 620
	else if (CHAR_TABLE_P (binding))
	  {
621 622 623
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
624 625 626 627 628 629 630 631 632
	    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;
	      }
633
	  }
634

635 636 637
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
638 639 640 641 642
	    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;
643 644 645
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
646
	    RETURN_UNGCPRO (val);
647
	  }
648
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
649
      }
650
    UNGCPRO;
651
    return get_keyelt (t_binding, autoload);
652
  }
Jim Blandy's avatar
Jim Blandy committed
653 654
}

655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
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);
      map_keymap_item (fun, XCDR (args), key, val,
		       XSAVE_VALUE (XCAR (args))->pointer);
    }
}

/* Call FUN for every binding in MAP.
Stefan Monnier's avatar
Stefan Monnier committed
682 683
   FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
   AUTOLOAD if non-zero means that we can autoload keymaps if necessary.  */
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
void
map_keymap (map, fun, args, data, autoload)
     map_keymap_function_t fun;
     Lisp_Object map, args;
     void *data;
     int autoload;
{
  struct gcpro gcpro1, gcpro2, gcpro3;
  Lisp_Object tail;

  GCPRO3 (map, args, tail);
  map = get_keymap (map, 1, autoload);
  for (tail = (CONSP (map) && EQ (Qkeymap, XCAR (map))) ? XCDR (map) : map;
       CONSP (tail) || (tail = get_keymap (tail, 0, autoload), CONSP (tail));
       tail = XCDR (tail))
    {
      Lisp_Object binding = XCAR (tail);
701

702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
      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))
	{
	  Lisp_Object indices[3];
719
	  map_char_table (map_keymap_char_table_item, Qnil, binding, binding,
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
			  Fcons (make_save_value (fun, 0),
				 Fcons (make_save_value (data, 0),
					args)),
			  0, indices);
	}
    }
  UNGCPRO;
}

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

737
DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 3, 0,
738
       doc: /* Call FUNCTION for every binding in KEYMAP.
739 740 741
FUNCTION is called with two arguments: the event and its binding.
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
742 743 744 745
grandparent's bindings are also included and so on.
usage: (map-keymap FUNCTION KEYMAP)  */)
     (function, keymap, sort_first)
     Lisp_Object function, keymap, sort_first;
746 747 748 749 750
{
  if (INTEGERP (function))
    /* We have to stop integers early since map_keymap gives them special
       significance.  */
    Fsignal (Qinvalid_function, Fcons (function, Qnil));
751 752
  if (! NILP (sort_first))
    return call3 (intern ("map-keymap-internal"), function, keymap, Qt);
753

754 755 756 757
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

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

   If AUTOLOAD is nonzero, load autoloadable keymaps
768 769 770
   that are referred to with indirection.

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

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

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

797
	      object = XCDR (XCDR (object));
798
	      tem = object;
799 800
	      if (CONSP (object))
		object = XCAR (object);
801 802 803

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
873 874 875
  /* 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.  */
876
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
877

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

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
888
  {
889
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
890

891 892 893 894 895 896
    /* 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.  */
897
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
898

899
    insertion_point = keymap;
900
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
901
      {
902
	Lisp_Object elt;
903

904
	elt = XCAR (tail);
905
	if (VECTORP (elt))
906
	  {
907
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
908
	      {
909
		ASET (elt, XFASTINT (idx), def);
910 911 912
		return def;
	      }
	    insertion_point = tail;
913
	  }
914 915
	else if (CHAR_TABLE_P (elt))
	  {
916 917 918
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
919
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
920
	      {
921 922 923 924 925
		Faset (elt, idx,
		       /* `nil' has a special meaning for char-tables, so
			  we use something else to record an explicitly
			  unbound entry.  */
		       NILP (def) ? Qt : def);
926 927 928 929
		return def;
	      }
	    insertion_point = tail;
	  }
930 931
	else if (CONSP (elt))
	  {