keymap.c 92.1 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"
Jim Blandy's avatar
Jim Blandy committed
33 34 35

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

36
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
#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
71 72 73
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

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

Jim Blandy's avatar
Jim Blandy committed
78 79 80 81 82
/* Keymap mapping ASCII function key sequences onto their preferred forms.
   Initialized by the terminal-specific lisp files.  See DEFVAR for more
   documentation.  */
Lisp_Object Vfunction_key_map;

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

86 87 88 89 90 91
/* A list of all commands given new bindings since a certain time
   when nil was stored here.
   This is used to speed up recomputation of menu key equivalents
   when Emacs starts up.   t means don't record anything here.  */
Lisp_Object Vdefine_key_rebound_commands;

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

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

99 100
extern Lisp_Object Voverriding_local_map;

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

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

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

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

   For example:

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

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

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

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

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

   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
   Fdefine_key should cause keymaps to be autoloaded.  */

Jim Blandy's avatar
Jim Blandy committed
216
Lisp_Object
217
get_keymap_1 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
218
     Lisp_Object object;
219
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
220
{
221
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
222

223
 autoload_retry:
224 225 226 227 228 229 230
  if (NILP (object))
    goto end;
  if (CONSP (object) && EQ (XCAR (object), Qkeymap))
    return object;
  else
    {
      tem = indirect_function (object);
231
      if (CONSP (tem) && EQ (XCAR (tem), Qkeymap))
232 233
	return tem;
    }
234

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

244 245 246 247
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
248

249 250
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
251 252 253 254
	  UNGCPRO;

	  goto autoload_retry;
	}
255 256
    }

257
 end:
Jim Blandy's avatar
Jim Blandy committed
258 259
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
260 261
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
262 263
}

264 265 266

/* 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
267 268 269 270
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
271
  return get_keymap_1 (object, 1, 0);
Jim Blandy's avatar
Jim Blandy committed
272
}
273 274 275 276 277 278 279 280 281 282 283 284 285 286

/* 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'.  */
287 288
  list = XCDR (keymap);
  for (; CONSP (list); list = XCDR (list))
289 290
    {
      /* See if there is another `keymap'.  */
291
      if (EQ (Qkeymap, XCAR (list)))
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
	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;
  int i;
Jim Blandy's avatar
Jim Blandy committed
308

309 310 311
  keymap = get_keymap_1 (keymap, 1, 1);
  if (!NILP (parent))
    parent = get_keymap_1 (parent, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
312

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

327
	  XCDR (prev) = parent;
328 329 330 331 332 333 334
	  break;
	}
      prev = list;
    }

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

335
  for (list = XCDR (keymap); CONSP (list); list = XCDR (list))
336 337
    {
      /* Stop the scan when we come to the parent.  */
338
      if (EQ (XCAR (list), Qkeymap))
339 340 341
	break;

      /* If this element holds a prefix map, deal with it.  */
342 343 344 345 346 347 348 349
      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]))
350
	    fix_submap_inheritance (keymap, make_number (i),
351
				    XVECTOR (XCAR (list))->contents[i]);
352

353
      if (CHAR_TABLE_P (XCAR (list)))
354
	{
355
	  Lisp_Object indices[3];
356

357
	  map_char_table (fix_submap_inheritance, Qnil, XCAR (list),
358 359
			  keymap, 0, indices);
	}
360 361 362 363 364 365 366 367 368
    }

  return parent;
}

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

369
void
370 371 372 373 374 375 376 377
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.  */

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

      /* Or a new format menu item */
400 401
      else if (EQ (XCAR (submap), Qmenu_item)
	       && CONSP (XCDR (submap)))
402
	{
403
	  submap = XCDR (XCDR (submap));
404
	  if (CONSP (submap))
405
	    submap = XCAR (submap);
406 407 408 409 410
	}
    }

  /* If it isn't a keymap now, there's no work to do.  */
  if (! CONSP (submap)
411
      || ! EQ (XCAR (submap), Qkeymap))
412 413 414 415 416 417 418 419
    return;

  map_parent = Fkeymap_parent (map);
  if (! NILP (map_parent))
    parent_entry = access_keymap (map_parent, event, 0, 0);
  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 (! (CONSP (parent_entry) && EQ (XCAR (parent_entry), Qkeymap)))
423 424
    parent_entry = Qnil;

425
  if (! EQ (parent_entry, submap))
426 427 428 429 430 431 432 433 434 435
    {
      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)
436
	      && EQ (XCAR (tem), Qkeymap))
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 503
		val = XCDR (binding);
		if (noprefix && CONSP (val) && EQ (XCAR (val), Qkeymap))
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 && CONSP (val) && EQ (XCAR (val), Qkeymap))
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 && CONSP (val) && EQ (XCAR (val), Qkeymap))
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 580 581 582
      /* 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.
	 This is a new format menu item.
      */
      else if (EQ (XCAR (object), Qmenu_item))
583
	{
584
	  if (CONSP (XCDR (object)))
585
	    {
586 587 588
	      object = XCDR (XCDR (object));
	      if (CONSP (object))
		object = XCAR (object);
589 590
	    }
	  else
591 592
	    /* Invalid keymap */
	    return object;
593 594
	}

595
      /* If the keymap contents looks like (STRING . DEFN), use DEFN.
Jim Blandy's avatar
Jim Blandy committed
596 597
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
598
      else if (STRINGP (XCAR (object)))
599
	{
600
	  object = XCDR (object);
601 602
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
603 604
	  if (CONSP (object) && STRINGP (XCAR (object)))
	    object = XCDR (object);
605
	  /* Also remove the sublist that caches key equivalences, if any.  */
606
	  if (CONSP (object) && CONSP (XCAR (object)))
607
	    {
608
	      Lisp_Object carcar;
609
	      carcar = XCAR (XCAR (object));
610
	      if (NILP (carcar) || VECTORP (carcar))
611
		object = XCDR (object);
612
	    }
613
	}
Jim Blandy's avatar
Jim Blandy committed
614

615 616
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
      else
617
	{
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
	  register Lisp_Object map;
	  map = get_keymap_1 (Fcar_safe (object), 0, autoload);
	  if (NILP (map))
	    /* Invalid keymap */
	    return object;
	  else
	    {
	      Lisp_Object key;
	      key = Fcdr (object);
	      if (INTEGERP (key) && (XINT (key) & meta_modifier))
		{
		  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);
	    }
638
	}
Jim Blandy's avatar
Jim Blandy committed
639 640 641 642 643 644 645 646 647
    }
}

Lisp_Object
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
648
  /* If we are preparing to dump, and DEF is a menu element
649 650
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
651 652
      && (EQ (XCAR (def), Qmenu_item) || STRINGP (XCAR (def))))
    def = Fcons (XCAR (def), XCDR (def));
653

654
  if (!CONSP (keymap) || ! EQ (XCAR (keymap), Qkeymap))
655 656
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
657 658 659
  /* 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.  */
660
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
661

662 663
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
664
  if (SYMBOLP (idx))
665
    idx = reorder_modifiers (idx);
666 667 668
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
669
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
670 671

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
672
  {
673
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
674

675 676 677 678 679 680
    /* 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.  */
681
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
682

683
    insertion_point = keymap;
684
    for (tail = XCDR (keymap); CONSP (tail); tail = XCDR (tail))
Jim Blandy's avatar
Jim Blandy committed
685
      {
686
	Lisp_Object elt;
687

688
	elt = XCAR (tail);
689
	if (VECTORP (elt))
690
	  {
691
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (elt)->size)
692 693 694 695 696
	      {
		XVECTOR (elt)->contents[XFASTINT (idx)] = def;
		return def;
	      }
	    insertion_point = tail;
697
	  }
698 699
	else if (CHAR_TABLE_P (elt))
	  {
700 701 702 703 704 705 706
	    /* 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)))
707 708 709 710 711 712
	      {
		Faset (elt, idx, def);
		return def;
	      }
	    insertion_point = tail;
	  }
713 714
	else if (CONSP (elt))
	  {
715
	    if (EQ (idx, XCAR (elt)))
716
	      {
717
		XCDR (elt) = def;
718 719
		return def;
	      }
720 721 722
	  }
	else if (SYMBOLP (elt))
	  {
723 724 725 726 727 728 729
	    /* 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;
	  }
730 731

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
732 733
      }

734 735 736
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
737 738
    XCDR (insertion_point)
      = Fcons (Fcons (idx, def), XCDR (insertion_point));
739 740
  }
	  
Jim Blandy's avatar
Jim Blandy committed
741 742 743
  return def;
}

744
void
745 746 747
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
748 749
  if (!SYMBOLP (elt) && ! NILP (Fkeymapp (elt)))
    Faset (chartable, idx, Fcopy_keymap (elt));
750
}
751

Jim Blandy's avatar
Jim Blandy committed
752 753 754 755
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
756 757 758
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
759 760 761 762 763 764 765
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));

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

770
      elt = XCAR (tail);
771 772
      if (CHAR_TABLE_P (elt))
	{
773
	  Lisp_Object indices[3];
774 775

	  elt = Fcopy_sequence (elt);
776
	  XCAR (tail) = elt;
777

778 779 780
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
781
	{
782
	  int i;
Jim Blandy's avatar
Jim Blandy committed
783

784
	  elt = Fcopy_sequence (elt);
785
	  XCAR (tail) = elt;
Jim Blandy's avatar
Jim Blandy committed
786

787
	  for (i = 0; i < XVECTOR (elt)->size; i++)
788
	    if (!SYMBOLP (XVECTOR (elt)->contents[i])
789
		&& ! NILP (Fkeymapp (XVECTOR (elt)->contents[i])))
790 791
	      XVECTOR (elt)->contents[i]
		= Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
792
	}
793
      else if (CONSP (elt) && CONSP (XCDR (elt)))
794
	{
795
	  Lisp_Object tem;
796
	  tem = XCDR (elt);
797

798
	  /* Is this a new format menu item.  */
799
	  if (EQ (XCAR (tem),Qmenu_item))
800 801
	    {
	      /* Copy cell with menu-item marker.  */
802 803 804 805
	      XCDR (elt)
		= Fcons (XCAR (tem), XCDR (tem));
	      elt = XCDR (elt);
	      tem = XCDR (elt);
806 807 808
	      if (CONSP (tem))
		{
		  /* Copy cell with menu-item name.  */
809 810 811 812
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCDR (elt);
813 814 815 816 817
		};
	      if (CONSP (tem))
		{
		  /* Copy cell with binding and if the binding is a keymap,
		     copy that.  */
818 819 820 821
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCAR (elt);
822
		  if (!(SYMBOLP (tem) || NILP (Fkeymapp (tem))))
823 824 825
		    XCAR (elt) = Fcopy_keymap (tem);
		  tem = XCDR (elt);
		  if (CONSP (tem) && CONSP (XCAR (tem)))
826
		    /* Delete cache for key equivalences.  */
827
		    XCDR (elt) = XCDR (tem);
828 829 830 831 832 833 834
		}
	    }
	  else
	    {
	      /* It may be an old fomat menu item.
		 Skip the optional menu string.
	      */
835
	      if (STRINGP (XCAR (tem)))
836
		{
837
		  /* Copy the cell, since copy-alist didn't go this deep.  */
838 839 840 841
		  XCDR (elt)
		    = Fcons (XCAR (tem), XCDR (tem));
		  elt = XCDR (elt);
		  tem = XCDR (elt);
842
		  /* Also skip the optional menu help string.  */
843
		  if (CONSP (tem) && STRINGP (XCAR (tem)))
844
		    {
845 846 847 848
		      XCDR (elt)
			= Fcons (XCAR (tem), XCDR (tem));
		      elt = XCDR (elt);
		      tem = XCDR (elt);
849 850 851 852
		    }
		  /* There may also be a list that caches key equivalences.
		     Just delete it for the new keymap.  */
		  if (CONSP (tem)
853 854 855 856
		      && CONSP (XCAR (tem))
		      && (NILP (XCAR (XCAR (tem)))
			  || VECTORP (XCAR (XCAR (tem)))))
		    XCDR (elt) = XCDR (tem);
857
		}
858
	      if (CONSP (elt)
859 860 861
		  && ! SYMBOLP (XCDR (elt))
		  && ! NILP (Fkeymapp (XCDR (elt))))
		XCDR (elt) = Fcopy_keymap (XCDR (elt));
862
	    }
863

864
	}
Jim Blandy's avatar
Jim Blandy committed
865
    }
866
	      
Jim Blandy's avatar
Jim Blandy committed
867 868 869
  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
870 871
/* Simple Keymap mutators and accessors.				*/

872 873
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
874 875 876 877
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
878 879
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
880 881 882 883 884 885 886 887 888 889
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
890 891 892 893
 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
894
  (keymap, key, def)
895
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
896 897 898 899 900 901 902
     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
903
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
904
  int length;
905
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
906

907
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
908

909
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
910 911
    key = wrong_type_argument (Qarrayp, key);

912
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
913 914 915
  if (length == 0)
    return Qnil;

916 917 918
  if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
    Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);

919 920
  GCPRO3 (keymap, key, def);

921
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
922 923 924 925
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
926 927 928 929 930
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

931
      if (CONSP (c) && lucid_event_type_list_p (c))
932
	c = Fevent_convert_list (c);
933

934
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
935
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
936 937 938 939 940 941 942
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
943
	  if (INTEGERP (c))
944
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
945 946 947 948 949

	  metized = 0;
	  idx++;
	}

950
      if (! INTEGERP (c) && ! SYMBOLP (c) && ! CONSP (c))
951
	error ("Key sequence contains invalid events");
952

Jim Blandy's avatar
Jim Blandy committed
953
      if (idx == length)
954
	RETURN_UNGCPRO (store_in_keymap (keymap, c, def));
Jim Blandy's avatar
Jim Blandy committed
955

956
      cmd = get_keyelt (access_keymap (keymap, c, 0, 1), 1);
Jim Blandy's avatar
Jim Blandy committed
957

958
      /* If this key is undefined, make it a prefix.  */
Jim Blandy's avatar
Jim Blandy committed
959
      if (NILP (cmd))
960
	cmd = define_as_prefix (keymap, c);
Jim Blandy's avatar
Jim Blandy committed
961

962 963
      keymap = get_keymap_1 (cmd, 0, 1);
      if (NILP (keymap))
964 965 966 967
	/* We must use Fkey_description rather than just passing key to
	   error; key might be a vector, not a string.  */
	error ("Key sequence %s uses invalid prefix characters",
	       XSTRING (Fkey_description (key))->data);
Jim Blandy's avatar
Jim Blandy committed
968 969 970 971
    }
}

/* Value is number if KEY is too long; NIL if valid but has no definition. */
972
/* GC is possible in this function if it autoloads a keymap.  */