keymap.c 69 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Manipulation of keymaps
2
   Copyright (C) 1985, 86, 87, 88, 93, 94 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;

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

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

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

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

   For example:

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

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

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

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

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

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

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

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

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

	  goto autoload_retry;
	}
234 235
    }

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

242 243 244

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

479

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

  copy = Fcopy_alist (get_keymap (keymap));

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

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

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

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

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

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

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

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

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

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

598 599
  GCPRO3 (keymap, key, def);

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

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

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

	  metized = 0;
	  idx++;
	}

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

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

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

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

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

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

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

680
  keymap = get_keymap_1 (keymap, 1, 1);
Jim Blandy's avatar
Jim Blandy committed
681

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

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

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

694 695
  GCPRO1 (key);

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

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

	  metized = 0;
	  idx++;
	}

717
      cmd = get_keyelt (access_keymap (keymap, c, t_ok, 0), 1);
Jim Blandy's avatar
Jim Blandy committed
718
      if (idx == length)
719
	RETURN_UNGCPRO (cmd);
Jim Blandy's avatar
Jim Blandy committed
720

721
      keymap = get_keymap_1 (cmd, 0, 1);
722
      if (NILP (keymap))
723
	RETURN_UNGCPRO (make_number (idx));
Jim Blandy's avatar
Jim Blandy committed
724 725 726 727 728

      QUIT;
    }
}

729 730 731 732 733 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
/* 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;
}

765 766
/* Append a key to the end of a key sequence.  We always make a vector.  */

Jim Blandy's avatar
Jim Blandy committed
767 768 769 770 771 772 773 774
Lisp_Object
append_key (key_sequence, key)
     Lisp_Object key_sequence, key;
{
  Lisp_Object args[2];

  args[0] = key_sequence;

775 776
  args[1] = Fcons (key, Qnil);
  return Fvconcat (2, args);
Jim Blandy's avatar
Jim Blandy committed
777 778 779
}

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

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

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

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

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

	    if (newmaps && newmodes)
	      {
Jim Blandy's avatar
Jim Blandy committed
848 849
		cmm_modes = newmodes;
		cmm_maps = newmaps;
Jim Blandy's avatar
Jim Blandy committed
850 851 852 853
	      }
	    else
	      break;
	  }
Jim Blandy's avatar
Jim Blandy committed
854
	cmm_modes[i] = var;
855
	cmm_maps [i] = Findirect_function (XCONS (assoc)->cdr);
Jim Blandy's avatar
Jim Blandy committed
856 857 858
	i++;
      }

Jim Blandy's avatar
Jim Blandy committed
859 860
  if (modeptr) *modeptr = cmm_modes;
  if (mapptr)  *mapptr  = cmm_maps;
Jim Blandy's avatar
Jim Blandy committed
861 862 863
  return i;
}

864 865
/* GC is possible in this function if it autoloads a keymap.  */

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

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

885
  if (!NILP (Voverriding_local_map))
Jim Blandy's avatar
Jim Blandy committed
886
    {
887
      value = Flookup_key (Voverriding_local_map, key, accept_default);
888
      if (! NILP (value) && !INTEGERP (value))
889
	RETURN_UNGCPRO (value);
Jim Blandy's avatar
Jim Blandy committed
890
    }
891 892 893
  else
    { 
      nmaps = current_minor_maps (0, &maps);
894 895 896
      /* Note that all these maps are GCPRO'd
	 in the places where we found them.  */

897 898 899 900
      for (i = 0; i < nmaps; i++)
	if (! NILP (maps[i]))
	  {
	    value = Flookup_key (maps[i], key, accept_default);
901
	    if (! NILP (value) && !INTEGERP (value))
902
	      RETURN_UNGCPRO (value);
903 904 905 906 907
	  }

      if (! NILP (current_buffer->keymap))
	{
	  value = Flookup_key (current_buffer->keymap, key, accept_default);
908
	  if (! NILP (value) && !INTEGERP (value))
909
	    RETURN_UNGCPRO (value);
910 911
	}
    }
Jim Blandy's avatar
Jim Blandy committed
912

913
  value = Flookup_key (current_global_map, key, accept_default);
914
  UNGCPRO;
915
  if (! NILP (value) && !INTEGERP (value))
Jim Blandy's avatar
Jim Blandy committed
916 917 918
    return value;
  
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
919 920
}

921 922
/* GC is possible in this function if it autoloads a keymap.  */

923
DEFUN ("local-key-binding", Flocal_key_binding, Slocal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
924 925
  "Return the binding for command KEYS in current local keymap only.\n\
KEYS is a string, a sequence of keystrokes.\n\
926 927 928 929 930 931
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
932 933 934
{
  register Lisp_Object map;
  map = current_buffer->keymap;
Jim Blandy's avatar
Jim Blandy committed
935
  if (NILP (map))
Jim Blandy's avatar
Jim Blandy committed
936
    return Qnil;
937
  return Flookup_key (map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
938 939
}

940 941
/* GC is possible in this function if it autoloads a keymap.  */

942
DEFUN ("global-key-binding", Fglobal_key_binding, Sglobal_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
943 944
  "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
945 946
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\
947
\(which see).\n\
948 949 950 951 952
\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
  return Flookup_key (current_global_map, keys, accept_default);
Jim Blandy's avatar
Jim Blandy committed
955 956
}

957 958
/* GC is possible in this function if it autoloads a keymap.  */

959
DEFUN ("minor-mode-key-binding", Fminor_mode_key_binding, Sminor_mode_key_binding, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
960 961 962 963 964 965 966
  "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\
967 968 969 970 971 972
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
973 974 975 976 977
{
  Lisp_Object *modes, *maps;
  int nmaps;
  Lisp_Object binding;
  int i, j;
978
  struct gcpro gcpro1, gcpro2;
Jim Blandy's avatar
Jim Blandy committed
979 980

  nmaps = current_minor_maps (&modes, &maps);
981 982 983 984 985
  /* 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
986 987

  for (i = j = 0; i < nmaps; i++)
Jim Blandy's avatar
Jim Blandy committed
988
    if (! NILP (maps[i])
989
	&& ! NILP (binding = Flookup_key (maps[i], key, accept_default))
990
	&& !INTEGERP (binding))
Jim Blandy's avatar
Jim Blandy committed
991
      {
992
	if (! NILP (get_keymap (binding)))
Jim Blandy's avatar
Jim Blandy committed
993 994
	  maps[j++] = Fcons (modes[i], binding);
	else if (j == 0)
995
	  RETURN_UNGCPRO (Fcons (Fcons (modes[i], binding), Qnil));
Jim Blandy's avatar
Jim Blandy committed
996 997
      }

998
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
999 1000 1001
  return Flist (j, maps);
}

Jim Blandy's avatar
Jim Blandy committed
1002
DEFUN ("global-set-key", Fglobal_set_key, Sglobal_set_key, 2, 2,
1003
  "KSet key globally: \nCSet key %s to command: ",
Jim Blandy's avatar
Jim Blandy committed
1004 1005
  "Give KEY a global binding as COMMAND.\n\
COMMAND is a symbol naming an interactively-callable function.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
1006
KEY is a key sequence (a string or vector of characters or event types).\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
1007 1008
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
1009 1010 1011 1012 1013
Note that if KEY has a local binding in the current buffer\n\
that local binding will continue to shadow any global binding.")
  (keys, function)
     Lisp_Object keys, function;
{
1014
  if (!VECTORP (keys) && !STRINGP (keys))
Jim Blandy's avatar
Jim Blandy committed
1015 1016 1017 1018 1019 1020 1021
    keys = wrong_type_argument (Qarrayp, keys);

  Fdefine_key (current_global_map, keys, function);
  return Qnil;
}

DEFUN ("local-set-key", Flocal_set_key, Slocal_set_key, 2, 2,
1022
  "KSet key locally: \nCSet key %s locally to command: ",
Jim Blandy's avatar
Jim Blandy committed
1023 1024
  "Give KEY a local binding as COMMAND.\n\
COMMAND is a symbol naming an interactively-callable function.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
1025
KEY is a key sequence (a string or vector of characters or event types).\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
1026