keymap.c 94.2 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
2
   Copyright (C) 1985, 86,87,88,93,94,95,98,99 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
#include <stdio.h>
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
27
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
29
#include "termhooks.h"
30
#include "blockinput.h"
31
#include "puresize.h"
Dave Love's avatar
Dave Love committed
32
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
33 34

#define min(a, b) ((a) < (b) ? (a) : (b))
35
#define KEYMAPP(m) (!NILP (Fkeymapp (m)))
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 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 103 104 105 106 107 108 109 110 111
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));
static Lisp_Object describe_buffer_bindings P_ ((Lisp_Object));
static void describe_command P_ ((Lisp_Object));
static void describe_translation P_ ((Lisp_Object));
static void describe_map P_ ((Lisp_Object, Lisp_Object,
			      void (*) P_ ((Lisp_Object)),
			      int, Lisp_Object, Lisp_Object*, int));
Jim Blandy's avatar
Jim Blandy committed
112

Jim Blandy's avatar
Jim Blandy committed
113 114
/* Keymap object support - constructors and predicates.			*/

115
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
116 117
  "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
118 119
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\
120 121 122 123 124
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
125
{
126 127 128 129 130
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
131
  return Fcons (Qkeymap,
132
		Fcons (Fmake_char_table (Qkeymap, Qnil), tail));
Jim Blandy's avatar
Jim Blandy committed
133 134
}

135
DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, Smake_sparse_keymap, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
136 137 138 139
  "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\
140 141 142 143 144
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
145
{
146 147
  if (!NILP (string))
    return Fcons (Qkeymap, Fcons (string, Qnil));
Jim Blandy's avatar
Jim Blandy committed
148 149 150 151 152 153 154 155
  return Fcons (Qkeymap, Qnil);
}

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

   For example:

156
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
157 158 159 160 161 162 163 164 165 166

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

167 168 169 170 171 172 173 174 175
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
176 177 178 179 180 181 182 183 184 185 186
/* 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;
187
  XSETVECTOR (v, tomap);
188
  XSETFASTINT (c, tochar);
Jim Blandy's avatar
Jim Blandy committed
189 190 191 192 193
  frommap->contents[fromchar] = Fcons (v, c);
}
#endif /* 0 */

DEFUN ("keymapp", Fkeymapp, Skeymapp, 1, 1, 0,
194
  "Return t if OBJECT is a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
195
\n\
196
A keymap is a list (keymap . ALIST),\n\
Karl Heuer's avatar
Karl Heuer committed
197
or a symbol whose function definition is itself a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
198
ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
199 200
a vector of densely packed bindings for small character codes\n\
is also allowed as an element.")
Jim Blandy's avatar
Jim Blandy committed
201 202 203
  (object)
     Lisp_Object object;
{
204
  /* FIXME: Maybe this should return t for autoloaded keymaps?   -sm  */
205
  return (NILP (get_keymap_1 (object, 0, 0)) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
206 207 208
}

/* Check that OBJECT is a keymap (after dereferencing through any
209 210 211 212
   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.
213
   If AUTOLOAD is nonzero, callers must assume GC is possible.
214 215 216 217 218 219 220 221

   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
222 223 224 225
   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.  */
226

Jim Blandy's avatar
Jim Blandy committed
227
Lisp_Object
228
get_keymap_1 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
229
     Lisp_Object object;
230
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
231
{
232
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
233

234
 autoload_retry:
235 236 237 238 239 240 241
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
  else
    {
      tem = indirect_function (object);
242
      if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
243 244
	return tem;
    }
245

246 247
  /* Should we do an autoload?  Autoload forms for keymaps have
     Qkeymap as their fifth element.  */
248
  if (autoload
249
      && SYMBOLP (object)
250
      && CONSP (tem)
251
      && EQ (XCAR (tem), Qautoload))
252
    {
253
      Lisp_Object tail;
254

255 256 257 258
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
259

260 261
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
262 263 264 265
	  UNGCPRO;

	  goto autoload_retry;
	}
266 267
    }

268
 end:
Jim Blandy's avatar
Jim Blandy committed
269 270
  if (error)
    wrong_type_argument (Qkeymapp, object);
271
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
272 273
}

274 275 276

/* 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
277 278 279 280
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
281
  return get_keymap_1 (object, 1, 0);
Jim Blandy's avatar
Jim Blandy committed
282
}
283 284 285 286 287 288 289 290 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,
  "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'.  */
297 298
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
299 300
    {
      /* See if there is another `keymap'.  */
301
      if (KEYMAPP (list))
302 303 304 305 306 307
	return list;
    }

  return Qnil;
}

308

309 310 311 312 313 314 315 316 317 318
/* Check whether MAP is one of MAPS parents.  */
int
keymap_memberp (map, maps)
     Lisp_Object map, maps;
{
  while (KEYMAPP (maps) && !EQ (map, maps))
    maps = Fkeymap_parent (maps);
  return (EQ (map, maps));
}

319 320 321 322 323 324 325 326 327
/* 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;
328
  struct gcpro gcpro1;
329
  int i;
Jim Blandy's avatar
Jim Blandy committed
330

331
  keymap = get_keymap_1 (keymap, 1, 1);
332 333
  GCPRO1 (keymap);
  
334
  if (!NILP (parent))
335 336 337 338
    {
      parent = get_keymap_1 (parent, 1, 1);

      /* Check for cycles.  */
339
      if (keymap_memberp (keymap, parent))
340 341
	error ("Cyclic keymap inheritance");
    }
Jim Blandy's avatar
Jim Blandy committed
342

343 344 345 346
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
347
      list = XCDR (prev);
348 349
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
350
      if (! CONSP (list) || KEYMAPP (list))
351
	{
352 353
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
354
	  if (EQ (XCDR (prev), parent))
355
	    RETURN_UNGCPRO (parent);
356

357
	  XCDR (prev) = parent;
358 359 360 361 362 363 364
	  break;
	}
      prev = list;
    }

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

365
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
366 367
    {
      /* Stop the scan when we come to the parent.  */
368
      if (EQ (XCAR (list), Qkeymap))
369 370 371
	break;

      /* If this element holds a prefix map, deal with it.  */
372 373 374 375 376 377 378 379
      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]))
380
	    fix_submap_inheritance (keymap, make_number (i),
381
				    XVECTOR (XCAR (list))->contents[i]);
382

383
      if (CHAR_TABLE_P (XCAR (list)))
384
	{
385
	  Lisp_Object indices[3];
386

387
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
388 389
			  keymap, 0, indices);
	}
390 391
    }

392
  RETURN_UNGCPRO (parent);
393 394 395 396 397 398
}

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

399
static void
400 401 402 403 404 405 406 407
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.  */

408
  submap = get_keymap_1 (get_keyelt (submap, 0), 0, 0);
409 410

  /* If it isn't a keymap now, there's no work to do.  */
411
  if (NILP (submap))
412 413 414 415
    return;

  map_parent = Fkeymap_parent (map);
  if (! NILP (map_parent))
416
    parent_entry = get_keyelt (access_keymap (map_parent, event, 0, 0), 0);
417 418 419
  else
    parent_entry = Qnil;

420 421
  /* If MAP's parent has something other than a keymap,
     our own submap shadows it completely, so use nil as SUBMAP's parent.  */
422
  if (! KEYMAPP (parent_entry))
423 424
    parent_entry = Qnil;

425
  if (! EQ (parent_entry, submap))
426 427 428 429 430 431 432
    {
      Lisp_Object submap_parent;
      submap_parent = submap;
      while (1)
	{
	  Lisp_Object tem;
	  tem = Fkeymap_parent (submap_parent);
433 434
	  if (keymap_memberp (tem, parent_entry))
	    /* Fset_keymap_parent could create a cycle.  */
435
	    return;
436
          if (KEYMAPP (tem))
437 438 439 440 441 442
	    submap_parent = tem;
	  else
	    break;
	}
      Fset_keymap_parent (submap_parent, parent_entry);
    }
443 444
}

Jim Blandy's avatar
Jim Blandy committed
445
/* Look up IDX in MAP.  IDX may be any sort of event.
446
   Note that this does only one level of lookup; IDX must be a single
447 448 449 450 451 452
   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.  

453 454 455
   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
456 457

Lisp_Object
458
access_keymap (map, idx, t_ok, noinherit)
Jim Blandy's avatar
Jim Blandy committed
459 460
     Lisp_Object map;
     Lisp_Object idx;
461
     int t_ok;
462
     int noinherit;
Jim Blandy's avatar
Jim Blandy committed
463
{
464 465 466
  int noprefix = 0;
  Lisp_Object val;

Jim Blandy's avatar
Jim Blandy committed
467 468 469
  /* 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.  */
470
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
471

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

481 482
  {
    Lisp_Object tail;
483
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
484

485
    t_binding = Qnil;
486
    for (tail = map; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
487
      {
488
	Lisp_Object binding;
489

490
	binding = XCAR (tail);
491
	if (SYMBOLP (binding))
492
	  {
493 494 495 496
	    /* 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;
497 498 499
	  }
	else if (CONSP (binding))
	  {
500
	    if (EQ (XCAR (binding), idx))
501
	      {
502
		val = XCDR (binding);
503
		if (noprefix && KEYMAPP (val))
504
		  return Qnil;
505 506
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
507 508
		return val;
	      }
509 510
	    if (t_ok && EQ (XCAR (binding), Qt))
	      t_binding = XCDR (binding);
511 512 513
	  }
	else if (VECTORP (binding))
	  {
514
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size)
515
	      {
516
		val = XVECTOR (binding)->contents[XFASTINT (idx)];
517
		if (noprefix && KEYMAPP (val))
518
		  return Qnil;
519 520
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
521 522
		return val;
	      }
523
	  }
524 525
	else if (CHAR_TABLE_P (binding))
	  {
526 527 528 529 530 531 532
	    /* 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)))
533 534
	      {
		val = Faref (binding, idx);
535
		if (noprefix && KEYMAPP (val))
536 537 538 539 540 541
		  return Qnil;
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
		return val;
	      }
	  }
542 543

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
544
      }
545

546 547
    return t_binding;
  }
Jim Blandy's avatar
Jim Blandy committed
548 549 550 551 552 553 554 555 556
}

/* 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,
557 558 559 560
   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
561 562

Lisp_Object
563
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
564
     register Lisp_Object object;
565
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
566 567 568
{
  while (1)
    {
569 570 571
      if (!(CONSP (object)))
	/* This is really the value.  */
	return object;
Jim Blandy's avatar
Jim Blandy committed
572

573 574 575 576 577 578 579
      /* 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.
580
	 This is a new format menu item.  */
581
      else if (EQ (XCAR (object), Qmenu_item))
582
	{
583
	  if (CONSP (XCDR (object)))
584
	    {
585 586
	      Lisp_Object tem;

587
	      object = XCDR (XCDR (object));
588
	      tem = object;
589 590
	      if (CONSP (object))
		object = XCAR (object);
591 592 593

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

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

634 635
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
636
	{
637 638
	  Lisp_Object map;
	  
639 640 641 642 643 644 645 646
	  map = get_keymap_1 (Fcar_safe (object), 0, autoload);
	  if (NILP (map))
	    /* Invalid keymap */
	    return object;
	  else
	    {
	      Lisp_Object key;
	      key = Fcdr (object);
647
	      if (INTEGERP (key) && (XUINT (key) & meta_modifier))
648 649 650 651 652 653 654 655 656 657
		{
		  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);
	    }
658
	}
Jim Blandy's avatar
Jim Blandy committed
659 660 661
    }
}

662
static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
663 664 665 666 667
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
668
  /* If we are preparing to dump, and DEF is a menu element
669 670
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
671 672
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
673

674
  if (!CONSP (keymap) || ! EQ (XCAR (keymap), Qkeymap))
675 676
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
677 678 679
  /* 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.  */
680
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
681

682 683
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
684
  if (SYMBOLP (idx))
685
    idx = reorder_modifiers (idx);
686 687 688
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
689
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
690 691

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
692
  {
693
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
694

695 696 697 698 699 700
    /* 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.  */
701
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
702

703
    insertion_point = keymap;
704
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
705
      {
706
	Lisp_Object elt;
707

708
	elt = XCAR (tail);
709
	if (VECTORP (elt))
710
	  {
711
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (elt)->size)
712 713 714 715 716
	      {
		XVECTOR (elt)->contents[XFASTINT (idx)] = def;
		return def;
	      }
	    insertion_point = tail;
717
	  }
718 719
	else if (CHAR_TABLE_P (elt))
	  {
720 721 722 723 724 725 726
	    /* 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)))
727 728 729 730 731 732
	      {
		Faset (elt, idx, def);
		return def;
	      }
	    insertion_point = tail;
	  }
733 734
	else if (CONSP (elt))
	  {
735
	    if (EQ (idx, XCAR (elt)))
736
	      {
737
		XCDR (elt) = def;
738 739
		return def;
	      }
740 741 742
	  }
	else if (SYMBOLP (elt))
	  {
743 744 745 746 747 748 749
	    /* 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;
	  }
750 751

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
752 753
      }

754 755 756
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
757 758
    XCDR (insertion_point)
      = Fcons (Fcons (idx, def), XCDR (insertion_point));
759
  }
760
  
Jim Blandy's avatar
Jim Blandy committed
761 762 763
  return def;
}

764
void
765 766 767
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
768 769
  if (!SYMBOLP (elt) && ! NILP (Fkeymapp (elt)))
    Faset (chartable, idx, Fcopy_keymap (elt));
770
}
771

Jim Blandy's avatar
Jim Blandy committed
772 773 774 775
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
776 777 778
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
779 780 781 782 783 784 785
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));

786
  for (tail = copy; CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
787
    {
788
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
789

790
      elt = XCAR (tail);
791 792
      if (CHAR_TABLE_P (elt))
	{
793
	  Lisp_Object indices[3];
794 795

	  elt = Fcopy_sequence (elt);
796
	  XCAR (tail) = elt;
797

798 799 800
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
801
	{
802
	  int i;
Jim Blandy's avatar
Jim Blandy committed
803

804
	  elt = Fcopy_sequence (elt);
805
	  XCAR (tail) = elt;
Jim Blandy's avatar
Jim Blandy committed
806

807
	  for (i = 0; i < XVECTOR (elt)->size; i++)
808
	    if (!SYMBOLP (XVECTOR (elt)->contents[i])
809
		&& ! NILP (Fkeymapp (XVECTOR (elt)->contents[i])))
810 811
	      XVECTOR (elt)->contents[i]
		= Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
812
	}
813
      else if (CONSP (elt) && CONSP (XCDR (elt)))
814
	{
815
	  Lisp_Object tem;
816
	  tem = XCDR (elt);
817

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

884
	}
Jim Blandy's avatar
Jim Blandy committed
885
    }
886
	      
Jim Blandy's avatar
Jim Blandy committed
887 888 889
  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
890 891
/* Simple Keymap mutators and accessors.				*/

892 893
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
894 895 896 897
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
898 899
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
900 901 902 903 904 905 906 907 908 909
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
910 911 912 913
 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
914
  (keymap, key, def)
915
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
916 917 918 919 920 921 922
     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
923
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
924
  int length;
925
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
926

927
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
928

929
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
930 931
    key = wrong_type_argument (Qarrayp, key);

932
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
933 934 935
  if (length == 0)
    return Qnil;

936 937 938
  if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
    Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);

939 940
  GCPRO3 (keymap, key, def);

941
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
942 943 944 945
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
946 947 948 949 950
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

951
      if (CONSP (c) && lucid_event_type_list_p (c))
952
	c = Fevent_convert_list (c);
953

954
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
955
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
956 957 958 959 960 961 962
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
963
	  if (INTEGERP (c))