keymap.c 102 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
2
   Copyright (C) 1985, 86,87,88,93,94,95,98,99, 2000, 2001
Gerd Moellmann's avatar
Gerd Moellmann committed
3
   Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25 26 27
#include <stdio.h>
#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"
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));
125
static void silly_event_symbol_error P_ ((Lisp_Object));
Jim Blandy's avatar
Jim Blandy committed
126

Jim Blandy's avatar
Jim Blandy committed
127 128
/* Keymap object support - constructors and predicates.			*/

129
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
130 131 132 133 134 135 136 137 138
       doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).
CHARTABLE is a char-table that holds the bindings for the ASCII
characters.  ALIST is an assoc-list which holds bindings for function keys,
mouse events, and any other things that appear in the input stream.
All entries in it are initially nil, meaning "command undefined".

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

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

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

   For example:

172
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
173 174 175 176 177 178 179 180 181 182

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

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

206
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
207 208 209 210
       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)
211 212 213 214 215 216 217 218 219 220 221 222 223
     Lisp_Object map;
{
  while (CONSP (map))
    {
      register Lisp_Object tem;
      tem = Fcar (map);
      if (STRINGP (tem))
	return tem;
      map = Fcdr (map);
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
224
/* Check that OBJECT is a keymap (after dereferencing through any
225 226 227 228
   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.
229
   If AUTOLOAD is nonzero, callers must assume GC is possible.
230

231 232 233
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

234 235 236 237 238 239 240
   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
241 242 243 244
   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.  */
245

Jim Blandy's avatar
Jim Blandy committed
246
Lisp_Object
247
get_keymap (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
248
     Lisp_Object object;
249
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
250
{
251
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
252

253
 autoload_retry:
254 255 256 257
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
258

259 260
  tem = indirect_function (object);
  if (CONSP (tem))
261
    {
262 263
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
264

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

271 272 273 274 275 276
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
277

278 279 280
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
281

282 283 284 285 286
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
287
	}
288 289
    }

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

299 300
Lisp_Object
keymap_parent (keymap, autoload)
301
     Lisp_Object keymap;
302
     int autoload;
303 304 305
{
  Lisp_Object list;

306
  keymap = get_keymap (keymap, 1, autoload);
307 308

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

317
  return get_keymap (list, 0, autoload);
318 319
}

320 321 322 323 324 325 326
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);
}
327

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

339 340 341
/* Set the parent keymap of MAP to PARENT.  */

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

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

360
  GCPRO2 (keymap, parent);
361
  keymap = get_keymap (keymap, 1, 1);
362

363
  if (!NILP (parent))
364
    {
365
      parent = get_keymap (parent, 1, 1);
366 367

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

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

386
	  XSETCDR (prev, parent);
387 388 389 390 391 392 393
	  break;
	}
      prev = list;
    }

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

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

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

412
      if (CHAR_TABLE_P (XCAR (list)))
413
	{
414
	  Lisp_Object indices[3];
415

416
	  map_char_table (fix_submap_inheritance, Qnil,
Kenichi Handa's avatar
Kenichi Handa committed
417
			  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 430 431 432 433 434 435 436
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.  */

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

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

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

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

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

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

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

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

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

Lisp_Object
492
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
493 494
     Lisp_Object map;
     Lisp_Object idx;
495
     int t_ok;
496
     int noinherit;
497
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
498
{
499 500 501 502
  Lisp_Object val;

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

Jim Blandy's avatar
Jim Blandy committed
504 505 506
  /* 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.  */
507
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
508

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

518 519 520
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
521 522
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
523 524 525 526 527 528 529
      struct gcpro gcpro1;
      Lisp_Object meta_map;
      GCPRO1 (map);
      meta_map = get_keymap (access_keymap (map, meta_prefix_char,
					    t_ok, noinherit, autoload),
			     0, autoload);
      UNGCPRO;
530
      if (CONSP (meta_map))
531
	{
532
	  map = meta_map;
533 534 535 536 537 538 539 540
	  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;
541 542
    }

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

551
    GCPRO4 (map, tail, idx, t_binding);
552

553
    /* If `t_ok' is 2, both `t' is accepted.  */
554
    t_ok = t_ok ? 2 : 0;
Jim Blandy's avatar
Jim Blandy committed
555

556
    for (tail = XCDR (map);
557
	 (CONSP (tail)
558
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
559
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
560
      {
561
	Lisp_Object binding;
562

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

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

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

624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
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
651 652
   FUN is called with 4 arguments: FUN (KEY, BINDING, ARGS, DATA).
   AUTOLOAD if non-zero means that we can autoload keymaps if necessary.  */
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
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);
Kenichi Handa's avatar
Kenichi Handa committed
670

671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
      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;
	  abort();
	  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];
Kenichi Handa's avatar
Kenichi Handa committed
689
	  map_char_table (map_keymap_char_table_item, Qnil, binding,
690 691
			  Fcons (make_save_value (fun, 0),
				 Fcons (make_save_value (data, 0),
Kenichi Handa's avatar
Kenichi Handa committed
692
					args)));
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
	}
    }
  UNGCPRO;
}

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

DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 2, 0,
       doc: /* Call FUNCTION for every binding in KEYMAP.
FUNCTION is called with two arguments: the event and its binding.  */)
     (function, keymap)
     Lisp_Object function, keymap;
{
  if (INTEGERP (function))
    /* We have to stop integers early since map_keymap gives them special
       significance.  */
    Fsignal (Qinvalid_function, Fcons (function, Qnil));
  map_keymap (keymap, map_keymap_call, function, NULL, 1);
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
720 721 722 723 724 725 726
/* 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,
727 728 729 730
   remove that.  Also remove a menu help string as second element.

   If AUTOLOAD is nonzero, load autoloadable keymaps
   that are referred to with indirection.  */
Jim Blandy's avatar
Jim Blandy committed
731 732

Lisp_Object
733
get_keyelt (object, autoload)
734
     Lisp_Object object;
735
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
736 737 738
{
  while (1)
    {
739 740 741
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
742

743 744 745 746 747 748 749
      /* 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.
750
	 This is a new format menu item.  */
751
      else if (EQ (XCAR (object), Qmenu_item))
752
	{
753
	  if (CONSP (XCDR (object)))
754
	    {
755 756
	      Lisp_Object tem;

757
	      object = XCDR (XCDR (object));
758
	      tem = object;
759 760
	      if (CONSP (object))
		object = XCAR (object);
761 762 763

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
764
		 use.  */
765
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
766
		if (EQ (XCAR (tem), QCfilter) && autoload)
767 768 769 770 771 772 773
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
774 775
	    }
	  else
776
	    /* Invalid keymap.  */
777
	    return object;
778 779
	}

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

800 801
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
802
	{
803
	  struct gcpro gcpro1;
804
	  Lisp_Object map;
805
	  GCPRO1 (object);
806
	  map = get_keymap (Fcar_safe (object), 0, autoload);
807
	  UNGCPRO;
808
	  return (!CONSP (map) ? object /* Invalid keymap */
809
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
810
	}
Jim Blandy's avatar
Jim Blandy committed
811 812 813
    }
}

814
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
815 816 817 818 819
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
820 821 822 823
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

824
  /* If we are preparing to dump, and DEF is a menu element
825 826
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
827 828
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
829

830
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
831 832
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
833 834 835
  /* 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.  */
836
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
837

838 839
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
840
  if (SYMBOLP (idx))
841
    idx = reorder_modifiers (idx);
842 843 844
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
845
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
846 847

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
848
  {
849
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
850

851 852 853 854 855 856
    /* 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.  */
857
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
858

859
    insertion_point = keymap;
860
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
861
      {
862
	Lisp_Object elt;
863

864
	elt = XCAR (tail);
865
	if (VECTORP (elt))
866
	  {
867
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
868
	      {
869
		ASET (elt, XFASTINT (idx), def);
870 871 872
		return def;
	      }
	    insertion_point = tail;
873
	  }
874 875
	else if (CHAR_TABLE_P (elt))
	  {
876 877 878
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
879
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
880
	      {
881 882 883 884 885
		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);
886 887
		return def;
	      }
Kenichi Handa's avatar
Kenichi Handa committed
888 889 890 891 892
	    else if (CONSP (idx) && CHARACTERP (XCAR (idx)))
	      {
		Fset_char_table_range (elt, idx, NILP (def) ? Qt : def);
		return def;
	      }
893 894
	    insertion_point = tail;
	  }
895 896
	else if (CONSP (elt))
	  {
897
	    if (EQ (idx, XCAR (elt)))
898
	      {
899
		XSETCDR (elt, def);
900 901
		return def;
	      }
902
	  }
903 904 905 906 907 908
	else if (EQ (elt, Qkeymap))
	  /* If we find a 'keymap' symbol in the spine of KEYMAP,
	     then we must have found the start of a second keymap
	     being used as the tail of KEYMAP, and a binding for IDX
	     should be inserted before it.  */
	  goto keymap_end;
909 910

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
911 912
      }

913 914 915
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
916 917
    XSETCDR (insertion_point,
	     Fcons (Fcons (idx, def), XCDR (insertion_point)));
918
  }
919

Jim Blandy's avatar
Jim Blandy committed
920 921 922
  return def;
}

923 924
EXFUN (Fcopy_keymap, 1);

925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998