keymap.c 67.7 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
Lisp_Object Qkeymapp, Qkeymap, Qnon_ascii;
Jim Blandy's avatar
Jim Blandy committed
77

Jim Blandy's avatar
Jim Blandy committed
78 79 80
/* 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
81 82
extern Lisp_Object meta_prefix_char;

83 84
extern Lisp_Object Voverriding_local_map;

85
static Lisp_Object define_as_prefix ();
Jim Blandy's avatar
Jim Blandy committed
86 87 88 89
static Lisp_Object describe_buffer_bindings ();
static void describe_command ();
static void describe_map ();

Jim Blandy's avatar
Jim Blandy committed
90 91
/* Keymap object support - constructors and predicates.			*/

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

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

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

   For example:

134
   initial_define_key (control_x_map, Ctl('X'), "exchange-point-and-mark");  */
Jim Blandy's avatar
Jim Blandy committed
135 136 137 138 139 140 141 142 143 144

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

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

/* Check that OBJECT is a keymap (after dereferencing through any
186 187 188 189
   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.
190
   If AUTOLOAD is nonzero, callers must assume GC is possible.
191 192 193 194 195 196 197 198 199 200

   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
201
Lisp_Object
202
get_keymap_1 (object, error, autoload)
Jim Blandy's avatar
Jim Blandy committed
203
     Lisp_Object object;
204
     int error, autoload;
Jim Blandy's avatar
Jim Blandy committed
205
{
206
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
207

208
 autoload_retry:
Jim Blandy's avatar
Jim Blandy committed
209
  tem = indirect_function (object);
Jim Blandy's avatar
Jim Blandy committed
210 211
  if (CONSP (tem) && EQ (XCONS (tem)->car, Qkeymap))
    return tem;
212

213 214
  /* Should we do an autoload?  Autoload forms for keymaps have
     Qkeymap as their fifth element.  */
215
  if (autoload
216
      && SYMBOLP (object)
217 218 219
      && CONSP (tem)
      && EQ (XCONS (tem)->car, Qautoload))
    {
220
      Lisp_Object tail;
221

222 223 224 225
      tail = Fnth (make_number (4), tem);
      if (EQ (tail, Qkeymap))
	{
	  struct gcpro gcpro1, gcpro2;
226

227 228
	  GCPRO2 (tem, object);
	  do_autoload (tem, object);
229 230 231 232
	  UNGCPRO;

	  goto autoload_retry;
	}
233 234
    }

Jim Blandy's avatar
Jim Blandy committed
235 236
  if (error)
    wrong_type_argument (Qkeymapp, object);
Jim Blandy's avatar
Jim Blandy committed
237 238
  else
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
239 240
}

241 242 243

/* 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
244 245 246 247
Lisp_Object
get_keymap (object)
     Lisp_Object object;
{
248
  return get_keymap_1 (object, 1, 0);
Jim Blandy's avatar
Jim Blandy committed
249 250 251 252
}


/* Look up IDX in MAP.  IDX may be any sort of event.
253
   Note that this does only one level of lookup; IDX must be a single
254 255 256 257 258 259
   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.  

260 261 262
   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
263 264

Lisp_Object
265
access_keymap (map, idx, t_ok, noinherit)
Jim Blandy's avatar
Jim Blandy committed
266 267
     Lisp_Object map;
     Lisp_Object idx;
268
     int t_ok;
269
     int noinherit;
Jim Blandy's avatar
Jim Blandy committed
270
{
271 272 273
  int noprefix = 0;
  Lisp_Object val;

Jim Blandy's avatar
Jim Blandy committed
274 275 276
  /* 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.  */
277
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
278

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

288 289
  {
    Lisp_Object tail;
290
    Lisp_Object t_binding;
Jim Blandy's avatar
Jim Blandy committed
291

292
    t_binding = Qnil;
293
    for (tail = map; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
294
      {
295
	Lisp_Object binding;
296

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

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
329
      }
330

331 332
    return t_binding;
  }
Jim Blandy's avatar
Jim Blandy committed
333 334 335 336 337 338 339 340 341
}

/* 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,
342 343 344 345
   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
346 347

Lisp_Object
348
get_keyelt (object, autoload)
Jim Blandy's avatar
Jim Blandy committed
349
     register Lisp_Object object;
350
     int autoload;
Jim Blandy's avatar
Jim Blandy committed
351 352 353 354 355
{
  while (1)
    {
      register Lisp_Object map, tem;

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

      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;
{
397 398 399 400
  /* 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))
401 402
    def = Fcons (XCONS (def)->car, XCONS (def)->cdr);

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

Jim Blandy's avatar
Jim Blandy committed
406 407 408
  /* 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.  */
409
  idx = EVENT_HEAD (idx);
Jim Blandy's avatar
Jim Blandy committed
410

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

  /* Scan the keymap for a binding of idx.  */
Jim Blandy's avatar
Jim Blandy committed
421
  {
422
    Lisp_Object tail;
Jim Blandy's avatar
Jim Blandy committed
423

424 425 426 427 428 429
    /* 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.  */
430
    Lisp_Object insertion_point;
Jim Blandy's avatar
Jim Blandy committed
431

432
    insertion_point = keymap;
433
    for (tail = XCONS (keymap)->cdr; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
434
      {
435
	Lisp_Object elt;
436

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

	QUIT;
Jim Blandy's avatar
Jim Blandy committed
466 467
      }

468 469 470
  keymap_end:
    /* We have scanned the entire keymap, and not found a binding for
       IDX.  Let's add one.  */
471 472
    XCONS (insertion_point)->cdr
      = Fcons (Fcons (idx, def), XCONS (insertion_point)->cdr);
473 474
  }
	  
Jim Blandy's avatar
Jim Blandy committed
475 476 477
  return def;
}

478

Jim Blandy's avatar
Jim Blandy committed
479 480 481 482
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
483 484 485
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
486 487 488 489 490 491 492
  (keymap)
     Lisp_Object keymap;
{
  register Lisp_Object copy, tail;

  copy = Fcopy_alist (get_keymap (keymap));

493
  for (tail = copy; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
494
    {
495
      Lisp_Object elt;
Jim Blandy's avatar
Jim Blandy committed
496

497
      elt = XCONS (tail)->car;
498
      if (VECTORP (elt))
Jim Blandy's avatar
Jim Blandy committed
499
	{
500
	  int i;
Jim Blandy's avatar
Jim Blandy committed
501

502 503
	  elt = Fcopy_sequence (elt);
	  XCONS (tail)->car = elt;
Jim Blandy's avatar
Jim Blandy committed
504

505
	  for (i = 0; i < XVECTOR (elt)->size; i++)
506
	    if (!SYMBOLP (XVECTOR (elt)->contents[i])
507
		&& ! NILP (Fkeymapp (XVECTOR (elt)->contents[i])))
508 509
	      XVECTOR (elt)->contents[i] =
		Fcopy_keymap (XVECTOR (elt)->contents[i]);
Jim Blandy's avatar
Jim Blandy committed
510
	}
511 512 513 514 515 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
      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
545 546 547 548 549
    }

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

552 553
/* GC is possible in this function if it autoloads a keymap.  */

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

588
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
589

590
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
591 592
    key = wrong_type_argument (Qarrayp, key);

593
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
594 595 596
  if (length == 0)
    return Qnil;

597 598
  GCPRO3 (keymap, key, def);

599
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
600 601 602 603
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

Jim Blandy's avatar
Jim Blandy committed
604 605 606 607 608
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

609
      if (CONSP (c) && lucid_event_type_list_p (c))
610
	c = Fevent_convert_list (c);
611

612
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
613
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
614 615 616 617 618 619 620
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
621
	  if (INTEGERP (c))
622
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
623 624 625 626 627

	  metized = 0;
	  idx++;
	}

628
      if (! INTEGERP (c) && ! SYMBOLP (c) && ! CONSP (c))
629
	error ("Key sequence contains invalid events");
630

Jim Blandy's avatar
Jim Blandy committed
631
      if (idx == length)
632
	RETURN_UNGCPRO (store_in_keymap (keymap, c, def));
Jim Blandy's avatar
Jim Blandy committed
633

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

636
      /* If this key is undefined, make it a prefix.  */
Jim Blandy's avatar
Jim Blandy committed
637
      if (NILP (cmd))
638
	cmd = define_as_prefix (keymap, c);
Jim Blandy's avatar
Jim Blandy committed
639

640 641
      keymap = get_keymap_1 (cmd, 0, 1);
      if (NILP (keymap))
642 643 644 645
	/* 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
646 647 648 649
    }
}

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

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

682
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
683

684
  if (!VECTORP (key) && !STRINGP (key))
Jim Blandy's avatar
Jim Blandy committed
685 686
    key = wrong_type_argument (Qarrayp, key);

687
  length = XFASTINT (Flength (key));
Jim Blandy's avatar
Jim Blandy committed
688 689 690
  if (length == 0)
    return keymap;

691
  if (VECTORP (key))
Richard M. Stallman's avatar
Richard M. Stallman committed
692 693 694 695
    meta_bit = meta_modifier;
  else
    meta_bit = 0x80;

696 697
  GCPRO1 (key);

Jim Blandy's avatar
Jim Blandy committed
698 699 700 701 702
  idx = 0;
  while (1)
    {
      c = Faref (key, make_number (idx));

703
      if (CONSP (c) && lucid_event_type_list_p (c))
704
	c = Fevent_convert_list (c);
705

706
      if (INTEGERP (c)
Richard M. Stallman's avatar
Richard M. Stallman committed
707
	  && (XINT (c) & meta_bit)
Jim Blandy's avatar
Jim Blandy committed
708 709 710 711 712 713 714
	  && !metized)
	{
	  c = meta_prefix_char;
	  metized = 1;
	}
      else
	{
715
	  if (INTEGERP (c))
Richard M. Stallman's avatar
Richard M. Stallman committed
716
	    XSETINT (c, XINT (c) & ~meta_bit);
Jim Blandy's avatar
Jim Blandy committed
717 718 719 720 721

	  metized = 0;
	  idx++;
	}

722
      cmd = get_keyelt (access_keymap (keymap, c, t_ok, 0), 1);
Jim Blandy's avatar
Jim Blandy committed
723
      if (idx == length)
724
	RETURN_UNGCPRO (cmd);
Jim Blandy's avatar
Jim Blandy committed
725

726
      keymap = get_keymap_1 (cmd, 0, 1);
727
      if (NILP (keymap))
728
	RETURN_UNGCPRO (make_number (idx));
Jim Blandy's avatar
Jim Blandy committed
729 730 731 732 733

      QUIT;
    }
}

734 735 736 737 738 739 740 741 742 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
/* 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;
}

770 771
/* Append a key to the end of a key sequence.  We always make a vector.  */

Jim Blandy's avatar
Jim Blandy committed
772 773 774 775 776 777 778 779
Lisp_Object
append_key (key_sequence, key)
     Lisp_Object key_sequence, key;
{
  Lisp_Object args[2];

  args[0] = key_sequence;

780 781
  args[1] = Fcons (key, Qnil);
  return Fvconcat (2, args);
Jim Blandy's avatar
Jim Blandy committed
782 783 784
}

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

Jim Blandy's avatar
Jim Blandy committed
787
/* We can't put these variables inside current_minor_maps, since under
Jim Blandy's avatar
Jim Blandy committed
788 789
   some systems, static gets macro-defined to be the empty string.
   Ickypoo.  */
Jim Blandy's avatar
Jim Blandy committed
790 791 792
static Lisp_Object *cmm_modes, *cmm_maps;
static int cmm_size;

Jim Blandy's avatar
Jim Blandy committed
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
/* 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
814
  Lisp_Object alist, assoc, var, val;
Jim Blandy's avatar
Jim Blandy committed
815 816 817 818

  for (alist = Vminor_mode_map_alist;
       CONSP (alist);
       alist = XCONS (alist)->cdr)
819 820 821
    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
822
	&& ! NILP (val))
Jim Blandy's avatar
Jim Blandy committed
823
      {
Jim Blandy's avatar
Jim Blandy committed
824
	if (i >= cmm_size)
Jim Blandy's avatar
Jim Blandy committed
825 826 827
	  {
	    Lisp_Object *newmodes, *newmaps;

Jim Blandy's avatar
Jim Blandy committed
828
	    if (cmm_maps)
Jim Blandy's avatar
Jim Blandy committed
829
	      {
830
		BLOCK_INPUT;
831
		cmm_size *= 2;
Richard M. Stallman's avatar
Richard M. Stallman committed
832 833 834 835 836 837
		newmodes
		  = (Lisp_Object *) realloc (cmm_modes,
					     cmm_size * sizeof (Lisp_Object));
		newmaps
		  = (Lisp_Object *) realloc (cmm_maps,
					     cmm_size * sizeof (Lisp_Object));
838
		UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
839 840 841
	      }
	    else
	      {
842
		BLOCK_INPUT;
843
		cmm_size = 30;
Richard M. Stallman's avatar
Richard M. Stallman committed
844 845 846 847
		newmodes
		  = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object));
		newmaps
		  = (Lisp_Object *) malloc (cmm_size * sizeof (Lisp_Object));
848
		UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
849 850 851 852
	      }

	    if (newmaps && newmodes)
	      {
Jim Blandy's avatar
Jim Blandy committed
853 854
		cmm_modes = newmodes;
		cmm_maps = newmaps;
Jim Blandy's avatar
Jim Blandy committed
855 856 857 858
	      }
	    else
	      break;
	  }
Jim Blandy's avatar
Jim Blandy committed
859
	cmm_modes[i] = var;
860
	cmm_maps [i] = Findirect_function (XCONS (assoc)->cdr);
Jim Blandy's avatar
Jim Blandy committed
861 862 863
	i++;
      }

Jim Blandy's avatar
Jim Blandy committed
864 865
  if (modeptr) *modeptr = cmm_modes;
  if (mapptr)  *mapptr  = cmm_maps;
Jim Blandy's avatar
Jim Blandy committed
866 867 868
  return i;
}

869 870
/* GC is possible in this function if it autoloads a keymap.  */

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

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

890 891 892 893 894 895 896 897
  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
898
    {
899
      value = Flookup_key (Voverriding_local_map, key, accept_default);
900
      if (! NILP (value) && !INTEGERP (value))
901
	RETURN_UNGCPRO (value);
Jim Blandy's avatar
Jim Blandy committed
902
    }
903 904 905
  else
    { 
      nmaps = current_minor_maps (0, &maps);
906 907 908
      /* Note that all these maps are GCPRO'd
	 in the places where we found them.  */

909 910 911 912
      for (i = 0; i < nmaps; i++)
	if (! NILP (maps[i]))
	  {
	    value = Flookup_key (maps[i], key, accept_default);
913
	    if (! NILP (value) && !INTEGERP (value))
914
	      RETURN_UNGCPRO (value);
915 916 917 918 919
	  }

      if (! NILP (current_buffer->keymap))
	{
	  value = Flookup_key (current_buffer->keymap, key, accept_default);
920
	  if (! NILP (value) && !INTEGERP (value))
921
	    RETURN_UNGCPRO (value);
922 923
	}
    }
Jim Blandy's avatar
Jim Blandy committed
924

925
  value = Flookup_key (current_global_map, key, accept_default);
926
  UNGCPRO;
927
  if (! NILP (value) && !INTEGERP (value))
Jim Blandy's avatar
Jim Blandy committed
928 929 930
    return value;
  
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
931 932
}

933 934
/* GC is possible in this function if it autoloads a keymap.  */

935
DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
936 937
  "Return the binding for command KEYS in current local keymap only.\n\
KEYS is a string, a sequence of keystrokes.\n\
938 939 940 941 942 943
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
944 945 946
{
  register Lisp_Object map;
  map = current_buffer->keymap;
Jim Blandy's avatar
Jim Blandy committed
947
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
948
    return Qnil;
949
  return Flookup_key (map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
950 951
}

952 953
/* GC is possible in this function if it autoloads a keymap.  */

954
DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
955 956
  "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
957 958
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\
959
\(which see).\n\
960 961 962 963 964
\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
965
{
966
  return Flookup_key (current_global_map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
967 968
}

969 970
/* GC is possible in this function if it autoloads a keymap.  */

971
DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
972 973 974 975 976 977 978
  "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\
979 980 981 982 983 984
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
985 986 987 988 989
{
  Lisp_Object *modes, *maps;
  int nmaps;
  Lisp_Object binding;
  int i, j;
990
  struct gcpro gcpro1, gcpro2;
Jim Blandy's avatar
Jim Blandy committed
991 992

  nmaps = current_minor_maps (&modes, &maps);
993 994 995 996 997
  /* 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
998 999

  for (i = j = 0; i < nmaps; i++)
Jim Blandy's avatar
Jim Blandy committed
1000
    if (! NILP (maps[i])
1001
	&& ! NILP (binding = Flookup_key (maps[i], key, accept_default))
1002
	&& !INTEGERP (binding))
Jim Blandy's avatar
Jim Blandy committed
1003
      {
1004
	if (! NILP (get_keymap (binding)))
Jim Blandy's avatar
Jim Blandy committed
1005 1006
	  maps[j++] = Fcons (modes[i], binding);
	else if (j == 0)
1007
	  RETURN_UNGCPRO (Fcons (Fcons (modes[i], binding), Qnil));
Jim Blandy's avatar
Jim Blandy committed
1008 1009
      }

1010
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
1011 1012 1013
  return Flist (j, maps);
}

Jim Blandy's avatar
Jim Blandy committed
1014
DEFUN ("define-prefix-command", Fdefine_prefix_command, Sdefine_prefix_command, 1, 2, 0,
1015
  "Define COMMAND as a prefix command.  COMMAND should be a symbol.\n\
Jim Blandy's avatar
Jim Blandy committed
1016
A new sparse keymap is stored as COMMAND's function definition and its value.\n\
Jim Blandy's avatar
Jim Blandy committed
1017 1018 1019
If a second optional argument MAPVAR is given, the map is stored as\n\
its value instead of as COMMAND's value; but COMMAND is still defined\n\
as a function.")
Jim Blandy's avatar
Jim Blandy committed
1020 1021 1022 1023
  (name, mapvar)
     Lisp_Object name, mapvar;
{
  Lisp_Object map;
1024
  map = Fmake_sparse_keymap (Qnil);
Jim Blandy's avatar
Jim Blandy committed