keymap.c 68.4 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 79 80 81
/* 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;

82
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii;
Jim Blandy's avatar
Jim Blandy committed
83

Jim Blandy's avatar
Jim Blandy committed
84 85 86
/* 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
87 88
extern Lisp_Object meta_prefix_char;

89 90
extern Lisp_Object Voverriding_local_map;

91
static Lisp_Object define_as_prefix ();
Jim Blandy's avatar
Jim Blandy committed
92 93 94 95
static Lisp_Object describe_buffer_bindings ();
static void describe_command ();
static void describe_map ();

Jim Blandy's avatar
Jim Blandy committed
96 97
/* Keymap object support - constructors and predicates.			*/

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

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

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

   For example:

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

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

151 152 153 154 155 156 157 158 159
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
160 161 162 163 164 165 166 167 168 169 170
/* 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;
171
  XSETVECTOR (v, tomap);
172
  XSETFASTINT (c, tochar);
Jim Blandy's avatar
Jim Blandy committed
173 174 175 176 177 178
  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
179
\n\
180
A keymap is a list (keymap . ALIST),\n\
Karl Heuer's avatar
Karl Heuer committed
181
or a symbol whose function definition is itself a keymap.\n\
Jim Blandy's avatar
Jim Blandy committed
182
ALIST elements look like (CHAR . DEFN) or (SYMBOL . DEFN);\n\
183 184
a vector of densely packed bindings for small character codes\n\
is also allowed as an element.")
Jim Blandy's avatar
Jim Blandy committed
185 186 187
  (object)
     Lisp_Object object;
{
188
  return (NILP (get_keymap_1 (object, 0, 0)) ? Qnil : Qt);
Jim Blandy's avatar
Jim Blandy committed
189 190 191
}

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

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

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

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

228 229 230 231
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
232

233 234
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
235 236 237 238
	  UNGCPRO;

	  goto autoload_retry;
	}
239 240
    }

Jim Blandy's avatar
Jim Blandy committed
241 242
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
243 244
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
245 246
}

247 248 249

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


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

266 267 268
   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
269 270

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

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

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

294 295
  {
    Lisp_Object tail;
296
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
297

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

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

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
335
      }
336

337 338
    return t_binding;
  }
Jim Blandy's avatar
Jim Blandy committed
339 340 341 342 343 344 345 346 347
}

/* 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,
348 349 350 351
   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
352 353

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

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

      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;
{
403 404 405 406
  /* 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))
407 408
    def = Fcons (XCONS (def)->car, XCONS (def)->cdr);

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

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

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

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
427
  {
428
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
429

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

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

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

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
472 473
      }

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

484

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

  copy = Fcopy_alist (get_keymap (keymap));

499
  for (tail = copy; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
500
    {
501
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
502

503
      elt = XCONS (tail)->car;
504
      if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
505
	{
506
	  int i;
Jim Blandy's avatar
Jim Blandy committed
507

508 509
	  elt = Fcopy_sequence (elt);
	  XCONS (tail)->car = elt;
Jim Blandy's avatar
Jim Blandy committed
510

511
	  for (i = 0; i < XVECTOR (elt)->size; i++)
512
	    if (!SYMBOLP (XVECTOR (elt)->contents[i])
513
		&& ! NILP (Fkeymapp (XVECTOR (elt)->contents[i])))
514 515
	      XVECTOR (elt)->contents[i] =
		Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
516
	}
517 518 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
      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
551 552 553 554 555
    }

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

558 559
/* GC is possible in this function if it autoloads a keymap.  */

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

594
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
595

596
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
597 598
    key = wrong_type_argument (Qarrayp, key);

599
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
600 601 602
  if (length == 0)
    return Qnil;

603 604 605
  if (SYMBOLP (def) && !EQ (Vdefine_key_rebound_commands, Qt))
    Vdefine_key_rebound_commands = Fcons (def, Vdefine_key_rebound_commands);

606 607
  GCPRO3 (keymap, key, def);

608
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
609 610 611 612
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
613 614 615 616 617
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

618
      if (CONSP (c) && lucid_event_type_list_p (c))
619
	c = Fevent_convert_list (c);
620

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

	  metized = 0;
	  idx++;
	}

637
      if (! INTEGERP (c) && ! SYMBOLP (c) && ! CONSP (c))
638
	error ("Key sequence contains invalid events");
639

Jim Blandy's avatar
Jim Blandy committed
640
      if (idx == length)
641
	RETURN_UNGCPRO (store_in_keymap (keymap, c, def));
Jim Blandy's avatar
Jim Blandy committed
642

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

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

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

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

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

691
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
692

693
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
694 695
    key = wrong_type_argument (Qarrayp, key);

696
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
697 698 699
  if (length == 0)
    return keymap;

700
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
701 702 703 704
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

705 706
  GCPRO1 (key);

Jim Blandy's avatar
Jim Blandy committed
707 708 709 710 711
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

712
      if (CONSP (c) && lucid_event_type_list_p (c))
713
	c = Fevent_convert_list (c);
714

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

	  metized = 0;
	  idx++;
	}

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

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

      QUIT;
    }
}

743 744 745 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
/* 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;
}

779 780
/* Append a key to the end of a key sequence.  We always make a vector.  */

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

  args[0] = key_sequence;

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

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

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

Jim Blandy's avatar
Jim Blandy committed
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
/* 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
823
  Lisp_Object alist, assoc, var, val;
Jim Blandy's avatar
Jim Blandy committed
824 825 826 827

  for (alist = Vminor_mode_map_alist;
       CONSP (alist);
       alist = XCONS (alist)->cdr)
828 829 830
    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
831
	&& ! NILP (val))
Jim Blandy's avatar
Jim Blandy committed
832
      {
Jim Blandy's avatar
Jim Blandy committed
833
	if (i >= cmm_size)
Jim Blandy's avatar
Jim Blandy committed
834 835 836
	  {
	    Lisp_Object *newmodes, *newmaps;

Jim Blandy's avatar
Jim Blandy committed
837
	    if (cmm_maps)
Jim Blandy's avatar
Jim Blandy committed
838
	      {
839
		BLOCK_INPUT;
840
		cmm_size *= 2;
Richard M. Stallman's avatar
Richard M. Stallman committed
841 842 843 844 845 846
		newmodes
		  = (Lisp_Object *) realloc (cmm_modes,
					     cmm_size * sizeof (Lisp_Object));
		newmaps
		  = (Lisp_Object *) realloc (cmm_maps,
					     cmm_size * sizeof (Lisp_Object));
847
		UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
848 849 850
	      }
	    else
	      {
851
		BLOCK_INPUT;
852
		cmm_size = 30;
Richard M. Stallman's avatar
Richard M. Stallman committed
853 854 855 856
		newmodes
		  = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object));
		newmaps
		  = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object));
857
		UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
858 859 860 861
	      }

	    if (newmaps && newmodes)
	      {
Jim Blandy's avatar
Jim Blandy committed
862 863
		cmm_modes = newmodes;
		cmm_maps = newmaps;
Jim Blandy's avatar
Jim Blandy committed
864 865 866 867
	      }
	    else
	      break;
	  }
Jim Blandy's avatar
Jim Blandy committed
868
	cmm_modes[i] = var;
869
	cmm_maps [i] = Findirect_function (XCONS (assoc)->cdr);
Jim Blandy's avatar
Jim Blandy committed
870 871 872
	i++;
      }

Jim Blandy's avatar
Jim Blandy committed
873 874
  if (modeptr) *modeptr = cmm_modes;
  if (mapptr)  *mapptr  = cmm_maps;
Jim Blandy's avatar
Jim Blandy committed
875 876 877
  return i;
}

878 879
/* GC is possible in this function if it autoloads a keymap.  */

880
DEFUN ("key-binding", Fkey_binding, Skey_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
881
  "Return the binding for command KEY in current keymaps.\n\
882 883 884 885 886
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
887 888
usable as a general function for probing keymaps.  However, if the\n\
optional second argument ACCEPT-DEFAULT is non-nil, `key-binding' does\n\
889 890
recognize the default bindings, just as `read-key-sequence' does.")
  (key, accept_default)
891
     Lisp_Object key, accept_default;
Jim Blandy's avatar
Jim Blandy committed
892
{
Jim Blandy's avatar
Jim Blandy committed
893 894
  Lisp_Object *maps, value;
  int nmaps, i;
895 896 897
  struct gcpro gcpro1;

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

899 900 901 902 903 904 905 906
  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
907
    {
908
      value = Flookup_key (Voverriding_local_map, key, accept_default);
909
      if (! NILP (value) && !INTEGERP (value))
910
	RETURN_UNGCPRO (value);
Jim Blandy's avatar
Jim Blandy committed
911
    }
912 913 914
  else
    { 
      nmaps = current_minor_maps (0, &maps);
915 916 917
      /* Note that all these maps are GCPRO'd
	 in the places where we found them.  */

918 919 920 921
      for (i = 0; i < nmaps; i++)
	if (! NILP (maps[i]))
	  {
	    value = Flookup_key (maps[i], key, accept_default);
922
	    if (! NILP (value) && !INTEGERP (value))
923
	      RETURN_UNGCPRO (value);
924 925 926 927 928
	  }

      if (! NILP (current_buffer->keymap))
	{
	  value = Flookup_key (current_buffer->keymap, key, accept_default);
929
	  if (! NILP (value) && !INTEGERP (value))
930
	    RETURN_UNGCPRO (value);
931 932
	}
    }
Jim Blandy's avatar
Jim Blandy committed
933

934
  value = Flookup_key (current_global_map, key, accept_default);
935
  UNGCPRO;
936
  if (! NILP (value) && !INTEGERP (value))
Jim Blandy's avatar
Jim Blandy committed
937 938 939
    return value;
  
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
940 941
}

942 943
/* GC is possible in this function if it autoloads a keymap.  */

944
DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
945 946
  "Return the binding for command KEYS in current local keymap only.\n\
KEYS is a string, a sequence of keystrokes.\n\
947 948 949 950 951 952
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
953 954 955
{
  register Lisp_Object map;
  map = current_buffer->keymap;
Jim Blandy's avatar
Jim Blandy committed
956
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
957
    return Qnil;
958
  return Flookup_key (map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
959 960
}

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

963
DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
964 965
  "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
966 967
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\
968
\(which see).\n\
969 970 971 972 973
\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
974
{
975
  return Flookup_key (current_global_map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
976 977
}

978 979
/* GC is possible in this function if it autoloads a keymap.  */

980
DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
981 982 983 984 985 986 987
  "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\
988 989 990 991 992 993
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
994 995 996 997 998
{
  Lisp_Object *modes, *maps;
  int nmaps;
  Lisp_Object binding;
  int i, j;
999
  struct gcpro gcpro1, gcpro2;
Jim Blandy's avatar
Jim Blandy committed
1000 1001

  nmaps = current_minor_maps (&modes, &maps);
1002 1003 1004 1005 1006
  /* 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
1007 1008

  for (i = j = 0; i < nmaps; i++)
Jim Blandy's avatar
Jim Blandy committed
1009
    if (! NILP (maps[i])
1010
	&& ! NILP (binding = Flookup_key (maps[i], key, accept_default))
1011
	&& !INTEGERP (binding))
Jim Blandy's avatar
Jim Blandy committed
1012
      {
1013
	if (! NILP (get_keymap (binding)))
Jim Blandy's avatar
Jim Blandy committed
1014 1015
	  maps[j++] = Fcons (modes[i], binding);
	else if (j == 0)
1016
	  RETURN_UNGCPRO (Fcons (Fcons (modes[i], binding), Qnil));
Jim Blandy's avatar
Jim Blandy committed
1017 1018
      }

1019
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
1020 1021 1022
  return Flist (j, maps);
}

Jim Blandy's avatar
Jim Blandy committed
1023
DEFUN ("define-prefix-command", Fdefine_prefix_command, Sdefine_prefix_command, 1, 2, 0,
1024
  "Define COMMAND as a prefix command.  COMMAND should be a symbol.\n\
Jim Blandy's avatar
Jim Blandy committed
1025
A new sparse keymap is stored as COMMAND's function definition and its value.\n\
Jim Blandy's avatar
Jim Blandy committed
1026 1027 1028
If a second optional argument MAPVAR is given, the map is stored as\n\