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

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


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

37
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
#define DENSE_TABLE_SIZE (0200)

/* Actually allocate storage for these variables */

Lisp_Object current_global_map;	/* Current global keymap */

Lisp_Object global_map;		/* default global key bindings */

Lisp_Object meta_map;		/* The keymap used for globally bound
				   ESC-prefixed default commands */

Lisp_Object control_x_map;	/* The keymap used for globally bound
				   C-x-prefixed default commands */

/* was MinibufLocalMap */
Lisp_Object Vminibuffer_local_map;
				/* The keymap used by the minibuf for local
				   bindings when spaces are allowed in the
				   minibuf */

/* was MinibufLocalNSMap */
59
Lisp_Object Vminibuffer_local_ns_map;
Jim Blandy's avatar
Jim Blandy committed
60 61 62 63 64 65 66 67 68 69 70 71
				/* The keymap used by the minibuf for local
				   bindings when spaces are not encouraged
				   in the minibuf */

/* keymap used for minibuffers when doing completion */
/* was MinibufLocalCompletionMap */
Lisp_Object Vminibuffer_local_completion_map;

/* keymap used for minibuffers when doing completion and require a match */
/* was MinibufLocalMustMatchMap */
Lisp_Object Vminibuffer_local_must_match_map;

Jim Blandy's avatar
Jim Blandy committed
72 73 74
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

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

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

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

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

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

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

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

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

106 107
extern Lisp_Object Voverriding_local_map;

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

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

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

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

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

   For example:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

317

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

530 531
  {
    Lisp_Object tail;
532 533 534

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
819 820
      }

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

831 832
EXFUN (Fcopy_keymap, 1);

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

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

Jim Blandy's avatar
Jim Blandy committed
854 855
  register Lisp_Object copy, tail;

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

858
  for (tail = copy; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
859
    {
860
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
861

862
      elt = XCAR (tail);
863 864
      if (CHAR_TABLE_P (elt))
	{
865
	  Lisp_Object indices[3];
866 867

	  elt = Fcopy_sequence (elt);
868
	  XSETCAR (tail, elt);
869

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

876
	  elt = Fcopy_sequence (elt);
877
	  XSETCAR (tail, elt);
Jim Blandy's avatar
Jim Blandy committed
878

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