keymap.c 94.5 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 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

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


22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23 24 25 26 27
#include <stdio.h>
#undef NULL
#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"
Jim Blandy's avatar
Jim Blandy committed
34 35 36

#define min(a, b) ((a) < (b) ? (a) : (b))

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 59 60 61 62 63 64 65 66 67 68 69 70 71
#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 */
Lisp_Object Vminibuffer_local_ns_map;			
				/* 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;
Jim Blandy's avatar
Jim Blandy committed
94

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

100 101
extern Lisp_Object Voverriding_local_map;

102
static Lisp_Object define_as_prefix ();
Jim Blandy's avatar
Jim Blandy committed
103
static Lisp_Object describe_buffer_bindings ();
104
static void describe_command (), describe_translation ();
Jim Blandy's avatar
Jim Blandy committed
105 106
static void describe_map ();

Jim Blandy's avatar
Jim Blandy committed
107 108
/* Keymap object support - constructors and predicates.			*/

109
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
110 111
  "Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST).\n\
CHARTABLE is a char-table that holds the bindings for the ASCII\n\
Jim Blandy's avatar
Jim Blandy committed
112 113
characters.  ALIST is an assoc-list which holds bindings for function keys,\n\
mouse events, and any other things that appear in the input stream.\n\
114 115 116 117 118
All entries in it are initially nil, meaning \"command undefined\".\n\n\
The optional arg STRING supplies a menu name for the keymap\n\
in case you use it as a menu with `x-popup-menu'.")
  (string)
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
119
{
120 121 122 123 124
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
125
  return Fcons (Qkeymap,
126
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
127 128
}

129
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
130 131 132 133
  "Construct and return a new sparse-keymap list.\n\
Its car is `keymap' and its cdr is an alist of (CHAR . DEFINITION),\n\
which binds the character CHAR to DEFINITION, or (SYMBOL . DEFINITION),\n\
which binds the function key or mouse event SYMBOL to DEFINITION.\n\
134 135 136 137 138
Initially the alist is nil.\n\n\
The optional arg STRING supplies a menu name for the keymap\n\
in case you use it as a menu with `x-popup-menu'.")
  (string)
     Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
139
{
140 141
  if (!NILP (string))
    return Fcons (Qkeymap, Fcons (string, Qnil));
Jim Blandy's avatar
Jim Blandy committed
142 143 144 145 146 147 148 149
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

150
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
151 152 153 154 155 156 157 158 159 160

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

161 162 163 164 165 166 167 168 169
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
170 171 172 173 174 175 176 177 178 179 180
/* Define character fromchar in map frommap as an alias for character
   tochar in map tomap.  Subsequent redefinitions of the latter WILL
   affect the former. */

#if 0
void
synkey (frommap, fromchar, tomap, tochar)
     struct Lisp_Vector *frommap, *tomap;
     int fromchar, tochar;
{
  Lisp_Object v, c;
181
  XSETVECTOR (v, tomap);
182
  XSETFASTINT (c, tochar);
Jim Blandy's avatar
Jim Blandy committed
183 184 185 186 187
  frommap->contents[fromchar] = Fcons (v, c);
}
#endif /* 0 */

DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
188
  "Return t if OBJECT is a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
189
\n\
190
A keymap is a list (keymap . ALIST),\n\
Karl Heuer's avatar
Karl Heuer committed
191
or a symbol whose function definition is itself a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
192
ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
193 194
a vector of densely packed bindings for small character codes\n\
is also allowed as an element.")
Jim Blandy's avatar
Jim Blandy committed
195 196 197
  (object)
     Lisp_Object object;
{
198
  return (NILP (get_keymap_1 (object, 0, 0)) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
199 200 201
}

/* Check that OBJECT is a keymap (after dereferencing through any
202 203 204 205
   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.
206
   If AUTOLOAD is nonzero, callers must assume GC is possible.
207 208 209 210 211 212 213 214

   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
215 216 217 218
   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.  */
219

Jim Blandy's avatar
Jim Blandy committed
220
Lisp_Object
221
get_keymap_1 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
222
     Lisp_Object object;
223
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
224
{
225
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
226

227
 autoload_retry:
228 229 230 231 232 233 234
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
  else
    {
      tem = indirect_function (object);
235
      if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
236 237
	return tem;
    }
238

239 240
  /* Should we do an autoload?  Autoload forms for keymaps have
     Qkeymap as their fifth element.  */
241
  if (autoload
242
      && SYMBOLP (object)
243
      && CONSP (tem)
244
      && EQ (XCAR (tem), Qautoload))
245
    {
246
      Lisp_Object tail;
247

248 249 250 251
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
252

253 254
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
255 256 257 258
	  UNGCPRO;

	  goto autoload_retry;
	}
259 260
    }

261
 end:
Jim Blandy's avatar
Jim Blandy committed
262 263
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
264 265
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
266 267
}

268 269 270

/* Follow any symbol chaining, and return the keymap denoted by OBJECT.
   If OBJECT doesn't denote a keymap at all, signal an error.  */
Jim Blandy's avatar
Jim Blandy committed
271 272 273 274
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
275
  return get_keymap_1 (object, 1, 0);
Jim Blandy's avatar
Jim Blandy committed
276
}
277 278 279 280 281 282 283 284 285 286 287 288 289 290

/* 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,
  "Return the parent keymap of KEYMAP.")
  (keymap)
     Lisp_Object keymap;
{
  Lisp_Object list;

  keymap = get_keymap_1 (keymap, 1, 1);

  /* Skip past the initial element `keymap'.  */
291 292
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
293 294
    {
      /* See if there is another `keymap'.  */
295
      if (EQ (Qkeymap, XCAR (list)))
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
	return list;
    }

  return Qnil;
}

/* Set the parent keymap of MAP to PARENT.  */

DEFUN ("set-keymap-parent", Fset_keymap_parent, Sset_keymap_parent, 2, 2, 0,
  "Modify KEYMAP to set its parent map to PARENT.\n\
PARENT should be nil or another keymap.")
  (keymap, parent)
     Lisp_Object keymap, parent;
{
  Lisp_Object list, prev;
311
  struct gcpro gcpro1;
312
  int i;
Jim Blandy's avatar
Jim Blandy committed
313

314
  keymap = get_keymap_1 (keymap, 1, 1);
315 316
  GCPRO1 (keymap);
  
317 318
  if (!NILP (parent))
    parent = get_keymap_1 (parent, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
319

320 321 322 323
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
324
      list = XCDR (prev);
325 326
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
327
      if (! CONSP (list) || EQ (Qkeymap, XCAR (list)))
328
	{
329 330
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
331
	  if (EQ (XCDR (prev), parent))
332
	    RETURN_UNGCPRO (parent);
333

334
	  XCDR (prev) = parent;
335 336 337 338 339 340 341
	  break;
	}
      prev = list;
    }

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

342
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
343 344
    {
      /* Stop the scan when we come to the parent.  */
345
      if (EQ (XCAR (list), Qkeymap))
346 347 348
	break;

      /* If this element holds a prefix map, deal with it.  */
349 350 351 352 353 354 355 356
      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]))
357
	    fix_submap_inheritance (keymap, make_number (i),
358
				    XVECTOR (XCAR (list))->contents[i]);
359

360
      if (CHAR_TABLE_P (XCAR (list)))
361
	{
362
	  Lisp_Object indices[3];
363

364
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
365 366
			  keymap, 0, indices);
	}
367 368
    }

369
  RETURN_UNGCPRO (parent);
370 371 372 373 374 375
}

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

376
void
377 378 379 380 381 382 383 384
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.  */

385
  if (CONSP (submap))
386
    {
387
      /* May be an old format menu item */
388
      if (STRINGP (XCAR (submap)))
389
	{
390
	  submap = XCDR (submap);
391 392
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
393 394
	  if (CONSP (submap) && STRINGP (XCAR (submap)))
	    submap = XCDR (submap);
395 396
	  /* Also remove the sublist that caches key equivalences, if any.  */
	  if (CONSP (submap)
397
	      && CONSP (XCAR (submap)))
398 399
	    {
	      Lisp_Object carcar;
400
	      carcar = XCAR (XCAR (submap));
401
	      if (NILP (carcar) || VECTORP (carcar))
402
		submap = XCDR (submap);
403 404 405 406
	    }
	}

      /* Or a new format menu item */
407 408
      else if (EQ (XCAR (submap), Qmenu_item)
	       && CONSP (XCDR (submap)))
409
	{
410
	  submap = XCDR (XCDR (submap));
411
	  if (CONSP (submap))
412
	    submap = XCAR (submap);
413 414 415 416 417
	}
    }

  /* If it isn't a keymap now, there's no work to do.  */
  if (! CONSP (submap)
418
      || ! EQ (XCAR (submap), Qkeymap))
419 420 421 422 423 424 425 426
    return;

  map_parent = Fkeymap_parent (map);
  if (! NILP (map_parent))
    parent_entry = access_keymap (map_parent, event, 0, 0);
  else
    parent_entry = Qnil;

427 428
  /* If MAP's parent has something other than a keymap,
     our own submap shadows it completely, so use nil as SUBMAP's parent.  */
429
  if (! (CONSP (parent_entry) && EQ (XCAR (parent_entry), Qkeymap)))
430 431
    parent_entry = Qnil;

432
  if (! EQ (parent_entry, submap))
433 434 435 436 437 438 439 440 441 442
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
	  tem = Fkeymap_parent (submap_parent);
	  if (EQ (tem, parent_entry))
	    return;
          if (CONSP (tem)
443
	      && EQ (XCAR (tem), Qkeymap))
444 445 446 447 448 449
	    submap_parent = tem;
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
450 451
}

Jim Blandy's avatar
Jim Blandy committed
452
/* Look up IDX in MAP.  IDX may be any sort of event.
453
   Note that this does only one level of lookup; IDX must be a single
454 455 456 457 458 459
   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.  

460 461 462
   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
463 464

Lisp_Object
465
access_keymap (map, idx, t_ok, noinherit)
Jim Blandy's avatar
Jim Blandy committed
466 467
     Lisp_Object map;
     Lisp_Object idx;
468
     int t_ok;
469
     int noinherit;
Jim Blandy's avatar
Jim Blandy committed
470
{
471 472 473
  int noprefix = 0;
  Lisp_Object val;

Jim Blandy's avatar
Jim Blandy committed
474 475 476
  /* 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.  */
477
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
478

479 480
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
481
  if (SYMBOLP (idx))
482
    idx = reorder_modifiers (idx);
483 484 485
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
486
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
487

488 489
  {
    Lisp_Object tail;
490
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
491

492
    t_binding = Qnil;
493
    for (tail = map; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
494
      {
495
	Lisp_Object binding;
496

497
	binding = XCAR (tail);
498
	if (SYMBOLP (binding))
499
	  {
500 501 502 503
	    /* If NOINHERIT, stop finding prefix definitions
	       after we pass a second occurrence of the `keymap' symbol.  */
	    if (noinherit && EQ (binding, Qkeymap) && ! EQ (tail, map))
	      noprefix = 1;
504 505 506
	  }
	else if (CONSP (binding))
	  {
507
	    if (EQ (XCAR (binding), idx))
508
	      {
509 510
		val = XCDR (binding);
		if (noprefix && CONSP (val) && EQ (XCAR (val), Qkeymap))
511
		  return Qnil;
512 513
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
514 515
		return val;
	      }
516 517
	    if (t_ok && EQ (XCAR (binding), Qt))
	      t_binding = XCDR (binding);
518 519 520
	  }
	else if (VECTORP (binding))
	  {
521
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size)
522
	      {
523
		val = XVECTOR (binding)->contents[XFASTINT (idx)];
524
		if (noprefix && CONSP (val) && EQ (XCAR (val), Qkeymap))
525
		  return Qnil;
526 527
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
528 529
		return val;
	      }
530
	  }
531 532
	else if (CHAR_TABLE_P (binding))
	  {
533 534 535 536 537 538 539
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
	    if (NATNUMP (idx)
		&& ! (XFASTINT (idx)
		      & (CHAR_ALT | CHAR_SUPER | CHAR_HYPER
			 | CHAR_SHIFT | CHAR_CTL | CHAR_META)))
540 541
	      {
		val = Faref (binding, idx);
542
		if (noprefix && CONSP (val) && EQ (XCAR (val), Qkeymap))
543 544 545 546 547 548
		  return Qnil;
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
		return val;
	      }
	  }
549 550

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
551
      }
552

553 554
    return t_binding;
  }
Jim Blandy's avatar
Jim Blandy committed
555 556 557 558 559 560 561 562 563
}

/* 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,
564 565 566 567
   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
568 569

Lisp_Object
570
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
571
     register Lisp_Object object;
572
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
573 574 575
{
  while (1)
    {
576 577 578
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
579

580 581 582 583 584 585 586
      /* 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.
587
	 This is a new format menu item.  */
588
      else if (EQ (XCAR (object), Qmenu_item))
589
	{
590
	  if (CONSP (XCDR (object)))
591
	    {
592 593
	      Lisp_Object tem;

594
	      object = XCDR (XCDR (object));
595
	      tem = object;
596 597
	      if (CONSP (object))
		object = XCAR (object);
598 599 600

	      /* If there's a `:filter FILTER', apply FILTER to the
		 menu-item's definition to get the real definition to
601 602 603
		 use.  Temporarily inhibit GC while evaluating FILTER,
	         because not functions calling get_keyelt are prepared
		 for a GC.  */
604 605 606
	      for (; CONSP (tem) && CONSP (XCDR (tem)); tem = XCDR (tem))
		if (EQ (XCAR (tem), QCfilter))
		  {
607
		    int count = inhibit_garbage_collection ();
608 609 610 611
		    Lisp_Object filter;
		    filter = XCAR (XCDR (tem));
		    filter = list2 (filter, list2 (Qquote, object));
		    object = menu_item_eval_property (filter);
612
		    unbind_to (count, Qnil);
613 614
		    break;
		  }
615 616
	    }
	  else
617 618
	    /* Invalid keymap */
	    return object;
619 620
	}

621
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
622 623
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
624
      else if (STRINGP (XCAR (object)))
625
	{
626
	  object = XCDR (object);
627 628
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
629 630
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
631
	  /* Also remove the sublist that caches key equivalences, if any.  */
632
	  if (CONSP (object) && CONSP (XCAR (object)))
633
	    {
634
	      Lisp_Object carcar;
635
	      carcar = XCAR (XCAR (object));
636
	      if (NILP (carcar) || VECTORP (carcar))
637
		object = XCDR (object);
638
	    }
639
	}
Jim Blandy's avatar
Jim Blandy committed
640

641 642
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
643
	{
644 645
	  Lisp_Object map;
	  
646 647 648 649 650 651 652 653
	  map = get_keymap_1 (Fcar_safe (object), 0, autoload);
	  if (NILP (map))
	    /* Invalid keymap */
	    return object;
	  else
	    {
	      Lisp_Object key;
	      key = Fcdr (object);
654
	      if (INTEGERP (key) && (XUINT (key) & meta_modifier))
655 656 657 658 659 660 661 662 663 664
		{
		  object = access_keymap (map, meta_prefix_char, 0, 0);
		  map = get_keymap_1 (object, 0, autoload);
		  object = access_keymap (map, make_number (XINT (key)
							    & ~meta_modifier),
					  0, 0);
		}
	      else
		object = access_keymap (map, key, 0, 0);
	    }
665
	}
Jim Blandy's avatar
Jim Blandy committed
666 667 668 669 670 671 672 673 674
    }
}

Lisp_Object
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
675
  /* If we are preparing to dump, and DEF is a menu element
676 677
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
678 679
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
680

681
  if (!CONSP (keymap) || ! EQ (XCAR (keymap), Qkeymap))
682 683
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
684 685 686
  /* 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.  */
687
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
688

689 690
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
691
  if (SYMBOLP (idx))
692
    idx = reorder_modifiers (idx);
693 694 695
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
696
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
697 698

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
699
  {
700
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
701

702 703 704 705 706 707
    /* 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.  */
708
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
709

710
    insertion_point = keymap;
711
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
712
      {
713
	Lisp_Object elt;
714

715
	elt = XCAR (tail);
716
	if (VECTORP (elt))
717
	  {
718
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (elt)->size)
719 720 721 722 723
	      {
		XVECTOR (elt)->contents[XFASTINT (idx)] = def;
		return def;
	      }
	    insertion_point = tail;
724
	  }
725 726
	else if (CHAR_TABLE_P (elt))
	  {
727 728 729 730 731 732 733
	    /* Character codes with modifiers
	       are not included in a char-table.
	       All character codes without modifiers are included.  */
	    if (NATNUMP (idx)
		&& ! (XFASTINT (idx)
		      & (CHAR_ALT | CHAR_SUPER | CHAR_HYPER
			 | CHAR_SHIFT | CHAR_CTL | CHAR_META)))
734 735 736 737 738 739
	      {
		Faset (elt, idx, def);
		return def;
	      }
	    insertion_point = tail;
	  }
740 741
	else if (CONSP (elt))
	  {
742
	    if (EQ (idx, XCAR (elt)))
743
	      {
744
		XCDR (elt) = def;
745 746
		return def;
	      }
747 748 749
	  }
	else if (SYMBOLP (elt))
	  {
750 751 752 753 754 755 756
	    /* 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.  */
	    if (EQ (elt, Qkeymap))
	      goto keymap_end;
	  }
757 758

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
759 760
      }

761 762 763
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
764 765
    XCDR (insertion_point)
      = Fcons (Fcons (idx, def), XCDR (insertion_point));
766 767
  }
	  
Jim Blandy's avatar
Jim Blandy committed
768 769 770
  return def;
}

771
void
772 773 774
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
775 776
  if (!SYMBOLP (elt) && ! NILP (Fkeymapp (elt)))
    Faset (chartable, idx, Fcopy_keymap (elt));
777
}
778

Jim Blandy's avatar
Jim Blandy committed
779 780 781 782
DEFUN ("copy-keymap", Fcopy_keymap, Scopy_keymap, 1, 1, 0,
  "Return a copy of the keymap KEYMAP.\n\
The copy starts out with the same definitions of KEYMAP,\n\
but changing either the copy or KEYMAP does not affect the other.\n\
Jim Blandy's avatar
Jim Blandy committed
783 784 785
Any key definitions that are subkeymaps are recursively copied.\n\
However, a key definition which is a symbol whose definition is a keymap\n\
is not copied.")
Jim Blandy's avatar
Jim Blandy committed
786 787 788 789 790 791 792
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));

793
  for (tail = copy; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
794
    {
795
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
796

797
      elt = XCAR (tail);
798 799
      if (CHAR_TABLE_P (elt))
	{
800
	  Lisp_Object indices[3];
801 802

	  elt = Fcopy_sequence (elt);
803
	  XCAR (tail) = elt;
804

805 806 807
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
808
	{
809
	  int i;
Jim Blandy's avatar
Jim Blandy committed
810

811
	  elt = Fcopy_sequence (elt);
812
	  XCAR (tail) = elt;
Jim Blandy's avatar
Jim Blandy committed
813

814
	  for (i = 0; i < XVECTOR (elt)->size; i++)
815
	    if (!SYMBOLP (XVECTOR (elt)->contents[i])
816
		&& ! NILP (Fkeymapp (XVECTOR (elt)->contents[i])))
817 818
	      XVECTOR (elt)->contents[i]
		= Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
819
	}
820
      else if (CONSP (elt) && CONSP (XCDR (elt)))
821
	{
822
	  Lisp_Object tem;
823
	  tem = XCDR (elt);
824

825
	  /* Is this a new format menu item.  */
826
	  if (EQ (XCAR (tem),Qmenu_item))
827 828
	    {
	      /* Copy cell with menu-item marker.  */
829 830 831 832
	      XCDR (elt)
		= Fcons (XCAR (tem), XCDR (tem));
	      elt = XCDR (elt);
	      tem = XCDR (elt);
833 834 835
	      if (CONSP (tem))
		{
		  /* Copy cell with menu-item name.  */
836 837 838 839
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCDR (elt);
840 841 842 843 844
		};
	      if (CONSP (tem))
		{
		  /* Copy cell with binding and if the binding is a keymap,
		     copy that.  */
845 846 847 848
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCAR (elt);
849
		  if (!(SYMBOLP (tem) || NILP (Fkeymapp (tem))))
850 851 852
		    XCAR (elt) = Fcopy_keymap (tem);
		  tem = XCDR (elt);
		  if (CONSP (tem) && CONSP (XCAR (tem)))
853
		    /* Delete cache for key equivalences.  */
854
		    XCDR (elt) = XCDR (tem);
855 856 857 858 859 860 861
		}
	    }
	  else
	    {
	      /* It may be an old fomat menu item.
		 Skip the optional menu string.
	      */
862
	      if (STRINGP (XCAR (tem)))
863
		{
864
		  /* Copy the cell, since copy-alist didn't go this deep.  */
865 866 867 868
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCDR (elt);
869
		  /* Also skip the optional menu help string.  */
870
		  if (CONSP (tem) && STRINGP (XCAR (tem)))
871
		    {
872 873 874 875
		      XCDR (elt)
			= Fcons (XCAR (tem), XCDR (tem));
		      elt = XCDR (elt);
		      tem = XCDR (elt);
876 877 878 879
		    }
		  /* There may also be a list that caches key equivalences.
		     Just delete it for the new keymap.  */
		  if (CONSP (tem)
880 881 882 883
		      && CONSP (XCAR (tem))
		      && (NILP (XCAR (XCAR (tem)))
			  || VECTORP (XCAR (XCAR (tem)))))
		    XCDR (elt) = XCDR (tem);
884
		}
885
	      if (CONSP (elt)
886 887 888
		  && ! SYMBOLP (XCDR (elt))
		  && ! NILP (Fkeymapp (XCDR (elt))))
		XCDR (elt) = Fcopy_keymap (XCDR (elt));
889
	    }
890

891
	}
Jim Blandy's avatar
Jim Blandy committed
892
    }
893
	      
Jim Blandy's avatar
Jim Blandy committed
894 895 896
  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
897 898
/* Simple Keymap mutators and accessors.				*/

899 900
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
901 902 903 904
DEFUN ("define-key", Fdefine_key, Sdefine_key, 3, 3, 0,
  "Args KEYMAP, KEY, DEF.  Define key sequence KEY, in KEYMAP, as DEF.\n\
KEYMAP is a keymap.  KEY is a string or a vector of symbols and characters\n\
meaning a sequence of keystrokes and events.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
905 906
Non-ASCII characters with codes above 127 (such as ISO Latin-1)\n\
can be included if you use a vector.\n\
Jim Blandy's avatar
Jim Blandy committed
907 908 909 910 911 912 913 914 915 916
DEF is anything that can be a key's definition:\n\
 nil (means key is undefined in this keymap),\n\
 a command (a Lisp function suitable for interactive calling)\n\
 a string (treated as a keyboard macro),\n\
 a keymap (to define a prefix key),\n\
 a symbol.  When the key is looked up, the symbol will stand for its\n\
    function definition, which should at that time be one of the above,\n\
    or another symbol whose function definition is used, etc.\n\
 a cons (STRING . DEFN), meaning that DEFN is the definition\n\
    (DEFN should be a valid definition in its own right),\n\
Jim Blandy's avatar
Jim Blandy committed
917 918 919 920
 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.\n\
\n\
If KEYMAP is a sparse keymap, the pair binding KEY to DEF is added at\n\
the front of KEYMAP.")
Jim Blandy's avatar
Jim Blandy committed
921
  (keymap, key, def)
922
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
923 924 925 926 927 928 929
     Lisp_Object key;
     Lisp_Object def;
{
  register int idx;
  register Lisp_Object c;
  register Lisp_Object cmd;
  int metized = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
930
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
931
  int length;
932
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
933

934
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
935

936
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
937 938
    key = wrong_type_argument (Qarrayp, key);

939
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
940 941 942
  if (length == 0)
    return Qnil;

943 944 945
  if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
    Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);

946 947
  GCPRO3 (keymap, key, def);

948
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
949 950 951 952
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
953 954 955 956 957
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

958
      if (CONSP (c) && lucid_event_type_list_p (c))
959
	c = Fevent_convert_list (c);
960