keymap.c 103 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;

Jim Blandy's avatar
Jim Blandy committed
78 79 80 81 82
/* 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;

83 84 85
/* Keymap mapping ASCII function key sequences onto their preferred forms.  */
Lisp_Object Vkey_translation_map;

86 87 88 89 90 91
/* 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;

92
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii, Qmenu_item, Qremap;
Jim Blandy's avatar
Jim Blandy committed
93

94 95 96
/* Alist of elements like (DEL . "\d").  */
static Lisp_Object exclude_keys;

97 98 99
/* Pre-allocated 2-element vector for Fremap_command to use.  */
static Lisp_Object remap_command_vector;

Jim Blandy's avatar
Jim Blandy committed
100 101 102
/* 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
103 104
extern Lisp_Object meta_prefix_char;

105 106
extern Lisp_Object Voverriding_local_map;

107 108 109 110 111
/* 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;

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

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

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

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

   For example:

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

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

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

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

227 228 229
   If the map needs to be autoloaded, but AUTOLOAD is zero (and ERROR
   is zero as well), return Qt.

230 231 232 233 234 235 236
   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
237 238 239 240
   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.  */
241

Jim Blandy's avatar
Jim Blandy committed
242
Lisp_Object
243
get_keymap (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
244
     Lisp_Object object;
245
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
246
{
247
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
248

249
 autoload_retry:
250 251 252 253
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
254

255 256
  tem = indirect_function (object);
  if (CONSP (tem))
257
    {
258 259
      if (EQ (XCAR (tem), Qkeymap))
	return tem;
260

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

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

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

302
  keymap = get_keymap (keymap, 1, 1);
303 304

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

313
  return get_keymap (list, 0, 1);
314 315
}

316

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

328 329 330
/* Set the parent keymap of MAP to PARENT.  */

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

340 341 342 343 344 345 346 347 348
  /* 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;

349
  keymap = get_keymap (keymap, 1, 1);
350 351
  GCPRO1 (keymap);
  
352
  if (!NILP (parent))
353
    {
354
      parent = get_keymap (parent, 1, 1);
355 356

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

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

375
	  XSETCDR (prev, parent);
376 377 378 379 380 381 382
	  break;
	}
      prev = list;
    }

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

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

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

401
      if (CHAR_TABLE_P (XCAR (list)))
402
	{
403
	  Lisp_Object indices[3];
404

405
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
406 407
			  keymap, 0, indices);
	}
408 409
    }

410
  RETURN_UNGCPRO (parent);
411 412 413 414 415 416
}

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

417
static void
418 419 420 421 422 423 424 425
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.  */

426
  submap = get_keymap (get_keyelt (submap, 0), 0, 0);
427 428

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

  map_parent = Fkeymap_parent (map);
433
  if (!NILP (map_parent))
434
    parent_entry =
435
      get_keymap (access_keymap (map_parent, event, 0, 0, 0), 0, 0);
436 437 438
  else
    parent_entry = Qnil;

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

444
  if (! EQ (parent_entry, submap))
445 446 447 448 449 450
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
451

452
	  tem = Fkeymap_parent (submap_parent);
453 454 455 456 457 458 459 460

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

476 477 478
   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
479 480

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

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

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

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

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

529 530
  {
    Lisp_Object tail;
531 532 533

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

    Lisp_Object t_binding;
    t_binding = Qnil;
538 539 540 541 542

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

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

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

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

626
    return get_keyelt (t_binding, autoload);
627
  }
Jim Blandy's avatar
Jim Blandy committed
628 629 630 631 632 633 634 635 636
}

/* 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,
637 638 639 640
   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
641 642

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

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

667
	      object = XCDR (XCDR (object));
668
	      tem = object;
669 670
	      if (CONSP (object))
		object = XCAR (object);
671 672 673

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

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

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

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

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

737
  if (!CONSP (keymap) || !EQ (XCAR (keymap), Qkeymap))
738 739
    error ("attempt to define a key in a non-keymap");

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

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

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
755
  {
756
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
757

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

766
    insertion_point = keymap;
767
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
768
      {
769
	Lisp_Object elt;
770

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

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
813 814
      }

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

825 826
EXFUN (Fcopy_keymap, 1);

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

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

Jim Blandy's avatar
Jim Blandy committed
848 849
  register Lisp_Object copy, tail;

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

852
  for (tail = copy; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
853
    {
854
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
855

856
      elt = XCAR (tail);
857 858
      if (CHAR_TABLE_P (elt))
	{
859
	  Lisp_Object indices[3];
860 861

	  elt = Fcopy_sequence (elt);
862
	  XSETCAR (tail, elt);
863

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

870
	  elt = Fcopy_sequence (elt);
871
	  XSETCAR (tail, elt);
Jim Blandy's avatar
Jim Blandy committed
872

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

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