keymap.c 98.2 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"
Karl Heuer's avatar
Karl Heuer committed
28
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
30
#include "termhooks.h"
31
#include "blockinput.h"
32
#include "puresize.h"
Dave Love's avatar
Dave Love committed
33
#include "intervals.h"
Stefan Monnier's avatar
Stefan Monnier committed
34
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
35

36
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50
#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 */

51 52 53
/* Alist of elements like (DEL . "\d").  */
Lisp_Object exclude_keys;

Jim Blandy's avatar
Jim Blandy committed
54 55 56 57 58 59 60
/* 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 70 71 72 73
				/* 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
74 75 76
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

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

Jim Blandy's avatar
Jim Blandy committed
81 82 83 84 85
/* 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;

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

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

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

Jim Blandy's avatar
Jim Blandy committed
97 98 99
/* 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
100 101
extern Lisp_Object meta_prefix_char;

102 103
extern Lisp_Object Voverriding_local_map;

104 105 106 107 108
/* 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;

109 110 111 112
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));
113 114
static void describe_command P_ ((Lisp_Object, Lisp_Object));
static void describe_translation P_ ((Lisp_Object, Lisp_Object));
115
static void describe_map P_ ((Lisp_Object, Lisp_Object,
116
			      void (*) P_ ((Lisp_Object, Lisp_Object)),
117
			      int, Lisp_Object, Lisp_Object*, int));
Jim Blandy's avatar
Jim Blandy committed
118

Jim Blandy's avatar
Jim Blandy committed
119 120
/* Keymap object support - constructors and predicates.			*/

121
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
122 123 124 125 126 127 128 129 130
       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)
131
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
132
{
133 134 135 136 137
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
138
  return Fcons (Qkeymap,
139
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
140 141
}

142
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
143 144 145 146 147 148 149 150 151
       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)
152
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
153
{
154 155
  if (!NILP (string))
    return Fcons (Qkeymap, Fcons (string, Qnil));
Jim Blandy's avatar
Jim Blandy committed
156 157 158 159 160 161 162 163
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

164
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
165 166 167 168 169 170 171 172 173 174

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

175 176 177 178 179 180 181 182 183
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
184
DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
185 186 187 188 189 190 191 192
       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
193 194
     Lisp_Object object;
{
195
  return (KEYMAPP (object) ? Qt : Qnil);
Jim Blandy's avatar
Jim Blandy committed
196 197
}

198
DEFUN ("keymap-prompt", Fkeymap_prompt, Skeymap_prompt, 1, 1, 0,
199 200 201 202
       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)
203 204 205 206 207 208 209 210 211 212 213 214 215
     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
216
/* Check that OBJECT is a keymap (after dereferencing through any
217 218 219 220
   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.
221
   If AUTOLOAD is nonzero, callers must assume GC is possible.
222

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

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

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

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

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

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

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
	  tail = Fnth (make_number (4), tem);
	  if (EQ (tail, Qkeymap))
	    {
	      if (autoload)
		{
		  struct gcpro gcpro1, gcpro2;
		  
		  GCPRO2 (tem, object);
		  do_autoload (tem, object);
		  UNGCPRO;
		  
		  goto autoload_retry;
		}
	      else
	      	return Qt;
	    }
279
	}
280 281
    }

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

DEFUN ("keymap-parent", Fkeymap_parent, Skeymap_parent, 1, 1, 0,
292 293
       doc: /* Return the parent keymap of KEYMAP.  */)
     (keymap)
294 295 296 297
     Lisp_Object keymap;
{
  Lisp_Object list;

298
  keymap = get_keymap (keymap, 1, 1);
299 300

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

309
  return get_keymap (list, 0, 1);
310 311
}

312

313 314 315 316 317
/* Check whether MAP is one of MAPS parents.  */
int
keymap_memberp (map, maps)
     Lisp_Object map, maps;
{
318
  if (NILP (map)) return 0;
319 320 321 322 323
  while (KEYMAPP (maps) && !EQ (map, maps))
    maps = Fkeymap_parent (maps);
  return (EQ (map, maps));
}

324 325 326
/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
327 328 329
       doc: /* Modify KEYMAP to set its parent map to PARENT.
PARENT should be nil or another keymap.  */)
     (keymap, parent)
330 331 332
     Lisp_Object keymap, parent;
{
  Lisp_Object list, prev;
333
  struct gcpro gcpro1;
334
  int i;
Jim Blandy's avatar
Jim Blandy committed
335

336 337 338 339 340 341 342 343 344
  /* 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;

345
  keymap = get_keymap (keymap, 1, 1);
346 347
  GCPRO1 (keymap);
  
348
  if (!NILP (parent))
349
    {
350
      parent = get_keymap (parent, 1, 1);
351 352

      /* Check for cycles.  */
353
      if (keymap_memberp (keymap, parent))
354 355
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
356

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

371
	  XSETCDR (prev, parent);
372 373 374 375 376 377 378
	  break;
	}
      prev = list;
    }

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

379
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
380 381
    {
      /* Stop the scan when we come to the parent.  */
382
      if (EQ (XCAR (list), Qkeymap))
383 384 385
	break;

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

397
      if (CHAR_TABLE_P (XCAR (list)))
398
	{
399
	  Lisp_Object indices[3];
400

401
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
402 403
			  keymap, 0, indices);
	}
404 405
    }

406
  RETURN_UNGCPRO (parent);
407 408 409 410 411 412
}

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

413
static void
414 415 416 417 418 419 420 421
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.  */

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

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

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

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

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

448
	  tem = Fkeymap_parent (submap_parent);
449 450 451 452 453 454 455 456

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
489 490 491
  /* 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.  */
492
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
493

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

503 504 505
  /* Handle the special meta -> esc mapping. */
  if (INTEGERP (idx) && XUINT (idx) & meta_modifier)
    {
506 507
      /* See if there is a meta-map.  If there's none, there is
         no binding for IDX, unless a default binding exists in MAP.  */
508
      Lisp_Object meta_map =
509 510 511 512
	get_keymap (access_keymap (map, meta_prefix_char,
				   t_ok, noinherit, autoload),
		    0, autoload);
      if (CONSP (meta_map))
513
	{
514
	  map = meta_map;
515 516 517 518 519 520 521 522
	  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;
523 524
    }

525 526
  {
    Lisp_Object tail;
527 528 529

    /* t_binding is where we put a default binding that applies,
       to use in case we do not find a binding specifically
530
       for this key sequence.  */
531 532 533

    Lisp_Object t_binding;
    t_binding = Qnil;
534 535 536 537 538

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

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

547
	binding = XCAR (tail);
548
	if (SYMBOLP (binding))
549
	  {
550 551
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
552
	    if (noinherit && EQ (binding, Qkeymap))
553
	      return Qnil;
554 555 556
	  }
	else if (CONSP (binding))
	  {
557 558 559
	    Lisp_Object key = XCAR (binding);
	    
	    if (EQ (key, idx))
560 561 562
	      val = XCDR (binding);
	    else if (t_ok
		     && INTEGERP (idx)
563
		     && (XINT (idx) & CHAR_MODIFIER_MASK) == 0
564
		     && INTEGERP (key)
565
		     && (XINT (key) & CHAR_MODIFIER_MASK) == 0
566 567 568 569 570 571 572 573 574 575
		     && !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.  */
576 577 578 579 580 581 582
		t_binding = XCDR (binding);
		t_ok = 0;
	      }
	    else if (t_ok > 1 && EQ (key, Qt))
	      {
		t_binding = XCDR (binding);
		t_ok = 1;
583
	      }
584 585 586
	  }
	else if (VECTORP (binding))
	  {
587 588
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (binding))
	      val = AREF (binding, XFASTINT (idx));
589
	  }
590 591
	else if (CHAR_TABLE_P (binding))
	  {
592 593 594
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
595 596 597 598 599 600 601 602 603
	    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;
	      }
604
	  }
605

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

622
    return get_keyelt (t_binding, autoload);
623
  }
Jim Blandy's avatar
Jim Blandy committed
624 625 626 627 628 629 630 631 632
}

/* 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,
633 634 635 636
   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
637 638

Lisp_Object
639
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
640
     register Lisp_Object object;
641
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
642 643 644
{
  while (1)
    {
645 646 647
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
648

649 650 651 652 653 654 655
      /* 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.
656
	 This is a new format menu item.  */
657
      else if (EQ (XCAR (object), Qmenu_item))
658
	{
659
	  if (CONSP (XCDR (object)))
660
	    {
661 662
	      Lisp_Object tem;

663
	      object = XCDR (XCDR (object));
664
	      tem = object;
665 666
	      if (CONSP (object))
		object = XCAR (object);
667 668 669

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
670
		 use.  */
671
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
672
		if (EQ (XCAR (tem), QCfilter) && autoload)
673 674 675 676 677 678 679
		  {
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
		    break;
		  }
680 681
	    }
	  else
682 683
	    /* Invalid keymap */
	    return object;
684 685
	}

686
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
687 688
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
689
      else if (STRINGP (XCAR (object)))
690
	{
691
	  object = XCDR (object);
692 693
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
694 695
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
696
	  /* Also remove the sublist that caches key equivalences, if any.  */
697
	  if (CONSP (object) && CONSP (XCAR (object)))
698
	    {
699
	      Lisp_Object carcar;
700
	      carcar = XCAR (XCAR (object));
701
	      if (NILP (carcar) || VECTORP (carcar))
702
		object = XCDR (object);
703
	    }
704
	}
Jim Blandy's avatar
Jim Blandy committed
705

706 707
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
708
	{
709
	  Lisp_Object map;
710 711
	  map = get_keymap (Fcar_safe (object), 0, autoload);
	  return (!CONSP (map) ? object /* Invalid keymap */
712
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
713
	}
Jim Blandy's avatar
Jim Blandy committed
714 715 716
    }
}

717
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
718 719 720 721 722
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
723 724 725 726
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

727
  /* If we are preparing to dump, and DEF is a menu element
728 729
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
730 731
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
732

733
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
734 735
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
736 737 738
  /* 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.  */
739
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
740

741 742
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
743
  if (SYMBOLP (idx))
744
    idx = reorder_modifiers (idx);
745 746 747
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
748
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
749 750

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
751
  {
752
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
753

754 755 756 757 758 759
    /* 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.  */
760
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
761

762
    insertion_point = keymap;
763
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
764
      {
765
	Lisp_Object elt;
766

767
	elt = XCAR (tail);
768
	if (VECTORP (elt))
769
	  {
770
	    if (NATNUMP (idx) && XFASTINT (idx) < ASIZE (elt))
771
	      {
772
		ASET (elt, XFASTINT (idx), def);
773 774 775
		return def;
	      }
	    insertion_point = tail;
776
	  }
777 778
	else if (CHAR_TABLE_P (elt))
	  {
779 780 781
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
782
	    if (NATNUMP (idx) && !(XFASTINT (idx) & CHAR_MODIFIER_MASK))
783
	      {
784 785 786 787 788
		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);
789 790 791 792
		return def;
	      }
	    insertion_point = tail;
	  }
793 794
	else if (CONSP (elt))
	  {
795
	    if (EQ (idx, XCAR (elt)))
796
	      {
797
		XSETCDR (elt, def);
798 799
		return def;
	      }
800
	  }
801 802 803 804 805 806
	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;
807 808

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
809 810
      }

811 812 813
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
814 815
    XSETCDR (insertion_point,
	     Fcons (Fcons (idx, def), XCDR (insertion_point)));
816
  }
817
  
Jim Blandy's avatar
Jim Blandy committed
818 819 820
  return def;
}

821 822
EXFUN (Fcopy_keymap, 1);

823
void
824 825 826
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
827
  if (CONSP (elt) && EQ (XCAR (elt), Qkeymap))
828
    Faset (chartable, idx, Fcopy_keymap (elt));
829
}
830

Jim Blandy's avatar
Jim Blandy committed
831
DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0,
832 833 834 835 836 837 838
       doc: /* Return a copy of the keymap KEYMAP.
The copy starts out with the same definitions of KEYMAP,
but changing either the copy or KEYMAP does not affect the other.
Any key definitions that are subkeymaps are recursively copied.
However, a key definition which is a symbol whose definition is a keymap
is not copied.  */)
     (keymap)
Jim Blandy's avatar
Jim Blandy committed
839 840
     Lisp_Object keymap;
{
841 842 843
  /* FIXME: This doesn't properly copy menu-items in vectors.  */
  /* FIXME: This also copies the parent keymap.  */

Jim Blandy's avatar
Jim Blandy committed
844 845
  register Lisp_Object copy, tail;

846
  copy = Fcopy_alist (get_keymap (keymap, 1, 0));
Jim Blandy's avatar
Jim Blandy committed
847

848
  for (tail = copy; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
849
    {
850
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
851

852
      elt = XCAR (tail);
853 854
      if (CHAR_TABLE_P (elt))
	{
855
	  Lisp_Object indices[3];
856 857

	  elt = Fcopy_sequence (elt);
858
	  XSETCAR (tail, elt);
859

860 861 862
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
863
	{
864
	  int i;
Jim Blandy's avatar
Jim Blandy committed
865

866
	  elt = Fcopy_sequence (elt);
867
	  XSETCAR (tail, elt);
Jim Blandy's avatar
Jim Blandy committed
868

869
	  for (i = 0; i < ASIZE (elt); i++)
870
	    if (CONSP (AREF (elt, i)) && EQ (XCAR (AREF (elt, i)), Qkeymap))
871
	      ASET (elt, i, Fcopy_keymap (AREF (elt, i)));
Jim Blandy's avatar
Jim Blandy committed
872
	}
873
      else if (CONSP (elt) && CONSP (XCDR (elt)))
874
	{
875
	  Lisp_Object tem;
876
	  tem = XCDR (elt);
877

878
	  /* Is this a new format menu item.  */
879
	  if (EQ (XCAR (tem),Qmenu_item))
880 881
	    {
	      /* Copy cell with menu-item marker.  */
882 883
	      XSETCDR (elt,
		       Fcons (XCAR (tem), XCDR (tem)));
884 885
	      elt = XCDR (elt);
	      tem = XCDR (elt);
886 887 888
	      if (CONSP (tem))
		{
		  /* Copy cell with menu-item name.  */
889 890
		  XSETCDR (elt,
			   Fcons (XCAR (tem), XCDR (tem)));
891 892
		  elt = XCDR (elt);
		  tem = XCDR (elt);
893 894 895 896 897
		};
	      if (CONSP (tem))
		{
		  /* Copy cell with binding and if the binding is a keymap,
		     copy that.  */
898 899
		  XSETCDR (elt,
			   Fcons (XCAR (tem), XCDR (tem)));
900 901
		  elt = XCDR (elt);
		  tem = XCAR (elt);
902
		  if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
903
		    XSETCAR (elt, Fcopy_keymap (tem));
904 905
		  tem = XCDR (elt);
		  if (CONSP (tem) && CONSP (XCAR (tem)))
906
		    /* Delete cache for key equivalences.  */
907
		    XSETCDR (elt, XCDR (tem));
908 909 910 911 912 913 914
		}
	    }
	  else
	    {
	      /* It may be an old fomat menu item.
		 Skip the optional menu string.
	      */
915
	      if (STRINGP (XCAR (tem)))
916
		{
917
		  /* Copy the cell, since copy-alist didn't go this deep.  */
918 919
		  XSETCDR (elt,
			   Fcons (XCAR (tem), XCDR (tem)));
920 921
		  elt = XCDR (elt);
		  tem = XCDR (elt);
922
		  /* Also skip the optional menu help string.  */
923
		  if (CONSP (tem) && STRINGP (XCAR (tem)))
924
		    {
925 926
		      XSETCDR (elt,
			       Fcons (XCAR (tem), XCDR (tem)));
927 928
		      elt = XCDR (elt);
		      tem = XCDR (elt);
929 930 931 932
		    }
		  /* There may also be a list that caches key equivalences.
		     Just delete it for the new keymap.  */
		  if (CONSP (tem)
933 934 935
		      && CONSP (XCAR (tem))
		      && (NILP (XCAR (XCAR (tem)))
			  || VECTORP (XCAR (XCAR (tem)))))
936
		    XSETCDR (elt, XCDR (tem));
937
		}
938
	      if (CONSP (elt)
939 940
		  && CONSP (XCDR (elt))
		  && EQ (XCAR (XCDR (elt)), Qkeym