keymap.c 91.5 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
Richard M. Stallman's avatar
Richard M. Stallman committed
2
   Copyright (C) 1985, 86,87,88,93,94,95,98 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
static void describe_map ();
105
Lisp_Object Fcopy_keymap ();
Jim Blandy's avatar
Jim Blandy committed
106

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,
Jim Blandy's avatar
Jim Blandy committed
110
  "Construct and return a new keymap, of the form (keymap VECTOR . ALIST).\n\
111
VECTOR is a vector which 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 215 216

   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
217
Lisp_Object
218
get_keymap_1 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
219
     Lisp_Object object;
220
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
221
{
222
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
223

224
 autoload_retry:
Jim Blandy's avatar
Jim Blandy committed
225
  tem = indirect_function (object);
Jim Blandy's avatar
Jim Blandy committed
226 227
  if (CONSP (tem) && EQ (XCONS (tem)->car, Qkeymap))
    return tem;
228

229 230
  /* Should we do an autoload?  Autoload forms for keymaps have
     Qkeymap as their fifth element.  */
231
  if (autoload
232
      && SYMBOLP (object)
233 234 235
      && CONSP (tem)
      && EQ (XCONS (tem)->car, Qautoload))
    {
236
      Lisp_Object tail;
237

238 239 240 241
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
242

243 244
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
245 246 247 248
	  UNGCPRO;

	  goto autoload_retry;
	}
249 250
    }

Jim Blandy's avatar
Jim Blandy committed
251 252
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
253 254
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
255 256
}

257 258 259

/* 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
260 261 262 263
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
264
  return get_keymap_1 (object, 1, 0);
Jim Blandy's avatar
Jim Blandy committed
265
}
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300

/* 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'.  */
  list = XCONS (keymap)->cdr;
  for (; CONSP (list); list = XCONS (list)->cdr)
    {
      /* See if there is another `keymap'.  */
      if (EQ (Qkeymap, XCONS (list)->car))
	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
301

302 303 304
  keymap = get_keymap_1 (keymap, 1, 1);
  if (!NILP (parent))
    parent = get_keymap_1 (parent, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
305

306 307 308 309 310 311 312 313 314
  /* Skip past the initial element `keymap'.  */
  prev = keymap;
  while (1)
    {
      list = XCONS (prev)->cdr;
      /* If there is a parent keymap here, replace it.
	 If we came to the end, add the parent in PREV.  */
      if (! CONSP (list) || EQ (Qkeymap, XCONS (list)->car))
	{
315 316 317 318 319
	  /* If we already have the right parent, return now
	     so that we avoid the loops below.  */
	  if (EQ (XCONS (prev)->cdr, parent))
	    return parent;

320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
	  XCONS (prev)->cdr = parent;
	  break;
	}
      prev = list;
    }

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

  for (list = XCONS (keymap)->cdr; CONSP (list); list = XCONS (list)->cdr)
    {
      /* Stop the scan when we come to the parent.  */
      if (EQ (XCONS (list)->car, Qkeymap))
	break;

      /* If this element holds a prefix map, deal with it.  */
      if (CONSP (XCONS (list)->car)
	  && CONSP (XCONS (XCONS (list)->car)->cdr))
	fix_submap_inheritance (keymap, XCONS (XCONS (list)->car)->car,
				XCONS (XCONS (list)->car)->cdr);

      if (VECTORP (XCONS (list)->car))
	for (i = 0; i < XVECTOR (XCONS (list)->car)->size; i++)
	  if (CONSP (XVECTOR (XCONS (list)->car)->contents[i]))
	    fix_submap_inheritance (keymap, make_number (i),
				    XVECTOR (XCONS (list)->car)->contents[i]);
345 346 347

      if (CHAR_TABLE_P (XCONS (list)->car))
	{
348
	  Lisp_Object indices[3];
349 350 351 352

	  map_char_table (fix_submap_inheritance, Qnil, XCONS (list)->car,
			  keymap, 0, indices);
	}
353 354 355 356 357 358 359 360 361
    }

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

362
void
363 364 365 366 367 368 369 370
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.  */

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

      /* Or a new format menu item */
      else if (EQ (XCONS (submap)->car, Qmenu_item)
	       && CONSP (XCONS (submap)->cdr))
	{
	  submap = XCONS (XCONS (submap)->cdr)->cdr;
	  if (CONSP (submap))
	    submap = XCONS (submap)->car;
399 400 401 402 403 404 405 406 407 408 409 410 411 412
	}
    }

  /* If it isn't a keymap now, there's no work to do.  */
  if (! CONSP (submap)
      || ! EQ (XCONS (submap)->car, Qkeymap))
    return;

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

413 414 415 416 417
  /* If MAP's parent has something other than a keymap,
     our own submap shadows it completely, so use nil as SUBMAP's parent.  */
  if (! (CONSP (parent_entry) && EQ (XCONS (parent_entry)->car, Qkeymap)))
    parent_entry = Qnil;

418 419 420 421
  if (! EQ (parent_entry, submap))
    Fset_keymap_parent (submap, parent_entry);
}

Jim Blandy's avatar
Jim Blandy committed
422
/* Look up IDX in MAP.  IDX may be any sort of event.
423
   Note that this does only one level of lookup; IDX must be a single
424 425 426 427 428 429
   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.  

430 431 432
   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
433 434

Lisp_Object
435
access_keymap (map, idx, t_ok, noinherit)
Jim Blandy's avatar
Jim Blandy committed
436 437
     Lisp_Object map;
     Lisp_Object idx;
438
     int t_ok;
439
     int noinherit;
Jim Blandy's avatar
Jim Blandy committed
440
{
441 442 443
  int noprefix = 0;
  Lisp_Object val;

Jim Blandy's avatar
Jim Blandy committed
444 445 446
  /* 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.  */
447
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
448

449 450
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
451
  if (SYMBOLP (idx))
452
    idx = reorder_modifiers (idx);
453 454 455
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
456
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
457

458 459
  {
    Lisp_Object tail;
460
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
461

462
    t_binding = Qnil;
463
    for (tail = map; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
464
      {
465
	Lisp_Object binding;
466

467
	binding = XCONS (tail)->car;
468
	if (SYMBOLP (binding))
469
	  {
470 471 472 473
	    /* 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;
474 475 476
	  }
	else if (CONSP (binding))
	  {
477
	    if (EQ (XCONS (binding)->car, idx))
478 479 480 481
	      {
		val = XCONS (binding)->cdr;
		if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap))
		  return Qnil;
482 483
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
484 485
		return val;
	      }
486 487
	    if (t_ok && EQ (XCONS (binding)->car, Qt))
	      t_binding = XCONS (binding)->cdr;
488 489 490
	  }
	else if (VECTORP (binding))
	  {
491
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size)
492
	      {
493
		val = XVECTOR (binding)->contents[XFASTINT (idx)];
494 495
		if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap))
		  return Qnil;
496 497
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
498 499
		return val;
	      }
500
	  }
501 502
	else if (CHAR_TABLE_P (binding))
	  {
503 504 505 506 507 508 509
	    /* 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)))
510 511 512 513 514 515 516 517 518
	      {
		val = Faref (binding, idx);
		if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap))
		  return Qnil;
		if (CONSP (val))
		  fix_submap_inheritance (map, idx, val);
		return val;
	      }
	  }
519 520

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
521
      }
522

523 524
    return t_binding;
  }
Jim Blandy's avatar
Jim Blandy committed
525 526 527 528 529 530 531 532 533
}

/* 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,
534 535 536 537
   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
538 539

Lisp_Object
540
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
541
     register Lisp_Object object;
542
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
543 544 545 546 547
{
  while (1)
    {
      register Lisp_Object map, tem;

548
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
549
      map = get_keymap_1 (Fcar_safe (object), 0, autoload);
Jim Blandy's avatar
Jim Blandy committed
550
      tem = Fkeymapp (map);
Jim Blandy's avatar
Jim Blandy committed
551
      if (!NILP (tem))
552 553 554 555 556
	{
	  Lisp_Object key;
	  key = Fcdr (object);
	  if (INTEGERP (key) && (XINT (key) & meta_modifier))
	    {
557
	      object = access_keymap (map, meta_prefix_char, 0, 0);
558 559 560 561 562 563 564 565 566
	      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);
	}

567 568 569 570
      else if (!(CONSP (object)))
	/* This is really the value.  */
	return object;

Jim Blandy's avatar
Jim Blandy committed
571 572 573 574
      /* If the keymap contents looks like (STRING . DEFN),
	 use DEFN.
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
575
      else if (STRINGP (XCONS (object)->car))
576 577 578 579
	{
	  object = XCONS (object)->cdr;
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
580
	  if (CONSP (object) && STRINGP (XCONS (object)->car))
581
	    object = XCONS (object)->cdr;
582 583 584
	  /* Also remove the sublist that caches key equivalences, if any.  */
	  if (CONSP (object)
	      && CONSP (XCONS (object)->car))
585
	    {
586 587 588
	      Lisp_Object carcar;
	      carcar = XCONS (XCONS (object)->car)->car;
	      if (NILP (carcar) || VECTORP (carcar))
589 590
		object = XCONS (object)->cdr;
	    }
591
	}
Jim Blandy's avatar
Jim Blandy committed
592

593 594 595 596 597 598 599 600 601 602 603 604
      /* 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 (XCONS (object)->car, Qmenu_item)
	       && CONSP (XCONS (object)->cdr))
	{
	  object = XCONS (XCONS (object)->cdr)->cdr;
	  if (CONSP (object))
	    object = XCONS (object)->car;
	}

Jim Blandy's avatar
Jim Blandy committed
605 606 607 608 609 610 611 612 613 614 615 616
      else
	/* Anything else is really the value.  */
	return object;
    }
}

Lisp_Object
store_in_keymap (keymap, idx, def)
     Lisp_Object keymap;
     register Lisp_Object idx;
     register Lisp_Object def;
{
617
  /* If we are preparing to dump, and DEF is a menu element
618 619 620
     with a menu item indicator, copy it to ensure it is not pure.  */
  if (CONSP (def) && PURE_P (def)
      && (EQ (XCONS (def)->car, Qmenu_item) || STRINGP (XCONS (def)->car)))
621 622
    def = Fcons (XCONS (def)->car, XCONS (def)->cdr);

623
  if (!CONSP (keymap) || ! EQ (XCONS (keymap)->car, Qkeymap))
624 625
    error ("attempt to define a key in a non-keymap");

Jim Blandy's avatar
Jim Blandy committed
626 627 628
  /* 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.  */
629
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
630

631 632
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
633
  if (SYMBOLP (idx))
634
    idx = reorder_modifiers (idx);
635 636 637
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
638
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
639 640

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
641
  {
642
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
643

644 645 646 647 648 649
    /* 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.  */
650
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
651

652
    insertion_point = keymap;
653
    for (tail = XCONS (keymap)->cdr; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
654
      {
655
	Lisp_Object elt;
656

657
	elt = XCONS (tail)->car;
658
	if (VECTORP (elt))
659
	  {
660
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (elt)->size)
661 662 663 664 665
	      {
		XVECTOR (elt)->contents[XFASTINT (idx)] = def;
		return def;
	      }
	    insertion_point = tail;
666
	  }
667 668
	else if (CHAR_TABLE_P (elt))
	  {
669 670 671 672 673 674 675
	    /* 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)))
676 677 678 679 680 681
	      {
		Faset (elt, idx, def);
		return def;
	      }
	    insertion_point = tail;
	  }
682 683
	else if (CONSP (elt))
	  {
684 685 686 687 688
	    if (EQ (idx, XCONS (elt)->car))
	      {
		XCONS (elt)->cdr = def;
		return def;
	      }
689 690 691
	  }
	else if (SYMBOLP (elt))
	  {
692 693 694 695 696 697 698
	    /* 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;
	  }
699 700

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
701 702
      }

703 704 705
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
706 707
    XCONS (insertion_point)->cdr
      = Fcons (Fcons (idx, def), XCONS (insertion_point)->cdr);
708 709
  }
	  
Jim Blandy's avatar
Jim Blandy committed
710 711 712
  return def;
}

713
void
714 715 716
copy_keymap_1 (chartable, idx, elt)
     Lisp_Object chartable, idx, elt;
{
717 718
  if (!SYMBOLP (elt) && ! NILP (Fkeymapp (elt)))
    Faset (chartable, idx, Fcopy_keymap (elt));
719
}
720

Jim Blandy's avatar
Jim Blandy committed
721 722 723 724
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
725 726 727
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
728 729 730 731 732 733 734
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));

735
  for (tail = copy; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
736
    {
737
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
738

739
      elt = XCONS (tail)->car;
740 741
      if (CHAR_TABLE_P (elt))
	{
742
	  Lisp_Object indices[3];
743 744

	  elt = Fcopy_sequence (elt);
745 746
	  XCONS (tail)->car = elt;

747 748 749
	  map_char_table (copy_keymap_1, Qnil, elt, elt, 0, indices);
	}
      else if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
750
	{
751
	  int i;
Jim Blandy's avatar
Jim Blandy committed
752

753 754
	  elt = Fcopy_sequence (elt);
	  XCONS (tail)->car = elt;
Jim Blandy's avatar
Jim Blandy committed
755

756
	  for (i = 0; i < XVECTOR (elt)->size; i++)
757
	    if (!SYMBOLP (XVECTOR (elt)->contents[i])
758
		&& ! NILP (Fkeymapp (XVECTOR (elt)->contents[i])))
759 760
	      XVECTOR (elt)->contents[i]
		= Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
761
	}
762
      else if (CONSP (elt) && CONSP (XCONS (elt)->cdr))
763
	{
764 765
	  Lisp_Object tem;
	  tem = XCONS (elt)->cdr;
766

767 768 769 770 771 772
	  /* Is this a new format menu item.  */
	  if (EQ (XCONS (tem)->car,Qmenu_item))
	    {
	      /* Copy cell with menu-item marker.  */
	      XCONS (elt)->cdr
		= Fcons (XCONS (tem)->car, XCONS (tem)->cdr);
773
	      elt = XCONS (elt)->cdr;
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
	      tem = XCONS (elt)->cdr;
	      if (CONSP (tem))
		{
		  /* Copy cell with menu-item name.  */
		  XCONS (elt)->cdr
		    = Fcons (XCONS (tem)->car, XCONS (tem)->cdr);
		  elt = XCONS (elt)->cdr;
		  tem = XCONS (elt)->cdr;
		};
	      if (CONSP (tem))
		{
		  /* Copy cell with binding and if the binding is a keymap,
		     copy that.  */
		  XCONS (elt)->cdr
		    = Fcons (XCONS (tem)->car, XCONS (tem)->cdr);
		  elt = XCONS (elt)->cdr;
		  tem = XCONS (elt)->car;
		  if (!(SYMBOLP (tem) || NILP (Fkeymapp (tem))))
		    XCONS (elt)->car = Fcopy_keymap (tem);
		  tem = XCONS (elt)->cdr;
		  if (CONSP (tem) && CONSP (XCONS (tem)->car))
		    /* Delete cache for key equivalences.  */
		    XCONS (elt)->cdr = XCONS (tem)->cdr;
		}
	    }
	  else
	    {
	      /* It may be an old fomat menu item.
		 Skip the optional menu string.
	      */
	      if (STRINGP (XCONS (tem)->car))
805
		{
806 807 808
		  /* Copy the cell, since copy-alist didn't go this deep.  */
		  XCONS (elt)->cdr
		    = Fcons (XCONS (tem)->car, XCONS (tem)->cdr);
809
		  elt = XCONS (elt)->cdr;
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
		  tem = XCONS (elt)->cdr;
		  /* Also skip the optional menu help string.  */
		  if (CONSP (tem) && STRINGP (XCONS (tem)->car))
		    {
		      XCONS (elt)->cdr
			= Fcons (XCONS (tem)->car, XCONS (tem)->cdr);
		      elt = XCONS (elt)->cdr;
		      tem = XCONS (elt)->cdr;
		    }
		  /* There may also be a list that caches key equivalences.
		     Just delete it for the new keymap.  */
		  if (CONSP (tem)
		      && CONSP (XCONS (tem)->car)
		      && (NILP (XCONS (XCONS (tem)->car)->car)
			  || VECTORP (XCONS (XCONS (tem)->car)->car)))
		    XCONS (elt)->cdr = XCONS (tem)->cdr;
826
		}
827 828 829 830
	      if (CONSP (elt)
		  && ! SYMBOLP (XCONS (elt)->cdr)
		  && ! NILP (Fkeymapp (XCONS (elt)->cdr)))
		XCONS (elt)->cdr = Fcopy_keymap (XCONS (elt)->cdr);
831
	    }
832

833
	}
Jim Blandy's avatar
Jim Blandy committed
834
    }
835
	      
Jim Blandy's avatar
Jim Blandy committed
836 837 838
  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
839 840
/* Simple Keymap mutators and accessors.				*/

841 842
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
843 844 845 846
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
847 848
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
849 850 851 852 853 854 855 856 857 858
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
859 860 861 862
 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
863
  (keymap, key, def)
864
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
865 866 867 868 869 870 871 872
     Lisp_Object key;
     Lisp_Object def;
{
  register int idx;
  register Lisp_Object c;
  register Lisp_Object tem;
  register Lisp_Object cmd;
  int metized = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
873
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
874
  int length;
875
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
876

877
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
878

879
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
880 881
    key = wrong_type_argument (Qarrayp, key);

882
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
883 884 885
  if (length == 0)
    return Qnil;

886 887 888
  if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
    Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);

889 890
  GCPRO3 (keymap, key, def);

891
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
892 893 894 895
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
896 897 898 899 900
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

901
      if (CONSP (c) && lucid_event_type_list_p (c))
902
	c = Fevent_convert_list (c);
903

904
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
905
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
906 907 908 909 910 911 912
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
913
	  if (INTEGERP (c))
914
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
915 916 917 918 919

	  metized = 0;
	  idx++;
	}

920
      if (! INTEGERP (c) && ! SYMBOLP (c) && ! CONSP (c))
921
	error ("Key sequence contains invalid events");
922

Jim Blandy's avatar
Jim Blandy committed
923
      if (idx == length)
924
	RETURN_UNGCPRO (store_in_keymap (keymap, c, def));
Jim Blandy's avatar
Jim Blandy committed
925

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

928
      /* If this key is undefined, make it a prefix.  */
Jim Blandy's avatar
Jim Blandy committed
929
      if (NILP (cmd))
930
	cmd = define_as_prefix (keymap, c);
Jim Blandy's avatar
Jim Blandy committed
931

932 933
      keymap = get_keymap_1 (cmd, 0, 1);
      if (NILP (keymap))
934 935 936 937
	/* 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
938 939 940 941
    }
}

/* Value is number if KEY is too long; NIL if valid but has no definition. */
942
/* GC is possible in this function if it autoloads a keymap.  */
Jim Blandy's avatar
Jim Blandy committed
943

944
DEFUN ("lookup-key", Flookup_key, Slookup_key, 2, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
945 946
  "In keymap KEYMAP, look up key sequence KEY.  Return the definition.\n\
nil means undefined.  See doc of `define-key' for kinds of definitions.\n\
947
\n\
Jim Blandy's avatar
Jim Blandy committed
948 949 950 951
A number as value means KEY is \"too long\";\n\
that is, characters or symbols in it except for the last one\n\
fail to be a valid sequence of prefix characters in KEYMAP.\n\
The number is how many characters at the front of KEY\n\
952 953 954 955
it takes to reach a non-prefix command.\n\
\n\
Normally, `lookup-key' ignores bindings for t, which act as default\n\
bindings, used when nothing else in the keymap applies; this makes it\n\
Karl Heuer's avatar
Karl Heuer committed
956
usable as a general function for probing keymaps.  However, if the\n\
957 958 959
third optional argument ACCEPT-DEFAULT is non-nil, `lookup-key' will\n\
recognize the default bindings, just as `read-key-sequence' does.")
  (keymap, key, accept_default)
Jim Blandy's avatar
Jim Blandy committed
960 961
     register Lisp_Object keymap;
     Lisp_Object key;
962
     Lisp_Object accept_default;
Jim Blandy's avatar
Jim Blandy committed
963 964 965 966 967 968 969
{
  register int idx;
  register Lisp_Object tem;
  register Lisp_Object cmd;
  register Lisp_Object c;
  int metized = 0;
  int length;
970
  int t_ok = ! NILP (accept_default);
Richard M. Stallman's avatar
Richard M. Stallman committed
971
  int meta_bit;
972
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
973

974
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
975

976
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
977 978
    key = wrong_type_argument (Qarrayp, key);

979
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
980 981 982
  if (length == 0)
    return keymap;

983
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
984 985 986 987
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

988 989
  GCPRO1 (key);

Jim Blandy's avatar
Jim Blandy committed
990 991 992 993 994
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

995
      if (CONSP (c) && lucid_event_type_list_p (c))
996
	c = Fevent_convert_list (c);
997

998
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
999
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
1000 1001 1002 1003 1004 1005 1006
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
1007
	  if (INTEGERP (c))
Richard M. Stallman's avatar
Richard M. Stallman committed
1008
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
1009 1010 1011 1012 1013

	  metized = 0;
	  idx++;
	}

1014
      cmd = get_keyelt (access_keymap (keymap, c, t_ok, 0), 1);
Jim Blandy's avatar
Jim Blandy committed
1015
      if (idx == length)
1016
	RETURN_UNGCPRO (cmd);
Jim Blandy's avatar
Jim Blandy committed
1017

1018
      keymap = get_keymap_1 (cmd, 0, 1);
1019
      if (NILP (keymap))
1020
	RETURN_UNGCPRO (make_number (idx));
Jim Blandy's avatar
Jim Blandy committed
1021 1022 1023 1024 1025

      QUIT;
    }
}

1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
/* Make KEYMAP define event C as a keymap (i.e., as a prefix).
   Assume that currently it does not define C at all.
   Return the keymap.  */

static Lisp_Object
define_as_prefix (keymap, c)
     Lisp_Object keymap, c;
{
  Lisp_Object inherit, cmd;

  cmd = Fmake_sparse_keymap (Qnil);
  /* If this key is defined as a prefix in an inherited keymap,
     make it a prefix in this map, and make its definition
     inherit the other prefix definition.  */
  inherit = access_keymap (keymap, c, 0, 0);
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
#if 0
  /* This code is needed to do the right thing in the following case:
     keymap A inherits from B,
     you define KEY as a prefix in A,
     then later you define KEY as a prefix in B.
     We want the old prefix definition in A to inherit from that in B.
     It is hard to do that retroactively, so this code
     creates the prefix in B right away.

     But it turns out that this code causes problems immediately
     when the prefix in A is defined: it causes B to define KEY
     as a prefix with no subcommands.

     So I took out this code.  */
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
  if (NILP (inherit))
    {
      /* If there's an inherited keymap
	 and it doesn't define this key,
	 make it define this key.  */
      Lisp_Object tail;

      for (tail = Fcdr (keymap); CONSP (tail); tail = XCONS (tail)->cdr)
	if (EQ (XCONS (tail)->car, Qkeymap))
	  break;

      if (!NILP (tail))
	inherit = define_as_prefix (tail, c);
    }
1069
#endif
1070 1071 1072 1073 1074 1075 1076

  cmd = nconc2 (cmd, inherit);
  store_in_keymap (keymap, c, cmd);

  return cmd;
}

1077 1078
/* Append a key to the end of a key sequence.  We always make a vector.  */

Jim Blandy's avatar
Jim Blandy committed
1079 1080 1081 1082 1083 1084 1085 1086
Lisp_Object
append_key (key_sequence, key)
     Lisp_Object key_sequence, key;
{
  Lisp_Object args[2];

  args[0] = key_sequence;

1087 1088
  args[1] = Fcons (key, Qnil);
  return Fvconcat (2, args);