keymap.c 73.1 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985, 86, 87, 88, 93, 94, 95 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 18 19 20
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
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */


21
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
22 23 24 25 26
#include <stdio.h>
#undef NULL
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "keyboard.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
28
#include "termhooks.h"
29
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
30 31 32

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

33
/* The number of elements in keymap vectors.  */
Jim Blandy's avatar
Jim Blandy committed
34 35 36 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
#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
68 69 70
/* Alist of minor mode variables and keymaps.  */
Lisp_Object Vminor_mode_map_alist;

Jim Blandy's avatar
Jim Blandy committed
71 72 73 74 75
/* 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;

76 77 78
/* Keymap mapping ASCII function key sequences onto their preferred forms.  */
Lisp_Object Vkey_translation_map;

79 80 81 82 83 84
/* 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;

85
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii;
Jim Blandy's avatar
Jim Blandy committed
86

Jim Blandy's avatar
Jim Blandy committed
87 88 89
/* 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
90 91
extern Lisp_Object meta_prefix_char;

92 93
extern Lisp_Object Voverriding_local_map;

94
static Lisp_Object define_as_prefix ();
Jim Blandy's avatar
Jim Blandy committed
95
static Lisp_Object describe_buffer_bindings ();
96
static void describe_command (), describe_translation ();
Jim Blandy's avatar
Jim Blandy committed
97 98
static void describe_map ();

Jim Blandy's avatar
Jim Blandy committed
99 100
/* Keymap object support - constructors and predicates.			*/

101
DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
102
  "Construct and return a new keymap, of the form (keymap VECTOR . ALIST).\n\
103
VECTOR is a vector which holds the bindings for the ASCII\n\
Jim Blandy's avatar
Jim Blandy committed
104 105
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\
106 107 108 109 110
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
111
{
112 113 114 115 116
  Lisp_Object tail;
  if (!NILP (string))
    tail = Fcons (string, Qnil);
  else
    tail = Qnil;
Jim Blandy's avatar
Jim Blandy committed
117 118
  return Fcons (Qkeymap,
		Fcons (Fmake_vector (make_number (DENSE_TABLE_SIZE), Qnil),
119
		       tail));
Jim Blandy's avatar
Jim Blandy committed
120 121
}

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

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

   For example:

143
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
144 145 146 147 148 149 150 151 152 153

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

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

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

/* Check that OBJECT is a keymap (after dereferencing through any
195 196 197 198
   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.
199
   If AUTOLOAD is nonzero, callers must assume GC is possible.
200 201 202 203 204 205 206 207 208 209

   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
210
Lisp_Object
211
get_keymap_1 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
212
     Lisp_Object object;
213
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
214
{
215
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
216

217
 autoload_retry:
Jim Blandy's avatar
Jim Blandy committed
218
  tem = indirect_function (object);
Jim Blandy's avatar
Jim Blandy committed
219 220
  if (CONSP (tem) && EQ (XCONS (tem)->car, Qkeymap))
    return tem;
221

222 223
  /* Should we do an autoload?  Autoload forms for keymaps have
     Qkeymap as their fifth element.  */
224
  if (autoload
225
      && SYMBOLP (object)
226 227 228
      && CONSP (tem)
      && EQ (XCONS (tem)->car, Qautoload))
    {
229
      Lisp_Object tail;
230

231 232 233 234
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
235

236 237
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
238 239 240 241
	  UNGCPRO;

	  goto autoload_retry;
	}
242 243
    }

Jim Blandy's avatar
Jim Blandy committed
244 245
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
246 247
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
248 249
}

250 251 252

/* 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
253 254 255 256
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
257
  return get_keymap_1 (object, 1, 0);
Jim Blandy's avatar
Jim Blandy committed
258 259 260 261
}


/* Look up IDX in MAP.  IDX may be any sort of event.
262
   Note that this does only one level of lookup; IDX must be a single
263 264 265 266 267 268
   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.  

269 270 271
   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
272 273

Lisp_Object
274
access_keymap (map, idx, t_ok, noinherit)
Jim Blandy's avatar
Jim Blandy committed
275 276
     Lisp_Object map;
     Lisp_Object idx;
277
     int t_ok;
278
     int noinherit;
Jim Blandy's avatar
Jim Blandy committed
279
{
280 281 282
  int noprefix = 0;
  Lisp_Object val;

Jim Blandy's avatar
Jim Blandy committed
283 284 285
  /* 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.  */
286
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
287

288 289
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
290
  if (SYMBOLP (idx))
291
    idx = reorder_modifiers (idx);
292 293 294
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
295
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
Jim Blandy's avatar
Jim Blandy committed
296

297 298
  {
    Lisp_Object tail;
299
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
300

301
    t_binding = Qnil;
302
    for (tail = map; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
303
      {
304
	Lisp_Object binding;
305

306
	binding = XCONS (tail)->car;
307
	if (SYMBOLP (binding))
308
	  {
309 310 311 312
	    /* 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;
313 314 315
	  }
	else if (CONSP (binding))
	  {
316
	    if (EQ (XCONS (binding)->car, idx))
317 318 319 320 321 322
	      {
		val = XCONS (binding)->cdr;
		if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap))
		  return Qnil;
		return val;
	      }
323 324
	    if (t_ok && EQ (XCONS (binding)->car, Qt))
	      t_binding = XCONS (binding)->cdr;
325 326 327
	  }
	else if (VECTORP (binding))
	  {
328
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (binding)->size)
329
	      {
330
		val = XVECTOR (binding)->contents[XFASTINT (idx)];
331 332 333 334
		if (noprefix && CONSP (val) && EQ (XCONS (val)->car, Qkeymap))
		  return Qnil;
		return val;
	      }
335
	  }
336 337

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
338
      }
339

340 341
    return t_binding;
  }
Jim Blandy's avatar
Jim Blandy committed
342 343 344 345 346 347 348 349 350
}

/* 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,
351 352 353 354
   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
355 356

Lisp_Object
357
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
358
     register Lisp_Object object;
359
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
360 361 362 363 364
{
  while (1)
    {
      register Lisp_Object map, tem;

365
      /* If the contents are (KEYMAP . ELEMENT), go indirect.  */
366
      map = get_keymap_1 (Fcar_safe (object), 0, autoload);
Jim Blandy's avatar
Jim Blandy committed
367
      tem = Fkeymapp (map);
Jim Blandy's avatar
Jim Blandy committed
368
      if (!NILP (tem))
369
	object = access_keymap (map, Fcdr (object), 0, 0);
Jim Blandy's avatar
Jim Blandy committed
370 371 372 373 374
      
      /* If the keymap contents looks like (STRING . DEFN),
	 use DEFN.
	 Keymap alist elements like (CHAR MENUSTRING . DEFN)
	 will be used by HierarKey menus.  */
375 376
      else if (CONSP (object)
	       && STRINGP (XCONS (object)->car))
377 378 379 380
	{
	  object = XCONS (object)->cdr;
	  /* Also remove a menu help string, if any,
	     following the menu item name.  */
381
	  if (CONSP (object) && STRINGP (XCONS (object)->car))
382
	    object = XCONS (object)->cdr;
383 384 385
	  /* Also remove the sublist that caches key equivalences, if any.  */
	  if (CONSP (object)
	      && CONSP (XCONS (object)->car))
386
	    {
387 388 389
	      Lisp_Object carcar;
	      carcar = XCONS (XCONS (object)->car)->car;
	      if (NILP (carcar) || VECTORP (carcar))
390 391
		object = XCONS (object)->cdr;
	    }
392
	}
Jim Blandy's avatar
Jim Blandy committed
393 394 395 396 397 398 399 400 401 402 403 404 405

      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;
{
406 407 408 409
  /* If we are preparing to dump, and DEF is a menu element
     with a menu item string, copy it to ensure it is not pure.  */
  if (!NILP (Vpurify_flag) && CONSP (def)
      && STRINGP (XCONS (def)->car))
410 411
    def = Fcons (XCONS (def)->car, XCONS (def)->cdr);

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

Jim Blandy's avatar
Jim Blandy committed
415 416 417
  /* 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.  */
418
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
419

420 421
  /* If idx is a symbol, it might have modifiers, which need to
     be put in the canonical order.  */
422
  if (SYMBOLP (idx))
423
    idx = reorder_modifiers (idx);
424 425 426
  else if (INTEGERP (idx))
    /* Clobber the high bits that can be present on a machine
       with more than 24 bits of integer.  */
427
    XSETFASTINT (idx, XINT (idx) & (CHAR_META | (CHAR_META - 1)));
428 429

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
430
  {
431
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
432

433 434 435 436 437 438
    /* 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.  */
439
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
440

441
    insertion_point = keymap;
442
    for (tail = XCONS (keymap)->cdr; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
443
      {
444
	Lisp_Object elt;
445

446
	elt = XCONS (tail)->car;
447
	if (VECTORP (elt))
448
	  {
449
	    if (NATNUMP (idx) && XFASTINT (idx) < XVECTOR (elt)->size)
450 451 452 453 454
	      {
		XVECTOR (elt)->contents[XFASTINT (idx)] = def;
		return def;
	      }
	    insertion_point = tail;
455 456 457
	  }
	else if (CONSP (elt))
	  {
458 459 460 461 462
	    if (EQ (idx, XCONS (elt)->car))
	      {
		XCONS (elt)->cdr = def;
		return def;
	      }
463 464 465
	  }
	else if (SYMBOLP (elt))
	  {
466 467 468 469 470 471 472
	    /* 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;
	  }
473 474

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
475 476
      }

477 478 479
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
480 481
    XCONS (insertion_point)->cdr
      = Fcons (Fcons (idx, def), XCONS (insertion_point)->cdr);
482 483
  }
	  
Jim Blandy's avatar
Jim Blandy committed
484 485 486
  return def;
}

487

Jim Blandy's avatar
Jim Blandy committed
488 489 490 491
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
492 493 494
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
495 496 497 498 499 500 501
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));

502
  for (tail = copy; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
503
    {
504
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
505

506
      elt = XCONS (tail)->car;
507
      if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
508
	{
509
	  int i;
Jim Blandy's avatar
Jim Blandy committed
510

511 512
	  elt = Fcopy_sequence (elt);
	  XCONS (tail)->car = elt;
Jim Blandy's avatar
Jim Blandy committed
513

514
	  for (i = 0; i < XVECTOR (elt)->size; i++)
515
	    if (!SYMBOLP (XVECTOR (elt)->contents[i])
516
		&& ! NILP (Fkeymapp (XVECTOR (elt)->contents[i])))
517 518
	      XVECTOR (elt)->contents[i] =
		Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
519
	}
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
      else if (CONSP (elt))
	{
	  /* Skip the optional menu string.  */
	  if (CONSP (XCONS (elt)->cdr)
	      && STRINGP (XCONS (XCONS (elt)->cdr)->car))
	    {
	      Lisp_Object tem;

	      /* Copy the cell, since copy-alist didn't go this deep.  */
	      XCONS (elt)->cdr = Fcons (XCONS (XCONS (elt)->cdr)->car,
					XCONS (XCONS (elt)->cdr)->cdr);
	      elt = XCONS (elt)->cdr;

	      /* Also skip the optional menu help string.  */
	      if (CONSP (XCONS (elt)->cdr)
		  && STRINGP (XCONS (XCONS (elt)->cdr)->car))
		{
		  XCONS (elt)->cdr = Fcons (XCONS (XCONS (elt)->cdr)->car,
					    XCONS (XCONS (elt)->cdr)->cdr);
		  elt = XCONS (elt)->cdr;
		}
	      /* There may also be a list that caches key equivalences.
		 Just delete it for the new keymap.  */
	      if (CONSP (XCONS (elt)->cdr)
		  && CONSP (XCONS (XCONS (elt)->cdr)->car)
		  && (NILP (tem = XCONS (XCONS (XCONS (elt)->cdr)->car)->car)
		      || VECTORP (tem)))
		XCONS (elt)->cdr = XCONS (XCONS (elt)->cdr)->cdr;
	    }
	  if (CONSP (elt)
	      && ! SYMBOLP (XCONS (elt)->cdr)
	      && ! NILP (Fkeymapp (XCONS (elt)->cdr)))
	    XCONS (elt)->cdr = Fcopy_keymap (XCONS (elt)->cdr);
	}
Jim Blandy's avatar
Jim Blandy committed
554 555 556 557 558
    }

  return copy;
}

Jim Blandy's avatar
Jim Blandy committed
559 560
/* Simple Keymap mutators and accessors.				*/

561 562
/* GC is possible in this function if it autoloads a keymap.  */

Jim Blandy's avatar
Jim Blandy committed
563 564 565 566
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
567 568
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
569 570 571 572 573 574 575 576 577 578
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
579 580 581 582
 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
583
  (keymap, key, def)
584
     Lisp_Object keymap;
Jim Blandy's avatar
Jim Blandy committed
585 586 587 588 589 590 591 592
     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
593
  int meta_bit;
Jim Blandy's avatar
Jim Blandy committed
594
  int length;
595
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
596

597
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
598

599
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
600 601
    key = wrong_type_argument (Qarrayp, key);

602
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
603 604 605
  if (length == 0)
    return Qnil;

606 607 608
  if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
    Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);

609 610
  GCPRO3 (keymap, key, def);

611
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
612 613 614 615
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
616 617 618 619 620
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

621
      if (CONSP (c) && lucid_event_type_list_p (c))
622
	c = Fevent_convert_list (c);
623

624
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
625
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
626 627 628 629 630 631 632
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
633
	  if (INTEGERP (c))
634
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638 639

	  metized = 0;
	  idx++;
	}

640
      if (! INTEGERP (c) && ! SYMBOLP (c) && ! CONSP (c))
641
	error ("Key sequence contains invalid events");
642

Jim Blandy's avatar
Jim Blandy committed
643
      if (idx == length)
644
	RETURN_UNGCPRO (store_in_keymap (keymap, c, def));
Jim Blandy's avatar
Jim Blandy committed
645

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

648
      /* If this key is undefined, make it a prefix.  */
Jim Blandy's avatar
Jim Blandy committed
649
      if (NILP (cmd))
650
	cmd = define_as_prefix (keymap, c);
Jim Blandy's avatar
Jim Blandy committed
651

652 653
      keymap = get_keymap_1 (cmd, 0, 1);
      if (NILP (keymap))
654 655 656 657
	/* 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
658 659 660 661
    }
}

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

664
DEFUN ("lookup-key", Flookup_key, Slookup_key, 2, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
665 666
  "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\
667
\n\
Jim Blandy's avatar
Jim Blandy committed
668 669 670 671
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\
672 673 674 675 676 677 678 679
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\
useable as a general function for probing keymaps.  However, if the\n\
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
680 681
     register Lisp_Object keymap;
     Lisp_Object key;
682
     Lisp_Object accept_default;
Jim Blandy's avatar
Jim Blandy committed
683 684 685 686 687 688 689
{
  register int idx;
  register Lisp_Object tem;
  register Lisp_Object cmd;
  register Lisp_Object c;
  int metized = 0;
  int length;
690
  int t_ok = ! NILP (accept_default);
Richard M. Stallman's avatar
Richard M. Stallman committed
691
  int meta_bit;
692
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
693

694
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
695

696
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
697 698
    key = wrong_type_argument (Qarrayp, key);

699
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
700 701 702
  if (length == 0)
    return keymap;

703
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
704 705 706 707
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

708 709
  GCPRO1 (key);

Jim Blandy's avatar
Jim Blandy committed
710 711 712 713 714
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

715
      if (CONSP (c) && lucid_event_type_list_p (c))
716
	c = Fevent_convert_list (c);
717

718
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
719
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
720 721 722 723 724 725 726
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
727
	  if (INTEGERP (c))
Richard M. Stallman's avatar
Richard M. Stallman committed
728
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
729 730 731 732 733

	  metized = 0;
	  idx++;
	}

734
      cmd = get_keyelt (access_keymap (keymap, c, t_ok, 0), 1);
Jim Blandy's avatar
Jim Blandy committed
735
      if (idx == length)
736
	RETURN_UNGCPRO (cmd);
Jim Blandy's avatar
Jim Blandy committed
737

738
      keymap = get_keymap_1 (cmd, 0, 1);
739
      if (NILP (keymap))
740
	RETURN_UNGCPRO (make_number (idx));
Jim Blandy's avatar
Jim Blandy committed
741 742 743 744 745

      QUIT;
    }
}

746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
/* 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);
  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);
    }

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

  return cmd;
}

782 783
/* Append a key to the end of a key sequence.  We always make a vector.  */

Jim Blandy's avatar
Jim Blandy committed
784 785 786 787 788 789 790 791
Lisp_Object
append_key (key_sequence, key)
     Lisp_Object key_sequence, key;
{
  Lisp_Object args[2];

  args[0] = key_sequence;

792 793
  args[1] = Fcons (key, Qnil);
  return Fvconcat (2, args);
Jim Blandy's avatar
Jim Blandy committed
794 795 796
}


Jim Blandy's avatar
Jim Blandy committed
797 798
/* Global, local, and minor mode keymap stuff.				*/

Jim Blandy's avatar
Jim Blandy committed
799
/* We can't put these variables inside current_minor_maps, since under
Jim Blandy's avatar
Jim Blandy committed
800 801
   some systems, static gets macro-defined to be the empty string.
   Ickypoo.  */
Jim Blandy's avatar
Jim Blandy committed
802 803 804
static Lisp_Object *cmm_modes, *cmm_maps;
static int cmm_size;

805 806 807 808 809 810 811
/* Error handler used in current_minor_maps.  */
static Lisp_Object
current_minor_maps_error ()
{
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
/* Store a pointer to an array of the keymaps of the currently active
   minor modes in *buf, and return the number of maps it contains.

   This function always returns a pointer to the same buffer, and may
   free or reallocate it, so if you want to keep it for a long time or
   hand it out to lisp code, copy it.  This procedure will be called
   for every key sequence read, so the nice lispy approach (return a
   new assoclist, list, what have you) for each invocation would
   result in a lot of consing over time.

   If we used xrealloc/xmalloc and ran out of memory, they would throw
   back to the command loop, which would try to read a key sequence,
   which would call this function again, resulting in an infinite
   loop.  Instead, we'll use realloc/malloc and silently truncate the
   list, let the key sequence be read, and hope some other piece of
   code signals the error.  */
int
current_minor_maps (modeptr, mapptr)
     Lisp_Object **modeptr, **mapptr;
{
  int i = 0;
Jim Blandy's avatar
Jim Blandy committed
833
  Lisp_Object alist, assoc, var, val;
Jim Blandy's avatar
Jim Blandy committed
834 835 836 837

  for (alist = Vminor_mode_map_alist;
       CONSP (alist);
       alist = XCONS (alist)->cdr)
838 839 840
    if ((assoc = XCONS (alist)->car, CONSP (assoc))
	&& (var = XCONS (assoc)->car, SYMBOLP (var))
	&& (val = find_symbol_value (var), ! EQ (val, Qunbound))
Jim Blandy's avatar
Jim Blandy committed
841
	&& ! NILP (val))
Jim Blandy's avatar
Jim Blandy committed
842
      {
843 844
	Lisp_Object temp;

Jim Blandy's avatar
Jim Blandy committed
845
	if (i >= cmm_size)
Jim Blandy's avatar
Jim Blandy committed
846 847 848
	  {
	    Lisp_Object *newmodes, *newmaps;

Jim Blandy's avatar
Jim Blandy committed
849
	    if (cmm_maps)
Jim Blandy's avatar
Jim Blandy committed
850
	      {
851
		BLOCK_INPUT;
852
		cmm_size *= 2;
Richard M. Stallman's avatar
Richard M. Stallman committed
853 854 855 856 857 858
		newmodes
		  = (Lisp_Object *) realloc (cmm_modes,
					     cmm_size * sizeof (Lisp_Object));
		newmaps
		  = (Lisp_Object *) realloc (cmm_maps,
					     cmm_size * sizeof (Lisp_Object));
859
		UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
860 861 862
	      }
	    else
	      {
863
		BLOCK_INPUT;
864
		cmm_size = 30;
Richard M. Stallman's avatar
Richard M. Stallman committed
865 866 867 868
		newmodes
		  = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object));
		newmaps
		  = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object));
869
		UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
870 871 872 873
	      }

	    if (newmaps && newmodes)
	      {
Jim Blandy's avatar
Jim Blandy committed
874 875
		cmm_modes = newmodes;
		cmm_maps = newmaps;
Jim Blandy's avatar
Jim Blandy committed
876 877 878 879
	      }
	    else
	      break;
	  }
880 881 882 883 884 885 886 887 888 889 890

	/* Get the keymap definition--or nil if it is not defined.  */
	temp = internal_condition_case_1 (Findirect_function,
					  XCONS (assoc)->cdr,
					  Qerror, current_minor_maps_error);
	if (!NILP (temp))
	  {
	    cmm_modes[i] = var;
	    cmm_maps [i] = temp;
	    i++;
	  }
Jim Blandy's avatar
Jim Blandy committed
891 892
      }

Jim Blandy's avatar
Jim Blandy committed
893 894
  if (modeptr) *modeptr = cmm_modes;
  if (mapptr)  *mapptr  = cmm_maps;
Jim Blandy's avatar
Jim Blandy committed
895 896 897
  return i;
}

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

900
DEFUN ("key-binding", Fkey_binding, Skey_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
901
  "Return the binding for command KEY in current keymaps.\n\
902 903 904 905 906
KEY is a string or vector, a sequence of keystrokes.\n\
The binding is probably a symbol with a function definition.\n\
\n\
Normally, `key-binding' ignores bindings for t, which act as default\n\
bindings, used when nothing else in the keymap applies; this makes it\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
907 908
usable as a general function for probing keymaps.  However, if the\n\
optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\
909 910
recognize the default bindings, just as `read-key-sequence' does.")
  (key, accept_default)
911
     Lisp_Object key, accept_default;
Jim Blandy's avatar
Jim Blandy committed
912
{
Jim Blandy's avatar
Jim Blandy committed
913 914
  Lisp_Object *maps, value;
  int nmaps, i;
915 916 917
  struct gcpro gcpro1;

  GCPRO1 (key);
Jim Blandy's avatar
Jim Blandy committed
918

919 920 921 922 923 924 925 926
  if (!NILP (current_kboard->Voverriding_terminal_local_map))
    {
      value = Flookup_key (current_kboard->Voverriding_terminal_local_map,
			   key, accept_default);
      if (! NILP (value) && !INTEGERP (value))
	RETURN_UNGCPRO (value);
    }
  else if (!NILP (Voverriding_local_map))
Jim Blandy's avatar
Jim Blandy committed
927
    {
928
      value = Flookup_key (Voverriding_local_map, key, accept_default);
929
      if (! NILP (value) && !INTEGERP (value))
930
	RETURN_UNGCPRO (value);
Jim Blandy's avatar
Jim Blandy committed
931
    }
932 933 934
  else
    { 
      nmaps = current_minor_maps (0, &maps);
935 936 937
      /* Note that all these maps are GCPRO'd
	 in the places where we found them.  */

938 939 940 941
      for (i = 0; i < nmaps; i++)
	if (! NILP (maps[i]))
	  {
	    value = Flookup_key (maps[i], key, accept_default);
942
	    if (! NILP (value) && !INTEGERP (value))
943
	      RETURN_UNGCPRO (value);
944 945 946 947 948
	  }

      if (! NILP (current_buffer->keymap))
	{
	  value = Flookup_key (current_buffer->keymap, key, accept_default);
949
	  if (! NILP (value) && !INTEGERP (value))
950
	    RETURN_UNGCPRO (value);
951 952
	}
    }
Jim Blandy's avatar
Jim Blandy committed
953

954
  value = Flookup_key (current_global_map, key, accept_default);
955
  UNGCPRO;
956
  if (! NILP (value) && !INTEGERP (value))
Jim Blandy's avatar
Jim Blandy committed
957 958 959
    return value;
  
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
960 961
}

962 963
/* GC is possible in this function if it autoloads a keymap.  */

964
DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
965 966
  "Return the binding for command KEYS in current local keymap only.\n\
KEYS is a string, a sequence of keystrokes.\n\
967 968 969 970 971 972
The binding is probably a symbol with a function definition.\n\
\n\
If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
bindings; see the description of `lookup-key' for more details about this.")
  (keys, accept_default)
     Lisp_Object keys, accept_default;
Jim Blandy's avatar
Jim Blandy committed
973 974 975
{
  register Lisp_Object map;
  map = current_buffer->keymap;
Jim Blandy's avatar
Jim Blandy committed
976
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
977
    return Qnil;
978
  return Flookup_key (map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
979 980
}

981 982
/* GC is possible in this function if it autoloads a keymap.  */

983
DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
984 985
  "Return the binding for command KEYS in current global keymap only.\n\
KEYS is a string, a sequence of keystrokes.\n\
Jim Blandy's avatar
Jim Blandy committed
986 987
The binding is probably a symbol with a function definition.\n\
This function's return values are the same as those of lookup-key\n\
988
\(which see).\n\
989 990 991 992 993
\n\
If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
bindings; see the description of `lookup-key' for more details about this.")
  (keys, accept_default)
     Lisp_Object keys, accept_default;
Jim Blandy's avatar
Jim Blandy committed
994
{
995
  return Flookup_key (current_global_map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
996 997
}

998 999
/* GC is possible in this function if it autoloads a keymap.  */

1000
DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
1001 1002 1003 1004 1005 1006 1007
  "Find the visible minor mode bindings of KEY.\n\
Return an alist of pairs (MODENAME . BINDING), where MODENAME is the\n\
the symbol which names the minor mode binding KEY, and BINDING is\n\
KEY's definition in that mode.  In particular, if KEY has no\n\
minor-mode bindings, return nil.  If the first binding is a\n\
non-prefix, all subsequent bindings will be omitted, since they would\n\
be ignored.  Similarly, the list doesn't include non-prefix bindings\n\
1008 1009 1010 1011 1012 1013
that come after prefix bindings.\n\
\n\
If optional argument ACCEPT-DEFAULT is non-nil, recognize default\n\
bindings; see the description of `lookup-key' for more details about this.")
  (key, accept_default)
     Lisp_Object key, accept_default;
Jim Blandy's avatar
Jim Blandy committed
1014 1015 1016 1017 1018
{
  Lisp_Object *modes, *maps;
  int nmaps;
  Lisp_Object binding;
  int i, j;
1019
  struct gcpro gcpro1, gcpro2;
Jim Blandy's avatar
Jim Blandy committed
1020 1021

  nmaps = current_minor_maps (&modes, &maps);
1022 1023 1024 1025 1026
  /* Note that all these maps are GCPRO'd
     in the places where we found them.  */

  binding = Qnil;
  GCPRO2 (key, binding);
Jim Blandy's avatar
Jim Blandy committed
1027 1028

  for (i = j = 0; i < nmaps; i++)
Jim Blandy's avatar
Jim Blandy committed
1029
    if (! NILP (maps[i])
1030
	&& ! NILP (binding = Flookup_key (maps[i], key, accept_default))
1031
	&& !INTEGERP (binding))
Jim Blandy's avatar
Jim Blandy committed
1032
      {
1033
	if (! NILP (get_keymap (binding)))
Jim Blandy's avatar
Jim Blandy committed
1034 1035
	  maps[j++] = Fcons (modes[i], binding);
	else if (j == 0)
1036
	  RETURN_UNGCPRO (Fcons (Fcons (modes[i], binding), Qnil));
Jim Blandy's avatar
Jim Blandy committed