keymap.c 104 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 51 52 53 54 55 56 57
#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 */
58
Lisp_Object Vminibuffer_local_ns_map;
Jim Blandy's avatar
Jim Blandy committed
59 60 61 62 63 64 65 66 67 68 69 70
				/* 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
71 72 73
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

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

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

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, Qremap;
Jim Blandy's avatar
Jim Blandy committed
96

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

100 101 102
/* Pre-allocated 2-element vector for Fremap_command to use.  */
static Lisp_Object remap_command_vector;

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

108 109
extern Lisp_Object Voverriding_local_map;

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

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

128
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
129 130 131 132 133 134 135 136 137
       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)
138
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
139
{
140 141 142 143 144
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
145
  return Fcons (Qkeymap,
146
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
147 148
}

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

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

   For example:

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

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

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

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

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

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

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

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

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

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

270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
	  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;
	    }
286
	}
287 288
    }

289
 end:
Jim Blandy's avatar
Jim Blandy committed
290 291
  if (error)
    wrong_type_argument (Qkeymapp, object);
292
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
293
}
294 295 296 297 298

/* 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,
299 300
       doc: /* Return the parent keymap of KEYMAP.  */)
     (keymap)
301 302 303 304
     Lisp_Object keymap;
{
  Lisp_Object list;

305
  keymap = get_keymap (keymap, 1, 1);
306 307

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

316
  return get_keymap (list, 0, 1);
317 318
}

319

320 321 322 323 324
/* Check whether MAP is one of MAPS parents.  */
int
keymap_memberp (map, maps)
     Lisp_Object map, maps;
{
325
  if (NILP (map)) return 0;
326 327 328 329 330
  while (KEYMAPP (maps) && !EQ (map, maps))
    maps = Fkeymap_parent (maps);
  return (EQ (map, maps));
}

331 332 333
/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
334 335 336
       doc: /* Modify KEYMAP to set its parent map to PARENT.
PARENT should be nil or another keymap.  */)
     (keymap, parent)
337 338 339
     Lisp_Object keymap, parent;
{
  Lisp_Object list, prev;
340
  struct gcpro gcpro1;
341
  int i;
Jim Blandy's avatar
Jim Blandy committed
342

343 344 345 346 347 348 349 350 351
  /* 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;

352
  keymap = get_keymap (keymap, 1, 1);
353 354
  GCPRO1 (keymap);
  
355
  if (!NILP (parent))
356
    {
357
      parent = get_keymap (parent, 1, 1);
358 359

      /* Check for cycles.  */
360
      if (keymap_memberp (keymap, parent))
361 362
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
363

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

378
	  XSETCDR (prev, parent);
379 380 381 382 383 384 385
	  break;
	}
      prev = list;
    }

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

386
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
387 388
    {
      /* Stop the scan when we come to the parent.  */
389
      if (EQ (XCAR (list), Qkeymap))
390 391 392
	break;

      /* If this element holds a prefix map, deal with it.  */
393 394 395 396 397 398 399 400
      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]))
401
	    fix_submap_inheritance (keymap, make_number (i),
402
				    XVECTOR (XCAR (list))->contents[i]);
403

404
      if (CHAR_TABLE_P (XCAR (list)))
405
	{
406
	  Lisp_Object indices[3];
407

408
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
409 410
			  keymap, 0, indices);
	}
411 412
    }

413
  RETURN_UNGCPRO (parent);
414 415 416 417 418 419
}

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

420
static void
421 422 423 424 425 426 427 428
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.  */

429
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
430 431

  /* If it isn't a keymap now, there's no work to do.  */
432
  if (!CONSP (submap))
433 434 435
    return;

  map_parent = Fkeymap_parent (map);
436
  if (!NILP (map_parent))
437
    parent_entry =
438
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
439 440 441
  else
    parent_entry = Qnil;

442
  /* If MAP's parent has something other than a keymap,
443
     our own submap shadows it completely.  */
444
  if (!CONSP (parent_entry))
445
    return;
446

447
  if (! EQ (parent_entry, submap))
448 449 450 451 452 453
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
454

455
	  tem = Fkeymap_parent (submap_parent);
456 457 458 459 460 461 462 463

	  if (KEYMAPP (tem))
	    {
	      if (keymap_memberp (tem, parent_entry))
		/* Fset_keymap_parent could create a cycle.  */
		return;
	      submap_parent = tem;
	    }
464 465 466 467 468
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
469 470
}

Jim Blandy's avatar
Jim Blandy committed
471
/* Look up IDX in MAP.  IDX may be any sort of event.
472
   Note that this does only one level of lookup; IDX must be a single
473 474 475 476 477 478
   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.  

479 480 481
   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
482 483

Lisp_Object
484
access_keymap (map, idx, t_ok, noinherit, autoload)
Jim Blandy's avatar
Jim Blandy committed
485 486
     Lisp_Object map;
     Lisp_Object idx;
487
     int t_ok;
488
     int noinherit;
489
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
490
{
491 492 493 494
  Lisp_Object val;

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

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

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

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

532 533
  {
    Lisp_Object tail;
534 535 536

    /* t_binding is where we put a default binding that applies,
       to use in case we do not find a binding specifically
537
       for this key sequence.  */
538 539 540

    Lisp_Object t_binding;
    t_binding = Qnil;
541 542 543 544 545

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

547
    for (tail = XCDR (map);
548
	 (CONSP (tail)
549
	  || (tail = get_keymap (tail, 0, autoload), CONSP (tail)));
550
	 tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
551
      {
552
	Lisp_Object binding;
553

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

613 614 615
	/* If we found a binding, clean it up and return it.  */
	if (!EQ (val, Qunbound))
	  {
616 617 618 619 620
	    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;
621 622 623 624 625
	    val = get_keyelt (val, autoload);
	    if (KEYMAPP (val))
	      fix_submap_inheritance (map, idx, val);
	    return val;
	  }
626
	QUIT;
Jim Blandy's avatar
Jim Blandy committed
627
      }
628

629
    return get_keyelt (t_binding, autoload);
630
  }
Jim Blandy's avatar
Jim Blandy committed
631 632 633 634 635 636 637 638 639
}

/* 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,
640 641 642 643
   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
644 645

Lisp_Object
646
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
647
     register Lisp_Object object;
648
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
649 650 651
{
  while (1)
    {
652 653 654
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
655

656 657 658 659 660 661 662
      /* 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.
663
	 This is a new format menu item.  */
664
      else if (EQ (XCAR (object), Qmenu_item))
665
	{
666
	  if (CONSP (XCDR (object)))
667
	    {
668 669
	      Lisp_Object tem;

670
	      object = XCDR (XCDR (object));
671
	      tem = object;
672 673
	      if (CONSP (object))
		object = XCAR (object);
674 675 676

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

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

713 714
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
715
	{
716
	  Lisp_Object map;
717 718
	  map = get_keymap (Fcar_safe (object), 0, autoload);
	  return (!CONSP (map) ? object /* Invalid keymap */
719
		  : access_keymap (map, Fcdr (object), 0, 0, autoload));
720
	}
Jim Blandy's avatar
Jim Blandy committed
721 722 723
    }
}

724
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
725 726 727 728 729
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
730 731 732 733
  /* Flush any reverse-map cache.  */
  where_is_cache = Qnil;
  where_is_cache_keymaps = Qt;

734
  /* If we are preparing to dump, and DEF is a menu element
735 736
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
737 738
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
739

740
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
741 742
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
743 744 745
  /* 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.  */
746
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
747

748 749
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
750
  if (SYMBOLP (idx))
751
    idx = reorder_modifiers (idx);
752 753 754
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
755
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
756 757

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
758
  {
759
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
760

761 762 763 764 765 766
    /* 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.  */
767
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
768

769
    insertion_point = keymap;
770
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
771
      {
772
	Lisp_Object elt;
773

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

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
816 817
      }

818 819 820
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
821 822
    XSETCDR (insertion_point,
	     Fcons (Fcons (idx, def), XCDR (insertion_point)));
823
  }
824
  
Jim Blandy's avatar
Jim Blandy committed
825 826 827
  return def;
}

828 829
EXFUN (Fcopy_keymap, 1);

830
void
831 832 833
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
834
  if (CONSP (elt) && EQ (XCAR (elt), Qkeymap))
835
    Faset (chartable, idx, Fcopy_keymap (elt));
836
}
837

Jim Blandy's avatar
Jim Blandy committed
838
DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0,
839 840 841 842 843 844 845
       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
846 847
     Lisp_Object keymap;
{
848 849 850
  /* FIXME: This doesn't properly copy menu-items in vectors.  */
  /* FIXME: This also copies the parent keymap.  */

Jim Blandy's avatar
Jim Blandy committed
851 852
  register Lisp_Object copy, tail;

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

855
  for (tail = copy; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
856
    {
857
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
858

859
      elt = XCAR (tail);
860 861
      if (CHAR_TABLE_P (elt))
	{
862
	  Lisp_Object indices[3];
863 864

	  elt = Fcopy_sequence (elt);
865
	  XSETCAR (tail, elt);
866

867 868 869
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
870
	{
871
	  int i;
Jim Blandy's avatar
Jim Blandy committed
872

873
	  elt = Fcopy_sequence (elt);
874
	  XSETCAR (tail, elt);
Jim Blandy's avatar
Jim Blandy committed
875

876
	  for (i = 0; i < ASIZE (elt); i++)
877
	    if (CONSP (AREF (elt, i)) && EQ (XCAR (AREF (elt, i)), Qkeymap))
878
	      ASET (elt, i, Fcopy_keymap (AREF (elt, i)));
Jim Blandy's avatar
Jim Blandy committed
879
	}
880
      else if (CONSP (elt) && CONSP (XCDR (elt)))
881
	{
882
	  Lisp_Object tem;
883
	  tem = XCDR (elt);
884

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